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