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 #if HAVE_REMSH
  89 #define RSYNC_RSH "remsh"
  90 #else
  91 #define RSYNC_RSH "rsh"
  92 #endif
  93
  94 #include <sys/types.h>
  95
  96 #ifdef HAVE_UNISTD_H
  97 #include <unistd.h>
  98 #endif
  99 #include <stdio.h>
 100 #include <stddef.h>
 101
 102 #ifdef HAVE_SYS_PARAM_H
 103 #include <sys/param.h>
 104 #endif
 105
 106 #ifdef HAVE_STDLIB_H
 107 #include <stdlib.h>
 108 #endif
 109
 110 #ifdef HAVE_SYS_SOCKET_H
 111 #include <sys/socket.h>
 112 #endif
 113
 114 #ifdef HAVE_STRING_H
 115 #include <string.h>
 116 #endif
 117
 118 #ifdef HAVE_MALLOC_H
 119 #include <malloc.h>
 120 #endif
 121
 122 #ifdef TIME_WITH_SYS_TIME
 123 #include <sys/time.h>
 124 #include <time.h>
 125 #else
 126 #ifdef HAVE_SYS_TIME_H
 127 #include <sys/time.h>
 128 #else
 129 #include <time.h>
 130 #endif
 131 #endif
 132
 133 #ifdef HAVE_FCNTL_H
 134 #include <fcntl.h>
 135 #else
 136 #ifdef HAVE_SYS_FCNTL_H
 137 #include <sys/fcntl.h>
 138 #endif
 139 #endif
 140
 141 #include <sys/stat.h>
 142
 143 #ifdef HAVE_SYS_IOCTL_H
 144 #include <sys/ioctl.h>
 145 #endif
 146
 147 #ifdef HAVE_SYS_FILIO_H
 148 #include <sys/filio.h>
 149 #endif
 150
 151 #include <signal.h>
 152 #ifdef HAVE_SYS_WAIT_H
 153 #include <sys/wait.h>
 154 #endif
 155 #ifdef HAVE_CTYPE_H
 156 #include <ctype.h>
 157 #endif
 158 #ifdef HAVE_GRP_H
 159 #include <grp.h>
 160 #endif
 161 #include <errno.h>
 162
 163 #ifdef HAVE_UTIME_H
 164 #include <utime.h>
 165 #endif
 166
 167 #ifdef HAVE_SYS_SELECT_H
 168 #include <sys/select.h>
 169 #endif
 170
 171 #ifdef HAVE_SYS_MODE_H
 172 /* apparently AIX needs this for S_ISLNK */
 173 #ifndef S_ISLNK
 174 #include <sys/mode.h>
 175 #endif
 176 #endif
 177
 178 #ifdef HAVE_FNMATCH
 179 #include <fnmatch.h>
 180 #else
 181 #include "lib/fnmatch.h"
 182 #endif
 183
 184 #ifdef HAVE_GLOB_H
 185 #include <glob.h>
 186 #endif
 187
 188 #ifdef HAVE_MALLOC_H
 189 #  include <malloc.h>
 190 #endif
 191
 192 /* these are needed for the uid/gid mapping code */
 193 #include <pwd.h>
 194 #include <grp.h>
 195
 196 #include <stdarg.h>
 197 #include <netinet/in.h>
 198 #include <arpa/inet.h>
 199 #include <netdb.h>
 200 #include <syslog.h>
 201 #include <sys/file.h>
 202
 203 #if HAVE_DIRENT_H
 204 # include <dirent.h>
 205 #else
 206 # define dirent direct
 207 # if HAVE_SYS_NDIR_H
 208 #  include <sys/ndir.h>
 209 # endif
 210 # if HAVE_SYS_DIR_H
 211 #  include <sys/dir.h>
 212 # endif
 213 # if HAVE_NDIR_H
 214 #  include <ndir.h>
 215 # endif
 216 #endif
 217
 218 #ifdef HAVE_COMPAT_H
 219 #include <compat.h>
 220 #endif
 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 #define INO64_T int64
 303 #define DEV64_T int64
 304
 305 #ifndef MIN
 306 #define MIN(a,b) ((a)<(b)?(a):(b))
 307 #endif
 308
 309 #ifndef MAX
 310 #define MAX(a,b) ((a)>(b)?(a):(b))
 311 #endif
 312
 313 #ifndef MAXHOSTNAMELEN
 314 #define MAXHOSTNAMELEN 256
 315 #endif
 316
 317 /* the length of the md4 checksum */
 318 #define MD4_SUM_LENGTH 16
 319 #define SUM_LENGTH 16
 320
 321 #ifndef MAXPATHLEN
 322 #define MAXPATHLEN 1024
 323 #endif
 324
 325 #ifndef INADDR_NONE
 326 #define INADDR_NONE 0xffffffff
 327 #endif
 328
 329 struct file_struct {
 330         unsigned flags;
 331         time_t modtime;
 332         OFF_T length;
 333         mode_t mode;
 334
 335         INO64_T inode;
 336         /** Device this file lives upon */
 337         DEV64_T dev;
 338
 339         /** If this is a device node, the device number. */
 340         DEV64_T rdev;
 341         uid_t uid;
 342         gid_t gid;
 343         char *basename;
 344         char *dirname;
 345         char *basedir;
 346         char *link;
 347         char *sum;
 348 };
 349
 350
 351 #define ARENA_SIZE      (32 * 1024)
 352
 353 struct string_area {
 354         char *base;
 355         char *end;
 356         char *current;
 357         struct string_area *next;
 358 };
 359
 360 struct file_list {
 361         int count;
 362         int malloced;
 363         struct file_struct **files;
 364         struct string_area *string_area;
 365 };
 366
 367 struct sum_buf {
 368         OFF_T offset;           /* offset in file of this chunk */
 369         int len;                /* length of chunk of file */
 370         int i;                  /* index of this chunk */
 371         uint32 sum1;            /* simple checksum */
 372         char sum2[SUM_LENGTH];  /* checksum  */
 373 };
 374
 375 struct sum_struct {
 376   OFF_T flength;                /* total file length */
 377   size_t count;                 /* how many chunks */
 378   size_t remainder;             /* flength % block_length */
 379   size_t n;                     /* block_length */
 380   struct sum_buf *sums;         /* points to info for each chunk */
 381 };
 382
 383 struct map_struct {
 384         char *p;
 385         int fd,p_size,p_len;
 386         OFF_T file_size, p_offset, p_fd_offset;
 387 };
 388
 389 struct exclude_struct {
 390         char *pattern;
 391         int regular_exp;
 392         int fnmatch_flags;
 393         int include;
 394         int directory;
 395         int local;
 396 };
 397
 398 struct stats {
 399         int64 total_size;
 400         int64 total_transferred_size;
 401         int64 total_written;
 402         int64 total_read;
 403         int64 literal_data;
 404         int64 matched_data;
 405         int flist_size;
 406         int num_files;
 407         int num_transferred_files;
 408 };
 409
 410
 411 /* we need this function because of the silly way in which duplicate
 412    entries are handled in the file lists - we can't change this
 413    without breaking existing versions */
 414 static inline int flist_up(struct file_list *flist, int i)
 415 {
 416         while (!flist->files[i]->basename) i++;
 417         return i;
 418 }
 419
 420 #include "byteorder.h"
 421 #include "proto.h"
 422 #include "lib/mdfour.h"
 423 #include "lib/permstring.h"
 424 #include "lib/addrinfo.h"
 425
 426 /* We have replacement versions of these if they're missing. */
 427 #ifndef HAVE_ASPRINTF
 428 int asprintf(char **ptr, const char *format, ...);
 429 #endif
 430
 431 #ifndef HAVE_VASPRINTF
 432 int vasprintf(char **ptr, const char *format, va_list ap);
 433 #endif
 434
 435 #if !defined(HAVE_VSNPRINTF) && !defined(HAVE_C99_VSNPRINTF)
 436 int vsnprintf (char *str, size_t count, const char *fmt, va_list args);
 437 #endif
 438
 439 #if !defined(HAVE_SNPRINTF) && !defined(HAVE_C99_VSNPRINTF)
 440 int snprintf(char *str,size_t count,const char *fmt,...);
 441 #endif
 442
 443
 444 #if !HAVE_STRERROR
 445 extern char *sys_errlist[];
 446 #define strerror(i) sys_errlist[i]
 447 #endif
 448
 449 #ifndef HAVE_STRCHR
 450 # define strchr                 index
 451 # define strrchr                rindex
 452 #endif
 453
 454 #ifndef HAVE_ERRNO_DECL
 455 extern int errno;
 456 #endif
 457
 458 #define SUPPORT_LINKS HAVE_READLINK
 459 #define SUPPORT_HARD_LINKS HAVE_LINK
 460
 461 #ifndef HAVE_LCHOWN
 462 #define lchown chown
 463 #endif
 464
 465 #define SIGNAL_CAST (RETSIGTYPE (*)())
 466
 467 #ifndef EWOULDBLOCK
 468 #define EWOULDBLOCK EAGAIN
 469 #endif
 470
 471 #ifndef STDIN_FILENO
 472 #define STDIN_FILENO 0
 473 #endif
 474
 475 #ifndef STDOUT_FILENO
 476 #define STDOUT_FILENO 1
 477 #endif
 478
 479 #ifndef STDERR_FILENO
 480 #define STDERR_FILENO 2
 481 #endif
 482
 483 #ifndef S_IWUSR
 484 #define S_IWUSR 0200
 485 #endif
 486
 487 #ifndef _S_IFMT
 488 #define _S_IFMT        0170000
 489 #endif
 490
 491 #ifndef _S_IFLNK
 492 #define _S_IFLNK  0120000
 493 #endif
 494
 495 #ifndef S_ISLNK
 496 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
 497 #endif
 498
 499 #ifndef S_ISBLK
 500 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
 501 #endif
 502
 503 #ifndef S_ISCHR
 504 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
 505 #endif
 506
 507 #ifndef S_ISSOCK
 508 #ifdef _S_IFSOCK
 509 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
 510 #else
 511 #define S_ISSOCK(mode) (0)
 512 #endif
 513 #endif
 514
 515 #ifndef S_ISFIFO
 516 #ifdef _S_IFIFO
 517 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
 518 #else
 519 #define S_ISFIFO(mode) (0)
 520 #endif
 521 #endif
 522
 523 #ifndef S_ISDIR
 524 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
 525 #endif
 526
 527 #ifndef S_ISREG
 528 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
 529 #endif
 530
 531 /* work out what fcntl flag to use for non-blocking */
 532 #ifdef O_NONBLOCK
 533 # define NONBLOCK_FLAG O_NONBLOCK
 534 #elif defined(SYSV)
 535 # define NONBLOCK_FLAG O_NDELAY
 536 #else
 537 # define NONBLOCK_FLAG FNDELAY
 538 #endif
 539
 540 #ifndef INADDR_LOOPBACK
 541 #define INADDR_LOOPBACK 0x7f000001
 542 #endif
 543
 544 #ifndef INADDR_NONE
 545 #define INADDR_NONE 0xffffffff
 546 #endif
 547
 548 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
 549
 550 #ifndef ACCESSPERMS
 551 #define ACCESSPERMS 0777
 552 #endif
 553 /* Initial mask on permissions given to temporary files.  Mask off setuid
 554      bits and group access because of potential race-condition security
 555      holes, and mask other access because mode 707 is bizarre */
 556 #define INITACCESSPERMS 0700
 557
 558 /* handler for null strings in printf format */
 559 #define NS(s) ((s)?(s):"<NULL>")
 560
 561 /* use magic gcc attributes to catch format errors */
 562  void rprintf(enum logcode , const char *, ...)
 563 #ifdef __GNUC__
 564      __attribute__ ((format (printf, 2, 3)))
 565 #endif
 566 ;
 567
 568 /* This is just like rprintf, but it also tries to print some
 569  * representation of the error code.  Normally errcode = errno. */
 570 void rsyserr(enum logcode, int, const char *, ...)
 571 #ifdef __GNUC__
 572      __attribute__ ((format (printf, 3, 4)))
 573 #endif
 574      ;
 575
 576 #ifdef REPLACE_INET_NTOA
 577 #define inet_ntoa rep_inet_ntoa
 578 #endif
 579
 580
 581 #ifndef HAVE_STRLCPY
 582 size_t strlcpy(char *d, const char *s, size_t bufsize);
 583 #endif
 584
 585 #ifndef HAVE_STRLCAT
 586 size_t strlcat(char *d, const char *s, size_t bufsize);
 587 #endif
 588
 589 #ifndef WEXITSTATUS
 590 #define WEXITSTATUS(stat)       ((int)(((stat)>>8)&0xFF))
 591 #endif
 592
 593 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
 594
 595
 596 extern int verbose;
 597
 598 #ifndef HAVE_INET_NTOP
 599 const char *
 600 inet_ntop(int af, const void *src, char *dst, size_t size);
 601 #endif /* !HAVE_INET_NTOP */
 602
 603 #ifndef HAVE_INET_PTON
 604 int isc_net_pton(int af, const char *src, void *dst);
 605 #endif