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