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_Vector.h"
  46 #include "BPatch_point.h"
  47 #include "BPatch_type.h"
  48 #include "BPatch_module.h"
  49
  50 class function_base;
  51 class process;
  52
  53 class BPatch_localVarCollection;
  54 class BPatch_function;
  55 class BPatch_point;
  56 class BPatch_flowGraph;
  57
  58 class BPatch_function: public BPatch_sourceObj {
  59     friend class BPatch_flowGraph;
  60
  61     process *proc;
  62     BPatch_type * retType;
  63     BPatch_Vector<BPatch_localVar *> params;
  64     BPatch_module *mod;
  65     BPatch_flowGraph* cfg;
  66
  67     void         *getBaseAddrRelative();
  68
  69 public:
  70     virtual     ~BPatch_function();
  71
  72 // The following are for  internal use by the library only:
  73     function_base *func;
  74     process *getProc() { return proc; }
  75
  76 // No longer inline but defined in .C file
  77     BPatch_function(process *_proc, function_base *_func, BPatch_module *);
  78     BPatch_function(process *_proc, function_base *_func,
  79                     BPatch_type * _retType, BPatch_module *);
  80
  81     BPatch_Vector<BPatch_sourceObj *> *getSourceObj();
  82     BPatch_sourceObj *getObjParent();
  83     BPatch_localVarCollection * localVariables;
  84     BPatch_localVarCollection * funcParameters;
  85     void setReturnType( BPatch_type * _retType){
  86       retType = _retType;}
  87
  88 // For users of the library:
  89     char         *getName(char *s, int len);
  90     void         *getBaseAddr();
  91     unsigned int getSize();
  92     BPatch_type * getReturnType(){ return retType; }
  93     BPatch_module *getModule()  { return mod; }
  94     void addParam(char * _name, BPatch_type *_type, int _linenum,
  95                   int _frameOffset, int _sc = 5 /* scAbs */ );
  96
  97     BPatch_Vector<BPatch_localVar *> *getParams() {
  98       return &params; }
  99     BPatch_Vector<BPatch_point *>
 100         *findPoint(const BPatch_procedureLocation loc);
 101     BPatch_localVar * findLocalVar( const char * name);
 102     BPatch_localVar * findLocalParam(const char * name);
 103
 104 //method to retrieve addresses corresponding a line in the function
 105     bool getLineToAddr (unsigned short lineNo,
 106                         BPatch_Vector<unsigned long>& buffer,
 107                         bool exactMatch = true);
 108
 109 //method to create the control flow graph for the function
 110     BPatch_flowGraph* getCFG();
 111 };
 112
 113 #endif /* _BPatch_function_h_ */