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