/*

 * Copyright (c) 2013, 2019, Red Hat, Inc. All rights reserved.

 *

 * 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 "classfile/symbolTable.hpp"

#include "classfile/systemDictionary.hpp"

#include "code/codeCache.hpp"

#include "gc/shared/weakProcessor.inline.hpp"

#include "gc/shared/gcTimer.hpp"

#include "gc/shared/referenceProcessor.hpp"

#include "gc/shared/referenceProcessorPhaseTimes.hpp"

#include "gc/shared/strongRootsScope.hpp"

#include "gc/shenandoah/shenandoahBarrierSet.inline.hpp"

#include "gc/shenandoah/shenandoahClosures.inline.hpp"

#include "gc/shenandoah/shenandoahConcurrentMark.inline.hpp"

#include "gc/shenandoah/shenandoahMarkCompact.hpp"

#include "gc/shenandoah/shenandoahHeap.inline.hpp"

#include "gc/shenandoah/shenandoahRootProcessor.inline.hpp"

#include "gc/shenandoah/shenandoahOopClosures.inline.hpp"

#include "gc/shenandoah/shenandoahTaskqueue.inline.hpp"

#include "gc/shenandoah/shenandoahTimingTracker.hpp"

#include "gc/shenandoah/shenandoahUtils.hpp"

#include "memory/iterator.inline.hpp"

#include "memory/metaspace.hpp"

#include "memory/resourceArea.hpp"

#include "oops/oop.inline.hpp"

#include "runtime/handles.inline.hpp"

template<UpdateRefsMode UPDATE_REFS>

class ShenandoahInitMarkRootsClosure : public OopClosure {

private:

  ShenandoahObjToScanQueue* _queue;

  ShenandoahHeap* _heap;

  ShenandoahMarkingContext* const _mark_context;

  template <class T>

  inline void do_oop_work(T* p) {

    ShenandoahConcurrentMark::mark_through_ref<T, UPDATE_REFS, NO_DEDUP>(p, _heap, _queue, _mark_context);

  }

public:

  ShenandoahInitMarkRootsClosure(ShenandoahObjToScanQueue* q) :

    _queue(q),

    _heap(ShenandoahHeap::heap()),

    _mark_context(_heap->marking_context()) {};

  void do_oop(narrowOop* p) { do_oop_work(p); }

  void do_oop(oop* p)       { do_oop_work(p); }

};

ShenandoahMarkRefsSuperClosure::ShenandoahMarkRefsSuperClosure(ShenandoahObjToScanQueue* q, ReferenceProcessor* rp) :

  MetadataVisitingOopIterateClosure(rp),

  _queue(q),

  _heap(ShenandoahHeap::heap()),

  _mark_context(_heap->marking_context())

{ }

template<UpdateRefsMode UPDATE_REFS>

class ShenandoahInitMarkRootsTask : public AbstractGangTask {

private:

  ShenandoahAllRootScanner* _rp;

  bool _process_refs;

public:

  ShenandoahInitMarkRootsTask(ShenandoahAllRootScanner* rp, bool process_refs) :

    AbstractGangTask("Shenandoah init mark roots task"),

    _rp(rp),

    _process_refs(process_refs) {

  }

  void work(uint worker_id) {

    assert(ShenandoahSafepoint::is_at_shenandoah_safepoint(), "Must be at a safepoint");

    ShenandoahParallelWorkerSession worker_session(worker_id);

    ShenandoahHeap* heap = ShenandoahHeap::heap();

    ShenandoahObjToScanQueueSet* queues = heap->concurrent_mark()->task_queues();

    assert(queues->get_reserved() > worker_id, "Queue has not been reserved for worker id: %d", worker_id);

    ShenandoahObjToScanQueue* q = queues->queue(worker_id);

    ShenandoahInitMarkRootsClosure<UPDATE_REFS> mark_cl(q);

    do_work(heap, &mark_cl, worker_id);

  }

private:

  void do_work(ShenandoahHeap* heap, OopClosure* oops, uint worker_id) {

    // The rationale for selecting the roots to scan is as follows:

    //   a. With unload_classes = true, we only want to scan the actual strong roots from the

    //      code cache. This will allow us to identify the dead classes, unload them, *and*

    //      invalidate the relevant code cache blobs. This could be only done together with

    //      class unloading.

    //   b. With unload_classes = false, we have to nominally retain all the references from code

    //      cache, because there could be the case of embedded class/oop in the generated code,

    //      which we will never visit during mark. Without code cache invalidation, as in (a),

    //      we risk executing that code cache blob, and crashing.

    if (heap->unload_classes()) {

      _rp->strong_roots_do(worker_id, oops);

    } else {

      _rp->roots_do(worker_id, oops);

    }

  }

};

class ShenandoahUpdateRootsTask : public AbstractGangTask {

private:

  ShenandoahRootUpdater*  _root_updater;

public:

  ShenandoahUpdateRootsTask(ShenandoahRootUpdater* root_updater) :

    AbstractGangTask("Shenandoah update roots task"),

    _root_updater(root_updater) {

  }

  void work(uint worker_id) {

    assert(ShenandoahSafepoint::is_at_shenandoah_safepoint(), "Must be at a safepoint");

    ShenandoahParallelWorkerSession worker_session(worker_id);

    ShenandoahHeap* heap = ShenandoahHeap::heap();

    ShenandoahUpdateRefsClosure cl;

    AlwaysTrueClosure always_true;

    _root_updater->roots_do<AlwaysTrueClosure, ShenandoahUpdateRefsClosure>(worker_id, &always_true, &cl);

  }

};

class ShenandoahConcurrentMarkingTask : public AbstractGangTask {

private:

  ShenandoahConcurrentMark* _cm;

  ShenandoahTaskTerminator* _terminator;

public:

  ShenandoahConcurrentMarkingTask(ShenandoahConcurrentMark* cm, ShenandoahTaskTerminator* terminator) :

    AbstractGangTask("Root Region Scan"), _cm(cm), _terminator(terminator) {

  }

  void work(uint worker_id) {

    ShenandoahHeap* heap = ShenandoahHeap::heap();

    ShenandoahConcurrentWorkerSession worker_session(worker_id);

    ShenandoahSuspendibleThreadSetJoiner stsj(ShenandoahSuspendibleWorkers);

    ShenandoahObjToScanQueue* q = _cm->get_queue(worker_id);

    ReferenceProcessor* rp;

    if (heap->process_references()) {

      rp = heap->ref_processor();

      shenandoah_assert_rp_isalive_installed();

    } else {

      rp = NULL;

    }

    _cm->concurrent_scan_code_roots(worker_id, rp);

    _cm->mark_loop(worker_id, _terminator, rp,

                   true, // cancellable

                   ShenandoahStringDedup::is_enabled()); // perform string dedup

  }

};

class ShenandoahSATBThreadsClosure : public ThreadClosure {

private:

  ShenandoahSATBBufferClosure* _satb_cl;

  uintx _claim_token;

public:

  ShenandoahSATBThreadsClosure(ShenandoahSATBBufferClosure* satb_cl) :

    _satb_cl(satb_cl),

    _claim_token(Threads::thread_claim_token()) {}

  void do_thread(Thread* thread) {

    if (thread->claim_threads_do(true, _claim_token)) {

      ShenandoahThreadLocalData::satb_mark_queue(thread).apply_closure_and_empty(_satb_cl);

    }

  }

};

class ShenandoahFinalMarkingTask : public AbstractGangTask {

private:

  ShenandoahConcurrentMark* _cm;

  ShenandoahTaskTerminator* _terminator;

  bool _dedup_string;

public:

  ShenandoahFinalMarkingTask(ShenandoahConcurrentMark* cm, ShenandoahTaskTerminator* terminator, bool dedup_string) :

    AbstractGangTask("Shenandoah Final Marking"), _cm(cm), _terminator(terminator), _dedup_string(dedup_string) {

  }

  void work(uint worker_id) {

    ShenandoahHeap* heap = ShenandoahHeap::heap();

    ShenandoahParallelWorkerSession worker_session(worker_id);

    // First drain remaining SATB buffers.

    // Notice that this is not strictly necessary for mark-compact. But since

    // it requires a StrongRootsScope around the task, we need to claim the

    // threads, and performance-wise it doesn't really matter. Adds about 1ms to

    // full-gc.

    {

      ShenandoahObjToScanQueue* q = _cm->get_queue(worker_id);

      ShenandoahSATBBufferClosure cl(q);

      SATBMarkQueueSet& satb_mq_set = ShenandoahBarrierSet::satb_mark_queue_set();

      while (satb_mq_set.apply_closure_to_completed_buffer(&cl));

      ShenandoahSATBThreadsClosure tc(&cl);

      Threads::threads_do(&tc);

    }

    ReferenceProcessor* rp;

    if (heap->process_references()) {

      rp = heap->ref_processor();

      shenandoah_assert_rp_isalive_installed();

    } else {

      rp = NULL;

    }

    if (heap->is_degenerated_gc_in_progress()) {

      // Degenerated cycle may bypass concurrent cycle, so code roots might not be scanned,

      // let's check here.

      _cm->concurrent_scan_code_roots(worker_id, rp);

    }

    _cm->mark_loop(worker_id, _terminator, rp,

                   false, // not cancellable

                   _dedup_string);

    assert(_cm->task_queues()->is_empty(), "Should be empty");

  }

};

void ShenandoahConcurrentMark::mark_roots(ShenandoahPhaseTimings::Phase root_phase) {

  assert(Thread::current()->is_VM_thread(), "can only do this in VMThread");

  assert(ShenandoahSafepoint::is_at_shenandoah_safepoint(), "Must be at a safepoint");

  ShenandoahHeap* heap = ShenandoahHeap::heap();

  ShenandoahGCPhase phase(root_phase);

  WorkGang* workers = heap->workers();

  uint nworkers = workers->active_workers();

  assert(nworkers <= task_queues()->size(), "Just check");

  ShenandoahAllRootScanner root_proc(nworkers, root_phase);

  TASKQUEUE_STATS_ONLY(task_queues()->reset_taskqueue_stats());

  task_queues()->reserve(nworkers);

  if (heap->has_forwarded_objects()) {

    ShenandoahInitMarkRootsTask<RESOLVE> mark_roots(&root_proc, _heap->process_references());

    workers->run_task(&mark_roots);

  } else {

    // No need to update references, which means the heap is stable.

    // Can save time not walking through forwarding pointers.

    ShenandoahInitMarkRootsTask<NONE> mark_roots(&root_proc, _heap->process_references());

    workers->run_task(&mark_roots);

  }

  if (ShenandoahConcurrentScanCodeRoots) {

    clear_claim_codecache();

  }

}

void ShenandoahConcurrentMark::update_roots(ShenandoahPhaseTimings::Phase root_phase) {

  assert(ShenandoahSafepoint::is_at_shenandoah_safepoint(), "Must be at a safepoint");

  bool update_code_cache = true; // initialize to safer value

  switch (root_phase) {

    case ShenandoahPhaseTimings::update_roots:

    case ShenandoahPhaseTimings::final_update_refs_roots:

      update_code_cache = false;

      break;

    case ShenandoahPhaseTimings::full_gc_roots:

    case ShenandoahPhaseTimings::degen_gc_update_roots:

      update_code_cache = true;

      break;

    default:

      ShouldNotReachHere();

  }

  ShenandoahGCPhase phase(root_phase);

#if COMPILER2_OR_JVMCI

  DerivedPointerTable::clear();

#endif

  uint nworkers = _heap->workers()->active_workers();

  ShenandoahRootUpdater root_updater(nworkers, root_phase, update_code_cache);

  ShenandoahUpdateRootsTask update_roots(&root_updater);

  _heap->workers()->run_task(&update_roots);

#if COMPILER2_OR_JVMCI

  DerivedPointerTable::update_pointers();

#endif

}

class ShenandoahUpdateThreadRootsTask : public AbstractGangTask {

private:

  ShenandoahThreadRoots           _thread_roots;

  ShenandoahPhaseTimings::Phase   _phase;

public:

  ShenandoahUpdateThreadRootsTask(bool is_par, ShenandoahPhaseTimings::Phase phase) :

    AbstractGangTask("Shenandoah Update Thread Roots"),

    _thread_roots(is_par),

    _phase(phase) {

    ShenandoahHeap::heap()->phase_timings()->record_workers_start(_phase);

  }

  ~ShenandoahUpdateThreadRootsTask() {

    ShenandoahHeap::heap()->phase_timings()->record_workers_end(_phase);

  }

  void work(uint worker_id) {

    ShenandoahUpdateRefsClosure cl;

    _thread_roots.oops_do(&cl, NULL, worker_id);

  }

};

void ShenandoahConcurrentMark::update_thread_roots(ShenandoahPhaseTimings::Phase root_phase) {

  WorkGang* workers = _heap->workers();

  bool is_par = workers->active_workers() > 1;

#if COMPILER2_OR_JVMCI

  DerivedPointerTable::clear();

#endif

  ShenandoahUpdateThreadRootsTask task(is_par, root_phase);

  workers->run_task(&task);

#if COMPILER2_OR_JVMCI

  DerivedPointerTable::update_pointers();

#endif

}

void ShenandoahConcurrentMark::initialize(uint workers) {

  _heap = ShenandoahHeap::heap();

  uint num_queues = MAX2(workers, 1U);

  _task_queues = new ShenandoahObjToScanQueueSet((int) num_queues);

  for (uint i = 0; i < num_queues; ++i) {

    ShenandoahObjToScanQueue* task_queue = new ShenandoahObjToScanQueue();

    task_queue->initialize();

    _task_queues->register_queue(i, task_queue);

  }

}

void ShenandoahConcurrentMark::concurrent_scan_code_roots(uint worker_id, ReferenceProcessor* rp) {

  if (ShenandoahConcurrentScanCodeRoots && claim_codecache()) {

    ShenandoahObjToScanQueue* q = task_queues()->queue(worker_id);

    if (!_heap->unload_classes()) {

      MutexLocker mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);

      // TODO: We can not honor StringDeduplication here, due to lock ranking

      // inversion. So, we may miss some deduplication candidates.

      if (_heap->has_forwarded_objects()) {

        ShenandoahMarkResolveRefsClosure cl(q, rp);

        CodeBlobToOopClosure blobs(&cl, !CodeBlobToOopClosure::FixRelocations);

        CodeCache::blobs_do(&blobs);

      } else {

        ShenandoahMarkRefsClosure cl(q, rp);

        CodeBlobToOopClosure blobs(&cl, !CodeBlobToOopClosure::FixRelocations);

        CodeCache::blobs_do(&blobs);

      }

    }

  }

}

void ShenandoahConcurrentMark::mark_from_roots() {

  WorkGang* workers = _heap->workers();

  uint nworkers = workers->active_workers();

  ShenandoahGCPhase conc_mark_phase(ShenandoahPhaseTimings::conc_mark);

  if (_heap->process_references()) {

    ReferenceProcessor* rp = _heap->ref_processor();

    rp->set_active_mt_degree(nworkers);

    // enable ("weak") refs discovery

    rp->enable_discovery(true /*verify_no_refs*/);

    rp->setup_policy(_heap->soft_ref_policy()->should_clear_all_soft_refs());

  }

  shenandoah_assert_rp_isalive_not_installed();

  ShenandoahIsAliveSelector is_alive;

  ReferenceProcessorIsAliveMutator fix_isalive(_heap->ref_processor(), is_alive.is_alive_closure());

  task_queues()->reserve(nworkers);

  {

    ShenandoahTerminationTracker term(ShenandoahPhaseTimings::conc_termination);

    ShenandoahTaskTerminator terminator(nworkers, task_queues());

    ShenandoahConcurrentMarkingTask task(this, &terminator);

    workers->run_task(&task);

  }

  assert(task_queues()->is_empty() || _heap->cancelled_gc(), "Should be empty when not cancelled");

}

