Mention the index number for an "invalid packet at end of run".
[rsync/rsync.git] / receiver.c
1 /* -*- c-file-style: "linux" -*-
2
3    Copyright (C) 1996-2000 by Andrew Tridgell
4    Copyright (C) Paul Mackerras 1996
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program; if not, write to the Free Software
18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 */
20
21 #include "rsync.h"
22
23 extern int verbose;
24 extern int dry_run;
25 extern int am_daemon;
26 extern int am_server;
27 extern int do_progress;
28 extern int log_before_transfer;
29 extern int log_format_has_i;
30 extern int daemon_log_format_has_i;
31 extern int csum_length;
32 extern int read_batch;
33 extern int batch_gen_fd;
34 extern int protocol_version;
35 extern int relative_paths;
36 extern int keep_dirlinks;
37 extern int preserve_hard_links;
38 extern int preserve_perms;
39 extern int io_error;
40 extern int basis_dir_cnt;
41 extern int make_backups;
42 extern int cleanup_got_literal;
43 extern int remove_sent_files;
44 extern int module_id;
45 extern int ignore_errors;
46 extern int orig_umask;
47 extern int keep_partial;
48 extern int checksum_seed;
49 extern int inplace;
50 extern int delay_updates;
51 extern struct stats stats;
52 extern char *log_format;
53 extern char *tmpdir;
54 extern char *partial_dir;
55 extern char *basis_dir[];
56
57 extern struct filter_list_struct server_filter_list;
58
59 #define SLOT_SIZE       (16*1024)       /* Desired size in bytes */
60 #define PER_SLOT_BITS   (SLOT_SIZE * 8) /* Number of bits per slot */
61 #define PER_SLOT_INTS   (SLOT_SIZE / 4) /* Number of int32s per slot */
62
63 static uint32 **delayed_bits = NULL;
64 static int delayed_slot_cnt = 0;
65
66 static void init_delayed_bits(int max_ndx)
67 {
68         delayed_slot_cnt = (max_ndx + PER_SLOT_BITS - 1) / PER_SLOT_BITS;
69
70         if (!(delayed_bits = (uint32**)calloc(delayed_slot_cnt, sizeof (uint32*))))
71                 out_of_memory("set_delayed_bit");
72 }
73
74 static void set_delayed_bit(int ndx)
75 {
76         int slot = ndx / PER_SLOT_BITS;
77         ndx %= PER_SLOT_BITS;
78
79         if (!delayed_bits[slot]) {
80                 if (!(delayed_bits[slot] = (uint32*)calloc(PER_SLOT_INTS, 4)))
81                         out_of_memory("set_delayed_bit");
82         }
83
84         delayed_bits[slot][ndx/32] |= 1u << (ndx % 32);
85 }
86
87 /* Call this with -1 to start checking from 0.  Returns -1 at the end. */
88 static int next_delayed_bit(int after)
89 {
90         uint32 bits, mask;
91         int i, ndx = after + 1;
92         int slot = ndx / PER_SLOT_BITS;
93         ndx %= PER_SLOT_BITS;
94
95         mask = (1u << (ndx % 32)) - 1;
96         for (i = ndx / 32; slot < delayed_slot_cnt; slot++, i = mask = 0) {
97                 if (!delayed_bits[slot])
98                         continue;
99                 for ( ; i < PER_SLOT_INTS; i++, mask = 0) {
100                         if (!(bits = delayed_bits[slot][i] & ~mask))
101                                 continue;
102                         /* The xor magic figures out the lowest enabled bit in
103                          * bits, and the switch quickly computes log2(bit). */
104                         switch (bits ^ (bits & (bits-1))) {
105 #define LOG2(n) case 1u << n: return slot*PER_SLOT_BITS + i*32 + n
106                             LOG2(0);  LOG2(1);  LOG2(2);  LOG2(3);
107                             LOG2(4);  LOG2(5);  LOG2(6);  LOG2(7);
108                             LOG2(8);  LOG2(9);  LOG2(10); LOG2(11);
109                             LOG2(12); LOG2(13); LOG2(14); LOG2(15);
110                             LOG2(16); LOG2(17); LOG2(18); LOG2(19);
111                             LOG2(20); LOG2(21); LOG2(22); LOG2(23);
112                             LOG2(24); LOG2(25); LOG2(26); LOG2(27);
113                             LOG2(28); LOG2(29); LOG2(30); LOG2(31);
114                         }
115                         return -1; /* impossible... */
116                 }
117         }
118
119         return -1;
120 }
121
122
123 /*
124  * get_tmpname() - create a tmp filename for a given filename
125  *
126  *   If a tmpdir is defined, use that as the directory to
127  *   put it in.  Otherwise, the tmp filename is in the same
128  *   directory as the given name.  Note that there may be no
129  *   directory at all in the given name!
130  *
131  *   The tmp filename is basically the given filename with a
132  *   dot prepended, and .XXXXXX appended (for mkstemp() to
133  *   put its unique gunk in).  Take care to not exceed
134  *   either the MAXPATHLEN or NAME_MAX, esp. the last, as
135  *   the basename basically becomes 8 chars longer. In that
136  *   case, the original name is shortened sufficiently to
137  *   make it all fit.
138  *
139  *   Of course, there's no real reason for the tmp name to
140  *   look like the original, except to satisfy us humans.
141  *   As long as it's unique, rsync will work.
142  */
143
144 static int get_tmpname(char *fnametmp, char *fname)
145 {
146         char *f;
147         int     length = 0;
148         int     maxname;
149
150         if (tmpdir) {
151                 /* Note: this can't overflow, so the return value is safe */
152                 length = strlcpy(fnametmp, tmpdir, MAXPATHLEN - 2);
153                 fnametmp[length++] = '/';
154                 fnametmp[length] = '\0';        /* always NULL terminated */
155         }
156
157         if ((f = strrchr(fname, '/')) != NULL) {
158                 ++f;
159                 if (!tmpdir) {
160                         length = f - fname;
161                         /* copy up to and including the slash */
162                         strlcpy(fnametmp, fname, length + 1);
163                 }
164         } else
165                 f = fname;
166         fnametmp[length++] = '.';
167         fnametmp[length] = '\0';                /* always NULL terminated */
168
169         maxname = MIN(MAXPATHLEN - 7 - length, NAME_MAX - 8);
170
171         if (maxname < 1) {
172                 rprintf(FERROR, "temporary filename too long: %s\n",
173                         safe_fname(fname));
174                 fnametmp[0] = '\0';
175                 return 0;
176         }
177
178         strlcpy(fnametmp + length, f, maxname);
179         strcat(fnametmp + length, ".XXXXXX");
180
181         return 1;
182 }
183
184
185 static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
186                         char *fname, int fd, OFF_T total_size)
187 {
188         static char file_sum1[MD4_SUM_LENGTH];
189         static char file_sum2[MD4_SUM_LENGTH];
190         struct map_struct *mapbuf;
191         struct sum_struct sum;
192         int32 len;
193         OFF_T offset = 0;
194         OFF_T offset2;
195         char *data;
196         int32 i;
197         char *map = NULL;
198
199         read_sum_head(f_in, &sum);
200
201         if (fd_r >= 0 && size_r > 0) {
202                 int32 read_size = MAX(sum.blength * 2, 16*1024);
203                 mapbuf = map_file(fd_r, size_r, read_size, sum.blength);
204                 if (verbose > 2) {
205                         rprintf(FINFO, "recv mapped %s of size %.0f\n",
206                                 safe_fname(fname_r), (double)size_r);
207                 }
208         } else
209                 mapbuf = NULL;
210
211         sum_init(checksum_seed);
212
213         while ((i = recv_token(f_in, &data)) != 0) {
214                 if (do_progress)
215                         show_progress(offset, total_size);
216
217                 if (i > 0) {
218                         if (verbose > 3) {
219                                 rprintf(FINFO,"data recv %d at %.0f\n",
220                                         i,(double)offset);
221                         }
222
223                         stats.literal_data += i;
224                         cleanup_got_literal = 1;
225
226                         sum_update(data, i);
227
228                         if (fd != -1 && write_file(fd,data,i) != i)
229                                 goto report_write_error;
230                         offset += i;
231                         continue;
232                 }
233
234                 i = -(i+1);
235                 offset2 = i * (OFF_T)sum.blength;
236                 len = sum.blength;
237                 if (i == (int)sum.count-1 && sum.remainder != 0)
238                         len = sum.remainder;
239
240                 stats.matched_data += len;
241
242                 if (verbose > 3) {
243                         rprintf(FINFO,
244                                 "chunk[%d] of size %ld at %.0f offset=%.0f\n",
245                                 i, (long)len, (double)offset2, (double)offset);
246                 }
247
248                 if (mapbuf) {
249                         map = map_ptr(mapbuf,offset2,len);
250
251                         see_token(map, len);
252                         sum_update(map, len);
253                 }
254
255                 if (inplace) {
256                         if (offset == offset2 && fd != -1) {
257                                 if (flush_write_file(fd) < 0)
258                                         goto report_write_error;
259                                 offset += len;
260                                 if (do_lseek(fd, len, SEEK_CUR) != offset) {
261                                         rsyserr(FERROR, errno,
262                                                 "lseek failed on %s",
263                                                 full_fname(fname));
264                                         exit_cleanup(RERR_FILEIO);
265                                 }
266                                 continue;
267                         }
268                 }
269                 if (fd != -1 && write_file(fd, map, len) != (int)len)
270                         goto report_write_error;
271                 offset += len;
272         }
273
274         if (flush_write_file(fd) < 0)
275                 goto report_write_error;
276
277 #ifdef HAVE_FTRUNCATE
278         if (inplace && fd != -1)
279                 ftruncate(fd, offset);
280 #endif
281
282         if (do_progress)
283                 end_progress(total_size);
284
285         if (fd != -1 && offset > 0 && sparse_end(fd) != 0) {
286             report_write_error:
287                 rsyserr(FERROR, errno, "write failed on %s",
288                         full_fname(fname));
289                 exit_cleanup(RERR_FILEIO);
290         }
291
292         sum_end(file_sum1);
293
294         if (mapbuf)
295                 unmap_file(mapbuf);
296
297         read_buf(f_in,file_sum2,MD4_SUM_LENGTH);
298         if (verbose > 2)
299                 rprintf(FINFO,"got file_sum\n");
300         if (fd != -1 && memcmp(file_sum1, file_sum2, MD4_SUM_LENGTH) != 0)
301                 return 0;
302         return 1;
303 }
304
305
306 static void discard_receive_data(int f_in, OFF_T length)
307 {
308         receive_data(f_in, NULL, -1, 0, NULL, -1, length);
309 }
310
311
312 /**
313  * main routine for receiver process.
314  *
315  * Receiver process runs on the same host as the generator process. */
316 int recv_files(int f_in, struct file_list *flist, char *local_name)
317 {
318         int next_gen_i = -1;
319         int fd1,fd2;
320         STRUCT_STAT st;
321         int iflags, xlen;
322         char *fname, fbuf[MAXPATHLEN];
323         char xname[MAXPATHLEN];
324         char fnametmp[MAXPATHLEN];
325         char *fnamecmp, *partialptr, numbuf[4];
326         char fnamecmpbuf[MAXPATHLEN];
327         uchar fnamecmp_type;
328         struct file_struct *file;
329         struct stats initial_stats;
330         int save_make_backups = make_backups;
331         int itemizing = am_daemon ? daemon_log_format_has_i
332                       : !am_server && log_format_has_i;
333         int i, recv_ok, phase = 0;
334
335         if (verbose > 2)
336                 rprintf(FINFO,"recv_files(%d) starting\n",flist->count);
337
338         if (flist->hlink_pool) {
339                 pool_destroy(flist->hlink_pool);
340                 flist->hlink_pool = NULL;
341         }
342
343         if (delay_updates)
344                 init_delayed_bits(flist->count);
345
346         while (1) {
347                 cleanup_disable();
348
349                 i = read_int(f_in);
350                 if (i == -1) {
351                         if (read_batch) {
352                                 if (next_gen_i != flist->count)
353                                         while (read_int(batch_gen_fd) != -1) {}
354                                 next_gen_i = -1;
355                         }
356
357                         if (phase)
358                                 break;
359
360                         phase = 1;
361                         csum_length = SUM_LENGTH;
362                         if (verbose > 2)
363                                 rprintf(FINFO, "recv_files phase=%d\n", phase);
364                         send_msg(MSG_DONE, "", 0);
365                         if (keep_partial && !partial_dir)
366                                 make_backups = 0; /* prevents double backup */
367                         continue;
368                 }
369
370                 iflags = read_item_attrs(f_in, -1, i, &fnamecmp_type,
371                                          xname, &xlen);
372                 if (iflags == ITEM_IS_NEW) /* no-op packet */
373                         continue;
374
375                 file = flist->files[i];
376                 fname = local_name ? local_name : f_name_to(file, fbuf);
377
378                 if (verbose > 2)
379                         rprintf(FINFO, "recv_files(%s)\n", safe_fname(fname));
380
381                 if (!(iflags & ITEM_TRANSFER)) {
382                         maybe_log_item(file, iflags, itemizing, xname);
383                         continue;
384                 }
385
386                 stats.current_file_index = i;
387                 stats.num_transferred_files++;
388                 stats.total_transferred_size += file->length;
389                 cleanup_got_literal = 0;
390
391                 if (server_filter_list.head
392                     && check_filter(&server_filter_list, fname, 0) < 0) {
393                         rprintf(FERROR, "attempt to hack rsync failed.\n");
394                         exit_cleanup(RERR_PROTOCOL);
395                 }
396
397                 if (dry_run) { /* log the transfer */
398                         if (!am_server && log_format)
399                                 log_item(file, &stats, iflags, NULL);
400                         continue;
401                 }
402
403                 if (read_batch) {
404                         while (i > next_gen_i) {
405                                 next_gen_i = read_int(batch_gen_fd);
406                                 if (next_gen_i == -1)
407                                         next_gen_i = flist->count;
408                         }
409                         if (i < next_gen_i) {
410                                 rprintf(FINFO, "skipping update for \"%s\"\n",
411                                         safe_fname(fname));
412                                 discard_receive_data(f_in, file->length);
413                                 continue;
414                         }
415                         next_gen_i = -1;
416                 }
417
418                 partialptr = partial_dir ? partial_dir_fname(fname) : fname;
419
420                 if (protocol_version >= 29) {
421                         switch (fnamecmp_type) {
422                         case FNAMECMP_FNAME:
423                                 fnamecmp = fname;
424                                 break;
425                         case FNAMECMP_PARTIAL_DIR:
426                                 fnamecmp = partialptr;
427                                 break;
428                         case FNAMECMP_BACKUP:
429                                 fnamecmp = get_backup_name(fname);
430                                 break;
431                         case FNAMECMP_FUZZY:
432                                 if (file->dirname) {
433                                         pathjoin(fnamecmpbuf, MAXPATHLEN,
434                                                  file->dirname, xname);
435                                         fnamecmp = fnamecmpbuf;
436                                 } else
437                                         fnamecmp = xname;
438                                 break;
439                         default:
440                                 if (fnamecmp_type >= basis_dir_cnt) {
441                                         rprintf(FERROR,
442                                                 "invalid basis_dir index: %d.\n",
443                                                 fnamecmp_type);
444                                         exit_cleanup(RERR_PROTOCOL);
445                                 }
446                                 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
447                                          basis_dir[fnamecmp_type], fname);
448                                 fnamecmp = fnamecmpbuf;
449                                 break;
450                         }
451                         if (!fnamecmp || (server_filter_list.head
452                           && check_filter(&server_filter_list, fname, 0) < 0))
453                                 fnamecmp = fname;
454                 } else {
455                         /* Reminder: --inplace && --partial-dir are never
456                          * enabled at the same time. */
457                         if (inplace && make_backups) {
458                                 if (!(fnamecmp = get_backup_name(fname)))
459                                         fnamecmp = fname;
460                         } else if (partial_dir && partialptr)
461                                 fnamecmp = partialptr;
462                         else
463                                 fnamecmp = fname;
464                 }
465
466                 initial_stats = stats;
467
468                 /* open the file */
469                 fd1 = do_open(fnamecmp, O_RDONLY, 0);
470
471                 if (fd1 == -1 && protocol_version < 29) {
472                         if (fnamecmp != fname) {
473                                 fnamecmp = fname;
474                                 fd1 = do_open(fnamecmp, O_RDONLY, 0);
475                         }
476
477                         if (fd1 == -1 && basis_dir[0]) {
478                                 /* pre-29 allowed only one alternate basis */
479                                 pathjoin(fnamecmpbuf, sizeof fnamecmpbuf,
480                                          basis_dir[0], fname);
481                                 fnamecmp = fnamecmpbuf;
482                                 fd1 = do_open(fnamecmp, O_RDONLY, 0);
483                         }
484                 }
485
486                 if (fd1 != -1 && do_fstat(fd1,&st) != 0) {
487                         rsyserr(FERROR, errno, "fstat %s failed",
488                                 full_fname(fnamecmp));
489                         discard_receive_data(f_in, file->length);
490                         close(fd1);
491                         continue;
492                 }
493
494                 if (fd1 != -1 && S_ISDIR(st.st_mode) && fnamecmp == fname) {
495                         /* this special handling for directories
496                          * wouldn't be necessary if robust_rename()
497                          * and the underlying robust_unlink could cope
498                          * with directories
499                          */
500                         rprintf(FERROR,"recv_files: %s is a directory\n",
501                                 full_fname(fnamecmp));
502                         discard_receive_data(f_in, file->length);
503                         close(fd1);
504                         continue;
505                 }
506
507                 if (fd1 != -1 && !S_ISREG(st.st_mode)) {
508                         close(fd1);
509                         fd1 = -1;
510                 }
511
512                 if (fd1 != -1 && !preserve_perms) {
513                         /* if the file exists already and we aren't preserving
514                          * permissions then act as though the remote end sent
515                          * us the file permissions we already have */
516                         file->mode = st.st_mode;
517                 }
518
519                 /* We now check to see if we are writing file "inplace" */
520                 if (inplace)  {
521                         fd2 = do_open(fname, O_WRONLY|O_CREAT, 0);
522                         if (fd2 == -1) {
523                                 rsyserr(FERROR, errno, "open %s failed",
524                                         full_fname(fname));
525                                 discard_receive_data(f_in, file->length);
526                                 if (fd1 != -1)
527                                         close(fd1);
528                                 continue;
529                         }
530                 } else {
531                         if (!get_tmpname(fnametmp,fname)) {
532                                 discard_receive_data(f_in, file->length);
533                                 if (fd1 != -1)
534                                         close(fd1);
535                                 continue;
536                         }
537
538                         /* we initially set the perms without the
539                          * setuid/setgid bits to ensure that there is no race
540                          * condition. They are then correctly updated after
541                          * the lchown. Thanks to snabb@epipe.fi for pointing
542                          * this out.  We also set it initially without group
543                          * access because of a similar race condition. */
544                         fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
545
546                         /* in most cases parent directories will already exist
547                          * because their information should have been previously
548                          * transferred, but that may not be the case with -R */
549                         if (fd2 == -1 && relative_paths && errno == ENOENT
550                             && create_directory_path(fnametmp, orig_umask) == 0) {
551                                 /* Get back to name with XXXXXX in it. */
552                                 get_tmpname(fnametmp, fname);
553                                 fd2 = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
554                         }
555                         if (fd2 == -1) {
556                                 rsyserr(FERROR, errno, "mkstemp %s failed",
557                                         full_fname(fnametmp));
558                                 discard_receive_data(f_in, file->length);
559                                 if (fd1 != -1)
560                                         close(fd1);
561                                 continue;
562                         }
563
564                         if (partialptr)
565                                 cleanup_set(fnametmp, partialptr, file, fd1, fd2);
566                 }
567
568                 /* log the transfer */
569                 if (log_before_transfer)
570                         log_item(file, &initial_stats, iflags, NULL);
571                 else if (!am_server && verbose && do_progress)
572                         rprintf(FINFO, "%s\n", safe_fname(fname));
573
574                 /* recv file data */
575                 recv_ok = receive_data(f_in, fnamecmp, fd1, st.st_size,
576                                        fname, fd2, file->length);
577
578                 if (!log_before_transfer)
579                         log_item(file, &initial_stats, iflags, NULL);
580
581                 if (fd1 != -1)
582                         close(fd1);
583                 if (close(fd2) < 0) {
584                         rsyserr(FERROR, errno, "close failed on %s",
585                                 full_fname(fnametmp));
586                         exit_cleanup(RERR_FILEIO);
587                 }
588
589                 if ((recv_ok && (!delay_updates || !partialptr)) || inplace) {
590                         finish_transfer(fname, fnametmp, file, recv_ok, 1);
591                         if (partialptr != fname && fnamecmp == partialptr) {
592                                 do_unlink(partialptr);
593                                 handle_partial_dir(partialptr, PDIR_DELETE);
594                         }
595                 } else if (keep_partial && partialptr
596                     && handle_partial_dir(partialptr, PDIR_CREATE)) {
597                         finish_transfer(partialptr, fnametmp, file, recv_ok,
598                                         !partial_dir);
599                         if (delay_updates && recv_ok) {
600                                 set_delayed_bit(i);
601                                 recv_ok = -1;
602                         }
603                 } else {
604                         partialptr = NULL;
605                         do_unlink(fnametmp);
606                 }
607
608                 cleanup_disable();
609
610                 if (recv_ok > 0) {
611                         if (remove_sent_files
612                             || (preserve_hard_links && file->link_u.links)) {
613                                 SIVAL(numbuf, 0, i);
614                                 send_msg(MSG_SUCCESS, numbuf, 4);
615                         }
616                 } else if (!recv_ok) {
617                         int msgtype = phase || read_batch ? FERROR : FINFO;
618                         if (msgtype == FERROR || verbose) {
619                                 char *errstr, *redostr, *keptstr;
620                                 if (!(keep_partial && partialptr) && !inplace)
621                                         keptstr = "discarded";
622                                 else if (partial_dir)
623                                         keptstr = "put into partial-dir";
624                                 else
625                                         keptstr = "retained";
626                                 if (msgtype == FERROR) {
627                                         errstr = "ERROR";
628                                         redostr = "";
629                                 } else {
630                                         errstr = "WARNING";
631                                         redostr = " (will try again)";
632                                 }
633                                 rprintf(msgtype,
634                                         "%s: %s failed verification -- update %s%s.\n",
635                                         errstr, safe_fname(fname),
636                                         keptstr, redostr);
637                         }
638                         if (!phase) {
639                                 SIVAL(numbuf, 0, i);
640                                 send_msg(MSG_REDO, numbuf, 4);
641                         }
642                 }
643         }
644         make_backups = save_make_backups;
645
646         if (delay_updates) {
647                 for (i = -1; (i = next_delayed_bit(i)) >= 0; ) {
648                         struct file_struct *file = flist->files[i];
649                         fname = local_name ? local_name : f_name(file);
650                         partialptr = partial_dir_fname(fname);
651                         if (partialptr) {
652                                 if (make_backups && !make_backup(fname))
653                                         continue;
654                                 if (verbose > 2) {
655                                         rprintf(FINFO, "renaming %s to %s\n",
656                                                 safe_fname(partialptr),
657                                                 safe_fname(fname));
658                                 }
659                                 if (do_rename(partialptr, fname) < 0) {
660                                         rsyserr(FERROR, errno,
661                                                 "rename failed for %s (from %s)",
662                                                 full_fname(fname),
663                                                 safe_fname(partialptr));
664                                 } else {
665                                         if (remove_sent_files
666                                             || (preserve_hard_links
667                                              && file->link_u.links)) {
668                                                 SIVAL(numbuf, 0, i);
669                                                 send_msg(MSG_SUCCESS,numbuf,4);
670                                         }
671                                         handle_partial_dir(partialptr,
672                                                            PDIR_DELETE);
673                                 }
674                         }
675                 }
676         }
677
678         if (verbose > 2)
679                 rprintf(FINFO,"recv_files finished\n");
680
681         return 0;
682 }