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.
24 #include <ac/string.h>
25 #include <sys/types.h>
26 #include <sys/socket.h>
28 #include "../slapd/slap.h"
33 extern char *str_getline LDAP_P(( char **next ));
34 extern void ch_free LDAP_P(( char *p ));
36 #ifdef DECL_SYS_ERRLIST
37 extern char *sys_errlist[];
38 #endif /* DECL_SYS_ERRLIST */
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 );
82 if ( re->re_refcnt > 0 ) {
83 Debug( LDAP_DEBUG_ANY,
84 "Warning: freeing re (dn: %s) with nonzero refcnt\n",
87 #if !defined( THREAD_SUNOS4_LWP )
88 /* This seems to have problems under SunOS lwp */
89 pthread_mutex_destroy( &re->re_mutex );
90 #endif /* THREAD_SUNOS4_LWP */
91 ch_free( re->re_timestamp );
92 if (( rh = re->re_replicas ) != NULL ) {
93 for ( i = 0; rh[ i ].rh_hostname != NULL; i++ ) {
94 free( rh[ i ].rh_hostname );
99 if (( mi = re->re_mods ) != NULL ) {
100 for ( i = 0; mi[ i ].mi_type != NULL; i++ ) {
101 free( mi[ i ].mi_type );
102 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 = str_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 = ( long ) strlen( buf );
166 if ( str_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 = strdup( value );
183 if ( p != NULL && isdigit( *p )) {
184 re->re_seq = atoi( p );
189 re->re_dn = ch_malloc( len + 1 );
190 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",
204 if ( state != GOT_ALL ) {
205 Debug( LDAP_DEBUG_ANY,
206 "Error: Re_parse: malformed replog file\n",
212 if (( buf = str_getline( &rp )) == NULL ) {
215 buflen = ( long ) strlen( buf );
216 if (( buflen == 1 ) && ( buf[ 0 ] == '-' )) {
220 if ( str_parse_line( buf, &type, &value, &len ) < 0 ) {
221 Debug( LDAP_DEBUG_ANY,
222 "Error: malformed replog line \"%s\"\n",
227 re->re_mods = ( Mi *) ch_realloc( (char *) re->re_mods,
228 sizeof( Mi ) * ( nml + 2 ));
229 re->re_mods[ nml ].mi_type = strdup( type );
230 if ( value != NULL ) {
231 re->re_mods[ nml ].mi_val = ch_malloc( len + 1 );
232 memcpy( re->re_mods[ nml ].mi_val, value, len );
233 re->re_mods[ nml ].mi_val[ len ] = '\0';
234 re->re_mods[ nml ].mi_len = len;
236 re->re_mods[ nml ].mi_val = NULL;
237 re->re_mods[ nml ].mi_len = 0;
239 re->re_mods[ nml + 1 ].mi_type = NULL;
240 re->re_mods[ nml + 1 ].mi_val = NULL;
249 * Extract the replication hosts from a repl buf. Check to be sure that
250 * each replica host and port number are ones we know about (that is, they're
251 * in the slapd config file we read at startup). Without that information
252 * from the config file, we won't have the appropriate credentials to
253 * make modifications. If there are any unknown replica names, don't
254 * add them the the Re struct. Instead, log a warning message.
263 char buf[ LINE_WIDTH + 1 ];
264 char *type, *value, *line, *p;
271 if ( replbuf == NULL ) {
278 * Get the host names of the replicas
283 /* If this is a reject log, we need to skip over the ERROR: line */
284 if ( !strncmp( *r_rp, ERROR_STR, strlen( ERROR_STR ))) {
285 line = str_getline( r_rp );
286 if ( line == NULL ) {
290 if ( strncasecmp( *r_rp, "replica:", 7 )) {
293 line = str_getline( r_rp );
294 if ( line == NULL ) {
297 if ( str_parse_line( line, &type, &value, &len ) < 0 ) {
301 if (( p = strchr( value, ':' )) != NULL ) {
309 /* Verify that we've heard of this replica before */
311 for ( i = 0; i < sglob->num_replicas; i++ ) {
312 if ( strcmp( sglob->replicas[ i ]->ri_hostname, value )) {
315 if ( sglob->replicas[ i ]->ri_port == port ) {
321 warn_unknown_replica( value, port );
325 rh = (Rh *) ch_realloc((char *) rh, ( nreplicas + 2 ) * sizeof( Rh ));
327 Debug( LDAP_DEBUG_ANY, "Out of memory in get_repl_hosts\n",
331 rh[ nreplicas ].rh_hostname = strdup( value );
332 rh[ nreplicas ].rh_port = port;
336 if ( nreplicas == 0 ) {
340 rh[ nreplicas ].rh_hostname = NULL;
341 *r_nreplicas = nreplicas;
351 * Convert "type" to an int.
358 if ( !strcmp( type, T_CHANGETYPESTR )) {
359 return( T_CHANGETYPE );
361 if ( !strcmp( type, T_TIMESTR )) {
364 if ( !strcmp( type, T_DNSTR )) {
373 * Convert "changetype" to an int.
380 if ( !strcmp( changetype, T_ADDCTSTR )) {
383 if ( !strcmp( changetype, T_MODIFYCTSTR )) {
384 return( T_MODIFYCT );
386 if ( !strcmp( changetype, T_DELETECTSTR )) {
387 return( T_DELETECT );
389 if ( !strcmp( changetype, T_MODRDNCTSTR )) {
390 return( T_MODRDNCT );
399 * Find the first line which is not a "replica:" line in buf.
400 * Returns a pointer to the line. Returns NULL if there are
401 * only "replica:" lines in buf.
410 if ( strncasecmp( p, "replica:", 8 )) {
413 while (( *p != '\0' ) && ( *p != '\n' )) {
428 * For debugging purposes: dump the contents of a replication entry.
429 * to the given stream.
441 Debug( LDAP_DEBUG_TRACE, "Re_dump: re is NULL\n", 0, 0, 0 );
444 fprintf( fp, "Re_dump: ******\n" );
445 fprintf( fp, "re_refcnt: %d\n", re->re_refcnt );
446 fprintf( fp, "re_timestamp: %s\n", re->re_timestamp );
447 fprintf( fp, "re_seq: %d\n", re->re_seq );
448 for ( i = 0; re->re_replicas && re->re_replicas[ i ].rh_hostname != NULL;
450 fprintf( fp, "re_replicas[%d]: %s:%d\n",
451 i, re->re_replicas[ i ].rh_hostname,
452 re->re_replicas[ i ].rh_port );
454 fprintf( fp, "re_dn: %s\n", re->re_dn );
455 switch ( re->re_changetype ) {
457 fprintf( fp, "re_changetype: add\n" );
460 fprintf( fp, "re_changetype: modify\n" );
463 fprintf( fp, "re_changetype: delete\n" );
466 fprintf( fp, "re_changetype: modrdn\n" );
469 fprintf( fp, "re_changetype: (unknown, type = %d\n",
472 if ( re->re_mods == NULL ) {
473 fprintf( fp, "re_mods: (none)\n" );
476 fprintf( fp, "re_mods:\n" );
477 for ( i = 0; mi[ i ].mi_type != NULL; i++ ) {
478 fprintf( fp, " %s, \"%s\", (%d bytes)\n",
480 mi[ i ].mi_val == NULL ? "(null)" : mi[ i ].mi_val,
489 * Given an Ri, an Re, and a file pointer, write a replication record to
490 * the file pointer. If ri is NULL, then include all replicas in the
491 * output. If ri is non-NULL, then only include a single "replica:" line
492 * (used when writing rejection records). Returns 0 on success, -1
493 * on failure. Note that Re_write will not write anything out if the
507 if ( re == NULL || fp == NULL ) {
508 Debug( LDAP_DEBUG_ANY, "Internal error: Re_write: NULL argument\n",
513 if ( re->re_refcnt < 1 ) {
514 return 0; /* this is not an error */
517 if ( ri != NULL ) { /* write a single "replica:" line */
518 if ( fprintf( fp, "replica: %s:%d\n", ri->ri_hostname,
519 ri->ri_port ) < 0 ) {
523 } else { /* write multiple "replica:" lines */
524 for ( i = 0; re->re_replicas[ i ].rh_hostname != NULL; i++ ) {
525 if ( fprintf( fp, "replica: %s:%d\n",
526 re->re_replicas[ i ].rh_hostname,
527 re->re_replicas[ i ].rh_port ) < 0 ) {
533 if ( fprintf( fp, "time: %s.%d\n", re->re_timestamp, re->re_seq ) < 0 ) {
537 if ( fprintf( fp, "dn: %s\n", re->re_dn ) < 0 ) {
541 if ( fprintf( fp, "changetype: " ) < 0 ) {
545 switch ( re->re_changetype ) {
559 s = "IllegalModifyType!!!";
561 if ( fprintf( fp, "%s\n", s ) < 0 ) {
565 for ( i = 0; (( re->re_mods != NULL ) &&
566 ( re->re_mods[ i ].mi_type != NULL )); i++ ) {
567 if ( !strcmp( re->re_mods[ i ].mi_type, T_MODSEPSTR )) {
568 if ( fprintf( fp, "%s\n", T_MODSEPSTR ) < 0 ) {
574 obuf = ldif_type_and_value( re->re_mods[ i ].mi_type,
575 re->re_mods[ i ].mi_val ? re->re_mods[ i ].mi_val : "",
576 re->re_mods[ i ].mi_len );
577 if ( fputs( obuf, fp ) < 0 ) {
586 if ( fprintf( fp, "\n" ) < 0 ) {
590 if ( fflush( fp ) != 0 ) {
596 Debug( LDAP_DEBUG_ANY, "Error while writing: %s\n",
597 sys_errlist[ errno ], 0, 0 );
606 * Decrement the refcnt. Locking handled internally.
622 * Get the refcnt. Locking handled internally.
642 * Lock this replication entry
649 return( pthread_mutex_lock( &re->re_mutex ));
656 * Unlock this replication entry
663 return( pthread_mutex_unlock( &re->re_mutex ));
670 * Instantiate and initialize an Re.
678 (*re) = (Re *) malloc( sizeof( Re ));
683 /* Fill in the member function pointers */
684 (*re)->re_free = Re_free;
685 (*re)->re_getnext = Re_getnext;
686 (*re)->re_parse = Re_parse;
687 (*re)->re_write = Re_write;
688 (*re)->re_dump = Re_dump;
689 (*re)->re_lock = Re_lock;
690 (*re)->re_unlock = Re_unlock;
691 (*re)->re_decrefcnt = Re_decrefcnt;
692 (*re)->re_getrefcnt = Re_getrefcnt;
694 /* Initialize private data */
695 (*re)->re_refcnt = sglob->num_replicas;
696 (*re)->re_timestamp = NULL;
697 (*re)->re_replicas = NULL;
699 (*re)->re_changetype = 0;
701 (*re)->re_mods = NULL;
702 (*re)->re_next = NULL;
704 pthread_mutex_init( &((*re)->re_mutex), pthread_mutexattr_default );
712 * Given a host and port, generate a warning message iff we haven't already
713 * generated a message for this host:port combination.
716 warn_unknown_replica(
724 for ( i = 0; i < nur; i++ ) {
725 if ( strcmp( ur[ i ].rh_hostname, host )) {
728 if ( ur[ i ].rh_port == port ) {
734 Debug( LDAP_DEBUG_ANY,
735 "Warning: unknown replica %s:%d found in replication log\n",
738 ur = (Rh *) ch_realloc( (char *) ur, ( nur * sizeof( Rh )));
739 ur[ nur - 1 ].rh_hostname = strdup( host );
740 ur[ nur - 1 ].rh_port = port;