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