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