dyninstAPI/h/BPatch_thread.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_thread_h_
  43 #define _BPatch_thread_h_
  44
  45 /*
  46  * The following is a kludge so that the functions that refer to signals (such
  47  * as BPatch_thread::stopSignal) can emulate the Unix behavior on Windows NT.
  48  */
  49 #include <signal.h>
  50 #ifndef SIGTRAP
  51 #define SIGTRAP         5
  52 #endif
  53
  54 #include "BPatch_Vector.h"
  55 #include "BPatch_image.h"
  56 #include "BPatch_snippet.h"
  57
  58 class process;
  59 class instInstance;
  60 class BPatch;
  61 class BPatch_thread;
  62
  63
  64 /*
  65  * Used to specify whether a snippet is to be called before the instructions
  66  * at the point where it is inserted, or after.
  67  */
  68 typedef enum {
  69     BPatch_callBefore,
  70     BPatch_callAfter
  71 } BPatch_callWhen;
  72
  73
  74 /*
  75  * Used to specify whether a snippet should be installed before other snippets
  76  * that have previously been inserted at the same point, or after.
  77  */
  78 typedef enum {
  79     BPatch_firstSnippet,
  80     BPatch_lastSnippet
  81 } BPatch_snippetOrder;
  82
  83
  84 /*
  85  * Contains information about the code that was inserted by an earlier call to
  86  * Bpatch_thread::insertSnippet.
  87  */
  88 class BPatchSnippetHandle {
  89     friend class BPatch_thread;
  90 private:
  91     BPatch_Vector<instInstance *> instance;
  92 public:
  93     process *proc;
  94
  95     BPatchSnippetHandle(process *_proc) : proc(_proc) {};
  96     ~BPatchSnippetHandle();
  97
  98     void add(instInstance *pointInstance);
  99 };
 100
 101 /*
 102  * Represents a thread of execution.
 103  */
 104 class BPatch_thread {
 105     friend class BPatch;
 106     friend class BPatch_image;
 107     friend class BPatch_function;
 108     friend class process;
 109     friend bool pollForStatusChange();
 110
 111     process             *proc;
 112     BPatch_image        *image;
 113     int                 lastSignal;
 114     int                 exitCode;
 115     bool                mutationsActive;
 116     bool                createdViaAttach;
 117     bool                detached;
 118
 119     bool                waitingForOneTimeCode;
 120     void                *lastOneTimeCodeReturnValue;
 121
 122     bool                unreportedStop;
 123     bool                unreportedTermination;
 124
 125     void                setUnreportedStop(bool new_value)
 126                                 { unreportedStop = new_value; }
 127     void                setUnreportedTermination(bool new_value)
 128                                 { unreportedTermination = new_value; }
 129
 130     bool                pendingUnreportedStop()
 131                                 { return unreportedStop; }
 132     bool                pendingUnreportedTermination()
 133                                 { return unreportedTermination; }
 134
 135     bool                statusIsStopped();
 136     bool                statusIsTerminated();
 137
 138     static void         oneTimeCodeCallbackDispatch(process *theProc,
 139                                                     void *userData,
 140                                                     void *returnValue);
 141
 142     void                oneTimeCodeCallback(void *userData,
 143                                             void *returnValue);
 144
 145     void                *oneTimeCodeInternal(const BPatch_snippet &expr);
 146 protected:
 147     // for creating a process
 148     BPatch_thread(char *path, char *argv[], char *envp[] = NULL, int stdin_fd = 0,
 149         int stdout_fd = 1, int stderr_fd = 2);
 150     // for attaching
 151     BPatch_thread(char *path, int pid);
 152
 153     // for forking
 154     BPatch_thread(int childPid, process *proc);
 155
 156 public:
 157     ~BPatch_thread();
 158
 159     BPatch_image *getImage() { return image; }
 160
 161     int         getPid();
 162
 163     bool        stopExecution();
 164     bool        continueExecution();
 165     bool        terminateExecution();
 166
 167     bool        isStopped();
 168     int         stopSignal();
 169     bool        isTerminated();
 170     int         terminationStatus();
 171
 172     void        detach(bool cont);
 173
 174     bool        dumpCore(const char *file, bool terminate);
 175     bool        dumpImage(const char *file);
 176
 177     BPatch_variableExpr *malloc(int n);
 178     BPatch_variableExpr *malloc(const BPatch_type &type);
 179     void        free(const BPatch_variableExpr &ptr);
 180
 181     // to provide backward compatiblity
 182     BPatchSnippetHandle *insertSnippet(
 183                             const BPatch_snippet &expr,
 184                             BPatch_point &point,
 185                             BPatch_snippetOrder order = BPatch_firstSnippet);
 186
 187     BPatchSnippetHandle *insertSnippet(
 188                             const BPatch_snippet &expr,
 189                             BPatch_point &point,
 190                             BPatch_callWhen when,
 191                             BPatch_snippetOrder order);
 192
 193     BPatchSnippetHandle *insertSnippet(
 194                             const BPatch_snippet &expr,
 195                             const BPatch_Vector<BPatch_point *> &points,
 196                             BPatch_snippetOrder order = BPatch_firstSnippet);
 197
 198     BPatchSnippetHandle *insertSnippet(
 199                             const BPatch_snippet &expr,
 200                             const BPatch_Vector<BPatch_point *> &points,
 201                             BPatch_callWhen when,
 202                             BPatch_snippetOrder order = BPatch_firstSnippet);
 203
 204     bool        deleteSnippet(BPatchSnippetHandle *handle);
 205
 206     void        setMutationsActive(bool activate);
 207
 208     bool        replaceFunctionCall(BPatch_point &point,
 209                                     BPatch_function &newFunc);
 210     bool        removeFunctionCall(BPatch_point &point);
 211     bool        replaceFunction(BPatch_function &oldFunc,
 212                                 BPatch_function &newFunc);
 213
 214     void        oneTimeCode(const BPatch_snippet &expr) {
 215                         oneTimeCodeInternal(expr);
 216                     };
 217
 218     bool        loadLibrary(char *libname);
 219 };
 220
 221 #endif /* BPatch_thread_h_ */