1 /*
  2  * Copyright (c) 1997, 2021, 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_UTILITIES_CONSTANTTAG_HPP
 26 #define SHARE_UTILITIES_CONSTANTTAG_HPP
 27 
 28 #include "utilities/globalDefinitions.hpp"
 29 
 30 
 31 class outputStream;
 32 
 33 // constant tags in Java .class files
 34 
 35 enum {
 36   // See jvm.h for shared JVM_CONSTANT_XXX tags
 37   // NOTE: replicated in SA in vm/agent/sun/jvm/hotspot/utilities/ConstantTag.java
 38   // Hotspot specific tags
 39   JVM_CONSTANT_Invalid                  = 0,    // For bad value initialization
 40   JVM_CONSTANT_InternalMin              = 100,  // First implementation tag (aside from bad value of course)
 41   JVM_CONSTANT_UnresolvedClass          = 100,  // Temporary tag until actual use
 42   JVM_CONSTANT_ClassIndex               = 101,  // Temporary tag while constructing constant pool
 43   JVM_CONSTANT_StringIndex              = 102,  // Temporary tag while constructing constant pool
 44   JVM_CONSTANT_UnresolvedClassInError   = 103,  // Error tag due to resolution error
 45   JVM_CONSTANT_MethodHandleInError      = 104,  // Error tag due to resolution error
 46   JVM_CONSTANT_MethodTypeInError        = 105,  // Error tag due to resolution error
 47   JVM_CONSTANT_DynamicInError           = 106,  // Error tag due to resolution error
 48   JVM_CONSTANT_InternalMax              = 106   // Last implementation tag
 49 };
 50 
 51 
 52 class constantTag {
 53  private:
 54   jbyte _tag;
 55  public:
 56   bool is_klass() const             { return _tag == JVM_CONSTANT_Class; }
 57   bool is_field () const            { return _tag == JVM_CONSTANT_Fieldref; }
 58   bool is_method() const            { return _tag == JVM_CONSTANT_Methodref; }
 59   bool is_interface_method() const  { return _tag == JVM_CONSTANT_InterfaceMethodref; }
 60   bool is_string() const            { return _tag == JVM_CONSTANT_String; }
 61   bool is_int() const               { return _tag == JVM_CONSTANT_Integer; }
 62   bool is_float() const             { return _tag == JVM_CONSTANT_Float; }
 63   bool is_long() const              { return _tag == JVM_CONSTANT_Long; }
 64   bool is_double() const            { return _tag == JVM_CONSTANT_Double; }
 65   bool is_name_and_type() const     { return _tag == JVM_CONSTANT_NameAndType; }
 66   bool is_utf8() const              { return _tag == JVM_CONSTANT_Utf8; }
 67 
 68   bool is_invalid() const           { return _tag == JVM_CONSTANT_Invalid; }
 69 
 70   bool is_unresolved_klass() const {
 71     return _tag == JVM_CONSTANT_UnresolvedClass || _tag == JVM_CONSTANT_UnresolvedClassInError;
 72   }
 73 
 74   bool is_unresolved_klass_in_error() const {
 75     return _tag == JVM_CONSTANT_UnresolvedClassInError;
 76   }
 77 
 78   bool is_method_handle_in_error() const {
 79     return _tag == JVM_CONSTANT_MethodHandleInError;
 80   }
 81   bool is_method_type_in_error() const {
 82     return _tag == JVM_CONSTANT_MethodTypeInError;
 83   }
 84 
 85   bool is_dynamic_constant_in_error() const {
 86     return _tag == JVM_CONSTANT_DynamicInError;
 87   }
 88 
 89   bool is_klass_index() const       { return _tag == JVM_CONSTANT_ClassIndex; }
 90   bool is_string_index() const      { return _tag == JVM_CONSTANT_StringIndex; }
 91 
 92   bool is_klass_reference() const   { return is_klass_index() || is_unresolved_klass(); }
 93   bool is_klass_or_reference() const{ return is_klass() || is_klass_reference(); }
 94   bool is_field_or_method() const   { return is_field() || is_method() || is_interface_method(); }
 95   bool is_symbol() const            { return is_utf8(); }
 96 
 97   bool is_method_type() const       { return _tag == JVM_CONSTANT_MethodType; }
 98   bool is_method_handle() const     { return _tag == JVM_CONSTANT_MethodHandle; }
 99   bool is_dynamic_constant() const  { return _tag == JVM_CONSTANT_Dynamic; }
100   bool is_invoke_dynamic() const    { return _tag == JVM_CONSTANT_InvokeDynamic; }
101 
102   bool has_bootstrap() const {
103     return (_tag == JVM_CONSTANT_Dynamic ||
104             _tag == JVM_CONSTANT_DynamicInError ||
105             _tag == JVM_CONSTANT_InvokeDynamic);
106   }
107 
108   bool is_loadable_constant() const {
109     return ((_tag >= JVM_CONSTANT_Integer && _tag <= JVM_CONSTANT_String) ||
110             is_method_type() || is_method_handle() || is_dynamic_constant() ||
111             is_unresolved_klass());
112   }
113 
114   constantTag() {
115     _tag = JVM_CONSTANT_Invalid;
116   }
117   constantTag(jbyte tag) {
118     assert((tag >= 0 && tag <= JVM_CONSTANT_NameAndType) ||
119            (tag >= JVM_CONSTANT_MethodHandle && tag <= JVM_CONSTANT_InvokeDynamic) ||
120            (tag >= JVM_CONSTANT_InternalMin && tag <= JVM_CONSTANT_InternalMax), "Invalid constant tag");
121     _tag = tag;
122   }
123 
124   static constantTag ofBasicType(BasicType bt) {
125     if (is_subword_type(bt))  bt = T_INT;
126     switch (bt) {
127       case T_OBJECT: return constantTag(JVM_CONSTANT_String);
128       case T_INT:    return constantTag(JVM_CONSTANT_Integer);
129       case T_LONG:   return constantTag(JVM_CONSTANT_Long);
130       case T_FLOAT:  return constantTag(JVM_CONSTANT_Float);
131       case T_DOUBLE: return constantTag(JVM_CONSTANT_Double);
132       default:       break;
133     }
134     assert(false, "bad basic type for tag");
135     return constantTag();
136   }
137 
138   jbyte value() const                { return _tag; }
139   jbyte error_value() const;
140   jbyte non_error_value() const;
141 
142   BasicType basic_type() const;        // if used with ldc, what kind of value gets pushed?
143 
144   const char* internal_name() const;  // for error reporting
145 
146   void print_on(outputStream* st) const PRODUCT_RETURN;
147 };
148 
149 #endif // SHARE_UTILITIES_CONSTANTTAG_HPP