Implemented an extended-flag-byte in the transfer protocol by moving
[rsync/rsync.git] / rsync.h
... / ...
CommitLineData
1/*
2 Copyright (C) by Andrew Tridgell 1996, 2000
3 Copyright (C) Paul Mackerras 1996
4 Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
5
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.
10
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.
15
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
21
22#define False 0
23#define True 1
24
25#define BLOCK_SIZE 700
26#define RSYNC_RSH_ENV "RSYNC_RSH"
27#define RSYNC_RSH_IO_ENV "RSYNC_RSH_IO"
28
29#define RSYNC_NAME "rsync"
30#define RSYNCD_SYSCONF "/etc/rsyncd.conf"
31#define RSYNCD_USERCONF "rsyncd.conf"
32
33#define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
34#define URL_PREFIX "rsync://"
35
36#define BACKUP_SUFFIX "~"
37
38/* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
39 incompatible with older versions :-( */
40#define CHAR_OFFSET 0
41
42
43#define FLAG_DELETE (1<<0)
44#define SAME_MODE (1<<1)
45#define EXTENDED_FLAGS (1<<2)
46#define OLD_SAME_RDEV EXTENDED_FLAGS
47#define SAME_UID (1<<3)
48#define SAME_GID (1<<4)
49#define SAME_DIR (1<<5)
50#define SAME_NAME SAME_DIR
51#define LONG_NAME (1<<6)
52#define SAME_TIME (1<<7)
53#define SAME_HIGH_RDEV (1<<8)
54
55/* update this if you make incompatible changes */
56#define PROTOCOL_VERSION 27
57
58/* We refuse to interoperate with versions that are not in this range.
59 * Note that we assume we'll work with later versions: the onus is on
60 * people writing them to make sure that they don't send us anything
61 * we won't understand.
62 *
63 * Interoperation with old but supported protocol versions
64 * should cause a warning to be printed. At a future date
65 * the old protocol will become the minimum and
66 * compatibility code removed.
67 *
68 * There are two possible explanations for the limit at
69 * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
70 * do not interoperate with us, and (more likely) so that we can
71 * detect an attempt to connect rsync to a non-rsync server, which is
72 * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
73 * MAX_PROTOCOL_VERSION. */
74
75#define MIN_PROTOCOL_VERSION 19
76#define OLD_PROTOCOL_VERSION 20
77#define MAX_PROTOCOL_VERSION 40
78
79#define RSYNC_PORT 873
80
81#define SPARSE_WRITE_SIZE (1024)
82#define WRITE_SIZE (32*1024)
83#define CHUNK_SIZE (32*1024)
84#define MAX_MAP_SIZE (256*1024)
85#define IO_BUFFER_SIZE (4092)
86
87#define IOERR_GENERAL (1<<0) /* For backward compatibility, this must == 1 */
88#define IOERR_VANISHED (1<<1)
89
90#define MAX_ARGS 1000
91
92#define MPLEX_BASE 7
93
94#define NO_EXCLUDES 0
95#define SERVER_EXCLUDES 1
96#define ALL_EXCLUDES 2
97
98#define MISSING_OK 0
99#define MISSING_FATAL 1
100
101#define ADD_INCLUDE 1
102#define ADD_EXCLUDE 0
103
104/* Log values. I *think* what these mean is: FLOG goes to the server
105 * logfile; FERROR and FINFO try to end up on the client, with
106 * different levels of filtering. */
107enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 };
108
109#include "errcode.h"
110
111#include "config.h"
112
113/* The default RSYNC_RSH is always set in config.h. */
114
115#include <sys/types.h>
116
117#ifdef HAVE_UNISTD_H
118#include <unistd.h>
119#endif
120#include <stdio.h>
121#include <stddef.h>
122
123#ifdef HAVE_SYS_PARAM_H
124#include <sys/param.h>
125#endif
126
127#ifdef HAVE_STDLIB_H
128#include <stdlib.h>
129#endif
130
131#if defined(HAVE_MALLOC_H) && (defined(HAVE_MALLINFO) || !defined(HAVE_STDLIB_H))
132#include <malloc.h>
133#endif
134
135#ifdef HAVE_SYS_SOCKET_H
136#include <sys/socket.h>
137#endif
138
139#ifdef HAVE_STRING_H
140#include <string.h>
141#endif
142
143#ifdef TIME_WITH_SYS_TIME
144#include <sys/time.h>
145#include <time.h>
146#else
147#ifdef HAVE_SYS_TIME_H
148#include <sys/time.h>
149#else
150#include <time.h>
151#endif
152#endif
153
154#ifdef HAVE_FCNTL_H
155#include <fcntl.h>
156#else
157#ifdef HAVE_SYS_FCNTL_H
158#include <sys/fcntl.h>
159#endif
160#endif
161
162#include <sys/stat.h>
163
164#ifdef HAVE_SYS_IOCTL_H
165#include <sys/ioctl.h>
166#endif
167
168#ifdef HAVE_SYS_FILIO_H
169#include <sys/filio.h>
170#endif
171
172#include <signal.h>
173#ifdef HAVE_SYS_WAIT_H
174#include <sys/wait.h>
175#endif
176#ifdef HAVE_CTYPE_H
177#include <ctype.h>
178#endif
179#ifdef HAVE_GRP_H
180#include <grp.h>
181#endif
182#include <errno.h>
183
184#ifdef HAVE_UTIME_H
185#include <utime.h>
186#endif
187
188#ifdef HAVE_SYS_SELECT_H
189#include <sys/select.h>
190#endif
191
192#ifdef HAVE_SYS_MODE_H
193/* apparently AIX needs this for S_ISLNK */
194#ifndef S_ISLNK
195#include <sys/mode.h>
196#endif
197#endif
198
199#ifdef HAVE_GLOB_H
200#include <glob.h>
201#endif
202
203/* these are needed for the uid/gid mapping code */
204#include <pwd.h>
205#include <grp.h>
206
207#include <stdarg.h>
208#include <netinet/in.h>
209#include <arpa/inet.h>
210#include <netdb.h>
211#include <syslog.h>
212#include <sys/file.h>
213
214#if HAVE_DIRENT_H
215# include <dirent.h>
216#else
217# define dirent direct
218# if HAVE_SYS_NDIR_H
219# include <sys/ndir.h>
220# endif
221# if HAVE_SYS_DIR_H
222# include <sys/dir.h>
223# endif
224# if HAVE_NDIR_H
225# include <ndir.h>
226# endif
227#endif
228
229#ifdef HAVE_COMPAT_H
230#include <compat.h>
231#endif
232
233#include <assert.h>
234
235
236#define BOOL int
237
238#ifndef uchar
239#define uchar unsigned char
240#endif
241
242#if HAVE_UNSIGNED_CHAR
243#define schar signed char
244#else
245#define schar char
246#endif
247
248#ifndef int32
249#if (SIZEOF_INT == 4)
250#define int32 int
251#elif (SIZEOF_LONG == 4)
252#define int32 long
253#elif (SIZEOF_SHORT == 4)
254#define int32 short
255#else
256/* I hope this works */
257#define int32 int
258#define LARGE_INT32
259#endif
260#endif
261
262#ifndef uint32
263#define uint32 unsigned int32
264#endif
265
266#if HAVE_OFF64_T
267#define OFF_T off64_t
268#define STRUCT_STAT struct stat64
269#else
270#define OFF_T off_t
271#define STRUCT_STAT struct stat
272#endif
273
274#if HAVE_OFF64_T
275#define int64 off64_t
276#elif (SIZEOF_LONG == 8)
277#define int64 long
278#elif (SIZEOF_INT == 8)
279#define int64 int
280#elif HAVE_LONGLONG
281#define int64 long long
282#else
283/* As long as it gets... */
284#define int64 off_t
285#define NO_INT64
286#endif
287
288#if (SIZEOF_LONG == 8)
289#define uint64 unsigned long
290#elif (SIZEOF_INT == 8)
291#define uint64 unsigned int
292#elif HAVE_LONGLONG
293#define uint64 unsigned long long
294#else
295/* As long as it gets... */
296#define uint64 unsigned off_t
297#endif
298
299/* Starting from protocol version 26, we always use 64-bit
300 * ino_t and dev_t internally, even if this platform does not
301 * allow files to have 64-bit inums. That's because the
302 * receiver needs to find duplicate (dev,ino) tuples to detect
303 * hardlinks, and it might have files coming from a platform
304 * that has 64-bit inums.
305 *
306 * The only exception is if we're on a platform with no 64-bit type at
307 * all.
308 *
309 * Because we use read_longint() to get these off the wire, if you
310 * transfer devices or hardlinks with dev or inum > 2**32 to a machine
311 * with no 64-bit types then you will get an overflow error. Probably
312 * not many people have that combination of machines, and you can
313 * avoid it by not preserving hardlinks or not transferring device
314 * nodes. It's not clear that any other behaviour is better.
315 *
316 * Note that if you transfer devices from a 64-bit-devt machine (say,
317 * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the
318 * device numbers will be truncated. But it's a kind of silly thing
319 * to do anyhow.
320 *
321 * FIXME: In future, we should probable split the device number into
322 * major/minor, and transfer the two parts as 32-bit ints. That gives
323 * you somewhat more of a chance that they'll come from a big machine
324 * to a little one in a useful way.
325 *
326 * FIXME: Really we need an unsigned type, and we perhaps ought to
327 * cope with platforms on which this is an unsigned int or even a
328 * struct. Later.
329 */
330#define INO64_T uint64
331#define DEV64_T uint64
332
333#ifndef MIN
334#define MIN(a,b) ((a)<(b)?(a):(b))
335#endif
336
337#ifndef MAX
338#define MAX(a,b) ((a)>(b)?(a):(b))
339#endif
340
341#ifndef MAXHOSTNAMELEN
342#define MAXHOSTNAMELEN 256
343#endif
344
345/* the length of the md4 checksum */
346#define MD4_SUM_LENGTH 16
347#define SUM_LENGTH 16
348#define SHORT_SUM_LENGTH 2
349#define BLOCKSUM_BIAS 10
350
351#ifndef MAXPATHLEN
352#define MAXPATHLEN 1024
353#endif
354
355#ifndef NAME_MAX
356#define NAME_MAX 255
357#endif
358
359#ifndef INADDR_NONE
360#define INADDR_NONE 0xffffffff
361#endif
362
363#ifndef IN_LOOPBACKNET
364#define IN_LOOPBACKNET 127
365#endif
366
367#define GID_NONE (gid_t) -1
368
369struct file_struct {
370 time_t modtime;
371 OFF_T length;
372 mode_t mode;
373
374 INO64_T inode;
375 /** Device this file lives upon */
376 DEV64_T dev;
377
378 /** If this is a device node, the device number. */
379 DEV64_T rdev;
380 uid_t uid;
381 gid_t gid;
382 char *basename;
383 char *dirname;
384 char *basedir;
385 char *link;
386 char *sum;
387 unsigned short flags;
388};
389
390
391#define ARENA_SIZE (32 * 1024)
392
393struct string_area {
394 char *base;
395 char *end;
396 char *current;
397 struct string_area *next;
398};
399
400struct file_list {
401 int count;
402 int malloced;
403 struct file_struct **files;
404 struct string_area *string_area;
405};
406
407struct sum_buf {
408 OFF_T offset; /**< offset in file of this chunk */
409 unsigned int len; /**< length of chunk of file */
410 int i; /**< index of this chunk */
411 uint32 sum1; /**< simple checksum */
412 char sum2[SUM_LENGTH]; /**< checksum */
413};
414
415struct sum_struct {
416 OFF_T flength; /**< total file length */
417 size_t count; /**< how many chunks */
418 unsigned int blength; /**< block_length */
419 unsigned int remainder; /**< flength % block_length */
420 int s2length; /**< sum2_length */
421 struct sum_buf *sums; /**< points to info for each chunk */
422};
423
424struct map_struct {
425 char *p; /* Window pointer */
426 int fd; /* File Descriptor */
427 int p_size; /* Window size at allocation */
428 int p_len; /* Window size after fill */
429 /* p_size and p_len could be
430 * consolodated by using a local
431 * variable in map_ptr() */
432 int status; /* first errno from read errors */
433 OFF_T file_size; /* File size (from stat) */
434 OFF_T p_offset; /* Window start */
435 OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */
436};
437
438#define MATCHFLG_WILD (1<<0) /* pattern has '*', '[', and/or '?' */
439#define MATCHFLG_WILD2 (1<<1) /* pattern has '**' */
440#define MATCHFLG_WILD2_PREFIX (1<<2) /* pattern starts with '**' */
441#define MATCHFLG_ABS_PATH (1<<3) /* path-match on absolute path */
442struct exclude_struct {
443 char *pattern;
444 int match_flags;
445 int include;
446 int directory;
447 int slash_cnt;
448};
449
450struct stats {
451 int64 total_size;
452 int64 total_transferred_size;
453 int64 total_written;
454 int64 total_read;
455 int64 literal_data;
456 int64 matched_data;
457 int flist_size;
458 int num_files;
459 int num_transferred_files;
460};
461
462
463/* we need this function because of the silly way in which duplicate
464 entries are handled in the file lists - we can't change this
465 without breaking existing versions */
466static inline int flist_up(struct file_list *flist, int i)
467{
468 while (!flist->files[i]->basename) i++;
469 return i;
470}
471
472#include "byteorder.h"
473#include "lib/mdfour.h"
474#include "lib/wildmatch.h"
475#include "lib/permstring.h"
476#include "lib/addrinfo.h"
477
478#include "proto.h"
479
480/* We have replacement versions of these if they're missing. */
481#ifndef HAVE_ASPRINTF
482int asprintf(char **ptr, const char *format, ...);
483#endif
484
485#ifndef HAVE_VASPRINTF
486int vasprintf(char **ptr, const char *format, va_list ap);
487#endif
488
489#if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
490#define vsnprintf rsync_vsnprintf
491int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
492#endif
493
494#if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
495#define snprintf rsync_snprintf
496int snprintf(char *str,size_t count,const char *fmt,...);
497#endif
498
499
500#if !HAVE_STRERROR
501extern char *sys_errlist[];
502#define strerror(i) sys_errlist[i]
503#endif
504
505#ifndef HAVE_STRCHR
506# define strchr index
507# define strrchr rindex
508#endif
509
510#ifndef HAVE_ERRNO_DECL
511extern int errno;
512#endif
513
514#define SUPPORT_LINKS HAVE_READLINK
515#define SUPPORT_HARD_LINKS HAVE_LINK
516
517/* This could be bad on systems which have no lchown and where chown
518 * follows symbollic links. On such systems it might be better not to
519 * try to chown symlinks at all. */
520#ifndef HAVE_LCHOWN
521#define lchown chown
522#endif
523
524#define SIGNAL_CAST (RETSIGTYPE (*)())
525
526#ifndef EWOULDBLOCK
527#define EWOULDBLOCK EAGAIN
528#endif
529
530#ifndef STDIN_FILENO
531#define STDIN_FILENO 0
532#endif
533
534#ifndef STDOUT_FILENO
535#define STDOUT_FILENO 1
536#endif
537
538#ifndef STDERR_FILENO
539#define STDERR_FILENO 2
540#endif
541
542#ifndef S_IWUSR
543#define S_IWUSR 0200
544#endif
545
546#ifndef ACCESSPERMS
547#define ACCESSPERMS 0777
548#endif
549
550#ifndef S_ISVTX
551#define S_ISVTX 0
552#endif
553
554#define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
555
556#ifndef _S_IFMT
557#define _S_IFMT 0170000
558#endif
559
560#ifndef _S_IFLNK
561#define _S_IFLNK 0120000
562#endif
563
564#ifndef S_ISLNK
565#define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
566#endif
567
568#ifndef S_ISBLK
569#define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
570#endif
571
572#ifndef S_ISCHR
573#define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
574#endif
575
576#ifndef S_ISSOCK
577#ifdef _S_IFSOCK
578#define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
579#else
580#define S_ISSOCK(mode) (0)
581#endif
582#endif
583
584#ifndef S_ISFIFO
585#ifdef _S_IFIFO
586#define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
587#else
588#define S_ISFIFO(mode) (0)
589#endif
590#endif
591
592#ifndef S_ISDIR
593#define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
594#endif
595
596#ifndef S_ISREG
597#define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
598#endif
599
600/* work out what fcntl flag to use for non-blocking */
601#ifdef O_NONBLOCK
602# define NONBLOCK_FLAG O_NONBLOCK
603#elif defined(SYSV)
604# define NONBLOCK_FLAG O_NDELAY
605#else
606# define NONBLOCK_FLAG FNDELAY
607#endif
608
609#ifndef INADDR_LOOPBACK
610#define INADDR_LOOPBACK 0x7f000001
611#endif
612
613#ifndef INADDR_NONE
614#define INADDR_NONE 0xffffffff
615#endif
616
617#define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
618
619/* Initial mask on permissions given to temporary files. Mask off setuid
620 bits and group access because of potential race-condition security
621 holes, and mask other access because mode 707 is bizarre */
622#define INITACCESSPERMS 0700
623
624/* handler for null strings in printf format */
625#define NS(s) ((s)?(s):"<NULL>")
626
627#if !defined(__GNUC__) || defined(APPLE)
628/* Apparently the OS X port of gcc gags on __attribute__.
629 *
630 * <http://www.opensource.apple.com/bugs/X/gcc/2512150.html> */
631#define __attribute__(x)
632
633#endif
634
635/* Convenient wrappers for malloc and realloc. Use them. */
636#define new(type) ((type *)malloc(sizeof(type)))
637#define new_array(type, num) ((type *)_new_array(sizeof(type), (num)))
638#define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num)))
639
640/* use magic gcc attributes to catch format errors */
641 void rprintf(enum logcode , const char *, ...)
642 __attribute__((format (printf, 2, 3)))
643;
644
645/* This is just like rprintf, but it also tries to print some
646 * representation of the error code. Normally errcode = errno. */
647void rsyserr(enum logcode, int, const char *, ...)
648 __attribute__((format (printf, 3, 4)))
649 ;
650
651#ifdef REPLACE_INET_NTOA
652#define inet_ntoa rep_inet_ntoa
653#endif
654
655/* Make sure that the O_BINARY flag is defined. */
656#ifndef O_BINARY
657#define O_BINARY 0
658#endif
659
660#ifndef HAVE_STRLCPY
661size_t strlcpy(char *d, const char *s, size_t bufsize);
662#endif
663
664#ifndef HAVE_STRLCAT
665size_t strlcat(char *d, const char *s, size_t bufsize);
666#endif
667
668#ifndef WEXITSTATUS
669#define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
670#endif
671
672#define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
673
674
675extern int verbose;
676
677#ifndef HAVE_INET_NTOP
678const char *
679inet_ntop(int af, const void *src, char *dst, size_t size);
680#endif /* !HAVE_INET_NTOP */
681
682#ifndef HAVE_INET_PTON
683int inet_pton(int af, const char *src, void *dst);
684#endif
685
686#ifdef MAINTAINER_MODE
687const char *get_panic_action(void);
688#endif
689
690#define UNUSED(x) x __attribute__((__unused__))
691
692extern const char *io_write_phase, *io_read_phase;