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.
23 #include <sys/types.h>
24 #include <sys/socket.h>
26 #include "../slapd/slap.h"
31 extern char *str_getline( char **next );
32 extern void ch_free( char *p );
34 #ifndef SYSERRLIST_IN_STDIO
35 extern char *sys_errlist[];
36 #endif /* SYSERRLIST_IN_STDIO */
38 /* Forward references */
39 static Rh *get_repl_hosts( char *, int *, char ** );
40 static int gettype( char * );
41 static int getchangetype( char *);
42 static int Re_parse( Re *re, char *replbuf );
43 static void Re_dump( Re *re, FILE *fp );
44 static void warn_unknown_replica( char *, int port );
46 /* Globals, scoped within this file */
47 static int nur = 0; /* Number of unknown replicas */
48 static Rh *ur = NULL; /* array of unknown replica names */
52 * Return the next Re in a linked list.
59 return(( re == NULL ) ? NULL : re->re_next );
80 if ( re->re_refcnt > 0 ) {
81 Debug( LDAP_DEBUG_ANY,
82 "Warning: freeing re (dn: %s) with nonzero refcnt\n",
85 #if !defined( THREAD_SUNOS4_LWP )
86 /* This seems to have problems under SunOS lwp */
87 pthread_mutex_destroy( &re->re_mutex );
88 #endif /* THREAD_SUNOS4_LWP */
89 ch_free( re->re_timestamp );
90 if (( rh = re->re_replicas ) != NULL ) {
91 for ( i = 0; rh[ i ].rh_hostname != NULL; i++ ) {
92 free( rh[ i ].rh_hostname );
97 if (( mi = re->re_mods ) != NULL ) {
98 for ( i = 0; mi[ i ].mi_type != NULL; i++ ) {
99 free( mi[ i ].mi_type );
100 ch_free( mi[ i ].mi_val );
111 * Read a buffer of data from a replication log file and fill in
112 * an (already allocated) Re.
118 #define GOT_CHANGETYPE 4
119 #define GOT_ALL ( GOT_DN | GOT_TIME | GOT_CHANGETYPE )
136 Debug( LDAP_DEBUG_ANY, "Re_parse: error: re is NULL\n", 0, 0, 0 );
139 if ( replbuf == NULL ) {
140 Debug( LDAP_DEBUG_ANY, "Re_parse: error: replbuf is NULL\n", 0, 0, 0 );
145 nml = 0; /* number of modification information entries */
148 re->re_replicas = get_repl_hosts( replbuf, &nreplicas, &rp );
149 re->re_refcnt = sglob->num_replicas;
152 if (( state == GOT_ALL ) || ( buf = str_getline( &rp )) == NULL ) {
156 * If we're processing a rejection log, then the first line
157 * of each replication record will begin with "ERROR" - just
160 if ( strncmp( buf, ERROR_STR, strlen( ERROR_STR )) == 0 ) {
163 buflen = ( long ) strlen( buf );
164 if ( str_parse_line( buf, &type, &value, &len ) < 0 ) {
165 Debug( LDAP_DEBUG_ANY,
166 "Error: Re_parse: malformed replog file\n",
170 switch ( gettype( type )) {
172 re->re_changetype = getchangetype( value );
173 state |= GOT_CHANGETYPE;
176 if (( p = strchr( value, '.' )) != NULL ) {
177 /* there was a sequence number */
180 re->re_timestamp = strdup( value );
181 if ( p != NULL && isdigit( *p )) {
182 re->re_seq = atoi( p );
187 re->re_dn = ch_malloc( len + 1 );
188 memcpy( re->re_dn, value, len );
189 re->re_dn[ len ]='\0';
193 if ( !( state == GOT_ALL )) {
194 Debug( LDAP_DEBUG_ANY,
195 "Error: Re_parse: bad type <%s>\n",
202 if ( state != GOT_ALL ) {
203 Debug( LDAP_DEBUG_ANY,
204 "Error: Re_parse: malformed replog file\n",
210 if (( buf = str_getline( &rp )) == NULL ) {
213 buflen = ( long ) strlen( buf );
214 if (( buflen == 1 ) && ( buf[ 0 ] == '-' )) {
218 if ( str_parse_line( buf, &type, &value, &len ) < 0 ) {
219 Debug( LDAP_DEBUG_ANY,
220 "Error: malformed replog line \"%s\"\n",
225 re->re_mods = ( Mi *) ch_realloc( (char *) re->re_mods,
226 sizeof( Mi ) * ( nml + 2 ));
227 re->re_mods[ nml ].mi_type = strdup( type );
228 if ( value != NULL ) {
229 re->re_mods[ nml ].mi_val = ch_malloc( len + 1 );
230 memcpy( re->re_mods[ nml ].mi_val, value, len );
231 re->re_mods[ nml ].mi_val[ len ] = '\0';
232 re->re_mods[ nml ].mi_len = len;
234 re->re_mods[ nml ].mi_val = NULL;
235 re->re_mods[ nml ].mi_len = 0;
237 re->re_mods[ nml + 1 ].mi_type = NULL;
238 re->re_mods[ nml + 1 ].mi_val = NULL;
247 * Extract the replication hosts from a repl buf. Check to be sure that
248 * each replica host and port number are ones we know about (that is, they're
249 * in the slapd config file we read at startup). Without that information
250 * from the config file, we won't have the appropriate credentials to
251 * make modifications. If there are any unknown replica names, don't
252 * add them the the Re struct. Instead, log a warning message.
261 char buf[ LINE_WIDTH + 1 ];
262 char *type, *value, *line, *p;
269 if ( replbuf == NULL ) {
276 * Get the host names of the replicas
281 /* If this is a reject log, we need to skip over the ERROR: line */
282 if ( !strncmp( *r_rp, ERROR_STR, strlen( ERROR_STR ))) {
283 line = str_getline( r_rp );
284 if ( line == NULL ) {
288 if ( strncasecmp( *r_rp, "replica:", 7 )) {
291 line = str_getline( r_rp );
292 if ( line == NULL ) {
295 if ( str_parse_line( line, &type, &value, &len ) < 0 ) {
299 if (( p = strchr( value, ':' )) != NULL ) {
307 /* Verify that we've heard of this replica before */
309 for ( i = 0; i < sglob->num_replicas; i++ ) {
310 if ( strcmp( sglob->replicas[ i ]->ri_hostname, value )) {
313 if ( sglob->replicas[ i ]->ri_port == port ) {
319 warn_unknown_replica( value, port );
323 rh = (Rh *) ch_realloc((char *) rh, ( nreplicas + 2 ) * sizeof( Rh ));
325 Debug( LDAP_DEBUG_ANY, "Out of memory in get_repl_hosts\n",
329 rh[ nreplicas ].rh_hostname = strdup( value );
330 rh[ nreplicas ].rh_port = port;
334 if ( nreplicas == 0 ) {
338 rh[ nreplicas ].rh_hostname = NULL;
339 *r_nreplicas = nreplicas;
349 * Convert "type" to an int.
356 if ( !strcmp( type, T_CHANGETYPESTR )) {
357 return( T_CHANGETYPE );
359 if ( !strcmp( type, T_TIMESTR )) {
362 if ( !strcmp( type, T_DNSTR )) {
371 * Convert "changetype" to an int.
378 if ( !strcmp( changetype, T_ADDCTSTR )) {
381 if ( !strcmp( changetype, T_MODIFYCTSTR )) {
382 return( T_MODIFYCT );
384 if ( !strcmp( changetype, T_DELETECTSTR )) {
385 return( T_DELETECT );
387 if ( !strcmp( changetype, T_MODRDNCTSTR )) {
388 return( T_MODRDNCT );
397 * Find the first line which is not a "replica:" line in buf.
398 * Returns a pointer to the line. Returns NULL if there are
399 * only "replica:" lines in buf.
408 if ( strncasecmp( p, "replica:", 8 )) {
411 while (( *p != '\0' ) && ( *p != '\n' )) {
426 * For debugging purposes: dump the contents of a replication entry.
427 * to the given stream.
439 Debug( LDAP_DEBUG_TRACE, "Re_dump: re is NULL\n", 0, 0, 0 );
442 fprintf( fp, "Re_dump: ******\n" );
443 fprintf( fp, "re_refcnt: %d\n", re->re_refcnt );
444 fprintf( fp, "re_timestamp: %s\n", re->re_timestamp );
445 fprintf( fp, "re_seq: %d\n", re->re_seq );
446 for ( i = 0; re->re_replicas && re->re_replicas[ i ].rh_hostname != NULL;
448 fprintf( fp, "re_replicas[%d]: %s:%d\n",
449 i, re->re_replicas[ i ].rh_hostname,
450 re->re_replicas[ i ].rh_port );
452 fprintf( fp, "re_dn: %s\n", re->re_dn );
453 switch ( re->re_changetype ) {
455 fprintf( fp, "re_changetype: add\n" );
458 fprintf( fp, "re_changetype: modify\n" );
461 fprintf( fp, "re_changetype: delete\n" );
464 fprintf( fp, "re_changetype: modrdn\n" );
467 fprintf( fp, "re_changetype: (unknown, type = %d\n",
470 if ( re->re_mods == NULL ) {
471 fprintf( fp, "re_mods: (none)\n" );
474 fprintf( fp, "re_mods:\n" );
475 for ( i = 0; mi[ i ].mi_type != NULL; i++ ) {
476 fprintf( fp, " %s, \"%s\", (%d bytes)\n",
478 mi[ i ].mi_val == NULL ? "(null)" : mi[ i ].mi_val,
487 * Given an Ri, an Re, and a file pointer, write a replication record to
488 * the file pointer. If ri is NULL, then include all replicas in the
489 * output. If ri is non-NULL, then only include a single "replica:" line
490 * (used when writing rejection records). Returns 0 on success, -1
491 * on failure. Note that Re_write will not write anything out if the
505 if ( re == NULL || fp == NULL ) {
506 Debug( LDAP_DEBUG_ANY, "Internal error: Re_write: NULL argument\n",
511 if ( re->re_refcnt < 1 ) {
512 return 0; /* this is not an error */
515 if ( ri != NULL ) { /* write a single "replica:" line */
516 if ( fprintf( fp, "replica: %s:%d\n", ri->ri_hostname,
517 ri->ri_port ) < 0 ) {
521 } else { /* write multiple "replica:" lines */
522 for ( i = 0; re->re_replicas[ i ].rh_hostname != NULL; i++ ) {
523 if ( fprintf( fp, "replica: %s:%d\n",
524 re->re_replicas[ i ].rh_hostname,
525 re->re_replicas[ i ].rh_port ) < 0 ) {
531 if ( fprintf( fp, "time: %s.%d\n", re->re_timestamp, re->re_seq ) < 0 ) {
535 if ( fprintf( fp, "dn: %s\n", re->re_dn ) < 0 ) {
539 if ( fprintf( fp, "changetype: " ) < 0 ) {
543 switch ( re->re_changetype ) {
557 s = "IllegalModifyType!!!";
559 if ( fprintf( fp, "%s\n", s ) < 0 ) {
563 for ( i = 0; (( re->re_mods != NULL ) &&
564 ( re->re_mods[ i ].mi_type != NULL )); i++ ) {
565 if ( !strcmp( re->re_mods[ i ].mi_type, T_MODSEPSTR )) {
566 if ( fprintf( fp, "%s\n", T_MODSEPSTR ) < 0 ) {
572 obuf = ldif_type_and_value( re->re_mods[ i ].mi_type,
573 re->re_mods[ i ].mi_val ? re->re_mods[ i ].mi_val : "",
574 re->re_mods[ i ].mi_len );
575 if ( fputs( obuf, fp ) < 0 ) {
584 if ( fprintf( fp, "\n" ) < 0 ) {
588 if ( fflush( fp ) != 0 ) {
594 Debug( LDAP_DEBUG_ANY, "Error while writing: %s\n",
595 sys_errlist[ errno ], 0, 0 );
604 * Decrement the refcnt. Locking handled internally.
620 * Get the refcnt. Locking handled internally.
640 * Lock this replication entry
647 return( pthread_mutex_lock( &re->re_mutex ));
654 * Unlock this replication entry
661 return( pthread_mutex_unlock( &re->re_mutex ));
668 * Instantiate and initialize an Re.
676 (*re) = (Re *) malloc( sizeof( Re ));
681 /* Fill in the member function pointers */
682 (*re)->re_free = Re_free;
683 (*re)->re_getnext = Re_getnext;
684 (*re)->re_parse = Re_parse;
685 (*re)->re_write = Re_write;
686 (*re)->re_dump = Re_dump;
687 (*re)->re_lock = Re_lock;
688 (*re)->re_unlock = Re_unlock;
689 (*re)->re_decrefcnt = Re_decrefcnt;
690 (*re)->re_getrefcnt = Re_getrefcnt;
692 /* Initialize private data */
693 (*re)->re_refcnt = sglob->num_replicas;
694 (*re)->re_timestamp = NULL;
695 (*re)->re_replicas = NULL;
697 (*re)->re_changetype = 0;
699 (*re)->re_mods = NULL;
700 (*re)->re_next = NULL;
702 pthread_mutex_init( &((*re)->re_mutex), pthread_mutexattr_default );
710 * Given a host and port, generate a warning message iff we haven't already
711 * generated a message for this host:port combination.
714 warn_unknown_replica(
722 for ( i = 0; i < nur; i++ ) {
723 if ( strcmp( ur[ i ].rh_hostname, host )) {
726 if ( ur[ i ].rh_port == port ) {
732 Debug( LDAP_DEBUG_ANY,
733 "Warning: unknown replica %s:%d found in replication log\n",
736 ur = (Rh *) ch_realloc( (char *) ur, ( nur * sizeof( Rh )));
737 ur[ nur - 1 ].rh_hostname = strdup( host );
738 ur[ nur - 1 ].rh_port = port;