rsync.h

   1 /*
   2    Copyright (C) by Andrew Tridgell 1996, 2000
   3    Copyright (C) Paul Mackerras 1996
   4    Copyright (C) 2001 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 #define False 0
  22 #define True 1
  23
  24 #define BLOCK_SIZE 700
  25 #define RSYNC_RSH_ENV "RSYNC_RSH"
  26
  27 #define RSYNC_NAME "rsync"
  28 #define RSYNCD_CONF "/etc/rsyncd.conf"
  29
  30 #define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
  31 #define URL_PREFIX "rsync://"
  32
  33 #define BACKUP_SUFFIX "~"
  34
  35 /* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
  36    incompatible with older versions :-( */
  37 #define CHAR_OFFSET 0
  38
  39
  40 #define FLAG_DELETE (1<<0)
  41 #define SAME_MODE (1<<1)
  42 #define SAME_RDEV (1<<2)
  43 #define SAME_UID (1<<3)
  44 #define SAME_GID (1<<4)
  45 #define SAME_DIR (1<<5)
  46 #define SAME_NAME SAME_DIR
  47 #define LONG_NAME (1<<6)
  48 #define SAME_TIME (1<<7)
  49
  50 /* update this if you make incompatible changes */
  51 #define PROTOCOL_VERSION 25
  52
  53 /* We refuse to interoperate with versions that are not in this range.
  54  * Note that we assume we'll work with later versions: the onus is on
  55  * people writing them to make sure that they don't send us anything
  56  * we won't understand.
  57  *
  58  * There are two possible explanations for the limit at thirty: either
  59  * to allow new major-rev versions that do not interoperate with us,
  60  * and (more likely) so that we can detect an attempt to connect rsync
  61  * to a non-rsync server, which is unlikely to begin by sending a byte
  62  * between 15 and 30. */
  63 #define MIN_PROTOCOL_VERSION 15
  64 #define MAX_PROTOCOL_VERSION 30
  65
  66 #define RSYNC_PORT 873
  67
  68 #define SPARSE_WRITE_SIZE (1024)
  69 #define WRITE_SIZE (32*1024)
  70 #define CHUNK_SIZE (32*1024)
  71 #define MAX_MAP_SIZE (256*1024)
  72 #define IO_BUFFER_SIZE (4092)
  73
  74 #define MAX_ARGS 1000
  75
  76 #define MPLEX_BASE 7
  77
  78 /* Log values.  I *think* what these mean is: FLOG goes to the server
  79  * logfile; FERROR and FINFO try to end up on the client, with
  80  * different levels of filtering. */
  81 enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 };
  82
  83 #include "errcode.h"
  84
  85 #include "config.h"
  86
  87 #if HAVE_REMSH
  88 #define RSYNC_RSH "remsh"
  89 #else
  90 #define RSYNC_RSH "rsh"
  91 #endif
  92
  93 #include <sys/types.h>
  94
  95 #ifdef HAVE_UNISTD_H
  96 #include <unistd.h>
  97 #endif
  98 #include <stdio.h>
  99 #include <stddef.h>
 100
 101 #ifdef HAVE_SYS_PARAM_H
 102 #include <sys/param.h>
 103 #endif
 104
 105 #ifdef HAVE_STDLIB_H
 106 #include <stdlib.h>
 107 #endif
 108
 109 #ifdef HAVE_SYS_SOCKET_H
 110 #include <sys/socket.h>
 111 #endif
 112
 113 #ifdef HAVE_STRING_H
 114 #include <string.h>
 115 #endif
 116
 117 #ifdef HAVE_MALLOC_H
 118 #include <malloc.h>
 119 #endif
 120
 121 #ifdef TIME_WITH_SYS_TIME
 122 #include <sys/time.h>
 123 #include <time.h>
 124 #else
 125 #ifdef HAVE_SYS_TIME_H
 126 #include <sys/time.h>
 127 #else
 128 #include <time.h>
 129 #endif
 130 #endif
 131
 132 #ifdef HAVE_FCNTL_H
 133 #include <fcntl.h>
 134 #else
 135 #ifdef HAVE_SYS_FCNTL_H
 136 #include <sys/fcntl.h>
 137 #endif
 138 #endif
 139
 140 #include <sys/stat.h>
 141
 142 #ifdef HAVE_SYS_IOCTL_H
 143 #include <sys/ioctl.h>
 144 #endif
 145
 146 #ifdef HAVE_SYS_FILIO_H
 147 #include <sys/filio.h>
 148 #endif
 149
 150 #include <signal.h>
 151 #ifdef HAVE_SYS_WAIT_H
 152 #include <sys/wait.h>
 153 #endif
 154 #ifdef HAVE_CTYPE_H
 155 #include <ctype.h>
 156 #endif
 157 #ifdef HAVE_GRP_H
 158 #include <grp.h>
 159 #endif
 160 #include <errno.h>
 161
 162 #ifdef HAVE_UTIME_H
 163 #include <utime.h>
 164 #endif
 165
 166 #ifdef HAVE_SYS_SELECT_H
 167 #include <sys/select.h>
 168 #endif
 169
 170 #ifdef HAVE_SYS_MODE_H
 171 /* apparently AIX needs this for S_ISLNK */
 172 #ifndef S_ISLNK
 173 #include <sys/mode.h>
 174 #endif
 175 #endif
 176
 177 #ifdef HAVE_FNMATCH
 178 #include <fnmatch.h>
 179 #else
 180 #include "lib/fnmatch.h"
 181 #endif
 182
 183 #ifdef HAVE_GLOB_H
 184 #include <glob.h>
 185 #endif
 186
 187 /* these are needed for the uid/gid mapping code */
 188 #include <pwd.h>
 189 #include <grp.h>
 190
 191 #include <stdarg.h>
 192 #include <netinet/in.h>
 193 #include <arpa/inet.h>
 194 #include <netdb.h>
 195 #include <syslog.h>
 196 #include <sys/file.h>
 197
 198 #if HAVE_DIRENT_H
 199 # include <dirent.h>
 200 #else
 201 # define dirent direct
 202 # if HAVE_SYS_NDIR_H
 203 #  include <sys/ndir.h>
 204 # endif
 205 # if HAVE_SYS_DIR_H
 206 #  include <sys/dir.h>
 207 # endif
 208 # if HAVE_NDIR_H
 209 #  include <ndir.h>
 210 # endif
 211 #endif
 212
 213 #ifdef HAVE_COMPAT_H
 214 #include <compat.h>
 215 #endif
 216
 217
 218 #define BOOL int
 219
 220 #ifndef uchar
 221 #define uchar unsigned char
 222 #endif
 223
 224 #if HAVE_UNSIGNED_CHAR
 225 #define schar signed char
 226 #else
 227 #define schar char
 228 #endif
 229
 230 #ifndef int32
 231 #if (SIZEOF_INT == 4)
 232 #define int32 int
 233 #elif (SIZEOF_LONG == 4)
 234 #define int32 long
 235 #elif (SIZEOF_SHORT == 4)
 236 #define int32 short
 237 #else
 238 /* I hope this works */
 239 #define int32 int
 240 #define LARGE_INT32
 241 #endif
 242 #endif
 243
 244 #ifndef uint32
 245 #define uint32 unsigned int32
 246 #endif
 247
 248 #if HAVE_OFF64_T
 249 #define OFF_T off64_t
 250 #define STRUCT_STAT struct stat64
 251 #else
 252 #define OFF_T off_t
 253 #define STRUCT_STAT struct stat
 254 #endif
 255
 256 #if HAVE_OFF64_T
 257 #define int64 off64_t
 258 #elif (SIZEOF_LONG == 8)
 259 #define int64 long
 260 #elif (SIZEOF_INT == 8)
 261 #define int64 int
 262 #elif HAVE_LONGLONG
 263 #define int64 long long
 264 #else
 265 #define int64 off_t
 266 #define NO_INT64
 267 #endif
 268
 269 #if HAVE_SHORT_INO_T
 270 #  define INO_T uint32
 271 #elif HAVE_INO_T
 272 #  define INO_T ino_t
 273 #else
 274 #  define INO_T unsigned
 275 #endif
 276
 277 #ifndef MIN
 278 #define MIN(a,b) ((a)<(b)?(a):(b))
 279 #endif
 280
 281 #ifndef MAX
 282 #define MAX(a,b) ((a)>(b)?(a):(b))
 283 #endif
 284
 285 #ifndef MAXHOSTNAMELEN
 286 #define MAXHOSTNAMELEN 256
 287 #endif
 288
 289 /* the length of the md4 checksum */
 290 #define MD4_SUM_LENGTH 16
 291 #define SUM_LENGTH 16
 292
 293 #ifndef MAXPATHLEN
 294 #define MAXPATHLEN 1024
 295 #endif
 296
 297 #ifndef INADDR_NONE
 298 #define INADDR_NONE 0xffffffff
 299 #endif
 300
 301 struct file_struct {
 302         unsigned flags;
 303         time_t modtime;
 304         OFF_T length;
 305         mode_t mode;
 306         INO_T inode;
 307         dev_t dev;
 308         dev_t rdev;
 309         uid_t uid;
 310         gid_t gid;
 311         char *basename;
 312         char *dirname;
 313         char *basedir;
 314         char *link;
 315         char *sum;
 316 };
 317
 318
 319 #define ARENA_SIZE      (32 * 1024)
 320
 321 struct string_area {
 322         char *base;
 323         char *end;
 324         char *current;
 325         struct string_area *next;
 326 };
 327
 328 struct file_list {
 329         int count;
 330         int malloced;
 331         struct file_struct **files;
 332         struct string_area *string_area;
 333 };
 334
 335 struct sum_buf {
 336         OFF_T offset;           /* offset in file of this chunk */
 337         int len;                /* length of chunk of file */
 338         int i;                  /* index of this chunk */
 339         uint32 sum1;            /* simple checksum */
 340         char sum2[SUM_LENGTH];  /* checksum  */
 341 };
 342
 343 struct sum_struct {
 344   OFF_T flength;                /* total file length */
 345   int count;                    /* how many chunks */
 346   int remainder;                /* flength % block_length */
 347   int n;                        /* block_length */
 348   struct sum_buf *sums;         /* points to info for each chunk */
 349 };
 350
 351 struct map_struct {
 352         char *p;
 353         int fd,p_size,p_len;
 354         OFF_T file_size, p_offset, p_fd_offset;
 355 };
 356
 357 struct exclude_struct {
 358         char *pattern;
 359         int regular_exp;
 360         int fnmatch_flags;
 361         int include;
 362         int directory;
 363         int local;
 364 };
 365
 366 struct stats {
 367         int64 total_size;
 368         int64 total_transferred_size;
 369         int64 total_written;
 370         int64 total_read;
 371         int64 literal_data;
 372         int64 matched_data;
 373         int flist_size;
 374         int num_files;
 375         int num_transferred_files;
 376 };
 377
 378
 379 /* we need this function because of the silly way in which duplicate
 380    entries are handled in the file lists - we can't change this
 381    without breaking existing versions */
 382 static inline int flist_up(struct file_list *flist, int i)
 383 {
 384         while (!flist->files[i]->basename) i++;
 385         return i;
 386 }
 387
 388 #include "byteorder.h"
 389 #include "version.h"
 390 #include "proto.h"
 391 #include "lib/mdfour.h"
 392
 393 #if !HAVE_STRERROR
 394 extern char *sys_errlist[];
 395 #define strerror(i) sys_errlist[i]
 396 #endif
 397
 398 #ifndef HAVE_STRCHR
 399 # define strchr                 index
 400 # define strrchr                rindex
 401 #endif
 402
 403 #ifndef HAVE_ERRNO_DECL
 404 extern int errno;
 405 #endif
 406
 407 #define SUPPORT_LINKS HAVE_READLINK
 408 #define SUPPORT_HARD_LINKS HAVE_LINK
 409
 410 #ifndef HAVE_LCHOWN
 411 #define lchown chown
 412 #endif
 413
 414 #define SIGNAL_CAST (RETSIGTYPE (*)())
 415
 416 #ifndef EWOULDBLOCK
 417 #define EWOULDBLOCK EAGAIN
 418 #endif
 419
 420 #ifndef STDIN_FILENO
 421 #define STDIN_FILENO 0
 422 #endif
 423
 424 #ifndef STDOUT_FILENO
 425 #define STDOUT_FILENO 1
 426 #endif
 427
 428 #ifndef STDERR_FILENO
 429 #define STDERR_FILENO 2
 430 #endif
 431
 432 #ifndef S_IWUSR
 433 #define S_IWUSR 0200
 434 #endif
 435
 436 #ifndef _S_IFMT
 437 #define _S_IFMT        0170000
 438 #endif
 439
 440 #ifndef _S_IFLNK
 441 #define _S_IFLNK  0120000
 442 #endif
 443
 444 #ifndef S_ISLNK
 445 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
 446 #endif
 447
 448 #ifndef S_ISBLK
 449 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
 450 #endif
 451
 452 #ifndef S_ISCHR
 453 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
 454 #endif
 455
 456 #ifndef S_ISSOCK
 457 #ifdef _S_IFSOCK
 458 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
 459 #else
 460 #define S_ISSOCK(mode) (0)
 461 #endif
 462 #endif
 463
 464 #ifndef S_ISFIFO
 465 #ifdef _S_IFIFO
 466 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
 467 #else
 468 #define S_ISFIFO(mode) (0)
 469 #endif
 470 #endif
 471
 472 #ifndef S_ISDIR
 473 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
 474 #endif
 475
 476 #ifndef S_ISREG
 477 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
 478 #endif
 479
 480 /* work out what fcntl flag to use for non-blocking */
 481 #ifdef O_NONBLOCK
 482 # define NONBLOCK_FLAG O_NONBLOCK
 483 #elif defined(SYSV)
 484 # define NONBLOCK_FLAG O_NDELAY
 485 #else
 486 # define NONBLOCK_FLAG FNDELAY
 487 #endif
 488
 489
 490 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
 491
 492 #ifndef ACCESSPERMS
 493 #define ACCESSPERMS 0777
 494 #endif
 495 /* Initial mask on permissions given to temporary files.  Mask off setuid
 496      bits and group access because of potential race-condition security
 497      holes, and mask other access because mode 707 is bizarre */
 498 #define INITACCESSPERMS 0700
 499
 500 /* handler for null strings in printf format */
 501 #define NS(s) ((s)?(s):"<NULL>")
 502
 503 /* use magic gcc attributes to catch format errors */
 504  void rprintf(enum logcode , const char *, ...)
 505 #ifdef __GNUC__
 506      __attribute__ ((format (printf, 2, 3)))
 507 #endif
 508 ;
 509
 510 /* This is just like rprintf, but it also tries to print some
 511  * representation of the error code.  Normally errcode = errno. */
 512 void rsyserr(enum logcode, int, const char *, ...)
 513 #ifdef __GNUC__
 514      __attribute__ ((format (printf, 3, 4)))
 515 #endif
 516      ;
 517
 518 #ifdef REPLACE_INET_NTOA
 519 #define inet_ntoa rep_inet_ntoa
 520 #endif
 521
 522
 523 #ifndef HAVE_STRLCPY
 524 size_t strlcpy(char *d, const char *s, size_t bufsize);
 525 #endif
 526
 527 #ifndef HAVE_STRLCAT
 528 size_t strlcat(char *d, const char *s, size_t bufsize);
 529 #endif
 530
 531 #ifndef WEXITSTATUS
 532 #define WEXITSTATUS(stat)       ((int)(((stat)>>8)&0xFF))
 533 #endif
 534
 535 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)