2 * Copyright (c) 1996 Regents of the University of Michigan.
5 * Redistribution and use in source and binary forms are permitted
6 * provided that this notice is preserved and that due credit is given
7 * to the University of Michigan at Ann Arbor. The name of the University
8 * may not be used to endorse or promote products derived from this
9 * software without specific prior written permission. This software
10 * is provided ``as is'' without express or implied warranty.
13 /* slurp.h - Standalone Ldap Update Replication Daemon (slurpd) */
20 #include <ac/syslog.h>
23 #include <sys/param.h>
30 #include "ldapconfig.h"
34 /* Default directory for slurpd's private copy of replication logs */
35 #define DEFAULT_SLURPD_REPLICA_DIR "/usr/tmp"
37 /* Default name for slurpd's private copy of the replication log */
38 #define DEFAULT_SLURPD_REPLOGFILE "slurpd.replog"
40 /* Name of file which stores saved slurpd state info, for restarting */
41 #define DEFAULT_SLURPD_STATUS_FILE "slurpd.status"
43 /* slurpd dump file - contents of rq struct are written here (debugging) */
44 #define SLURPD_DUMPFILE "/tmp/slurpd.dump"
46 /* default srvtab file. Can be overridden */
47 #define SRVTAB "/etc/srvtab"
49 /* Amount of time to sleep if no more work to do */
50 #define DEFAULT_NO_WORK_INTERVAL 3
52 /* The time we wait between checks to see if the replog file needs trimming */
53 #define TRIMCHECK_INTERVAL ( 60 * 5 )
55 /* Only try to trim slurpd replica files larger than this size */
56 #define MIN_TRIM_FILESIZE ( 10L * 1024L )
58 /* Maximum line length we can read from replication log */
59 #define REPLBUFLEN 256
61 /* We support simple (plaintext password) and kerberos authentication */
63 #define AUTH_KERBEROS 2
65 /* Rejection records are prefaced with this string */
66 #define ERROR_STR "ERROR"
68 /* Strings found in replication entries */
69 #define T_CHANGETYPESTR "changetype"
70 #define T_CHANGETYPE 1
71 #define T_TIMESTR "time"
76 #define T_ADDCTSTR "add"
78 #define T_MODIFYCTSTR "modify"
80 #define T_DELETECTSTR "delete"
82 #define T_MODRDNCTSTR "modrdn"
85 #define T_MODOPADDSTR "add"
87 #define T_MODOPREPLACESTR "replace"
88 #define T_MODOPREPLACE 9
89 #define T_MODOPDELETESTR "delete"
90 #define T_MODOPDELETE 10
91 #define T_MODSEPSTR "-"
94 #define T_NEWRDNSTR "newrdn"
95 #define T_DRDNFLAGSTR "deleteoldrdn"
99 /* Config file keywords */
100 #define HOSTSTR "host"
101 #define BINDDNSTR "binddn"
102 #define BINDMETHSTR "bindmethod"
103 #define KERBEROSSTR "kerberos"
104 #define SIMPLESTR "simple"
105 #define CREDSTR "credentials"
106 #define BINDPSTR "bindprincipal"
107 #define SRVTABSTR "srvtab"
109 #define REPLICA_SLEEP_TIME ( 10 )
111 /* Enumeration of various types of bind failures */
113 #define BIND_ERR_BADLDP 1
114 #define BIND_ERR_OPEN 2
115 #define BIND_ERR_BAD_ATYPE 3
116 #define BIND_ERR_SIMPLE_FAILED 4
117 #define BIND_ERR_KERBEROS_FAILED 5
118 #define BIND_ERR_BADRI 6
120 /* Return codes for do_ldap() */
122 #define DO_LDAP_ERR_RETRYABLE 1
123 #define DO_LDAP_ERR_FATAL 2
126 * Types of counts one can request from the Rq rq_getcount()
130 #define RQ_COUNT_ALL 1
131 /* all elements with nonzero refcnt */
132 #define RQ_COUNT_NZRC 2
134 /* Amount of time, in seconds, for a thread to sleep when it encounters
135 * a retryable error in do_ldap().
137 #define RETRY_SLEEP_TIME 60
143 * ****************************************************************************
144 * Data types for replication queue and queue elements.
145 * ****************************************************************************
150 * Replica host information. An Ri struct will contain an array of these,
151 * with one entry for each replica. The end of the array is signaled
152 * by a NULL value in the rh_hostname field.
155 char *rh_hostname; /* replica hostname */
156 int rh_port; /* replica port */
161 * Per-replica information.
164 * - Private data should not be manipulated expect by Ri member functions.
166 typedef struct ri Ri;
170 char *ri_hostname; /* canonical hostname of replica */
171 int ri_port; /* port where slave slapd running */
172 LDAP *ri_ldp; /* LDAP struct for this replica */
173 int ri_bind_method; /* AUTH_SIMPLE or AUTH_KERBEROS */
174 char *ri_bind_dn; /* DN to bind as when replicating */
175 char *ri_password; /* Password for AUTH_SIMPLE */
176 char *ri_principal; /* principal for kerberos bind */
177 char *ri_srvtab; /* srvtab file for kerberos bind */
178 struct re *ri_curr; /* current repl entry being processed */
179 struct stel *ri_stel; /* pointer to Stel for this replica */
181 ri_seq; /* seq number of last repl */
182 pthread_t ri_tid; /* ID of thread for this replica */
184 /* Member functions */
185 int (*ri_process) LDAP_P(( Ri * )); /* process the next repl entry */
186 void (*ri_wake) LDAP_P(( Ri * )); /* wake up a sleeping thread */
193 * Information about one particular modification to make. This data should
194 * be considered private to routines in re.c, and to routines in ri.c.
199 char *mi_type; /* attr or type */
200 char *mi_val; /* value */
201 int mi_len; /* length of mi_val */
208 * Information about one particular replication entry. Only routines in
209 * re.c and rq.c should touch the private data. Other routines should
210 * only use member functions.
212 typedef struct re Re;
217 re_mutex; /* mutex for this Re */
218 int re_refcnt; /* ref count, 0 = done */
219 char *re_timestamp; /* timestamp of this re */
220 int re_seq; /* sequence number */
221 Rh *re_replicas; /* array of replica info */
222 char *re_dn; /* dn of entry being modified */
223 int re_changetype; /* type of modification */
224 Mi *re_mods; /* array of modifications to make */
225 struct re *re_next; /* pointer to next element */
227 /* Public functions */
228 int (*re_free) LDAP_P(( Re * )); /* free an re struct */
229 Re *(*re_getnext) LDAP_P(( Re * )); /* return next Re in linked list */
230 int (*re_parse) LDAP_P(( Re *, char * )); /* parse replication log entry */
231 int (*re_write) LDAP_P(( Ri *, Re *, FILE * )); /* write repl. log entry */
232 void (*re_dump) LDAP_P(( Re *, FILE * )); /* debugging - print contents */
233 int (*re_lock) LDAP_P(( Re * )); /* lock this re */
234 int (*re_unlock) LDAP_P(( Re * )); /* unlock this re */
235 int (*re_decrefcnt) LDAP_P(( Re * )); /* decrement the refcnt */
236 int (*re_getrefcnt) LDAP_P(( Re * )); /* get the refcnt */
243 * Definition for the queue of replica information. Private data is
244 * private to rq.c. Other routines should only touch public data or
245 * use member functions. Note that although we have a member function
246 * for locking the queue's mutex, we need to expose the rq_mutex
247 * variable so routines in ri.c can use it as a mutex for the
248 * rq_more condition variable.
250 typedef struct rq Rq;
254 Re *rq_head; /* pointer to head */
255 Re *rq_tail; /* pointer to tail */
256 int rq_nre; /* total number of Re's in queue */
257 int rq_ndel; /* number of deleted Re's in queue */
258 time_t rq_lasttrim; /* Last time we trimmed file */
262 rq_mutex; /* mutex for whole queue */
264 rq_more; /* condition var - more work added */
266 /* Member functions */
267 Re * (*rq_gethead) LDAP_P(( Rq * )); /* get the element at head */
268 Re * (*rq_getnext) LDAP_P(( Re * )); /* get the next element */
269 int (*rq_delhead) LDAP_P(( Rq * )); /* delete the element at head */
270 int (*rq_add) LDAP_P(( Rq *, char * )); /* add at tail */
271 void (*rq_gc) LDAP_P(( Rq * )); /* garbage-collect queue */
272 int (*rq_lock) LDAP_P(( Rq * )); /* lock the queue */
273 int (*rq_unlock) LDAP_P(( Rq * )); /* unlock the queue */
274 int (*rq_needtrim) LDAP_P(( Rq * )); /* see if queue needs trimming */
275 int (*rq_write) LDAP_P(( Rq *, FILE * )); /*write Rq contents to file*/
276 int (*rq_getcount) LDAP_P(( Rq *, int )); /* return queue counts */
277 void (*rq_dump) LDAP_P(( Rq * )); /* debugging - print contents */
282 * An Stel (status element) contains information about one replica.
283 * Stel structs are associated with the St (status) struct, defined
286 typedef struct stel {
287 char *hostname; /* host name of replica */
288 int port; /* port number of replica */
289 char last[ 64 ]; /* timestamp of last successful repl */
290 int seq; /* Sequence number of last repl */
295 * An St struct in an in-core structure which contains the current
296 * slurpd state. Most importantly, it contains an array of Stel
297 * structs which contain the timestamp and sequence number of the last
298 * successful replication for each replica. The st_write() member
299 * function is called periodically to flush status information to
300 * disk. At startup time, slurpd checks for the status file, and
301 * if present, uses the timestamps to avoid "replaying" replications
302 * which have already been sent to a given replica.
304 typedef struct st St;
308 st_mutex; /* mutex to serialize access */
309 Stel **st_data; /* array of pointers to Stel structs */
310 int st_nreplicas; /* number of repl hosts */
311 int st_err_logged; /* 1 if fopen err logged */
312 FILE *st_fp; /* st file kept open */
313 FILE *st_lfp; /* lockfile fp */
315 /* Public member functions */
316 int (*st_update) LDAP_P(( St *, Stel*, Re* ));/*update entry for a host*/
317 Stel*(*st_add) LDAP_P(( St *, Ri * )); /*add a new repl host*/
318 int (*st_write) LDAP_P(( St * )); /* write status to disk */
319 int (*st_read) LDAP_P(( St * )); /* read status info from disk */
320 int (*st_lock) LDAP_P(( St * )); /* read status info from disk */
321 int (*st_unlock) LDAP_P(( St * )); /* read status info from disk */
324 #if defined( HAVE_LWP )
326 thread_t tl_tid; /* thread being managed */
327 time_t tl_wake; /* time thread should be resumed */
328 struct tl *tl_next; /* next node in list */
335 #endif /* HAVE_LWP */
338 * Public functions used to instantiate and initialize queue objects.
340 extern int Ri_init LDAP_P(( Ri **ri ));
341 extern int Rq_init LDAP_P(( Rq **rq ));
342 extern int Re_init LDAP_P(( Re **re ));
344 #include "proto-slurp.h"
348 #endif /* _SLURPD_H_ */