Added testing of the --itemize-changes output for devices.
[rsync/rsync.git] / rsync.h
CommitLineData
d622d4bf 1/*
a039749b 2 Copyright (C) by Andrew Tridgell 1996, 2000
c627d613 3 Copyright (C) Paul Mackerras 1996
736a6a29 4 Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
d622d4bf 5
c627d613
AT
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
d622d4bf 10
c627d613
AT
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
d622d4bf 15
c627d613
AT
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19*/
20
0de40240 21
d41c7d02
DD
22#define False 0
23#define True 1
24
c627d613
AT
25#define BLOCK_SIZE 700
26#define RSYNC_RSH_ENV "RSYNC_RSH"
8dd99390 27#define RSYNC_RSH_IO_ENV "RSYNC_RSH_IO"
7b8356d0 28
c627d613 29#define RSYNC_NAME "rsync"
cd3fe9fb 30/* RSYNCD_SYSCONF is now set in config.h */
30e8c8e1 31#define RSYNCD_USERCONF "rsyncd.conf"
f0fca04e 32
5e71c444 33#define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
f7632fc6
AT
34#define URL_PREFIX "rsync://"
35
c627d613
AT
36#define BACKUP_SUFFIX "~"
37
1b01b295 38/* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
6543dc0c 39 incompatible with older versions :-( */
1b01b295
AT
40#define CHAR_OFFSET 0
41
a5f9cff2
WD
42/* These flags are only used during the flist transfer. */
43
ec33e0e6 44#define XMIT_TOP_DIR (1<<0)
a5f9cff2
WD
45#define XMIT_SAME_MODE (1<<1)
46#define XMIT_EXTENDED_FLAGS (1<<2)
47#define XMIT_SAME_RDEV_pre28 XMIT_EXTENDED_FLAGS /* Only in protocols < 28 */
48#define XMIT_SAME_UID (1<<3)
49#define XMIT_SAME_GID (1<<4)
50#define XMIT_SAME_NAME (1<<5)
51#define XMIT_LONG_NAME (1<<6)
52#define XMIT_SAME_TIME (1<<7)
af107f6c 53#define XMIT_SAME_RDEV_MAJOR (1<<8)
a5f9cff2
WD
54#define XMIT_HAS_IDEV_DATA (1<<9)
55#define XMIT_SAME_DEV (1<<10)
af107f6c 56#define XMIT_RDEV_MINOR_IS_SMALL (1<<11)
a5f9cff2
WD
57
58/* These flags are used in the live flist data. */
59
ec33e0e6 60#define FLAG_TOP_DIR (1<<0)
5cb31dcf 61#define FLAG_SENT (1<<1) /* sender */
669e7671 62#define FLAG_HLINK_EOL (1<<1) /* receiver/generator */
5cb31dcf 63#define FLAG_MOUNT_POINT (1<<2) /* sender/generator */
ec33e0e6 64#define FLAG_DEL_HERE (1<<3) /* receiver/generator */
669e7671 65#define FLAG_HLINK_TOL (1<<4) /* receiver/generator */
5cb31dcf 66#define FLAG_NO_FUZZY (1<<5) /* generator */
520cf417 67
c627d613 68/* update this if you make incompatible changes */
2b2ea368 69#define PROTOCOL_VERSION 29
063393d6
MP
70
71/* We refuse to interoperate with versions that are not in this range.
72 * Note that we assume we'll work with later versions: the onus is on
73 * people writing them to make sure that they don't send us anything
74 * we won't understand.
75 *
1b2db7ae
S
76 * Interoperation with old but supported protocol versions
77 * should cause a warning to be printed. At a future date
78 * the old protocol will become the minimum and
79 * compatibility code removed.
80 *
91c4da3f
S
81 * There are two possible explanations for the limit at
82 * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
83 * do not interoperate with us, and (more likely) so that we can
84 * detect an attempt to connect rsync to a non-rsync server, which is
85 * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
86 * MAX_PROTOCOL_VERSION. */
87
3e491682
S
88#define MIN_PROTOCOL_VERSION 20
89#define OLD_PROTOCOL_VERSION 25
1b2db7ae 90#define MAX_PROTOCOL_VERSION 40
c627d613 91
9486289c
AT
92#define RSYNC_PORT 873
93
d867229b 94#define SPARSE_WRITE_SIZE (1024)
dc5ddbcc 95#define WRITE_SIZE (32*1024)
34ccb63e 96#define CHUNK_SIZE (32*1024)
61542c41 97#define MAX_MAP_SIZE (256*1024)
e3fe383a 98#define IO_BUFFER_SIZE (4092)
2b2ea368 99#define MAX_BLOCK_SIZE ((int32)1 << 29)
c627d613 100
e2d22fee
WD
101#define IOERR_GENERAL (1<<0) /* For backward compatibility, this must == 1 */
102#define IOERR_VANISHED (1<<1)
ff3d3c32 103#define IOERR_DEL_LIMIT (1<<2)
e2d22fee 104
874895d5 105#define MAX_ARGS 1000
e4977b0b 106#define MAX_BASIS_DIRS 20
c296031d 107#define MAX_SERVER_ARGS (MAX_BASIS_DIRS*2 + 100)
e4977b0b 108
8d9dc9f9 109#define MPLEX_BASE 7
ff41a59f 110
7842418b
WD
111#define NO_FILTERS 0
112#define SERVER_FILTERS 1
113#define ALL_FILTERS 2
4762db4f 114
753b6b46 115#define XFLG_FATAL_ERRORS (1<<0)
3b2461cf
WD
116#define XFLG_OLD_PREFIXES (1<<1)
117#define XFLG_ANCHORED2ABS (1<<2)
699f7024 118#define XFLG_ABS_IF_SLASH (1<<3)
4762db4f 119
38443188
WD
120#define PERMS_REPORT (1<<0)
121#define PERMS_SKIP_MTIME (1<<1)
5c6fc4a6 122
419896af
WD
123#define FULL_FLUSH 1
124#define NORMAL_FLUSH 0
125
a7260c40
WD
126#define PDIR_CREATE 1
127#define PDIR_DELETE 0
128
e341588a
WD
129/* Note: 0x00 - 0x7F are used for basis_dir[] indexes! */
130#define FNAMECMP_BASIS_DIR_LOW 0x00 /* Must remain 0! */
131#define FNAMECMP_BASIS_DIR_HIGH 0x7F
41cfde6b
WD
132#define FNAMECMP_FNAME 0x80
133#define FNAMECMP_PARTIAL_DIR 0x81
134#define FNAMECMP_BACKUP 0x82
0dd046d3 135#define FNAMECMP_FUZZY 0x83
41cfde6b 136
0cc279e0 137/* For use by the itemize_changes code */
0cc279e0
WD
138#define ITEM_REPORT_CHECKSUM (1<<1)
139#define ITEM_REPORT_SIZE (1<<2)
140#define ITEM_REPORT_TIME (1<<3)
141#define ITEM_REPORT_PERMS (1<<4)
142#define ITEM_REPORT_OWNER (1<<5)
143#define ITEM_REPORT_GROUP (1<<6)
6d0e5d2e 144#define ITEM_REPORT_XATTRS (1<<7)
3019a9ba
WD
145#define ITEM_BASIS_TYPE_FOLLOWS (1<<11)
146#define ITEM_XNAME_FOLLOWS (1<<12)
6d0e5d2e
WD
147#define ITEM_IS_NEW (1<<13)
148#define ITEM_LOCAL_CHANGE (1<<14)
149#define ITEM_TRANSFER (1<<15)
d4d4890d 150/* These are outside the range of the transmitted flags. */
d4d4890d
WD
151#define ITEM_MISSING_DATA (1<<16) /* used by log_formatted() */
152#define ITEM_DELETED (1<<17) /* used by log_formatted() */
0cc279e0 153
3019a9ba
WD
154#define SIGNIFICANT_ITEM_FLAGS (~(\
155 ITEM_BASIS_TYPE_FOLLOWS | ITEM_XNAME_FOLLOWS | ITEM_LOCAL_CHANGE))
669e7671 156
df0054ab 157
18e1289f
WD
158/* Log-message categories. Only FERROR and FINFO get sent over the socket.
159 * FLOG and FCLIENT are only used on the daemon side for custom logging,
160 * while FNAME is only used on the client side. */
161enum logcode { FERROR=1, FINFO=2, FLOG=3, FCLIENT=4, FNAME=5 };
419896af
WD
162
163/* Messages types that are sent over the message channel. The logcode
164 * values must all be present here with identical numbers. */
165enum msgcode {
1dcf3b43
WD
166 MSG_DATA=0, /* raw data on the multiplexed stream */
167 MSG_ERROR=FERROR, MSG_INFO=FINFO, /* remote logging */
18e1289f 168 MSG_LOG=FLOG, /* sibling logging */
1dcf3b43
WD
169 MSG_REDO=9, /* reprocess indicated flist index */
170 MSG_SUCCESS=100,/* successfully updated indicated flist index */
171 MSG_DELETED=101,/* successfully deleted a file on receiving side */
172 MSG_DONE=86 /* current phase is done */
419896af 173};
7bec6a5c 174
65417579
AT
175#include "errcode.h"
176
c627d613
AT
177#include "config.h"
178
e3217f14 179/* The default RSYNC_RSH is always set in config.h. */
24d95c03 180
c627d613 181#include <stdio.h>
4f5b0756 182#ifdef HAVE_SYS_TYPES_H
e95538ca
WD
183# include <sys/types.h>
184#endif
4f5b0756 185#ifdef HAVE_SYS_STAT_H
e95538ca
WD
186# include <sys/stat.h>
187#endif
4f5b0756 188#ifdef STDC_HEADERS
e95538ca
WD
189# include <stdlib.h>
190# include <stddef.h>
191#else
4f5b0756 192# ifdef HAVE_STDLIB_H
e95538ca
WD
193# include <stdlib.h>
194# endif
195#endif
4f5b0756
WD
196#ifdef HAVE_STRING_H
197# if !defined STDC_HEADERS && defined HAVE_MEMORY_H
e95538ca
WD
198# include <memory.h>
199# endif
200# include <string.h>
201#endif
4f5b0756 202#ifdef HAVE_STRINGS_H
e95538ca
WD
203# include <strings.h>
204#endif
4f5b0756 205#ifdef HAVE_UNISTD_H
e95538ca 206# include <unistd.h>
c627d613
AT
207#endif
208
4f5b0756 209#ifdef HAVE_SYS_PARAM_H
e95538ca 210#include <sys/param.h>
38b02c13 211#endif
59192f56 212
4f5b0756 213#if defined HAVE_MALLOC_H && (defined HAVE_MALLINFO || !defined HAVE_STDLIB_H)
59192f56 214#include <malloc.h>
d7b305fd
AT
215#endif
216
4f5b0756 217#ifdef HAVE_SYS_SOCKET_H
fdd71e17
AT
218#include <sys/socket.h>
219#endif
220
4f5b0756 221#ifdef TIME_WITH_SYS_TIME
c627d613
AT
222#include <sys/time.h>
223#include <time.h>
224#else
4f5b0756 225#ifdef HAVE_SYS_TIME_H
c627d613
AT
226#include <sys/time.h>
227#else
228#include <time.h>
229#endif
230#endif
231
4f5b0756 232#ifdef HAVE_FCNTL_H
c627d613
AT
233#include <fcntl.h>
234#else
4f5b0756 235#ifdef HAVE_SYS_FCNTL_H
c627d613
AT
236#include <sys/fcntl.h>
237#endif
238#endif
239
4f5b0756 240#ifdef HAVE_SYS_IOCTL_H
94481d91
AT
241#include <sys/ioctl.h>
242#endif
243
4f5b0756 244#ifdef HAVE_SYS_FILIO_H
94481d91
AT
245#include <sys/filio.h>
246#endif
247
c627d613 248#include <signal.h>
4f5b0756 249#ifdef HAVE_SYS_WAIT_H
c627d613
AT
250#include <sys/wait.h>
251#endif
4f5b0756 252#ifdef HAVE_CTYPE_H
c627d613
AT
253#include <ctype.h>
254#endif
4f5b0756 255#ifdef HAVE_GRP_H
c627d613
AT
256#include <grp.h>
257#endif
258#include <errno.h>
259
4f5b0756 260#ifdef HAVE_UTIME_H
c627d613
AT
261#include <utime.h>
262#endif
263
4f5b0756 264#ifdef HAVE_SYS_SELECT_H
8bf73749
AT
265#include <sys/select.h>
266#endif
267
4f5b0756 268#ifdef HAVE_SYS_MODE_H
773f2bd4 269/* apparently AIX needs this for S_ISLNK */
05a6556d 270#ifndef S_ISLNK
773f2bd4
AT
271#include <sys/mode.h>
272#endif
05a6556d 273#endif
773f2bd4 274
4f5b0756 275#ifdef HAVE_GLOB_H
874895d5
AT
276#include <glob.h>
277#endif
278
f6c34742
AT
279/* these are needed for the uid/gid mapping code */
280#include <pwd.h>
281#include <grp.h>
282
9486289c 283#include <stdarg.h>
f0fca04e
AT
284#include <netinet/in.h>
285#include <arpa/inet.h>
286#include <netdb.h>
ff8b29b8 287#include <syslog.h>
6c8f5373 288#include <sys/file.h>
9486289c 289
4f5b0756 290#ifdef HAVE_DIRENT_H
e8f5b936
AT
291# include <dirent.h>
292#else
293# define dirent direct
4f5b0756 294# ifdef HAVE_SYS_NDIR_H
e8f5b936
AT
295# include <sys/ndir.h>
296# endif
4f5b0756 297# ifdef HAVE_SYS_DIR_H
e8f5b936
AT
298# include <sys/dir.h>
299# endif
4f5b0756 300# ifdef HAVE_NDIR_H
e8f5b936
AT
301# include <ndir.h>
302# endif
303#endif
304
4f5b0756 305#ifdef MAJOR_IN_MKDEV
c39d6514 306#include <sys/mkdev.h>
8a33c406 307# if !defined makedev && (defined mkdev || defined _WIN32 || defined __WIN32__)
73496a36
WD
308# define makedev mkdev
309# endif
4f5b0756 310#elif defined MAJOR_IN_SYSMACROS
f8ed564c 311#include <sys/sysmacros.h>
c39d6514
WD
312#endif
313
4f5b0756 314#ifdef HAVE_COMPAT_H
e8f5b936
AT
315#include <compat.h>
316#endif
317
ea8291d8
WD
318#ifdef HAVE_LIMITS_H
319# include <limits.h>
320#endif
321
1bfbf40b
MP
322#include <assert.h>
323
9935066b 324#include "lib/pool_alloc.h"
e8f5b936 325
f0fca04e
AT
326#define BOOL int
327
c627d613
AT
328#ifndef uchar
329#define uchar unsigned char
330#endif
331
4f5b0756 332#ifdef SIGNED_CHAR_OK
debb4505
AT
333#define schar signed char
334#else
335#define schar char
336#endif
337
43d0f38b
WD
338/* Find a variable that is either exactly 32-bits or longer.
339 * If some code depends on 32-bit truncation, it will need to
340 * take special action in a "#if SIZEOF_INT32 > 4" section. */
c627d613 341#ifndef int32
43d0f38b
WD
342#if SIZEOF_INT == 4
343# define int32 int
344# define SIZEOF_INT32 4
345#elif SIZEOF_LONG == 4
346# define int32 long
347# define SIZEOF_INT32 4
348#elif SIZEOF_SHORT == 4
349# define int32 short
350# define SIZEOF_INT32 4
351#elif SIZEOF_INT > 4
352# define int32 int
353# define SIZEOF_INT32 SIZEOF_INT
354#elif SIZEOF_LONG > 4
355# define int32 long
356# define SIZEOF_INT32 SIZEOF_LONG
8de330a3 357#else
43d0f38b 358# error Could not find a 32-bit integer variable
c627d613 359#endif
43d0f38b
WD
360#else
361# define SIZEOF_INT32 4
c627d613
AT
362#endif
363
364#ifndef uint32
365#define uint32 unsigned int32
366#endif
367
0dd046d3 368#if SIZEOF_OFF_T == 8 || !SIZEOF_OFF64_T || !defined HAVE_STRUCT_STAT64
bcacc18b
AT
369#define OFF_T off_t
370#define STRUCT_STAT struct stat
5b5f7e3b
WD
371#else
372#define OFF_T off64_t
373#define STRUCT_STAT struct stat64
374#define USE_STAT64_FUNCS 1
bcacc18b
AT
375#endif
376
d4198823
WD
377/* CAVEAT: on some systems, int64 will really be a 32-bit integer IFF
378 * that's the maximum size the file system can handle and there is no
379 * 64-bit type available. The rsync source must therefore take steps
380 * to ensure that any code that really requires a 64-bit integer has
381 * it (e.g. the checksum code uses two 32-bit integers for its 64-bit
382 * counter). */
d622d4bf
WD
383#if SIZEOF_OFF64_T == 8
384# define int64 off64_t
385# define SIZEOF_INT64 8
386#elif SIZEOF_LONG == 8
387# define int64 long
388# define SIZEOF_INT64 8
389#elif SIZEOF_INT == 8
390# define int64 int
391# define SIZEOF_INT64 8
392#elif SIZEOF_LONG_LONG == 8
393# define int64 long long
394# define SIZEOF_INT64 8
395#elif SIZEOF_OFF_T == 8
396# define int64 off_t
397# define SIZEOF_INT64 8
398#elif SIZEOF_INT > 8
399# define int64 int
400# define SIZEOF_INT64 SIZEOF_INT
401#elif SIZEOF_LONG > 8
402# define int64 long
403# define SIZEOF_INT64 SIZEOF_LONG
404#elif SIZEOF_LONG_LONG > 8
405# define int64 long long
406# define SIZEOF_INT64 SIZEOF_LONG_LONG
71c46176 407#else
736a6a29 408/* As long as it gets... */
d622d4bf
WD
409# define int64 off_t
410# define SIZEOF_INT64 SIZEOF_OFF_T
71c46176 411#endif
c627d613 412
6abd193f
MP
413/* Starting from protocol version 26, we always use 64-bit
414 * ino_t and dev_t internally, even if this platform does not
415 * allow files to have 64-bit inums. That's because the
416 * receiver needs to find duplicate (dev,ino) tuples to detect
417 * hardlinks, and it might have files coming from a platform
418 * that has 64-bit inums.
419 *
420 * The only exception is if we're on a platform with no 64-bit type at
421 * all.
422 *
423 * Because we use read_longint() to get these off the wire, if you
424 * transfer devices or hardlinks with dev or inum > 2**32 to a machine
425 * with no 64-bit types then you will get an overflow error. Probably
426 * not many people have that combination of machines, and you can
427 * avoid it by not preserving hardlinks or not transferring device
428 * nodes. It's not clear that any other behaviour is better.
429 *
430 * Note that if you transfer devices from a 64-bit-devt machine (say,
431 * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the
432 * device numbers will be truncated. But it's a kind of silly thing
433 * to do anyhow.
b9df3bf2 434 *
33a2361c
WD
435 * FIXME: I don't think the code in flist.c has ever worked on a system
436 * where dev_t is a struct.
d622d4bf 437 */
33a2361c
WD
438
439struct idev {
d06f6328
WD
440 int64 inode;
441 int64 dev;
33a2361c 442};
c29ee43d 443
c627d613
AT
444#ifndef MIN
445#define MIN(a,b) ((a)<(b)?(a):(b))
446#endif
447
448#ifndef MAX
449#define MAX(a,b) ((a)>(b)?(a):(b))
450#endif
451
d41c7d02
DD
452#ifndef MAXHOSTNAMELEN
453#define MAXHOSTNAMELEN 256
454#endif
455
c627d613 456/* the length of the md4 checksum */
ebb0a6f6 457#define MD4_SUM_LENGTH 16
c627d613 458#define SUM_LENGTH 16
195bd906
S
459#define SHORT_SUM_LENGTH 2
460#define BLOCKSUM_BIAS 10
c627d613
AT
461
462#ifndef MAXPATHLEN
463#define MAXPATHLEN 1024
464#endif
465
a22ca885
WD
466/* We want a roomy line buffer that can hold more than MAXPATHLEN,
467 * and significantly more than an overly short MAXPATHLEN. */
468#if MAXPATHLEN < 4096
469#define BIGPATHBUFLEN (4096+1024)
470#else
471#define BIGPATHBUFLEN (MAXPATHLEN+1024)
472#endif
473
52d3e106
S
474#ifndef NAME_MAX
475#define NAME_MAX 255
476#endif
477
0473e2a1
AT
478#ifndef INADDR_NONE
479#define INADDR_NONE 0xffffffff
480#endif
481
bda41fa5
WD
482#ifndef IN_LOOPBACKNET
483#define IN_LOOPBACKNET 127
484#endif
485
25bd9945 486#define GID_NONE ((gid_t)-1)
a60e2dca 487
520cf417
WD
488#define HL_CHECK_MASTER 0
489#define HL_SKIP 1
490
88a7fb3e 491struct hlink {
669e7671 492 int next;
2b2ea368 493 int hlindex;
88a7fb3e
WD
494};
495
5e58e3f9
WD
496struct id_pair {
497 uid_t uid;
498 gid_t gid;
499};
500
88a7fb3e
WD
501#define F_DEV link_u.idev->dev
502#define F_INODE link_u.idev->inode
503
520cf417 504#define F_HLINDEX link_u.links->hlindex
fe70ad26
WD
505#define F_NEXT link_u.links->next
506
c627d613 507struct file_struct {
80707c98 508 union {
af107f6c 509 dev_t rdev; /* The device number, if this is a device */
80707c98 510 char *sum; /* Only a normal file can have a checksum */
af107f6c 511 char *link; /* Points to symlink string, if a symlink */
80707c98 512 } u;
0596df00 513 OFF_T length;
f8057304
WD
514 char *basename; /* The current item's name (AKA filename) */
515 char *dirname; /* The directory info inside the transfer */
516 union {
517 char *root; /* Sender-side dir info outside transfer */
518 int depth; /* Receiver-side directory depth info */
519 } dir;
88a7fb3e
WD
520 union {
521 struct idev *idev;
522 struct hlink *links;
523 } link_u;
5e58e3f9 524 struct id_pair *ids;
0596df00 525 time_t modtime;
0596df00 526 mode_t mode;
5009de7d 527 uchar flags; /* this item MUST remain last */
c627d613
AT
528};
529
a85906c7
S
530/*
531 * Start the flist array at FLIST_START entries and grow it
532 * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
533 */
534#define FLIST_START (32 * 1024)
535#define FLIST_LINEAR (FLIST_START * 512)
b96efc2f 536
9935066b
S
537/*
538 * Extent size for allocation pools A minimum size of 128KB
539 * is needed to mmap them so that freeing will release the
540 * space to the OS.
541 *
542 * Larger sizes reduce leftover fragments and speed free calls
543 * (when they happen) Smaller sizes increase the chance of
544 * freed allocations freeing whole extents.
545 */
9935066b
S
546#define FILE_EXTENT (256 * 1024)
547#define HLINK_EXTENT (128 * 1024)
548
549#define WITH_HLINK 1
550#define WITHOUT_HLINK 0
3d382777 551
c627d613 552struct file_list {
2b2ea368 553 struct file_struct **files;
9935066b
S
554 alloc_pool_t file_pool;
555 alloc_pool_t hlink_pool;
2b2ea368
WD
556 int count;
557 int malloced;
f8057304 558 int low, high;
c627d613
AT
559};
560
a3221d2a
WD
561#define SUMFLG_SAME_OFFSET (1<<0)
562
c627d613 563struct sum_buf {
6ded1170 564 OFF_T offset; /**< offset in file of this chunk */
a06b419d 565 int32 len; /**< length of chunk of file */
6ded1170 566 uint32 sum1; /**< simple checksum */
a3221d2a 567 short flags; /**< flag bits */
6ded1170 568 char sum2[SUM_LENGTH]; /**< checksum */
c627d613
AT
569};
570
571struct sum_struct {
6ded1170 572 OFF_T flength; /**< total file length */
2b2ea368 573 struct sum_buf *sums; /**< points to info for each chunk */
15859584 574 int32 count; /**< how many chunks */
a06b419d
WD
575 int32 blength; /**< block_length */
576 int32 remainder; /**< flength % block_length */
da9d12f5 577 int s2length; /**< sum2_length */
c627d613
AT
578};
579
c6e7fcb4 580struct map_struct {
6a7cc46c
S
581 OFF_T file_size; /* File size (from stat) */
582 OFF_T p_offset; /* Window start */
583 OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */
2b2ea368
WD
584 char *p; /* Window pointer */
585 int32 p_size; /* Largest window size we allocated */
586 int32 p_len; /* Latest (rounded) window size */
587 int32 def_window_size; /* Default window size */
588 int fd; /* File Descriptor */
589 int status; /* first errno from read errors */
c6e7fcb4 590};
c627d613 591
e2d22fee
WD
592#define MATCHFLG_WILD (1<<0) /* pattern has '*', '[', and/or '?' */
593#define MATCHFLG_WILD2 (1<<1) /* pattern has '**' */
685517ab
WD
594#define MATCHFLG_WILD2_PREFIX (1<<2) /* pattern starts with "**" */
595#define MATCHFLG_WILD3_SUFFIX (1<<3) /* pattern ends with "***" */
596#define MATCHFLG_ABS_PATH (1<<4) /* path-match on absolute path */
597#define MATCHFLG_INCLUDE (1<<5) /* this is an include, not an exclude */
598#define MATCHFLG_DIRECTORY (1<<6) /* this matches only directories */
46fa6025
WD
599#define MATCHFLG_WORD_SPLIT (1<<7) /* split rules on whitespace */
600#define MATCHFLG_NO_INHERIT (1<<8) /* don't inherit these rules */
601#define MATCHFLG_NO_PREFIXES (1<<9) /* parse no prefixes from patterns */
602#define MATCHFLG_MERGE_FILE (1<<10)/* specifies a file to merge */
603#define MATCHFLG_PERDIR_MERGE (1<<11)/* merge-file is searched per-dir */
604#define MATCHFLG_EXCLUDE_SELF (1<<12)/* merge-file name should be excluded */
605#define MATCHFLG_FINISH_SETUP (1<<13)/* per-dir merge file needs setup */
53b417e4
WD
606#define MATCHFLG_NEGATE (1<<14)/* rule matches when pattern does not */
607#define MATCHFLG_CVS_IGNORE (1<<15)/* rule was -C or :C */
a427e893
WD
608#define MATCHFLG_SENDER_SIDE (1<<16)/* rule applies to the sending side */
609#define MATCHFLG_RECEIVER_SIDE (1<<17)/* rule applies to the receiving side */
685517ab 610#define MATCHFLG_CLEAR_LIST (1<<18)/* this item is the "!" token */
7c8e23bd 611
3b2461cf 612#define MATCHFLGS_FROM_CONTAINER (MATCHFLG_ABS_PATH | MATCHFLG_INCLUDE \
a427e893
WD
613 | MATCHFLG_DIRECTORY | MATCHFLG_SENDER_SIDE \
614 | MATCHFLG_NEGATE | MATCHFLG_RECEIVER_SIDE)
3b2461cf 615
7842418b
WD
616struct filter_struct {
617 struct filter_struct *next;
2b6b4d53 618 char *pattern;
53b417e4 619 uint32 match_flags;
46fa6025
WD
620 union {
621 int slash_cnt;
7842418b 622 struct filter_list_struct *mergelist;
46fa6025 623 } u;
2b6b4d53
AT
624};
625
7842418b
WD
626struct filter_list_struct {
627 struct filter_struct *head;
628 struct filter_struct *tail;
ac1d2d33 629 char *debug_type;
63d03319
WD
630};
631
a800434a
AT
632struct stats {
633 int64 total_size;
634 int64 total_transferred_size;
635 int64 total_written;
636 int64 total_read;
637 int64 literal_data;
638 int64 matched_data;
d4198823
WD
639 int64 flist_buildtime;
640 int64 flist_xfertime;
a800434a
AT
641 int flist_size;
642 int num_files;
643 int num_transferred_files;
dc8293ff 644 int current_file_index;
a800434a
AT
645};
646
2b6b4d53 647
c627d613 648#include "byteorder.h"
8de330a3 649#include "lib/mdfour.h"
87f18b62 650#include "lib/wildmatch.h"
740819ef 651#include "lib/permstring.h"
e20a4f84 652#include "lib/addrinfo.h"
0de40240 653
58c29609
MP
654#include "proto.h"
655
0de40240 656/* We have replacement versions of these if they're missing. */
4f5b0756 657#ifndef HAVE_ASPRINTF
0de40240
MP
658int asprintf(char **ptr, const char *format, ...);
659#endif
660
4f5b0756 661#ifndef HAVE_VASPRINTF
0de40240
MP
662int vasprintf(char **ptr, const char *format, va_list ap);
663#endif
664
4f5b0756 665#if !defined HAVE_VSNPRINTF || !defined HAVE_C99_VSNPRINTF
6813fa7e
WD
666#define vsnprintf rsync_vsnprintf
667int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
0de40240
MP
668#endif
669
4f5b0756 670#if !defined HAVE_SNPRINTF || !defined HAVE_C99_VSNPRINTF
6813fa7e 671#define snprintf rsync_snprintf
0de40240
MP
672int snprintf(char *str,size_t count,const char *fmt,...);
673#endif
674
675
4f5b0756 676#ifndef HAVE_STRERROR
c627d613
AT
677extern char *sys_errlist[];
678#define strerror(i) sys_errlist[i]
679#endif
680
4f5b0756 681#ifndef HAVE_STRCHR
c627d613
AT
682# define strchr index
683# define strrchr rindex
684#endif
685
4f5b0756 686#ifndef HAVE_ERRNO_DECL
c627d613
AT
687extern int errno;
688#endif
689
9a929c8f
WD
690#ifdef HAVE_READLINK
691#define SUPPORT_LINKS 1
692#endif
693#ifdef HAVE_LINK
694#define SUPPORT_HARD_LINKS 1
695#endif
c627d613 696
ac1eb754 697#define SIGNAL_CAST (RETSIGTYPE (*)())
720b47f2
AT
698
699#ifndef EWOULDBLOCK
700#define EWOULDBLOCK EAGAIN
701#endif
182dca5c 702
7b8356d0
AT
703#ifndef STDIN_FILENO
704#define STDIN_FILENO 0
705#endif
706
707#ifndef STDOUT_FILENO
708#define STDOUT_FILENO 1
709#endif
710
711#ifndef STDERR_FILENO
712#define STDERR_FILENO 2
713#endif
714
8120a98f
WD
715#ifndef S_IRUSR
716#define S_IRUSR 0400
717#endif
718
7b8356d0
AT
719#ifndef S_IWUSR
720#define S_IWUSR 0200
721#endif
722
b0d791bb
PG
723#ifndef ACCESSPERMS
724#define ACCESSPERMS 0777
725#endif
726
727#ifndef S_ISVTX
728#define S_ISVTX 0
729#endif
730
731#define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
732
b280a1f4
AT
733#ifndef _S_IFMT
734#define _S_IFMT 0170000
735#endif
736
737#ifndef _S_IFLNK
738#define _S_IFLNK 0120000
739#endif
740
741#ifndef S_ISLNK
742#define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
743#endif
744
1e9f155a
AT
745#ifndef S_ISBLK
746#define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
747#endif
748
749#ifndef S_ISCHR
750#define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
751#endif
752
a0b65b18
AT
753#ifndef S_ISSOCK
754#ifdef _S_IFSOCK
755#define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
756#else
757#define S_ISSOCK(mode) (0)
758#endif
759#endif
760
761#ifndef S_ISFIFO
762#ifdef _S_IFIFO
763#define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
764#else
765#define S_ISFIFO(mode) (0)
766#endif
767#endif
768
1e9f155a
AT
769#ifndef S_ISDIR
770#define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
771#endif
772
773#ifndef S_ISREG
774#define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
775#endif
776
f0359dd0
AT
777/* work out what fcntl flag to use for non-blocking */
778#ifdef O_NONBLOCK
779# define NONBLOCK_FLAG O_NONBLOCK
4f5b0756 780#elif defined SYSV
f0359dd0 781# define NONBLOCK_FLAG O_NDELAY
d622d4bf 782#else
f0359dd0
AT
783# define NONBLOCK_FLAG FNDELAY
784#endif
785
d79c77ca
MP
786#ifndef INADDR_LOOPBACK
787#define INADDR_LOOPBACK 0x7f000001
788#endif
789
790#ifndef INADDR_NONE
791#define INADDR_NONE 0xffffffff
792#endif
a0b65b18
AT
793
794#define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
7bec6a5c 795
5afd8aed
DD
796/* Initial mask on permissions given to temporary files. Mask off setuid
797 bits and group access because of potential race-condition security
798 holes, and mask other access because mode 707 is bizarre */
972a3619 799#define INITACCESSPERMS 0700
e08bfe12
AT
800
801/* handler for null strings in printf format */
0ee6ca98 802#define NS(s) ((s)?(s):"<NULL>")
e08bfe12 803
96a8ca6d 804#if !defined __GNUC__ || defined __APPLE__
999dfffc
MP
805/* Apparently the OS X port of gcc gags on __attribute__.
806 *
807 * <http://www.opensource.apple.com/bugs/X/gcc/2512150.html> */
d622d4bf 808#define __attribute__(x)
fb859e56
MP
809
810#endif
811
58cadc86
WD
812/* Convenient wrappers for malloc and realloc. Use them. */
813#define new(type) ((type *)malloc(sizeof(type)))
814#define new_array(type, num) ((type *)_new_array(sizeof(type), (num)))
815#define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num)))
fb859e56 816
e08bfe12 817/* use magic gcc attributes to catch format errors */
ff41a59f 818 void rprintf(enum logcode , const char *, ...)
fb859e56 819 __attribute__((format (printf, 2, 3)))
e08bfe12 820;
7b3d4257 821
a039749b
MP
822/* This is just like rprintf, but it also tries to print some
823 * representation of the error code. Normally errcode = errno. */
824void rsyserr(enum logcode, int, const char *, ...)
fb859e56 825 __attribute__((format (printf, 3, 4)))
a039749b
MP
826 ;
827
4f5b0756 828#ifdef REPLACE_INET_NTOA
7b3d4257
AT
829#define inet_ntoa rep_inet_ntoa
830#endif
5a788ade 831
afbcc8f2
WD
832/* Make sure that the O_BINARY flag is defined. */
833#ifndef O_BINARY
834#define O_BINARY 0
835#endif
5a788ade 836
4f5b0756 837#ifndef HAVE_STRLCPY
5a788ade
AT
838size_t strlcpy(char *d, const char *s, size_t bufsize);
839#endif
840
4f5b0756 841#ifndef HAVE_STRLCAT
5a788ade
AT
842size_t strlcat(char *d, const char *s, size_t bufsize);
843#endif
844
82980a23
AT
845#ifndef WEXITSTATUS
846#define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
847#endif
848
a9766ef1 849#define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
eecd22ff 850
4f5b0756 851#ifdef HAVE_GETEUID
b2bffbb2
WD
852#define MY_UID() geteuid()
853#else
854#define MY_UID() getuid()
855#endif
856
4f5b0756 857#ifdef HAVE_GETEGID
b2bffbb2
WD
858#define MY_GID() getegid()
859#else
860#define MY_GID() getgid()
861#endif
eecd22ff
MP
862
863extern int verbose;
d5d4b282 864
4f5b0756 865#ifndef HAVE_INET_NTOP
d622d4bf 866const char *inet_ntop(int af, const void *src, char *dst, size_t size);
4f5b0756 867#endif
8f694072 868
4f5b0756 869#ifndef HAVE_INET_PTON
bda41fa5 870int inet_pton(int af, const char *src, void *dst);
8f694072 871#endif
0f0ea7f7 872
f4a0483a
MP
873#ifdef MAINTAINER_MODE
874const char *get_panic_action(void);
875#endif
876
fb859e56 877#define UNUSED(x) x __attribute__((__unused__))
eca2adb4 878
c80b3d8c 879extern const char *io_write_phase, *io_read_phase;