Added an extra phase to the end of the transfer to handle
[rsync/rsync.git] / sender.c
1 /*
2    Copyright (C) Andrew Tridgell 1996
3    Copyright (C) Paul Mackerras 1996
4
5    This program is free software; you can redistribute it and/or modify
6    it under the terms of the GNU General Public License as published by
7    the Free Software Foundation; either version 2 of the License, or
8    (at your option) any later version.
9
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13    GNU General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software
17    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19
20 #include "rsync.h"
21
22 extern int verbose;
23 extern int dry_run;
24 extern int am_server;
25 extern int am_daemon;
26 extern int log_before_transfer;
27 extern int log_format_has_i;
28 extern int daemon_log_format_has_i;
29 extern int csum_length;
30 extern int io_error;
31 extern int protocol_version;
32 extern int remove_sent_files;
33 extern int updating_basis_file;
34 extern int make_backups;
35 extern int do_progress;
36 extern int inplace;
37 extern struct stats stats;
38 extern struct file_list *the_file_list;
39 extern char *log_format;
40
41
42 /**
43  * @file
44  *
45  * The sender gets checksums from the generator, calculates deltas,
46  * and transmits them to the receiver.  The sender process runs on the
47  * machine holding the source files.
48  **/
49
50 /**
51  * Receive the checksums for a buffer
52  **/
53 static struct sum_struct *receive_sums(int f)
54 {
55         struct sum_struct *s;
56         int32 i;
57         OFF_T offset = 0;
58
59         if (!(s = new(struct sum_struct)))
60                 out_of_memory("receive_sums");
61
62         read_sum_head(f, s);
63
64         s->sums = NULL;
65
66         if (verbose > 3) {
67                 rprintf(FINFO, "count=%.0f n=%ld rem=%ld\n",
68                         (double)s->count, (long)s->blength, (long)s->remainder);
69         }
70
71         if (s->count == 0)
72                 return(s);
73
74         if (!(s->sums = new_array(struct sum_buf, s->count)))
75                 out_of_memory("receive_sums");
76
77         for (i = 0; i < s->count; i++) {
78                 s->sums[i].sum1 = read_int(f);
79                 read_buf(f, s->sums[i].sum2, s->s2length);
80
81                 s->sums[i].offset = offset;
82                 s->sums[i].flags = 0;
83
84                 if (i == s->count-1 && s->remainder != 0)
85                         s->sums[i].len = s->remainder;
86                 else
87                         s->sums[i].len = s->blength;
88                 offset += s->sums[i].len;
89
90                 if (verbose > 3) {
91                         rprintf(FINFO,
92                                 "chunk[%d] len=%d offset=%.0f sum1=%08x\n",
93                                 i, s->sums[i].len, (double)s->sums[i].offset,
94                                 s->sums[i].sum1);
95                 }
96         }
97
98         s->flength = offset;
99
100         return s;
101 }
102
103 void successful_send(int ndx)
104 {
105         char fname[MAXPATHLEN];
106         struct file_struct *file;
107         unsigned int offset;
108
109         if (ndx < 0 || ndx >= the_file_list->count)
110                 return;
111
112         file = the_file_list->files[ndx];
113         /* The generator might tell us about symlinks we didn't send. */
114         if (!(file->flags & FLAG_SENT) && !S_ISLNK(file->mode))
115                 return;
116         if (file->dir.root) {
117                 offset = stringjoin(fname, sizeof fname,
118                                     file->dir.root, "/", NULL);
119         } else
120                 offset = 0;
121         f_name_to(file, fname + offset);
122         if (remove_sent_files && do_unlink(fname) == 0 && verbose > 1) {
123                 rprintf(FINFO, "sender removed %s\n",
124                         safe_fname(fname + offset));
125         }
126 }
127
128 static void write_ndx_and_attrs(int f_out, int ndx, int iflags,
129                                 uchar fnamecmp_type, char *buf, int len)
130 {
131         write_int(f_out, ndx);
132         if (protocol_version < 29)
133                 return;
134         write_shortint(f_out, iflags);
135         if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
136                 write_byte(f_out, fnamecmp_type);
137         if (iflags & ITEM_XNAME_FOLLOWS)
138                 write_vstring(f_out, buf, len);
139 }
140
141 /* This is also used by receive.c with f_out = -1. */
142 int read_item_attrs(int f_in, int f_out, int ndx, uchar *type_ptr,
143                     char *buf, int *len_ptr)
144 {
145         int len;
146         uchar fnamecmp_type = FNAMECMP_FNAME;
147         int iflags = protocol_version >= 29 ? read_shortint(f_in)
148                    : ITEM_TRANSFER | ITEM_MISSING_DATA;
149         int isave = iflags; /* XXX remove soon */
150
151         /* Handle the new keep-alive (no-op) packet. */
152         if (ndx == the_file_list->count && iflags == ITEM_IS_NEW)
153                 ;
154         else if (ndx < 0 || ndx >= the_file_list->count) {
155                 rprintf(FERROR, "Invalid file index: %d (count=%d) [%s]\n",
156                         ndx, the_file_list->count, who_am_i());
157                 exit_cleanup(RERR_PROTOCOL);
158         } else if (iflags == ITEM_IS_NEW) {
159                 rprintf(FERROR, "Invalid itemized flag word: %x [%s]\n",
160                         iflags, who_am_i());
161                 exit_cleanup(RERR_PROTOCOL);
162         }
163
164         if (iflags & ITEM_BASIS_TYPE_FOLLOWS)
165                 fnamecmp_type = read_byte(f_in);
166         *type_ptr = fnamecmp_type;
167
168         if (iflags & ITEM_XNAME_FOLLOWS) {
169                 if ((len = read_vstring(f_in, buf, MAXPATHLEN)) < 0)
170                         exit_cleanup(RERR_PROTOCOL);
171         } else {
172                 *buf = '\0';
173                 len = -1;
174         }
175         *len_ptr = len;
176
177         /* XXX Temporary backward compatibility when talking to 2.6.4pre[12] */
178         if (protocol_version >= 29 && iflags & ITEM_TRANSFER
179             && !S_ISREG(the_file_list->files[ndx]->mode)) {
180                 iflags &= ~ITEM_TRANSFER;
181                 iflags |= ITEM_LOCAL_CHANGE;
182         }
183
184         if (iflags & ITEM_TRANSFER) {
185                 if (!S_ISREG(the_file_list->files[ndx]->mode)) {
186                         rprintf(FERROR,
187                                 "received request to transfer non-regular file: %d [%s]\n",
188                                 ndx, who_am_i());
189                         exit_cleanup(RERR_PROTOCOL);
190                 }
191         } else if (f_out >= 0) {
192                 write_ndx_and_attrs(f_out, ndx, isave /*XXX iflags */,
193                                     fnamecmp_type, buf, len);
194         }
195
196         return iflags;
197 }
198
199 void send_files(struct file_list *flist, int f_out, int f_in)
200 {
201         int fd = -1;
202         struct sum_struct *s;
203         struct map_struct *mbuf = NULL;
204         STRUCT_STAT st;
205         char *fname2, fname[MAXPATHLEN];
206         char xname[MAXPATHLEN];
207         uchar fnamecmp_type;
208         int iflags, xlen;
209         struct file_struct *file;
210         int phase = 0;
211         struct stats initial_stats;
212         int save_make_backups = make_backups;
213         int itemizing = am_daemon ? daemon_log_format_has_i
214                       : !am_server && log_format_has_i;
215         int i, j;
216
217         if (verbose > 2)
218                 rprintf(FINFO, "send_files starting\n");
219
220         while (1) {
221                 unsigned int offset;
222
223                 i = read_int(f_in);
224                 if (i == -1) {
225                         if (phase)
226                                 break;
227                         phase = 1;
228                         csum_length = SUM_LENGTH;
229                         if (verbose > 2)
230                                 rprintf(FINFO, "send_files phase=%d\n", phase);
231                         write_int(f_out, -1);
232                         /* For inplace: redo phase turns off the backup
233                          * flag so that we do a regular inplace send. */
234                         make_backups = 0;
235                         continue;
236                 }
237
238                 iflags = read_item_attrs(f_in, f_out, i, &fnamecmp_type,
239                                          xname, &xlen);
240                 if (iflags == ITEM_IS_NEW) /* no-op packet */
241                         continue;
242
243                 file = flist->files[i];
244                 if (file->dir.root) {
245                         /* N.B. We're sure that this fits, so offset is OK. */
246                         offset = strlcpy(fname, file->dir.root, sizeof fname);
247                         if (!offset || fname[offset-1] != '/')
248                                 fname[offset++] = '/';
249                 } else
250                         offset = 0;
251                 fname2 = f_name_to(file, fname + offset);
252
253                 if (verbose > 2)
254                         rprintf(FINFO, "send_files(%d, %s)\n", i, fname);
255
256                 if (!(iflags & ITEM_TRANSFER)) {
257                         maybe_log_item(file, iflags, itemizing, xname);
258                         continue;
259                 }
260
261                 updating_basis_file = inplace && (protocol_version >= 29
262                         ? fnamecmp_type == FNAMECMP_FNAME : !make_backups);
263
264                 stats.current_file_index = i;
265                 stats.num_transferred_files++;
266                 stats.total_transferred_size += file->length;
267
268                 if (dry_run) { /* log the transfer */
269                         if (!am_server && log_format)
270                                 log_item(file, &stats, iflags, NULL);
271                         write_ndx_and_attrs(f_out, i, iflags, fnamecmp_type,
272                                             xname, xlen);
273                         continue;
274                 }
275
276                 initial_stats = stats;
277
278                 if (!(s = receive_sums(f_in))) {
279                         io_error |= IOERR_GENERAL;
280                         rprintf(FERROR, "receive_sums failed\n");
281                         return;
282                 }
283
284                 fd = do_open(fname, O_RDONLY, 0);
285                 if (fd == -1) {
286                         if (errno == ENOENT) {
287                                 enum logcode c = am_daemon
288                                     && protocol_version < 28 ? FERROR
289                                                              : FINFO;
290                                 io_error |= IOERR_VANISHED;
291                                 rprintf(c, "file has vanished: %s\n",
292                                         full_fname(fname));
293                         } else {
294                                 io_error |= IOERR_GENERAL;
295                                 rsyserr(FERROR, errno,
296                                         "send_files failed to open %s",
297                                         full_fname(fname));
298                         }
299                         free_sums(s);
300                         continue;
301                 }
302
303                 /* map the local file */
304                 if (do_fstat(fd, &st) != 0) {
305                         io_error |= IOERR_GENERAL;
306                         rsyserr(FERROR, errno, "fstat failed");
307                         free_sums(s);
308                         close(fd);
309                         return;
310                 }
311
312                 if (st.st_size) {
313                         int32 read_size = MAX(s->blength * 3, MAX_MAP_SIZE);
314                         mbuf = map_file(fd, st.st_size, read_size, s->blength);
315                 } else
316                         mbuf = NULL;
317
318                 if (verbose > 2) {
319                         rprintf(FINFO, "send_files mapped %s of size %.0f\n",
320                                 safe_fname(fname), (double)st.st_size);
321                 }
322
323                 write_ndx_and_attrs(f_out, i, iflags, fnamecmp_type,
324                                     xname, xlen);
325                 write_sum_head(f_out, s);
326
327                 if (verbose > 2) {
328                         rprintf(FINFO, "calling match_sums %s\n",
329                                 safe_fname(fname));
330                 }
331
332                 if (log_before_transfer)
333                         log_item(file, &initial_stats, iflags, NULL);
334                 else if (!am_server && verbose && do_progress)
335                         rprintf(FINFO, "%s\n", safe_fname(fname2));
336
337                 set_compression(fname);
338
339                 match_sums(f_out, s, mbuf, st.st_size);
340                 if (do_progress)
341                         end_progress(st.st_size);
342
343                 if (!log_before_transfer)
344                         log_item(file, &initial_stats, iflags, NULL);
345
346                 if (mbuf) {
347                         j = unmap_file(mbuf);
348                         if (j) {
349                                 io_error |= IOERR_GENERAL;
350                                 rsyserr(FERROR, j,
351                                         "read errors mapping %s",
352                                         full_fname(fname));
353                         }
354                 }
355                 close(fd);
356
357                 free_sums(s);
358
359                 if (verbose > 2) {
360                         rprintf(FINFO, "sender finished %s\n",
361                                 safe_fname(fname));
362                 }
363
364                 /* Flag that we actually sent this entry. */
365                 file->flags |= FLAG_SENT;
366         }
367         make_backups = save_make_backups;
368
369         if (verbose > 2)
370                 rprintf(FINFO, "send files finished\n");
371
372         match_report();
373
374         write_int(f_out, -1);
375 }