Go ahead and define upcoming ITEM_REPORT_* defines now.
[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
8eda7a4b
WD
120#define ATTRS_REPORT (1<<0)
121#define ATTRS_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)
06407101
WD
144#define ITEM_REPORT_ATIME (1<<7)
145#define ITEM_REPORT_ACL (1<<8)
146#define ITEM_REPORT_XATTR (1<<9)
3019a9ba
WD
147#define ITEM_BASIS_TYPE_FOLLOWS (1<<11)
148#define ITEM_XNAME_FOLLOWS (1<<12)
6d0e5d2e
WD
149#define ITEM_IS_NEW (1<<13)
150#define ITEM_LOCAL_CHANGE (1<<14)
151#define ITEM_TRANSFER (1<<15)
d4d4890d 152/* These are outside the range of the transmitted flags. */
d4d4890d
WD
153#define ITEM_MISSING_DATA (1<<16) /* used by log_formatted() */
154#define ITEM_DELETED (1<<17) /* used by log_formatted() */
0cc279e0 155
3019a9ba
WD
156#define SIGNIFICANT_ITEM_FLAGS (~(\
157 ITEM_BASIS_TYPE_FOLLOWS | ITEM_XNAME_FOLLOWS | ITEM_LOCAL_CHANGE))
669e7671 158
df0054ab 159
18e1289f
WD
160/* Log-message categories. Only FERROR and FINFO get sent over the socket.
161 * FLOG and FCLIENT are only used on the daemon side for custom logging,
162 * while FNAME is only used on the client side. */
ea26c854 163enum logcode { FERROR=1, FINFO=2, FLOG=3, FCLIENT=4, FNAME=5, FSOCKERR=6 };
419896af
WD
164
165/* Messages types that are sent over the message channel. The logcode
166 * values must all be present here with identical numbers. */
167enum msgcode {
1dcf3b43
WD
168 MSG_DATA=0, /* raw data on the multiplexed stream */
169 MSG_ERROR=FERROR, MSG_INFO=FINFO, /* remote logging */
ea26c854 170 MSG_LOG=FLOG, MSG_SOCKERR=FSOCKERR, /* sibling logging */
1dcf3b43
WD
171 MSG_REDO=9, /* reprocess indicated flist index */
172 MSG_SUCCESS=100,/* successfully updated indicated flist index */
173 MSG_DELETED=101,/* successfully deleted a file on receiving side */
174 MSG_DONE=86 /* current phase is done */
419896af 175};
7bec6a5c 176
65417579
AT
177#include "errcode.h"
178
c627d613
AT
179#include "config.h"
180
e3217f14 181/* The default RSYNC_RSH is always set in config.h. */
24d95c03 182
c627d613 183#include <stdio.h>
4f5b0756 184#ifdef HAVE_SYS_TYPES_H
e95538ca
WD
185# include <sys/types.h>
186#endif
4f5b0756 187#ifdef HAVE_SYS_STAT_H
e95538ca
WD
188# include <sys/stat.h>
189#endif
4f5b0756 190#ifdef STDC_HEADERS
e95538ca
WD
191# include <stdlib.h>
192# include <stddef.h>
193#else
4f5b0756 194# ifdef HAVE_STDLIB_H
e95538ca
WD
195# include <stdlib.h>
196# endif
197#endif
4f5b0756
WD
198#ifdef HAVE_STRING_H
199# if !defined STDC_HEADERS && defined HAVE_MEMORY_H
e95538ca
WD
200# include <memory.h>
201# endif
202# include <string.h>
203#endif
4f5b0756 204#ifdef HAVE_STRINGS_H
e95538ca
WD
205# include <strings.h>
206#endif
4f5b0756 207#ifdef HAVE_UNISTD_H
e95538ca 208# include <unistd.h>
c627d613
AT
209#endif
210
4f5b0756 211#ifdef HAVE_SYS_PARAM_H
e95538ca 212#include <sys/param.h>
38b02c13 213#endif
59192f56 214
4f5b0756 215#if defined HAVE_MALLOC_H && (defined HAVE_MALLINFO || !defined HAVE_STDLIB_H)
59192f56 216#include <malloc.h>
d7b305fd
AT
217#endif
218
4f5b0756 219#ifdef HAVE_SYS_SOCKET_H
fdd71e17
AT
220#include <sys/socket.h>
221#endif
222
4f5b0756 223#ifdef TIME_WITH_SYS_TIME
c627d613
AT
224#include <sys/time.h>
225#include <time.h>
226#else
4f5b0756 227#ifdef HAVE_SYS_TIME_H
c627d613
AT
228#include <sys/time.h>
229#else
230#include <time.h>
231#endif
232#endif
233
4f5b0756 234#ifdef HAVE_FCNTL_H
c627d613
AT
235#include <fcntl.h>
236#else
4f5b0756 237#ifdef HAVE_SYS_FCNTL_H
c627d613
AT
238#include <sys/fcntl.h>
239#endif
240#endif
241
4f5b0756 242#ifdef HAVE_SYS_IOCTL_H
94481d91
AT
243#include <sys/ioctl.h>
244#endif
245
4f5b0756 246#ifdef HAVE_SYS_FILIO_H
94481d91
AT
247#include <sys/filio.h>
248#endif
249
c627d613 250#include <signal.h>
4f5b0756 251#ifdef HAVE_SYS_WAIT_H
c627d613
AT
252#include <sys/wait.h>
253#endif
4f5b0756 254#ifdef HAVE_CTYPE_H
c627d613
AT
255#include <ctype.h>
256#endif
4f5b0756 257#ifdef HAVE_GRP_H
c627d613
AT
258#include <grp.h>
259#endif
260#include <errno.h>
261
4f5b0756 262#ifdef HAVE_UTIME_H
c627d613
AT
263#include <utime.h>
264#endif
265
4f5b0756 266#ifdef HAVE_SYS_SELECT_H
8bf73749
AT
267#include <sys/select.h>
268#endif
269
4f5b0756 270#ifdef HAVE_SYS_MODE_H
773f2bd4 271/* apparently AIX needs this for S_ISLNK */
05a6556d 272#ifndef S_ISLNK
773f2bd4
AT
273#include <sys/mode.h>
274#endif
05a6556d 275#endif
773f2bd4 276
4f5b0756 277#ifdef HAVE_GLOB_H
874895d5
AT
278#include <glob.h>
279#endif
280
f6c34742
AT
281/* these are needed for the uid/gid mapping code */
282#include <pwd.h>
283#include <grp.h>
284
9486289c 285#include <stdarg.h>
f0fca04e
AT
286#include <netinet/in.h>
287#include <arpa/inet.h>
288#include <netdb.h>
ff8b29b8 289#include <syslog.h>
6c8f5373 290#include <sys/file.h>
9486289c 291
4f5b0756 292#ifdef HAVE_DIRENT_H
e8f5b936
AT
293# include <dirent.h>
294#else
295# define dirent direct
4f5b0756 296# ifdef HAVE_SYS_NDIR_H
e8f5b936
AT
297# include <sys/ndir.h>
298# endif
4f5b0756 299# ifdef HAVE_SYS_DIR_H
e8f5b936
AT
300# include <sys/dir.h>
301# endif
4f5b0756 302# ifdef HAVE_NDIR_H
e8f5b936
AT
303# include <ndir.h>
304# endif
305#endif
306
4f5b0756 307#ifdef MAJOR_IN_MKDEV
c39d6514 308#include <sys/mkdev.h>
8a33c406 309# if !defined makedev && (defined mkdev || defined _WIN32 || defined __WIN32__)
73496a36
WD
310# define makedev mkdev
311# endif
4f5b0756 312#elif defined MAJOR_IN_SYSMACROS
f8ed564c 313#include <sys/sysmacros.h>
c39d6514
WD
314#endif
315
4f5b0756 316#ifdef HAVE_COMPAT_H
e8f5b936
AT
317#include <compat.h>
318#endif
319
ea8291d8
WD
320#ifdef HAVE_LIMITS_H
321# include <limits.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
a22ca885
WD
468/* We want a roomy line buffer that can hold more than MAXPATHLEN,
469 * and significantly more than an overly short MAXPATHLEN. */
470#if MAXPATHLEN < 4096
471#define BIGPATHBUFLEN (4096+1024)
472#else
473#define BIGPATHBUFLEN (MAXPATHLEN+1024)
474#endif
475
52d3e106
S
476#ifndef NAME_MAX
477#define NAME_MAX 255
478#endif
479
0473e2a1
AT
480#ifndef INADDR_NONE
481#define INADDR_NONE 0xffffffff
482#endif
483
bda41fa5
WD
484#ifndef IN_LOOPBACKNET
485#define IN_LOOPBACKNET 127
486#endif
487
25bd9945 488#define GID_NONE ((gid_t)-1)
a60e2dca 489
520cf417
WD
490#define HL_CHECK_MASTER 0
491#define HL_SKIP 1
492
88a7fb3e 493struct hlink {
669e7671 494 int next;
2b2ea368 495 int hlindex;
88a7fb3e
WD
496};
497
88a7fb3e
WD
498#define F_DEV link_u.idev->dev
499#define F_INODE link_u.idev->inode
500
520cf417 501#define F_HLINDEX link_u.links->hlindex
fe70ad26
WD
502#define F_NEXT link_u.links->next
503
c627d613 504struct file_struct {
80707c98 505 union {
af107f6c 506 dev_t rdev; /* The device number, if this is a device */
80707c98 507 char *sum; /* Only a normal file can have a checksum */
af107f6c 508 char *link; /* Points to symlink string, if a symlink */
80707c98 509 } u;
0596df00 510 OFF_T length;
f8057304
WD
511 char *basename; /* The current item's name (AKA filename) */
512 char *dirname; /* The directory info inside the transfer */
513 union {
514 char *root; /* Sender-side dir info outside transfer */
515 int depth; /* Receiver-side directory depth info */
516 } dir;
88a7fb3e
WD
517 union {
518 struct idev *idev;
519 struct hlink *links;
520 } link_u;
0596df00 521 time_t modtime;
7b6fa00f
WD
522 uid_t uid;
523 gid_t gid;
fc2dd77e 524 mode_t mode;
5009de7d 525 uchar flags; /* this item MUST remain last */
c627d613
AT
526};
527
a85906c7
S
528/*
529 * Start the flist array at FLIST_START entries and grow it
530 * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
531 */
532#define FLIST_START (32 * 1024)
533#define FLIST_LINEAR (FLIST_START * 512)
b96efc2f 534
9935066b
S
535/*
536 * Extent size for allocation pools A minimum size of 128KB
537 * is needed to mmap them so that freeing will release the
538 * space to the OS.
539 *
540 * Larger sizes reduce leftover fragments and speed free calls
541 * (when they happen) Smaller sizes increase the chance of
542 * freed allocations freeing whole extents.
543 */
9935066b
S
544#define FILE_EXTENT (256 * 1024)
545#define HLINK_EXTENT (128 * 1024)
546
547#define WITH_HLINK 1
548#define WITHOUT_HLINK 0
3d382777 549
c627d613 550struct file_list {
2b2ea368 551 struct file_struct **files;
9935066b
S
552 alloc_pool_t file_pool;
553 alloc_pool_t hlink_pool;
2b2ea368
WD
554 int count;
555 int malloced;
f8057304 556 int low, high;
c627d613
AT
557};
558
a3221d2a
WD
559#define SUMFLG_SAME_OFFSET (1<<0)
560
c627d613 561struct sum_buf {
6ded1170 562 OFF_T offset; /**< offset in file of this chunk */
a06b419d 563 int32 len; /**< length of chunk of file */
6ded1170 564 uint32 sum1; /**< simple checksum */
d733de97 565 int32 chain; /**< next hash-table collision */
a3221d2a 566 short flags; /**< flag bits */
6ded1170 567 char sum2[SUM_LENGTH]; /**< checksum */
c627d613
AT
568};
569
570struct sum_struct {
6ded1170 571 OFF_T flength; /**< total file length */
2b2ea368 572 struct sum_buf *sums; /**< points to info for each chunk */
15859584 573 int32 count; /**< how many chunks */
a06b419d
WD
574 int32 blength; /**< block_length */
575 int32 remainder; /**< flength % block_length */
da9d12f5 576 int s2length; /**< sum2_length */
c627d613
AT
577};
578
c6e7fcb4 579struct map_struct {
6a7cc46c
S
580 OFF_T file_size; /* File size (from stat) */
581 OFF_T p_offset; /* Window start */
582 OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */
2b2ea368
WD
583 char *p; /* Window pointer */
584 int32 p_size; /* Largest window size we allocated */
585 int32 p_len; /* Latest (rounded) window size */
586 int32 def_window_size; /* Default window size */
587 int fd; /* File Descriptor */
588 int status; /* first errno from read errors */
c6e7fcb4 589};
c627d613 590
e2d22fee
WD
591#define MATCHFLG_WILD (1<<0) /* pattern has '*', '[', and/or '?' */
592#define MATCHFLG_WILD2 (1<<1) /* pattern has '**' */
685517ab
WD
593#define MATCHFLG_WILD2_PREFIX (1<<2) /* pattern starts with "**" */
594#define MATCHFLG_WILD3_SUFFIX (1<<3) /* pattern ends with "***" */
595#define MATCHFLG_ABS_PATH (1<<4) /* path-match on absolute path */
596#define MATCHFLG_INCLUDE (1<<5) /* this is an include, not an exclude */
597#define MATCHFLG_DIRECTORY (1<<6) /* this matches only directories */
46fa6025
WD
598#define MATCHFLG_WORD_SPLIT (1<<7) /* split rules on whitespace */
599#define MATCHFLG_NO_INHERIT (1<<8) /* don't inherit these rules */
600#define MATCHFLG_NO_PREFIXES (1<<9) /* parse no prefixes from patterns */
601#define MATCHFLG_MERGE_FILE (1<<10)/* specifies a file to merge */
602#define MATCHFLG_PERDIR_MERGE (1<<11)/* merge-file is searched per-dir */
603#define MATCHFLG_EXCLUDE_SELF (1<<12)/* merge-file name should be excluded */
604#define MATCHFLG_FINISH_SETUP (1<<13)/* per-dir merge file needs setup */
53b417e4
WD
605#define MATCHFLG_NEGATE (1<<14)/* rule matches when pattern does not */
606#define MATCHFLG_CVS_IGNORE (1<<15)/* rule was -C or :C */
a427e893
WD
607#define MATCHFLG_SENDER_SIDE (1<<16)/* rule applies to the sending side */
608#define MATCHFLG_RECEIVER_SIDE (1<<17)/* rule applies to the receiving side */
685517ab 609#define MATCHFLG_CLEAR_LIST (1<<18)/* this item is the "!" token */
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
f7bce90c 646struct chmod_mode_struct;
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
4ea58045
WD
654#if !defined __GNUC__ || defined __APPLE__
655/* Apparently the OS X port of gcc gags on __attribute__.
656 *
657 * <http://www.opensource.apple.com/bugs/X/gcc/2512150.html> */
658#define __attribute__(x)
659#endif
660
90b13cf6
WD
661#define UNUSED(x) x __attribute__((__unused__))
662
58c29609
MP
663#include "proto.h"
664
0de40240 665/* We have replacement versions of these if they're missing. */
4f5b0756 666#ifndef HAVE_ASPRINTF
0de40240
MP
667int asprintf(char **ptr, const char *format, ...);
668#endif
669
4f5b0756 670#ifndef HAVE_VASPRINTF
0de40240
MP
671int vasprintf(char **ptr, const char *format, va_list ap);
672#endif
673
4f5b0756 674#if !defined HAVE_VSNPRINTF || !defined HAVE_C99_VSNPRINTF
6813fa7e
WD
675#define vsnprintf rsync_vsnprintf
676int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
0de40240
MP
677#endif
678
4f5b0756 679#if !defined HAVE_SNPRINTF || !defined HAVE_C99_VSNPRINTF
6813fa7e 680#define snprintf rsync_snprintf
0de40240
MP
681int snprintf(char *str,size_t count,const char *fmt,...);
682#endif
683
684
4f5b0756 685#ifndef HAVE_STRERROR
c627d613
AT
686extern char *sys_errlist[];
687#define strerror(i) sys_errlist[i]
688#endif
689
4f5b0756 690#ifndef HAVE_STRCHR
c627d613
AT
691# define strchr index
692# define strrchr rindex
693#endif
694
4f5b0756 695#ifndef HAVE_ERRNO_DECL
c627d613
AT
696extern int errno;
697#endif
698
9a929c8f
WD
699#ifdef HAVE_READLINK
700#define SUPPORT_LINKS 1
701#endif
702#ifdef HAVE_LINK
703#define SUPPORT_HARD_LINKS 1
704#endif
c627d613 705
5173f99e 706#ifdef HAVE_SIGACTION
90b13cf6
WD
707#define SIGACTION(n,h) sigact.sa_handler=(h), sigaction((n),&sigact,NULL)
708#define signal(n,h) we_need_to_call_SIGACTION_not_signal(n,h)
709#else
710#define SIGACTION(n,h) signal(n,h)
711#endif
720b47f2
AT
712
713#ifndef EWOULDBLOCK
714#define EWOULDBLOCK EAGAIN
715#endif
182dca5c 716
7b8356d0
AT
717#ifndef STDIN_FILENO
718#define STDIN_FILENO 0
719#endif
720
721#ifndef STDOUT_FILENO
722#define STDOUT_FILENO 1
723#endif
724
725#ifndef STDERR_FILENO
726#define STDERR_FILENO 2
727#endif
728
8120a98f
WD
729#ifndef S_IRUSR
730#define S_IRUSR 0400
731#endif
732
7b8356d0
AT
733#ifndef S_IWUSR
734#define S_IWUSR 0200
735#endif
736
b0d791bb
PG
737#ifndef ACCESSPERMS
738#define ACCESSPERMS 0777
739#endif
740
741#ifndef S_ISVTX
742#define S_ISVTX 0
743#endif
744
745#define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
746
b280a1f4
AT
747#ifndef _S_IFMT
748#define _S_IFMT 0170000
749#endif
750
751#ifndef _S_IFLNK
752#define _S_IFLNK 0120000
753#endif
754
755#ifndef S_ISLNK
756#define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
757#endif
758
1e9f155a
AT
759#ifndef S_ISBLK
760#define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
761#endif
762
763#ifndef S_ISCHR
764#define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
765#endif
766
a0b65b18
AT
767#ifndef S_ISSOCK
768#ifdef _S_IFSOCK
769#define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
770#else
771#define S_ISSOCK(mode) (0)
772#endif
773#endif
774
775#ifndef S_ISFIFO
776#ifdef _S_IFIFO
777#define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
778#else
779#define S_ISFIFO(mode) (0)
780#endif
781#endif
782
1e9f155a
AT
783#ifndef S_ISDIR
784#define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
785#endif
786
787#ifndef S_ISREG
788#define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
789#endif
790
f0359dd0
AT
791/* work out what fcntl flag to use for non-blocking */
792#ifdef O_NONBLOCK
793# define NONBLOCK_FLAG O_NONBLOCK
4f5b0756 794#elif defined SYSV
f0359dd0 795# define NONBLOCK_FLAG O_NDELAY
d622d4bf 796#else
f0359dd0
AT
797# define NONBLOCK_FLAG FNDELAY
798#endif
799
d79c77ca
MP
800#ifndef INADDR_LOOPBACK
801#define INADDR_LOOPBACK 0x7f000001
802#endif
803
804#ifndef INADDR_NONE
805#define INADDR_NONE 0xffffffff
806#endif
a0b65b18 807
b5c6a6ae
WD
808#define IS_SPECIAL(mode) (S_ISSOCK(mode) || S_ISFIFO(mode))
809#define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode))
7bec6a5c 810
5afd8aed
DD
811/* Initial mask on permissions given to temporary files. Mask off setuid
812 bits and group access because of potential race-condition security
813 holes, and mask other access because mode 707 is bizarre */
972a3619 814#define INITACCESSPERMS 0700
e08bfe12
AT
815
816/* handler for null strings in printf format */
0ee6ca98 817#define NS(s) ((s)?(s):"<NULL>")
e08bfe12 818
58cadc86
WD
819/* Convenient wrappers for malloc and realloc. Use them. */
820#define new(type) ((type *)malloc(sizeof(type)))
821#define new_array(type, num) ((type *)_new_array(sizeof(type), (num)))
822#define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num)))
fb859e56 823
e08bfe12 824/* use magic gcc attributes to catch format errors */
ff41a59f 825 void rprintf(enum logcode , const char *, ...)
fb859e56 826 __attribute__((format (printf, 2, 3)))
e08bfe12 827;
7b3d4257 828
a039749b
MP
829/* This is just like rprintf, but it also tries to print some
830 * representation of the error code. Normally errcode = errno. */
831void rsyserr(enum logcode, int, const char *, ...)
fb859e56 832 __attribute__((format (printf, 3, 4)))
a039749b
MP
833 ;
834
4f5b0756 835#ifdef REPLACE_INET_NTOA
7b3d4257
AT
836#define inet_ntoa rep_inet_ntoa
837#endif
5a788ade 838
afbcc8f2
WD
839/* Make sure that the O_BINARY flag is defined. */
840#ifndef O_BINARY
841#define O_BINARY 0
842#endif
5a788ade 843
4f5b0756 844#ifndef HAVE_STRLCPY
5a788ade
AT
845size_t strlcpy(char *d, const char *s, size_t bufsize);
846#endif
847
4f5b0756 848#ifndef HAVE_STRLCAT
5a788ade
AT
849size_t strlcat(char *d, const char *s, size_t bufsize);
850#endif
851
82980a23
AT
852#ifndef WEXITSTATUS
853#define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
854#endif
855
a9766ef1 856#define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
eecd22ff 857
4f5b0756 858#ifdef HAVE_GETEUID
b2bffbb2
WD
859#define MY_UID() geteuid()
860#else
861#define MY_UID() getuid()
862#endif
863
4f5b0756 864#ifdef HAVE_GETEGID
b2bffbb2
WD
865#define MY_GID() getegid()
866#else
867#define MY_GID() getgid()
868#endif
eecd22ff
MP
869
870extern int verbose;
d5d4b282 871
4f5b0756 872#ifndef HAVE_INET_NTOP
d622d4bf 873const char *inet_ntop(int af, const void *src, char *dst, size_t size);
4f5b0756 874#endif
8f694072 875
4f5b0756 876#ifndef HAVE_INET_PTON
bda41fa5 877int inet_pton(int af, const char *src, void *dst);
8f694072 878#endif
0f0ea7f7 879
f4a0483a
MP
880#ifdef MAINTAINER_MODE
881const char *get_panic_action(void);
882#endif