1 /*
   2  * Copyright (c) 2012, 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_OOPS_ANNOTATIONS_HPP
  26 #define SHARE_VM_OOPS_ANNOTATIONS_HPP
  27 
  28 #include "oops/array.hpp"
  29 #include "oops/metadata.hpp"
  30 #include "runtime/handles.hpp"
  31 #include "utilities/exceptions.hpp"
  32 #include "utilities/globalDefinitions.hpp"
  33 
  34 
  35 class ClassLoaderData;
  36 class outputStream;
  37 class KlassSizeStats;
  38 
  39 typedef Array<u1> AnnotationArray;
  40 
  41 // Class to hold the various types of annotations. The only metadata that points
  42 // to this is InstanceKlass, or another Annotations instance if this is a
  43 // a type_annotation instance.
  44 
  45 class Annotations: public MetaspaceObj {
  46   // If you add a new field that points to any metaspace object, you
  47   // must add this field to Annotations::metaspace_pointers_do().
  48 
  49   // Annotations for this class, or null if none.
  50   AnnotationArray*             _class_annotations;
  51   // Annotation objects (byte arrays) for fields, or null if no annotations.
  52   // Indices correspond to entries (not indices) in fields array.
  53   Array<AnnotationArray*>*     _fields_annotations;
  54   // Type annotations for this class, or null if none.
  55   AnnotationArray*             _class_type_annotations;
  56   Array<AnnotationArray*>*     _fields_type_annotations;
  57 
  58  public:
  59   // Allocate instance of this class
  60   static Annotations* allocate(ClassLoaderData* loader_data, TRAPS);
  61 
  62   static void free_contents(ClassLoaderData* loader_data, Array<AnnotationArray*>* p);
  63   void deallocate_contents(ClassLoaderData* loader_data);
  64   DEBUG_ONLY(bool on_stack() { return false; })  // for template
  65 
  66   // Sizing (in words)
  67   static int size()    { return sizeof(Annotations) / wordSize; }
  68 
  69   // Annotations should be stored in the read-only region of CDS archive.
  70   static bool is_read_only_by_default() { return true; }
  71 
  72 #if INCLUDE_SERVICES
  73   void collect_statistics(KlassSizeStats *sz) const;
  74 #endif
  75 
  76   // Constructor to initialize to null
  77   Annotations() : _class_annotations(NULL),
  78                   _fields_annotations(NULL),
  79                   _class_type_annotations(NULL),
  80                   _fields_type_annotations(NULL) {}
  81 
  82   AnnotationArray* class_annotations() const                       { return _class_annotations; }
  83   Array<AnnotationArray*>* fields_annotations() const              { return _fields_annotations; }
  84   AnnotationArray* class_type_annotations() const                  { return _class_type_annotations; }
  85   Array<AnnotationArray*>* fields_type_annotations() const         { return _fields_type_annotations; }
  86 
  87   void set_class_annotations(AnnotationArray* md)                     { _class_annotations = md; }
  88   void set_fields_annotations(Array<AnnotationArray*>* md)            { _fields_annotations = md; }
  89   void set_class_type_annotations(AnnotationArray* cta)               { _class_type_annotations = cta; }
  90   void set_fields_type_annotations(Array<AnnotationArray*>* fta)      { _fields_type_annotations = fta; }
  91 
  92   // Turn metadata annotations into a Java heap object (oop)
  93   static typeArrayOop make_java_array(AnnotationArray* annotations, TRAPS);
  94 
  95   bool is_klass() const { return false; }
  96   void metaspace_pointers_do(MetaspaceClosure* it);
  97   MetaspaceObj::Type type() const { return AnnotationsType; }
  98 
  99  private:
 100   static julong count_bytes(Array<AnnotationArray*>* p);
 101  public:
 102   const char* internal_name() const { return "{constant pool}"; }
 103 #ifndef PRODUCT
 104   void print_on(outputStream* st) const;
 105 #endif
 106   void print_value_on(outputStream* st) const;
 107 };
 108 #endif // SHARE_VM_OOPS_ANNOTATIONS_HPP