--- servers/slapd/slap.h 2004/03/22 17:33:28 1.452.2.14 +++ servers/slapd/slap.h 2005/02/17 15:24:56 1.452.2.33 @@ -1,8 +1,8 @@ /* slap.h - stand alone ldap server include file */ -/* $OpenLDAP: pkg/ldap/servers/slapd/slap.h,v 1.527 2004/03/20 11:56:31 hyc Exp $ */ +/* $OpenLDAP: pkg/ldap/servers/slapd/slap.h,v 1.452.2.32 2005/01/20 17:01:10 kurt Exp $ */ /* This work is part of OpenLDAP Software . * - * Copyright 1998-2004 The OpenLDAP Foundation. + * Copyright 1998-2005 The OpenLDAP Foundation. * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -133,7 +133,10 @@ LDAP_BEGIN_DECL || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) ) #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR) -#define DN_SEPARATOR(c) ((c) == ',' || (c) == ';') +/* NOTE: for consistency, this macro must only operate + * on normalized/pretty DN, such that ';' is never used + * as RDN separator, and all occurrences of ';' must be escaped */ +#define DN_SEPARATOR(c) ((c) == ',') #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */ #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c)) #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"') @@ -145,9 +148,9 @@ LDAP_BEGIN_DECL #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) ) #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) ) -#define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' ) +#define ATTR_CHAR(c) ( DESC_CHAR((c)) || OID_SEPARATOR(c) ) -#define AD_LEADCHAR(c) ( ATTR_CHAR(c) ) +#define AD_LEADCHAR(c) ( ATTR_LEADCHAR(c) ) #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' ) #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) ) @@ -530,8 +533,8 @@ typedef struct slap_matching_rule { */ struct slap_matching_rule *smr_associated; -#define SLAP_MR_ASSOCIATED(mr,amr) (((mr) == (amr)) || \ - ((mr)->smr_associated == (amr))) +#define SLAP_MR_ASSOCIATED(mr,amr) \ + (((mr) == (amr)) || ((mr)->smr_associated == (amr))) LDAP_SLIST_ENTRY(slap_matching_rule)smr_next; @@ -607,6 +610,8 @@ typedef struct slap_attribute_type { #else #define SLAP_AT_HIDE 0x8000U /* hide attribute */ #endif +#define SLAP_AT_DYNAMIC 0x0400U /* dynamically generated */ + slap_mask_t sat_flags; LDAP_SLIST_ENTRY(slap_attribute_type) sat_next; @@ -789,14 +794,14 @@ struct slap_internal_schema { AttributeDescription *si_ad_subtreeSpecification; /* subschema subentry attribute descriptions */ - AttributeDescription *si_ad_ditStructureRules; - AttributeDescription *si_ad_ditContentRules; - AttributeDescription *si_ad_nameForms; - AttributeDescription *si_ad_objectClasses; AttributeDescription *si_ad_attributeTypes; + AttributeDescription *si_ad_ditContentRules; + AttributeDescription *si_ad_ditStructureRules; AttributeDescription *si_ad_ldapSyntaxes; AttributeDescription *si_ad_matchingRules; AttributeDescription *si_ad_matchingRuleUse; + AttributeDescription *si_ad_nameForms; + AttributeDescription *si_ad_objectClasses; /* Aliases & Referrals */ AttributeDescription *si_ad_aliasedObjectName; @@ -845,6 +850,16 @@ struct slap_internal_schema { Syntax *si_syn_distinguishedName; Syntax *si_syn_integer; Syntax *si_syn_octetString; + + /* Schema Syntaxes */ + Syntax *si_syn_attributeTypeDesc; + Syntax *si_syn_ditContentRuleDesc; + Syntax *si_syn_ditStructureRuleDesc; + Syntax *si_syn_ldapSyntaxDesc; + Syntax *si_syn_matchingRuleDesc; + Syntax *si_syn_matchingRuleUseDesc; + Syntax *si_syn_nameFormDesc; + Syntax *si_syn_objectClassDesc; }; typedef struct slap_attr_assertion { @@ -1034,7 +1049,6 @@ typedef struct slap_mod { AttributeDescription *sm_desc; struct berval sm_type; BerVarray sm_values; -#define sm_bvalues sm_values BerVarray sm_nvalues; } Modification; @@ -1043,7 +1057,6 @@ typedef struct slap_mod_list { #define sml_op sml_mod.sm_op #define sml_desc sml_mod.sm_desc #define sml_type sml_mod.sm_type -#define sml_bvalues sml_mod.sm_values #define sml_values sml_mod.sm_values #define sml_nvalues sml_mod.sm_nvalues struct slap_mod_list *sml_next; @@ -1055,7 +1068,6 @@ typedef struct slap_ldap_modlist { #define ml_op ml_mod.mod_op #define ml_type ml_mod.mod_type #define ml_values ml_mod.mod_values -#define ml_bvalues ml_mod.mod_values } LDAPModList; /* @@ -1287,8 +1299,13 @@ struct slap_limits_set { int lms_s_unchecked; int lms_s_pr; int lms_s_pr_hide; + int lms_s_pr_total; }; +/* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */ +#define SLAP_NO_LIMIT -1 +#define SLAP_MAX_LIMIT 2147483647 + struct slap_limits { unsigned lm_flags; /* type of pattern */ #define SLAP_LIMITS_UNDEFINED 0x0000U @@ -1373,28 +1390,38 @@ typedef struct syncinfo_s { char *si_authcId; char *si_authzId; int si_schemachecking; - Filter *si_filter; struct berval si_filterstr; struct berval si_base; int si_scope; int si_attrsonly; char **si_attrs; + char **si_exattrs; int si_type; time_t si_interval; + time_t *si_retryinterval; + int *si_retrynum_init; + int *si_retrynum; struct sync_cookie si_syncCookie; int si_manageDSAit; int si_slimit; int si_tlimit; - struct berval si_syncUUID_ndn; + int si_refreshDelete; + int si_refreshPresent; Avlnode *si_presentlist; LDAP *si_ld; LDAP_LIST_HEAD(np, nonpresent_entry) si_nonpresentlist; LDAP_STAILQ_ENTRY( syncinfo_s ) si_next; + ldap_pvt_thread_mutex_t si_mutex; } syncinfo_t; +LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry ); + struct slap_backend_db { BackendInfo *bd_info; /* pointer to shared backend info */ + /* fields in this structure (and routines acting on this structure) + should be renamed from be_ to bd_ */ + /* BackendInfo accessors */ #define be_config bd_info->bi_db_config #define be_type bd_info->bi_type @@ -1412,9 +1439,9 @@ struct slap_backend_db { #define be_extended bd_info->bi_extended +#define be_chk_referrals bd_info->bi_chk_referrals #define be_fetch bd_info->bi_entry_get_rw #define be_release bd_info->bi_entry_release_rw -#define be_chk_referrals bd_info->bi_chk_referrals #define be_group bd_info->bi_acl_group #define be_attribute bd_info->bi_acl_attribute #define be_operational bd_info->bi_operational @@ -1445,33 +1472,30 @@ struct slap_backend_db { #define be_entry_modify bd_info->bi_tool_entry_modify #endif -#define SLAP_BFLAG_NOLASTMOD 0x0001U -#define SLAP_BFLAG_NO_SCHEMA_CHECK 0x0002U -#define SLAP_BFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */ -#define SLAP_BFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */ -#define SLAP_BFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */ -#define SLAP_BFLAG_MONITOR 0x0080U /* a monitor backend */ -#define SLAP_BFLAG_INCREMENT 0x0100U -#define SLAP_BFLAG_ALIASES 0x1000U -#define SLAP_BFLAG_REFERRALS 0x2000U -#define SLAP_BFLAG_SUBENTRIES 0x4000U -#define SLAP_BFLAG_DYNAMIC 0x8000U +/* Database flags */ +#define SLAP_DBFLAG_NOLASTMOD 0x0001U +#define SLAP_DBFLAG_NO_SCHEMA_CHECK 0x0002U +#define SLAP_DBFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */ +#define SLAP_DBFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */ +#define SLAP_DBFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */ +#define SLAP_DBFLAG_SHADOW 0x8000U /* a shadow */ +#define SLAP_DBFLAG_SYNC_SHADOW 0x1000U /* a sync shadow */ +#define SLAP_DBFLAG_SLURP_SHADOW 0x2000U /* a slurp shadow */ slap_mask_t be_flags; -#define SLAP_LASTMOD(be) (!((be)->be_flags & SLAP_BFLAG_NOLASTMOD)) -#define SLAP_NO_SCHEMA_CHECK(be) (((be)->be_flags & SLAP_BFLAG_NO_SCHEMA_CHECK)) -#define SLAP_GLUE_INSTANCE(be) ((be)->be_flags & SLAP_BFLAG_GLUE_INSTANCE) -#define SLAP_GLUE_SUBORDINATE(be) \ - ((be)->be_flags & SLAP_BFLAG_GLUE_SUBORDINATE) -#define SLAP_GLUE_LINKED(be) ((be)->be_flags & SLAP_BFLAG_GLUE_LINKED) - -#define SLAP_MONITOR(be) ((be)->be_flags & SLAP_BFLAG_MONITOR) -#define SLAP_INCREMENT(be) ((be)->be_flags & SLAP_BFLAG_INCREMENT) - -#define SLAP_ALIASES(be) ((be)->be_flags & SLAP_BFLAG_ALIASES) -#define SLAP_REFERRALS(be) ((be)->be_flags & SLAP_BFLAG_REFERRALS) -#define SLAP_SUBENTRIES(be) ((be)->be_flags & SLAP_BFLAG_SUBENTRIES) -#define SLAP_DYNAMIC(be) ((be)->be_flags & SLAP_BFLAG_DYNAMIC) - +#define SLAP_DBFLAGS(be) ((be)->be_flags) +#define SLAP_NOLASTMOD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD) +#define SLAP_LASTMOD(be) (!SLAP_NOLASTMOD(be)) +#define SLAP_NO_SCHEMA_CHECK(be) \ + (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK) +#define SLAP_GLUE_INSTANCE(be) \ + (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE) +#define SLAP_GLUE_SUBORDINATE(be) \ + (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE) +#define SLAP_GLUE_LINKED(be) \ + (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED) +#define SLAP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW) +#define SLAP_SYNC_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW) +#define SLAP_SLURP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW) slap_mask_t be_restrictops; /* restriction operations */ #define SLAP_RESTRICT_OP_ADD 0x0001U @@ -1517,7 +1541,6 @@ struct slap_backend_db { /* Required Security Strength Factor */ slap_ssf_set_t be_ssf_set; - /* these should be renamed from be_ to bd_ */ BerVarray be_suffix; /* the DN suffixes of data in this backend */ BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */ struct berval be_schemadn; /* per-backend subschema subentry DN */ @@ -1532,19 +1555,23 @@ struct slap_backend_db { struct slap_limits **be_limits; /* regex-based size and time limits */ AccessControl *be_acl; /* access control list for this backend */ slap_access_t be_dfltaccess; /* access given if no acl matches */ + + /* Replica Information */ struct slap_replica_info **be_replica; /* replicas of this backend (in master) */ char *be_replogfile; /* replication log file (in master) */ struct berval be_update_ndn; /* allowed to make changes (in replicas) */ BerVarray be_update_refs; /* where to refer modifying clients to */ - char *be_realm; - void *be_private; /* anything the backend database needs */ - - void *be_pb; /* Netscape plugin */ - LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry ) be_pending_csn_list; + struct be_pcl *be_pending_csn_list; ldap_pvt_thread_mutex_t be_pcl_mutex; + ldap_pvt_thread_mutex_t *be_pcl_mutexp; struct berval be_context_csn; ldap_pvt_thread_mutex_t be_context_csn_mutex; LDAP_STAILQ_HEAD( be_si, syncinfo_s ) be_syncinfo; /* For syncrepl */ + + char *be_realm; + void *be_pb; /* Netscape plugin */ + + void *be_private; /* anything the backend database needs */ }; struct slap_conn; @@ -1664,9 +1691,10 @@ typedef struct slap_rep { rep_search_s sru_search; } sr_un; slap_mask_t sr_flags; -#define REP_ENTRY_MODIFIABLE 0x00000001 -#define REP_ENTRY_MUSTBEFREED 0x00000002 -#define REP_MATCHED_MUSTBEFREED 0x00000010 +#define REP_ENTRY_MODIFIABLE 0x0001U +#define REP_ENTRY_MUSTBEFREED 0x0002U +#define REP_MATCHED_MUSTBEFREED 0x0010U +#define REP_REF_MUSTBEFREED 0x0020U } SlapReply; /* short hands for response members */ @@ -1688,18 +1716,23 @@ typedef int (BI_op_add) LDAP_P(( struct typedef int (BI_op_delete) LDAP_P(( struct slap_op *op, struct slap_rep *rs )); typedef int (BI_op_abandon) LDAP_P(( struct slap_op *op, struct slap_rep *rs )); typedef int (BI_op_cancel) LDAP_P(( struct slap_op *op, struct slap_rep *rs )); -typedef int (BI_op_extended) LDAP_P(( struct slap_op *op, struct slap_rep *rs )); -typedef int (BI_entry_release_rw) LDAP_P(( struct slap_op *op, Entry *e, int rw )); +typedef int (BI_op_extended) LDAP_P(( + struct slap_op *op, struct slap_rep *rs )); +typedef int (BI_chk_referrals) LDAP_P(( + struct slap_op *op, struct slap_rep *rs )); +typedef int (BI_entry_release_rw) + LDAP_P(( struct slap_op *op, Entry *e, int rw )); typedef int (BI_entry_get_rw) LDAP_P(( struct slap_op *op, struct berval *ndn, ObjectClass *oc, AttributeDescription *at, int rw, Entry **e )); -typedef int (BI_chk_referrals) LDAP_P(( struct slap_op *op, struct slap_rep *rs )); -typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs, int opattrs, Attribute **ap )); -typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op, Entry *e, int *hasSubs )); - -typedef int (BI_connection_init) LDAP_P((BackendDB *bd, - struct slap_conn *c)); -typedef int (BI_connection_destroy) LDAP_P((BackendDB *bd, - struct slap_conn *c)); +typedef int (BI_operational) LDAP_P(( struct slap_op *op, struct slap_rep *rs, + int opattrs, Attribute **ap )); +typedef int (BI_has_subordinates) LDAP_P(( struct slap_op *op, + Entry *e, int *hasSubs )); + +typedef int (BI_connection_init) LDAP_P(( BackendDB *bd, + struct slap_conn *c )); +typedef int (BI_connection_destroy) LDAP_P(( BackendDB *bd, + struct slap_conn *c )); typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode )); typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be )); @@ -1707,13 +1740,13 @@ typedef ID (BI_tool_entry_first) LDAP_P( typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be )); typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id )); typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e, - struct berval *text )); + struct berval *text )); typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id )); typedef int (BI_tool_sync) LDAP_P(( BackendDB *be )); typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn )); typedef int (BI_tool_id2entry_get) LDAP_P(( BackendDB *be, ID id, Entry **e )); typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e, - struct berval *text )); + struct berval *text )); struct slap_backend_info { char *bi_type; /* type of backend */ @@ -1787,9 +1820,9 @@ struct slap_backend_info { BI_op_extended *bi_extended; /* Auxilary Functions */ + BI_chk_referrals *bi_chk_referrals; BI_entry_get_rw *bi_entry_get_rw; BI_entry_release_rw *bi_entry_release_rw; - BI_chk_referrals *bi_chk_referrals; BI_operational *bi_operational; BI_has_subordinates *bi_has_subordinates; @@ -1813,6 +1846,25 @@ struct slap_backend_info { #define SLAP_INDEX_ADD_OP 0x0001 #define SLAP_INDEX_DELETE_OP 0x0002 + slap_mask_t bi_flags; /* backend flags */ +#define SLAP_BFLAG_MONITOR 0x0001U /* a monitor backend */ +#define SLAP_BFLAG_NOLASTMODCMD 0x0010U +#define SLAP_BFLAG_INCREMENT 0x0100U +#define SLAP_BFLAG_ALIASES 0x1000U +#define SLAP_BFLAG_REFERRALS 0x2000U +#define SLAP_BFLAG_SUBENTRIES 0x4000U +#define SLAP_BFLAG_DYNAMIC 0x8000U + +#define SLAP_BFLAGS(be) ((be)->bd_info->bi_flags) +#define SLAP_MONITOR(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR) +#define SLAP_INCREMENT(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT) +#define SLAP_ALIASES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES) +#define SLAP_REFERRALS(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS) +#define SLAP_SUBENTRIES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES) +#define SLAP_DYNAMIC(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC) +#define SLAP_NOLASTMODCMD(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD) +#define SLAP_LASTMODCMD(be) (!SLAP_NOLASTMODCMD(be)) + char **bi_controls; /* supported controls */ unsigned int bi_nDB; /* number of databases of this type */ @@ -1871,10 +1923,9 @@ typedef unsigned long PagedResultsCookie typedef struct slap_paged_state { Backend *ps_be; PagedResultsCookie ps_cookie; - ID ps_id; + int ps_count; } PagedResultsState; - #define LDAP_PSEARCH_BY_ADD 0x01 #define LDAP_PSEARCH_BY_DELETE 0x02 #define LDAP_PSEARCH_BY_PREMODIFY 0x03 @@ -1902,13 +1953,13 @@ struct slap_session_entry { }; struct slap_csn_entry { - struct berval *csn; - unsigned long opid; - unsigned long connid; + struct berval *ce_csn; + unsigned long ce_opid; + unsigned long ce_connid; #define SLAP_CSN_PENDING 1 #define SLAP_CSN_COMMIT 2 - long state; - LDAP_TAILQ_ENTRY (slap_csn_entry) csn_link; + long ce_state; + LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link; }; /* @@ -2009,6 +2060,7 @@ typedef struct slap_op { char o_do_not_cache; /* don't cache groups from this op */ char o_is_auth_check; /* authorization in progress */ +#define SLAP_IGNORED_CONTROL -1 #define SLAP_NO_CONTROL 0 #define SLAP_NONCRITICAL_CONTROL 1 #define SLAP_CRITICAL_CONTROL 2 @@ -2088,6 +2140,7 @@ typedef struct slap_op { void *o_threadctx; /* thread pool thread context */ void *o_tmpmemctx; /* slab malloc context */ + void *o_savmemctx; BerMemoryFunctions *o_tmpmfuncs; #define o_tmpalloc o_tmpmfuncs->bmf_malloc #define o_tmpcalloc o_tmpmfuncs->bmf_calloc