git.sur5r.net Git - openldap/blob - libraries/liblber/lber-int.h

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
   4  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   5  */
   6 /* Portions
   7  * Copyright (c) 1990 Regents of the University of Michigan.
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms are permitted
  11  * provided that this notice is preserved and that due credit is given
  12  * to the University of Michigan at Ann Arbor. The name of the University
  13  * may not be used to endorse or promote products derived from this
  14  * software without specific prior written permission. This software
  15  * is provided ``as is'' without express or implied warranty.
  16  */
  17
  18 #ifndef _LBER_INT_H
  19 #define _LBER_INT_H
  20
  21 #include "lber.h"
  22 #include "ldap_log.h"
  23 #include "lber_pvt.h"
  24 #include "ldap_queue.h"
  25
  26 LDAP_BEGIN_DECL
  27
  28 typedef void (*BER_LOG_FN)(FILE *file,
  29         const char *subsys, int level, const char *fmt, ... );
  30
  31 LBER_V (BER_ERRNO_FN) ber_int_errno_fn;
  32
  33 struct lber_options {
  34         short lbo_valid;
  35         unsigned short          lbo_options;
  36         int                     lbo_debug;
  37         long            lbo_meminuse;
  38 };
  39
  40 #ifdef NEW_LOGGING
  41 /*
  42 #    ifdef LDAP_DEBUG
  43 #        ifdef LDAP_LOG
  44 #            undef LDAP_LOG
  45 #        endif
  46 #        define LDAP_LOG(a) ber_pvt_log_output a
  47  */
  48 #        define BER_DUMP(a) ber_output_dump a
  49 /*
  50 #    else
  51 #        define LDAP_LOG(a)
  52 #        define BER_DUMP(a)
  53 #    endif
  54  */
  55 #endif
  56
  57 LBER_F( int ) ber_pvt_log_output(
  58         const char *subsystem,
  59         int level,
  60         const char *fmt, ... );
  61
  62 #define LBER_UNINITIALIZED              0x0
  63 #define LBER_INITIALIZED                0x1
  64 #define LBER_VALID_BERELEMENT   0x2
  65 #define LBER_VALID_SOCKBUF              0x3
  66
  67 LBER_V (struct lber_options) ber_int_options;
  68 #define ber_int_debug ber_int_options.lbo_debug
  69
  70 struct berelement {
  71         struct          lber_options ber_opts;
  72 #define ber_valid               ber_opts.lbo_valid
  73 #define ber_options             ber_opts.lbo_options
  74 #define ber_debug               ber_opts.lbo_debug
  75
  76         /* Do not change the order of these 3 fields! see ber_get_next */
  77         ber_tag_t       ber_tag;
  78         ber_len_t       ber_len;
  79         ber_tag_t       ber_usertag;
  80
  81         char            *ber_buf;
  82         char            *ber_ptr;
  83         char            *ber_end;
  84
  85         struct seqorset *ber_sos;
  86         char            *ber_rwptr;
  87         void            *ber_memctx;
  88 };
  89 #define LBER_VALID(ber) ((ber)->ber_valid==LBER_VALID_BERELEMENT)
  90
  91 #define ber_pvt_ber_remaining(ber)      ((ber)->ber_end - (ber)->ber_ptr)
  92 #define ber_pvt_ber_total(ber)          ((ber)->ber_end - (ber)->ber_buf)
  93 #define ber_pvt_ber_write(ber)          ((ber)->ber_ptr - (ber)->ber_buf)
  94
  95 struct sockbuf {
  96         struct lber_options sb_opts;
  97         Sockbuf_IO_Desc         *sb_iod;                /* I/O functions */
  98 #define sb_valid                sb_opts.lbo_valid
  99 #define sb_options              sb_opts.lbo_options
 100 #define sb_debug                sb_opts.lbo_debug
 101         ber_socket_t            sb_fd;
 102         unsigned int            sb_trans_needs_read:1;
 103         unsigned int            sb_trans_needs_write:1;
 104         ber_len_t                       sb_max_incoming;
 105 };
 106
 107 #define SOCKBUF_VALID( sb )     ( (sb)->sb_valid == LBER_VALID_SOCKBUF )
 108
 109 struct seqorset {
 110         BerElement      *sos_ber;
 111         ber_len_t       sos_clen;
 112         ber_tag_t       sos_tag;
 113         char            *sos_first;
 114         char            *sos_ptr;
 115         struct seqorset *sos_next;
 116 };
 117
 118
 119 /*
 120  * io.c
 121  */
 122 LBER_F( int )
 123 ber_realloc LDAP_P((
 124         BerElement *ber,
 125         ber_len_t len ));
 126
 127 LBER_F (char *) ber_start LDAP_P(( BerElement * ));
 128 LBER_F (int) ber_len LDAP_P(( BerElement * ));
 129 LBER_F (int) ber_ptrlen LDAP_P(( BerElement * ));
 130 LBER_F (void) ber_rewind LDAP_P(( BerElement * ));
 131
 132 /*
 133  * bprint.c
 134  */
 135 #define ber_log_printf ber_pvt_log_printf
 136
 137 #ifdef NEW_LOGGING
 138 LBER_F( int )
 139 ber_output_dump LDAP_P((
 140         const char *subsys,
 141         int level,
 142         BerElement *ber,
 143         int inout ));
 144 #endif
 145
 146 LBER_F( int )
 147 ber_log_bprint LDAP_P((
 148         int errlvl,
 149         int loglvl,
 150         const char *data,
 151         ber_len_t len ));
 152
 153 LBER_F( int )
 154 ber_log_dump LDAP_P((
 155         int errlvl,
 156         int loglvl,
 157         BerElement *ber,
 158         int inout ));
 159
 160 LBER_F( int )
 161 ber_log_sos_dump LDAP_P((
 162         int errlvl,
 163         int loglvl,
 164         Seqorset *sos ));
 165
 166 LBER_V (BER_LOG_FN) ber_int_log_proc;
 167 LBER_V (FILE *) ber_pvt_err_file;
 168
 169 /* memory.c */
 170         /* simple macros to realloc for now */
 171 LBER_V (BerMemoryFunctions *)   ber_int_memory_fns;
 172 LBER_F (char *) ber_strndup( LDAP_CONST char *, ber_len_t );
 173 LBER_F (char *) ber_strndup_x( LDAP_CONST char *, ber_len_t, void *ctx );
 174
 175 #define LBER_MALLOC(s)          ber_memalloc((s))
 176 #define LBER_CALLOC(n,s)        ber_memcalloc((n),(s))
 177 #define LBER_REALLOC(p,s)       ber_memrealloc((p),(s))
 178 #define LBER_FREE(p)            ber_memfree((p))
 179 #define LBER_VFREE(v)           ber_memvfree((void**)(v))
 180 #define LBER_STRDUP(s)          ber_strdup((s))
 181 #define LBER_STRNDUP(s,l)       ber_strndup((s),(l))
 182
 183 /* sockbuf.c */
 184
 185 LBER_F( int )
 186 ber_int_sb_init LDAP_P(( Sockbuf *sb ));
 187
 188 LBER_F( int )
 189 ber_int_sb_close LDAP_P(( Sockbuf *sb ));
 190
 191 LBER_F( int )
 192 ber_int_sb_destroy LDAP_P(( Sockbuf *sb ));
 193
 194 LBER_F( ber_slen_t )
 195 ber_int_sb_read LDAP_P(( Sockbuf *sb, void *buf, ber_len_t len ));
 196
 197 LBER_F( ber_slen_t )
 198 ber_int_sb_write LDAP_P(( Sockbuf *sb, void *buf, ber_len_t len ));
 199
 200 LDAP_END_DECL
 201
 202 #endif /* _LBER_INT_H */