change the controls to return a struct ctdb_client_control_state* instead of a handle
[sahlberg/ctdb.git] / include / ctdb.h
index 94198aacc8730e8e69204baa0bf541317e9297c4..716e2a1312ff142b834180a4645eeb8fd53f7f8c 100644 (file)
@@ -1,7 +1,7 @@
 /* 
    ctdb database library
 
-   Copyright (C) Andrew Tridgell  2006
+   Copyright (C) Ronnie sahlberg 2010
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
 #ifndef _CTDB_H
 #define _CTDB_H
 
-#define CTDB_IMMEDIATE_MIGRATION       0x00000001
-struct ctdb_call {
-       int call_id;
-       TDB_DATA key;
-       TDB_DATA call_data;
-       TDB_DATA reply_data;
-       uint32_t status;
-       uint32_t flags;
-};
+/* Functions are not thread safe so all function calls must be wrapped
+ * inside a pthread_mutex for threaded applications.
+ *
+ * All *_send() functions are guaranteed to be non-blocking and fully
+ * asynchronous.
+ *
+ * The return data from a _send() call can be accessed through two different
+ * mechanisms.
+ *
+ * 1, by calling *_recv() directly on the handle.
+ *    This function will block until the response is received so it
+ *    should be avoided.
+ *    The exception is when called from in the registered callback,
+ *    in this case the fucntion is guaranteed not to block.
+ *
+ * 2, providing an async callback to be invoked when the call completes.
+ *    From inside the callback you use the *_recv() function to extract the
+ *    response data.
+ *
+ * After the *_recv() function returns, the handle will have been destroyed.
+ */
 
 /*
-  structure passed to a ctdb call backend function
-*/
-struct ctdb_call_info {
-       TDB_DATA key;          /* record key */
      TDB_DATA record_data;  /* current data in the record */
-       TDB_DATA *new_data;    /* optionally updated record data */
-       TDB_DATA *call_data;   /* optionally passed from caller */
-       TDB_DATA *reply_data;  /* optionally returned by function */
-       uint32_t status;       /* optional reply status - defaults to zero */
-};
-
-#define CTDB_ERR_INVALID 1
-#define CTDB_ERR_NOMEM 2
+ * Connect to ctdb using the specified domain socket.
+ * Returns a ctdb context if successful or NULL.
+ *
+ * Use ctdb_free() to release the returned ctdb_context when finished.
+ */
+struct ctdb_context *ctdb_connect(const char *addr);
+
+int ctdb_get_fd(struct ctdb_context *ctdb);
+
+int ctdb_which_events(struct ctdb_context *ctdb);
+
+int ctdb_service(struct ctdb_context *ctdb);
+
 
 /*
-  ctdb flags
-*/
-#define CTDB_FLAG_TORTURE      (1<<1)
+ * Special node addresses :
+ */
+/* used on the domain socket, send a pdu to the local daemon */
+#define CTDB_CURRENT_NODE     0xF0000001
+/* send a broadcast to all nodes in the cluster, active or not */
+#define CTDB_BROADCAST_ALL    0xF0000002
+/* send a broadcast to all nodes in the current vnn map */
+#define CTDB_BROADCAST_VNNMAP 0xF0000003
+/* send a broadcast to all connected nodes */
+#define CTDB_BROADCAST_CONNECTED 0xF0000004
+
+
+
 
