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