lib/dbwrap/dbwrap.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Database interface wrapper
   4    Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2006
   5
   6    Major code contributions from Aleksey Fedoseev (fedoseev@ru.ibm.com)
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #include "replace.h"
  23 #include "lib/util/debug.h"
  24 #include "lib/util/fault.h"
  25 #include "lib/util/talloc_stack.h"
  26 #include "dbwrap/dbwrap.h"
  27 #include "dbwrap/dbwrap_private.h"
  28 #include "lib/util/util_tdb.h"
  29 #include "lib/util/tevent_ntstatus.h"
  30
  31 /*
  32  * Fall back using fetch if no genuine exists operation is provided
  33  */
  34
  35 static int dbwrap_fallback_exists(struct db_context *db, TDB_DATA key)
  36 {
  37         NTSTATUS status = dbwrap_parse_record(db, key, NULL, NULL);
  38         return NT_STATUS_IS_OK(status) ? 1 : 0;
  39 }
  40
  41 static int delete_record(struct db_record *rec, void *data)
  42 {
  43         NTSTATUS status = dbwrap_record_delete(rec);
  44         return NT_STATUS_IS_OK(status) ? 0 : -1;
  45 }
  46
  47 /*
  48  * Fallback wipe implementation using traverse and delete if no genuine
  49  * wipe operation is provided
  50  */
  51 static int dbwrap_fallback_wipe(struct db_context *db)
  52 {
  53         NTSTATUS status = dbwrap_trans_traverse(db, delete_record, NULL);
  54         return NT_STATUS_IS_OK(status) ? 0 : -1;
  55 }
  56
  57 static int do_nothing(struct db_record *rec, void *unused)
  58 {
  59         return 0;
  60 }
  61
  62 /*
  63  * Fallback check operation: just traverse.
  64  */
  65 static int dbwrap_fallback_check(struct db_context *db)
  66 {
  67         NTSTATUS status = dbwrap_traverse_read(db, do_nothing, NULL, NULL);
  68         return NT_STATUS_IS_OK(status) ? 0 : -1;
  69 }
  70
  71 /*
  72  * Wrapper functions for the backend methods
  73  */
  74
  75 TDB_DATA dbwrap_record_get_key(const struct db_record *rec)
  76 {
  77         return rec->key;
  78 }
  79
  80 TDB_DATA dbwrap_record_get_value(const struct db_record *rec)
  81 {
  82         return rec->value;
  83 }
  84
  85 NTSTATUS dbwrap_record_storev(struct db_record *rec,
  86                               const TDB_DATA *dbufs, int num_dbufs, int flags)
  87 {
  88         NTSTATUS status;
  89
  90         status = rec->storev(rec, dbufs, num_dbufs, flags);
  91         if (!NT_STATUS_IS_OK(status)) {
  92                 return status;
  93         }
  94         return NT_STATUS_OK;
  95 }
  96
  97 NTSTATUS dbwrap_record_store(struct db_record *rec, TDB_DATA data, int flags)
  98 {
  99         return dbwrap_record_storev(rec, &data, 1, flags);
 100 }
 101
 102 NTSTATUS dbwrap_record_delete(struct db_record *rec)
 103 {
 104         NTSTATUS status;
 105
 106         status = rec->delete_rec(rec);
 107         if (!NT_STATUS_IS_OK(status)) {
 108                 return status;
 109         }
 110         return NT_STATUS_OK;
 111 }
 112
 113 static void debug_lock_order(int level, struct db_context *dbs[])
 114 {
 115         int i;
 116         DEBUG(level, ("lock order: "));
 117         for (i=0; i<DBWRAP_LOCK_ORDER_MAX; i++) {
 118                 DEBUGADD(level, (" %d:%s", i + 1, dbs[i] ? dbs[i]->name : "<none>"));
 119         }
 120         DEBUGADD(level, ("\n"));
 121 }
 122
 123 static void dbwrap_lock_order_lock(struct db_context *db,
 124                                    struct db_context ***lockptr)
 125 {
 126         static struct db_context *locked_dbs[DBWRAP_LOCK_ORDER_MAX];
 127         int idx;
 128
 129         DBG_INFO("check lock order %d for %s\n", (int)db->lock_order,
 130                  db->name);
 131
 132         if (!DBWRAP_LOCK_ORDER_VALID(db->lock_order)) {
 133                 DBG_ERR("Invalid lock order %d of %s\n",
 134                         (int)db->lock_order, db->name);
 135                 smb_panic("lock order violation");
 136         }
 137
 138         for (idx=db->lock_order-1; idx<DBWRAP_LOCK_ORDER_MAX; idx++) {
 139                 if (locked_dbs[idx] != NULL) {
 140                         DBG_ERR("Lock order violation: Trying %s at %d while "
 141                                 "%s at %d is locked\n",
 142                                 db->name, (int)db->lock_order,
 143                                 locked_dbs[idx]->name, idx + 1);
 144                         debug_lock_order(0, locked_dbs);
 145                         smb_panic("lock order violation");
 146                 }
 147         }
 148
 149         locked_dbs[db->lock_order-1] = db;
 150         *lockptr = &locked_dbs[db->lock_order-1];
 151
 152         debug_lock_order(10, locked_dbs);
 153 }
 154
 155 static void dbwrap_lock_order_unlock(struct db_context *db,
 156                                      struct db_context **lockptr)
 157 {
 158         DBG_INFO("release lock order %d for %s\n",
 159                  (int)db->lock_order, db->name);
 160
 161         if (*lockptr == NULL) {
 162                 DBG_ERR("db %s at order %d unlocked\n", db->name,
 163                         (int)db->lock_order);
 164                 smb_panic("lock order violation");
 165         }
 166
 167         if (*lockptr != db) {
 168                 DBG_ERR("locked db at lock order %d is %s, expected %s\n",
 169                         (int)(*lockptr)->lock_order, (*lockptr)->name,
 170                         db->name);
 171                 smb_panic("lock order violation");
 172         }
 173
 174         *lockptr = NULL;
 175 }
 176
 177 struct dbwrap_lock_order_state {
 178         struct db_context *db;
 179         struct db_context **lockptr;
 180 };
 181
 182 static int dbwrap_lock_order_state_destructor(
 183         struct dbwrap_lock_order_state *s)
 184 {
 185         dbwrap_lock_order_unlock(s->db, s->lockptr);
 186         return 0;
 187 }
 188
 189 static struct dbwrap_lock_order_state *dbwrap_check_lock_order(
 190         struct db_context *db, TALLOC_CTX *mem_ctx)
 191 {
 192         struct dbwrap_lock_order_state *state;
 193
 194         state = talloc(mem_ctx, struct dbwrap_lock_order_state);
 195         if (state == NULL) {
 196                 DBG_WARNING("talloc failed\n");
 197                 return NULL;
 198         }
 199         state->db = db;
 200
 201         dbwrap_lock_order_lock(db, &state->lockptr);
 202         talloc_set_destructor(state, dbwrap_lock_order_state_destructor);
 203
 204         return state;
 205 }
 206
 207 static struct db_record *dbwrap_fetch_locked_internal(
 208         struct db_context *db, TALLOC_CTX *mem_ctx, TDB_DATA key,
 209         struct db_record *(*db_fn)(struct db_context *db, TALLOC_CTX *mem_ctx,
 210                                    TDB_DATA key))
 211 {
 212         struct db_record *rec;
 213         struct dbwrap_lock_order_state *lock_order = NULL;
 214
 215         if (db->lock_order != DBWRAP_LOCK_ORDER_NONE) {
 216                 lock_order = dbwrap_check_lock_order(db, mem_ctx);
 217                 if (lock_order == NULL) {
 218                         return NULL;
 219                 }
 220         }
 221         rec = db_fn(db, mem_ctx, key);
 222         if (rec == NULL) {
 223                 TALLOC_FREE(lock_order);
 224                 return NULL;
 225         }
 226         (void)talloc_steal(rec, lock_order);
 227         rec->db = db;
 228         return rec;
 229 }
 230
 231 struct db_record *dbwrap_fetch_locked(struct db_context *db,
 232                                       TALLOC_CTX *mem_ctx,
 233                                       TDB_DATA key)
 234 {
 235         return dbwrap_fetch_locked_internal(db, mem_ctx, key,
 236                                             db->fetch_locked);
 237 }
 238
 239 struct db_record *dbwrap_try_fetch_locked(struct db_context *db,
 240                                       TALLOC_CTX *mem_ctx,
 241                                       TDB_DATA key)
 242 {
 243         return dbwrap_fetch_locked_internal(
 244                 db, mem_ctx, key,
 245                 db->try_fetch_locked
 246                 ? db->try_fetch_locked : db->fetch_locked);
 247 }
 248
 249 struct db_context *dbwrap_record_get_db(struct db_record *rec)
 250 {
 251         return rec->db;
 252 }
 253
 254 struct dbwrap_fetch_state {
 255         TALLOC_CTX *mem_ctx;
 256         TDB_DATA data;
 257 };
 258
 259 static void dbwrap_fetch_parser(TDB_DATA key, TDB_DATA data,
 260                                 void *private_data)
 261 {
 262         struct dbwrap_fetch_state *state =
 263                 (struct dbwrap_fetch_state *)private_data;
 264
 265         state->data.dsize = data.dsize;
 266         state->data.dptr = (uint8_t *)talloc_memdup(state->mem_ctx, data.dptr,
 267                                                     data.dsize);
 268 }
 269
 270 NTSTATUS dbwrap_fetch(struct db_context *db, TALLOC_CTX *mem_ctx,
 271                       TDB_DATA key, TDB_DATA *value)
 272 {
 273         struct dbwrap_fetch_state state;
 274         NTSTATUS status;
 275
 276         if (value == NULL) {
 277                 return NT_STATUS_INVALID_PARAMETER;
 278         }
 279
 280         state.mem_ctx = mem_ctx;
 281
 282         status = dbwrap_parse_record(db, key, dbwrap_fetch_parser, &state);
 283         if (!NT_STATUS_IS_OK(status)) {
 284                 return status;
 285         }
 286         if ((state.data.dsize != 0) && (state.data.dptr == NULL)) {
 287                 return NT_STATUS_NO_MEMORY;
 288         }
 289         *value = state.data;
 290         return NT_STATUS_OK;
 291 }
 292
 293 bool dbwrap_exists(struct db_context *db, TDB_DATA key)
 294 {
 295         int result;
 296         if (db->exists != NULL) {
 297                 result = db->exists(db, key);
 298         } else {
 299                 result = dbwrap_fallback_exists(db,key);
 300         }
 301         return (result == 1);
 302 }
 303
 304 struct dbwrap_store_state {
 305         TDB_DATA data;
 306         int flags;
 307         NTSTATUS status;
 308 };
 309
 310 static void dbwrap_store_fn(struct db_record *rec, void *private_data)
 311 {
 312         struct dbwrap_store_state *state = private_data;
 313         state->status = dbwrap_record_store(rec, state->data, state->flags);
 314 }
 315
 316 NTSTATUS dbwrap_store(struct db_context *db, TDB_DATA key,
 317                       TDB_DATA data, int flags)
 318 {
 319         struct dbwrap_store_state state = { .data = data, .flags = flags };
 320         NTSTATUS status;
 321
 322         status = dbwrap_do_locked(db, key, dbwrap_store_fn, &state);
 323         if (!NT_STATUS_IS_OK(status)) {
 324                 return status;
 325         }
 326
 327         return state.status;
 328 }
 329
 330 NTSTATUS dbwrap_delete(struct db_context *db, TDB_DATA key)
 331 {
 332         struct db_record *rec;
 333         NTSTATUS status;
 334         TALLOC_CTX *frame = talloc_stackframe();
 335
 336         rec = dbwrap_fetch_locked(db, frame, key);
 337         if (rec == NULL) {
 338                 TALLOC_FREE(frame);
 339                 return NT_STATUS_NO_MEMORY;
 340         }
 341         status = dbwrap_record_delete(rec);
 342         TALLOC_FREE(frame);
 343         return status;
 344 }
 345
 346 NTSTATUS dbwrap_traverse(struct db_context *db,
 347                          int (*f)(struct db_record*, void*),
 348                          void *private_data,
 349                          int *count)
 350 {
 351         int ret = db->traverse(db, f, private_data);
 352
 353         if (ret < 0) {
 354                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 355         }
 356
 357         if (count != NULL) {
 358                 *count = ret;
 359         }
 360
 361         return NT_STATUS_OK;
 362 }
 363
 364 NTSTATUS dbwrap_traverse_read(struct db_context *db,
 365                               int (*f)(struct db_record*, void*),
 366                               void *private_data,
 367                               int *count)
 368 {
 369         int ret = db->traverse_read(db, f, private_data);
 370
 371         if (ret < 0) {
 372                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 373         }
 374
 375         if (count != NULL) {
 376                 *count = ret;
 377         }
 378
 379         return NT_STATUS_OK;
 380 }
 381
 382 static void dbwrap_null_parser(TDB_DATA key, TDB_DATA val, void* data)
 383 {
 384         return;
 385 }
 386
 387 NTSTATUS dbwrap_parse_record(struct db_context *db, TDB_DATA key,
 388                              void (*parser)(TDB_DATA key, TDB_DATA data,
 389                                             void *private_data),
 390                              void *private_data)
 391 {
 392         if (parser == NULL) {
 393                 parser = dbwrap_null_parser;
 394         }
 395         return db->parse_record(db, key, parser, private_data);
 396 }
 397
 398 struct dbwrap_parse_record_state {
 399         struct db_context *db;
 400         TDB_DATA key;
 401         uint8_t _keybuf[64];
 402 };
 403
 404 static void dbwrap_parse_record_done(struct tevent_req *subreq);
 405
 406 struct tevent_req *dbwrap_parse_record_send(
 407         TALLOC_CTX *mem_ctx,
 408         struct tevent_context *ev,
 409         struct db_context *db,
 410         TDB_DATA key,
 411         void (*parser)(TDB_DATA key, TDB_DATA data, void *private_data),
 412         void *private_data,
 413         enum dbwrap_req_state *req_state)
 414 {
 415         struct tevent_req *req = NULL;
 416         struct tevent_req *subreq = NULL;
 417         struct dbwrap_parse_record_state *state = NULL;
 418         NTSTATUS status;
 419
 420         req = tevent_req_create(mem_ctx, &state, struct dbwrap_parse_record_state);
 421         if (req == NULL) {
 422                 *req_state = DBWRAP_REQ_ERROR;
 423                 return NULL;
 424         }
 425
 426         *state = (struct dbwrap_parse_record_state) {
 427                 .db = db,
 428         };
 429
 430         if (parser == NULL) {
 431                 parser = dbwrap_null_parser;
 432         }
 433
 434         *req_state = DBWRAP_REQ_INIT;
 435
 436         if (db->parse_record_send == NULL) {
 437                 /*
 438                  * Backend doesn't implement async version, call sync one
 439                  */
 440                 status = db->parse_record(db, key, parser, private_data);
 441                 if (tevent_req_nterror(req, status)) {
 442                         *req_state = DBWRAP_REQ_DONE;
 443                         return tevent_req_post(req, ev);
 444                 }
 445
 446                 *req_state = DBWRAP_REQ_DONE;
 447                 tevent_req_done(req);
 448                 return tevent_req_post(req, ev);
 449         }
 450
 451         /*
 452          * Copy the key into our state ensuring the key data buffer is always
 453          * available to the all dbwrap backend over the entire lifetime of the
 454          * async request. Otherwise the caller might have free'd the key buffer.
 455          */
 456         if (key.dsize > sizeof(state->_keybuf)) {
 457                 state->key.dptr = talloc_memdup(state, key.dptr, key.dsize);
 458                 if (tevent_req_nomem(state->key.dptr, req)) {
 459                         return tevent_req_post(req, ev);
 460                 }
 461         } else {
 462                 memcpy(state->_keybuf, key.dptr, key.dsize);
 463                 state->key.dptr = state->_keybuf;
 464         }
 465         state->key.dsize = key.dsize;
 466
 467         subreq = db->parse_record_send(state,
 468                                        ev,
 469                                        db,
 470                                        state->key,
 471                                        parser,
 472                                        private_data,
 473                                        req_state);
 474         if (tevent_req_nomem(subreq, req)) {
 475                 *req_state = DBWRAP_REQ_ERROR;
 476                 return tevent_req_post(req, ev);
 477         }
 478
 479         tevent_req_set_callback(subreq,
 480                                 dbwrap_parse_record_done,
 481                                 req);
 482         return req;
 483 }
 484
 485 static void dbwrap_parse_record_done(struct tevent_req *subreq)
 486 {
 487         struct tevent_req *req = tevent_req_callback_data(
 488                 subreq, struct tevent_req);
 489         struct dbwrap_parse_record_state *state = tevent_req_data(
 490                 req, struct dbwrap_parse_record_state);
 491         NTSTATUS status;
 492
 493         status = state->db->parse_record_recv(subreq);
 494         TALLOC_FREE(subreq);
 495         if (!NT_STATUS_IS_OK(status)) {
 496                 tevent_req_nterror(req, status);
 497                 return;
 498         }
 499
 500         tevent_req_done(req);
 501         return;
 502 }
 503
 504 NTSTATUS dbwrap_parse_record_recv(struct tevent_req *req)
 505 {
 506         return tevent_req_simple_recv_ntstatus(req);
 507 }
 508
 509 NTSTATUS dbwrap_do_locked(struct db_context *db, TDB_DATA key,
 510                           void (*fn)(struct db_record *rec,
 511                                      void *private_data),
 512                           void *private_data)
 513 {
 514         struct db_record *rec;
 515
 516         if (db->do_locked != NULL) {
 517                 struct db_context **lockptr;
 518                 NTSTATUS status;
 519
 520                 if (db->lock_order != DBWRAP_LOCK_ORDER_NONE) {
 521                         dbwrap_lock_order_lock(db, &lockptr);
 522                 }
 523
 524                 status = db->do_locked(db, key, fn, private_data);
 525
 526                 if (db->lock_order != DBWRAP_LOCK_ORDER_NONE) {
 527                         dbwrap_lock_order_unlock(db, lockptr);
 528                 }
 529
 530                 return status;
 531         }
 532
 533         rec = dbwrap_fetch_locked(db, db, key);
 534         if (rec == NULL) {
 535                 return NT_STATUS_NO_MEMORY;
 536         }
 537
 538         fn(rec, private_data);
 539
 540         TALLOC_FREE(rec);
 541
 542         return NT_STATUS_OK;
 543 }
 544
 545 int dbwrap_wipe(struct db_context *db)
 546 {
 547         if (db->wipe == NULL) {
 548                 return dbwrap_fallback_wipe(db);
 549         }
 550         return db->wipe(db);
 551 }
 552
 553 int dbwrap_check(struct db_context *db)
 554 {
 555         if (db->check == NULL) {
 556                 return dbwrap_fallback_check(db);
 557         }
 558         return db->check(db);
 559 }
 560
 561 int dbwrap_get_seqnum(struct db_context *db)
 562 {
 563         return db->get_seqnum(db);
 564 }
 565
 566 int dbwrap_transaction_start(struct db_context *db)
 567 {
 568         if (!db->persistent) {
 569                 /*
 570                  * dbwrap_ctdb has two different data models for persistent
 571                  * and non-persistent databases. Transactions are supported
 572                  * only for the persistent databases. This check is here to
 573                  * prevent breakages of the cluster case, autobuild at this
 574                  * point only tests non-clustered Samba. Before removing this
 575                  * check, please make sure that this facility has also been
 576                  * added to dbwrap_ctdb.
 577                  *
 578                  * Thanks, vl
 579                  */
 580                 DEBUG(1, ("transactions not supported on non-persistent "
 581                           "database %s\n", db->name));
 582                 return -1;
 583         }
 584         return db->transaction_start(db);
 585 }
 586
 587 NTSTATUS dbwrap_transaction_start_nonblock(struct db_context *db)
 588 {
 589         if (db->transaction_start_nonblock) {
 590                 return db->transaction_start_nonblock(db);
 591         } else {
 592                 return dbwrap_transaction_start(db) == 0 ? NT_STATUS_OK
 593                         : NT_STATUS_UNSUCCESSFUL;
 594         }
 595 }
 596
 597 int dbwrap_transaction_commit(struct db_context *db)
 598 {
 599         return db->transaction_commit(db);
 600 }
 601
 602 int dbwrap_transaction_cancel(struct db_context *db)
 603 {
 604         return db->transaction_cancel(db);
 605 }
 606
 607 size_t dbwrap_db_id(struct db_context *db, uint8_t *id, size_t idlen)
 608 {
 609         return db->id(db, id, idlen);
 610 }
 611
 612 bool dbwrap_is_persistent(struct db_context *db)
 613 {
 614         return db->persistent;
 615 }
 616
 617 const char *dbwrap_name(struct db_context *db)
 618 {
 619         return db->name;
 620 }
 621
 622 static ssize_t tdb_data_buf(const TDB_DATA *dbufs, int num_dbufs,
 623                             uint8_t *buf, size_t buflen)
 624 {
 625         size_t needed = 0;
 626         uint8_t *p = buf;
 627         int i;
 628
 629         for (i=0; i<num_dbufs; i++) {
 630                 size_t thislen = dbufs[i].dsize;
 631                 size_t tmp;
 632
 633                 tmp = needed + thislen;
 634                 if (tmp < needed) {
 635                         /* wrap */
 636                         return -1;
 637                 }
 638                 needed = tmp;
 639
 640                 if (needed <= buflen) {
 641                         memcpy(p, dbufs[i].dptr, thislen);
 642                         p += thislen;
 643                 }
 644         }
 645
 646         return needed;
 647 }
 648
 649
 650 TDB_DATA dbwrap_merge_dbufs(TALLOC_CTX *mem_ctx,
 651                             const TDB_DATA *dbufs, int num_dbufs)
 652 {
 653         ssize_t len = tdb_data_buf(dbufs, num_dbufs, NULL, 0);
 654         uint8_t *buf;
 655
 656         if (len == -1) {
 657                 return (TDB_DATA) {0};
 658         }
 659
 660         buf = talloc_array(mem_ctx, uint8_t, len);
 661         if (buf == NULL) {
 662                 return (TDB_DATA) {0};
 663         }
 664
 665         tdb_data_buf(dbufs, num_dbufs, buf, len);
 666
 667         return (TDB_DATA) { .dptr = buf, .dsize = len };
 668 }