void ShenandoahConcurrentMark::finish_mark_from_roots(bool full_gc) {

  assert(ShenandoahSafepoint::is_at_shenandoah_safepoint(), "Must be at a safepoint");

  uint nworkers = _heap->workers()->active_workers();

  // Finally mark everything else we've got in our queues during the previous steps.

  // It does two different things for concurrent vs. mark-compact GC:

  // - For concurrent GC, it starts with empty task queues, drains the remaining

  //   SATB buffers, and then completes the marking closure.

  // - For mark-compact GC, it starts out with the task queues seeded by initial

  //   root scan, and completes the closure, thus marking through all live objects

  // The implementation is the same, so it's shared here.

  {

    ShenandoahGCPhase phase(full_gc ?

                            ShenandoahPhaseTimings::full_gc_mark_finish_queues :

                            ShenandoahPhaseTimings::finish_queues);

    task_queues()->reserve(nworkers);

    shenandoah_assert_rp_isalive_not_installed();

    ShenandoahIsAliveSelector is_alive;

    ReferenceProcessorIsAliveMutator fix_isalive(_heap->ref_processor(), is_alive.is_alive_closure());

    ShenandoahTerminationTracker termination_tracker(full_gc ?

                                                     ShenandoahPhaseTimings::full_gc_mark_termination :

                                                     ShenandoahPhaseTimings::termination);

    StrongRootsScope scope(nworkers);

    ShenandoahTaskTerminator terminator(nworkers, task_queues());

    ShenandoahFinalMarkingTask task(this, &terminator, ShenandoahStringDedup::is_enabled());

    _heap->workers()->run_task(&task);

  }

  assert(task_queues()->is_empty(), "Should be empty");

  // When we're done marking everything, we process weak references.

  if (_heap->process_references()) {

    weak_refs_work(full_gc);

  }

  assert(task_queues()->is_empty(), "Should be empty");

  TASKQUEUE_STATS_ONLY(task_queues()->print_taskqueue_stats());

  TASKQUEUE_STATS_ONLY(task_queues()->reset_taskqueue_stats());

}

