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 /* Log values.  I *think* what these mean is: FLOG goes to the server
  89  * logfile; FERROR and FINFO try to end up on the client, with
  90  * different levels of filtering. */
  91 enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 };
  92
  93 #include "errcode.h"
  94
  95 #include "config.h"
  96
  97 /* The default RSYNC_RSH is always set in config.h, either to "remsh",
  98  * "rsh", or otherwise something specified by the user.  HAVE_REMSH
  99  * controls parameter munging for HP/UX, etc. */
 100
 101 #include <sys/types.h>
 102
 103 #ifdef HAVE_UNISTD_H
 104 #include <unistd.h>
 105 #endif
 106 #include <stdio.h>
 107 #include <stddef.h>
 108
 109 #ifdef HAVE_SYS_PARAM_H
 110 #include <sys/param.h>
 111 #endif
 112
 113 #ifdef HAVE_STDLIB_H
 114 #include <stdlib.h>
 115 #endif
 116
 117 #ifdef HAVE_SYS_SOCKET_H
 118 #include <sys/socket.h>
 119 #endif
 120
 121 #ifdef HAVE_STRING_H
 122 #include <string.h>
 123 #endif
 124
 125 #ifdef HAVE_MALLOC_H
 126 #include <malloc.h>
 127 #endif
 128
 129 #ifdef TIME_WITH_SYS_TIME
 130 #include <sys/time.h>
 131 #include <time.h>
 132 #else
 133 #ifdef HAVE_SYS_TIME_H
 134 #include <sys/time.h>
 135 #else
 136 #include <time.h>
 137 #endif
 138 #endif
 139
 140 #ifdef HAVE_FCNTL_H
 141 #include <fcntl.h>
 142 #else
 143 #ifdef HAVE_SYS_FCNTL_H
 144 #include <sys/fcntl.h>
 145 #endif
 146 #endif
 147
 148 #include <sys/stat.h>
 149
 150 #ifdef HAVE_SYS_IOCTL_H
 151 #include <sys/ioctl.h>
 152 #endif
 153
 154 #ifdef HAVE_SYS_FILIO_H
 155 #include <sys/filio.h>
 156 #endif
 157
 158 #include <signal.h>
 159 #ifdef HAVE_SYS_WAIT_H
 160 #include <sys/wait.h>
 161 #endif
 162 #ifdef HAVE_CTYPE_H
 163 #include <ctype.h>
 164 #endif
 165 #ifdef HAVE_GRP_H
 166 #include <grp.h>
 167 #endif
 168 #include <errno.h>
 169
 170 #ifdef HAVE_UTIME_H
 171 #include <utime.h>
 172 #endif
 173
 174 #ifdef HAVE_SYS_SELECT_H
 175 #include <sys/select.h>
 176 #endif
 177
 178 #ifdef HAVE_SYS_MODE_H
 179 /* apparently AIX needs this for S_ISLNK */
 180 #ifndef S_ISLNK
 181 #include <sys/mode.h>
 182 #endif
 183 #endif
 184
 185 #ifdef HAVE_FNMATCH
 186 #include <fnmatch.h>
 187 #else
 188 #include "lib/fnmatch.h"
 189 #endif
 190
 191 #ifdef HAVE_GLOB_H
 192 #include <glob.h>
 193 #endif
 194
 195 #ifdef HAVE_MALLOC_H
 196 #  include <malloc.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;
 420         int fd,p_size,p_len;
 421         OFF_T file_size, p_offset, p_fd_offset;
 422 };
 423
 424 struct exclude_struct {
 425         char *pattern;
 426         int regular_exp;
 427         int fnmatch_flags;
 428         int include;
 429         int directory;
 430         int local;
 431 };
 432
 433 struct stats {
 434         int64 total_size;
 435         int64 total_transferred_size;
 436         int64 total_written;
 437         int64 total_read;
 438         int64 literal_data;
 439         int64 matched_data;
 440         int flist_size;
 441         int num_files;
 442         int num_transferred_files;
 443 };
 444
 445
 446 /* we need this function because of the silly way in which duplicate
 447    entries are handled in the file lists - we can't change this
 448    without breaking existing versions */
 449 static inline int flist_up(struct file_list *flist, int i)
 450 {
 451         while (!flist->files[i]->basename) i++;
 452         return i;
 453 }
 454
 455 #include "byteorder.h"
 456 #include "lib/mdfour.h"
 457 #include "lib/permstring.h"
 458 #include "lib/addrinfo.h"
 459
 460 #include "proto.h"
 461
 462 /* We have replacement versions of these if they're missing. */
 463 #ifndef HAVE_ASPRINTF
 464 int asprintf(char **ptr, const char *format, ...);
 465 #endif
 466
 467 #ifndef HAVE_VASPRINTF
 468 int vasprintf(char **ptr, const char *format, va_list ap);
 469 #endif
 470
 471 #if !defined(HAVE_VSNPRINTF) && !defined(HAVE_C99_VSNPRINTF)
 472 int vsnprintf (char *str, size_t count, const char *fmt, va_list args);
 473 #endif
 474
 475 #if !defined(HAVE_SNPRINTF) && !defined(HAVE_C99_VSNPRINTF)
 476 int snprintf(char *str,size_t count,const char *fmt,...);
 477 #endif
 478
 479
 480 #if !HAVE_STRERROR
 481 extern char *sys_errlist[];
 482 #define strerror(i) sys_errlist[i]
 483 #endif
 484
 485 #ifndef HAVE_STRCHR
 486 # define strchr                 index
 487 # define strrchr                rindex
 488 #endif
 489
 490 #ifndef HAVE_ERRNO_DECL
 491 extern int errno;
 492 #endif
 493
 494 #define SUPPORT_LINKS HAVE_READLINK
 495 #define SUPPORT_HARD_LINKS HAVE_LINK
 496
 497 /* This could be bad on systems which have no lchown and where chown
 498  * follows symbollic links.  On such systems it might be better not to
 499  * try to chown symlinks at all. */
 500 #ifndef HAVE_LCHOWN
 501 #define lchown chown
 502 #endif
 503
 504 #define SIGNAL_CAST (RETSIGTYPE (*)())
 505
 506 #ifndef EWOULDBLOCK
 507 #define EWOULDBLOCK EAGAIN
 508 #endif
 509
 510 #ifndef STDIN_FILENO
 511 #define STDIN_FILENO 0
 512 #endif
 513
 514 #ifndef STDOUT_FILENO
 515 #define STDOUT_FILENO 1
 516 #endif
 517
 518 #ifndef STDERR_FILENO
 519 #define STDERR_FILENO 2
 520 #endif
 521
 522 #ifndef S_IWUSR
 523 #define S_IWUSR 0200
 524 #endif
 525
 526 #ifndef ACCESSPERMS
 527 #define ACCESSPERMS 0777
 528 #endif
 529
 530 #ifndef S_ISVTX
 531 #define S_ISVTX 0
 532 #endif
 533
 534 #define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
 535
 536 #ifndef _S_IFMT
 537 #define _S_IFMT        0170000
 538 #endif
 539
 540 #ifndef _S_IFLNK
 541 #define _S_IFLNK  0120000
 542 #endif
 543
 544 #ifndef S_ISLNK
 545 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
 546 #endif
 547
 548 #ifndef S_ISBLK
 549 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
 550 #endif
 551
 552 #ifndef S_ISCHR
 553 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
 554 #endif
 555
 556 #ifndef S_ISSOCK
 557 #ifdef _S_IFSOCK
 558 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
 559 #else
 560 #define S_ISSOCK(mode) (0)
 561 #endif
 562 #endif
 563
 564 #ifndef S_ISFIFO
 565 #ifdef _S_IFIFO
 566 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
 567 #else
 568 #define S_ISFIFO(mode) (0)
 569 #endif
 570 #endif
 571
 572 #ifndef S_ISDIR
 573 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
 574 #endif
 575
 576 #ifndef S_ISREG
 577 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
 578 #endif
 579
 580 /* work out what fcntl flag to use for non-blocking */
 581 #ifdef O_NONBLOCK
 582 # define NONBLOCK_FLAG O_NONBLOCK
 583 #elif defined(SYSV)
 584 # define NONBLOCK_FLAG O_NDELAY
 585 #else
 586 # define NONBLOCK_FLAG FNDELAY
 587 #endif
 588
 589 #ifndef INADDR_LOOPBACK
 590 #define INADDR_LOOPBACK 0x7f000001
 591 #endif
 592
 593 #ifndef INADDR_NONE
 594 #define INADDR_NONE 0xffffffff
 595 #endif
 596
 597 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
 598
 599 /* Initial mask on permissions given to temporary files.  Mask off setuid
 600      bits and group access because of potential race-condition security
 601      holes, and mask other access because mode 707 is bizarre */
 602 #define INITACCESSPERMS 0700
 603
 604 /* handler for null strings in printf format */
 605 #define NS(s) ((s)?(s):"<NULL>")
 606
 607 #if !defined(__GNUC__) || defined(APPLE)
 608 /* Apparently the OS X port of gcc gags on __attribute__.
 609  *
 610  * <http://www.opensource.apple.com/bugs/X/gcc/2512150.html> */
 611 #define __attribute__(x)
 612
 613 #endif
 614
 615
 616 /* use magic gcc attributes to catch format errors */
 617  void rprintf(enum logcode , const char *, ...)
 618      __attribute__((format (printf, 2, 3)))
 619 ;
 620
 621 /* This is just like rprintf, but it also tries to print some
 622  * representation of the error code.  Normally errcode = errno. */
 623 void rsyserr(enum logcode, int, const char *, ...)
 624      __attribute__((format (printf, 3, 4)))
 625      ;
 626
 627 #ifdef REPLACE_INET_NTOA
 628 #define inet_ntoa rep_inet_ntoa
 629 #endif
 630
 631 /* Make sure that the O_BINARY flag is defined. */
 632 #ifndef O_BINARY
 633 #define O_BINARY 0
 634 #endif
 635
 636 #ifndef HAVE_STRLCPY
 637 size_t strlcpy(char *d, const char *s, size_t bufsize);
 638 #endif
 639
 640 #ifndef HAVE_STRLCAT
 641 size_t strlcat(char *d, const char *s, size_t bufsize);
 642 #endif
 643
 644 #ifndef WEXITSTATUS
 645 #define WEXITSTATUS(stat)       ((int)(((stat)>>8)&0xFF))
 646 #endif
 647
 648 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
 649
 650
 651 extern int verbose;
 652
 653 #ifndef HAVE_INET_NTOP
 654 const char *
 655 inet_ntop(int af, const void *src, char *dst, size_t size);
 656 #endif /* !HAVE_INET_NTOP */
 657
 658 #ifndef HAVE_INET_PTON
 659 int inet_pton(int af, const char *src, void *dst);
 660 #endif
 661
 662 #ifdef MAINTAINER_MODE
 663 const char *get_panic_action(void);
 664 #endif
 665
 666 #define UNUSED(x) x __attribute__((__unused__))
 667
 668 extern const char *io_write_phase, *io_read_phase;