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