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.
14 * rq.c - routines used to manage the queue of replication entries.
15 * An Rq (Replication queue) struct contains a linked list of Re
16 * (Replication entry) structures.
18 * Routines wishing to access the replication queue should do so through
19 * the Rq struct's member functions, e.g. rq->rq_gethead() and friends.
20 * For example, Re structs should be added to the queue by calling
21 * the rq_add() member function.
23 * Access to the queue is serialized by a mutex. Member functions which do
24 * not do their own locking should only be called after locking the queue
25 * using the rq_lock() member function. The queue should be unlocked with
26 * the rq_unlock() member function.
28 * Note that some member functions handle their own locking internally.
29 * Callers should not lock the queue before calling these functions.
30 * See the comment block for each function below.
38 #include <ac/stdlib.h>
39 #include <ac/unistd.h> /* get ftruncate() */
46 * Lock the replication queue.
53 return( ldap_pvt_thread_mutex_lock( &rq->rq_mutex ));
58 * Unlock the replication queue.
65 return( ldap_pvt_thread_mutex_unlock( &rq->rq_mutex ));
71 * Return the head of the queue. Callers should lock the queue before
72 * calling this routine.
79 return( rq == NULL ? NULL : rq->rq_head );
84 * Return the next item in the queue. Callers should lock the queue before
85 * calling this routine.
95 return( re->re_getnext( re ));
101 * Delete the item at the head of the list. The queue should be locked
102 * by the caller before calling this routine.
116 savedhead = rq->rq_head;
117 if ( savedhead == NULL ) {
121 if ( savedhead->re_getrefcnt( savedhead ) != 0 ) {
122 Debug( LDAP_DEBUG_ANY, "Warning: attempt to delete when refcnt != 0\n",
127 rq->rq_head = rq->rq_head->re_getnext( rq->rq_head );
128 rc = savedhead->re_free( savedhead );
129 rq->rq_nre--; /* decrement count of Re's in queue */
135 * Add an entry to the tail of the replication queue. Locking is handled
136 * internally. When items are added to the queue, this routine wakes
137 * up any threads which are waiting for more work by signaling on the
138 * rq->rq_more condition variable.
152 /* Create a new Re */
153 if ( Re_init( &re ) < 0 ) {
158 /* parse buf and fill in the re struct */
159 if ( re->re_parse( re, buf ) < 0 ) {
165 /* Insert into queue */
166 if ( rq->rq_head == NULL ) {
171 rq->rq_tail->re_next = re;
174 /* set the sequence number */
176 if ( !wasempty && !strcmp(rq->rq_tail->re_timestamp, re->re_timestamp )) {
178 * Our new re has the same timestamp as the tail's timestamp.
179 * Increment the seq number in the tail and use it as our seq number.
181 re->re_seq = rq->rq_tail->re_seq + 1;
185 /* Increment count of items in queue */
187 /* wake up any threads waiting for more work */
188 ldap_pvt_thread_cond_broadcast( &rq->rq_more );
190 /* ... and unlock the queue */
198 * Garbage-collect the replication queue. Locking is handled internally.
206 Debug( LDAP_DEBUG_ANY, "Rq_gc: rq is NULL!\n", 0, 0, 0 );
210 while (( rq->rq_head != NULL ) &&
211 ( rq->rq_head->re_getrefcnt( rq->rq_head ) == 0 )) {
212 rq->rq_delhead( rq );
213 rq->rq_ndel++; /* increment count of deleted entries */
221 * For debugging: dump the contents of the replication queue to a file.
222 * Locking is handled internally.
233 Debug( LDAP_DEBUG_ANY, "Rq_dump: rq is NULL!\n", 0, 0, 0 );
237 if (( fp = fopen( SLURPD_DUMPFILE, "w" )) == NULL ) {
238 Debug( LDAP_DEBUG_ANY, "Rq_dump: cannot open \"%s\" for write\n",
239 SLURPD_DUMPFILE, 0, 0 );
244 for ( re = rq->rq_gethead( rq ); re != NULL; re = rq->rq_getnext( re )) {
245 re->re_dump( re, fp );
254 * Write the contents of a replication queue to a file. Returns zero if
255 * successful, -1 if not. Handles queue locking internally. Callers should
256 * provide an open file pointer, which should refer to a locked file.
271 Debug( LDAP_DEBUG_ARGS, "re-write on-disk replication log\n",
276 fseek( fp, 0L, SEEK_SET ); /* Go to beginning of file */
279 for ( re = rq->rq_gethead( rq ); re != NULL; re = rq->rq_getnext( re )) {
280 if ( re->re_write( NULL, re, fp ) < 0 ) {
287 sglob->srpos = ftell( fp ); /* update replog file position */
288 /* and truncate to correct len */
289 if ( ftruncate( fileno( fp ), sglob->srpos ) < 0 ) {
290 Debug( LDAP_DEBUG_ANY, "Error truncating replication log: %s\n",
291 sys_errlist[ errno ], 0, 0 );
293 rq->rq_ndel = 0; /* reset count of deleted re's */
295 rq->rq_lasttrim = now; /* reset last trim time */
302 * Check to see if the private slurpd replication log needs trimming.
303 * The current criteria are:
304 * - The last trim was more than 5 minutes ago, *and*
305 * - We've finished with at least 50 replication log entries since the
306 * last time we re-wrote the replication log.
308 * Return 1 if replogfile should be trimmed, 0 if not.
309 * Any different policy should be implemented by replacing this function.
318 int nzrc = 0; /* nzrc is count of entries with refcnt == 0 */
329 if ( now > ( rq->rq_lasttrim + TRIMCHECK_INTERVAL )) {
330 rc = ( rq->rq_ndel >= 50 );
340 * Return counts of Re structs in the queue.
356 if ( type == RQ_COUNT_ALL ) {
359 for ( re = rq->rq_gethead( rq ); re != NULL;
360 re = rq->rq_getnext( re )) {
361 if ( type == RQ_COUNT_NZRC ) {
362 if ( re->re_getrefcnt( re ) > 1 ) {
374 * Allocate and initialize an Rq object.
381 /* Instantiate the struct */
382 (*rq) = (Rq *) malloc( sizeof( Rq ));
387 /* Fill in all the function pointers */
388 (*rq)->rq_gethead = Rq_gethead;
389 (*rq)->rq_getnext = Rq_getnext;
390 (*rq)->rq_delhead = Rq_delhead;
391 (*rq)->rq_add = Rq_add;
392 (*rq)->rq_gc = Rq_gc;
393 (*rq)->rq_lock = Rq_lock;
394 (*rq)->rq_unlock = Rq_unlock;
395 (*rq)->rq_dump = Rq_dump;
396 (*rq)->rq_needtrim = Rq_needtrim;
397 (*rq)->rq_write = Rq_write;
398 (*rq)->rq_getcount = Rq_getcount;
400 /* Initialize private data */
401 ldap_pvt_thread_mutex_init( &((*rq)->rq_mutex) );
402 ldap_pvt_thread_cond_init( &((*rq)->rq_more) );
403 (*rq)->rq_head = NULL;
404 (*rq)->rq_tail = NULL;
407 (*rq)->rq_lasttrim = (time_t) 0L;