r25084: Move samba-specific code out of lib/ldb directory.
[kai/samba.git] / source4 / lib / ldb / ldb_tdb / ldb_tdb.h
1 #if (_SAMBA_BUILD_ == 3)
2 #include "tdb/include/tdb.h"
3 #else
4 #include "tdb.h"
5 #endif
6
7 /* this private structure is used by the ltdb backend in the
8    ldb_context */
9 struct ltdb_private {
10         TDB_CONTEXT *tdb;
11         unsigned int connect_flags;
12         
13         /* a double is used for portability and ease of string
14            handling. It has plenty of digits of precision */
15         unsigned long long sequence_number;
16
17         /* the low level tdb seqnum - used to avoid loading BASEINFO when
18            possible */
19         int tdb_seqnum;
20
21         struct ltdb_cache {
22                 struct ldb_message *indexlist;
23                 struct ldb_message *attributes;
24                 struct ldb_message *subclasses;
25
26                 struct {
27                         char *name;
28                         int flags;
29                 } last_attribute;
30         } *cache;
31 };
32
33 /*
34   the async local context
35   holds also internal search state during a full db search
36 */
37 struct ltdb_context {
38         struct ldb_module *module;
39
40         /* search stuff */
41         const struct ldb_parse_tree *tree;
42         struct ldb_dn *base;
43         enum ldb_scope scope;
44         const char * const *attrs;
45
46         /* async stuff */
47         void *context;
48         int (*callback)(struct ldb_context *, void *, struct ldb_reply *);
49 };
50
51 /* special record types */
52 #define LTDB_INDEX      "@INDEX"
53 #define LTDB_INDEXLIST  "@INDEXLIST"
54 #define LTDB_IDX        "@IDX"
55 #define LTDB_IDXATTR    "@IDXATTR"
56 #define LTDB_IDXONE     "@IDXONE"
57 #define LTDB_BASEINFO   "@BASEINFO"
58 #define LTDB_ATTRIBUTES "@ATTRIBUTES"
59 #define LTDB_SUBCLASSES "@SUBCLASSES"
60
61 /* special attribute types */
62 #define LTDB_SEQUENCE_NUMBER "sequenceNumber"
63 #define LTDB_MOD_TIMESTAMP "whenChanged"
64 #define LTDB_OBJECTCLASS "objectClass"
65
66 /* The following definitions come from lib/ldb/ldb_tdb/ldb_cache.c  */
67
68 int ltdb_cache_reload(struct ldb_module *module);
69 int ltdb_cache_load(struct ldb_module *module);
70 int ltdb_increase_sequence_number(struct ldb_module *module);
71 int ltdb_check_at_attributes_values(const struct ldb_val *value);
72
73 /* The following definitions come from lib/ldb/ldb_tdb/ldb_index.c  */
74
75 struct ldb_parse_tree;
76
77 int ltdb_search_indexed(struct ldb_handle *handle);
78 int ltdb_index_add(struct ldb_module *module, const struct ldb_message *msg);
79 int ltdb_index_del(struct ldb_module *module, const struct ldb_message *msg);
80 int ltdb_index_one(struct ldb_module *module, const struct ldb_message *msg, int add);
81 int ltdb_reindex(struct ldb_module *module);
82
83 /* The following definitions come from lib/ldb/ldb_tdb/ldb_pack.c  */
84
85 int ltdb_pack_data(struct ldb_module *module,
86                    const struct ldb_message *message,
87                    struct TDB_DATA *data);
88 void ltdb_unpack_data_free(struct ldb_module *module,
89                            struct ldb_message *message);
90 int ltdb_unpack_data(struct ldb_module *module,
91                      const struct TDB_DATA *data,
92                      struct ldb_message *message);
93
94 /* The following definitions come from lib/ldb/ldb_tdb/ldb_search.c  */
95
96 int ltdb_has_wildcard(struct ldb_module *module, const char *attr_name, 
97                       const struct ldb_val *val);
98 void ltdb_search_dn1_free(struct ldb_module *module, struct ldb_message *msg);
99 int ltdb_search_dn1(struct ldb_module *module, struct ldb_dn *dn, struct ldb_message *msg);
100 int ltdb_add_attr_results(struct ldb_module *module,
101                           TALLOC_CTX *mem_ctx, 
102                           struct ldb_message *msg,
103                           const char * const attrs[], 
104                           unsigned int *count, 
105                           struct ldb_message ***res);
106 int ltdb_filter_attrs(struct ldb_message *msg, const char * const *attrs);
107 int ltdb_search(struct ldb_module *module, struct ldb_request *req);
108
109 /* The following definitions come from lib/ldb/ldb_tdb/ldb_tdb.c  */
110 struct ldb_handle *init_ltdb_handle(struct ltdb_private *ltdb, struct ldb_module *module,
111                                     struct ldb_request *req);
112 struct TDB_DATA ltdb_key(struct ldb_module *module, struct ldb_dn *dn);
113 int ltdb_store(struct ldb_module *module, const struct ldb_message *msg, int flgs);
114 int ltdb_delete_noindex(struct ldb_module *module, struct ldb_dn *dn);
115 int ltdb_modify_internal(struct ldb_module *module, const struct ldb_message *msg);
116
117 int ltdb_index_del_value(struct ldb_module *module, const char *dn, 
118                          struct ldb_message_element *el, int v_idx);
119
120 struct tdb_context *ltdb_wrap_open(TALLOC_CTX *mem_ctx,
121                                    const char *path, int hash_size, int tdb_flags,
122                                    int open_flags, mode_t mode,
123                                    struct ldb_context *ldb);
124