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.
19 * rq.c - routines used to manage the queue of replication entries.
20 * An Rq (Replication queue) struct contains a linked list of Re
21 * (Replication entry) structures.
23 * Routines wishing to access the replication queue should do so through
24 * the Rq struct's member functions, e.g. rq->rq_gethead() and friends.
25 * For example, Re structs should be added to the queue by calling
26 * the rq_add() member function.
28 * Access to the queue is serialized by a mutex. Member functions which do
29 * not do their own locking should only be called after locking the queue
30 * using the rq_lock() member function. The queue should be unlocked with
31 * the rq_unlock() member function.
33 * Note that some member functions handle their own locking internally.
34 * Callers should not lock the queue before calling these functions.
35 * See the comment block for each function below.
44 #include <ac/stdlib.h>
45 #include <ac/string.h>
46 #include <ac/unistd.h> /* get ftruncate() */
48 #ifdef HAVE_SYS_TYPES_H
49 #include <sys/types.h>
60 * Lock the replication queue.
67 return( ldap_pvt_thread_mutex_lock( &rq->rq_mutex ));
72 * Unlock the replication queue.
79 return( ldap_pvt_thread_mutex_unlock( &rq->rq_mutex ));
85 * Return the head of the queue. Callers should lock the queue before
86 * calling this routine.
93 return( rq == NULL ? NULL : rq->rq_head );
98 * Return the next item in the queue. Callers should lock the queue before
99 * calling this routine.
109 return( re->re_getnext( re ));
115 * Delete the item at the head of the list. The queue should be locked
116 * by the caller before calling this routine.
130 savedhead = rq->rq_head;
131 if ( savedhead == NULL ) {
135 if ( savedhead->re_getrefcnt( savedhead ) != 0 ) {
137 LDAP_LOG (( "rq", LDAP_LEVEL_WARNING, "Rq_delhead: "
138 "Warning: attempt to delete when refcnt != 0\n" ));
140 Debug( LDAP_DEBUG_ANY, "Warning: attempt to delete when refcnt != 0\n",
146 rq->rq_head = rq->rq_head->re_getnext( rq->rq_head );
147 rc = savedhead->re_free( savedhead );
148 rq->rq_nre--; /* decrement count of Re's in queue */
154 * Add an entry to the tail of the replication queue. Locking is handled
155 * internally. When items are added to the queue, this routine wakes
156 * up any threads which are waiting for more work by signaling on the
157 * rq->rq_more condition variable.
171 /* Create a new Re */
172 if ( Re_init( &re ) < 0 ) {
177 /* parse buf and fill in the re struct */
178 if ( re->re_parse( re, buf ) < 0 ) {
184 /* Insert into queue */
185 if ( rq->rq_head == NULL ) {
190 rq->rq_tail->re_next = re;
193 /* set the sequence number */
195 if ( !wasempty && ( rq->rq_tail->re_timestamp == re->re_timestamp )) {
197 * Our new re has the same timestamp as the tail's timestamp.
198 * Increment the seq number in the tail and use it as our seq number.
200 re->re_seq = rq->rq_tail->re_seq + 1;
204 /* Increment count of items in queue */
206 /* wake up any threads waiting for more work */
207 ldap_pvt_thread_cond_broadcast( &rq->rq_more );
209 /* ... and unlock the queue */
217 * Garbage-collect the replication queue. Locking is handled internally.
226 LDAP_LOG (( "rq", LDAP_LEVEL_DETAIL1, "Rq_gc: rq is NULL!\n" ));
228 Debug( LDAP_DEBUG_ANY, "Rq_gc: rq is NULL!\n", 0, 0, 0 );
233 while (( rq->rq_head != NULL ) &&
234 ( rq->rq_head->re_getrefcnt( rq->rq_head ) == 0 )) {
235 rq->rq_delhead( rq );
236 rq->rq_ndel++; /* increment count of deleted entries */
244 * For debugging: dump the contents of the replication queue to a file.
245 * Locking is handled internally.
258 LDAP_LOG (( "rq", LDAP_LEVEL_ARGS, "Rq_dump: rq is NULL!\n" ));
260 Debug( LDAP_DEBUG_ANY, "Rq_dump: rq is NULL!\n", 0, 0, 0 );
265 if (unlink(SLURPD_DUMPFILE) == -1 && errno != ENOENT) {
267 LDAP_LOG (( "rq", LDAP_LEVEL_ERR, "Rq_dump: "
268 "\"%s\" exists, cannot unlink\n", SLURPD_DUMPFILE ));
270 Debug( LDAP_DEBUG_ANY, "Rq_dump: \"%s\" exists, and cannot unlink\n",
271 SLURPD_DUMPFILE, 0, 0 );
275 if (( tmpfd = open(SLURPD_DUMPFILE, O_CREAT|O_RDWR|O_EXCL, 0600)) == -1) {
277 LDAP_LOG (( "rq", LDAP_LEVEL_ERR, "Rq_dump: "
278 "cannot open \"%s\" for write\n", SLURPD_DUMPFILE ));
280 Debug( LDAP_DEBUG_ANY, "Rq_dump: cannot open \"%s\" for write\n",
281 SLURPD_DUMPFILE, 0, 0 );
285 if (( fp = fdopen( tmpfd, "w" )) == NULL ) {
287 LDAP_LOG (( "rq", LDAP_LEVEL_ERR, "Rq_dump: "
288 "cannot fdopen \"%s\" for write\n", SLURPD_DUMPFILE ));
290 Debug( LDAP_DEBUG_ANY, "Rq_dump: cannot fdopen \"%s\" for write\n",
291 SLURPD_DUMPFILE, 0, 0 );
297 for ( re = rq->rq_gethead( rq ); re != NULL; re = rq->rq_getnext( re )) {
298 re->re_dump( re, fp );
307 * Write the contents of a replication queue to a file. Returns zero if
308 * successful, -1 if not. Handles queue locking internally. Callers should
309 * provide an open file pointer, which should refer to a locked file.
325 LDAP_LOG (( "rq", LDAP_LEVEL_ENTRY, "Rq_write: "
326 "re-write on-disk replication log\n" ));
328 Debug( LDAP_DEBUG_ARGS, "re-write on-disk replication log\n",
334 fseek( fp, 0L, SEEK_SET ); /* Go to beginning of file */
337 for ( re = rq->rq_gethead( rq ); re != NULL; re = rq->rq_getnext( re )) {
338 if ( re->re_write( NULL, re, fp ) < 0 ) {
345 sglob->srpos = ftell( fp ); /* update replog file position */
346 /* and truncate to correct len */
347 if ( ftruncate( fileno( fp ), sglob->srpos ) < 0 ) {
349 LDAP_LOG (( "rq", LDAP_LEVEL_ERR, "Rq_write: "
350 "Error truncating replication log: %s\n", sys_errlist[ errno ] ));
352 Debug( LDAP_DEBUG_ANY, "Error truncating replication log: %s\n",
353 sys_errlist[ errno ], 0, 0 );
356 rq->rq_ndel = 0; /* reset count of deleted re's */
358 rq->rq_lasttrim = now; /* reset last trim time */
365 * Check to see if the private slurpd replication log needs trimming.
366 * The current criteria are:
367 * - The last trim was more than 5 minutes ago, *and*
368 * - We've finished with at least 50 replication log entries since the
369 * last time we re-wrote the replication log.
371 * Return 1 if replogfile should be trimmed, 0 if not.
372 * Any different policy should be implemented by replacing this function.
390 if ( now > ( rq->rq_lasttrim + TRIMCHECK_INTERVAL )) {
391 rc = ( rq->rq_ndel >= 50 );
401 * Return counts of Re structs in the queue.
417 if ( type == RQ_COUNT_ALL ) {
420 for ( re = rq->rq_gethead( rq ); re != NULL;
421 re = rq->rq_getnext( re )) {
422 if ( type == RQ_COUNT_NZRC ) {
423 if ( re->re_getrefcnt( re ) > 0 ) {
435 * Allocate and initialize an Rq object.
442 /* Instantiate the struct */
443 (*rq) = (Rq *) malloc( sizeof( Rq ));
448 /* Fill in all the function pointers */
449 (*rq)->rq_gethead = Rq_gethead;
450 (*rq)->rq_getnext = Rq_getnext;
451 (*rq)->rq_delhead = Rq_delhead;
452 (*rq)->rq_add = Rq_add;
453 (*rq)->rq_gc = Rq_gc;
454 (*rq)->rq_lock = Rq_lock;
455 (*rq)->rq_unlock = Rq_unlock;
456 (*rq)->rq_dump = Rq_dump;
457 (*rq)->rq_needtrim = Rq_needtrim;
458 (*rq)->rq_write = Rq_write;
459 (*rq)->rq_getcount = Rq_getcount;
461 /* Initialize private data */
462 ldap_pvt_thread_mutex_init( &((*rq)->rq_mutex) );
463 ldap_pvt_thread_cond_init( &((*rq)->rq_more) );
464 (*rq)->rq_head = NULL;
465 (*rq)->rq_tail = NULL;
468 (*rq)->rq_lasttrim = (time_t) 0L;