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 * re.c - routines which deal with Re (Replication entry) structures.
20 * An Re struct is an in-core representation of one replication to
21 * be performed, along with member functions which are called by other
22 * routines. The Re struct is defined in slurp.h.
31 #include <ac/socket.h>
32 #include <ac/string.h>
38 #include "../slapd/slap.h"
40 /* Forward references */
41 static Rh *get_repl_hosts LDAP_P(( char *, int *, char ** ));
42 static int gettype LDAP_P(( char * ));
43 static int getchangetype LDAP_P(( char * ));
44 static int Re_parse LDAP_P(( Re *re, char *replbuf ));
45 static void Re_dump LDAP_P(( Re *re, FILE *fp ));
46 static void warn_unknown_replica LDAP_P(( char *, int port ));
48 /* Globals, scoped within this file */
49 static int nur = 0; /* Number of unknown replicas */
50 static Rh *ur = NULL; /* array of unknown replica names */
54 * Return the next Re in a linked list.
61 return(( re == NULL ) ? NULL : re->re_next );
69 * ??? Something should apparently return nonzero here, but I dont know what.
83 if ( re->re_refcnt > 0 ) {
85 LDAP_LOG (( "re", LDAP_LEVEL_WARNING, "Re_free: "
86 "Warning: freeing re (dn: %s) with nonzero refcnt\n", re->re_dn ));
88 Debug( LDAP_DEBUG_ANY,
89 "Warning: freeing re (dn: %s) with nonzero refcnt\n",
94 ldap_pvt_thread_mutex_destroy( &re->re_mutex );
96 if (( rh = re->re_replicas ) != NULL ) {
97 for ( i = 0; rh[ i ].rh_hostname != NULL; i++ ) {
98 free( rh[ i ].rh_hostname );
102 ch_free( re->re_dn );
103 if (( mi = re->re_mods ) != NULL ) {
104 for ( i = 0; mi[ i ].mi_type != NULL; i++ ) {
105 free( mi[ i ].mi_type );
106 ch_free( mi[ i ].mi_val );
118 * Read a buffer of data from a replication log file and fill in
119 * an (already allocated) Re.
125 #define GOT_CHANGETYPE 4
126 #define GOT_ALL ( GOT_DN | GOT_TIME | GOT_CHANGETYPE )
144 LDAP_LOG (( "re", LDAP_LEVEL_ERR, "Re_parse: Error: re is NULL\n" ));
146 Debug( LDAP_DEBUG_ANY, "Re_parse: error: re is NULL\n", 0, 0, 0 );
150 if ( replbuf == NULL ) {
152 LDAP_LOG (( "re", LDAP_LEVEL_ERR, "Re_parse: Error: replbuf is NULL\n" ));
154 Debug( LDAP_DEBUG_ANY, "Re_parse: error: replbuf is NULL\n", 0, 0, 0 );
160 nml = 0; /* number of modification information entries */
163 re->re_replicas = get_repl_hosts( replbuf, &nreplicas, &rp );
164 re->re_refcnt = sglob->num_replicas;
167 if (( state == GOT_ALL ) || ( buf = ldif_getline( &rp )) == NULL ) {
171 * If we're processing a rejection log, then the first line
172 * of each replication record will begin with "ERROR" - just
175 if ( strncmp( buf, ERROR_STR, strlen( ERROR_STR )) == 0 ) {
178 buflen = strlen( buf );
179 if ( ldif_parse_line( buf, &type, &value, &len ) < 0 ) {
181 LDAP_LOG (( "re", LDAP_LEVEL_ERR,
182 "Re_parse: Error: malformed replog file\n" ));
184 Debug( LDAP_DEBUG_ANY,
185 "Error: Re_parse: malformed replog file\n",
190 switch ( gettype( type )) {
192 re->re_changetype = getchangetype( value );
193 state |= GOT_CHANGETYPE;
196 if (( p = strchr( value, '.' )) != NULL ) {
197 /* there was a sequence number */
200 re->re_timestamp = atol( value );
201 if ( p != NULL && isdigit( (unsigned char) *p )) {
202 re->re_seq = atoi( p );
207 re->re_dn = ch_malloc( len + 1 );
208 AC_MEMCPY( re->re_dn, value, len );
209 re->re_dn[ len ]='\0';
213 if ( !( state == GOT_ALL )) {
215 LDAP_LOG (( "re", LDAP_LEVEL_ERR,
216 "Re_parse: Error: bad type <%s>\n", type ));
218 Debug( LDAP_DEBUG_ANY,
219 "Error: Re_parse: bad type <%s>\n",
233 if ( state != GOT_ALL ) {
235 LDAP_LOG (( "re", LDAP_LEVEL_ERR,
236 "Re_parse: Error: malformed replog file\n" ));
238 Debug( LDAP_DEBUG_ANY,
239 "Error: Re_parse: malformed replog file\n",
246 char *const dash = "-";
248 if (( buf = ldif_getline( &rp )) == NULL ) {
251 buflen = strlen( buf );
252 if (( buflen == 1 ) && ( buf[ 0 ] == '-' )) {
256 if ( ldif_parse_line( buf, &type, &value, &len ) < 0 ) {
258 LDAP_LOG (( "re", LDAP_LEVEL_ERR,
259 "Re_parse: Error: malformed replog line \"%s\"\n", buf ));
261 Debug( LDAP_DEBUG_ANY,
262 "Error: malformed replog line \"%s\"\n",
268 re->re_mods = ( Mi *) ch_realloc( (char *) re->re_mods,
269 sizeof( Mi ) * ( nml + 2 ));
270 re->re_mods[ nml ].mi_type = strdup( type );
271 if ( value != NULL ) {
272 re->re_mods[ nml ].mi_val = ch_malloc( len + 1 );
273 AC_MEMCPY( re->re_mods[ nml ].mi_val, value, len );
274 re->re_mods[ nml ].mi_val[ len ] = '\0';
275 re->re_mods[ nml ].mi_len = len;
277 re->re_mods[ nml ].mi_val = NULL;
278 re->re_mods[ nml ].mi_len = 0;
280 re->re_mods[ nml + 1 ].mi_type = NULL;
281 re->re_mods[ nml + 1 ].mi_val = NULL;
295 * Extract the replication hosts from a repl buf. Check to be sure that
296 * each replica host and port number are ones we know about (that is, they're
297 * in the slapd config file we read at startup). Without that information
298 * from the config file, we won't have the appropriate credentials to
299 * make modifications. If there are any unknown replica names, don't
300 * add them the the Re struct. Instead, log a warning message.
309 char *type, *value, *line, *p;
317 if ( replbuf == NULL ) {
324 * Get the host names of the replicas
329 /* If this is a reject log, we need to skip over the ERROR: line */
330 if ( !strncmp( *r_rp, ERROR_STR, strlen( ERROR_STR ))) {
331 line = ldif_getline( r_rp );
332 if ( line == NULL ) {
336 if ( strncasecmp( *r_rp, "replica:", 7 )) {
339 line = ldif_getline( r_rp );
340 if ( line == NULL ) {
343 if ( ldif_parse_line( line, &type, &value, &len ) < 0 ) {
347 if (( p = strchr( value, ':' )) != NULL ) {
355 /* Verify that we've heard of this replica before */
357 for ( i = 0; i < sglob->num_replicas; i++ ) {
358 if ( strcmp( sglob->replicas[ i ]->ri_hostname, value )) {
361 if ( sglob->replicas[ i ]->ri_port == port ) {
368 warn_unknown_replica( value, port );
374 rh = (Rh *) ch_realloc((char *) rh, ( nreplicas + 2 ) * sizeof( Rh ));
377 LDAP_LOG (( "re", LDAP_LEVEL_ERR,
378 "get_repl_hosts: Out of memory\n" ));
380 Debug( LDAP_DEBUG_ANY, "Out of memory in get_repl_hosts\n",
385 rh[ nreplicas ].rh_hostname = strdup( value );
386 rh[ nreplicas ].rh_port = port;
393 if ( nreplicas == 0 ) {
397 rh[ nreplicas ].rh_hostname = NULL;
398 *r_nreplicas = nreplicas;
408 * Convert "type" to an int.
415 if ( !strcmp( type, T_CHANGETYPESTR )) {
416 return( T_CHANGETYPE );
418 if ( !strcmp( type, T_TIMESTR )) {
421 if ( !strcmp( type, T_DNSTR )) {
430 * Convert "changetype" to an int.
437 if ( !strcmp( changetype, T_ADDCTSTR )) {
440 if ( !strcmp( changetype, T_MODIFYCTSTR )) {
441 return( T_MODIFYCT );
443 if ( !strcmp( changetype, T_DELETECTSTR )) {
444 return( T_DELETECT );
446 if ( !strcmp( changetype, T_MODRDNCTSTR )) {
447 return( T_MODRDNCT );
456 * Find the first line which is not a "replica:" line in buf.
457 * Returns a pointer to the line. Returns NULL if there are
458 * only "replica:" lines in buf.
467 if ( strncasecmp( p, "replica:", 8 )) {
470 while (( *p != '\0' ) && ( *p != '\n' )) {
485 * For debugging purposes: dump the contents of a replication entry.
486 * to the given stream.
499 LDAP_LOG (( "re", LDAP_LEVEL_ERR, "Re_dump: re is NULL\n" ));
501 Debug( LDAP_DEBUG_TRACE, "Re_dump: re is NULL\n", 0, 0, 0 );
505 fprintf( fp, "Re_dump: ******\n" );
506 fprintf( fp, "re_refcnt: %d\n", re->re_refcnt );
507 fprintf( fp, "re_timestamp: %ld\n", (long) re->re_timestamp );
508 fprintf( fp, "re_seq: %d\n", re->re_seq );
509 for ( i = 0; re->re_replicas && re->re_replicas[ i ].rh_hostname != NULL;
511 fprintf( fp, "re_replicas[%d]: %s:%d\n",
512 i, re->re_replicas[ i ].rh_hostname,
513 re->re_replicas[ i ].rh_port );
515 fprintf( fp, "re_dn: %s\n", re->re_dn );
516 switch ( re->re_changetype ) {
518 fprintf( fp, "re_changetype: add\n" );
521 fprintf( fp, "re_changetype: modify\n" );
524 fprintf( fp, "re_changetype: delete\n" );
527 fprintf( fp, "re_changetype: modrdn\n" );
530 fprintf( fp, "re_changetype: (unknown, type = %d\n",
533 if ( re->re_mods == NULL ) {
534 fprintf( fp, "re_mods: (none)\n" );
537 fprintf( fp, "re_mods:\n" );
538 for ( i = 0; mi[ i ].mi_type != NULL; i++ ) {
539 fprintf( fp, " %s, \"%s\", (%d bytes)\n",
541 mi[ i ].mi_val == NULL ? "(null)" : mi[ i ].mi_val,
550 * Given an Ri, an Re, and a file pointer, write a replication record to
551 * the file pointer. If ri is NULL, then include all replicas in the
552 * output. If ri is non-NULL, then only include a single "replica:" line
553 * (used when writing rejection records). Returns 0 on success, -1
554 * on failure. Note that Re_write will not write anything out if the
567 if ( re == NULL || fp == NULL ) {
569 LDAP_LOG (( "re", LDAP_LEVEL_ERR,
570 "Re_write: Internal error: NULL argument\n" ));
572 Debug( LDAP_DEBUG_ANY, "Internal error: Re_write: NULL argument\n",
578 if ( re->re_refcnt < 1 ) {
579 return 0; /* this is not an error */
582 if ( ri != NULL ) { /* write a single "replica:" line */
583 if ( fprintf( fp, "replica: %s:%d\n", ri->ri_hostname,
584 ri->ri_port ) < 0 ) {
588 } else { /* write multiple "replica:" lines */
589 for ( i = 0; re->re_replicas[ i ].rh_hostname != NULL; i++ ) {
590 if ( fprintf( fp, "replica: %s:%d\n",
591 re->re_replicas[ i ].rh_hostname,
592 re->re_replicas[ i ].rh_port ) < 0 ) {
598 if ( fprintf( fp, "time: %ld.%d\n", (long) re->re_timestamp, re->re_seq ) < 0 ) {
602 if ( fprintf( fp, "dn: %s\n", re->re_dn ) < 0 ) {
606 if ( fprintf( fp, "changetype: " ) < 0 ) {
610 switch ( re->re_changetype ) {
624 s = "IllegalModifyType!!!";
626 if ( fprintf( fp, "%s\n", s ) < 0 ) {
630 for ( i = 0; (( re->re_mods != NULL ) &&
631 ( re->re_mods[ i ].mi_type != NULL )); i++ ) {
632 if ( !strcmp( re->re_mods[ i ].mi_type, T_MODSEPSTR )) {
633 if ( fprintf( fp, "%s\n", T_MODSEPSTR ) < 0 ) {
639 obuf = ldif_put( LDIF_PUT_VALUE,
640 re->re_mods[ i ].mi_type,
641 re->re_mods[ i ].mi_val ? re->re_mods[ i ].mi_val : "",
642 re->re_mods[ i ].mi_len );
643 if ( fputs( obuf, fp ) < 0 ) {
652 if ( fprintf( fp, "\n" ) < 0 ) {
656 if ( fflush( fp ) != 0 ) {
663 LDAP_LOG (( "re", LDAP_LEVEL_ERR,
664 "Re_write: Error while writing: %s\n", sys_errlist[ errno ] ));
666 Debug( LDAP_DEBUG_ANY, "Error while writing: %s\n",
667 sys_errlist[ errno ], 0, 0 );
677 * Decrement the refcnt. Locking handled internally.
693 * Get the refcnt. Locking handled internally.
713 * Lock this replication entry
720 return( ldap_pvt_thread_mutex_lock( &re->re_mutex ));
727 * Unlock this replication entry
734 return( ldap_pvt_thread_mutex_unlock( &re->re_mutex ));
741 * Instantiate and initialize an Re.
749 (*re) = (Re *) malloc( sizeof( Re ));
754 /* Fill in the member function pointers */
755 (*re)->re_free = Re_free;
756 (*re)->re_getnext = Re_getnext;
757 (*re)->re_parse = Re_parse;
758 (*re)->re_write = Re_write;
759 (*re)->re_dump = Re_dump;
760 (*re)->re_lock = Re_lock;
761 (*re)->re_unlock = Re_unlock;
762 (*re)->re_decrefcnt = Re_decrefcnt;
763 (*re)->re_getrefcnt = Re_getrefcnt;
765 /* Initialize private data */
766 (*re)->re_refcnt = sglob->num_replicas;
767 (*re)->re_timestamp = (time_t) 0L;
768 (*re)->re_replicas = NULL;
770 (*re)->re_changetype = 0;
772 (*re)->re_mods = NULL;
773 (*re)->re_next = NULL;
775 ldap_pvt_thread_mutex_init( &((*re)->re_mutex) );
783 * Given a host and port, generate a warning message iff we haven't already
784 * generated a message for this host:port combination.
787 warn_unknown_replica(
795 for ( i = 0; i < nur; i++ ) {
796 if ( strcmp( ur[ i ].rh_hostname, host )) {
799 if ( ur[ i ].rh_port == port ) {
806 LDAP_LOG (( "re", LDAP_LEVEL_WARNING, "warn_unknown_replica: "
807 "Warning: unknown replica %s:%d found in replication log\n",
810 Debug( LDAP_DEBUG_ANY,
811 "Warning: unknown replica %s:%d found in replication log\n",
815 ur = (Rh *) ch_realloc( (char *) ur, ( nur * sizeof( Rh )));
816 ur[ nur - 1 ].rh_hostname = strdup( host );
817 ur[ nur - 1 ].rh_port = port;