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