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
  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 25
  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 /* these are needed for the uid/gid mapping code */
 189 #include <pwd.h>
 190 #include <grp.h>
 191
 192 #include <stdarg.h>
 193 #include <netinet/in.h>
 194 #include <arpa/inet.h>
 195 #include <netdb.h>
 196 #include <syslog.h>
 197 #include <sys/file.h>
 198
 199 #if HAVE_DIRENT_H
 200 # include <dirent.h>
 201 #else
 202 # define dirent direct
 203 # if HAVE_SYS_NDIR_H
 204 #  include <sys/ndir.h>
 205 # endif
 206 # if HAVE_SYS_DIR_H
 207 #  include <sys/dir.h>
 208 # endif
 209 # if HAVE_NDIR_H
 210 #  include <ndir.h>
 211 # endif
 212 #endif
 213
 214 #ifdef HAVE_COMPAT_H
 215 #include <compat.h>
 216 #endif
 217
 218
 219 #define BOOL int
 220
 221 #ifndef uchar
 222 #define uchar unsigned char
 223 #endif
 224
 225 #if HAVE_UNSIGNED_CHAR
 226 #define schar signed char
 227 #else
 228 #define schar char
 229 #endif
 230
 231 #ifndef int32
 232 #if (SIZEOF_INT == 4)
 233 #define int32 int
 234 #elif (SIZEOF_LONG == 4)
 235 #define int32 long
 236 #elif (SIZEOF_SHORT == 4)
 237 #define int32 short
 238 #else
 239 /* I hope this works */
 240 #define int32 int
 241 #define LARGE_INT32
 242 #endif
 243 #endif
 244
 245 #ifndef uint32
 246 #define uint32 unsigned int32
 247 #endif
 248
 249 #if HAVE_OFF64_T
 250 #define OFF_T off64_t
 251 #define STRUCT_STAT struct stat64
 252 #else
 253 #define OFF_T off_t
 254 #define STRUCT_STAT struct stat
 255 #endif
 256
 257 #if HAVE_OFF64_T
 258 #define int64 off64_t
 259 #elif (SIZEOF_LONG == 8)
 260 #define int64 long
 261 #elif (SIZEOF_INT == 8)
 262 #define int64 int
 263 #elif HAVE_LONGLONG
 264 #define int64 long long
 265 #else
 266 #define int64 off_t
 267 #define NO_INT64
 268 #endif
 269
 270 #if HAVE_SHORT_INO_T
 271 #  define INO_T uint32
 272 #elif HAVE_INO_T
 273 #  define INO_T ino_t
 274 #else
 275 #  define INO_T unsigned
 276 #endif
 277
 278 #ifndef MIN
 279 #define MIN(a,b) ((a)<(b)?(a):(b))
 280 #endif
 281
 282 #ifndef MAX
 283 #define MAX(a,b) ((a)>(b)?(a):(b))
 284 #endif
 285
 286 #ifndef MAXHOSTNAMELEN
 287 #define MAXHOSTNAMELEN 256
 288 #endif
 289
 290 /* the length of the md4 checksum */
 291 #define MD4_SUM_LENGTH 16
 292 #define SUM_LENGTH 16
 293
 294 #ifndef MAXPATHLEN
 295 #define MAXPATHLEN 1024
 296 #endif
 297
 298 #ifndef INADDR_NONE
 299 #define INADDR_NONE 0xffffffff
 300 #endif
 301
 302 struct file_struct {
 303         unsigned flags;
 304         time_t modtime;
 305         OFF_T length;
 306         mode_t mode;
 307         INO_T inode;
 308         dev_t dev;
 309         dev_t rdev;
 310         uid_t uid;
 311         gid_t gid;
 312         char *basename;
 313         char *dirname;
 314         char *basedir;
 315         char *link;
 316         char *sum;
 317 };
 318
 319
 320 #define ARENA_SIZE      (32 * 1024)
 321
 322 struct string_area {
 323         char *base;
 324         char *end;
 325         char *current;
 326         struct string_area *next;
 327 };
 328
 329 struct file_list {
 330         int count;
 331         int malloced;
 332         struct file_struct **files;
 333         struct string_area *string_area;
 334 };
 335
 336 struct sum_buf {
 337         OFF_T offset;           /* offset in file of this chunk */
 338         int len;                /* length of chunk of file */
 339         int i;                  /* index of this chunk */
 340         uint32 sum1;            /* simple checksum */
 341         char sum2[SUM_LENGTH];  /* checksum  */
 342 };
 343
 344 struct sum_struct {
 345   OFF_T flength;                /* total file length */
 346   int count;                    /* how many chunks */
 347   int remainder;                /* flength % block_length */
 348   int n;                        /* block_length */
 349   struct sum_buf *sums;         /* points to info for each chunk */
 350 };
 351
 352 struct map_struct {
 353         char *p;
 354         int fd,p_size,p_len;
 355         OFF_T file_size, p_offset, p_fd_offset;
 356 };
 357
 358 struct exclude_struct {
 359         char *pattern;
 360         int regular_exp;
 361         int fnmatch_flags;
 362         int include;
 363         int directory;
 364         int local;
 365 };
 366
 367 struct stats {
 368         int64 total_size;
 369         int64 total_transferred_size;
 370         int64 total_written;
 371         int64 total_read;
 372         int64 literal_data;
 373         int64 matched_data;
 374         int flist_size;
 375         int num_files;
 376         int num_transferred_files;
 377 };
 378
 379
 380 /* we need this function because of the silly way in which duplicate
 381    entries are handled in the file lists - we can't change this
 382    without breaking existing versions */
 383 static inline int flist_up(struct file_list *flist, int i)
 384 {
 385         while (!flist->files[i]->basename) i++;
 386         return i;
 387 }
 388
 389 #include "byteorder.h"
 390 #include "proto.h"
 391 #include "lib/mdfour.h"
 392 #include "lib/permstring.h"
 393
 394 /* We have replacement versions of these if they're missing. */
 395 #ifndef HAVE_ASPRINTF
 396 int asprintf(char **ptr, const char *format, ...);
 397 #endif
 398
 399 #ifndef HAVE_VASPRINTF
 400 int vasprintf(char **ptr, const char *format, va_list ap);
 401 #endif
 402
 403 #if !defined(HAVE_VSNPRINTF) && !defined(HAVE_C99_VSNPRINTF)
 404 int vsnprintf (char *str, size_t count, const char *fmt, va_list args);
 405 #endif
 406
 407 #if !defined(HAVE_SNPRINTF) && !defined(HAVE_C99_VSNPRINTF)
 408 int snprintf(char *str,size_t count,const char *fmt,...);
 409 #endif
 410
 411
 412 #if !HAVE_STRERROR
 413 extern char *sys_errlist[];
 414 #define strerror(i) sys_errlist[i]
 415 #endif
 416
 417 #ifndef HAVE_STRCHR
 418 # define strchr                 index
 419 # define strrchr                rindex
 420 #endif
 421
 422 #ifndef HAVE_ERRNO_DECL
 423 extern int errno;
 424 #endif
 425
 426 #define SUPPORT_LINKS HAVE_READLINK
 427 #define SUPPORT_HARD_LINKS HAVE_LINK
 428
 429 #ifndef HAVE_LCHOWN
 430 #define lchown chown
 431 #endif
 432
 433 #define SIGNAL_CAST (RETSIGTYPE (*)())
 434
 435 #ifndef EWOULDBLOCK
 436 #define EWOULDBLOCK EAGAIN
 437 #endif
 438
 439 #ifndef STDIN_FILENO
 440 #define STDIN_FILENO 0
 441 #endif
 442
 443 #ifndef STDOUT_FILENO
 444 #define STDOUT_FILENO 1
 445 #endif
 446
 447 #ifndef STDERR_FILENO
 448 #define STDERR_FILENO 2
 449 #endif
 450
 451 #ifndef S_IWUSR
 452 #define S_IWUSR 0200
 453 #endif
 454
 455 #ifndef _S_IFMT
 456 #define _S_IFMT        0170000
 457 #endif
 458
 459 #ifndef _S_IFLNK
 460 #define _S_IFLNK  0120000
 461 #endif
 462
 463 #ifndef S_ISLNK
 464 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
 465 #endif
 466
 467 #ifndef S_ISBLK
 468 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
 469 #endif
 470
 471 #ifndef S_ISCHR
 472 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
 473 #endif
 474
 475 #ifndef S_ISSOCK
 476 #ifdef _S_IFSOCK
 477 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
 478 #else
 479 #define S_ISSOCK(mode) (0)
 480 #endif
 481 #endif
 482
 483 #ifndef S_ISFIFO
 484 #ifdef _S_IFIFO
 485 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
 486 #else
 487 #define S_ISFIFO(mode) (0)
 488 #endif
 489 #endif
 490
 491 #ifndef S_ISDIR
 492 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
 493 #endif
 494
 495 #ifndef S_ISREG
 496 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
 497 #endif
 498
 499 /* work out what fcntl flag to use for non-blocking */
 500 #ifdef O_NONBLOCK
 501 # define NONBLOCK_FLAG O_NONBLOCK
 502 #elif defined(SYSV)
 503 # define NONBLOCK_FLAG O_NDELAY
 504 #else
 505 # define NONBLOCK_FLAG FNDELAY
 506 #endif
 507
 508 #ifndef INADDR_LOOPBACK
 509 #define INADDR_LOOPBACK 0x7f000001
 510 #endif
 511
 512 #ifndef INADDR_NONE
 513 #define INADDR_NONE 0xffffffff
 514 #endif
 515
 516 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
 517
 518 #ifndef ACCESSPERMS
 519 #define ACCESSPERMS 0777
 520 #endif
 521 /* Initial mask on permissions given to temporary files.  Mask off setuid
 522      bits and group access because of potential race-condition security
 523      holes, and mask other access because mode 707 is bizarre */
 524 #define INITACCESSPERMS 0700
 525
 526 /* handler for null strings in printf format */
 527 #define NS(s) ((s)?(s):"<NULL>")
 528
 529 /* use magic gcc attributes to catch format errors */
 530  void rprintf(enum logcode , const char *, ...)
 531 #ifdef __GNUC__
 532      __attribute__ ((format (printf, 2, 3)))
 533 #endif
 534 ;
 535
 536 /* This is just like rprintf, but it also tries to print some
 537  * representation of the error code.  Normally errcode = errno. */
 538 void rsyserr(enum logcode, int, const char *, ...)
 539 #ifdef __GNUC__
 540      __attribute__ ((format (printf, 3, 4)))
 541 #endif
 542      ;
 543
 544 #ifdef REPLACE_INET_NTOA
 545 #define inet_ntoa rep_inet_ntoa
 546 #endif
 547
 548
 549 #ifndef HAVE_STRLCPY
 550 size_t strlcpy(char *d, const char *s, size_t bufsize);
 551 #endif
 552
 553 #ifndef HAVE_STRLCAT
 554 size_t strlcat(char *d, const char *s, size_t bufsize);
 555 #endif
 556
 557 #ifndef WEXITSTATUS
 558 #define WEXITSTATUS(stat)       ((int)(((stat)>>8)&0xFF))
 559 #endif
 560
 561 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
 562
 563
 564 extern int verbose;
 565
 566 extern struct global_opts {
 567         /** Network address family. **/
 568         int af_hint;
 569 } global_opts;
 570
 571
 572 #ifndef HAVE_INET_NTOP
 573 const char *
 574 inet_ntop(int af, const void *src, char *dst, size_t size);
 575 #endif /* !HAVE_INET_NTOP */
 576
 577 #ifndef HAVE_INET_PTON
 578 int isc_net_pton(int af, const char *src, void *dst);
 579 #endif