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