/*

 * Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 *

 */

#include "precompiled.hpp"

#include "code/codeCache.hpp"

#include "code/compiledIC.hpp"

#include "code/icBuffer.hpp"

#include "code/nmethod.hpp"

#include "compiler/compileBroker.hpp"

#include "gc/shared/collectedHeap.hpp"

#include "gc/shared/workgroup.hpp"

#include "jfr/jfrEvents.hpp"

#include "logging/log.hpp"

#include "logging/logStream.hpp"

#include "memory/allocation.inline.hpp"

#include "memory/resourceArea.hpp"

#include "memory/universe.hpp"

#include "oops/method.hpp"

#include "runtime/interfaceSupport.inline.hpp"

#include "runtime/handshake.hpp"

#include "runtime/mutexLocker.hpp"

#include "runtime/orderAccess.hpp"

#include "runtime/os.hpp"

#include "runtime/sweeper.hpp"

#include "runtime/thread.inline.hpp"

#include "runtime/vmOperations.hpp"

#include "runtime/vmThread.hpp"

#include "utilities/events.hpp"

#include "utilities/xmlstream.hpp"

#ifdef ASSERT

#define SWEEP(nm) record_sweep(nm, __LINE__)

// Sweeper logging code

class SweeperRecord {

 public:

  int traversal;

  int compile_id;

  long traversal_mark;

  int state;

  const char* kind;

  address vep;

  address uep;

  int line;

  void print() {

      tty->print_cr("traversal = %d compile_id = %d %s uep = " PTR_FORMAT " vep = "

                    PTR_FORMAT " state = %d traversal_mark %ld line = %d",

                    traversal,

                    compile_id,

                    kind == NULL ? "" : kind,

                    p2i(uep),

                    p2i(vep),

                    state,

                    traversal_mark,

                    line);

  }

};

static int _sweep_index = 0;

static SweeperRecord* _records = NULL;

void NMethodSweeper::report_events(int id, address entry) {

  if (_records != NULL) {

    for (int i = _sweep_index; i < SweeperLogEntries; i++) {

      if (_records[i].uep == entry ||

          _records[i].vep == entry ||

          _records[i].compile_id == id) {

        _records[i].print();

      }

    }

    for (int i = 0; i < _sweep_index; i++) {

      if (_records[i].uep == entry ||

          _records[i].vep == entry ||

          _records[i].compile_id == id) {

        _records[i].print();

      }

    }

  }

}

void NMethodSweeper::report_events() {

  if (_records != NULL) {

    for (int i = _sweep_index; i < SweeperLogEntries; i++) {

      // skip empty records

      if (_records[i].vep == NULL) continue;

      _records[i].print();

    }

    for (int i = 0; i < _sweep_index; i++) {

      // skip empty records

      if (_records[i].vep == NULL) continue;

      _records[i].print();

    }

  }

}

void NMethodSweeper::record_sweep(CompiledMethod* nm, int line) {

  if (_records != NULL) {

    _records[_sweep_index].traversal = _traversals;

    _records[_sweep_index].traversal_mark = nm->is_nmethod() ? ((nmethod*)nm)->stack_traversal_mark() : 0;

    _records[_sweep_index].compile_id = nm->compile_id();

    _records[_sweep_index].kind = nm->compile_kind();

    _records[_sweep_index].state = nm->get_state();

    _records[_sweep_index].vep = nm->verified_entry_point();

    _records[_sweep_index].uep = nm->entry_point();

    _records[_sweep_index].line = line;

    _sweep_index = (_sweep_index + 1) % SweeperLogEntries;

  }

}

void NMethodSweeper::init_sweeper_log() {

 if (LogSweeper && _records == NULL) {

   // Create the ring buffer for the logging code

   _records = NEW_C_HEAP_ARRAY(SweeperRecord, SweeperLogEntries, mtGC);

   memset(_records, 0, sizeof(SweeperRecord) * SweeperLogEntries);

  }

}

#else

#define SWEEP(nm)

#endif

CompiledMethodIterator NMethodSweeper::_current(CompiledMethodIterator::all_blobs); // Current compiled method

long     NMethodSweeper::_traversals                   = 0;    // Stack scan count, also sweep ID.

long     NMethodSweeper::_total_nof_code_cache_sweeps  = 0;    // Total number of full sweeps of the code cache

long     NMethodSweeper::_time_counter                 = 0;    // Virtual time used to periodically invoke sweeper

long     NMethodSweeper::_last_sweep                   = 0;    // Value of _time_counter when the last sweep happened

int      NMethodSweeper::_seen                         = 0;    // Nof. nmethod we have currently processed in current pass of CodeCache

