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.
21 #define DISABLE_BRIDGE
25 #include <ac/string.h>
26 #include <sys/types.h>
27 #include <sys/socket.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 #ifdef DECL_SYS_ERRLIST
38 extern char *sys_errlist[];
39 #endif /* DECL_SYS_ERRLIST */
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 );
83 if ( re->re_refcnt > 0 ) {
84 Debug( LDAP_DEBUG_ANY,
85 "Warning: freeing re (dn: %s) with nonzero refcnt\n",
88 #if !defined( THREAD_SUNOS4_LWP )
89 /* This seems to have problems under SunOS lwp */
90 pthread_mutex_destroy( &re->re_mutex );
91 #endif /* THREAD_SUNOS4_LWP */
92 ch_free( re->re_timestamp );
93 if (( rh = re->re_replicas ) != NULL ) {
94 for ( i = 0; rh[ i ].rh_hostname != NULL; i++ ) {
95 free( rh[ i ].rh_hostname );
100 if (( mi = re->re_mods ) != NULL ) {
101 for ( i = 0; mi[ i ].mi_type != NULL; i++ ) {
102 free( mi[ i ].mi_type );
103 ch_free( mi[ i ].mi_val );
114 * Read a buffer of data from a replication log file and fill in
115 * an (already allocated) Re.
121 #define GOT_CHANGETYPE 4
122 #define GOT_ALL ( GOT_DN | GOT_TIME | GOT_CHANGETYPE )
139 Debug( LDAP_DEBUG_ANY, "Re_parse: error: re is NULL\n", 0, 0, 0 );
142 if ( replbuf == NULL ) {
143 Debug( LDAP_DEBUG_ANY, "Re_parse: error: replbuf is NULL\n", 0, 0, 0 );
148 nml = 0; /* number of modification information entries */
151 re->re_replicas = get_repl_hosts( replbuf, &nreplicas, &rp );
152 re->re_refcnt = sglob->num_replicas;
155 if (( state == GOT_ALL ) || ( buf = str_getline( &rp )) == NULL ) {
159 * If we're processing a rejection log, then the first line
160 * of each replication record will begin with "ERROR" - just
163 if ( strncmp( buf, ERROR_STR, strlen( ERROR_STR )) == 0 ) {
166 buflen = ( long ) strlen( buf );
167 if ( str_parse_line( buf, &type, &value, &len ) < 0 ) {
168 Debug( LDAP_DEBUG_ANY,
169 "Error: Re_parse: malformed replog file\n",
173 switch ( gettype( type )) {
175 re->re_changetype = getchangetype( value );
176 state |= GOT_CHANGETYPE;
179 if (( p = strchr( value, '.' )) != NULL ) {
180 /* there was a sequence number */
183 re->re_timestamp = strdup( value );
184 if ( p != NULL && isdigit( *p )) {
185 re->re_seq = atoi( p );
190 re->re_dn = ch_malloc( len + 1 );
191 memcpy( re->re_dn, value, len );
192 re->re_dn[ len ]='\0';
196 if ( !( state == GOT_ALL )) {
197 Debug( LDAP_DEBUG_ANY,
198 "Error: Re_parse: bad type <%s>\n",
205 if ( state != GOT_ALL ) {
206 Debug( LDAP_DEBUG_ANY,
207 "Error: Re_parse: malformed replog file\n",
213 if (( buf = str_getline( &rp )) == NULL ) {
216 buflen = ( long ) strlen( buf );
217 if (( buflen == 1 ) && ( buf[ 0 ] == '-' )) {
221 if ( str_parse_line( buf, &type, &value, &len ) < 0 ) {
222 Debug( LDAP_DEBUG_ANY,
223 "Error: malformed replog line \"%s\"\n",
228 re->re_mods = ( Mi *) ch_realloc( (char *) re->re_mods,
229 sizeof( Mi ) * ( nml + 2 ));
230 re->re_mods[ nml ].mi_type = strdup( type );
231 if ( value != NULL ) {
232 re->re_mods[ nml ].mi_val = ch_malloc( len + 1 );
233 memcpy( re->re_mods[ nml ].mi_val, value, len );
234 re->re_mods[ nml ].mi_val[ len ] = '\0';
235 re->re_mods[ nml ].mi_len = len;
237 re->re_mods[ nml ].mi_val = NULL;
238 re->re_mods[ nml ].mi_len = 0;
240 re->re_mods[ nml + 1 ].mi_type = NULL;
241 re->re_mods[ nml + 1 ].mi_val = NULL;
250 * Extract the replication hosts from a repl buf. Check to be sure that
251 * each replica host and port number are ones we know about (that is, they're
252 * in the slapd config file we read at startup). Without that information
253 * from the config file, we won't have the appropriate credentials to
254 * make modifications. If there are any unknown replica names, don't
255 * add them the the Re struct. Instead, log a warning message.
264 char buf[ LINE_WIDTH + 1 ];
265 char *type, *value, *line, *p;
272 if ( replbuf == NULL ) {
279 * Get the host names of the replicas
284 /* If this is a reject log, we need to skip over the ERROR: line */
285 if ( !strncmp( *r_rp, ERROR_STR, strlen( ERROR_STR ))) {
286 line = str_getline( r_rp );
287 if ( line == NULL ) {
291 if ( strncasecmp( *r_rp, "replica:", 7 )) {
294 line = str_getline( r_rp );
295 if ( line == NULL ) {
298 if ( str_parse_line( line, &type, &value, &len ) < 0 ) {
302 if (( p = strchr( value, ':' )) != NULL ) {
310 /* Verify that we've heard of this replica before */
312 for ( i = 0; i < sglob->num_replicas; i++ ) {
313 if ( strcmp( sglob->replicas[ i ]->ri_hostname, value )) {
316 if ( sglob->replicas[ i ]->ri_port == port ) {
322 warn_unknown_replica( value, port );
326 rh = (Rh *) ch_realloc((char *) rh, ( nreplicas + 2 ) * sizeof( Rh ));
328 Debug( LDAP_DEBUG_ANY, "Out of memory in get_repl_hosts\n",
332 rh[ nreplicas ].rh_hostname = strdup( value );
333 rh[ nreplicas ].rh_port = port;
337 if ( nreplicas == 0 ) {
341 rh[ nreplicas ].rh_hostname = NULL;
342 *r_nreplicas = nreplicas;
352 * Convert "type" to an int.
359 if ( !strcmp( type, T_CHANGETYPESTR )) {
360 return( T_CHANGETYPE );
362 if ( !strcmp( type, T_TIMESTR )) {
365 if ( !strcmp( type, T_DNSTR )) {
374 * Convert "changetype" to an int.
381 if ( !strcmp( changetype, T_ADDCTSTR )) {
384 if ( !strcmp( changetype, T_MODIFYCTSTR )) {
385 return( T_MODIFYCT );
387 if ( !strcmp( changetype, T_DELETECTSTR )) {
388 return( T_DELETECT );
390 if ( !strcmp( changetype, T_MODRDNCTSTR )) {
391 return( T_MODRDNCT );
400 * Find the first line which is not a "replica:" line in buf.
401 * Returns a pointer to the line. Returns NULL if there are
402 * only "replica:" lines in buf.
411 if ( strncasecmp( p, "replica:", 8 )) {
414 while (( *p != '\0' ) && ( *p != '\n' )) {
429 * For debugging purposes: dump the contents of a replication entry.
430 * to the given stream.
442 Debug( LDAP_DEBUG_TRACE, "Re_dump: re is NULL\n", 0, 0, 0 );
445 fprintf( fp, "Re_dump: ******\n" );
446 fprintf( fp, "re_refcnt: %d\n", re->re_refcnt );
447 fprintf( fp, "re_timestamp: %s\n", re->re_timestamp );
448 fprintf( fp, "re_seq: %d\n", re->re_seq );
449 for ( i = 0; re->re_replicas && re->re_replicas[ i ].rh_hostname != NULL;
451 fprintf( fp, "re_replicas[%d]: %s:%d\n",
452 i, re->re_replicas[ i ].rh_hostname,
453 re->re_replicas[ i ].rh_port );
455 fprintf( fp, "re_dn: %s\n", re->re_dn );
456 switch ( re->re_changetype ) {
458 fprintf( fp, "re_changetype: add\n" );
461 fprintf( fp, "re_changetype: modify\n" );
464 fprintf( fp, "re_changetype: delete\n" );
467 fprintf( fp, "re_changetype: modrdn\n" );
470 fprintf( fp, "re_changetype: (unknown, type = %d\n",
473 if ( re->re_mods == NULL ) {
474 fprintf( fp, "re_mods: (none)\n" );
477 fprintf( fp, "re_mods:\n" );
478 for ( i = 0; mi[ i ].mi_type != NULL; i++ ) {
479 fprintf( fp, " %s, \"%s\", (%d bytes)\n",
481 mi[ i ].mi_val == NULL ? "(null)" : mi[ i ].mi_val,
490 * Given an Ri, an Re, and a file pointer, write a replication record to
491 * the file pointer. If ri is NULL, then include all replicas in the
492 * output. If ri is non-NULL, then only include a single "replica:" line
493 * (used when writing rejection records). Returns 0 on success, -1
494 * on failure. Note that Re_write will not write anything out if the
508 if ( re == NULL || fp == NULL ) {
509 Debug( LDAP_DEBUG_ANY, "Internal error: Re_write: NULL argument\n",
514 if ( re->re_refcnt < 1 ) {
515 return 0; /* this is not an error */
518 if ( ri != NULL ) { /* write a single "replica:" line */
519 if ( fprintf( fp, "replica: %s:%d\n", ri->ri_hostname,
520 ri->ri_port ) < 0 ) {
524 } else { /* write multiple "replica:" lines */
525 for ( i = 0; re->re_replicas[ i ].rh_hostname != NULL; i++ ) {
526 if ( fprintf( fp, "replica: %s:%d\n",
527 re->re_replicas[ i ].rh_hostname,
528 re->re_replicas[ i ].rh_port ) < 0 ) {
534 if ( fprintf( fp, "time: %s.%d\n", re->re_timestamp, re->re_seq ) < 0 ) {
538 if ( fprintf( fp, "dn: %s\n", re->re_dn ) < 0 ) {
542 if ( fprintf( fp, "changetype: " ) < 0 ) {
546 switch ( re->re_changetype ) {
560 s = "IllegalModifyType!!!";
562 if ( fprintf( fp, "%s\n", s ) < 0 ) {
566 for ( i = 0; (( re->re_mods != NULL ) &&
567 ( re->re_mods[ i ].mi_type != NULL )); i++ ) {
568 if ( !strcmp( re->re_mods[ i ].mi_type, T_MODSEPSTR )) {
569 if ( fprintf( fp, "%s\n", T_MODSEPSTR ) < 0 ) {
575 obuf = ldif_type_and_value( re->re_mods[ i ].mi_type,
576 re->re_mods[ i ].mi_val ? re->re_mods[ i ].mi_val : "",
577 re->re_mods[ i ].mi_len );
578 if ( fputs( obuf, fp ) < 0 ) {
587 if ( fprintf( fp, "\n" ) < 0 ) {
591 if ( fflush( fp ) != 0 ) {
597 Debug( LDAP_DEBUG_ANY, "Error while writing: %s\n",
598 sys_errlist[ errno ], 0, 0 );
607 * Decrement the refcnt. Locking handled internally.
623 * Get the refcnt. Locking handled internally.
643 * Lock this replication entry
650 return( pthread_mutex_lock( &re->re_mutex ));
657 * Unlock this replication entry
664 return( pthread_mutex_unlock( &re->re_mutex ));
671 * Instantiate and initialize an Re.
679 (*re) = (Re *) malloc( sizeof( Re ));
684 /* Fill in the member function pointers */
685 (*re)->re_free = Re_free;
686 (*re)->re_getnext = Re_getnext;
687 (*re)->re_parse = Re_parse;
688 (*re)->re_write = Re_write;
689 (*re)->re_dump = Re_dump;
690 (*re)->re_lock = Re_lock;
691 (*re)->re_unlock = Re_unlock;
692 (*re)->re_decrefcnt = Re_decrefcnt;
693 (*re)->re_getrefcnt = Re_getrefcnt;
695 /* Initialize private data */
696 (*re)->re_refcnt = sglob->num_replicas;
697 (*re)->re_timestamp = NULL;
698 (*re)->re_replicas = NULL;
700 (*re)->re_changetype = 0;
702 (*re)->re_mods = NULL;
703 (*re)->re_next = NULL;
705 pthread_mutex_init( &((*re)->re_mutex), pthread_mutexattr_default );
713 * Given a host and port, generate a warning message iff we haven't already
714 * generated a message for this host:port combination.
717 warn_unknown_replica(
725 for ( i = 0; i < nur; i++ ) {
726 if ( strcmp( ur[ i ].rh_hostname, host )) {
729 if ( ur[ i ].rh_port == port ) {
735 Debug( LDAP_DEBUG_ANY,
736 "Warning: unknown replica %s:%d found in replication log\n",
739 ur = (Rh *) ch_realloc( (char *) ur, ( nur * sizeof( Rh )));
740 ur[ nur - 1 ].rh_hostname = strdup( host );
741 ur[ nur - 1 ].rh_port = port;