Eliminate unneeded strlen after strlcpy.
[rsync/rsync.git] / rsync.h
1 /* 
2    Copyright (C) by Andrew Tridgell 1996, 2000
3    Copyright (C) Paul Mackerras 1996
4    Copyright (C) 2001, 2002 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
22 #define False 0
23 #define True 1
24
25 #define BLOCK_SIZE 700
26 #define RSYNC_RSH_ENV "RSYNC_RSH"
27 #define RSYNC_RSH_IO_ENV "RSYNC_RSH_IO"
28
29 #define RSYNC_NAME "rsync"
30 #define RSYNCD_SYSCONF "/etc/rsyncd.conf"
31 #define RSYNCD_USERCONF "rsyncd.conf"
32
33 #define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
34 #define URL_PREFIX "rsync://"
35
36 #define BACKUP_SUFFIX "~"
37
38 /* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
39    incompatible with older versions :-( */
40 #define CHAR_OFFSET 0
41
42
43 #define FLAG_DELETE (1<<0)
44 #define SAME_MODE (1<<1)
45 #define EXTENDED_FLAGS (1<<2)
46 #define SAME_RDEV_pre28 EXTENDED_FLAGS /* Only use in protocols < 28 */
47 #define SAME_UID (1<<3)
48 #define SAME_GID (1<<4)
49 #define SAME_DIR (1<<5)
50 #define SAME_NAME SAME_DIR
51 #define LONG_NAME (1<<6)
52 #define SAME_TIME (1<<7)
53 #define SAME_HIGH_RDEV (1<<8)
54 #define HAS_INODE_DATA (1<<9)
55 #define SAME_DEV (1<<10)
56
57 /* What flags are relevant after the transfer of the flist is complete? */
58 #define LIVE_FLAGS FLAG_DELETE
59
60 /* update this if you make incompatible changes */
61 #define PROTOCOL_VERSION 28
62
63 /* We refuse to interoperate with versions that are not in this range.
64  * Note that we assume we'll work with later versions: the onus is on
65  * people writing them to make sure that they don't send us anything
66  * we won't understand.
67  *
68  * Interoperation with old but supported protocol versions
69  * should cause a warning to be printed.  At a future date
70  * the old protocol will become the minimum and
71  * compatibility code removed.
72  *
73  * There are two possible explanations for the limit at
74  * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
75  * do not interoperate with us, and (more likely) so that we can
76  * detect an attempt to connect rsync to a non-rsync server, which is
77  * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
78  * MAX_PROTOCOL_VERSION. */
79
80 #define MIN_PROTOCOL_VERSION 19
81 #define OLD_PROTOCOL_VERSION 20
82 #define MAX_PROTOCOL_VERSION 40
83
84 #define RSYNC_PORT 873
85
86 #define SPARSE_WRITE_SIZE (1024)
87 #define WRITE_SIZE (32*1024)
88 #define CHUNK_SIZE (32*1024)
89 #define MAX_MAP_SIZE (256*1024)
90 #define IO_BUFFER_SIZE (4092)
91
92 #define IOERR_GENERAL   (1<<0) /* For backward compatibility, this must == 1 */
93 #define IOERR_VANISHED  (1<<1)
94
95 #define MAX_ARGS 1000
96
97 #define MPLEX_BASE 7
98
99 #define NO_EXCLUDES     0
100 #define SERVER_EXCLUDES 1
101 #define ALL_EXCLUDES    2
102
103 #define MISSING_OK    0
104 #define MISSING_FATAL 1
105
106 #define ADD_INCLUDE 1
107 #define ADD_EXCLUDE 0
108
109 #define FULL_FLUSH      1
110 #define NORMAL_FLUSH    0
111
112 /* Log-message categories.  FLOG is only used on the daemon side to
113  * output messages to the log file. */
114 enum logcode { FERROR=1, FINFO=2, FLOG=3 };
115
116 /* Messages types that are sent over the message channel.  The logcode
117  * values must all be present here with identical numbers. */
118 enum msgcode {
119         MSG_DATA=0,     /* raw data on the multiplexed stream */
120         MSG_ERROR=FERROR, MSG_INFO=FINFO, MSG_LOG=FLOG, /* remote logging */
121         MSG_REDO=4,     /* reprocess indicated flist index */
122         MSG_DONE=5,     /* current phase is done */
123 };
124
125 #include "errcode.h"
126
127 #include "config.h"
128
129 /* The default RSYNC_RSH is always set in config.h. */
130
131 #include <sys/types.h>
132
133 #ifdef HAVE_UNISTD_H
134 #include <unistd.h>
135 #endif
136 #include <stdio.h>
137 #include <stddef.h>
138
139 #ifdef HAVE_SYS_PARAM_H
140 #include <sys/param.h>
141 #endif
142
143 #ifdef HAVE_STDLIB_H
144 #include <stdlib.h>
145 #endif
146
147 #if defined(HAVE_MALLOC_H) && (defined(HAVE_MALLINFO) || !defined(HAVE_STDLIB_H))
148 #include <malloc.h>
149 #endif
150
151 #ifdef HAVE_SYS_SOCKET_H
152 #include <sys/socket.h>
153 #endif
154
155 #ifdef HAVE_STRING_H
156 #include <string.h>
157 #endif
158
159 #ifdef TIME_WITH_SYS_TIME
160 #include <sys/time.h>
161 #include <time.h>
162 #else
163 #ifdef HAVE_SYS_TIME_H
164 #include <sys/time.h>
165 #else
166 #include <time.h>
167 #endif
168 #endif
169
170 #ifdef HAVE_FCNTL_H
171 #include <fcntl.h>
172 #else
173 #ifdef HAVE_SYS_FCNTL_H
174 #include <sys/fcntl.h>
175 #endif
176 #endif
177
178 #include <sys/stat.h>
179
180 #ifdef HAVE_SYS_IOCTL_H
181 #include <sys/ioctl.h>
182 #endif
183
184 #ifdef HAVE_SYS_FILIO_H
185 #include <sys/filio.h>
186 #endif
187
188 #include <signal.h>
189 #ifdef HAVE_SYS_WAIT_H
190 #include <sys/wait.h>
191 #endif
192 #ifdef HAVE_CTYPE_H
193 #include <ctype.h>
194 #endif
195 #ifdef HAVE_GRP_H
196 #include <grp.h>
197 #endif
198 #include <errno.h>
199
200 #ifdef HAVE_UTIME_H
201 #include <utime.h>
202 #endif
203
204 #ifdef HAVE_SYS_SELECT_H
205 #include <sys/select.h>
206 #endif
207
208 #ifdef HAVE_SYS_MODE_H
209 /* apparently AIX needs this for S_ISLNK */
210 #ifndef S_ISLNK
211 #include <sys/mode.h>
212 #endif
213 #endif
214
215 #ifdef HAVE_GLOB_H
216 #include <glob.h>
217 #endif
218
219 /* these are needed for the uid/gid mapping code */
220 #include <pwd.h>
221 #include <grp.h>
222
223 #include <stdarg.h>
224 #include <netinet/in.h>
225 #include <arpa/inet.h>
226 #include <netdb.h>
227 #include <syslog.h>
228 #include <sys/file.h>
229
230 #if HAVE_DIRENT_H
231 # include <dirent.h>
232 #else
233 # define dirent direct
234 # if HAVE_SYS_NDIR_H
235 #  include <sys/ndir.h>
236 # endif
237 # if HAVE_SYS_DIR_H
238 #  include <sys/dir.h>
239 # endif
240 # if HAVE_NDIR_H
241 #  include <ndir.h>
242 # endif
243 #endif
244
245 #ifdef HAVE_COMPAT_H
246 #include <compat.h>
247 #endif
248
249 #include <assert.h>
250
251
252 #define BOOL int
253
254 #ifndef uchar
255 #define uchar unsigned char
256 #endif
257
258 #if HAVE_UNSIGNED_CHAR
259 #define schar signed char
260 #else
261 #define schar char
262 #endif
263
264 #ifndef int32
265 #if (SIZEOF_INT == 4)
266 #define int32 int
267 #elif (SIZEOF_LONG == 4)
268 #define int32 long
269 #elif (SIZEOF_SHORT == 4)
270 #define int32 short
271 #else
272 /* I hope this works */
273 #define int32 int
274 #define LARGE_INT32
275 #endif
276 #endif
277
278 #ifndef uint32
279 #define uint32 unsigned int32
280 #endif
281
282 #if HAVE_OFF64_T
283 #define OFF_T off64_t
284 #define STRUCT_STAT struct stat64
285 #else
286 #define OFF_T off_t
287 #define STRUCT_STAT struct stat
288 #endif
289
290 #if HAVE_OFF64_T
291 #define int64 off64_t
292 #elif (SIZEOF_LONG == 8) 
293 #define int64 long
294 #elif (SIZEOF_INT == 8) 
295 #define int64 int
296 #elif HAVE_LONGLONG
297 #define int64 long long
298 #else
299 /* As long as it gets... */
300 #define int64 off_t
301 #define NO_INT64
302 #endif
303
304 #if (SIZEOF_LONG == 8) 
305 #define uint64 unsigned long
306 #elif (SIZEOF_INT == 8) 
307 #define uint64 unsigned int
308 #elif HAVE_LONGLONG
309 #define uint64 unsigned long long
310 #else
311 /* As long as it gets... */
312 #define uint64 unsigned off_t
313 #endif
314
315 /* Starting from protocol version 26, we always use 64-bit
316  * ino_t and dev_t internally, even if this platform does not
317  * allow files to have 64-bit inums.  That's because the
318  * receiver needs to find duplicate (dev,ino) tuples to detect
319  * hardlinks, and it might have files coming from a platform
320  * that has 64-bit inums.
321  *
322  * The only exception is if we're on a platform with no 64-bit type at
323  * all.
324  *
325  * Because we use read_longint() to get these off the wire, if you
326  * transfer devices or hardlinks with dev or inum > 2**32 to a machine
327  * with no 64-bit types then you will get an overflow error.  Probably
328  * not many people have that combination of machines, and you can
329  * avoid it by not preserving hardlinks or not transferring device
330  * nodes.  It's not clear that any other behaviour is better.
331  *
332  * Note that if you transfer devices from a 64-bit-devt machine (say,
333  * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the
334  * device numbers will be truncated.  But it's a kind of silly thing
335  * to do anyhow.
336  *
337  * FIXME: In future, we should probable split the device number into
338  * major/minor, and transfer the two parts as 32-bit ints.  That gives
339  * you somewhat more of a chance that they'll come from a big machine
340  * to a little one in a useful way.
341  *
342  * FIXME: Really we need an unsigned type, and we perhaps ought to
343  * cope with platforms on which this is an unsigned int or even a
344  * struct.  Later.
345  */ 
346 #define INO64_T uint64
347 #define DEV64_T uint64
348
349 #ifndef MIN
350 #define MIN(a,b) ((a)<(b)?(a):(b))
351 #endif
352
353 #ifndef MAX
354 #define MAX(a,b) ((a)>(b)?(a):(b))
355 #endif
356
357 #ifndef MAXHOSTNAMELEN
358 #define MAXHOSTNAMELEN 256
359 #endif
360
361 /* the length of the md4 checksum */
362 #define MD4_SUM_LENGTH 16
363 #define SUM_LENGTH 16
364 #define SHORT_SUM_LENGTH 2
365 #define BLOCKSUM_BIAS 10
366
367 #ifndef MAXPATHLEN
368 #define MAXPATHLEN 1024
369 #endif
370
371 #ifndef NAME_MAX
372 #define NAME_MAX 255
373 #endif
374
375 #ifndef INADDR_NONE
376 #define INADDR_NONE 0xffffffff
377 #endif
378
379 #ifndef IN_LOOPBACKNET
380 #define IN_LOOPBACKNET 127
381 #endif
382
383 #define GID_NONE (gid_t) -1
384
385 struct hlink {
386         struct file_struct *head;
387         struct file_struct *next;
388 };
389
390 struct idev {
391         INO64_T inode;
392         DEV64_T dev;
393 };
394
395 #define F_DEV   link_u.idev->dev
396 #define F_INODE link_u.idev->inode
397
398 #define F_HEAD  link_u.links->head
399 #define F_NEXT  link_u.links->next
400
401 struct file_struct {
402         time_t modtime;
403         OFF_T length;
404         mode_t mode;
405         union {
406                 DEV64_T rdev;   /* The device number, if this is a device */
407                 char *sum;      /* Only a normal file can have a checksum */
408                 char *link;     /* Holds symlink string, if a symlink */
409         } u;
410         union {
411                 struct idev *idev;
412                 struct hlink *links;
413         } link_u;
414         char *basename;
415         char *dirname;
416         char *basedir;
417         uid_t uid;
418         gid_t gid;
419         unsigned short flags;
420 };
421
422 #define ARENA_SIZE      (32 * 1024)
423
424 struct string_area {
425         char *base;
426         char *end;
427         char *current;
428         struct string_area *next;
429 };
430
431 struct file_list {
432         int count;
433         int malloced;
434         struct file_struct **files;
435         struct string_area *string_area;
436 };
437
438 struct sum_buf {
439         OFF_T offset;           /**< offset in file of this chunk */
440         unsigned int len;       /**< length of chunk of file */
441         int i;                  /**< index of this chunk */
442         uint32 sum1;            /**< simple checksum */
443         char sum2[SUM_LENGTH];  /**< checksum  */
444 };
445
446 struct sum_struct {
447         OFF_T flength;          /**< total file length */
448         size_t count;           /**< how many chunks */
449         unsigned int blength;   /**< block_length */
450         unsigned int remainder; /**< flength % block_length */
451         int s2length;           /**< sum2_length */
452         struct sum_buf *sums;   /**< points to info for each chunk */
453 };
454
455 struct map_struct {
456         char *p;                /* Window pointer                       */
457         int fd;                 /* File Descriptor                      */
458         int p_size;             /* Window size at allocation            */
459         int p_len;              /* Window size after fill               */
460                                 /*    p_size and p_len could be
461                                  *    consolodated by using a local
462                                  *    variable in map_ptr()             */
463         int status;             /* first errno from read errors         */
464         OFF_T file_size;        /* File size (from stat)                */
465         OFF_T p_offset;         /* Window start                         */
466         OFF_T p_fd_offset;      /* offset of cursor in fd ala lseek     */
467 };
468
469 #define MATCHFLG_WILD           (1<<0) /* pattern has '*', '[', and/or '?' */
470 #define MATCHFLG_WILD2          (1<<1) /* pattern has '**' */
471 #define MATCHFLG_WILD2_PREFIX   (1<<2) /* pattern starts with '**' */
472 #define MATCHFLG_ABS_PATH       (1<<3) /* path-match on absolute path */
473 struct exclude_struct {
474         char *pattern;
475         int match_flags;
476         int include;
477         int directory;
478         int slash_cnt;
479 };
480
481 struct stats {
482         int64 total_size;
483         int64 total_transferred_size;
484         int64 total_written;
485         int64 total_read;
486         int64 literal_data;
487         int64 matched_data;
488         int flist_size;
489         int num_files;
490         int num_transferred_files;
491         int current_file_index;
492 };
493
494
495 /* we need this function because of the silly way in which duplicate
496    entries are handled in the file lists - we can't change this
497    without breaking existing versions */
498 static inline int flist_up(struct file_list *flist, int i)
499 {
500         while (!flist->files[i]->basename) i++;
501         return i;
502 }
503
504 #include "byteorder.h"
505 #include "lib/mdfour.h"
506 #include "lib/wildmatch.h"
507 #include "lib/permstring.h"
508 #include "lib/addrinfo.h"
509
510 #include "proto.h"
511
512 /* We have replacement versions of these if they're missing. */
513 #ifndef HAVE_ASPRINTF
514 int asprintf(char **ptr, const char *format, ...);
515 #endif
516
517 #ifndef HAVE_VASPRINTF
518 int vasprintf(char **ptr, const char *format, va_list ap);
519 #endif
520
521 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
522 #define vsnprintf rsync_vsnprintf
523 int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
524 #endif
525
526 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
527 #define snprintf rsync_snprintf
528 int snprintf(char *str,size_t count,const char *fmt,...);
529 #endif
530
531
532 #if !HAVE_STRERROR
533 extern char *sys_errlist[];
534 #define strerror(i) sys_errlist[i]
535 #endif
536
537 #ifndef HAVE_STRCHR
538 # define strchr                 index
539 # define strrchr                rindex
540 #endif
541
542 #ifndef HAVE_ERRNO_DECL
543 extern int errno;
544 #endif
545
546 #define SUPPORT_LINKS HAVE_READLINK
547 #define SUPPORT_HARD_LINKS HAVE_LINK
548
549 /* This could be bad on systems which have no lchown and where chown
550  * follows symbollic links.  On such systems it might be better not to
551  * try to chown symlinks at all. */
552 #ifndef HAVE_LCHOWN
553 #define lchown chown
554 #endif
555
556 #define SIGNAL_CAST (RETSIGTYPE (*)())
557
558 #ifndef EWOULDBLOCK
559 #define EWOULDBLOCK EAGAIN
560 #endif
561
562 #ifndef STDIN_FILENO
563 #define STDIN_FILENO 0
564 #endif
565
566 #ifndef STDOUT_FILENO
567 #define STDOUT_FILENO 1
568 #endif
569
570 #ifndef STDERR_FILENO
571 #define STDERR_FILENO 2
572 #endif
573
574 #ifndef S_IWUSR
575 #define S_IWUSR 0200
576 #endif
577
578 #ifndef ACCESSPERMS
579 #define ACCESSPERMS 0777
580 #endif
581
582 #ifndef S_ISVTX
583 #define S_ISVTX 0
584 #endif
585
586 #define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
587
588 #ifndef _S_IFMT
589 #define _S_IFMT        0170000
590 #endif
591
592 #ifndef _S_IFLNK
593 #define _S_IFLNK  0120000
594 #endif
595
596 #ifndef S_ISLNK
597 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
598 #endif
599
600 #ifndef S_ISBLK
601 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
602 #endif
603
604 #ifndef S_ISCHR
605 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
606 #endif
607
608 #ifndef S_ISSOCK
609 #ifdef _S_IFSOCK
610 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
611 #else
612 #define S_ISSOCK(mode) (0)
613 #endif
614 #endif
615
616 #ifndef S_ISFIFO
617 #ifdef _S_IFIFO
618 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
619 #else
620 #define S_ISFIFO(mode) (0)
621 #endif
622 #endif
623
624 #ifndef S_ISDIR
625 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
626 #endif
627
628 #ifndef S_ISREG
629 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
630 #endif
631
632 /* work out what fcntl flag to use for non-blocking */
633 #ifdef O_NONBLOCK
634 # define NONBLOCK_FLAG O_NONBLOCK
635 #elif defined(SYSV)
636 # define NONBLOCK_FLAG O_NDELAY
637 #else 
638 # define NONBLOCK_FLAG FNDELAY
639 #endif
640
641 #ifndef INADDR_LOOPBACK
642 #define INADDR_LOOPBACK 0x7f000001
643 #endif
644
645 #ifndef INADDR_NONE
646 #define INADDR_NONE 0xffffffff
647 #endif
648
649 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
650
651 /* Initial mask on permissions given to temporary files.  Mask off setuid
652      bits and group access because of potential race-condition security
653      holes, and mask other access because mode 707 is bizarre */
654 #define INITACCESSPERMS 0700
655
656 /* handler for null strings in printf format */
657 #define NS(s) ((s)?(s):"<NULL>")
658
659 #if !defined(__GNUC__) || defined(APPLE)
660 /* Apparently the OS X port of gcc gags on __attribute__.
661  *
662  * <http://www.opensource.apple.com/bugs/X/gcc/2512150.html> */
663 #define __attribute__(x) 
664
665 #endif
666
667 /* Convenient wrappers for malloc and realloc.  Use them. */
668 #define new(type) ((type *)malloc(sizeof(type)))
669 #define new_array(type, num) ((type *)_new_array(sizeof(type), (num)))
670 #define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num)))
671
672 /* use magic gcc attributes to catch format errors */
673  void rprintf(enum logcode , const char *, ...)
674      __attribute__((format (printf, 2, 3)))
675 ;
676
677 /* This is just like rprintf, but it also tries to print some
678  * representation of the error code.  Normally errcode = errno. */
679 void rsyserr(enum logcode, int, const char *, ...)
680      __attribute__((format (printf, 3, 4)))
681      ;
682
683 #ifdef REPLACE_INET_NTOA
684 #define inet_ntoa rep_inet_ntoa
685 #endif
686
687 /* Make sure that the O_BINARY flag is defined. */
688 #ifndef O_BINARY
689 #define O_BINARY 0
690 #endif
691
692 #ifndef HAVE_STRLCPY
693 size_t strlcpy(char *d, const char *s, size_t bufsize);
694 #endif
695
696 #ifndef HAVE_STRLCAT
697 size_t strlcat(char *d, const char *s, size_t bufsize);
698 #endif
699
700 #ifndef WEXITSTATUS
701 #define WEXITSTATUS(stat)       ((int)(((stat)>>8)&0xFF))
702 #endif
703
704 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
705
706
707 extern int verbose;
708
709 #ifndef HAVE_INET_NTOP
710 const char *                 
711 inet_ntop(int af, const void *src, char *dst, size_t size);
712 #endif /* !HAVE_INET_NTOP */
713
714 #ifndef HAVE_INET_PTON
715 int inet_pton(int af, const char *src, void *dst);
716 #endif
717
718 #ifdef MAINTAINER_MODE
719 const char *get_panic_action(void);
720 #endif
721
722 #define UNUSED(x) x __attribute__((__unused__))
723
724 extern const char *io_write_phase, *io_read_phase;