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