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