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