---

generator.c File Reference

Go to the source code of this file.

Functions
int	skip_file (char *fname, struct file_struct *file, STRUCT_STAT *st)
int	adapt_block_size (struct file_struct *file, int bsize)
void	send_sums (struct sum_struct *s, int f_out)
BOOL	disable_deltas_p (void)
	Perhaps we want to just send an empty checksum set for this file, which will force the whole thing to be literally transferred. More...
sum_struct *	generate_sums (struct map_struct *buf, OFF_T len, int n)
	Generate a stream of signatures/checksums that describe a buffer. More...
void	recv_generator (char *fname, struct file_list *flist, int i, int f_out)
	Acts on file number i from flist, whose name is fname. More...
void	generate_files (int f, struct file_list *flist, char *local_name, int f_recv)
Variables
int	verbose
int	dry_run
int	relative_paths
int	preserve_links
int	am_root
int	preserve_devices
int	preserve_hard_links
int	update_only
int	opt_ignore_existing
int	block_size
int	csum_length
int	ignore_times
int	size_only
int	io_timeout
int	remote_version
int	always_checksum
int	modify_window = 0
char *	compare_dest

---

Function Documentation

int skip_file (  char *    fname, struct file_struct *    file, STRUCT_STAT *    st )  [static]

Definition at line 47 of file generator.c. References always_checksum, cmp_modtime(), compare_dest, file_checksum(), file_struct::length, file_struct::modtime, remote_version, snprintf(), and file_struct::sum. Referenced by recv_generator(). { if (st->st_size != file->length) { return 0; } /* if always checksum is set then we use the checksum instead of the file time to determine whether to sync */ if (always_checksum && S_ISREG(st->st_mode)) { char sum[MD4_SUM_LENGTH]; char fnamecmpdest[MAXPATHLEN]; if (compare_dest != NULL) { if (access(fname, 0) != 0) { snprintf(fnamecmpdest,MAXPATHLEN,"%s/%s", compare_dest,fname); fname = fnamecmpdest; } } file_checksum(fname,sum,st->st_size); if (remote_version < 21) { return (memcmp(sum,file->sum,2) == 0); } else { return (memcmp(sum,file->sum,MD4_SUM_LENGTH) == 0); } } if (size_only) { return 1; } if (ignore_times) { return 0; } return (cmp_modtime(st->st_mtime,file->modtime) == 0); }

int adapt_block_size (  struct file_struct *    file, int    bsize )  [static]

Definition at line 88 of file generator.c. References file_struct::length. Referenced by recv_generator(). { int ret; if (bsize != BLOCK_SIZE) return bsize; ret = file->length / (10000); /* rough heuristic */ ret = ret & ~15; /* multiple of 16 */ if (ret < bsize) ret = bsize; if (ret > CHUNK_SIZE/2) ret = CHUNK_SIZE/2; return ret; }

void send_sums (  struct sum_struct *    s, int    f_out )  [static]

Definition at line 105 of file generator.c. References block_size, sum_struct::count, csum_length, sum_struct::n, sum_struct::remainder, sum_buf::sum1, sum_buf::sum2, sum_struct::sums, write_buf(), and write_int(). Referenced by recv_generator(). { if (s) { size_t i; /* tell the other guy how many we are going to be doing and how many bytes there are in the last chunk */ write_int(f_out, s->count); write_int(f_out, s->n); write_int(f_out, s->remainder); for (i = 0; i < s->count; i++) { write_int(f_out, s->sums[i].sum1); write_buf(f_out, s->sums[i].sum2, csum_length); } } else { /* we don't have checksums */ write_int(f_out, 0); write_int(f_out, block_size); write_int(f_out, 0); } }

BOOL disable_deltas_p (  void    )  [static]

Perhaps we want to just send an empty checksum set for this file, which will force the whole thing to be literally transferred. When do we do this? If the user's explicitly said they want the whole thing, or if { they haven't explicitly requested a delta, and it's local but not batch mode.} Whew. Definition at line 139 of file generator.c. References local_server, no_whole_file, and whole_file. Referenced by generate_files(), and recv_generator(). { extern int whole_file, no_whole_file; extern int local_server; extern int write_batch; assert(whole_file == 0 || whole_file == 1); /* whole_file and no_whole_file are never both on at the same time */ if (whole_file) return True; else if (no_whole_file) return False; else if (write_batch) return False; else return local_server; }

struct sum_struct* generate_sums (  struct map_struct *    buf, OFF_T    len, int    n )  [static]

