aoqi@0: /*
aoqi@0:  * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  *
aoqi@0:  */
aoqi@0: 
aoqi@0: #ifndef SHARE_VM_OOPS_ANNOTATIONS_HPP
aoqi@0: #define SHARE_VM_OOPS_ANNOTATIONS_HPP
aoqi@0: 
aoqi@0: #include "oops/metadata.hpp"
aoqi@0: #include "runtime/handles.hpp"
aoqi@0: #include "utilities/array.hpp"
aoqi@0: #include "utilities/exceptions.hpp"
aoqi@0: #include "utilities/globalDefinitions.hpp"
aoqi@0: 
aoqi@0: 
aoqi@0: class ClassLoaderData;
aoqi@0: class outputStream;
aoqi@0: class KlassSizeStats;
aoqi@0: 
aoqi@0: typedef Array<u1> AnnotationArray;
aoqi@0: 
aoqi@0: // Class to hold the various types of annotations. The only metadata that points
aoqi@0: // to this is InstanceKlass, or another Annotations instance if this is a
aoqi@0: // a type_annotation instance.
aoqi@0: 
aoqi@0: class Annotations: public MetaspaceObj {
aoqi@0: 
aoqi@0:   // Annotations for this class, or null if none.
aoqi@0:   AnnotationArray*             _class_annotations;
aoqi@0:   // Annotation objects (byte arrays) for fields, or null if no annotations.
aoqi@0:   // Indices correspond to entries (not indices) in fields array.
aoqi@0:   Array<AnnotationArray*>*     _fields_annotations;
aoqi@0:   // Type annotations for this class, or null if none.
aoqi@0:   AnnotationArray*             _class_type_annotations;
aoqi@0:   Array<AnnotationArray*>*     _fields_type_annotations;
aoqi@0: 
aoqi@0:  public:
aoqi@0:   // Allocate instance of this class
aoqi@0:   static Annotations* allocate(ClassLoaderData* loader_data, TRAPS);
aoqi@0: 
aoqi@0:   static void free_contents(ClassLoaderData* loader_data, Array<AnnotationArray*>* p);
aoqi@0:   void deallocate_contents(ClassLoaderData* loader_data);
aoqi@0:   DEBUG_ONLY(bool on_stack() { return false; })  // for template
aoqi@0: 
aoqi@0:   // Sizing (in words)
aoqi@0:   static int size()    { return sizeof(Annotations) / wordSize; }
aoqi@0: #if INCLUDE_SERVICES
aoqi@0:   void collect_statistics(KlassSizeStats *sz) const;
aoqi@0: #endif
aoqi@0: 
aoqi@0:   // Constructor to initialize to null
aoqi@0:   Annotations() : _class_annotations(NULL),
aoqi@0:                   _fields_annotations(NULL),
aoqi@0:                   _class_type_annotations(NULL),
aoqi@0:                   _fields_type_annotations(NULL) {}
aoqi@0: 
aoqi@0:   AnnotationArray* class_annotations() const                       { return _class_annotations; }
aoqi@0:   Array<AnnotationArray*>* fields_annotations() const              { return _fields_annotations; }
aoqi@0:   AnnotationArray* class_type_annotations() const                  { return _class_type_annotations; }
aoqi@0:   Array<AnnotationArray*>* fields_type_annotations() const         { return _fields_type_annotations; }
aoqi@0: 
aoqi@0:   void set_class_annotations(AnnotationArray* md)                     { _class_annotations = md; }
aoqi@0:   void set_fields_annotations(Array<AnnotationArray*>* md)            { _fields_annotations = md; }
aoqi@0:   void set_class_type_annotations(AnnotationArray* cta)               { _class_type_annotations = cta; }
aoqi@0:   void set_fields_type_annotations(Array<AnnotationArray*>* fta)      { _fields_type_annotations = fta; }
aoqi@0: 
aoqi@0:   // Turn metadata annotations into a Java heap object (oop)
aoqi@0:   static typeArrayOop make_java_array(AnnotationArray* annotations, TRAPS);
aoqi@0: 
aoqi@0:   bool is_klass() const { return false; }
aoqi@0:  private:
aoqi@0:   static julong count_bytes(Array<AnnotationArray*>* p);
aoqi@0:  public:
aoqi@0:   const char* internal_name() const { return "{constant pool}"; }
aoqi@0: #ifndef PRODUCT
aoqi@0:   void print_on(outputStream* st) const;
aoqi@0: #endif
aoqi@0:   void print_value_on(outputStream* st) const;
aoqi@0: };
aoqi@0: #endif // SHARE_VM_OOPS_ANNOTATIONS_HPP