sin/samba-mirror
1
0
Fork 0
mirror of https://github.com/samba-team/samba.git synced 2024-12-23 17:34:34 +03:00
Code
737c0a5473
samba-mirror/lib/dbwrap/dbwrap.h

132 lines
5.2 KiB
C
Raw Normal View History

r22775: For the cluster code I've developed a wrapper around tdb to put different database backends in place dynamically. The main abstractions are db_context and db_record, it should be mainly self-describing, see include/dbwrap.h. You open the db just as you would open a tdb, this time with db_open(). If you want to fetch a record, just do the db->fetch() call, if you want to do operations on it, you need to get it with fetch_locked(). I added dbwrap_file.c (not heavily tested lately) as an example for what can be done with that abstraction, uses a file per key. So if anybody is willing to shape that up, we might have a chance on reiserfs again.... :-) This abstraction works fine for brlock.tdb, locking.tdb, connections.tdb and sessionid.tdb. It should work fine for the others as well, I just did not yet get around to convert them. If nobody loudly screams NO, then I will import the code that uses this soon. Volker (This used to be commit e9d7484ca246cfca4a1fd23be35edc2783136ebe)
2007-05-10 14:42:13 +04:00
/*
Unix SMB/CIFS implementation.
Database interface wrapper around tdb
Copyright (C) Volker Lendecke 2005-2007
s3: Fix some nonempty blank lines
2010-03-14 16:06:45 +03:00
r22775: For the cluster code I've developed a wrapper around tdb to put different database backends in place dynamically. The main abstractions are db_context and db_record, it should be mainly self-describing, see include/dbwrap.h. You open the db just as you would open a tdb, this time with db_open(). If you want to fetch a record, just do the db->fetch() call, if you want to do operations on it, you need to get it with fetch_locked(). I added dbwrap_file.c (not heavily tested lately) as an example for what can be done with that abstraction, uses a file per key. So if anybody is willing to shape that up, we might have a chance on reiserfs again.... :-) This abstraction works fine for brlock.tdb, locking.tdb, connections.tdb and sessionid.tdb. It should work fine for the others as well, I just did not yet get around to convert them. If nobody loudly screams NO, then I will import the code that uses this soon. Volker (This used to be commit e9d7484ca246cfca4a1fd23be35edc2783136ebe)
2007-05-10 14:42:13 +04:00
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
r23779: Change from v2 or later to v3 or later. Jeremy. (This used to be commit 407e6e695b8366369b7c76af1ff76869b45347b3)
2007-07-09 23:25:36 +04:00
the Free Software Foundation; either version 3 of the License, or
r22775: For the cluster code I've developed a wrapper around tdb to put different database backends in place dynamically. The main abstractions are db_context and db_record, it should be mainly self-describing, see include/dbwrap.h. You open the db just as you would open a tdb, this time with db_open(). If you want to fetch a record, just do the db->fetch() call, if you want to do operations on it, you need to get it with fetch_locked(). I added dbwrap_file.c (not heavily tested lately) as an example for what can be done with that abstraction, uses a file per key. So if anybody is willing to shape that up, we might have a chance on reiserfs again.... :-) This abstraction works fine for brlock.tdb, locking.tdb, connections.tdb and sessionid.tdb. It should work fine for the others as well, I just did not yet get around to convert them. If nobody loudly screams NO, then I will import the code that uses this soon. Volker (This used to be commit e9d7484ca246cfca4a1fd23be35edc2783136ebe)
2007-05-10 14:42:13 +04:00
(at your option) any later version.
s3: Fix some nonempty blank lines
2010-03-14 16:06:45 +03:00
r22775: For the cluster code I've developed a wrapper around tdb to put different database backends in place dynamically. The main abstractions are db_context and db_record, it should be mainly self-describing, see include/dbwrap.h. You open the db just as you would open a tdb, this time with db_open(). If you want to fetch a record, just do the db->fetch() call, if you want to do operations on it, you need to get it with fetch_locked(). I added dbwrap_file.c (not heavily tested lately) as an example for what can be done with that abstraction, uses a file per key. So if anybody is willing to shape that up, we might have a chance on reiserfs again.... :-) This abstraction works fine for brlock.tdb, locking.tdb, connections.tdb and sessionid.tdb. It should work fine for the others as well, I just did not yet get around to convert them. If nobody loudly screams NO, then I will import the code that uses this soon. Volker (This used to be commit e9d7484ca246cfca4a1fd23be35edc2783136ebe)
2007-05-10 14:42:13 +04:00
This program 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 General Public License for more details.
s3: Fix some nonempty blank lines
2010-03-14 16:06:45 +03:00
r22775: For the cluster code I've developed a wrapper around tdb to put different database backends in place dynamically. The main abstractions are db_context and db_record, it should be mainly self-describing, see include/dbwrap.h. You open the db just as you would open a tdb, this time with db_open(). If you want to fetch a record, just do the db->fetch() call, if you want to do operations on it, you need to get it with fetch_locked(). I added dbwrap_file.c (not heavily tested lately) as an example for what can be done with that abstraction, uses a file per key. So if anybody is willing to shape that up, we might have a chance on reiserfs again.... :-) This abstraction works fine for brlock.tdb, locking.tdb, connections.tdb and sessionid.tdb. It should work fine for the others as well, I just did not yet get around to convert them. If nobody loudly screams NO, then I will import the code that uses this soon. Volker (This used to be commit e9d7484ca246cfca4a1fd23be35edc2783136ebe)
2007-05-10 14:42:13 +04:00
You should have received a copy of the GNU General Public License
r23784: use the GPLv3 boilerplate as recommended by the FSF and the license text (This used to be commit b0132e94fc5fef936aa766fb99a306b3628e9f07)
2007-07-10 04:52:41 +04:00
along with this program. If not, see <http://www.gnu.org/licenses/>.
r22775: For the cluster code I've developed a wrapper around tdb to put different database backends in place dynamically. The main abstractions are db_context and db_record, it should be mainly self-describing, see include/dbwrap.h. You open the db just as you would open a tdb, this time with db_open(). If you want to fetch a record, just do the db->fetch() call, if you want to do operations on it, you need to get it with fetch_locked(). I added dbwrap_file.c (not heavily tested lately) as an example for what can be done with that abstraction, uses a file per key. So if anybody is willing to shape that up, we might have a chance on reiserfs again.... :-) This abstraction works fine for brlock.tdb, locking.tdb, connections.tdb and sessionid.tdb. It should work fine for the others as well, I just did not yet get around to convert them. If nobody loudly screams NO, then I will import the code that uses this soon. Volker (This used to be commit e9d7484ca246cfca4a1fd23be35edc2783136ebe)
2007-05-10 14:42:13 +04:00
*/
Cosmetic fix (This used to be commit 8d8cb8f9ccbc013b97c252d27c3af4e2eb10d56a)
2007-11-07 22:18:38 +03:00
#ifndef __DBWRAP_H__
#define __DBWRAP_H__
r22775: For the cluster code I've developed a wrapper around tdb to put different database backends in place dynamically. The main abstractions are db_context and db_record, it should be mainly self-describing, see include/dbwrap.h. You open the db just as you would open a tdb, this time with db_open(). If you want to fetch a record, just do the db->fetch() call, if you want to do operations on it, you need to get it with fetch_locked(). I added dbwrap_file.c (not heavily tested lately) as an example for what can be done with that abstraction, uses a file per key. So if anybody is willing to shape that up, we might have a chance on reiserfs again.... :-) This abstraction works fine for brlock.tdb, locking.tdb, connections.tdb and sessionid.tdb. It should work fine for the others as well, I just did not yet get around to convert them. If nobody loudly screams NO, then I will import the code that uses this soon. Volker (This used to be commit e9d7484ca246cfca4a1fd23be35edc2783136ebe)
2007-05-10 14:42:13 +04:00
tdb_compat.h: divert every tdb build and includes to tdb_compat We change all the headers and wscript files to use tdb_compat; this means we have one place to decide whether to use TDB1 or TDB2. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2011-06-20 13:10:25 +04:00
#include "tdb_compat.h"
s3: only include tdb headers where needed. Guenther
2011-05-05 13:25:29 +04:00
s3:dbwrap: move definitions of db_record and db_contect structs to dbwrap_private.h The API and callers now only need the forward declarations.
2011-08-24 16:53:42 +04:00
struct db_record;
struct db_context;
r22775: For the cluster code I've developed a wrapper around tdb to put different database backends in place dynamically. The main abstractions are db_context and db_record, it should be mainly self-describing, see include/dbwrap.h. You open the db just as you would open a tdb, this time with db_open(). If you want to fetch a record, just do the db->fetch() call, if you want to do operations on it, you need to get it with fetch_locked(). I added dbwrap_file.c (not heavily tested lately) as an example for what can be done with that abstraction, uses a file per key. So if anybody is willing to shape that up, we might have a chance on reiserfs again.... :-) This abstraction works fine for brlock.tdb, locking.tdb, connections.tdb and sessionid.tdb. It should work fine for the others as well, I just did not yet get around to convert them. If nobody loudly screams NO, then I will import the code that uses this soon. Volker (This used to be commit e9d7484ca246cfca4a1fd23be35edc2783136ebe)
2007-05-10 14:42:13 +04:00
s3:dbwrap: move definition of dbwrap_lock_order to dbwrap.h This is needed in all of the library, not only in the dbwrap_open part.
2012-05-11 23:36:48 +04:00
enum dbwrap_lock_order {
DBWRAP_LOCK_ORDER_1 = 1,
DBWRAP_LOCK_ORDER_2 = 2,
DBWRAP_LOCK_ORDER_3 = 3
};
s3:dbwrap: reorganize dbwrap.h some
2011-08-17 10:45:09 +04:00
/* The following definitions come from lib/dbwrap.c */
build: don't autogenerate prototypes for util_tdb and dbwrap anymore. Stick to hand-written headers (that are there anyways). Add some missing prototypes to util_tdb.h and dbwrap.h. I did not bother to add a header for each single dbwrap backend open function but put the prototypes for the open functions into the central dbwrap.h. Michael (This used to be commit edf4dbed27a3c63c04e8110e75cdb76e31627eb6)
2008-03-25 14:54:14 +03:00
s3:dbwrap: add get-functions for db_record key, value and private_data
2011-08-19 12:50:20 +04:00
TDB_DATA dbwrap_record_get_key(const struct db_record *rec);
TDB_DATA dbwrap_record_get_value(const struct db_record *rec);
s3:dbwrap: add dbwrap_record_store(), a wrapper for record->store
2011-08-19 12:51:27 +04:00
NTSTATUS dbwrap_record_store(struct db_record *rec, TDB_DATA data, int flags);
s3:dbwrap: add dbwrap_record_delete(), a wrapper for record->delete_rec
2011-08-19 12:52:57 +04:00
NTSTATUS dbwrap_record_delete(struct db_record *rec);
s3:dbwrap: add dbwrap_fetch_locked(), a wrapper for db->fetch_locked
2011-08-19 12:53:29 +04:00
struct db_record *dbwrap_fetch_locked(struct db_context *db,
TALLOC_CTX *mem_ctx,
TDB_DATA key);
s3: Add dbwrap_try_fetch_locked This is designed to spread the load on individual ctdb records to allow upper layers to do backoff mechanisms. In the ctdb case, do not get the record if a local lock is already taken. If we are not dmaster, do at most one migrate attempt. For the tdb case, this is a nonblocking fetch_locked. If someone else has the lock, give up.
2012-03-27 16:31:04 +04:00
struct db_record *dbwrap_try_fetch_locked(struct db_context *db,
TALLOC_CTX *mem_ctx,
TDB_DATA key);
s3-dbwrap: Add "db_context" to "db_record"
2012-01-02 16:30:51 +04:00
struct db_context *dbwrap_record_get_db(struct db_record *rec);
s3-dbwrap: Add dbwrap_set_stored_callback This is a per-db function that is called whenever some record is modified
2012-02-15 18:08:29 +04:00
void dbwrap_set_stored_callback(
struct db_context *db,
void (*cb)(struct db_context *db, struct db_record *rec,
void *private_data),
void *private_data);
s3:dbwrap: add get-functions for db_record key, value and private_data
2011-08-19 12:50:20 +04:00
s3:dbwrap: add dbwrap_delete(), dbwrap_store() and dbwrap_fetch() The _bystring function are now just tiny wrappers. metze
2008-12-17 10:53:31 +03:00
NTSTATUS dbwrap_delete(struct db_context *db, TDB_DATA key);
NTSTATUS dbwrap_store(struct db_context *db, TDB_DATA key,
TDB_DATA data, int flags);
s3:dbwrap: convert dbwrap_fetch(), dbwrap_fetch_bystring() and dbwrap_fetch_bystring_upper() to NTSTATUS
2011-08-24 15:08:13 +04:00
NTSTATUS dbwrap_fetch(struct db_context *db, TALLOC_CTX *mem_ctx,
TDB_DATA key, TDB_DATA *value);
s3:dbwrap: add function dbwrap_exists() Signed-off-by: Michael Adam <obnox@samba.org>
2011-07-04 12:15:44 +04:00
bool dbwrap_exists(struct db_context *db, TDB_DATA key);
s3:dbwrap: reorganize dbwrap.h some
2011-08-17 10:45:09 +04:00
NTSTATUS dbwrap_traverse(struct db_context *db,
int (*f)(struct db_record*, void*),
s3:dbwrap: change the dbwrap_traverse() wrapper to return the count in an additional parameter
2011-08-17 11:51:12 +04:00
void *private_data,
int *count);
s3:dbwrap: add a wrapper dbwrap_traverse_read()
2011-08-17 11:59:25 +04:00
NTSTATUS dbwrap_traverse_read(struct db_context *db,
int (*f)(struct db_record*, void*),
void *private_data,
int *count);
s3-dbwrap: Make dbwrap_parse_record return NTSTATUS Also, the parser now returns void. The parser is called if and only if dbwrap_parse_record returns NT_STATUS_OK. Signed-off-by: Michael Adam <obnox@samba.org>
2011-12-08 18:50:33 +04:00
NTSTATUS dbwrap_parse_record(struct db_context *db, TDB_DATA key,
void (*parser)(TDB_DATA key, TDB_DATA data,
void *private_data),
void *private_data);
s3:dbwrap: add function dbwrap_wipe() Signed-off-by: Michael Adam <obnox@samba.org>
2011-08-16 16:39:19 +04:00
int dbwrap_wipe(struct db_context *db);
s3:dbwrap: add wrapper function dbwrap_get_seqnum()
2011-08-18 16:09:56 +04:00
int dbwrap_get_seqnum(struct db_context *db);
s3:dbwrap: add wrapper dbwrap_get_flags()
2011-08-18 00:43:01 +04:00
int dbwrap_get_flags(struct db_context *db);
s3:dbwrap: add wrappers for transactions start/cancel/commit
2011-08-18 00:51:12 +04:00
int dbwrap_transaction_start(struct db_context *db);
int dbwrap_transaction_commit(struct db_context *db);
int dbwrap_transaction_cancel(struct db_context *db);
s3-dbwrap: Add dbwrap_db_id This returns a blob uniquely identifying the database
2012-02-15 17:57:01 +04:00
void dbwrap_db_id(struct db_context *db, const uint8_t **id, size_t *idlen);
s3:dbwrap: reorganize dbwrap.h some
2011-08-17 10:45:09 +04:00
/* The following definitions come from lib/dbwrap_util.c */
Add dbwrap bystring service routines (This used to be commit 1e214b536b0628db299d701839e62a4ac52727c9)
2007-11-24 21:56:16 +03:00
NTSTATUS dbwrap_delete_bystring(struct db_context *db, const char *key);
NTSTATUS dbwrap_store_bystring(struct db_context *db, const char *key,
TDB_DATA data, int flags);
s3:dbwrap: convert dbwrap_fetch(), dbwrap_fetch_bystring() and dbwrap_fetch_bystring_upper() to NTSTATUS
2011-08-24 15:08:13 +04:00
NTSTATUS dbwrap_fetch_bystring(struct db_context *db, TALLOC_CTX *mem_ctx,
const char *key, TDB_DATA *value);
r22775: For the cluster code I've developed a wrapper around tdb to put different database backends in place dynamically. The main abstractions are db_context and db_record, it should be mainly self-describing, see include/dbwrap.h. You open the db just as you would open a tdb, this time with db_open(). If you want to fetch a record, just do the db->fetch() call, if you want to do operations on it, you need to get it with fetch_locked(). I added dbwrap_file.c (not heavily tested lately) as an example for what can be done with that abstraction, uses a file per key. So if anybody is willing to shape that up, we might have a chance on reiserfs again.... :-) This abstraction works fine for brlock.tdb, locking.tdb, connections.tdb and sessionid.tdb. It should work fine for the others as well, I just did not yet get around to convert them. If nobody loudly screams NO, then I will import the code that uses this soon. Volker (This used to be commit e9d7484ca246cfca4a1fd23be35edc2783136ebe)
2007-05-10 14:42:13 +04:00
dbwrap: dbwrap_fetch_int32->dbwrap_fetch_int32_bystring Signed-off-by: Michael Adam <obnox@samba.org>
2012-06-14 22:26:28 +04:00
NTSTATUS dbwrap_fetch_int32_bystring(struct db_context *db, const char *keystr,
int32_t *result);
s3:dbwrap: change dbwrap_store_int32() to NTSTATUS return type for consistency and better error propagation
2011-10-06 23:24:07 +04:00
NTSTATUS dbwrap_store_int32(struct db_context *db, const char *keystr,
int32_t v);
s3:dbwrap: change dbwrap_fetch_uint32() to NTSTATUS return type (instead of bool) for consistency and better error propagation
2011-10-06 23:07:27 +04:00
NTSTATUS dbwrap_fetch_uint32(struct db_context *db, const char *keystr,
uint32_t *val);
s3:dbwrap: change dbwrap_store_uint32() to NTSTATUS return type for consistency and better error propagation Autobuild-User: Michael Adam <obnox@samba.org> Autobuild-Date: Tue Oct 11 15:51:00 CEST 2011 on sn-devel-104
2011-10-06 23:29:04 +04:00
NTSTATUS dbwrap_store_uint32(struct db_context *db, const char *keystr,
uint32_t v);
s3-build: use dbwrap.h only where needed. Guenther
2010-08-18 20:59:23 +04:00
NTSTATUS dbwrap_change_uint32_atomic(struct db_context *db, const char *keystr,
uint32_t *oldval, uint32_t change_val);
NTSTATUS dbwrap_trans_change_uint32_atomic(struct db_context *db,
const char *keystr,
uint32_t *oldval,
uint32_t change_val);
NTSTATUS dbwrap_change_int32_atomic(struct db_context *db, const char *keystr,
int32_t *oldval, int32_t change_val);
NTSTATUS dbwrap_trans_change_int32_atomic(struct db_context *db,
const char *keystr,
int32_t *oldval,
int32_t change_val);
NTSTATUS dbwrap_trans_store(struct db_context *db, TDB_DATA key, TDB_DATA dbuf,
int flag);
NTSTATUS dbwrap_trans_delete(struct db_context *db, TDB_DATA key);
NTSTATUS dbwrap_trans_store_int32(struct db_context *db, const char *keystr,
int32_t v);
NTSTATUS dbwrap_trans_store_uint32(struct db_context *db, const char *keystr,
uint32_t v);
NTSTATUS dbwrap_trans_store_bystring(struct db_context *db, const char *key,
TDB_DATA data, int flags);
NTSTATUS dbwrap_trans_delete_bystring(struct db_context *db, const char *key);
NTSTATUS dbwrap_trans_do(struct db_context *db,
NTSTATUS (*action)(struct db_context *, void *),
void *private_data);
s3: add function dbwrap_trans_traverse
2011-03-16 11:13:40 +03:00
NTSTATUS dbwrap_trans_traverse(struct db_context *db,
int (*f)(struct db_record*, void*),
void *private_data);
s3: add function dbwrap_traverse
2011-03-18 16:39:15 +03:00
s3-build: use dbwrap.h only where needed. Guenther
2010-08-18 20:59:23 +04:00
NTSTATUS dbwrap_delete_bystring_upper(struct db_context *db, const char *key);
NTSTATUS dbwrap_store_bystring_upper(struct db_context *db, const char *key,
TDB_DATA data, int flags);
s3:dbwrap: convert dbwrap_fetch(), dbwrap_fetch_bystring() and dbwrap_fetch_bystring_upper() to NTSTATUS
2011-08-24 15:08:13 +04:00
NTSTATUS dbwrap_fetch_bystring_upper(struct db_context *db, TALLOC_CTX *mem_ctx,
const char *key, TDB_DATA *value);
s3-build: use dbwrap.h only where needed. Guenther
2010-08-18 20:59:23 +04:00
Cosmetic fix (This used to be commit 8d8cb8f9ccbc013b97c252d27c3af4e2eb10d56a)
2007-11-07 22:18:38 +03:00
#endif /* __DBWRAP_H__ */
Copy Permalink