Fix m4 quoting to make autoconf2.50 happy. I checked it still works
[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 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#define False 0
22#define True 1
23
24#define BLOCK_SIZE 700
25#define RSYNC_RSH_ENV "RSYNC_RSH"
26
27#define RSYNC_NAME "rsync"
28#define RSYNCD_CONF "/etc/rsyncd.conf"
29
30#define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
31#define URL_PREFIX "rsync://"
32
33#define BACKUP_SUFFIX "~"
34
35/* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
36 incompatible with older versions :-( */
37#define CHAR_OFFSET 0
38
39
40#define FLAG_DELETE (1<<0)
41#define SAME_MODE (1<<1)
42#define SAME_RDEV (1<<2)
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
50/* update this if you make incompatible changes */
51#define PROTOCOL_VERSION 24
52#define MIN_PROTOCOL_VERSION 15
53#define MAX_PROTOCOL_VERSION 30
54
55#define RSYNC_PORT 873
56
57#define SPARSE_WRITE_SIZE (1024)
58#define WRITE_SIZE (32*1024)
59#define CHUNK_SIZE (32*1024)
60#define MAX_MAP_SIZE (256*1024)
61#define IO_BUFFER_SIZE (4092)
62
63#define MAX_ARGS 1000
64
65#define MPLEX_BASE 7
66
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. */
70enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 };
71
72#include "errcode.h"
73
74#include "config.h"
75
76#if HAVE_REMSH
77#define RSYNC_RSH "remsh"
78#else
79#define RSYNC_RSH "rsh"
80#endif
81
82#include <sys/types.h>
83
84#ifdef HAVE_UNISTD_H
85#include <unistd.h>
86#endif
87#include <stdio.h>
88#include <stddef.h>
89
90#ifdef HAVE_SYS_PARAM_H
91#include <sys/param.h>
92#endif
93
94#ifdef HAVE_STDLIB_H
95#include <stdlib.h>
96#endif
97
98#ifdef HAVE_SYS_SOCKET_H
99#include <sys/socket.h>
100#endif
101
102#ifdef HAVE_STRING_H
103#include <string.h>
104#endif
105
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
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
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
151#ifdef HAVE_UTIME_H
152#include <utime.h>
153#endif
154
155#ifdef HAVE_SYS_SELECT_H
156#include <sys/select.h>
157#endif
158
159#ifdef HAVE_SYS_MODE_H
160/* apparently AIX needs this for S_ISLNK */
161#ifndef S_ISLNK
162#include <sys/mode.h>
163#endif
164#endif
165
166#ifdef HAVE_FNMATCH
167#include <fnmatch.h>
168#else
169#include "lib/fnmatch.h"
170#endif
171
172#ifdef HAVE_GLOB_H
173#include <glob.h>
174#endif
175
176/* these are needed for the uid/gid mapping code */
177#include <pwd.h>
178#include <grp.h>
179
180#include <stdarg.h>
181#include <netinet/in.h>
182#include <arpa/inet.h>
183#include <netdb.h>
184#include <syslog.h>
185#include <sys/file.h>
186
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
207#define BOOL int
208
209#ifndef uchar
210#define uchar unsigned char
211#endif
212
213#if HAVE_UNSIGNED_CHAR
214#define schar signed char
215#else
216#define schar char
217#endif
218
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
226#else
227/* I hope this works */
228#define int32 int
229#define LARGE_INT32
230#endif
231#endif
232
233#ifndef uint32
234#define uint32 unsigned int32
235#endif
236
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)
248#define int64 long
249#elif (SIZEOF_INT == 8)
250#define int64 int
251#elif HAVE_LONGLONG
252#define int64 long long
253#else
254#define int64 off_t
255#define NO_INT64
256#endif
257
258#if HAVE_SHORT_INO_T
259#define INO_T uint32
260#else
261#define INO_T ino_t
262#endif
263
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
272#ifndef MAXHOSTNAMELEN
273#define MAXHOSTNAMELEN 256
274#endif
275
276/* the length of the md4 checksum */
277#define MD4_SUM_LENGTH 16
278#define SUM_LENGTH 16
279
280#ifndef MAXPATHLEN
281#define MAXPATHLEN 1024
282#endif
283
284#ifndef INADDR_NONE
285#define INADDR_NONE 0xffffffff
286#endif
287
288struct file_struct {
289 unsigned flags;
290 time_t modtime;
291 OFF_T length;
292 mode_t mode;
293 INO_T inode;
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;
302 char *sum;
303};
304
305
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
315struct file_list {
316 int count;
317 int malloced;
318 struct file_struct **files;
319 struct string_area *string_area;
320};
321
322struct sum_buf {
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 */
328};
329
330struct sum_struct {
331 OFF_T flength; /* total file length */
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
338struct map_struct {
339 char *p;
340 int fd,p_size,p_len;
341 OFF_T file_size, p_offset, p_fd_offset;
342};
343
344struct exclude_struct {
345 char *pattern;
346 int regular_exp;
347 int fnmatch_flags;
348 int include;
349 int directory;
350 int local;
351};
352
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
365
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 */
369static inline int flist_up(struct file_list *flist, int i)
370{
371 while (!flist->files[i]->basename) i++;
372 return i;
373}
374
375#include "byteorder.h"
376#include "version.h"
377#include "proto.h"
378#include "lib/mdfour.h"
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
390#ifndef HAVE_ERRNO_DECL
391extern int errno;
392#endif
393
394#define SUPPORT_LINKS HAVE_READLINK
395#define SUPPORT_HARD_LINKS HAVE_LINK
396
397#ifndef HAVE_LCHOWN
398#define lchown chown
399#endif
400
401#define SIGNAL_CAST (RETSIGTYPE (*)())
402
403#ifndef EWOULDBLOCK
404#define EWOULDBLOCK EAGAIN
405#endif
406
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
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
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
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
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
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
476
477#define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
478
479#ifndef ACCESSPERMS
480#define ACCESSPERMS 0777
481#endif
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 */
485#define INITACCESSPERMS 0700
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 */
491 void rprintf(enum logcode , const char *, ...)
492#ifdef __GNUC__
493 __attribute__ ((format (printf, 2, 3)))
494#endif
495;
496
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
505#ifdef REPLACE_INET_NTOA
506#define inet_ntoa rep_inet_ntoa
507#endif
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
518#ifndef WEXITSTATUS
519#define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
520#endif
521
522#define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)