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