1 /*
   2  * Copyright (c) 2001, 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #ifndef SHARE_VM_GC_SHARED_SPECIALIZED_OOP_CLOSURES_HPP
  26 #define SHARE_VM_GC_SHARED_SPECIALIZED_OOP_CLOSURES_HPP
  27 
  28 #include "utilities/macros.hpp"
  29 #if INCLUDE_ALL_GCS
  30 #include "gc/g1/g1_specialized_oop_closures.hpp"
  31 #endif // INCLUDE_ALL_GCS
  32 
  33 // The following OopClosure types get specialized versions of
  34 // "oop_oop_iterate" that invoke the closures' do_oop methods
  35 // non-virtually, using a mechanism defined in this file.  Extend these
  36 // macros in the obvious way to add specializations for new closures.
  37 
  38 // Forward declarations.
  39 class OopClosure;
  40 class OopsInGenClosure;
  41 // DefNew
  42 class ScanClosure;
  43 class FastScanClosure;
  44 class FilteringClosure;
  45 // MarkSweep
  46 class MarkAndPushClosure;
  47 class AdjustPointerClosure;
  48 // ParNew
  49 class ParScanWithBarrierClosure;
  50 class ParScanWithoutBarrierClosure;
  51 // CMS
  52 class MarkRefsIntoAndScanClosure;
  53 class ParMarkRefsIntoAndScanClosure;
  54 class PushAndMarkClosure;
  55 class ParPushAndMarkClosure;
  56 class PushOrMarkClosure;
  57 class ParPushOrMarkClosure;
  58 class CMSKeepAliveClosure;
  59 class CMSInnerParMarkAndPushClosure;
  60 // Misc
  61 class NoHeaderExtendedOopClosure;
  62 
  63 // This macro applies an argument macro to all OopClosures for which we
  64 // want specialized bodies of "oop_oop_iterate".  The arguments to "f" are:
  65 //   "f(closureType, non_virtual)"
  66 // where "closureType" is the name of the particular subclass of ExtendedOopClosure,
  67 // and "non_virtual" will be the string "_nv" if the closure type should
  68 // have its "do_oop" method invoked non-virtually, or else the
  69 // string "_v".  ("ExtendedOopClosure" itself will be the only class in the latter
  70 // category.)
  71 
  72 // This is split into several because of a Visual C++ 6.0 compiler bug
  73 // where very long macros cause the compiler to crash
  74 
  75 #define SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_S(f)       \
  76   f(ScanClosure,_nv)                                    \
  77   f(FastScanClosure,_nv)                                \
  78   f(FilteringClosure,_nv)
  79 
  80 #if INCLUDE_ALL_GCS
  81 #define SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_P(f)       \
  82   f(ParScanWithBarrierClosure,_nv)                      \
  83   f(ParScanWithoutBarrierClosure,_nv)
  84 #else  // INCLUDE_ALL_GCS
  85 #define SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_P(f)
  86 #endif // INCLUDE_ALL_GCS
  87 
  88 #define SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_1(f)       \
  89   f(NoHeaderExtendedOopClosure,_nv)                     \
  90   SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_S(f)             \
  91   SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_P(f)
  92 
  93 #define SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_MS(f)      \
  94   f(MarkAndPushClosure,_nv)                             \
  95   f(AdjustPointerClosure, _nv)
  96 
  97 #if INCLUDE_ALL_GCS
  98 #define SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_CMS(f)     \
  99   f(MarkRefsIntoAndScanClosure,_nv)                     \
 100   f(ParMarkRefsIntoAndScanClosure,_nv)                  \
 101   f(PushAndMarkClosure,_nv)                             \
 102   f(ParPushAndMarkClosure,_nv)                          \
 103   f(PushOrMarkClosure,_nv)                              \
 104   f(ParPushOrMarkClosure,_nv)                           \
 105   f(CMSKeepAliveClosure,_nv)                            \
 106   f(CMSInnerParMarkAndPushClosure,_nv)
 107 #endif
 108 
 109 #if INCLUDE_ALL_GCS
 110 #define SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_2(f)       \
 111   SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_MS(f)            \
 112   SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_CMS(f)           \
 113   SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_G1(f)
 114 #else  // INCLUDE_ALL_GCS
 115 #define SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_2(f)       \
 116   SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_MS(f)
 117 #endif // INCLUDE_ALL_GCS
 118 
 119 
 120 // We separate these out, because sometime the general one has
 121 // a different definition from the specialized ones, and sometimes it
 122 // doesn't.
 123 
 124 #define ALL_OOP_OOP_ITERATE_CLOSURES_1(f)               \
 125   f(ExtendedOopClosure,_v)                              \
 126   SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_1(f)
 127 
 128 #define ALL_OOP_OOP_ITERATE_CLOSURES_2(f)               \
 129   SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_2(f)
 130 
 131 #if INCLUDE_ALL_GCS
 132 // This macro applies an argument macro to all OopClosures for which we
 133 // want specialized bodies of a family of methods related to
 134 // "par_oop_iterate".  The arguments to f are the same as above.
 135 // The "root_class" is the most general class to define; this may be
 136 // "OopClosure" in some applications and "OopsInGenClosure" in others.
 137 
 138 #define SPECIALIZED_PAR_OOP_ITERATE_CLOSURES(f)        \
 139   f(MarkRefsIntoAndScanClosure,_nv)                    \
 140   f(PushAndMarkClosure,_nv)                            \
 141   f(ParMarkRefsIntoAndScanClosure,_nv)                 \
 142   f(ParPushAndMarkClosure,_nv)
 143 
 144 #define ALL_PAR_OOP_ITERATE_CLOSURES(f)                \
 145   f(ExtendedOopClosure,_v)                             \
 146   SPECIALIZED_PAR_OOP_ITERATE_CLOSURES(f)
 147 #endif // INCLUDE_ALL_GCS
 148 
 149 // This macro applies an argument macro to all OopClosures for which we
 150 // want specialized bodies of a family of methods related to
 151 // "oops_since_save_marks_do".  The arguments to f are the same as above.
 152 // The "root_class" is the most general class to define; this may be
 153 // "OopClosure" in some applications and "OopsInGenClosure" in others.
 154 
 155 #define SPECIALIZED_SINCE_SAVE_MARKS_CLOSURES_YOUNG_S(f) \
 156   f(ScanClosure,_nv)                                     \
 157   f(FastScanClosure,_nv)
 158 
 159 #if INCLUDE_ALL_GCS
 160 #define SPECIALIZED_SINCE_SAVE_MARKS_CLOSURES_YOUNG_P(f) \
 161   f(ParScanWithBarrierClosure,_nv)                       \
 162   f(ParScanWithoutBarrierClosure,_nv)
 163 #else  // INCLUDE_ALL_GCS
 164 #define SPECIALIZED_SINCE_SAVE_MARKS_CLOSURES_YOUNG_P(f)
 165 #endif // INCLUDE_ALL_GCS
 166 
 167 #define SPECIALIZED_SINCE_SAVE_MARKS_CLOSURES_YOUNG(f)  \
 168   SPECIALIZED_SINCE_SAVE_MARKS_CLOSURES_YOUNG_S(f)      \
 169   SPECIALIZED_SINCE_SAVE_MARKS_CLOSURES_YOUNG_P(f)
 170 
 171 #define SPECIALIZED_SINCE_SAVE_MARKS_CLOSURES(f)        \
 172   SPECIALIZED_SINCE_SAVE_MARKS_CLOSURES_YOUNG(f)
 173 
 174 // We separate these out, because sometime the general one has
 175 // a different definition from the specialized ones, and sometimes it
 176 // doesn't.
 177 
 178 #define ALL_SINCE_SAVE_MARKS_CLOSURES(f)                \
 179   f(OopsInGenClosure,_v)                                \
 180   SPECIALIZED_SINCE_SAVE_MARKS_CLOSURES(f)
 181 
 182 #endif // SHARE_VM_GC_SHARED_SPECIALIZED_OOP_CLOSURES_HPP