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