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