ldb_tdb: add control points for the new GUID index mode
[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                 bool one_level_indexes;
22                 bool attribute_indexes;
23                 const char *GUID_index_attribute;
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         bool warn_reindex;
36
37         bool read_only;
38 };
39
40 struct ltdb_context {
41         struct ldb_module *module;
42         struct ldb_request *req;
43
44         bool request_terminated;
45         struct ltdb_req_spy *spy;
46
47         /* search stuff */
48         const struct ldb_parse_tree *tree;
49         struct ldb_dn *base;
50         enum ldb_scope scope;
51         const char * const *attrs;
52         struct tevent_timer *timeout_event;
53
54         /* error handling */
55         int error;
56 };
57
58 /* special record types */
59 #define LTDB_INDEX      "@INDEX"
60 #define LTDB_INDEXLIST  "@INDEXLIST"
61 #define LTDB_IDX        "@IDX"
62 #define LTDB_IDXVERSION "@IDXVERSION"
63 #define LTDB_IDXATTR    "@IDXATTR"
64 #define LTDB_IDXONE     "@IDXONE"
65 #define LTDB_IDXDN     "@IDXDN"
66 #define LTDB_IDXGUID    "@IDXGUID"
67 #define LTDB_IDX_DN_GUID "@IDX_DN_GUID"
68 #define LTDB_BASEINFO   "@BASEINFO"
69 #define LTDB_OPTIONS    "@OPTIONS"
70 #define LTDB_ATTRIBUTES "@ATTRIBUTES"
71
72 /* special attribute types */
73 #define LTDB_SEQUENCE_NUMBER "sequenceNumber"
74 #define LTDB_CHECK_BASE "checkBaseOnSearch"
75 #define LTDB_DISALLOW_DN_FILTER "disallowDNFilter"
76 #define LTDB_MOD_TIMESTAMP "whenChanged"
77 #define LTDB_OBJECTCLASS "objectClass"
78
79 /* DB keys */
80 #define LTDB_GUID_KEY_PREFIX "GUID="
81 #define LTDB_GUID_SIZE 16
82
83 /* The following definitions come from lib/ldb/ldb_tdb/ldb_cache.c  */
84
85 int ltdb_cache_reload(struct ldb_module *module);
86 int ltdb_cache_load(struct ldb_module *module);
87 int ltdb_increase_sequence_number(struct ldb_module *module);
88 int ltdb_check_at_attributes_values(const struct ldb_val *value);
89
90 /* The following definitions come from lib/ldb/ldb_tdb/ldb_index.c  */
91
92 struct ldb_parse_tree;
93
94 int ltdb_search_indexed(struct ltdb_context *ctx, uint32_t *);
95 int ltdb_index_add_new(struct ldb_module *module,
96                        struct ltdb_private *ltdb,
97                        const struct ldb_message *msg);
98 int ltdb_index_delete(struct ldb_module *module, const struct ldb_message *msg);
99 int ltdb_index_del_element(struct ldb_module *module,
100                            struct ltdb_private *ltdb,
101                            const struct ldb_message *msg,
102                            struct ldb_message_element *el);
103 int ltdb_index_add_element(struct ldb_module *module,
104                            struct ltdb_private *ltdb,
105                            const struct ldb_message *msg,
106                            struct ldb_message_element *el);
107 int ltdb_index_del_value(struct ldb_module *module,
108                          struct ltdb_private *ltdb,
109                          const struct ldb_message *msg,
110                          struct ldb_message_element *el, unsigned int v_idx);
111 int ltdb_reindex(struct ldb_module *module);
112 int ltdb_index_transaction_start(struct ldb_module *module);
113 int ltdb_index_transaction_commit(struct ldb_module *module);
114 int ltdb_index_transaction_cancel(struct ldb_module *module);
115
116 /* The following definitions come from lib/ldb/ldb_tdb/ldb_search.c  */
117
118 int ltdb_has_wildcard(struct ldb_module *module, const char *attr_name, 
119                       const struct ldb_val *val);
120 void ltdb_search_dn1_free(struct ldb_module *module, struct ldb_message *msg);
121 int ltdb_search_dn1(struct ldb_module *module, struct ldb_dn *dn, struct ldb_message *msg,
122                     unsigned int unpack_flags);
123 int ltdb_search_base(struct ldb_module *module, struct ldb_dn *dn);
124 int ltdb_search_key(struct ldb_module *module, struct ltdb_private *ltdb,
125                     struct TDB_DATA tdb_key,
126                     struct ldb_message *msg,
127                     unsigned int unpack_flags);
128 int ltdb_filter_attrs(TALLOC_CTX *mem_ctx,
129                       const struct ldb_message *msg, const char * const *attrs,
130                       struct ldb_message **filtered_msg);
131 int ltdb_search(struct ltdb_context *ctx);
132
133 /* The following definitions come from lib/ldb/ldb_tdb/ldb_tdb.c  */
134 int ltdb_lock_read(struct ldb_module *module);
135 int ltdb_unlock_read(struct ldb_module *module);
136 /* 
137  * Determine if this key could hold a record.  We allow the new GUID
138  * index, the old DN index and a possible future ID=
139  */
140 bool ltdb_key_is_record(TDB_DATA key);
141 TDB_DATA ltdb_key_dn(struct ldb_module *module, struct ldb_dn *dn);
142 TDB_DATA ltdb_key_msg(struct ldb_module *module, const struct ldb_message *msg);
143 int ltdb_store(struct ldb_module *module, const struct ldb_message *msg, int flgs);
144 int ltdb_modify_internal(struct ldb_module *module, const struct ldb_message *msg, struct ldb_request *req);
145 int ltdb_delete_noindex(struct ldb_module *module,
146                         const struct ldb_message *msg);
147 int ltdb_err_map(enum TDB_ERROR tdb_code);
148
149 struct tdb_context *ltdb_wrap_open(TALLOC_CTX *mem_ctx,
150                                    const char *path, int hash_size, int tdb_flags,
151                                    int open_flags, mode_t mode,
152                                    struct ldb_context *ldb);