]> git.sur5r.net Git - openldap/blob - servers/slapd/proto-slap.h
Add macros to support testing of error categories to ldap.h
[openldap] / servers / slapd / proto-slap.h
1 #ifndef _PROTO_SLAP
2 #define _PROTO_SLAP
3
4 #include <ldap_cdefs.h>
5
6 LDAP_BEGIN_DECL
7
8 /*
9  * acl.c
10  */
11
12 int access_allowed LDAP_P(( Backend *be, Connection *conn,
13         Operation *op, Entry *e,
14         char *attr, struct berval *val, int access ));
15
16 struct acl * acl_get_applicable LDAP_P(( Backend *be,
17         Operation *op, Entry *e,
18         char *attr, int nmatches, regmatch_t *matches ));
19
20 int acl_access_allowed LDAP_P(( struct acl *a, Backend *be, Connection *conn, Entry *e,
21         struct berval *val, Operation *op, int  access, char *edn,
22         regmatch_t *matches ));
23
24 int acl_check_modlist LDAP_P(( Backend *be,
25         Connection *conn,
26         Operation *op,
27         Entry *e,
28         LDAPModList *ml ));
29
30 /*
31  * aclparse.c
32  */
33
34 void parse_acl LDAP_P(( Backend *be, char *fname, int lineno, int argc, char **argv ));
35 char * access2str LDAP_P(( int access ));
36 int str2access LDAP_P(( char *str ));
37
38 /*
39  * attr.c
40  */
41
42 void attr_free LDAP_P(( Attribute *a ));
43 char * attr_normalize LDAP_P(( char *s ));
44 int attr_merge_fast LDAP_P(( Entry *e, char *type, struct berval **vals, int  nvals,
45         int  naddvals, int  *maxvals, Attribute ***a ));
46 int attr_merge LDAP_P(( Entry *e, char *type, struct berval **vals ));
47 Attribute * attr_find LDAP_P(( Attribute *a, char *type ));
48 int attr_delete LDAP_P(( Attribute **attrs, char *type ));
49 int attr_syntax LDAP_P(( char *type ));
50 void attr_syntax_config LDAP_P(( char *fname, int lineno, int argc, char **argv ));
51 AttributeType * at_find LDAP_P(( const char *name ));
52 int at_find_in_list LDAP_P(( AttributeType *sat, AttributeType **list ));
53 int at_append_to_list LDAP_P(( AttributeType *sat, AttributeType ***listp ));
54 int at_delete_from_list LDAP_P(( int pos, AttributeType ***listp ));
55 int at_fake_if_needed LDAP_P(( char *name ));
56 int at_schema_info LDAP_P(( Entry *e ));
57 int at_add LDAP_P(( LDAP_ATTRIBUTE_TYPE *at, const char **err ));
58 char * at_canonical_name LDAP_P(( char * a_type ));
59
60 /*
61  * ava.c
62  */
63
64 int get_ava LDAP_P(( BerElement *ber, Ava *ava ));
65 void ava_free LDAP_P(( Ava *ava, int freeit ));
66
67 /*
68  * backend.c
69  */
70
71 int backend_init LDAP_P((void));
72 int backend_add LDAP_P((BackendInfo *aBackendInfo));
73 int backend_startup LDAP_P((int dbnum));
74 int backend_shutdown LDAP_P((int dbnum));
75 int backend_destroy LDAP_P((void));
76
77 BackendInfo * backend_info LDAP_P(( char *type ));
78 BackendDB * backend_db_init LDAP_P(( char *type ));
79
80 BackendDB * select_backend LDAP_P(( char * dn ));
81
82 int be_issuffix LDAP_P(( Backend *be, char *suffix ));
83 int be_isroot LDAP_P(( Backend *be, char *ndn ));
84 int be_isroot_pw LDAP_P(( Backend *be, char *ndn, struct berval *cred ));
85 char* be_root_dn LDAP_P(( Backend *be ));
86 int be_entry_release_rw LDAP_P(( Backend *be, Entry *e, int rw ));
87 #define be_entry_release_r( be, e ) be_entry_release_rw( be, e, 0 )
88 #define be_entry_release_w( be, e ) be_entry_release_rw( be, e, 1 )
89
90
91 extern int      backend_unbind LDAP_P((Connection *conn, Operation *op));
92
93 extern int      backend_connection_init LDAP_P((Connection *conn));
94 extern int      backend_connection_destroy LDAP_P((Connection *conn));
95
96 extern int      backend_group LDAP_P((Backend *be,
97         Entry *target,
98         char *gr_ndn, char *op_ndn,
99         char *objectclassValue, char *groupattrName));
100
101 /*
102  * ch_malloc.c
103  */
104
105 void * ch_malloc LDAP_P(( ber_len_t size ));
106 void * ch_realloc LDAP_P(( void *block, ber_len_t size ));
107 void * ch_calloc LDAP_P(( ber_len_t nelem, ber_len_t size ));
108 char * ch_strdup LDAP_P(( const char *string ));
109 void   ch_free LDAP_P(( void * ));
110 #define free ch_free
111
112 /*
113  * charray.c
114  */
115
116 void charray_add LDAP_P(( char ***a, char *s ));
117 void charray_merge LDAP_P(( char ***a, char **s ));
118 void charray_free LDAP_P(( char **array ));
119 int charray_inlist LDAP_P(( char **a, char *s ));
120 char ** charray_dup LDAP_P(( char **a ));
121 char ** str2charray LDAP_P(( char *str, char *brkstr ));
122
123 /*
124  * controls.c
125  */
126 int get_ctrls LDAP_P((
127         Connection *co,
128         Operation *op,
129         int senderrors ));
130
131 /*
132  * config.c
133  */
134
135 int read_config LDAP_P(( char *fname ));
136
137 /*
138  * connection.c
139  */
140 int connections_init LDAP_P((void));
141 int connections_shutdown LDAP_P((void));
142 int connections_destroy LDAP_P((void));
143 int connections_timeout_idle LDAP_P((time_t));
144
145 long connection_init LDAP_P((
146         ber_socket_t s,
147         const char* name, const char* addr));
148
149 void connection_closing LDAP_P(( Connection *c ));
150 int connection_state_closing LDAP_P(( Connection *c ));
151
152 int connection_write LDAP_P((ber_socket_t s));
153 int connection_read LDAP_P((ber_socket_t s));
154
155 unsigned long connections_nextid(void);
156
157 Connection* connection_first LDAP_P((ber_socket_t *));
158 Connection* connection_next LDAP_P((Connection *, ber_socket_t *));
159 void connection_done LDAP_P((Connection *));
160
161 /*
162  * dn.c
163  */
164
165 char * dn_normalize LDAP_P(( char *dn ));
166 char * dn_normalize_case LDAP_P(( char *dn ));
167 char * dn_parent LDAP_P(( Backend *be, char *dn ));
168 char * dn_rdn LDAP_P(( Backend *be, char *dn ));
169 int dn_issuffix LDAP_P(( char *dn, char *suffix ));
170 int dn_type LDAP_P(( char *dn ));
171 char * dn_upcase LDAP_P(( char *dn ));
172 char * rdn_attr_value LDAP_P(( char * rdn ));
173 char * rdn_attr_type LDAP_P(( char * rdn ));
174 void build_new_dn LDAP_P(( char ** new_dn, char *e_dn, char * p_dn,
175                            char * newrdn ));
176 /*
177  * entry.c
178  */
179
180 Entry * str2entry LDAP_P(( char *s ));
181 char * entry2str LDAP_P(( Entry *e, int *len, int printid ));
182 void entry_free LDAP_P(( Entry *e ));
183
184 int entry_cmp LDAP_P(( Entry *a, Entry *b ));
185 int entry_dn_cmp LDAP_P(( Entry *a, Entry *b ));
186 int entry_id_cmp LDAP_P(( Entry *a, Entry *b ));
187
188 /*
189  * filter.c
190  */
191
192 int get_filter LDAP_P(( Connection *conn, BerElement *ber, Filter **filt, char **fstr ));
193 void filter_free LDAP_P(( Filter *f ));
194 void filter_print LDAP_P(( Filter *f ));
195
196 /*
197  * filterentry.c
198  */
199
200 int test_filter LDAP_P(( Backend *be, Connection *conn, Operation *op, Entry *e,
201         Filter  *f ));
202
203 /*
204  * lock.c
205  */
206
207 FILE * lock_fopen LDAP_P(( char *fname, char *type, FILE **lfp ));
208 int lock_fclose LDAP_P(( FILE *fp, FILE *lfp ));
209
210 /*
211  * module.c
212  */
213
214 #ifdef SLAPD_MODULES
215 int load_module LDAP_P(( const char* file_name, int argc, char *argv[] ));
216 #endif /* SLAPD_MODULES */
217
218 /*
219  * monitor.c
220  */
221 extern char *supportedExtensions[];
222 extern char *supportedControls[];
223 extern char *supportedSASLMechanisms[];
224
225 void monitor_info LDAP_P(( Connection *conn, Operation *op ));
226
227 /*
228  * operation.c
229  */
230
231 void slap_op_free LDAP_P(( Operation *op ));
232 Operation * slap_op_alloc LDAP_P((
233         BerElement *ber, ber_int_t msgid,
234         ber_tag_t tag, ber_int_t id ));
235
236 int slap_op_add LDAP_P(( Operation **olist, Operation *op ));
237 int slap_op_remove LDAP_P(( Operation **olist, Operation *op ));
238 Operation * slap_op_pop LDAP_P(( Operation **olist ));
239
240 /*
241  * phonetic.c
242  */
243
244 char * first_word LDAP_P(( char *s ));
245 char * next_word LDAP_P(( char *s ));
246 char * word_dup LDAP_P(( char *w ));
247 char * phonetic LDAP_P(( char *s ));
248
249 /*
250  * repl.c
251  */
252
253 void replog LDAP_P(( Backend *be, int optype, char *dn, void *change, int flag ));
254
255 /*
256  * result.c
257  */
258
259 void send_ldap_result LDAP_P(( Connection *conn, Operation *op, int err, char *matched,
260         char *text ));
261 void send_ldap_search_result LDAP_P(( Connection *conn, Operation *op, int err,
262         char *matched, char *text, int nentries ));
263
264 /*
265  * schema.c
266  */
267
268 int oc_schema_check LDAP_P(( Entry *e ));
269 int oc_check_operational LDAP_P(( char *type ));
270 ObjectClass *oc_find LDAP_P((const char *ocname));
271 int oc_add LDAP_P((LDAP_OBJECT_CLASS *oc, const char **err));
272 Syntax *syn_find LDAP_P((const char *synname));
273 int syn_add LDAP_P((LDAP_SYNTAX *syn, slap_syntax_check_func *check, const char **err));
274 MatchingRule *mr_find LDAP_P((const char *mrname));
275 int mr_add LDAP_P((LDAP_MATCHING_RULE *mr, slap_mr_normalize_func *normalize, slap_mr_compare_func *compare, const char **err));
276 void schema_info LDAP_P((Connection *conn, Operation *op, char **attrs, int attrsonly));
277 int schema_init LDAP_P((void));
278
279
280 /*
281  * schemaparse.c
282  */
283
284 void parse_oc_old LDAP_P(( Backend *be, char *fname, int lineno, int argc, char **argv ));
285 void parse_oc LDAP_P(( char *fname, int lineno, char *line ));
286 void parse_at LDAP_P(( char *fname, int lineno, char *line ));
287 char *scherr2str LDAP_P((int code));
288 /*
289  * str2filter.c
290  */
291
292 Filter * str2filter LDAP_P(( char *str ));
293
294 /*
295  * value.c
296  */
297
298 int value_add_fast LDAP_P(( struct berval ***vals, struct berval **addvals, int nvals,
299         int naddvals, int *maxvals ));
300 int value_add LDAP_P(( struct berval ***vals, struct berval **addvals ));
301 void value_normalize LDAP_P(( char *s, int syntax ));
302 int value_cmp LDAP_P(( struct berval *v1, struct berval *v2, int syntax,
303         int normalize ));
304 int value_find LDAP_P(( struct berval **vals, struct berval *v, int syntax,
305         int normalize ));
306
307 /*
308  * suffixAlias.c
309  */
310 char *suffixAlias LDAP_P(( char *dn, Operation *op, Backend *be ));
311
312 /*
313  * user.c
314  */
315 #if defined(HAVE_PWD_H) && defined(HAVE_GRP_H)
316 void slap_init_user LDAP_P(( char *username, char *groupname ));
317 #endif
318
319 /*
320  * Other...
321  */
322
323 extern char             *default_referral;
324 extern char             *replogfile;
325 extern const char Versionstr[];
326 extern int              active_threads;
327 extern int              defsize;
328 extern int              deftime;
329 extern int              g_argc;
330 extern int              global_default_access;
331 extern int              global_lastmod;
332 extern int              global_idletimeout;
333 extern int              global_schemacheck;
334 extern int              lber_debug;
335 extern int              ldap_syslog;
336
337 extern ldap_pvt_thread_mutex_t  num_sent_mutex;
338 extern long             num_bytes_sent;
339 extern long             num_entries_sent;
340
341 extern ldap_pvt_thread_mutex_t  num_ops_mutex;
342 extern long             num_ops_completed;
343 extern long             num_ops_initiated;
344
345 extern char   *slapd_pid_file;
346 extern char   *slapd_args_file;
347 extern char             **g_argv;
348 extern time_t   starttime;
349
350 time_t slap_get_time LDAP_P((void));
351
352 extern ldap_pvt_thread_mutex_t  active_threads_mutex;
353 extern ldap_pvt_thread_cond_t   active_threads_cond;
354
355 extern ldap_pvt_thread_mutex_t  entry2str_mutex;
356 extern ldap_pvt_thread_mutex_t  replog_mutex;
357
358 #ifdef SLAPD_CRYPT
359 extern ldap_pvt_thread_mutex_t  crypt_mutex;
360 #endif
361 extern ldap_pvt_thread_mutex_t  gmtime_mutex;
362
363 extern struct acl               *global_acl;
364
365 extern int      slap_init LDAP_P((int mode, char* name));
366 extern int      slap_startup LDAP_P((int dbnum));
367 extern int      slap_shutdown LDAP_P((int dbnum));
368 extern int      slap_destroy LDAP_P((void));
369
370 struct sockaddr_in;
371
372 struct slapd_args {
373         struct sockaddr_in *addr;
374         int tcps;
375 };
376
377 extern int      slapd_daemon LDAP_P((struct slapd_args *args));
378 extern int      set_socket LDAP_P((struct sockaddr_in *addr));
379
380 extern void slapd_set_write LDAP_P((ber_socket_t s, int wake));
381 extern void slapd_clr_write LDAP_P((ber_socket_t s, int wake));
382 extern void slapd_set_read LDAP_P((ber_socket_t s, int wake));
383 extern void slapd_clr_read LDAP_P((ber_socket_t s, int wake));
384
385 extern void slapd_remove LDAP_P((ber_socket_t s, int wake));
386
387 extern void     slap_set_shutdown LDAP_P((int sig));
388 extern void     slap_do_nothing   LDAP_P((int sig));
389
390 extern void     config_info LDAP_P((Connection *conn, Operation *op));
391 extern void     root_dse_info LDAP_P((Connection *conn, Operation *op, char **attrs, int attrsonly));
392
393 extern int      do_abandon LDAP_P((Connection *conn, Operation *op));
394 extern int      do_add LDAP_P((Connection *conn, Operation *op));
395 extern int      do_bind LDAP_P((Connection *conn, Operation *op));
396 extern int      do_compare LDAP_P((Connection *conn, Operation *op));
397 extern int      do_delete LDAP_P((Connection *conn, Operation *op));
398 extern int      do_modify LDAP_P((Connection *conn, Operation *op));
399 extern int      do_modrdn LDAP_P((Connection *conn, Operation *op));
400 extern int      do_search LDAP_P((Connection *conn, Operation *op));
401 extern int      do_unbind LDAP_P((Connection *conn, Operation *op));
402 extern int      do_exop LDAP_P((Connection *conn, Operation *op));
403
404 extern int send_search_entry LDAP_P((Backend *be, Connection *conn, Operation *op, Entry *e, char **attrs, int attrsonly));
405 extern int str2result LDAP_P(( char *s, int *code, char **matched, char **info ));
406
407 extern ber_socket_t dtblsize;
408
409 LDAP_END_DECL
410
411 #endif /* _proto_slap */
412