etc/cnid_dbd/dbif.h

   1 /*
   2   Copyright (C) Joerg Lenneis 2003
   3   Copyright (C) Frank Lahm 2009
   4   All Rights Reserved.  See COPYING.
   5
   6
   7   API usage
   8   =========
   9
  10   Initialisation
  11   --------------
  12   1. Provide storage for a DBD * handle
  13      DBD *dbd;
  14   2. Call dbif_init with a filename to receive a DBD handle:
  15      dbd = dbif_init("cnid2.db");
  16      Pass NULL to create an in-memory db.
  17      Note: the DBD type is NOT from BerkeleyDB ! We've defined it.
  18   3. Call dbif_env_open to open an dbd environment if you called dbif_init
  19      with a filename. Pass a db_param here for on-disk databases.
  20   4. Call dbif_open to finally open the CNID database itself. Pass db_param
  21      here for in-memory database.
  22
  23   Querying the CNID database
  24   --------------------------
  25   Call dbif_[get|pget|put|del]. They map to the corresponding BerkeleyDB calls
  26   with the same names.
  27
  28   Transactions
  29   ------------
  30   We use AUTO_COMMIT for the BDB database accesses. This avoids explicit transactions
  31   for every bdb access which speeds up reads. But in order to be able to rollback
  32   in case of errors we start a transaction once we encounter the first write from
  33   dbif_put or dbif_del.
  34   Thus you shouldn't call dbif_txn_[begin|abort|commit], they're used internally.
  35
  36   Checkpoiting
  37   ------------
  38   Call dbif_txn_checkpoint.
  39
  40   Closing
  41   -------
  42   Call dbif_close.
  43
  44   Silent Upgrade Support
  45   ----------------------
  46
  47   On cnid_dbd shutdown we reopen the environment with recovery, close and then
  48   remove it. This enables an upgraded netatalk installation possibly linked against
  49   a newer bdb lib to succesfully open/create an environment and then silently
  50   upgrade the database itself. How nice!
  51 */
  52
  53 #ifndef CNID_DBD_DBIF_H
  54 #define CNID_DBD_DBIF_H 1
  55
  56 #include <db.h>
  57 #include <atalk/adouble.h>
  58 #include "db_param.h"
  59
  60 #define DBIF_DB_CNT 4
  61
  62 #define DBIF_CNID          0
  63 #define DBIF_IDX_DEVINO    1
  64 #define DBIF_IDX_DIDNAME   2
  65 #define DBIF_IDX_NAME      3
  66
  67 /* get_lock cmd and return value */
  68 #define LOCKFILENAME  "lock"
  69 #define LOCK_FREE          0
  70 #define LOCK_UNLOCK        1
  71 #define LOCK_EXCL          2
  72 #define LOCK_SHRD          3
  73
  74 /* Structures */
  75 typedef struct {
  76     char     *name;
  77     DB       *db;
  78     uint32_t flags;
  79     uint32_t openflags;
  80     DBTYPE   type;
  81 } db_table;
  82
  83 typedef struct {
  84     DB_ENV   *db_env;
  85     struct db_param db_param;
  86     DB_TXN   *db_txn;
  87     DBC      *db_cur;              /* for dbif_walk */
  88     char     *db_envhome;
  89     char     *db_filename;
  90     FILE     *db_errlog;
  91     db_table db_table[DBIF_DB_CNT];
  92 } DBD;
  93
  94 /* Functions */
  95 extern int get_lock(int cmd, const char *dbpath);
  96
  97 extern DBD *dbif_init(const char *envhome, const char *dbname);
  98 extern int dbif_env_open(DBD *dbd, struct db_param *dbp, uint32_t dbenv_oflags);
  99 extern int dbif_open(DBD *dbd, struct db_param *dbp, int reindex);
 100 extern int dbif_close(DBD *dbd);
 101 extern int dbif_env_remove(const char *path);
 102
 103 extern int dbif_get(DBD *, const int, DBT *, DBT *, u_int32_t);
 104 extern int dbif_pget(DBD *, const int, DBT *, DBT *, DBT *, u_int32_t);
 105 extern int dbif_put(DBD *, const int, DBT *, DBT *, u_int32_t);
 106 extern int dbif_del(DBD *, const int, DBT *, u_int32_t);
 107 extern int dbif_count(DBD *, const int, u_int32_t *);
 108 extern int dbif_search(DBD *dbd, DBT *key, char *resbuf);
 109 extern int dbif_copy_rootinfokey(DBD *srcdbd, DBD *destdbd);
 110 extern int dbif_txn_begin(DBD *);
 111 extern int dbif_txn_commit(DBD *);
 112 extern int dbif_txn_abort(DBD *);
 113 extern int dbif_txn_close(DBD *dbd, int ret); /* Switch between commit+abort */
 114 extern int dbif_txn_checkpoint(DBD *, u_int32_t, u_int32_t, u_int32_t);
 115
 116 extern int dbif_dump(DBD *dbd, int dumpindexes);
 117 extern int dbif_idwalk(DBD *dbd, cnid_t *cnid, int close);
 118 #endif