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