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
  57 class BPatch_function: public BPatch_sourceObj {
  58     process *proc;
  59     BPatch_type * retType;
  60     BPatch_Vector<BPatch_localVar *> params;
  61     BPatch_module *mod;
  62
  63 public:
  64     virtual     ~BPatch_function();
  65
  66 // The following are for  internal use by the library only:
  67     function_base *func;
  68     process *getProc() { return proc; }
  69
  70 // No longer inline but defined in .C file
  71     BPatch_function(process *_proc, function_base *_func, BPatch_module *);
  72     BPatch_function(process *_proc, function_base *_func,
  73                     BPatch_type * _retType, BPatch_module *);
  74
  75     BPatch_Vector<BPatch_sourceObj *> *getSourceObj();
  76     BPatch_sourceObj *getObjParent();
  77     BPatch_localVarCollection * localVariables;
  78     BPatch_localVarCollection * funcParameters;
  79     void setReturnType( BPatch_type * _retType){
  80       retType = _retType;}
  81
  82 // For users of the library:
  83     char         *getName(char *s, int len);
  84     void         *getBaseAddr();
  85     unsigned int getSize();
  86     BPatch_type * getReturnType(){ return retType; }
  87     BPatch_module *getModule()  { return mod; }
  88     void addParam(char * _name, BPatch_type *_type, int _linenum,
  89                   int _frameOffset, int _sc = 5 /* scAbs */ );
  90
  91     BPatch_Vector<BPatch_localVar *> *getParams() {
  92       return &params; }
  93     BPatch_Vector<BPatch_point *>
  94         *findPoint(const BPatch_procedureLocation loc);
  95     BPatch_localVar * findLocalVar( const char * name);
  96     BPatch_localVar * findLocalParam(const char * name);
  97 };
  98
  99
 100
 101 #endif /* _BPatch_function_h_ */