1 /*
   2  * Copyright (c) 2001, 2017, 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_CMSGC
  30 #include "gc/cms/cms_specialized_oop_closures.hpp"
  31 #endif
  32 #if INCLUDE_G1GC
  33 #include "gc/g1/g1_specialized_oop_closures.hpp"
  34 #endif
  35 #if INCLUDE_SERIALGC
  36 #include "gc/serial/serial_specialized_oop_closures.hpp"
  37 #endif
  38 
  39 // The following OopClosure types get specialized versions of
  40 // "oop_oop_iterate" that invoke the closures' do_oop methods
  41 // non-virtually, using a mechanism defined in this file.  Extend these
  42 // macros in the obvious way to add specializations for new closures.
  43 
  44 // Forward declarations.
  45 class ExtendedOopClosure;
  46 class NoHeaderExtendedOopClosure;
  47 class OopsInGenClosure;
  48 
  49 // This macro applies an argument macro to all OopClosures for which we
  50 // want specialized bodies of "oop_oop_iterate".  The arguments to "f" are:
  51 //   "f(closureType, non_virtual)"
  52 // where "closureType" is the name of the particular subclass of ExtendedOopClosure,
  53 // and "non_virtual" will be the string "_nv" if the closure type should
  54 // have its "do_oop" method invoked non-virtually, or else the
  55 // string "_v".  ("ExtendedOopClosure" itself will be the only class in the latter
  56 // category.)
  57 
  58 // This is split into several because of a Visual C++ 6.0 compiler bug
  59 // where very long macros cause the compiler to crash
  60 
  61 #define SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_1(f)                 \
  62   f(NoHeaderExtendedOopClosure,_nv)                               \
  63   SERIALGC_ONLY(SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_S(f))        \
  64      CMSGC_ONLY(SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_P(f))
  65 
  66 #define SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_2(f)                 \
  67   SERIALGC_ONLY(SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_MS(f))       \
  68      CMSGC_ONLY(SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_CMS(f))      \
  69       G1GC_ONLY(SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_G1(f))       \
  70       G1GC_ONLY(SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_G1FULL(f))
  71 
  72 // We separate these out, because sometime the general one has
  73 // a different definition from the specialized ones, and sometimes it
  74 // doesn't.
  75 
  76 #define ALL_OOP_OOP_ITERATE_CLOSURES_1(f)                         \
  77   f(ExtendedOopClosure,_v)                                        \
  78   SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_1(f)
  79 
  80 #define ALL_OOP_OOP_ITERATE_CLOSURES_2(f)                         \
  81   SPECIALIZED_OOP_OOP_ITERATE_CLOSURES_2(f)
  82 
  83 // This macro applies an argument macro to all OopClosures for which we
  84 // want specialized bodies of a family of methods related to
  85 // "par_oop_iterate".  The arguments to f are the same as above.
  86 // The "root_class" is the most general class to define; this may be
  87 // "OopClosure" in some applications and "OopsInGenClosure" in others.
  88 
  89 
  90 #define ALL_PAR_OOP_ITERATE_CLOSURES(f)                           \
  91   f(ExtendedOopClosure,_v)                                        \
  92   CMSGC_ONLY(SPECIALIZED_PAR_OOP_ITERATE_CLOSURES(f))
  93 
  94 #endif // SHARE_VM_GC_SHARED_SPECIALIZED_OOP_CLOSURES_HPP