src/hotspot/share/gc/shared/barrierSet.hpp
author dnsimon
Mon, 06 Nov 2017 12:53:55 +0100
changeset 47794 e84aa2c71241
parent 47658 c2b7fb8e5144
child 47998 fb0275c320a0
permissions -rw-r--r--
8188102: [JVMCI] Convert special JVMCI oops in nmethod to jweak values Reviewed-by: never, kvn, kbarrett
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
     1
/*
47658
c2b7fb8e5144 8189355: Cleanup of BarrierSet barrier functions
eosterlund
parents: 47216
diff changeset
     2
 * Copyright (c) 2000, 2017, Oracle and/or its affiliates. All rights reserved.
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
489c9b5090e2 Initial load
duke
parents:
diff changeset
     4
 *
489c9b5090e2 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
489c9b5090e2 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
489c9b5090e2 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.
489c9b5090e2 Initial load
duke
parents:
diff changeset
     8
 *
489c9b5090e2 Initial load
duke
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
489c9b5090e2 Initial load
duke
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
489c9b5090e2 Initial load
duke
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
489c9b5090e2 Initial load
duke
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
489c9b5090e2 Initial load
duke
parents:
diff changeset
    13
 * accompanied this code).
489c9b5090e2 Initial load
duke
parents:
diff changeset
    14
 *
489c9b5090e2 Initial load
duke
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
489c9b5090e2 Initial load
duke
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
489c9b5090e2 Initial load
duke
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    18
 *
5547
f4b087cbb361 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 4886
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
f4b087cbb361 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 4886
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
f4b087cbb361 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 4886
diff changeset
    21
 * questions.
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
    22
 *
489c9b5090e2 Initial load
duke
parents:
diff changeset
    23
 */
489c9b5090e2 Initial load
duke
parents:
diff changeset
    24
30764
fec48bf5a827 8079792: GC directory structure cleanup
pliden
parents: 29331
diff changeset
    25
#ifndef SHARE_VM_GC_SHARED_BARRIERSET_HPP
fec48bf5a827 8079792: GC directory structure cleanup
pliden
parents: 29331
diff changeset
    26
#define SHARE_VM_GC_SHARED_BARRIERSET_HPP
7397
5b173b4ca846 6989984: Use standard include model for Hospot
stefank
parents: 5547
diff changeset
    27
5b173b4ca846 6989984: Use standard include model for Hospot
stefank
parents: 5547
diff changeset
    28
#include "memory/memRegion.hpp"
5b173b4ca846 6989984: Use standard include model for Hospot
stefank
parents: 5547
diff changeset
    29
#include "oops/oopsHierarchy.hpp"
29325
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    30
#include "utilities/fakeRttiSupport.hpp"
7397
5b173b4ca846 6989984: Use standard include model for Hospot
stefank
parents: 5547
diff changeset
    31
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
    32
// This class provides the interface between a barrier implementation and
489c9b5090e2 Initial load
duke
parents:
diff changeset
    33
// the rest of the system.
489c9b5090e2 Initial load
duke
parents:
diff changeset
    34
13195
be27e1b6a4b9 6995781: Native Memory Tracking (Phase 1)
zgu
parents: 12268
diff changeset
    35
