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