ROSE  0.11.50.0
Registers.h
1 #ifndef ROSE_BinaryAnalysis_Registers_H
2 #define ROSE_BinaryAnalysis_Registers_H
3 #include <featureTests.h>
4 #ifdef ROSE_ENABLE_BINARY_ANALYSIS
5 
6 #include <Rose/BinaryAnalysis/RegisterParts.h>
7 
8 #include <boost/serialization/access.hpp>
9 #include <boost/serialization/map.hpp>
10 #include <boost/serialization/string.hpp>
11 
12 #include <queue>
13 
14 namespace Rose {
15 namespace BinaryAnalysis {
16 
38 public:
39  typedef std::map<std::string/*name*/, RegisterDescriptor> Entries;
40  typedef std::vector<RegisterDescriptor> RegisterDescriptors;
41 
43  static const RegisterDictionary *dictionary_null();
44 
54  static const RegisterDictionary *dictionary_i8086();
55 
59  static const RegisterDictionary *dictionary_i8088();
60 
64  static const RegisterDictionary *dictionary_i286();
65 
72  static const RegisterDictionary *dictionary_i386();
73 
76 
80  static const RegisterDictionary *dictionary_i486();
81 
85  static const RegisterDictionary *dictionary_pentium();
86 
92 
95 
107  static const RegisterDictionary *dictionary_amd64();
108 
109 #ifdef ROSE_ENABLE_ASM_AARCH64
110 
115  static const RegisterDictionary* dictionary_aarch64();
116 #endif
117 
118 #ifdef ROSE_ENABLE_ASM_AARCH32
119 
122  static const RegisterDictionary* dictionary_aarch32();
123 #endif
124 
127 
130 
134  static const RegisterDictionary *dictionary_mips32();
135 
143 
145  static const RegisterDictionary *dictionary_m68000();
146 
149 
151  static const RegisterDictionary *dictionary_coldfire();
152 
155 
156 private:
157  typedef std::map<RegisterDescriptor, std::vector<std::string> > Reverse; // a descriptor can have more than one name
158  std::string name; /*name of the dictionary, usually an architecture name like 'i386'*/
159  Entries forward;
160  Reverse reverse;
161 
162 #ifdef ROSE_HAVE_BOOST_SERIALIZATION_LIB
163 private:
164  friend class boost::serialization::access;
165 
166  template<class S>
167  void serialize(S &s, const unsigned /*version*/) {
168  s & BOOST_SERIALIZATION_NVP(name);
169  s & BOOST_SERIALIZATION_NVP(forward);
170  s & BOOST_SERIALIZATION_NVP(reverse);
171  }
172 #endif
173 
174 protected:
175  // needed for serialization
176  RegisterDictionary() {}
177 
178 public:
179  RegisterDictionary(const std::string &name)
180  :name(name) {}
181  RegisterDictionary(const RegisterDictionary& other) {
182  *this = other;
183  }
184 
193  const std::string &get_architecture_name() const {
194  return name;
195  }
196 
199  void set_architecture_name(const std::string &name) {
200  this->name = name;
201  }
202 
205  void insert(const std::string &name, RegisterDescriptor);
206 
209  void insert(const std::string &name, unsigned majr, unsigned minr, unsigned offset, unsigned nbits);
210 
213  void insert(const RegisterDictionary*);
214 
217  void insert(const RegisterDictionary&);
218 
222  void resize(const std::string &name, unsigned new_nbits);
223 
228  RegisterDescriptor find(const std::string &name) const;
229 
234  RegisterDescriptor findOrThrow(const std::string &name) const;
235 
239  const std::string& lookup(RegisterDescriptor) const;
240 
247 
255  RegisterDescriptor findLargestRegister(unsigned major, unsigned minor, size_t maxWidth=0) const;
256 
265 
268  const Entries& get_registers() const;
269  Entries& get_registers();
274  RegisterDescriptors get_descriptors() const;
275 
277  unsigned firstUnusedMajor() const;
278 
280  unsigned firstUnusedMinor(unsigned majr) const;
281 
293  class SortBySize {
294  public:
295  enum Direction { ASCENDING, DESCENDING };
296  explicit SortBySize(Direction d=DESCENDING): direction(d) {}
297  bool operator()(RegisterDescriptor a, RegisterDescriptor b) const {
298  return ASCENDING==direction ?
299  a.nBits() < b.nBits() :
300  a.nBits() > b.nBits();
301  }
302  protected:
303  Direction direction;
304  };
305 
331  template<class Compare>
332  static RegisterDescriptors filter_nonoverlapping(RegisterDescriptors reglist,
333  Compare order=SortBySize(),
334  bool reconsider_parts=true);
335 
348  RegisterDescriptors get_largest_registers() const;
349 
361  RegisterDescriptors get_smallest_registers() const;
362 
365  void print(std::ostream&) const;
366  friend std::ostream& operator<<(std::ostream&, const RegisterDictionary&);
367 
369  size_t size() const { return forward.size(); }
370 };
371 
375 public:
377  explicit RegisterNames(const RegisterDictionary *dict=NULL)
378  : dflt_dict(dict), prefix("REG"), show_offset(-1), offset_prefix("@"), show_size(-1), size_prefix("+") {}
379 
382  std::string operator()(RegisterDescriptor, const RegisterDictionary *dict=NULL) const;
383 
385  std::string prefix;
386  std::string suffix;
388  std::string offset_prefix;
389  std::string offset_suffix;
390  int show_size;
391  std::string size_prefix;
392  std::string size_suffix;
393 };
394 
395 /*******************************************************************************************************************************
396  * Template definitions
397  *******************************************************************************************************************************/
398 
399 
400 
401 template<class Compare>
402 RegisterDictionary::RegisterDescriptors
403 RegisterDictionary::filter_nonoverlapping(RegisterDescriptors desc, Compare order, bool reconsider_parts)
404 {
405  RegisterDescriptors retval;
406  Map<std::pair<int/*major*/, int/*minor*/>, ExtentMap> have_bits; // the union of the bits of descriptors we will return
407 
408  // Process the descriptors in the order specified.
409  std::priority_queue<RegisterDescriptor, RegisterDescriptors, Compare> heap(order, desc);
410  while (!heap.empty()) {
411  const RegisterDescriptor cur_desc = heap.top();
412  heap.pop();
413  const std::pair<int, int> cur_majmin(cur_desc.majorNumber(), cur_desc.minorNumber());
414  const Extent cur_extent(cur_desc.offset(), cur_desc.nBits());
415  ExtentMap &have_extents = have_bits[cur_majmin];
416  if (have_extents.distinct(cur_extent)) {
417  // We're not returning any of these bits yet, so add the whole descriptor
418  retval.push_back(cur_desc);
419  have_extents.insert(cur_extent);
420  } else if (reconsider_parts) {
421  // We're already returning some (or all) of these bits. Split the cur_extent into sub-parts by subtracting the
422  // stuff we're already returning.
423  ExtentMap parts;
424  parts.insert(cur_extent);
425  parts.erase_ranges(have_extents);
426  for (ExtentMap::iterator pi=parts.begin(); pi!=parts.end(); ++pi) {
427  const Extent &part = pi->first;
428  RegisterDescriptor part_desc(cur_desc.majorNumber(), cur_desc.minorNumber(), part.first(), part.size());
429  heap.push(part_desc);
430  }
431  }
432  }
433  return retval;
434 }
435 
436 } // namespace
437 } // namespace
438 
439 #endif
440 #endif
int show_size
0=>never; positive=>always; negative=>when offset is non-zero
Definition: Registers.h:390
const RegisterDescriptor * exists(RegisterDescriptor) const
Determine if a register descriptor exists.
static const RegisterDictionary * dictionary_i8088()
Intel 8088 registers.
static const RegisterDictionary * dictionary_pentium()
Intel Pentium registers.
unsigned majorNumber() const
Property: Major number.
static const RegisterDictionary * dictionary_coldfire_emac()
Registers for FreeScale ColdFire CPUs with EMAC (extended multiply-accumulate) unit.
size_t nBits() const
Property: Size in bits.
RegisterDescriptors get_largest_registers() const
Returns a list of the largest non-overlapping registers.
RegisterDescriptors get_descriptors() const
Returns the list of all register descriptors.
std::string offset_prefix
String printed before the offset when the offset is shown.
Definition: Registers.h:388
Rose::BinaryAnalysis::RegisterParts getAllParts() const
Returns all register parts.
static const RegisterDictionary * dictionary_i386_387()
Intel 80386 with 80387 math co-processor.
static const RegisterDictionary * dictionary_powerpc32()
PowerPC-32 registers.
const Entries & get_registers() const
Returns the list of all register definitions in the dictionary.
const std::string & lookup(RegisterDescriptor) const
Returns a register name for a given descriptor.
A contiguous range of values.
Definition: rangemap.h:50
std::string offset_suffix
String printed after the offset when the offset is shown.
Definition: Registers.h:389
InsSetArchitecture
Instruction sets organized by families.
static RegisterDescriptors filter_nonoverlapping(RegisterDescriptors reglist, Compare order=SortBySize(), bool reconsider_parts=true)
Returns the list of non-overlapping registers or register parts.
Definition: Registers.h:403
RegisterDescriptor findOrThrow(const std::string &name) const
Find a register by name.
static const RegisterDictionary * dictionary_m68000()
Motorola M68330 register names.
static const RegisterDictionary * dictionary_pentium4()
Intel Pentium 4 registers.
static const RegisterDictionary * dictionary_i386()
Intel 80386 registers.
Main namespace for the ROSE library.
Holds a set of registers without regard for register boundaries.
Definition: RegisterParts.h:27
void print(std::ostream &) const
Prints the contents of this register dictionary.
size_t size() const
Return the number of entries in the dictionary.
Definition: Registers.h:369
Compares number of bits in register descriptors.
Definition: Registers.h:293
RegisterNames(const RegisterDictionary *dict=NULL)
Constructor.
Definition: Registers.h:377
static const RegisterDictionary * dictionary_m68000_altnames()
Motorola M68330 alternate registers.
int show_offset
0=>never show offset; positive=>always show; negative=>show only when non-zero
Definition: Registers.h:387
iterator insert(Range new_range, Value new_value=Value(), bool make_hole=true)
Insert a range/value pair into the map.
Definition: rangemap.h:1192
std::string size_prefix
String printed prior to the size when the size is printed.
Definition: Registers.h:391
static const RegisterDictionary * dictionary_coldfire()
FreeScale ColdFire generic hardware registers.
const std::string & get_architecture_name() const
Obtain the name of the dictionary.
Definition: Registers.h:193
void insert(const std::string &name, RegisterDescriptor)
Insert a definition into the dictionary.
std::string operator()(RegisterDescriptor, const RegisterDictionary *dict=NULL) const
Obtain a name for a register descriptor.
void erase_ranges(const OtherMap &other)
Erase ranges from this map.
Definition: rangemap.h:1181
unsigned firstUnusedMajor() const
Returns the first unused major register number.
std::string suffix
String to print at the very end of the generated name.
Definition: Registers.h:386
Describes (part of) a physical CPU register.
static const RegisterDictionary * dictionary_for_isa(SgAsmExecutableFileFormat::InsSetArchitecture)
Class method to choose an appropriate register dictionary for an instruction set architecture.
std::string size_suffix
String printed after the size when the size is printed.
Definition: Registers.h:392
RegisterDescriptors get_smallest_registers() const
Returns a list of the smallest non-overlapping registers.
RegisterDescriptor find(const std::string &name) const
Find a register by name.
static const RegisterDictionary * dictionary_i486()
Intel 80486 registers.
Prints a register name even when no dictionary is available or when the dictionary doesn't contain an...
Definition: Registers.h:374
iterator begin()
First-item iterator.
Definition: rangemap.h:905
void set_architecture_name(const std::string &name)
Set the name of the dictionary.
Definition: Registers.h:199
size_t offset() const
Property: Offset to least-significant bit.
Value size() const
Returns the number of values represented by the range.
Definition: rangemap.h:147
std::string prefix
The leading part of a register name.
Definition: Registers.h:385
Extends std::map with methods that return optional values.
Definition: Map.h:10
const RegisterDictionary * dflt_dict
Dictionary supplied to the constructor.
Definition: Registers.h:384
unsigned firstUnusedMinor(unsigned majr) const
Returns the first unused minor register number.
static const RegisterDictionary * dictionary_null()
Mostly empty dictionary for the null ISA.
iterator end()
End-item iterator.
Definition: rangemap.h:917
static const RegisterDictionary * dictionary_powerpc64()
PowerPC-64 registers.
static const RegisterDictionary * dictionary_i8086()
Intel 8086 registers.
static const RegisterDictionary * dictionary_amd64()
Amd64 registers.
static const RegisterDictionary * dictionary_pentiumiii()
Intel Pentium III registers.
void first(const Value &first)
Accessor for the first value of a range.
Definition: rangemap.h:103
Defines registers available for a particular architecture.
Definition: Registers.h:37
static const RegisterDictionary * dictionary_mips32()
MIPS32 Release 1.
void resize(const std::string &name, unsigned new_nbits)
Changes the size of a register.
static const RegisterDictionary * dictionary_i286()
Intel 80286 registers.
unsigned minorNumber() const
Property: Minor number.
Represents an interpretation of a binary container.
static const RegisterDictionary * dictionary_mips32_altnames()
MIPS32 Release 1 with special registers.
RegisterDescriptor findLargestRegister(unsigned major, unsigned minor, size_t maxWidth=0) const
Finds the first largest register with specified major and minor number.