Generate a stream of signatures/checksums that describe a buffer. Generate approximately one checksum every n bytes. Returns: Newly-allocated sum_struct Definition at line 167 of file generator.c. References sum_struct::count, FINFO, sum_struct::flength, get_checksum1(), get_checksum2(), sum_buf::i, sum_buf::len, map_ptr(), sum_struct::n, sum_buf::offset, out_of_memory(), sum_struct::remainder, rprintf(), sum_buf::sum1, sum_buf::sum2, sum_struct::sums, and verbose. Referenced by recv_generator(). { int i; struct sum_struct *s; int count; int block_len = n; int remainder = (len % block_len); OFF_T offset = 0; count = (len + (block_len - 1)) / block_len; s = (struct sum_struct *) malloc(sizeof(*s)); if (!s) out_of_memory("generate_sums"); s->count = count; s->remainder = remainder; s->n = n; s->flength = len; if (count == 0) { s->sums = NULL; return s; } if (verbose > 3) { rprintf(FINFO, "count=%ld rem=%ld n=%ld flength=%.0f\n", (long) s->count, (long) s->remainder, (long) s->n, (double) s->flength); } s->sums = (struct sum_buf *) malloc(sizeof(s->sums[0]) * s->count); if (!s->sums) out_of_memory("generate_sums"); for (i = 0; i < count; i++) { int n1 = MIN(len, n); char *map = map_ptr(buf, offset, n1); s->sums[i].sum1 = get_checksum1(map, n1); get_checksum2(map, n1, s->sums[i].sum2); s->sums[i].offset = offset; s->sums[i].len = n1; s->sums[i].i = i; if (verbose > 3) rprintf(FINFO, "chunk[%d] offset=%.0f len=%d sum1=%08x\n", i, (double) s->sums[i].offset, s->sums[i].len, s->sums[i].sum1); len -= n1; offset += n1; } return s; }

void recv_generator (  char *    fname, struct file_list *    flist, int    i, int    f_out )

