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 * re.c - routines which deal with Re (Replication entry) structures.
15 * An Re struct is an in-core representation of one replication to
16 * be performed, along with member functions which are called by other
17 * routines. The Re struct is defined in slurp.h.
26 #include <ac/socket.h>
27 #include <ac/string.h>
29 #include "../slapd/slap.h"
34 extern char *str_getline LDAP_P(( char **next ));
35 extern void ch_free LDAP_P(( char *p ));
37 /* Forward references */
38 static Rh *get_repl_hosts LDAP_P(( char *, int *, char ** ));
39 static int gettype LDAP_P(( char * ));
40 static int getchangetype LDAP_P(( char * ));
41 static int Re_parse LDAP_P(( Re *re, char *replbuf ));
42 static void Re_dump LDAP_P(( Re *re, FILE *fp ));
43 static void warn_unknown_replica LDAP_P(( char *, int port ));
45 /* Globals, scoped within this file */
46 static int nur = 0; /* Number of unknown replicas */
47 static Rh *ur = NULL; /* array of unknown replica names */
51 * Return the next Re in a linked list.
58 return(( re == NULL ) ? NULL : re->re_next );
79 if ( re->re_refcnt > 0 ) {
80 Debug( LDAP_DEBUG_ANY,
81 "Warning: freeing re (dn: %s) with nonzero refcnt\n",
84 #if !defined( HAVE_LWP )
85 /* This seems to have problems under SunOS lwp */
86 pthread_mutex_destroy( &re->re_mutex );
88 ch_free( re->re_timestamp );
89 if (( rh = re->re_replicas ) != NULL ) {
90 for ( i = 0; rh[ i ].rh_hostname != NULL; i++ ) {
91 free( rh[ i ].rh_hostname );
96 if (( mi = re->re_mods ) != NULL ) {
97 for ( i = 0; mi[ i ].mi_type != NULL; i++ ) {
98 free( mi[ i ].mi_type );
99 ch_free( mi[ i ].mi_val );
110 * Read a buffer of data from a replication log file and fill in
111 * an (already allocated) Re.
117 #define GOT_CHANGETYPE 4
118 #define GOT_ALL ( GOT_DN | GOT_TIME | GOT_CHANGETYPE )
135 Debug( LDAP_DEBUG_ANY, "Re_parse: error: re is NULL\n", 0, 0, 0 );
138 if ( replbuf == NULL ) {
139 Debug( LDAP_DEBUG_ANY, "Re_parse: error: replbuf is NULL\n", 0, 0, 0 );
144 nml = 0; /* number of modification information entries */
147 re->re_replicas = get_repl_hosts( replbuf, &nreplicas, &rp );
148 re->re_refcnt = sglob->num_replicas;
151 if (( state == GOT_ALL ) || ( buf = str_getline( &rp )) == NULL ) {
155 * If we're processing a rejection log, then the first line
156 * of each replication record will begin with "ERROR" - just
159 if ( strncmp( buf, ERROR_STR, strlen( ERROR_STR )) == 0 ) {
162 buflen = ( long ) strlen( buf );
163 if ( str_parse_line( buf, &type, &value, &len ) < 0 ) {
164 Debug( LDAP_DEBUG_ANY,
165 "Error: Re_parse: malformed replog file\n",
169 switch ( gettype( type )) {
171 re->re_changetype = getchangetype( value );
172 state |= GOT_CHANGETYPE;
175 if (( p = strchr( value, '.' )) != NULL ) {
176 /* there was a sequence number */
179 re->re_timestamp = strdup( value );
180 if ( p != NULL && isdigit( *p )) {
181 re->re_seq = atoi( p );
186 re->re_dn = ch_malloc( len + 1 );
187 memcpy( re->re_dn, value, len );
188 re->re_dn[ len ]='\0';
192 if ( !( state == GOT_ALL )) {
193 Debug( LDAP_DEBUG_ANY,
194 "Error: Re_parse: bad type <%s>\n",
201 if ( state != GOT_ALL ) {
202 Debug( LDAP_DEBUG_ANY,
203 "Error: Re_parse: malformed replog file\n",
209 if (( buf = str_getline( &rp )) == NULL ) {
212 buflen = ( long ) strlen( buf );
213 if (( buflen == 1 ) && ( buf[ 0 ] == '-' )) {
217 if ( str_parse_line( buf, &type, &value, &len ) < 0 ) {
218 Debug( LDAP_DEBUG_ANY,
219 "Error: malformed replog line \"%s\"\n",
224 re->re_mods = ( Mi *) ch_realloc( (char *) re->re_mods,
225 sizeof( Mi ) * ( nml + 2 ));
226 re->re_mods[ nml ].mi_type = strdup( type );
227 if ( value != NULL ) {
228 re->re_mods[ nml ].mi_val = ch_malloc( len + 1 );
229 memcpy( re->re_mods[ nml ].mi_val, value, len );
230 re->re_mods[ nml ].mi_val[ len ] = '\0';
231 re->re_mods[ nml ].mi_len = len;
233 re->re_mods[ nml ].mi_val = NULL;
234 re->re_mods[ nml ].mi_len = 0;
236 re->re_mods[ nml + 1 ].mi_type = NULL;
237 re->re_mods[ nml + 1 ].mi_val = NULL;
246 * Extract the replication hosts from a repl buf. Check to be sure that
247 * each replica host and port number are ones we know about (that is, they're
248 * in the slapd config file we read at startup). Without that information
249 * from the config file, we won't have the appropriate credentials to
250 * make modifications. If there are any unknown replica names, don't
251 * add them the the Re struct. Instead, log a warning message.
260 char buf[ LINE_WIDTH + 1 ];
261 char *type, *value, *line, *p;
268 if ( replbuf == NULL ) {
275 * Get the host names of the replicas
280 /* If this is a reject log, we need to skip over the ERROR: line */
281 if ( !strncmp( *r_rp, ERROR_STR, strlen( ERROR_STR ))) {
282 line = str_getline( r_rp );
283 if ( line == NULL ) {
287 if ( strncasecmp( *r_rp, "replica:", 7 )) {
290 line = str_getline( r_rp );
291 if ( line == NULL ) {
294 if ( str_parse_line( line, &type, &value, &len ) < 0 ) {
298 if (( p = strchr( value, ':' )) != NULL ) {
306 /* Verify that we've heard of this replica before */
308 for ( i = 0; i < sglob->num_replicas; i++ ) {
309 if ( strcmp( sglob->replicas[ i ]->ri_hostname, value )) {
312 if ( sglob->replicas[ i ]->ri_port == port ) {
318 warn_unknown_replica( value, port );
322 rh = (Rh *) ch_realloc((char *) rh, ( nreplicas + 2 ) * sizeof( Rh ));
324 Debug( LDAP_DEBUG_ANY, "Out of memory in get_repl_hosts\n",
328 rh[ nreplicas ].rh_hostname = strdup( value );
329 rh[ nreplicas ].rh_port = port;
333 if ( nreplicas == 0 ) {
337 rh[ nreplicas ].rh_hostname = NULL;
338 *r_nreplicas = nreplicas;
348 * Convert "type" to an int.
355 if ( !strcmp( type, T_CHANGETYPESTR )) {
356 return( T_CHANGETYPE );
358 if ( !strcmp( type, T_TIMESTR )) {
361 if ( !strcmp( type, T_DNSTR )) {
370 * Convert "changetype" to an int.
377 if ( !strcmp( changetype, T_ADDCTSTR )) {
380 if ( !strcmp( changetype, T_MODIFYCTSTR )) {
381 return( T_MODIFYCT );
383 if ( !strcmp( changetype, T_DELETECTSTR )) {
384 return( T_DELETECT );
386 if ( !strcmp( changetype, T_MODRDNCTSTR )) {
387 return( T_MODRDNCT );
396 * Find the first line which is not a "replica:" line in buf.
397 * Returns a pointer to the line. Returns NULL if there are
398 * only "replica:" lines in buf.
407 if ( strncasecmp( p, "replica:", 8 )) {
410 while (( *p != '\0' ) && ( *p != '\n' )) {
425 * For debugging purposes: dump the contents of a replication entry.
426 * to the given stream.
438 Debug( LDAP_DEBUG_TRACE, "Re_dump: re is NULL\n", 0, 0, 0 );
441 fprintf( fp, "Re_dump: ******\n" );
442 fprintf( fp, "re_refcnt: %d\n", re->re_refcnt );
443 fprintf( fp, "re_timestamp: %s\n", re->re_timestamp );
444 fprintf( fp, "re_seq: %d\n", re->re_seq );
445 for ( i = 0; re->re_replicas && re->re_replicas[ i ].rh_hostname != NULL;
447 fprintf( fp, "re_replicas[%d]: %s:%d\n",
448 i, re->re_replicas[ i ].rh_hostname,
449 re->re_replicas[ i ].rh_port );
451 fprintf( fp, "re_dn: %s\n", re->re_dn );
452 switch ( re->re_changetype ) {
454 fprintf( fp, "re_changetype: add\n" );
457 fprintf( fp, "re_changetype: modify\n" );
460 fprintf( fp, "re_changetype: delete\n" );
463 fprintf( fp, "re_changetype: modrdn\n" );
466 fprintf( fp, "re_changetype: (unknown, type = %d\n",
469 if ( re->re_mods == NULL ) {
470 fprintf( fp, "re_mods: (none)\n" );
473 fprintf( fp, "re_mods:\n" );
474 for ( i = 0; mi[ i ].mi_type != NULL; i++ ) {
475 fprintf( fp, " %s, \"%s\", (%d bytes)\n",
477 mi[ i ].mi_val == NULL ? "(null)" : mi[ i ].mi_val,
486 * Given an Ri, an Re, and a file pointer, write a replication record to
487 * the file pointer. If ri is NULL, then include all replicas in the
488 * output. If ri is non-NULL, then only include a single "replica:" line
489 * (used when writing rejection records). Returns 0 on success, -1
490 * on failure. Note that Re_write will not write anything out if the
504 if ( re == NULL || fp == NULL ) {
505 Debug( LDAP_DEBUG_ANY, "Internal error: Re_write: NULL argument\n",
510 if ( re->re_refcnt < 1 ) {
511 return 0; /* this is not an error */
514 if ( ri != NULL ) { /* write a single "replica:" line */
515 if ( fprintf( fp, "replica: %s:%d\n", ri->ri_hostname,
516 ri->ri_port ) < 0 ) {
520 } else { /* write multiple "replica:" lines */
521 for ( i = 0; re->re_replicas[ i ].rh_hostname != NULL; i++ ) {
522 if ( fprintf( fp, "replica: %s:%d\n",
523 re->re_replicas[ i ].rh_hostname,
524 re->re_replicas[ i ].rh_port ) < 0 ) {
530 if ( fprintf( fp, "time: %s.%d\n", re->re_timestamp, re->re_seq ) < 0 ) {
534 if ( fprintf( fp, "dn: %s\n", re->re_dn ) < 0 ) {
538 if ( fprintf( fp, "changetype: " ) < 0 ) {
542 switch ( re->re_changetype ) {
556 s = "IllegalModifyType!!!";
558 if ( fprintf( fp, "%s\n", s ) < 0 ) {
562 for ( i = 0; (( re->re_mods != NULL ) &&
563 ( re->re_mods[ i ].mi_type != NULL )); i++ ) {
564 if ( !strcmp( re->re_mods[ i ].mi_type, T_MODSEPSTR )) {
565 if ( fprintf( fp, "%s\n", T_MODSEPSTR ) < 0 ) {
571 obuf = ldif_type_and_value( re->re_mods[ i ].mi_type,
572 re->re_mods[ i ].mi_val ? re->re_mods[ i ].mi_val : "",
573 re->re_mods[ i ].mi_len );
574 if ( fputs( obuf, fp ) < 0 ) {
583 if ( fprintf( fp, "\n" ) < 0 ) {
587 if ( fflush( fp ) != 0 ) {
593 Debug( LDAP_DEBUG_ANY, "Error while writing: %s\n",
594 sys_errlist[ errno ], 0, 0 );
603 * Decrement the refcnt. Locking handled internally.
619 * Get the refcnt. Locking handled internally.
639 * Lock this replication entry
646 return( pthread_mutex_lock( &re->re_mutex ));
653 * Unlock this replication entry
660 return( pthread_mutex_unlock( &re->re_mutex ));
667 * Instantiate and initialize an Re.
675 (*re) = (Re *) malloc( sizeof( Re ));
680 /* Fill in the member function pointers */
681 (*re)->re_free = Re_free;
682 (*re)->re_getnext = Re_getnext;
683 (*re)->re_parse = Re_parse;
684 (*re)->re_write = Re_write;
685 (*re)->re_dump = Re_dump;
686 (*re)->re_lock = Re_lock;
687 (*re)->re_unlock = Re_unlock;
688 (*re)->re_decrefcnt = Re_decrefcnt;
689 (*re)->re_getrefcnt = Re_getrefcnt;
691 /* Initialize private data */
692 (*re)->re_refcnt = sglob->num_replicas;
693 (*re)->re_timestamp = NULL;
694 (*re)->re_replicas = NULL;
696 (*re)->re_changetype = 0;
698 (*re)->re_mods = NULL;
699 (*re)->re_next = NULL;
701 pthread_mutex_init( &((*re)->re_mutex), pthread_mutexattr_default );
709 * Given a host and port, generate a warning message iff we haven't already
710 * generated a message for this host:port combination.
713 warn_unknown_replica(
721 for ( i = 0; i < nur; i++ ) {
722 if ( strcmp( ur[ i ].rh_hostname, host )) {
725 if ( ur[ i ].rh_port == port ) {
731 Debug( LDAP_DEBUG_ANY,
732 "Warning: unknown replica %s:%d found in replication log\n",
735 ur = (Rh *) ch_realloc( (char *) ur, ( nur * sizeof( Rh )));
736 ur[ nur - 1 ].rh_hostname = strdup( host );
737 ur[ nur - 1 ].rh_port = port;