+
+
+typedef void ctdb_handle;
+struct ctdb_client_control_state;
+
+typedef void (*ctdb_control_callback)(int32_t status, struct ctdb_context *ctdb, struct ctdb_client_control_state *state, void *private_data);
+
+
+/*
+ * functions to attach to a database
+ * if the database does not exist it will be created.
+ *
+ * You have to free the handle with ctdb_free() when finished with it.
+ */
+struct ctdb_db_context;
+
+typedef void (*ctdb_attachdb_cb)(int32_t status, ctdb_handle *, struct ctdb_db_context *ctdb_db, void *private_data);
+
+ctdb_handle *
+ctdb_attachdb_send(struct ctdb_context *ctdb,
+                  const char *name, int persistent, uint32_t tdb_flags,
+                  ctdb_attachdb_cb callback,
+                  void *private_data);
+int ctdb_attachdb_recv(struct ctdb_context *ctdb,
+                      ctdb_handle *handle, struct ctdb_db_context **);
+int ctdb_attachdb(struct ctdb_context *ctdb,
+                 const char *name, int persistent, uint32_t tdb_flags,
+                 struct ctdb_db_context **);
+
+
+/*
+ * functions to read a record from the database
+ * when the callback is invoked, the client will hold an exclusive lock
+ * on the record, until the handle is ctdb_free()d.
+ * the client MUST NOT block during holding this lock and MUST
+ * release it quickly by performing ctdb_free(handle).
+ *
+ * When the handle is freed, data is freed too, so make sure to copy the data
+ * before freeing the handle.
+ */
+typedef void (*ctdb_readrecordlock_cb)(int32_t status, ctdb_handle *handle, TDB_DATA data, void *private_data);
+
+ctdb_handle *
+ctdb_readrecordlock_send(struct ctdb_context *ctdb,
+               struct ctdb_db_context *ctdb_db_context,
+               TDB_DATA key,
+               ctdb_readrecordlock_cb callback,
+               void *private_data);
+int ctdb_readrecordlock_recv(struct ctdb_context *ctdb,
+               ctdb_handle *handle,
+               TDB_DATA **data);
+int ctdb_readrecordlock(struct ctdb_context *ctdb,
+               struct ctdb_db_context *ctdb_db_context,
+               TDB_DATA key,
+               TDB_DATA **data);
+
+
+
+/*
+ * Function to write data to a record
+ * This function may ONLY be called while holding a lock to the record 
+ * created by ctdb_readrecordlock*
+ * Either from the callback provided to ctdb_readrecordlock_send()
+ * or after calling ctdb_readrecordlock_recv() but before calling
+ * ctdb_free() to release the handle.
+ */
+int ctdb_writerecord(ctdb_handle *handle,
+               TDB_DATA key,
+               TDB_DATA data);
+
+
+
+/*
+   Messaging serverid ports
+*/
 /* 
    a message handler ID meaning "give me all messages"
  */
 #define CTDB_SRVID_ALL (~(uint64_t)0)
 
+/*
+   The top 32 bits of the server id represents the owner of
+   this part of the srvid space
+*/
+#define CTDB_SRVID_MASK        0xFFFFFFFF00000000LL
+
+
+/*
+   Samba owns all message handler IDs where the top 32 bits are all zero
+*/
+#define CTDB_SRVID_SAMBA               0x0000000000000000
+#define CTDB_IS_SAMBA_SRVID(srvid)     ((srvid & CTDB_SRVID_MASK) == CTDB_SRVID_SAMBA)
+
+/*
+   Server ids reserved for testing 
+*/
+#define CTDB_SRVID_TEST                        0x0000000100000000
+#define CTDB_IS_TEST_SRVID(srvid)      ((srvid & CTDB_SRVID_MASK) == CTDB_SRVID_TEST)
+
 /*
   srvid type : RECOVERY
 */
