source3/lib/dbwrap_util.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Utility functions for the dbwrap API
   4    Copyright (C) Volker Lendecke 2007
   5    Copyright (C) Michael Adam 2009
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 */
  21
  22 #include "includes.h"
  23 #include "dbwrap.h"
  24
  25 int32_t dbwrap_fetch_int32(struct db_context *db, const char *keystr)
  26 {
  27         TDB_DATA dbuf;
  28         int32 ret;
  29
  30         if (db->fetch(db, NULL, string_term_tdb_data(keystr), &dbuf) != 0) {
  31                 return -1;
  32         }
  33
  34         if ((dbuf.dptr == NULL) || (dbuf.dsize != sizeof(int32_t))) {
  35                 TALLOC_FREE(dbuf.dptr);
  36                 return -1;
  37         }
  38
  39         ret = IVAL(dbuf.dptr, 0);
  40         TALLOC_FREE(dbuf.dptr);
  41         return ret;
  42 }
  43
  44 int dbwrap_store_int32(struct db_context *db, const char *keystr, int32_t v)
  45 {
  46         struct db_record *rec;
  47         int32 v_store;
  48         NTSTATUS status;
  49
  50         rec = db->fetch_locked(db, NULL, string_term_tdb_data(keystr));
  51         if (rec == NULL) {
  52                 return -1;
  53         }
  54
  55         SIVAL(&v_store, 0, v);
  56
  57         status = rec->store(rec, make_tdb_data((const uint8 *)&v_store,
  58                                                sizeof(v_store)),
  59                             TDB_REPLACE);
  60         TALLOC_FREE(rec);
  61         return NT_STATUS_IS_OK(status) ? 0 : -1;
  62 }
  63
  64 bool dbwrap_fetch_uint32(struct db_context *db, const char *keystr,
  65                          uint32_t *val)
  66 {
  67         TDB_DATA dbuf;
  68
  69         if (db->fetch(db, NULL, string_term_tdb_data(keystr), &dbuf) != 0) {
  70                 return false;
  71         }
  72
  73         if ((dbuf.dptr == NULL) || (dbuf.dsize != sizeof(uint32_t))) {
  74                 TALLOC_FREE(dbuf.dptr);
  75                 return false;
  76         }
  77
  78         *val = IVAL(dbuf.dptr, 0);
  79         TALLOC_FREE(dbuf.dptr);
  80         return true;
  81 }
  82
  83 int dbwrap_store_uint32(struct db_context *db, const char *keystr, uint32_t v)
  84 {
  85         struct db_record *rec;
  86         uint32 v_store;
  87         NTSTATUS status;
  88
  89         rec = db->fetch_locked(db, NULL, string_term_tdb_data(keystr));
  90         if (rec == NULL) {
  91                 return -1;
  92         }
  93
  94         SIVAL(&v_store, 0, v);
  95
  96         status = rec->store(rec, make_tdb_data((const uint8 *)&v_store,
  97                                                sizeof(v_store)),
  98                             TDB_REPLACE);
  99         TALLOC_FREE(rec);
 100         return NT_STATUS_IS_OK(status) ? 0 : -1;
 101 }
 102
 103 /**
 104  * Atomic unsigned integer change (addition):
 105  *
 106  * if value does not exist yet in the db, use *oldval as initial old value.
 107  * return old value in *oldval.
 108  * store *oldval + change_val to db.
 109  */
 110
 111 struct dbwrap_change_uint32_atomic_context {
 112         const char *keystr;
 113         uint32_t *oldval;
 114         uint32_t change_val;
 115 };
 116
 117 static NTSTATUS dbwrap_change_uint32_atomic_action(struct db_context *db,
 118                                                    void *private_data)
 119 {
 120         struct db_record *rec;
 121         uint32_t val = (uint32_t)-1;
 122         uint32_t v_store;
 123         NTSTATUS ret;
 124         struct dbwrap_change_uint32_atomic_context *state;
 125
 126         state = (struct dbwrap_change_uint32_atomic_context *)private_data;
 127
 128         rec = db->fetch_locked(db, NULL, string_term_tdb_data(state->keystr));
 129         if (!rec) {
 130                 return NT_STATUS_UNSUCCESSFUL;
 131         }
 132
 133         if (rec->value.dptr == NULL) {
 134                 val = *(state->oldval);
 135         } else if (rec->value.dsize == sizeof(val)) {
 136                 val = IVAL(rec->value.dptr, 0);
 137                 *(state->oldval) = val;
 138         } else {
 139                 ret = NT_STATUS_UNSUCCESSFUL;
 140                 goto done;
 141         }
 142
 143         val += state->change_val;
 144
 145         SIVAL(&v_store, 0, val);
 146
 147         ret = rec->store(rec,
 148                          make_tdb_data((const uint8 *)&v_store,
 149                                        sizeof(v_store)),
 150                          TDB_REPLACE);
 151
 152 done:
 153         TALLOC_FREE(rec);
 154         return ret;
 155 }
 156
 157 NTSTATUS dbwrap_change_uint32_atomic(struct db_context *db, const char *keystr,
 158                                      uint32_t *oldval, uint32_t change_val)
 159 {
 160         NTSTATUS ret;
 161         struct dbwrap_change_uint32_atomic_context state;
 162
 163         state.keystr = keystr;
 164         state.oldval = oldval;
 165         state.change_val = change_val;
 166
 167         ret = dbwrap_change_uint32_atomic_action(db, &state);
 168
 169         return ret;
 170 }
 171
 172 NTSTATUS dbwrap_trans_change_uint32_atomic(struct db_context *db,
 173                                            const char *keystr,
 174                                            uint32_t *oldval,
 175                                            uint32_t change_val)
 176 {
 177         NTSTATUS ret;
 178         struct dbwrap_change_uint32_atomic_context state;
 179
 180         state.keystr = keystr;
 181         state.oldval = oldval;
 182         state.change_val = change_val;
 183
 184         ret = dbwrap_trans_do(db, dbwrap_change_uint32_atomic_action, &state);
 185
 186         return ret;
 187 }
 188
 189 /**
 190  * Atomic integer change (addition):
 191  *
 192  * if value does not exist yet in the db, use *oldval as initial old value.
 193  * return old value in *oldval.
 194  * store *oldval + change_val to db.
 195  */
 196
 197 struct dbwrap_change_int32_atomic_context {
 198         const char *keystr;
 199         int32_t *oldval;
 200         int32_t change_val;
 201 };
 202
 203 static NTSTATUS dbwrap_change_int32_atomic_action(struct db_context *db,
 204                                                   void *private_data)
 205 {
 206         struct db_record *rec;
 207         int32_t val = -1;
 208         int32_t v_store;
 209         NTSTATUS ret;
 210         struct dbwrap_change_int32_atomic_context *state;
 211
 212         state = (struct dbwrap_change_int32_atomic_context *)private_data;
 213
 214         rec = db->fetch_locked(db, NULL, string_term_tdb_data(state->keystr));
 215         if (!rec) {
 216                 return NT_STATUS_UNSUCCESSFUL;
 217         }
 218
 219         if (rec->value.dptr == NULL) {
 220                 val = *(state->oldval);
 221         } else if (rec->value.dsize == sizeof(val)) {
 222                 val = IVAL(rec->value.dptr, 0);
 223                 *(state->oldval) = val;
 224         } else {
 225                 ret = NT_STATUS_UNSUCCESSFUL;
 226                 goto done;
 227         }
 228
 229         val += state->change_val;
 230
 231         SIVAL(&v_store, 0, val);
 232
 233         ret = rec->store(rec,
 234                          make_tdb_data((const uint8_t *)&v_store,
 235                                        sizeof(v_store)),
 236                          TDB_REPLACE);
 237
 238 done:
 239         TALLOC_FREE(rec);
 240         return ret;
 241 }
 242
 243 NTSTATUS dbwrap_change_int32_atomic(struct db_context *db, const char *keystr,
 244                                     int32_t *oldval, int32_t change_val)
 245 {
 246         NTSTATUS ret;
 247         struct dbwrap_change_int32_atomic_context state;
 248
 249         state.keystr = keystr;
 250         state.oldval = oldval;
 251         state.change_val = change_val;
 252
 253         ret = dbwrap_change_int32_atomic_action(db, &state);
 254
 255         return ret;
 256 }
 257
 258 NTSTATUS dbwrap_trans_change_int32_atomic(struct db_context *db,
 259                                           const char *keystr,
 260                                           int32_t *oldval,
 261                                           int32_t change_val)
 262 {
 263         NTSTATUS ret;
 264         struct dbwrap_change_int32_atomic_context state;
 265
 266         state.keystr = keystr;
 267         state.oldval = oldval;
 268         state.change_val = change_val;
 269
 270         ret = dbwrap_trans_do(db, dbwrap_change_int32_atomic_action, &state);
 271
 272         return ret;
 273 }
 274
 275 struct dbwrap_store_context {
 276         TDB_DATA *key;
 277         TDB_DATA *dbuf;
 278         int flag;
 279 };
 280
 281 static NTSTATUS dbwrap_store_action(struct db_context *db, void *private_data)
 282 {
 283         struct db_record *rec = NULL;
 284         NTSTATUS status;
 285         struct dbwrap_store_context *store_ctx;
 286
 287         store_ctx = (struct dbwrap_store_context *)private_data;
 288
 289         rec = db->fetch_locked(db, talloc_tos(), *(store_ctx->key));
 290         if (rec == NULL) {
 291                 DEBUG(5, ("fetch_locked failed\n"));
 292                 return NT_STATUS_NO_MEMORY;
 293         }
 294
 295         status = rec->store(rec, *(store_ctx->dbuf), store_ctx->flag);
 296         if (!NT_STATUS_IS_OK(status)) {
 297                 DEBUG(5, ("store returned %s\n", nt_errstr(status)));
 298         }
 299
 300         TALLOC_FREE(rec);
 301         return status;
 302 }
 303
 304 NTSTATUS dbwrap_trans_store(struct db_context *db, TDB_DATA key, TDB_DATA dbuf,
 305                             int flag)
 306 {
 307         NTSTATUS status;
 308         struct dbwrap_store_context store_ctx;
 309
 310         store_ctx.key = &key;
 311         store_ctx.dbuf = &dbuf;
 312         store_ctx.flag = flag;
 313
 314         status = dbwrap_trans_do(db, dbwrap_store_action, &store_ctx);
 315
 316         return status;
 317 }
 318
 319 static NTSTATUS dbwrap_delete_action(struct db_context * db, void *private_data)
 320 {
 321         NTSTATUS status;
 322         struct db_record *rec;
 323         TDB_DATA *key = (TDB_DATA *)private_data;
 324
 325         rec = db->fetch_locked(db, talloc_tos(), *key);
 326         if (rec == NULL) {
 327                 DEBUG(5, ("fetch_locked failed\n"));
 328                 return NT_STATUS_NO_MEMORY;
 329         }
 330
 331         status = rec->delete_rec(rec);
 332         if (!NT_STATUS_IS_OK(status)) {
 333                 DEBUG(5, ("delete_rec returned %s\n", nt_errstr(status)));
 334         }
 335
 336         talloc_free(rec);
 337         return  status;
 338 }
 339
 340 NTSTATUS dbwrap_trans_delete(struct db_context *db, TDB_DATA key)
 341 {
 342         NTSTATUS status;
 343
 344         status = dbwrap_trans_do(db, dbwrap_delete_action, &key);
 345
 346         return status;
 347 }
 348
 349 NTSTATUS dbwrap_trans_store_int32(struct db_context *db, const char *keystr,
 350                                   int32_t v)
 351 {
 352         int32 v_store;
 353
 354         SIVAL(&v_store, 0, v);
 355
 356         return dbwrap_trans_store(db, string_term_tdb_data(keystr),
 357                                   make_tdb_data((const uint8 *)&v_store,
 358                                                 sizeof(v_store)),
 359                                   TDB_REPLACE);
 360 }
 361
 362 NTSTATUS dbwrap_trans_store_uint32(struct db_context *db, const char *keystr,
 363                                    uint32_t v)
 364 {
 365         uint32 v_store;
 366
 367         SIVAL(&v_store, 0, v);
 368
 369         return dbwrap_trans_store(db, string_term_tdb_data(keystr),
 370                                   make_tdb_data((const uint8 *)&v_store,
 371                                                 sizeof(v_store)),
 372                                   TDB_REPLACE);
 373 }
 374
 375 NTSTATUS dbwrap_trans_store_bystring(struct db_context *db, const char *key,
 376                                      TDB_DATA data, int flags)
 377 {
 378         return dbwrap_trans_store(db, string_term_tdb_data(key), data, flags);
 379 }
 380
 381 NTSTATUS dbwrap_trans_delete_bystring(struct db_context *db, const char *key)
 382 {
 383         return dbwrap_trans_delete(db, string_term_tdb_data(key));
 384 }
 385
 386 /**
 387  * Wrap db action(s) into a transaction.
 388  */
 389 NTSTATUS dbwrap_trans_do(struct db_context *db,
 390                          NTSTATUS (*action)(struct db_context *, void *),
 391                          void *private_data)
 392 {
 393         int res;
 394         NTSTATUS status;
 395
 396         res = db->transaction_start(db);
 397         if (res != 0) {
 398                 DEBUG(5, ("transaction_start failed\n"));
 399                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 400         }
 401
 402         status = action(db, private_data);
 403         if (!NT_STATUS_IS_OK(status)) {
 404                 if (db->transaction_cancel(db) != 0) {
 405                         smb_panic("Cancelling transaction failed");
 406                 }
 407                 return status;
 408         }
 409
 410         res = db->transaction_commit(db);
 411         if (res == 0) {
 412                 return NT_STATUS_OK;
 413         }
 414
 415         DEBUG(2, ("transaction_commit failed\n"));
 416         return NT_STATUS_INTERNAL_DB_CORRUPTION;
 417 }
 418
 419 struct dbwrap_trans_traverse_action_ctx {
 420         int (*f)(struct db_record* rec, void* private_data);
 421         void* private_data;
 422 };
 423
 424
 425 static NTSTATUS dbwrap_trans_traverse_action(struct db_context* db, void* private_data)
 426 {
 427         struct dbwrap_trans_traverse_action_ctx* ctx =
 428                 (struct dbwrap_trans_traverse_action_ctx*)private_data;
 429
 430         int ret = db->traverse(db, ctx->f, ctx->private_data);
 431
 432         return (ret == -1) ? NT_STATUS_INTERNAL_DB_CORRUPTION : NT_STATUS_OK;
 433 }
 434
 435 NTSTATUS dbwrap_trans_traverse(struct db_context *db,
 436                                int (*f)(struct db_record*, void*),
 437                                void *private_data)
 438 {
 439         struct dbwrap_trans_traverse_action_ctx ctx = {
 440                 .f = f,
 441                 .private_data = private_data,
 442         };
 443         return dbwrap_trans_do(db, dbwrap_trans_traverse_action, &ctx);
 444 }
 445
 446 NTSTATUS dbwrap_traverse(struct db_context *db,
 447                          int (*f)(struct db_record*, void*),
 448                          void *private_data)
 449 {
 450         int ret = db->traverse(db, f, private_data);
 451         return (ret == -1) ? NT_STATUS_INTERNAL_DB_CORRUPTION : NT_STATUS_OK;
 452 }
 453
 454
 455
 456
 457 NTSTATUS dbwrap_delete_bystring_upper(struct db_context *db, const char *key)
 458 {
 459         char *key_upper;
 460         NTSTATUS status;
 461
 462         key_upper = talloc_strdup_upper(talloc_tos(), key);
 463         if (key_upper == NULL) {
 464                 return NT_STATUS_NO_MEMORY;
 465         }
 466
 467         status = dbwrap_delete_bystring(db, key_upper);
 468
 469         talloc_free(key_upper);
 470         return status;
 471 }
 472
 473 NTSTATUS dbwrap_store_bystring_upper(struct db_context *db, const char *key,
 474                                      TDB_DATA data, int flags)
 475 {
 476         char *key_upper;
 477         NTSTATUS status;
 478
 479         key_upper = talloc_strdup_upper(talloc_tos(), key);
 480         if (key_upper == NULL) {
 481                 return NT_STATUS_NO_MEMORY;
 482         }
 483
 484         status = dbwrap_store_bystring(db, key_upper, data, flags);
 485
 486         talloc_free(key_upper);
 487         return status;
 488 }
 489
 490 TDB_DATA dbwrap_fetch_bystring_upper(struct db_context *db, TALLOC_CTX *mem_ctx,
 491                                      const char *key)
 492 {
 493         char *key_upper;
 494         TDB_DATA result;
 495
 496         key_upper = talloc_strdup_upper(talloc_tos(), key);
 497         if (key_upper == NULL) {
 498                 return make_tdb_data(NULL, 0);
 499         }
 500
 501         result = dbwrap_fetch_bystring(db, mem_ctx, key_upper);
 502
 503         talloc_free(key_upper);
 504         return result;
 505 }