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

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