ldb: replace 'struct TDB_DATA' with 'TDB_DATA'
[nivanova/samba-autobuild/.git] / source4 / lib / ldb / ldb_tdb / ldb_tdb.h
1 #include "replace.h"
2 #include "system/filesys.h"
3 #include "system/time.h"
4 #include "tdb_compat.h"
5 #include "ldb_module.h"
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         unsigned long long sequence_number;
14
15         /* the low level tdb seqnum - used to avoid loading BASEINFO when
16            possible */
17         int tdb_seqnum;
18
19         struct ltdb_cache {
20                 struct ldb_message *indexlist;
21                 struct ldb_message *attributes;
22                 bool one_level_indexes;
23                 bool attribute_indexes;
24         } *cache;
25
26         int in_transaction;
27
28         bool check_base;
29         struct ltdb_idxptr *idxptr;
30         bool prepared_commit;
31         int read_lock_count;
32
33         bool warn_unindexed;
34 };
35
36 /*
37   the async local context
38   holds also internal search state during a full db search
39 */
40 struct ltdb_req_spy {
41         struct ltdb_context *ctx;
42 };
43
44 struct ltdb_context {
45         struct ldb_module *module;
46         struct ldb_request *req;
47
48         bool request_terminated;
49         struct ltdb_req_spy *spy;
50
51         /* search stuff */
52         const struct ldb_parse_tree *tree;
53         struct ldb_dn *base;
54         enum ldb_scope scope;
55         const char * const *attrs;
56         struct tevent_timer *timeout_event;
57 };
58
59 /* special record types */
60 #define LTDB_INDEX      "@INDEX"
61 #define LTDB_INDEXLIST  "@INDEXLIST"
62 #define LTDB_IDX        "@IDX"
63 #define LTDB_IDXVERSION "@IDXVERSION"
64 #define LTDB_IDXATTR    "@IDXATTR"
65 #define LTDB_IDXONE     "@IDXONE"
66 #define LTDB_BASEINFO   "@BASEINFO"
67 #define LTDB_OPTIONS    "@OPTIONS"
68 #define LTDB_ATTRIBUTES "@ATTRIBUTES"
69
70 /* special attribute types */
71 #define LTDB_SEQUENCE_NUMBER "sequenceNumber"
72 #define LTDB_CHECK_BASE "checkBaseOnSearch"
73 #define LTDB_MOD_TIMESTAMP "whenChanged"
74 #define LTDB_OBJECTCLASS "objectClass"
75
76 /* The following definitions come from lib/ldb/ldb_tdb/ldb_cache.c  */
77
78 int ltdb_cache_reload(struct ldb_module *module);
79 int ltdb_cache_load(struct ldb_module *module);
80 int ltdb_increase_sequence_number(struct ldb_module *module);
81 int ltdb_check_at_attributes_values(const struct ldb_val *value);
82
83 /* The following definitions come from lib/ldb/ldb_tdb/ldb_index.c  */
84
85 struct ldb_parse_tree;
86
87 int ltdb_search_indexed(struct ltdb_context *ctx, uint32_t *);
88 int ltdb_index_add_new(struct ldb_module *module, const struct ldb_message *msg);
89 int ltdb_index_delete(struct ldb_module *module, const struct ldb_message *msg);
90 int ltdb_index_del_element(struct ldb_module *module, struct ldb_dn *dn,
91                            struct ldb_message_element *el);
92 int ltdb_index_add_element(struct ldb_module *module, struct ldb_dn *dn, 
93                            struct ldb_message_element *el);
94 int ltdb_index_del_value(struct ldb_module *module, struct ldb_dn *dn,
95                          struct ldb_message_element *el, unsigned int v_idx);
96 int ltdb_reindex(struct ldb_module *module);
97 int ltdb_index_transaction_start(struct ldb_module *module);
98 int ltdb_index_transaction_commit(struct ldb_module *module);
99 int ltdb_index_transaction_cancel(struct ldb_module *module);
100
101 /* The following definitions come from lib/ldb/ldb_tdb/ldb_pack.c  */
102
103 int ltdb_pack_data(struct ldb_module *module,
104                    const struct ldb_message *message,
105                    TDB_DATA *data);
106 void ltdb_unpack_data_free(struct ldb_module *module,
107                            struct ldb_message *message);
108 int ltdb_unpack_data(struct ldb_module *module,
109                      const TDB_DATA *data,
110                      struct ldb_message *message);
111
112 /* The following definitions come from lib/ldb/ldb_tdb/ldb_search.c  */
113
114 int ltdb_has_wildcard(struct ldb_module *module, const char *attr_name, 
115                       const struct ldb_val *val);
116 void ltdb_search_dn1_free(struct ldb_module *module, struct ldb_message *msg);
117 int ltdb_search_dn1(struct ldb_module *module, struct ldb_dn *dn, struct ldb_message *msg);
118 int ltdb_add_attr_results(struct ldb_module *module,
119                           TALLOC_CTX *mem_ctx, 
120                           struct ldb_message *msg,
121                           const char * const attrs[], 
122                           unsigned int *count, 
123                           struct ldb_message ***res);
124 int ltdb_filter_attrs(struct ldb_message *msg, const char * const *attrs);
125 int ltdb_search(struct ltdb_context *ctx);
126
127 /* The following definitions come from lib/ldb/ldb_tdb/ldb_tdb.c  */
128 int ltdb_lock_read(struct ldb_module *module);
129 int ltdb_unlock_read(struct ldb_module *module);
130 TDB_DATA ltdb_key(struct ldb_module *module, struct ldb_dn *dn);
131 int ltdb_store(struct ldb_module *module, const struct ldb_message *msg, int flgs);
132 int ltdb_modify_internal(struct ldb_module *module, const struct ldb_message *msg, struct ldb_request *req);
133 int ltdb_delete_noindex(struct ldb_module *module, struct ldb_dn *dn);
134 int ltdb_err_map(enum TDB_ERROR tdb_code);
135
136 struct tdb_context *ltdb_wrap_open(TALLOC_CTX *mem_ctx,
137                                    const char *path, int hash_size, int tdb_flags,
138                                    int open_flags, mode_t mode,
139                                    struct ldb_context *ldb);