2011-06-10 16:59:58 +04:00
/*
Unix SMB / CIFS implementation .
tdb utility functions
Copyright ( C ) Andrew Tridgell 1992 - 2006
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
the Free Software Foundation ; either version 3 of the License , or
( at your option ) any later version .
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 .
You should have received a copy of the GNU General Public License
along with this program . If not , see < http : //www.gnu.org/licenses/>.
*/
2008-10-12 19:50:41 +04:00
# ifndef _____LIB_UTIL_UTIL_TDB_H__
# define _____LIB_UTIL_UTIL_TDB_H__
/***************************************************************
Make a TDB_DATA and keep the const warning in one place
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
TDB_DATA make_tdb_data ( const uint8_t * dptr , size_t dsize ) ;
2009-12-03 20:43:49 +03:00
bool tdb_data_equal ( TDB_DATA t1 , TDB_DATA t2 ) ;
2011-11-07 12:59:37 +04:00
bool tdb_data_is_empty ( TDB_DATA d ) ;
2008-10-12 19:50:41 +04:00
TDB_DATA string_tdb_data ( const char * string ) ;
TDB_DATA string_term_tdb_data ( const char * string ) ;
/****************************************************************************
2011-06-20 13:10:33 +04:00
Lock a chain by string . Return non - zero if lock failed .
2008-10-12 19:50:41 +04:00
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
int tdb_lock_bystring ( struct tdb_context * tdb , const char * keyval ) ;
/****************************************************************************
Unlock a chain by string .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
void tdb_unlock_bystring ( struct tdb_context * tdb , const char * keyval ) ;
/****************************************************************************
2011-06-20 13:10:33 +04:00
Read lock a chain by string . Return non - zero if lock failed .
2008-10-12 19:50:41 +04:00
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
int tdb_read_lock_bystring ( struct tdb_context * tdb , const char * keyval ) ;
/****************************************************************************
Read unlock a chain by string .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
void tdb_read_unlock_bystring ( struct tdb_context * tdb , const char * keyval ) ;
/****************************************************************************
Fetch a int32_t value by a arbitrary blob key , return - 1 if not found .
Output is int32_t in native byte order .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
int32_t tdb_fetch_int32_byblob ( struct tdb_context * tdb , TDB_DATA key ) ;
/****************************************************************************
Fetch a int32_t value by string key , return - 1 if not found .
Output is int32_t in native byte order .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
int32_t tdb_fetch_int32 ( struct tdb_context * tdb , const char * keystr ) ;
/****************************************************************************
2011-06-20 13:10:31 +04:00
Store a int32_t value by an arbitrary blob key , return 0 on success , - ve on failure .
2008-10-12 19:50:41 +04:00
Input is int32_t in native byte order . Output in tdb is in little - endian .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
int tdb_store_int32_byblob ( struct tdb_context * tdb , TDB_DATA key , int32_t v ) ;
/****************************************************************************
2011-06-20 13:10:31 +04:00
Store a int32_t value by string key , return 0 on success , - ve on failure .
2008-10-12 19:50:41 +04:00
Input is int32_t in native byte order . Output in tdb is in little - endian .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
int tdb_store_int32 ( struct tdb_context * tdb , const char * keystr , int32_t v ) ;
/****************************************************************************
Fetch a uint32_t value by a arbitrary blob key , return - 1 if not found .
Output is uint32_t in native byte order .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
bool tdb_fetch_uint32_byblob ( struct tdb_context * tdb , TDB_DATA key , uint32_t * value ) ;
/****************************************************************************
Fetch a uint32_t value by string key , return - 1 if not found .
Output is uint32_t in native byte order .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
bool tdb_fetch_uint32 ( struct tdb_context * tdb , const char * keystr , uint32_t * value ) ;
/****************************************************************************
2011-06-20 13:10:31 +04:00
Store a uint32_t value by an arbitrary blob key , return true on success , false on failure .
2008-10-12 19:50:41 +04:00
Input is uint32_t in native byte order . Output in tdb is in little - endian .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
bool tdb_store_uint32_byblob ( struct tdb_context * tdb , TDB_DATA key , uint32_t value ) ;
/****************************************************************************
2011-06-20 13:10:31 +04:00
Store a uint32_t value by string key , return true on success , false on failure .
2008-10-12 19:50:41 +04:00
Input is uint32_t in native byte order . Output in tdb is in little - endian .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
bool tdb_store_uint32 ( struct tdb_context * tdb , const char * keystr , uint32_t value ) ;
/****************************************************************************
2011-06-20 13:10:31 +04:00
Store a buffer by a null terminated string key . Return 0 on success , - ve
2008-10-12 19:50:41 +04:00
on failure .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
int tdb_store_bystring ( struct tdb_context * tdb , const char * keystr , TDB_DATA data , int flags ) ;
/****************************************************************************
Fetch a buffer using a null terminated string key . Don ' t forget to call
free ( ) on the result dptr .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
TDB_DATA tdb_fetch_bystring ( struct tdb_context * tdb , const char * keystr ) ;
/****************************************************************************
2011-06-20 13:10:31 +04:00
Delete an entry using a null terminated string key . 0 on success , - ve on err .
2008-10-12 19:50:41 +04:00
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
int tdb_delete_bystring ( struct tdb_context * tdb , const char * keystr ) ;
/****************************************************************************
Atomic integer change . Returns old value . To create , set initial value in * oldval .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
int32_t tdb_change_int32_atomic ( struct tdb_context * tdb , const char * keystr , int32_t * oldval , int32_t change_val ) ;
/****************************************************************************
Atomic unsigned integer change . Returns old value . To create , set initial value in * oldval .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
bool tdb_change_uint32_atomic ( struct tdb_context * tdb , const char * keystr , uint32_t * oldval , uint32_t change_val ) ;
/****************************************************************************
Allow tdb_delete to be used as a tdb_traversal_fn .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
int tdb_traverse_delete_fn ( struct tdb_context * the_tdb , TDB_DATA key , TDB_DATA dbuf ,
void * state ) ;
2012-04-16 08:18:49 +04:00
/****************************************************************************
Return an NTSTATUS from a TDB_ERROR
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
NTSTATUS map_nt_error_from_tdb ( enum TDB_ERROR err ) ;
2008-10-12 19:50:41 +04:00
# endif /* _____LIB_UTIL_UTIL_TDB_H__ */
