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 class BPatch {
  67     friend class BPatch_thread;
  68     friend class process;
  69
  70     BPatch_libInfo      *info;
  71
  72     BPatchErrorCallback      errorHandler;
  73     BPatchDynLibraryCallback dynLibraryCallback;
  74     bool        typeCheckOn;
  75     int         lastError;
  76     bool        debugParseOn;
  77
  78     bool        getThreadEvent(bool block);
  79     bool        havePendingEvent();
  80
  81     /* If true, trampolines can recurse to their heart's content.
  82        Defaults to false */
  83     bool        trampRecursiveOn;
  84
  85 public:
  86     static BPatch                *bpatch;
  87
  88     BPatch_builtInTypeCollection *builtInTypes;
  89     BPatch_typeCollection        *stdTypes;
  90     BPatch_typeCollection        *APITypes; //API/User defined types
  91     BPatch_type                  *type_Error;
  92     BPatch_type                  *type_Untyped;
  93
  94     // The following are only to be called by the library:
  95     bool isTypeChecked() { return typeCheckOn; }
  96     bool parseDebugInfo() { return debugParseOn; }
  97     bool isTrampRecursive() { return trampRecursiveOn; }
  98
  99     void registerProvisionalThread(int pid);
 100     void registerThread(BPatch_thread *thread);
 101     void unRegisterThread(int pid);
 102
 103     BPatch_thread *getThreadByPid(int pid, bool *exists = NULL);
 104
 105     static void reportError(BPatchErrorLevel severity, int number, const char *str);
 106
 107     void clearError() { lastError = 0; }
 108     int getLastError() { return lastError; }
 109     // End of functions that are for internal use only
 110
 111     BPatch();
 112     ~BPatch();
 113
 114     static const char *getEnglishErrorString(int number);
 115     static void formatErrorString(char *dst, int size,
 116                                   const char *fmt, const char **params);
 117     BPatchErrorCallback registerErrorCallback(BPatchErrorCallback function);
 118     BPatchDynLibraryCallback registerDynLibraryCallback(BPatchDynLibraryCallback function);
 119     BPatch_Vector<BPatch_thread*> *getThreads();
 120
 121     void setDebugParsing(bool x) { debugParseOn = x; }
 122     void setTypeChecking(bool x) { typeCheckOn = x; }
 123     void setTrampRecursive(bool x) { trampRecursiveOn = x; }
 124
 125     BPatch_thread *createProcess(char *path, char *argv[], char *envp[] = NULL);
 126     BPatch_thread *attachProcess(char *path, int pid);
 127
 128     // Create Enum types.
 129     BPatch_type * createEnum(const char * name,
 130         BPatch_Vector<char *> elementNames,
 131         BPatch_Vector<int> elementIds);
 132
 133     // API selects elemetIds
 134     BPatch_type * createEnum(const char * name,
 135         BPatch_Vector<char *> elementNames);
 136
 137     // Create Struct types.
 138     BPatch_type * createStruct( const char * name,
 139                                 BPatch_Vector<char *> fieldNames,
 140                                 BPatch_Vector<BPatch_type *> fieldTypes);
 141
 142     // Create Union types.
 143     BPatch_type * createUnion( const char * name,
 144                                 BPatch_Vector<char *> fieldNames,
 145                                 BPatch_Vector<BPatch_type *> fieldTypes);
 146
 147     // Creates BPatch_array type or symtyperanges ( scalars with upper and
 148    //lower bound).
 149     BPatch_type * createArray( const char * name, BPatch_type * ptr,
 150                                unsigned int low, unsigned int hi );
 151
 152     // Creates BPatch_pointer types
 153     BPatch_type * createPointer( const char * name, BPatch_type * ptr,
 154                                  int size = sizeof(void *));
 155
 156     // Creates BPatch_scalar types
 157     BPatch_type * createScalar( const char * name, int size );
 158
 159     // Creates typedefs.
 160     BPatch_type * createTypedef( const char * name, BPatch_type * ptr );
 161
 162     bool        pollForStatusChange();
 163     bool        waitForStatusChange();
 164 };
 165
 166 #endif /* _BPatch_h_ */