2 #include <ccan/tdb2/tdb2.h>
7 struct tdb_data tdb_null = { .dptr = NULL, .dsize = 0 };
9 /* all contexts, to ensure no double-opens (fcntl locks don't nest!) */
10 static struct tdb_context *tdbs = NULL;
12 static bool tdb_already_open(dev_t device, ino_t ino)
14 struct tdb_context *i;
16 for (i = tdbs; i; i = i->next) {
17 if (i->device == device && i->inode == ino) {
25 static bool read_all(int fd, void *buf, size_t len)
29 ret = read(fd, buf, len);
37 buf = (char *)buf + ret;
43 static uint64_t random_number(struct tdb_context *tdb)
49 fd = open("/dev/urandom", O_RDONLY);
51 if (read_all(fd, &ret, sizeof(ret))) {
57 /* FIXME: Untested! Based on Wikipedia protocol description! */
58 fd = open("/dev/egd-pool", O_RDWR);
60 /* Command is 1, next byte is size we want to read. */
61 char cmd[2] = { 1, sizeof(uint64_t) };
62 if (write(fd, cmd, sizeof(cmd)) == sizeof(cmd)) {
63 char reply[1 + sizeof(uint64_t)];
64 int r = read(fd, reply, sizeof(reply));
66 /* Copy at least some bytes. */
67 memcpy(&ret, reply+1, r - 1);
68 if (reply[0] == sizeof(uint64_t)
69 && r == sizeof(reply)) {
78 /* Fallback: pid and time. */
79 gettimeofday(&now, NULL);
80 ret = getpid() * 100132289ULL + now.tv_sec * 1000000ULL + now.tv_usec;
81 tdb_logerr(tdb, TDB_SUCCESS, TDB_LOG_WARNING,
82 "tdb_open: random from getpid and time");
87 struct tdb_header hdr;
88 struct tdb_freetable ftable;
91 /* initialise a new database */
92 static enum TDB_ERROR tdb_new_database(struct tdb_context *tdb,
93 struct tdb_attribute_seed *seed,
94 struct tdb_header *hdr)
96 /* We make it up in memory, then write it out if not internal */
97 struct new_database newdb;
98 unsigned int magic_len;
100 enum TDB_ERROR ecode;
102 /* Fill in the header */
103 newdb.hdr.version = TDB_VERSION;
105 newdb.hdr.hash_seed = seed->seed;
107 newdb.hdr.hash_seed = random_number(tdb);
108 newdb.hdr.hash_test = TDB_HASH_MAGIC;
109 newdb.hdr.hash_test = tdb->khash(&newdb.hdr.hash_test,
110 sizeof(newdb.hdr.hash_test),
113 newdb.hdr.recovery = 0;
114 memset(newdb.hdr.reserved, 0, sizeof(newdb.hdr.reserved));
115 /* Initial hashes are empty. */
116 memset(newdb.hdr.hashtable, 0, sizeof(newdb.hdr.hashtable));
119 newdb.hdr.free_table = offsetof(struct new_database, ftable);
120 memset(&newdb.ftable, 0, sizeof(newdb.ftable));
121 ecode = set_header(NULL, &newdb.ftable.hdr, TDB_FTABLE_MAGIC, 0,
122 sizeof(newdb.ftable) - sizeof(newdb.ftable.hdr),
123 sizeof(newdb.ftable) - sizeof(newdb.ftable.hdr),
125 if (ecode != TDB_SUCCESS) {
130 memset(newdb.hdr.magic_food, 0, sizeof(newdb.hdr.magic_food));
131 strcpy(newdb.hdr.magic_food, TDB_MAGIC_FOOD);
133 /* This creates an endian-converted database, as if read from disk */
134 magic_len = sizeof(newdb.hdr.magic_food);
136 (char *)&newdb.hdr + magic_len, sizeof(newdb) - magic_len);
140 if (tdb->flags & TDB_INTERNAL) {
141 tdb->map_size = sizeof(newdb);
142 tdb->map_ptr = malloc(tdb->map_size);
144 return tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_ERROR,
146 " failed to allocate");
148 memcpy(tdb->map_ptr, &newdb, tdb->map_size);
151 if (lseek(tdb->fd, 0, SEEK_SET) == -1) {
152 return tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
154 " failed to seek: %s", strerror(errno));
157 if (ftruncate(tdb->fd, 0) == -1) {
158 return tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
160 " failed to truncate: %s", strerror(errno));
163 rlen = write(tdb->fd, &newdb, sizeof(newdb));
164 if (rlen != sizeof(newdb)) {
167 return tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
168 "tdb_new_database: %zi writing header: %s",
169 rlen, strerror(errno));
174 struct tdb_context *tdb_open(const char *name, int tdb_flags,
175 int open_flags, mode_t mode,
176 union tdb_attribute *attr)
178 struct tdb_context *tdb;
184 struct tdb_header hdr;
185 struct tdb_attribute_seed *seed = NULL;
187 enum TDB_ERROR ecode;
189 tdb = malloc(sizeof(*tdb));
197 tdb->direct_access = 0;
199 tdb->map_size = sizeof(struct tdb_header);
200 tdb->flags = tdb_flags;
202 tdb->transaction = NULL;
210 switch (attr->base.attr) {
211 case TDB_ATTRIBUTE_LOG:
212 tdb->logfn = attr->log.log_fn;
213 tdb->log_private = attr->log.log_private;
215 case TDB_ATTRIBUTE_HASH:
216 tdb->khash = attr->hash.hash_fn;
217 tdb->hash_priv = attr->hash.hash_private;
219 case TDB_ATTRIBUTE_SEED:
222 case TDB_ATTRIBUTE_STATS:
223 tdb->stats = &attr->stats;
224 /* They have stats we don't know about? Tell them. */
225 if (tdb->stats->size > sizeof(attr->stats))
226 tdb->stats->size = sizeof(attr->stats);
229 ecode = tdb_logerr(tdb, TDB_ERR_EINVAL,
232 " unknown attribute type %u",
236 attr = attr->base.next;
239 if ((open_flags & O_ACCMODE) == O_WRONLY) {
240 ecode = tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
241 "tdb_open: can't open tdb %s write-only",
246 if ((open_flags & O_ACCMODE) == O_RDONLY) {
247 tdb->read_only = true;
248 /* read only databases don't do locking */
249 tdb->flags |= TDB_NOLOCK;
250 tdb->mmap_flags = PROT_READ;
252 tdb->read_only = false;
253 tdb->mmap_flags = PROT_READ | PROT_WRITE;
256 /* internal databases don't need any of the rest. */
257 if (tdb->flags & TDB_INTERNAL) {
258 tdb->flags |= (TDB_NOLOCK | TDB_NOMMAP);
259 ecode = tdb_new_database(tdb, seed, &hdr);
260 if (ecode != TDB_SUCCESS) {
263 tdb_convert(tdb, &hdr.hash_seed, sizeof(hdr.hash_seed));
264 tdb->hash_seed = hdr.hash_seed;
265 tdb_ftable_init(tdb);
269 if ((tdb->fd = open(name, open_flags, mode)) == -1) {
270 /* errno set by open(2) */
272 ecode = tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
273 "tdb_open: could not open file %s: %s",
274 name, strerror(errno));
278 /* on exec, don't inherit the fd */
279 v = fcntl(tdb->fd, F_GETFD, 0);
280 fcntl(tdb->fd, F_SETFD, v | FD_CLOEXEC);
282 /* ensure there is only one process initialising at once */
283 ecode = tdb_lock_open(tdb, TDB_LOCK_WAIT|TDB_LOCK_NOCHECK);
284 if (ecode != TDB_SUCCESS) {
288 /* If they used O_TRUNC, read will return 0. */
289 rlen = read(tdb->fd, &hdr, sizeof(hdr));
290 if (rlen == 0 && (open_flags & O_CREAT)) {
291 ecode = tdb_new_database(tdb, seed, &hdr);
292 if (ecode != TDB_SUCCESS) {
295 } else if (rlen < 0) {
296 ecode = tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
297 "tdb_open: error %s reading %s",
298 strerror(errno), name);
300 } else if (rlen < sizeof(hdr)
301 || strcmp(hdr.magic_food, TDB_MAGIC_FOOD) != 0) {
302 ecode = tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
303 "tdb_open: %s is not a tdb file", name);
307 if (hdr.version != TDB_VERSION) {
308 if (hdr.version == bswap_64(TDB_VERSION))
309 tdb->flags |= TDB_CONVERT;
312 ecode = tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
314 " %s is unknown version 0x%llx",
315 name, (long long)hdr.version);
320 tdb_convert(tdb, &hdr, sizeof(hdr));
321 tdb->hash_seed = hdr.hash_seed;
322 hash_test = TDB_HASH_MAGIC;
323 hash_test = tdb_hash(tdb, &hash_test, sizeof(hash_test));
324 if (hdr.hash_test != hash_test) {
325 /* wrong hash variant */
326 ecode = tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
328 " %s uses a different hash function",
333 if (fstat(tdb->fd, &st) == -1) {
335 ecode = tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
336 "tdb_open: could not stat open %s: %s",
337 name, strerror(errno));
341 /* Is it already in the open list? If so, fail. */
342 if (tdb_already_open(st.st_dev, st.st_ino)) {
344 ecode = tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_USE_ERROR,
345 "tdb_open: %s (%d,%d) is already open"
347 name, (int)st.st_dev, (int)st.st_ino);
351 tdb->name = strdup(name);
353 ecode = tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_ERROR,
354 "tdb_open: failed to allocate name");
358 tdb->device = st.st_dev;
359 tdb->inode = st.st_ino;
360 tdb_unlock_open(tdb);
362 /* This make sure we have current map_size and mmap. */
363 tdb->methods->oob(tdb, tdb->map_size + 1, true);
365 /* Now it's fully formed, recover if necessary. */
366 berr = tdb_needs_recovery(tdb);
367 if (unlikely(berr != false)) {
372 ecode = tdb_lock_and_recover(tdb);
373 if (ecode != TDB_SUCCESS) {
378 ecode = tdb_ftable_init(tdb);
379 if (ecode != TDB_SUCCESS) {
388 /* Map ecode to some logical errno. */
391 case TDB_ERR_CORRUPT:
396 saved_errno = EWOULDBLOCK;
399 saved_errno = ENOMEM;
402 saved_errno = EINVAL;
405 saved_errno = EINVAL;
414 if (tdb->flags & TDB_INTERNAL) {
420 free((char *)tdb->name);
422 if (close(tdb->fd) != 0)
423 tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
424 "tdb_open: failed to close tdb->fd"
425 " on error: %s", strerror(errno));
431 static enum TDB_ERROR update_rec_hdr(struct tdb_context *tdb,
435 struct tdb_used_record *rec,
438 uint64_t dataroom = rec_data_length(rec) + rec_extra_padding(rec);
439 enum TDB_ERROR ecode;
441 ecode = set_header(tdb, rec, TDB_USED_MAGIC, keylen, datalen,
442 keylen + dataroom, h);
443 if (ecode == TDB_SUCCESS) {
444 ecode = tdb_write_convert(tdb, off, rec, sizeof(*rec));
449 static enum TDB_ERROR replace_data(struct tdb_context *tdb,
451 struct tdb_data key, struct tdb_data dbuf,
452 tdb_off_t old_off, tdb_len_t old_room,
456 enum TDB_ERROR ecode;
458 /* Allocate a new record. */
459 new_off = alloc(tdb, key.dsize, dbuf.dsize, h->h, TDB_USED_MAGIC,
461 if (TDB_OFF_IS_ERR(new_off)) {
465 /* We didn't like the existing one: remove it. */
467 add_stat(tdb, frees, 1);
468 ecode = add_free_record(tdb, old_off,
469 sizeof(struct tdb_used_record)
470 + key.dsize + old_room);
471 if (ecode == TDB_SUCCESS)
472 ecode = replace_in_hash(tdb, h, new_off);
474 ecode = add_to_hash(tdb, h, new_off);
476 if (ecode != TDB_SUCCESS) {
480 new_off += sizeof(struct tdb_used_record);
481 ecode = tdb->methods->twrite(tdb, new_off, key.dptr, key.dsize);
482 if (ecode != TDB_SUCCESS) {
486 new_off += key.dsize;
487 ecode = tdb->methods->twrite(tdb, new_off, dbuf.dptr, dbuf.dsize);
488 if (ecode != TDB_SUCCESS) {
492 /* FIXME: tdb_increment_seqnum(tdb); */
496 enum TDB_ERROR tdb_store(struct tdb_context *tdb,
497 struct tdb_data key, struct tdb_data dbuf, int flag)
501 tdb_len_t old_room = 0;
502 struct tdb_used_record rec;
503 enum TDB_ERROR ecode;
505 off = find_and_lock(tdb, key, F_WRLCK, &h, &rec, NULL);
506 if (TDB_OFF_IS_ERR(off)) {
510 /* Now we have lock on this hash bucket. */
511 if (flag == TDB_INSERT) {
513 ecode = TDB_ERR_EXISTS;
518 old_room = rec_data_length(&rec)
519 + rec_extra_padding(&rec);
520 if (old_room >= dbuf.dsize) {
521 /* Can modify in-place. Easy! */
522 ecode = update_rec_hdr(tdb, off,
523 key.dsize, dbuf.dsize,
525 if (ecode != TDB_SUCCESS) {
528 ecode = tdb->methods->twrite(tdb,
533 if (ecode != TDB_SUCCESS) {
536 tdb_unlock_hashes(tdb, h.hlock_start,
537 h.hlock_range, F_WRLCK);
541 if (flag == TDB_MODIFY) {
542 /* if the record doesn't exist and we
543 are in TDB_MODIFY mode then we should fail
545 ecode = TDB_ERR_NOEXIST;
551 /* If we didn't use the old record, this implies we're growing. */
552 ecode = replace_data(tdb, &h, key, dbuf, off, old_room, off);
554 tdb_unlock_hashes(tdb, h.hlock_start, h.hlock_range, F_WRLCK);
558 enum TDB_ERROR tdb_append(struct tdb_context *tdb,
559 struct tdb_data key, struct tdb_data dbuf)
563 struct tdb_used_record rec;
564 tdb_len_t old_room = 0, old_dlen;
565 unsigned char *newdata;
566 struct tdb_data new_dbuf;
567 enum TDB_ERROR ecode;
569 off = find_and_lock(tdb, key, F_WRLCK, &h, &rec, NULL);
570 if (TDB_OFF_IS_ERR(off)) {
575 old_dlen = rec_data_length(&rec);
576 old_room = old_dlen + rec_extra_padding(&rec);
578 /* Fast path: can append in place. */
579 if (rec_extra_padding(&rec) >= dbuf.dsize) {
580 ecode = update_rec_hdr(tdb, off, key.dsize,
581 old_dlen + dbuf.dsize, &rec,
583 if (ecode != TDB_SUCCESS) {
587 off += sizeof(rec) + key.dsize + old_dlen;
588 ecode = tdb->methods->twrite(tdb, off, dbuf.dptr,
594 newdata = malloc(key.dsize + old_dlen + dbuf.dsize);
596 ecode = tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_ERROR,
598 " failed to allocate %zu bytes",
599 (size_t)(key.dsize + old_dlen
603 ecode = tdb->methods->tread(tdb, off + sizeof(rec) + key.dsize,
605 if (ecode != TDB_SUCCESS) {
606 goto out_free_newdata;
608 memcpy(newdata + old_dlen, dbuf.dptr, dbuf.dsize);
609 new_dbuf.dptr = newdata;
610 new_dbuf.dsize = old_dlen + dbuf.dsize;
616 /* If they're using tdb_append(), it implies they're growing record. */
617 ecode = replace_data(tdb, &h, key, new_dbuf, off, old_room, true);
622 tdb_unlock_hashes(tdb, h.hlock_start, h.hlock_range, F_WRLCK);
626 enum TDB_ERROR tdb_fetch(struct tdb_context *tdb, struct tdb_data key,
627 struct tdb_data *data)
630 struct tdb_used_record rec;
632 enum TDB_ERROR ecode;
634 off = find_and_lock(tdb, key, F_RDLCK, &h, &rec, NULL);
635 if (TDB_OFF_IS_ERR(off)) {
640 ecode = TDB_ERR_NOEXIST;
642 data->dsize = rec_data_length(&rec);
643 data->dptr = tdb_alloc_read(tdb, off + sizeof(rec) + key.dsize,
645 if (TDB_PTR_IS_ERR(data->dptr)) {
646 ecode = TDB_PTR_ERR(data->dptr);
651 tdb_unlock_hashes(tdb, h.hlock_start, h.hlock_range, F_RDLCK);
655 enum TDB_ERROR tdb_delete(struct tdb_context *tdb, struct tdb_data key)
658 struct tdb_used_record rec;
660 enum TDB_ERROR ecode;
662 off = find_and_lock(tdb, key, F_WRLCK, &h, &rec, NULL);
663 if (TDB_OFF_IS_ERR(off)) {
668 ecode = TDB_ERR_NOEXIST;
672 ecode = delete_from_hash(tdb, &h);
673 if (ecode != TDB_SUCCESS) {
677 /* Free the deleted entry. */
678 add_stat(tdb, frees, 1);
679 ecode = add_free_record(tdb, off,
680 sizeof(struct tdb_used_record)
681 + rec_key_length(&rec)
682 + rec_data_length(&rec)
683 + rec_extra_padding(&rec));
686 tdb_unlock_hashes(tdb, h.hlock_start, h.hlock_range, F_WRLCK);
690 int tdb_close(struct tdb_context *tdb)
692 struct tdb_context **i;
695 tdb_trace(tdb, "tdb_close");
697 if (tdb->transaction) {
698 tdb_transaction_cancel(tdb);
702 if (tdb->flags & TDB_INTERNAL)
707 free((char *)tdb->name);
709 ret = close(tdb->fd);
714 /* Remove from contexts list */
715 for (i = &tdbs; *i; i = &(*i)->next) {
730 const char *tdb_errorstr(enum TDB_ERROR ecode)
732 /* Gcc warns if you miss a case in the switch, so use that. */
734 case TDB_SUCCESS: return "Success";
735 case TDB_ERR_CORRUPT: return "Corrupt database";
736 case TDB_ERR_IO: return "IO Error";
737 case TDB_ERR_LOCK: return "Locking error";
738 case TDB_ERR_OOM: return "Out of memory";
739 case TDB_ERR_EXISTS: return "Record exists";
740 case TDB_ERR_EINVAL: return "Invalid parameter";
741 case TDB_ERR_NOEXIST: return "Record does not exist";
742 case TDB_ERR_RDONLY: return "write not permitted";
744 return "Invalid error code";
747 enum TDB_ERROR COLD tdb_logerr(struct tdb_context *tdb,
748 enum TDB_ERROR ecode,
749 enum tdb_log_level level,
750 const char *fmt, ...)
755 /* tdb_open paths care about errno, so save it. */
756 int saved_errno = errno;
761 /* FIXME: Doesn't assume asprintf. */
763 len = vsnprintf(NULL, 0, fmt, ap);
766 message = malloc(len + 1);
768 tdb->logfn(tdb, TDB_LOG_ERROR, tdb->log_private,
769 "out of memory formatting message:");
770 tdb->logfn(tdb, level, tdb->log_private, fmt);
774 len = vsprintf(message, fmt, ap);
776 tdb->logfn(tdb, level, tdb->log_private, message);