]> git.sur5r.net Git - openldap/blobdiff - servers/slapd/back-meta/back-meta.h
refine fix to ITS#4315; apply it to back-meta as well
[openldap] / servers / slapd / back-meta / back-meta.h
index 78ab9ffdf3ddbb466380625357697e3359589fc6..4f27415c37a323e92054fc8b56ebd0857d977213 100644 (file)
@@ -1,7 +1,7 @@
 /* $OpenLDAP$ */
 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
  *
- * Copyright 1999-2005 The OpenLDAP Foundation.
+ * Copyright 1999-2006 The OpenLDAP Foundation.
  * Portions Copyright 2001-2003 Pierangelo Masarati.
  * Portions Copyright 1999-2003 Howard Chu.
  * All rights reserved.
@@ -70,21 +70,18 @@ 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;
 
-#define META_BIND_NRETRIES     3
-#define META_BIND_TIMEOUT      1000
-
 int ldap_back_dn_massage(dncookie *dc, struct berval *dn,
        struct berval *res);
 
@@ -105,123 +102,182 @@ void ldap_back_map ( struct ldapmap *map, struct berval *s, struct berval *m,
 #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_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 );
+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 {
+struct metainfo_t;
+
+typedef struct metasingleconn_t {
        int                     msc_candidate;
-#define        META_NOT_CANDIDATE      ((char)0)
-#define        META_CANDIDATE          ((char)1)
-#define        META_LAST_CONN          ((char)(-1))
+#define        META_NOT_CANDIDATE      ((ber_tag_t)0)
+#define        META_CANDIDATE          ((ber_tag_t)1)
        
        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)->msc_candidate == META_LAST_CONN)
+       time_t                  msc_time;
 
-struct metaconn {
+       struct metainfo_t       *msc_info;
+} metasingleconn_t;
+
+typedef struct metaconn_t {
        struct slap_conn        *mc_conn;
+       ldap_pvt_thread_mutex_t mc_mutex;
+       unsigned                mc_refcnt;
+       int                     mc_tainted;
        
+       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                     mc_bound_target;
+       int                     mc_authz_target;
 #define META_BOUND_NONE                (-1)
 #define META_BOUND_ALL         (-2)
        /* supersedes the connection stuff */
-       struct metasingleconn   *mc_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;
 
-struct metatarget {
+typedef struct metatarget_t {
        char                    *mt_uri;
+       int                     mt_scope;
+
        struct berval           mt_psuffix;             /* pretty suffix */
        struct berval           mt_nsuffix;             /* normalized suffix */
+
        struct berval           mt_binddn;
        struct berval           mt_bindpw;
 
        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;
-};
 
-struct metadncache {
+       unsigned                mt_flags;
+       int                     mt_version;
+       time_t                  mt_network_timeout;
+       time_t                  mt_idle_timeout;
+       struct timeval          mt_bind_timeout;
+#define META_BIND_TIMEOUT      10000
+       time_t                  mt_timeout[ LDAP_BACK_OP_LAST ];
+} metatarget_t;
+
+typedef struct metadncache_t {
        ldap_pvt_thread_mutex_t mutex;
        Avlnode                 *tree;
 
 #define META_DNCACHE_DISABLED   (0)
-#define META_DNCACHE_FOREVER    (-1)
-       long int                ttl;  /* seconds; 0: no cache, -1: no expiry */
-};
+#define META_DNCACHE_FOREVER    ((time_t)(-1))
+       time_t                  ttl;  /* seconds; 0: no cache, -1: no expiry */
+} metadncache_t;
+
+typedef struct metacandidates_t {
+       int                     mc_ntargets;
+       SlapReply               *mc_candidates;
+} metacandidates_t;
 
-struct metainfo {
+typedef struct metainfo_t {
        int                     mi_ntargets;
        int                     mi_defaulttarget;
-       int                     mi_network_timeout;
 #define META_DEFAULT_TARGET_NONE       (-1)
-       struct metatarget       **mi_targets;
-       char                    *mi_candidates;
+       int                     mi_nretries;
 
-       struct metadncache      mi_cache;
+       metatarget_t            *mi_targets;
+       metacandidates_t        *mi_candidates;
+
+       metadncache_t           mi_cache;
        
-       ldap_pvt_thread_mutex_t mi_conn_mutex;
-       Avlnode                 *mi_conntree;
+       ldap_avl_info_t         mi_conninfo;
 
-       unsigned                flags;
-#if 0
-/* defined in <back-ldap/back-ldap.h> */
-#define LDAP_BACK_F_NONE               0x00U
-#define LDAP_BACK_F_SAVECRED           0x01U
-#define LDAP_BACK_F_USE_TLS            0x02U
-#define LDAP_BACK_F_TLS_CRITICAL       ( 0x04U | LDAP_BACK_F_USE_TLS )
-#define LDAP_BACK_F_CHASE_REFERRALS    0x8U
-#endif
-};
+       unsigned                mi_flags;
+#define        li_flags                mi_flags
+/* uses flags as defined in <back-ldap/back-ldap.h> */
+#define        META_BACK_F_ONERR_STOP          0x00010000U
+#define        META_BACK_F_DEFER_ROOTDN_BIND   0x00020000U
+
+#define        META_BACK_ONERR_STOP(mi)        ( (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)->mi_flags & META_BACK_F_DEFER_ROOTDN_BIND )
+
+       int                     mi_version;
+       time_t                  mi_network_timeout;
+       time_t                  mi_idle_timeout;
+       struct timeval          mi_bind_timeout;
+       time_t                  mi_timeout[ LDAP_BACK_OP_LAST ];
+} metainfo_t;
 
 typedef enum meta_op_type {
        META_OP_ALLOW_MULTIPLE = 0,
@@ -229,123 +285,141 @@ typedef enum meta_op_type {
        META_OP_REQUIRE_ALL
 } meta_op_type;
 
-char *
+SlapReply *
 meta_back_candidates_get( Operation *op );
 
-extern struct metaconn *
+extern metaconn_t *
 meta_back_getconn(
-               Operation               *op,
-               SlapReply               *rs,
-               int                     *candidate,
-               ldap_back_send_t        sendok
-);
+       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,
-               ldap_back_send_t        sendok
-);
+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_is_valid(
-               struct metaconn         *lc, 
-               int                     candidate 
-);
+meta_back_init_one_conn(
+       Operation               *op,
+       SlapReply               *rs,
+       metatarget_t            *mt, 
+       metaconn_t              *mc,
+       int                     candidate,
+       int                     ispriv,
+       ldap_back_send_t        sendok );
+
+extern int
+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,
-               int                     candidate
-);
+       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
-);
+       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(
-               Operation               *op,
-               struct metaconn         *lc,
-               int                     candidate
-);
+       Operation               *op,
+       int                     candidate );
 
 extern int
 meta_clear_one_candidate(
-               struct metasingleconn   *lc
-);
+       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