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 ) {
84 Debug( LDAP_DEBUG_ANY,
85 "Warning: freeing re (dn: %s) with nonzero refcnt\n",
89 ldap_pvt_thread_mutex_destroy( &re->re_mutex );
91 if (( rh = re->re_replicas ) != NULL ) {
92 for ( i = 0; rh[ i ].rh_hostname != NULL; i++ ) {
93 free( rh[ i ].rh_hostname );
98 if (( mi = re->re_mods ) != NULL ) {
99 for ( i = 0; mi[ i ].mi_type != NULL; i++ ) {
100 free( mi[ i ].mi_type );
101 ch_free( mi[ i ].mi_val );
113 * Read a buffer of data from a replication log file and fill in
114 * an (already allocated) Re.
120 #define GOT_CHANGETYPE 4
121 #define GOT_ALL ( GOT_DN | GOT_TIME | GOT_CHANGETYPE )
138 Debug( LDAP_DEBUG_ANY, "Re_parse: error: re is NULL\n", 0, 0, 0 );
141 if ( replbuf == NULL ) {
142 Debug( LDAP_DEBUG_ANY, "Re_parse: error: replbuf is NULL\n", 0, 0, 0 );
147 nml = 0; /* number of modification information entries */
150 re->re_replicas = get_repl_hosts( replbuf, &nreplicas, &rp );
151 re->re_refcnt = sglob->num_replicas;
154 if (( state == GOT_ALL ) || ( buf = ldif_getline( &rp )) == NULL ) {
158 * If we're processing a rejection log, then the first line
159 * of each replication record will begin with "ERROR" - just
162 if ( strncmp( buf, ERROR_STR, strlen( ERROR_STR )) == 0 ) {
165 buflen = strlen( buf );
166 if ( ldif_parse_line( buf, &type, &value, &len ) < 0 ) {
167 Debug( LDAP_DEBUG_ANY,
168 "Error: Re_parse: malformed replog file\n",
172 switch ( gettype( type )) {
174 re->re_changetype = getchangetype( value );
175 state |= GOT_CHANGETYPE;
178 if (( p = strchr( value, '.' )) != NULL ) {
179 /* there was a sequence number */
182 re->re_timestamp = atol( value );
183 if ( p != NULL && isdigit( (unsigned char) *p )) {
184 re->re_seq = atoi( p );
189 re->re_dn = ch_malloc( len + 1 );
190 AC_MEMCPY( re->re_dn, value, len );
191 re->re_dn[ len ]='\0';
195 if ( !( state == GOT_ALL )) {
196 Debug( LDAP_DEBUG_ANY,
197 "Error: Re_parse: bad type <%s>\n",
210 if ( state != GOT_ALL ) {
211 Debug( LDAP_DEBUG_ANY,
212 "Error: Re_parse: malformed replog file\n",
218 char *const dash = "-";
220 if (( buf = ldif_getline( &rp )) == NULL ) {
223 buflen = strlen( buf );
224 if (( buflen == 1 ) && ( buf[ 0 ] == '-' )) {
228 if ( ldif_parse_line( buf, &type, &value, &len ) < 0 ) {
229 Debug( LDAP_DEBUG_ANY,
230 "Error: malformed replog line \"%s\"\n",
235 re->re_mods = ( Mi *) ch_realloc( (char *) re->re_mods,
236 sizeof( Mi ) * ( nml + 2 ));
237 re->re_mods[ nml ].mi_type = strdup( type );
238 if ( value != NULL ) {
239 re->re_mods[ nml ].mi_val = ch_malloc( len + 1 );
240 AC_MEMCPY( re->re_mods[ nml ].mi_val, value, len );
241 re->re_mods[ nml ].mi_val[ len ] = '\0';
242 re->re_mods[ nml ].mi_len = len;
244 re->re_mods[ nml ].mi_val = NULL;
245 re->re_mods[ nml ].mi_len = 0;
247 re->re_mods[ nml + 1 ].mi_type = NULL;
248 re->re_mods[ nml + 1 ].mi_val = NULL;
262 * Extract the replication hosts from a repl buf. Check to be sure that
263 * each replica host and port number are ones we know about (that is, they're
264 * in the slapd config file we read at startup). Without that information
265 * from the config file, we won't have the appropriate credentials to
266 * make modifications. If there are any unknown replica names, don't
267 * add them the the Re struct. Instead, log a warning message.
276 char *type, *value, *line, *p;
284 if ( replbuf == NULL ) {
291 * Get the host names of the replicas
296 /* If this is a reject log, we need to skip over the ERROR: line */
297 if ( !strncmp( *r_rp, ERROR_STR, strlen( ERROR_STR ))) {
298 line = ldif_getline( r_rp );
299 if ( line == NULL ) {
303 if ( strncasecmp( *r_rp, "replica:", 7 )) {
306 line = ldif_getline( r_rp );
307 if ( line == NULL ) {
310 if ( ldif_parse_line( line, &type, &value, &len ) < 0 ) {
314 if (( p = strchr( value, ':' )) != NULL ) {
322 /* Verify that we've heard of this replica before */
324 for ( i = 0; i < sglob->num_replicas; i++ ) {
325 if ( strcmp( sglob->replicas[ i ]->ri_hostname, value )) {
328 if ( sglob->replicas[ i ]->ri_port == port ) {
335 warn_unknown_replica( value, port );
341 rh = (Rh *) ch_realloc((char *) rh, ( nreplicas + 2 ) * sizeof( Rh ));
343 Debug( LDAP_DEBUG_ANY, "Out of memory in get_repl_hosts\n",
347 rh[ nreplicas ].rh_hostname = strdup( value );
348 rh[ nreplicas ].rh_port = port;
355 if ( nreplicas == 0 ) {
359 rh[ nreplicas ].rh_hostname = NULL;
360 *r_nreplicas = nreplicas;
370 * Convert "type" to an int.
377 if ( !strcmp( type, T_CHANGETYPESTR )) {
378 return( T_CHANGETYPE );
380 if ( !strcmp( type, T_TIMESTR )) {
383 if ( !strcmp( type, T_DNSTR )) {
392 * Convert "changetype" to an int.
399 if ( !strcmp( changetype, T_ADDCTSTR )) {
402 if ( !strcmp( changetype, T_MODIFYCTSTR )) {
403 return( T_MODIFYCT );
405 if ( !strcmp( changetype, T_DELETECTSTR )) {
406 return( T_DELETECT );
408 if ( !strcmp( changetype, T_MODRDNCTSTR )) {
409 return( T_MODRDNCT );
418 * Find the first line which is not a "replica:" line in buf.
419 * Returns a pointer to the line. Returns NULL if there are
420 * only "replica:" lines in buf.
429 if ( strncasecmp( p, "replica:", 8 )) {
432 while (( *p != '\0' ) && ( *p != '\n' )) {
447 * For debugging purposes: dump the contents of a replication entry.
448 * to the given stream.
460 Debug( LDAP_DEBUG_TRACE, "Re_dump: re is NULL\n", 0, 0, 0 );
463 fprintf( fp, "Re_dump: ******\n" );
464 fprintf( fp, "re_refcnt: %d\n", re->re_refcnt );
465 fprintf( fp, "re_timestamp: %ld\n", (long) re->re_timestamp );
466 fprintf( fp, "re_seq: %d\n", re->re_seq );
467 for ( i = 0; re->re_replicas && re->re_replicas[ i ].rh_hostname != NULL;
469 fprintf( fp, "re_replicas[%d]: %s:%d\n",
470 i, re->re_replicas[ i ].rh_hostname,
471 re->re_replicas[ i ].rh_port );
473 fprintf( fp, "re_dn: %s\n", re->re_dn );
474 switch ( re->re_changetype ) {
476 fprintf( fp, "re_changetype: add\n" );
479 fprintf( fp, "re_changetype: modify\n" );
482 fprintf( fp, "re_changetype: delete\n" );
485 fprintf( fp, "re_changetype: modrdn\n" );
488 fprintf( fp, "re_changetype: (unknown, type = %d\n",
491 if ( re->re_mods == NULL ) {
492 fprintf( fp, "re_mods: (none)\n" );
495 fprintf( fp, "re_mods:\n" );
496 for ( i = 0; mi[ i ].mi_type != NULL; i++ ) {
497 fprintf( fp, " %s, \"%s\", (%d bytes)\n",
499 mi[ i ].mi_val == NULL ? "(null)" : mi[ i ].mi_val,
508 * Given an Ri, an Re, and a file pointer, write a replication record to
509 * the file pointer. If ri is NULL, then include all replicas in the
510 * output. If ri is non-NULL, then only include a single "replica:" line
511 * (used when writing rejection records). Returns 0 on success, -1
512 * on failure. Note that Re_write will not write anything out if the
525 if ( re == NULL || fp == NULL ) {
526 Debug( LDAP_DEBUG_ANY, "Internal error: Re_write: NULL argument\n",
531 if ( re->re_refcnt < 1 ) {
532 return 0; /* this is not an error */
535 if ( ri != NULL ) { /* write a single "replica:" line */
536 if ( fprintf( fp, "replica: %s:%d\n", ri->ri_hostname,
537 ri->ri_port ) < 0 ) {
541 } else { /* write multiple "replica:" lines */
542 for ( i = 0; re->re_replicas[ i ].rh_hostname != NULL; i++ ) {
543 if ( fprintf( fp, "replica: %s:%d\n",
544 re->re_replicas[ i ].rh_hostname,
545 re->re_replicas[ i ].rh_port ) < 0 ) {
551 if ( fprintf( fp, "time: %ld.%d\n", (long) re->re_timestamp, re->re_seq ) < 0 ) {
555 if ( fprintf( fp, "dn: %s\n", re->re_dn ) < 0 ) {
559 if ( fprintf( fp, "changetype: " ) < 0 ) {
563 switch ( re->re_changetype ) {
577 s = "IllegalModifyType!!!";
579 if ( fprintf( fp, "%s\n", s ) < 0 ) {
583 for ( i = 0; (( re->re_mods != NULL ) &&
584 ( re->re_mods[ i ].mi_type != NULL )); i++ ) {
585 if ( !strcmp( re->re_mods[ i ].mi_type, T_MODSEPSTR )) {
586 if ( fprintf( fp, "%s\n", T_MODSEPSTR ) < 0 ) {
592 obuf = ldif_put( LDIF_PUT_VALUE,
593 re->re_mods[ i ].mi_type,
594 re->re_mods[ i ].mi_val ? re->re_mods[ i ].mi_val : "",
595 re->re_mods[ i ].mi_len );
596 if ( fputs( obuf, fp ) < 0 ) {
605 if ( fprintf( fp, "\n" ) < 0 ) {
609 if ( fflush( fp ) != 0 ) {
615 Debug( LDAP_DEBUG_ANY, "Error while writing: %s\n",
616 sys_errlist[ errno ], 0, 0 );
625 * Decrement the refcnt. Locking handled internally.
641 * Get the refcnt. Locking handled internally.
661 * Lock this replication entry
668 return( ldap_pvt_thread_mutex_lock( &re->re_mutex ));
675 * Unlock this replication entry
682 return( ldap_pvt_thread_mutex_unlock( &re->re_mutex ));
689 * Instantiate and initialize an Re.
697 (*re) = (Re *) malloc( sizeof( Re ));
702 /* Fill in the member function pointers */
703 (*re)->re_free = Re_free;
704 (*re)->re_getnext = Re_getnext;
705 (*re)->re_parse = Re_parse;
706 (*re)->re_write = Re_write;
707 (*re)->re_dump = Re_dump;
708 (*re)->re_lock = Re_lock;
709 (*re)->re_unlock = Re_unlock;
710 (*re)->re_decrefcnt = Re_decrefcnt;
711 (*re)->re_getrefcnt = Re_getrefcnt;
713 /* Initialize private data */
714 (*re)->re_refcnt = sglob->num_replicas;
715 (*re)->re_timestamp = (time_t) 0L;
716 (*re)->re_replicas = NULL;
718 (*re)->re_changetype = 0;
720 (*re)->re_mods = NULL;
721 (*re)->re_next = NULL;
723 ldap_pvt_thread_mutex_init( &((*re)->re_mutex) );
731 * Given a host and port, generate a warning message iff we haven't already
732 * generated a message for this host:port combination.
735 warn_unknown_replica(
743 for ( i = 0; i < nur; i++ ) {
744 if ( strcmp( ur[ i ].rh_hostname, host )) {
747 if ( ur[ i ].rh_port == port ) {
753 Debug( LDAP_DEBUG_ANY,
754 "Warning: unknown replica %s:%d found in replication log\n",
757 ur = (Rh *) ch_realloc( (char *) ur, ( nur * sizeof( Rh )));
758 ur[ nur - 1 ].rh_hostname = strdup( host );
759 ur[ nur - 1 ].rh_port = port;