Acts on file number i from flist, whose name is fname. First fixes up permissions, then generates checksums for the file. Note: This comment was added later by mbp who was trying to work it out. It might be wrong. Definition at line 237 of file generator.c. References adapt_block_size(), am_root, block_size, check_hard_link(), cmp_modtime(), compare_dest, create_directory_path(), delete_file(), disable_deltas_p(), do_mkdir(), do_mknod(), do_open(), do_symlink(), dry_run, f_name(), FERROR, file_list::files, FINFO, free_sums(), generate_sums(), file_struct::link, link_stat(), map_file(), file_struct::mode, file_struct::modtime, only_existing, opt_ignore_existing, orig_umask, preserve_devices, preserve_hard_links, preserve_links, file_struct::rdev, relative_paths, robust_unlink(), rprintf(), safe_symlinks, send_sums(), set_perms(), skip_file(), snprintf(), unmap_file(), unsafe_symlink(), update_only, verbose, and write_int(). Referenced by generate_files(), and recv_files(). { int fd; STRUCT_STAT st; struct map_struct *buf; struct sum_struct *s; int statret; struct file_struct *file = flist->files[i]; char *fnamecmp; char fnamecmpbuf[MAXPATHLEN]; extern char *compare_dest; extern int list_only; extern int preserve_perms; extern int only_existing; extern int orig_umask; if (list_only) return; if (verbose > 2) rprintf(FINFO,"recv_generator(%s,%d)\n",fname,i); statret = link_stat(fname,&st); if (only_existing && statret == -1 && errno == ENOENT) { /* we only want to update existing files */ if (verbose > 1) rprintf(FINFO, "not creating new file \"%s\"\n",fname); return; } if (statret == 0 && !preserve_perms && (S_ISDIR(st.st_mode) == S_ISDIR(file->mode))) { /* if the file exists already and we aren't perserving presmissions then act as though the remote end sent us the file permissions we already have */ file->mode = (file->mode & _S_IFMT) | (st.st_mode & ~_S_IFMT); } if (S_ISDIR(file->mode)) { /* The file to be received is a directory, so we need * to prepare appropriately. If there is already a * file of that name and it is *not* a directory, then * we need to delete it. If it doesn't exist, then * recursively create it. */ if (dry_run) return; /* XXXX -- might cause inaccuracies?? -- mbp */ if (statret == 0 && !S_ISDIR(st.st_mode)) { if (robust_unlink(fname) != 0) { rprintf(FERROR, RSYNC_NAME ": recv_generator: unlink \"%s\" to make room for directory: %s\n", fname,strerror(errno)); return; } statret = -1; } if (statret != 0 && do_mkdir(fname,file->mode) != 0 && errno != EEXIST) { if (!(relative_paths && errno==ENOENT && create_directory_path(fname, orig_umask)==0 && do_mkdir(fname,file->mode)==0)) { rprintf(FERROR, RSYNC_NAME ": recv_generator: mkdir \"%s\": %s (2)\n", fname,strerror(errno)); } } /* f_out is set to -1 when doing final directory permission and modification time repair */ if (set_perms(fname,file,NULL,0) && verbose && (f_out != -1)) rprintf(FINFO,"%s/\n",fname); return; } if (preserve_links && S_ISLNK(file->mode)) { #if SUPPORT_LINKS char lnk[MAXPATHLEN]; int l; extern int safe_symlinks; if (safe_symlinks && unsafe_symlink(file->link, fname)) { if (verbose) { rprintf(FINFO,"ignoring unsafe symlink \"%s\" -> \"%s\"\n", fname,file->link); } return; } if (statret == 0) { l = readlink(fname,lnk,MAXPATHLEN-1); if (l > 0) { lnk[l] = 0; /* A link already pointing to the * right place -- no further action * required. */ if (strcmp(lnk,file->link) == 0) { set_perms(fname,file,&st,1); return; } } /* Not a symlink, so delete whatever's * already there and put a new symlink * in place. */ delete_file(fname); } if (do_symlink(file->link,fname) != 0) { rprintf(FERROR,RSYNC_NAME": symlink \"%s\" -> \"%s\": %s\n", fname,file->link,strerror(errno)); } else { set_perms(fname,file,NULL,0); if (verbose) { rprintf(FINFO,"%s -> %s\n", fname,file->link); } } #endif return; } #ifdef HAVE_MKNOD if (am_root && preserve_devices && IS_DEVICE(file->mode)) { if (statret != 0 || st.st_mode != file->mode || st.st_rdev != file->rdev) { delete_file(fname); if (verbose > 2) rprintf(FINFO,"mknod(%s,0%o,0x%x)\n", fname,(int)file->mode,(int)file->rdev); if (do_mknod(fname,file->mode,file->rdev) != 0) { rprintf(FERROR,"mknod %s : %s\n",fname,strerror(errno)); } else { set_perms(fname,file,NULL,0); if (verbose) rprintf(FINFO,"%s\n",fname); } } else { set_perms(fname,file,&st,1); } return; } #endif if (preserve_hard_links && check_hard_link(file)) { if (verbose > 1) rprintf(FINFO, "recv_generator: \"%s\" is a hard link\n",f_name(file)); return; } if (!S_ISREG(file->mode)) { rprintf(FINFO, "skipping non-regular file \"%s\"\n",fname); return; } fnamecmp = fname; if ((statret == -1) && (compare_dest != NULL)) { /* try the file at compare_dest instead */ int saveerrno = errno; snprintf(fnamecmpbuf,MAXPATHLEN,"%s/%s",compare_dest,fname); statret = link_stat(fnamecmpbuf,&st); if (!S_ISREG(st.st_mode)) statret = -1; if (statret == -1) errno = saveerrno; else fnamecmp = fnamecmpbuf; } if (statret == -1) { if (errno == ENOENT) { write_int(f_out,i); if (!dry_run) send_sums(NULL,f_out); } else { if (verbose > 1) rprintf(FERROR, RSYNC_NAME ": recv_generator failed to open \"%s\": %s\n", fname, strerror(errno)); } return; } if (!S_ISREG(st.st_mode)) { if (delete_file(fname) != 0) { return; } /* now pretend the file didn't exist */ write_int(f_out,i); if (!dry_run) send_sums(NULL,f_out); return; } if (opt_ignore_existing && fnamecmp == fname) { if (verbose > 1) rprintf(FINFO,"%s exists\n",fname); return; } if (update_only && cmp_modtime(st.st_mtime,file->modtime)>0 && fnamecmp == fname) { if (verbose > 1) rprintf(FINFO,"%s is newer\n",fname); return; } if (skip_file(fname, file, &st)) { if (fnamecmp == fname) set_perms(fname,file,&st,1); return; } if (dry_run) { write_int(f_out,i); return; } if (disable_deltas_p()) { write_int(f_out,i); send_sums(NULL,f_out); return; } /* open the file */ fd = do_open(fnamecmp, O_RDONLY, 0); if (fd == -1) { rprintf(FERROR,RSYNC_NAME": failed to open \"%s\", continuing : %s\n",fnamecmp,strerror(errno)); /* pretend the file didn't exist */ write_int(f_out,i); send_sums(NULL,f_out); return; } if (st.st_size > 0) { buf = map_file(fd,st.st_size); } else { buf = NULL; } if (verbose > 3) rprintf(FINFO,"gen mapped %s of size %.0f\n",fnamecmp,(double)st.st_size); s = generate_sums(buf,st.st_size,adapt_block_size(file, block_size)); if (verbose > 2) rprintf(FINFO,"sending sums for %d\n",i); write_int(f_out,i); send_sums(s,f_out); close(fd); if (buf) unmap_file(buf); free_sums(s); }

void generate_files (  int    f, struct file_list *    flist, char *    local_name, int    f_recv )

Definition at line 488 of file generator.c. References am_root, file_struct::basename, file_list::count, csum_length, disable_deltas_p(), file_list::files, FINFO, ignore_times, io_timeout, file_struct::mode, read_int(), recv_generator(), remote_version, rprintf(), verbose, and write_int(). Referenced by do_recv(). { int i; int phase=0; if (verbose > 2) rprintf(FINFO,"generator starting pid=%d count=%d\n", (int)getpid(),flist->count); if (verbose >= 2) { rprintf(FINFO, disable_deltas_p() ? "delta-transmission disabled for local transfer or --whole-file\n" : "delta transmission enabled\n"); } /* we expect to just sit around now, so don't exit on a timeout. If we really get a timeout then the other process should exit */ io_timeout = 0; for (i = 0; i < flist->count; i++) { struct file_struct *file = flist->files[i]; mode_t saved_mode = file->mode; if (!file->basename) continue; /* we need to ensure that any directories we create have writeable permissions initially so that we can create the files within them. This is then fixed after the files are transferred */ if (!am_root && S_ISDIR(file->mode)) { file->mode |= S_IWUSR; /* user write */ /* XXX: Could this be causing a problem on SCO? Perhaps their * handling of permissions is strange? */ } recv_generator(local_name?local_name:f_name(file), flist,i,f); file->mode = saved_mode; } phase++; csum_length = SUM_LENGTH; ignore_times=1; if (verbose > 2) rprintf(FINFO,"generate_files phase=%d\n",phase); write_int(f,-1); if (remote_version >= 13) { /* in newer versions of the protocol the files can cycle through the system more than once to catch initial checksum errors */ for (i=read_int(f_recv); i != -1; i=read_int(f_recv)) { struct file_struct *file = flist->files[i]; recv_generator(local_name?local_name:f_name(file), flist,i,f); } phase++; if (verbose > 2) rprintf(FINFO,"generate_files phase=%d\n",phase); write_int(f,-1); } }

---

Variable Documentation

int verbose

Definition at line 26 of file generator.c. Referenced by generate_files(), generate_sums(), and recv_generator().

int dry_run

Definition at line 27 of file generator.c. Referenced by recv_generator().

int relative_paths

Definition at line 28 of file generator.c. Referenced by recv_generator().

int preserve_links

Definition at line 29 of file generator.c. Referenced by parse_arguments(), and recv_generator().

int am_root

Definition at line 30 of file generator.c. Referenced by generate_files(), and recv_generator().

int preserve_devices

Definition at line 31 of file generator.c. Referenced by parse_arguments(), and recv_generator().

int preserve_hard_links

Definition at line 32 of file generator.c. Referenced by recv_generator().

int update_only

Definition at line 33 of file generator.c. Referenced by recv_generator().

int opt_ignore_existing

Definition at line 34 of file generator.c. Referenced by recv_generator(), and server_options().

int block_size

Definition at line 35 of file generator.c. Referenced by recv_generator(), send_sums(), and server_options().

int csum_length

Definition at line 36 of file generator.c. Referenced by generate_files(), and send_sums().

int ignore_times

Definition at line 37 of file generator.c. Referenced by generate_files().

int size_only

Definition at line 38 of file generator.c.

int io_timeout

Definition at line 39 of file generator.c. Referenced by generate_files().

int remote_version

Definition at line 40 of file generator.c. Referenced by generate_files(), and skip_file().

int always_checksum

Definition at line 41 of file generator.c. Referenced by skip_file().

int modify_window = 0

Definition at line 86 of file options.c. Referenced by server_options(), and usage().

char* compare_dest

Definition at line 43 of file generator.c. Referenced by recv_generator(), and skip_file().

---