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