dbwrap: add enum dbwrap_req_state

[kai/samba-autobuild/.git] / lib / dbwrap / dbwrap.h

diff --git a/lib/dbwrap/dbwrap.h b/lib/dbwrap/dbwrap.h
index 366e657680f271ede91ad9de1f69ed60f60f87f0..936e66247d762b7af05995e729ab3f30a684eb78 100644 (file)
--- a/lib/dbwrap/dbwrap.h
+++ b/lib/dbwrap/dbwrap.h
@@ -20,17 +20,52 @@
 #ifndef __DBWRAP_H__
 #define __DBWRAP_H__
 
+#include "replace.h"
+#include <talloc.h>
+#include "libcli/util/ntstatus.h"
 #include "tdb.h"
+#include "lib/param/loadparm.h"
 
 struct db_record;
 struct db_context;
 
 enum dbwrap_lock_order {
+       DBWRAP_LOCK_ORDER_NONE = 0, /* Don't check lock orders for this db. */
+       /*
+        * We only allow orders 1, 2, 3:
+        * These are the orders that CTDB currently supports.
+        */
        DBWRAP_LOCK_ORDER_1 = 1,
        DBWRAP_LOCK_ORDER_2 = 2,
        DBWRAP_LOCK_ORDER_3 = 3
 };
 
+#define DBWRAP_FLAG_NONE                     0x0000000000000000ULL
+#define DBWRAP_FLAG_OPTIMIZE_READONLY_ACCESS 0x0000000000000001ULL
+
+enum dbwrap_req_state {
+       /**
+        * We are creating the request
+        */
+       DBWRAP_REQ_INIT,
+       /**
+        * The request is queued and waiting to be dispatched
+        */
+       DBWRAP_REQ_QUEUED,
+       /**
+        * We are waiting to receive the reply
+        */
+       DBWRAP_REQ_DISPATCHED,
+       /**
+        * The request is finished
+        */
+       DBWRAP_REQ_DONE,
+       /**
+        * The request errored out
+        */
+       DBWRAP_REQ_ERROR
+};
+
 /* The following definitions come from lib/dbwrap.c  */
 
 TDB_DATA dbwrap_record_get_key(const struct db_record *rec);
@@ -43,17 +78,7 @@ struct db_record *dbwrap_fetch_locked(struct db_context *db,
 struct db_record *dbwrap_try_fetch_locked(struct db_context *db,
                                          TALLOC_CTX *mem_ctx,
                                          TDB_DATA key);
-struct db_record *dbwrap_fetch_locked_timeout(struct db_context *db,
-                                             TALLOC_CTX *mem_ctx,
-                                             TDB_DATA key,
-                                             unsigned int timeout);
-
 struct db_context *dbwrap_record_get_db(struct db_record *rec);
-void dbwrap_set_stored_callback(
-       struct db_context *db,
-       void (*cb)(struct db_context *db, struct db_record *rec,
-                  void *private_data),
-       void *private_data);
 
 NTSTATUS dbwrap_delete(struct db_context *db, TDB_DATA key);
 NTSTATUS dbwrap_store(struct db_context *db, TDB_DATA key,
@@ -76,21 +101,27 @@ NTSTATUS dbwrap_parse_record(struct db_context *db, TDB_DATA key,
 int dbwrap_wipe(struct db_context *db);
 int dbwrap_check(struct db_context *db);
 int dbwrap_get_seqnum(struct db_context *db);
+/* Returns 0 if unknown. */
 int dbwrap_transaction_start(struct db_context *db);
 NTSTATUS dbwrap_transaction_start_nonblock(struct db_context *db);
 int dbwrap_transaction_commit(struct db_context *db);
 int dbwrap_transaction_cancel(struct db_context *db);
-void dbwrap_db_id(struct db_context *db, const uint8_t **id, size_t *idlen);
-
+size_t dbwrap_db_id(struct db_context *db, uint8_t *id, size_t idlen);
+bool dbwrap_is_persistent(struct db_context *db);
+const char *dbwrap_name(struct db_context *db);
 
 /* The following definitions come from lib/dbwrap_util.c  */
 
+NTSTATUS dbwrap_purge(struct db_context *db, TDB_DATA key);
+NTSTATUS dbwrap_purge_bystring(struct db_context *db, const char *key);
 NTSTATUS dbwrap_delete_bystring(struct db_context *db, const char *key);
 NTSTATUS dbwrap_store_bystring(struct db_context *db, const char *key,
                               TDB_DATA data, int flags);
 NTSTATUS dbwrap_fetch_bystring(struct db_context *db, TALLOC_CTX *mem_ctx,
                               const char *key, TDB_DATA *value);
 
+NTSTATUS dbwrap_fetch_int32(struct db_context *db, TDB_DATA key,
+                           int32_t *result);
 NTSTATUS dbwrap_fetch_int32_bystring(struct db_context *db, const char *keystr,
                                     int32_t *result);
 NTSTATUS dbwrap_store_int32_bystring(struct db_context *db, const char *keystr,
@@ -107,6 +138,10 @@ NTSTATUS dbwrap_trans_change_uint32_atomic_bystring(struct db_context *db,
                                                    const char *keystr,
                                                    uint32_t *oldval,
                                                    uint32_t change_val);
+NTSTATUS dbwrap_change_int32_atomic(struct db_context *db,
+                                   TDB_DATA key,
+                                   int32_t *oldval,
+                                   int32_t change_val);
 NTSTATUS dbwrap_change_int32_atomic_bystring(struct db_context *db,
                                             const char *keystr,
                                             int32_t *oldval,
@@ -140,18 +175,24 @@ NTSTATUS dbwrap_store_bystring_upper(struct db_context *db, const char *key,
 NTSTATUS dbwrap_fetch_bystring_upper(struct db_context *db, TALLOC_CTX *mem_ctx,
                                     const char *key, TDB_DATA *value);
 
+size_t dbwrap_marshall(struct db_context *db, uint8_t *buf, size_t bufsize);
+NTSTATUS dbwrap_parse_marshall_buf(const uint8_t *buf, size_t buflen,
+                                  bool (*fn)(TDB_DATA key, TDB_DATA value,
+                                             void *private_data),
+                                  void *private_data);
+NTSTATUS dbwrap_unmarshall(struct db_context *db, const uint8_t *buf,
+                          size_t buflen);
+
+
 /**
- * This opens an ntdb or tdb file: you can hand it a .ntdb or .tdb extension
- * and it will decide (based on parameter settings, or else what exists) which
- * to use.
- *
- * For backwards compatibility, it takes tdb-style open flags, not ntdb!
+ * This opens a tdb file
  */
 struct db_context *dbwrap_local_open(TALLOC_CTX *mem_ctx,
                                     struct loadparm_context *lp_ctx,
                                     const char *name,
                                     int hash_size, int tdb_flags,
                                     int open_flags, mode_t mode,
-                                    enum dbwrap_lock_order lock_order);
+                                    enum dbwrap_lock_order lock_order,
+                                    uint64_t dbwrap_flags);
 
 #endif /* __DBWRAP_H__ */