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