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