chiark - git - mdw - disorder/blob - lib/trackdb-int.h

   1 /*
   2  * This file is part of DisOrder
   3  * Copyright (C) 2005, 2007 Richard Kettlewell
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  18  * USA
  19  */
  20
  21 #ifndef TRACKDB_INT_H
  22 #define TRACKDB_INT_H
  23
  24 struct vector;                          /* forward declaration */
  25
  26 extern DB_ENV *trackdb_env;
  27
  28 extern DB *trackdb_tracksdb;
  29 extern DB *trackdb_prefsdb;
  30 extern DB *trackdb_searchdb;
  31 extern DB *trackdb_tagsdb;
  32 extern DB *trackdb_noticeddb;
  33 extern DB *trackdb_globaldb;
  34 extern DB *trackdb_usersdb;
  35
  36 DBC *trackdb_opencursor(DB *db, DB_TXN *tid);
  37 /* open a transaction */
  38
  39 int trackdb_closecursor(DBC *c);
  40 /* close transaction, returns 0 or DB_LOCK_DEADLOCK */
  41
  42 int trackdb_notice(const char *track,
  43                    const char *path);
  44 int trackdb_notice_tid(const char *track,
  45                        const char *path,
  46                        DB_TXN *tid);
  47 /* notice a track; return DB_NOTFOUND if new, else 0.  _tid can return
  48  * DB_LOCK_DEADLOCK too. */
  49
  50 int trackdb_obsolete(const char *track, DB_TXN *tid);
  51 /* obsolete a track */
  52
  53 DB_TXN *trackdb_begin_transaction(void);
  54 void trackdb_abort_transaction(DB_TXN *tid);
  55 void trackdb_commit_transaction(DB_TXN *tid);
  56 /* begin, abort or commit a transaction */
  57
  58 /** @brief Evaluate @p expr in a transaction, looping on deadlock
  59  *
  60  * @c tid will be the transaction handle.  @p e will be the error code.
  61  */
  62 #define WITH_TRANSACTION(expr) do {             \
  63   DB_TXN *tid;                                  \
  64                                                 \
  65   tid = trackdb_begin_transaction();            \
  66   while((e = (expr)) == DB_LOCK_DEADLOCK) {     \
  67     trackdb_abort_transaction(tid);             \
  68     tid = trackdb_begin_transaction();          \
  69   }                                             \
  70   if(e)                                         \
  71     trackdb_abort_transaction(tid);             \
  72   else                                          \
  73     trackdb_commit_transaction(tid);            \
  74 } while(0)
  75
  76 int trackdb_getdata(DB *db,
  77                     const char *track,
  78                     struct kvp **kp,
  79                     DB_TXN *tid);
  80 /* fetch and decode a database entry.  Returns 0, DB_NOTFOUND or
  81  * DB_LOCK_DEADLOCK. */
  82
  83 int trackdb_putdata(DB *db,
  84                     const char *track,
  85                     const struct kvp *k,
  86                     DB_TXN *tid,
  87                     u_int32_t flags);
  88 /* encode and store a database entry.  Returns 0, DB_KEYEXIST or
  89  * DB_LOCK_DEADLOCK. */
  90
  91 int trackdb_delkey(DB *db,
  92                    const char *track,
  93                    DB_TXN *tid);
  94 /* delete a database entry.  Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
  95
  96 int trackdb_delkeydata(DB *db,
  97                        const char *word,
  98                        const char *track,
  99                        DB_TXN *tid);
 100 /* delete a (key,data) pair.  Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
 101
 102 int trackdb_scan(const char *root,
 103                  int (*callback)(const char *track,
 104                                  struct kvp *data,
 105                                  struct kvp *prefs,
 106                                  void *u,
 107                                  DB_TXN *tid),
 108                  void *u,
 109                  DB_TXN *tid);
 110 /* Call CALLBACK for each non-alias track below ROOT (or all tracks if ROOT is
 111  * 0).  Return 0 or DB_LOCK_DEADLOCK.  CALLBACK should return 0 on success or
 112  * EINTR to cancel the scan. */
 113
 114 int trackdb_listkeys(DB *db, struct vector *v, DB_TXN *tid);
 115
 116 /* fill KEY in with S, returns KEY */
 117 static inline DBT *make_key(DBT *key, const char *s) {
 118   memset(key, 0, sizeof *key);
 119   key->data = (void *)s;
 120   key->size = strlen(s);
 121   return key;
 122 }
 123
 124 /* set DATA up to receive data, returns DATA */
 125 static inline DBT *prepare_data(DBT *data) {
 126   memset(data, 0, sizeof *data);
 127   data->flags = DB_DBT_MALLOC;
 128   return data;
 129 }
 130
 131 /* encode K and store in DATA, returns DATA */
 132 static inline DBT *encode_data(DBT *data, const struct kvp *k) {
 133   size_t size;
 134
 135   memset(data, 0, sizeof *data);
 136   data->data = kvp_urlencode(k, &size);
 137   data->size = size;
 138   return data;
 139 }
 140
 141 int trackdb_set_global_tid(const char *name,
 142                            const char *value,
 143                            DB_TXN *tid);
 144 int trackdb_get_global_tid(const char *name,
 145                            DB_TXN *tid,
 146                            const char **rp);
 147
 148 #endif /* TRACKDB_INT_H */
 149
 150 /*
 151 Local Variables:
 152 c-basic-offset:2
 153 comment-column:40
 154 fill-column:79
 155 indent-tabs-mode:nil
 156 End:
 157 */