ROSE  0.9.9.109
BinaryCallingConvention.h
1 #ifndef ROSE_BinaryAnalysis_CallingConvention_H
2 #define ROSE_BinaryAnalysis_CallingConvention_H
3 
4 #include <BaseSemantics2.h>
5 #include <BinaryStackVariable.h>
6 #include <Partitioner2/BasicTypes.h>
7 #include <RegisterParts.h>
8 
9 #include <boost/serialization/access.hpp>
10 #include <boost/serialization/set.hpp>
11 #include <boost/serialization/string.hpp>
12 #include <boost/serialization/vector.hpp>
13 #include <Sawyer/SharedObject.h>
14 #include <Sawyer/SharedPointer.h>
15 
16 namespace Rose {
17 namespace BinaryAnalysis {
18 
19 // Forwards
20 class Disassembler;
21 
32 namespace CallingConvention {
33 
37 void initDiagnostics();
38 
43 
45 // Miscellaneous small types
47 
53 };
54 
59 };
60 
66 };
67 
68 
70 // ParameterLocation
72 
82  #undef ABSOLUTE
84 public:
86  enum Type {
91  };
92 
93 private:
94  Type type_;
95  RegisterDescriptor reg_; // The argument register, or the stack base register.
96  union {
97  int64_t offset_; // Offset from stack base register for stack-based locations.
98  rose_addr_t va_; // Absolute address
99  };
100 
101 #ifdef ROSE_HAVE_BOOST_SERIALIZATION_LIB
102 private:
103  friend class boost::serialization::access;
104 
105  template<class S>
106  void serialize(S &s, const unsigned version) {
107  s & BOOST_SERIALIZATION_NVP(type_);
108  s & BOOST_SERIALIZATION_NVP(reg_);
109  if (STACK==type_) {
110  s & BOOST_SERIALIZATION_NVP(offset_);
111  } else {
112  s & BOOST_SERIALIZATION_NVP(va_);
113  }
114  }
115 #endif
116 
117 public:
124  : type_(NO_LOCATION), offset_(0) {}
125 
128  : type_(REGISTER), reg_(reg), offset_(0) {}
129 
132  : type_(STACK), reg_(reg), offset_(offset) {}
133 
135  explicit ParameterLocation(rose_addr_t va)
136  : type_(ABSOLUTE), va_(va) {}
137 
139  Type type() const { return type_; }
140 
144  bool isValid() const {
145  return type() != NO_LOCATION;
146  }
147 
154  return reg_;
155  }
156 
162  int64_t offset() const {
163  return STACK == type_ ? offset_ : (int64_t)0;
164  }
165 
170  rose_addr_t address() const {
171  return ABSOLUTE == type_ ? va_ : (rose_addr_t)0;
172  }
173 
177  bool operator==(const ParameterLocation &other) const {
178  return type_ == other.type_ && reg_ == other.reg_ && offset_ == other.offset_; // &va_ == &offset_
179  }
180 
184  bool operator!=(const ParameterLocation &other) const {
185  return type_ != other.type_ || reg_ != other.reg_ || offset_ != other.offset_; // &va_ == &offset_
186  }
187 
191  void print(std::ostream &out, const RegisterDictionary *regdict) const {
192  print(out, RegisterNames(regdict));
193  }
194  void print(std::ostream &out, const RegisterNames &regnames) const {
195  switch (type_) {
196  case NO_LOCATION: out <<"nowhere"; break;
197  case REGISTER: out <<regnames(reg_); break;
198  case STACK: out <<"mem[" <<regnames(reg_) <<"+" <<offset_ <<"]"; break;
199  case ABSOLUTE: out <<"mem[" <<StringUtility::addrToString(va_) <<"]"; break;
200  }
201  }
204 };
205 
206 
208 // Definition
210 
213 
218 public:
221 
222 private:
223  std::string name_; // Official short name of the convention, like "stdcall".
224  std::string comment_; // Long name, like "Windows Borland x86-32 fastcall"
225  size_t wordWidth_; // Natural width word size in bits
226  const RegisterDictionary *regDict_; // Register dictionary used when this definition was created
227  std::vector<ParameterLocation> inputParameters_; // Input (inc. in-out) parameters; additional stack-based are implied
228  std::vector<ParameterLocation> outputParameters_; // Return values and output parameters.
229  StackParameterOrder stackParameterOrder_; // Order of arguments on the stack
230  RegisterDescriptor stackPointerRegister_; // Base pointer for implied stack parameters
231  size_t nonParameterStackSize_; // Size in bytes of non-parameter stack area
232  size_t stackAlignment_; // Stack alignment in bytes (zero means unknown)
233  StackDirection stackDirection_; // Direction that stack grows from a PUSH operation
234  StackCleanup stackCleanup_; // Who cleans up stack parameters?
235  ParameterLocation thisParameter_; // Object pointer for calling conventions that are object methods
236  std::set<RegisterDescriptor> calleeSavedRegisters_; // Register that the callee must restore before returning
237  std::set<RegisterDescriptor> scratchRegisters_; // Caller-saved registers
238 
239 #ifdef ROSE_HAVE_BOOST_SERIALIZATION_LIB
240 private:
241  friend class boost::serialization::access;
242 
243  template<class S>
244  void serialize(S &s, const unsigned version) {
245  s & BOOST_SERIALIZATION_NVP(name_);
246  s & BOOST_SERIALIZATION_NVP(comment_);
247  s & BOOST_SERIALIZATION_NVP(wordWidth_);
248  s & BOOST_SERIALIZATION_NVP(regDict_);
249  s & BOOST_SERIALIZATION_NVP(inputParameters_);
250  s & BOOST_SERIALIZATION_NVP(outputParameters_);
251  s & BOOST_SERIALIZATION_NVP(stackParameterOrder_);
252  s & BOOST_SERIALIZATION_NVP(stackPointerRegister_);
253  s & BOOST_SERIALIZATION_NVP(nonParameterStackSize_);
254  s & BOOST_SERIALIZATION_NVP(stackAlignment_);
255  s & BOOST_SERIALIZATION_NVP(stackDirection_);
256  s & BOOST_SERIALIZATION_NVP(stackCleanup_);
257  s & BOOST_SERIALIZATION_NVP(thisParameter_);
258  s & BOOST_SERIALIZATION_NVP(calleeSavedRegisters_);
259  s & BOOST_SERIALIZATION_NVP(scratchRegisters_);
260  }
261 #endif
262 
263 protected:
268  : wordWidth_(0), regDict_(NULL), stackParameterOrder_(ORDER_UNSPECIFIED), nonParameterStackSize_(0),
269  stackAlignment_(0), stackDirection_(GROWS_DOWN), stackCleanup_(CLEANUP_UNSPECIFIED) {}
270 
276  Definition(size_t wordWidth, const std::string &name, const std::string &comment, const RegisterDictionary *regDict)
277  : name_(name), comment_(comment), wordWidth_(wordWidth), regDict_(regDict), stackParameterOrder_(ORDER_UNSPECIFIED),
278  nonParameterStackSize_(0), stackAlignment_(0), stackDirection_(GROWS_DOWN), stackCleanup_(CLEANUP_UNSPECIFIED) {
279  ASSERT_require2(0 == (wordWidth & 7) && wordWidth > 0, "word size must be a positive multiple of eight");
280  }
281 
282 public:
284  static Ptr instance(size_t wordWidth, const std::string &name, const std::string &comment, const RegisterDictionary *regs) {
285  return Ptr(new Definition(wordWidth, name, comment, regs));
286  }
287 
288 public:
292  static Ptr x86_32bit_cdecl();
293  static Ptr x86_64bit_cdecl();
294  static Ptr x86_32bit_stdcall();
295  static Ptr x86_64bit_stdcall();
296  static Ptr x86_32bit_fastcall();
297  static Ptr x86_64bit_sysv();
303  static Ptr x86_cdecl(const RegisterDictionary*);
304  static Ptr x86_stdcall(const RegisterDictionary*);
305  static Ptr x86_fastcall(const RegisterDictionary*);
313  const RegisterDictionary* registerDictionary() const { return regDict_; }
314  void registerDictionary(const RegisterDictionary *d) { regDict_ = d; }
325  const std::string& name() const { return name_; }
326  void name(const std::string &s) { name_ = s; }
336  const std::string& comment() const { return comment_; }
337  void comment(const std::string &s) { comment_ = s; }
349  size_t wordWidth() const { return wordWidth_; }
350  void wordWidth(size_t nBits) {
351  ASSERT_require2(nBits > 0 && 0 == (nBits & 7), "word size must be a positive multiple of eight");
352  wordWidth_ = nBits;
353  }
362  thisParameter_ = ParameterLocation();
363  }
364 
369  const std::vector<ParameterLocation>& inputParameters() const { return inputParameters_; }
370 
373 
378  void clearInputParameters() { inputParameters_.clear(); }
379 
389  }
390  void appendInputParameter(RegisterDescriptor reg, int64_t offset) {
392  }
393  void appendInputParameter(rose_addr_t va) {
395  }
402  const std::vector<ParameterLocation>& outputParameters() const { return outputParameters_; }
403 
406 
411  void clearOutputParameters() { outputParameters_.clear(); }
412 
424  }
425  void appendOutputParameter(RegisterDescriptor reg, int64_t offset) {
427  }
428  void appendOutputParameter(rose_addr_t va) {
430  }
443  StackParameterOrder stackParameterOrder() const { return stackParameterOrder_; }
444  void stackParameterOrder(StackParameterOrder x) { stackParameterOrder_ = x; }
454  const RegisterDescriptor stackPointerRegister() const { return stackPointerRegister_; }
455  void stackPointerRegister(RegisterDescriptor r) { stackPointerRegister_ = r; }
465  size_t nonParameterStackSize() const {
466  return nonParameterStackSize_;
467  }
468  void nonParameterStackSize(size_t nBytes) {
469  nonParameterStackSize_ = nBytes;
470  }
480  StackDirection stackDirection() const { return stackDirection_; }
481  void stackDirection(StackDirection x) { stackDirection_ = x; }
491  StackCleanup stackCleanup() const { return stackCleanup_; }
492  void stackCleanup(StackCleanup x) { stackCleanup_ = x; }
501  size_t stackAlignment() const { return stackAlignment_; }
502  void stackAlignment(size_t nBytes) { stackAlignment_ = nBytes; }
519  const ParameterLocation& thisParameter() const { return thisParameter_; }
520  void thisParameter(const ParameterLocation &x) { thisParameter_ = x; }
523  }
524  void thisParameter(RegisterDescriptor reg, int64_t offset) {
525  thisParameter(ParameterLocation(reg, offset));
526  }
527  void thisParameter(rose_addr_t va) {
529  }
543  const std::set<RegisterDescriptor>& calleeSavedRegisters() const { return calleeSavedRegisters_; }
544  std::set<RegisterDescriptor>& calleeSavedRegisters() { return calleeSavedRegisters_; }
549 
557  const std::set<RegisterDescriptor>& scratchRegisters() const { return scratchRegisters_; }
558  std::set<RegisterDescriptor>& scratchRegisters() { return scratchRegisters_; }
563 
574 
579  void print(std::ostream&, const RegisterDictionary *regDict = NULL) const;
580 
582  // Deprecated API
583  //
584  // This is mostly here for backward compatibility with the original API design, which was then implemented in SEI's pharos
585  // library. Unless otherwise noted, these were all deprecated as of 2015-08-14 in favor of CamelCase and dropping the
586  // "get" and "set" from properties that have names that are nouns.
588 public:
589  size_t get_word_size() const ROSE_DEPRECATED("use wordWidth property instead") {
590  return wordWidth();
591  }
592  void set_word_size(size_t w) ROSE_DEPRECATED("use wordWidth property instead") {
593  wordWidth(w);
594  }
595 
596  const std::string& get_name() const ROSE_DEPRECATED("use \"name\" property instead") {
597  return name();
598  }
599  void set_name(const std::string &n) ROSE_DEPRECATED("use \"name\" property instead") {
600  name(n);
601  }
602 
603  // The comment property stores a full name without any particular format. It may or may not include the compiler name
604  // depending on whether the compiler name is significant. If it includes a compiler name, it may or may not include a
605  // compiler version.
606  const std::string &get_compiler() const ROSE_DEPRECATED("use \"comment\" property instead") {
607  return comment();
608  }
609  void set_compiler(const std::string &c) ROSE_DEPRECATED("use \"comment\" property instead") {
610  comment(c);
611  }
612 
613  const std::string &get_comment() const ROSE_DEPRECATED("use \"comment\" property instead") {
614  return comment();
615  }
616  void set_comment(const std::string &c) ROSE_DEPRECATED("use \"comment\" property instead") {
617  comment(c);
618  }
619 
620  enum ParameterOrder {/*NO_STRINGIFY*/
621  ORDER_LTR = LEFT_TO_RIGHT,
622  ORDER_RTL = RIGHT_TO_LEFT,
623  ORDER_UNKNOWN = ORDER_UNSPECIFIED,
624  };
625 
626  ParameterOrder get_param_order() const ROSE_DEPRECATED("use stackParameterOrder property instead") {
627  return (ParameterOrder)stackParameterOrder();
628  }
629  void set_param_order(ParameterOrder order) ROSE_DEPRECATED("use stackParameterOrder property instead") {
631  }
632 
633  enum ThisPointerLocation {/*NO_STRINGIFY*/
634  THIS_FIRST_PARAM,
635  THIS_REGISTER,
636  THIS_NOT_APPLICABLE,
637  THIS_UNKNOWN,
638  };
639 
640  ThisPointerLocation get_this_location() const ROSE_DEPRECATED("use thisParameter property instead") {
641  const ParameterLocation &loc = thisParameter();
642  switch (loc.type()) {
643  case ParameterLocation::NO_LOCATION: return THIS_NOT_APPLICABLE; // or maybe THIS_UNKNOWN
644  case ParameterLocation::REGISTER: return THIS_REGISTER;
645  case ParameterLocation::STACK: return THIS_FIRST_PARAM; // assume its the first parameter
646  case ParameterLocation::ABSOLUTE: return THIS_UNKNOWN; // not supported in old API
647  }
648  }
649  // We can't set the location type independent of the location.
650  //void set_this_location(ThisPointerLocation loc) ROSE_DEPRECATED("use thisParameter property instead") {
651 
652  void set_this_register(const RegisterDescriptor *reg) ROSE_DEPRECATED("use thisParameter property instead") {
653  if (NULL == reg) {
654  thisParameter(ParameterLocation()); // no location
655  } else {
656  thisParameter(*reg);
657  }
658  }
659 
660  enum ReturnValueLocation {/*NO_STRINGIFY*/
661  RETVAL_STACK,
662  RETVAL_REGISTER,
663  RETVAL_NOT_APPLICABLE,
664  RETVAL_UNKNOWN,
665  };
666 
667  ReturnValueLocation get_retval_location() const ROSE_DEPRECATED("use outputParameters property instead") {
668  if (outputParameters().empty())
669  return RETVAL_NOT_APPLICABLE;
670  const ParameterLocation &loc = outputParameters().front();
671  switch (loc.type()) {
672  case ParameterLocation::NO_LOCATION: return RETVAL_UNKNOWN;
673  case ParameterLocation::REGISTER: return RETVAL_REGISTER;
674  case ParameterLocation::STACK: return RETVAL_STACK;
675  case ParameterLocation::ABSOLUTE: return RETVAL_UNKNOWN; // not supported in old API
676  }
677  ASSERT_not_reachable("invalid return value location");
678  }
679  // We can't set the return value location type independent of the location.
680  // void set_retval_location(ReturnValueLocation loc) ROSE_DEPRECATED("use appendOutputParameter instead");
681 
682  void set_retval_register(const RegisterDescriptor *reg) ROSE_DEPRECATED("use appendOutputParameter instead") {
684  if (NULL != reg)
685  appendOutputParameter(*reg);
686  }
687 
688  StackCleanup get_stack_cleanup() const ROSE_DEPRECATED("use stackCleanup property instead") {
689  return stackCleanup();
690  }
691  void set_stack_cleanup(StackCleanup cleanup) ROSE_DEPRECATED("use stackCleanup property instead") {
692  stackCleanup(cleanup);
693  }
694 
695  // These aren't needed for disassembly, only for compilers.
696  //size_t get_stack_alignment() const { return stack_alignment; }
697  //void set_stack_alignment(size_t alignment) { stack_alignment = alignment; }
698 
699  typedef std::vector<RegisterDescriptor> RegisterVector;
700 
701  // We can't return a reference like the original API because this object doesn't keep a vector of just the register
702  // parameters.
703  RegisterVector get_reg_params() const ROSE_DEPRECATED("use inputParameters property instead") {
704  RegisterVector retval;
705  BOOST_FOREACH (const ParameterLocation &loc, inputParameters_) {
706  if (loc.type() == ParameterLocation::REGISTER)
707  retval.push_back(loc.reg());
708  }
709  return retval;
710  }
711  void add_reg_param(const RegisterDescriptor *reg) ROSE_DEPRECATED("use appendInputParameter instead") {
713  }
714 
715  typedef std::set<RegisterDescriptor> RegisterSet;
716 
717  const RegisterSet& get_nonvolatile() const ROSE_DEPRECATED("use calleeSavedRegisters property instead") {
718  return calleeSavedRegisters();
719  }
720  void add_nonvolatile(const RegisterDictionary *dict, const std::string &name)
721  ROSE_DEPRECATED("use calleeSavedRegisters property instead") {
722  const RegisterDescriptor *rd = dict->lookup(name);
723  ASSERT_not_null2(rd, "unable to find register \"" + StringUtility::cEscape(name) + "\"");
724  calleeSavedRegisters().insert(*rd);
725  }
726  void add_nonvolatile(const RegisterDescriptor *rd) ROSE_DEPRECATED("use calleeSavedRegisters property instead") {
727  ASSERT_require2(rd && rd->is_valid(), "invalid nonvolatile register");
728  calleeSavedRegisters().insert(*rd);
729  }
730  void add_nonvolatile(const RegisterSet &regs) ROSE_DEPRECATED("use calleeSavedRegisters property instead") {
731  calleeSavedRegisters().insert(regs.begin(), regs.end());
732  }
733 
734  // Write information about this calling convention to the debug log stream.
735  void report(const RegisterDictionary *regdict) const ROSE_DEPRECATED("use \"print\" instead") {
736  print(std::cout, regdict);
737  };
738 };
739 
740 
742 // Dictionary
744 
746 typedef std::vector<Definition::Ptr> Dictionary;
747 
749 const Dictionary& dictionaryAmd64();
750 
752 const Dictionary& dictionaryArm();
753 
755 const Dictionary& dictionaryM68k();
756 
758 const Dictionary& dictionaryMips();
759 
761 const Dictionary& dictionaryPowerpc();
762 
764 const Dictionary& dictionaryX86();
765 
766 
768 // Analysis
770 
774 class Analysis {
775 private:
777  const RegisterDictionary *regDict_; // Names for the register parts
778  Definition::Ptr defaultCc_; // Default calling convention for called functions
779 
780  bool hasResults_; // Are the following data members initialized?
781  bool didConverge_; // Are the following data members valid (else only approximations)?
782  RegisterParts restoredRegisters_; // Registers accessed but restored
783  RegisterParts inputRegisters_; // Registers that serve as possible input parameters
784  RegisterParts outputRegisters_; // Registers that hold possible return values
785  StackVariables inputStackParameters_; // Stack variables serving as function inputs
786  StackVariables outputStackParameters_; // Stack variables serving as possible return values
787  Sawyer::Optional<int64_t> stackDelta_; // Change in stack across entire function
788  // Don't forget to update clearResults() and serialize() if you add more.
789 
790 #ifdef ROSE_HAVE_BOOST_SERIALIZATION_LIB
791 private:
792  friend class boost::serialization::access;
793 
794  template<class S>
795  void serialize(S &s, const unsigned version) {
796  s & BOOST_SERIALIZATION_NVP(cpu_);
797  s & BOOST_SERIALIZATION_NVP(regDict_);
798  s & BOOST_SERIALIZATION_NVP(defaultCc_);
799  s & BOOST_SERIALIZATION_NVP(hasResults_);
800  s & BOOST_SERIALIZATION_NVP(didConverge_);
801  s & BOOST_SERIALIZATION_NVP(restoredRegisters_);
802  s & BOOST_SERIALIZATION_NVP(inputRegisters_);
803  s & BOOST_SERIALIZATION_NVP(outputRegisters_);
804  s & BOOST_SERIALIZATION_NVP(inputStackParameters_);
805  s & BOOST_SERIALIZATION_NVP(outputStackParameters_);
806  s & BOOST_SERIALIZATION_NVP(stackDelta_);
807  }
808 #endif
809 
810 public:
817  : regDict_(NULL), hasResults_(false), didConverge_(false) {}
818 
822  explicit Analysis(Disassembler *d)
823  : regDict_(NULL), hasResults_(false), didConverge_(false) {
824  init(d);
825  }
826 
834  : cpu_(cpu), regDict_(NULL), hasResults_(false), didConverge_(false) {}
835 
843  Definition::Ptr defaultCallingConvention() const { return defaultCc_; }
844  void defaultCallingConvention(const Definition::Ptr &x) { defaultCc_ = x; }
853 
858  bool hasResults() const { return hasResults_; }
859 
864  bool didConverge() const { return didConverge_; }
865 
870  void clearResults();
871 
876  void clearNonResults();
877 
885  const RegisterDictionary* registerDictionary() const { return regDict_; }
886  void registerDictionary(const RegisterDictionary *d) { regDict_ = d; }
893  const RegisterParts& calleeSavedRegisters() const { return restoredRegisters_; }
894 
899  const RegisterParts& inputRegisters() const { return inputRegisters_; }
900 
905  const RegisterParts& outputRegisters() const { return outputRegisters_; }
906 
910  const StackVariables& inputStackParameters() const { return inputStackParameters_; }
911 
915  const StackVariables& outputStackParameters() const { return outputStackParameters_; }
916 
921  Sawyer::Optional<int64_t> stackDelta() const { return stackDelta_; }
922 
926  bool match(const Definition::Ptr&) const;
927 
933  Dictionary match(const Dictionary&) const;
934 
939  void print(std::ostream&, bool multiLine=false) const;
940 
941 private:
942  // Finish constructing
943  void init(Disassembler*);
944 
945  // Recompute the restoredRegisters_ data member.
946  void updateRestoredRegisters(const InstructionSemantics2::BaseSemantics::StatePtr &initialState,
948 
949  // Recompute the inputRegisters_ data member after updateRestoredRegisters is computed.
950  void updateInputRegisters(const InstructionSemantics2::BaseSemantics::StatePtr &state);
951 
952  // Recompute the outputRegisters_ data member after updateRestoredRegisters is computed.
953  void updateOutputRegisters(const InstructionSemantics2::BaseSemantics::StatePtr &state);
954 
955  // Recompute the input and output stack variables
956  void updateStackParameters(const InstructionSemantics2::BaseSemantics::StatePtr &initialState,
958 
959  // Recomputes the stack delta
960  void updateStackDelta(const InstructionSemantics2::BaseSemantics::StatePtr &initialState,
962 };
963 
965 // Free functions
967 
968 std::ostream& operator<<(std::ostream&, const Definition&);
969 std::ostream& operator<<(std::ostream&, const Analysis&);
970 
971 } // namespace
972 } // namespace
973 } // namespace
974 
975 #endif
void print(std::ostream &out, const RegisterNames &regnames) const
Print location.
void thisParameter(rose_addr_t va)
Property: Object pointer parameter.
size_t wordWidth() const
Property: Word size in bits.
const Dictionary & dictionaryX86()
Common calling conventions for 32-bit x86.
const std::vector< ParameterLocation > & outputParameters() const
Property: List of output parameters.
void registerDictionary(const RegisterDictionary *d)
Property: Register dictionary.
StackParameterOrder stackParameterOrder() const
Property: Stack parameter order.
size_t stackAlignment() const
Property: Stack alignment.
const Dictionary & dictionaryM68k()
Common calling conventions for m68k.
void print(std::ostream &out, const RegisterDictionary *regdict) const
Print location.
StackDirection stackDirection() const
Property: Direction that stack grows for a push operation.
The called function pops all stack parameters.
void wordWidth(size_t nBits)
Property: Word size in bits.
void stackDirection(StackDirection x)
Property: Direction that stack grows for a push operation.
void appendInputParameter(const ParameterLocation &)
Append input parameter.
const Dictionary & dictionaryArm()
Common calling conventions for ARM.
std::vector< StackVariable > StackVariables
Multiple stack variables.
RegisterDescriptor reg() const
Register part of location.
static Ptr x86_32bit_cdecl()
Returns a predefined, cached calling convention.
const RegisterDictionary * registerDictionary() const
Property: Register dictionary.
void appendOutputParameter(rose_addr_t va)
Append output parameter.
Sawyer::SharedPointer< class Definition > DefinitionPtr
Reference counting pointer to calling convention definition.
void registerDictionary(const RegisterDictionary *d)
Property: Register dictionary.
Collection of streams.
Definition: Message.h:1579
static Ptr x86_32bit_stdcall()
Allocating constructor.
void thisParameter(RegisterDescriptor reg, int64_t offset)
Property: Object pointer parameter.
ParameterLocation(RegisterDescriptor reg)
Constructs a parameter in a register location.
ParameterLocation(RegisterDescriptor reg, int64_t offset)
Constructs a parameter at a register-relative memory address.
void thisParameter(const ParameterLocation &x)
Property: Object pointer parameter.
StackDirection
The direction in which the stack grows.
Analysis(Disassembler *d)
Construct an analyzer using a specified disassembler.
bool operator!=(const ParameterLocation &other) const
Inequality.
const Dictionary & dictionaryAmd64()
Common calling conventions for amd64 (x86-64).
void appendInputParameter(rose_addr_t va)
Append input parameter.
Definition::Ptr defaultCallingConvention() const
Property: Default calling convention.
void thisParameter(RegisterDescriptor reg)
Property: Object pointer parameter.
void stackCleanup(StackCleanup x)
Property: Who pops stack parameters.
rose_addr_t address() const
Fixed address location.
Main namespace for the ROSE library.
RegisterParts inputRegisterParts() const
Compute the set of input registers.
RegisterParts scratchRegisterParts() const
Computes the set of scratch registers.
Describes (part of) a physical CPU register.
Holds a set of registers without regard for register boundaries.
Definition: RegisterParts.h:25
StackCleanup stackCleanup() const
Property: Who pops stack parameters.
static Ptr x86_fastcall(const RegisterDictionary *)
Constructs a new pre-defined calling convention based on a register dictionary.
Sawyer::Optional< int64_t > stackDelta() const
Concrete stack delta.
bool hasResults() const
Whether a function has been analyzed.
Sawyer::SharedPointer< Definition > Ptr
Reference counting pointer to calling convention definition.
const ParameterLocation & thisParameter() const
Property: Object pointer parameter.
ROSE_UTIL_API std::string cEscape(const std::string &)
Escapes characters that are special to C/C++.
boost::shared_ptr< class State > StatePtr
Shared-ownership pointer to a semantic state.
void comment(const std::string &s)
Property: Full name of calling convention.
const RegisterParts & calleeSavedRegisters() const
Callee-saved registers.
void stackParameterOrder(StackParameterOrder x)
Property: Stack parameter order.
const RegisterParts & inputRegisters() const
Input registers.
boost::shared_ptr< class Dispatcher > DispatcherPtr
Shared-ownership pointer to a semantics instruction dispatcher.
void print(std::ostream &, bool multiLine=false) const
Print information about the analysis results.
bool operator==(const ParameterLocation &other) const
Equality.
std::vector< Definition::Ptr > Dictionary
A ordered collection of calling convention definitions.
const Dictionary & dictionaryMips()
Common calling conventions for MIPS.
void appendOutputParameter(const ParameterLocation &)
Append output parameter.
static Ptr x86_cdecl(const RegisterDictionary *)
Constructs a new pre-defined calling convention based on a register dictionary.
static Ptr instance(size_t wordWidth, const std::string &name, const std::string &comment, const RegisterDictionary *regs)
Allocating constructor.
const std::set< RegisterDescriptor > & calleeSavedRegisters() const
Property: Callee-saved registers.
void appendInputParameter(RegisterDescriptor reg)
Append input parameter.
ROSE_UTIL_API std::string addrToString(uint64_t value, size_t nbits=0)
Convert a virtual address to a string.
void nonParameterStackSize(size_t nBytes)
Property: Size of non-parameter stack area.
StackParameterOrder
The order that arguments are pushed onto the stack.
bool isValid() const
Predicate to determine if location is valid.
bool didConverge() const
Whether the analysis results are valid.
std::set< RegisterDescriptor > & scratchRegisters()
Property: Scratch registers.
Sawyer::Message::Facility mlog
Facility for diagnostic output.
void appendInputParameter(RegisterDescriptor reg, int64_t offset)
Append input parameter.
void analyzeFunction(const Partitioner2::Partitioner &, const Sawyer::SharedPointer< Partitioner2::Function > &)
Analyze one function.
void print(std::ostream &, const RegisterDictionary *regDict=NULL) const
Print detailed information about this calling convention.
size_t nonParameterStackSize() const
Property: Size of non-parameter stack area.
Analysis(const InstructionSemantics2::BaseSemantics::DispatcherPtr &cpu)
Construct an analysis using a specified dispatcher.
static Ptr x86_stdcall(const RegisterDictionary *)
Constructs a new pre-defined calling convention based on a register dictionary.
RegisterParts outputRegisterParts() const
Computes the set of output registers.
bool match(const Definition::Ptr &) const
Determine whether a definition matches.
Defines registers available for a particular architecture.
Definition: Registers.h:32
const RegisterDescriptor stackPointerRegister() const
Property: Register for implied stack parameters.
RegisterParts getUsedRegisterParts() const
Returns all registers mentioned in this definition.
const RegisterParts & outputRegisters() const
Output registers.
Prints a register name even when no dictionary is available or when the dictionary doesn't contain an...
Definition: Registers.h:354
static Ptr x86_64bit_cdecl()
Allocating constructor.
void name(const std::string &s)
Property: Short name of calling convention.
Stack parameters pushed left to right (Pascal order).
ParameterLocation(rose_addr_t va)
Constructs a parameter at a fixed memory address.
StackCleanup
Who is responsible for popping stack parameters.
const RegisterDictionary * registerDictionary() const
Property: Register dictionary.
Base class for reference counted objects.
Definition: SharedObject.h:22
void clearNonResults()
Clears everything but results.
void initDiagnostics()
Initialize diagnostics.
void clearResults()
Clear analysis results.
const std::vector< ParameterLocation > & inputParameters() const
Property: Enumerated input parameters.
Stack parameters pushed right to left (C order).
void clearInputParameters()
Erase enumerated input parameters.
void appendOutputParameter(RegisterDescriptor reg)
Append output parameter.
const std::string & name() const
Property: Short name of calling convention.
void stackAlignment(size_t nBytes)
Property: Stack alignment.
const Dictionary & dictionaryPowerpc()
Common calling conventions for PowerPC.
Stack parameter cleanup is unknown or unspecified.
Definition(size_t wordWidth, const std::string &name, const std::string &comment, const RegisterDictionary *regDict)
Allocating constructor.
Stack parameter order is unknown or unspecified.
const StackVariables & inputStackParameters() const
Input stack parameters.
RegisterParts calleeSavedRegisterParts() const
Compute the set of callee-saved registers.
void defaultCallingConvention(const Definition::Ptr &x)
Property: Default calling convention.
const std::string & comment() const
Property: Full name of calling convention.
const std::set< RegisterDescriptor > & scratchRegisters() const
Property: Scratch registers.
static Ptr x86_32bit_fastcall()
Allocating constructor.
Partitions instructions into basic blocks and functions.
Definition: Partitioner.h:289
static Ptr x86_64bit_sysv()
Allocating constructor.
Virtual base class for instruction disassemblers.
Definition: Disassembler.h:41
const StackVariables & outputStackParameters() const
Output stack parameters.
static Ptr x86_64bit_stdcall()
Allocating constructor.
std::set< RegisterDescriptor > & calleeSavedRegisters()
Property: Callee-saved registers.
void stackPointerRegister(RegisterDescriptor r)
Property: Register for implied stack parameters.
void appendOutputParameter(RegisterDescriptor reg, int64_t offset)
Append output parameter.