class BarrierSet: public CHeapObj<mtGC> {
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
    36
  friend class VMStructs;
489c9b5090e2 Initial load
duke
parents:
diff changeset
    37
public:
29325
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    38
  // Fake RTTI support.  For a derived class T to participate
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    39
  // - T must have a corresponding Name entry.
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    40
  // - GetName<T> must be specialized to return the corresponding Name
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    41
  //   entry.
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    42
  // - If T is a base class, the constructor must have a FakeRtti
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    43
  //   parameter and pass it up to its base class, with the tag set
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    44
  //   augmented with the corresponding Name entry.
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    45
  // - If T is a concrete class, the constructor must create a
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    46
  //   FakeRtti object whose tag set includes the corresponding Name
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    47
  //   entry, and pass it up to its base class.
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    48
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    49
  enum Name {                   // associated class
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    50
    ModRef,                     // ModRefBarrierSet
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    51
    CardTableModRef,            // CardTableModRefBS
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    52
    CardTableForRS,             // CardTableModRefBSForCTRS
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    53
    CardTableExtension,         // CardTableExtension
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    54
    G1SATBCT,                   // G1SATBCardTableModRefBS
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    55
    G1SATBCTLogging             // G1SATBCardTableLoggingModRefBS
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
    56
  };
489c9b5090e2 Initial load
duke
parents:
diff changeset
    57
29325
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    58
protected:
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    59
  typedef FakeRttiSupport<BarrierSet, Name> FakeRtti;
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    60
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    61
private:
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    62
  FakeRtti _fake_rtti;
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    63
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    64
  // Metafunction mapping a class derived from BarrierSet to the
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    65
  // corresponding Name enum tag.
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    66
  template<typename T> struct GetName;
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    67
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    68
  // Downcast argument to a derived barrier set type.
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    69
  // The cast is checked in a debug build.
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    70
  // T must have a specialization for BarrierSet::GetName<T>.
29331
b788134d664a 8074319: barrier_set_cast defined via friend injection
jwilhelm
parents: 29325
diff changeset
    71
  template<typename T> friend T* barrier_set_cast(BarrierSet* bs);
29325
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    72
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    73
public:
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    74
  // Note: This is not presently the Name corresponding to the
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    75
  // concrete class of this object.
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    76
  BarrierSet::Name kind() const { return _fake_rtti.concrete_tag(); }
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    77
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    78
  // Test whether this object is of the type corresponding to bsn.
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    79
  bool is_a(BarrierSet::Name bsn) const { return _fake_rtti.has_tag(bsn); }
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    80
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    81
  // End of fake RTTI support.
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    82
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
    83
protected:
29325
0e86e64c66e5 8069016: Add BarrierSet downcast support
kbarrett
parents: 29081
diff changeset
    84
  BarrierSet(const FakeRtti& fake_rtti) : _fake_rtti(fake_rtti) { }
28830
a252e278c3d9 8064947: Clean up BarrierSet ctor/dtor
jprovino
parents: 27687
diff changeset
    85
  ~BarrierSet() { }
a252e278c3d9 8064947: Clean up BarrierSet ctor/dtor
jprovino
parents: 27687
diff changeset
    86
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
    87
public:
489c9b5090e2 Initial load
duke
parents:
diff changeset
    88
  // Invoke the barrier, if any, necessary when writing "new_val" into the
489c9b5090e2 Initial load
duke
parents:
diff changeset
    89
  // ref field at "offset" in "obj".
489c9b5090e2 Initial load
duke
parents:
diff changeset
    90
  // (For efficiency reasons, this operation is specialized for certain
489c9b5090e2 Initial load
duke
parents:
diff changeset
    91
  // barrier types.  Semantically, it should be thought of as a call to the
489c9b5090e2 Initial load
duke
parents:
diff changeset
    92
  // virtual "_work" function below, which must implement the barrier.)
1374
4c24294029a9 6711316: Open source the Garbage-First garbage collector
ysr
parents: 360
diff changeset
    93
  // First the pre-write versions...
3262
30d1c247fc25 6700789: G1: Enable use of compressed oops with G1 heaps
ysr
parents: 1388
diff changeset
    94
  template <class T> inline void write_ref_field_pre(T* field, oop new_val);
1374
4c24294029a9 6711316: Open source the Garbage-First garbage collector
ysr
parents: 360
diff changeset
    95
4c24294029a9 6711316: Open source the Garbage-First garbage collector
ysr
parents: 360
diff changeset
    96
  // ...then the post-write version.
22859
7b88983393b7 8029396: PPC64 (part 212): Several memory ordering fixes in C-code.
goetz
parents: 13728
diff changeset
    97
  inline void write_ref_field(void* field, oop new_val, bool release = false);
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
    98
47658
c2b7fb8e5144 8189355: Cleanup of BarrierSet barrier functions
eosterlund
parents: 47216
diff changeset
    99
protected:
c2b7fb8e5144 8189355: Cleanup of BarrierSet barrier functions
eosterlund
parents: 47216
diff changeset
   100
  virtual void write_ref_field_pre_work(      oop* field, oop new_val) {};
c2b7fb8e5144 8189355: Cleanup of BarrierSet barrier functions
eosterlund
parents: 47216
diff changeset
   101
  virtual void write_ref_field_pre_work(narrowOop* field, oop new_val) {};
c2b7fb8e5144 8189355: Cleanup of BarrierSet barrier functions
eosterlund
parents: 47216
diff changeset
   102
  virtual void write_ref_field_work(void* field, oop new_val, bool release) = 0;
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
   103
47658
c2b7fb8e5144 8189355: Cleanup of BarrierSet barrier functions
eosterlund
parents: 47216
diff changeset
   104
public:
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
   105
  // Operations on arrays, or general regions (e.g., for "clone") may be
489c9b5090e2 Initial load
duke
parents:
diff changeset
   106
  // optimized by some barriers.
489c9b5090e2 Initial load
duke
parents:
diff changeset
   107
4461
c17c526d36ef 6906727: UseCompressedOops: some card-marking fixes related to object arrays
ysr
parents: 3262
diff changeset
   108
  // Below length is the # array elements being written
8498
6398004126b9 6627983: G1: Bad oop deference during marking
iveresov
parents: 7397
diff changeset
   109
  virtual void write_ref_array_pre(oop* dst, int length,
6398004126b9 6627983: G1: Bad oop deference during marking
iveresov
parents: 7397
diff changeset
   110
                                   bool dest_uninitialized = false) {}
6398004126b9 6627983: G1: Bad oop deference during marking
iveresov
parents: 7397
diff changeset
   111
  virtual void write_ref_array_pre(narrowOop* dst, int length,
6398004126b9 6627983: G1: Bad oop deference during marking
iveresov
parents: 7397
diff changeset
   112
                                   bool dest_uninitialized = false) {}
4461
c17c526d36ef 6906727: UseCompressedOops: some card-marking fixes related to object arrays
ysr
parents: 3262
diff changeset
   113
  // Below count is the # array elements being written, starting
c17c526d36ef 6906727: UseCompressedOops: some card-marking fixes related to object arrays
ysr
parents: 3262
diff changeset
   114
  // at the address "start", which may not necessarily be HeapWord-aligned
c17c526d36ef 6906727: UseCompressedOops: some card-marking fixes related to object arrays
ysr
parents: 3262
diff changeset
   115
  inline void write_ref_array(HeapWord* start, size_t count);
1374
4c24294029a9 6711316: Open source the Garbage-First garbage collector
ysr
parents: 360
diff changeset
   116
4461
c17c526d36ef 6906727: UseCompressedOops: some card-marking fixes related to object arrays
ysr
parents: 3262
diff changeset
   117
  // Static versions, suitable for calling from generated code;
c17c526d36ef 6906727: UseCompressedOops: some card-marking fixes related to object arrays
ysr
parents: 3262
diff changeset
   118
  // count is # array elements being written, starting with "start",
c17c526d36ef 6906727: UseCompressedOops: some card-marking fixes related to object arrays
ysr
parents: 3262
diff changeset
   119
  // which may not necessarily be HeapWord-aligned.
1374
4c24294029a9 6711316: Open source the Garbage-First garbage collector
ysr
parents: 360
diff changeset
   120
  static void static_write_ref_array_pre(HeapWord* start, size_t count);
4c24294029a9 6711316: Open source the Garbage-First garbage collector
ysr
parents: 360
diff changeset
   121
  static void static_write_ref_array_post(HeapWord* start, size_t count);
4c24294029a9 6711316: Open source the Garbage-First garbage collector
ysr
parents: 360
diff changeset
   122
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
   123
protected:
489c9b5090e2 Initial load
duke
parents:
diff changeset
   124
  virtual void write_ref_array_work(MemRegion mr) = 0;
47658
c2b7fb8e5144 8189355: Cleanup of BarrierSet barrier functions
eosterlund
parents: 47216
diff changeset
   125
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
   126
public:
489c9b5090e2 Initial load
duke
parents:
diff changeset
   127
  // (For efficiency reasons, this operation is specialized for certain
489c9b5090e2 Initial load
duke
parents:
diff changeset
   128
  // barrier types.  Semantically, it should be thought of as a call to the
489c9b5090e2 Initial load
duke
parents:
diff changeset
   129
  // virtual "_work" function below, which must implement the barrier.)
29081
c61eb4914428 8072911: Remove includes of oop.inline.hpp from .hpp files
stefank
parents: 28837
diff changeset
   130
  void write_region(MemRegion mr);
47658
c2b7fb8e5144 8189355: Cleanup of BarrierSet barrier functions
eosterlund
parents: 47216
diff changeset
   131
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
   132
protected:
489c9b5090e2 Initial load
duke
parents:
diff changeset
   133
  virtual void write_region_work(MemRegion mr) = 0;
47658
c2b7fb8e5144 8189355: Cleanup of BarrierSet barrier functions
eosterlund
parents: 47216
diff changeset
   134
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
   135
public:
489c9b5090e2 Initial load
duke
parents:
diff changeset
   136
  // Inform the BarrierSet that the the covered heap region that starts
489c9b5090e2 Initial load
duke
parents:
diff changeset
   137
  // with "base" has been changed to have the given size (possibly from 0,
489c9b5090e2 Initial load
duke
parents:
diff changeset
   138
  // for initialization.)
489c9b5090e2 Initial load
duke
parents:
diff changeset
   139
  virtual void resize_covered_region(MemRegion new_region) = 0;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   140
489c9b5090e2 Initial load
duke
parents:
diff changeset
   141
  // If the barrier set imposes any alignment restrictions on boundaries
489c9b5090e2 Initial load
duke
parents:
diff changeset
   142
  // within the heap, this function tells whether they are met.
489c9b5090e2 Initial load
duke
parents:
diff changeset
   143
  virtual bool is_aligned(HeapWord* addr) = 0;
489c9b5090e2 Initial load
duke
parents:
diff changeset
   144
12268
f7897aacb9ce 7157141: crash in 64 bit with corrupted oops
never
parents: 8498
diff changeset
   145
  // Print a description of the memory for the barrier set
f7897aacb9ce 7157141: crash in 64 bit with corrupted oops
never
parents: 8498
diff changeset
   146
  virtual void print_on(outputStream* st) const = 0;
1
489c9b5090e2 Initial load
duke
parents:
diff changeset
   147
};
7397
5b173b4ca846 6989984: Use standard include model for Hospot
stefank
parents: 5547
diff changeset
   148
29331
b788134d664a 8074319: barrier_set_cast defined via friend injection
jwilhelm
parents: 29325
diff changeset
   149
template<typename T>
b788134d664a 8074319: barrier_set_cast defined via friend injection
jwilhelm
parents: 29325
diff changeset
   150
inline T* barrier_set_cast(BarrierSet* bs) {
b788134d664a 8074319: barrier_set_cast defined via friend injection
jwilhelm
parents: 29325
diff changeset
   151
  assert(bs->is_a(BarrierSet::GetName<T>::value), "wrong type of barrier set");
b788134d664a 8074319: barrier_set_cast defined via friend injection
jwilhelm
parents: 29325
diff changeset
   152
  return static_cast<T*>(bs);
b788134d664a 8074319: barrier_set_cast defined via friend injection
jwilhelm
parents: 29325
diff changeset
   153
}
b788134d664a 8074319: barrier_set_cast defined via friend injection
jwilhelm
parents: 29325
diff changeset
   154
30764
fec48bf5a827 8079792: GC directory structure cleanup
pliden
parents: 29331
diff changeset
   155
#endif // SHARE_VM_GC_SHARED_BARRIERSET_HPP