dyninstAPI/h/BPatch_function.h

   1 /*
   2  * Copyright (c) 1996 Barton P. Miller
   3  *
   4  * We provide the Paradyn Parallel Performance Tools (below
   5  * described as Paradyn") on an AS IS basis, and do not warrant its
   6  * validity or performance.  We reserve the right to update, modify,
   7  * or discontinue this software at any time.  We shall have no
   8  * obligation to supply such updates or modifications or any other
   9  * form of support to you.
  10  *
  11  * This license is for research uses.  For such uses, there is no
  12  * charge. We define "research use" to mean you may freely use it
  13  * inside your organization for whatever purposes you see fit. But you
  14  * may not re-distribute Paradyn or parts of Paradyn, in any form
  15  * source or binary (including derivatives), electronic or otherwise,
  16  * to any other organization or entity without our permission.
  17  *
  18  * (for other uses, please contact us at paradyn@cs.wisc.edu)
  19  *
  20  * All warranties, including without limitation, any warranty of
  21  * merchantability or fitness for a particular purpose, are hereby
  22  * excluded.
  23  *
  24  * By your use of Paradyn, you understand and agree that we (or any
  25  * other person or entity with proprietary rights in Paradyn) are
  26  * under no obligation to provide either maintenance services,
  27  * update services, notices of latent defects, or correction of
  28  * defects for Paradyn.
  29  *
  30  * Even if advised of the possibility of such damages, under no
  31  * circumstances shall we (or any other person or entity with
  32  * proprietary rights in the software licensed hereunder) be liable
  33  * to you or any third party for direct, indirect, or consequential
  34  * damages of any character regardless of type of action, including,
  35  * without limitation, loss of profits, loss of use, loss of good
  36  * will, or computer failure or malfunction.  You agree to indemnify
  37  * us (and any other person or entity with proprietary rights in the
  38  * software licensed hereunder) for any and all liability it may
  39  * incur to third parties resulting from your use of Paradyn.
  40  */
  41
  42 #ifndef _BPatch_function_h_
  43 #define _BPatch_function_h_
  44
  45 #include "BPatch_dll.h"
  46 #include "BPatch_Vector.h"
  47 #include "BPatch_point.h"
  48 #include "BPatch_type.h"
  49 #include "BPatch_module.h"
  50 #include "BPatch_flowGraph.h"
  51
  52 class function_base;
  53 class process;
  54
  55 class BPatch_localVarCollection;
  56 class BPatch_function;
  57 class BPatch_point;
  58 class BPatch_flowGraph;
  59
  60 class BPATCH_DLL_EXPORT BPatch_function: public BPatch_sourceObj {
  61     friend class BPatch_flowGraph;
  62
  63     process *proc;
  64     BPatch_type * retType;
  65     BPatch_Vector<BPatch_localVar *> params;
  66     BPatch_module *mod;
  67     BPatch_flowGraph* cfg;
  68
  69     void         *getBaseAddrRelative();
  70
  71 public:
  72     virtual     ~BPatch_function();
  73
  74 // The following are for  internal use by the library only:
  75     function_base *func;
  76     process *getProc() { return proc; }
  77
  78 // No longer inline but defined in .C file
  79     BPatch_function(process *_proc, function_base *_func, BPatch_module *mod = NULL);
  80     BPatch_function(process *_proc, function_base *_func,
  81                     BPatch_type * _retType, BPatch_module *);
  82
  83     bool getSourceObj(BPatch_Vector<BPatch_sourceObj *> &);
  84     BPatch_sourceObj *getObjParent();
  85     BPatch_localVarCollection * localVariables;
  86     BPatch_localVarCollection * funcParameters;
  87     void setReturnType( BPatch_type * _retType){
  88       retType = _retType;}
  89
  90 // For users of the library:
  91     char         *getName(char *s, int len);
  92     char         *getMangledName(char *s, int len);
  93     void         *getBaseAddr();
  94     unsigned int getSize();
  95     BPatch_type * getReturnType(){ return retType; }
  96     BPatch_module *getModule()  { return mod; }
  97     void addParam(char * _name, BPatch_type *_type, int _linenum,
  98                   int _frameOffset, int _sc = 5 /* scAbs */ );
  99
 100     BPatch_Vector<BPatch_localVar *> *getParams() {
 101       return &params; }
 102     BPatch_Vector<BPatch_localVar *> *getVars();
 103     BPatch_Vector<BPatch_point *>
 104         *findPoint(const BPatch_procedureLocation loc);
 105     BPatch_Vector<BPatch_point *>
 106         *findPoint(const BPatch_Set<BPatch_opCode>& ops);
 107     BPatch_localVar * findLocalVar( const char * name);
 108     BPatch_localVar * findLocalParam(const char * name);
 109     BPatch_Vector<BPatch_variableExpr *> *findVariable(const char *);
 110
 111     //method to retrieve addresses corresponding a line in the function
 112     bool getLineToAddr (unsigned short lineNo,
 113                         BPatch_Vector<unsigned long>& buffer,
 114                         bool exactMatch = true);
 115
 116     // method to return file name, and first and last lines of the func
 117     bool getLineAndFile(unsigned int &start,
 118                         unsigned int &end,
 119                         char *name,
 120                         unsigned &length);
 121
 122     // is this defined, what variables should be returned??
 123     bool getVariables(BPatch_Vector<BPatch_variableExpr *> &vect);
 124
 125     char *getModuleName(char *name, int maxLen);
 126
 127     // Returns true if the function is instrumentable.
 128     bool isInstrumentable();
 129
 130 #ifdef IBM_BPATCH_COMPAT
 131     bool getLineNumbers(unsigned int &start, unsigned int &end);
 132
 133     void *getAddress();
 134
 135     bool getAddressRange(void * &start, void * &end);
 136
 137     BPatch_type *returnType();
 138
 139     void getIncPoints(BPatch_Vector<BPatch_point *> &vect);
 140
 141
 142     int getMangledNameLen();
 143
 144     void getExcPoints(BPatch_Vector<BPatch_point*> &points);
 145
 146     // return a function that can be passed as a paramter
 147     BPatch_variableExpr *getFunctionRef();
 148
 149
 150 #endif
 151
 152
 153 //method to create the control flow graph for the function
 154     BPatch_flowGraph* getCFG();
 155 };
 156
 157 #endif /* _BPatch_function_h_ */