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
  49 class BPatch_typeCollection;
  50 class BPatch_type;
  51 class BPatch_libInfo;
  52
  53 typedef enum BPatchErrorLevel {
  54     BPatchFatal, BPatchSerious, BPatchWarning, BPatchInfo
  55 };
  56
  57 typedef void (*BPatchErrorCallback)(BPatchErrorLevel severity,
  58                                     int number,
  59                                     const char **params);
  60
  61 class BPatch {
  62     friend bool pollForStatusChange();
  63
  64     BPatch_libInfo      *info;
  65
  66     BPatchErrorCallback errorHandler;
  67     bool                typeCheckOn;
  68     int                 lastError;
  69
  70     BPatch_thread *pidToThread(int pid, bool *exists = NULL);
  71
  72 public:
  73     static BPatch               *bpatch;
  74
  75     BPatch_typeCollection       *stdTypes;
  76     BPatch_type                 *type_Error;
  77     BPatch_type                 *type_Untyped;
  78
  79     BPatch();
  80     ~BPatch();
  81
  82     static const char *getEnglishErrorString(int number);
  83     static void formatErrorString(char *dst, int size,
  84                                   const char *fmt, const char **params);
  85     BPatchErrorCallback registerErrorCallback(BPatchErrorCallback function);
  86     BPatch_Vector<BPatch_thread*> *getThreads();
  87
  88     void setTypeChecking(bool x) { typeCheckOn = x; }
  89
  90     BPatch_thread *createProcess(char *path, char *argv[], char *envp[] = NULL);
  91     BPatch_thread *attachProcess(char *path, int pid);
  92
  93     // The following are only to be called by the library:
  94     bool isTypeChecked() { return typeCheckOn; }
  95
  96     void registerProvisionalThread(int pid);
  97     void registerThread(BPatch_thread *thread);
  98     void unRegisterThread(int pid);
  99
 100     void reportError(BPatchErrorLevel severity, int number, const char *str);
 101
 102     void clearError() { lastError = 0; }
 103     int getLastError() { return lastError; }
 104 };
 105
 106 extern bool pollForStatusChange();
 107
 108 #endif /* _BPatch_h_ */