2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2009 The OpenLDAP Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
11 * A copy of this license is available in the file LICENSE in the
12 * top-level directory of the distribution or, alternatively, at
13 * <http://www.OpenLDAP.org/license.html>.
15 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
16 * All rights reserved.
18 * Redistribution and use in source and binary forms are permitted
19 * provided that this notice is preserved and that due credit is given
20 * to the University of Michigan at Ann Arbor. The name of the University
21 * may not be used to endorse or promote products derived from this
22 * software without specific prior written permission. This software
23 * is provided ``as is'' without express or implied warranty.
32 #include "ldap_queue.h"
36 typedef void (*BER_LOG_FN)(FILE *file,
37 const char *subsys, int level, const char *fmt, ... );
39 LBER_V (BER_ERRNO_FN) ber_int_errno_fn;
41 #ifdef LDAP_MEMORY_TRACE
42 # ifndef LDAP_MEMORY_DEBUG
43 # define LDAP_MEMORY_DEBUG 1
47 #ifdef LDAP_MEMORY_DEBUG
48 LBER_V (long) ber_int_meminuse;
50 #if defined(LDAP_MEMORY_DEBUG) && ((LDAP_MEMORY_DEBUG +0) & 2)
51 # define LDAP_MEMORY_DEBUG_ASSERT assert
53 # define LDAP_MEMORY_DEBUG_ASSERT(expr) ((void) 0)
58 unsigned short lbo_options;
62 LBER_F( int ) ber_pvt_log_output(
63 const char *subsystem,
65 const char *fmt, ... );
67 #define LBER_UNINITIALIZED 0x0
68 #define LBER_INITIALIZED 0x1
69 #define LBER_VALID_BERELEMENT 0x2
70 #define LBER_VALID_SOCKBUF 0x3
72 LBER_V (struct lber_options) ber_int_options;
73 #define ber_int_debug ber_int_options.lbo_debug
75 /* Data encoded in ASN.1 BER format */
77 struct lber_options ber_opts;
78 #define ber_valid ber_opts.lbo_valid
79 #define ber_options ber_opts.lbo_options
80 #define ber_debug ber_opts.lbo_debug
83 * The members below, when not NULL/LBER_DEFAULT/etc, are:
84 * ber_buf Data buffer. Other pointers normally point into it.
85 * ber_rwptr Read/write cursor for Sockbuf I/O.
86 * ber_memctx Context passed to ber_memalloc() & co.
87 * When decoding data (reading it from the BerElement):
88 * ber_end End of BER data.
89 * ber_ptr Read cursor, except for 1st octet of tags.
90 * ber_tag 1st octet of next tag, saved from *ber_ptr when
91 * ber_ptr may be pointing at a tag and is >ber_buf.
92 * The octet *ber_ptr itself may get overwritten with
93 * a \0, to terminate the preceding element.
94 * When encoding data (writing it to the BerElement):
95 * ber_end End of allocated buffer - 1 (allowing a final \0).
96 * ber_ptr Last complete BER element (normally write cursor).
97 * ber_sos_ptr NULL or write cursor for incomplete sequence or set.
98 * ber_sos_inner offset(seq/set length octets) if ber_sos_ptr!=NULL.
99 * ber_tag Default tag for next ber_printf() element.
100 * ber_usertag Boolean set by ber_printf "!" if it sets ber_tag.
101 * ber_len Reused for ber_sos_inner.
102 * When output to a Sockbuf:
103 * ber_ptr End of encoded data to write.
104 * When input from a Sockbuf:
105 * See ber_get_next().
108 /* Do not change the order of these 3 fields! see ber_get_next */
111 ber_tag_t ber_usertag;
118 # define ber_sos_inner ber_len /* reused for binary compat */
123 #define LBER_VALID(ber) ((ber)->ber_valid==LBER_VALID_BERELEMENT)
125 #define ber_pvt_ber_remaining(ber) ((ber)->ber_end - (ber)->ber_ptr)
126 #define ber_pvt_ber_total(ber) ((ber)->ber_end - (ber)->ber_buf)
127 #define ber_pvt_ber_write(ber) ((ber)->ber_ptr - (ber)->ber_buf)
130 struct lber_options sb_opts;
131 Sockbuf_IO_Desc *sb_iod; /* I/O functions */
132 #define sb_valid sb_opts.lbo_valid
133 #define sb_options sb_opts.lbo_options
134 #define sb_debug sb_opts.lbo_debug
136 ber_len_t sb_max_incoming;
137 unsigned int sb_trans_needs_read:1;
138 unsigned int sb_trans_needs_write:1;
139 #ifdef LDAP_PF_LOCAL_SENDMSG
145 #define SOCKBUF_VALID( sb ) ( (sb)->sb_valid == LBER_VALID_SOCKBUF )
152 /* Simplest OID max-DER-component to implement in both decode and encode */
153 #define LBER_OID_COMPONENT_MAX ((unsigned long)-1 - 128)
164 LBER_F (char *) ber_start LDAP_P(( BerElement * ));
165 LBER_F (int) ber_len LDAP_P(( BerElement * ));
166 LBER_F (int) ber_ptrlen LDAP_P(( BerElement * ));
167 LBER_F (void) ber_rewind LDAP_P(( BerElement * ));
172 #define ber_log_printf ber_pvt_log_printf
175 ber_log_bprint LDAP_P((
182 ber_log_dump LDAP_P((
188 LBER_V (BER_LOG_FN) ber_int_log_proc;
189 LBER_V (FILE *) ber_pvt_err_file;
192 /* simple macros to realloc for now */
193 LBER_V (BerMemoryFunctions *) ber_int_memory_fns;
194 LBER_F (char *) ber_strndup( LDAP_CONST char *, ber_len_t );
195 LBER_F (char *) ber_strndup_x( LDAP_CONST char *, ber_len_t, void *ctx );
197 #define LBER_MALLOC(s) ber_memalloc((s))
198 #define LBER_CALLOC(n,s) ber_memcalloc((n),(s))
199 #define LBER_REALLOC(p,s) ber_memrealloc((p),(s))
200 #define LBER_FREE(p) ber_memfree((p))
201 #define LBER_VFREE(v) ber_memvfree((void**)(v))
202 #define LBER_STRDUP(s) ber_strdup((s))
203 #define LBER_STRNDUP(s,l) ber_strndup((s),(l))
208 ber_int_sb_init LDAP_P(( Sockbuf *sb ));
211 ber_int_sb_close LDAP_P(( Sockbuf *sb ));
214 ber_int_sb_destroy LDAP_P(( Sockbuf *sb ));
217 ber_int_sb_read LDAP_P(( Sockbuf *sb, void *buf, ber_len_t len ));
220 ber_int_sb_write LDAP_P(( Sockbuf *sb, void *buf, ber_len_t len ));
224 #endif /* _LBER_INT_H */