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