volatile bool NMethodSweeper::_should_sweep            = false;// Indicates if we should invoke the sweeper

volatile bool NMethodSweeper::_force_sweep             = false;// Indicates if we should force a sweep

volatile int  NMethodSweeper::_bytes_changed           = 0;    // Counts the total nmethod size if the nmethod changed from:

                                                               //   1) alive       -> not_entrant

                                                               //   2) not_entrant -> zombie

int    NMethodSweeper::_hotness_counter_reset_val       = 0;

long   NMethodSweeper::_total_nof_methods_reclaimed     = 0;   // Accumulated nof methods flushed

long   NMethodSweeper::_total_nof_c2_methods_reclaimed  = 0;   // Accumulated nof methods flushed

size_t NMethodSweeper::_total_flushed_size              = 0;   // Total number of bytes flushed from the code cache

Tickspan NMethodSweeper::_total_time_sweeping;                 // Accumulated time sweeping

Tickspan NMethodSweeper::_total_time_this_sweep;               // Total time this sweep

Tickspan NMethodSweeper::_peak_sweep_time;                     // Peak time for a full sweep

Tickspan NMethodSweeper::_peak_sweep_fraction_time;            // Peak time sweeping one fraction

class MarkActivationClosure: public CodeBlobClosure {

public:

  virtual void do_code_blob(CodeBlob* cb) {

    assert(cb->is_nmethod(), "CodeBlob should be nmethod");

    nmethod* nm = (nmethod*)cb;

    nm->set_hotness_counter(NMethodSweeper::hotness_counter_reset_val());

    // If we see an activation belonging to a non_entrant nmethod, we mark it.

    if (nm->is_not_entrant()) {

      nm->mark_as_seen_on_stack();

    }

  }

};

static MarkActivationClosure mark_activation_closure;

class SetHotnessClosure: public CodeBlobClosure {

public:

  virtual void do_code_blob(CodeBlob* cb) {

    assert(cb->is_nmethod(), "CodeBlob should be nmethod");

    nmethod* nm = (nmethod*)cb;

    nm->set_hotness_counter(NMethodSweeper::hotness_counter_reset_val());

  }

};

static SetHotnessClosure set_hotness_closure;

int NMethodSweeper::hotness_counter_reset_val() {

  if (_hotness_counter_reset_val == 0) {

    _hotness_counter_reset_val = (ReservedCodeCacheSize < M) ? 1 : (ReservedCodeCacheSize / M) * 2;

  }

  return _hotness_counter_reset_val;

}

bool NMethodSweeper::wait_for_stack_scanning() {

  return _current.end();

}

class NMethodMarkingThreadClosure : public ThreadClosure {

private:

  CodeBlobClosure* _cl;

public:

  NMethodMarkingThreadClosure(CodeBlobClosure* cl) : _cl(cl) {}

  void do_thread(Thread* thread) {

    if (thread->is_Java_thread() && ! thread->is_Code_cache_sweeper_thread()) {

      JavaThread* jt = (JavaThread*) thread;

      jt->nmethods_do(_cl);

    }

  }

};

class NMethodMarkingTask : public AbstractGangTask {

private:

  NMethodMarkingThreadClosure* _cl;

public:

  NMethodMarkingTask(NMethodMarkingThreadClosure* cl) :

    AbstractGangTask("Parallel NMethod Marking"),

    _cl(cl) {

    Threads::change_thread_claim_token();

  }

  ~NMethodMarkingTask() {

    Threads::assert_all_threads_claimed();

  }

  void work(uint worker_id) {

    Threads::possibly_parallel_threads_do(true, _cl);

  }

};

/**

  * Scans the stacks of all Java threads and marks activations of not-entrant methods.

  * No need to synchronize access, since 'mark_active_nmethods' is always executed at a

  * safepoint.

  */

void NMethodSweeper::mark_active_nmethods() {

  CodeBlobClosure* cl = prepare_mark_active_nmethods();

  if (cl != NULL) {

    WorkGang* workers = Universe::heap()->get_safepoint_workers();

    if (workers != NULL) {

      NMethodMarkingThreadClosure tcl(cl);

      NMethodMarkingTask task(&tcl);

      workers->run_task(&task);

    } else {

      Threads::nmethods_do(cl);

    }

  }

}

