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_dll.h"
  47 #include "BPatch_Vector.h"
  48 #include "BPatch_thread.h"
  49 #include "BPatch_type.h"
  50
  51 #ifdef mips_unknown_ce2_11 //ccw 28 july 2000
  52 #include "remoteDevice.h"
  53 #endif
  54
  55 class BPatch_typeCollection;
  56 class BPatch_libInfo;
  57 class BPatch_module;
  58
  59 typedef enum {
  60     BPatchFatal, BPatchSerious, BPatchWarning, BPatchInfo
  61 } BPatchErrorLevel;
  62
  63 typedef void (*BPatchErrorCallback)(BPatchErrorLevel severity,
  64                                     int number,
  65                                     const char **params);
  66
  67 typedef void (*BPatchDynLibraryCallback)(BPatch_thread *thr,
  68                                          BPatch_module *mod,
  69                                          bool load);
  70
  71 typedef void (*BPatchForkCallback)(BPatch_thread *parent, BPatch_thread *child);
  72
  73 typedef void (*BPatchExecCallback)(BPatch_thread *proc);
  74
  75 typedef void (*BPatchExitCallback)(BPatch_thread *proc, int code);
  76
  77 typedef void (*BPatchSignalCallback)(BPatch_thread *proc, int sigNum);
  78
  79 typedef void (*BPatchOneTimeCodeCallback)(BPatch_thread *proc, void *userData, void *returnValue);
  80
  81 #ifdef IBM_BPATCH_COMPAT
  82 typedef void *BPatch_Address;
  83 typedef void (*BPatchLoggingCallback)(char *msg, int);
  84 extern void setLogging_NP(BPatchLoggingCallback func, int);
  85
  86 typedef void (*BPatchThreadEventCallback)(BPatch_thread *thr, void *arg1, void *arg2);
  87
  88 #define BP_OK                   0
  89 #define BP_Pending              1
  90 #define BP_Delayed              2
  91 #define BP_child                3
  92 #define BP_state                4
  93 #define BP_pthdbBadContext      5
  94 #define BP_lastCode             6
  95
  96 extern int eCodes[BP_lastCode];
  97
  98 #endif
  99
 100 class BPATCH_DLL_EXPORT BPatch {
 101     friend class BPatch_thread;
 102     friend class process;
 103
 104     BPatch_libInfo      *info;
 105
 106     BPatchErrorCallback         errorHandler;
 107     BPatchDynLibraryCallback    dynLibraryCallback;
 108     BPatchForkCallback          postForkCallback;
 109     BPatchForkCallback          preForkCallback;
 110     BPatchExecCallback          execCallback;
 111     BPatchExitCallback          exitCallback;
 112     BPatchOneTimeCodeCallback   oneTimeCodeCallback;
 113     bool        typeCheckOn;
 114     int         lastError;
 115     bool        debugParseOn;
 116     bool        baseTrampDeletionOn;
 117
 118     bool        getThreadEvent(bool block);
 119     bool        getThreadEventOnly(bool block);
 120     bool        havePendingEvent();
 121
 122     /* If true, trampolines can recurse to their heart's content.
 123        Defaults to false */
 124     bool        trampRecursiveOn;
 125     bool        forceRelocation_NP;
 126     /* If true, allows automatic relocation of functions if dyninst
 127        deems it necessary.  Defaults to true */
 128     bool        autoRelocation;
 129
 130 public:
 131     static BPatch                *bpatch;
 132
 133     BPatch_builtInTypeCollection *builtInTypes;
 134     BPatch_typeCollection        *stdTypes;
 135     BPatch_typeCollection        *APITypes; //API/User defined types
 136     BPatch_type                  *type_Error;
 137     BPatch_type                  *type_Untyped;
 138 #ifdef mips_unknown_ce2_11 //ccw 28 july 2000
 139         remoteDevice *rDevice;  //the ctor sets up the connection here and
 140                                 //gets the tramptemplate from the CE device.
 141 #endif
 142
 143
 144     bool isTypeChecked() { return typeCheckOn; }
 145     bool parseDebugInfo() { return debugParseOn; }
 146     bool baseTrampDeletion() { return baseTrampDeletionOn; }
 147     bool isTrampRecursive() { return trampRecursiveOn; }
 148     bool hasForcedRelocation_NP() { return forceRelocation_NP; }
 149     bool autoRelocationOn() { return autoRelocation; }
 150
 151     // The following are only to be called by the library:
 152     void registerProvisionalThread(int pid);
 153     void registerForkedThread(int parentPid, int childPid, process *proc);
 154     void registerForkingThread(int forkingPid, process *proc);
 155     void registerExec(BPatch_thread *thread);
 156     void registerExit(BPatch_thread *thread, int code);
 157     void registerThread(BPatch_thread *thread);
 158     void unRegisterThread(int pid);
 159     void launchDeferredOneTimeCode();
 160
 161     BPatch_thread *getThreadByPid(int pid, bool *exists = NULL);
 162
 163     static void reportError(BPatchErrorLevel severity, int number, const char *str);
 164
 165     void clearError() { lastError = 0; }
 166     int getLastError() { return lastError; }
 167     // End of functions that are for internal use only
 168
 169 #ifdef IBM_BPATCH_COMPAT
 170     int getLastErrorCode() { return lastError; }
 171
 172     BPatchThreadEventCallback registerDetachDoneCallback(BPatchThreadEventCallback) { return NULL; }
 173     BPatchThreadEventCallback registerSnippetRemovedCallback(BPatchThreadEventCallback) { return NULL; }
 174
 175     BPatchExitCallback registerSignalCallback(BPatchThreadEventCallback func, int sigNum) {return NULL;}
 176     BPatchExitCallback registerExitCallback(BPatchThreadEventCallback func);
 177
 178     BPatchThreadEventCallback registerRPCTerminationCallback(BPatchThreadEventCallback);
 179     BPatchThreadEventCallback           RPCdoneCallback;
 180 #endif
 181
 182     BPatch();
 183     ~BPatch();
 184
 185     static const char *getEnglishErrorString(int number);
 186     static void formatErrorString(char *dst, int size,
 187                                   const char *fmt, const char **params);
 188     BPatchErrorCallback registerErrorCallback(BPatchErrorCallback function);
 189     BPatchDynLibraryCallback registerDynLibraryCallback(BPatchDynLibraryCallback function);
 190     BPatchForkCallback registerPostForkCallback(BPatchForkCallback func);
 191     BPatchForkCallback registerPreForkCallback(BPatchForkCallback func);
 192     BPatchExecCallback registerExecCallback(BPatchExecCallback func);
 193     BPatchExitCallback registerExitCallback(BPatchExitCallback func);
 194     BPatchOneTimeCodeCallback registerOneTimeCodeCallback(BPatchOneTimeCodeCallback func);
 195
 196     BPatch_Vector<BPatch_thread*> *getThreads();
 197
 198     void setDebugParsing(bool x) { debugParseOn = x; }
 199     void setBaseTrampDeletion(bool x) { baseTrampDeletionOn = x; }
 200     void setTypeChecking(bool x) { typeCheckOn = x; }
 201     void setTrampRecursive(bool x) { trampRecursiveOn = x; }
 202     void setForcedRelocation_NP(bool x) { forceRelocation_NP = x; }
 203     void setAutoRelocation(bool x) { autoRelocation = x; }
 204
 205     BPatch_thread *createProcess(const char *path, char *argv[],
 206         char *envp[] = NULL, int stdin_fd=0, int stdout_fd=1, int stderr_fd=2);
 207     BPatch_thread *attachProcess(const char *path, int pid);
 208
 209     // Create Enum types.
 210     BPatch_type * createEnum(const char * name,
 211         BPatch_Vector<char *> elementNames,
 212         BPatch_Vector<int> elementIds);
 213
 214     // API selects elemetIds
 215     BPatch_type * createEnum(const char * name,
 216         BPatch_Vector<char *> elementNames);
 217
 218     // Create Struct types.
 219     BPatch_type * createStruct( const char * name,
 220                                 BPatch_Vector<char *> fieldNames,
 221                                 BPatch_Vector<BPatch_type *> fieldTypes);
 222
 223     // Create Union types.
 224     BPatch_type * createUnion( const char * name,
 225                                 BPatch_Vector<char *> fieldNames,
 226                                 BPatch_Vector<BPatch_type *> fieldTypes);
 227
 228     // Creates BPatch_array type or symtyperanges ( scalars with upper and
 229    //lower bound).
 230     BPatch_type * createArray( const char * name, BPatch_type * ptr,
 231                                unsigned int low, unsigned int hi );
 232
 233     // Creates BPatch_pointer types
 234     BPatch_type * createPointer( const char * name, BPatch_type * ptr,
 235                                  int size = sizeof(void *));
 236
 237     // Creates BPatch_scalar types
 238     BPatch_type * createScalar( const char * name, int size );
 239
 240     // Creates typedefs.
 241     BPatch_type * createTypedef( const char * name, BPatch_type * ptr );
 242
 243     bool        pollForStatusChange();
 244     bool        waitForStatusChange();
 245
 246     bool waitUntilStopped(BPatch_thread *appThread);
 247 };
 248
 249 #endif /* _BPatch_h_ */