/*

 * Copyright (c) 2015, 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.

 *

 */

#ifndef SHARE_GC_G1_G1ROOTCLOSURES_HPP

#define SHARE_GC_G1_G1ROOTCLOSURES_HPP

#include "memory/allocation.hpp"

#include "memory/iterator.hpp"

class G1CollectedHeap;

class G1ParScanThreadState;

class G1RootClosures : public CHeapObj<mtGC> {

public:

  virtual ~G1RootClosures() {}

// Closures to process raw oops in the root set.

  virtual OopClosure* weak_oops() = 0;

  virtual OopClosure* strong_oops() = 0;

  // Closures to process CLDs in the root set.

  virtual CLDClosure* weak_clds() = 0;

  virtual CLDClosure* strong_clds() = 0;

  // Applied to code blobs reachable as strong roots.

  virtual CodeBlobClosure* strong_codeblobs() = 0;

};

class G1EvacuationRootClosures : public G1RootClosures {

public:

  // Applied to the weakly reachable CLDs when all strongly reachable

  // CLDs are guaranteed to have been processed.

  virtual CLDClosure* second_pass_weak_clds() = 0;

  // Get a raw oop closure for processing oops, bypassing the flushing above.

  virtual OopClosure* raw_strong_oops() = 0;

  // Applied to code blobs treated as weak roots.

  virtual CodeBlobClosure* weak_codeblobs() = 0;

  // Is this closure used for tracing metadata?

  virtual bool trace_metadata() = 0;

  static G1EvacuationRootClosures* create_root_closures(G1ParScanThreadState* pss, G1CollectedHeap* g1h);

};

#endif // SHARE_GC_G1_G1ROOTCLOSURES_HPP