git.sur5r.net Git - openldap/blob - servers/slapd/slap.h

   1 /* slap.h - stand alone ldap server include file */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 1998-2007 The OpenLDAP Foundation.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted only as authorized by the OpenLDAP
  10  * Public License.
  11  *
  12  * A copy of this license is available in the file LICENSE in the
  13  * top-level directory of the distribution or, alternatively, at
  14  * <http://www.OpenLDAP.org/license.html>.
  15  */
  16 /* Portions Copyright (c) 1995 Regents of the University of Michigan.
  17  * All rights reserved.
  18  *
  19  * Redistribution and use in source and binary forms are permitted
  20  * provided that this notice is preserved and that due credit is given
  21  * to the University of Michigan at Ann Arbor. The name of the University
  22  * may not be used to endorse or promote products derived from this
  23  * software without specific prior written permission. This software
  24  * is provided ``as is'' without express or implied warranty.
  25  */
  26
  27 #ifndef _SLAP_H_
  28 #define _SLAP_H_
  29
  30 #include "ldap_defaults.h"
  31
  32 #include <stdio.h>
  33 #include <ac/stdlib.h>
  34
  35 #include <sys/types.h>
  36 #include <ac/syslog.h>
  37 #include <ac/regex.h>
  38 #include <ac/signal.h>
  39 #include <ac/socket.h>
  40 #include <ac/time.h>
  41 #include <ac/param.h>
  42
  43 #include "avl.h"
  44
  45 #ifndef ldap_debug
  46 #define ldap_debug slap_debug
  47 #endif
  48
  49 #include "ldap_log.h"
  50
  51 #include <ldap.h>
  52 #include <ldap_schema.h>
  53
  54 #include "lber_pvt.h"
  55 #include "ldap_pvt.h"
  56 #include "ldap_pvt_thread.h"
  57 #include "ldap_queue.h"
  58
  59 LDAP_BEGIN_DECL
  60
  61
  62 #ifdef LDAP_DEVEL
  63 #define SLAP_LIGHTWEIGHT_DISPATCHER /* experimental slapd architecture */
  64 #define SLAP_MULTI_CONN_ARRAY
  65 #ifdef LDAP_PVT_THREAD_POOL_SEM_LOAD_CONTROL
  66 #define SLAP_SEM_LOAD_CONTROL
  67 #endif /* LDAP_PVT_THREAD_POOL_SEM_LOAD_CONTROL */
  68
  69 #define SLAP_ACL_HONOR_DISCLOSE /* partially implemented */
  70 #define SLAP_ACL_HONOR_MANAGE   /* not yet implemented */
  71 #define SLAP_DYNACL
  72 #define SLAP_OVERLAY_ACCESS
  73 #define LDAP_COMP_MATCH
  74 #define LDAP_DYNAMIC_OBJECTS
  75 #define LDAP_SYNC_TIMESTAMP
  76 #define LDAP_COLLECTIVE_ATTRIBUTES
  77 #define SLAPD_CONF_UNKNOWN_BAILOUT
  78 #define SLAP_CONTROL_X_TREE_DELETE LDAP_CONTROL_X_TREE_DELETE
  79
  80 #define SLAP_ORDERED_PRETTYNORM
  81 #define SLAP_AUTHZ_SYNTAX
  82
  83 #ifdef ENABLE_REWRITE
  84 #define SLAP_AUTH_REWRITE       1 /* use librewrite for sasl-regexp */
  85 #endif
  86 #endif
  87
  88 #if defined(LDAP_SLAPI) && !defined(SLAP_OVERLAY_ACCESS)
  89 #define SLAP_OVERLAY_ACCESS
  90 #endif
  91
  92 /*
  93  * ITS#3705: bail out if unknown config directives appear in slapd.conf
  94  */
  95 #ifdef SLAPD_CONF_UNKNOWN_BAILOUT
  96 #define SLAPD_CONF_UNKNOWN_IGNORED      ""
  97 #define SLAPD_DEBUG_CONFIG_ERROR        LDAP_DEBUG_ANY
  98 #else /* ! SLAPD_CONF_UNKNOWN_BAILOUT */
  99 #define SLAPD_CONF_UNKNOWN_IGNORED      " (ignored)"
 100 #define SLAPD_DEBUG_CONFIG_ERROR        LDAP_DEBUG_CONFIG
 101 #endif /* ! SLAPD_CONF_UNKNOWN_BAILOUT */
 102
 103 /*
 104  * SLAPD Memory allocation macros
 105  *
 106  * Unlike ch_*() routines, these routines do not assert() upon
 107  * allocation error.  They are intended to be used instead of
 108  * ch_*() routines where the caller has implemented proper
 109  * checking for and handling of allocation errors.
 110  *
 111  * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
 112  */
 113 #define SLAP_MALLOC(s)      ber_memalloc((s))
 114 #define SLAP_CALLOC(n,s)    ber_memcalloc((n),(s))
 115 #define SLAP_REALLOC(p,s)   ber_memrealloc((p),(s))
 116 #define SLAP_FREE(p)        ber_memfree((p))
 117 #define SLAP_VFREE(v)       ber_memvfree((void**)(v))
 118 #define SLAP_STRDUP(s)      ber_strdup((s))
 119 #define SLAP_STRNDUP(s,l)   ber_strndup((s),(l))
 120
 121 #ifdef f_next
 122 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
 123 #endif
 124
 125 #define SERVICE_NAME  OPENLDAP_PACKAGE "-slapd"
 126 #define SLAPD_ANONYMOUS ""
 127
 128 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
 129  * This is a value used internally by the backends. It is needed to allow
 130  * adding values that already exist without getting an error as required by
 131  * modrdn when the new rdn was already an attribute value itself.
 132  */
 133 #define SLAP_MOD_SOFTADD        0x1000
 134
 135 #define MAXREMATCHES (100)
 136
 137 #define SLAP_MAX_WORKER_THREADS         (16)
 138
 139 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
 140 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
 141
 142 #define SLAP_CONN_MAX_PENDING_DEFAULT   100
 143 #define SLAP_CONN_MAX_PENDING_AUTH      1000
 144
 145 #define SLAP_TEXT_BUFLEN (256)
 146
 147 /* psuedo error code indicating abandoned operation */
 148 #define SLAPD_ABANDON (-1024)
 149
 150 /* psuedo error code indicating disconnect */
 151 #define SLAPD_DISCONNECT (-1025)
 152
 153 /* unknown config file directive */
 154 #define SLAP_CONF_UNKNOWN (-1026)
 155
 156 /* We assume "C" locale, that is US-ASCII */
 157 #define ASCII_SPACE(c)  ( (c) == ' ' )
 158 #define ASCII_LOWER(c)  ( (c) >= 'a' && (c) <= 'z' )
 159 #define ASCII_UPPER(c)  ( (c) >= 'A' && (c) <= 'Z' )
 160 #define ASCII_ALPHA(c)  ( ASCII_LOWER(c) || ASCII_UPPER(c) )
 161 #define ASCII_DIGIT(c)  ( (c) >= '0' && (c) <= '9' )
 162 #define ASCII_HEXLOWER(c)       ( (c) >= 'a' && (c) <= 'f' )
 163 #define ASCII_HEXUPPER(c)       ( (c) >= 'A' && (c) <= 'F' )
 164 #define ASCII_HEX(c)    ( ASCII_DIGIT(c) || \
 165         ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
 166 #define ASCII_ALNUM(c)  ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
 167 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
 168
 169 #define SLAP_NIBBLE(c) ((c)&0x0f)
 170 #define SLAP_ESCAPE_CHAR ('\\')
 171 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
 172 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
 173
 174 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
 175         || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
 176
 177 #define DN_ESCAPE(c)    ((c) == SLAP_ESCAPE_CHAR)
 178 /* NOTE: for consistency, this macro must only operate
 179  * on normalized/pretty DN, such that ';' is never used
 180  * as RDN separator, and all occurrences of ';' must be escaped */
 181 #define DN_SEPARATOR(c) ((c) == ',')
 182 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
 183 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
 184 #define RDN_NEEDSESCAPE(c)      ((c) == '\\' || (c) == '"')
 185
 186 #define DESC_LEADCHAR(c)        ( ASCII_ALPHA(c) )
 187 #define DESC_CHAR(c)    ( ASCII_ALNUM(c) || (c) == '-' )
 188 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
 189 #define OID_SEPARATOR(c)        ( (c) == '.' )
 190 #define OID_CHAR(c)     ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
 191
 192 #define ATTR_LEADCHAR(c)        ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
 193 #define ATTR_CHAR(c)    ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
 194
 195 #define AD_LEADCHAR(c)  ( ATTR_LEADCHAR(c) )
 196 #define AD_CHAR(c)              ( ATTR_CHAR(c) || (c) == ';' )
 197
 198 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
 199
 200 #define SLAP_PRINTABLE(c)       ( ASCII_ALNUM(c) || (c) == '\'' || \
 201         (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
 202         (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
 203         (c) == '?' || (c) == ' ' || (c) == '=' )
 204 #define SLAP_PRINTABLES(c)      ( SLAP_PRINTABLE(c) || (c) == '$' )
 205
 206 /* must match in schema_init.c */
 207 #define SLAPD_DN_SYNTAX                 "1.3.6.1.4.1.1466.115.121.1.12"
 208 #define SLAPD_NAMEUID_SYNTAX    "1.3.6.1.4.1.1466.115.121.1.34"
 209 #define SLAPD_INTEGER_SYNTAX    "1.3.6.1.4.1.1466.115.121.1.27"
 210 #define SLAPD_GROUP_ATTR                "member"
 211 #define SLAPD_GROUP_CLASS               "groupOfNames"
 212 #define SLAPD_ROLE_ATTR                 "roleOccupant"
 213 #define SLAPD_ROLE_CLASS                "organizationalRole"
 214
 215 #ifdef SLAPD_ACI_ENABLED
 216 #define SLAPD_ACI_SYNTAX                "1.3.6.1.4.1.4203.666.2.1"
 217 #endif /* SLAPD_ACI_ENABLED */
 218
 219 /* change this to "OpenLDAPset" */
 220 #define SLAPD_ACI_SET_ATTR              "template"
 221
 222 #define SLAPD_TOP_OID                   "2.5.6.0"
 223
 224 LDAP_SLAPD_V (int) slap_debug;
 225
 226 typedef unsigned long slap_mask_t;
 227
 228 /* Security Strength Factor */
 229 typedef unsigned slap_ssf_t;
 230
 231 typedef struct slap_ssf_set {
 232         slap_ssf_t sss_ssf;
 233         slap_ssf_t sss_transport;
 234         slap_ssf_t sss_tls;
 235         slap_ssf_t sss_sasl;
 236         slap_ssf_t sss_update_ssf;
 237         slap_ssf_t sss_update_transport;
 238         slap_ssf_t sss_update_tls;
 239         slap_ssf_t sss_update_sasl;
 240         slap_ssf_t sss_simple_bind;
 241 } slap_ssf_set_t;
 242
 243 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
 244 #define SLAP_GETDN_AUTHCID 2
 245 #define SLAP_GETDN_AUTHZID 4
 246
 247 /*
 248  * Index types
 249  */
 250 #define SLAP_INDEX_TYPE           0x00FFUL
 251 #define SLAP_INDEX_UNDEFINED      0x0001UL
 252 #define SLAP_INDEX_PRESENT        0x0002UL
 253 #define SLAP_INDEX_EQUALITY       0x0004UL
 254 #define SLAP_INDEX_APPROX         0x0008UL
 255 #define SLAP_INDEX_SUBSTR         0x0010UL
 256 #define SLAP_INDEX_EXTENDED               0x0020UL
 257
 258 #define SLAP_INDEX_DEFAULT        SLAP_INDEX_EQUALITY
 259
 260 #define IS_SLAP_INDEX(mask, type)       (((mask) & (type)) == (type))
 261
 262 #define SLAP_INDEX_SUBSTR_TYPE    0x0F00UL
 263
 264 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
 265 #define SLAP_INDEX_SUBSTR_ANY     ( SLAP_INDEX_SUBSTR | 0x0200UL )
 266 #define SLAP_INDEX_SUBSTR_FINAL   ( SLAP_INDEX_SUBSTR | 0x0400UL )
 267 #define SLAP_INDEX_SUBSTR_DEFAULT \
 268         ( SLAP_INDEX_SUBSTR \
 269         | SLAP_INDEX_SUBSTR_INITIAL \
 270         | SLAP_INDEX_SUBSTR_ANY \
 271         | SLAP_INDEX_SUBSTR_FINAL )
 272
 273 /* defaults for initial/final substring indices */
 274 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT     2
 275 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT     4
 276
 277 /* defaults for any substring indices */
 278 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT               4
 279 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT              2
 280
 281 #define SLAP_INDEX_FLAGS         0xF000UL
 282 #define SLAP_INDEX_NOSUBTYPES    0x1000UL /* don't use index w/ subtypes */
 283 #define SLAP_INDEX_NOTAGS        0x2000UL /* don't use index w/ tags */
 284
 285 /*
 286  * there is a single index for each attribute.  these prefixes ensure
 287  * that there is no collision among keys.
 288  */
 289 #define SLAP_INDEX_EQUALITY_PREFIX      '='     /* prefix for equality keys     */
 290 #define SLAP_INDEX_APPROX_PREFIX        '~'             /* prefix for approx keys       */
 291 #define SLAP_INDEX_SUBSTR_PREFIX        '*'             /* prefix for substring keys    */
 292 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
 293 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
 294 #define SLAP_INDEX_CONT_PREFIX          '.'             /* prefix for continuation keys */
 295
 296 #define SLAP_SYNTAX_MATCHINGRULES_OID    "1.3.6.1.4.1.1466.115.121.1.30"
 297 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID   "1.3.6.1.4.1.1466.115.121.1.3"
 298 #define SLAP_SYNTAX_OBJECTCLASSES_OID    "1.3.6.1.4.1.1466.115.121.1.37"
 299 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
 300 #define SLAP_SYNTAX_CONTENTRULE_OID              "1.3.6.1.4.1.1466.115.121.1.16"
 301
 302 /*
 303  * represents schema information for a database
 304  */
 305 enum {
 306         SLAP_SCHERR_OUTOFMEM = 1,
 307         SLAP_SCHERR_CLASS_NOT_FOUND,
 308         SLAP_SCHERR_CLASS_BAD_USAGE,
 309         SLAP_SCHERR_CLASS_BAD_SUP,
 310         SLAP_SCHERR_CLASS_DUP,
 311         SLAP_SCHERR_CLASS_INCONSISTENT,
 312         SLAP_SCHERR_ATTR_NOT_FOUND,
 313         SLAP_SCHERR_ATTR_BAD_MR,
 314         SLAP_SCHERR_ATTR_BAD_USAGE,
 315         SLAP_SCHERR_ATTR_BAD_SUP,
 316         SLAP_SCHERR_ATTR_INCOMPLETE,
 317         SLAP_SCHERR_ATTR_DUP,
 318         SLAP_SCHERR_ATTR_INCONSISTENT,
 319         SLAP_SCHERR_MR_NOT_FOUND,
 320         SLAP_SCHERR_MR_INCOMPLETE,
 321         SLAP_SCHERR_MR_DUP,
 322         SLAP_SCHERR_SYN_NOT_FOUND,
 323         SLAP_SCHERR_SYN_DUP,
 324         SLAP_SCHERR_NO_NAME,
 325         SLAP_SCHERR_NOT_SUPPORTED,
 326         SLAP_SCHERR_BAD_DESCR,
 327         SLAP_SCHERR_OIDM,
 328         SLAP_SCHERR_CR_DUP,
 329         SLAP_SCHERR_CR_BAD_STRUCT,
 330         SLAP_SCHERR_CR_BAD_AUX,
 331         SLAP_SCHERR_CR_BAD_AT,
 332
 333         SLAP_SCHERR_LAST
 334 };
 335
 336 typedef union slap_sockaddr {
 337         struct sockaddr sa_addr;
 338         struct sockaddr_in sa_in_addr;
 339 #ifdef LDAP_PF_INET6
 340         struct sockaddr_storage sa_storage;
 341         struct sockaddr_in6 sa_in6_addr;
 342 #endif
 343 #ifdef LDAP_PF_LOCAL
 344         struct sockaddr_un sa_un_addr;
 345 #endif
 346 } Sockaddr;
 347
 348 #ifdef LDAP_PF_INET6
 349 extern int slap_inet4or6;
 350 #endif
 351
 352 typedef struct slap_oid_macro {
 353         struct berval som_oid;
 354         BerVarray som_names;
 355         BerVarray som_subs;
 356 #define SLAP_OM_HARDCODE        0x10000U        /* This is hardcoded schema */
 357         int som_flags;
 358         LDAP_STAILQ_ENTRY(slap_oid_macro) som_next;
 359 } OidMacro;
 360
 361 /* forward declarations */
 362 struct slap_syntax;
 363 struct slap_matching_rule;
 364
 365 typedef int slap_syntax_validate_func LDAP_P((
 366         struct slap_syntax *syntax,
 367         struct berval * in));
 368
 369 typedef int slap_syntax_transform_func LDAP_P((
 370         struct slap_syntax *syntax,
 371         struct berval * in,
 372         struct berval * out,
 373         void *memctx));
 374
 375 #ifdef LDAP_COMP_MATCH
 376 typedef void* slap_component_transform_func LDAP_P((
 377         struct berval * in ));
 378 struct ComponentDesc;
 379 #endif
 380
 381 typedef struct slap_syntax {
 382         LDAPSyntax                      ssyn_syn;
 383 #define ssyn_oid                ssyn_syn.syn_oid
 384 #define ssyn_desc               ssyn_syn.syn_desc
 385 #define ssyn_extensions ssyn_syn.syn_extensions
 386         /*
 387          * Note: the former
 388         ber_len_t       ssyn_oidlen;
 389          * has been replaced by a struct berval that uses the value
 390          * provided by ssyn_syn.syn_oid; a macro that expands to
 391          * the bv_len field of the berval is provided for backward
 392          * compatibility.  CAUTION: NEVER FREE THE BERVAL
 393          */
 394         struct berval   ssyn_bvoid;
 395 #define ssyn_oidlen     ssyn_bvoid.bv_len
 396
 397         unsigned int ssyn_flags;
 398
 399 #define SLAP_SYNTAX_NONE        0x0000U
 400 #define SLAP_SYNTAX_BLOB        0x0001U /* syntax treated as blob (audio) */
 401 #define SLAP_SYNTAX_BINARY      0x0002U /* binary transfer required (certificate) */
 402 #define SLAP_SYNTAX_BER         0x0004U /* stored in BER encoding (certificate) */
 403 #ifdef LDAP_DEVEL
 404 #define SLAP_SYNTAX_HIDE        0x0000U /* publish everything */
 405 #else
 406 #define SLAP_SYNTAX_HIDE        0x8000U /* hide (do not publish) */
 407 #endif
 408
 409         slap_syntax_validate_func       *ssyn_validate;
 410         slap_syntax_transform_func      *ssyn_pretty;
 411
 412 #ifdef SLAPD_BINARY_CONVERSION
 413         /* convert to and from binary */
 414         slap_syntax_transform_func      *ssyn_ber2str;
 415         slap_syntax_transform_func      *ssyn_str2ber;
 416 #endif
 417 #ifdef LDAP_COMP_MATCH
 418         slap_component_transform_func *ssyn_attr2comp;
 419         struct ComponentDesc* ssync_comp_syntax;
 420 #endif
 421
 422         LDAP_SLIST_ENTRY(slap_syntax) ssyn_next;
 423 } Syntax;
 424
 425 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
 426 #define slap_syntax_is_blob(s)          slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
 427 #define slap_syntax_is_binary(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
 428 #define slap_syntax_is_ber(s)           slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
 429 #define slap_syntax_is_hidden(s)        slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
 430
 431 typedef struct slap_syntax_defs_rec {
 432         char *sd_desc;
 433         int sd_flags;
 434         slap_syntax_validate_func *sd_validate;
 435         slap_syntax_transform_func *sd_pretty;
 436 #ifdef SLAPD_BINARY_CONVERSION
 437         slap_syntax_transform_func *sd_ber2str;
 438         slap_syntax_transform_func *sd_str2ber;
 439 #endif
 440 } slap_syntax_defs_rec;
 441
 442 /* X -> Y Converter */
 443 typedef int slap_mr_convert_func LDAP_P((
 444         struct berval * in,
 445         struct berval * out,
 446         void *memctx ));
 447
 448 /* Normalizer */
 449 typedef int slap_mr_normalize_func LDAP_P((
 450         slap_mask_t use,
 451         struct slap_syntax *syntax, /* NULL if in is asserted value */
 452         struct slap_matching_rule *mr,
 453         struct berval * in,
 454         struct berval * out,
 455         void *memctx ));
 456
 457 /* Match (compare) function */
 458 typedef int slap_mr_match_func LDAP_P((
 459         int *match,
 460         slap_mask_t use,
 461         struct slap_syntax *syntax,     /* syntax of stored value */
 462         struct slap_matching_rule *mr,
 463         struct berval * value,
 464         void * assertValue ));
 465
 466 /* Index generation function */
 467 typedef int slap_mr_indexer_func LDAP_P((
 468         slap_mask_t use,
 469         slap_mask_t mask,
 470         struct slap_syntax *syntax,     /* syntax of stored value */
 471         struct slap_matching_rule *mr,
 472         struct berval *prefix,
 473         BerVarray values,
 474         BerVarray *keys,
 475         void *memctx ));
 476
 477 /* Filter index function */
 478 typedef int slap_mr_filter_func LDAP_P((
 479         slap_mask_t use,
 480         slap_mask_t mask,
 481         struct slap_syntax *syntax,     /* syntax of stored value */
 482         struct slap_matching_rule *mr,
 483         struct berval *prefix,
 484         void * assertValue,
 485         BerVarray *keys,
 486         void *memctx ));
 487
 488 typedef struct slap_matching_rule_use MatchingRuleUse;
 489
 490 typedef struct slap_matching_rule {
 491         LDAPMatchingRule                smr_mrule;
 492         MatchingRuleUse                 *smr_mru;
 493         /* RFC2252 string representation */
 494         struct berval                   smr_str;
 495         /*
 496          * Note: the former
 497          *                      ber_len_t       smr_oidlen;
 498          * has been replaced by a struct berval that uses the value
 499          * provided by smr_mrule.mr_oid; a macro that expands to
 500          * the bv_len field of the berval is provided for backward
 501          * compatibility.  CAUTION: NEVER FREE THE BERVAL
 502          */
 503         struct berval                   smr_bvoid;
 504 #define smr_oidlen                      smr_bvoid.bv_len
 505
 506         slap_mask_t                             smr_usage;
 507
 508 #ifdef LDAP_DEVEL
 509 #define SLAP_MR_HIDE                    0x0000U
 510 #else
 511 #define SLAP_MR_HIDE                    0x8000U
 512 #endif
 513
 514 #define SLAP_MR_MUTATION_NORMALIZER 0x4000U
 515
 516 #define SLAP_MR_TYPE_MASK               0x0F00U
 517 #define SLAP_MR_SUBTYPE_MASK    0x00F0U
 518 #define SLAP_MR_USAGE                   0x000FU
 519
 520 #define SLAP_MR_NONE                    0x0000U
 521 #define SLAP_MR_EQUALITY                0x0100U
 522 #define SLAP_MR_ORDERING                0x0200U
 523 #define SLAP_MR_SUBSTR                  0x0400U
 524 #define SLAP_MR_EXT                             0x0800U /* implicitly extensible */
 525 #define SLAP_MR_ORDERED_INDEX   0x1000U
 526 #ifdef LDAP_COMP_MATCH
 527 #define SLAP_MR_COMPONENT               0x2000U
 528 #endif
 529
 530 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
 531
 532 #define SLAP_MR_SUBSTR_INITIAL  ( SLAP_MR_SUBSTR | 0x0010U )
 533 #define SLAP_MR_SUBSTR_ANY              ( SLAP_MR_SUBSTR | 0x0020U )
 534 #define SLAP_MR_SUBSTR_FINAL    ( SLAP_MR_SUBSTR | 0x0040U )
 535
 536
 537 /*
 538  * The asserted value, depending on the particular usage,
 539  * is expected to conform to either the assertion syntax
 540  * or the attribute syntax.   In some cases, the syntax of
 541  * the value is known.  If so, these flags indicate which
 542  * syntax the value is expected to conform to.  If not,
 543  * neither of these flags is set (until the syntax of the
 544  * provided value is determined).  If the value is of the
 545  * attribute syntax, the flag is changed once a value of
 546  * the assertion syntax is derived from the provided value.
 547  */
 548 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX       0x0001U
 549 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX       0x0002U
 550 #define SLAP_MR_VALUE_OF_SYNTAX                         0x0003U
 551
 552 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
 553         ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
 554 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
 555         ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
 556 #ifdef LDAP_DEBUG
 557 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
 558         ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
 559 #else
 560 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage )     (1)
 561 #endif
 562
 563 /* either or both the asserted value or attribute value
 564  * may be provided in normalized form
 565  */
 566 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH         0x0004U
 567 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH        0x0008U
 568
 569 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
 570         (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
 571 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
 572         ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
 573
 574 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
 575         (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
 576                 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
 577 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
 578         (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
 579                 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
 580
 581 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
 582         ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
 583 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
 584         ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
 585
 586         Syntax                                  *smr_syntax;
 587         slap_mr_convert_func    *smr_convert;
 588         slap_mr_normalize_func  *smr_normalize;
 589         slap_mr_match_func              *smr_match;
 590         slap_mr_indexer_func    *smr_indexer;
 591         slap_mr_filter_func             *smr_filter;
 592
 593         /*
 594          * null terminated array of syntaxes compatible with this syntax
 595          * note: when MS_EXT is set, this MUST NOT contain the assertion
 596          * syntax of the rule.  When MS_EXT is not set, it MAY.
 597          */
 598         Syntax                                  **smr_compat_syntaxes;
 599
 600         /*
 601          * For equality rules, refers to an associated approximate rule.
 602          * For non-equality rules, refers to an associated equality rule.
 603          */
 604         struct slap_matching_rule       *smr_associated;
 605
 606 #define SLAP_MR_ASSOCIATED(mr,amr)      \
 607         (((mr) == (amr)) || ((mr)->smr_associated == (amr)))
 608
 609         LDAP_SLIST_ENTRY(slap_matching_rule)smr_next;
 610
 611 #define smr_oid                         smr_mrule.mr_oid
 612 #define smr_names                       smr_mrule.mr_names
 613 #define smr_desc                        smr_mrule.mr_desc
 614 #define smr_obsolete            smr_mrule.mr_obsolete
 615 #define smr_syntax_oid          smr_mrule.mr_syntax_oid
 616 #define smr_extensions          smr_mrule.mr_extensions
 617 } MatchingRule;
 618
 619 struct slap_matching_rule_use {
 620         LDAPMatchingRuleUse             smru_mruleuse;
 621         MatchingRule                    *smru_mr;
 622         /* RFC2252 string representation */
 623         struct berval                   smru_str;
 624
 625         LDAP_SLIST_ENTRY(slap_matching_rule_use) smru_next;
 626
 627 #define smru_oid                        smru_mruleuse.mru_oid
 628 #define smru_names                      smru_mruleuse.mru_names
 629 #define smru_desc                       smru_mruleuse.mru_desc
 630 #define smru_obsolete                   smru_mruleuse.mru_obsolete
 631 #define smru_applies_oids               smru_mruleuse.mru_applies_oids
 632
 633 #define smru_usage                      smru_mr->smr_usage
 634 } /* MatchingRuleUse */ ;
 635
 636 typedef struct slap_mrule_defs_rec {
 637         char *                                          mrd_desc;
 638         slap_mask_t                                     mrd_usage;
 639         char **                                         mrd_compat_syntaxes;
 640         slap_mr_convert_func *          mrd_convert;
 641         slap_mr_normalize_func *        mrd_normalize;
 642         slap_mr_match_func *            mrd_match;
 643         slap_mr_indexer_func *          mrd_indexer;
 644         slap_mr_filter_func *           mrd_filter;
 645
 646         /* For equality rule, this may refer to an associated approximate rule */
 647         /* For non-equality rule, this may refer to an associated equality rule */
 648         char *                                          mrd_associated;
 649 } slap_mrule_defs_rec;
 650
 651 struct slap_backend_db;
 652 struct slap_entry;
 653 struct slap_attr;
 654
 655 typedef int (AttributeTypeSchemaCheckFN)(
 656         struct slap_backend_db *be,
 657         struct slap_entry *e,
 658         struct slap_attr *attr,
 659         const char** text,
 660         char *textbuf, size_t textlen );
 661
 662 typedef struct slap_attribute_type {
 663         LDAPAttributeType               sat_atype;
 664         struct berval                   sat_cname;
 665         struct slap_attribute_type      *sat_sup;
 666         struct slap_attribute_type      **sat_subtypes;
 667         MatchingRule                    *sat_equality;
 668         MatchingRule                    *sat_approx;
 669         MatchingRule                    *sat_ordering;
 670         MatchingRule                    *sat_substr;
 671         Syntax                                  *sat_syntax;
 672
 673         AttributeTypeSchemaCheckFN      *sat_check;
 674         char                                    *sat_oidmacro;
 675
 676 #define SLAP_AT_NONE                    0x0000U
 677 #define SLAP_AT_ABSTRACT                0x0100U /* cannot be instantiated */
 678 #define SLAP_AT_FINAL                   0x0200U /* cannot be subtyped */
 679 #ifdef LDAP_DEVEL
 680 #define SLAP_AT_HIDE                    0x0000U /* publish everything */
 681 #else
 682 #define SLAP_AT_HIDE                    0x8000U /* hide attribute */
 683 #endif
 684 #define SLAP_AT_DYNAMIC                 0x0400U /* dynamically generated */
 685
 686 #define SLAP_AT_MANAGEABLE              0x0800U /* no-user-mod can be by-passed */
 687
 688 #define SLAP_AT_ORDERED_VAL             0x0001U /* values are ordered */
 689 #define SLAP_AT_ORDERED_SIB             0x0002U /* siblings are ordered */
 690 #define SLAP_AT_ORDERED                 0x0003U /* value has order index */
 691
 692 #define SLAP_AT_HARDCODE        0x10000U        /* hardcoded schema */
 693
 694         slap_mask_t                                     sat_flags;
 695
 696         LDAP_STAILQ_ENTRY(slap_attribute_type) sat_next;
 697
 698 #define sat_oid                         sat_atype.at_oid
 699 #define sat_names                       sat_atype.at_names
 700 #define sat_desc                        sat_atype.at_desc
 701 #define sat_obsolete            sat_atype.at_obsolete
 702 #define sat_sup_oid                     sat_atype.at_sup_oid
 703 #define sat_equality_oid        sat_atype.at_equality_oid
 704 #define sat_ordering_oid        sat_atype.at_ordering_oid
 705 #define sat_substr_oid          sat_atype.at_substr_oid
 706 #define sat_syntax_oid          sat_atype.at_syntax_oid
 707 #define sat_single_value        sat_atype.at_single_value
 708 #define sat_collective          sat_atype.at_collective
 709 #define sat_no_user_mod         sat_atype.at_no_user_mod
 710 #define sat_usage                       sat_atype.at_usage
 711 #define sat_extensions          sat_atype.at_extensions
 712
 713         struct slap_attr_desc           *sat_ad;
 714         ldap_pvt_thread_mutex_t         sat_ad_mutex;
 715 } AttributeType;
 716
 717 #define is_at_operational(at)   ((at)->sat_usage)
 718 #define is_at_single_value(at)  ((at)->sat_single_value)
 719 #define is_at_collective(at)    ((at)->sat_collective)
 720 #define is_at_obsolete(at)              ((at)->sat_obsolete)
 721 #define is_at_no_user_mod(at)   ((at)->sat_no_user_mod)
 722
 723 struct slap_object_class;
 724
 725 typedef int (ObjectClassSchemaCheckFN)(
 726         struct slap_backend_db *be,
 727         struct slap_entry *e,
 728         struct slap_object_class *oc,
 729         const char** text,
 730         char *textbuf, size_t textlen );
 731
 732 typedef struct slap_object_class {
 733         LDAPObjectClass                 soc_oclass;
 734         struct berval                   soc_cname;
 735         struct slap_object_class        **soc_sups;
 736         AttributeType                           **soc_required;
 737         AttributeType                           **soc_allowed;
 738         ObjectClassSchemaCheckFN        *soc_check;
 739         char                                    *soc_oidmacro;
 740         slap_mask_t                                     soc_flags;
 741 #define soc_oid                         soc_oclass.oc_oid
 742 #define soc_names                       soc_oclass.oc_names
 743 #define soc_desc                        soc_oclass.oc_desc
 744 #define soc_obsolete            soc_oclass.oc_obsolete
 745 #define soc_sup_oids            soc_oclass.oc_sup_oids
 746 #define soc_kind                        soc_oclass.oc_kind
 747 #define soc_at_oids_must        soc_oclass.oc_at_oids_must
 748 #define soc_at_oids_may         soc_oclass.oc_at_oids_may
 749 #define soc_extensions          soc_oclass.oc_extensions
 750
 751         LDAP_STAILQ_ENTRY(slap_object_class) soc_next;
 752 } ObjectClass;
 753
 754 #define SLAP_OCF_SET_FLAGS      0x1
 755 #define SLAP_OCF_CHECK_SUP      0x2
 756 #define SLAP_OCF_MASK           (SLAP_OCF_SET_FLAGS|SLAP_OCF_CHECK_SUP)
 757
 758 #define SLAP_OC_ALIAS           0x0001
 759 #define SLAP_OC_REFERRAL        0x0002
 760 #define SLAP_OC_SUBENTRY        0x0004
 761 #define SLAP_OC_DYNAMICOBJECT   0x0008
 762 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY     0x0010
 763 #define SLAP_OC_GLUE            0x0020
 764 #define SLAP_OC_SYNCPROVIDERSUBENTRY            0x0040
 765 #define SLAP_OC_SYNCCONSUMERSUBENTRY            0x0080
 766 #define SLAP_OC__MASK           0x00FF
 767 #define SLAP_OC__END            0x0100
 768 #define SLAP_OC_OPERATIONAL     0x4000
 769 #ifdef LDAP_DEVEL
 770 #define SLAP_OC_HIDE            0x0000
 771 #else
 772 #define SLAP_OC_HIDE            0x8000
 773 #endif
 774 #define SLAP_OC_HARDCODE        0x10000U        /* This is hardcoded schema */
 775
 776 /*
 777  * DIT content rule
 778  */
 779 typedef struct slap_content_rule {
 780         LDAPContentRule         scr_crule;
 781         ObjectClass                     *scr_sclass;
 782         ObjectClass                     **scr_auxiliaries;      /* optional */
 783         AttributeType           **scr_required;         /* optional */
 784         AttributeType           **scr_allowed;          /* optional */
 785         AttributeType           **scr_precluded;        /* optional */
 786 #define scr_oid                         scr_crule.cr_oid
 787 #define scr_names                       scr_crule.cr_names
 788 #define scr_desc                        scr_crule.cr_desc
 789 #define scr_obsolete            scr_crule.cr_obsolete
 790 #define scr_oc_oids_aux         scr_crule.cr_oc_oids_aux
 791 #define scr_at_oids_must        scr_crule.cr_at_oids_must
 792 #define scr_at_oids_may         scr_crule.cr_at_oids_may
 793 #define scr_at_oids_not         scr_crule.cr_at_oids_not
 794
 795         char                            *scr_oidmacro;
 796 #define         SLAP_CR_HARDCODE        0x10000U
 797         int     scr_flags;
 798
 799         LDAP_STAILQ_ENTRY( slap_content_rule ) scr_next;
 800 } ContentRule;
 801
 802 /* Represents a recognized attribute description ( type + options ). */
 803 typedef struct slap_attr_desc {
 804         struct slap_attr_desc *ad_next;
 805         AttributeType *ad_type;         /* attribute type, must be specified */
 806         struct berval ad_cname;         /* canonical name, must be specified */
 807         struct berval ad_tags;          /* empty if no tagging options */
 808         unsigned ad_flags;
 809 #define SLAP_DESC_NONE                  0x00U
 810 #define SLAP_DESC_BINARY                0x01U
 811 #define SLAP_DESC_TAG_RANGE             0x80U
 812 } AttributeDescription;
 813
 814 /* flags to slap_*2undef_ad to register undefined (0, the default)
 815  * or proxied (SLAP_AD_PROXIED) AttributeDescriptions; the additional
 816  * SLAP_AD_NOINSERT is to lookup without insert */
 817 #define SLAP_AD_UNDEF                   0x00U
 818 #define SLAP_AD_PROXIED                 0x01U
 819 #define SLAP_AD_NOINSERT                0x02U
 820
 821 typedef struct slap_attr_name {
 822         struct berval an_name;
 823         AttributeDescription *an_desc;
 824         int an_oc_exclude;
 825         ObjectClass *an_oc;
 826 } AttributeName;
 827
 828 #define slap_ad_is_tagged(ad)                   ( (ad)->ad_tags.bv_len != 0 )
 829 #define slap_ad_is_tag_range(ad)        \
 830         ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
 831 #define slap_ad_is_binary(ad)           \
 832         ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
 833
 834 /*
 835  * pointers to schema elements used internally
 836  */
 837 struct slap_internal_schema {
 838         /* objectClass */
 839         ObjectClass *si_oc_top;
 840         ObjectClass *si_oc_extensibleObject;
 841         ObjectClass *si_oc_alias;
 842         ObjectClass *si_oc_referral;
 843         ObjectClass *si_oc_rootdse;
 844         ObjectClass *si_oc_subentry;
 845         ObjectClass *si_oc_subschema;
 846         ObjectClass *si_oc_collectiveAttributeSubentry;
 847         ObjectClass *si_oc_dynamicObject;
 848
 849         ObjectClass *si_oc_glue;
 850         ObjectClass *si_oc_syncConsumerSubentry;
 851         ObjectClass *si_oc_syncProviderSubentry;
 852
 853         /* objectClass attribute descriptions */
 854         AttributeDescription *si_ad_objectClass;
 855
 856         /* operational attribute descriptions */
 857         AttributeDescription *si_ad_structuralObjectClass;
 858         AttributeDescription *si_ad_creatorsName;
 859         AttributeDescription *si_ad_createTimestamp;
 860         AttributeDescription *si_ad_modifiersName;
 861         AttributeDescription *si_ad_modifyTimestamp;
 862         AttributeDescription *si_ad_hasSubordinates;
 863         AttributeDescription *si_ad_subschemaSubentry;
 864         AttributeDescription *si_ad_collectiveSubentries;
 865         AttributeDescription *si_ad_collectiveExclusions;
 866         AttributeDescription *si_ad_entryDN;
 867         AttributeDescription *si_ad_entryUUID;
 868         AttributeDescription *si_ad_entryCSN;
 869         AttributeDescription *si_ad_namingCSN;
 870
 871         AttributeDescription *si_ad_dseType;
 872         AttributeDescription *si_ad_syncreplCookie;
 873         AttributeDescription *si_ad_syncTimestamp;
 874         AttributeDescription *si_ad_contextCSN;
 875
 876         /* root DSE attribute descriptions */
 877         AttributeDescription *si_ad_altServer;
 878         AttributeDescription *si_ad_namingContexts;
 879         AttributeDescription *si_ad_supportedControl;
 880         AttributeDescription *si_ad_supportedExtension;
 881         AttributeDescription *si_ad_supportedLDAPVersion;
 882         AttributeDescription *si_ad_supportedSASLMechanisms;
 883         AttributeDescription *si_ad_supportedFeatures;
 884         AttributeDescription *si_ad_monitorContext;
 885         AttributeDescription *si_ad_vendorName;
 886         AttributeDescription *si_ad_vendorVersion;
 887         AttributeDescription *si_ad_configContext;
 888
 889         /* subentry attribute descriptions */
 890         AttributeDescription *si_ad_administrativeRole;
 891         AttributeDescription *si_ad_subtreeSpecification;
 892
 893         /* subschema subentry attribute descriptions */
 894         AttributeDescription *si_ad_attributeTypes;
 895         AttributeDescription *si_ad_ditContentRules;
 896         AttributeDescription *si_ad_ditStructureRules;
 897         AttributeDescription *si_ad_ldapSyntaxes;
 898         AttributeDescription *si_ad_matchingRules;
 899         AttributeDescription *si_ad_matchingRuleUse;
 900         AttributeDescription *si_ad_nameForms;
 901         AttributeDescription *si_ad_objectClasses;
 902
 903         /* Aliases & Referrals */
 904         AttributeDescription *si_ad_aliasedObjectName;
 905         AttributeDescription *si_ad_ref;
 906
 907         /* Access Control Internals */
 908         AttributeDescription *si_ad_entry;
 909         AttributeDescription *si_ad_children;
 910         AttributeDescription *si_ad_saslAuthzTo;
 911         AttributeDescription *si_ad_saslAuthzFrom;
 912
 913         /* dynamic entries */
 914         AttributeDescription *si_ad_entryTtl;
 915         AttributeDescription *si_ad_dynamicSubtrees;
 916
 917         /* Other attributes descriptions */
 918         AttributeDescription *si_ad_distinguishedName;
 919         AttributeDescription *si_ad_name;
 920         AttributeDescription *si_ad_cn;
 921         AttributeDescription *si_ad_uid;
 922         AttributeDescription *si_ad_uidNumber;
 923         AttributeDescription *si_ad_gidNumber;
 924         AttributeDescription *si_ad_userPassword;
 925         AttributeDescription *si_ad_labeledURI;
 926 #ifdef SLAPD_AUTHPASSWD
 927         AttributeDescription *si_ad_authPassword;
 928         AttributeDescription *si_ad_authPasswordSchemes;
 929 #endif
 930 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
 931         AttributeDescription *si_ad_krbName;
 932 #endif
 933         AttributeDescription *si_ad_description;
 934         AttributeDescription *si_ad_seeAlso;
 935
 936         /* Undefined Attribute Type */
 937         AttributeType   *si_at_undefined;
 938
 939         /* "Proxied" Attribute Type */
 940         AttributeType   *si_at_proxied;
 941
 942         /* Matching Rules */
 943         MatchingRule    *si_mr_distinguishedNameMatch;
 944         MatchingRule    *si_mr_dnSubtreeMatch;
 945         MatchingRule    *si_mr_dnOneLevelMatch;
 946         MatchingRule    *si_mr_dnSubordinateMatch;
 947         MatchingRule    *si_mr_dnSuperiorMatch;
 948         MatchingRule    *si_mr_caseExactMatch;
 949         MatchingRule    *si_mr_caseExactSubstringsMatch;
 950         MatchingRule    *si_mr_caseExactIA5Match;
 951         MatchingRule    *si_mr_integerMatch;
 952         MatchingRule    *si_mr_integerFirstComponentMatch;
 953         MatchingRule    *si_mr_objectIdentifierFirstComponentMatch;
 954
 955         /* Syntaxes */
 956         Syntax          *si_syn_directoryString;
 957         Syntax          *si_syn_distinguishedName;
 958         Syntax          *si_syn_integer;
 959         Syntax          *si_syn_octetString;
 960
 961         /* Schema Syntaxes */
 962         Syntax          *si_syn_attributeTypeDesc;
 963         Syntax          *si_syn_ditContentRuleDesc;
 964         Syntax          *si_syn_ditStructureRuleDesc;
 965         Syntax          *si_syn_ldapSyntaxDesc;
 966         Syntax          *si_syn_matchingRuleDesc;
 967         Syntax          *si_syn_matchingRuleUseDesc;
 968         Syntax          *si_syn_nameFormDesc;
 969         Syntax          *si_syn_objectClassDesc;
 970 };
 971
 972 typedef struct slap_attr_assertion {
 973         AttributeDescription    *aa_desc;
 974         struct berval aa_value;
 975 #ifdef LDAP_COMP_MATCH
 976         struct slap_component_filter *aa_cf;/* for attribute aliasing */
 977 #endif
 978 } AttributeAssertion;
 979
 980 typedef struct slap_ss_assertion {
 981         AttributeDescription    *sa_desc;
 982         struct berval           sa_initial;
 983         struct berval           *sa_any;
 984         struct berval           sa_final;
 985 } SubstringsAssertion;
 986
 987 #ifdef LDAP_COMP_MATCH
 988 struct slap_component_filter;
 989 #endif
 990
 991 typedef struct slap_mr_assertion {
 992         MatchingRule            *ma_rule;       /* optional */
 993         struct berval           ma_rule_text;  /* optional */
 994         AttributeDescription    *ma_desc;       /* optional */
 995         int                                             ma_dnattrs; /* boolean */
 996         struct berval           ma_value;       /* required */
 997 #ifdef LDAP_COMP_MATCH
 998         struct slap_component_filter* ma_cf; /* component filter */
 999 #endif
1000 } MatchingRuleAssertion;
1001
1002 /*
1003  * represents a search filter
1004  */
1005 typedef struct slap_filter {
1006         ber_tag_t       f_choice;       /* values taken from ldap.h, plus: */
1007 #define SLAPD_FILTER_COMPUTED           ((ber_tag_t) -1)
1008 #define SLAPD_FILTER_DN_ONE                     ((ber_tag_t) -2)
1009 #define SLAPD_FILTER_DN_SUBTREE         ((ber_tag_t) -3)
1010 #define SLAPD_FILTER_DN_CHILDREN        ((ber_tag_t) -4)
1011
1012         union f_un_u {
1013                 /* precomputed result */
1014                 ber_int_t f_un_result;
1015
1016                 /* DN */
1017                 struct berval *f_un_dn;
1018
1019                 /* present */
1020                 AttributeDescription *f_un_desc;
1021
1022                 /* simple value assertion */
1023                 AttributeAssertion *f_un_ava;
1024
1025                 /* substring assertion */
1026                 SubstringsAssertion *f_un_ssa;
1027
1028                 /* matching rule assertion */
1029                 MatchingRuleAssertion *f_un_mra;
1030
1031 #define f_dn                    f_un.f_un_dn
1032 #define f_desc                  f_un.f_un_desc
1033 #define f_ava                   f_un.f_un_ava
1034 #define f_av_desc               f_un.f_un_ava->aa_desc
1035 #define f_av_value              f_un.f_un_ava->aa_value
1036 #define f_sub                   f_un.f_un_ssa
1037 #define f_sub_desc              f_un.f_un_ssa->sa_desc
1038 #define f_sub_initial   f_un.f_un_ssa->sa_initial
1039 #define f_sub_any               f_un.f_un_ssa->sa_any
1040 #define f_sub_final             f_un.f_un_ssa->sa_final
1041 #define f_mra                   f_un.f_un_mra
1042 #define f_mr_rule               f_un.f_un_mra->ma_rule
1043 #define f_mr_rule_text  f_un.f_un_mra->ma_rule_text
1044 #define f_mr_desc               f_un.f_un_mra->ma_desc
1045 #define f_mr_value              f_un.f_un_mra->ma_value
1046 #define f_mr_dnattrs    f_un.f_un_mra->ma_dnattrs
1047
1048                 /* and, or, not */
1049                 struct slap_filter *f_un_complex;
1050         } f_un;
1051
1052 #define f_result        f_un.f_un_result
1053 #define f_and           f_un.f_un_complex
1054 #define f_or            f_un.f_un_complex
1055 #define f_not           f_un.f_un_complex
1056 #define f_list          f_un.f_un_complex
1057
1058         struct slap_filter      *f_next;
1059 } Filter;
1060
1061 /* compare routines can return undefined */
1062 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
1063
1064 typedef struct slap_valuesreturnfilter {
1065         ber_tag_t       vrf_choice;
1066
1067         union vrf_un_u {
1068                 /* precomputed result */
1069                 ber_int_t vrf_un_result;
1070
1071                 /* DN */
1072                 char *vrf_un_dn;
1073
1074                 /* present */
1075                 AttributeDescription *vrf_un_desc;
1076
1077                 /* simple value assertion */
1078                 AttributeAssertion *vrf_un_ava;
1079
1080                 /* substring assertion */
1081                 SubstringsAssertion *vrf_un_ssa;
1082
1083                 /* matching rule assertion */
1084                 MatchingRuleAssertion *vrf_un_mra;
1085
1086 #define vrf_result              vrf_un.vrf_un_result
1087 #define vrf_dn                  vrf_un.vrf_un_dn
1088 #define vrf_desc                vrf_un.vrf_un_desc
1089 #define vrf_ava                 vrf_un.vrf_un_ava
1090 #define vrf_av_desc             vrf_un.vrf_un_ava->aa_desc
1091 #define vrf_av_value    vrf_un.vrf_un_ava->aa_value
1092 #define vrf_ssa                 vrf_un.vrf_un_ssa
1093 #define vrf_sub                 vrf_un.vrf_un_ssa
1094 #define vrf_sub_desc    vrf_un.vrf_un_ssa->sa_desc
1095 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1096 #define vrf_sub_any             vrf_un.vrf_un_ssa->sa_any
1097 #define vrf_sub_final   vrf_un.vrf_un_ssa->sa_final
1098 #define vrf_mra                 vrf_un.vrf_un_mra
1099 #define vrf_mr_rule             vrf_un.vrf_un_mra->ma_rule
1100 #define vrf_mr_rule_text        vrf_un.vrf_un_mra->ma_rule_text
1101 #define vrf_mr_desc             vrf_un.vrf_un_mra->ma_desc
1102 #define vrf_mr_value            vrf_un.vrf_un_mra->ma_value
1103 #define vrf_mr_dnattrs  vrf_un.vrf_un_mra->ma_dnattrs
1104
1105
1106         } vrf_un;
1107
1108         struct slap_valuesreturnfilter  *vrf_next;
1109 } ValuesReturnFilter;
1110
1111 #ifdef LDAP_COMP_MATCH
1112 struct slap_component_syntax_info;
1113 typedef struct  slap_component_data {
1114         void* cd_mem_op;/* nibble memory handler */
1115         struct slap_component_syntax_info** cd_tree;/* component tree */
1116 } ComponentData;
1117 #endif
1118
1119 /*
1120  * represents an attribute (description + values)
1121  */
1122 typedef struct slap_attr {
1123         AttributeDescription *a_desc;
1124         BerVarray       a_vals;         /* preserved values */
1125         BerVarray       a_nvals;        /* normalized values */
1126 #ifdef LDAP_COMP_MATCH
1127         ComponentData   *a_comp_data; /* component values */
1128 #endif
1129         struct slap_attr *a_next;
1130         unsigned a_flags;
1131 #define SLAP_ATTR_IXADD         0x1U
1132 #define SLAP_ATTR_IXDEL         0x2U
1133 } Attribute;
1134
1135
1136 /*
1137  * the id used in the indexes to refer to an entry
1138  */
1139 typedef unsigned long   ID;
1140 #define NOID    ((ID)~0)
1141
1142 /*
1143  * represents an entry in core
1144  */
1145 typedef struct slap_entry {
1146         /*
1147          * The ID field should only be changed before entry is
1148          * inserted into a cache.  The ID value is backend
1149          * specific.
1150          */
1151         ID              e_id;
1152
1153         struct berval e_name;   /* name (DN) of this entry */
1154         struct berval e_nname;  /* normalized name (DN) of this entry */
1155
1156         /* for migration purposes */
1157 #define e_dn e_name.bv_val
1158 #define e_ndn e_nname.bv_val
1159
1160         Attribute       *e_attrs;       /* list of attributes + values */
1161
1162         slap_mask_t     e_ocflags;
1163
1164         struct berval   e_bv;           /* For entry_encode/entry_decode */
1165
1166         /* for use by the backend for any purpose */
1167         void*   e_private;
1168 } Entry;
1169
1170 /*
1171  * A list of LDAPMods
1172  */
1173 typedef struct slap_mod {
1174         short sm_op;
1175         short sm_flags;
1176 /* Set for internal mods, will bypass ACL checks. Only needed when
1177  * running as non-root user, for user modifiable attributes.
1178  */
1179 #define SLAP_MOD_INTERNAL       0x01
1180 #define SLAP_MOD_MANAGING       0x02
1181
1182         AttributeDescription *sm_desc;
1183         struct berval sm_type;
1184         BerVarray sm_values;
1185         BerVarray sm_nvalues;
1186 } Modification;
1187
1188 typedef struct slap_mod_list {
1189         Modification sml_mod;
1190 #define sml_op          sml_mod.sm_op
1191 #define sml_flags       sml_mod.sm_flags
1192 #define sml_desc        sml_mod.sm_desc
1193 #define sml_type        sml_mod.sm_type
1194 #define sml_values      sml_mod.sm_values
1195 #define sml_nvalues     sml_mod.sm_nvalues
1196         struct slap_mod_list *sml_next;
1197 } Modifications;
1198
1199 typedef struct slap_ldap_modlist {
1200         LDAPMod ml_mod;
1201         struct slap_ldap_modlist *ml_next;
1202 #define ml_op           ml_mod.mod_op
1203 #define ml_type         ml_mod.mod_type
1204 #define ml_values       ml_mod.mod_values
1205 } LDAPModList;
1206
1207 /*
1208  * represents an access control list
1209  */
1210 typedef enum slap_access_e {
1211         ACL_INVALID_ACCESS = -1,
1212         ACL_NONE = 0,
1213         ACL_DISCLOSE,
1214         ACL_AUTH,
1215         ACL_COMPARE,
1216         ACL_SEARCH,
1217         ACL_READ,
1218         ACL_WRITE_,
1219         ACL_MANAGE,
1220
1221         /* always leave at end of levels but not greater than ACL_LEVEL_MASK */
1222         ACL_LAST,
1223
1224         /* ACL level mask and modifiers */
1225         ACL_LEVEL_MASK = 0x000f,
1226         ACL_QUALIFIER1 = 0x0100,
1227         ACL_QUALIFIER2 = 0x0200,
1228         ACL_QUALIFIER3 = 0x0400,
1229         ACL_QUALIFIER4 = 0x0800,
1230         ACL_QUALIFIER_MASK = 0x0f00,
1231
1232         /* write granularity */
1233         ACL_WADD = ACL_WRITE_|ACL_QUALIFIER1,
1234         ACL_WDEL = ACL_WRITE_|ACL_QUALIFIER2,
1235
1236         ACL_WRITE = ACL_WADD|ACL_WDEL
1237 } slap_access_t;
1238
1239 typedef enum slap_control_e {
1240         ACL_INVALID_CONTROL     = 0,
1241         ACL_STOP,
1242         ACL_CONTINUE,
1243         ACL_BREAK
1244 } slap_control_t;
1245
1246 typedef enum slap_style_e {
1247         ACL_STYLE_REGEX = 0,
1248         ACL_STYLE_EXPAND,
1249         ACL_STYLE_BASE,
1250         ACL_STYLE_ONE,
1251         ACL_STYLE_SUBTREE,
1252         ACL_STYLE_CHILDREN,
1253         ACL_STYLE_LEVEL,
1254         ACL_STYLE_ATTROF,
1255         ACL_STYLE_ANONYMOUS,
1256         ACL_STYLE_USERS,
1257         ACL_STYLE_SELF,
1258         ACL_STYLE_IP,
1259         ACL_STYLE_PATH
1260 } slap_style_t;
1261
1262 typedef struct slap_authz_info {
1263         ber_tag_t       sai_method;                     /* LDAP_AUTH_* from <ldap.h> */
1264         struct berval   sai_mech;               /* SASL Mechanism */
1265         struct berval   sai_dn;                 /* DN for reporting purposes */
1266         struct berval   sai_ndn;                /* Normalized DN */
1267
1268         /* Security Strength Factors */
1269         slap_ssf_t      sai_ssf;                        /* Overall SSF */
1270         slap_ssf_t      sai_transport_ssf;      /* Transport SSF */
1271         slap_ssf_t      sai_tls_ssf;            /* TLS SSF */
1272         slap_ssf_t      sai_sasl_ssf;           /* SASL SSF */
1273 } AuthorizationInformation;
1274
1275
1276 #ifdef SLAP_DYNACL
1277 struct slap_op;
1278
1279 /*
1280  * "dynamic" ACL infrastructure (for ACIs and more)
1281  */
1282 typedef int (slap_dynacl_parse) LDAP_P(( const char *fname, int lineno,
1283         const char *opts, slap_style_t, const char *, void **privp ));
1284 typedef int (slap_dynacl_unparse) LDAP_P(( void *priv, struct berval *bv ));
1285 typedef int (slap_dynacl_mask) LDAP_P((
1286                 void                    *priv,
1287                 struct slap_op          *op,
1288                 Entry                   *e,
1289                 AttributeDescription    *desc,
1290                 struct berval           *val,
1291                 int                     nmatch,
1292                 regmatch_t              *matches,
1293                 slap_access_t           *grant,
1294                 slap_access_t           *deny ));
1295 typedef int (slap_dynacl_destroy) LDAP_P(( void *priv ));
1296
1297 typedef struct slap_dynacl_t {
1298         char                    *da_name;
1299         slap_dynacl_parse       *da_parse;
1300         slap_dynacl_unparse     *da_unparse;
1301         slap_dynacl_mask        *da_mask;
1302         slap_dynacl_destroy     *da_destroy;
1303
1304         void                    *da_private;
1305         struct slap_dynacl_t    *da_next;
1306 } slap_dynacl_t;
1307 #endif /* SLAP_DYNACL */
1308
1309 /* the DN portion of the "by" part */
1310 typedef struct slap_dn_access {
1311         /* DN pattern */
1312         AuthorizationInformation        a_dnauthz;
1313 #define a_pat                   a_dnauthz.sai_dn
1314
1315         slap_style_t            a_style;
1316         int                     a_level;
1317         int                     a_self_level;
1318         AttributeDescription    *a_at;
1319         int                     a_self;
1320         int                     a_expand;
1321 } slap_dn_access;
1322
1323 /* the "by" part */
1324 typedef struct slap_access {
1325         slap_control_t a_type;
1326
1327 /* strip qualifiers */
1328 #define ACL_LEVEL(p)                    ((p) & ACL_LEVEL_MASK)
1329 #define ACL_QUALIFIERS(p)               ((p) & ~ACL_LEVEL_MASK)
1330
1331 #define ACL_ACCESS2PRIV(access)         ((0x01U << ACL_LEVEL((access))) | ACL_QUALIFIERS((access)))
1332
1333 #define ACL_PRIV_NONE                   ACL_ACCESS2PRIV( ACL_NONE )
1334 #define ACL_PRIV_DISCLOSE               ACL_ACCESS2PRIV( ACL_DISCLOSE )
1335 #define ACL_PRIV_AUTH                   ACL_ACCESS2PRIV( ACL_AUTH )
1336 #define ACL_PRIV_COMPARE                ACL_ACCESS2PRIV( ACL_COMPARE )
1337 #define ACL_PRIV_SEARCH                 ACL_ACCESS2PRIV( ACL_SEARCH )
1338 #define ACL_PRIV_READ                   ACL_ACCESS2PRIV( ACL_READ )
1339 #define ACL_PRIV_WADD                   ACL_ACCESS2PRIV( ACL_WADD )
1340 #define ACL_PRIV_WDEL                   ACL_ACCESS2PRIV( ACL_WDEL )
1341 #define ACL_PRIV_WRITE                  ( ACL_PRIV_WADD | ACL_PRIV_WDEL )
1342 #define ACL_PRIV_MANAGE                 ACL_ACCESS2PRIV( ACL_MANAGE )
1343
1344 /* NOTE: always use the highest level; current: 0x00ffUL */
1345 #define ACL_PRIV_MASK                   ((ACL_ACCESS2PRIV(ACL_LAST) - 1) | ACL_QUALIFIER_MASK)
1346
1347 /* priv flags */
1348 #define ACL_PRIV_LEVEL                  0x1000UL
1349 #define ACL_PRIV_ADDITIVE               0x2000UL
1350 #define ACL_PRIV_SUBSTRACTIVE           0x4000UL
1351
1352 /* invalid privs */
1353 #define ACL_PRIV_INVALID                0x0UL
1354
1355 #define ACL_PRIV_ISSET(m,p)             (((m) & (p)) == (p))
1356 #define ACL_PRIV_ASSIGN(m,p)            do { (m)  =  (p); } while(0)
1357 #define ACL_PRIV_SET(m,p)               do { (m) |=  (p); } while(0)
1358 #define ACL_PRIV_CLR(m,p)               do { (m) &= ~(p); } while(0)
1359
1360 #define ACL_INIT(m)                     ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
1361 #define ACL_INVALIDATE(m)               ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
1362
1363 #define ACL_GRANT(m,a)                  ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1364
1365 #define ACL_IS_INVALID(m)               ((m) == ACL_PRIV_INVALID)
1366
1367 #define ACL_IS_LEVEL(m)                 ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1368 #define ACL_IS_ADDITIVE(m)              ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1369 #define ACL_IS_SUBTRACTIVE(m)           ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1370
1371 #define ACL_LVL_NONE                    (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1372 #define ACL_LVL_DISCLOSE                (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1373 #define ACL_LVL_AUTH                    (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1374 #define ACL_LVL_COMPARE                 (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1375 #define ACL_LVL_SEARCH                  (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1376 #define ACL_LVL_READ                    (ACL_PRIV_READ|ACL_LVL_SEARCH)
1377 #define ACL_LVL_WADD                    (ACL_PRIV_WADD|ACL_LVL_READ)
1378 #define ACL_LVL_WDEL                    (ACL_PRIV_WDEL|ACL_LVL_READ)
1379 #define ACL_LVL_WRITE                   (ACL_PRIV_WRITE|ACL_LVL_READ)
1380 #define ACL_LVL_MANAGE                  (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1381
1382 #define ACL_LVL(m,l)                    (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1383 #define ACL_LVL_IS_NONE(m)              ACL_LVL((m),ACL_LVL_NONE)
1384 #define ACL_LVL_IS_DISCLOSE(m)          ACL_LVL((m),ACL_LVL_DISCLOSE)
1385 #define ACL_LVL_IS_AUTH(m)              ACL_LVL((m),ACL_LVL_AUTH)
1386 #define ACL_LVL_IS_COMPARE(m)           ACL_LVL((m),ACL_LVL_COMPARE)
1387 #define ACL_LVL_IS_SEARCH(m)            ACL_LVL((m),ACL_LVL_SEARCH)
1388 #define ACL_LVL_IS_READ(m)              ACL_LVL((m),ACL_LVL_READ)
1389 #define ACL_LVL_IS_WADD(m)              ACL_LVL((m),ACL_LVL_WADD)
1390 #define ACL_LVL_IS_WDEL(m)              ACL_LVL((m),ACL_LVL_WDEL)
1391 #define ACL_LVL_IS_WRITE(m)             ACL_LVL((m),ACL_LVL_WRITE)
1392 #define ACL_LVL_IS_MANAGE(m)            ACL_LVL((m),ACL_LVL_MANAGE)
1393
1394 #define ACL_LVL_ASSIGN_NONE(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1395 #define ACL_LVL_ASSIGN_DISCLOSE(m)      ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1396 #define ACL_LVL_ASSIGN_AUTH(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1397 #define ACL_LVL_ASSIGN_COMPARE(m)       ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1398 #define ACL_LVL_ASSIGN_SEARCH(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1399 #define ACL_LVL_ASSIGN_READ(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1400 #define ACL_LVL_ASSIGN_WADD(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_WADD)
1401 #define ACL_LVL_ASSIGN_WDEL(m)          ACL_PRIV_ASSIGN((m),ACL_LVL_WDEL)
1402 #define ACL_LVL_ASSIGN_WRITE(m)         ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1403 #define ACL_LVL_ASSIGN_MANAGE(m)        ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1404
1405         slap_mask_t     a_access_mask;
1406
1407         /* DN pattern */
1408         slap_dn_access          a_dn;
1409 #define a_dn_pat                a_dn.a_dnauthz.sai_dn
1410 #define a_dn_at                 a_dn.a_at
1411 #define a_dn_self               a_dn.a_self
1412
1413         /* real DN pattern */
1414         slap_dn_access          a_realdn;
1415 #define a_realdn_pat            a_realdn.a_dnauthz.sai_dn
1416 #define a_realdn_at             a_realdn.a_at
1417 #define a_realdn_self           a_realdn.a_self
1418
1419         /* used for ssf stuff
1420          * NOTE: the ssf stuff in a_realdn is ignored */
1421 #define a_authz                 a_dn.a_dnauthz
1422
1423         /* connection related stuff */
1424         slap_style_t a_peername_style;
1425         struct berval   a_peername_pat;
1426         unsigned long   a_peername_addr,
1427                         a_peername_mask;
1428         int             a_peername_port;
1429
1430         slap_style_t a_sockname_style;
1431         struct berval   a_sockname_pat;
1432
1433         slap_style_t a_domain_style;
1434         struct berval   a_domain_pat;
1435         int             a_domain_expand;
1436
1437         slap_style_t a_sockurl_style;
1438         struct berval   a_sockurl_pat;
1439         slap_style_t a_set_style;
1440         struct berval   a_set_pat;
1441
1442 #ifdef SLAP_DYNACL
1443         slap_dynacl_t           *a_dynacl;
1444 #else /* ! SLAP_DYNACL */
1445 #ifdef SLAPD_ACI_ENABLED
1446         /* NOTE: ACIs have been moved under the "dynacl" interface,
1447          * which is currently built only when LDAP_DEVEL is defined.
1448          *
1449          * In any case, SLAPD_ACI_ENABLED, set by --enable-aci,
1450          * is required to enable ACI support.
1451          */
1452         AttributeDescription    *a_aci_at;
1453 #endif /* SLAPD_ACI_ENABLED */
1454 #endif /* SLAP_DYNACL */
1455
1456         /* ACL Groups */
1457         slap_style_t a_group_style;
1458         struct berval   a_group_pat;
1459         ObjectClass                             *a_group_oc;
1460         AttributeDescription    *a_group_at;
1461
1462         struct slap_access      *a_next;
1463 } Access;
1464
1465 /* the "to" part */
1466 typedef struct slap_acl {
1467         /* "to" part: the entries this acl applies to */
1468         Filter          *acl_filter;
1469         slap_style_t acl_dn_style;
1470         regex_t         acl_dn_re;
1471         struct berval   acl_dn_pat;
1472         AttributeName   *acl_attrs;
1473         MatchingRule    *acl_attrval_mr;
1474         slap_style_t    acl_attrval_style;
1475         regex_t         acl_attrval_re;
1476         struct berval   acl_attrval;
1477
1478         /* "by" part: list of who has what access to the entries */
1479         Access  *acl_access;
1480
1481         struct slap_acl *acl_next;
1482 } AccessControl;
1483
1484 typedef struct slap_acl_state {
1485         unsigned as_recorded;
1486 #define ACL_STATE_NOT_RECORDED                  0x0
1487 #define ACL_STATE_RECORDED_VD                   0x1
1488 #define ACL_STATE_RECORDED_NV                   0x2
1489 #define ACL_STATE_RECORDED                              0x3
1490
1491         /* Access state */
1492         AccessControl *as_vd_acl;
1493         AccessControl *as_vi_acl;
1494         slap_mask_t as_vd_acl_mask;
1495         regmatch_t as_vd_acl_matches[MAXREMATCHES];
1496         int as_vd_acl_count;
1497
1498         Access *as_vd_access;
1499         int as_vd_access_count;
1500
1501         int as_result;
1502         AttributeDescription *as_vd_ad;
1503 } AccessControlState;
1504 #define ACL_STATE_INIT { ACL_STATE_NOT_RECORDED, NULL, NULL, 0UL, \
1505         { { 0, 0 } }, 0, NULL, 0, 0, NULL }
1506
1507 #ifdef SLAPD_ACI_ENABLED
1508 typedef enum slap_aci_scope_t {
1509         SLAP_ACI_SCOPE_ENTRY            = 0x1,
1510         SLAP_ACI_SCOPE_CHILDREN         = 0x2,
1511         SLAP_ACI_SCOPE_SUBTREE          = ( SLAP_ACI_SCOPE_ENTRY | SLAP_ACI_SCOPE_CHILDREN )
1512 } slap_aci_scope_t;
1513 #endif /* SLAPD_ACI_ENABLED */
1514
1515 /*
1516  * Backend-info
1517  * represents a backend
1518  */
1519
1520 typedef struct slap_backend_info BackendInfo;   /* per backend type */
1521 typedef struct slap_backend_db BackendDB;               /* per backend database */
1522 typedef LDAP_STAILQ_HEAD(BeI, slap_backend_info) slap_bi_head;
1523 typedef LDAP_STAILQ_HEAD(BeDB, slap_backend_db) slap_be_head;
1524
1525 LDAP_SLAPD_V (int) nBackendInfo;
1526 LDAP_SLAPD_V (int) nBackendDB;
1527 LDAP_SLAPD_V (slap_bi_head) backendInfo;
1528 LDAP_SLAPD_V (slap_be_head) backendDB;
1529 LDAP_SLAPD_V (BackendDB *) frontendDB;
1530
1531 LDAP_SLAPD_V (int) slapMode;
1532 #define SLAP_UNDEFINED_MODE     0x0000
1533 #define SLAP_SERVER_MODE        0x0001
1534 #define SLAP_TOOL_MODE          0x0002
1535 #define SLAP_MODE                       0x0003
1536
1537 #define SLAP_TRUNCATE_MODE      0x0100
1538 #define SLAP_TOOL_READMAIN      0x0200
1539 #define SLAP_TOOL_READONLY      0x0400
1540 #define SLAP_TOOL_QUICK         0x0800
1541 #define SLAP_TOOL_NO_SCHEMA_CHECK       0x1000
1542
1543 #define SB_TLS_DEFAULT          (-1)
1544 #define SB_TLS_OFF              0
1545 #define SB_TLS_ON               1
1546 #define SB_TLS_CRITICAL         2
1547
1548 typedef struct slap_bindconf {
1549         struct berval sb_uri;
1550         int sb_tls;
1551         int sb_method;
1552         struct berval sb_binddn;
1553         struct berval sb_cred;
1554         struct berval sb_saslmech;
1555         char *sb_secprops;
1556         struct berval sb_realm;
1557         struct berval sb_authcId;
1558         struct berval sb_authzId;
1559 } slap_bindconf;
1560
1561 struct slap_replica_info {
1562         const char *ri_host;            /* points to host part of uri */
1563         BerVarray ri_nsuffix;           /* array of suffixes this replica accepts */
1564         AttributeName *ri_attrs;        /* attrs to replicate, NULL=all */
1565         int ri_exclude;                         /* 1 => exclude ri_attrs */
1566         slap_bindconf ri_bindconf;      /* for back-config */
1567 };
1568
1569 typedef struct slap_verbmasks {
1570         struct berval word;
1571         const slap_mask_t mask;
1572 } slap_verbmasks;
1573
1574 typedef struct slap_cf_aux_table {
1575         struct berval key;
1576         int off;
1577         char type;
1578         char quote;
1579         void *aux;
1580 } slap_cf_aux_table;
1581
1582 #define SLAP_LIMIT_TIME 1
1583 #define SLAP_LIMIT_SIZE 2
1584
1585 struct slap_limits_set {
1586         /* time limits */
1587         int     lms_t_soft;
1588         int     lms_t_hard;
1589
1590         /* size limits */
1591         int     lms_s_soft;
1592         int     lms_s_hard;
1593         int     lms_s_unchecked;
1594         int     lms_s_pr;
1595         int     lms_s_pr_hide;
1596         int     lms_s_pr_total;
1597 };
1598
1599 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1600 #define SLAP_NO_LIMIT                   -1
1601 #define SLAP_MAX_LIMIT                  2147483647
1602
1603 struct slap_limits {
1604         unsigned                lm_flags;       /* type of pattern */
1605 #define SLAP_LIMITS_UNDEFINED           0x0000U
1606 #define SLAP_LIMITS_EXACT               0x0001U
1607 #define SLAP_LIMITS_BASE                SLAP_LIMITS_EXACT
1608 #define SLAP_LIMITS_ONE                 0x0002U
1609 #define SLAP_LIMITS_SUBTREE             0x0003U
1610 #define SLAP_LIMITS_CHILDREN            0x0004U
1611 #define SLAP_LIMITS_REGEX               0x0005U
1612 #define SLAP_LIMITS_ANONYMOUS           0x0006U
1613 #define SLAP_LIMITS_USERS               0x0007U
1614 #define SLAP_LIMITS_ANY                 0x0008U
1615 #define SLAP_LIMITS_MASK                0x000FU
1616
1617 #define SLAP_LIMITS_TYPE_DN             0x0000U
1618 #define SLAP_LIMITS_TYPE_GROUP          0x0010U
1619 #define SLAP_LIMITS_TYPE_MASK           0x00F0U
1620
1621         regex_t                 lm_regex;       /* regex data for REGEX */
1622
1623         /*
1624          * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1625          * pattern for REGEX; NULL for ANONYMOUS, USERS
1626          */
1627         struct berval           lm_pat;
1628
1629         /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1630          * lm_group_oc is objectClass and lm_group_at is attributeType
1631          * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1632          * can only be SLAP_LIMITS_EXACT */
1633         ObjectClass             *lm_group_oc;
1634         AttributeDescription    *lm_group_ad;
1635
1636         struct slap_limits_set  lm_limits;
1637 };
1638
1639 /* temporary aliases */
1640 typedef BackendDB Backend;
1641 #define nbackends nBackendDB
1642 #define backends backendDB
1643
1644 /*
1645  * syncinfo structure for syncrepl
1646  */
1647
1648 struct syncinfo_s;
1649
1650 #define SLAP_SYNC_RID_SIZE      3
1651 #define SLAP_SYNCUUID_SET_SIZE 256
1652
1653 #define SLAP_SYNC_UPDATE_MSGID  1
1654
1655 struct sync_cookie {
1656         struct berval ctxcsn;
1657         struct berval octet_str;
1658         long rid;
1659         LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1660 };
1661
1662 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1663
1664 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1665
1666 #ifndef SLAP_MAX_CIDS
1667 #define SLAP_MAX_CIDS   32      /* Maximum number of supported controls */
1668 #endif
1669
1670 struct ConfigOCs;       /* config.h */
1671
1672 struct slap_backend_db {
1673         BackendInfo     *bd_info;       /* pointer to shared backend info */
1674
1675         /* fields in this structure (and routines acting on this structure)
1676            should be renamed from be_ to bd_ */
1677
1678         /* BackendInfo accessors */
1679 #define         be_config       bd_info->bi_db_config
1680 #define         be_type         bd_info->bi_type
1681
1682 #define         be_bind         bd_info->bi_op_bind
1683 #define         be_unbind       bd_info->bi_op_unbind
1684 #define         be_add          bd_info->bi_op_add
1685 #define         be_compare      bd_info->bi_op_compare
1686 #define         be_delete       bd_info->bi_op_delete
1687 #define         be_modify       bd_info->bi_op_modify
1688 #define         be_modrdn       bd_info->bi_op_modrdn
1689 #define         be_search       bd_info->bi_op_search
1690 #define         be_abandon      bd_info->bi_op_abandon
1691 #define         be_cancel       bd_info->bi_op_cancel
1692
1693 #define         be_extended     bd_info->bi_extended
1694
1695 #define         be_chk_referrals        bd_info->bi_chk_referrals
1696 #define         be_chk_controls         bd_info->bi_chk_controls
1697 #define         be_fetch        bd_info->bi_entry_get_rw
1698 #define         be_release      bd_info->bi_entry_release_rw
1699 #define         be_group        bd_info->bi_acl_group
1700 #define         be_attribute    bd_info->bi_acl_attribute
1701 #define         be_operational  bd_info->bi_operational
1702
1703 /*
1704  * define to honor hasSubordinates operational attribute in search filters
1705  * (in previous use there was a flaw with back-bdb and back-ldbm; now it
1706  * is fixed).
1707  */
1708 #define         be_has_subordinates bd_info->bi_has_subordinates
1709
1710 #define         be_connection_init      bd_info->bi_connection_init
1711 #define         be_connection_destroy   bd_info->bi_connection_destroy
1712
1713 #ifdef SLAPD_TOOLS
1714 #define         be_entry_open bd_info->bi_tool_entry_open
1715 #define         be_entry_close bd_info->bi_tool_entry_close
1716 #define         be_entry_first bd_info->bi_tool_entry_first
1717 #define         be_entry_next bd_info->bi_tool_entry_next
1718 #define         be_entry_reindex bd_info->bi_tool_entry_reindex
1719 #define         be_entry_get bd_info->bi_tool_entry_get
1720 #define         be_entry_put bd_info->bi_tool_entry_put
1721 #define         be_sync bd_info->bi_tool_sync
1722 #define         be_dn2id_get bd_info->bi_tool_dn2id_get
1723 #define         be_id2entry_get bd_info->bi_tool_id2entry_get
1724 #define         be_entry_modify bd_info->bi_tool_entry_modify
1725 #endif
1726
1727         /* supported controls */
1728         /* note: set to 0 if the database does not support the control;
1729          * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1730         char            be_ctrls[SLAP_MAX_CIDS + 1];
1731
1732 /* Database flags */
1733 #define SLAP_DBFLAG_NOLASTMOD           0x0001U
1734 #define SLAP_DBFLAG_NO_SCHEMA_CHECK     0x0002U
1735 #define SLAP_DBFLAG_GLUE_INSTANCE       0x0010U /* a glue backend */
1736 #define SLAP_DBFLAG_GLUE_SUBORDINATE    0x0020U /* child of a glue hierarchy */
1737 #define SLAP_DBFLAG_GLUE_LINKED         0x0040U /* child is connected to parent */
1738 #define SLAP_DBFLAG_GLUE_ADVERTISE      0x0080U /* advertise in rootDSE */
1739 #define SLAP_DBFLAG_OVERLAY             0x0100U /* this db struct is an overlay */
1740 #define SLAP_DBFLAG_GLOBAL_OVERLAY      0x0200U /* this db struct is a global overlay */
1741 #define SLAP_DBFLAG_SHADOW              0x8000U /* a shadow */
1742 #define SLAP_DBFLAG_SYNC_SHADOW         0x1000U /* a sync shadow */
1743 #define SLAP_DBFLAG_SLURP_SHADOW        0x2000U /* a slurp shadow */
1744         slap_mask_t     be_flags;
1745 #define SLAP_DBFLAGS(be)                        ((be)->be_flags)
1746 #define SLAP_NOLASTMOD(be)                      (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1747 #define SLAP_LASTMOD(be)                        (!SLAP_NOLASTMOD(be))
1748 #define SLAP_ISOVERLAY(be)                      (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1749 #define SLAP_ISGLOBALOVERLAY(be)        (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLOBAL_OVERLAY)
1750 #define SLAP_NO_SCHEMA_CHECK(be)        \
1751         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1752 #define SLAP_GLUE_INSTANCE(be)          \
1753         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1754 #define SLAP_GLUE_SUBORDINATE(be)       \
1755         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1756 #define SLAP_GLUE_LINKED(be)            \
1757         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1758 #define SLAP_GLUE_ADVERTISE(be) \
1759         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1760 #define SLAP_SHADOW(be)                         (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1761 #define SLAP_SYNC_SHADOW(be)                    (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1762 #define SLAP_SLURP_SHADOW(be)                   (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1763
1764         slap_mask_t     be_restrictops;         /* restriction operations */
1765 #define SLAP_RESTRICT_OP_ADD            0x0001U
1766 #define SLAP_RESTRICT_OP_BIND           0x0002U
1767 #define SLAP_RESTRICT_OP_COMPARE        0x0004U
1768 #define SLAP_RESTRICT_OP_DELETE         0x0008U
1769 #define SLAP_RESTRICT_OP_EXTENDED       0x0010U
1770 #define SLAP_RESTRICT_OP_MODIFY         0x0020U
1771 #define SLAP_RESTRICT_OP_RENAME         0x0040U
1772 #define SLAP_RESTRICT_OP_SEARCH         0x0080U
1773 #define SLAP_RESTRICT_OP_MASK           0x00FFU
1774
1775 #define SLAP_RESTRICT_READONLY          0x80000000U
1776
1777 #define SLAP_RESTRICT_EXOP_START_TLS            0x0100U
1778 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD        0x0200U
1779 #define SLAP_RESTRICT_EXOP_WHOAMI               0x0400U
1780 #define SLAP_RESTRICT_EXOP_CANCEL               0x0800U
1781 #define SLAP_RESTRICT_EXOP_MASK                 0xFF00U
1782
1783 #define SLAP_RESTRICT_OP_READS  \
1784         ( SLAP_RESTRICT_OP_COMPARE      \
1785         | SLAP_RESTRICT_OP_SEARCH )
1786 #define SLAP_RESTRICT_OP_WRITES \
1787         ( SLAP_RESTRICT_OP_ADD    \
1788         | SLAP_RESTRICT_OP_DELETE \
1789         | SLAP_RESTRICT_OP_MODIFY \
1790         | SLAP_RESTRICT_OP_RENAME )
1791
1792 #define SLAP_ALLOW_BIND_V2                      0x0001U /* LDAPv2 bind */
1793 #define SLAP_ALLOW_BIND_ANON_CRED       0x0002U /* cred should be empty */
1794 #define SLAP_ALLOW_BIND_ANON_DN         0x0004U /* dn should be empty */
1795
1796 #define SLAP_ALLOW_UPDATE_ANON          0x0008U /* allow anonymous updates */
1797
1798 #define SLAP_DISALLOW_BIND_ANON         0x0001U /* no anonymous */
1799 #define SLAP_DISALLOW_BIND_SIMPLE       0x0002U /* simple authentication */
1800 #define SLAP_DISALLOW_BIND_KRBV4        0x0004U /* Kerberos V4 authentication */
1801
1802 #define SLAP_DISALLOW_TLS_2_ANON        0x0010U /* StartTLS -> Anonymous */
1803 #define SLAP_DISALLOW_TLS_AUTHC         0x0020U /* TLS while authenticated */
1804
1805 #define SLAP_DISALLOW_AUX_WO_CR         0x4000U
1806
1807         slap_mask_t     be_requires;    /* pre-operation requirements */
1808 #define SLAP_REQUIRE_BIND               0x0001U /* bind before op */
1809 #define SLAP_REQUIRE_LDAP_V3    0x0002U /* LDAPv3 before op */
1810 #define SLAP_REQUIRE_AUTHC              0x0004U /* authentication before op */
1811 #define SLAP_REQUIRE_SASL               0x0008U /* SASL before op  */
1812 #define SLAP_REQUIRE_STRONG             0x0010U /* strong authentication before op */
1813
1814         /* Required Security Strength Factor */
1815         slap_ssf_set_t be_ssf_set;
1816
1817         BerVarray       be_suffix;      /* the DN suffixes of data in this backend */
1818         BerVarray       be_nsuffix;     /* the normalized DN suffixes in this backend */
1819         struct berval be_schemadn;      /* per-backend subschema subentry DN */
1820         struct berval be_schemandn;     /* normalized subschema DN */
1821         struct berval be_rootdn;        /* the magic "root" name (DN) for this db */
1822         struct berval be_rootndn;       /* the magic "root" normalized name (DN) for this db */
1823         struct berval be_rootpw;        /* the magic "root" password for this db        */
1824         unsigned int be_max_deref_depth; /* limit for depth of an alias deref  */
1825 #define be_sizelimit    be_def_limit.lms_s_soft
1826 #define be_timelimit    be_def_limit.lms_t_soft
1827         struct slap_limits_set be_def_limit; /* default limits */
1828         struct slap_limits **be_limits; /* regex-based size and time limits */
1829         AccessControl *be_acl;  /* access control list for this backend    */
1830         slap_access_t   be_dfltaccess;  /* access given if no acl matches          */
1831
1832         /* Replica Information */
1833         struct slap_replica_info **be_replica;  /* replicas of this backend (in master) */
1834         char    *be_replogfile; /* replication log file (in master)        */
1835         struct berval be_update_ndn;    /* allowed to make changes (in replicas) */
1836         BerVarray       be_update_refs; /* where to refer modifying clients to */
1837         struct          be_pcl  *be_pending_csn_list;
1838         ldap_pvt_thread_mutex_t                                 be_pcl_mutex;
1839         ldap_pvt_thread_mutex_t                                 *be_pcl_mutexp;
1840         struct syncinfo_s                                               *be_syncinfo; /* For syncrepl */
1841
1842         void    *be_pb;         /* Netscape plugin */
1843         struct ConfigOCs *be_cf_ocs;
1844
1845         void    *be_private;    /* anything the backend database needs     */
1846         LDAP_STAILQ_ENTRY(slap_backend_db) be_next;
1847 };
1848
1849 struct slap_conn;
1850 struct slap_op;
1851
1852 /* Backend function typedefs */
1853 typedef int (BI_bi_func) LDAP_P((BackendInfo *bi));
1854 typedef BI_bi_func BI_init;
1855 typedef BI_bi_func BI_open;
1856 typedef BI_bi_func BI_close;
1857 typedef BI_bi_func BI_destroy;
1858 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1859         const char *fname, int lineno,
1860         int argc, char **argv));
1861
1862 typedef int (BI_db_func) LDAP_P((Backend *bd));
1863 typedef BI_db_func BI_db_init;
1864 typedef BI_db_func BI_db_open;
1865 typedef BI_db_func BI_db_close;
1866 typedef BI_db_func BI_db_destroy;
1867 typedef int (BI_db_config) LDAP_P((Backend *bd,
1868         const char *fname, int lineno,
1869         int argc, char **argv));
1870
1871 typedef struct req_bind_s {
1872         int rb_method;
1873         struct berval rb_cred;
1874         struct berval rb_edn;
1875         slap_ssf_t rb_ssf;
1876         struct berval rb_tmp_mech;      /* FIXME: temporary */
1877 } req_bind_s;
1878
1879 typedef struct req_search_s {
1880         int rs_scope;
1881         int rs_deref;
1882         int rs_slimit;
1883         int rs_tlimit;
1884         /* NULL means be_isroot evaluated to TRUE */
1885         struct slap_limits_set *rs_limit;
1886         int rs_attrsonly;
1887         AttributeName *rs_attrs;
1888         Filter *rs_filter;
1889         struct berval rs_filterstr;
1890 } req_search_s;
1891
1892 typedef struct req_compare_s {
1893         AttributeAssertion *rs_ava;
1894 } req_compare_s;
1895
1896 typedef struct req_modify_s {
1897         Modifications *rs_modlist;
1898         int rs_increment;               /* FIXME: temporary */
1899 } req_modify_s;
1900
1901 typedef struct req_modrdn_s {
1902         struct berval rs_newrdn;
1903         struct berval rs_nnewrdn;
1904         struct berval *rs_newSup;
1905         struct berval *rs_nnewSup;
1906         int rs_deleteoldrdn;
1907 } req_modrdn_s;
1908
1909 typedef struct req_add_s {
1910         Entry *rs_e;
1911         Modifications *rs_modlist;      /* FIXME: temporary */
1912 } req_add_s;
1913
1914 typedef struct req_abandon_s {
1915         ber_int_t rs_msgid;
1916 } req_abandon_s;
1917
1918 #ifdef LDAP_DEVEL
1919 #define SLAP_EXOP_HIDE 0x0000
1920 #else
1921 #define SLAP_EXOP_HIDE 0x8000
1922 #endif
1923 #define SLAP_EXOP_WRITES 0x0001         /* Exop does writes */
1924
1925 typedef struct req_extended_s {
1926         struct berval rs_reqoid;
1927         int rs_flags;
1928         struct berval *rs_reqdata;
1929 } req_extended_s;
1930
1931 typedef struct req_pwdexop_s {
1932         struct req_extended_s rs_extended;
1933         struct berval rs_old;
1934         struct berval rs_new;
1935         Modifications *rs_mods;
1936         Modifications **rs_modtail;
1937 } req_pwdexop_s;
1938
1939 typedef enum slap_reply_e {
1940         REP_RESULT,
1941         REP_SASL,
1942         REP_EXTENDED,
1943         REP_SEARCH,
1944         REP_SEARCHREF,
1945         REP_INTERMEDIATE,
1946         REP_GLUE_RESULT
1947 } slap_reply_t;
1948
1949 typedef struct rep_sasl_s {
1950         struct berval *r_sasldata;
1951 } rep_sasl_s;
1952
1953 typedef struct rep_extended_s {
1954         const char *r_rspoid;
1955         struct berval *r_rspdata;
1956 } rep_extended_s;
1957
1958 typedef struct rep_search_s {
1959         Entry *r_entry;
1960         slap_mask_t r_attr_flags;
1961 #define SLAP_ATTRS_UNDEFINED    (0x00U)
1962 #define SLAP_OPATTRS_NO                 (0x01U)
1963 #define SLAP_OPATTRS_YES                (0x02U)
1964 #define SLAP_USERATTRS_NO               (0x10U)
1965 #define SLAP_USERATTRS_YES              (0x20U)
1966 #define SLAP_OPATTRS_MASK(f)    ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
1967 #define SLAP_OPATTRS(f)                 (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
1968 #define SLAP_USERATTRS_MASK(f)  ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
1969 #define SLAP_USERATTRS(f)               \
1970         (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
1971
1972         Attribute *r_operational_attrs;
1973         AttributeName *r_attrs;
1974         int r_nentries;
1975         BerVarray r_v2ref;
1976 } rep_search_s;
1977
1978 typedef struct slap_rep {
1979         slap_reply_t sr_type;
1980         ber_tag_t sr_tag;
1981         ber_int_t sr_msgid;
1982         ber_int_t sr_err;
1983         const char *sr_matched;
1984         const char *sr_text;
1985         BerVarray sr_ref;
1986         LDAPControl **sr_ctrls;
1987         union sr_u {
1988                 rep_sasl_s sru_sasl;
1989                 rep_extended_s sru_extended;
1990                 rep_search_s sru_search;
1991         } sr_un;
1992         slap_mask_t sr_flags;
1993 #define REP_ENTRY_MODIFIABLE    0x0001U
1994 #define REP_ENTRY_MUSTBEFREED   0x0002U
1995 #define REP_ENTRY_MUSTRELEASE   0x0004U
1996 #define REP_MATCHED_MUSTBEFREED 0x0010U
1997 #define REP_REF_MUSTBEFREED     0x0020U
1998
1999 #define REP_NO_ENTRYDN          0x1000U
2000 #define REP_NO_SUBSCHEMA        0x2000U
2001 #define REP_NO_OPERATIONALS     (REP_NO_ENTRYDN|REP_NO_SUBSCHEMA)
2002 } SlapReply;
2003
2004 /* short hands for response members */
2005 #define sr_attrs sr_un.sru_search.r_attrs
2006 #define sr_entry sr_un.sru_search.r_entry
2007 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
2008 #define sr_attr_flags sr_un.sru_search.r_attr_flags
2009 #define sr_v2ref sr_un.sru_search.r_v2ref
2010 #define sr_nentries sr_un.sru_search.r_nentries
2011 #define sr_rspoid sr_un.sru_extended.r_rspoid
2012 #define sr_rspdata sr_un.sru_extended.r_rspdata
2013 #define sr_sasldata sr_un.sru_sasl.r_sasldata
2014
2015 typedef int (BI_op_func) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2016 typedef BI_op_func BI_op_bind;
2017 typedef BI_op_func BI_op_unbind;
2018 typedef BI_op_func BI_op_search;
2019 typedef BI_op_func BI_op_compare;
2020 typedef BI_op_func BI_op_modify;
2021 typedef BI_op_func BI_op_modrdn;
2022 typedef BI_op_func BI_op_add;
2023 typedef BI_op_func BI_op_delete;
2024 typedef BI_op_func BI_op_abandon;
2025 typedef BI_op_func BI_op_cancel;
2026 typedef BI_op_func BI_op_extended;
2027 typedef BI_op_func BI_chk_referrals;
2028 typedef BI_op_func BI_chk_controls;
2029 typedef int (BI_entry_release_rw)
2030         LDAP_P(( struct slap_op *op, Entry *e, int rw ));
2031 typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn,
2032         ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
2033 typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs ));
2034 typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op,
2035         Entry *e, int *hasSubs ));
2036 #ifdef SLAP_OVERLAY_ACCESS
2037 typedef int (BI_access_allowed) LDAP_P(( struct slap_op *op, Entry *e,
2038         AttributeDescription *desc, struct berval *val, slap_access_t access,
2039         AccessControlState *state, slap_mask_t *maskp ));
2040 typedef int (BI_acl_group) LDAP_P(( struct slap_op *op, Entry *target,
2041         struct berval *gr_ndn, struct berval *op_ndn,
2042         ObjectClass *group_oc, AttributeDescription *group_at ));
2043 typedef int (BI_acl_attribute) LDAP_P(( struct slap_op *op, Entry *target,
2044         struct berval *entry_ndn, AttributeDescription *entry_at,
2045         BerVarray *vals, slap_access_t access ));
2046 #endif /* SLAP_OVERLAY_ACCESS */
2047
2048 typedef int (BI_conn_func) LDAP_P(( BackendDB *bd, struct slap_conn *c ));
2049 typedef BI_conn_func BI_connection_init;
2050 typedef BI_conn_func BI_connection_destroy;
2051
2052 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
2053 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
2054 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
2055 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
2056 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
2057 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
2058         struct berval *text ));
2059 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
2060 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
2061 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
2062 typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e ));
2063 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
2064         struct berval *text ));
2065
2066 struct slap_backend_info {
2067         char    *bi_type; /* type of backend */
2068
2069         /*
2070          * per backend type routines:
2071          * bi_init: called to allocate a backend_info structure,
2072          *              called once BEFORE configuration file is read.
2073          *              bi_init() initializes this structure hence is
2074          *              called directly from be_initialize()
2075          * bi_config: called per 'backend' specific option
2076          *              all such options must before any 'database' options
2077          *              bi_config() is called only from read_config()
2078          * bi_open: called to open each database, called
2079          *              once AFTER configuration file is read but
2080          *              BEFORE any bi_db_open() calls.
2081          *              bi_open() is called from backend_startup()
2082          * bi_close: called to close each database, called
2083          *              once during shutdown after all bi_db_close calls.
2084          *              bi_close() is called from backend_shutdown()
2085          * bi_destroy: called to destroy each database, called
2086          *              once during shutdown after all bi_db_destroy calls.
2087          *              bi_destory() is called from backend_destroy()
2088          */
2089         BI_init *bi_init;
2090         BI_config       *bi_config;
2091         BI_open *bi_open;
2092         BI_close        *bi_close;
2093         BI_destroy      *bi_destroy;
2094
2095         /*
2096          * per database routines:
2097          * bi_db_init: called to initialize each database,
2098          *      called upon reading 'database <type>'
2099          *      called only from backend_db_init()
2100          * bi_db_config: called to configure each database,
2101          *  called per database to handle per database options
2102          *      called only from read_config()
2103          * bi_db_open: called to open each database
2104          *      called once per database immediately AFTER bi_open()
2105          *      calls but before daemon startup.
2106          *  called only by backend_startup()
2107          * bi_db_close: called to close each database
2108          *      called once per database during shutdown but BEFORE
2109          *  any bi_close call.
2110          *  called only by backend_shutdown()
2111          * bi_db_destroy: called to destroy each database
2112          *  called once per database during shutdown AFTER all
2113          *  bi_close calls but before bi_destory calls.
2114          *  called only by backend_destory()
2115          */
2116         BI_db_init      *bi_db_init;
2117         BI_db_config    *bi_db_config;
2118         BI_db_open      *bi_db_open;
2119         BI_db_close     *bi_db_close;
2120         BI_db_destroy   *bi_db_destroy;
2121
2122         /* LDAP Operations Handling Routines */
2123         BI_op_bind      *bi_op_bind;
2124         BI_op_unbind    *bi_op_unbind;
2125         BI_op_search    *bi_op_search;
2126         BI_op_compare   *bi_op_compare;
2127         BI_op_modify    *bi_op_modify;
2128         BI_op_modrdn    *bi_op_modrdn;
2129         BI_op_add       *bi_op_add;
2130         BI_op_delete    *bi_op_delete;
2131         BI_op_abandon   *bi_op_abandon;
2132         BI_op_cancel    *bi_op_cancel;
2133
2134         /* Extended Operations Helper */
2135         BI_op_extended  *bi_extended;
2136
2137         /* Auxilary Functions */
2138         BI_operational          *bi_operational;
2139         BI_chk_referrals        *bi_chk_referrals;
2140         BI_chk_controls         *bi_chk_controls;
2141         BI_entry_get_rw         *bi_entry_get_rw;
2142         BI_entry_release_rw     *bi_entry_release_rw;
2143
2144         BI_has_subordinates     *bi_has_subordinates;
2145 #ifdef SLAP_OVERLAY_ACCESS
2146         BI_access_allowed       *bi_access_allowed;
2147         BI_acl_group            *bi_acl_group;
2148         BI_acl_attribute        *bi_acl_attribute;
2149 #endif /* SLAP_OVERLAY_ACCESS */
2150
2151         BI_connection_init      *bi_connection_init;
2152         BI_connection_destroy   *bi_connection_destroy;
2153
2154         /* hooks for slap tools */
2155         BI_tool_entry_open      *bi_tool_entry_open;
2156         BI_tool_entry_close     *bi_tool_entry_close;
2157         BI_tool_entry_first     *bi_tool_entry_first;
2158         BI_tool_entry_next      *bi_tool_entry_next;
2159         BI_tool_entry_get       *bi_tool_entry_get;
2160         BI_tool_entry_put       *bi_tool_entry_put;
2161         BI_tool_entry_reindex   *bi_tool_entry_reindex;
2162         BI_tool_sync            *bi_tool_sync;
2163         BI_tool_dn2id_get       *bi_tool_dn2id_get;
2164         BI_tool_id2entry_get    *bi_tool_id2entry_get;
2165         BI_tool_entry_modify    *bi_tool_entry_modify;
2166
2167 #define SLAP_INDEX_ADD_OP               0x0001
2168 #define SLAP_INDEX_DELETE_OP    0x0002
2169
2170         slap_mask_t     bi_flags; /* backend flags */
2171 #define SLAP_BFLAG_MONITOR                      0x0001U /* a monitor backend */
2172 #define SLAP_BFLAG_CONFIG                       0x0002U /* a config backend */
2173 #define SLAP_BFLAG_FRONTEND                     0x0004U /* the frontendDB */
2174 #define SLAP_BFLAG_NOLASTMODCMD         0x0010U
2175 #define SLAP_BFLAG_INCREMENT            0x0100U
2176 #define SLAP_BFLAG_ALIASES                      0x1000U
2177 #define SLAP_BFLAG_REFERRALS            0x2000U
2178 #define SLAP_BFLAG_SUBENTRIES           0x4000U
2179 #define SLAP_BFLAG_DYNAMIC                      0x8000U
2180
2181 #define SLAP_BFLAGS(be)         ((be)->bd_info->bi_flags)
2182 #define SLAP_MONITOR(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2183 #define SLAP_CONFIG(be)         (SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG)
2184 #define SLAP_FRONTEND(be)       (SLAP_BFLAGS(be) & SLAP_BFLAG_FRONTEND)
2185 #define SLAP_INCREMENT(be)      (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2186 #define SLAP_ALIASES(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2187 #define SLAP_REFERRALS(be)      (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2188 #define SLAP_SUBENTRIES(be)     (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2189 #define SLAP_DYNAMIC(be)        (SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC)
2190 #define SLAP_NOLASTMODCMD(be)   (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2191 #define SLAP_LASTMODCMD(be)     (!SLAP_NOLASTMODCMD(be))
2192
2193         char    **bi_controls;          /* supported controls */
2194         char    bi_ctrls[SLAP_MAX_CIDS + 1];
2195
2196         unsigned int bi_nDB;    /* number of databases of this type */
2197         struct ConfigOCs *bi_cf_ocs;
2198         void    *bi_private;    /* anything the backend type needs */
2199         LDAP_STAILQ_ENTRY(slap_backend_info) bi_next ;
2200 };
2201
2202 #define c_authtype      c_authz.sai_method
2203 #define c_authmech      c_authz.sai_mech
2204 #define c_dn            c_authz.sai_dn
2205 #define c_ndn           c_authz.sai_ndn
2206 #define c_ssf                   c_authz.sai_ssf
2207 #define c_transport_ssf c_authz.sai_transport_ssf
2208 #define c_tls_ssf               c_authz.sai_tls_ssf
2209 #define c_sasl_ssf              c_authz.sai_sasl_ssf
2210
2211 #define o_authtype      o_authz.sai_method
2212 #define o_authmech      o_authz.sai_mech
2213 #define o_dn            o_authz.sai_dn
2214 #define o_ndn           o_authz.sai_ndn
2215 #define o_ssf                   o_authz.sai_ssf
2216 #define o_transport_ssf o_authz.sai_transport_ssf
2217 #define o_tls_ssf               o_authz.sai_tls_ssf
2218 #define o_sasl_ssf              o_authz.sai_sasl_ssf
2219
2220 typedef int (slap_response)( struct slap_op *, struct slap_rep * );
2221
2222 typedef struct slap_callback {
2223         struct slap_callback *sc_next;
2224         slap_response *sc_response;
2225         slap_response *sc_cleanup;
2226         void *sc_private;
2227 } slap_callback;
2228
2229 struct slap_overinfo;
2230
2231 typedef enum slap_operation_e {
2232         op_bind = 0,
2233         op_unbind,
2234         op_search,
2235         op_compare,
2236         op_modify,
2237         op_modrdn,
2238         op_add,
2239         op_delete,
2240         op_abandon,
2241         op_cancel,
2242         op_extended,
2243         op_aux_operational,
2244         op_aux_chk_referrals,
2245         op_aux_chk_controls,
2246         op_last
2247 } slap_operation_t;
2248
2249 typedef struct slap_overinst {
2250         BackendInfo on_bi;
2251         slap_response *on_response;
2252         struct slap_overinfo *on_info;
2253         struct slap_overinst *on_next;
2254 } slap_overinst;
2255
2256 typedef struct slap_overinfo {
2257         BackendInfo oi_bi;
2258         BackendInfo *oi_orig;
2259         BackendDB       *oi_origdb;
2260         struct slap_overinst *oi_list;
2261 } slap_overinfo;
2262
2263 /* Should successive callbacks in a chain be processed? */
2264 #define SLAP_CB_FREEME          0x04000
2265 #define SLAP_CB_BYPASS          0x08800
2266 #define SLAP_CB_CONTINUE        0x08000
2267
2268 /*
2269  * Paged Results state
2270  */
2271 typedef unsigned long PagedResultsCookie;
2272 typedef struct slap_paged_state {
2273         Backend *ps_be;
2274         ber_int_t ps_size;
2275         PagedResultsCookie ps_cookie;
2276         int ps_count;
2277 } PagedResultsState;
2278
2279 struct slap_csn_entry {
2280         struct berval ce_csn;
2281         unsigned long ce_opid;
2282         unsigned long ce_connid;
2283 #define SLAP_CSN_PENDING        1
2284 #define SLAP_CSN_COMMIT         2
2285         long ce_state;
2286         LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2287 };
2288
2289 /*
2290  * Caches the result of a backend_group check for ACL evaluation
2291  */
2292 typedef struct slap_gacl {
2293         struct slap_gacl *ga_next;
2294         Backend *ga_be;
2295         ObjectClass *ga_oc;
2296         AttributeDescription *ga_at;
2297         int ga_res;
2298         ber_len_t ga_len;
2299         char ga_ndn[1];
2300 } GroupAssertion;
2301
2302 struct slap_control_ids {
2303         int sc_LDAPsync;
2304         int sc_assert;
2305         int sc_domainScope;
2306         int sc_dontUseCopy;
2307         int sc_manageDIT;
2308         int sc_manageDSAit;
2309         int sc_modifyIncrement;
2310         int sc_noOp;
2311         int sc_pagedResults;
2312         int sc_permissiveModify;
2313         int sc_postRead;
2314         int sc_preRead;
2315         int sc_proxyAuthz;
2316         int sc_searchOptions;
2317 #ifdef LDAP_DEVEL
2318         int sc_sortedResults;
2319 #endif
2320         int sc_subentries;
2321         int sc_treeDelete;
2322         int sc_valuesReturnFilter;
2323 };
2324
2325 /*
2326  * represents an operation pending from an ldap client
2327  */
2328 typedef struct slap_op_header {
2329         unsigned long oh_opid;  /* id of this operation */
2330         unsigned long oh_connid; /* id of conn initiating this op */
2331         struct slap_conn *oh_conn;      /* connection spawning this op */
2332
2333         ber_int_t       oh_msgid;       /* msgid of the request */
2334         ber_int_t       oh_protocol;    /* version of the LDAP protocol used by client */
2335
2336         ldap_pvt_thread_t       oh_tid; /* thread handling this op */
2337
2338         void    *oh_threadctx;          /* thread pool thread context */
2339         void    *oh_tmpmemctx;          /* slab malloc context */
2340         BerMemoryFunctions *oh_tmpmfuncs;
2341
2342         char            oh_log_prefix[sizeof("conn=18446744073709551615 op=18446744073709551615")];
2343
2344 #ifdef LDAP_SLAPI
2345         void    *oh_extensions;         /* NS-SLAPI plugin */
2346 #endif
2347 } Opheader;
2348
2349 typedef union slap_op_request {
2350         req_add_s oq_add;
2351         req_bind_s oq_bind;
2352         req_compare_s oq_compare;
2353         req_modify_s oq_modify;
2354         req_modrdn_s oq_modrdn;
2355         req_search_s oq_search;
2356         req_abandon_s oq_abandon;
2357         req_abandon_s oq_cancel;
2358         req_extended_s oq_extended;
2359         req_pwdexop_s oq_pwdexop;
2360 } OpRequest;
2361
2362 typedef struct slap_op {
2363         Opheader *o_hdr;
2364
2365 #define o_opid o_hdr->oh_opid
2366 #define o_connid o_hdr->oh_connid
2367 #define o_conn o_hdr->oh_conn
2368 #define o_msgid o_hdr->oh_msgid
2369 #define o_protocol o_hdr->oh_protocol
2370 #define o_tid o_hdr->oh_tid
2371 #define o_threadctx o_hdr->oh_threadctx
2372 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2373 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2374
2375 #define o_tmpalloc      o_tmpmfuncs->bmf_malloc
2376 #define o_tmpcalloc     o_tmpmfuncs->bmf_calloc
2377 #define o_tmprealloc    o_tmpmfuncs->bmf_realloc
2378 #define o_tmpfree       o_tmpmfuncs->bmf_free
2379
2380 #define o_log_prefix o_hdr->oh_log_prefix
2381
2382         ber_tag_t       o_tag;          /* tag of the request */
2383         time_t          o_time;         /* time op was initiated */
2384         int                     o_tincr;        /* counter for multiple ops with same o_time */
2385
2386         BackendDB       *o_bd;  /* backend DB processing this op */
2387         struct berval   o_req_dn;       /* DN of target of request */
2388         struct berval   o_req_ndn;
2389
2390         OpRequest o_request;
2391
2392 /* short hands for union members */
2393 #define oq_add o_request.oq_add
2394 #define oq_bind o_request.oq_bind
2395 #define oq_compare o_request.oq_compare
2396 #define oq_modify o_request.oq_modify
2397 #define oq_modrdn o_request.oq_modrdn
2398 #define oq_search o_request.oq_search
2399 #define oq_abandon o_request.oq_abandon
2400 #define oq_cancel o_request.oq_cancel
2401 #define oq_extended o_request.oq_extended
2402 #define oq_pwdexop o_request.oq_pwdexop
2403
2404 /* short hands for inner request members */
2405 #define orb_method oq_bind.rb_method
2406 #define orb_cred oq_bind.rb_cred
2407 #define orb_edn oq_bind.rb_edn
2408 #define orb_ssf oq_bind.rb_ssf
2409 #define orb_tmp_mech oq_bind.rb_tmp_mech
2410
2411 #define ors_scope oq_search.rs_scope
2412 #define ors_deref oq_search.rs_deref
2413 #define ors_slimit oq_search.rs_slimit
2414 #define ors_tlimit oq_search.rs_tlimit
2415 #define ors_limit oq_search.rs_limit
2416 #define ors_attrsonly oq_search.rs_attrsonly
2417 #define ors_attrs oq_search.rs_attrs
2418 #define ors_filter oq_search.rs_filter
2419 #define ors_filterstr oq_search.rs_filterstr
2420
2421 #define orr_newrdn oq_modrdn.rs_newrdn
2422 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2423 #define orr_newSup oq_modrdn.rs_newSup
2424 #define orr_nnewSup oq_modrdn.rs_nnewSup
2425 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2426
2427 #define orc_ava oq_compare.rs_ava
2428 #define ora_e oq_add.rs_e
2429 #define ora_modlist oq_add.rs_modlist
2430 #define orn_msgid oq_abandon.rs_msgid
2431 #define orm_modlist oq_modify.rs_modlist
2432 #define orm_increment oq_modify.rs_increment
2433
2434 #define ore_reqoid oq_extended.rs_reqoid
2435 #define ore_flags oq_extended.rs_flags
2436 #define ore_reqdata oq_extended.rs_reqdata
2437         volatile sig_atomic_t o_abandon;        /* abandon flag */
2438         volatile sig_atomic_t o_cancel;         /* cancel flag */
2439 #define SLAP_CANCEL_NONE                                0x00
2440 #define SLAP_CANCEL_REQ                                 0x01
2441 #define SLAP_CANCEL_ACK                                 0x02
2442 #define SLAP_CANCEL_DONE                                0x03
2443
2444         GroupAssertion *o_groups;
2445         char o_do_not_cache;    /* don't cache groups from this op */
2446         char o_is_auth_check;   /* authorization in progress */
2447
2448         char o_nocaching;
2449         char o_delete_glue_parent;
2450         char o_no_schema_check;
2451 #define get_no_schema_check(op)                 ((op)->o_no_schema_check)
2452
2453 #define SLAP_CONTROL_NONE       0
2454 #define SLAP_CONTROL_IGNORED    1
2455 #define SLAP_CONTROL_NONCRITICAL 2
2456 #define SLAP_CONTROL_CRITICAL   3
2457 #define SLAP_CONTROL_MASK       3
2458
2459 /* spare bits for simple flags */
2460 #define SLAP_CONTROL_SHIFT      4       /* shift to reach data bits */
2461 #define SLAP_CONTROL_DATA0      0x10
2462 #define SLAP_CONTROL_DATA1      0x20
2463 #define SLAP_CONTROL_DATA2      0x40
2464 #define SLAP_CONTROL_DATA3      0x80
2465
2466
2467 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2468
2469         char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2470         void **o_controls;              /* per-control state */
2471
2472 #define o_dontUseCopy                   o_ctrlflag[slap_cids.sc_dontUseCopy]
2473 #define get_dontUseCopy(op)             _SCM((op)->o_dontUseCopy)
2474
2475 #define o_managedit                             o_ctrlflag[slap_cids.sc_manageDIT]
2476 #define get_manageDIT(op)               _SCM((op)->o_managedit)
2477
2478 #define o_managedsait   o_ctrlflag[slap_cids.sc_manageDSAit]
2479 #define get_manageDSAit(op)                             _SCM((op)->o_managedsait)
2480
2481 #define o_noop  o_ctrlflag[slap_cids.sc_noOp]
2482 #define o_proxy_authz   o_ctrlflag[slap_cids.sc_proxyAuthz]
2483 #define o_subentries    o_ctrlflag[slap_cids.sc_subentries]
2484
2485 #define get_subentries(op)                              _SCM((op)->o_subentries)
2486 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2487
2488 #define set_subentries_visibility(op)   ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2489 #define get_subentries_visibility(op)   (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2490
2491 #define o_assert        o_ctrlflag[slap_cids.sc_assert]
2492 #define get_assert(op)                                  ((int)(op)->o_assert)
2493 #define o_assertion     o_controls[slap_cids.sc_assert]
2494 #define get_assertion(op)                               ((op)->o_assertion)
2495
2496 #define o_valuesreturnfilter    o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2497 #define o_vrFilter      o_controls[slap_cids.sc_valuesReturnFilter]
2498
2499 #define o_permissive_modify     o_ctrlflag[slap_cids.sc_permissiveModify]
2500 #define get_permissiveModify(op)                ((int)(op)->o_permissive_modify)
2501
2502 #define o_domain_scope  o_ctrlflag[slap_cids.sc_domainScope]
2503 #define get_domainScope(op)                             ((int)(op)->o_domain_scope)
2504
2505 #define o_tree_delete   o_ctrlflag[slap_cids.sc_treeDelete]
2506 #define get_treeDelete(op)                              ((int)(op)->o_tree_delete)
2507
2508 #define o_preread       o_ctrlflag[slap_cids.sc_preRead]
2509 #define o_postread      o_ctrlflag[slap_cids.sc_postRead]
2510
2511 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2512 #define o_postread_attrs        o_controls[slap_cids.sc_postRead]
2513
2514 #define o_pagedresults  o_ctrlflag[slap_cids.sc_pagedResults]
2515 #define o_pagedresults_state    o_controls[slap_cids.sc_pagedResults]
2516 #define get_pagedresults(op)                    ((int)(op)->o_pagedresults)
2517
2518 #ifdef LDAP_DEVEL
2519 #define o_sortedresults         o_ctrlflag[slap_cids.sc_sortedResults]
2520 #endif
2521
2522 #define o_sync                  o_ctrlflag[slap_cids.sc_LDAPsync]
2523
2524         AuthorizationInformation o_authz;
2525
2526         BerElement      *o_ber;         /* ber of the request */
2527         BerElement      *o_res_ber;     /* ber of the CLDAP reply or readback control */
2528         slap_callback *o_callback;      /* callback pointers */
2529         LDAPControl     **o_ctrls;       /* controls */
2530         struct berval o_csn;
2531
2532         void    *o_private;     /* anything the backend needs */
2533
2534         LDAP_STAILQ_ENTRY(slap_op)      o_next; /* next operation in list         */
2535
2536 } Operation;
2537 #define OPERATION_BUFFER_SIZE   ( sizeof(Operation) + sizeof(Opheader) + \
2538         SLAP_MAX_CIDS*sizeof(void *) )
2539
2540 typedef LBER_ALIGNED_BUFFER(operation_buffer_u,OPERATION_BUFFER_SIZE)
2541         OperationBuffer;
2542
2543 #define send_ldap_error( op, rs, err, text ) do { \
2544                 (rs)->sr_err = err; (rs)->sr_text = text; \
2545                 (op->o_conn->c_send_ldap_result)( op, rs ); \
2546         } while (0)
2547 #define send_ldap_discon( op, rs, err, text ) do { \
2548                 (rs)->sr_err = err; (rs)->sr_text = text; \
2549                 send_ldap_disconnect( op, rs ); \
2550         } while (0)
2551
2552 typedef void (SEND_LDAP_RESULT)(
2553         struct slap_op *op, struct slap_rep *rs);
2554 typedef int (SEND_SEARCH_ENTRY)(
2555         struct slap_op *op, struct slap_rep *rs);
2556 typedef int (SEND_SEARCH_REFERENCE)(
2557         struct slap_op *op, struct slap_rep *rs);
2558 typedef void (SEND_LDAP_EXTENDED)(
2559         struct slap_op *op, struct slap_rep *rs);
2560 typedef void (SEND_LDAP_INTERMEDIATE)(
2561         struct slap_op *op, struct slap_rep *rs);
2562
2563 #define send_ldap_result( op, rs ) \
2564         ((op)->o_conn->c_send_ldap_result)( op, rs )
2565 #define send_search_entry( op, rs ) \
2566         ((op)->o_conn->c_send_search_entry)( op, rs )
2567 #define send_search_reference( op, rs ) \
2568         ((op)->o_conn->c_send_search_reference)( op, rs )
2569 #define send_ldap_extended( op, rs ) \
2570         ((op)->o_conn->c_send_ldap_extended)( op, rs )
2571 #define send_ldap_intermediate( op, rs ) \
2572         ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2573
2574 typedef struct slap_listener Listener;
2575
2576 /*
2577  * represents a connection from an ldap client
2578  */
2579 typedef struct slap_conn {
2580         int                     c_struct_state; /* structure management state */
2581         int                     c_conn_state;   /* connection state */
2582         int                     c_conn_idx;             /* slot in connections array */
2583         const char      *c_close_reason; /* why connection is closing */
2584
2585         ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2586         Sockbuf         *c_sb;                  /* ber connection stuff           */
2587
2588         /* only can be changed by connect_init */
2589         time_t          c_starttime;    /* when the connection was opened */
2590         time_t          c_activitytime; /* when the connection was last used */
2591         unsigned long           c_connid;       /* id of this connection for stats*/
2592
2593         struct berval   c_peer_domain;  /* DNS name of client */
2594         struct berval   c_peer_name;    /* peer name (trans=addr:port) */
2595         Listener        *c_listener;
2596 #define c_listener_url c_listener->sl_url       /* listener URL */
2597 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2598
2599         /* only can be changed by binding thread */
2600         int             c_sasl_bind_in_progress;        /* multi-op bind in progress */
2601         struct berval   c_sasl_bind_mech;                       /* mech in progress */
2602         struct berval   c_sasl_dn;      /* temporary storage */
2603         struct berval   c_sasl_authz_dn;        /* SASL proxy authz */
2604
2605         /* authorization backend */
2606         Backend *c_authz_backend;
2607         void    *c_authz_cookie;
2608 #define SLAP_IS_AUTHZ_BACKEND( op )     \
2609         ( (op)->o_bd != NULL \
2610                 && (op)->o_bd->be_private != NULL \
2611                 && (op)->o_conn != NULL \
2612                 && (op)->o_conn->c_authz_backend != NULL \
2613                 && ( (op)->o_bd->be_private == (op)->o_conn->c_authz_backend->be_private \
2614                         || (op)->o_bd->be_private == (op)->o_conn->c_authz_cookie ) )
2615
2616         AuthorizationInformation c_authz;
2617
2618         ber_int_t       c_protocol;     /* version of the LDAP protocol used by client */
2619
2620         LDAP_STAILQ_HEAD(c_o, slap_op) c_ops;   /* list of operations being processed */
2621         LDAP_STAILQ_HEAD(c_po, slap_op) c_pending_ops;  /* list of pending operations */
2622
2623         ldap_pvt_thread_mutex_t c_write_mutex;  /* only one pdu written at a time */
2624         ldap_pvt_thread_cond_t  c_write_cv;             /* used to wait for sd write-ready*/
2625
2626         BerElement      *c_currentber;  /* ber we're attempting to read */
2627         int             c_writewaiter;  /* true if writer is waiting */
2628
2629 #define CONN_IS_TLS     1
2630 #define CONN_IS_UDP     2
2631 #define CONN_IS_CLIENT  3
2632
2633 #ifdef LDAP_CONNECTIONLESS
2634         int     c_is_udp;               /* true if this is (C)LDAP over UDP */
2635 #endif
2636 #ifdef HAVE_TLS
2637         int     c_is_tls;               /* true if this LDAP over raw TLS */
2638         int     c_needs_tls_accept;     /* true if SSL_accept should be called */
2639 #endif
2640         int             c_sasl_layers;   /* true if we need to install SASL i/o handlers */
2641         int     c_sasl_done;            /* SASL completed once */
2642         void    *c_sasl_authctx;        /* SASL authentication context */
2643         void    *c_sasl_sockctx;        /* SASL security layer context */
2644         void    *c_sasl_extra;          /* SASL session extra stuff */
2645         struct slap_op  *c_sasl_bindop; /* set to current op if it's a bind */
2646
2647         PagedResultsState c_pagedresults_state; /* paged result state */
2648
2649         long    c_n_ops_received;       /* num of ops received (next op_id) */
2650         long    c_n_ops_executing;      /* num of ops currently executing */
2651         long    c_n_ops_pending;        /* num of ops pending execution */
2652         long    c_n_ops_completed;      /* num of ops completed */
2653
2654         long    c_n_get;                /* num of get calls */
2655         long    c_n_read;               /* num of read calls */
2656         long    c_n_write;              /* num of write calls */
2657
2658         void    *c_pb;                  /* Netscape plugin */
2659         void    *c_extensions;          /* Netscape plugin */
2660
2661         /*
2662          * Client connection handling
2663          */
2664         ldap_pvt_thread_start_t *c_clientfunc;
2665         void    *c_clientarg;
2666
2667         /*
2668          * These are the "callbacks" that are available for back-ends to
2669          * supply data back to connected clients that are connected
2670          * through the "front-end".
2671          */
2672         SEND_LDAP_RESULT *c_send_ldap_result;
2673         SEND_SEARCH_ENTRY *c_send_search_entry;
2674         SEND_SEARCH_REFERENCE *c_send_search_reference;
2675         SEND_LDAP_EXTENDED *c_send_ldap_extended;
2676         SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2677 } Connection;
2678
2679 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
2680 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2681         do { \
2682                 if ( ldap_debug & (level) ) \
2683                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2684                 if ( ldap_syslog & (level) ) \
2685                         syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
2686                                 (arg2), (arg3) ); \
2687         } while (0)
2688 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2689 #elif defined(LDAP_DEBUG)
2690 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )  \
2691         do { \
2692                 if ( ldap_debug & (level) ) \
2693                         fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2694         } while (0)
2695 #define StatslogTest( level ) (ldap_debug & (level))
2696 #else
2697 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
2698 #define StatslogTest( level ) (0)
2699 #endif
2700
2701 /*
2702  * listener; need to access it from monitor backend
2703  */
2704 struct slap_listener {
2705         struct berval sl_url;
2706         struct berval sl_name;
2707         mode_t  sl_perms;
2708 #ifdef HAVE_TLS
2709         int             sl_is_tls;
2710 #endif
2711 #ifdef LDAP_CONNECTIONLESS
2712         int     sl_is_udp;              /* UDP listener is also data port */
2713 #endif
2714         int     sl_mute;        /* Listener is temporarily disabled due to emfile */
2715 #ifdef SLAP_LIGHTWEIGHT_DISPATCHER
2716         int     sl_busy;        /* Listener is busy (accept thread activated) */
2717 #endif
2718         ber_socket_t sl_sd;
2719         Sockaddr sl_sa;
2720 #define sl_addr sl_sa.sa_in_addr
2721 };
2722
2723 /*
2724  * Operation indices
2725  */
2726 typedef enum {
2727         SLAP_OP_BIND = 0,
2728         SLAP_OP_UNBIND,
2729         SLAP_OP_ADD,
2730         SLAP_OP_DELETE,
2731         SLAP_OP_MODRDN,
2732         SLAP_OP_MODIFY,
2733         SLAP_OP_COMPARE,
2734         SLAP_OP_SEARCH,
2735         SLAP_OP_ABANDON,
2736         SLAP_OP_EXTENDED,
2737         SLAP_OP_LAST
2738 } slap_op_t;
2739
2740 typedef struct slap_counters_t {
2741         ldap_pvt_thread_mutex_t sc_sent_mutex;
2742         ldap_pvt_mp_t           sc_bytes;
2743         ldap_pvt_mp_t           sc_pdu;
2744         ldap_pvt_mp_t           sc_entries;
2745         ldap_pvt_mp_t           sc_refs;
2746
2747         ldap_pvt_thread_mutex_t sc_ops_mutex;
2748         ldap_pvt_mp_t           sc_ops_completed;
2749         ldap_pvt_mp_t           sc_ops_initiated;
2750 #ifdef SLAPD_MONITOR
2751         ldap_pvt_mp_t           sc_ops_completed_[SLAP_OP_LAST];
2752         ldap_pvt_mp_t           sc_ops_initiated_[SLAP_OP_LAST];
2753 #endif /* SLAPD_MONITOR */
2754 } slap_counters_t;
2755
2756 /*
2757  * Better know these all around slapd
2758  */
2759 #define SLAP_LDAPDN_PRETTY 0x1
2760 #define SLAP_LDAPDN_MAXLEN 8192
2761
2762 /* number of response controls supported */
2763 #define SLAP_MAX_RESPONSE_CONTROLS   6
2764
2765 #ifdef LDAP_DEVEL
2766 #define SLAP_CTRL_HIDE                          0x00000000U
2767 #else
2768 #define SLAP_CTRL_HIDE                          0x80000000U
2769 #endif
2770
2771 #define SLAP_CTRL_REQUIRES_ROOT         0x40000000U /* for ManageDIT */
2772
2773 #define SLAP_CTRL_GLOBAL                        0x00800000U
2774 #define SLAP_CTRL_GLOBAL_SEARCH         0x00010000U     /* for NOOP */
2775
2776 #define SLAP_CTRL_OPFLAGS                       0x0000FFFFU
2777 #define SLAP_CTRL_ABANDON                       0x00000001U
2778 #define SLAP_CTRL_ADD                           0x00002002U
2779 #define SLAP_CTRL_BIND                          0x00000004U
2780 #define SLAP_CTRL_COMPARE                       0x00001008U
2781 #define SLAP_CTRL_DELETE                        0x00002010U
2782 #define SLAP_CTRL_MODIFY                        0x00002020U
2783 #define SLAP_CTRL_RENAME                        0x00002040U
2784 #define SLAP_CTRL_SEARCH                        0x00001080U
2785 #define SLAP_CTRL_UNBIND                        0x00000100U
2786
2787 #define SLAP_CTRL_INTROGATE     (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2788 #define SLAP_CTRL_UPDATE \
2789         (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2790 #define SLAP_CTRL_ACCESS        (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2791
2792 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2793         Operation *op,
2794         SlapReply *rs,
2795         LDAPControl *ctrl ));
2796
2797 #define SLAP_SLAB_SIZE  (1024*1024)
2798 #define SLAP_SLAB_STACK 1
2799 #define SLAP_SLAB_SOBLOCK 64
2800
2801 #define SLAP_ZONE_ALLOC 1
2802 #undef SLAP_ZONE_ALLOC
2803
2804 #ifdef LDAP_COMP_MATCH
2805 /*
2806  * Extensible Filter Definition
2807  *
2808  * MatchingRuleAssertion := SEQUENCE {
2809  *      matchingRule    [1] MatchingRuleId OPTIONAL,
2810  *      type            [2] AttributeDescription OPTIONAL,
2811  *      matchValue      [3] AssertionValue,
2812  *      dnAttributes    [4] BOOLEAN DEFAULT FALSE }
2813  *
2814  * Following ComponentFilter is contained in matchValue
2815  *
2816  * ComponentAssertion ::= SEQUENCE {
2817  *      component               ComponentReference (SIZE(1..MAX)) OPTIONAL
2818  *      useDefaultValues        BOOLEAN DEFAULT TRUE,
2819  *      rule                    MATCHING-RULE.&id,
2820  *      value                   MATCHING-RULE.&AssertionType }
2821  *
2822  * ComponentFilter ::= CHOICE {
2823  *      item    [0] ComponentAssertion,
2824  *      and     [1] SEQUENCE OF ComponentFilter,
2825  *      or      [2] SEQUENCE OF ComponentFilter,
2826  *      not     [3] ComponentFilter }
2827  */
2828
2829 #define LDAP_COMPREF_IDENTIFIER         ((ber_tag_t) 0x80U)
2830 #define LDAP_COMPREF_FROM_BEGINNING     ((ber_tag_t) 0x81U)
2831 #define LDAP_COMPREF_COUNT              ((ber_tag_t) 0x82U)
2832 #define LDAP_COMPREF_FROM_END           ((ber_tag_t) 0x83U)
2833 #define LDAP_COMPREF_CONTENT            ((ber_tag_t) 0x84U)
2834 #define LDAP_COMPREF_SELECT             ((ber_tag_t) 0x85U)
2835 #define LDAP_COMPREF_ALL                ((ber_tag_t) 0x86U)
2836 #define LDAP_COMPREF_DEFINED            ((ber_tag_t) 0x87U)
2837 #define LDAP_COMPREF_UNDEFINED          ((ber_tag_t) 0x88U)
2838
2839 #define LDAP_COMP_FILTER_AND            ((ber_tag_t) 0xa0U)
2840 #define LDAP_COMP_FILTER_OR             ((ber_tag_t) 0xa1U)
2841 #define LDAP_COMP_FILTER_NOT            ((ber_tag_t) 0xa2U)
2842 #define LDAP_COMP_FILTER_ITEM           ((ber_tag_t) 0xa3U)
2843 #define LDAP_COMP_FILTER_UNDEFINED      ((ber_tag_t) 0xa4U)
2844
2845 typedef struct slap_component_id {
2846         int     ci_type;
2847         struct slap_component_id *ci_next;
2848
2849         union comp_id_value{
2850                 BerValue        ci_identifier;
2851                 ber_int_t       ci_from_beginning;
2852                 ber_int_t       ci_count;
2853                 ber_int_t       ci_from_end;
2854                 ber_int_t       ci_content;
2855                 BerValue        ci_select_value;
2856                 char            ci_all;
2857         } ci_val;
2858 } ComponentId;
2859
2860 typedef struct slap_component_reference {
2861         ComponentId     *cr_list;
2862         ComponentId     *cr_curr;
2863         struct berval   cr_string;
2864         int cr_len;
2865         /* Component Indexing */
2866         int             cr_asn_type_id;
2867         slap_mask_t     cr_indexmask;
2868         AttributeDescription* cr_ad;
2869         BerVarray       cr_nvals;
2870         struct slap_component_reference* cr_next;
2871 } ComponentReference;
2872
2873 typedef struct slap_component_assertion {
2874         ComponentReference      *ca_comp_ref;
2875         ber_int_t               ca_use_def;
2876         MatchingRule            *ca_ma_rule;
2877         struct berval           ca_ma_value;
2878         ComponentData           ca_comp_data; /* componentized assertion */
2879         struct slap_component_filter    *ca_cf;
2880         MatchingRuleAssertion   *ca_mra;
2881 } ComponentAssertion;
2882
2883 typedef struct slap_component_filter {
2884         ber_tag_t cf_choice;
2885         union cf_un_u {
2886                 ber_int_t cf_un_result;
2887                 ComponentAssertion *cf_un_ca;
2888                 struct slap_component_filter *cf_un_complex;
2889         } cf_un;
2890
2891 #define cf_ca           cf_un.cf_un_ca
2892 #define cf_result       cf_un.cf_un_result
2893 #define cf_and          cf_un.cf_un_complex
2894 #define cf_or           cf_un.cf_un_complex
2895 #define cf_not          cf_un.cf_un_complex
2896 #define cf_any          cf_un.cf_un_complex
2897
2898         struct slap_component_filter *cf_next;
2899 } ComponentFilter;
2900
2901 typedef struct slap_component_assertion_value {
2902         char* cav_buf;
2903         char* cav_ptr;
2904         char* cav_end;
2905 } ComponentAssertionValue;
2906
2907 typedef int encoder_func LDAP_P((
2908         void* b,
2909         void* comp));
2910
2911 struct slap_component_syntax_info;
2912
2913 typedef int gser_decoder_func LDAP_P((
2914         void* mem_op,
2915         void* b,
2916         struct slap_component_syntax_info** comp_syn_info,
2917         int* len,
2918         int mode));
2919
2920 typedef int comp_free_func LDAP_P((
2921         void* b));
2922
2923 typedef int ber_decoder_func LDAP_P((
2924         void* mem_op,
2925         void* b,
2926         int tag,
2927         int elmtLen,
2928         struct slap_component_syntax_info* comp_syn_info,
2929         int* len,
2930         int mode));
2931
2932 typedef int ber_tag_decoder_func LDAP_P((
2933         void* mem_op,
2934         void* b,
2935         struct slap_component_syntax_info* comp_syn_info,
2936         int* len,
2937         int mode));
2938
2939 typedef void* extract_component_from_id_func LDAP_P((
2940         void* mem_op,
2941         ComponentReference* cr,
2942         void* comp ));
2943
2944 typedef void* convert_attr_to_comp_func LDAP_P ((
2945         Attribute* a,
2946         Syntax* syn,
2947         struct berval* bv ));
2948
2949 typedef void* alloc_nibble_func LDAP_P ((
2950         int initial_size,
2951         int increment_size ));
2952
2953 typedef void free_nibble_func LDAP_P ((
2954         void* nm ));
2955
2956 struct slap_component_syntax_info;
2957 typedef void convert_assert_to_comp_func LDAP_P ((
2958         void *mem_op,
2959         struct slap_component_syntax_info* csi_attr,
2960         struct berval* bv,
2961         struct slap_component_syntax_info** csi,
2962         int* len,
2963         int mode ));
2964
2965 typedef int convert_asn_to_ldap_func LDAP_P ((
2966         struct slap_component_syntax_info* csi,
2967         struct berval *bv ));
2968
2969 typedef void free_component_func LDAP_P ((
2970         void* mem_op));
2971
2972 typedef int test_component_func LDAP_P ((
2973         void* attr_mem_op,
2974         void* assert_mem_op,
2975         struct slap_component_syntax_info* csi,
2976         struct slap_component_assertion* ca));
2977
2978 typedef void* test_membership_func LDAP_P ((
2979         void* in ));
2980
2981 typedef void* get_component_info_func LDAP_P ((
2982         int in ));
2983
2984 struct slap_component_syntax_info;
2985
2986 typedef int component_encoder_func LDAP_P ((
2987         void* mem_op,
2988         struct slap_component_syntax_info* csi,
2989         struct berval* nvals ));
2990
2991 typedef int allcomponent_matching_func LDAP_P((
2992         char* oid,
2993         struct slap_component_syntax_info* comp1,
2994         struct slap_component_syntax_info* comp));
2995
2996 typedef struct slap_component_desc {
2997         /* Don't change the order of following four fields */
2998         int             cd_tag;
2999         AttributeType   *cd_comp_type;
3000         struct berval   cd_ad_type;/* ad_type, ad_cname */
3001         struct berval   cd_ad_cname;/* ad_type, ad_cname */
3002         unsigned        cd_flags; /*ad_flags*/
3003         int             cd_type;
3004         int             cd_type_id;
3005         encoder_func            *cd_ldap_encoder;
3006         encoder_func            *cd_gser_encoder;
3007         encoder_func            *cd_ber_encoder;
3008         gser_decoder_func       *cd_gser_decoder;
3009         ber_decoder_func        *cd_ber_decoder;
3010         comp_free_func          *cd_free;
3011         extract_component_from_id_func*  cd_extract_i;
3012         allcomponent_matching_func      *cd_all_match;
3013 } ComponentDesc;
3014
3015 typedef struct slap_component_syntax_info {
3016         Syntax* csi_syntax;
3017         ComponentDesc* csi_comp_desc;
3018 } ComponentSyntaxInfo;
3019
3020 #endif
3021
3022 /* slab heap data structures */
3023
3024 struct slab_object {
3025     void *so_ptr;
3026         int so_blockhead;
3027     LDAP_LIST_ENTRY(slab_object) so_link;
3028 };
3029
3030 struct slab_heap {
3031     void *sh_base;
3032     void *sh_last;
3033     void *sh_end;
3034         int sh_stack;
3035         int sh_maxorder;
3036     unsigned char **sh_map;
3037     LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
3038         LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
3039 };
3040
3041 #ifdef SLAP_ZONE_ALLOC
3042 #define SLAP_ZONE_SIZE 0x80000          /* 512KB */
3043 #define SLAP_ZONE_SHIFT 19
3044 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
3045 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
3046 #define SLAP_ZONE_DELTA 0x800000        /* 8MB */
3047 #define SLAP_ZONE_ZOBLOCK 256
3048
3049 struct zone_object {
3050         void *zo_ptr;
3051         int zo_siz;
3052         int zo_idx;
3053         int zo_blockhead;
3054         LDAP_LIST_ENTRY(zone_object) zo_link;
3055 };
3056
3057 struct zone_latency_history {
3058         double zlh_latency;
3059         LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
3060 };
3061
3062 struct zone_heap {
3063         int zh_fd;
3064         int zh_zonesize;
3065         int zh_zoneorder;
3066         int zh_numzones;
3067         int zh_maxzones;
3068         int zh_deltazones;
3069         void **zh_zones;
3070         ldap_pvt_thread_rdwr_t *zh_znlock;
3071         Avlnode *zh_zonetree;
3072         unsigned char ***zh_maps;
3073         int *zh_seqno;
3074         LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
3075         LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
3076         ldap_pvt_thread_mutex_t zh_mutex;
3077         ldap_pvt_thread_rdwr_t zh_lock;
3078         double zh_ema_latency;
3079         unsigned long zh_ema_samples;
3080         LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
3081                                 zh_latency_history_queue;
3082         int zh_latency_history_qlen;
3083         int zh_latency_jump;
3084         int zh_swapping;
3085 };
3086 #endif
3087
3088 #define SLAP_BACKEND_INIT_MODULE(b) \
3089         static BackendInfo bi;  \
3090         int \
3091         init_module( int argc, char *argv[] ) \
3092         { \
3093                 bi.bi_type = #b ; \
3094                 bi.bi_init = b ## _back_initialize; \
3095                 backend_add( &bi ); \
3096                 return 0; \
3097         }
3098
3099 typedef int (OV_init)(void);
3100 typedef struct slap_oinit_t {
3101         const char      *ov_type;
3102         OV_init         *ov_init;
3103 } OverlayInit;
3104
3105 LDAP_END_DECL
3106
3107 #include "proto-slap.h"
3108
3109 #endif /* _SLAP_H_ */