1 /*
2  * Copyright (C) 2011 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_OFFSETS_H_
18 #define ART_RUNTIME_OFFSETS_H_
19 
20 #include <ostream>
21 
22 #include "base/enums.h"
23 #include "globals.h"
24 
25 namespace art {
26 
27 // Allow the meaning of offsets to be strongly typed.
28 class Offset {
29  public:
Offset(size_t val)30   explicit Offset(size_t val) : val_(val) {}
Int32Value()31   int32_t Int32Value() const {
32     return static_cast<int32_t>(val_);
33   }
Uint32Value()34   uint32_t Uint32Value() const {
35     return static_cast<uint32_t>(val_);
36   }
SizeValue()37   size_t SizeValue() const {
38     return val_;
39   }
40 
41  protected:
42   size_t val_;
43 };
44 std::ostream& operator<<(std::ostream& os, const Offset& offs);
45 
46 // Offsets relative to the current frame.
47 class FrameOffset : public Offset {
48  public:
FrameOffset(size_t val)49   explicit FrameOffset(size_t val) : Offset(val) {}
50   bool operator>(FrameOffset other) const { return val_ > other.val_; }
51   bool operator<(FrameOffset other) const { return val_ < other.val_; }
52 };
53 
54 // Offsets relative to the current running thread.
55 template<PointerSize pointer_size>
56 class ThreadOffset : public Offset {
57  public:
ThreadOffset(size_t val)58   explicit ThreadOffset(size_t val) : Offset(val) {}
59 };
60 
61 using ThreadOffset32 = ThreadOffset<PointerSize::k32>;
62 using ThreadOffset64 = ThreadOffset<PointerSize::k64>;
63 
64 // Offsets relative to an object.
65 class MemberOffset : public Offset {
66  public:
MemberOffset(size_t val)67   explicit MemberOffset(size_t val) : Offset(val) {}
68 };
69 
70 }  // namespace art
71 
72 #endif  // ART_RUNTIME_OFFSETS_H_
73