rsync.h

   1 /*
   2    Copyright (C) Andrew Tridgell 1996
   3    Copyright (C) Paul Mackerras 1996
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #define BLOCK_SIZE 700
  21 #define RSYNC_RSH_ENV "RSYNC_RSH"
  22
  23 #define RSYNC_NAME "rsync"
  24 #define RSYNCD_CONF "/etc/rsyncd.conf"
  25
  26 #define URL_PREFIX "rsync://"
  27
  28 #define BACKUP_SUFFIX "~"
  29
  30 /* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
  31    imcompatible with older versions :-( */
  32 #define CHAR_OFFSET 0
  33
  34
  35 #define FLAG_DELETE (1<<0)
  36 #define SAME_MODE (1<<1)
  37 #define SAME_RDEV (1<<2)
  38 #define SAME_UID (1<<3)
  39 #define SAME_GID (1<<4)
  40 #define SAME_DIR (1<<5)
  41 #define SAME_NAME SAME_DIR
  42 #define LONG_NAME (1<<6)
  43 #define SAME_TIME (1<<7)
  44
  45 /* update this if you make incompatible changes */
  46 #define PROTOCOL_VERSION 19
  47 #define MIN_PROTOCOL_VERSION 11
  48 #define MAX_PROTOCOL_VERSION 30
  49
  50 #define RSYNC_PORT 873
  51
  52 #define SPARSE_WRITE_SIZE (1024)
  53 #define WRITE_SIZE (32*1024)
  54 #define CHUNK_SIZE (32*1024)
  55 #define MAX_MAP_SIZE (256*1024)
  56 #define IO_BUFFER_SIZE (4092)
  57 #define MAX_READ_BUFFER (1024*1024)
  58
  59 #define MAX_ARGS 1000
  60
  61 #define MPLEX_BASE 7
  62 #define FERROR 1
  63 #define FINFO 2
  64 #define FLOG 3
  65
  66 #include "errcode.h"
  67
  68 #include "config.h"
  69
  70 #if HAVE_REMSH
  71 #define RSYNC_RSH "remsh"
  72 #else
  73 #define RSYNC_RSH "rsh"
  74 #endif
  75
  76 #include <sys/types.h>
  77
  78 #ifdef HAVE_GETOPT_LONG
  79 #include <getopt.h>
  80 #else
  81 #include "lib/getopt.h"
  82 #endif
  83
  84 #ifdef HAVE_UNISTD_H
  85 #include <unistd.h>
  86 #endif
  87 #include <stdio.h>
  88 #include <stddef.h>
  89
  90 #ifdef HAVE_SYS_PARAM_H
  91 #include <sys/param.h>
  92 #endif
  93
  94 #ifdef HAVE_STDLIB_H
  95 #include <stdlib.h>
  96 #endif
  97
  98 #ifdef HAVE_SYS_SOCKET_H
  99 #include <sys/socket.h>
 100 #endif
 101
 102 #ifdef HAVE_STRING_H
 103 #include <string.h>
 104 #endif
 105
 106 #ifdef HAVE_MALLOC_H
 107 #include <malloc.h>
 108 #endif
 109
 110 #ifdef TIME_WITH_SYS_TIME
 111 #include <sys/time.h>
 112 #include <time.h>
 113 #else
 114 #ifdef HAVE_SYS_TIME_H
 115 #include <sys/time.h>
 116 #else
 117 #include <time.h>
 118 #endif
 119 #endif
 120
 121 #ifdef HAVE_FCNTL_H
 122 #include <fcntl.h>
 123 #else
 124 #ifdef HAVE_SYS_FCNTL_H
 125 #include <sys/fcntl.h>
 126 #endif
 127 #endif
 128
 129 #include <sys/stat.h>
 130
 131 #ifdef HAVE_SYS_IOCTL_H
 132 #include <sys/ioctl.h>
 133 #endif
 134
 135 #ifdef HAVE_SYS_FILIO_H
 136 #include <sys/filio.h>
 137 #endif
 138
 139 #include <signal.h>
 140 #ifdef HAVE_SYS_WAIT_H
 141 #include <sys/wait.h>
 142 #endif
 143 #ifdef HAVE_CTYPE_H
 144 #include <ctype.h>
 145 #endif
 146 #ifdef HAVE_GRP_H
 147 #include <grp.h>
 148 #endif
 149 #include <errno.h>
 150
 151 #ifdef HAVE_UTIME_H
 152 #include <utime.h>
 153 #endif
 154
 155 #ifdef HAVE_SYS_SELECT_H
 156 #include <sys/select.h>
 157 #endif
 158
 159 #ifdef HAVE_SYS_MODE_H
 160 /* apparently AIX needs this for S_ISLNK */
 161 #ifndef S_ISLNK
 162 #include <sys/mode.h>
 163 #endif
 164 #endif
 165
 166 #ifdef HAVE_FNMATCH
 167 #include <fnmatch.h>
 168 #else
 169 #include "lib/fnmatch.h"
 170 #endif
 171
 172 #ifdef HAVE_GLOB_H
 173 #include <glob.h>
 174 #endif
 175
 176 /* these are needed for the uid/gid mapping code */
 177 #include <pwd.h>
 178 #include <grp.h>
 179
 180 #include <stdarg.h>
 181 #include <netinet/in.h>
 182 #include <arpa/inet.h>
 183 #include <netdb.h>
 184 #include <syslog.h>
 185 #include <sys/file.h>
 186
 187 #if HAVE_DIRENT_H
 188 # include <dirent.h>
 189 #else
 190 # define dirent direct
 191 # if HAVE_SYS_NDIR_H
 192 #  include <sys/ndir.h>
 193 # endif
 194 # if HAVE_SYS_DIR_H
 195 #  include <sys/dir.h>
 196 # endif
 197 # if HAVE_NDIR_H
 198 #  include <ndir.h>
 199 # endif
 200 #endif
 201
 202 #ifdef HAVE_COMPAT_H
 203 #include <compat.h>
 204 #endif
 205
 206
 207 #define BOOL int
 208
 209 #ifndef uchar
 210 #define uchar unsigned char
 211 #endif
 212
 213 #if HAVE_UNSIGNED_CHAR
 214 #define schar signed char
 215 #else
 216 #define schar char
 217 #endif
 218
 219 #ifndef int32
 220 #if (SIZEOF_INT == 4)
 221 #define int32 int
 222 #elif (SIZEOF_LONG == 4)
 223 #define int32 long
 224 #elif (SIZEOF_SHORT == 4)
 225 #define int32 short
 226 #else
 227 /* I hope this works */
 228 #define int32 int
 229 #define LARGE_INT32
 230 #endif
 231 #endif
 232
 233 #ifndef uint32
 234 #define uint32 unsigned int32
 235 #endif
 236
 237 #if HAVE_OFF64_T
 238 #define OFF_T off64_t
 239 #define STRUCT_STAT struct stat64
 240 #else
 241 #define OFF_T off_t
 242 #define STRUCT_STAT struct stat
 243 #endif
 244
 245 #if HAVE_OFF64_T
 246 #define int64 off64_t
 247 #elif (SIZEOF_LONG == 8)
 248 #define int64 long
 249 #elif (SIZEOF_INT == 8)
 250 #define int64 int
 251 #elif HAVE_LONGLONG
 252 #define int64 long long
 253 #else
 254 #define int64 off_t
 255 #define NO_INT64
 256 #endif
 257
 258 #if HAVE_SHORT_INO_T
 259 #define INO_T uint32
 260 #else
 261 #define INO_T ino_t
 262 #endif
 263
 264 #ifndef MIN
 265 #define MIN(a,b) ((a)<(b)?(a):(b))
 266 #endif
 267
 268 #ifndef MAX
 269 #define MAX(a,b) ((a)>(b)?(a):(b))
 270 #endif
 271
 272 /* the length of the md4 checksum */
 273 #define MD4_SUM_LENGTH 16
 274 #define SUM_LENGTH 16
 275
 276 #ifndef MAXPATHLEN
 277 #define MAXPATHLEN 1024
 278 #endif
 279
 280 #ifndef INADDR_NONE
 281 #define INADDR_NONE 0xffffffff
 282 #endif
 283
 284 struct file_struct {
 285         unsigned flags;
 286         time_t modtime;
 287         OFF_T length;
 288         mode_t mode;
 289         INO_T inode;
 290         dev_t dev;
 291         dev_t rdev;
 292         uid_t uid;
 293         gid_t gid;
 294         char *basename;
 295         char *dirname;
 296         char *basedir;
 297         char *link;
 298         char *sum;
 299 };
 300
 301
 302 struct file_list {
 303         int count;
 304         int malloced;
 305         struct file_struct **files;
 306 };
 307
 308 struct sum_buf {
 309         OFF_T offset;           /* offset in file of this chunk */
 310         int len;                /* length of chunk of file */
 311         int i;                  /* index of this chunk */
 312         uint32 sum1;            /* simple checksum */
 313         char sum2[SUM_LENGTH];  /* checksum  */
 314 };
 315
 316 struct sum_struct {
 317   OFF_T flength;                /* total file length */
 318   int count;                    /* how many chunks */
 319   int remainder;                /* flength % block_length */
 320   int n;                        /* block_length */
 321   struct sum_buf *sums;         /* points to info for each chunk */
 322 };
 323
 324 struct map_struct {
 325         char *p;
 326         int fd,p_size,p_len;
 327         OFF_T file_size, p_offset, p_fd_offset;
 328 };
 329
 330 struct exclude_struct {
 331         char *orig;
 332         char *pattern;
 333         int regular_exp;
 334         int include;
 335         int directory;
 336         int local;
 337 };
 338
 339 struct stats {
 340         int64 total_size;
 341         int64 total_transferred_size;
 342         int64 total_written;
 343         int64 total_read;
 344         int64 literal_data;
 345         int64 matched_data;
 346         int flist_size;
 347         int num_files;
 348         int num_transferred_files;
 349 };
 350
 351
 352 /* we need this function because of the silly way in which duplicate
 353    entries are handled in the file lists - we can't change this
 354    without breaking existing versions */
 355 static inline int flist_up(struct file_list *flist, int i)
 356 {
 357         while (!flist->files[i]->basename) i++;
 358         return i;
 359 }
 360
 361 #include "byteorder.h"
 362 #include "version.h"
 363 #include "proto.h"
 364 #include "lib/mdfour.h"
 365
 366 #if !HAVE_STRERROR
 367 extern char *sys_errlist[];
 368 #define strerror(i) sys_errlist[i]
 369 #endif
 370
 371 #ifndef HAVE_STRCHR
 372 # define strchr                 index
 373 # define strrchr                rindex
 374 #endif
 375
 376 #ifndef HAVE_ERRNO_DECL
 377 extern int errno;
 378 #endif
 379
 380 #define SUPPORT_LINKS HAVE_READLINK
 381 #define SUPPORT_HARD_LINKS HAVE_LINK
 382
 383 #ifndef HAVE_LCHOWN
 384 #define lchown chown
 385 #endif
 386
 387 #define SIGNAL_CAST (RETSIGTYPE (*)())
 388
 389 #ifndef EWOULDBLOCK
 390 #define EWOULDBLOCK EAGAIN
 391 #endif
 392
 393 #ifndef STDIN_FILENO
 394 #define STDIN_FILENO 0
 395 #endif
 396
 397 #ifndef STDOUT_FILENO
 398 #define STDOUT_FILENO 1
 399 #endif
 400
 401 #ifndef STDERR_FILENO
 402 #define STDERR_FILENO 2
 403 #endif
 404
 405 #ifndef S_IWUSR
 406 #define S_IWUSR 0200
 407 #endif
 408
 409 #ifndef _S_IFMT
 410 #define _S_IFMT        0170000
 411 #endif
 412
 413 #ifndef _S_IFLNK
 414 #define _S_IFLNK  0120000
 415 #endif
 416
 417 #ifndef S_ISLNK
 418 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
 419 #endif
 420
 421 #ifndef S_ISBLK
 422 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
 423 #endif
 424
 425 #ifndef S_ISCHR
 426 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
 427 #endif
 428
 429 #ifndef S_ISSOCK
 430 #ifdef _S_IFSOCK
 431 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
 432 #else
 433 #define S_ISSOCK(mode) (0)
 434 #endif
 435 #endif
 436
 437 #ifndef S_ISFIFO
 438 #ifdef _S_IFIFO
 439 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
 440 #else
 441 #define S_ISFIFO(mode) (0)
 442 #endif
 443 #endif
 444
 445 #ifndef S_ISDIR
 446 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
 447 #endif
 448
 449 #ifndef S_ISREG
 450 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
 451 #endif
 452
 453
 454 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
 455
 456 #ifndef ACCESSPERMS
 457 #define ACCESSPERMS 0777
 458 #endif
 459
 460 /* handler for null strings in printf format */
 461 #define NS(s) ((s)?(s):"<NULL>")
 462
 463 /* use magic gcc attributes to catch format errors */
 464  void rprintf(int , const char *, ...)
 465 #ifdef __GNUC__
 466      __attribute__ ((format (printf, 2, 3)))
 467 #endif
 468 ;
 469
 470 #ifdef REPLACE_INET_NTOA
 471 #define inet_ntoa rep_inet_ntoa
 472 #endif
 473
 474
 475 #ifndef HAVE_STRLCPY
 476 size_t strlcpy(char *d, const char *s, size_t bufsize);
 477 #endif
 478
 479 #ifndef HAVE_STRLCAT
 480 size_t strlcat(char *d, const char *s, size_t bufsize);
 481 #endif
 482
 483 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)