Moved the call to do_hard_links() and the final directory-permissions
[rsync/rsync.git] / rsync.h
1 /* 
2    Copyright (C) by Andrew Tridgell 1996, 2000
3    Copyright (C) Paul Mackerras 1996
4    Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
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
22 #define False 0
23 #define True 1
24
25 #define BLOCK_SIZE 700
26 #define RSYNC_RSH_ENV "RSYNC_RSH"
27 #define RSYNC_RSH_IO_ENV "RSYNC_RSH_IO"
28
29 #define RSYNC_NAME "rsync"
30 #define RSYNCD_SYSCONF "/etc/rsyncd.conf"
31 #define RSYNCD_USERCONF "rsyncd.conf"
32
33 #define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
34 #define URL_PREFIX "rsync://"
35
36 #define BACKUP_SUFFIX "~"
37
38 /* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
39    incompatible with older versions :-( */
40 #define CHAR_OFFSET 0
41
42 /* These flags are used during the flist transfer. */
43
44 #define FLAG_DELETE (1<<0)
45 #define SAME_MODE (1<<1)
46 #define EXTENDED_FLAGS (1<<2)
47 #define SAME_RDEV_pre28 EXTENDED_FLAGS /* Only use in protocols < 28 */
48 #define SAME_UID (1<<3)
49 #define SAME_GID (1<<4)
50 #define SAME_DIR (1<<5)
51 #define SAME_NAME SAME_DIR
52 #define LONG_NAME (1<<6)
53 #define SAME_TIME (1<<7)
54 #define SAME_HIGH_RDEV (1<<8)
55 #define HAS_INODE_DATA (1<<9)
56 #define SAME_DEV (1<<10)
57
58 /* What flags above are relevant after the transfer of the flist? */
59 #define LIVE_FLAGS FLAG_DELETE
60
61 /* update this if you make incompatible changes */
62 #define PROTOCOL_VERSION 28
63
64 /* We refuse to interoperate with versions that are not in this range.
65  * Note that we assume we'll work with later versions: the onus is on
66  * people writing them to make sure that they don't send us anything
67  * we won't understand.
68  *
69  * Interoperation with old but supported protocol versions
70  * should cause a warning to be printed.  At a future date
71  * the old protocol will become the minimum and
72  * compatibility code removed.
73  *
74  * There are two possible explanations for the limit at
75  * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
76  * do not interoperate with us, and (more likely) so that we can
77  * detect an attempt to connect rsync to a non-rsync server, which is
78  * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
79  * MAX_PROTOCOL_VERSION. */
80
81 #define MIN_PROTOCOL_VERSION 19
82 #define OLD_PROTOCOL_VERSION 20
83 #define MAX_PROTOCOL_VERSION 40
84
85 #define RSYNC_PORT 873
86
87 #define SPARSE_WRITE_SIZE (1024)
88 #define WRITE_SIZE (32*1024)
89 #define CHUNK_SIZE (32*1024)
90 #define MAX_MAP_SIZE (256*1024)
91 #define IO_BUFFER_SIZE (4092)
92
93 #define IOERR_GENERAL   (1<<0) /* For backward compatibility, this must == 1 */
94 #define IOERR_VANISHED  (1<<1)
95
96 #define MAX_ARGS 1000
97
98 #define MPLEX_BASE 7
99
100 #define NO_EXCLUDES     0
101 #define SERVER_EXCLUDES 1
102 #define ALL_EXCLUDES    2
103
104 #define MISSING_OK    0
105 #define MISSING_FATAL 1
106
107 #define ADD_INCLUDE 1
108 #define ADD_EXCLUDE 0
109
110 #define FULL_FLUSH      1
111 #define NORMAL_FLUSH    0
112
113 /* Log-message categories.  FLOG is only used on the daemon side to
114  * output messages to the log file. */
115 enum logcode { FERROR=1, FINFO=2, FLOG=3 };
116
117 /* Messages types that are sent over the message channel.  The logcode
118  * values must all be present here with identical numbers. */
119 enum msgcode {
120         MSG_DATA=0,     /* raw data on the multiplexed stream */
121         MSG_ERROR=FERROR, MSG_INFO=FINFO, MSG_LOG=FLOG, /* remote logging */
122         MSG_REDO=4,     /* reprocess indicated flist index */
123         MSG_DONE=5,     /* current phase is done */
124 };
125
126 #include "errcode.h"
127
128 #include "config.h"
129
130 /* The default RSYNC_RSH is always set in config.h. */
131
132 #include <sys/types.h>
133
134 #ifdef HAVE_UNISTD_H
135 #include <unistd.h>
136 #endif
137 #include <stdio.h>
138 #include <stddef.h>
139
140 #ifdef HAVE_SYS_PARAM_H
141 #include <sys/param.h>
142 #endif
143
144 #ifdef HAVE_STDLIB_H
145 #include <stdlib.h>
146 #endif
147
148 #if defined(HAVE_MALLOC_H) && (defined(HAVE_MALLINFO) || !defined(HAVE_STDLIB_H))
149 #include <malloc.h>
150 #endif
151
152 #ifdef HAVE_SYS_SOCKET_H
153 #include <sys/socket.h>
154 #endif
155
156 #ifdef HAVE_STRING_H
157 #include <string.h>
158 #endif
159
160 #ifdef TIME_WITH_SYS_TIME
161 #include <sys/time.h>
162 #include <time.h>
163 #else
164 #ifdef HAVE_SYS_TIME_H
165 #include <sys/time.h>
166 #else
167 #include <time.h>
168 #endif
169 #endif
170
171 #ifdef HAVE_FCNTL_H
172 #include <fcntl.h>
173 #else
174 #ifdef HAVE_SYS_FCNTL_H
175 #include <sys/fcntl.h>
176 #endif
177 #endif
178
179 #include <sys/stat.h>
180
181 #ifdef HAVE_SYS_IOCTL_H
182 #include <sys/ioctl.h>
183 #endif
184
185 #ifdef HAVE_SYS_FILIO_H
186 #include <sys/filio.h>
187 #endif
188
189 #include <signal.h>
190 #ifdef HAVE_SYS_WAIT_H
191 #include <sys/wait.h>
192 #endif
193 #ifdef HAVE_CTYPE_H
194 #include <ctype.h>
195 #endif
196 #ifdef HAVE_GRP_H
197 #include <grp.h>
198 #endif
199 #include <errno.h>
200
201 #ifdef HAVE_UTIME_H
202 #include <utime.h>
203 #endif
204
205 #ifdef HAVE_SYS_SELECT_H
206 #include <sys/select.h>
207 #endif
208
209 #ifdef HAVE_SYS_MODE_H
210 /* apparently AIX needs this for S_ISLNK */
211 #ifndef S_ISLNK
212 #include <sys/mode.h>
213 #endif
214 #endif
215
216 #ifdef HAVE_GLOB_H
217 #include <glob.h>
218 #endif
219
220 /* these are needed for the uid/gid mapping code */
221 #include <pwd.h>
222 #include <grp.h>
223
224 #include <stdarg.h>
225 #include <netinet/in.h>
226 #include <arpa/inet.h>
227 #include <netdb.h>
228 #include <syslog.h>
229 #include <sys/file.h>
230
231 #if HAVE_DIRENT_H
232 # include <dirent.h>
233 #else
234 # define dirent direct
235 # if HAVE_SYS_NDIR_H
236 #  include <sys/ndir.h>
237 # endif
238 # if HAVE_SYS_DIR_H
239 #  include <sys/dir.h>
240 # endif
241 # if HAVE_NDIR_H
242 #  include <ndir.h>
243 # endif
244 #endif
245
246 #ifdef HAVE_COMPAT_H
247 #include <compat.h>
248 #endif
249
250 #include <assert.h>
251
252
253 #define BOOL int
254
255 #ifndef uchar
256 #define uchar unsigned char
257 #endif
258
259 #if HAVE_UNSIGNED_CHAR
260 #define schar signed char
261 #else
262 #define schar char
263 #endif
264
265 #ifndef int32
266 #if (SIZEOF_INT == 4)
267 #define int32 int
268 #elif (SIZEOF_LONG == 4)
269 #define int32 long
270 #elif (SIZEOF_SHORT == 4)
271 #define int32 short
272 #else
273 /* I hope this works */
274 #define int32 int
275 #define LARGE_INT32
276 #endif
277 #endif
278
279 #ifndef uint32
280 #define uint32 unsigned int32
281 #endif
282
283 #if HAVE_OFF64_T
284 #define OFF_T off64_t
285 #define STRUCT_STAT struct stat64
286 #else
287 #define OFF_T off_t
288 #define STRUCT_STAT struct stat
289 #endif
290
291 #if HAVE_OFF64_T
292 #define int64 off64_t
293 #elif (SIZEOF_LONG == 8) 
294 #define int64 long
295 #elif (SIZEOF_INT == 8) 
296 #define int64 int
297 #elif HAVE_LONGLONG
298 #define int64 long long
299 #else
300 /* As long as it gets... */
301 #define int64 off_t
302 #define NO_INT64
303 #endif
304
305 #if (SIZEOF_LONG == 8) 
306 #define uint64 unsigned long
307 #elif (SIZEOF_INT == 8) 
308 #define uint64 unsigned int
309 #elif HAVE_LONGLONG
310 #define uint64 unsigned long long
311 #else
312 /* As long as it gets... */
313 #define uint64 unsigned off_t
314 #endif
315
316 /* Starting from protocol version 26, we always use 64-bit
317  * ino_t and dev_t internally, even if this platform does not
318  * allow files to have 64-bit inums.  That's because the
319  * receiver needs to find duplicate (dev,ino) tuples to detect
320  * hardlinks, and it might have files coming from a platform
321  * that has 64-bit inums.
322  *
323  * The only exception is if we're on a platform with no 64-bit type at
324  * all.
325  *
326  * Because we use read_longint() to get these off the wire, if you
327  * transfer devices or hardlinks with dev or inum > 2**32 to a machine
328  * with no 64-bit types then you will get an overflow error.  Probably
329  * not many people have that combination of machines, and you can
330  * avoid it by not preserving hardlinks or not transferring device
331  * nodes.  It's not clear that any other behaviour is better.
332  *
333  * Note that if you transfer devices from a 64-bit-devt machine (say,
334  * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the
335  * device numbers will be truncated.  But it's a kind of silly thing
336  * to do anyhow.
337  *
338  * FIXME: In future, we should probable split the device number into
339  * major/minor, and transfer the two parts as 32-bit ints.  That gives
340  * you somewhat more of a chance that they'll come from a big machine
341  * to a little one in a useful way.
342  *
343  * FIXME: Really we need an unsigned type, and we perhaps ought to
344  * cope with platforms on which this is an unsigned int or even a
345  * struct.  Later.
346  */ 
347 #define INO64_T uint64
348 #define DEV64_T uint64
349
350 #ifndef MIN
351 #define MIN(a,b) ((a)<(b)?(a):(b))
352 #endif
353
354 #ifndef MAX
355 #define MAX(a,b) ((a)>(b)?(a):(b))
356 #endif
357
358 #ifndef MAXHOSTNAMELEN
359 #define MAXHOSTNAMELEN 256
360 #endif
361
362 /* the length of the md4 checksum */
363 #define MD4_SUM_LENGTH 16
364 #define SUM_LENGTH 16
365 #define SHORT_SUM_LENGTH 2
366 #define BLOCKSUM_BIAS 10
367
368 #ifndef MAXPATHLEN
369 #define MAXPATHLEN 1024
370 #endif
371
372 #ifndef NAME_MAX
373 #define NAME_MAX 255
374 #endif
375
376 #ifndef INADDR_NONE
377 #define INADDR_NONE 0xffffffff
378 #endif
379
380 #ifndef IN_LOOPBACKNET
381 #define IN_LOOPBACKNET 127
382 #endif
383
384 #define GID_NONE (gid_t) -1
385
386 struct hlink {
387         struct file_struct *head;
388         struct file_struct *next;
389 };
390
391 struct idev {
392         INO64_T inode;
393         DEV64_T dev;
394 };
395
396 #define F_DEV   link_u.idev->dev
397 #define F_INODE link_u.idev->inode
398
399 #define F_HEAD  link_u.links->head
400 #define F_NEXT  link_u.links->next
401
402 struct file_struct {
403         time_t modtime;
404         OFF_T length;
405         mode_t mode;
406         union {
407                 DEV64_T rdev;   /* The device number, if this is a device */
408                 char *sum;      /* Only a normal file can have a checksum */
409                 char *link;     /* Holds symlink string, if a symlink */
410         } u;
411         union {
412                 struct idev *idev;
413                 struct hlink *links;
414         } link_u;
415         char *basename;
416         char *dirname;
417         char *basedir;
418         uid_t uid;
419         gid_t gid;
420         unsigned short flags;
421 };
422
423 #define ARENA_SIZE      (32 * 1024)
424
425 struct string_area {
426         char *base;
427         char *end;
428         char *current;
429         struct string_area *next;
430 };
431
432 struct file_list {
433         int count;
434         int malloced;
435         struct file_struct **files;
436         struct string_area *string_area;
437 };
438
439 struct sum_buf {
440         OFF_T offset;           /**< offset in file of this chunk */
441         unsigned int len;       /**< length of chunk of file */
442         int i;                  /**< index of this chunk */
443         uint32 sum1;            /**< simple checksum */
444         char sum2[SUM_LENGTH];  /**< checksum  */
445 };
446
447 struct sum_struct {
448         OFF_T flength;          /**< total file length */
449         size_t count;           /**< how many chunks */
450         unsigned int blength;   /**< block_length */
451         unsigned int remainder; /**< flength % block_length */
452         int s2length;           /**< sum2_length */
453         struct sum_buf *sums;   /**< points to info for each chunk */
454 };
455
456 struct map_struct {
457         char *p;                /* Window pointer                       */
458         int fd;                 /* File Descriptor                      */
459         int p_size;             /* Window size at allocation            */
460         int p_len;              /* Window size after fill               */
461                                 /*    p_size and p_len could be
462                                  *    consolodated by using a local
463                                  *    variable in map_ptr()             */
464         int status;             /* first errno from read errors         */
465         OFF_T file_size;        /* File size (from stat)                */
466         OFF_T p_offset;         /* Window start                         */
467         OFF_T p_fd_offset;      /* offset of cursor in fd ala lseek     */
468 };
469
470 #define MATCHFLG_WILD           (1<<0) /* pattern has '*', '[', and/or '?' */
471 #define MATCHFLG_WILD2          (1<<1) /* pattern has '**' */
472 #define MATCHFLG_WILD2_PREFIX   (1<<2) /* pattern starts with '**' */
473 #define MATCHFLG_ABS_PATH       (1<<3) /* path-match on absolute path */
474 struct exclude_struct {
475         char *pattern;
476         int match_flags;
477         int include;
478         int directory;
479         int slash_cnt;
480 };
481
482 struct stats {
483         int64 total_size;
484         int64 total_transferred_size;
485         int64 total_written;
486         int64 total_read;
487         int64 literal_data;
488         int64 matched_data;
489         int flist_size;
490         int num_files;
491         int num_transferred_files;
492         int current_file_index;
493 };
494
495
496 /* we need this function because of the silly way in which duplicate
497    entries are handled in the file lists - we can't change this
498    without breaking existing versions */
499 static inline int flist_up(struct file_list *flist, int i)
500 {
501         while (!flist->files[i]->basename) i++;
502         return i;
503 }
504
505 #include "byteorder.h"
506 #include "lib/mdfour.h"
507 #include "lib/wildmatch.h"
508 #include "lib/permstring.h"
509 #include "lib/addrinfo.h"
510
511 #include "proto.h"
512
513 /* We have replacement versions of these if they're missing. */
514 #ifndef HAVE_ASPRINTF
515 int asprintf(char **ptr, const char *format, ...);
516 #endif
517
518 #ifndef HAVE_VASPRINTF
519 int vasprintf(char **ptr, const char *format, va_list ap);
520 #endif
521
522 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
523 #define vsnprintf rsync_vsnprintf
524 int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
525 #endif
526
527 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
528 #define snprintf rsync_snprintf
529 int snprintf(char *str,size_t count,const char *fmt,...);
530 #endif
531
532
533 #if !HAVE_STRERROR
534 extern char *sys_errlist[];
535 #define strerror(i) sys_errlist[i]
536 #endif
537
538 #ifndef HAVE_STRCHR
539 # define strchr                 index
540 # define strrchr                rindex
541 #endif
542
543 #ifndef HAVE_ERRNO_DECL
544 extern int errno;
545 #endif
546
547 #define SUPPORT_LINKS HAVE_READLINK
548 #define SUPPORT_HARD_LINKS HAVE_LINK
549
550 /* This could be bad on systems which have no lchown and where chown
551  * follows symbollic links.  On such systems it might be better not to
552  * try to chown symlinks at all. */
553 #ifndef HAVE_LCHOWN
554 #define lchown chown
555 #endif
556
557 #define SIGNAL_CAST (RETSIGTYPE (*)())
558
559 #ifndef EWOULDBLOCK
560 #define EWOULDBLOCK EAGAIN
561 #endif
562
563 #ifndef STDIN_FILENO
564 #define STDIN_FILENO 0
565 #endif
566
567 #ifndef STDOUT_FILENO
568 #define STDOUT_FILENO 1
569 #endif
570
571 #ifndef STDERR_FILENO
572 #define STDERR_FILENO 2
573 #endif
574
575 #ifndef S_IWUSR
576 #define S_IWUSR 0200
577 #endif
578
579 #ifndef ACCESSPERMS
580 #define ACCESSPERMS 0777
581 #endif
582
583 #ifndef S_ISVTX
584 #define S_ISVTX 0
585 #endif
586
587 #define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
588
589 #ifndef _S_IFMT
590 #define _S_IFMT        0170000
591 #endif
592
593 #ifndef _S_IFLNK
594 #define _S_IFLNK  0120000
595 #endif
596
597 #ifndef S_ISLNK
598 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
599 #endif
600
601 #ifndef S_ISBLK
602 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
603 #endif
604
605 #ifndef S_ISCHR
606 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
607 #endif
608
609 #ifndef S_ISSOCK
610 #ifdef _S_IFSOCK
611 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
612 #else
613 #define S_ISSOCK(mode) (0)
614 #endif
615 #endif
616
617 #ifndef S_ISFIFO
618 #ifdef _S_IFIFO
619 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
620 #else
621 #define S_ISFIFO(mode) (0)
622 #endif
623 #endif
624
625 #ifndef S_ISDIR
626 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
627 #endif
628
629 #ifndef S_ISREG
630 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
631 #endif
632
633 /* work out what fcntl flag to use for non-blocking */
634 #ifdef O_NONBLOCK
635 # define NONBLOCK_FLAG O_NONBLOCK
636 #elif defined(SYSV)
637 # define NONBLOCK_FLAG O_NDELAY
638 #else 
639 # define NONBLOCK_FLAG FNDELAY
640 #endif
641
642 #ifndef INADDR_LOOPBACK
643 #define INADDR_LOOPBACK 0x7f000001
644 #endif
645
646 #ifndef INADDR_NONE
647 #define INADDR_NONE 0xffffffff
648 #endif
649
650 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
651
652 /* Initial mask on permissions given to temporary files.  Mask off setuid
653      bits and group access because of potential race-condition security
654      holes, and mask other access because mode 707 is bizarre */
655 #define INITACCESSPERMS 0700
656
657 /* handler for null strings in printf format */
658 #define NS(s) ((s)?(s):"<NULL>")
659
660 #if !defined(__GNUC__) || defined(APPLE)
661 /* Apparently the OS X port of gcc gags on __attribute__.
662  *
663  * <http://www.opensource.apple.com/bugs/X/gcc/2512150.html> */
664 #define __attribute__(x) 
665
666 #endif
667
668 /* Convenient wrappers for malloc and realloc.  Use them. */
669 #define new(type) ((type *)malloc(sizeof(type)))
670 #define new_array(type, num) ((type *)_new_array(sizeof(type), (num)))
671 #define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num)))
672
673 /* use magic gcc attributes to catch format errors */
674  void rprintf(enum logcode , const char *, ...)
675      __attribute__((format (printf, 2, 3)))
676 ;
677
678 /* This is just like rprintf, but it also tries to print some
679  * representation of the error code.  Normally errcode = errno. */
680 void rsyserr(enum logcode, int, const char *, ...)
681      __attribute__((format (printf, 3, 4)))
682      ;
683
684 #ifdef REPLACE_INET_NTOA
685 #define inet_ntoa rep_inet_ntoa
686 #endif
687
688 /* Make sure that the O_BINARY flag is defined. */
689 #ifndef O_BINARY
690 #define O_BINARY 0
691 #endif
692
693 #ifndef HAVE_STRLCPY
694 size_t strlcpy(char *d, const char *s, size_t bufsize);
695 #endif
696
697 #ifndef HAVE_STRLCAT
698 size_t strlcat(char *d, const char *s, size_t bufsize);
699 #endif
700
701 #ifndef WEXITSTATUS
702 #define WEXITSTATUS(stat)       ((int)(((stat)>>8)&0xFF))
703 #endif
704
705 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
706
707
708 extern int verbose;
709
710 #ifndef HAVE_INET_NTOP
711 const char *                 
712 inet_ntop(int af, const void *src, char *dst, size_t size);
713 #endif /* !HAVE_INET_NTOP */
714
715 #ifndef HAVE_INET_PTON
716 int inet_pton(int af, const char *src, void *dst);
717 #endif
718
719 #ifdef MAINTAINER_MODE
720 const char *get_panic_action(void);
721 #endif
722
723 #define UNUSED(x) x __attribute__((__unused__))
724
725 extern const char *io_write_phase, *io_read_phase;