1 /*
2  * Copyright (C) 2015 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef ART_RUNTIME_MIRROR_FIELD_H_
18 #define ART_RUNTIME_MIRROR_FIELD_H_
19 
20 #include "accessible_object.h"
21 #include "base/enums.h"
22 #include "dex/modifiers.h"
23 #include "dex/primitive.h"
24 #include "obj_ptr.h"
25 #include "object.h"
26 #include "read_barrier_option.h"
27 
28 namespace art {
29 
30 class ArtField;
31 struct FieldOffsets;
32 
33 namespace mirror {
34 
35 class Class;
36 class String;
37 
38 // C++ mirror of java.lang.reflect.Field.
39 class MANAGED Field : public AccessibleObject {
40  public:
GetDexFieldIndex()41   ALWAYS_INLINE uint32_t GetDexFieldIndex() REQUIRES_SHARED(Locks::mutator_lock_) {
42     return GetField32(OFFSET_OF_OBJECT_MEMBER(Field, dex_field_index_));
43   }
44 
45   ObjPtr<mirror::Class> GetDeclaringClass() REQUIRES_SHARED(Locks::mutator_lock_);
46 
GetAccessFlags()47   uint32_t GetAccessFlags() REQUIRES_SHARED(Locks::mutator_lock_) {
48     return GetField32(OFFSET_OF_OBJECT_MEMBER(Field, access_flags_));
49   }
50 
IsStatic()51   bool IsStatic() REQUIRES_SHARED(Locks::mutator_lock_) {
52     return (GetAccessFlags() & kAccStatic) != 0;
53   }
54 
IsFinal()55   bool IsFinal() REQUIRES_SHARED(Locks::mutator_lock_) {
56     return (GetAccessFlags() & kAccFinal) != 0;
57   }
58 
IsVolatile()59   bool IsVolatile() REQUIRES_SHARED(Locks::mutator_lock_) {
60     return (GetAccessFlags() & kAccVolatile) != 0;
61   }
62 
63   ALWAYS_INLINE Primitive::Type GetTypeAsPrimitiveType() REQUIRES_SHARED(Locks::mutator_lock_);
64 
65   ObjPtr<mirror::Class> GetType() REQUIRES_SHARED(Locks::mutator_lock_);
66 
GetOffset()67   int32_t GetOffset() REQUIRES_SHARED(Locks::mutator_lock_) {
68     return GetField32(OFFSET_OF_OBJECT_MEMBER(Field, offset_));
69   }
70 
71   // Slow, try to use only for PrettyField and such.
72   ArtField* GetArtField() REQUIRES_SHARED(Locks::mutator_lock_);
73 
74   template <PointerSize kPointerSize, bool kTransactionActive = false>
75   static ObjPtr<mirror::Field> CreateFromArtField(Thread* self,
76                                                   ArtField* field,
77                                                   bool force_resolve)
78       REQUIRES_SHARED(Locks::mutator_lock_) REQUIRES(!Roles::uninterruptible_);
79 
80  private:
81   // Padding required for matching alignment with the Java peer.
82   uint8_t padding_[2];
83 
84   HeapReference<mirror::Class> declaring_class_;
85   HeapReference<mirror::Class> type_;
86   int32_t access_flags_;
87   int32_t dex_field_index_;
88   int32_t offset_;
89 
90   template<bool kTransactionActive>
91   void SetDeclaringClass(ObjPtr<mirror::Class> c) REQUIRES_SHARED(Locks::mutator_lock_);
92 
93   template<bool kTransactionActive>
94   void SetType(ObjPtr<mirror::Class> type) REQUIRES_SHARED(Locks::mutator_lock_);
95 
96   template<bool kTransactionActive>
SetAccessFlags(uint32_t flags)97   void SetAccessFlags(uint32_t flags) REQUIRES_SHARED(Locks::mutator_lock_) {
98     SetField32<kTransactionActive>(OFFSET_OF_OBJECT_MEMBER(Field, access_flags_), flags);
99   }
100 
101   template<bool kTransactionActive>
SetDexFieldIndex(uint32_t idx)102   void SetDexFieldIndex(uint32_t idx) REQUIRES_SHARED(Locks::mutator_lock_) {
103     SetField32<kTransactionActive>(OFFSET_OF_OBJECT_MEMBER(Field, dex_field_index_), idx);
104   }
105 
106   template<bool kTransactionActive>
SetOffset(uint32_t offset)107   void SetOffset(uint32_t offset) REQUIRES_SHARED(Locks::mutator_lock_) {
108     SetField32<kTransactionActive>(OFFSET_OF_OBJECT_MEMBER(Field, offset_), offset);
109   }
110 
111   friend struct art::FieldOffsets;  // for verifying offset information
112   DISALLOW_IMPLICIT_CONSTRUCTORS(Field);
113 };
114 
115 }  // namespace mirror
116 }  // namespace art
117 
118 #endif  // ART_RUNTIME_MIRROR_FIELD_H_
119