1 /*
   2  * Copyright (c) 1997, 2018, 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_UTILITIES_ACCESSFLAGS_HPP
  26 #define SHARE_VM_UTILITIES_ACCESSFLAGS_HPP
  27 
  28 #include "jvm.h"
  29 #include "memory/allocation.hpp"
  30 #include "utilities/macros.hpp"
  31 
  32 // AccessFlags is an abstraction over Java access flags.
  33 
  34 
  35 enum {
  36   // See jvm.h for shared JVM_ACC_XXX access flags
  37 
  38   // HotSpot-specific access flags
  39 
  40   // flags actually put in .class file
  41   JVM_ACC_WRITTEN_FLAGS           = 0x00007FFF,
  42 
  43   // Method* flags
  44   JVM_ACC_MONITOR_MATCH           = 0x10000000,     // True if we know that monitorenter/monitorexit bytecodes match
  45   JVM_ACC_HAS_MONITOR_BYTECODES   = 0x20000000,     // Method contains monitorenter/monitorexit bytecodes
  46   JVM_ACC_HAS_LOOPS               = 0x40000000,     // Method has loops
  47   JVM_ACC_LOOPS_FLAG_INIT         = (int)0x80000000,// The loop flag has been initialized
  48   JVM_ACC_QUEUED                  = 0x01000000,     // Queued for compilation
  49   JVM_ACC_NOT_C2_COMPILABLE       = 0x02000000,
  50   JVM_ACC_NOT_C1_COMPILABLE       = 0x04000000,
  51   JVM_ACC_NOT_C2_OSR_COMPILABLE   = 0x08000000,
  52   JVM_ACC_HAS_LINE_NUMBER_TABLE   = 0x00100000,
  53   JVM_ACC_HAS_CHECKED_EXCEPTIONS  = 0x00400000,
  54   JVM_ACC_HAS_JSRS                = 0x00800000,
  55   JVM_ACC_IS_OLD                  = 0x00010000,     // RedefineClasses() has replaced this method
  56   JVM_ACC_IS_OBSOLETE             = 0x00020000,     // RedefineClasses() has made method obsolete
  57   JVM_ACC_IS_PREFIXED_NATIVE      = 0x00040000,     // JVMTI has prefixed this native method
  58   JVM_ACC_ON_STACK                = 0x00080000,     // RedefineClasses() was used on the stack
  59   JVM_ACC_IS_DELETED              = 0x00008000,     // RedefineClasses() has deleted this method
  60 
  61   // Klass* flags
  62   JVM_ACC_HAS_MIRANDA_METHODS     = 0x10000000,     // True if this class has miranda methods in it's vtable
  63   JVM_ACC_HAS_VANILLA_CONSTRUCTOR = 0x20000000,     // True if klass has a vanilla default constructor
  64   JVM_ACC_HAS_FINALIZER           = 0x40000000,     // True if klass has a non-empty finalize() method
  65   JVM_ACC_IS_CLONEABLE_FAST       = (int)0x80000000,// True if klass implements the Cloneable interface and can be optimized in generated code
  66   JVM_ACC_HAS_FINAL_METHOD        = 0x01000000,     // True if klass has final method
  67   JVM_ACC_IS_SHARED_CLASS         = 0x02000000,     // True if klass is shared
  68 #if INCLUDE_VBC
  69   JVM_ACC_IS_VALUE_BASED_CLASS    = 0x04000000,     // True if klass is "value-based"
  70 #endif
  71   // Klass* and Method* flags
  72   JVM_ACC_HAS_LOCAL_VARIABLE_TABLE= 0x00200000,
  73 
  74   JVM_ACC_PROMOTED_FLAGS          = 0x00200000,     // flags promoted from methods to the holding klass
  75 
  76   // field flags
  77   // Note: these flags must be defined in the low order 16 bits because
  78   // InstanceKlass only stores a ushort worth of information from the
  79   // AccessFlags value.
  80   // These bits must not conflict with any other field-related access flags
  81   // (e.g., ACC_ENUM).
  82   // Note that the class-related ACC_ANNOTATION bit conflicts with these flags.
  83   JVM_ACC_FIELD_ACCESS_WATCHED            = 0x00002000, // field access is watched by JVMTI
  84   JVM_ACC_FIELD_MODIFICATION_WATCHED      = 0x00008000, // field modification is watched by JVMTI
  85   JVM_ACC_FIELD_INTERNAL                  = 0x00000400, // internal field, same as JVM_ACC_ABSTRACT
  86   JVM_ACC_FIELD_STABLE                    = 0x00000020, // @Stable field, same as JVM_ACC_SYNCHRONIZED and JVM_ACC_SUPER
  87   JVM_ACC_FIELD_INITIALIZED_FINAL_UPDATE  = 0x00000100, // (static) final field updated outside (class) initializer, same as JVM_ACC_NATIVE
  88   JVM_ACC_FIELD_HAS_GENERIC_SIGNATURE     = 0x00000800, // field has generic signature
  89 
  90   JVM_ACC_FIELD_INTERNAL_FLAGS       = JVM_ACC_FIELD_ACCESS_WATCHED |
  91                                        JVM_ACC_FIELD_MODIFICATION_WATCHED |
  92                                        JVM_ACC_FIELD_INTERNAL |
  93                                        JVM_ACC_FIELD_STABLE |
  94                                        JVM_ACC_FIELD_HAS_GENERIC_SIGNATURE,
  95 
  96                                                     // flags accepted by set_field_flags()
  97   JVM_ACC_FIELD_FLAGS                = JVM_RECOGNIZED_FIELD_MODIFIERS | JVM_ACC_FIELD_INTERNAL_FLAGS
  98 
  99 };
 100 
 101 
 102 class AccessFlags VALUE_OBJ_CLASS_SPEC {
 103   friend class VMStructs;
 104  private:
 105   jint _flags;
 106 
 107  public:
 108   AccessFlags() : _flags(0) {}
 109   explicit AccessFlags(jint flags) : _flags(flags) {}
 110 
 111   // Java access flags
 112   bool is_public      () const         { return (_flags & JVM_ACC_PUBLIC      ) != 0; }
 113   bool is_private     () const         { return (_flags & JVM_ACC_PRIVATE     ) != 0; }
 114   bool is_protected   () const         { return (_flags & JVM_ACC_PROTECTED   ) != 0; }
 115   bool is_static      () const         { return (_flags & JVM_ACC_STATIC      ) != 0; }
 116   bool is_final       () const         { return (_flags & JVM_ACC_FINAL       ) != 0; }
 117   bool is_synchronized() const         { return (_flags & JVM_ACC_SYNCHRONIZED) != 0; }
 118   bool is_super       () const         { return (_flags & JVM_ACC_SUPER       ) != 0; }
 119   bool is_volatile    () const         { return (_flags & JVM_ACC_VOLATILE    ) != 0; }
 120   bool is_transient   () const         { return (_flags & JVM_ACC_TRANSIENT   ) != 0; }
 121   bool is_native      () const         { return (_flags & JVM_ACC_NATIVE      ) != 0; }
 122   bool is_interface   () const         { return (_flags & JVM_ACC_INTERFACE   ) != 0; }
 123   bool is_abstract    () const         { return (_flags & JVM_ACC_ABSTRACT    ) != 0; }
 124   bool is_strict      () const         { return (_flags & JVM_ACC_STRICT      ) != 0; }
 125 
 126   // Attribute flags
 127   bool is_synthetic   () const         { return (_flags & JVM_ACC_SYNTHETIC   ) != 0; }
 128 
 129   // Method* flags
 130   bool is_monitor_matching     () const { return (_flags & JVM_ACC_MONITOR_MATCH          ) != 0; }
 131   bool has_monitor_bytecodes   () const { return (_flags & JVM_ACC_HAS_MONITOR_BYTECODES  ) != 0; }
 132   bool has_loops               () const { return (_flags & JVM_ACC_HAS_LOOPS              ) != 0; }
 133   bool loops_flag_init         () const { return (_flags & JVM_ACC_LOOPS_FLAG_INIT        ) != 0; }
 134   bool queued_for_compilation  () const { return (_flags & JVM_ACC_QUEUED                 ) != 0; }
 135   bool is_not_c1_compilable    () const { return (_flags & JVM_ACC_NOT_C1_COMPILABLE      ) != 0; }
 136   bool is_not_c2_compilable    () const { return (_flags & JVM_ACC_NOT_C2_COMPILABLE      ) != 0; }
 137   bool is_not_c2_osr_compilable() const { return (_flags & JVM_ACC_NOT_C2_OSR_COMPILABLE  ) != 0; }
 138   bool has_linenumber_table    () const { return (_flags & JVM_ACC_HAS_LINE_NUMBER_TABLE  ) != 0; }
 139   bool has_checked_exceptions  () const { return (_flags & JVM_ACC_HAS_CHECKED_EXCEPTIONS ) != 0; }
 140   bool has_jsrs                () const { return (_flags & JVM_ACC_HAS_JSRS               ) != 0; }
 141   bool is_old                  () const { return (_flags & JVM_ACC_IS_OLD                 ) != 0; }
 142   bool is_obsolete             () const { return (_flags & JVM_ACC_IS_OBSOLETE            ) != 0; }
 143   bool is_deleted              () const { return (_flags & JVM_ACC_IS_DELETED             ) != 0; }
 144   bool is_prefixed_native      () const { return (_flags & JVM_ACC_IS_PREFIXED_NATIVE     ) != 0; }
 145 
 146   // Klass* flags
 147   bool has_miranda_methods     () const { return (_flags & JVM_ACC_HAS_MIRANDA_METHODS    ) != 0; }
 148   bool has_vanilla_constructor () const { return (_flags & JVM_ACC_HAS_VANILLA_CONSTRUCTOR) != 0; }
 149   bool has_finalizer           () const { return (_flags & JVM_ACC_HAS_FINALIZER          ) != 0; }
 150   bool has_final_method        () const { return (_flags & JVM_ACC_HAS_FINAL_METHOD       ) != 0; }
 151   bool is_cloneable_fast       () const { return (_flags & JVM_ACC_IS_CLONEABLE_FAST      ) != 0; }
 152   bool is_shared_class         () const { return (_flags & JVM_ACC_IS_SHARED_CLASS        ) != 0; }
 153 #if INCLUDE_VBC
 154   bool is_value_based_class    () const { return (_flags & JVM_ACC_IS_VALUE_BASED_CLASS   ) != 0; }
 155 #endif
 156   // Klass* and Method* flags
 157   bool has_localvariable_table () const { return (_flags & JVM_ACC_HAS_LOCAL_VARIABLE_TABLE) != 0; }
 158   void set_has_localvariable_table()    { atomic_set_bits(JVM_ACC_HAS_LOCAL_VARIABLE_TABLE); }
 159   void clear_has_localvariable_table()  { atomic_clear_bits(JVM_ACC_HAS_LOCAL_VARIABLE_TABLE); }
 160 
 161   // field flags
 162   bool is_field_access_watched() const  { return (_flags & JVM_ACC_FIELD_ACCESS_WATCHED) != 0; }
 163   bool is_field_modification_watched() const
 164                                         { return (_flags & JVM_ACC_FIELD_MODIFICATION_WATCHED) != 0; }
 165   bool has_field_initialized_final_update() const
 166                                         { return (_flags & JVM_ACC_FIELD_INITIALIZED_FINAL_UPDATE) != 0; }
 167   bool on_stack() const                 { return (_flags & JVM_ACC_ON_STACK) != 0; }
 168   bool is_internal() const              { return (_flags & JVM_ACC_FIELD_INTERNAL) != 0; }
 169   bool is_stable() const                { return (_flags & JVM_ACC_FIELD_STABLE) != 0; }
 170   bool field_has_generic_signature() const
 171                                         { return (_flags & JVM_ACC_FIELD_HAS_GENERIC_SIGNATURE) != 0; }
 172 
 173   // get .class file flags
 174   jint get_flags               () const { return (_flags & JVM_ACC_WRITTEN_FLAGS); }
 175 
 176   // Initialization
 177   void add_promoted_flags(jint flags)   { _flags |= (flags & JVM_ACC_PROMOTED_FLAGS); }
 178   void set_field_flags(jint flags)      {
 179     assert((flags & JVM_ACC_FIELD_FLAGS) == flags, "only recognized flags");
 180     _flags = (flags & JVM_ACC_FIELD_FLAGS);
 181   }
 182   void set_flags(jint flags)            { _flags = (flags & JVM_ACC_WRITTEN_FLAGS); }
 183 
 184   void set_queued_for_compilation()    { atomic_set_bits(JVM_ACC_QUEUED); }
 185   void clear_queued_for_compilation()  { atomic_clear_bits(JVM_ACC_QUEUED); }
 186 
 187   // Atomic update of flags
 188   void atomic_set_bits(jint bits);
 189   void atomic_clear_bits(jint bits);
 190 
 191  private:
 192   friend class Method;
 193   friend class Klass;
 194   friend class ClassFileParser;
 195   // the functions below should only be called on the _access_flags inst var directly,
 196   // otherwise they are just changing a copy of the flags
 197 
 198   // attribute flags
 199   void set_is_synthetic()              { atomic_set_bits(JVM_ACC_SYNTHETIC);               }
 200 
 201   // Method* flags
 202   void set_monitor_matching()          { atomic_set_bits(JVM_ACC_MONITOR_MATCH);           }
 203   void set_has_monitor_bytecodes()     { atomic_set_bits(JVM_ACC_HAS_MONITOR_BYTECODES);   }
 204   void set_has_loops()                 { atomic_set_bits(JVM_ACC_HAS_LOOPS);               }
 205   void set_loops_flag_init()           { atomic_set_bits(JVM_ACC_LOOPS_FLAG_INIT);         }
 206   void set_not_c1_compilable()         { atomic_set_bits(JVM_ACC_NOT_C1_COMPILABLE);       }
 207   void set_not_c2_compilable()         { atomic_set_bits(JVM_ACC_NOT_C2_COMPILABLE);       }
 208   void set_not_c2_osr_compilable()     { atomic_set_bits(JVM_ACC_NOT_C2_OSR_COMPILABLE);   }
 209   void set_has_linenumber_table()      { atomic_set_bits(JVM_ACC_HAS_LINE_NUMBER_TABLE);   }
 210   void set_has_checked_exceptions()    { atomic_set_bits(JVM_ACC_HAS_CHECKED_EXCEPTIONS);  }
 211   void set_has_jsrs()                  { atomic_set_bits(JVM_ACC_HAS_JSRS);                }
 212   void set_is_old()                    { atomic_set_bits(JVM_ACC_IS_OLD);                  }
 213   void set_is_obsolete()               { atomic_set_bits(JVM_ACC_IS_OBSOLETE);             }
 214   void set_is_deleted()                { atomic_set_bits(JVM_ACC_IS_DELETED);              }
 215   void set_is_prefixed_native()        { atomic_set_bits(JVM_ACC_IS_PREFIXED_NATIVE);      }
 216 
 217   void clear_not_c1_compilable()       { atomic_clear_bits(JVM_ACC_NOT_C1_COMPILABLE);       }
 218   void clear_not_c2_compilable()       { atomic_clear_bits(JVM_ACC_NOT_C2_COMPILABLE);       }
 219   void clear_not_c2_osr_compilable()   { atomic_clear_bits(JVM_ACC_NOT_C2_OSR_COMPILABLE);   }
 220   // Klass* flags
 221   void set_has_vanilla_constructor()   { atomic_set_bits(JVM_ACC_HAS_VANILLA_CONSTRUCTOR); }
 222   void set_has_finalizer()             { atomic_set_bits(JVM_ACC_HAS_FINALIZER);           }
 223   void set_has_final_method()          { atomic_set_bits(JVM_ACC_HAS_FINAL_METHOD);        }
 224   void set_is_cloneable_fast()         { atomic_set_bits(JVM_ACC_IS_CLONEABLE_FAST);       }
 225   void set_has_miranda_methods()       { atomic_set_bits(JVM_ACC_HAS_MIRANDA_METHODS);     }
 226   void set_is_shared_class()           { atomic_set_bits(JVM_ACC_IS_SHARED_CLASS);         }
 227 #if INCLUDE_VBC
 228   void set_is_value_based_class()      { atomic_set_bits(JVM_ACC_IS_VALUE_BASED_CLASS);    }
 229 #endif
 230 
 231  public:
 232   // field flags
 233   void set_is_field_access_watched(const bool value)
 234                                        {
 235                                          if (value) {
 236                                            atomic_set_bits(JVM_ACC_FIELD_ACCESS_WATCHED);
 237                                          } else {
 238                                            atomic_clear_bits(JVM_ACC_FIELD_ACCESS_WATCHED);
 239                                          }
 240                                        }
 241   void set_is_field_modification_watched(const bool value)
 242                                        {
 243                                          if (value) {
 244                                            atomic_set_bits(JVM_ACC_FIELD_MODIFICATION_WATCHED);
 245                                          } else {
 246                                            atomic_clear_bits(JVM_ACC_FIELD_MODIFICATION_WATCHED);
 247                                          }
 248                                        }
 249 
 250   void set_has_field_initialized_final_update(const bool value) {
 251     if (value) {
 252       atomic_set_bits(JVM_ACC_FIELD_INITIALIZED_FINAL_UPDATE);
 253     } else {
 254       atomic_clear_bits(JVM_ACC_FIELD_INITIALIZED_FINAL_UPDATE);
 255     }
 256   }
 257 
 258   void set_field_has_generic_signature()
 259                                        {
 260                                          atomic_set_bits(JVM_ACC_FIELD_HAS_GENERIC_SIGNATURE);
 261                                        }
 262 
 263   void set_on_stack(const bool value)
 264                                        {
 265                                          if (value) {
 266                                            atomic_set_bits(JVM_ACC_ON_STACK);
 267                                          } else {
 268                                            atomic_clear_bits(JVM_ACC_ON_STACK);
 269                                          }
 270                                        }
 271   // Conversion
 272   jshort as_short() const              { return (jshort)_flags; }
 273   jint   as_int() const                { return _flags; }
 274 
 275   inline friend AccessFlags accessFlags_from(jint flags);
 276 
 277   // Printing/debugging
 278 #if INCLUDE_JVMTI
 279   void print_on(outputStream* st) const;
 280 #else
 281   void print_on(outputStream* st) const PRODUCT_RETURN;
 282 #endif
 283 };
 284 
 285 inline AccessFlags accessFlags_from(jint flags) {
 286   AccessFlags af;
 287   af._flags = flags;
 288   return af;
 289 }
 290 
 291 #endif // SHARE_VM_UTILITIES_ACCESSFLAGS_HPP