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