CodeBlobClosure* NMethodSweeper::prepare_mark_active_nmethods() {

#ifdef ASSERT

  if (ThreadLocalHandshakes) {

    assert(Thread::current()->is_Code_cache_sweeper_thread(), "must be executed under CodeCache_lock and in sweeper thread");

    assert_lock_strong(CodeCache_lock);

  } else {

    assert(SafepointSynchronize::is_at_safepoint(), "must be executed at a safepoint");

  }

#endif

  // If we do not want to reclaim not-entrant or zombie methods there is no need

  // to scan stacks

  if (!MethodFlushing) {

    return NULL;

  }

  // Increase time so that we can estimate when to invoke the sweeper again.

  _time_counter++;

  // Check for restart

  assert(_current.method() == NULL, "should only happen between sweeper cycles");

  assert(wait_for_stack_scanning(), "should only happen between sweeper cycles");

  _seen = 0;

  _current = CompiledMethodIterator(CompiledMethodIterator::all_blobs);

  // Initialize to first nmethod

  _current.next();

  _traversals += 1;

  _total_time_this_sweep = Tickspan();

  if (PrintMethodFlushing) {

    tty->print_cr("### Sweep: stack traversal %ld", _traversals);

  }

  return &mark_activation_closure;

}

CodeBlobClosure* NMethodSweeper::prepare_reset_hotness_counters() {

  assert(SafepointSynchronize::is_at_safepoint(), "must be executed at a safepoint");

  // If we do not want to reclaim not-entrant or zombie methods there is no need

  // to scan stacks

  if (!MethodFlushing) {

    return NULL;

  }

  // Increase time so that we can estimate when to invoke the sweeper again.

  _time_counter++;

  // Check for restart

  if (_current.method() != NULL) {

    if (_current.method()->is_nmethod()) {

      assert(CodeCache::find_blob_unsafe(_current.method()) == _current.method(), "Sweeper nmethod cached state invalid");

    } else if (_current.method()->is_aot()) {

      assert(CodeCache::find_blob_unsafe(_current.method()->code_begin()) == _current.method(), "Sweeper AOT method cached state invalid");

    } else {

      ShouldNotReachHere();

    }

  }

  return &set_hotness_closure;

}

/**

  * This function triggers a VM operation that does stack scanning of active

  * methods. Stack scanning is mandatory for the sweeper to make progress.

  */

void NMethodSweeper::do_stack_scanning() {

  assert(!CodeCache_lock->owned_by_self(), "just checking");

  if (wait_for_stack_scanning()) {

    if (ThreadLocalHandshakes) {

      CodeBlobClosure* code_cl;

      {

        MutexLocker ccl(CodeCache_lock, Mutex::_no_safepoint_check_flag);

        code_cl = prepare_mark_active_nmethods();

      }

      if (code_cl != NULL) {

        NMethodMarkingThreadClosure tcl(code_cl);

        Handshake::execute(&tcl);

      }

    } else {

      VM_MarkActiveNMethods op;

      VMThread::execute(&op);

    }

  }

}

void NMethodSweeper::sweeper_loop() {

  bool timeout;

  while (true) {

    {

      ThreadBlockInVM tbivm(JavaThread::current());

      MonitorLocker waiter(CodeCache_lock, Mutex::_no_safepoint_check_flag);

      const long wait_time = 60*60*24 * 1000;

      timeout = waiter.wait(wait_time);

    }

    if (!timeout) {

      possibly_sweep();

    }

  }

}

/**

  * Wakes up the sweeper thread to possibly sweep.

  */

void NMethodSweeper::notify(int code_blob_type) {

  // Makes sure that we do not invoke the sweeper too often during startup.

  double start_threshold = 100.0 / (double)StartAggressiveSweepingAt;

  double aggressive_sweep_threshold = MIN2(start_threshold, 1.1);

  if (CodeCache::reverse_free_ratio(code_blob_type) >= aggressive_sweep_threshold) {

    assert_locked_or_safepoint(CodeCache_lock);

    CodeCache_lock->notify();

  }

}

/**

  * Wakes up the sweeper thread and forces a sweep. Blocks until it finished.

  */

void NMethodSweeper::force_sweep() {

  ThreadBlockInVM tbivm(JavaThread::current());

  MonitorLocker waiter(CodeCache_lock, Mutex::_no_safepoint_check_flag);

  // Request forced sweep

  _force_sweep = true;

  while (_force_sweep) {

    // Notify sweeper that we want to force a sweep and wait for completion.

    // In case a sweep currently takes place we timeout and try again because

    // we want to enforce a full sweep.

    CodeCache_lock->notify();

    waiter.wait(1000);

  }

}

/**

 * Handle a safepoint request

 */

