mirror of
https://github.com/samba-team/samba.git
synced 2024-12-23 17:34:34 +03:00
0ea5db4e0d
The tdb1 backend simply returns "true" if there's an error determining if a tdb needs recovery. But this leads failtest down a rabbit hole; it's better to return the error at this case (and makes for better for diagnostics, since they will come from the first fault, not later in tdb1_transaction_recover(). Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> (Imported from CCAN commit 332d0c29baa6896e67c439aeb47f58a104fbc781)
179 lines
7.1 KiB
C
179 lines
7.1 KiB
C
#ifndef CCAN_TDB2_TDB1_PRIVATE_H
|
|
#define CCAN_TDB2_TDB1_PRIVATE_H
|
|
/*
|
|
Unix SMB/CIFS implementation.
|
|
|
|
trivial database library - private includes
|
|
|
|
Copyright (C) Andrew Tridgell 2005
|
|
|
|
** NOTE! The following LGPL license applies to the tdb
|
|
** library. This does NOT imply that all of Samba is released
|
|
** under the LGPL
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 3 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include "private.h"
|
|
|
|
#include <limits.h>
|
|
|
|
/* #define TDB_TRACE 1 */
|
|
#ifndef HAVE_GETPAGESIZE
|
|
#define getpagesize() 0x2000
|
|
#endif
|
|
|
|
#ifndef __STRING
|
|
#define __STRING(x) #x
|
|
#endif
|
|
|
|
#ifndef __STRINGSTRING
|
|
#define __STRINGSTRING(x) __STRING(x)
|
|
#endif
|
|
|
|
#ifndef __location__
|
|
#define __location__ __FILE__ ":" __STRINGSTRING(__LINE__)
|
|
#endif
|
|
|
|
#ifndef offsetof
|
|
#define offsetof(t,f) ((unsigned int)&((t *)0)->f)
|
|
#endif
|
|
|
|
#define TDB1_VERSION (0x26011967 + 6)
|
|
#define TDB1_MAGIC (0x26011999U)
|
|
#define TDB1_FREE_MAGIC (~TDB1_MAGIC)
|
|
#define TDB1_DEAD_MAGIC (0xFEE1DEAD)
|
|
#define TDB1_RECOVERY_MAGIC (0xf53bc0e7U)
|
|
#define TDB1_RECOVERY_INVALID_MAGIC (0x0)
|
|
#define TDB1_HASH_RWLOCK_MAGIC (0xbad1a51U)
|
|
#define TDB1_ALIGNMENT 4
|
|
#define TDB1_DEFAULT_HASH_SIZE 131
|
|
#define TDB1_FREELIST_TOP (sizeof(struct tdb1_header))
|
|
#define TDB1_ALIGN(x,a) (((x) + (a)-1) & ~((a)-1))
|
|
#define TDB1_DEAD(r) ((r)->magic == TDB1_DEAD_MAGIC)
|
|
#define TDB1_BAD_MAGIC(r) ((r)->magic != TDB1_MAGIC && !TDB1_DEAD(r))
|
|
#define TDB1_HASH_TOP(hash) (TDB1_FREELIST_TOP + (TDB1_BUCKET(hash)+1)*sizeof(tdb1_off_t))
|
|
#define TDB1_HASHTABLE_SIZE(tdb) ((tdb->tdb1.header.hash_size+1)*sizeof(tdb1_off_t))
|
|
#define TDB1_DATA_START(hash_size) (TDB1_HASH_TOP(hash_size-1) + sizeof(tdb1_off_t))
|
|
#define TDB1_RECOVERY_HEAD offsetof(struct tdb1_header, recovery_start)
|
|
#define TDB1_SEQNUM_OFS offsetof(struct tdb1_header, sequence_number)
|
|
#define TDB1_PAD_BYTE 0x42
|
|
#define TDB1_PAD_U32 0x42424242
|
|
|
|
/* lock offsets */
|
|
#define TDB1_OPEN_LOCK 0
|
|
#define TDB1_ACTIVE_LOCK 4
|
|
#define TDB1_TRANSACTION_LOCK 8
|
|
|
|
/* free memory if the pointer is valid and zero the pointer */
|
|
#ifndef SAFE_FREE
|
|
#define SAFE_FREE(x) do { if ((x) != NULL) {free((void *)x); (x)=NULL;} } while(0)
|
|
#endif
|
|
|
|
#define TDB1_BUCKET(hash) ((hash) % tdb->tdb1.header.hash_size)
|
|
|
|
#define TDB1_DOCONV() (tdb->flags & TDB_CONVERT)
|
|
#define TDB1_CONV(x) (TDB1_DOCONV() ? tdb1_convert(&x, sizeof(x)) : &x)
|
|
|
|
/* the body of the database is made of one tdb1_record for the free space
|
|
plus a separate data list for each hash value */
|
|
struct tdb1_record {
|
|
tdb1_off_t next; /* offset of the next record in the list */
|
|
tdb1_len_t rec_len; /* total byte length of record */
|
|
tdb1_len_t key_len; /* byte length of key */
|
|
tdb1_len_t data_len; /* byte length of data */
|
|
uint32_t full_hash; /* the full 32 bit hash of the key */
|
|
uint32_t magic; /* try to catch errors */
|
|
/* the following union is implied:
|
|
union {
|
|
char record[rec_len];
|
|
struct {
|
|
char key[key_len];
|
|
char data[data_len];
|
|
}
|
|
uint32_t totalsize; (tailer)
|
|
}
|
|
*/
|
|
};
|
|
|
|
|
|
struct tdb1_methods {
|
|
int (*tdb1_read)(struct tdb_context *, tdb1_off_t , void *, tdb1_len_t , int );
|
|
int (*tdb1_write)(struct tdb_context *, tdb1_off_t, const void *, tdb1_len_t);
|
|
void (*next_hash_chain)(struct tdb_context *, uint32_t *);
|
|
int (*tdb1_oob)(struct tdb_context *, tdb1_off_t , int );
|
|
int (*tdb1_expand_file)(struct tdb_context *, tdb1_off_t , tdb1_off_t );
|
|
};
|
|
|
|
|
|
/*
|
|
internal prototypes
|
|
*/
|
|
int tdb1_munmap(struct tdb_context *tdb);
|
|
void tdb1_mmap(struct tdb_context *tdb);
|
|
int tdb1_lock(struct tdb_context *tdb, int list, int ltype);
|
|
int tdb1_nest_lock(struct tdb_context *tdb, uint32_t offset, int ltype,
|
|
enum tdb_lock_flags flags);
|
|
int tdb1_nest_unlock(struct tdb_context *tdb, uint32_t offset, int ltype);
|
|
int tdb1_unlock(struct tdb_context *tdb, int list, int ltype);
|
|
int tdb1_brlock(struct tdb_context *tdb,
|
|
int rw_type, tdb1_off_t offset, size_t len,
|
|
enum tdb_lock_flags flags);
|
|
int tdb1_brunlock(struct tdb_context *tdb,
|
|
int rw_type, tdb1_off_t offset, size_t len);
|
|
bool tdb1_have_extra_locks(struct tdb_context *tdb);
|
|
void tdb1_release_transaction_locks(struct tdb_context *tdb);
|
|
int tdb1_transaction_lock(struct tdb_context *tdb, int ltype,
|
|
enum tdb_lock_flags lockflags);
|
|
int tdb1_transaction_unlock(struct tdb_context *tdb, int ltype);
|
|
int tdb1_recovery_area(struct tdb_context *tdb,
|
|
const struct tdb1_methods *methods,
|
|
tdb1_off_t *recovery_offset,
|
|
struct tdb1_record *rec);
|
|
int tdb1_allrecord_upgrade(struct tdb_context *tdb);
|
|
int tdb1_write_lock_record(struct tdb_context *tdb, tdb1_off_t off);
|
|
int tdb1_write_unlock_record(struct tdb_context *tdb, tdb1_off_t off);
|
|
int tdb1_ofs_read(struct tdb_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
|
|
int tdb1_ofs_write(struct tdb_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
|
|
void *tdb1_convert(void *buf, uint32_t size);
|
|
int tdb1_free(struct tdb_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
|
|
tdb1_off_t tdb1_allocate(struct tdb_context *tdb, tdb1_len_t length, struct tdb1_record *rec);
|
|
int tdb1_ofs_read(struct tdb_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
|
|
int tdb1_ofs_write(struct tdb_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
|
|
int tdb1_lock_record(struct tdb_context *tdb, tdb1_off_t off);
|
|
int tdb1_unlock_record(struct tdb_context *tdb, tdb1_off_t off);
|
|
tdb_bool_err tdb1_needs_recovery(struct tdb_context *tdb);
|
|
int tdb1_rec_read(struct tdb_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
|
|
int tdb1_rec_write(struct tdb_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
|
|
int tdb1_do_delete(struct tdb_context *tdb, tdb1_off_t rec_ptr, struct tdb1_record *rec);
|
|
unsigned char *tdb1_alloc_read(struct tdb_context *tdb, tdb1_off_t offset, tdb1_len_t len);
|
|
enum TDB_ERROR tdb1_parse_data(struct tdb_context *tdb, TDB_DATA key,
|
|
tdb1_off_t offset, tdb1_len_t len,
|
|
enum TDB_ERROR (*parser)(TDB_DATA key,
|
|
TDB_DATA data,
|
|
void *private_data),
|
|
void *private_data);
|
|
tdb1_off_t tdb1_find_lock_hash(struct tdb_context *tdb, TDB_DATA key, uint32_t hash, int locktype,
|
|
struct tdb1_record *rec);
|
|
void tdb1_io_init(struct tdb_context *tdb);
|
|
int tdb1_expand(struct tdb_context *tdb, tdb1_off_t size);
|
|
int tdb1_rec_free_read(struct tdb_context *tdb, tdb1_off_t off,
|
|
struct tdb1_record *rec);
|
|
bool tdb1_write_all(int fd, const void *buf, size_t count);
|
|
void tdb1_header_hash(struct tdb_context *tdb,
|
|
uint32_t *magic1_hash, uint32_t *magic2_hash);
|
|
uint64_t tdb1_old_hash(const void *key, size_t len, uint64_t seed, void *);
|
|
size_t tdb1_dead_space(struct tdb_context *tdb, tdb1_off_t off);
|
|
#endif /* CCAN_TDB2_TDB1_PRIVATE_H */
|