--- servers/slapd/back-meta/back-meta.h 2004/11/13 13:45:18 1.23
+++ servers/slapd/back-meta/back-meta.h 2005/10/05 17:42:20 1.23.2.11
@@ -1,7 +1,7 @@
-/* $OpenLDAP: pkg/ldap/servers/slapd/back-meta/back-meta.h,v 1.22 2004/11/10 23:40:51 ando Exp $ */
+/* $OpenLDAP: pkg/ldap/servers/slapd/back-meta/back-meta.h,v 1.49 2005/10/01 16:07:00 ando Exp $ */
/* This work is part of OpenLDAP Software .
*
- * Copyright 1999-2004 The OpenLDAP Foundation.
+ * Copyright 1999-2005 The OpenLDAP Foundation.
* Portions Copyright 2001-2003 Pierangelo Masarati.
* Portions Copyright 1999-2003 Howard Chu.
* All rights reserved.
@@ -70,26 +70,20 @@ struct ldaprwmap {
/* Whatever context ldap_back_dn_massage needs... */
typedef struct dncookie {
- struct ldaprwmap *rwmap;
+ struct metatarget_t *target;
#ifdef ENABLE_REWRITE
- Connection *conn;
- char *ctx;
- SlapReply *rs;
+ Connection *conn;
+ char *ctx;
+ SlapReply *rs;
#else
- int normalized;
- int tofrom;
+ int normalized;
+ int tofrom;
#endif
} dncookie;
-int ldap_back_freeconn( Operation *op, struct ldapconn *lc );
-struct ldapconn *ldap_back_getconn(struct slap_op *op, struct slap_rep *rs);
-int ldap_back_dobind(struct ldapconn *lc, Operation *op, SlapReply *rs);
-int ldap_back_retry(struct ldapconn *lc, Operation *op, SlapReply *rs);
-int ldap_back_map_result(SlapReply *rs);
-int ldap_back_op_result(struct ldapconn *lc, Operation *op, SlapReply *rs,
- ber_int_t msgid, int sendok);
-int back_ldap_LTX_init_module(int argc, char *argv[]);
+/* TODO: allow to define it on a per-target basis */
+#define META_BIND_TIMEOUT 10000
int ldap_back_dn_massage(dncookie *dc, struct berval *dn,
struct berval *res);
@@ -103,258 +97,332 @@ int mapping_cmp (const void *, const voi
int mapping_dup (void *, void *);
void ldap_back_map_init ( struct ldapmap *lm, struct ldapmapping ** );
+int ldap_back_mapping ( struct ldapmap *map, struct berval *s,
+ struct ldapmapping **m, int remap );
void ldap_back_map ( struct ldapmap *map, struct berval *s, struct berval *m,
int remap );
#define BACKLDAP_MAP 0
#define BACKLDAP_REMAP 1
char *
ldap_back_map_filter(
- struct ldapmap *at_map,
- struct ldapmap *oc_map,
- struct berval *f,
- int remap
-);
+ struct ldapmap *at_map,
+ struct ldapmap *oc_map,
+ struct berval *f,
+ int remap );
int
ldap_back_map_attrs(
- struct ldapmap *at_map,
- AttributeName *a,
- int remap,
- char ***mapped_attrs
-);
+ struct ldapmap *at_map,
+ AttributeName *a,
+ int remap,
+ char ***mapped_attrs );
extern int ldap_back_map_config(
- struct ldapmap *oc_map,
- struct ldapmap *at_map,
- const char *fname,
- int lineno,
- int argc,
- char **argv );
+ struct ldapmap *oc_map,
+ struct ldapmap *at_map,
+ const char *fname,
+ int lineno,
+ int argc,
+ char **argv );
extern int
ldap_back_filter_map_rewrite(
- dncookie *dc,
- Filter *f,
- struct berval *fstr,
- int remap );
+ dncookie *dc,
+ Filter *f,
+ struct berval *fstr,
+ int remap );
/* suffix massaging by means of librewrite */
#ifdef ENABLE_REWRITE
-extern int suffix_massage_config( struct rewrite_info *info,
- struct berval *pvnc, struct berval *nvnc,
- struct berval *prnc, struct berval *nrnc);
+extern int
+suffix_massage_config( struct rewrite_info *info,
+ struct berval *pvnc,
+ struct berval *nvnc,
+ struct berval *prnc,
+ struct berval *nrnc );
#endif /* ENABLE_REWRITE */
-extern int ldap_dnattr_rewrite( dncookie *dc, BerVarray a_vals );
-extern int ldap_dnattr_result_rewrite( dncookie *dc, BerVarray a_vals );
+extern int
+ldap_back_referral_result_rewrite(
+ dncookie *dc,
+ BerVarray a_vals );
+extern int
+ldap_dnattr_rewrite(
+ dncookie *dc,
+ BerVarray a_vals );
+extern int
+ldap_dnattr_result_rewrite(
+ dncookie *dc,
+ BerVarray a_vals );
/* (end of) from back-ldap.h before rwm removal */
-struct metasingleconn {
- int candidate;
-#define META_NOT_CANDIDATE 0
-#define META_CANDIDATE 1
-#define META_LAST_CONN -1
+struct metainfo_t;
+
+typedef struct metasingleconn_t {
+ int msc_candidate;
+#define META_NOT_CANDIDATE ((ber_tag_t)0)
+#define META_CANDIDATE ((ber_tag_t)1)
- LDAP *ld;
- struct berval bound_dn;
- struct berval cred;
- int bound;
+ LDAP *msc_ld;
+ struct berval msc_bound_ndn;
+ struct berval msc_cred;
+ unsigned msc_mscflags;
+ /* NOTE: lc_lcflags is redefined to msc_mscflags to reuse the macros
+ * defined for back-ldap */
+#define lc_lcflags msc_mscflags
+#if 0
+ int msc_bound;
#define META_UNBOUND 0
#define META_BOUND 1
#define META_ANONYMOUS 2
-};
+#endif
-#define META_LAST(lsc) ((lsc)->candidate == META_LAST_CONN)
+ struct metainfo_t *msc_info;
+} metasingleconn_t;
-struct metaconn {
- struct slap_conn *conn;
- struct rewrite_info *rwinfo;
+typedef struct metaconn_t {
+ struct slap_conn *mc_conn;
+ ldap_pvt_thread_mutex_t mc_mutex;
+ unsigned mc_refcnt;
+ struct berval mc_local_ndn;
+ /* NOTE: msc_mscflags is used to recycle the #define
+ * in metasingleconn_t */
+ unsigned msc_mscflags;
+
/*
* means that the connection is bound;
* of course only one target actually is ...
*/
- int bound_target;
-#define META_BOUND_NONE -1
-#define META_BOUND_ALL -2
+ int mc_authz_target;
+#define META_BOUND_NONE (-1)
+#define META_BOUND_ALL (-2)
/* supersedes the connection stuff */
- struct metasingleconn *conns;
+ metasingleconn_t mc_conns[ 1 ];
+ /* NOTE: mc_conns must be last, because
+ * the required number of conns is malloc'ed
+ * in one block with the metaconn_t structure */
+} metaconn_t;
+
+enum {
+ META_OP_ADD = 0,
+ META_OP_DELETE,
+ META_OP_MODIFY,
+ META_OP_MODRDN,
+ META_OP_LAST
};
-struct metatarget {
- char *uri;
- struct berval psuffix; /* pretty suffix */
- struct berval suffix; /* normalized suffix */
- struct berval binddn;
- struct berval bindpw;
+typedef struct metatarget_t {
+ char *mt_uri;
+ int mt_scope;
- struct berval pseudorootdn;
- struct berval pseudorootpw;
+ struct berval mt_psuffix; /* pretty suffix */
+ struct berval mt_nsuffix; /* normalized suffix */
-#if 0
- struct rewrite_info *rwinfo;
+ struct berval mt_binddn;
+ struct berval mt_bindpw;
- struct ldapmap oc_map;
- struct ldapmap at_map;
-#endif
- struct ldaprwmap rwmap;
-};
+ struct berval mt_pseudorootdn;
+ struct berval mt_pseudorootpw;
+
+ int mt_nretries;
+#define META_RETRY_UNDEFINED (-2)
+#define META_RETRY_FOREVER (-1)
+#define META_RETRY_NEVER (0)
+#define META_RETRY_DEFAULT (3)
+
+ struct ldaprwmap mt_rwmap;
+
+ unsigned mt_flags;
+ int mt_version;
+ time_t mt_timeout[ META_OP_LAST ];
+} metatarget_t;
-struct metadncache {
+typedef struct metadncache_t {
ldap_pvt_thread_mutex_t mutex;
Avlnode *tree;
-#define META_DNCACHE_DISABLED 0
-#define META_DNCACHE_FOREVER -1
+#define META_DNCACHE_DISABLED (0)
+#define META_DNCACHE_FOREVER (-1)
long int ttl; /* seconds; 0: no cache, -1: no expiry */
-};
+} metadncache_t;
-struct metainfo {
- int ntargets;
- int defaulttarget;
- int network_timeout;
-#define META_DEFAULT_TARGET_NONE -1
- struct metatarget **targets;
+typedef struct metacandidates_t {
+ int mc_ntargets;
+ SlapReply *mc_candidates;
+} metacandidates_t;
+
+typedef struct metainfo_t {
+ int mi_ntargets;
+ int mi_defaulttarget;
+ int mi_network_timeout;
+#define META_DEFAULT_TARGET_NONE (-1)
+ int mi_nretries;
- struct rewrite_info *rwinfo;
- Backend *glue_be;
+ metatarget_t *mi_targets;
+ metacandidates_t *mi_candidates;
- struct metadncache cache;
+ metadncache_t mi_cache;
- ldap_pvt_thread_mutex_t conn_mutex;
- Avlnode *conntree;
+ ldap_pvt_thread_mutex_t mi_conn_mutex;
+ Avlnode *mi_conntree;
- int savecred;
-};
+ unsigned flags;
+/* uses flags as defined in */
+#define META_BACK_F_ONERR_STOP 0x00010000U
+#define META_BACK_F_DEFER_ROOTDN_BIND 0x00020000U
+
+#define META_BACK_ONERR_STOP(mi) ( (mi)->flags & META_BACK_F_ONERR_STOP )
+#define META_BACK_ONERR_CONTINUE(mi) ( !META_BACK_ONERR_CONTINUE( (mi) ) )
+
+#define META_BACK_DEFER_ROOTDN_BIND(mi) ( (mi)->flags & META_BACK_F_DEFER_ROOTDN_BIND )
-#define META_OP_ALLOW_MULTIPLE 0x00
-#define META_OP_REQUIRE_SINGLE 0x01
-#define META_OP_REQUIRE_ALL 0x02
-extern struct metaconn *
+ int mi_version;
+ time_t mi_timeout[ META_OP_LAST ];
+} metainfo_t;
+
+typedef enum meta_op_type {
+ META_OP_ALLOW_MULTIPLE = 0,
+ META_OP_REQUIRE_SINGLE,
+ META_OP_REQUIRE_ALL
+} meta_op_type;
+
+SlapReply *
+meta_back_candidates_get( Operation *op );
+
+extern metaconn_t *
meta_back_getconn(
- Operation *op,
- SlapReply *rs,
- int op_type,
- struct berval *dn,
- int *candidate
-);
+ Operation *op,
+ SlapReply *rs,
+ int *candidate,
+ ldap_back_send_t sendok );
+
+extern void
+meta_back_release_conn(
+ Operation *op,
+ metaconn_t *mc );
extern int
-meta_back_dobind(
- struct metaconn *lc,
- Operation *op
-);
+meta_back_retry(
+ Operation *op,
+ SlapReply *rs,
+ metaconn_t *mc,
+ int candidate,
+ ldap_back_send_t sendok );
+
+extern void
+meta_back_conn_free(
+ void *v_mc );
+
+extern int
+meta_back_init_one_conn(
+ Operation *op,
+ SlapReply *rs,
+ metatarget_t *mt,
+ metaconn_t *mc,
+ metasingleconn_t *msc,
+ int ispriv,
+ int isauthz,
+ ldap_back_send_t sendok );
extern int
-meta_back_is_valid(
- struct metaconn *lc,
- int candidate
-);
+meta_back_dobind(
+ Operation *op,
+ SlapReply *rs,
+ metaconn_t *mc,
+ ldap_back_send_t sendok );
+
+int
+meta_back_single_dobind(
+ Operation *op,
+ SlapReply *rs,
+ metaconn_t *msc,
+ int candidate,
+ ldap_back_send_t sendok,
+ int retries,
+ int dolock );
extern int
meta_back_op_result(
- struct metaconn *lc,
- Operation *op,
- SlapReply *rs
-);
+ metaconn_t *mc,
+ Operation *op,
+ SlapReply *rs,
+ int candidate );
extern int
back_meta_LTX_init_module(
- int argc,
- char *argv[]
-);
+ int argc,
+ char *argv[] );
extern int
meta_back_conn_cmp(
- const void *c1,
- const void *c2
-);
+ const void *c1,
+ const void *c2 );
extern int
meta_back_conn_dup(
- void *c1,
- void *c2
-);
+ void *c1,
+ void *c2 );
/*
* Candidate stuff
*/
extern int
meta_back_is_candidate(
- struct berval *nsuffix,
- struct berval *ndn
-);
-
-extern int
-meta_back_count_candidates(
- struct metainfo *li,
- struct berval *ndn
-);
-
-extern int
-meta_back_is_candidate_unique(
- struct metainfo *li,
- struct berval *ndn
-);
+ struct berval *nsuffix,
+ int suffixscope,
+ struct berval *ndn,
+ int scope );
extern int
meta_back_select_unique_candidate(
- struct metainfo *li,
- struct berval *ndn
-);
+ metainfo_t *mi,
+ struct berval *ndn );
extern int
meta_clear_unused_candidates(
- struct metainfo *li,
- struct metaconn *lc,
- int candidate,
- int reallyclean
-);
+ Operation *op,
+ int candidate );
extern int
meta_clear_one_candidate(
- struct metasingleconn *lc,
- int reallyclean
-);
+ metasingleconn_t *mc );
/*
* Dn cache stuff (experimental)
*/
extern int
meta_dncache_cmp(
- const void *c1,
- const void *c2
-);
+ const void *c1,
+ const void *c2 );
extern int
meta_dncache_dup(
- void *c1,
- void *c2
-);
+ void *c1,
+ void *c2 );
+#define META_TARGET_NONE (-1)
+#define META_TARGET_MULTIPLE (-2)
extern int
meta_dncache_get_target(
- struct metadncache *cache,
- struct berval *ndn
-);
+ metadncache_t *cache,
+ struct berval *ndn );
extern int
meta_dncache_update_entry(
- struct metadncache *cache,
- struct berval *ndn,
- int target
-);
+ metadncache_t *cache,
+ struct berval *ndn,
+ int target );
extern int
meta_dncache_delete_entry(
- struct metadncache *cache,
- struct berval *ndn
-);
+ metadncache_t *cache,
+ struct berval *ndn );
extern void
-meta_dncache_free(
- void *entry
-);
+meta_dncache_free( void *entry );
+
+extern LDAP_REBIND_PROC *meta_back_rebind_f;
LDAP_END_DECL