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