Patch from J.W. Schultz to have --include-from and --exclude-from on
[rsync/rsync.git] / generator.c
index 4845238..dd3eef6 100644 (file)
@@ -1,7 +1,10 @@
 /* -*- c-file-style: "linux" -*-
+
+   rsync -- fast file replication program
    
    Copyright (C) 1996-2000 by Andrew Tridgell 
    Copyright (C) Paul Mackerras 1996
+   Copyright (C) 2002 by Martin Pool <mbp@samba.org>
    
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -28,7 +31,7 @@ extern int am_root;
 extern int preserve_devices;
 extern int preserve_hard_links;
 extern int update_only;
-extern int whole_file;
+extern int opt_ignore_existing;
 extern int block_size;
 extern int csum_length;
 extern int ignore_times;
@@ -56,7 +59,7 @@ static int skip_file(char *fname,
 
                if (compare_dest != NULL) {
                        if (access(fname, 0) != 0) {
-                               slprintf(fnamecmpdest,MAXPATHLEN,"%s/%s",
+                               snprintf(fnamecmpdest,MAXPATHLEN,"%s/%s",
                                                    compare_dest,fname);
                                fname = fnamecmpdest;
                        }
@@ -97,101 +100,110 @@ static int adapt_block_size(struct file_struct *file, int bsize)
 
 
 /*
-  send a sums struct down a fd
+  send a header that says "we have no checksums" down the f_out fd
   */
-static void send_sums(struct sum_struct *s,int f_out)
+static void send_null_sums(int f_out)
 {
-       int 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?s->count:0);
-       write_int(f_out,s?s->n:block_size);
-       write_int(f_out,s?s->remainder:0);
+       write_int(f_out, 0);
+       write_int(f_out, block_size);
+       write_int(f_out, 0);
+}
 
-       if (!s) return;
 
-       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);
-       }
+
+/**
+ * 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. */
+static BOOL disable_deltas_p(void)
+{
+       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;
 }
 
 
 /*
-  generate a stream of signatures/checksums that describe a buffer
-
-  generate approximately one checksum every n bytes
-  */
-static struct sum_struct *generate_sums(struct map_struct *buf,OFF_T len,int n)
+ * Generate and send a stream of signatures/checksums that describe a buffer
+ *
+ * Generate approximately one checksum every block_len bytes.
+ */
+static void generate_and_send_sums(struct map_struct *buf, OFF_T len,
+                                  int block_len, int f_out)
 {
-       int i;
-       struct sum_struct *s;
-       int count;
-       int block_len = n;
-       int remainder = (len%block_len);
+       size_t i;
+       struct sum_struct sum;
        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;
+       sum.count = (len + (block_len - 1)) / block_len;
+       sum.remainder = (len % block_len);
+       sum.n = block_len;
+       sum.flength = len;
+       /* not needed here  sum.sums = NULL; */
 
-       if (count==0) {
-               s->sums = NULL;
-               return s;
+       if (sum.count && verbose > 3) {
+               rprintf(FINFO, "count=%ld rem=%ld n=%ld flength=%.0f\n",
+                       (long) sum.count, (long) sum.remainder,
+                       (long) sum.n, (double) sum.flength);
        }
 
-       if (verbose > 3)
-               rprintf(FINFO,"count=%d rem=%d n=%d flength=%.0f\n",
-                       s->count,s->remainder,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);
+       write_int(f_out, sum.count);
+       write_int(f_out, sum.n);
+       write_int(f_out, sum.remainder);
 
-               s->sums[i].offset = offset;
-               s->sums[i].len = n1;
-               s->sums[i].i = i;
+       for (i = 0; i < sum.count; i++) {
+               int n1 = MIN(len, block_len);
+               char *map = map_ptr(buf, offset, n1);
+               uint32 sum1 = get_checksum1(map, n1);
+               char sum2[SUM_LENGTH];
 
-               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);
+               get_checksum2(map, n1, sum2);
 
+               if (verbose > 3) {
+                       rprintf(FINFO,
+                               "chunk[%d] offset=%.0f len=%d sum1=%08lx\n",
+                               i, (double) offset, n1, (unsigned long) sum1);
+               }
+               write_int(f_out, sum1);
+               write_buf(f_out, sum2, csum_length);
                len -= n1;
                offset += n1;
        }
-
-       return s;
 }
 
 
 
