Restored write_ndx_and_attrs() and made it public.
[rsync/rsync.git] / rsync.h
CommitLineData
d622d4bf 1/*
0f78b815
WD
2 * Copyright (C) 1996, 2000 Andrew Tridgell
3 * Copyright (C) 1996 Paul Mackerras
4 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
5 * Copyright (C) 2003, 2004, 2005, 2006 Wayne Davison
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
e7c67065
WD
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
0f78b815 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 */
f38f6f80 67#define FLAG_MISSING (1<<6) /* generator */
520cf417 68
c627d613 69/* update this if you make incompatible changes */
21068d8e 70#define PROTOCOL_VERSION 30
063393d6
MP
71
72/* We refuse to interoperate with versions that are not in this range.
73 * Note that we assume we'll work with later versions: the onus is on
74 * people writing them to make sure that they don't send us anything
75 * we won't understand.
76 *
1b2db7ae
S
77 * Interoperation with old but supported protocol versions
78 * should cause a warning to be printed. At a future date
79 * the old protocol will become the minimum and
80 * compatibility code removed.
81 *
91c4da3f
S
82 * There are two possible explanations for the limit at
83 * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
84 * do not interoperate with us, and (more likely) so that we can
85 * detect an attempt to connect rsync to a non-rsync server, which is
86 * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
87 * MAX_PROTOCOL_VERSION. */
88
3e491682
S
89#define MIN_PROTOCOL_VERSION 20
90#define OLD_PROTOCOL_VERSION 25
1b2db7ae 91#define MAX_PROTOCOL_VERSION 40
c627d613 92
9486289c
AT
93#define RSYNC_PORT 873
94
d867229b 95#define SPARSE_WRITE_SIZE (1024)
dc5ddbcc 96#define WRITE_SIZE (32*1024)
34ccb63e 97#define CHUNK_SIZE (32*1024)
61542c41 98#define MAX_MAP_SIZE (256*1024)
e3fe383a 99#define IO_BUFFER_SIZE (4092)
2b2ea368 100#define MAX_BLOCK_SIZE ((int32)1 << 29)
c627d613 101
e2d22fee
WD
102#define IOERR_GENERAL (1<<0) /* For backward compatibility, this must == 1 */
103#define IOERR_VANISHED (1<<1)
ff3d3c32 104#define IOERR_DEL_LIMIT (1<<2)
e2d22fee 105
874895d5 106#define MAX_ARGS 1000
e4977b0b 107#define MAX_BASIS_DIRS 20
c296031d 108#define MAX_SERVER_ARGS (MAX_BASIS_DIRS*2 + 100)
e4977b0b 109
8d9dc9f9 110#define MPLEX_BASE 7
ff41a59f 111
7842418b
WD
112#define NO_FILTERS 0
113#define SERVER_FILTERS 1
114#define ALL_FILTERS 2
4762db4f 115
753b6b46 116#define XFLG_FATAL_ERRORS (1<<0)
3b2461cf
WD
117#define XFLG_OLD_PREFIXES (1<<1)
118#define XFLG_ANCHORED2ABS (1<<2)
699f7024 119#define XFLG_ABS_IF_SLASH (1<<3)
4762db4f 120
8eda7a4b
WD
121#define ATTRS_REPORT (1<<0)
122#define ATTRS_SKIP_MTIME (1<<1)
5c6fc4a6 123
419896af
WD
124#define FULL_FLUSH 1
125#define NORMAL_FLUSH 0
126
a7260c40
WD
127#define PDIR_CREATE 1
128#define PDIR_DELETE 0
129
e341588a
WD
130/* Note: 0x00 - 0x7F are used for basis_dir[] indexes! */
131#define FNAMECMP_BASIS_DIR_LOW 0x00 /* Must remain 0! */
132#define FNAMECMP_BASIS_DIR_HIGH 0x7F
41cfde6b
WD
133#define FNAMECMP_FNAME 0x80
134#define FNAMECMP_PARTIAL_DIR 0x81
135#define FNAMECMP_BACKUP 0x82
0dd046d3 136#define FNAMECMP_FUZZY 0x83
41cfde6b 137
0cc279e0 138/* For use by the itemize_changes code */
b3222792 139#define ITEM_REPORT_ATIME (1<<0)
0cc279e0
WD
140#define ITEM_REPORT_CHECKSUM (1<<1)
141#define ITEM_REPORT_SIZE (1<<2)
142#define ITEM_REPORT_TIME (1<<3)
143#define ITEM_REPORT_PERMS (1<<4)
144#define ITEM_REPORT_OWNER (1<<5)
145#define ITEM_REPORT_GROUP (1<<6)
b3222792
WD
146#define ITEM_REPORT_ACL (1<<7)
147#define ITEM_REPORT_XATTR (1<<8)
3019a9ba
WD
148#define ITEM_BASIS_TYPE_FOLLOWS (1<<11)
149#define ITEM_XNAME_FOLLOWS (1<<12)
6d0e5d2e
WD
150#define ITEM_IS_NEW (1<<13)
151#define ITEM_LOCAL_CHANGE (1<<14)
152#define ITEM_TRANSFER (1<<15)
d4d4890d 153/* These are outside the range of the transmitted flags. */
d4d4890d
WD
154#define ITEM_MISSING_DATA (1<<16) /* used by log_formatted() */
155#define ITEM_DELETED (1<<17) /* used by log_formatted() */
1e4f5f63 156#define ITEM_MATCHED (1<<18) /* used by itemize() */
0cc279e0 157
3019a9ba
WD
158#define SIGNIFICANT_ITEM_FLAGS (~(\
159 ITEM_BASIS_TYPE_FOLLOWS | ITEM_XNAME_FOLLOWS | ITEM_LOCAL_CHANGE))
669e7671 160
df0054ab 161
56aaa4c4
WD
162/* Log-message categories. Only FERROR and FINFO get sent over the socket,
163 * but FLOG and FSOCKERR can be sent over the receiver -> generator pipe.
85909931 164 * FLOG only goes to the log file, not the client; FCLIENT is the opposite. */
011e85a5 165enum logcode { FNONE=0, FERROR=1, FINFO=2, FLOG=3, FCLIENT=4, FSOCKERR=5 };
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 */
ea26c854 172 MSG_LOG=FLOG, MSG_SOCKERR=FSOCKERR, /* sibling logging */
1dcf3b43
WD
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
5a3810b4
WD
318#ifdef MAKEDEV_TAKES_3_ARGS
319#define MAKEDEV(devmajor,devminor) makedev(0,devmajor,devminor)
320#else
321#define MAKEDEV(devmajor,devminor) makedev(devmajor,devminor)
322#endif
323
4f5b0756 324#ifdef HAVE_COMPAT_H
e8f5b936
AT
325#include <compat.h>
326#endif
327
ea8291d8
WD
328#ifdef HAVE_LIMITS_H
329# include <limits.h>
330#endif
331
1bfbf40b
MP
332#include <assert.h>
333
9935066b 334#include "lib/pool_alloc.h"
e8f5b936 335
f0fca04e
AT
336#define BOOL int
337
c627d613
AT
338#ifndef uchar
339#define uchar unsigned char
340#endif
341
4f5b0756 342#ifdef SIGNED_CHAR_OK
debb4505
AT
343#define schar signed char
344#else
345#define schar char
346#endif
347
43d0f38b
WD
348/* Find a variable that is either exactly 32-bits or longer.
349 * If some code depends on 32-bit truncation, it will need to
350 * take special action in a "#if SIZEOF_INT32 > 4" section. */
c627d613 351#ifndef int32
43d0f38b
WD
352#if SIZEOF_INT == 4
353# define int32 int
354# define SIZEOF_INT32 4
355#elif SIZEOF_LONG == 4
356# define int32 long
357# define SIZEOF_INT32 4
358#elif SIZEOF_SHORT == 4
359# define int32 short
360# define SIZEOF_INT32 4
361#elif SIZEOF_INT > 4
362# define int32 int
363# define SIZEOF_INT32 SIZEOF_INT
364#elif SIZEOF_LONG > 4
365# define int32 long
366# define SIZEOF_INT32 SIZEOF_LONG
8de330a3 367#else
43d0f38b 368# error Could not find a 32-bit integer variable
c627d613 369#endif
43d0f38b
WD
370#else
371# define SIZEOF_INT32 4
c627d613
AT
372#endif
373
374#ifndef uint32
375#define uint32 unsigned int32
376#endif
377
0dd046d3 378#if SIZEOF_OFF_T == 8 || !SIZEOF_OFF64_T || !defined HAVE_STRUCT_STAT64
bcacc18b
AT
379#define OFF_T off_t
380#define STRUCT_STAT struct stat
5b5f7e3b
WD
381#else
382#define OFF_T off64_t
383#define STRUCT_STAT struct stat64
384#define USE_STAT64_FUNCS 1
bcacc18b
AT
385#endif
386
d4198823
WD
387/* CAVEAT: on some systems, int64 will really be a 32-bit integer IFF
388 * that's the maximum size the file system can handle and there is no
389 * 64-bit type available. The rsync source must therefore take steps
390 * to ensure that any code that really requires a 64-bit integer has
391 * it (e.g. the checksum code uses two 32-bit integers for its 64-bit
392 * counter). */
2c177562 393#if SIZEOF_LONG == 8
d622d4bf
WD
394# define int64 long
395# define SIZEOF_INT64 8
396#elif SIZEOF_INT == 8
397# define int64 int
398# define SIZEOF_INT64 8
399#elif SIZEOF_LONG_LONG == 8
400# define int64 long long
401# define SIZEOF_INT64 8
2c177562
WD
402#elif SIZEOF_OFF64_T == 8
403# define int64 off64_t
404# define SIZEOF_INT64 8
d622d4bf
WD
405#elif SIZEOF_OFF_T == 8
406# define int64 off_t
407# define SIZEOF_INT64 8
408#elif SIZEOF_INT > 8
409# define int64 int
410# define SIZEOF_INT64 SIZEOF_INT
411#elif SIZEOF_LONG > 8
412# define int64 long
413# define SIZEOF_INT64 SIZEOF_LONG
414#elif SIZEOF_LONG_LONG > 8
415# define int64 long long
416# define SIZEOF_INT64 SIZEOF_LONG_LONG
71c46176 417#else
736a6a29 418/* As long as it gets... */
d622d4bf
WD
419# define int64 off_t
420# define SIZEOF_INT64 SIZEOF_OFF_T
71c46176 421#endif
c627d613 422
6abd193f
MP
423/* Starting from protocol version 26, we always use 64-bit
424 * ino_t and dev_t internally, even if this platform does not
425 * allow files to have 64-bit inums. That's because the
426 * receiver needs to find duplicate (dev,ino) tuples to detect
427 * hardlinks, and it might have files coming from a platform
428 * that has 64-bit inums.
429 *
430 * The only exception is if we're on a platform with no 64-bit type at
431 * all.
432 *
433 * Because we use read_longint() to get these off the wire, if you
434 * transfer devices or hardlinks with dev or inum > 2**32 to a machine
435 * with no 64-bit types then you will get an overflow error. Probably
436 * not many people have that combination of machines, and you can
437 * avoid it by not preserving hardlinks or not transferring device
438 * nodes. It's not clear that any other behaviour is better.
439 *
440 * Note that if you transfer devices from a 64-bit-devt machine (say,
441 * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the
442 * device numbers will be truncated. But it's a kind of silly thing
443 * to do anyhow.
b9df3bf2 444 *
33a2361c
WD
445 * FIXME: I don't think the code in flist.c has ever worked on a system
446 * where dev_t is a struct.
d622d4bf 447 */
33a2361c
WD
448
449struct idev {
d06f6328
WD
450 int64 inode;
451 int64 dev;
33a2361c 452};
c29ee43d 453
c627d613
AT
454#ifndef MIN
455#define MIN(a,b) ((a)<(b)?(a):(b))
456#endif
457
458#ifndef MAX
459#define MAX(a,b) ((a)>(b)?(a):(b))
460#endif
461
d41c7d02
DD
462#ifndef MAXHOSTNAMELEN
463#define MAXHOSTNAMELEN 256
464#endif
465
c627d613 466/* the length of the md4 checksum */
ebb0a6f6 467#define MD4_SUM_LENGTH 16
c627d613 468#define SUM_LENGTH 16
195bd906
S
469#define SHORT_SUM_LENGTH 2
470#define BLOCKSUM_BIAS 10
c627d613
AT
471
472#ifndef MAXPATHLEN
473#define MAXPATHLEN 1024
474#endif
475
a22ca885
WD
476/* We want a roomy line buffer that can hold more than MAXPATHLEN,
477 * and significantly more than an overly short MAXPATHLEN. */
478#if MAXPATHLEN < 4096
479#define BIGPATHBUFLEN (4096+1024)
480#else
481#define BIGPATHBUFLEN (MAXPATHLEN+1024)
482#endif
483
52d3e106
S
484#ifndef NAME_MAX
485#define NAME_MAX 255
486#endif
487
0473e2a1
AT
488#ifndef INADDR_NONE
489#define INADDR_NONE 0xffffffff
490#endif
491
bda41fa5
WD
492#ifndef IN_LOOPBACKNET
493#define IN_LOOPBACKNET 127
494#endif
495
25bd9945 496#define GID_NONE ((gid_t)-1)
a60e2dca 497
520cf417
WD
498#define HL_CHECK_MASTER 0
499#define HL_SKIP 1
500
88a7fb3e 501struct hlink {
44885a39
WD
502 int32 next;
503 int32 hlindex;
504 unsigned short link_dest_used;
88a7fb3e
WD
505};
506
88a7fb3e
WD
507#define F_DEV link_u.idev->dev
508#define F_INODE link_u.idev->inode
509
520cf417 510#define F_HLINDEX link_u.links->hlindex
fe70ad26
WD
511#define F_NEXT link_u.links->next
512
c627d613 513struct file_struct {
80707c98 514 union {
af107f6c 515 dev_t rdev; /* The device number, if this is a device */
4a19c3b2
WD
516 const char *sum;/* Only a normal file can have a checksum */
517 const char *link;/* Points to symlink string, if a symlink */
80707c98 518 } u;
0596df00 519 OFF_T length;
4a19c3b2
WD
520 const char *basename; /* The current item's name (AKA filename) */
521 const char *dirname; /* The directory info inside the transfer */
f8057304 522 union {
eaf895e6 523 const char *root;/* Sender-side dir info outside transfer */
f8057304
WD
524 int depth; /* Receiver-side directory depth info */
525 } dir;
88a7fb3e
WD
526 union {
527 struct idev *idev;
528 struct hlink *links;
529 } link_u;
0596df00 530 time_t modtime;
7b6fa00f
WD
531 uid_t uid;
532 gid_t gid;
fc2dd77e 533 mode_t mode;
5009de7d 534 uchar flags; /* this item MUST remain last */
c627d613
AT
535};
536
a85906c7
S
537/*
538 * Start the flist array at FLIST_START entries and grow it
539 * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
540 */
541#define FLIST_START (32 * 1024)
542#define FLIST_LINEAR (FLIST_START * 512)
b96efc2f 543
9935066b
S
544/*
545 * Extent size for allocation pools A minimum size of 128KB
546 * is needed to mmap them so that freeing will release the
547 * space to the OS.
548 *
549 * Larger sizes reduce leftover fragments and speed free calls
550 * (when they happen) Smaller sizes increase the chance of
551 * freed allocations freeing whole extents.
552 */
9935066b
S
553#define FILE_EXTENT (256 * 1024)
554#define HLINK_EXTENT (128 * 1024)
555
556#define WITH_HLINK 1
557#define WITHOUT_HLINK 0
3d382777 558
c627d613 559struct file_list {
2b2ea368 560 struct file_struct **files;
9935066b
S
561 alloc_pool_t file_pool;
562 alloc_pool_t hlink_pool;
2b2ea368
WD
563 int count;
564 int malloced;
f8057304 565 int low, high;
c627d613
AT
566};
567
a3221d2a
WD
568#define SUMFLG_SAME_OFFSET (1<<0)
569
c627d613 570struct sum_buf {
6ded1170 571 OFF_T offset; /**< offset in file of this chunk */
a06b419d 572 int32 len; /**< length of chunk of file */
6ded1170 573 uint32 sum1; /**< simple checksum */
d733de97 574 int32 chain; /**< next hash-table collision */
a3221d2a 575 short flags; /**< flag bits */
6ded1170 576 char sum2[SUM_LENGTH]; /**< checksum */
c627d613
AT
577};
578
579struct sum_struct {
6ded1170 580 OFF_T flength; /**< total file length */
2b2ea368 581 struct sum_buf *sums; /**< points to info for each chunk */
15859584 582 int32 count; /**< how many chunks */
a06b419d
WD
583 int32 blength; /**< block_length */
584 int32 remainder; /**< flength % block_length */
da9d12f5 585 int s2length; /**< sum2_length */
c627d613
AT
586};
587
c6e7fcb4 588struct map_struct {
6a7cc46c
S
589 OFF_T file_size; /* File size (from stat) */
590 OFF_T p_offset; /* Window start */
591 OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */
2b2ea368
WD
592 char *p; /* Window pointer */
593 int32 p_size; /* Largest window size we allocated */
594 int32 p_len; /* Latest (rounded) window size */
595 int32 def_window_size; /* Default window size */
596 int fd; /* File Descriptor */
597 int status; /* first errno from read errors */
c6e7fcb4 598};
c627d613 599
e2d22fee
WD
600#define MATCHFLG_WILD (1<<0) /* pattern has '*', '[', and/or '?' */
601#define MATCHFLG_WILD2 (1<<1) /* pattern has '**' */
685517ab
WD
602#define MATCHFLG_WILD2_PREFIX (1<<2) /* pattern starts with "**" */
603#define MATCHFLG_WILD3_SUFFIX (1<<3) /* pattern ends with "***" */
604#define MATCHFLG_ABS_PATH (1<<4) /* path-match on absolute path */
605#define MATCHFLG_INCLUDE (1<<5) /* this is an include, not an exclude */
606#define MATCHFLG_DIRECTORY (1<<6) /* this matches only directories */
46fa6025
WD
607#define MATCHFLG_WORD_SPLIT (1<<7) /* split rules on whitespace */
608#define MATCHFLG_NO_INHERIT (1<<8) /* don't inherit these rules */
609#define MATCHFLG_NO_PREFIXES (1<<9) /* parse no prefixes from patterns */
610#define MATCHFLG_MERGE_FILE (1<<10)/* specifies a file to merge */
611#define MATCHFLG_PERDIR_MERGE (1<<11)/* merge-file is searched per-dir */
612#define MATCHFLG_EXCLUDE_SELF (1<<12)/* merge-file name should be excluded */
613#define MATCHFLG_FINISH_SETUP (1<<13)/* per-dir merge file needs setup */
53b417e4
WD
614#define MATCHFLG_NEGATE (1<<14)/* rule matches when pattern does not */
615#define MATCHFLG_CVS_IGNORE (1<<15)/* rule was -C or :C */
a427e893
WD
616#define MATCHFLG_SENDER_SIDE (1<<16)/* rule applies to the sending side */
617#define MATCHFLG_RECEIVER_SIDE (1<<17)/* rule applies to the receiving side */
685517ab 618#define MATCHFLG_CLEAR_LIST (1<<18)/* this item is the "!" token */
c0f1e57b 619#define MATCHFLG_PERISHABLE (1<<19)/* perishable if parent dir goes away */
7c8e23bd 620
3b2461cf 621#define MATCHFLGS_FROM_CONTAINER (MATCHFLG_ABS_PATH | MATCHFLG_INCLUDE \
a427e893 622 | MATCHFLG_DIRECTORY | MATCHFLG_SENDER_SIDE \
c0f1e57b
WD
623 | MATCHFLG_NEGATE | MATCHFLG_RECEIVER_SIDE \
624 | MATCHFLG_PERISHABLE)
3b2461cf 625
7842418b
WD
626struct filter_struct {
627 struct filter_struct *next;
2b6b4d53 628 char *pattern;
53b417e4 629 uint32 match_flags;
46fa6025
WD
630 union {
631 int slash_cnt;
7842418b 632 struct filter_list_struct *mergelist;
46fa6025 633 } u;
2b6b4d53
AT
634};
635
7842418b
WD
636struct filter_list_struct {
637 struct filter_struct *head;
638 struct filter_struct *tail;
ac1d2d33 639 char *debug_type;
63d03319
WD
640};
641
a800434a
AT
642struct stats {
643 int64 total_size;
644 int64 total_transferred_size;
645 int64 total_written;
646 int64 total_read;
647 int64 literal_data;
648 int64 matched_data;
d4198823
WD
649 int64 flist_buildtime;
650 int64 flist_xfertime;
604dbf6d 651 int64 flist_size;
a800434a
AT
652 int num_files;
653 int num_transferred_files;
dc8293ff 654 int current_file_index;
a800434a
AT
655};
656
f7bce90c 657struct chmod_mode_struct;
2b6b4d53 658
c627d613 659#include "byteorder.h"
8de330a3 660#include "lib/mdfour.h"
87f18b62 661#include "lib/wildmatch.h"
740819ef 662#include "lib/permstring.h"
e20a4f84 663#include "lib/addrinfo.h"
0de40240 664
2b916250 665#ifndef __GNUC__
4ea58045 666#define __attribute__(x)
7de7b49f
WD
667# if __GNUC__ <= 2
668# define NORETURN
669# endif
4ea58045
WD
670#endif
671
90b13cf6 672#define UNUSED(x) x __attribute__((__unused__))
7de7b49f 673#ifndef NORETURN
011e85a5 674#define NORETURN __attribute__((__noreturn__))
7de7b49f 675#endif
90b13cf6 676
58c29609
MP
677#include "proto.h"
678
0de40240 679/* We have replacement versions of these if they're missing. */
4f5b0756 680#ifndef HAVE_ASPRINTF
0de40240
MP
681int asprintf(char **ptr, const char *format, ...);
682#endif
683
4f5b0756 684#ifndef HAVE_VASPRINTF
0de40240
MP
685int vasprintf(char **ptr, const char *format, va_list ap);
686#endif
687
4f5b0756 688#if !defined HAVE_VSNPRINTF || !defined HAVE_C99_VSNPRINTF
6813fa7e
WD
689#define vsnprintf rsync_vsnprintf
690int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
0de40240
MP
691#endif
692
4f5b0756 693#if !defined HAVE_SNPRINTF || !defined HAVE_C99_VSNPRINTF
6813fa7e 694#define snprintf rsync_snprintf
0de40240
MP
695int snprintf(char *str,size_t count,const char *fmt,...);
696#endif
697
698
4f5b0756 699#ifndef HAVE_STRERROR
c627d613
AT
700extern char *sys_errlist[];
701#define strerror(i) sys_errlist[i]
702#endif
703
4f5b0756 704#ifndef HAVE_STRCHR
c627d613
AT
705# define strchr index
706# define strrchr rindex
707#endif
708
4f5b0756 709#ifndef HAVE_ERRNO_DECL
c627d613
AT
710extern int errno;
711#endif
712
9a929c8f
WD
713#ifdef HAVE_READLINK
714#define SUPPORT_LINKS 1
715#endif
716#ifdef HAVE_LINK
717#define SUPPORT_HARD_LINKS 1
718#endif
c627d613 719
5173f99e 720#ifdef HAVE_SIGACTION
90b13cf6
WD
721#define SIGACTION(n,h) sigact.sa_handler=(h), sigaction((n),&sigact,NULL)
722#define signal(n,h) we_need_to_call_SIGACTION_not_signal(n,h)
723#else
724#define SIGACTION(n,h) signal(n,h)
725#endif
720b47f2
AT
726
727#ifndef EWOULDBLOCK
728#define EWOULDBLOCK EAGAIN
729#endif
182dca5c 730
7b8356d0
AT
731#ifndef STDIN_FILENO
732#define STDIN_FILENO 0
733#endif
734
735#ifndef STDOUT_FILENO
736#define STDOUT_FILENO 1
737#endif
738
739#ifndef STDERR_FILENO
740#define STDERR_FILENO 2
741#endif
742
8120a98f
WD
743#ifndef S_IRUSR
744#define S_IRUSR 0400
745#endif
746
7b8356d0
AT
747#ifndef S_IWUSR
748#define S_IWUSR 0200
749#endif
750
b0d791bb
PG
751#ifndef ACCESSPERMS
752#define ACCESSPERMS 0777
753#endif
754
755#ifndef S_ISVTX
756#define S_ISVTX 0
757#endif
758
759#define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
760
b280a1f4
AT
761#ifndef _S_IFMT
762#define _S_IFMT 0170000
763#endif
764
765#ifndef _S_IFLNK
766#define _S_IFLNK 0120000
767#endif
768
769#ifndef S_ISLNK
770#define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
771#endif
772
1e9f155a
AT
773#ifndef S_ISBLK
774#define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
775#endif
776
777#ifndef S_ISCHR
778#define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
779#endif
780
a0b65b18
AT
781#ifndef S_ISSOCK
782#ifdef _S_IFSOCK
783#define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
784#else
785#define S_ISSOCK(mode) (0)
786#endif
787#endif
788
789#ifndef S_ISFIFO
790#ifdef _S_IFIFO
791#define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
792#else
793#define S_ISFIFO(mode) (0)
794#endif
795#endif
796
1e9f155a
AT
797#ifndef S_ISDIR
798#define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
799#endif
800
801#ifndef S_ISREG
802#define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
803#endif
804
f0359dd0
AT
805/* work out what fcntl flag to use for non-blocking */
806#ifdef O_NONBLOCK
807# define NONBLOCK_FLAG O_NONBLOCK
4f5b0756 808#elif defined SYSV
f0359dd0 809# define NONBLOCK_FLAG O_NDELAY
d622d4bf 810#else
f0359dd0
AT
811# define NONBLOCK_FLAG FNDELAY
812#endif
813
d79c77ca
MP
814#ifndef INADDR_LOOPBACK
815#define INADDR_LOOPBACK 0x7f000001
816#endif
817
818#ifndef INADDR_NONE
819#define INADDR_NONE 0xffffffff
820#endif
a0b65b18 821
b5c6a6ae
WD
822#define IS_SPECIAL(mode) (S_ISSOCK(mode) || S_ISFIFO(mode))
823#define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode))
7bec6a5c 824
5afd8aed
DD
825/* Initial mask on permissions given to temporary files. Mask off setuid
826 bits and group access because of potential race-condition security
827 holes, and mask other access because mode 707 is bizarre */
972a3619 828#define INITACCESSPERMS 0700
e08bfe12
AT
829
830/* handler for null strings in printf format */
0ee6ca98 831#define NS(s) ((s)?(s):"<NULL>")
e08bfe12 832
58cadc86
WD
833/* Convenient wrappers for malloc and realloc. Use them. */
834#define new(type) ((type *)malloc(sizeof(type)))
835#define new_array(type, num) ((type *)_new_array(sizeof(type), (num)))
836#define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num)))
fb859e56 837
e08bfe12 838/* use magic gcc attributes to catch format errors */
ff41a59f 839 void rprintf(enum logcode , const char *, ...)
fb859e56 840 __attribute__((format (printf, 2, 3)))
e08bfe12 841;
7b3d4257 842
a039749b
MP
843/* This is just like rprintf, but it also tries to print some
844 * representation of the error code. Normally errcode = errno. */
845void rsyserr(enum logcode, int, const char *, ...)
fb859e56 846 __attribute__((format (printf, 3, 4)))
a039749b
MP
847 ;
848
afbcc8f2
WD
849/* Make sure that the O_BINARY flag is defined. */
850#ifndef O_BINARY
851#define O_BINARY 0
852#endif
5a788ade 853
4f5b0756 854#ifndef HAVE_STRLCPY
5a788ade
AT
855size_t strlcpy(char *d, const char *s, size_t bufsize);
856#endif
857
4f5b0756 858#ifndef HAVE_STRLCAT
5a788ade
AT
859size_t strlcat(char *d, const char *s, size_t bufsize);
860#endif
861
82980a23
AT
862#ifndef WEXITSTATUS
863#define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
864#endif
47b032e9
WD
865#ifndef WIFEXITED
866#define WIFEXITED(stat) ((int)((stat)&0xFF) == 0)
867#endif
82980a23 868
a9766ef1 869#define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
eecd22ff 870
4f5b0756 871#ifdef HAVE_GETEUID
b2bffbb2
WD
872#define MY_UID() geteuid()
873#else
874#define MY_UID() getuid()
875#endif
876
4f5b0756 877#ifdef HAVE_GETEGID
b2bffbb2
WD
878#define MY_GID() getegid()
879#else
880#define MY_GID() getgid()
881#endif
eecd22ff
MP
882
883extern int verbose;
d5d4b282 884
4f5b0756 885#ifndef HAVE_INET_NTOP
d622d4bf 886const char *inet_ntop(int af, const void *src, char *dst, size_t size);
4f5b0756 887#endif
8f694072 888
4f5b0756 889#ifndef HAVE_INET_PTON
bda41fa5 890int inet_pton(int af, const char *src, void *dst);
8f694072 891#endif
0f0ea7f7 892
f4a0483a
MP
893#ifdef MAINTAINER_MODE
894const char *get_panic_action(void);
895#endif
2dc7b8bd
WD
896
897static inline int
898isDigit(const char *ptr)
899{
900 return isdigit(*(unsigned char *)ptr);
901}
902
903static inline int
904isPrint(const char *ptr)
905{
906 return isprint(*(unsigned char *)ptr);
907}
908
909static inline int
910isSpace(const char *ptr)
911{
912 return isspace(*(unsigned char *)ptr);
913}
914
915static inline int
916isLower(const char *ptr)
917{
918 return islower(*(unsigned char *)ptr);
919}
920
921static inline int
922isUpper(const char *ptr)
923{
924 return isupper(*(unsigned char *)ptr);
925}
926
927static inline int
928toLower(const char *ptr)
929{
930 return tolower(*(unsigned char *)ptr);
931}
932
933static inline int
934toUpper(const char *ptr)
935{
936 return toupper(*(unsigned char *)ptr);
937}