3 * Copyright 1998-2003 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.
30 #include <ac/stdlib.h>
32 #include <ac/socket.h>
33 #include <ac/string.h>
36 #include "../slapd/slap.h"
41 /* Forward references */
42 static Rh *get_repl_hosts LDAP_P(( char *, int *, char ** ));
43 static int gettype LDAP_P(( char * ));
44 static int getchangetype LDAP_P(( char * ));
45 static int Re_parse LDAP_P(( Re *re, char *replbuf ));
46 static void Re_dump LDAP_P(( Re *re, FILE *fp ));
47 static void warn_unknown_replica LDAP_P(( char *, int port ));
49 /* Globals, scoped within this file */
50 static int nur = 0; /* Number of unknown replicas */
51 static Rh *ur = NULL; /* array of unknown replica names */
55 * Return the next Re in a linked list.
62 return(( re == NULL ) ? NULL : re->re_next );
70 * ??? Something should apparently return nonzero here, but I dont know what.
84 if ( re->re_refcnt > 0 ) {
86 LDAP_LOG ( SLURPD, WARNING, "Re_free: "
87 "Warning: freeing re (dn: %s) with nonzero refcnt\n", re->re_dn, 0, 0 );
89 Debug( LDAP_DEBUG_ANY,
90 "Warning: freeing re (dn: %s) with nonzero refcnt\n",
95 ldap_pvt_thread_mutex_destroy( &re->re_mutex );
97 if (( rh = re->re_replicas ) != NULL ) {
98 for ( i = 0; rh[ i ].rh_hostname != NULL; i++ ) {
99 free( rh[ i ].rh_hostname );
103 ch_free( re->re_dn );
104 if (( mi = re->re_mods ) != NULL ) {
105 for ( i = 0; mi[ i ].mi_type != NULL; i++ ) {
106 free( mi[ i ].mi_type );
107 ch_free( mi[ i ].mi_val );
119 * Read a buffer of data from a replication log file and fill in
120 * an (already allocated) Re.
126 #define GOT_CHANGETYPE 4
127 #define GOT_ALL ( GOT_DN | GOT_TIME | GOT_CHANGETYPE )
145 LDAP_LOG ( SLURPD, ERR, "Re_parse: Error: re is NULL\n", 0, 0, 0 );
147 Debug( LDAP_DEBUG_ANY, "Re_parse: error: re is NULL\n", 0, 0, 0 );
151 if ( replbuf == NULL ) {
153 LDAP_LOG ( SLURPD, ERR, "Re_parse: Error: replbuf is NULL\n", 0, 0, 0 );
155 Debug( LDAP_DEBUG_ANY, "Re_parse: error: replbuf is NULL\n", 0, 0, 0 );
161 nml = 0; /* number of modification information entries */
164 re->re_replicas = get_repl_hosts( replbuf, &nreplicas, &rp );
165 re->re_refcnt = sglob->num_replicas;
168 if (( state == GOT_ALL ) || ( buf = ldif_getline( &rp )) == NULL ) {
172 * If we're processing a rejection log, then the first line
173 * of each replication record will begin with "ERROR" - just
176 if ( strncmp( buf, ERROR_STR, strlen( ERROR_STR )) == 0 ) {
179 buflen = strlen( buf );
180 if ( ldif_parse_line( buf, &type, &value, &len ) < 0 ) {
182 LDAP_LOG ( SLURPD, ERR,
183 "Re_parse: Error: malformed replog file\n", 0, 0, 0 );
185 Debug( LDAP_DEBUG_ANY,
186 "Error: Re_parse: malformed replog file\n",
191 switch ( gettype( type )) {
193 re->re_changetype = getchangetype( value );
194 state |= GOT_CHANGETYPE;
197 if (( p = strchr( value, '.' )) != NULL ) {
198 /* there was a sequence number */
201 re->re_timestamp = atol( value );
202 if ( p != NULL && isdigit( (unsigned char) *p )) {
203 re->re_seq = atoi( p );
208 re->re_dn = ch_malloc( len + 1 );
209 AC_MEMCPY( re->re_dn, value, len );
210 re->re_dn[ len ]='\0';
214 if ( !( state == GOT_ALL )) {
216 LDAP_LOG ( SLURPD, ERR,
217 "Re_parse: Error: bad type <%s>\n", type, 0, 0 );
219 Debug( LDAP_DEBUG_ANY,
220 "Error: Re_parse: bad type <%s>\n",
232 if ( state != GOT_ALL ) {
234 LDAP_LOG ( SLURPD, ERR,
235 "Re_parse: Error: malformed replog file\n", 0, 0, 0 );
237 Debug( LDAP_DEBUG_ANY,
238 "Error: Re_parse: malformed replog file\n",
245 char *const dash = "-";
247 if (( buf = ldif_getline( &rp )) == NULL ) {
250 buflen = strlen( buf );
251 if (( buflen == 1 ) && ( buf[ 0 ] == '-' )) {
255 if ( ldif_parse_line( buf, &type, &value, &len ) < 0 ) {
257 LDAP_LOG ( SLURPD, ERR,
258 "Re_parse: Error: malformed replog line \"%s\"\n", buf, 0, 0 );
260 Debug( LDAP_DEBUG_ANY,
261 "Error: malformed replog line \"%s\"\n",
267 re->re_mods = ( Mi *) ch_realloc( (char *) re->re_mods,
268 sizeof( Mi ) * ( nml + 2 ));
269 re->re_mods[ nml ].mi_type = strdup( type );
270 if ( value != NULL ) {
271 re->re_mods[ nml ].mi_val = ch_malloc( len + 1 );
272 AC_MEMCPY( re->re_mods[ nml ].mi_val, value, len );
273 re->re_mods[ nml ].mi_val[ len ] = '\0';
274 re->re_mods[ nml ].mi_len = len;
276 re->re_mods[ nml ].mi_val = NULL;
277 re->re_mods[ nml ].mi_len = 0;
279 re->re_mods[ nml + 1 ].mi_type = NULL;
280 re->re_mods[ nml + 1 ].mi_val = NULL;
294 * Extract the replication hosts from a repl buf. Check to be sure that
295 * each replica host and port number are ones we know about (that is, they're
296 * in the slapd config file we read at startup). Without that information
297 * from the config file, we won't have the appropriate credentials to
298 * make modifications. If there are any unknown replica names, don't
299 * add them the the Re struct. Instead, log a warning message.
308 char *type, *value, *line, *p;
316 if ( replbuf == NULL ) {
323 * Get the host names of the replicas
328 /* If this is a reject log, we need to skip over the ERROR: line */
329 if ( !strncmp( *r_rp, ERROR_STR, strlen( ERROR_STR ))) {
330 line = ldif_getline( r_rp );
331 if ( line == NULL ) {
335 if ( strncasecmp( *r_rp, "replica:", 7 )) {
338 line = ldif_getline( r_rp );
339 if ( line == NULL ) {
342 if ( ldif_parse_line( line, &type, &value, &len ) < 0 ) {
346 if (( p = strchr( value, ':' )) != NULL ) {
354 /* Verify that we've heard of this replica before */
356 for ( i = 0; i < sglob->num_replicas; i++ ) {
357 if ( strcmp( sglob->replicas[ i ]->ri_hostname, value )) {
360 if ( sglob->replicas[ i ]->ri_port == port ) {
367 warn_unknown_replica( value, port );
372 rh = (Rh *) ch_realloc((char *) rh, ( nreplicas + 2 ) * sizeof( Rh ));
375 LDAP_LOG ( SLURPD, ERR,
376 "get_repl_hosts: Out of memory\n", 0, 0, 0 );
378 Debug( LDAP_DEBUG_ANY, "Out of memory in get_repl_hosts\n",
383 rh[ nreplicas ].rh_hostname = strdup( value );
384 rh[ nreplicas ].rh_port = port;
390 if ( nreplicas == 0 ) {
394 rh[ nreplicas ].rh_hostname = NULL;
395 *r_nreplicas = nreplicas;
405 * Convert "type" to an int.
412 if ( !strcmp( type, T_CHANGETYPESTR )) {
413 return( T_CHANGETYPE );
415 if ( !strcmp( type, T_TIMESTR )) {
418 if ( !strcmp( type, T_DNSTR )) {
427 * Convert "changetype" to an int.
434 if ( !strcmp( changetype, T_ADDCTSTR )) {
437 if ( !strcmp( changetype, T_MODIFYCTSTR )) {
438 return( T_MODIFYCT );
440 if ( !strcmp( changetype, T_DELETECTSTR )) {
441 return( T_DELETECT );
443 if ( !strcmp( changetype, T_MODRDNCTSTR )) {
444 return( T_MODRDNCT );
453 * Find the first line which is not a "replica:" line in buf.
454 * Returns a pointer to the line. Returns NULL if there are
455 * only "replica:" lines in buf.
464 if ( strncasecmp( p, "replica:", 8 )) {
467 while (( *p != '\0' ) && ( *p != '\n' )) {
482 * For debugging purposes: dump the contents of a replication entry.
483 * to the given stream.
496 LDAP_LOG ( SLURPD, ERR, "Re_dump: re is NULL\n", 0, 0, 0 );
498 Debug( LDAP_DEBUG_TRACE, "Re_dump: re is NULL\n", 0, 0, 0 );
502 fprintf( fp, "Re_dump: ******\n" );
503 fprintf( fp, "re_refcnt: %d\n", re->re_refcnt );
504 fprintf( fp, "re_timestamp: %ld\n", (long) re->re_timestamp );
505 fprintf( fp, "re_seq: %d\n", re->re_seq );
506 for ( i = 0; re->re_replicas && re->re_replicas[ i ].rh_hostname != NULL;
508 fprintf( fp, "re_replicas[%d]: %s:%d\n",
509 i, re->re_replicas[ i ].rh_hostname,
510 re->re_replicas[ i ].rh_port );
512 fprintf( fp, "re_dn: %s\n", re->re_dn );
513 switch ( re->re_changetype ) {
515 fprintf( fp, "re_changetype: add\n" );
518 fprintf( fp, "re_changetype: modify\n" );
521 fprintf( fp, "re_changetype: delete\n" );
524 fprintf( fp, "re_changetype: modrdn\n" );
527 fprintf( fp, "re_changetype: (unknown, type = %d\n",
530 if ( re->re_mods == NULL ) {
531 fprintf( fp, "re_mods: (none)\n" );
534 fprintf( fp, "re_mods:\n" );
535 for ( i = 0; mi[ i ].mi_type != NULL; i++ ) {
536 fprintf( fp, " %s, \"%s\", (%d bytes)\n",
538 mi[ i ].mi_val == NULL ? "(null)" : mi[ i ].mi_val,
547 * Given an Ri, an Re, and a file pointer, write a replication record to
548 * the file pointer. If ri is NULL, then include all replicas in the
549 * output. If ri is non-NULL, then only include a single "replica:" line
550 * (used when writing rejection records). Returns 0 on success, -1
551 * on failure. Note that Re_write will not write anything out if the
564 if ( re == NULL || fp == NULL ) {
566 LDAP_LOG ( SLURPD, ERR,
567 "Re_write: Internal error: NULL argument\n", 0, 0, 0 );
569 Debug( LDAP_DEBUG_ANY, "Internal error: Re_write: NULL argument\n",
575 if ( re->re_refcnt < 1 ) {
576 return 0; /* this is not an error */
579 if ( ri != NULL ) { /* write a single "replica:" line */
580 if ( fprintf( fp, "replica: %s:%d\n", ri->ri_hostname,
581 ri->ri_port ) < 0 ) {
585 } else { /* write multiple "replica:" lines */
586 for ( i = 0; re->re_replicas && re->re_replicas[ i ].rh_hostname != NULL; i++ ) {
587 if ( fprintf( fp, "replica: %s:%d\n",
588 re->re_replicas[ i ].rh_hostname,
589 re->re_replicas[ i ].rh_port ) < 0 ) {
595 if ( fprintf( fp, "time: %ld.%d\n", (long) re->re_timestamp, re->re_seq ) < 0 ) {
599 if ( fprintf( fp, "dn: %s\n", re->re_dn ) < 0 ) {
603 if ( fprintf( fp, "changetype: " ) < 0 ) {
607 switch ( re->re_changetype ) {
621 s = "IllegalModifyType!!!";
623 if ( fprintf( fp, "%s\n", s ) < 0 ) {
627 for ( i = 0; (( re->re_mods != NULL ) &&
628 ( re->re_mods[ i ].mi_type != NULL )); i++ ) {
629 if ( !strcmp( re->re_mods[ i ].mi_type, T_MODSEPSTR )) {
630 if ( fprintf( fp, "%s\n", T_MODSEPSTR ) < 0 ) {
636 obuf = ldif_put( LDIF_PUT_VALUE,
637 re->re_mods[ i ].mi_type,
638 re->re_mods[ i ].mi_val ? re->re_mods[ i ].mi_val : "",
639 re->re_mods[ i ].mi_len );
640 if ( fputs( obuf, fp ) < 0 ) {
649 if ( fprintf( fp, "\n" ) < 0 ) {
653 if ( fflush( fp ) != 0 ) {
660 LDAP_LOG ( SLURPD, ERR,
661 "Re_write: Error while writing: %s\n", sys_errlist[ errno ], 0, 0 );
663 Debug( LDAP_DEBUG_ANY, "Error while writing: %s\n",
664 sys_errlist[ errno ], 0, 0 );
674 * Decrement the refcnt. Locking handled internally.
690 * Get the refcnt. Locking handled internally.
710 * Lock this replication entry
717 return( ldap_pvt_thread_mutex_lock( &re->re_mutex ));
724 * Unlock this replication entry
731 return( ldap_pvt_thread_mutex_unlock( &re->re_mutex ));
738 * Instantiate and initialize an Re.
746 (*re) = (Re *) malloc( sizeof( Re ));
751 /* Fill in the member function pointers */
752 (*re)->re_free = Re_free;
753 (*re)->re_getnext = Re_getnext;
754 (*re)->re_parse = Re_parse;
755 (*re)->re_write = Re_write;
756 (*re)->re_dump = Re_dump;
757 (*re)->re_lock = Re_lock;
758 (*re)->re_unlock = Re_unlock;
759 (*re)->re_decrefcnt = Re_decrefcnt;
760 (*re)->re_getrefcnt = Re_getrefcnt;
762 /* Initialize private data */
763 (*re)->re_refcnt = sglob->num_replicas;
764 (*re)->re_timestamp = (time_t) 0L;
765 (*re)->re_replicas = NULL;
767 (*re)->re_changetype = 0;
769 (*re)->re_mods = NULL;
770 (*re)->re_next = NULL;
772 ldap_pvt_thread_mutex_init( &((*re)->re_mutex) );
780 * Given a host and port, generate a warning message iff we haven't already
781 * generated a message for this host:port combination.
784 warn_unknown_replica(
792 for ( i = 0; i < nur; i++ ) {
793 if ( strcmp( ur[ i ].rh_hostname, host )) {
796 if ( ur[ i ].rh_port == port ) {
803 LDAP_LOG ( SLURPD, WARNING, "warn_unknown_replica: "
804 "Warning: unknown replica %s:%d found in replication log\n",
807 Debug( LDAP_DEBUG_ANY,
808 "Warning: unknown replica %s:%d found in replication log\n",
812 ur = (Rh *) ch_realloc( (char *) ur, ( nur * sizeof( Rh )));
813 ur[ nur - 1 ].rh_hostname = strdup( host );
814 ur[ nur - 1 ].rh_port = port;