git.ozlabs.org Git - ccan/blob - ccan/ntdb/test/external-agent.h

   1 #ifndef NTDB_TEST_EXTERNAL_AGENT_H
   2 #define NTDB_TEST_EXTERNAL_AGENT_H
   3
   4 /* For locking tests, we need a different process to try things at
   5  * various times. */
   6 enum operation {
   7         OPEN,
   8         OPEN_WITH_HOOK,
   9         FETCH,
  10         STORE,
  11         TRANSACTION_START,
  12         TRANSACTION_COMMIT,
  13         NEEDS_RECOVERY,
  14         CHECK,
  15         SEND_SIGNAL,
  16         CLOSE,
  17 };
  18
  19 /* Do this before doing any ntdb stuff.  Return handle, or -1. */
  20 struct agent *prepare_external_agent(void);
  21
  22 enum agent_return {
  23         SUCCESS,
  24         WOULD_HAVE_BLOCKED,
  25         AGENT_DIED,
  26         FAILED, /* For fetch, or NEEDS_RECOVERY */
  27         OTHER_FAILURE,
  28 };
  29
  30 /* Ask the external agent to try to do an operation.
  31  * name == ntdb name for OPEN/OPEN_WITH_CLEAR_IF_FIRST,
  32  * <key>=<data> for FETCH/STORE.
  33  */
  34 enum agent_return external_agent_operation(struct agent *handle,
  35                                            enum operation op,
  36                                            const char *name);
  37
  38 /* Hook into free() on ntdb_data in external agent. */
  39 extern void (*external_agent_free)(void *);
  40
  41 /* Mapping enum -> string. */
  42 const char *agent_return_name(enum agent_return ret);
  43 const char *operation_name(enum operation op);
  44
  45 void free_external_agent(struct agent *agent);
  46
  47 /* Internal use: */
  48 struct ntdb_context;
  49 enum agent_return external_agent_needs_rec(struct ntdb_context *ntdb);
  50
  51 #endif /* NTDB_TEST_EXTERNAL_AGENT_H */