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 "arch/instruction_set.h"
25#include "base/macros.h"
26
27namespace art {
28
29class 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
37  // 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) {}
45
46 private:
47  DISALLOW_COPY_AND_ASSIGN(DisassemblerOptions);
48};
49
50class Disassembler {
51 public:
52  // 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  }
60
61  // 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.
64  virtual void Dump(std::ostream& os, const uint8_t* begin, const uint8_t* end) = 0;
65
66 protected:
67  explicit Disassembler(DisassemblerOptions* disassembler_options)
68      : disassembler_options_(disassembler_options) {
69    CHECK(disassembler_options_ != nullptr);
70  }
71
72  std::string FormatInstructionPointer(const uint8_t* begin);
73
74 private:
75  DisassemblerOptions* disassembler_options_;
76  DISALLOW_COPY_AND_ASSIGN(Disassembler);
77};
78
79static inline bool HasBitSet(uint32_t value, uint32_t bit) {
80  return (value & (1 << bit)) != 0;
81}
82
83}  // namespace art
84
85#endif  // ART_DISASSEMBLER_DISASSEMBLER_H_
86