dyninstAPI/h/BPatch.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_h_
  43 #define _BPatch_h_
  44
  45 #include <stdio.h>
  46 #include "BPatch_Vector.h"
  47 #include "BPatch_thread.h"
  48 #include "BPatch_type.h"
  49
  50 class BPatch_typeCollection;
  51 class BPatch_libInfo;
  52 class BPatch_module;
  53
  54 typedef enum {
  55     BPatchFatal, BPatchSerious, BPatchWarning, BPatchInfo
  56 } BPatchErrorLevel;
  57
  58 typedef void (*BPatchErrorCallback)(BPatchErrorLevel severity,
  59                                     int number,
  60                                     const char **params);
  61
  62 typedef void (*BPatchDynLibraryCallback)(BPatch_thread *thr,
  63                                          BPatch_module *mod,
  64                                          bool load);
  65
  66 typedef void (*BPatchForkCallback)(BPatch_thread *parent, BPatch_thread *child);
  67
  68 typedef void (*BPatchExecCallback)(BPatch_thread *proc);
  69
  70 typedef void (*BPatchExitCallback)(BPatch_thread *proc, int code);
  71
  72 class BPatch {
  73     friend class BPatch_thread;
  74     friend class process;
  75
  76     BPatch_libInfo      *info;
  77
  78     BPatchErrorCallback         errorHandler;
  79     BPatchDynLibraryCallback    dynLibraryCallback;
  80     BPatchForkCallback          postForkCallback;
  81     BPatchForkCallback          preForkCallback;
  82     BPatchExecCallback          execCallback;
  83     BPatchExitCallback          exitCallback;
  84     bool        typeCheckOn;
  85     int         lastError;
  86     bool        debugParseOn;
  87
  88     bool        getThreadEvent(bool block);
  89     bool        havePendingEvent();
  90
  91     /* If true, trampolines can recurse to their heart's content.
  92        Defaults to false */
  93     bool        trampRecursiveOn;
  94
  95 public:
  96     static BPatch                *bpatch;
  97
  98     BPatch_builtInTypeCollection *builtInTypes;
  99     BPatch_typeCollection        *stdTypes;
 100     BPatch_typeCollection        *APITypes; //API/User defined types
 101     BPatch_type                  *type_Error;
 102     BPatch_type                  *type_Untyped;
 103
 104     bool isTypeChecked() { return typeCheckOn; }
 105     bool parseDebugInfo() { return debugParseOn; }
 106     bool isTrampRecursive() { return trampRecursiveOn; }
 107
 108     // The following are only to be called by the library:
 109     void registerProvisionalThread(int pid);
 110     void registerForkedThread(int parentPid, int childPid, process *proc);
 111     void registerExec(BPatch_thread *thread);
 112     void registerExit(BPatch_thread *thread, int code);
 113     void registerThread(BPatch_thread *thread);
 114     void unRegisterThread(int pid);
 115
 116     BPatch_thread *getThreadByPid(int pid, bool *exists = NULL);
 117
 118     static void reportError(BPatchErrorLevel severity, int number, const char *str);
 119
 120     void clearError() { lastError = 0; }
 121     int getLastError() { return lastError; }
 122     // End of functions that are for internal use only
 123
 124     BPatch();
 125     ~BPatch();
 126
 127     static const char *getEnglishErrorString(int number);
 128     static void formatErrorString(char *dst, int size,
 129                                   const char *fmt, const char **params);
 130     BPatchErrorCallback registerErrorCallback(BPatchErrorCallback function);
 131     BPatchDynLibraryCallback registerDynLibraryCallback(BPatchDynLibraryCallback function);
 132     BPatchForkCallback registerPostForkCallback(BPatchForkCallback func);
 133     BPatchForkCallback registerPreForkCallback(BPatchForkCallback func);
 134     BPatchExecCallback registerExecCallback(BPatchExecCallback func);
 135     BPatchExitCallback registerExitCallback(BPatchExitCallback func);
 136
 137     BPatch_Vector<BPatch_thread*> *getThreads();
 138
 139     void setDebugParsing(bool x) { debugParseOn = x; }
 140     void setTypeChecking(bool x) { typeCheckOn = x; }
 141     void setTrampRecursive(bool x) { trampRecursiveOn = x; }
 142
 143     BPatch_thread *createProcess(char *path, char *argv[],
 144         char *envp[] = NULL, int stdin_fd=0, int stdout_fd=1, int stderr_fd=2);
 145     BPatch_thread *attachProcess(char *path, int pid);
 146
 147     // Create Enum types.
 148     BPatch_type * createEnum(const char * name,
 149         BPatch_Vector<char *> elementNames,
 150         BPatch_Vector<int> elementIds);
 151
 152     // API selects elemetIds
 153     BPatch_type * createEnum(const char * name,
 154         BPatch_Vector<char *> elementNames);
 155
 156     // Create Struct types.
 157     BPatch_type * createStruct( const char * name,
 158                                 BPatch_Vector<char *> fieldNames,
 159                                 BPatch_Vector<BPatch_type *> fieldTypes);
 160
 161     // Create Union types.
 162     BPatch_type * createUnion( const char * name,
 163                                 BPatch_Vector<char *> fieldNames,
 164                                 BPatch_Vector<BPatch_type *> fieldTypes);
 165
 166     // Creates BPatch_array type or symtyperanges ( scalars with upper and
 167    //lower bound).
 168     BPatch_type * createArray( const char * name, BPatch_type * ptr,
 169                                unsigned int low, unsigned int hi );
 170
 171     // Creates BPatch_pointer types
 172     BPatch_type * createPointer( const char * name, BPatch_type * ptr,
 173                                  int size = sizeof(void *));
 174
 175     // Creates BPatch_scalar types
 176     BPatch_type * createScalar( const char * name, int size );
 177
 178     // Creates typedefs.
 179     BPatch_type * createTypedef( const char * name, BPatch_type * ptr );
 180
 181     bool        pollForStatusChange();
 182     bool        waitForStatusChange();
 183 };
 184
 185 #endif /* _BPatch_h_ */