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