]> git.sur5r.net Git - openldap/blob - include/lber.h
a runqueue for periodic thread execution (for syncrepl)
[openldap] / include / lber.h
1 /* $OpenLDAP$ */
2 /*
3  * Copyright 1998-2003 The OpenLDAP Foundation, Redwood City, California, USA
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted only as authorized by the OpenLDAP
8  * Public License.  A copy of this license is available at
9  * http://www.OpenLDAP.org/license.html or in file LICENSE in the
10  * top-level directory of the distribution.
11  */
12 /* Portions
13  * Copyright (c) 1990 Regents of the University of Michigan.
14  * All rights reserved.
15  *
16  * Redistribution and use in source and binary forms are permitted
17  * provided that this notice is preserved and that due credit is given
18  * to the University of Michigan at Ann Arbor. The name of the University
19  * may not be used to endorse or promote products derived from this
20  * software without specific prior written permission. This software
21  * is provided ``as is'' without express or implied warranty.
22  */
23
24 #ifndef _LBER_H
25 #define _LBER_H
26
27 #include <lber_types.h>
28
29 LDAP_BEGIN_DECL
30
31 /* Overview of LBER tag construction
32  *
33  *      Bits
34  *      ______
35  *      8 7 | CLASS
36  *      0 0 = UNIVERSAL
37  *      0 1 = APPLICATION
38  *      1 0 = CONTEXT-SPECIFIC
39  *      1 1 = PRIVATE
40  *              _____
41  *              | 6 | DATA-TYPE
42  *                0 = PRIMITIVE
43  *                1 = CONSTRUCTED
44  *                      ___________
45  *                      | 5 ... 1 | TAG-NUMBER
46  */
47
48 /* BER classes and mask */
49 #define LBER_CLASS_UNIVERSAL    ((ber_tag_t) 0x00U)
50 #define LBER_CLASS_APPLICATION  ((ber_tag_t) 0x40U)
51 #define LBER_CLASS_CONTEXT              ((ber_tag_t) 0x80U)
52 #define LBER_CLASS_PRIVATE              ((ber_tag_t) 0xc0U)
53 #define LBER_CLASS_MASK                 ((ber_tag_t) 0xc0U)
54
55 /* BER encoding type and mask */
56 #define LBER_PRIMITIVE                  ((ber_tag_t) 0x00U)
57 #define LBER_CONSTRUCTED                ((ber_tag_t) 0x20U)
58 #define LBER_ENCODING_MASK              ((ber_tag_t) 0x20U)
59
60 #define LBER_BIG_TAG_MASK               ((ber_tag_t) 0x1fU)
61 #define LBER_MORE_TAG_MASK              ((ber_tag_t) 0x80U)
62
63 /*
64  * Note that LBER_ERROR and LBER_DEFAULT are values that can never appear
65  * as valid BER tags, and so it is safe to use them to report errors.  In
66  * fact, any tag for which the following is true is invalid:
67  */
68 #define LBER_INVALID(t)     (((t) & (ber_tag_t) 0x080UL) \
69         && (((t) & (ber_tag_t) ~ 0x0FF))
70
71 #define LBER_ERROR                      ((ber_tag_t) -1)
72 #define LBER_DEFAULT            ((ber_tag_t) -1)
73
74 /* general BER types we know about */
75 #define LBER_BOOLEAN            ((ber_tag_t) 0x01UL)
76 #define LBER_INTEGER            ((ber_tag_t) 0x02UL)
77 #define LBER_BITSTRING          ((ber_tag_t) 0x03UL)
78 #define LBER_OCTETSTRING        ((ber_tag_t) 0x04UL)
79 #define LBER_NULL                       ((ber_tag_t) 0x05UL)
80 #define LBER_ENUMERATED         ((ber_tag_t) 0x0aUL)
81 #define LBER_SEQUENCE           ((ber_tag_t) 0x30UL)    /* constructed */
82 #define LBER_SET                        ((ber_tag_t) 0x31UL)    /* constructed */
83
84 /* LBER BerElement options */
85 #define LBER_USE_DER            0x01
86
87 /* get/set options for BerElement */
88 #define LBER_OPT_BER_OPTIONS                    0x01
89 #define LBER_OPT_BER_DEBUG                              0x02
90 #define LBER_OPT_BER_REMAINING_BYTES    0x03
91 #define LBER_OPT_BER_TOTAL_BYTES                0x04
92 #define LBER_OPT_BER_BYTES_TO_WRITE             0x05
93 #define LBER_OPT_BER_MEMCTX                             0x06
94
95 #define LBER_OPT_DEBUG_LEVEL    LBER_OPT_BER_DEBUG
96 #define LBER_OPT_REMAINING_BYTES        LBER_OPT_BER_REMAINING_BYTES
97 #define LBER_OPT_TOTAL_BYTES            LBER_OPT_BER_TOTAL_BYTES
98 #define LBER_OPT_BYTES_TO_WRITE         LBER_OPT_BER_BYTES_TO_WRITE
99
100 #define LBER_OPT_LOG_PRINT_FN   0x8001
101 #define LBER_OPT_MEMORY_FNS             0x8002
102 #define LBER_OPT_ERROR_FN               0x8003
103 #define LBER_OPT_LOG_PRINT_FILE         0x8004
104
105 /* get/set Memory Debug options */
106 #define LBER_OPT_MEMORY_INUSE           0x8005  /* for memory debugging */
107 #define LBER_OPT_LOG_PROC           0x8006  /* for external logging function */
108
109 typedef int* (*BER_ERRNO_FN) LDAP_P(( void ));
110
111 typedef void (*BER_LOG_PRINT_FN) LDAP_P(( LDAP_CONST char *buf ));
112
113 typedef void* (BER_MEMALLOC_FN) LDAP_P(( ber_len_t size, void *ctx ));
114 typedef void* (BER_MEMCALLOC_FN)        LDAP_P(( ber_len_t n, ber_len_t size, void *ctx ));
115 typedef void* (BER_MEMREALLOC_FN)       LDAP_P(( void *p, ber_len_t size, void *ctx ));
116 typedef void  (BER_MEMFREE_FN)          LDAP_P(( void *p, void *ctx ));
117
118 typedef struct lber_memory_fns {
119         BER_MEMALLOC_FN *bmf_malloc;
120         BER_MEMCALLOC_FN *bmf_calloc;
121         BER_MEMREALLOC_FN *bmf_realloc;
122         BER_MEMFREE_FN *bmf_free;
123 } BerMemoryFunctions;
124
125 /* LBER Sockbuf_IO options */
126 #define LBER_SB_OPT_GET_FD              1
127 #define LBER_SB_OPT_SET_FD              2
128 #define LBER_SB_OPT_HAS_IO              3
129 #define LBER_SB_OPT_SET_NONBLOCK        4
130 #define LBER_SB_OPT_GET_SSL             7
131 #define LBER_SB_OPT_DATA_READY          8
132 #define LBER_SB_OPT_SET_READAHEAD       9
133 #define LBER_SB_OPT_DRAIN               10
134 #define LBER_SB_OPT_NEEDS_READ          11
135 #define LBER_SB_OPT_NEEDS_WRITE         12
136 #define LBER_SB_OPT_GET_MAX_INCOMING    13
137 #define LBER_SB_OPT_SET_MAX_INCOMING    14
138 /* Largest option used by the library */
139 #define LBER_SB_OPT_OPT_MAX             14
140
141 /* LBER IO operations stacking levels */
142 #define LBER_SBIOD_LEVEL_PROVIDER       10
143 #define LBER_SBIOD_LEVEL_TRANSPORT      20
144 #define LBER_SBIOD_LEVEL_APPLICATION    30
145
146 /* get/set options for Sockbuf */
147 #define LBER_OPT_SOCKBUF_DESC           0x1000
148 #define LBER_OPT_SOCKBUF_OPTIONS        0x1001
149 #define LBER_OPT_SOCKBUF_DEBUG          0x1002
150
151 /* on/off values */
152 #define LBER_OPT_ON             ((void *) 1)
153 #define LBER_OPT_OFF    ((void *) 0)
154
155 #define LBER_OPT_SUCCESS        (0)
156 #define LBER_OPT_ERROR          (-1)
157
158 #define LBER_ELEMENT_SIZEOF (256) /* must be >= sizeof(BerElement) */
159 typedef struct berelement BerElement;
160 typedef struct sockbuf Sockbuf;
161 typedef struct seqorset Seqorset;
162
163 typedef struct sockbuf_io Sockbuf_IO;
164
165 /* Structure for LBER IO operarion descriptor */
166 typedef struct sockbuf_io_desc {
167         int                     sbiod_level;
168         Sockbuf                 *sbiod_sb;
169         Sockbuf_IO              *sbiod_io;
170         void                    *sbiod_pvt;
171         struct sockbuf_io_desc  *sbiod_next;
172 } Sockbuf_IO_Desc;
173
174 /* Structure for LBER IO operation functions */
175 struct sockbuf_io {
176         int (*sbi_setup)( Sockbuf_IO_Desc *sbiod, void *arg );
177         int (*sbi_remove)( Sockbuf_IO_Desc *sbiod );
178         int (*sbi_ctrl)( Sockbuf_IO_Desc *sbiod, int opt, void *arg);
179
180         ber_slen_t (*sbi_read)( Sockbuf_IO_Desc *sbiod, void *buf,
181                 ber_len_t len );
182         ber_slen_t (*sbi_write)( Sockbuf_IO_Desc *sbiod, void *buf,
183                 ber_len_t len );
184
185         int (*sbi_close)( Sockbuf_IO_Desc *sbiod );
186 };
187
188 /* Helper macros for LBER IO functions */
189 #define LBER_SBIOD_READ_NEXT( sbiod, buf, len ) \
190         ( (sbiod)->sbiod_next->sbiod_io->sbi_read( (sbiod)->sbiod_next, \
191                 buf, len ) )
192 #define LBER_SBIOD_WRITE_NEXT( sbiod, buf, len ) \
193         ( (sbiod)->sbiod_next->sbiod_io->sbi_write( (sbiod)->sbiod_next, \
194                 buf, len ) )
195 #define LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg ) \
196         ( (sbiod)->sbiod_next ? \
197                 ( (sbiod)->sbiod_next->sbiod_io->sbi_ctrl( \
198                 (sbiod)->sbiod_next, opt, arg ) ) : 0 )
199
200 /* structure for returning a sequence of octet strings + length */
201 typedef struct berval {
202         ber_len_t       bv_len;
203         char            *bv_val;
204 } BerValue;
205
206 typedef BerValue *BerVarray;    /* To distinguish from a single bv */
207
208 /* this should be moved to lber-int.h */
209
210 /*
211  * in bprint.c:
212  */
213 LBER_F( void )
214 ber_error_print LDAP_P((
215         LDAP_CONST char *data ));
216
217 LBER_F( void )
218 ber_bprint LDAP_P((
219         LDAP_CONST char *data, ber_len_t len ));
220
221 LBER_F( void )
222 ber_dump LDAP_P((
223         BerElement *ber, int inout ));
224
225 LBER_F( void )
226 ber_sos_dump LDAP_P((
227         Seqorset *sos ));
228
229 /*
230  * in decode.c:
231  */
232 typedef int (*BERDecodeCallback) LDAP_P((
233         BerElement *ber,
234         void *data,
235         int mode ));
236
237 LBER_F( ber_tag_t )
238 ber_get_tag LDAP_P((
239         BerElement *ber ));
240
241 LBER_F( ber_tag_t )
242 ber_skip_tag LDAP_P((
243         BerElement *ber,
244         ber_len_t *len ));
245
246 LBER_F( ber_tag_t )
247 ber_peek_tag LDAP_P((
248         BerElement *ber,
249         ber_len_t *len ));
250
251 LBER_F( ber_tag_t )
252 ber_get_int LDAP_P((
253         BerElement *ber,
254         ber_int_t *num ));
255
256 LBER_F( ber_tag_t )
257 ber_get_enum LDAP_P((
258         BerElement *ber,
259         ber_int_t *num ));
260
261 LBER_F( ber_tag_t )
262 ber_get_stringb LDAP_P((
263         BerElement *ber,
264         char *buf,
265         ber_len_t *len ));
266
267 LBER_F( ber_tag_t )
268 ber_get_stringbv LDAP_P((
269         BerElement *ber,
270         struct berval *bv,
271         int alloc ));
272
273 LBER_F( ber_tag_t )
274 ber_get_stringa LDAP_P((
275         BerElement *ber,
276         char **buf ));
277
278 LBER_F( ber_tag_t )
279 ber_get_stringal LDAP_P((
280         BerElement *ber,
281         struct berval **bv ));
282
283 LBER_F( ber_tag_t )
284 ber_get_bitstringa LDAP_P((
285         BerElement *ber,
286         char **buf,
287         ber_len_t *len ));
288
289 LBER_F( ber_tag_t )
290 ber_get_null LDAP_P((
291         BerElement *ber ));
292
293 LBER_F( ber_tag_t )
294 ber_get_boolean LDAP_P((
295         BerElement *ber,
296         ber_int_t *boolval ));
297
298 LBER_F( ber_tag_t )
299 ber_first_element LDAP_P((
300         BerElement *ber,
301         ber_len_t *len,
302         char **last ));
303
304 LBER_F( ber_tag_t )
305 ber_next_element LDAP_P((
306         BerElement *ber,
307         ber_len_t *len,
308         LDAP_CONST char *last ));
309
310 LBER_F( ber_tag_t )
311 ber_scanf LDAP_P((
312         BerElement *ber,
313         LDAP_CONST char *fmt,
314         ... ));
315
316 /*
317  * in encode.c
318  */
319 typedef int (*BEREncodeCallback) LDAP_P((
320         BerElement *ber,
321         void *data ));
322
323 LBER_F( int )
324 ber_put_enum LDAP_P((
325         BerElement *ber,
326         ber_int_t num,
327         ber_tag_t tag ));
328
329 LBER_F( int )
330 ber_put_int LDAP_P((
331         BerElement *ber,
332         ber_int_t num,
333         ber_tag_t tag ));
334
335 LBER_F( int )
336 ber_put_ostring LDAP_P((
337         BerElement *ber,
338         LDAP_CONST char *str,
339         ber_len_t len,
340         ber_tag_t tag ));
341
342 LBER_F( int )
343 ber_put_berval LDAP_P((
344         BerElement *ber,
345         struct berval *bv,
346         ber_tag_t tag ));
347
348 LBER_F( int )
349 ber_put_string LDAP_P((
350         BerElement *ber,
351         LDAP_CONST char *str,
352         ber_tag_t tag ));
353
354 LBER_F( int )
355 ber_put_bitstring LDAP_P((
356         BerElement *ber,
357         LDAP_CONST char *str,
358         ber_len_t bitlen,
359         ber_tag_t tag ));
360
361 LBER_F( int )
362 ber_put_null LDAP_P((
363         BerElement *ber,
364         ber_tag_t tag ));
365
366 LBER_F( int )
367 ber_put_boolean LDAP_P((
368         BerElement *ber,
369         ber_int_t boolval,
370         ber_tag_t tag ));
371
372 LBER_F( int )
373 ber_start_seq LDAP_P((
374         BerElement *ber,
375         ber_tag_t tag ));
376
377 LBER_F( int )
378 ber_start_set LDAP_P((
379         BerElement *ber,
380         ber_tag_t tag ));
381
382 LBER_F( int )
383 ber_put_seq LDAP_P((
384         BerElement *ber ));
385
386 LBER_F( int )
387 ber_put_set LDAP_P((
388         BerElement *ber ));
389
390 LBER_F( int )
391 ber_printf LDAP_P((
392         BerElement *ber,
393         LDAP_CONST char *fmt,
394         ... ));
395
396
397 /*
398  * in io.c:
399  */
400
401 LBER_F( ber_slen_t )
402 ber_read LDAP_P((
403         BerElement *ber,
404         char *buf,
405         ber_len_t len ));
406
407 LBER_F( ber_slen_t )
408 ber_write LDAP_P((
409         BerElement *ber,
410         LDAP_CONST char *buf,
411         ber_len_t len,
412         int nosos ));
413
414 LBER_F( void )
415 ber_free LDAP_P((
416         BerElement *ber,
417         int freebuf ));
418
419 LBER_F( void )
420 ber_free_buf LDAP_P(( BerElement *ber ));
421
422 LBER_F( int )
423 ber_flush LDAP_P((
424         Sockbuf *sb,
425         BerElement *ber,
426         int freeit ));
427
428 LBER_F( BerElement * )
429 ber_alloc LDAP_P(( void )); /* DEPRECATED */
430
431 LBER_F( BerElement * )
432 der_alloc LDAP_P(( void )); /* DEPRECATED */
433
434 LBER_F( BerElement * )
435 ber_alloc_t LDAP_P((
436         int beroptions ));
437
438 LBER_F( BerElement * )
439 ber_dup LDAP_P((
440         BerElement *ber ));
441
442 LBER_F( ber_tag_t )
443 ber_get_next LDAP_P((
444         Sockbuf *sb,
445         ber_len_t *len,
446         BerElement *ber ));
447
448 LBER_F( void )
449 ber_init2 LDAP_P((
450         BerElement *ber,
451         struct berval *bv,
452         int options ));
453
454 LBER_F( void )
455 ber_init_w_nullc LDAP_P((       /* DEPRECATED */
456         BerElement *ber,
457         int options ));
458
459 LBER_F( void )
460 ber_reset LDAP_P((
461         BerElement *ber,
462         int was_writing ));
463
464 LBER_F( BerElement * )
465 ber_init LDAP_P((
466         struct berval *bv ));
467
468 LBER_F( int )
469 ber_flatten LDAP_P((
470         BerElement *ber,
471         struct berval **bvPtr ));
472
473 LBER_F( int )
474 ber_flatten2 LDAP_P((
475         BerElement *ber,
476         struct berval *bv,
477         int alloc ));
478
479 /*
480  * LBER ber accessor functions
481  */
482
483 LBER_F( int )
484 ber_get_option LDAP_P((
485         void *item,
486         int option,
487         void *outvalue));
488
489 LBER_F( int )
490 ber_set_option LDAP_P((
491         void *item,
492         int option,
493         LDAP_CONST void *invalue));
494
495 /*
496  * LBER sockbuf.c
497  */
498
499 LBER_F( Sockbuf *  )
500 ber_sockbuf_alloc LDAP_P((
501         void ));
502
503 LBER_F( void )
504 ber_sockbuf_free LDAP_P((
505         Sockbuf *sb ));
506
507 LBER_F( int )
508 ber_sockbuf_add_io LDAP_P((
509         Sockbuf *sb,
510         Sockbuf_IO *sbio,
511         int layer,
512         void *arg ));
513
514 LBER_F( int )
515 ber_sockbuf_remove_io LDAP_P((
516         Sockbuf *sb,
517         Sockbuf_IO *sbio,
518         int layer ));
519
520 LBER_F( int )
521 ber_sockbuf_ctrl LDAP_P((
522         Sockbuf *sb,
523         int opt,
524         void *arg ));
525
526 LBER_V( Sockbuf_IO ) ber_sockbuf_io_tcp;
527 LBER_V( Sockbuf_IO ) ber_sockbuf_io_readahead;
528 LBER_V( Sockbuf_IO ) ber_sockbuf_io_fd;
529 LBER_V( Sockbuf_IO ) ber_sockbuf_io_debug;
530 #ifdef LDAP_CONNECTIONLESS
531 LBER_V( Sockbuf_IO ) ber_sockbuf_io_udp;
532 #endif
533
534 /*
535  * LBER memory.c
536  */
537 LBER_F( void * )
538 ber_memalloc LDAP_P((
539         ber_len_t s ));
540
541 LBER_F( void * )
542 ber_memrealloc LDAP_P((
543         void* p,
544         ber_len_t s ));
545
546 LBER_F( void * )
547 ber_memcalloc LDAP_P((
548         ber_len_t n,
549         ber_len_t s ));
550
551 LBER_F( void )
552 ber_memfree LDAP_P((
553         void* p ));
554
555 LBER_F( void )
556 ber_memvfree LDAP_P((
557         void** vector ));
558
559 LBER_F( void )
560 ber_bvfree LDAP_P((
561         struct berval *bv ));
562
563 LBER_F( void )
564 ber_bvecfree LDAP_P((
565         struct berval **bv ));
566
567 LBER_F( int )
568 ber_bvecadd LDAP_P((
569         struct berval ***bvec,
570         struct berval *bv ));
571
572 LBER_F( struct berval * )
573 ber_dupbv LDAP_P((
574         struct berval *dst, struct berval *src ));
575
576 LBER_F( struct berval * )
577 ber_bvdup LDAP_P((
578         struct berval *src ));
579
580 LBER_F( struct berval * )
581 ber_str2bv LDAP_P((
582         LDAP_CONST char *, ber_len_t len, int dup, struct berval *bv));
583
584 LBER_F( struct berval * )
585 ber_mem2bv LDAP_P((
586         LDAP_CONST char *, ber_len_t len, int dup, struct berval *bv));
587
588 #define ber_bvstr(a)    ber_str2bv(a, 0, 0, NULL)
589 #define ber_bvstrdup(a) ber_str2bv(a, 0, 1, NULL)
590
591 LBER_F( char * )
592 ber_strdup LDAP_P((
593         LDAP_CONST char * ));
594
595 LBER_F( void )
596 ber_bvarray_free LDAP_P(( BerVarray p ));
597
598 LBER_F( int )
599 ber_bvarray_add LDAP_P(( BerVarray *p, BerValue *bv ));
600
601 LBER_F( void * )
602 ber_memalloc_x LDAP_P((
603         ber_len_t s, void *ctx));
604
605 LBER_F( void * )
606 ber_memrealloc_x LDAP_P((
607         void* p,
608         ber_len_t s, void *ctx ));
609
610 LBER_F( void * )
611 ber_memcalloc_x LDAP_P((
612         ber_len_t n,
613         ber_len_t s, void *ctx ));
614
615 LBER_F( void )
616 ber_memfree_x LDAP_P((
617         void* p, void *ctx ));
618
619 LBER_F( void )
620 ber_memvfree_x LDAP_P((
621         void** vector, void *ctx ));
622
623 LBER_F( void )
624 ber_bvfree_x LDAP_P((
625         struct berval *bv, void *ctx ));
626
627 LBER_F( void )
628 ber_bvecfree_x LDAP_P((
629         struct berval **bv, void *ctx ));
630
631 LBER_F( int )
632 ber_bvecadd_x LDAP_P((
633         struct berval ***bvec,
634         struct berval *bv, void *ctx ));
635
636 LBER_F( struct berval * )
637 ber_dupbv_x LDAP_P((
638         struct berval *dst, struct berval *src, void *ctx ));
639
640 LBER_F( struct berval * )
641 ber_str2bv_x LDAP_P((
642         LDAP_CONST char *, ber_len_t len, int dup, struct berval *bv, void *ctx));
643
644 LBER_F( struct berval * )
645 ber_mem2bv_x LDAP_P((
646         LDAP_CONST char *, ber_len_t len, int dup, struct berval *bv, void *ctx));
647
648 LBER_F( char * )
649 ber_strdup_x LDAP_P((
650         LDAP_CONST char *, void *ctx ));
651
652 LBER_F( void )
653 ber_bvarray_free_x LDAP_P(( BerVarray p, void *ctx ));
654
655 LBER_F( int )
656 ber_bvarray_add_x LDAP_P(( BerVarray *p, BerValue *bv, void *ctx ));
657
658 #define ber_bvcmp(v1,v2) \
659         ((v1)->bv_len < (v2)->bv_len \
660                 ? -1 : ((v1)->bv_len > (v2)->bv_len \
661                         ? 1 : memcmp((v1)->bv_val, (v2)->bv_val, (v1)->bv_len) ))
662
663 /*
664  * error.c
665  */
666 LBER_F( int * ) ber_errno_addr LDAP_P((void));
667 #define ber_errno (*(ber_errno_addr)())
668
669 #define LBER_ERROR_NONE         0
670 #define LBER_ERROR_PARAM        0x1
671 #define LBER_ERROR_MEMORY       0x2
672
673 LDAP_END_DECL
674
675 #endif /* _LBER_H */