3 * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
7 * Copyright (c) 1996 Regents of the University of Michigan.
10 * Redistribution and use in source and binary forms are permitted
11 * provided that this notice is preserved and that due credit is given
12 * to the University of Michigan at Ann Arbor. The name of the University
13 * may not be used to endorse or promote products derived from this
14 * software without specific prior written permission. This software
15 * is provided ``as is'' without express or implied warranty.
18 /* slurp.h - Standalone Ldap Update Replication Daemon (slurpd) */
29 #include <ac/signal.h>
30 #include <ac/syslog.h>
33 #include <sys/types.h>
38 #define ldap_debug slurp_debug
41 #include "ldap_pvt_thread.h"
42 #include "ldap_defaults.h"
46 /* Default directory for slurpd's private copy of replication logs */
47 #define DEFAULT_SLURPD_REPLICA_DIR LDAP_RUNDIR LDAP_DIRSEP "openldap-slurp"
49 /* Default name for slurpd's private copy of the replication log */
50 #define DEFAULT_SLURPD_REPLOGFILE "slurpd.replog"
52 /* Name of file which stores saved slurpd state info, for restarting */
53 #define DEFAULT_SLURPD_STATUS_FILE "slurpd.status"
55 /* slurpd dump file - contents of rq struct are written here (debugging) */
56 #define SLURPD_DUMPFILE LDAP_TMPDIR LDAP_DIRSEP "slurpd.dump"
58 /* default srvtab file. Can be overridden */
59 #define SRVTAB "/etc/srvtab"
61 /* Amount of time to sleep if no more work to do */
62 #define DEFAULT_NO_WORK_INTERVAL 3
64 /* The time we wait between checks to see if the replog file needs trimming */
65 #define TRIMCHECK_INTERVAL ( 60 * 5 )
67 /* Only try to trim slurpd replica files larger than this size */
68 #define MIN_TRIM_FILESIZE ( 10L * 1024L )
70 /* Maximum line length we can read from replication log */
71 #define REPLBUFLEN 256
76 #define TLS_CRITICAL 2
78 /* We support simple (plaintext password) and SASL authentication */
80 #define AUTH_KERBEROS 2
83 /* Rejection records are prefaced with this string */
84 #define ERROR_STR "ERROR"
86 /* Strings found in replication entries */
87 #define T_CHANGETYPESTR "changetype"
88 #define T_CHANGETYPE 1
89 #define T_TIMESTR "time"
94 #define T_ADDCTSTR "add"
96 #define T_MODIFYCTSTR "modify"
98 #define T_DELETECTSTR "delete"
100 #define T_MODRDNCTSTR "modrdn"
101 #define T_MODDNCTSTR "moddn"
102 #define T_RENAMECTSTR "rename"
105 #define T_MODOPADDSTR "add"
107 #define T_MODOPREPLACESTR "replace"
108 #define T_MODOPREPLACE 9
109 #define T_MODOPDELETESTR "delete"
110 #define T_MODOPDELETE 10
111 #define T_MODSEPSTR "-"
114 #define T_NEWRDNSTR "newrdn"
115 #define T_DELOLDRDNSTR "deleteoldrdn"
116 #define T_NEWSUPSTR "newsuperior"
120 /* Config file keywords */
121 #define HOSTSTR "host"
122 #define SUFFIXSTR "suffix"
123 #define BINDDNSTR "binddn"
124 #define BINDMETHSTR "bindmethod"
125 #define KERBEROSSTR "kerberos"
126 #define SIMPLESTR "simple"
127 #define SASLSTR "sasl"
128 #define CREDSTR "credentials"
129 #define OLDAUTHCSTR "bindprincipal"
130 #define AUTHCSTR "authcID"
131 #define AUTHZSTR "authzID"
132 #define SRVTABSTR "srvtab"
133 #define SASLMECHSTR "saslmech"
134 #define REALMSTR "realm"
135 #define SECPROPSSTR "secprops"
137 #define TLSCRITICALSTR "critical"
139 #define REPLICA_SLEEP_TIME ( 10 )
141 /* Enumeration of various types of bind failures */
143 #define BIND_ERR_BADLDP 1
144 #define BIND_ERR_OPEN 2
145 #define BIND_ERR_BAD_ATYPE 3
146 #define BIND_ERR_SIMPLE_FAILED 4
147 #define BIND_ERR_KERBEROS_FAILED 5
148 #define BIND_ERR_BADRI 6
149 #define BIND_ERR_VERSION 7
150 #define BIND_ERR_REFERRALS 8
151 #define BIND_ERR_MANAGEDSAIT 9
152 #define BIND_ERR_SASL_FAILED 10
153 #define BIND_ERR_TLS_FAILED 11
155 /* Return codes for do_ldap() */
157 #define DO_LDAP_ERR_RETRYABLE 1
158 #define DO_LDAP_ERR_FATAL 2
161 * Types of counts one can request from the Rq rq_getcount()
165 #define RQ_COUNT_ALL 1
166 /* all elements with nonzero refcnt */
167 #define RQ_COUNT_NZRC 2
169 /* Amount of time, in seconds, for a thread to sleep when it encounters
170 * a retryable error in do_ldap().
172 #define RETRY_SLEEP_TIME 60
178 * ****************************************************************************
179 * Data types for replication queue and queue elements.
180 * ****************************************************************************
185 * Replica host information. An Ri struct will contain an array of these,
186 * with one entry for each replica. The end of the array is signaled
187 * by a NULL value in the rh_hostname field.
190 char *rh_hostname; /* replica hostname */
191 int rh_port; /* replica port */
196 * Per-replica information.
199 * - Private data should not be manipulated expect by Ri member functions.
201 typedef struct ri Ri;
204 char *ri_hostname; /* canonical hostname of replica */
205 int ri_port; /* port where slave slapd running */
206 LDAP *ri_ldp; /* LDAP struct for this replica */
207 int ri_tls; /* TLS: 0=no, 1=yes, 2=critical */
208 int ri_bind_method; /* AUTH_SIMPLE or AUTH_KERBEROS */
209 char *ri_bind_dn; /* DN to bind as when replicating */
210 char *ri_password; /* Password for any method */
211 char *ri_secprops; /* SASL security properties */
212 char *ri_realm; /* realm for any mechanism */
213 char *ri_authcId; /* authentication ID for any mechanism */
214 char *ri_authzId; /* authorization ID for any mechanism */
215 char *ri_srvtab; /* srvtab file for kerberos bind */
216 char *ri_saslmech; /* SASL mechanism to use */
217 struct re *ri_curr; /* current repl entry being processed */
218 struct stel *ri_stel; /* pointer to Stel for this replica */
220 ri_seq; /* seq number of last repl */
221 ldap_pvt_thread_t ri_tid; /* ID of thread for this replica */
223 /* Member functions */
224 int (*ri_process) LDAP_P(( Ri * )); /* process the next repl entry */
225 void (*ri_wake) LDAP_P(( Ri * )); /* wake up a sleeping thread */
232 * Information about one particular modification to make. This data should
233 * be considered private to routines in re.c, and to routines in ri.c.
238 char *mi_type; /* attr or type */
239 char *mi_val; /* value */
240 int mi_len; /* length of mi_val */
247 * Information about one particular replication entry. Only routines in
248 * re.c and rq.c should touch the private data. Other routines should
249 * only use member functions.
251 typedef struct re Re;
255 ldap_pvt_thread_mutex_t
256 re_mutex; /* mutex for this Re */
257 int re_refcnt; /* ref count, 0 = done */
258 time_t re_timestamp; /* timestamp of this re */
259 int re_seq; /* sequence number */
260 Rh *re_replicas; /* array of replica info */
261 char *re_dn; /* dn of entry being modified */
262 int re_changetype; /* type of modification */
263 Mi *re_mods; /* array of modifications to make */
264 struct re *re_next; /* pointer to next element */
266 /* Public functions */
267 int (*re_free) LDAP_P(( Re * )); /* free an re struct */
268 Re *(*re_getnext) LDAP_P(( Re * )); /* return next Re in linked list */
269 int (*re_parse) LDAP_P(( Re *, char * )); /* parse replication log entry */
270 int (*re_write) LDAP_P(( Ri *, Re *, FILE * )); /* write repl. log entry */
271 void (*re_dump) LDAP_P(( Re *, FILE * )); /* debugging - print contents */
272 int (*re_lock) LDAP_P(( Re * )); /* lock this re */
273 int (*re_unlock) LDAP_P(( Re * )); /* unlock this re */
274 int (*re_decrefcnt) LDAP_P(( Re * )); /* decrement the refcnt */
275 int (*re_getrefcnt) LDAP_P(( Re * )); /* get the refcnt */
282 * Definition for the queue of replica information. Private data is
283 * private to rq.c. Other routines should only touch public data or
284 * use member functions. Note that although we have a member function
285 * for locking the queue's mutex, we need to expose the rq_mutex
286 * variable so routines in ri.c can use it as a mutex for the
287 * rq_more condition variable.
289 typedef struct rq Rq;
293 Re *rq_head; /* pointer to head */
294 Re *rq_tail; /* pointer to tail */
295 int rq_nre; /* total number of Re's in queue */
296 int rq_ndel; /* number of deleted Re's in queue */
297 time_t rq_lasttrim; /* Last time we trimmed file */
300 ldap_pvt_thread_mutex_t
301 rq_mutex; /* mutex for whole queue */
302 ldap_pvt_thread_cond_t
303 rq_more; /* condition var - more work added */
305 /* Member functions */
306 Re * (*rq_gethead) LDAP_P(( Rq * )); /* get the element at head */
307 Re * (*rq_getnext) LDAP_P(( Re * )); /* get the next element */
308 int (*rq_delhead) LDAP_P(( Rq * )); /* delete the element at head */
309 int (*rq_add) LDAP_P(( Rq *, char * )); /* add at tail */
310 void (*rq_gc) LDAP_P(( Rq * )); /* garbage-collect queue */
311 int (*rq_lock) LDAP_P(( Rq * )); /* lock the queue */
312 int (*rq_unlock) LDAP_P(( Rq * )); /* unlock the queue */
313 int (*rq_needtrim) LDAP_P(( Rq * )); /* see if queue needs trimming */
314 int (*rq_write) LDAP_P(( Rq *, FILE * )); /*write Rq contents to file*/
315 int (*rq_getcount) LDAP_P(( Rq *, int )); /* return queue counts */
316 void (*rq_dump) LDAP_P(( Rq * )); /* debugging - print contents */
321 * An Stel (status element) contains information about one replica.
322 * Stel structs are associated with the St (status) struct, defined
325 typedef struct stel {
326 char *hostname; /* host name of replica */
327 int port; /* port number of replica */
328 time_t last; /* timestamp of last successful repl */
329 int seq; /* Sequence number of last repl */
334 * An St struct in an in-core structure which contains the current
335 * slurpd state. Most importantly, it contains an array of Stel
336 * structs which contain the timestamp and sequence number of the last
337 * successful replication for each replica. The st_write() member
338 * function is called periodically to flush status information to
339 * disk. At startup time, slurpd checks for the status file, and
340 * if present, uses the timestamps to avoid "replaying" replications
341 * which have already been sent to a given replica.
343 typedef struct st St;
346 ldap_pvt_thread_mutex_t
347 st_mutex; /* mutex to serialize access */
348 Stel **st_data; /* array of pointers to Stel structs */
349 int st_nreplicas; /* number of repl hosts */
350 int st_err_logged; /* 1 if fopen err logged */
351 FILE *st_fp; /* st file kept open */
352 FILE *st_lfp; /* lockfile fp */
354 /* Public member functions */
355 int (*st_update) LDAP_P(( St *, Stel*, Re* ));/*update entry for a host*/
356 Stel*(*st_add) LDAP_P(( St *, Ri * )); /*add a new repl host*/
357 int (*st_write) LDAP_P(( St * )); /* write status to disk */
358 int (*st_read) LDAP_P(( St * )); /* read status info from disk */
359 int (*st_lock) LDAP_P(( St * )); /* read status info from disk */
360 int (*st_unlock) LDAP_P(( St * )); /* read status info from disk */
363 #if defined( HAVE_LWP )
365 thread_t tl_tid; /* thread being managed */
366 time_t tl_wake; /* time thread should be resumed */
367 struct tl *tl_next; /* next node in list */
374 #endif /* HAVE_LWP */
377 * Public functions used to instantiate and initialize queue objects.
379 extern int Ri_init LDAP_P(( Ri **ri ));
380 extern int Rq_init LDAP_P(( Rq **rq ));
381 extern int Re_init LDAP_P(( Re **re ));
383 #include "proto-slurp.h"
387 #endif /* _SLURPD_H_ */