Report all socket connection errors if we fail.
[rsync.git] / rsync.h
1 /*
2  * Copyright (C) 1996, 2000 Andrew Tridgell
3  * Copyright (C) 1996 Paul Mackerras
4  * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
5  * Copyright (C) 2003-2008 Wayne Davison
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, visit the http://fsf.org website.
19  */
20
21 #define False 0
22 #define True 1
23
24 #define BLOCK_SIZE 700
25 #define RSYNC_RSH_ENV "RSYNC_RSH"
26 #define RSYNC_RSH_IO_ENV "RSYNC_RSH_IO"
27
28 #define RSYNC_NAME "rsync"
29 /* RSYNCD_SYSCONF is now set in config.h */
30 #define RSYNCD_USERCONF "rsyncd.conf"
31
32 #define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
33 #define URL_PREFIX "rsync://"
34
35 #define SYMLINK_PREFIX "/rsyncd-munged/"  /* This MUST have a trailing slash! */
36 #define SYMLINK_PREFIX_LEN ((int)sizeof SYMLINK_PREFIX - 1)
37
38 #define BACKUP_SUFFIX "~"
39
40 /* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
41    incompatible with older versions :-( */
42 #define CHAR_OFFSET 0
43
44 /* These flags are only used during the flist transfer. */
45
46 #define XMIT_TOP_DIR (1<<0)
47 #define XMIT_SAME_MODE (1<<1)
48 #define XMIT_SAME_RDEV_pre28 (1<<2)     /* protocols 20 - 27  */
49 #define XMIT_EXTENDED_FLAGS (1<<2)      /* protocols 28 - now */
50 #define XMIT_SAME_UID (1<<3)
51 #define XMIT_SAME_GID (1<<4)
52 #define XMIT_SAME_NAME (1<<5)
53 #define XMIT_LONG_NAME (1<<6)
54 #define XMIT_SAME_TIME (1<<7)
55 #define XMIT_SAME_RDEV_MAJOR (1<<8)     /* protocols 28 - now (devices only) */
56 #define XMIT_NO_CONTENT_DIR (1<<8)      /* protocols 30 - now (dirs only) */
57 #define XMIT_HLINKED (1<<9)             /* protocols 28 - now */
58 #define XMIT_SAME_DEV_pre30 (1<<10)     /* protocols 28 - 29  */
59 #define XMIT_USER_NAME_FOLLOWS (1<<10)  /* protocols 30 - now */
60 #define XMIT_RDEV_MINOR_8_pre30 (1<<11) /* protocols 28 - 29  */
61 #define XMIT_GROUP_NAME_FOLLOWS (1<<11) /* protocols 30 - now */
62 #define XMIT_HLINK_FIRST (1<<12)        /* protocols 30 - now (HLINKED files only) */
63 #define XMIT_IO_ERROR_ENDLIST (1<<12)   /* protocols 31*- now (w/XMIT_EXTENDED_FLAGS) (also protocol 30 w/'f' compat flag) */
64
65 /* These flags are used in the live flist data. */
66
67 #define FLAG_TOP_DIR (1<<0)     /* sender/receiver/generator */
68 #define FLAG_FILE_SENT (1<<1)   /* sender/receiver/generator */
69 #define FLAG_DIR_CREATED (1<<1) /* generator */
70 #define FLAG_CONTENT_DIR (1<<2) /* sender/receiver/generator */
71 #define FLAG_MOUNT_DIR (1<<3)   /* sender/generator (dirs only) */
72 #define FLAG_SKIP_HLINK (1<<3)  /* receiver/generator (w/FLAG_HLINKED) */
73 #define FLAG_DUPLICATE (1<<4)   /* sender */
74 #define FLAG_MISSING_DIR (1<<4) /* generator */
75 #define FLAG_HLINKED (1<<5)     /* receiver/generator (checked on all types) */
76 #define FLAG_HLINK_FIRST (1<<6) /* receiver/generator (w/FLAG_HLINKED) */
77 #define FLAG_IMPLIED_DIR (1<<6) /* sender/receiver/generator (dirs only) */
78 #define FLAG_HLINK_LAST (1<<7)  /* receiver/generator */
79 #define FLAG_HLINK_DONE (1<<8)  /* receiver/generator (checked on all types) */
80 #define FLAG_LENGTH64 (1<<9)    /* sender/receiver/generator */
81 #define FLAG_SKIP_GROUP (1<<10) /* receiver/generator */
82 #define FLAG_TIME_FAILED (1<<11)/* generator */
83
84 /* These flags are passed to functions but not stored. */
85
86 #define FLAG_DIVERT_DIRS (1<<16)/* sender */
87
88 #define BITS_SET(val,bits) (((val) & (bits)) == (bits))
89 #define BITS_SETnUNSET(val,onbits,offbits) (((val) & ((onbits)|(offbits))) == (onbits))
90 #define BITS_EQUAL(b1,b2,mask) (((unsigned)(b1) & (unsigned)(mask)) \
91                              == ((unsigned)(b2) & (unsigned)(mask)))
92
93 /* update this if you make incompatible changes */
94 #define PROTOCOL_VERSION 30
95
96 /* This is used when working on a new protocol version in CVS, and should
97  * be a new non-zero value for each CVS change that affects the protocol.
98  * It must ALWAYS be 0 when the protocol goes final! */
99 #define SUBPROTOCOL_VERSION 0
100
101 /* We refuse to interoperate with versions that are not in this range.
102  * Note that we assume we'll work with later versions: the onus is on
103  * people writing them to make sure that they don't send us anything
104  * we won't understand.
105  *
106  * Interoperation with old but supported protocol versions
107  * should cause a warning to be printed.  At a future date
108  * the old protocol will become the minimum and
109  * compatibility code removed.
110  *
111  * There are two possible explanations for the limit at
112  * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
113  * do not interoperate with us, and (more likely) so that we can
114  * detect an attempt to connect rsync to a non-rsync server, which is
115  * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
116  * MAX_PROTOCOL_VERSION. */
117
118 #define MIN_PROTOCOL_VERSION 20
119 #define OLD_PROTOCOL_VERSION 25
120 #define MAX_PROTOCOL_VERSION 40
121
122 #define FILECNT_LOOKAHEAD 1000
123
124 #define RSYNC_PORT 873
125
126 #define SPARSE_WRITE_SIZE (1024)
127 #define WRITE_SIZE (32*1024)
128 #define CHUNK_SIZE (32*1024)
129 #define MAX_MAP_SIZE (256*1024)
130 #define IO_BUFFER_SIZE (4092)
131 #define MAX_BLOCK_SIZE ((int32)1 << 17)
132
133 /* For compatibility with older rsyncs */
134 #define OLD_MAX_BLOCK_SIZE ((int32)1 << 29)
135
136 #define IOERR_GENERAL   (1<<0) /* For backward compatibility, this must == 1 */
137 #define IOERR_VANISHED  (1<<1)
138 #define IOERR_DEL_LIMIT (1<<2)
139
140 #define MAX_ARGS 1000
141 #define MAX_BASIS_DIRS 20
142 #define MAX_SERVER_ARGS (MAX_BASIS_DIRS*2 + 100)
143
144 #define MPLEX_BASE 7
145
146 #define NO_FILTERS      0
147 #define SERVER_FILTERS  1
148 #define ALL_FILTERS     2
149
150 #define XFLG_FATAL_ERRORS       (1<<0)
151 #define XFLG_OLD_PREFIXES       (1<<1)
152 #define XFLG_ANCHORED2ABS       (1<<2) /* leading slash indicates absolute */
153 #define XFLG_ABS_IF_SLASH       (1<<3) /* leading or interior slash is absolute */
154 #define XFLG_DIR2WILD3          (1<<4) /* dir/ match gets trailing *** added */
155
156 #define ATTRS_REPORT            (1<<0)
157 #define ATTRS_SKIP_MTIME        (1<<1)
158
159 #define FULL_FLUSH      1
160 #define NORMAL_FLUSH    0
161
162 #define PDIR_CREATE     1
163 #define PDIR_DELETE     0
164
165 /* Note: 0x00 - 0x7F are used for basis_dir[] indexes! */
166 #define FNAMECMP_BASIS_DIR_LOW  0x00 /* Must remain 0! */
167 #define FNAMECMP_BASIS_DIR_HIGH 0x7F
168 #define FNAMECMP_FNAME          0x80
169 #define FNAMECMP_PARTIAL_DIR    0x81
170 #define FNAMECMP_BACKUP         0x82
171 #define FNAMECMP_FUZZY          0x83
172
173 /* For use by the itemize_changes code */
174 #define ITEM_REPORT_ATIME (1<<0)
175 #define ITEM_REPORT_CHANGE (1<<1)
176 #define ITEM_REPORT_SIZE (1<<2)     /* regular files only */
177 #define ITEM_REPORT_TIMEFAIL (1<<2) /* symlinks only */
178 #define ITEM_REPORT_TIME (1<<3)
179 #define ITEM_REPORT_PERMS (1<<4)
180 #define ITEM_REPORT_OWNER (1<<5)
181 #define ITEM_REPORT_GROUP (1<<6)
182 #define ITEM_REPORT_ACL (1<<7)
183 #define ITEM_REPORT_XATTR (1<<8)
184 #define ITEM_BASIS_TYPE_FOLLOWS (1<<11)
185 #define ITEM_XNAME_FOLLOWS (1<<12)
186 #define ITEM_IS_NEW (1<<13)
187 #define ITEM_LOCAL_CHANGE (1<<14)
188 #define ITEM_TRANSFER (1<<15)
189 /* These are outside the range of the transmitted flags. */
190 #define ITEM_MISSING_DATA (1<<16)          /* used by log_formatted() */
191 #define ITEM_DELETED (1<<17)               /* used by log_formatted() */
192 #define ITEM_MATCHED (1<<18)               /* used by itemize() */
193
194 #define SIGNIFICANT_ITEM_FLAGS (~(\
195         ITEM_BASIS_TYPE_FOLLOWS | ITEM_XNAME_FOLLOWS | ITEM_LOCAL_CHANGE))
196
197 #define CFN_KEEP_DOT_DIRS (1<<0)
198 #define CFN_KEEP_TRAILING_SLASH (1<<1)
199 #define CFN_DROP_TRAILING_DOT_DIR (1<<2)
200 #define CFN_COLLAPSE_DOT_DOT_DIRS (1<<3)
201
202 #define SP_DEFAULT 0
203 #define SP_KEEP_DOT_DIRS (1<<0)
204
205 #define CD_NORMAL 0
206 #define CD_SKIP_CHDIR 1
207
208 /* Log-message categories.  FLOG only goes to the log file, not the client;
209  * FCLIENT is the opposite. */
210 enum logcode {
211     FNONE=0, /* never sent */
212     FERROR_XFER=1, FINFO=2, /* sent over socket for any protocol */
213     FERROR=3, FWARNING=4, /* sent over socket for protocols >= 30 */
214     FERROR_SOCKET=5, FLOG=6, /* only sent via receiver -> generator pipe */
215     FERROR_UTF8=8, /* only sent via receiver -> generator pipe */
216     FCLIENT=7 /* never transmitted (e.g. server converts to FINFO) */
217 };
218
219 /* Messages types that are sent over the message channel.  The logcode
220  * values must all be present here with identical numbers. */
221 enum msgcode {
222         MSG_DATA=0,     /* raw data on the multiplexed stream */
223         MSG_ERROR_XFER=FERROR_XFER, MSG_INFO=FINFO, /* remote logging */
224         MSG_ERROR=FERROR, MSG_WARNING=FWARNING, /* protocol-30 remote logging */
225         MSG_ERROR_SOCKET=FERROR_SOCKET, /* sibling logging */
226         MSG_ERROR_UTF8=FERROR_UTF8, /* sibling logging */
227         MSG_LOG=FLOG, MSG_CLIENT=FCLIENT, /* sibling logging */
228         MSG_REDO=9,     /* reprocess indicated flist index */
229         MSG_FLIST=20,   /* extra file list over sibling socket */
230         MSG_FLIST_EOF=21,/* we've transmitted all the file lists */
231         MSG_IO_ERROR=22,/* the sending side had an I/O error */
232         MSG_NOOP=42,    /* a do-nothing message */
233         MSG_SUCCESS=100,/* successfully updated indicated flist index */
234         MSG_DELETED=101,/* successfully deleted a file on receiving side */
235         MSG_NO_SEND=102,/* sender failed to open a file we wanted */
236         MSG_DONE=86     /* current phase is done */
237 };
238
239 #define NDX_DONE -1
240 #define NDX_FLIST_EOF -2
241 #define NDX_FLIST_OFFSET -101
242
243 #include "errcode.h"
244
245 #include "config.h"
246
247 /* The default RSYNC_RSH is always set in config.h. */
248
249 #include <stdio.h>
250 #ifdef HAVE_SYS_TYPES_H
251 # include <sys/types.h>
252 #endif
253 #ifdef HAVE_SYS_STAT_H
254 # include <sys/stat.h>
255 #endif
256 #ifdef STDC_HEADERS
257 # include <stdlib.h>
258 # include <stddef.h>
259 #else
260 # ifdef HAVE_STDLIB_H
261 #  include <stdlib.h>
262 # endif
263 #endif
264 #ifdef HAVE_STRING_H
265 # if !defined STDC_HEADERS && defined HAVE_MEMORY_H
266 #  include <memory.h>
267 # endif
268 # include <string.h>
269 #endif
270 #ifdef HAVE_STRINGS_H
271 # include <strings.h>
272 #endif
273 #ifdef HAVE_INTTYPES_H
274 # include <inttypes.h>
275 #endif
276 #ifdef HAVE_STDINT_H
277 # include <stdint.h>
278 #endif
279 #ifdef HAVE_UNISTD_H
280 # include <unistd.h>
281 #endif
282
283 #ifdef HAVE_SYS_PARAM_H
284 #include <sys/param.h>
285 #endif
286
287 #if defined HAVE_MALLOC_H && (defined HAVE_MALLINFO || !defined HAVE_STDLIB_H)
288 #include <malloc.h>
289 #endif
290
291 #ifdef HAVE_SYS_SOCKET_H
292 #include <sys/socket.h>
293 #endif
294
295 #ifdef TIME_WITH_SYS_TIME
296 #include <sys/time.h>
297 #include <time.h>
298 #else
299 #ifdef HAVE_SYS_TIME_H
300 #include <sys/time.h>
301 #else
302 #include <time.h>
303 #endif
304 #endif
305
306 #ifdef HAVE_FCNTL_H
307 #include <fcntl.h>
308 #else
309 #ifdef HAVE_SYS_FCNTL_H
310 #include <sys/fcntl.h>
311 #endif
312 #endif
313
314 #ifdef HAVE_SYS_IOCTL_H
315 #include <sys/ioctl.h>
316 #endif
317
318 #ifdef HAVE_SYS_FILIO_H
319 #include <sys/filio.h>
320 #endif
321
322 #include <signal.h>
323 #ifdef HAVE_SYS_WAIT_H
324 #include <sys/wait.h>
325 #endif
326 #ifdef HAVE_CTYPE_H
327 #include <ctype.h>
328 #endif
329 #ifdef HAVE_GRP_H
330 #include <grp.h>
331 #endif
332 #include <errno.h>
333
334 #ifdef HAVE_UTIME_H
335 #include <utime.h>
336 #endif
337
338 #ifdef HAVE_SYS_SELECT_H
339 #include <sys/select.h>
340 #endif
341
342 #ifdef HAVE_SYS_MODE_H
343 /* apparently AIX needs this for S_ISLNK */
344 #ifndef S_ISLNK
345 #include <sys/mode.h>
346 #endif
347 #endif
348
349 /* these are needed for the uid/gid mapping code */
350 #include <pwd.h>
351 #include <grp.h>
352
353 #include <stdarg.h>
354 #include <netinet/in.h>
355 #include <arpa/inet.h>
356 #ifdef HAVE_NETDB_H
357 #include <netdb.h>
358 #endif
359 #include <syslog.h>
360 #include <sys/file.h>
361
362 #ifdef HAVE_DIRENT_H
363 # include <dirent.h>
364 #else
365 # define dirent direct
366 # ifdef HAVE_SYS_NDIR_H
367 #  include <sys/ndir.h>
368 # endif
369 # ifdef HAVE_SYS_DIR_H
370 #  include <sys/dir.h>
371 # endif
372 # ifdef HAVE_NDIR_H
373 #  include <ndir.h>
374 # endif
375 #endif
376
377 #ifdef MAJOR_IN_MKDEV
378 #include <sys/mkdev.h>
379 # if !defined makedev && (defined mkdev || defined _WIN32 || defined __WIN32__)
380 #  define makedev mkdev
381 # endif
382 #elif defined MAJOR_IN_SYSMACROS
383 #include <sys/sysmacros.h>
384 #endif
385
386 #ifdef MAKEDEV_TAKES_3_ARGS
387 #define MAKEDEV(devmajor,devminor) makedev(0,devmajor,devminor)
388 #else
389 #define MAKEDEV(devmajor,devminor) makedev(devmajor,devminor)
390 #endif
391
392 #ifdef HAVE_COMPAT_H
393 #include <compat.h>
394 #endif
395
396 #ifdef HAVE_LIMITS_H
397 # include <limits.h>
398 #endif
399
400 #if defined USE_ICONV_OPEN && defined HAVE_ICONV_H
401 #include <iconv.h>
402 #ifndef ICONV_CONST
403 #define ICONV_CONST
404 #endif
405 #else
406 #ifdef ICONV_CONST
407 #undef ICONV_CONST
408 #endif
409 #ifdef ICONV_OPTION
410 #undef ICONV_OPTION
411 #endif
412 #ifdef iconv_t
413 #undef iconv_t
414 #endif
415 #define iconv_t int
416 #endif
417
418 #include <assert.h>
419
420 #include "lib/pool_alloc.h"
421
422 #ifndef HAVE_ID_T
423 typedef unsigned int id_t;
424 #endif
425 #ifndef HAVE_PID_T
426 typedef int pid_t;
427 #endif
428 #ifndef HAVE_MODE_T
429 typedef unsigned int mode_t;
430 #endif
431 #ifndef HAVE_OFF_T
432 typedef long off_t;
433 #undef SIZEOF_OFF_T
434 #define SIZEOF_OFF_T SIZEOF_LONG
435 #endif
436 #ifndef HAVE_SIZE_T
437 typedef unsigned int size_t;
438 #endif
439
440 #define BOOL int
441
442 #ifndef uchar
443 #define uchar unsigned char
444 #endif
445
446 #ifdef SIGNED_CHAR_OK
447 #define schar signed char
448 #else
449 #define schar char
450 #endif
451
452 #ifndef int16
453 #if SIZEOF_INT16_T == 2
454 # define int16 int16_t
455 #else
456 # define int16 short
457 #endif
458 #endif
459
460 #ifndef uint16
461 #if SIZEOF_UINT16_T == 2
462 # define uint16 uint16_t
463 #else
464 # define uint16 unsigned int16
465 #endif
466 #endif
467
468 /* Find a variable that is either exactly 32-bits or longer.
469  * If some code depends on 32-bit truncation, it will need to
470  * take special action in a "#if SIZEOF_INT32 > 4" section. */
471 #ifndef int32
472 #if SIZEOF_INT32_T == 4
473 # define int32 int32_t
474 # define SIZEOF_INT32 4
475 #elif SIZEOF_INT == 4
476 # define int32 int
477 # define SIZEOF_INT32 4
478 #elif SIZEOF_LONG == 4
479 # define int32 long
480 # define SIZEOF_INT32 4
481 #elif SIZEOF_SHORT == 4
482 # define int32 short
483 # define SIZEOF_INT32 4
484 #elif SIZEOF_INT > 4
485 # define int32 int
486 # define SIZEOF_INT32 SIZEOF_INT
487 #elif SIZEOF_LONG > 4
488 # define int32 long
489 # define SIZEOF_INT32 SIZEOF_LONG
490 #else
491 # error Could not find a 32-bit integer variable
492 #endif
493 #else
494 # define SIZEOF_INT32 4
495 #endif
496
497 #ifndef uint32
498 #if SIZEOF_UINT32_T == 4
499 # define uint32 uint32_t
500 #else
501 # define uint32 unsigned int32
502 #endif
503 #endif
504
505 #if SIZEOF_OFF_T == 8 || !SIZEOF_OFF64_T || !defined HAVE_STRUCT_STAT64
506 #define OFF_T off_t
507 #define STRUCT_STAT struct stat
508 #define SIZEOF_CAPITAL_OFF_T SIZEOF_OFF_T
509 #else
510 #define OFF_T off64_t
511 #define STRUCT_STAT struct stat64
512 #define USE_STAT64_FUNCS 1
513 #define SIZEOF_CAPITAL_OFF_T SIZEOF_OFF64_T
514 #endif
515
516 /* CAVEAT: on some systems, int64 will really be a 32-bit integer IFF
517  * that's the maximum size the file system can handle and there is no
518  * 64-bit type available.  The rsync source must therefore take steps
519  * to ensure that any code that really requires a 64-bit integer has
520  * it (e.g. the checksum code uses two 32-bit integers for its 64-bit
521  * counter). */
522 #if SIZEOF_INT64_T == 8
523 # define int64 int64_t
524 # define SIZEOF_INT64 8
525 #elif SIZEOF_LONG == 8
526 # define int64 long
527 # define SIZEOF_INT64 8
528 #elif SIZEOF_INT == 8
529 # define int64 int
530 # define SIZEOF_INT64 8
531 #elif SIZEOF_LONG_LONG == 8
532 # define int64 long long
533 # define SIZEOF_INT64 8
534 #elif SIZEOF_OFF64_T == 8
535 # define int64 off64_t
536 # define SIZEOF_INT64 8
537 #elif SIZEOF_OFF_T == 8
538 # define int64 off_t
539 # define SIZEOF_INT64 8
540 #elif SIZEOF_INT > 8
541 # define int64 int
542 # define SIZEOF_INT64 SIZEOF_INT
543 #elif SIZEOF_LONG > 8
544 # define int64 long
545 # define SIZEOF_INT64 SIZEOF_LONG
546 #elif SIZEOF_LONG_LONG > 8
547 # define int64 long long
548 # define SIZEOF_INT64 SIZEOF_LONG_LONG
549 #else
550 /* As long as it gets... */
551 # define int64 off_t
552 # define SIZEOF_INT64 SIZEOF_OFF_T
553 #endif
554
555 struct hashtable {
556         void *nodes;
557         int32 size, entries;
558         uint32 node_size;
559         int key64;
560 };
561
562 struct ht_int32_node {
563         void *data;
564         int32 key;
565 };
566
567 struct ht_int64_node {
568         void *data;
569         int64 key;
570 };
571
572 #define HT_NODE(tbl, bkts, i) ((void*)((char*)(bkts) + (i)*(tbl)->node_size))
573 #define HT_KEY(node, k64) ((k64)? ((struct ht_int64_node*)(node))->key \
574                          : (int64)((struct ht_int32_node*)(node))->key)
575
576 #ifndef MIN
577 #define MIN(a,b) ((a)<(b)?(a):(b))
578 #endif
579
580 #ifndef MAX
581 #define MAX(a,b) ((a)>(b)?(a):(b))
582 #endif
583
584 #ifndef MAXHOSTNAMELEN
585 #define MAXHOSTNAMELEN 256
586 #endif
587
588 #define SUM_LENGTH 16
589 #define SHORT_SUM_LENGTH 2
590 #define BLOCKSUM_BIAS 10
591
592 #ifndef MAXPATHLEN
593 #define MAXPATHLEN 1024
594 #endif
595
596 /* We want a roomy line buffer that can hold more than MAXPATHLEN,
597  * and significantly more than an overly short MAXPATHLEN. */
598 #if MAXPATHLEN < 4096
599 #define BIGPATHBUFLEN (4096+1024)
600 #else
601 #define BIGPATHBUFLEN (MAXPATHLEN+1024)
602 #endif
603
604 #ifndef NAME_MAX
605 #define NAME_MAX 255
606 #endif
607
608 #ifndef INADDR_NONE
609 #define INADDR_NONE 0xffffffff
610 #endif
611
612 #ifndef IN_LOOPBACKNET
613 #define IN_LOOPBACKNET 127
614 #endif
615
616 #if HAVE_UNIXWARE_ACLS|HAVE_SOLARIS_ACLS|HAVE_HPUX_ACLS
617 #define ACLS_NEED_MASK 1
618 #endif
619
620 union file_extras {
621         int32 num;
622         uint32 unum;
623 };
624
625 struct file_struct {
626         const char *dirname;    /* The dir info inside the transfer */
627         time_t modtime;         /* When the item was last modified */
628         uint32 len32;           /* Lowest 32 bits of the file's length */
629         uint16 mode;            /* The item's type and permissions */
630         uint16 flags;           /* The FLAG_* bits for this item */
631         const char basename[1]; /* The basename (AKA filename) follows */
632 };
633
634 extern int file_extra_cnt;
635 extern int inc_recurse;
636 extern int uid_ndx;
637 extern int gid_ndx;
638 extern int acls_ndx;
639 extern int xattrs_ndx;
640
641 #define FILE_STRUCT_LEN (offsetof(struct file_struct, basename))
642 #define EXTRA_LEN (sizeof (union file_extras))
643 #define PTR_EXTRA_CNT ((sizeof (char *) + EXTRA_LEN - 1) / EXTRA_LEN)
644 #define DEV_EXTRA_CNT 2
645 #define DIRNODE_EXTRA_CNT 3
646 #define SUM_EXTRA_CNT ((MAX_DIGEST_LEN + EXTRA_LEN - 1) / EXTRA_LEN)
647
648 #define REQ_EXTRA(f,ndx) ((union file_extras*)(f) - (ndx))
649 #define OPT_EXTRA(f,bump) ((union file_extras*)(f) - file_extra_cnt - 1 - (bump))
650
651 #define LEN64_BUMP(f) ((f)->flags & FLAG_LENGTH64 ? 1 : 0)
652 #define HLINK_BUMP(f) ((f)->flags & (FLAG_HLINKED|FLAG_HLINK_DONE) ? inc_recurse+1 : 0)
653 #define ACL_BUMP(f) (acls_ndx ? 1 : 0)
654
655 /* The length applies to all items. */
656 #if SIZEOF_INT64 < 8
657 #define F_LENGTH(f) ((int64)(f)->len32)
658 #else
659 #define F_LENGTH(f) ((int64)(f)->len32 + ((f)->flags & FLAG_LENGTH64 \
660                    ? (int64)OPT_EXTRA(f, 0)->unum << 32 : 0))
661 #endif
662
663 /* If there is a symlink string, it is always right after the basename */
664 #define F_SYMLINK(f) ((f)->basename + strlen((f)->basename) + 1)
665
666 /* The sending side always has this available: */
667 #define F_PATHNAME(f) (*(const char**)REQ_EXTRA(f, PTR_EXTRA_CNT))
668
669 /* The receiving side always has this available: */
670 #define F_DEPTH(f) REQ_EXTRA(f, 1)->num
671
672 /* When the associated option is on, all entries will have these present: */
673 #define F_OWNER(f) REQ_EXTRA(f, uid_ndx)->unum
674 #define F_GROUP(f) REQ_EXTRA(f, gid_ndx)->unum
675 #define F_ACL(f) REQ_EXTRA(f, acls_ndx)->num
676 #define F_XATTR(f) REQ_EXTRA(f, xattrs_ndx)->num
677 #define F_NDX(f) REQ_EXTRA(f, unsort_ndx)->num
678
679 /* These items are per-entry optional: */
680 #define F_HL_GNUM(f) OPT_EXTRA(f, LEN64_BUMP(f))->num /* non-dirs */
681 #define F_HL_PREV(f) OPT_EXTRA(f, LEN64_BUMP(f)+inc_recurse)->num /* non-dirs */
682 #define F_DIR_NODE_P(f) (&OPT_EXTRA(f, LEN64_BUMP(f) \
683                                 + DIRNODE_EXTRA_CNT - 1)->num) /* sender dirs */
684 #define F_DIR_RELNAMES_P(f) (&OPT_EXTRA(f, LEN64_BUMP(f) + DIRNODE_EXTRA_CNT \
685                                 + PTR_EXTRA_CNT - 1)->num) /* sender dirs */
686 #define F_DIR_DEFACL(f) OPT_EXTRA(f, LEN64_BUMP(f))->unum /* receiver dirs */
687 #define F_DIR_DEV_P(f) (&OPT_EXTRA(f, LEN64_BUMP(f) + ACL_BUMP(f) \
688                                 + DEV_EXTRA_CNT - 1)->unum) /* receiver dirs */
689
690 /* This optional item might follow an F_HL_*() item.
691  * (Note: a device doesn't need to check LEN64_BUMP(f).) */
692 #define F_RDEV_P(f) (&OPT_EXTRA(f, HLINK_BUMP(f) + DEV_EXTRA_CNT - 1)->unum)
693
694 /* The sum is only present on regular files. */
695 #define F_SUM(f) ((char*)OPT_EXTRA(f, LEN64_BUMP(f) + HLINK_BUMP(f) \
696                                     + SUM_EXTRA_CNT - 1))
697
698 /* Some utility defines: */
699 #define F_IS_ACTIVE(f) (f)->basename[0]
700 #define F_IS_HLINKED(f) ((f)->flags & FLAG_HLINKED)
701
702 #define F_HLINK_NOT_FIRST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_FIRST)
703 #define F_HLINK_NOT_LAST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_LAST)
704
705 /* These access the F_DIR_DEV_P() and F_RDEV_P() values: */
706 #define DEV_MAJOR(a) (a)[0]
707 #define DEV_MINOR(a) (a)[1]
708
709 /* These access the F_DIRS_NODE_P() values: */
710 #define DIR_PARENT(a) (a)[0]
711 #define DIR_FIRST_CHILD(a) (a)[1]
712 #define DIR_NEXT_SIBLING(a) (a)[2]
713
714 /*
715  * Start the flist array at FLIST_START entries and grow it
716  * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
717  */
718 #define FLIST_START     (32 * 1024)
719 #define FLIST_LINEAR    (FLIST_START * 512)
720
721 /*
722  * Extent size for allocation pools: A minimum size of 128KB
723  * is needed to mmap them so that freeing will release the
724  * space to the OS.
725  *
726  * Larger sizes reduce leftover fragments and speed free calls
727  * (when they happen). Smaller sizes increase the chance of
728  * freed allocations freeing whole extents.
729  */
730 #define NORMAL_EXTENT   (256 * 1024)
731 #define SMALL_EXTENT    (128 * 1024)
732
733 #define FLIST_TEMP      (1<<1)
734
735 struct file_list {
736         struct file_list *next, *prev;
737         struct file_struct **files, **sorted;
738         alloc_pool_t file_pool;
739         void *pool_boundary;
740         int used, malloced;
741         int low, high;  /* 0-relative index values excluding empties */
742         int ndx_start;  /* the start offset for inc_recurse mode */
743         int flist_num;  /* 1-relative file_list number or 0 */
744         int parent_ndx; /* dir_flist index of parent directory */
745         int in_progress, to_redo;
746 };
747
748 #define SUMFLG_SAME_OFFSET      (1<<0)
749
750 struct sum_buf {
751         OFF_T offset;           /**< offset in file of this chunk */
752         int32 len;              /**< length of chunk of file */
753         uint32 sum1;            /**< simple checksum */
754         int32 chain;            /**< next hash-table collision */
755         short flags;            /**< flag bits */
756         char sum2[SUM_LENGTH];  /**< checksum  */
757 };
758
759 struct sum_struct {
760         OFF_T flength;          /**< total file length */
761         struct sum_buf *sums;   /**< points to info for each chunk */
762         int32 count;            /**< how many chunks */
763         int32 blength;          /**< block_length */
764         int32 remainder;        /**< flength % block_length */
765         int s2length;           /**< sum2_length */
766 };
767
768 struct map_struct {
769         OFF_T file_size;        /* File size (from stat)                */
770         OFF_T p_offset;         /* Window start                         */
771         OFF_T p_fd_offset;      /* offset of cursor in fd ala lseek     */
772         char *p;                /* Window pointer                       */
773         int32 p_size;           /* Largest window size we allocated     */
774         int32 p_len;            /* Latest (rounded) window size         */
775         int32 def_window_size;  /* Default window size                  */
776         int fd;                 /* File Descriptor                      */
777         int status;             /* first errno from read errors         */
778 };
779
780 #define MATCHFLG_WILD           (1<<0) /* pattern has '*', '[', and/or '?' */
781 #define MATCHFLG_WILD2          (1<<1) /* pattern has '**' */
782 #define MATCHFLG_WILD2_PREFIX   (1<<2) /* pattern starts with "**" */
783 #define MATCHFLG_WILD3_SUFFIX   (1<<3) /* pattern ends with "***" */
784 #define MATCHFLG_ABS_PATH       (1<<4) /* path-match on absolute path */
785 #define MATCHFLG_INCLUDE        (1<<5) /* this is an include, not an exclude */
786 #define MATCHFLG_DIRECTORY      (1<<6) /* this matches only directories */
787 #define MATCHFLG_WORD_SPLIT     (1<<7) /* split rules on whitespace */
788 #define MATCHFLG_NO_INHERIT     (1<<8) /* don't inherit these rules */
789 #define MATCHFLG_NO_PREFIXES    (1<<9) /* parse no prefixes from patterns */
790 #define MATCHFLG_MERGE_FILE     (1<<10)/* specifies a file to merge */
791 #define MATCHFLG_PERDIR_MERGE   (1<<11)/* merge-file is searched per-dir */
792 #define MATCHFLG_EXCLUDE_SELF   (1<<12)/* merge-file name should be excluded */
793 #define MATCHFLG_FINISH_SETUP   (1<<13)/* per-dir merge file needs setup */
794 #define MATCHFLG_NEGATE         (1<<14)/* rule matches when pattern does not */
795 #define MATCHFLG_CVS_IGNORE     (1<<15)/* rule was -C or :C */
796 #define MATCHFLG_SENDER_SIDE    (1<<16)/* rule applies to the sending side */
797 #define MATCHFLG_RECEIVER_SIDE  (1<<17)/* rule applies to the receiving side */
798 #define MATCHFLG_CLEAR_LIST     (1<<18)/* this item is the "!" token */
799 #define MATCHFLG_PERISHABLE     (1<<19)/* perishable if parent dir goes away */
800
801 #define MATCHFLGS_FROM_CONTAINER (MATCHFLG_ABS_PATH | MATCHFLG_INCLUDE \
802                                 | MATCHFLG_DIRECTORY | MATCHFLG_SENDER_SIDE \
803                                 | MATCHFLG_NEGATE | MATCHFLG_RECEIVER_SIDE \
804                                 | MATCHFLG_PERISHABLE)
805
806 struct filter_struct {
807         struct filter_struct *next;
808         char *pattern;
809         uint32 match_flags;
810         union {
811                 int slash_cnt;
812                 struct filter_list_struct *mergelist;
813         } u;
814 };
815
816 struct filter_list_struct {
817         struct filter_struct *head;
818         struct filter_struct *tail;
819         char *debug_type;
820 };
821
822 struct stats {
823         int64 total_size;
824         int64 total_transferred_size;
825         int64 total_written;
826         int64 total_read;
827         int64 literal_data;
828         int64 matched_data;
829         int64 flist_buildtime;
830         int64 flist_xfertime;
831         int64 flist_size;
832         int num_files;
833         int num_transferred_files;
834 };
835
836 struct chmod_mode_struct;
837
838 struct flist_ndx_item {
839         struct flist_ndx_item *next;
840         int ndx;
841 };
842
843 typedef struct {
844         struct flist_ndx_item *head, *tail;
845 } flist_ndx_list;
846
847 #define EMPTY_ITEM_LIST {NULL, 0, 0}
848
849 typedef struct {
850         void *items;
851         size_t count;
852         size_t malloced;
853 } item_list;
854
855 #define EXPAND_ITEM_LIST(lp, type, incr) \
856         (type*)expand_item_list(lp, sizeof (type), #type, incr)
857
858 #define EMPTY_XBUF {NULL, 0, 0, 0}
859
860 typedef struct {
861         char *buf;
862         size_t pos;  /* pos = read pos in the buf */
863         size_t len;  /* len = chars following pos */
864         size_t size; /* size = total space in buf */
865 } xbuf;
866
867 #define INIT_XBUF(xb, str, ln, sz) (xb).buf = (str), (xb).len = (ln), (xb).size = (sz), (xb).pos = 0
868 #define INIT_XBUF_STRLEN(xb, str) (xb).buf = (str), (xb).len = strlen((xb).buf), (xb).size = (-1), (xb).pos = 0
869 /* This one is used to make an output xbuf based on a char[] buffer: */
870 #define INIT_CONST_XBUF(xb, bf) (xb).buf = (bf), (xb).size = sizeof (bf), (xb).len = (xb).pos = 0
871
872 #define ICB_EXPAND_OUT (1<<0)
873 #define ICB_INCLUDE_BAD (1<<1)
874 #define ICB_INCLUDE_INCOMPLETE (1<<2)
875
876 #define RL_EOL_NULLS (1<<0)
877 #define RL_DUMP_COMMENTS (1<<1)
878 #define RL_CONVERT (1<<2)
879
880 typedef struct {
881         char name_type;
882         char fname[1]; /* has variable size */
883 } relnamecache;
884
885 #include "byteorder.h"
886 #include "lib/mdigest.h"
887 #include "lib/wildmatch.h"
888 #include "lib/permstring.h"
889 #include "lib/addrinfo.h"
890
891 #ifndef __GNUC__
892 #define __attribute__(x)
893 #else
894 # if __GNUC__ <= 2
895 # define NORETURN
896 # endif
897 #endif
898
899 #define UNUSED(x) x __attribute__((__unused__))
900 #ifndef NORETURN
901 #define NORETURN __attribute__((__noreturn__))
902 #endif
903
904 typedef struct {
905     STRUCT_STAT st;
906 #ifdef SUPPORT_ACLS
907     struct rsync_acl *acc_acl; /* access ACL */
908     struct rsync_acl *def_acl; /* default ACL */
909 #endif
910 #ifdef SUPPORT_XATTRS
911     item_list *xattr;
912 #endif
913 } stat_x;
914
915 #define ACL_READY(sx) ((sx).acc_acl != NULL)
916 #define XATTR_READY(sx) ((sx).xattr != NULL)
917
918 #include "proto.h"
919
920 #ifndef SUPPORT_XATTRS
921 #define x_stat(fn,fst,xst) do_stat(fn,fst)
922 #define x_lstat(fn,fst,xst) do_lstat(fn,fst)
923 #define x_fstat(fd,fst,xst) do_fstat(fd,fst)
924 #endif
925
926 /* We have replacement versions of these if they're missing. */
927 #ifndef HAVE_ASPRINTF
928 int asprintf(char **ptr, const char *format, ...);
929 #endif
930
931 #ifndef HAVE_VASPRINTF
932 int vasprintf(char **ptr, const char *format, va_list ap);
933 #endif
934
935 #if !defined HAVE_VSNPRINTF || !defined HAVE_C99_VSNPRINTF
936 #define vsnprintf rsync_vsnprintf
937 int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
938 #endif
939
940 #if !defined HAVE_SNPRINTF || !defined HAVE_C99_VSNPRINTF
941 #define snprintf rsync_snprintf
942 int snprintf(char *str, size_t count, const char *fmt,...);
943 #endif
944
945
946 #ifndef HAVE_STRERROR
947 extern char *sys_errlist[];
948 #define strerror(i) sys_errlist[i]
949 #endif
950
951 #ifndef HAVE_STRCHR
952 # define strchr                 index
953 # define strrchr                rindex
954 #endif
955
956 #ifndef HAVE_ERRNO_DECL
957 extern int errno;
958 #endif
959
960 #ifdef HAVE_READLINK
961 #define SUPPORT_LINKS 1
962 #endif
963 #ifdef HAVE_LINK
964 #define SUPPORT_HARD_LINKS 1
965 #endif
966
967 #ifdef HAVE_SIGACTION
968 #define SIGACTION(n,h) sigact.sa_handler=(h), sigaction((n),&sigact,NULL)
969 #define signal(n,h) we_need_to_call_SIGACTION_not_signal(n,h)
970 #else
971 #define SIGACTION(n,h) signal(n,h)
972 #endif
973
974 #ifndef EWOULDBLOCK
975 #define EWOULDBLOCK EAGAIN
976 #endif
977
978 #ifndef STDIN_FILENO
979 #define STDIN_FILENO 0
980 #endif
981
982 #ifndef STDOUT_FILENO
983 #define STDOUT_FILENO 1
984 #endif
985
986 #ifndef STDERR_FILENO
987 #define STDERR_FILENO 2
988 #endif
989
990 #ifndef S_IRUSR
991 #define S_IRUSR 0400
992 #endif
993
994 #ifndef S_IWUSR
995 #define S_IWUSR 0200
996 #endif
997
998 #ifndef ACCESSPERMS
999 #define ACCESSPERMS 0777
1000 #endif
1001
1002 #ifndef S_ISVTX
1003 #define S_ISVTX 0
1004 #endif
1005
1006 #define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
1007
1008 #ifndef _S_IFMT
1009 #define _S_IFMT        0170000
1010 #endif
1011
1012 #ifndef _S_IFLNK
1013 #define _S_IFLNK  0120000
1014 #endif
1015
1016 #ifndef S_ISLNK
1017 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
1018 #endif
1019
1020 #ifndef S_ISBLK
1021 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
1022 #endif
1023
1024 #ifndef S_ISCHR
1025 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
1026 #endif
1027
1028 #ifndef S_ISSOCK
1029 #ifdef _S_IFSOCK
1030 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
1031 #else
1032 #define S_ISSOCK(mode) (0)
1033 #endif
1034 #endif
1035
1036 #ifndef S_ISFIFO
1037 #ifdef _S_IFIFO
1038 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
1039 #else
1040 #define S_ISFIFO(mode) (0)
1041 #endif
1042 #endif
1043
1044 #ifndef S_ISDIR
1045 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
1046 #endif
1047
1048 #ifndef S_ISREG
1049 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
1050 #endif
1051
1052 /* work out what fcntl flag to use for non-blocking */
1053 #ifdef O_NONBLOCK
1054 # define NONBLOCK_FLAG O_NONBLOCK
1055 #elif defined SYSV
1056 # define NONBLOCK_FLAG O_NDELAY
1057 #else
1058 # define NONBLOCK_FLAG FNDELAY
1059 #endif
1060
1061 #ifndef INADDR_LOOPBACK
1062 #define INADDR_LOOPBACK 0x7f000001
1063 #endif
1064
1065 #ifndef INADDR_NONE
1066 #define INADDR_NONE 0xffffffff
1067 #endif
1068
1069 #define IS_SPECIAL(mode) (S_ISSOCK(mode) || S_ISFIFO(mode))
1070 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode))
1071
1072 /* Initial mask on permissions given to temporary files.  Mask off setuid
1073      bits and group access because of potential race-condition security
1074      holes, and mask other access because mode 707 is bizarre */
1075 #define INITACCESSPERMS 0700
1076
1077 /* handler for null strings in printf format */
1078 #define NS(s) ((s)?(s):"<NULL>")
1079
1080 /* Convenient wrappers for malloc and realloc.  Use them. */
1081 #define new(type) ((type*)malloc(sizeof (type)))
1082 #define new0(type) ((type*)calloc(1, sizeof (type)))
1083 #define new_array(type, num) ((type*)_new_array((num), sizeof (type), 0))
1084 #define new_array0(type, num) ((type*)_new_array((num), sizeof (type), 1))
1085 #define realloc_array(ptr, type, num) ((type*)_realloc_array((ptr), sizeof(type), (num)))
1086
1087 /* use magic gcc attributes to catch format errors */
1088  void rprintf(enum logcode , const char *, ...)
1089      __attribute__((format (printf, 2, 3)))
1090 ;
1091
1092 /* This is just like rprintf, but it also tries to print some
1093  * representation of the error code.  Normally errcode = errno. */
1094 void rsyserr(enum logcode, int, const char *, ...)
1095      __attribute__((format (printf, 3, 4)))
1096      ;
1097
1098 /* Make sure that the O_BINARY flag is defined. */
1099 #ifndef O_BINARY
1100 #define O_BINARY 0
1101 #endif
1102
1103 #ifndef HAVE_STRLCPY
1104 size_t strlcpy(char *d, const char *s, size_t bufsize);
1105 #endif
1106
1107 #ifndef HAVE_STRLCAT
1108 size_t strlcat(char *d, const char *s, size_t bufsize);
1109 #endif
1110
1111 #ifndef WEXITSTATUS
1112 #define WEXITSTATUS(stat)       ((int)(((stat)>>8)&0xFF))
1113 #endif
1114 #ifndef WIFEXITED
1115 #define WIFEXITED(stat)         ((int)((stat)&0xFF) == 0)
1116 #endif
1117
1118 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
1119
1120 #ifdef HAVE_GETEUID
1121 #define MY_UID() geteuid()
1122 #else
1123 #define MY_UID() getuid()
1124 #endif
1125
1126 #ifdef HAVE_GETEGID
1127 #define MY_GID() getegid()
1128 #else
1129 #define MY_GID() getgid()
1130 #endif
1131
1132 #ifdef FORCE_FD_ZERO_MEMSET
1133 #undef FD_ZERO
1134 #define FD_ZERO(fdsetp) memset(fdsetp, 0, sizeof (fd_set))
1135 #endif
1136
1137 extern int verbose;
1138
1139 #ifndef HAVE_INET_NTOP
1140 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
1141 #endif
1142
1143 #ifndef HAVE_INET_PTON
1144 int inet_pton(int af, const char *src, void *dst);
1145 #endif
1146
1147 #ifdef MAINTAINER_MODE
1148 const char *get_panic_action(void);
1149 #endif