/usr/include/dmtcpaware.h is in libdmtcpaware-dev 1.2.5-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 | /*************************************************************************
* TODO: Replace this header with appropriate header showing MIT OR BSD *
* License *
* This file, dmtcpaware.h, is placed in the public domain. *
* The motivation for this is to allow anybody to freely use this file *
* without restriction to statically link this file with any software. *
* This allows that software to communicate with the DMTCP libraries. *
* - Jason Ansel, Kapil Arya, and Gene Cooperman *
* jansel@csail.mit.edu, kapil@ccs.neu.edu, gene@ccs.neu.edu *
*************************************************************************/
#ifndef DMTCPAWARE_H
#define DMTCPAWARE_H
#ifdef __cplusplus
extern "C" {
#endif
/// Return value of dmtcpCheckpoint
#define DMTCP_AFTER_CHECKPOINT 1
/// Return value of dmtcpCheckpoint
#define DMTCP_AFTER_RESTART 2
/// Returned when DMTCP is disabled, unless stated otherwise
#define DMTCP_ERROR_DISABLED -128
/// Pointer to a "void foo();" function
typedef void (*DmtcpFunctionPointer)(void);
/// Returned by dmtcpGetCoordinatorStatus()
typedef struct _DmtcpCoordinatorStatus {
/// Number of processes connected to dmtcp_coordinator
int numProcesses;
/// 1 if all processes connected to dmtcp_coordinator are in a running state
int isRunning;
} DmtcpCoordinatorStatus;
/// Returned by dmtcpGetLocalStatus()
typedef struct _DmtcpLocalStatus {
/// The number of times this process has been checkpointed (excludes restarts)
int numCheckpoints;
/// The number of times this process has been restarted
int numRestarts;
/// Filename of .dmtcp checkpoint file for this process
const char* checkpointFilename;
/// The DMTCP cluster-wide unique process identifier for this process.
/// Format is "HostHash-PID-Timestamp"
const char* uniquePidStr;
} DmtcpLocalStatus;
/**
* If synchronization log and replay is enabled, adds a generic "user" event
* to the log. Returns 1 on success, 0 on error.
*/
int dmtcp_userSynchronizedEvent();
int dmtcp_userSynchronizedEventBegin();
int dmtcp_userSynchronizedEventEnd();
/**
* Returns 1 if executing under dmtcp_checkpoint, 0 otherwise
*/
int dmtcpIsEnabled();
/**
* Checkpoint the entire distributed computation, block until checkpoint is
* complete.
* - returns DMTCP_AFTER_CHECKPOINT if the checkpoint succeeded.
* - returns DMTCP_AFTER_RESTART after a restart.
* - returns <=0 on error.
*/
int dmtcpCheckpoint();
/**
* Prevent a checkpoint from starting until dmtcpDelayCheckpointsUnlock() is
* called.
* - Has (recursive) lock semantics, only one thread may acquire it at time.
* - Only prevents checkpoints locally, remote processes may be suspended.
* Thus, send or recv to another checkpointed process may create deadlock.
* - Returns 1 on success, <=0 on error
*/
int dmtcpDelayCheckpointsLock();
/**
* Re-allow checkpoints, opposite of dmtcpDelayCheckpointsLock().
* - Returns 1 on success, <=0 on error
*/
int dmtcpDelayCheckpointsUnlock();
/**
* Sets the hook functions that DMTCP calls when it checkpoints/restarts.
* - These functions are called from the DMTCP thread while all user threads
* are suspended.
* - First preCheckpoint() is called, then either postCheckpoint() or
* postRestart() is called.
* - Set to NULL to disable.
* - Returns 1 on success, <=0 on error
*/
int dmtcpInstallHooks( DmtcpFunctionPointer preCheckpoint
, DmtcpFunctionPointer postCheckpoint
, DmtcpFunctionPointer postRestart);
/**
* Gets the coordinator-specific status of DMTCP.
* - Calling this function invalidates older DmtcpCoordinatorStatus structures.
* - Returns NULL on error.
*/
const DmtcpCoordinatorStatus* dmtcpGetCoordinatorStatus();
/**
* Gets the local-node-specific status of DMTCP.
* - Calling this function invalidates older DmtcpLocalStatus structures.
* - Returns NULL on error.
*/
const DmtcpLocalStatus* dmtcpGetLocalStatus();
/**
* Send a command to the dmtcp_coordinator as if it were typed on the console.
* - Returns 1 if command was sent and well-formed, <= 0 otherwise.
*/
int dmtcpRunCommand(char command);
#ifdef __cplusplus
} //extern "C"
#endif
#endif //DMTCPAWARE_H
|