]> git.sur5r.net Git - openldap/blobdiff - include/lber.h
Sync with HEAD for OL 2.4.5
[openldap] / include / lber.h
index 327c40acb3c4f7690f6752be2626774f974198bc..4b3a8d5ecd8ac22a03e39fa9748976d0512a7a25 100644 (file)
@@ -1,16 +1,18 @@
 /* $OpenLDAP$ */
-/*
- * Copyright 1998-2001 The OpenLDAP Foundation, Redwood City, California, USA
+/* This work is part of OpenLDAP Software <http://www.openldap.org/>.
+ *
+ * Copyright 1998-2007 The OpenLDAP Foundation.
  * All rights reserved.
  *
  * 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.
+ * Public License.
+ *
+ * A copy of this license is available in file LICENSE in the
+ * top-level directory of the distribution or, alternatively, at
+ * <http://www.OpenLDAP.org/license.html>.
  */
-/* 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
@@ -25,6 +27,7 @@
 #define _LBER_H
 
 #include <lber_types.h>
+#include <string.h>
 
 LDAP_BEGIN_DECL
 
@@ -90,6 +93,7 @@ LDAP_BEGIN_DECL
 #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
@@ -109,16 +113,16 @@ 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 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 */
@@ -132,10 +136,14 @@ typedef struct lber_memory_fns {
 #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
+#define LBER_SB_OPT_GET_MAX_INCOMING   13
+#define LBER_SB_OPT_SET_MAX_INCOMING   14
+
+/* Only meaningful ifdef LDAP_PF_LOCAL_SENDMSG */
+#define LBER_SB_OPT_UNGET_BUF  15
+
 /* Largest option used by the library */
-#define LBER_SB_OPT_OPT_MAX            14
+#define LBER_SB_OPT_OPT_MAX            15
 
 /* LBER IO operations stacking levels */
 #define LBER_SBIOD_LEVEL_PROVIDER      10
@@ -148,7 +156,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)
@@ -201,6 +210,8 @@ typedef struct berval {
        char            *bv_val;
 } BerValue;
 
+typedef BerValue *BerVarray;   /* To distinguish from a single bv */
+
 /* this should be moved to lber-int.h */
 
 /*
@@ -260,6 +271,15 @@ ber_get_stringb LDAP_P((
        char *buf,
        ber_len_t *len ));
 
+#define        LBER_BV_ALLOC   0x01    /* allocate/copy result, otherwise in-place */
+#define        LBER_BV_NOTERM  0x02    /* omit NUL-terminator if parsing in-place */
+
+LBER_F( ber_tag_t )
+ber_get_stringbv LDAP_P((
+       BerElement *ber,
+       struct berval *bv,
+       int options ));
+
 LBER_F( ber_tag_t )
 ber_get_stringa LDAP_P((
        BerElement *ber,
@@ -303,9 +323,19 @@ ber_scanf LDAP_P((
        LDAP_CONST char *fmt,
        ... ));
 
+LBER_F( int )
+ber_decode_oid LDAP_P((
+       struct berval *in,
+       struct berval *out ));
+
 /*
  * in encode.c
  */
+LBER_F( int )
+ber_encode_oid LDAP_P((
+       struct berval *in,
+       struct berval *out ));
+
 typedef int (*BEREncodeCallback) LDAP_P((
        BerElement *ber,
        void *data ));
@@ -332,7 +362,7 @@ ber_put_ostring LDAP_P((
 LBER_F( int )
 ber_put_berval LDAP_P((
        BerElement *ber,
-       LDAP_CONST struct berval *bv,
+       struct berval *bv,
        ber_tag_t tag ));
 
 LBER_F( int )
@@ -388,6 +418,11 @@ ber_printf LDAP_P((
  * in io.c:
  */
 
+LBER_F( ber_slen_t )
+ber_skip_data LDAP_P((
+       BerElement *ber,
+       ber_len_t len ));
+
 LBER_F( ber_slen_t )
 ber_read LDAP_P((
        BerElement *ber,
@@ -406,11 +441,24 @@ ber_free LDAP_P((
        BerElement *ber,
        int freebuf ));
 
+LBER_F( void )
+ber_free_buf LDAP_P(( BerElement *ber ));
+
 LBER_F( int )
-ber_flush LDAP_P((
+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 */
 
 LBER_F( BerElement * )
 ber_alloc LDAP_P(( void )); /* DEPRECATED */
@@ -432,6 +480,12 @@ ber_get_next LDAP_P((
        ber_len_t *len,
        BerElement *ber ));
 
+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,
@@ -451,6 +505,16 @@ 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
  */
@@ -502,9 +566,7 @@ 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;
-#ifdef LDAP_CONNECTIONLESS
 LBER_V( Sockbuf_IO ) ber_sockbuf_io_udp;
-#endif
 
 /*
  * LBER memory.c
@@ -544,22 +606,44 @@ ber_bvecadd LDAP_P((
        struct berval ***bvec,
        struct berval *bv ));
 
+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 ));
 
 LBER_F( struct berval * )
-ber_bvstr LDAP_P((
-       LDAP_CONST char * ));
+ber_mem2bv LDAP_P((
+       LDAP_CONST char *, ber_len_t len, int duplicate, struct berval *bv));
 
 LBER_F( struct berval * )
-ber_bvstrdup LDAP_P((
-       LDAP_CONST char * ));
+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))
 
 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
  */