preparing for release of 2.0.18
[rsync.git] / rsync.h
blobdeb20a23581df6b8e55828e6164fe0158a23f3f9
1 /*
2 Copyright (C) Andrew Tridgell 1996
3 Copyright (C) Paul Mackerras 1996
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #define BLOCK_SIZE 700
21 #define RSYNC_RSH_ENV "RSYNC_RSH"
23 #define RSYNC_NAME "rsync"
24 #define RSYNCD_CONF "/etc/rsyncd.conf"
26 #define BACKUP_SUFFIX "~"
28 /* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
29 imcompatible with older versions :-( */
30 #define CHAR_OFFSET 0
33 #define FLAG_DELETE (1<<0)
34 #define SAME_MODE (1<<1)
35 #define SAME_RDEV (1<<2)
36 #define SAME_UID (1<<3)
37 #define SAME_GID (1<<4)
38 #define SAME_DIR (1<<5)
39 #define SAME_NAME SAME_DIR
40 #define LONG_NAME (1<<6)
41 #define SAME_TIME (1<<7)
43 /* update this if you make incompatible changes */
44 #define PROTOCOL_VERSION 19
45 #define MIN_PROTOCOL_VERSION 11
46 #define MAX_PROTOCOL_VERSION 30
48 #define RSYNC_PORT 873
50 #define SPARSE_WRITE_SIZE (1024)
51 #define WRITE_SIZE (32*1024)
52 #define CHUNK_SIZE (32*1024)
53 #define MAX_MAP_SIZE (1*1024*1024)
54 #define IO_BUFFER_SIZE (4092)
55 #define MAX_READ_BUFFER (1024*1024)
57 #define MAX_ARGS 1000
59 #define MPLEX_BASE 7
60 #define FERROR 1
61 #define FINFO 2
63 #include "config.h"
65 #if HAVE_REMSH
66 #define RSYNC_RSH "remsh"
67 #else
68 #define RSYNC_RSH "rsh"
69 #endif
71 #include <sys/types.h>
72 #ifdef HAVE_UNISTD_H
73 #include <unistd.h>
74 #endif
75 #include <stdio.h>
76 #include <stddef.h>
78 #ifdef HAVE_SYS_PARAM_H
79 #include <sys/param.h>
80 #endif
82 #ifdef HAVE_STDLIB_H
83 #include <stdlib.h>
84 #endif
86 #ifdef HAVE_SYS_SOCKET_H
87 #include <sys/socket.h>
88 #endif
90 #ifdef HAVE_STRING_H
91 #include <string.h>
92 #endif
94 #ifdef HAVE_MALLOC_H
95 #include <malloc.h>
96 #endif
98 #ifdef TIME_WITH_SYS_TIME
99 #include <sys/time.h>
100 #include <time.h>
101 #else
102 #ifdef HAVE_SYS_TIME_H
103 #include <sys/time.h>
104 #else
105 #include <time.h>
106 #endif
107 #endif
109 #ifdef HAVE_FCNTL_H
110 #include <fcntl.h>
111 #else
112 #ifdef HAVE_SYS_FCNTL_H
113 #include <sys/fcntl.h>
114 #endif
115 #endif
117 #include <sys/stat.h>
119 #ifdef HAVE_SYS_IOCTL_H
120 #include <sys/ioctl.h>
121 #endif
123 #ifdef HAVE_SYS_FILIO_H
124 #include <sys/filio.h>
125 #endif
127 #include <signal.h>
128 #ifdef HAVE_SYS_WAIT_H
129 #include <sys/wait.h>
130 #endif
131 #ifdef HAVE_CTYPE_H
132 #include <ctype.h>
133 #endif
134 #ifdef HAVE_GRP_H
135 #include <grp.h>
136 #endif
137 #include <errno.h>
139 #if defined(HAVE_MMAP) && defined(HAVE_MUNMAP)
140 #include <sys/mman.h>
141 #define USE_MMAP 1
142 #endif
144 #ifdef HAVE_UTIME_H
145 #include <utime.h>
146 #endif
148 #ifdef HAVE_SYS_SELECT_H
149 #include <sys/select.h>
150 #endif
152 #ifdef HAVE_SYS_MODE_H
153 /* apparently AIX needs this for S_ISLNK */
154 #ifndef S_ISLNK
155 #include <sys/mode.h>
156 #endif
157 #endif
159 #ifdef HAVE_FNMATCH
160 #include <fnmatch.h>
161 #else
162 #include "lib/fnmatch.h"
163 #endif
165 #ifdef HAVE_GETOPT_LONG
166 #include <getopt.h>
167 #else
168 #include "lib/getopt.h"
169 #endif
171 #ifdef HAVE_GLOB
172 #include <glob.h>
173 #endif
175 /* these are needed for the uid/gid mapping code */
176 #include <pwd.h>
177 #include <grp.h>
179 #include <stdarg.h>
180 #include <netinet/in.h>
181 #include <arpa/inet.h>
182 #include <netdb.h>
183 #include <syslog.h>
184 #include <sys/file.h>
186 #if HAVE_DIRENT_H
187 # include <dirent.h>
188 #else
189 # define dirent direct
190 # if HAVE_SYS_NDIR_H
191 # include <sys/ndir.h>
192 # endif
193 # if HAVE_SYS_DIR_H
194 # include <sys/dir.h>
195 # endif
196 # if HAVE_NDIR_H
197 # include <ndir.h>
198 # endif
199 #endif
201 #ifdef HAVE_COMPAT_H
202 #include <compat.h>
203 #endif
206 #ifndef S_IFLNK
207 #define S_IFLNK 0120000
208 #endif
210 #ifndef S_ISLNK
211 #define S_ISLNK(mode) (((mode) & S_IFLNK) == S_IFLNK)
212 #endif
214 #define BOOL int
216 #ifndef uchar
217 #define uchar unsigned char
218 #endif
220 #if HAVE_UNSIGNED_CHAR
221 #define schar signed char
222 #else
223 #define schar char
224 #endif
226 #ifndef int32
227 #if (SIZEOF_INT == 4)
228 #define int32 int
229 #elif (SIZEOF_LONG == 4)
230 #define int32 long
231 #elif (SIZEOF_SHORT == 4)
232 #define int32 short
233 #endif
234 #endif
236 #ifndef uint32
237 #define uint32 unsigned int32
238 #endif
240 #if HAVE_OFF64_T
241 #define OFF_T off64_t
242 #define STRUCT_STAT struct stat64
243 #else
244 #define OFF_T off_t
245 #define STRUCT_STAT struct stat
246 #endif
248 #if HAVE_OFF64_T
249 #define int64 off64_t
250 #elif (SIZEOF_LONG == 8)
251 #define int64 long
252 #elif (SIZEOF_INT == 8)
253 #define int64 int
254 #elif HAVE_LONGLONG
255 #define int64 long long
256 #else
257 #define int64 off_t
258 #define NO_INT64
259 #endif
261 #ifndef MIN
262 #define MIN(a,b) ((a)<(b)?(a):(b))
263 #endif
265 #ifndef MAX
266 #define MAX(a,b) ((a)>(b)?(a):(b))
267 #endif
269 /* the length of the md4 checksum */
270 #define MD4_SUM_LENGTH 16
271 #define SUM_LENGTH 16
273 #ifndef MAXPATHLEN
274 #define MAXPATHLEN 1024
275 #endif
277 #ifndef INADDR_NONE
278 #define INADDR_NONE 0xffffffff
279 #endif
281 struct file_struct {
282 unsigned flags;
283 time_t modtime;
284 OFF_T length;
285 mode_t mode;
286 ino_t inode;
287 dev_t dev;
288 dev_t rdev;
289 uid_t uid;
290 gid_t gid;
291 char *basename;
292 char *dirname;
293 char *basedir;
294 char *link;
295 char *sum;
298 struct file_list {
299 int count;
300 int malloced;
301 struct file_struct **files;
304 struct sum_buf {
305 OFF_T offset; /* offset in file of this chunk */
306 int len; /* length of chunk of file */
307 int i; /* index of this chunk */
308 uint32 sum1; /* simple checksum */
309 char sum2[SUM_LENGTH]; /* checksum */
312 struct sum_struct {
313 OFF_T flength; /* total file length */
314 int count; /* how many chunks */
315 int remainder; /* flength % block_length */
316 int n; /* block_length */
317 struct sum_buf *sums; /* points to info for each chunk */
320 struct map_struct {
321 char *map,*p;
322 int fd,p_size,p_len;
323 OFF_T size, p_offset;
326 struct exclude_struct {
327 char *orig;
328 char *pattern;
329 int regular_exp;
330 int include;
331 int directory;
332 int local;
335 struct stats {
336 int64 total_size;
337 int64 total_transferred_size;
338 int64 total_written;
339 int64 total_read;
340 int64 literal_data;
341 int64 matched_data;
342 int flist_size;
343 int num_files;
344 int num_transferred_files;
348 /* we need this function because of the silly way in which duplicate
349 entries are handled in the file lists - we can't change this
350 without breaking existing versions */
351 static inline int flist_up(struct file_list *flist, int i)
353 while (!flist->files[i]->basename) i++;
354 return i;
357 #include "byteorder.h"
358 #include "version.h"
359 #include "proto.h"
360 #include "md4.h"
362 #if !HAVE_STRERROR
363 extern char *sys_errlist[];
364 #define strerror(i) sys_errlist[i]
365 #endif
367 #ifndef HAVE_STRCHR
368 # define strchr index
369 # define strrchr rindex
370 #endif
372 #ifndef HAVE_ERRNO_DECL
373 extern int errno;
374 #endif
376 #define SUPPORT_LINKS HAVE_READLINK
377 #define SUPPORT_HARD_LINKS HAVE_LINK
379 #ifndef HAVE_LCHOWN
380 #define lchown chown
381 #endif
383 #define SIGNAL_CAST (RETSIGTYPE (*)())
385 #ifndef EWOULDBLOCK
386 #define EWOULDBLOCK EAGAIN
387 #endif
389 #ifndef STDIN_FILENO
390 #define STDIN_FILENO 0
391 #endif
393 #ifndef STDOUT_FILENO
394 #define STDOUT_FILENO 1
395 #endif
397 #ifndef STDERR_FILENO
398 #define STDERR_FILENO 2
399 #endif
401 #ifndef S_IWUSR
402 #define S_IWUSR 0200
403 #endif
405 #ifndef S_ISBLK
406 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
407 #endif
409 #ifndef S_ISCHR
410 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
411 #endif
413 #ifndef S_ISSOCK
414 #ifdef _S_IFSOCK
415 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
416 #else
417 #define S_ISSOCK(mode) (0)
418 #endif
419 #endif
421 #ifndef S_ISFIFO
422 #ifdef _S_IFIFO
423 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
424 #else
425 #define S_ISFIFO(mode) (0)
426 #endif
427 #endif
429 #ifndef S_ISDIR
430 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
431 #endif
433 #ifndef S_ISREG
434 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
435 #endif
438 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
440 #ifndef ACCESSPERMS
441 #define ACCESSPERMS 0777
442 #endif