X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=include%2Flber.h;h=522ff4c88703763b638fcdb83dd5e5eb3181d75b;hb=b0b4cc35deaa2779cdc4bf3c9b63841b2fdd1b92;hp=fb49db32b2b0af90c83b97a26f441bb9ab8253e0;hpb=2e0912622bca412c0a1b1a3fdba30f65bf222ade;p=openldap diff --git a/include/lber.h b/include/lber.h index fb49db32b2..522ff4c887 100644 --- a/include/lber.h +++ b/include/lber.h @@ -1,15 +1,18 @@ /* $OpenLDAP$ */ -/* - * Copyright 1998-2000 The OpenLDAP Foundation, Redwood City, California, USA +/* This work is part of OpenLDAP Software . + * + * Copyright 1998-2006 The OpenLDAP Foundation. * All rights reserved. * - * Redistribution and use in source and binary forms are permitted only - * as authorized by the OpenLDAP Public License. A copy of this - * license is available at http://www.OpenLDAP.org/license.html or - * in file LICENSE in the top-level directory of the distribution. + * Redistribution and use in source and binary forms, with or without + * modification, are permitted only as authorized by the OpenLDAP + * Public License. + * + * A copy of this license is available in file LICENSE in the + * top-level directory of the distribution or, alternatively, at + * . */ -/* Portions - * Copyright (c) 1990 Regents of the University of Michigan. +/* Portions Copyright (c) 1990 Regents of the University of Michigan. * All rights reserved. * * Redistribution and use in source and binary forms are permitted @@ -24,6 +27,7 @@ #define _LBER_H #include +#include LDAP_BEGIN_DECL @@ -80,15 +84,8 @@ LDAP_BEGIN_DECL #define LBER_SEQUENCE ((ber_tag_t) 0x30UL) /* constructed */ #define LBER_SET ((ber_tag_t) 0x31UL) /* constructed */ -typedef int (*BERTranslateProc) LDAP_P(( - char **bufp, - ber_len_t *buflenp, - int free_input )); - /* LBER BerElement options */ #define LBER_USE_DER 0x01 -#define LBER_USE_INDEFINITE_LEN 0x02 -#define LBER_TRANSLATE_STRINGS 0x04 /* deprecated */ /* get/set options for BerElement */ #define LBER_OPT_BER_OPTIONS 0x01 @@ -96,6 +93,7 @@ typedef int (*BERTranslateProc) LDAP_P(( #define LBER_OPT_BER_REMAINING_BYTES 0x03 #define LBER_OPT_BER_TOTAL_BYTES 0x04 #define LBER_OPT_BER_BYTES_TO_WRITE 0x05 +#define LBER_OPT_BER_MEMCTX 0x06 #define LBER_OPT_DEBUG_LEVEL LBER_OPT_BER_DEBUG #define LBER_OPT_REMAINING_BYTES LBER_OPT_BER_REMAINING_BYTES @@ -107,37 +105,41 @@ typedef int (*BERTranslateProc) LDAP_P(( #define LBER_OPT_ERROR_FN 0x8003 #define LBER_OPT_LOG_PRINT_FILE 0x8004 +/* get/set Memory Debug options */ +#define LBER_OPT_MEMORY_INUSE 0x8005 /* for memory debugging */ +#define LBER_OPT_LOG_PROC 0x8006 /* for external logging function */ + typedef int* (*BER_ERRNO_FN) LDAP_P(( void )); -typedef void (*BER_LOG_PRINT_FN) LDAP_P(( char *buf )); +typedef void (*BER_LOG_PRINT_FN) LDAP_P(( LDAP_CONST char *buf )); -typedef void* (*BER_MEMALLOC_FN) LDAP_P(( ber_len_t size )); -typedef void* (*BER_MEMCALLOC_FN) LDAP_P(( ber_len_t n, ber_len_t size )); -typedef void* (*BER_MEMREALLOC_FN) LDAP_P(( void *p, ber_len_t size )); -typedef void (*BER_MEMFREE_FN) LDAP_P(( void *p )); +typedef void* (BER_MEMALLOC_FN) LDAP_P(( ber_len_t size, void *ctx )); +typedef void* (BER_MEMCALLOC_FN) LDAP_P(( ber_len_t n, ber_len_t size, void *ctx )); +typedef void* (BER_MEMREALLOC_FN) LDAP_P(( void *p, ber_len_t size, void *ctx )); +typedef void (BER_MEMFREE_FN) LDAP_P(( void *p, void *ctx )); typedef struct lber_memory_fns { - BER_MEMALLOC_FN bmf_malloc; - BER_MEMCALLOC_FN bmf_calloc; - BER_MEMREALLOC_FN bmf_realloc; - BER_MEMFREE_FN bmf_free; + BER_MEMALLOC_FN *bmf_malloc; + BER_MEMCALLOC_FN *bmf_calloc; + BER_MEMREALLOC_FN *bmf_realloc; + BER_MEMFREE_FN *bmf_free; } BerMemoryFunctions; -/* LBER Sockbuf_IO options */ +/* LBER Sockbuf_IO options */ #define LBER_SB_OPT_GET_FD 1 #define LBER_SB_OPT_SET_FD 2 #define LBER_SB_OPT_HAS_IO 3 #define LBER_SB_OPT_SET_NONBLOCK 4 -#define LBER_SB_OPT_UDP_GET_SRC 5 -#define LBER_SB_OPT_UDP_SET_DST 6 #define LBER_SB_OPT_GET_SSL 7 #define LBER_SB_OPT_DATA_READY 8 #define LBER_SB_OPT_SET_READAHEAD 9 #define LBER_SB_OPT_DRAIN 10 #define LBER_SB_OPT_NEEDS_READ 11 #define LBER_SB_OPT_NEEDS_WRITE 12 +#define LBER_SB_OPT_GET_MAX_INCOMING 13 +#define LBER_SB_OPT_SET_MAX_INCOMING 14 /* Largest option used by the library */ -#define LBER_SB_OPT_OPT_MAX 12 +#define LBER_SB_OPT_OPT_MAX 14 /* LBER IO operations stacking levels */ #define LBER_SBIOD_LEVEL_PROVIDER 10 @@ -150,7 +152,8 @@ typedef struct lber_memory_fns { #define LBER_OPT_SOCKBUF_DEBUG 0x1002 /* on/off values */ -#define LBER_OPT_ON ((void *) 1) +LBER_V( char ) ber_pvt_opt_on; +#define LBER_OPT_ON ((void *) &ber_pvt_opt_on) #define LBER_OPT_OFF ((void *) 0) #define LBER_OPT_SUCCESS (0) @@ -176,12 +179,12 @@ struct sockbuf_io { int (*sbi_setup)( Sockbuf_IO_Desc *sbiod, void *arg ); int (*sbi_remove)( Sockbuf_IO_Desc *sbiod ); int (*sbi_ctrl)( Sockbuf_IO_Desc *sbiod, int opt, void *arg); - + ber_slen_t (*sbi_read)( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len ); ber_slen_t (*sbi_write)( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len ); - + int (*sbi_close)( Sockbuf_IO_Desc *sbiod ); }; @@ -203,28 +206,29 @@ typedef struct berval { char *bv_val; } BerValue; +typedef BerValue *BerVarray; /* To distinguish from a single bv */ + /* this should be moved to lber-int.h */ /* * in bprint.c: */ -LIBLBER_F( void ) -ber_print_error LDAP_P(( +LBER_F( void ) +ber_error_print LDAP_P(( LDAP_CONST char *data )); -LIBLBER_F( void ) +LBER_F( void ) ber_bprint LDAP_P(( LDAP_CONST char *data, ber_len_t len )); -LIBLBER_F( void ) +LBER_F( void ) ber_dump LDAP_P(( BerElement *ber, int inout )); -LIBLBER_F( void ) +LBER_F( void ) ber_sos_dump LDAP_P(( Seqorset *sos )); - /* * in decode.c: */ @@ -233,85 +237,85 @@ typedef int (*BERDecodeCallback) LDAP_P(( void *data, int mode )); -LIBLBER_F( ber_tag_t ) +LBER_F( ber_tag_t ) ber_get_tag LDAP_P(( BerElement *ber )); -LIBLBER_F( ber_tag_t ) +LBER_F( ber_tag_t ) ber_skip_tag LDAP_P(( BerElement *ber, ber_len_t *len )); -LIBLBER_F( ber_tag_t ) +LBER_F( ber_tag_t ) ber_peek_tag LDAP_P(( BerElement *ber, ber_len_t *len )); -LIBLBER_F( ber_tag_t ) +LBER_F( ber_tag_t ) ber_get_int LDAP_P(( BerElement *ber, ber_int_t *num )); -LIBLBER_F( ber_tag_t ) +LBER_F( ber_tag_t ) ber_get_enum LDAP_P(( BerElement *ber, ber_int_t *num )); -LIBLBER_F( ber_tag_t ) +LBER_F( ber_tag_t ) ber_get_stringb LDAP_P(( BerElement *ber, char *buf, ber_len_t *len )); -LIBLBER_F( ber_tag_t ) +LBER_F( ber_tag_t ) +ber_get_stringbv LDAP_P(( + BerElement *ber, + struct berval *bv, + int alloc )); + +LBER_F( ber_tag_t ) ber_get_stringa LDAP_P(( BerElement *ber, char **buf )); -LIBLBER_F( ber_tag_t ) +LBER_F( ber_tag_t ) ber_get_stringal LDAP_P(( BerElement *ber, struct berval **bv )); -LIBLBER_F( ber_tag_t ) +LBER_F( ber_tag_t ) ber_get_bitstringa LDAP_P(( BerElement *ber, char **buf, ber_len_t *len )); -LIBLBER_F( ber_tag_t ) +LBER_F( ber_tag_t ) ber_get_null LDAP_P(( BerElement *ber )); -LIBLBER_F( ber_tag_t ) +LBER_F( ber_tag_t ) ber_get_boolean LDAP_P(( BerElement *ber, ber_int_t *boolval )); -LIBLBER_F( ber_tag_t ) +LBER_F( ber_tag_t ) ber_first_element LDAP_P(( BerElement *ber, ber_len_t *len, char **last )); -LIBLBER_F( ber_tag_t ) +LBER_F( ber_tag_t ) ber_next_element LDAP_P(( BerElement *ber, ber_len_t *len, LDAP_CONST char *last )); -LIBLBER_F( ber_tag_t ) -ber_scanf LDAP_P(( +LBER_F( ber_tag_t ) +ber_scanf LDAP_P(( BerElement *ber, LDAP_CONST char *fmt, ... )); -LIBLBER_F( void ) -ber_set_string_translators LDAP_P(( - BerElement *ber, - BERTranslateProc encode_proc, - BERTranslateProc decode_proc )); - /* * in encode.c */ @@ -319,74 +323,74 @@ typedef int (*BEREncodeCallback) LDAP_P(( BerElement *ber, void *data )); -LIBLBER_F( int ) +LBER_F( int ) ber_put_enum LDAP_P(( BerElement *ber, ber_int_t num, ber_tag_t tag )); -LIBLBER_F( int ) +LBER_F( int ) ber_put_int LDAP_P(( BerElement *ber, ber_int_t num, ber_tag_t tag )); -LIBLBER_F( int ) +LBER_F( int ) ber_put_ostring LDAP_P(( BerElement *ber, LDAP_CONST char *str, ber_len_t len, ber_tag_t tag )); -LIBLBER_F( int ) +LBER_F( int ) ber_put_berval LDAP_P(( BerElement *ber, - LDAP_CONST struct berval *bv, + struct berval *bv, ber_tag_t tag )); -LIBLBER_F( int ) +LBER_F( int ) ber_put_string LDAP_P(( BerElement *ber, LDAP_CONST char *str, ber_tag_t tag )); -LIBLBER_F( int ) +LBER_F( int ) ber_put_bitstring LDAP_P(( BerElement *ber, LDAP_CONST char *str, ber_len_t bitlen, ber_tag_t tag )); -LIBLBER_F( int ) +LBER_F( int ) ber_put_null LDAP_P(( BerElement *ber, ber_tag_t tag )); -LIBLBER_F( int ) +LBER_F( int ) ber_put_boolean LDAP_P(( BerElement *ber, ber_int_t boolval, ber_tag_t tag )); -LIBLBER_F( int ) +LBER_F( int ) ber_start_seq LDAP_P(( BerElement *ber, ber_tag_t tag )); -LIBLBER_F( int ) +LBER_F( int ) ber_start_set LDAP_P(( BerElement *ber, ber_tag_t tag )); -LIBLBER_F( int ) +LBER_F( int ) ber_put_seq LDAP_P(( BerElement *ber )); -LIBLBER_F( int ) +LBER_F( int ) ber_put_set LDAP_P(( BerElement *ber )); -LIBLBER_F( int ) +LBER_F( int ) ber_printf LDAP_P(( BerElement *ber, LDAP_CONST char *fmt, @@ -397,80 +401,109 @@ ber_printf LDAP_P(( * in io.c: */ -LIBLBER_F( ber_slen_t ) +LBER_F( ber_slen_t ) ber_read LDAP_P(( BerElement *ber, char *buf, ber_len_t len )); -LIBLBER_F( ber_slen_t ) +LBER_F( ber_slen_t ) ber_write LDAP_P(( BerElement *ber, LDAP_CONST char *buf, ber_len_t len, int nosos )); -LIBLBER_F( void ) +LBER_F( void ) ber_free LDAP_P(( BerElement *ber, int freebuf )); -LIBLBER_F( int ) -ber_flush LDAP_P(( +LBER_F( void ) +ber_free_buf LDAP_P(( BerElement *ber )); + +LBER_F( int ) +ber_flush2 LDAP_P(( Sockbuf *sb, BerElement *ber, int freeit )); +#define LBER_FLUSH_FREE_NEVER (0x0) /* traditional behavior */ +#define LBER_FLUSH_FREE_ON_SUCCESS (0x1) /* traditional behavior */ +#define LBER_FLUSH_FREE_ON_ERROR (0x2) +#define LBER_FLUSH_FREE_ALWAYS (LBER_FLUSH_FREE_ON_SUCCESS|LBER_FLUSH_FREE_ON_ERROR) + +LBER_F( int ) +ber_flush LDAP_P(( + Sockbuf *sb, + BerElement *ber, + int freeit )); /* DEPRECATED */ -LIBLBER_F( BerElement * ) +LBER_F( BerElement * ) ber_alloc LDAP_P(( void )); /* DEPRECATED */ -LIBLBER_F( BerElement * ) +LBER_F( BerElement * ) der_alloc LDAP_P(( void )); /* DEPRECATED */ -LIBLBER_F( BerElement * ) +LBER_F( BerElement * ) ber_alloc_t LDAP_P(( int beroptions )); -LIBLBER_F( BerElement * ) +LBER_F( BerElement * ) ber_dup LDAP_P(( BerElement *ber )); -LIBLBER_F( ber_tag_t ) +LBER_F( ber_tag_t ) ber_get_next LDAP_P(( Sockbuf *sb, ber_len_t *len, BerElement *ber )); -LIBLBER_F( void ) -ber_init_w_nullc LDAP_P(( +LBER_F( void ) +ber_init2 LDAP_P(( + BerElement *ber, + struct berval *bv, + int options )); + +LBER_F( void ) +ber_init_w_nullc LDAP_P(( /* DEPRECATED */ BerElement *ber, int options )); -LIBLBER_F( void ) +LBER_F( void ) ber_reset LDAP_P(( BerElement *ber, int was_writing )); -LIBLBER_F( BerElement * ) +LBER_F( BerElement * ) ber_init LDAP_P(( struct berval *bv )); -LIBLBER_F( int ) +LBER_F( int ) ber_flatten LDAP_P(( BerElement *ber, struct berval **bvPtr )); +LBER_F( int ) +ber_flatten2 LDAP_P(( + BerElement *ber, + struct berval *bv, + int alloc )); + +LBER_F( int ) +ber_remaining LDAP_P(( + BerElement *ber )); + /* * LBER ber accessor functions */ -LIBLBER_F( int ) +LBER_F( int ) ber_get_option LDAP_P(( void *item, int option, void *outvalue)); -LIBLBER_F( int ) +LBER_F( int ) ber_set_option LDAP_P(( void *item, int option, @@ -480,97 +513,119 @@ ber_set_option LDAP_P(( * LBER sockbuf.c */ -LIBLBER_F( Sockbuf * ) +LBER_F( Sockbuf * ) ber_sockbuf_alloc LDAP_P(( void )); -LIBLBER_F( void ) +LBER_F( void ) ber_sockbuf_free LDAP_P(( Sockbuf *sb )); -LIBLBER_F( int ) +LBER_F( int ) ber_sockbuf_add_io LDAP_P(( Sockbuf *sb, Sockbuf_IO *sbio, int layer, void *arg )); -LIBLBER_F( int ) +LBER_F( int ) ber_sockbuf_remove_io LDAP_P(( Sockbuf *sb, Sockbuf_IO *sbio, int layer )); -LIBLBER_F( int ) +LBER_F( int ) ber_sockbuf_ctrl LDAP_P(( Sockbuf *sb, int opt, void *arg )); -LIBLBER_F( Sockbuf_IO ) ber_sockbuf_io_tcp; -LIBLBER_F( Sockbuf_IO ) ber_sockbuf_io_udp; -LIBLBER_F( Sockbuf_IO ) ber_sockbuf_io_readahead; -LIBLBER_F( Sockbuf_IO ) ber_sockbuf_io_fd; -LIBLBER_F( Sockbuf_IO ) ber_sockbuf_io_debug; +LBER_V( Sockbuf_IO ) ber_sockbuf_io_tcp; +LBER_V( Sockbuf_IO ) ber_sockbuf_io_readahead; +LBER_V( Sockbuf_IO ) ber_sockbuf_io_fd; +LBER_V( Sockbuf_IO ) ber_sockbuf_io_debug; +LBER_V( Sockbuf_IO ) ber_sockbuf_io_udp; /* * LBER memory.c */ -LIBLBER_F( void * ) +LBER_F( void * ) ber_memalloc LDAP_P(( ber_len_t s )); -LIBLBER_F( void * ) +LBER_F( void * ) ber_memrealloc LDAP_P(( void* p, ber_len_t s )); -LIBLBER_F( void * ) +LBER_F( void * ) ber_memcalloc LDAP_P(( ber_len_t n, ber_len_t s )); -LIBLBER_F( void ) +LBER_F( void ) ber_memfree LDAP_P(( void* p )); -LIBLBER_F( void ) +LBER_F( void ) ber_memvfree LDAP_P(( void** vector )); -LIBLBER_F( void ) +LBER_F( void ) ber_bvfree LDAP_P(( struct berval *bv )); -LIBLBER_F( void ) +LBER_F( void ) ber_bvecfree LDAP_P(( struct berval **bv )); -LIBLBER_F( int ) +LBER_F( int ) ber_bvecadd LDAP_P(( struct berval ***bvec, struct berval *bv )); -LIBLBER_F( struct berval * ) +LBER_F( struct berval * ) +ber_dupbv LDAP_P(( + struct berval *dst, struct berval *src )); + +LBER_F( struct berval * ) ber_bvdup LDAP_P(( - LDAP_CONST struct berval *bv )); + struct berval *src )); -LIBLBER_F( struct berval * ) -ber_bvstr LDAP_P(( - LDAP_CONST char * )); +LBER_F( struct berval * ) +ber_mem2bv LDAP_P(( + LDAP_CONST char *, ber_len_t len, int duplicate, struct berval *bv)); -LIBLBER_F( struct berval * ) -ber_bvstrdup LDAP_P(( - LDAP_CONST char * )); +LBER_F( struct berval * ) +ber_str2bv LDAP_P(( + LDAP_CONST char *, ber_len_t len, int duplicate, struct berval *bv)); + +#define ber_bvstr(a) ((ber_str2bv)((a), 0, 0, NULL)) +#define ber_bvstrdup(a) ((ber_str2bv)((a), 0, 1, NULL)) -LIBLBER_F( char * ) +LBER_F( char * ) ber_strdup LDAP_P(( LDAP_CONST char * )); +LBER_F( struct berval * ) +ber_bvreplace LDAP_P(( + struct berval *dst, LDAP_CONST struct berval *src )); + +LBER_F( void ) +ber_bvarray_free LDAP_P(( BerVarray p )); + +LBER_F( int ) +ber_bvarray_add LDAP_P(( BerVarray *p, BerValue *bv )); + +#define ber_bvcmp(v1,v2) \ + ((v1)->bv_len < (v2)->bv_len \ + ? -1 : ((v1)->bv_len > (v2)->bv_len \ + ? 1 : memcmp((v1)->bv_val, (v2)->bv_val, (v1)->bv_len) )) + /* * error.c */ -LIBLBER_F( int * ) ber_errno_addr LDAP_P((void)); +LBER_F( int * ) ber_errno_addr LDAP_P((void)); #define ber_errno (*(ber_errno_addr)()) #define LBER_ERROR_NONE 0