A few superficial tweaks.
[rsync.git] / rsync.h
blobda72dc997684e622fd2ebbc292f794c443e1de2e
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-2020 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/" /* This MUST have a trailing slash! */
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)
56 #define XMIT_SAME_RDEV_MAJOR (1<<8) /* protocols 28 - now (devices only) */
57 #define XMIT_NO_CONTENT_DIR (1<<8) /* protocols 30 - now (dirs only) */
58 #define XMIT_HLINKED (1<<9) /* protocols 28 - now (non-dirs) */
59 #define XMIT_SAME_DEV_pre30 (1<<10) /* protocols 28 - 29 */
60 #define XMIT_USER_NAME_FOLLOWS (1<<10) /* protocols 30 - now */
61 #define XMIT_RDEV_MINOR_8_pre30 (1<<11) /* protocols 28 - 29 */
62 #define XMIT_GROUP_NAME_FOLLOWS (1<<11) /* protocols 30 - now */
63 #define XMIT_HLINK_FIRST (1<<12) /* protocols 30 - now (HLINKED files only) */
64 #define XMIT_IO_ERROR_ENDLIST (1<<12) /* protocols 31*- now (w/XMIT_EXTENDED_FLAGS) (also protocol 30 w/'f' compat flag) */
65 #define XMIT_MOD_NSEC (1<<13) /* protocols 31 - now */
66 #define XMIT_SAME_ATIME (1<<14) /* any protocol - restricted by command-line option */
67 #define XMIT_UNUSED_15 (1<<15) /* unused flag bit */
69 /* The following XMIT flags require an rsync that uses a varint for the flag values */
71 #define XMIT_RESERVED_16 (1<<16) /* reserved for future fileflags use */
72 #define XMIT_RESERVED_17 (1<<17) /* reserved for future crtimes use */
74 /* These flags are used in the live flist data. */
76 #define FLAG_TOP_DIR (1<<0) /* sender/receiver/generator */
77 #define FLAG_OWNED_BY_US (1<<0) /* generator: set by make_file() for aux flists only */
78 #define FLAG_FILE_SENT (1<<1) /* sender/receiver/generator */
79 #define FLAG_DIR_CREATED (1<<1) /* generator */
80 #define FLAG_CONTENT_DIR (1<<2) /* sender/receiver/generator */
81 #define FLAG_MOUNT_DIR (1<<3) /* sender/generator (dirs only) */
82 #define FLAG_SKIP_HLINK (1<<3) /* receiver/generator (w/FLAG_HLINKED) */
83 #define FLAG_DUPLICATE (1<<4) /* sender */
84 #define FLAG_MISSING_DIR (1<<4) /* generator */
85 #define FLAG_HLINKED (1<<5) /* receiver/generator (checked on all types) */
86 #define FLAG_HLINK_FIRST (1<<6) /* receiver/generator (w/FLAG_HLINKED) */
87 #define FLAG_IMPLIED_DIR (1<<6) /* sender/receiver/generator (dirs only) */
88 #define FLAG_HLINK_LAST (1<<7) /* receiver/generator */
89 #define FLAG_HLINK_DONE (1<<8) /* receiver/generator (checked on all types) */
90 #define FLAG_LENGTH64 (1<<9) /* sender/receiver/generator */
91 #define FLAG_SKIP_GROUP (1<<10) /* receiver/generator */
92 #define FLAG_TIME_FAILED (1<<11)/* generator */
93 #define FLAG_MOD_NSEC (1<<12) /* sender/receiver/generator */
95 /* These flags are passed to functions but not stored. */
97 #define FLAG_DIVERT_DIRS (1<<16) /* sender, but must be unique */
98 #define FLAG_PERHAPS_DIR (1<<17) /* generator */
100 /* These flags are for get_dirlist(). */
101 #define GDL_IGNORE_FILTER_RULES (1<<0)
102 #define GDL_PERHAPS_DIR (1<<1)
104 /* Some helper macros for matching bits. */
105 #define BITS_SET(val,bits) (((val) & (bits)) == (bits))
106 #define BITS_SETnUNSET(val,onbits,offbits) (((val) & ((onbits)|(offbits))) == (onbits))
107 #define BITS_EQUAL(b1,b2,mask) (((unsigned)(b1) & (unsigned)(mask)) \
108 == ((unsigned)(b2) & (unsigned)(mask)))
110 /* update this if you make incompatible changes */
111 #define PROTOCOL_VERSION 31
113 /* This is used when working on a new protocol version in CVS, and should
114 * be a new non-zero value for each CVS change that affects the protocol.
115 * It must ALWAYS be 0 when the protocol goes final (and NEVER before)! */
116 #define SUBPROTOCOL_VERSION 0
118 /* We refuse to interoperate with versions that are not in this range.
119 * Note that we assume we'll work with later versions: the onus is on
120 * people writing them to make sure that they don't send us anything
121 * we won't understand.
123 * Interoperation with old but supported protocol versions
124 * should cause a warning to be printed. At a future date
125 * the old protocol will become the minimum and
126 * compatibility code removed.
128 * There are two possible explanations for the limit at
129 * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
130 * do not interoperate with us, and (more likely) so that we can
131 * detect an attempt to connect rsync to a non-rsync server, which is
132 * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
133 * MAX_PROTOCOL_VERSION. */
135 #define MIN_PROTOCOL_VERSION 20
136 #define OLD_PROTOCOL_VERSION 25
137 #define MAX_PROTOCOL_VERSION 40
139 #define MIN_FILECNT_LOOKAHEAD 1000
140 #define MAX_FILECNT_LOOKAHEAD 10000
142 #define RSYNC_PORT 873
144 #define SPARSE_WRITE_SIZE (1024)
145 #define WRITE_SIZE (32*1024)
146 #define CHUNK_SIZE (32*1024)
147 #define MAX_MAP_SIZE (256*1024)
148 #define IO_BUFFER_SIZE (32*1024)
149 #define MAX_BLOCK_SIZE ((int32)1 << 17)
151 /* For compatibility with older rsyncs */
152 #define OLD_MAX_BLOCK_SIZE ((int32)1 << 29)
154 #define ROUND_UP_1024(siz) ((siz) & (1024-1) ? ((siz) | (1024-1)) + 1 : (siz))
156 #define IOERR_GENERAL (1<<0) /* For backward compatibility, this must == 1 */
157 #define IOERR_VANISHED (1<<1)
158 #define IOERR_DEL_LIMIT (1<<2)
160 #define MAX_ARGS 1000
161 #define MAX_BASIS_DIRS 20
162 #define MAX_SERVER_ARGS (MAX_BASIS_DIRS*2 + 100)
164 #define MPLEX_BASE 7
166 #define NO_FILTERS 0
167 #define SERVER_FILTERS 1
168 #define ALL_FILTERS 2
170 #define XFLG_FATAL_ERRORS (1<<0)
171 #define XFLG_OLD_PREFIXES (1<<1)
172 #define XFLG_ANCHORED2ABS (1<<2) /* leading slash indicates absolute */
173 #define XFLG_ABS_IF_SLASH (1<<3) /* leading or interior slash is absolute */
174 #define XFLG_DIR2WILD3 (1<<4) /* dir/ match gets trailing *** added */
176 #define ATTRS_REPORT (1<<0)
177 #define ATTRS_SKIP_MTIME (1<<1)
178 #define ATTRS_SET_NANO (1<<2)
179 #define ATTRS_SKIP_ATIME (1<<3)
181 #define FULL_FLUSH 1
182 #define NORMAL_FLUSH 0
184 #define PDIR_CREATE 1
185 #define PDIR_DELETE 0
187 /* Note: 0x00 - 0x7F are used for basis_dir[] indexes! */
188 #define FNAMECMP_BASIS_DIR_LOW 0x00 /* Must remain 0! */
189 #define FNAMECMP_BASIS_DIR_HIGH 0x7F
190 #define FNAMECMP_FNAME 0x80
191 #define FNAMECMP_PARTIAL_DIR 0x81
192 #define FNAMECMP_BACKUP 0x82
193 #define FNAMECMP_FUZZY 0x83
195 /* For use by the itemize_changes code */
196 #define ITEM_REPORT_ATIME (1<<0)
197 #define ITEM_REPORT_CHANGE (1<<1)
198 #define ITEM_REPORT_SIZE (1<<2) /* regular files only */
199 #define ITEM_REPORT_TIMEFAIL (1<<2) /* symlinks only */
200 #define ITEM_REPORT_TIME (1<<3)
201 #define ITEM_REPORT_PERMS (1<<4)
202 #define ITEM_REPORT_OWNER (1<<5)
203 #define ITEM_REPORT_GROUP (1<<6)
204 #define ITEM_REPORT_ACL (1<<7)
205 #define ITEM_REPORT_XATTR (1<<8)
206 #define ITEM_BASIS_TYPE_FOLLOWS (1<<11)
207 #define ITEM_XNAME_FOLLOWS (1<<12)
208 #define ITEM_IS_NEW (1<<13)
209 #define ITEM_LOCAL_CHANGE (1<<14)
210 #define ITEM_TRANSFER (1<<15)
211 /* These are outside the range of the transmitted flags. */
212 #define ITEM_MISSING_DATA (1<<16) /* used by log_formatted() */
213 #define ITEM_DELETED (1<<17) /* used by log_formatted() */
214 #define ITEM_MATCHED (1<<18) /* used by itemize() */
216 #define SIGNIFICANT_ITEM_FLAGS (~(\
217 ITEM_BASIS_TYPE_FOLLOWS | ITEM_XNAME_FOLLOWS | ITEM_LOCAL_CHANGE))
219 #define CFN_KEEP_DOT_DIRS (1<<0)
220 #define CFN_KEEP_TRAILING_SLASH (1<<1)
221 #define CFN_DROP_TRAILING_DOT_DIR (1<<2)
222 #define CFN_COLLAPSE_DOT_DOT_DIRS (1<<3)
223 #define CFN_REFUSE_DOT_DOT_DIRS (1<<4)
225 #define SP_DEFAULT 0
226 #define SP_KEEP_DOT_DIRS (1<<0)
228 #define CD_NORMAL 0
229 #define CD_SKIP_CHDIR 1
231 /* Log-message categories. FLOG only goes to the log file, not the client;
232 * FCLIENT is the opposite. */
233 enum logcode {
234 FNONE=0, /* never sent */
235 FERROR_XFER=1, FINFO=2, /* sent over socket for any protocol */
236 FERROR=3, FWARNING=4, /* sent over socket for protocols >= 30 */
237 FERROR_SOCKET=5, FLOG=6, /* only sent via receiver -> generator pipe */
238 FERROR_UTF8=8, /* only sent via receiver -> generator pipe */
239 FCLIENT=7 /* never transmitted (e.g. server converts to FINFO) */
242 /* Messages types that are sent over the message channel. The logcode
243 * values must all be present here with identical numbers. */
244 enum msgcode {
245 MSG_DATA=0, /* raw data on the multiplexed stream */
246 MSG_ERROR_XFER=FERROR_XFER, MSG_INFO=FINFO, /* remote logging */
247 MSG_ERROR=FERROR, MSG_WARNING=FWARNING, /* protocol-30 remote logging */
248 MSG_ERROR_SOCKET=FERROR_SOCKET, /* sibling logging */
249 MSG_ERROR_UTF8=FERROR_UTF8, /* sibling logging */
250 MSG_LOG=FLOG, MSG_CLIENT=FCLIENT, /* sibling logging */
251 MSG_REDO=9, /* reprocess indicated flist index */
252 MSG_STATS=10, /* message has stats data for generator */
253 MSG_IO_ERROR=22,/* the sending side had an I/O error */
254 MSG_IO_TIMEOUT=33,/* tell client about a daemon's timeout value */
255 MSG_NOOP=42, /* a do-nothing message (legacy protocol-30 only) */
256 MSG_ERROR_EXIT=86, /* synchronize an error exit (siblings and protocol >= 31) */
257 MSG_SUCCESS=100,/* successfully updated indicated flist index */
258 MSG_DELETED=101,/* successfully deleted a file on receiving side */
259 MSG_NO_SEND=102,/* sender failed to open a file we wanted */
262 #define NDX_DONE -1
263 #define NDX_FLIST_EOF -2
264 #define NDX_DEL_STATS -3
265 #define NDX_FLIST_OFFSET -101
267 /* For calling delete_item() and delete_dir_contents(). */
268 #define DEL_NO_UID_WRITE (1<<0) /* file/dir has our uid w/o write perm */
269 #define DEL_RECURSE (1<<1) /* if dir, delete all contents */
270 #define DEL_DIR_IS_EMPTY (1<<2) /* internal delete_FUNCTIONS use only */
271 #define DEL_FOR_FILE (1<<3) /* making room for a replacement file */
272 #define DEL_FOR_DIR (1<<4) /* making room for a replacement dir */
273 #define DEL_FOR_SYMLINK (1<<5) /* making room for a replacement symlink */
274 #define DEL_FOR_DEVICE (1<<6) /* making room for a replacement device */
275 #define DEL_FOR_SPECIAL (1<<7) /* making room for a replacement special */
276 #define DEL_FOR_BACKUP (1<<8) /* the delete is for a backup operation */
278 #define DEL_MAKE_ROOM (DEL_FOR_FILE|DEL_FOR_DIR|DEL_FOR_SYMLINK|DEL_FOR_DEVICE|DEL_FOR_SPECIAL)
280 enum delret {
281 DR_SUCCESS = 0, DR_FAILURE, DR_AT_LIMIT, DR_NOT_EMPTY
284 /* Defines for make_path() */
285 #define MKP_DROP_NAME (1<<0) /* drop trailing filename or trailing slash */
286 #define MKP_SKIP_SLASH (1<<1) /* skip one or more leading slashes */
288 /* Defines for maybe_send_keepalive() */
289 #define MSK_ALLOW_FLUSH (1<<0)
290 #define MSK_ACTIVE_RECEIVER (1<<1)
292 #include "errcode.h"
294 #include "config.h"
296 /* The default RSYNC_RSH is always set in config.h. */
298 #include <stdio.h>
299 #ifdef HAVE_SYS_TYPES_H
300 # include <sys/types.h>
301 #endif
302 #ifdef HAVE_SYS_STAT_H
303 # include <sys/stat.h>
304 #endif
305 #ifdef STDC_HEADERS
306 # include <stdlib.h>
307 # include <stddef.h>
308 #else
309 # ifdef HAVE_STDLIB_H
310 # include <stdlib.h>
311 # endif
312 #endif
313 #ifdef HAVE_STRING_H
314 # if !defined STDC_HEADERS && defined HAVE_MEMORY_H
315 # include <memory.h>
316 # endif
317 # include <string.h>
318 #endif
319 #ifdef HAVE_STRINGS_H
320 # include <strings.h>
321 #endif
322 #ifdef HAVE_INTTYPES_H
323 # include <inttypes.h>
324 #endif
325 #ifdef HAVE_STDINT_H
326 # include <stdint.h>
327 #endif
328 #ifdef HAVE_UNISTD_H
329 # include <unistd.h>
330 #endif
332 #ifdef HAVE_SYS_PARAM_H
333 #include <sys/param.h>
334 #endif
336 #if defined HAVE_MALLOC_H && (defined HAVE_MALLINFO || !defined HAVE_STDLIB_H)
337 #include <malloc.h>
338 #endif
340 #ifdef HAVE_SYS_SOCKET_H
341 #include <sys/socket.h>
342 #endif
344 #ifdef TIME_WITH_SYS_TIME
345 #include <sys/time.h>
346 #include <time.h>
347 #else
348 #ifdef HAVE_SYS_TIME_H
349 #include <sys/time.h>
350 #else
351 #include <time.h>
352 #endif
353 #endif
355 #ifdef HAVE_FCNTL_H
356 #include <fcntl.h>
357 #else
358 #ifdef HAVE_SYS_FCNTL_H
359 #include <sys/fcntl.h>
360 #endif
361 #endif
363 #ifdef HAVE_SYS_IOCTL_H
364 #include <sys/ioctl.h>
365 #endif
367 #ifdef HAVE_SYS_FILIO_H
368 #include <sys/filio.h>
369 #endif
371 #include <signal.h>
372 #ifdef HAVE_SYS_WAIT_H
373 #include <sys/wait.h>
374 #endif
375 #ifdef HAVE_CTYPE_H
376 #include <ctype.h>
377 #endif
378 #ifdef HAVE_GRP_H
379 #include <grp.h>
380 #endif
381 #include <errno.h>
383 #ifdef HAVE_UTIME_H
384 #include <utime.h>
385 #endif
387 #if defined HAVE_UTIMENSAT || defined HAVE_LUTIMES || defined HAVE_SETATTRLIST
388 #define CAN_SET_SYMLINK_TIMES 1
389 #endif
391 #if defined HAVE_LCHOWN || defined CHOWN_MODIFIES_SYMLINK
392 #define CAN_CHOWN_SYMLINK 1
393 #endif
395 #if defined HAVE_LCHMOD || defined HAVE_SETATTRLIST
396 #define CAN_CHMOD_SYMLINK 1
397 #endif
399 #if defined HAVE_UTIMENSAT || defined HAVE_SETATTRLIST
400 #define CAN_SET_NSEC 1
401 #endif
403 #ifdef CAN_SET_NSEC
404 #ifdef HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
405 #define ST_MTIME_NSEC st_mtim.tv_nsec
406 #define ST_ATIME_NSEC st_atim.tv_nsec
407 #elif defined(HAVE_STRUCT_STAT_ST_MTIMENSEC)
408 #define ST_MTIME_NSEC st_mtimensec
409 #define ST_ATIME_NSEC st_atimensec
410 #elif defined(HAVE_STRUCT_STAT_ST_MTIMESPEC_TV_NSEC)
411 #define ST_MTIME_NSEC st_mtimespec.tv_nsec
412 #define ST_ATIME_NSEC st_atimespec.tv_nsec
413 #endif
414 #endif
416 #ifdef HAVE_SYS_SELECT_H
417 #include <sys/select.h>
418 #endif
420 #ifdef HAVE_SYS_MODE_H
421 /* apparently AIX needs this for S_ISLNK */
422 #ifndef S_ISLNK
423 #include <sys/mode.h>
424 #endif
425 #endif
427 /* these are needed for the uid/gid mapping code */
428 #include <pwd.h>
429 #include <grp.h>
431 #include <stdarg.h>
432 #include <netinet/in.h>
433 #include <arpa/inet.h>
434 #ifdef HAVE_NETDB_H
435 #include <netdb.h>
436 #endif
437 #include <syslog.h>
438 #include <sys/file.h>
440 #ifdef HAVE_DIRENT_H
441 # include <dirent.h>
442 #else
443 # define dirent direct
444 # ifdef HAVE_SYS_NDIR_H
445 # include <sys/ndir.h>
446 # endif
447 # ifdef HAVE_SYS_DIR_H
448 # include <sys/dir.h>
449 # endif
450 # ifdef HAVE_NDIR_H
451 # include <ndir.h>
452 # endif
453 #endif
455 #ifdef MAJOR_IN_MKDEV
456 #include <sys/mkdev.h>
457 # if !defined makedev && (defined mkdev || defined _WIN32 || defined __WIN32__)
458 # define makedev mkdev
459 # endif
460 #elif defined MAJOR_IN_SYSMACROS
461 #include <sys/sysmacros.h>
462 #endif
464 #ifdef MAKEDEV_TAKES_3_ARGS
465 #define MAKEDEV(devmajor,devminor) makedev(0,devmajor,devminor)
466 #else
467 #define MAKEDEV(devmajor,devminor) makedev(devmajor,devminor)
468 #endif
470 #ifdef HAVE_COMPAT_H
471 #include <compat.h>
472 #endif
474 #ifdef HAVE_LIMITS_H
475 # include <limits.h>
476 #endif
478 #if defined USE_ICONV_OPEN && defined HAVE_ICONV_H
479 #include <iconv.h>
480 #ifndef ICONV_CONST
481 #define ICONV_CONST
482 #endif
483 #else
484 #ifdef ICONV_CONST
485 #undef ICONV_CONST
486 #endif
487 #ifdef ICONV_OPTION
488 #undef ICONV_OPTION
489 #endif
490 #ifdef iconv_t
491 #undef iconv_t
492 #endif
493 #define iconv_t int
494 #endif
496 #include <assert.h>
498 #include "lib/pool_alloc.h"
500 #ifndef HAVE_ID_T
501 typedef unsigned int id_t;
502 #endif
503 #ifndef HAVE_PID_T
504 typedef int pid_t;
505 #endif
506 #ifndef HAVE_MODE_T
507 typedef unsigned int mode_t;
508 #endif
509 #ifndef HAVE_OFF_T
510 typedef long off_t;
511 #undef SIZEOF_OFF_T
512 #define SIZEOF_OFF_T SIZEOF_LONG
513 #endif
514 #ifndef HAVE_SIZE_T
515 typedef unsigned int size_t;
516 #endif
518 #define BOOL int
520 #ifndef uchar
521 #define uchar unsigned char
522 #endif
524 #ifdef SIGNED_CHAR_OK
525 #define schar signed char
526 #else
527 #define schar char
528 #endif
530 #ifndef int16
531 #if SIZEOF_INT16_T == 2
532 # define int16 int16_t
533 #else
534 # define int16 short
535 #endif
536 #endif
538 #ifndef uint16
539 #if SIZEOF_UINT16_T == 2
540 # define uint16 uint16_t
541 #else
542 # define uint16 unsigned int16
543 #endif
544 #endif
546 /* Find a variable that is either exactly 32-bits or longer.
547 * If some code depends on 32-bit truncation, it will need to
548 * take special action in a "#if SIZEOF_INT32 > 4" section. */
549 #ifndef int32
550 #if SIZEOF_INT32_T == 4
551 # define int32 int32_t
552 # define SIZEOF_INT32 4
553 #elif SIZEOF_INT == 4
554 # define int32 int
555 # define SIZEOF_INT32 4
556 #elif SIZEOF_LONG == 4
557 # define int32 long
558 # define SIZEOF_INT32 4
559 #elif SIZEOF_SHORT == 4
560 # define int32 short
561 # define SIZEOF_INT32 4
562 #elif SIZEOF_INT > 4
563 # define int32 int
564 # define SIZEOF_INT32 SIZEOF_INT
565 #elif SIZEOF_LONG > 4
566 # define int32 long
567 # define SIZEOF_INT32 SIZEOF_LONG
568 #else
569 # error Could not find a 32-bit integer variable
570 #endif
571 #else
572 # define SIZEOF_INT32 4
573 #endif
575 #ifndef uint32
576 #if SIZEOF_UINT32_T == 4
577 # define uint32 uint32_t
578 #else
579 # define uint32 unsigned int32
580 #endif
581 #endif
583 #if SIZEOF_OFF_T == 8 || !SIZEOF_OFF64_T || !defined HAVE_STRUCT_STAT64
584 #define OFF_T off_t
585 #define STRUCT_STAT struct stat
586 #define SIZEOF_CAPITAL_OFF_T SIZEOF_OFF_T
587 #else
588 #define OFF_T off64_t
589 #define STRUCT_STAT struct stat64
590 #define USE_STAT64_FUNCS 1
591 #define SIZEOF_CAPITAL_OFF_T SIZEOF_OFF64_T
592 #endif
594 /* CAVEAT: on some systems, int64 will really be a 32-bit integer IFF
595 * that's the maximum size the file system can handle and there is no
596 * 64-bit type available. The rsync source must therefore take steps
597 * to ensure that any code that really requires a 64-bit integer has
598 * it (e.g. the checksum code uses two 32-bit integers for its 64-bit
599 * counter). */
600 #if SIZEOF_INT64_T == 8
601 # define int64 int64_t
602 # define SIZEOF_INT64 8
603 #elif SIZEOF_LONG == 8
604 # define int64 long
605 # define SIZEOF_INT64 8
606 #elif SIZEOF_INT == 8
607 # define int64 int
608 # define SIZEOF_INT64 8
609 #elif SIZEOF_LONG_LONG == 8
610 # define int64 long long
611 # define SIZEOF_INT64 8
612 #elif SIZEOF_OFF64_T == 8
613 # define int64 off64_t
614 # define SIZEOF_INT64 8
615 #elif SIZEOF_OFF_T == 8
616 # define int64 off_t
617 # define SIZEOF_INT64 8
618 #elif SIZEOF_INT > 8
619 # define int64 int
620 # define SIZEOF_INT64 SIZEOF_INT
621 #elif SIZEOF_LONG > 8
622 # define int64 long
623 # define SIZEOF_INT64 SIZEOF_LONG
624 #elif SIZEOF_LONG_LONG > 8
625 # define int64 long long
626 # define SIZEOF_INT64 SIZEOF_LONG_LONG
627 #else
628 /* As long as it gets... */
629 # define int64 off_t
630 # define SIZEOF_INT64 SIZEOF_OFF_T
631 #endif
633 struct hashtable {
634 void *nodes;
635 int32 size, entries;
636 uint32 node_size;
637 short key64;
640 struct ht_int32_node {
641 void *data;
642 int32 key;
645 struct ht_int64_node {
646 void *data;
647 int64 key;
650 #define HT_NODE(tbl, bkts, i) ((void*)((char*)(bkts) + (i)*(tbl)->node_size))
651 #define HT_KEY(node, k64) ((k64)? ((struct ht_int64_node*)(node))->key \
652 : (int64)((struct ht_int32_node*)(node))->key)
654 #ifndef MIN
655 #define MIN(a,b) ((a)<(b)?(a):(b))
656 #endif
658 #ifndef MAX
659 #define MAX(a,b) ((a)>(b)?(a):(b))
660 #endif
662 #ifndef MAXHOSTNAMELEN
663 #define MAXHOSTNAMELEN 256
664 #endif
666 #define SUM_LENGTH 16
667 #define SHORT_SUM_LENGTH 2
668 #define BLOCKSUM_BIAS 10
670 #ifndef MAXPATHLEN
671 #define MAXPATHLEN 1024
672 #endif
674 /* We want a roomy line buffer that can hold more than MAXPATHLEN,
675 * and significantly more than an overly short MAXPATHLEN. */
676 #if MAXPATHLEN < 4096
677 #define BIGPATHBUFLEN (4096+1024)
678 #else
679 #define BIGPATHBUFLEN (MAXPATHLEN+1024)
680 #endif
682 #ifndef NAME_MAX
683 #define NAME_MAX 255
684 #endif
686 #ifndef INADDR_NONE
687 #define INADDR_NONE 0xffffffff
688 #endif
690 #ifndef IN_LOOPBACKNET
691 #define IN_LOOPBACKNET 127
692 #endif
694 #if HAVE_UNIXWARE_ACLS|HAVE_SOLARIS_ACLS|HAVE_HPUX_ACLS
695 #define ACLS_NEED_MASK 1
696 #endif
698 #if defined HAVE_FALLOCATE || HAVE_SYS_FALLOCATE
699 #ifdef HAVE_LINUX_FALLOC_H
700 #include <linux/falloc.h>
701 #endif
702 #ifdef FALLOC_FL_KEEP_SIZE
703 #define SUPPORT_PREALLOCATION 1
704 #elif defined HAVE_FTRUNCATE
705 #define SUPPORT_PREALLOCATION 1
706 #define PREALLOCATE_NEEDS_TRUNCATE 1
707 #endif
708 #else /* !fallocate */
709 #if defined HAVE_EFFICIENT_POSIX_FALLOCATE && defined HAVE_FTRUNCATE
710 #define SUPPORT_PREALLOCATION 1
711 #define PREALLOCATE_NEEDS_TRUNCATE 1
712 #endif
713 #endif
715 #if SIZEOF_CHARP == 4
716 # define PTRS_ARE_32 1
717 # define PTR_EXTRA_CNT 1
718 #elif SIZEOF_CHARP == 8
719 # define PTRS_ARE_64 1
720 # define PTR_EXTRA_CNT EXTRA64_CNT
721 #else
722 # error Character pointers are not 4 or 8 bytes.
723 #endif
725 union file_extras {
726 int32 num;
727 uint32 unum;
728 #ifdef PTRS_ARE_32
729 const char* ptr;
730 #endif
733 union file_extras64 {
734 int64 num;
735 #ifdef PTRS_ARE_64
736 const char* ptr;
737 #endif
740 struct file_struct {
741 const char *dirname; /* The dir info inside the transfer */
742 time_t modtime; /* When the item was last modified */
743 uint32 len32; /* Lowest 32 bits of the file's length */
744 uint16 mode; /* The item's type and permissions */
745 uint16 flags; /* The FLAG_* bits for this item */
746 const char basename[1]; /* The basename (AKA filename) follows */
749 extern int file_extra_cnt;
750 extern int inc_recurse;
751 extern int atimes_ndx;
752 extern int pathname_ndx;
753 extern int depth_ndx;
754 extern int uid_ndx;
755 extern int gid_ndx;
756 extern int acls_ndx;
757 extern int xattrs_ndx;
759 #define FILE_STRUCT_LEN (offsetof(struct file_struct, basename))
760 #define EXTRA_LEN (sizeof (union file_extras))
761 #define DEV_EXTRA_CNT 2
762 #define DIRNODE_EXTRA_CNT 3
763 #define EXTRA64_CNT ((sizeof (union file_extras64) + EXTRA_LEN - 1) / EXTRA_LEN)
764 #define SUM_EXTRA_CNT ((MAX_DIGEST_LEN + EXTRA_LEN - 1) / EXTRA_LEN)
766 #define REQ_EXTRA(f,ndx) ((union file_extras*)(f) - (ndx))
767 #define OPT_EXTRA(f,bump) ((union file_extras*)(f) - file_extra_cnt - 1 - (bump))
769 /* These are guaranteed to be allocated first in the array so that they
770 * are aligned for direct int64-pointer access. */
771 #define REQ_EXTRA64(f,ndx) ((union file_extras64*)REQ_EXTRA(f,ndx))
773 #define NSEC_BUMP(f) ((f)->flags & FLAG_MOD_NSEC ? 1 : 0)
774 #define LEN64_BUMP(f) ((f)->flags & FLAG_LENGTH64 ? 1 : 0)
775 #define START_BUMP(f) (NSEC_BUMP(f) + LEN64_BUMP(f))
776 #define HLINK_BUMP(f) ((f)->flags & (FLAG_HLINKED|FLAG_HLINK_DONE) ? inc_recurse+1 : 0)
777 #define ACL_BUMP(f) (acls_ndx ? 1 : 0)
779 /* The length applies to all items. */
780 #if SIZEOF_INT64 < 8
781 #define F_LENGTH(f) ((int64)(f)->len32)
782 #else
783 #define F_HIGH_LEN(f) (OPT_EXTRA(f, NSEC_BUMP(f))->unum)
784 #define F_LENGTH(f) ((int64)(f)->len32 + ((f)->flags & FLAG_LENGTH64 ? (int64)F_HIGH_LEN(f) << 32 : 0))
785 #endif
787 #define F_MOD_NSEC(f) OPT_EXTRA(f, 0)->unum
788 #define F_MOD_NSEC_or_0(f) ((f)->flags & FLAG_MOD_NSEC ? F_MOD_NSEC(f) : 0)
790 /* If there is a symlink string, it is always right after the basename */
791 #define F_SYMLINK(f) ((f)->basename + strlen((f)->basename) + 1)
793 /* The sending side always has this available: */
794 #ifdef PTRS_ARE_32
795 #define F_PATHNAME(f) REQ_EXTRA(f, pathname_ndx)->ptr
796 #else
797 #define F_PATHNAME(f) REQ_EXTRA64(f, pathname_ndx)->ptr
798 #endif
800 /* The receiving side always has this available: */
801 #define F_DEPTH(f) REQ_EXTRA(f, depth_ndx)->num
803 /* When the associated option is on, all entries will have these present: */
804 #define F_OWNER(f) REQ_EXTRA(f, uid_ndx)->unum
805 #define F_GROUP(f) REQ_EXTRA(f, gid_ndx)->unum
806 #define F_ACL(f) REQ_EXTRA(f, acls_ndx)->num
807 #define F_XATTR(f) REQ_EXTRA(f, xattrs_ndx)->num
808 #define F_NDX(f) REQ_EXTRA(f, unsort_ndx)->num
809 #define F_ATIME(f) REQ_EXTRA64(f, atimes_ndx)->num
811 /* These items are per-entry optional: */
812 #define F_HL_GNUM(f) OPT_EXTRA(f, START_BUMP(f))->num /* non-dirs */
813 #define F_HL_PREV(f) OPT_EXTRA(f, START_BUMP(f)+inc_recurse)->num /* non-dirs */
814 #define F_DIR_NODE_P(f) (&OPT_EXTRA(f, START_BUMP(f) \
815 + DIRNODE_EXTRA_CNT - 1)->num) /* sender dirs */
816 #define F_DIR_RELNAMES_P(f) (&OPT_EXTRA(f, START_BUMP(f) + DIRNODE_EXTRA_CNT \
817 + PTR_EXTRA_CNT - 1)->num) /* sender dirs */
818 #define F_DIR_DEFACL(f) OPT_EXTRA(f, START_BUMP(f))->unum /* receiver dirs */
819 #define F_DIR_DEV_P(f) (&OPT_EXTRA(f, START_BUMP(f) + ACL_BUMP(f) \
820 + DEV_EXTRA_CNT - 1)->unum) /* receiver dirs */
822 /* This optional item might follow an F_HL_*() item. */
823 #define F_RDEV_P(f) (&OPT_EXTRA(f, START_BUMP(f) + HLINK_BUMP(f) + DEV_EXTRA_CNT - 1)->unum)
825 /* The sum is only present on regular files. */
826 #define F_SUM(f) ((char*)OPT_EXTRA(f, START_BUMP(f) + HLINK_BUMP(f) \
827 + SUM_EXTRA_CNT - 1))
829 /* Some utility defines: */
830 #define F_IS_ACTIVE(f) (f)->basename[0]
831 #define F_IS_HLINKED(f) ((f)->flags & FLAG_HLINKED)
833 #define F_HLINK_NOT_FIRST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_FIRST)
834 #define F_HLINK_NOT_LAST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_LAST)
836 /* These access the F_DIR_DEV_P() and F_RDEV_P() values: */
837 #define DEV_MAJOR(a) (a)[0]
838 #define DEV_MINOR(a) (a)[1]
840 /* These access the F_DIRS_NODE_P() values: */
841 #define DIR_PARENT(a) (a)[0]
842 #define DIR_FIRST_CHILD(a) (a)[1]
843 #define DIR_NEXT_SIBLING(a) (a)[2]
845 #define IS_MISSING_FILE(statbuf) ((statbuf).st_mode == 0)
848 * Start the flist array at FLIST_START entries and grow it
849 * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
851 #define FLIST_START (32 * 1024)
852 #define FLIST_LINEAR (FLIST_START * 512)
855 * Extent size for allocation pools: A minimum size of 128KB
856 * is needed to mmap them so that freeing will release the
857 * space to the OS.
859 * Larger sizes reduce leftover fragments and speed free calls
860 * (when they happen). Smaller sizes increase the chance of
861 * freed allocations freeing whole extents.
863 #define NORMAL_EXTENT (256 * 1024)
864 #define SMALL_EXTENT (128 * 1024)
866 #define FLIST_TEMP (1<<1)
868 struct file_list {
869 struct file_list *next, *prev;
870 struct file_struct **files, **sorted;
871 alloc_pool_t file_pool;
872 void *pool_boundary;
873 int used, malloced;
874 int low, high; /* 0-relative index values excluding empties */
875 int ndx_start; /* the start offset for inc_recurse mode */
876 int flist_num; /* 1-relative file_list number or 0 */
877 int parent_ndx; /* dir_flist index of parent directory */
878 int in_progress, to_redo;
881 #define SUMFLG_SAME_OFFSET (1<<0)
883 struct sum_buf {
884 OFF_T offset; /**< offset in file of this chunk */
885 int32 len; /**< length of chunk of file */
886 uint32 sum1; /**< simple checksum */
887 int32 chain; /**< next hash-table collision */
888 short flags; /**< flag bits */
889 char sum2[SUM_LENGTH]; /**< checksum */
892 struct sum_struct {
893 OFF_T flength; /**< total file length */
894 struct sum_buf *sums; /**< points to info for each chunk */
895 int32 count; /**< how many chunks */
896 int32 blength; /**< block_length */
897 int32 remainder; /**< flength % block_length */
898 int s2length; /**< sum2_length */
901 struct map_struct {
902 OFF_T file_size; /* File size (from stat) */
903 OFF_T p_offset; /* Window start */
904 OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */
905 char *p; /* Window pointer */
906 int32 p_size; /* Largest window size we allocated */
907 int32 p_len; /* Latest (rounded) window size */
908 int32 def_window_size; /* Default window size */
909 int fd; /* File Descriptor */
910 int status; /* first errno from read errors */
913 #define NAME_IS_FILE (0) /* filter name as a file */
914 #define NAME_IS_DIR (1<<0) /* filter name as a dir */
915 #define NAME_IS_XATTR (1<<2) /* filter name as an xattr */
917 #define FILTRULE_WILD (1<<0) /* pattern has '*', '[', and/or '?' */
918 #define FILTRULE_WILD2 (1<<1) /* pattern has '**' */
919 #define FILTRULE_WILD2_PREFIX (1<<2) /* pattern starts with "**" */
920 #define FILTRULE_WILD3_SUFFIX (1<<3) /* pattern ends with "***" */
921 #define FILTRULE_ABS_PATH (1<<4) /* path-match on absolute path */
922 #define FILTRULE_INCLUDE (1<<5) /* this is an include, not an exclude */
923 #define FILTRULE_DIRECTORY (1<<6) /* this matches only directories */
924 #define FILTRULE_WORD_SPLIT (1<<7) /* split rules on whitespace */
925 #define FILTRULE_NO_INHERIT (1<<8) /* don't inherit these rules */
926 #define FILTRULE_NO_PREFIXES (1<<9) /* parse no prefixes from patterns */
927 #define FILTRULE_MERGE_FILE (1<<10)/* specifies a file to merge */
928 #define FILTRULE_PERDIR_MERGE (1<<11)/* merge-file is searched per-dir */
929 #define FILTRULE_EXCLUDE_SELF (1<<12)/* merge-file name should be excluded */
930 #define FILTRULE_FINISH_SETUP (1<<13)/* per-dir merge file needs setup */
931 #define FILTRULE_NEGATE (1<<14)/* rule matches when pattern does not */
932 #define FILTRULE_CVS_IGNORE (1<<15)/* rule was -C or :C */
933 #define FILTRULE_SENDER_SIDE (1<<16)/* rule applies to the sending side */
934 #define FILTRULE_RECEIVER_SIDE (1<<17)/* rule applies to the receiving side */
935 #define FILTRULE_CLEAR_LIST (1<<18)/* this item is the "!" token */
936 #define FILTRULE_PERISHABLE (1<<19)/* perishable if parent dir goes away */
937 #define FILTRULE_XATTR (1<<20)/* rule only applies to xattr names */
939 #define FILTRULES_SIDES (FILTRULE_SENDER_SIDE | FILTRULE_RECEIVER_SIDE)
941 typedef struct filter_struct {
942 struct filter_struct *next;
943 char *pattern;
944 uint32 rflags;
945 union {
946 int slash_cnt;
947 struct filter_list_struct *mergelist;
948 } u;
949 } filter_rule;
951 typedef struct filter_list_struct {
952 filter_rule *head;
953 filter_rule *tail;
954 char *debug_type;
955 } filter_rule_list;
957 struct stats {
958 int64 total_size;
959 int64 total_transferred_size;
960 int64 total_written;
961 int64 total_read;
962 int64 literal_data;
963 int64 matched_data;
964 int64 flist_buildtime;
965 int64 flist_xfertime;
966 int64 flist_size;
967 int num_files, num_dirs, num_symlinks, num_devices, num_specials;
968 int created_files, created_dirs, created_symlinks, created_devices, created_specials;
969 int deleted_files, deleted_dirs, deleted_symlinks, deleted_devices, deleted_specials;
970 int xferred_files;
973 struct chmod_mode_struct;
975 struct flist_ndx_item {
976 struct flist_ndx_item *next;
977 int ndx;
980 typedef struct {
981 struct flist_ndx_item *head, *tail;
982 } flist_ndx_list;
984 #define EMPTY_ITEM_LIST {NULL, 0, 0}
986 typedef struct {
987 void *items;
988 size_t count;
989 size_t malloced;
990 } item_list;
992 #define EXPAND_ITEM_LIST(lp, type, incr) \
993 (type*)expand_item_list(lp, sizeof (type), #type, incr)
995 #define EMPTY_XBUF {NULL, 0, 0, 0}
997 typedef struct {
998 char *buf;
999 size_t pos; /* pos = read pos in the buf */
1000 size_t len; /* len = chars following pos */
1001 size_t size; /* size = total space in buf */
1002 } xbuf;
1004 #define INIT_XBUF(xb, str, ln, sz) (xb).buf = (str), (xb).len = (ln), (xb).size = (sz), (xb).pos = 0
1005 #define INIT_XBUF_STRLEN(xb, str) (xb).buf = (str), (xb).len = strlen((xb).buf), (xb).size = (size_t)-1, (xb).pos = 0
1006 /* This one is used to make an output xbuf based on a char[] buffer: */
1007 #define INIT_CONST_XBUF(xb, bf) (xb).buf = (bf), (xb).size = sizeof (bf), (xb).len = (xb).pos = 0
1009 #define ICB_EXPAND_OUT (1<<0)
1010 #define ICB_INCLUDE_BAD (1<<1)
1011 #define ICB_INCLUDE_INCOMPLETE (1<<2)
1012 #define ICB_CIRCULAR_OUT (1<<3)
1013 #define ICB_INIT (1<<4)
1015 #define IOBUF_KEEP_BUFS 0
1016 #define IOBUF_FREE_BUFS 1
1018 #define MPLX_SWITCHING IOBUF_KEEP_BUFS
1019 #define MPLX_ALL_DONE IOBUF_FREE_BUFS
1020 #define MPLX_TO_BUFFERED 2
1022 #define RL_EOL_NULLS (1<<0)
1023 #define RL_DUMP_COMMENTS (1<<1)
1024 #define RL_CONVERT (1<<2)
1026 typedef struct {
1027 char name_type;
1028 char fname[1]; /* has variable size */
1029 } relnamecache;
1031 #include "byteorder.h"
1032 #include "lib/mdigest.h"
1033 #include "lib/wildmatch.h"
1034 #include "lib/permstring.h"
1035 #include "lib/addrinfo.h"
1037 #ifndef __GNUC__
1038 #define __attribute__(x)
1039 #else
1040 # if __GNUC__ <= 2
1041 # define NORETURN
1042 # endif
1043 #endif
1045 #define UNUSED(x) x __attribute__((__unused__))
1046 #ifndef NORETURN
1047 #define NORETURN __attribute__((__noreturn__))
1048 #endif
1050 typedef struct {
1051 STRUCT_STAT st;
1052 #ifdef SUPPORT_ACLS
1053 struct rsync_acl *acc_acl; /* access ACL */
1054 struct rsync_acl *def_acl; /* default ACL */
1055 #endif
1056 #ifdef SUPPORT_XATTRS
1057 item_list *xattr;
1058 #endif
1059 } stat_x;
1061 #define ACL_READY(sx) ((sx).acc_acl != NULL)
1062 #define XATTR_READY(sx) ((sx).xattr != NULL)
1064 #include "proto.h"
1066 #ifndef SUPPORT_XATTRS
1067 #define x_stat(fn,fst,xst) do_stat(fn,fst)
1068 #define x_lstat(fn,fst,xst) do_lstat(fn,fst)
1069 #define x_fstat(fd,fst,xst) do_fstat(fd,fst)
1070 #endif
1072 /* We have replacement versions of these if they're missing. */
1073 #ifndef HAVE_ASPRINTF
1074 int asprintf(char **ptr, const char *format, ...);
1075 #endif
1077 #ifndef HAVE_VASPRINTF
1078 int vasprintf(char **ptr, const char *format, va_list ap);
1079 #endif
1081 #if !defined HAVE_VSNPRINTF || !defined HAVE_C99_VSNPRINTF
1082 #define vsnprintf rsync_vsnprintf
1083 int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
1084 #endif
1086 #if !defined HAVE_SNPRINTF || !defined HAVE_C99_VSNPRINTF
1087 #define snprintf rsync_snprintf
1088 int snprintf(char *str, size_t count, const char *fmt,...);
1089 #endif
1092 #ifndef HAVE_STRERROR
1093 extern char *sys_errlist[];
1094 #define strerror(i) sys_errlist[i]
1095 #endif
1097 #ifndef HAVE_STRCHR
1098 # define strchr index
1099 # define strrchr rindex
1100 #endif
1102 #ifndef HAVE_ERRNO_DECL
1103 extern int errno;
1104 #endif
1106 #ifdef HAVE_READLINK
1107 #define SUPPORT_LINKS 1
1108 #if !defined NO_SYMLINK_XATTRS && !defined NO_SYMLINK_USER_XATTRS
1109 #define do_readlink(path, buf, bufsiz) readlink(path, buf, bufsiz)
1110 #endif
1111 #endif
1112 #ifdef HAVE_LINK
1113 #define SUPPORT_HARD_LINKS 1
1114 #endif
1116 #ifdef HAVE_SIGACTION
1117 #define SIGACTION(n,h) sigact.sa_handler=(h), sigaction((n),&sigact,NULL)
1118 #define signal(n,h) we_need_to_call_SIGACTION_not_signal(n,h)
1119 #else
1120 #define SIGACTION(n,h) signal(n,h)
1121 #endif
1123 #ifndef EWOULDBLOCK
1124 #define EWOULDBLOCK EAGAIN
1125 #endif
1127 #ifndef STDIN_FILENO
1128 #define STDIN_FILENO 0
1129 #endif
1131 #ifndef STDOUT_FILENO
1132 #define STDOUT_FILENO 1
1133 #endif
1135 #ifndef STDERR_FILENO
1136 #define STDERR_FILENO 2
1137 #endif
1139 #ifndef S_IRUSR
1140 #define S_IRUSR 0400
1141 #endif
1143 #ifndef S_IWUSR
1144 #define S_IWUSR 0200
1145 #endif
1147 #ifndef ACCESSPERMS
1148 #define ACCESSPERMS 0777
1149 #endif
1151 #ifndef S_ISVTX
1152 #define S_ISVTX 0
1153 #endif
1155 #define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
1157 #ifndef _S_IFMT
1158 #define _S_IFMT 0170000
1159 #endif
1161 #ifndef _S_IFLNK
1162 #define _S_IFLNK 0120000
1163 #endif
1165 #ifndef S_ISLNK
1166 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
1167 #endif
1169 #ifndef S_ISBLK
1170 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
1171 #endif
1173 #ifndef S_ISCHR
1174 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
1175 #endif
1177 #ifndef S_ISSOCK
1178 #ifdef _S_IFSOCK
1179 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
1180 #else
1181 #define S_ISSOCK(mode) (0)
1182 #endif
1183 #endif
1185 #ifndef S_ISFIFO
1186 #ifdef _S_IFIFO
1187 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
1188 #else
1189 #define S_ISFIFO(mode) (0)
1190 #endif
1191 #endif
1193 #ifndef S_ISDIR
1194 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
1195 #endif
1197 #ifndef S_ISREG
1198 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
1199 #endif
1201 /* work out what fcntl flag to use for non-blocking */
1202 #ifdef O_NONBLOCK
1203 # define NONBLOCK_FLAG O_NONBLOCK
1204 #elif defined SYSV
1205 # define NONBLOCK_FLAG O_NDELAY
1206 #else
1207 # define NONBLOCK_FLAG FNDELAY
1208 #endif
1210 #ifndef INADDR_LOOPBACK
1211 #define INADDR_LOOPBACK 0x7f000001
1212 #endif
1214 #ifndef INADDR_NONE
1215 #define INADDR_NONE 0xffffffff
1216 #endif
1218 #define IS_SPECIAL(mode) (S_ISSOCK(mode) || S_ISFIFO(mode))
1219 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode))
1221 #define PRESERVE_FILE_TIMES (1<<0)
1222 #define PRESERVE_DIR_TIMES (1<<1)
1223 #define PRESERVE_LINK_TIMES (1<<2)
1225 /* Initial mask on permissions given to temporary files. Mask off setuid
1226 bits and group access because of potential race-condition security
1227 holes, and mask other access because mode 707 is bizarre */
1228 #define INITACCESSPERMS 0700
1230 /* handler for null strings in printf format */
1231 #define NS(s) ((s)?(s):"<NULL>")
1233 /* Convenient wrappers for malloc and realloc. Use them. */
1234 #define new(type) ((type*)malloc(sizeof (type)))
1235 #define new0(type) ((type*)calloc(1, sizeof (type)))
1236 #define new_array(type, num) ((type*)_new_array((num), sizeof (type), 0))
1237 #define new_array0(type, num) ((type*)_new_array((num), sizeof (type), 1))
1238 #define realloc_array(ptr, type, num) ((type*)_realloc_array((ptr), sizeof(type), (num)))
1240 /* use magic gcc attributes to catch format errors */
1241 void rprintf(enum logcode , const char *, ...)
1242 __attribute__((format (printf, 2, 3)))
1245 /* This is just like rprintf, but it also tries to print some
1246 * representation of the error code. Normally errcode = errno. */
1247 void rsyserr(enum logcode, int, const char *, ...)
1248 __attribute__((format (printf, 3, 4)))
1251 /* Make sure that the O_BINARY flag is defined. */
1252 #ifndef O_BINARY
1253 #define O_BINARY 0
1254 #endif
1256 #ifndef HAVE_STRLCPY
1257 size_t strlcpy(char *d, const char *s, size_t bufsize);
1258 #endif
1260 #ifndef HAVE_STRLCAT
1261 size_t strlcat(char *d, const char *s, size_t bufsize);
1262 #endif
1264 #ifndef WEXITSTATUS
1265 #define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
1266 #endif
1267 #ifndef WIFEXITED
1268 #define WIFEXITED(stat) ((int)((stat)&0xFF) == 0)
1269 #endif
1271 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
1273 #ifdef HAVE_GETEUID
1274 #define MY_UID() geteuid()
1275 #else
1276 #define MY_UID() getuid()
1277 #endif
1279 #ifdef HAVE_GETEGID
1280 #define MY_GID() getegid()
1281 #else
1282 #define MY_GID() getgid()
1283 #endif
1285 #ifdef FORCE_FD_ZERO_MEMSET
1286 #undef FD_ZERO
1287 #define FD_ZERO(fdsetp) memset(fdsetp, 0, sizeof (fd_set))
1288 #endif
1290 extern short info_levels[], debug_levels[];
1292 #define INFO_GTE(flag, lvl) (info_levels[INFO_##flag] >= (lvl))
1293 #define INFO_EQ(flag, lvl) (info_levels[INFO_##flag] == (lvl))
1294 #define DEBUG_GTE(flag, lvl) (debug_levels[DEBUG_##flag] >= (lvl))
1295 #define DEBUG_EQ(flag, lvl) (debug_levels[DEBUG_##flag] == (lvl))
1297 #define INFO_BACKUP 0
1298 #define INFO_COPY (INFO_BACKUP+1)
1299 #define INFO_DEL (INFO_COPY+1)
1300 #define INFO_FLIST (INFO_DEL+1)
1301 #define INFO_MISC (INFO_FLIST+1)
1302 #define INFO_MOUNT (INFO_MISC+1)
1303 #define INFO_NAME (INFO_MOUNT+1)
1304 #define INFO_PROGRESS (INFO_NAME+1)
1305 #define INFO_REMOVE (INFO_PROGRESS+1)
1306 #define INFO_SKIP (INFO_REMOVE+1)
1307 #define INFO_STATS (INFO_SKIP+1)
1308 #define INFO_SYMSAFE (INFO_STATS+1)
1310 #define COUNT_INFO (INFO_SYMSAFE+1)
1312 #define DEBUG_ACL 0
1313 #define DEBUG_BACKUP (DEBUG_ACL+1)
1314 #define DEBUG_BIND (DEBUG_BACKUP+1)
1315 #define DEBUG_CHDIR (DEBUG_BIND+1)
1316 #define DEBUG_CONNECT (DEBUG_CHDIR+1)
1317 #define DEBUG_CMD (DEBUG_CONNECT+1)
1318 #define DEBUG_DEL (DEBUG_CMD+1)
1319 #define DEBUG_DELTASUM (DEBUG_DEL+1)
1320 #define DEBUG_DUP (DEBUG_DELTASUM+1)
1321 #define DEBUG_EXIT (DEBUG_DUP+1)
1322 #define DEBUG_FILTER (DEBUG_EXIT+1)
1323 #define DEBUG_FLIST (DEBUG_FILTER+1)
1324 #define DEBUG_FUZZY (DEBUG_FLIST+1)
1325 #define DEBUG_GENR (DEBUG_FUZZY+1)
1326 #define DEBUG_HASH (DEBUG_GENR+1)
1327 #define DEBUG_HLINK (DEBUG_HASH+1)
1328 #define DEBUG_ICONV (DEBUG_HLINK+1)
1329 #define DEBUG_IO (DEBUG_ICONV+1)
1330 #define DEBUG_OWN (DEBUG_IO+1)
1331 #define DEBUG_PROTO (DEBUG_OWN+1)
1332 #define DEBUG_RECV (DEBUG_PROTO+1)
1333 #define DEBUG_SEND (DEBUG_RECV+1)
1334 #define DEBUG_TIME (DEBUG_SEND+1)
1336 #define COUNT_DEBUG (DEBUG_TIME+1)
1338 #ifndef HAVE_INET_NTOP
1339 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
1340 #endif
1342 #ifndef HAVE_INET_PTON
1343 int inet_pton(int af, const char *src, void *dst);
1344 #endif
1346 #ifndef HAVE_GETPASS
1347 char *getpass(const char *prompt);
1348 #endif
1350 #ifdef MAINTAINER_MODE
1351 const char *get_panic_action(void);
1352 #endif