1 /*
2 * Copyright (C) 2012 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_DISASSEMBLER_DISASSEMBLER_H_
18 #define ART_DISASSEMBLER_DISASSEMBLER_H_
19
20 #include <stdint.h>
21
22 #include <iosfwd>
23
24 #include "android-base/macros.h"
25
26 #include "arch/instruction_set.h"
27
28 namespace art {
29
30 class DisassemblerOptions {
31 public:
32 using ThreadOffsetNameFunction = void (*)(std::ostream& os, uint32_t offset);
33
34 ThreadOffsetNameFunction thread_offset_name_function_;
35
36 // Base address for calculating relative code offsets when absolute_addresses_ is false.
37 const uint8_t* const base_address_;
38
39 // End address (exclusive);
40 const uint8_t* const end_address_;
41
42 // Should the disassembler print absolute or relative addresses.
43 const bool absolute_addresses_;
44
45 // If set, the disassembler is allowed to look at load targets in literal
46 // pools.
47 const bool can_read_literals_;
48
DisassemblerOptions(bool absolute_addresses,const uint8_t * base_address,const uint8_t * end_address,bool can_read_literals,ThreadOffsetNameFunction fn)49 DisassemblerOptions(bool absolute_addresses,
50 const uint8_t* base_address,
51 const uint8_t* end_address,
52 bool can_read_literals,
53 ThreadOffsetNameFunction fn)
54 : thread_offset_name_function_(fn),
55 base_address_(base_address),
56 end_address_(end_address),
57 absolute_addresses_(absolute_addresses),
58 can_read_literals_(can_read_literals) {}
59
60 private:
61 DISALLOW_COPY_AND_ASSIGN(DisassemblerOptions);
62 };
63
64 class Disassembler {
65 public:
66 // Creates a Disassembler for the given InstructionSet with the
67 // non-null DisassemblerOptions which become owned by the
68 // Disassembler.
69 static Disassembler* Create(InstructionSet instruction_set, DisassemblerOptions* options);
70
~Disassembler()71 virtual ~Disassembler() {
72 delete disassembler_options_;
73 }
74
75 // Dump a single instruction returning the length of that instruction.
76 virtual size_t Dump(std::ostream& os, const uint8_t* begin) = 0;
77 // Dump instructions within a range.
78 virtual void Dump(std::ostream& os, const uint8_t* begin, const uint8_t* end) = 0;
79
GetDisassemblerOptions()80 const DisassemblerOptions* GetDisassemblerOptions() const {
81 return disassembler_options_;
82 }
83
84 protected:
85 explicit Disassembler(DisassemblerOptions* disassembler_options);
86
87 std::string FormatInstructionPointer(const uint8_t* begin);
88
89 private:
90 DisassemblerOptions* disassembler_options_;
91 DISALLOW_COPY_AND_ASSIGN(Disassembler);
92 };
93
HasBitSet(uint32_t value,uint32_t bit)94 static inline bool HasBitSet(uint32_t value, uint32_t bit) {
95 return (value & (1 << bit)) != 0;
96 }
97
98 extern "C"
99 Disassembler* create_disassembler(InstructionSet instruction_set, DisassemblerOptions* options);
100
101 } // namespace art
102
103 #endif // ART_DISASSEMBLER_DISASSEMBLER_H_
104