source4/cluster/ctdb/include/ctdb.h

   1 /*
   2    ctdb database library
   3
   4    Copyright (C) Andrew Tridgell  2006
   5
   6    This library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2 of the License, or (at your option) any later version.
  10
  11    This library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with this library; if not, write to the Free Software
  18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19 */
  20
  21 #ifndef _CTDB_H
  22 #define _CTDB_H
  23
  24 /*
  25   structure passed to a ctdb call function
  26 */
  27 struct ctdb_call {
  28         TDB_DATA key;          /* record key */
  29         TDB_DATA record_data;  /* current data in the record */
  30         TDB_DATA *new_data;    /* optionally updated record data */
  31         TDB_DATA *call_data;   /* optionally passed from caller */
  32         TDB_DATA *reply_data;  /* optionally returned by function */
  33 };
  34
  35 #define CTDB_ERR_INVALID 1
  36 #define CTDB_ERR_NOMEM 2
  37
  38 /*
  39   ctdb flags
  40 */
  41 #define CTDB_FLAG_SELF_CONNECT (1<<0)
  42
  43
  44 struct event_context;
  45
  46 /*
  47   initialise ctdb subsystem
  48 */
  49 struct ctdb_context *ctdb_init(struct event_context *ev);
  50
  51 /*
  52   choose the transport
  53 */
  54 int ctdb_set_transport(struct ctdb_context *ctdb, const char *transport);
  55
  56 /*
  57   set some flags
  58 */
  59 void ctdb_set_flags(struct ctdb_context *ctdb, unsigned flags);
  60
  61 /*
  62   set max acess count before a dmaster migration
  63 */
  64 void ctdb_set_max_lacount(struct ctdb_context *ctdb, unsigned count);
  65
  66 /*
  67   tell ctdb what address to listen on, in transport specific format
  68 */
  69 int ctdb_set_address(struct ctdb_context *ctdb, const char *address);
  70
  71 /*
  72   tell ctdb what nodes are available. This takes a filename, which will contain
  73   1 node address per line, in a transport specific format
  74 */
  75 int ctdb_set_nlist(struct ctdb_context *ctdb, const char *nlist);
  76
  77 /*
  78   start the ctdb protocol
  79 */
  80 int ctdb_start(struct ctdb_context *ctdb);
  81
  82 /*
  83   error string for last ctdb error
  84 */
  85 const char *ctdb_errstr(struct ctdb_context *);
  86
  87 /* a ctdb call function */
  88 typedef int (*ctdb_fn_t)(struct ctdb_call *);
  89
  90 /*
  91   setup a ctdb call function
  92 */
  93 int ctdb_set_call(struct ctdb_context *ctdb, ctdb_fn_t fn, int id);
  94
  95 /*
  96   attach to a ctdb database
  97 */
  98 int ctdb_attach(struct ctdb_context *ctdb, const char *name, int tdb_flags,
  99                 int open_flags, mode_t mode);
 100
 101
 102 /*
 103   make a ctdb call. The associated ctdb call function will be called on the DMASTER
 104   for the given record
 105 */
 106 int ctdb_call(struct ctdb_context *ctdb, TDB_DATA key, int call_id,
 107               TDB_DATA *call_data, TDB_DATA *reply_data);
 108
 109 /*
 110   wait for all nodes to be connected - useful for test code
 111 */
 112 void ctdb_connect_wait(struct ctdb_context *ctdb);
 113
 114 /*
 115   wait until we're the only node left
 116 */
 117 void ctdb_wait_loop(struct ctdb_context *ctdb);
 118
 119 /* return vnn of this node */
 120 uint32_t ctdb_get_vnn(struct ctdb_context *ctdb);
 121
 122 #endif