a few code cleanups
[rsync/rsync.git] / rsync.h
1 /* 
2    Copyright (C) Andrew Tridgell 1996
3    Copyright (C) Paul Mackerras 1996
4    
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.
9    
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.
14    
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.
18 */
19
20 #define BLOCK_SIZE 700
21 #define RSYNC_RSH_ENV "RSYNC_RSH"
22
23 #define RSYNC_NAME "rsync"
24 #define BACKUP_SUFFIX "~"
25
26 /* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
27    imcompatible with older versions :-( */
28 #define CHAR_OFFSET 0
29
30
31 #define FILE_VALID 1
32 #define SAME_MODE (1<<1)
33 #define SAME_RDEV (1<<2)
34 #define SAME_UID (1<<3)
35 #define SAME_GID (1<<4)
36 #define SAME_DIR (1<<5)
37 #define SAME_NAME SAME_DIR
38 #define LONG_NAME (1<<6)
39 #define SAME_TIME (1<<7)
40
41 /* update this if you make incompatible changes */
42 #define PROTOCOL_VERSION 17
43 #define MIN_PROTOCOL_VERSION 11
44 #define MAX_PROTOCOL_VERSION 30
45
46 #define SPARSE_WRITE_SIZE (1024)
47 #define WRITE_SIZE (32*1024)
48 #define CHUNK_SIZE (32*1024)
49 #define MAX_MAP_SIZE (4*1024*1024)
50
51 #define BLOCKING_TIMEOUT 10
52
53 #define FERROR stderr
54 #define FINFO (am_server?stderr:stdout)
55
56 #include "config.h"
57
58 #if HAVE_REMSH
59 #define RSYNC_RSH "remsh"
60 #else
61 #define RSYNC_RSH "rsh"
62 #endif
63
64 #include <sys/types.h>
65 #ifdef HAVE_UNISTD_H
66 #include <unistd.h>
67 #endif
68 #include <stdio.h>
69
70 #ifdef HAVE_SYS_PARAM_H
71 #include <sys/param.h>
72 #endif
73
74 #ifdef HAVE_STDLIB_H
75 #include <stdlib.h>
76 #endif
77
78 #ifdef HAVE_SYS_SOCKET_H
79 #include <sys/socket.h>
80 #endif
81
82 #ifdef HAVE_STRING_H
83 #include <string.h>
84 #endif
85
86 #ifdef HAVE_COMPAT_H
87 #include <compat.h>
88 #endif
89
90 #ifdef HAVE_MALLOC_H
91 #include <malloc.h>
92 #endif
93
94 #ifdef TIME_WITH_SYS_TIME
95 #include <sys/time.h>
96 #include <time.h>
97 #else
98 #ifdef HAVE_SYS_TIME_H
99 #include <sys/time.h>
100 #else
101 #include <time.h>
102 #endif
103 #endif
104
105 #ifdef HAVE_FCNTL_H
106 #include <fcntl.h>
107 #else
108 #ifdef HAVE_SYS_FCNTL_H
109 #include <sys/fcntl.h>
110 #endif
111 #endif
112
113 #include <sys/stat.h>
114
115 #ifdef HAVE_SYS_IOCTL_H
116 #include <sys/ioctl.h>
117 #endif
118
119 #ifdef HAVE_SYS_FILIO_H
120 #include <sys/filio.h>
121 #endif
122
123 #include <signal.h>
124 #ifdef HAVE_SYS_WAIT_H
125 #include <sys/wait.h>
126 #endif
127 #ifdef HAVE_CTYPE_H
128 #include <ctype.h>
129 #endif
130 #ifdef HAVE_GRP_H
131 #include <grp.h>
132 #endif
133 #include <errno.h>
134
135 #ifdef HAVE_MMAP
136 #include <sys/mman.h>
137 #endif
138
139 #ifdef HAVE_UTIME_H
140 #include <utime.h>
141 #endif
142
143 #ifdef HAVE_SYS_SELECT_H
144 #include <sys/select.h>
145 #endif
146
147 #ifdef HAVE_SYS_MODE_H
148 /* apparently AIX needs this for S_ISLNK */
149 #ifndef S_ISLNK
150 #include <sys/mode.h>
151 #endif
152 #endif
153
154 #ifdef HAVE_FNMATCH
155 #include <fnmatch.h>
156 #else
157 #include "lib/fnmatch.h"
158 #endif
159
160 #ifdef HAVE_GETOPT_LONG
161 #include <getopt.h>
162 #else
163 #include "lib/getopt.h"
164 #endif
165
166 /* these are needed for the uid/gid mapping code */
167 #include <pwd.h>
168 #include <grp.h>
169
170 #ifndef S_IFLNK
171 #define S_IFLNK  0120000
172 #endif
173
174 #ifndef S_ISLNK
175 #define S_ISLNK(mode) (((mode) & S_IFLNK) == S_IFLNK)
176 #endif
177
178 #ifndef uchar
179 #define uchar unsigned char
180 #endif
181
182 #ifndef int32
183 #if (SIZEOF_INT == 4)
184 #define int32 int
185 #elif (SIZEOF_LONG == 4)
186 #define int32 long
187 #elif (SIZEOF_SHORT == 4)
188 #define int32 short
189 #endif
190 #endif
191
192 #ifndef uint32
193 #define uint32 unsigned int32
194 #endif
195
196 #ifdef HAVE_LONGLONG
197 #define int64 long long
198 #else
199 #define int64 off_t
200 #endif
201
202 #ifndef MIN
203 #define MIN(a,b) ((a)<(b)?(a):(b))
204 #endif
205
206 #ifndef MAX
207 #define MAX(a,b) ((a)>(b)?(a):(b))
208 #endif
209
210 /* the length of the md4 checksum */
211 #define MD4_SUM_LENGTH 16
212 #define SUM_LENGTH 16
213
214 #ifndef MAXPATHLEN
215 #define MAXPATHLEN 1024
216 #endif
217
218 struct file_struct {
219         time_t modtime;
220         off_t length;
221         mode_t mode;
222         ino_t inode;
223         dev_t dev;
224         dev_t rdev;
225         uid_t uid;
226         gid_t gid;
227         char *basename;
228         char *dirname;
229         char *basedir;
230         char *link;
231         char *sum;
232 };
233
234 struct file_list {
235   int count;
236   int malloced;
237   struct file_struct **files;
238 };
239
240 struct sum_buf {
241   off_t offset;                 /* offset in file of this chunk */
242   int len;                      /* length of chunk of file */
243   int i;                        /* index of this chunk */
244   uint32 sum1;                  /* simple checksum */
245   char sum2[SUM_LENGTH];        /* checksum  */
246 };
247
248 struct sum_struct {
249   off_t flength;                /* total file length */
250   int count;                    /* how many chunks */
251   int remainder;                /* flength % block_length */
252   int n;                        /* block_length */
253   struct sum_buf *sums;         /* points to info for each chunk */
254 };
255
256 struct map_struct {
257         char *map,*p;
258         int fd,p_size,p_len;
259         off_t size, p_offset;
260 };
261
262 /* we need this function because of the silly way in which duplicate
263    entries are handled in the file lists - we can't change this
264    without breaking existing versions */
265 static inline int flist_up(struct file_list *flist, int i)
266 {
267         while (!flist->files[i]->basename) i++;
268         return i;
269 }
270
271
272 #include "byteorder.h"
273 #include "version.h"
274 #include "proto.h"
275 #include "md4.h"
276
277 #if !HAVE_STRERROR
278 extern char *sys_errlist[];
279 #define strerror(i) sys_errlist[i]
280 #endif
281
282 #ifndef HAVE_STRCHR
283 # define strchr                 index
284 # define strrchr                rindex
285 #endif
286
287 #if HAVE_DIRENT_H
288 # include <dirent.h>
289 #else
290 # define dirent direct
291 # if HAVE_SYS_NDIR_H
292 #  include <sys/ndir.h>
293 # endif
294 # if HAVE_SYS_DIR_H
295 #  include <sys/dir.h>
296 # endif
297 # if HAVE_NDIR_H
298 #  include <ndir.h>
299 # endif
300 #endif
301
302 #ifndef HAVE_ERRNO_DECL
303 extern int errno;
304 #endif
305
306 #ifndef HAVE_BCOPY
307 #define bcopy(src,dest,n) memcpy(dest,src,n)
308 #endif
309
310 #ifndef HAVE_BZERO
311 #define bzero(buf,n) memset(buf,0,n)
312 #endif
313
314 #define SUPPORT_LINKS HAVE_READLINK
315 #define SUPPORT_HARD_LINKS HAVE_LINK
316
317 #ifndef HAVE_LCHOWN
318 #define lchown chown
319 #endif
320
321 #define SIGNAL_CAST (RETSIGTYPE (*)())
322
323 #ifndef EWOULDBLOCK
324 #define EWOULDBLOCK EAGAIN
325 #endif
326
327 #ifndef STDIN_FILENO
328 #define STDIN_FILENO 0
329 #endif
330
331 #ifndef STDOUT_FILENO
332 #define STDOUT_FILENO 1
333 #endif
334
335 #ifndef STDERR_FILENO
336 #define STDERR_FILENO 2
337 #endif
338
339 #ifndef S_IWUSR
340 #define S_IWUSR 0200
341 #endif
342
343 #ifndef S_ISBLK
344 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
345 #endif
346
347 #ifndef S_ISCHR
348 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
349 #endif
350
351 #ifndef S_ISDIR
352 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
353 #endif
354
355 #ifndef S_ISREG
356 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
357 #endif
358
359 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode))
360