@@ -75,6 +191,12 @@ struct ctdb_call_info {
  */
 #define CTDB_SRVID_SET_NODE_FLAGS 0xF400000000000000LL
 
+/* 
+   a message ID to ask the recovery daemon to update the expected node
+   assignment for a public ip
+ */
+#define CTDB_SRVID_RECD_UPDATE_IP 0xF500000000000000LL
+
 /*
   a message to tell the recovery daemon to fetch a set of records
  */
@@ -115,628 +237,109 @@ struct ctdb_call_info {
  */
 #define CTDB_SRVID_SAMBA_NOTIFY  0xFE00000000000000LL
 
-/* used on the domain socket, send a pdu to the local daemon */
-#define CTDB_CURRENT_NODE     0xF0000001
-/* send a broadcast to all nodes in the cluster, active or not */
-#define CTDB_BROADCAST_ALL    0xF0000002
-/* send a broadcast to all nodes in the current vnn map */
-#define CTDB_BROADCAST_VNNMAP 0xF0000003
-/* send a broadcast to all connected nodes */
-#define CTDB_BROADCAST_CONNECTED 0xF0000004
-
-/* the key used for transaction locking on persistent databases */
-#define CTDB_TRANSACTION_LOCK_KEY "__transaction_lock__"
-
-/* the key used to store persistent db sequence number */
-#define CTDB_DB_SEQNUM_KEY "__db_sequence_number__"
-
-enum control_state {CTDB_CONTROL_WAIT, CTDB_CONTROL_DONE, CTDB_CONTROL_ERROR, CTDB_CONTROL_TIMEOUT};
-
-struct ctdb_client_control_state {
-       struct ctdb_context *ctdb;
-       uint32_t reqid;
-       int32_t status;
-       TDB_DATA outdata;
-       enum control_state state;
-       char *errormsg;
-       struct ctdb_req_control *c;
-
-       /* if we have a callback registered for the completion (or failure) of
-          this control
-          if a callback is used, it MUST talloc_free the cb_data passed to it
-       */
-       struct {
-               void (*fn)(struct ctdb_client_control_state *);
-               void *private_data;
-       } async;        
-};
-
-struct ctdb_client_notify_register {
-       uint64_t srvid;
-       uint32_t len;
-       uint8_t notify_data[1];
-};
-
-struct ctdb_client_notify_deregister {
-       uint64_t srvid;
-};
-
-struct event_context;
-
-/*
-  initialise ctdb subsystem
-*/
-struct ctdb_context *ctdb_init(struct event_context *ev);
-
-/*
-  choose the transport
-*/
-int ctdb_set_transport(struct ctdb_context *ctdb, const char *transport);
-
 /*
-  set the directory for the local databases
-*/
-int ctdb_set_tdb_dir(struct ctdb_context *ctdb, const char *dir);
-int ctdb_set_tdb_dir_persistent(struct ctdb_context *ctdb, const char *dir);
-int ctdb_set_tdb_dir_state(struct ctdb_context *ctdb, const char *dir);
-
-/*
-  set some flags
-*/
-void ctdb_set_flags(struct ctdb_context *ctdb, unsigned flags);
-
-/*
-  set max acess count before a dmaster migration
-*/
-void ctdb_set_max_lacount(struct ctdb_context *ctdb, unsigned count);
-
-/*
-  tell ctdb what address to listen on, in transport specific format
-*/
-int ctdb_set_address(struct ctdb_context *ctdb, const char *address);
-
-int ctdb_set_socketname(struct ctdb_context *ctdb, const char *socketname);
-
-/*
-  tell ctdb what nodes are available. This takes a filename, which will contain
-  1 node address per line, in a transport specific format
-*/
-int ctdb_set_nlist(struct ctdb_context *ctdb, const char *nlist);
-
-/*
-  Check that a specific ip address exists in the node list and returns
-  the id for the node or -1
-*/
-int ctdb_ip_to_nodeid(struct ctdb_context *ctdb, const char *nodeip);
-
-/*
-  start the ctdb protocol
-*/
-int ctdb_start(struct ctdb_context *ctdb);
-int ctdb_start_daemon(struct ctdb_context *ctdb, bool do_fork, bool use_syslog);
-
-/*
-  attach to a ctdb database
-*/
-struct ctdb_db_context *ctdb_attach(struct ctdb_context *ctdb, const char *name, bool persistent, uint32_t tdb_flags);
-
-/*
-  find an attached ctdb_db handle given a name
+ * messaging functions
+ * these functions provide a messaging layer for applications to communicate
+ * with eachother across
  */
-struct ctdb_db_context *ctdb_db_handle(struct ctdb_context *ctdb, const char *name);
-
-/*
-  error string for last ctdb error
-*/
-const char *ctdb_errstr(struct ctdb_context *);
-
-/* a ctdb call function */
-typedef int (*ctdb_fn_t)(struct ctdb_call_info *);
-
-/*
-  setup a ctdb call function
-*/
-int ctdb_set_call(struct ctdb_db_context *ctdb_db, ctdb_fn_t fn, uint32_t id);
-
-
-
-/*
-  make a ctdb call. The associated ctdb call function will be called on the DMASTER
-  for the given record
-*/
-int ctdb_call(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
-
-/*
-  initiate an ordered ctdb cluster shutdown
-  this function will never return
-*/
-void ctdb_shutdown(struct ctdb_context *ctdb);
-
-/* return pnn of this node */
-uint32_t ctdb_get_pnn(struct ctdb_context *ctdb);
+typedef void (*ctdb_message_fn_t)(struct ctdb_context *, uint64_t srvid, TDB_DATA data, void *);
 
 /*
-  return the number of nodes
-*/
-uint32_t ctdb_get_num_nodes(struct ctdb_context *ctdb);
-
-/* setup a handler for ctdb messages */
-typedef void (*ctdb_message_fn_t)(struct ctdb_context *, uint64_t srvid, 
-                                 TDB_DATA data, void *);
-int ctdb_set_message_handler(struct ctdb_context *ctdb, uint64_t srvid, 
-                            ctdb_message_fn_t handler,
-                            void *private_data);
-
-
-int ctdb_call(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
-struct ctdb_client_call_state *ctdb_call_send(struct ctdb_db_context *ctdb_db, struct ctdb_call *call);
-int ctdb_call_recv(struct ctdb_client_call_state *state, struct ctdb_call *call);
-
-/* send a ctdb message */
-int ctdb_send_message(struct ctdb_context *ctdb, uint32_t pnn,
-                     uint64_t srvid, TDB_DATA data);
-
-
-/* 
-   Fetch a ctdb record from a remote node
- . Underneath this will force the
-   dmaster for the record to be moved to the local node. 
-*/
-struct ctdb_record_handle *ctdb_fetch_lock(struct ctdb_db_context *ctdb_db, TALLOC_CTX *mem_ctx, 
-                                          TDB_DATA key, TDB_DATA *data);
-
-int ctdb_record_store(struct ctdb_record_handle *h, TDB_DATA data);
-
-int ctdb_fetch(struct ctdb_db_context *ctdb_db, TALLOC_CTX *mem_ctx, 
-              TDB_DATA key, TDB_DATA *data);
-
-int ctdb_register_message_handler(struct ctdb_context *ctdb, 
-                                 TALLOC_CTX *mem_ctx,
-                                 uint64_t srvid,
-                                 ctdb_message_fn_t handler,
-                                 void *private_data);
-
-struct ctdb_db_context *find_ctdb_db(struct ctdb_context *ctdb, uint32_t id);
-
-
-struct ctdb_context *ctdb_cmdline_client(struct event_context *ev);
+ * register a message handler and start listening on a service port
+ */
+typedef void (*ctdb_set_message_handler_cb)(int32_t status, void *private_data);
 
-struct ctdb_statistics;
-int ctdb_ctrl_statistics(struct ctdb_context *ctdb, uint32_t destnode, struct ctdb_statistics *status);
+ctdb_handle *
+ctdb_set_message_handler_send(struct ctdb_context *ctdb, uint64_t srvid,
+                             ctdb_set_message_handler_cb callback,
+                             ctdb_message_fn_t handler, void *private_data);
 
-int ctdb_ctrl_shutdown(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
+int ctdb_set_message_handler_recv(struct ctdb_context *ctdb,
+                                 ctdb_handle *handle);
 
-struct ctdb_vnn_map;
-int ctdb_ctrl_getvnnmap(struct ctdb_context *ctdb, 
-               struct timeval timeout, uint32_t destnode, 
-               TALLOC_CTX *mem_ctx, struct ctdb_vnn_map **vnnmap);
-int ctdb_ctrl_setvnnmap(struct ctdb_context *ctdb,
-               struct timeval timeout, uint32_t destnode, 
-               TALLOC_CTX *mem_ctx, struct ctdb_vnn_map *vnnmap);
+int ctdb_set_message_handler(struct ctdb_context *ctdb, uint64_t srvid,
+                            ctdb_message_fn_t handler, void *private_data);
 
-/* table that contains a list of all dbids on a node
- */
-struct ctdb_dbid_map {
-       uint32_t num;
-       struct ctdb_dbid {
-               uint32_t dbid;
-               bool persistent;
-       } dbs[1];
-};
-int ctdb_ctrl_getdbmap(struct ctdb_context *ctdb, 
-       struct timeval timeout, uint32_t destnode, 
-       TALLOC_CTX *mem_ctx, struct ctdb_dbid_map **dbmap);
-
-
-struct ctdb_node_map;
-
-int ctdb_ctrl_getnodemap(struct ctdb_context *ctdb, 
-                   struct timeval timeout, uint32_t destnode, 
-                   TALLOC_CTX *mem_ctx, struct ctdb_node_map **nodemap);
-
-int ctdb_ctrl_getnodemapv4(struct ctdb_context *ctdb, 
-                   struct timeval timeout, uint32_t destnode, 
-                   TALLOC_CTX *mem_ctx, struct ctdb_node_map **nodemap);
-
-int ctdb_ctrl_reload_nodes_file(struct ctdb_context *ctdb, 
-                   struct timeval timeout, uint32_t destnode);
-
-struct ctdb_key_list {
-       uint32_t dbid;
-       uint32_t num;
-       TDB_DATA *keys;
-       struct ctdb_ltdb_header *headers;
-       TDB_DATA *data;
-};
-
-int ctdb_ctrl_pulldb(
-       struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
-       uint32_t lmaster, TALLOC_CTX *mem_ctx,
-       struct timeval timeout, TDB_DATA *outdata);
-
-struct ctdb_client_control_state *ctdb_ctrl_pulldb_send(
-       struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
-       uint32_t lmaster, TALLOC_CTX *mem_ctx, struct timeval timeout);
-
-int ctdb_ctrl_pulldb_recv(
-       struct ctdb_context *ctdb,
-       TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state,
-       TDB_DATA *outdata);
-
-int ctdb_ctrl_pushdb(
-       struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
-       TALLOC_CTX *mem_ctx,
-       struct timeval timeout, TDB_DATA indata);
-
-struct ctdb_client_control_state *ctdb_ctrl_pushdb_send(
-       struct ctdb_context *ctdb, uint32_t destnode, uint32_t dbid,
-       TALLOC_CTX *mem_ctx, struct timeval timeout,
-       TDB_DATA indata);
-
-int ctdb_ctrl_pushdb_recv(
-       struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx,
-       struct ctdb_client_control_state *state);
-
-
-int ctdb_ctrl_copydb(struct ctdb_context *ctdb, 
-       struct timeval timeout, uint32_t sourcenode, 
-       uint32_t destnode, uint32_t dbid, uint32_t lmaster, 
-       TALLOC_CTX *mem_ctx);
-
-int ctdb_ctrl_getdbpath(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t dbid, TALLOC_CTX *mem_ctx, const char **path);
-int ctdb_ctrl_getdbname(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t dbid, TALLOC_CTX *mem_ctx, const char **name);
-int ctdb_ctrl_getdbhealth(struct ctdb_context *ctdb,
-                         struct timeval timeout,
-                         uint32_t destnode,
-                         uint32_t dbid, TALLOC_CTX *mem_ctx,
-                         const char **reason);
-int ctdb_ctrl_createdb(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, TALLOC_CTX *mem_ctx, const char *name, bool persistent);
-
-int ctdb_ctrl_process_exists(struct ctdb_context *ctdb, uint32_t destnode, pid_t pid);
-
-int ctdb_ctrl_ping(struct ctdb_context *ctdb, uint32_t destnode);
-
-int ctdb_ctrl_get_config(struct ctdb_context *ctdb);
-
-int ctdb_ctrl_get_debuglevel(struct ctdb_context *ctdb, uint32_t destnode, int32_t *level);
-int ctdb_ctrl_set_debuglevel(struct ctdb_context *ctdb, uint32_t destnode, int32_t level);
 
-/*
-  change dmaster for all keys in the database to the new value
- */
-int ctdb_ctrl_setdmaster(struct ctdb_context *ctdb, 
-       struct timeval timeout, uint32_t destnode, 
-       TALLOC_CTX *mem_ctx, uint32_t dbid, uint32_t dmaster);
 
 /*
-  write a record on a specific db (this implicitely updates dmaster of the record to locally be the vnn of the node where the control is executed on)
+ * unregister a message handler and stop listening on teh specified port
  */
-int ctdb_ctrl_write_record(struct ctdb_context *ctdb, uint32_t destnode, TALLOC_CTX *mem_ctx, uint32_t dbid, TDB_DATA key, TDB_DATA data);
+typedef void (*ctdb_remove_message_handler_cb)(int32_t status, void *private_data);
 
-#define CTDB_RECOVERY_NORMAL           0
-#define CTDB_RECOVERY_ACTIVE           1
+ctdb_handle *
+ctdb_remove_message_handler_send(struct ctdb_context *ctdb, uint64_t srvid,
+                                ctdb_remove_message_handler_cb callback,
+                                void *private_data);
 
-/*
-  get the recovery mode of a remote node
- */
-int ctdb_ctrl_getrecmode(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, uint32_t *recmode);
+int ctdb_remove_message_handler_recv(struct ctdb_context *ctdb,
+                                 ctdb_handle *handle);
 
-struct ctdb_client_control_state *ctdb_ctrl_getrecmode_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
-
-int ctdb_ctrl_getrecmode_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *recmode);
-
-
-/*
-  set the recovery mode of a remote node
- */
-int ctdb_ctrl_setrecmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmode);
-/*
-  get the monitoring mode of a remote node
- */
-int ctdb_ctrl_getmonmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *monmode);
-
-/*
-  set the monitoring mode of a remote node to active
- */
-int ctdb_ctrl_enable_monmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
+int ctdb_remove_message_handler(struct ctdb_context *ctdb, uint64_t srvid);
 
-/*
-  set the monitoring mode of a remote node to disabled
- */
-int ctdb_ctrl_disable_monmode(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
 
 
 /*
-  get the recovery master of a remote node
+ * send a message to a specific node/port
+ * this function is non-blocking
  */
-int ctdb_ctrl_getrecmaster(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, uint32_t *recmaster);
+int ctdb_send_message(struct ctdb_context *ctdb, uint32_t pnn, uint64_t srvid, TDB_DATA data);
 
-struct ctdb_client_control_state *ctdb_ctrl_getrecmaster_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
-
-int ctdb_ctrl_getrecmaster_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *recmaster);
 
 
 
 /*
-  set the recovery master of a remote node
+ * functions to read the pnn number of the local node
+ *
+ * ctdb_cancel_control(state) is used
+ * to abort this command before it completes.
  */
-int ctdb_ctrl_setrecmaster(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmaster);
-
-uint32_t *ctdb_get_connected_nodes(struct ctdb_context *ctdb, 
-                                  struct timeval timeout, 
-                                  TALLOC_CTX *mem_ctx,
-                                  uint32_t *num_nodes);
-
-int ctdb_statistics_reset(struct ctdb_context *ctdb, uint32_t destnode);
+struct ctdb_client_control_state *
+ctdb_getpnn_send(struct ctdb_context *ctdb,
+                uint32_t destnode,
+                ctdb_control_callback callback,
+                void *private_data);
+int ctdb_getpnn_recv(struct ctdb_context *ctdb,
+                    struct ctdb_client_control_state *state,
+                    uint32_t *pnn);
+int ctdb_getpnn(struct ctdb_context *ctdb,
+               uint32_t destnode,
+               uint32_t *pnn);
 
-int ctdb_set_logfile(struct ctdb_context *ctdb, const char *logfile, bool use_syslog);
 
-typedef int (*ctdb_traverse_func)(struct ctdb_context *, TDB_DATA, TDB_DATA, void *);
-int ctdb_traverse(struct ctdb_db_context *ctdb_db, ctdb_traverse_func fn, void *private_data);
 
-int ctdb_dumpdb_record(struct ctdb_context *ctdb, TDB_DATA key, TDB_DATA data, void *p);
-int ctdb_dump_db(struct ctdb_db_context *ctdb_db, FILE *f);
 
 /*
-  get the pid of a ctdb daemon
+ * functions to read the recovery master of a node
+ *
+ * ctdb_cancel_control(state) is used
+ * to abort this command before it completes.
  */
-int ctdb_ctrl_getpid(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *pid);
+struct ctdb_client_control_state *
+ctdb_getrecmaster_send(struct ctdb_context *ctdb,
+                       uint32_t destnode,
+                       ctdb_control_callback callback,
+                       void *private_data);
+int ctdb_getrecmaster_recv(struct ctdb_context *ctdb,
+                          struct ctdb_client_control_state *state,
+                          uint32_t *recmaster);
+int ctdb_getrecmaster(struct ctdb_context *ctdb,
+                       uint32_t destnode,
+                       uint32_t *recmaster);
 
-int ctdb_ctrl_freeze(struct ctdb_context *ctdb, struct timeval timeout, 
-                       uint32_t destnode);
-int ctdb_ctrl_freeze_priority(struct ctdb_context *ctdb, struct timeval timeout, 
-                             uint32_t destnode, uint32_t priority);
 
-struct ctdb_client_control_state *
-ctdb_ctrl_freeze_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, 
-                     struct timeval timeout, uint32_t destnode,
-                     uint32_t priority);
-
-int ctdb_ctrl_freeze_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, 
-                       struct ctdb_client_control_state *state);
-
-int ctdb_ctrl_thaw_priority(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t priority);
-int ctdb_ctrl_thaw(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
-
-int ctdb_ctrl_getpnn(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
-
-int ctdb_ctrl_get_tunable(struct ctdb_context *ctdb, 
-                         struct timeval timeout, 
-                         uint32_t destnode,
-                         const char *name, uint32_t *value);
-
-int ctdb_ctrl_set_tunable(struct ctdb_context *ctdb, 
-                         struct timeval timeout, 
-                         uint32_t destnode,
-                         const char *name, uint32_t value);
-
-int ctdb_ctrl_list_tunables(struct ctdb_context *ctdb, 
-                           struct timeval timeout, 
-                           uint32_t destnode,
-                           TALLOC_CTX *mem_ctx,
-                           const char ***list, uint32_t *count);
-
-int ctdb_ctrl_modflags(struct ctdb_context *ctdb, 
-                      struct timeval timeout, 
-                      uint32_t destnode, 
-                      uint32_t set, uint32_t clear);
-
-enum ctdb_server_id_type { SERVER_TYPE_SAMBA=1 };
-
-struct ctdb_server_id {
-       enum ctdb_server_id_type type;
-       uint32_t pnn;
-       uint32_t server_id;
-};
-
-struct ctdb_server_id_list {
-       uint32_t num;
-       struct ctdb_server_id server_ids[1];
-};
-
-
-int ctdb_ctrl_register_server_id(struct ctdb_context *ctdb,
-               struct timeval timeout,
-               struct ctdb_server_id *id);
-int ctdb_ctrl_unregister_server_id(struct ctdb_context *ctdb, 
-               struct timeval timeout, 
-               struct ctdb_server_id *id);
-int ctdb_ctrl_check_server_id(struct ctdb_context *ctdb,
-               struct timeval timeout, uint32_t destnode, 
-               struct ctdb_server_id *id, uint32_t *status);
-int ctdb_ctrl_get_server_id_list(struct ctdb_context *ctdb,
-               TALLOC_CTX *mem_ctx,
-               struct timeval timeout, uint32_t destnode, 
-               struct ctdb_server_id_list **svid_list);
-
-struct ctdb_uptime {
-       struct timeval current_time;
-       struct timeval ctdbd_start_time;
-       struct timeval last_recovery_started;
-       struct timeval last_recovery_finished;
-};
 
 /*
-  definitions for different socket structures
+ * Cancel a control before it has completed
  */
-typedef struct sockaddr_in ctdb_addr_in;
-typedef struct sockaddr_in6 ctdb_addr_in6;
-typedef union {
-       struct sockaddr sa;
-       ctdb_addr_in    ip;
-       ctdb_addr_in6   ip6;
-} ctdb_sock_addr;
+int ctdb_cancel_control(struct ctdb_client_control_state *state);
 
-/*
-  struct for tcp_client control
-  this is an ipv4 only version of this structure used by samba
-  samba will later be migrated over to use the 
-  ctdb_control_tcp_addr structure instead
- */
-struct ctdb_control_tcp {
-       struct sockaddr_in src; // samba uses this
-       struct sockaddr_in dest;// samba uses this
-};
-/* new style structure */
-struct ctdb_control_tcp_addr {
-       ctdb_sock_addr src;
-       ctdb_sock_addr dest;
-};
-
-int ctdb_socket_connect(struct ctdb_context *ctdb);
 
 /*
 get the uptime of a remote node
* release a handle
  */
-int ctdb_ctrl_uptime(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode, struct ctdb_uptime **uptime);
-
-struct ctdb_client_control_state *ctdb_ctrl_uptime_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
-
-int ctdb_ctrl_uptime_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, struct ctdb_uptime **uptime);
-
-int ctdb_ctrl_end_recovery(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
-
-int ctdb_ctrl_getreclock(struct ctdb_context *ctdb, 
-       struct timeval timeout, uint32_t destnode, 
-       TALLOC_CTX *mem_ctx, const char **reclock);
-int ctdb_ctrl_setreclock(struct ctdb_context *ctdb, 
-       struct timeval timeout, uint32_t destnode, 
-       const char *reclock);
+int ctdb_free(ctdb_handle *);
 
 
-uint32_t *list_of_connected_nodes(struct ctdb_context *ctdb,
-                               struct ctdb_node_map *node_map,
-                               TALLOC_CTX *mem_ctx,
-                               bool include_self);
-uint32_t *list_of_active_nodes(struct ctdb_context *ctdb,
-                               struct ctdb_node_map *node_map,
-                               TALLOC_CTX *mem_ctx,
-                               bool include_self);
-uint32_t *list_of_vnnmap_nodes(struct ctdb_context *ctdb,
-                               struct ctdb_vnn_map *vnn_map,
-                               TALLOC_CTX *mem_ctx,
-                               bool include_self);
-uint32_t *list_of_active_nodes_except_pnn(struct ctdb_context *ctdb,
-                               struct ctdb_node_map *node_map,
-                               TALLOC_CTX *mem_ctx,
-                               uint32_t pnn);
-
-int ctdb_read_pnn_lock(int fd, int32_t pnn);
-
-/*
-  get capabilities of a remote node
- */
-int ctdb_ctrl_getcapabilities(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t *capabilities);
-
-struct ctdb_client_control_state *ctdb_ctrl_getcapabilities_send(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct timeval timeout, uint32_t destnode);
-
-int ctdb_ctrl_getcapabilities_recv(struct ctdb_context *ctdb, TALLOC_CTX *mem_ctx, struct ctdb_client_control_state *state, uint32_t *capabilities);
-
-
-int32_t ctdb_ctrl_transaction_active(struct ctdb_context *ctdb,
-                                    uint32_t destnode,
-                                    uint32_t db_id);
-
-struct ctdb_marshall_buffer *ctdb_marshall_add(TALLOC_CTX *mem_ctx, 
-                                              struct ctdb_marshall_buffer *m,
-                                              uint64_t db_id,
-                                              uint32_t reqid,
-                                              TDB_DATA key,
-                                              struct ctdb_ltdb_header *header,
-                                              TDB_DATA data);
-TDB_DATA ctdb_marshall_finish(struct ctdb_marshall_buffer *m);
-
-struct ctdb_transaction_handle *ctdb_transaction_start(struct ctdb_db_context *ctdb_db,
-                                                      TALLOC_CTX *mem_ctx);
-int ctdb_transaction_fetch(struct ctdb_transaction_handle *h, 
-                          TALLOC_CTX *mem_ctx, 
-                          TDB_DATA key, TDB_DATA *data);
-int ctdb_transaction_store(struct ctdb_transaction_handle *h, 
-                          TDB_DATA key, TDB_DATA data);
-int ctdb_transaction_commit(struct ctdb_transaction_handle *h);
-
-int ctdb_ctrl_recd_ping(struct ctdb_context *ctdb);
-
-int switch_from_server_to_client(struct ctdb_context *ctdb);
-
-#define MONITOR_SCRIPT_OK      0
-#define MONITOR_SCRIPT_TIMEOUT 1
-
-#define MAX_SCRIPT_NAME 31
-#define MAX_SCRIPT_OUTPUT 511
-struct ctdb_script_wire {
-       char name[MAX_SCRIPT_NAME+1];
-       struct timeval start;
-       struct timeval finished;
-       int32_t status;
-       char output[MAX_SCRIPT_OUTPUT+1];
-};
-
-struct ctdb_scripts_wire {
-       uint32_t num_scripts;
-       struct ctdb_script_wire scripts[1];
-};
-
-/* different calls to event scripts. */
-enum ctdb_eventscript_call {
-       CTDB_EVENT_INIT,                /* CTDB starting up: no args */
-       CTDB_EVENT_SETUP,               /* CTDB starting up after transport is readdy: no args. */
-       CTDB_EVENT_STARTUP,             /* CTDB starting up after initial recovery: no args. */
-       CTDB_EVENT_START_RECOVERY,      /* CTDB recovery starting: no args. */
-       CTDB_EVENT_RECOVERED,           /* CTDB recovery finished: no args. */
-       CTDB_EVENT_TAKE_IP,             /* IP taken: interface, IP address, netmask bits. */
-       CTDB_EVENT_RELEASE_IP,          /* IP released: interface, IP address, netmask bits. */
-       CTDB_EVENT_STOPPED,             /* This node is stopped: no args. */
-       CTDB_EVENT_MONITOR,             /* Please check if service is healthy: no args. */
-       CTDB_EVENT_STATUS,              /* Report service status: no args. */
-       CTDB_EVENT_SHUTDOWN,            /* CTDB shutting down: no args. */
-       CTDB_EVENT_RELOAD,              /* magic */
-       CTDB_EVENT_UPDATE_IP,           /* IP updating: old interface, new interface, IP address, netmask bits. */
-       CTDB_EVENT_MAX
-};
-
-/* Mapping from enum to names. */
-extern const char *ctdb_eventscript_call_names[];
-
-int ctdb_ctrl_getscriptstatus(struct ctdb_context *ctdb, 
-                   struct timeval timeout, uint32_t destnode, 
-                   TALLOC_CTX *mem_ctx, enum ctdb_eventscript_call type,
-                   struct ctdb_scripts_wire **script_status);
-
-
-struct debug_levels {
-       int32_t level;
-       const char *description;
-};
-extern struct debug_levels debug_levels[];
-
-const char *get_debug_by_level(int32_t level);
-int32_t get_debug_by_desc(const char *desc);
-
-int ctdb_ctrl_stop_node(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
-int ctdb_ctrl_continue_node(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode);
-
-int ctdb_ctrl_setnatgwstate(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t natgwstate);
-int ctdb_ctrl_setlmasterrole(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t lmasterrole);
-int ctdb_ctrl_setrecmasterrole(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t recmasterrole);
-
-int ctdb_ctrl_enablescript(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, const char *script);
-int ctdb_ctrl_disablescript(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, const char *script);
-
-struct ctdb_ban_time {
-       uint32_t pnn;
-       uint32_t time;
-};
-
-int ctdb_ctrl_set_ban(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, struct ctdb_ban_time *bantime);
-int ctdb_ctrl_get_ban(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, TALLOC_CTX *mem_ctx, struct ctdb_ban_time **bantime);
-
-struct ctdb_db_priority {
-       uint32_t db_id;
-       uint32_t priority;
-};
-
-int ctdb_ctrl_set_db_priority(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, struct ctdb_db_priority *db_prio);
-int ctdb_ctrl_get_db_priority(struct ctdb_context *ctdb, struct timeval timeout, uint32_t destnode, uint32_t db_id, uint32_t *priority);
 
 #endif