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