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