// Weak Reference Closures

class ShenandoahCMDrainMarkingStackClosure: public VoidClosure {

  uint _worker_id;

  ShenandoahTaskTerminator* _terminator;

  bool _reset_terminator;

public:

  ShenandoahCMDrainMarkingStackClosure(uint worker_id, ShenandoahTaskTerminator* t, bool reset_terminator = false):

    _worker_id(worker_id),

    _terminator(t),

    _reset_terminator(reset_terminator) {

  }

  void do_void() {

    assert(ShenandoahSafepoint::is_at_shenandoah_safepoint(), "Must be at a safepoint");

    ShenandoahHeap* sh = ShenandoahHeap::heap();

    ShenandoahConcurrentMark* scm = sh->concurrent_mark();

    assert(sh->process_references(), "why else would we be here?");

    ReferenceProcessor* rp = sh->ref_processor();

    shenandoah_assert_rp_isalive_installed();

    scm->mark_loop(_worker_id, _terminator, rp,

                   false,   // not cancellable

                   false);  // do not do strdedup

    if (_reset_terminator) {

      _terminator->reset_for_reuse();

    }

  }

};

class ShenandoahCMKeepAliveClosure : public OopClosure {

private:

  ShenandoahObjToScanQueue* _queue;

  ShenandoahHeap* _heap;

  ShenandoahMarkingContext* const _mark_context;

  template <class T>

  inline void do_oop_work(T* p) {

    ShenandoahConcurrentMark::mark_through_ref<T, NONE, NO_DEDUP>(p, _heap, _queue, _mark_context);

  }

public:

  ShenandoahCMKeepAliveClosure(ShenandoahObjToScanQueue* q) :

    _queue(q),

    _heap(ShenandoahHeap::heap()),

    _mark_context(_heap->marking_context()) {}

  void do_oop(narrowOop* p) { do_oop_work(p); }

  void do_oop(oop* p)       { do_oop_work(p); }

};

class ShenandoahCMKeepAliveUpdateClosure : public OopClosure {

private:

  ShenandoahObjToScanQueue* _queue;

  ShenandoahHeap* _heap;

  ShenandoahMarkingContext* const _mark_context;

  template <class T>

  inline void do_oop_work(T* p) {

    ShenandoahConcurrentMark::mark_through_ref<T, SIMPLE, NO_DEDUP>(p, _heap, _queue, _mark_context);

  }