-/*
- * Acts on file number I from FLIST, whose name is fname.
+/**
+ * Acts on file number @p i from @p flist, whose name is @p fname.
  *
  * First fixes up permissions, then generates checksums for the file.
  *
- * (This comment was added later by mbp who was trying to work it out;
- * it might be wrong.)
- */ 
-void recv_generator(char *fname,struct file_list *flist,int i,int f_out)
+ * @note This comment was added later by mbp who was trying to work it
+ * out.  It might be wrong.
+ **
+void recv_generator(char *fname, struct file_list *flist, int i, int f_out)
 {  
        int fd;
        STRUCT_STAT st;
        struct map_struct *buf;
-       struct sum_struct *s;
        int statret;
        struct file_struct *file = flist->files[i];
        char *fnamecmp;
@@ -200,6 +212,7 @@ void recv_generator(char *fname,struct file_list *flist,int i,int f_out)
        extern int list_only;
        extern int preserve_perms;
        extern int only_existing;
+       extern int orig_umask;
 
        if (list_only) return;
 
@@ -210,7 +223,7 @@ void recv_generator(char *fname,struct file_list *flist,int i,int f_out)
 
        if (only_existing && statret == -1 && errno == ENOENT) {
                /* we only want to update existing files */
-               if (verbose > 1) rprintf(FINFO,"not creating %s\n",fname);
+               if (verbose > 1) rprintf(FINFO, "not creating new file \"%s\"\n",fname);
                return;
        }
 
@@ -230,10 +243,11 @@ void recv_generator(char *fname,struct file_list *flist,int i,int f_out)
                  * we need to delete it.  If it doesn't exist, then
                  * recursively create it. */
           
-               if (dry_run) return;
+               if (dry_run) return; /* XXXX -- might cause inaccuracies?? -- mbp */
                if (statret == 0 && !S_ISDIR(st.st_mode)) {
                        if (robust_unlink(fname) != 0) {
-                               rprintf(FERROR,"recv_generator: unlink %s: %s\n",
+                               rprintf(FERROR, RSYNC_NAME
+                                       ": recv_generator: unlink \"%s\" to make room for directory: %s\n",
                                         fname,strerror(errno));
                                return;
                        }
@@ -241,13 +255,15 @@ void recv_generator(char *fname,struct file_list *flist,int i,int f_out)
                }
                if (statret != 0 && do_mkdir(fname,file->mode) != 0 && errno != EEXIST) {
                        if (!(relative_paths && errno==ENOENT && 
-                             create_directory_path(fname)==0 && 
+                             create_directory_path(fname, orig_umask)==0 && 
                              do_mkdir(fname,file->mode)==0)) {
-                               rprintf(FERROR,"recv_generator: mkdir %s: %s (2)\n",
+                               rprintf(FERROR, RSYNC_NAME ": recv_generator: mkdir \"%s\": %s (2)\n",
                                        fname,strerror(errno));
                        }
                }
-               if (set_perms(fname,file,NULL,0) && verbose) 
+               /* 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;
        }
@@ -260,7 +276,7 @@ void recv_generator(char *fname,struct file_list *flist,int i,int f_out)
 
                if (safe_symlinks && unsafe_symlink(file->link, fname)) {
                        if (verbose) {
-                               rprintf(FINFO,"ignoring unsafe symlink %s -> %s\n",
+                               rprintf(FINFO,"ignoring unsafe symlink \"%s\" -> \"%s\"\n",
                                        fname,file->link);
                        }
                        return;
@@ -269,21 +285,26 @@ void recv_generator(char *fname,struct file_list *flist,int i,int f_out)
                        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,"symlink %s -> %s : %s\n",
+                       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);
+                               rprintf(FINFO,"%s -> %s\n", fname,file->link);
                        }
                }
 #endif
@@ -315,12 +336,12 @@ void recv_generator(char *fname,struct file_list *flist,int i,int f_out)
 
        if (preserve_hard_links && check_hard_link(file)) {
                if (verbose > 1)
-                       rprintf(FINFO,"%s is a hard link\n",f_name(file));
+                       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);
+               rprintf(FINFO, "skipping non-regular file \"%s\"\n",fname);
                return;
        }
 
@@ -329,7 +350,7 @@ void recv_generator(char *fname,struct file_list *flist,int i,int f_out)
        if ((statret == -1) && (compare_dest != NULL)) {
                /* try the file at compare_dest instead */
                int saveerrno = errno;
-               slprintf(fnamecmpbuf,MAXPATHLEN,"%s/%s",compare_dest,fname);
+               snprintf(fnamecmpbuf,MAXPATHLEN,"%s/%s",compare_dest,fname);
                statret = link_stat(fnamecmpbuf,&st);
                if (!S_ISREG(st.st_mode))
                        statret = -1;
@@ -342,10 +363,12 @@ void recv_generator(char *fname,struct file_list *flist,int i,int f_out)
        if (statret == -1) {
                if (errno == ENOENT) {
                        write_int(f_out,i);
-                       if (!dry_run) send_sums(NULL,f_out);
+                       if (!dry_run) send_null_sums(f_out);
                } else {
                        if (verbose > 1)
-                               rprintf(FERROR,"recv_generator failed to open %s\n",fname);
+                               rprintf(FERROR, RSYNC_NAME
+                                       ": recv_generator failed to open \"%s\": %s\n",
+                                       fname, strerror(errno));
                }
                return;
        }
@@ -357,10 +380,16 @@ void recv_generator(char *fname,struct file_list *flist,int i,int f_out)
 
                /* now pretend the file didn't exist */
                write_int(f_out,i);
-               if (!dry_run) send_sums(NULL,f_out);    
+               if (!dry_run) send_null_sums(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);
@@ -378,9 +407,9 @@ void recv_generator(char *fname,struct file_list *flist,int i,int f_out)
                return;
        }
 
-       if (whole_file) {
+       if (disable_deltas_p()) {
                write_int(f_out,i);
-               send_sums(NULL,f_out);    
+               send_null_sums(f_out);
                return;
        }
 
@@ -388,10 +417,10 @@ void recv_generator(char *fname,struct file_list *flist,int i,int f_out)
        fd = do_open(fnamecmp, O_RDONLY, 0);
 
        if (fd == -1) {
-               rprintf(FERROR,"failed to open %s, continuing : %s\n",fnamecmp,strerror(errno));
+               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);
+               send_null_sums(f_out);
                return;
        }
 
@@ -404,18 +433,15 @@ void recv_generator(char *fname,struct file_list *flist,int i,int f_out)
        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);
+               rprintf(FINFO, "generating and sending sums for %d\n", i);
 
        write_int(f_out,i);
-       send_sums(s,f_out);
+       generate_and_send_sums(buf, st.st_size,
+                              adapt_block_size(file, block_size), f_out);
 
        close(fd);
        if (buf) unmap_file(buf);
-
-       free_sums(s);
 }
 
 
@@ -429,6 +455,18 @@ void generate_files(int f,struct file_list *flist,char *local_name,int f_recv)
                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;
@@ -458,11 +496,6 @@ void generate_files(int f,struct file_list *flist,char *local_name,int f_recv)
 
        write_int(f,-1);
 
-       /* 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;
-
        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 */