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