+/* $OpenLDAP$ */
/*
- * Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA
+ * Copyright 1998-2001 The OpenLDAP Foundation, Redwood City, California, USA
* 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 at
+ * http://www.OpenLDAP.org/license.html or in file LICENSE in the
+ * top-level directory of the distribution.
*/
/* Portions
* Copyright (c) 1990 Regents of the University of Michigan.
#ifndef _LBER_H
#define _LBER_H
-#include <ldap_cdefs.h>
+#include <lber_types.h>
LDAP_BEGIN_DECL
*/
/* BER classes and mask */
-#define LBER_CLASS_UNIVERSAL 0x00UL
-#define LBER_CLASS_APPLICATION 0x40UL
-#define LBER_CLASS_CONTEXT 0x80UL
-#define LBER_CLASS_PRIVATE 0xc0UL
-#define LBER_CLASS_MASK 0xc0UL
+#define LBER_CLASS_UNIVERSAL ((ber_tag_t) 0x00U)
+#define LBER_CLASS_APPLICATION ((ber_tag_t) 0x40U)
+#define LBER_CLASS_CONTEXT ((ber_tag_t) 0x80U)
+#define LBER_CLASS_PRIVATE ((ber_tag_t) 0xc0U)
+#define LBER_CLASS_MASK ((ber_tag_t) 0xc0U)
/* BER encoding type and mask */
-#define LBER_PRIMITIVE 0x00UL
-#define LBER_CONSTRUCTED 0x20UL
-#define LBER_ENCODING_MASK 0x20UL
+#define LBER_PRIMITIVE ((ber_tag_t) 0x00U)
+#define LBER_CONSTRUCTED ((ber_tag_t) 0x20U)
+#define LBER_ENCODING_MASK ((ber_tag_t) 0x20U)
-#define LBER_BIG_TAG_MASK 0x1fUL
-#define LBER_MORE_TAG_MASK 0x80UL
+#define LBER_BIG_TAG_MASK ((ber_tag_t) 0x1fU)
+#define LBER_MORE_TAG_MASK ((ber_tag_t) 0x80U)
/*
* Note that LBER_ERROR and LBER_DEFAULT are values that can never appear
* as valid BER tags, and so it is safe to use them to report errors. In
* fact, any tag for which the following is true is invalid:
- * (( tag & 0x00000080 ) != 0 ) && (( tag & 0xFFFFFF00 ) != 0 )
*/
-#define LBER_INVALID(tag) ( ( (tag) & 0xFFFFFF80UL ) != 0 )
-#define LBER_ERROR 0xffffffffUL
-#define LBER_DEFAULT 0xffffffffUL
-/* #define LBER_END_SEQORSET 0xfffffffeUL *//* not part of LDAP C-API */
+#define LBER_INVALID(t) (((t) & (ber_tag_t) 0x080UL) \
+ && (((t) & (ber_tag_t) ~ 0x0FF))
+
+#define LBER_ERROR ((ber_tag_t) -1)
+#define LBER_DEFAULT ((ber_tag_t) -1)
/* general BER types we know about */
-#define LBER_BOOLEAN 0x01UL
-#define LBER_INTEGER 0x02UL
-#define LBER_BITSTRING 0x03UL
-#define LBER_OCTETSTRING 0x04UL
-#define LBER_NULL 0x05UL
-#define LBER_ENUMERATED 0x0aUL
-#define LBER_SEQUENCE 0x30UL /* constructed */
-#define LBER_SET 0x31UL /* constructed */
-
-#define OLD_LBER_SEQUENCE 0x10UL /* w/o constructed bit - broken */
-#define OLD_LBER_SET 0x11UL /* w/o constructed bit - broken */
-
-typedef int (*BERTranslateProc) LDAP_P((
- char **bufp,
- unsigned long *buflenp,
- int free_input ));
+#define LBER_BOOLEAN ((ber_tag_t) 0x01UL)
+#define LBER_INTEGER ((ber_tag_t) 0x02UL)
+#define LBER_BITSTRING ((ber_tag_t) 0x03UL)
+#define LBER_OCTETSTRING ((ber_tag_t) 0x04UL)
+#define LBER_NULL ((ber_tag_t) 0x05UL)
+#define LBER_ENUMERATED ((ber_tag_t) 0x0aUL)
+#define LBER_SEQUENCE ((ber_tag_t) 0x30UL) /* constructed */
+#define LBER_SET ((ber_tag_t) 0x31UL) /* constructed */
/* LBER BerElement options */
#define LBER_USE_DER 0x01
-#define LBER_USE_INDEFINITE_LEN 0x02
-#define LBER_TRANSLATE_STRINGS 0x04
/* get/set options for BerElement */
-#define LBER_OPT_BER_OPTIONS 0x01
-#define LBER_OPT_BER_DEBUG 0x02
+#define LBER_OPT_BER_OPTIONS 0x01
+#define LBER_OPT_BER_DEBUG 0x02
+#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_DEBUG_LEVEL LBER_OPT_BER_DEBUG
-#define LBER_OPT_LOG_PRINT_FN 0x8001
+#define LBER_OPT_REMAINING_BYTES LBER_OPT_BER_REMAINING_BYTES
+#define LBER_OPT_TOTAL_BYTES LBER_OPT_BER_TOTAL_BYTES
+#define LBER_OPT_BYTES_TO_WRITE LBER_OPT_BER_BYTES_TO_WRITE
-typedef void (*BER_LOG_PRINT_FN) LDAP_P(( char *buf ));
-
-/* LBER Sockbuf options */
-#define LBER_TO_FILE 0x01 /* to a file referenced by sb_fd */
-#define LBER_TO_FILE_ONLY 0x02 /* only write to file, not network */
-#define LBER_MAX_INCOMING_SIZE 0x04 /* impose limit on incoming stuff */
-#define LBER_NO_READ_AHEAD 0x08 /* read only as much as requested */
+#define LBER_OPT_LOG_PRINT_FN 0x8001
+#define LBER_OPT_MEMORY_FNS 0x8002
+#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(( 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 struct lber_memory_fns {
+ 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 */
+#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_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 14
+
+/* LBER IO operations stacking levels */
+#define LBER_SBIOD_LEVEL_PROVIDER 10
+#define LBER_SBIOD_LEVEL_TRANSPORT 20
+#define LBER_SBIOD_LEVEL_APPLICATION 30
/* get/set options for Sockbuf */
#define LBER_OPT_SOCKBUF_DESC 0x1000
#define LBER_OPT_ON ((void *) 1)
#define LBER_OPT_OFF ((void *) 0)
-#define LBER_OPT_SUCCESS 0
+#define LBER_OPT_SUCCESS (0)
#define LBER_OPT_ERROR (-1)
typedef struct berelement BerElement;
typedef struct sockbuf Sockbuf;
typedef struct seqorset Seqorset;
+typedef struct sockbuf_io Sockbuf_IO;
+
+/* Structure for LBER IO operarion descriptor */
+typedef struct sockbuf_io_desc {
+ int sbiod_level;
+ Sockbuf *sbiod_sb;
+ Sockbuf_IO *sbiod_io;
+ void *sbiod_pvt;
+ struct sockbuf_io_desc *sbiod_next;
+} Sockbuf_IO_Desc;
+
+/* Structure for LBER IO operation functions */
+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 );
+};
+
+/* Helper macros for LBER IO functions */
+#define LBER_SBIOD_READ_NEXT( sbiod, buf, len ) \
+ ( (sbiod)->sbiod_next->sbiod_io->sbi_read( (sbiod)->sbiod_next, \
+ buf, len ) )
+#define LBER_SBIOD_WRITE_NEXT( sbiod, buf, len ) \
+ ( (sbiod)->sbiod_next->sbiod_io->sbi_write( (sbiod)->sbiod_next, \
+ buf, len ) )
+#define LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg ) \
+ ( (sbiod)->sbiod_next ? \
+ ( (sbiod)->sbiod_next->sbiod_io->sbi_ctrl( \
+ (sbiod)->sbiod_next, opt, arg ) ) : 0 )
+
/* structure for returning a sequence of octet strings + length */
typedef struct berval {
- unsigned long bv_len;
+ ber_len_t bv_len;
char *bv_val;
} BerValue;
+/* this should be moved to lber-int.h */
+
/*
* in bprint.c:
*/
-LDAP_F( void )
-ber_print_error LDAP_P((
+LBER_F( void )
+ber_error_print LDAP_P((
LDAP_CONST char *data ));
-LDAP_F( void )
+LBER_F( void )
ber_bprint LDAP_P((
- LDAP_CONST char *data, int len ));
+ LDAP_CONST char *data, ber_len_t len ));
-LDAP_F( void )
+LBER_F( void )
ber_dump LDAP_P((
- LDAP_CONST BerElement *ber, int inout ));
+ BerElement *ber, int inout ));
-LDAP_F( void )
+LBER_F( void )
ber_sos_dump LDAP_P((
- LDAP_CONST Seqorset *sos ));
-
+ Seqorset *sos ));
/*
* in decode.c:
void *data,
int mode ));
-LDAP_F( unsigned long )
+LBER_F( ber_tag_t )
ber_get_tag LDAP_P((
BerElement *ber ));
-LDAP_F( unsigned long )
+LBER_F( ber_tag_t )
ber_skip_tag LDAP_P((
BerElement *ber,
- unsigned long *len ));
+ ber_len_t *len ));
-LDAP_F( unsigned long )
+LBER_F( ber_tag_t )
ber_peek_tag LDAP_P((
- LDAP_CONST BerElement *ber, /* not const in c-api-02 */
- unsigned long *len ));
+ BerElement *ber,
+ ber_len_t *len ));
-LDAP_F( unsigned long )
+LBER_F( ber_tag_t )
ber_get_int LDAP_P((
BerElement *ber,
- long *num ));
+ ber_int_t *num ));
-LDAP_F( unsigned long )
+LBER_F( ber_tag_t )
+ber_get_enum LDAP_P((
+ BerElement *ber,
+ ber_int_t *num ));
+
+LBER_F( ber_tag_t )
ber_get_stringb LDAP_P((
BerElement *ber,
char *buf,
- unsigned long *len ));
+ ber_len_t *len ));
-LDAP_F( unsigned long )
+LBER_F( ber_tag_t )
ber_get_stringa LDAP_P((
- BerElement *ber, char **buf ));
+ BerElement *ber,
+ char **buf ));
-LDAP_F( unsigned long )
+LBER_F( ber_tag_t )
ber_get_stringal LDAP_P((
BerElement *ber,
struct berval **bv ));
-LDAP_F( unsigned long )
+LBER_F( ber_tag_t )
ber_get_bitstringa LDAP_P((
BerElement *ber,
char **buf,
- unsigned long *len ));
+ ber_len_t *len ));
-LDAP_F( unsigned long )
+LBER_F( ber_tag_t )
ber_get_null LDAP_P((
BerElement *ber ));
-LDAP_F( unsigned long )
+LBER_F( ber_tag_t )
ber_get_boolean LDAP_P((
BerElement *ber,
- int *boolval ));
+ ber_int_t *boolval ));
-LDAP_F( unsigned long )
+LBER_F( ber_tag_t )
ber_first_element LDAP_P((
BerElement *ber,
- unsigned long *len,
+ ber_len_t *len,
char **last ));
-LDAP_F( unsigned long )
+LBER_F( ber_tag_t )
ber_next_element LDAP_P((
BerElement *ber,
- unsigned long *len,
- char *last ));
+ ber_len_t *len,
+ LDAP_CONST char *last ));
-LDAP_F( unsigned long )
+LBER_F( ber_tag_t )
ber_scanf LDAP_P((
BerElement *ber,
LDAP_CONST char *fmt,
... ));
-LDAP_F( void )
-ber_bvfree LDAP_P((
- struct berval *bv ));
-
-LDAP_F( void )
-ber_bvecfree LDAP_P((
- struct berval **bv ));
-
-LDAP_F( struct berval * )
-ber_bvdup LDAP_P((
- LDAP_CONST struct berval *bv ));
-
-LDAP_F( void )
-ber_set_string_translators LDAP_P((
- BerElement *ber,
- BERTranslateProc encode_proc,
- BERTranslateProc decode_proc ));
-
/*
* in encode.c
*/
BerElement *ber,
void *data ));
-LDAP_F( int )
+LBER_F( int )
ber_put_enum LDAP_P((
BerElement *ber,
- long num,
- unsigned long tag ));
+ ber_int_t num,
+ ber_tag_t tag ));
-LDAP_F( int )
+LBER_F( int )
ber_put_int LDAP_P((
BerElement *ber,
- long num,
- unsigned long tag ));
+ ber_int_t num,
+ ber_tag_t tag ));
-LDAP_F( int )
+LBER_F( int )
ber_put_ostring LDAP_P((
BerElement *ber,
LDAP_CONST char *str,
- unsigned long len,
- unsigned long tag ));
+ ber_len_t len,
+ ber_tag_t tag ));
-LDAP_F( int )
+LBER_F( int )
ber_put_berval LDAP_P((
BerElement *ber,
LDAP_CONST struct berval *bv,
- unsigned long tag ));
+ ber_tag_t tag ));
-LDAP_F( int )
+LBER_F( int )
ber_put_string LDAP_P((
BerElement *ber,
LDAP_CONST char *str,
- unsigned long tag ));
+ ber_tag_t tag ));
-LDAP_F( int )
+LBER_F( int )
ber_put_bitstring LDAP_P((
BerElement *ber,
LDAP_CONST char *str,
- unsigned long bitlen,
- unsigned long tag ));
+ ber_len_t bitlen,
+ ber_tag_t tag ));
-LDAP_F( int )
+LBER_F( int )
ber_put_null LDAP_P((
BerElement *ber,
- unsigned long tag ));
+ ber_tag_t tag ));
-LDAP_F( int )
+LBER_F( int )
ber_put_boolean LDAP_P((
BerElement *ber,
- int boolval,
- unsigned long tag ));
+ ber_int_t boolval,
+ ber_tag_t tag ));
-LDAP_F( int )
+LBER_F( int )
ber_start_seq LDAP_P((
BerElement *ber,
- unsigned long tag ));
+ ber_tag_t tag ));
-LDAP_F( int )
+LBER_F( int )
ber_start_set LDAP_P((
BerElement *ber,
- unsigned long tag ));
+ ber_tag_t tag ));
-LDAP_F( int )
+LBER_F( int )
ber_put_seq LDAP_P((
BerElement *ber ));
-LDAP_F( int )
+LBER_F( int )
ber_put_set LDAP_P((
BerElement *ber ));
-LDAP_F( int )
+LBER_F( int )
ber_printf LDAP_P((
BerElement *ber,
LDAP_CONST char *fmt,
... ));
+
+
/*
* in io.c:
*/
-LDAP_F( long )
+LBER_F( ber_slen_t )
ber_read LDAP_P((
BerElement *ber,
char *buf,
- unsigned long len ));
+ ber_len_t len ));
-LDAP_F( long )
+LBER_F( ber_slen_t )
ber_write LDAP_P((
BerElement *ber,
LDAP_CONST char *buf,
- unsigned long len,
+ ber_len_t len,
int nosos ));
-LDAP_F( void )
+LBER_F( void )
ber_free LDAP_P((
BerElement *ber,
int freebuf ));
-LDAP_F( void )
-ber_clear LDAP_P((
- BerElement *ber,
- int freebuf ));
-
-LDAP_F( int )
+LBER_F( int )
ber_flush LDAP_P((
- Sockbuf *sb, BerElement *ber, int freeit ));
+ Sockbuf *sb,
+ BerElement *ber,
+ int freeit ));
-LDAP_F( BerElement * )
+LBER_F( BerElement * )
ber_alloc LDAP_P(( void )); /* DEPRECATED */
-LDAP_F( BerElement * )
+LBER_F( BerElement * )
der_alloc LDAP_P(( void )); /* DEPRECATED */
-LDAP_F( BerElement * )
+LBER_F( BerElement * )
ber_alloc_t LDAP_P((
- int options ));
+ int beroptions ));
-LDAP_F( BerElement * )
+LBER_F( BerElement * )
ber_dup LDAP_P((
- LDAP_CONST BerElement *ber ));
+ BerElement *ber ));
-LDAP_F( unsigned long )
+LBER_F( ber_tag_t )
ber_get_next LDAP_P((
Sockbuf *sb,
- unsigned long *len,
+ ber_len_t *len,
BerElement *ber ));
-LDAP_F( void )
-ber_init_w_nullc LDAP_P((
+LBER_F( void )
+ber_init_w_nullc LDAP_P(( /* DEPRECATED */
BerElement *ber,
int options ));
-LDAP_F( void )
+LBER_F( void )
ber_reset LDAP_P((
BerElement *ber,
int was_writing ));
-/*
- * LBER draft-ietf-ldapext-ldap-c-api-01 routines
- */
-LDAP_F( BerElement * )
+LBER_F( BerElement * )
ber_init LDAP_P((
struct berval *bv ));
-LDAP_F( int )
+LBER_F( int )
ber_flatten LDAP_P((
- LDAP_CONST BerElement *ber,
+ BerElement *ber,
struct berval **bvPtr ));
/*
* LBER ber accessor functions
*/
-LDAP_F( int )
+LBER_F( int )
ber_get_option LDAP_P((
void *item,
int option,
void *outvalue));
-LDAP_F( int )
+LBER_F( int )
ber_set_option LDAP_P((
void *item,
int option,
* LBER sockbuf.c
*/
-LDAP_F( Sockbuf * )
-ber_sockbuf_alloc( void );
+LBER_F( Sockbuf * )
+ber_sockbuf_alloc LDAP_P((
+ void ));
+
+LBER_F( void )
+ber_sockbuf_free LDAP_P((
+ Sockbuf *sb ));
+
+LBER_F( int )
+ber_sockbuf_add_io LDAP_P((
+ Sockbuf *sb,
+ Sockbuf_IO *sbio,
+ int layer,
+ void *arg ));
+
+LBER_F( int )
+ber_sockbuf_remove_io LDAP_P((
+ Sockbuf *sb,
+ Sockbuf_IO *sbio,
+ int layer ));
+
+LBER_F( int )
+ber_sockbuf_ctrl LDAP_P((
+ Sockbuf *sb,
+ int opt,
+ void *arg ));
+
+LBER_F( Sockbuf_IO ) ber_sockbuf_io_tcp;
+LBER_F( Sockbuf_IO ) ber_sockbuf_io_readahead;
+LBER_F( Sockbuf_IO ) ber_sockbuf_io_fd;
+LBER_F( Sockbuf_IO ) ber_sockbuf_io_debug;
+
+/*
+ * LBER memory.c
+ */
+LBER_F( void * )
+ber_memalloc LDAP_P((
+ ber_len_t s ));
+
+LBER_F( void * )
+ber_memrealloc LDAP_P((
+ void* p,
+ ber_len_t s ));
+
+LBER_F( void * )
+ber_memcalloc LDAP_P((
+ ber_len_t n,
+ ber_len_t s ));
+
+LBER_F( void )
+ber_memfree LDAP_P((
+ void* p ));
-LDAP_F( Sockbuf * )
-ber_sockbuf_alloc_fd(
- int fd );
+LBER_F( void )
+ber_memvfree LDAP_P((
+ void** vector ));
-LDAP_F( void )
-ber_sockbuf_free(
- Sockbuf *sb );
+LBER_F( void )
+ber_bvfree LDAP_P((
+ struct berval *bv ));
+
+LBER_F( void )
+ber_bvecfree LDAP_P((
+ struct berval **bv ));
+
+LBER_F( int )
+ber_bvecadd LDAP_P((
+ struct berval ***bvec,
+ struct berval *bv ));
+
+LBER_F( struct berval * )
+ber_bvdup LDAP_P((
+ LDAP_CONST struct berval *bv ));
+
+LBER_F( struct berval * )
+ber_bvstr LDAP_P((
+ LDAP_CONST char * ));
+
+LBER_F( struct berval * )
+ber_bvstrdup LDAP_P((
+ LDAP_CONST char * ));
+
+LBER_F( char * )
+ber_strdup LDAP_P((
+ LDAP_CONST char * ));
+
+/*
+ * error.c
+ */
+LBER_F( int * ) ber_errno_addr LDAP_P((void));
+#define ber_errno (*(ber_errno_addr)())
+#define LBER_ERROR_NONE 0
+#define LBER_ERROR_PARAM 0x1
+#define LBER_ERROR_MEMORY 0x2
LDAP_END_DECL
projects / openldap / blobdiff