git.sur5r.net Git - openldap/blob - servers/slurpd/slurp.h

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 1998-2005 The OpenLDAP Foundation.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted only as authorized by the OpenLDAP
   9  * Public License.
  10  *
  11  * A copy of this license is available in file LICENSE in the
  12  * top-level directory of the distribution or, alternatively, at
  13  * <http://www.OpenLDAP.org/license.html>.
  14  */
  15 /* Portions Copyright (c) 1996 Regents of the University of Michigan.
  16  * All rights reserved.
  17  *
  18  * Redistribution and use in source and binary forms are permitted
  19  * provided that this notice is preserved and that due credit is given
  20  * to the University of Michigan at Ann Arbor. The name of the University
  21  * may not be used to endorse or promote products derived from this
  22  * software without specific prior written permission. This software
  23  * is provided ``as is'' without express or implied warranty.
  24  */
  25 /* ACKNOWLEDGEMENTS:
  26  * This work was originally developed by the University of Michigan
  27  * (as part of U-MICH LDAP).
  28  */
  29
  30 /* slurp.h - Standalone Ldap Update Replication Daemon (slurpd) */
  31
  32 #ifndef _SLURPD_H_
  33 #define _SLURPD_H_
  34
  35 #if !defined(HAVE_WINSOCK) && !defined(LDAP_SYSLOG)
  36 #define LDAP_SYSLOG 1
  37 #endif
  38
  39 #include <ac/errno.h>
  40 #include <ac/param.h>
  41 #include <ac/signal.h>
  42 #include <ac/syslog.h>
  43 #include <ac/time.h>
  44
  45 #include <sys/types.h>
  46
  47 #include <ldap.h>
  48
  49 #undef  ldap_debug
  50 #define ldap_debug slurp_debug
  51 #include "ldap_log.h"
  52
  53 #include "ldap_pvt_thread.h"
  54 #include "ldap_defaults.h"
  55 #include "ldif.h"
  56
  57 #ifdef HAVE_WINSOCK
  58         /* should be moved to portable.h.nt */
  59 #define ftruncate(a,b) _chsize(a,b)
  60 #define truncate(a,b) _lclose( _lcreat(a, 0))
  61 #define mkdir(a,b) mkdir(a)
  62 #define S_IRGRP 0
  63 #define S_IWGRP 0
  64 #endif
  65
  66 #undef SERVICE_NAME
  67 #define SERVICE_NAME    OPENLDAP_PACKAGE "-slurpd"
  68
  69 /* Default directory for slurpd's private copy of replication logs */
  70 #define DEFAULT_SLURPD_REPLICA_DIR      LDAP_RUNDIR LDAP_DIRSEP "openldap-slurp"
  71
  72 /* Default name for slurpd's private copy of the replication log */
  73 #define DEFAULT_SLURPD_REPLOGFILE       "slurpd.replog"
  74
  75 /* Name of file which stores saved slurpd state info, for restarting */
  76 #define DEFAULT_SLURPD_STATUS_FILE      "slurpd.status"
  77
  78 /* slurpd dump file - contents of rq struct are written here (debugging) */
  79 #define SLURPD_DUMPFILE                 LDAP_TMPDIR LDAP_DIRSEP "slurpd.dump"
  80
  81 /* Amount of time to sleep if no more work to do */
  82 #define DEFAULT_NO_WORK_INTERVAL        3
  83
  84 /* The time we wait between checks to see if the replog file needs trimming */
  85 #define TRIMCHECK_INTERVAL              ( 60 * 5 )
  86
  87 /* Only try to trim slurpd replica files larger than this size */
  88 #define MIN_TRIM_FILESIZE               ( 10L * 1024L )
  89
  90 /* Maximum line length we can read from replication log */
  91 #define REPLBUFLEN                      256
  92
  93 /* TLS flags */
  94 #define TLS_OFF                 0
  95 #define TLS_ON                  1
  96 #define TLS_CRITICAL    2
  97
  98 /* Rejection records are prefaced with this string */
  99 #define ERROR_STR       "ERROR"
 100
 101 /* Strings found in replication entries */
 102 #define T_CHANGETYPESTR         "changetype"
 103 #define T_CHANGETYPE            1
 104 #define T_TIMESTR               "time"
 105 #define T_TIME                  2
 106 #define T_DNSTR                 "dn"
 107 #define T_DN                    3
 108
 109 #define T_ADDCTSTR              "add"
 110 #define T_ADDCT                 4
 111 #define T_MODIFYCTSTR           "modify"
 112 #define T_MODIFYCT              5
 113 #define T_DELETECTSTR           "delete"
 114 #define T_DELETECT              6
 115 #define T_MODRDNCTSTR           "modrdn"
 116 #define T_MODDNCTSTR            "moddn"
 117 #define T_RENAMECTSTR           "rename"
 118 #define T_MODRDNCT              7
 119
 120 #define T_MODOPADDSTR           "add"
 121 #define T_MODOPADD              8
 122 #define T_MODOPREPLACESTR       "replace"
 123 #define T_MODOPREPLACE          9
 124 #define T_MODOPDELETESTR        "delete"
 125 #define T_MODOPDELETE           10
 126 #define T_MODOPINCREMENTSTR     "increment"
 127 #define T_MODOPINCREMENT        11
 128 #define T_MODSEPSTR             "-"
 129 #define T_MODSEP                12
 130
 131 #define T_NEWRDNSTR             "newrdn"
 132 #define T_DELOLDRDNSTR  "deleteoldrdn"
 133 #define T_NEWSUPSTR             "newsuperior"
 134
 135 #define T_ERR                   -1
 136
 137 /* Config file keywords */
 138 #define HOSTSTR                 "host"
 139 #define URISTR                  "uri"
 140 #define ATTRSTR                 "attr"
 141 #define SUFFIXSTR               "suffix"
 142 #define BINDDNSTR               "binddn"
 143 #define BINDMETHSTR             "bindmethod"
 144 #define KERBEROSSTR             "kerberos"
 145 #define SIMPLESTR               "simple"
 146 #define SASLSTR                 "sasl"
 147 #define CREDSTR                 "credentials"
 148 #define OLDAUTHCSTR             "bindprincipal"
 149 #define AUTHCSTR                "authcID"
 150 #define AUTHZSTR                "authzID"
 151 #define SRVTABSTR               "srvtab"
 152 #define SASLMECHSTR             "saslmech"
 153 #define REALMSTR                "realm"
 154 #define SECPROPSSTR             "secprops"
 155 #define STARTTLSSTR             "starttls"
 156 #define TLSSTR                  "tls"
 157 #define CRITICALSTR             "critical"
 158
 159 #define REPLICA_SLEEP_TIME      ( 10 )
 160
 161 /* Enumeration of various types of bind failures */
 162 #define BIND_OK                                         0
 163 #define BIND_ERR_BADLDP                         1
 164 #define BIND_ERR_OPEN                           2
 165 #define BIND_ERR_BAD_ATYPE                      3
 166 #define BIND_ERR_SIMPLE_FAILED          4
 167 #define BIND_ERR_KERBEROS_FAILED        5
 168 #define BIND_ERR_BADRI                          6
 169 #define BIND_ERR_VERSION                        7
 170 #define BIND_ERR_REFERRALS                      8
 171 #define BIND_ERR_MANAGEDSAIT            9
 172 #define BIND_ERR_SASL_FAILED            10
 173 #define BIND_ERR_TLS_FAILED                     11
 174
 175 /* Return codes for do_ldap() */
 176 #define DO_LDAP_OK                      0
 177 #define DO_LDAP_ERR_RETRYABLE           1
 178 #define DO_LDAP_ERR_FATAL               2
 179
 180 /*
 181  * Types of counts one can request from the Rq rq_getcount()
 182  * member function
 183  */
 184 /* all elements */
 185 #define RQ_COUNT_ALL                    1
 186 /* all elements with nonzero refcnt */
 187 #define RQ_COUNT_NZRC                   2
 188
 189 /* Amount of time, in seconds, for a thread to sleep when it encounters
 190  * a retryable error in do_ldap().
 191  */
 192 #define RETRY_SLEEP_TIME                60
 193
 194
 195 LDAP_BEGIN_DECL
 196
 197 /*
 198  * ****************************************************************************
 199  * Data types for replication queue and queue elements.
 200  * ****************************************************************************
 201  */
 202
 203
 204 /*
 205  * Replica host information.  An Ri struct will contain an array of these,
 206  * with one entry for each replica.  The end of the array is signaled
 207  * by a NULL value in the rh_hostname field.
 208  */
 209 typedef struct rh {
 210     char        *rh_hostname;           /* replica hostname  */
 211     int         rh_port;                /* replica port */
 212 } Rh;
 213
 214
 215 /*
 216  * Per-replica information.
 217  *
 218  * Notes:
 219  *  - Private data should not be manipulated expect by Ri member functions.
 220  */
 221 typedef struct ri Ri;
 222 struct ri {
 223     /* Private data */
 224     char        *ri_hostname;           /* canonical hostname of replica */
 225     int         ri_port;                /* port where slave slapd running */
 226     char        *ri_uri;                /* e.g. "ldaps://ldap-1.example.com:636" */
 227     LDAP        *ri_ldp;                /* LDAP struct for this replica */
 228     int         ri_tls;                 /* TLS: 0=no, 1=yes, 2=critical */
 229     int         ri_bind_method;         /* AUTH_SIMPLE or AUTH_KERBEROS */
 230     char        *ri_bind_dn;            /* DN to bind as when replicating */
 231     char        *ri_password;           /* Password for any method */
 232     char        *ri_secprops;           /* SASL security properties */
 233     char        *ri_realm;                      /* realm for any mechanism */
 234     char        *ri_authcId;            /* authentication ID for any mechanism */
 235     char        *ri_authzId;            /* authorization ID for any mechanism */
 236     char        *ri_srvtab;             /* srvtab file for kerberos bind */
 237     char        *ri_saslmech;           /* SASL mechanism to use */
 238     struct re   *ri_curr;               /* current repl entry being processed */
 239     struct stel *ri_stel;               /* pointer to Stel for this replica */
 240     unsigned long
 241                 ri_seq;                 /* seq number of last repl */
 242     ldap_pvt_thread_t   ri_tid;                 /* ID of thread for this replica */
 243
 244     /* Member functions */
 245     int (*ri_process) LDAP_P(( Ri * )); /* process the next repl entry */
 246     void (*ri_wake)   LDAP_P(( Ri * )); /* wake up a sleeping thread */
 247 };
 248
 249
 250
 251 /*
 252  * Information about one particular modification to make.  This data should
 253  * be considered private to routines in re.c, and to routines in ri.c.
 254  */
 255 typedef struct mi {
 256     /* Private data */
 257     char        *mi_type;               /* attr or type */
 258     char        *mi_val;                /* value */
 259     int         mi_len;                 /* length of mi_val */
 260 } Mi;
 261
 262
 263
 264 /*
 265  * Information about one particular replication entry.  Only routines in
 266  * re.c  and rq.c should touch the private data.  Other routines should
 267  * only use member functions.
 268  */
 269 typedef struct re Re;
 270 struct re {
 271     /* Private data */
 272     ldap_pvt_thread_mutex_t
 273                 re_mutex;               /* mutex for this Re */
 274     int         re_refcnt;              /* ref count, 0 = done */
 275     time_t      re_timestamp;           /* timestamp of this re */
 276     int         re_seq;                 /* sequence number */
 277     Rh          *re_replicas;           /* array of replica info */
 278     char        *re_dn;                 /* dn of entry being modified */
 279     int         re_changetype;          /* type of modification */
 280     Mi          *re_mods;               /* array of modifications to make */
 281     struct re   *re_next;               /* pointer to next element */
 282
 283     /* Public functions */
 284     int (*re_free)    LDAP_P(( Re * )); /* free an re struct */
 285     Re *(*re_getnext) LDAP_P(( Re * )); /* return next Re in linked list */
 286     int (*re_parse) LDAP_P(( Re *, char * )); /* parse replication log entry */
 287     int (*re_write) LDAP_P(( Ri *, Re *, FILE * )); /* write repl. log entry */
 288     void (*re_dump)  LDAP_P(( Re *, FILE * )); /* debugging - print contents */
 289     int (*re_lock)   LDAP_P(( Re * ));    /* lock this re */
 290     int (*re_unlock) LDAP_P(( Re * ));    /* unlock this re */
 291     int (*re_decrefcnt) LDAP_P(( Re * )); /* decrement the refcnt */
 292     int (*re_getrefcnt) LDAP_P(( Re * )); /* get the refcnt */
 293 };
 294
 295
 296
 297
 298 /*
 299  * Definition for the queue of replica information.  Private data is
 300  * private to rq.c.  Other routines should only touch public data or
 301  * use member functions.  Note that although we have a member function
 302  * for locking the queue's mutex, we need to expose the rq_mutex
 303  * variable so routines in ri.c can use it as a mutex for the
 304  * rq_more condition variable.
 305  */
 306 typedef struct rq Rq;
 307 struct rq {
 308
 309     /* Private data */
 310     Re          *rq_head;               /* pointer to head */
 311     Re          *rq_tail;               /* pointer to tail */
 312     int         rq_nre;                 /* total number of Re's in queue */
 313     int         rq_ndel;                /* number of deleted Re's in queue */
 314     time_t      rq_lasttrim;            /* Last time we trimmed file */
 315
 316     /* Public data */
 317     ldap_pvt_thread_mutex_t
 318                 rq_mutex;               /* mutex for whole queue */
 319     ldap_pvt_thread_cond_t
 320                 rq_more;                /* condition var - more work added */
 321
 322     /* Member functions */
 323     Re * (*rq_gethead)  LDAP_P(( Rq * )); /* get the element at head */
 324     Re * (*rq_getnext)  LDAP_P(( Re * )); /* get the next element */
 325     int  (*rq_delhead)  LDAP_P(( Rq * )); /* delete the element at head */
 326     int  (*rq_add)      LDAP_P(( Rq *, char * )); /* add at tail */
 327     void (*rq_gc)       LDAP_P(( Rq * )); /* garbage-collect queue */
 328     int  (*rq_lock)     LDAP_P(( Rq * )); /* lock the queue */
 329     int  (*rq_unlock)   LDAP_P(( Rq * )); /* unlock the queue */
 330     int  (*rq_needtrim) LDAP_P(( Rq * )); /* see if queue needs trimming */
 331     int  (*rq_write)    LDAP_P(( Rq *, FILE * )); /*write Rq contents to file*/
 332     int  (*rq_getcount) LDAP_P(( Rq *, int )); /* return queue counts */
 333     void (*rq_dump)     LDAP_P(( Rq * )); /* debugging - print contents */
 334 };
 335
 336
 337 /*
 338  * An Stel (status element) contains information about one replica.
 339  * Stel structs are associated with the St (status) struct, defined
 340  * below.
 341  */
 342 typedef struct stel {
 343     char        *hostname;              /* host name of replica */
 344     int         port;                   /* port number of replica */
 345     time_t      last;                   /* timestamp of last successful repl */
 346     int         seq;                    /* Sequence number of last repl */
 347 } Stel;
 348
 349
 350 /*
 351  * An St struct in an in-core structure which contains the current
 352  * slurpd state.  Most importantly, it contains an array of Stel
 353  * structs which contain the timestamp and sequence number of the last
 354  * successful replication for each replica.  The st_write() member
 355  * function is called periodically to flush status information to
 356  * disk.  At startup time, slurpd checks for the status file, and
 357  * if present, uses the timestamps to avoid "replaying" replications
 358  * which have already been sent to a given replica.
 359  */
 360 typedef struct st St;
 361 struct st {
 362     /* Private data */
 363     ldap_pvt_thread_mutex_t
 364                 st_mutex;               /* mutex to serialize access */
 365     Stel        **st_data;              /* array of pointers to Stel structs */
 366     int         st_nreplicas;           /* number of repl hosts */
 367     int         st_err_logged;          /* 1 if fopen err logged */
 368     FILE        *st_fp;                 /* st file kept open */
 369     FILE        *st_lfp;                /* lockfile fp */
 370
 371     /* Public member functions */
 372     int  (*st_update) LDAP_P(( St *, Stel*, Re* ));/*update entry for a host*/
 373     Stel*(*st_add)    LDAP_P(( St *, Ri * ));      /*add a new repl host*/
 374     int  (*st_write)  LDAP_P(( St * )); /* write status to disk */
 375     int  (*st_read)   LDAP_P(( St * )); /* read status info from disk */
 376     int  (*st_lock)   LDAP_P(( St * )); /* read status info from disk */
 377     int  (*st_unlock) LDAP_P(( St * )); /* read status info from disk */
 378 };
 379
 380 #if defined( HAVE_LWP )
 381 typedef struct tl {
 382     thread_t    tl_tid;         /* thread being managed */
 383     time_t      tl_wake;        /* time thread should be resumed */
 384     struct tl   *tl_next;       /* next node in list */
 385 } tl_t;
 386
 387 typedef struct tsl {
 388     tl_t        *tsl_list;
 389     mon_t       tsl_mon;
 390 } tsl_t;
 391 #endif /* HAVE_LWP */
 392
 393 /*
 394  * Public functions used to instantiate and initialize queue objects.
 395  */
 396 extern int Ri_init LDAP_P(( Ri **ri ));
 397 extern int Rq_init LDAP_P(( Rq **rq ));
 398 extern int Re_init LDAP_P(( Re **re ));
 399
 400 #include "proto-slurp.h"
 401
 402 LDAP_END_DECL
 403
 404 #endif /* _SLURPD_H_ */