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