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