Fix m4 quoting to make autoconf2.50 happy. I checked it still works
[rsync/rsync.git] / rsync.h
CommitLineData
c627d613 1/*
a039749b 2 Copyright (C) by Andrew Tridgell 1996, 2000
c627d613 3 Copyright (C) Paul Mackerras 1996
e420b9d8 4 Copyright (C) 2001 by Martin Pool <mbp@samba.org>
c627d613
AT
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
d41c7d02
DD
21#define False 0
22#define True 1
23
c627d613
AT
24#define BLOCK_SIZE 700
25#define RSYNC_RSH_ENV "RSYNC_RSH"
7b8356d0 26
c627d613 27#define RSYNC_NAME "rsync"
f0fca04e 28#define RSYNCD_CONF "/etc/rsyncd.conf"
f0fca04e 29
5e71c444 30#define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
f7632fc6
AT
31#define URL_PREFIX "rsync://"
32
c627d613
AT
33#define BACKUP_SUFFIX "~"
34
1b01b295 35/* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
6543dc0c 36 incompatible with older versions :-( */
1b01b295
AT
37#define CHAR_OFFSET 0
38
39
3333ffbd 40#define FLAG_DELETE (1<<0)
4fe159a8 41#define SAME_MODE (1<<1)
dc5ddbcc 42#define SAME_RDEV (1<<2)
4fe159a8
AT
43#define SAME_UID (1<<3)
44#define SAME_GID (1<<4)
45#define SAME_DIR (1<<5)
46#define SAME_NAME SAME_DIR
47#define LONG_NAME (1<<6)
48#define SAME_TIME (1<<7)
49
c627d613 50/* update this if you make incompatible changes */
8ada7518 51#define PROTOCOL_VERSION 24
ff41a59f 52#define MIN_PROTOCOL_VERSION 15
6ba9279f 53#define MAX_PROTOCOL_VERSION 30
c627d613 54
9486289c
AT
55#define RSYNC_PORT 873
56
d867229b 57#define SPARSE_WRITE_SIZE (1024)
dc5ddbcc 58#define WRITE_SIZE (32*1024)
34ccb63e 59#define CHUNK_SIZE (32*1024)
4440b8aa 60#define MAX_MAP_SIZE (256*1024)
e3fe383a 61#define IO_BUFFER_SIZE (4092)
c627d613 62
874895d5 63#define MAX_ARGS 1000
f0fca04e 64
8d9dc9f9 65#define MPLEX_BASE 7
ff41a59f 66
e420b9d8
MP
67/* Log values. I *think* what these mean is: FLOG goes to the server
68 * logfile; FERROR and FINFO try to end up on the client, with
69 * different levels of filtering. */
a039749b 70enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 };
7bec6a5c 71
65417579
AT
72#include "errcode.h"
73
c627d613
AT
74#include "config.h"
75
24d95c03
AT
76#if HAVE_REMSH
77#define RSYNC_RSH "remsh"
78#else
79#define RSYNC_RSH "rsh"
80#endif
81
c627d613 82#include <sys/types.h>
6ed67e6d 83
c627d613
AT
84#ifdef HAVE_UNISTD_H
85#include <unistd.h>
86#endif
87#include <stdio.h>
3591c066 88#include <stddef.h>
c627d613
AT
89
90#ifdef HAVE_SYS_PARAM_H
91#include <sys/param.h>
92#endif
93
d7b305fd
AT
94#ifdef HAVE_STDLIB_H
95#include <stdlib.h>
96#endif
97
fdd71e17
AT
98#ifdef HAVE_SYS_SOCKET_H
99#include <sys/socket.h>
100#endif
101
d7b305fd
AT
102#ifdef HAVE_STRING_H
103#include <string.h>
c627d613
AT
104#endif
105
c627d613
AT
106#ifdef HAVE_MALLOC_H
107#include <malloc.h>
108#endif
109
110#ifdef TIME_WITH_SYS_TIME
111#include <sys/time.h>
112#include <time.h>
113#else
114#ifdef HAVE_SYS_TIME_H
115#include <sys/time.h>
116#else
117#include <time.h>
118#endif
119#endif
120
121#ifdef HAVE_FCNTL_H
122#include <fcntl.h>
123#else
124#ifdef HAVE_SYS_FCNTL_H
125#include <sys/fcntl.h>
126#endif
127#endif
128
129#include <sys/stat.h>
130
94481d91
AT
131#ifdef HAVE_SYS_IOCTL_H
132#include <sys/ioctl.h>
133#endif
134
135#ifdef HAVE_SYS_FILIO_H
136#include <sys/filio.h>
137#endif
138
c627d613
AT
139#include <signal.h>
140#ifdef HAVE_SYS_WAIT_H
141#include <sys/wait.h>
142#endif
143#ifdef HAVE_CTYPE_H
144#include <ctype.h>
145#endif
146#ifdef HAVE_GRP_H
147#include <grp.h>
148#endif
149#include <errno.h>
150
c627d613
AT
151#ifdef HAVE_UTIME_H
152#include <utime.h>
153#endif
154
8bf73749
AT
155#ifdef HAVE_SYS_SELECT_H
156#include <sys/select.h>
157#endif
158
773f2bd4
AT
159#ifdef HAVE_SYS_MODE_H
160/* apparently AIX needs this for S_ISLNK */
05a6556d 161#ifndef S_ISLNK
773f2bd4
AT
162#include <sys/mode.h>
163#endif
05a6556d 164#endif
773f2bd4 165
c627d613
AT
166#ifdef HAVE_FNMATCH
167#include <fnmatch.h>
168#else
169#include "lib/fnmatch.h"
170#endif
171
932be9aa 172#ifdef HAVE_GLOB_H
874895d5
AT
173#include <glob.h>
174#endif
175
f6c34742
AT
176/* these are needed for the uid/gid mapping code */
177#include <pwd.h>
178#include <grp.h>
179
9486289c 180#include <stdarg.h>
f0fca04e
AT
181#include <netinet/in.h>
182#include <arpa/inet.h>
183#include <netdb.h>
ff8b29b8 184#include <syslog.h>
6c8f5373 185#include <sys/file.h>
9486289c 186
e8f5b936
AT
187#if HAVE_DIRENT_H
188# include <dirent.h>
189#else
190# define dirent direct
191# if HAVE_SYS_NDIR_H
192# include <sys/ndir.h>
193# endif
194# if HAVE_SYS_DIR_H
195# include <sys/dir.h>
196# endif
197# if HAVE_NDIR_H
198# include <ndir.h>
199# endif
200#endif
201
202#ifdef HAVE_COMPAT_H
203#include <compat.h>
204#endif
205
206
f0fca04e
AT
207#define BOOL int
208
c627d613
AT
209#ifndef uchar
210#define uchar unsigned char
211#endif
212
debb4505
AT
213#if HAVE_UNSIGNED_CHAR
214#define schar signed char
215#else
216#define schar char
217#endif
218
c627d613
AT
219#ifndef int32
220#if (SIZEOF_INT == 4)
221#define int32 int
222#elif (SIZEOF_LONG == 4)
223#define int32 long
224#elif (SIZEOF_SHORT == 4)
225#define int32 short
8de330a3
AT
226#else
227/* I hope this works */
228#define int32 int
f3737e06 229#define LARGE_INT32
c627d613
AT
230#endif
231#endif
232
233#ifndef uint32
234#define uint32 unsigned int32
235#endif
236
bcacc18b
AT
237#if HAVE_OFF64_T
238#define OFF_T off64_t
239#define STRUCT_STAT struct stat64
240#else
241#define OFF_T off_t
242#define STRUCT_STAT struct stat
243#endif
244
245#if HAVE_OFF64_T
246#define int64 off64_t
247#elif (SIZEOF_LONG == 8)
3bee6733
AT
248#define int64 long
249#elif (SIZEOF_INT == 8)
250#define int64 int
251#elif HAVE_LONGLONG
71c46176
AT
252#define int64 long long
253#else
254#define int64 off_t
3bee6733 255#define NO_INT64
71c46176 256#endif
c627d613 257
c29ee43d
AT
258#if HAVE_SHORT_INO_T
259#define INO_T uint32
260#else
261#define INO_T ino_t
262#endif
263
c627d613
AT
264#ifndef MIN
265#define MIN(a,b) ((a)<(b)?(a):(b))
266#endif
267
268#ifndef MAX
269#define MAX(a,b) ((a)>(b)?(a):(b))
270#endif
271
d41c7d02
DD
272#ifndef MAXHOSTNAMELEN
273#define MAXHOSTNAMELEN 256
274#endif
275
c627d613 276/* the length of the md4 checksum */
ebb0a6f6 277#define MD4_SUM_LENGTH 16
c627d613
AT
278#define SUM_LENGTH 16
279
280#ifndef MAXPATHLEN
281#define MAXPATHLEN 1024
282#endif
283
0473e2a1
AT
284#ifndef INADDR_NONE
285#define INADDR_NONE 0xffffffff
286#endif
287
c627d613 288struct file_struct {
3333ffbd 289 unsigned flags;
3ec4dd97 290 time_t modtime;
bcacc18b 291 OFF_T length;
3ec4dd97 292 mode_t mode;
c29ee43d 293 INO_T inode;
3ec4dd97
AT
294 dev_t dev;
295 dev_t rdev;
296 uid_t uid;
297 gid_t gid;
298 char *basename;
299 char *dirname;
300 char *basedir;
301 char *link;
2d0bb8eb 302 char *sum;
c627d613
AT
303};
304
4440b8aa 305
3d382777
AT
306#define ARENA_SIZE (32 * 1024)
307
308struct string_area {
309 char *base;
310 char *end;
311 char *current;
312 struct string_area *next;
313};
314
c627d613 315struct file_list {
a800434a
AT
316 int count;
317 int malloced;
318 struct file_struct **files;
3d382777 319 struct string_area *string_area;
c627d613
AT
320};
321
322struct sum_buf {
c29ee43d
AT
323 OFF_T offset; /* offset in file of this chunk */
324 int len; /* length of chunk of file */
325 int i; /* index of this chunk */
326 uint32 sum1; /* simple checksum */
327 char sum2[SUM_LENGTH]; /* checksum */
c627d613
AT
328};
329
330struct sum_struct {
bcacc18b 331 OFF_T flength; /* total file length */
c627d613
AT
332 int count; /* how many chunks */
333 int remainder; /* flength % block_length */
334 int n; /* block_length */
335 struct sum_buf *sums; /* points to info for each chunk */
336};
337
c6e7fcb4 338struct map_struct {
4440b8aa 339 char *p;
0b910560 340 int fd,p_size,p_len;
4440b8aa 341 OFF_T file_size, p_offset, p_fd_offset;
c6e7fcb4 342};
c627d613 343
2b6b4d53 344struct exclude_struct {
2b6b4d53
AT
345 char *pattern;
346 int regular_exp;
a8b9d4ed 347 int fnmatch_flags;
2b6b4d53
AT
348 int include;
349 int directory;
350 int local;
351};
352
a800434a
AT
353struct stats {
354 int64 total_size;
355 int64 total_transferred_size;
356 int64 total_written;
357 int64 total_read;
358 int64 literal_data;
359 int64 matched_data;
360 int flist_size;
361 int num_files;
362 int num_transferred_files;
363};
364
2b6b4d53 365
3b3a2fbc
AT
366/* we need this function because of the silly way in which duplicate
367 entries are handled in the file lists - we can't change this
368 without breaking existing versions */
71c46176 369static inline int flist_up(struct file_list *flist, int i)
3b3a2fbc 370{
3ec4dd97 371 while (!flist->files[i]->basename) i++;
3b3a2fbc
AT
372 return i;
373}
374
c627d613
AT
375#include "byteorder.h"
376#include "version.h"
377#include "proto.h"
8de330a3 378#include "lib/mdfour.h"
c627d613
AT
379
380#if !HAVE_STRERROR
381extern char *sys_errlist[];
382#define strerror(i) sys_errlist[i]
383#endif
384
385#ifndef HAVE_STRCHR
386# define strchr index
387# define strrchr rindex
388#endif
389
c627d613
AT
390#ifndef HAVE_ERRNO_DECL
391extern int errno;
392#endif
393
cbbe4892 394#define SUPPORT_LINKS HAVE_READLINK
dc5ddbcc 395#define SUPPORT_HARD_LINKS HAVE_LINK
c627d613 396
8bf73749
AT
397#ifndef HAVE_LCHOWN
398#define lchown chown
399#endif
400
ac1eb754 401#define SIGNAL_CAST (RETSIGTYPE (*)())
720b47f2
AT
402
403#ifndef EWOULDBLOCK
404#define EWOULDBLOCK EAGAIN
405#endif
182dca5c 406
7b8356d0
AT
407#ifndef STDIN_FILENO
408#define STDIN_FILENO 0
409#endif
410
411#ifndef STDOUT_FILENO
412#define STDOUT_FILENO 1
413#endif
414
415#ifndef STDERR_FILENO
416#define STDERR_FILENO 2
417#endif
418
419#ifndef S_IWUSR
420#define S_IWUSR 0200
421#endif
422
b280a1f4
AT
423#ifndef _S_IFMT
424#define _S_IFMT 0170000
425#endif
426
427#ifndef _S_IFLNK
428#define _S_IFLNK 0120000
429#endif
430
431#ifndef S_ISLNK
432#define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
433#endif
434
1e9f155a
AT
435#ifndef S_ISBLK
436#define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
437#endif
438
439#ifndef S_ISCHR
440#define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
441#endif
442
a0b65b18
AT
443#ifndef S_ISSOCK
444#ifdef _S_IFSOCK
445#define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
446#else
447#define S_ISSOCK(mode) (0)
448#endif
449#endif
450
451#ifndef S_ISFIFO
452#ifdef _S_IFIFO
453#define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
454#else
455#define S_ISFIFO(mode) (0)
456#endif
457#endif
458
1e9f155a
AT
459#ifndef S_ISDIR
460#define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
461#endif
462
463#ifndef S_ISREG
464#define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
465#endif
466
f0359dd0
AT
467/* work out what fcntl flag to use for non-blocking */
468#ifdef O_NONBLOCK
469# define NONBLOCK_FLAG O_NONBLOCK
470#elif defined(SYSV)
471# define NONBLOCK_FLAG O_NDELAY
472#else
473# define NONBLOCK_FLAG FNDELAY
474#endif
475
a0b65b18
AT
476
477#define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
7bec6a5c 478
972a3619
DD
479#ifndef ACCESSPERMS
480#define ACCESSPERMS 0777
481#endif
5afd8aed
DD
482/* Initial mask on permissions given to temporary files. Mask off setuid
483 bits and group access because of potential race-condition security
484 holes, and mask other access because mode 707 is bizarre */
972a3619 485#define INITACCESSPERMS 0700
e08bfe12
AT
486
487/* handler for null strings in printf format */
488#define NS(s) ((s)?(s):"<NULL>")
489
490/* use magic gcc attributes to catch format errors */
ff41a59f 491 void rprintf(enum logcode , const char *, ...)
e08bfe12
AT
492#ifdef __GNUC__
493 __attribute__ ((format (printf, 2, 3)))
494#endif
495;
7b3d4257 496
a039749b
MP
497/* This is just like rprintf, but it also tries to print some
498 * representation of the error code. Normally errcode = errno. */
499void rsyserr(enum logcode, int, const char *, ...)
500#ifdef __GNUC__
501 __attribute__ ((format (printf, 3, 4)))
502#endif
503 ;
504
7b3d4257
AT
505#ifdef REPLACE_INET_NTOA
506#define inet_ntoa rep_inet_ntoa
507#endif
5a788ade
AT
508
509
510#ifndef HAVE_STRLCPY
511size_t strlcpy(char *d, const char *s, size_t bufsize);
512#endif
513
514#ifndef HAVE_STRLCAT
515size_t strlcat(char *d, const char *s, size_t bufsize);
516#endif
517
82980a23
AT
518#ifndef WEXITSTATUS
519#define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
520#endif
521
a9766ef1 522#define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)