Backward compatibility fix in read_iflags() (for protocols < 29).
[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 /* This is also used by receive.c with f_out = -1. */
129 int read_iflags(int f_in, int f_out, int ndx, char *buf)
130 {
131         int len;
132         int iflags = protocol_version >= 29 ? read_shortint(f_in)
133                    : ITEM_TRANSFER | ITEM_MISSING_DATA;
134         int isave = iflags; /* XXX remove soon */
135
136         /* Handle the new keep-alive (no-op) packet. */
137         if (ndx == the_file_list->count && iflags == ITEM_IS_NEW)
138                 ;
139         else if (ndx < 0 || ndx >= the_file_list->count) {
140                 rprintf(FERROR, "Invalid file index %d (count=%d) [%s]\n",
141                         ndx, the_file_list->count, who_am_i());
142                 exit_cleanup(RERR_PROTOCOL);
143         } else if (iflags == ITEM_IS_NEW) {
144                 rprintf(FERROR, "Invalid itemized flag word [%s]\n",
145                         who_am_i());
146                 exit_cleanup(RERR_PROTOCOL);
147         }
148
149         if (iflags & ITEM_HARD_LINKED)
150                 len = read_vstring(f_in, buf, MAXPATHLEN);
151         else {
152                 *buf = '\0';
153                 len = -1;
154         }
155
156         /* XXX Temporary backward compatibility when talking to 2.6.4pre[12] */
157         if (protocol_version >= 29 && iflags & ITEM_TRANSFER
158             && !S_ISREG(the_file_list->files[ndx]->mode)) {
159                 iflags &= ~ITEM_TRANSFER;
160                 iflags |= ITEM_LOCAL_CHANGE;
161         }
162
163         if (iflags & ITEM_TRANSFER) {
164                 if (!S_ISREG(the_file_list->files[ndx]->mode)) {
165                         rprintf(FERROR,
166                                 "received index of non-regular file: %d [%s]\n",
167                                 ndx, who_am_i());
168                         exit_cleanup(RERR_PROTOCOL);
169                 }
170         } else if (f_out >= 0) {
171                 write_int(f_out, ndx);
172                 if (protocol_version >= 29)
173                         write_shortint(f_out, isave /*XXX iflags */);
174                 if (len >= 0)
175                         write_vstring(f_out, buf, len);
176         }
177
178         return iflags;
179 }
180
181 void send_files(struct file_list *flist, int f_out, int f_in)
182 {
183         int fd = -1;
184         struct sum_struct *s;
185         struct map_struct *mbuf = NULL;
186         STRUCT_STAT st;
187         char *fname2, fname[MAXPATHLEN];
188         char fnametmp[MAXPATHLEN];
189         int iflags;
190         struct file_struct *file;
191         int phase = 0;
192         struct stats initial_stats;
193         int save_make_backups = make_backups;
194         int itemizing = am_daemon ? daemon_log_format_has_i
195                       : !am_server && log_format_has_i;
196         int i, j;
197
198         if (verbose > 2)
199                 rprintf(FINFO, "send_files starting\n");
200
201         while (1) {
202                 unsigned int offset;
203
204                 i = read_int(f_in);
205                 if (i == -1) {
206                         if (phase == 0) {
207                                 phase++;
208                                 csum_length = SUM_LENGTH;
209                                 write_int(f_out, -1);
210                                 if (verbose > 2)
211                                         rprintf(FINFO, "send_files phase=%d\n", phase);
212                                 /* For inplace: redo phase turns off the backup
213                                  * flag so that we do a regular inplace send. */
214                                 make_backups = 0;
215                                 continue;
216                         }
217                         break;
218                 }
219
220                 iflags = read_iflags(f_in, f_out, i, fnametmp);
221                 if (iflags == ITEM_IS_NEW) /* no-op packet */
222                         continue;
223
224                 file = flist->files[i];
225                 if (file->dir.root) {
226                         /* N.B. We're sure that this fits, so offset is OK. */
227                         offset = strlcpy(fname, file->dir.root, sizeof fname);
228                         if (!offset || fname[offset-1] != '/')
229                                 fname[offset++] = '/';
230                 } else
231                         offset = 0;
232                 fname2 = f_name_to(file, fname + offset);
233
234                 if (verbose > 2)
235                         rprintf(FINFO, "send_files(%d, %s)\n", i, fname);
236
237                 if (!(iflags & ITEM_TRANSFER)) {
238                         maybe_log_item(file, iflags, itemizing, fnametmp);
239                         continue;
240                 }
241
242                 if (inplace && protocol_version >= 29) {
243                         updating_basis_file = !(iflags & ITEM_USING_ALT_BASIS);
244                 } else
245                         updating_basis_file = inplace && !make_backups;
246
247                 stats.current_file_index = i;
248                 stats.num_transferred_files++;
249                 stats.total_transferred_size += file->length;
250
251                 if (dry_run) { /* log the transfer */
252                         if (!am_server && log_format)
253                                 log_item(file, &stats, iflags, NULL);
254                         write_int(f_out, i);
255                         if (protocol_version >= 29)
256                                 write_shortint(f_out, iflags);
257                         continue;
258                 }
259
260                 initial_stats = stats;
261
262                 if (!(s = receive_sums(f_in))) {
263                         io_error |= IOERR_GENERAL;
264                         rprintf(FERROR, "receive_sums failed\n");
265                         return;
266                 }
267
268                 fd = do_open(fname, O_RDONLY, 0);
269                 if (fd == -1) {
270                         if (errno == ENOENT) {
271                                 enum logcode c = am_daemon
272                                     && protocol_version < 28 ? FERROR
273                                                              : FINFO;
274                                 io_error |= IOERR_VANISHED;
275                                 rprintf(c, "file has vanished: %s\n",
276                                         full_fname(fname));
277                         } else {
278                                 io_error |= IOERR_GENERAL;
279                                 rsyserr(FERROR, errno,
280                                         "send_files failed to open %s",
281                                         full_fname(fname));
282                         }
283                         free_sums(s);
284                         continue;
285                 }
286
287                 /* map the local file */
288                 if (do_fstat(fd, &st) != 0) {
289                         io_error |= IOERR_GENERAL;
290                         rsyserr(FERROR, errno, "fstat failed");
291                         free_sums(s);
292                         close(fd);
293                         return;
294                 }
295
296                 if (st.st_size) {
297                         int32 read_size = MAX(s->blength * 3, MAX_MAP_SIZE);
298                         mbuf = map_file(fd, st.st_size, read_size, s->blength);
299                 } else
300                         mbuf = NULL;
301
302                 if (verbose > 2) {
303                         rprintf(FINFO, "send_files mapped %s of size %.0f\n",
304                                 safe_fname(fname), (double)st.st_size);
305                 }
306
307                 write_int(f_out, i);
308                 if (protocol_version >= 29)
309                         write_shortint(f_out, iflags);
310                 write_sum_head(f_out, s);
311
312                 if (verbose > 2) {
313                         rprintf(FINFO, "calling match_sums %s\n",
314                                 safe_fname(fname));
315                 }
316
317                 if (log_before_transfer)
318                         log_item(file, &initial_stats, iflags, NULL);
319                 else if (!am_server && verbose && do_progress)
320                         rprintf(FINFO, "%s\n", safe_fname(fname2));
321
322                 set_compression(fname);
323
324                 match_sums(f_out, s, mbuf, st.st_size);
325                 if (do_progress)
326                         end_progress(st.st_size);
327
328                 if (!log_before_transfer)
329                         log_item(file, &initial_stats, iflags, NULL);
330
331                 if (mbuf) {
332                         j = unmap_file(mbuf);
333                         if (j) {
334                                 io_error |= IOERR_GENERAL;
335                                 rsyserr(FERROR, j,
336                                         "read errors mapping %s",
337                                         full_fname(fname));
338                         }
339                 }
340                 close(fd);
341
342                 free_sums(s);
343
344                 if (verbose > 2) {
345                         rprintf(FINFO, "sender finished %s\n",
346                                 safe_fname(fname));
347                 }
348
349                 /* Flag that we actually sent this entry. */
350                 file->flags |= FLAG_SENT;
351         }
352         make_backups = save_make_backups;
353
354         if (verbose > 2)
355                 rprintf(FINFO, "send files finished\n");
356
357         match_report();
358
359         write_int(f_out, -1);
360 }