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