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