void NMethodSweeper::handle_safepoint_request() {

  JavaThread* thread = JavaThread::current();

  if (SafepointMechanism::should_block(thread)) {

    if (PrintMethodFlushing && Verbose) {

      tty->print_cr("### Sweep at %d out of %d, yielding to safepoint", _seen, CodeCache::nmethod_count());

    }

    MutexUnlocker mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);

    ThreadBlockInVM tbivm(thread);

    thread->java_suspend_self();

  }

}

/**

 * This function invokes the sweeper if at least one of the three conditions is met:

 *    (1) The code cache is getting full

 *    (2) There are sufficient state changes in/since the last sweep.

 *    (3) We have not been sweeping for 'some time'

 */

void NMethodSweeper::possibly_sweep() {

  assert(JavaThread::current()->thread_state() == _thread_in_vm, "must run in vm mode");

  // If there was no state change while nmethod sweeping, 'should_sweep' will be false.

  // This is one of the two places where should_sweep can be set to true. The general

  // idea is as follows: If there is enough free space in the code cache, there is no

  // need to invoke the sweeper. The following formula (which determines whether to invoke

  // the sweeper or not) depends on the assumption that for larger ReservedCodeCacheSizes

  // we need less frequent sweeps than for smaller ReservedCodecCacheSizes. Furthermore,

  // the formula considers how much space in the code cache is currently used. Here are

  // some examples that will (hopefully) help in understanding.

  //

  // Small ReservedCodeCacheSizes:  (e.g., < 16M) We invoke the sweeper every time, since

  //                                              the result of the division is 0. This

  //                                              keeps the used code cache size small

  //                                              (important for embedded Java)

  // Large ReservedCodeCacheSize :  (e.g., 256M + code cache is 10% full). The formula

  //                                              computes: (256 / 16) - 1 = 15

  //                                              As a result, we invoke the sweeper after

  //                                              15 invocations of 'mark_active_nmethods.

  // Large ReservedCodeCacheSize:   (e.g., 256M + code Cache is 90% full). The formula

  //                                              computes: (256 / 16) - 10 = 6.

  if (!_should_sweep) {

    const int time_since_last_sweep = _time_counter - _last_sweep;

    // ReservedCodeCacheSize has an 'unsigned' type. We need a 'signed' type for max_wait_time,

    // since 'time_since_last_sweep' can be larger than 'max_wait_time'. If that happens using

    // an unsigned type would cause an underflow (wait_until_next_sweep becomes a large positive

    // value) that disables the intended periodic sweeps.

    const int max_wait_time = ReservedCodeCacheSize / (16 * M);

    double wait_until_next_sweep = max_wait_time - time_since_last_sweep -

        MAX2(CodeCache::reverse_free_ratio(CodeBlobType::MethodProfiled),

             CodeCache::reverse_free_ratio(CodeBlobType::MethodNonProfiled));

    assert(wait_until_next_sweep <= (double)max_wait_time, "Calculation of code cache sweeper interval is incorrect");

    if ((wait_until_next_sweep <= 0.0) || !CompileBroker::should_compile_new_jobs()) {

      _should_sweep = true;

    }

  }

  // Remember if this was a forced sweep

  bool forced = _force_sweep;

  // Force stack scanning if there is only 10% free space in the code cache.

  // We force stack scanning only if the non-profiled code heap gets full, since critical

  // allocations go to the non-profiled heap and we must be make sure that there is

  // enough space.

  double free_percent = 1 / CodeCache::reverse_free_ratio(CodeBlobType::MethodNonProfiled) * 100;

  if (free_percent <= StartAggressiveSweepingAt || forced || _should_sweep) {

    do_stack_scanning();

  }

  if (_should_sweep || forced) {

    init_sweeper_log();

    sweep_code_cache();

  }

  // We are done with sweeping the code cache once.

  _total_nof_code_cache_sweeps++;

  _last_sweep = _time_counter;

  // Reset flag; temporarily disables sweeper

  _should_sweep = false;

  // If there was enough state change, 'possibly_enable_sweeper()'

  // sets '_should_sweep' to true

  possibly_enable_sweeper();

  // Reset _bytes_changed only if there was enough state change. _bytes_changed

  // can further increase by calls to 'report_state_change'.

  if (_should_sweep) {

    _bytes_changed = 0;

  }

  if (forced) {

    // Notify requester that forced sweep finished

    assert(_force_sweep, "Should be a forced sweep");

    MutexLocker mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);

    _force_sweep = false;

    CodeCache_lock->notify();

  }

}

static void post_sweep_event(EventSweepCodeCache* event,

                             const Ticks& start,

                             const Ticks& end,

                             s4 traversals,

                             int swept,

                             int flushed,

                             int zombified) {

  assert(event != NULL, "invariant");