blob: b99e5c2df4cb62ebfd793a3a56d35fc201db40a9 [file] [log] [blame]
Ian Rogers3a5c1ce2012-02-29 10:06:46 -08001/*
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
Ian Rogers02ed4c02013-09-06 13:10:04 -070017#ifndef ART_DISASSEMBLER_DISASSEMBLER_H_
18#define ART_DISASSEMBLER_DISASSEMBLER_H_
Ian Rogers3a5c1ce2012-02-29 10:06:46 -080019
Elliott Hughes0f3c5532012-03-30 14:51:51 -070020#include <stdint.h>
21
22#include <iosfwd>
23
Ian Rogersd582fa42014-11-05 23:46:43 -080024#include "arch/instruction_set.h"
Elliott Hughes76160052012-12-12 16:31:20 -080025#include "base/macros.h"
Ian Rogers3a5c1ce2012-02-29 10:06:46 -080026
27namespace art {
28
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -070029class DisassemblerOptions {
30 public:
31 // Should the disassembler print absolute or relative addresses.
32 const bool absolute_addresses_;
33
34 // Base addess for calculating relative code offsets when absolute_addresses_ is false.
35 const uint8_t* const base_address_;
36
Alexandre Ramesa37d9252014-10-27 11:28:14 +000037 // If set, the disassembler is allowed to look at load targets in literal
38 // pools.
39 const bool can_read_literals_;
40
41 DisassemblerOptions(bool absolute_addresses, const uint8_t* base_address,
42 bool can_read_literals)
43 : absolute_addresses_(absolute_addresses), base_address_(base_address),
44 can_read_literals_(can_read_literals) {}
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -070045
46 private:
47 DISALLOW_COPY_AND_ASSIGN(DisassemblerOptions);
48};
49
Ian Rogers3a5c1ce2012-02-29 10:06:46 -080050class Disassembler {
51 public:
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -070052 // Creates a Disassembler for the given InstructionSet with the
53 // non-null DisassemblerOptions which become owned by the
54 // Disassembler.
55 static Disassembler* Create(InstructionSet instruction_set, DisassemblerOptions* options);
56
57 virtual ~Disassembler() {
58 delete disassembler_options_;
59 }
Ian Rogers3a5c1ce2012-02-29 10:06:46 -080060
Ian Rogersb23a7722012-10-09 16:54:26 -070061 // Dump a single instruction returning the length of that instruction.
62 virtual size_t Dump(std::ostream& os, const uint8_t* begin) = 0;
63 // Dump instructions within a range.
Ian Rogers3a5c1ce2012-02-29 10:06:46 -080064 virtual void Dump(std::ostream& os, const uint8_t* begin, const uint8_t* end) = 0;
Elliott Hughes105afd22012-04-10 15:04:25 -070065
Alexandre Rameseb7b7392015-06-19 14:47:01 +010066 const DisassemblerOptions* GetDisassemblerOptions() const {
67 return disassembler_options_;
68 }
69
Elliott Hughes105afd22012-04-10 15:04:25 -070070 protected:
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -070071 explicit Disassembler(DisassemblerOptions* disassembler_options)
72 : disassembler_options_(disassembler_options) {
73 CHECK(disassembler_options_ != nullptr);
74 }
75
76 std::string FormatInstructionPointer(const uint8_t* begin);
Elliott Hughes105afd22012-04-10 15:04:25 -070077
78 private:
Brian Carlstrom2cbaccb2014-09-14 20:34:17 -070079 DisassemblerOptions* disassembler_options_;
Elliott Hughes105afd22012-04-10 15:04:25 -070080 DISALLOW_COPY_AND_ASSIGN(Disassembler);
Ian Rogers3a5c1ce2012-02-29 10:06:46 -080081};
82
Nicolas Geoffray3c7bb982014-07-23 16:04:16 +010083static inline bool HasBitSet(uint32_t value, uint32_t bit) {
84 return (value & (1 << bit)) != 0;
85}
86
Alexandre Rameseb7b7392015-06-19 14:47:01 +010087extern "C"
88Disassembler* create_disassembler(InstructionSet instruction_set, DisassemblerOptions* options);
89
Ian Rogers3a5c1ce2012-02-29 10:06:46 -080090} // namespace art
91
Ian Rogers02ed4c02013-09-06 13:10:04 -070092#endif // ART_DISASSEMBLER_DISASSEMBLER_H_