Mention the latest changes.
[rsync/rsync.git] / rsync.h
... / ...
CommitLineData
1/*
2 * Copyright (C) 1996, 2000 Andrew Tridgell
3 * Copyright (C) 1996 Paul Mackerras
4 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
5 * Copyright (C) 2003, 2004, 2005, 2006 Wayne Davison
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
20 */
21
22#define False 0
23#define True 1
24
25#define BLOCK_SIZE 700
26#define RSYNC_RSH_ENV "RSYNC_RSH"
27#define RSYNC_RSH_IO_ENV "RSYNC_RSH_IO"
28
29#define RSYNC_NAME "rsync"
30/* RSYNCD_SYSCONF is now set in config.h */
31#define RSYNCD_USERCONF "rsyncd.conf"
32
33#define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
34#define URL_PREFIX "rsync://"
35
36#define BACKUP_SUFFIX "~"
37
38/* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
39 incompatible with older versions :-( */
40#define CHAR_OFFSET 0
41
42/* These flags are only used during the flist transfer. */
43
44#define XMIT_TOP_DIR (1<<0)
45#define XMIT_SAME_MODE (1<<1)
46#define XMIT_EXTENDED_FLAGS (1<<2)
47#define XMIT_SAME_RDEV_pre28 XMIT_EXTENDED_FLAGS /* Only in protocols < 28 */
48#define XMIT_SAME_UID (1<<3)
49#define XMIT_SAME_GID (1<<4)
50#define XMIT_SAME_NAME (1<<5)
51#define XMIT_LONG_NAME (1<<6)
52#define XMIT_SAME_TIME (1<<7)
53#define XMIT_SAME_RDEV_MAJOR (1<<8)
54#define XMIT_HAS_IDEV_DATA (1<<9)
55#define XMIT_SAME_DEV (1<<10)
56#define XMIT_RDEV_MINOR_IS_SMALL (1<<11)
57
58/* These flags are used in the live flist data. */
59
60#define FLAG_TOP_DIR (1<<0)
61#define FLAG_SENT (1<<1) /* sender */
62#define FLAG_HLINK_EOL (1<<1) /* receiver/generator */
63#define FLAG_MOUNT_POINT (1<<2) /* sender/generator */
64#define FLAG_DEL_HERE (1<<3) /* receiver/generator */
65#define FLAG_HLINK_TOL (1<<4) /* receiver/generator */
66#define FLAG_NO_FUZZY (1<<5) /* generator */
67#define FLAG_MISSING (1<<6) /* generator */
68
69/* update this if you make incompatible changes */
70#define PROTOCOL_VERSION 29
71
72/* We refuse to interoperate with versions that are not in this range.
73 * Note that we assume we'll work with later versions: the onus is on
74 * people writing them to make sure that they don't send us anything
75 * we won't understand.
76 *
77 * Interoperation with old but supported protocol versions
78 * should cause a warning to be printed. At a future date
79 * the old protocol will become the minimum and
80 * compatibility code removed.
81 *
82 * There are two possible explanations for the limit at
83 * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
84 * do not interoperate with us, and (more likely) so that we can
85 * detect an attempt to connect rsync to a non-rsync server, which is
86 * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
87 * MAX_PROTOCOL_VERSION. */
88
89#define MIN_PROTOCOL_VERSION 20
90#define OLD_PROTOCOL_VERSION 25
91#define MAX_PROTOCOL_VERSION 40
92
93#define RSYNC_PORT 873
94
95#define SPARSE_WRITE_SIZE (1024)
96#define WRITE_SIZE (32*1024)
97#define CHUNK_SIZE (32*1024)
98#define MAX_MAP_SIZE (256*1024)
99#define IO_BUFFER_SIZE (4092)
100#define MAX_BLOCK_SIZE ((int32)1 << 29)
101
102#define IOERR_GENERAL (1<<0) /* For backward compatibility, this must == 1 */
103#define IOERR_VANISHED (1<<1)
104#define IOERR_DEL_LIMIT (1<<2)
105
106#define MAX_ARGS 1000
107#define MAX_BASIS_DIRS 20
108#define MAX_SERVER_ARGS (MAX_BASIS_DIRS*2 + 100)
109
110#define MPLEX_BASE 7
111
112#define NO_FILTERS 0
113#define SERVER_FILTERS 1
114#define ALL_FILTERS 2
115
116#define XFLG_FATAL_ERRORS (1<<0)
117#define XFLG_OLD_PREFIXES (1<<1)
118#define XFLG_ANCHORED2ABS (1<<2)
119#define XFLG_ABS_IF_SLASH (1<<3)
120
121#define ATTRS_REPORT (1<<0)
122#define ATTRS_SKIP_MTIME (1<<1)
123
124#define FULL_FLUSH 1
125#define NORMAL_FLUSH 0
126
127#define PDIR_CREATE 1
128#define PDIR_DELETE 0
129
130/* Note: 0x00 - 0x7F are used for basis_dir[] indexes! */
131#define FNAMECMP_BASIS_DIR_LOW 0x00 /* Must remain 0! */
132#define FNAMECMP_BASIS_DIR_HIGH 0x7F
133#define FNAMECMP_FNAME 0x80
134#define FNAMECMP_PARTIAL_DIR 0x81
135#define FNAMECMP_BACKUP 0x82
136#define FNAMECMP_FUZZY 0x83
137
138/* For use by the itemize_changes code */
139#define ITEM_REPORT_ATIME (1<<0)
140#define ITEM_REPORT_CHECKSUM (1<<1)
141#define ITEM_REPORT_SIZE (1<<2)
142#define ITEM_REPORT_TIME (1<<3)
143#define ITEM_REPORT_PERMS (1<<4)
144#define ITEM_REPORT_OWNER (1<<5)
145#define ITEM_REPORT_GROUP (1<<6)
146#define ITEM_REPORT_ACL (1<<7)
147#define ITEM_REPORT_XATTR (1<<8)
148#define ITEM_BASIS_TYPE_FOLLOWS (1<<11)
149#define ITEM_XNAME_FOLLOWS (1<<12)
150#define ITEM_IS_NEW (1<<13)
151#define ITEM_LOCAL_CHANGE (1<<14)
152#define ITEM_TRANSFER (1<<15)
153/* These are outside the range of the transmitted flags. */
154#define ITEM_MISSING_DATA (1<<16) /* used by log_formatted() */
155#define ITEM_DELETED (1<<17) /* used by log_formatted() */
156
157#define SIGNIFICANT_ITEM_FLAGS (~(\
158 ITEM_BASIS_TYPE_FOLLOWS | ITEM_XNAME_FOLLOWS | ITEM_LOCAL_CHANGE))
159
160
161/* Log-message categories. Only FERROR and FINFO get sent over the socket,
162 * but FLOG and FSOCKERR can be sent over the receiver -> generator pipe.
163 * FLOG only goes to the log file, not the client; FCLIENT is the opposite. */
164enum logcode { FERROR=1, FINFO=2, FLOG=3, FCLIENT=4, FSOCKERR=5 };
165
166/* Messages types that are sent over the message channel. The logcode
167 * values must all be present here with identical numbers. */
168enum msgcode {
169 MSG_DATA=0, /* raw data on the multiplexed stream */
170 MSG_ERROR=FERROR, MSG_INFO=FINFO, /* remote logging */
171 MSG_LOG=FLOG, MSG_SOCKERR=FSOCKERR, /* sibling logging */
172 MSG_REDO=9, /* reprocess indicated flist index */
173 MSG_SUCCESS=100,/* successfully updated indicated flist index */
174 MSG_DELETED=101,/* successfully deleted a file on receiving side */
175 MSG_DONE=86 /* current phase is done */
176};
177
178#include "errcode.h"
179
180#include "config.h"
181
182/* The default RSYNC_RSH is always set in config.h. */
183
184#include <stdio.h>
185#ifdef HAVE_SYS_TYPES_H
186# include <sys/types.h>
187#endif
188#ifdef HAVE_SYS_STAT_H
189# include <sys/stat.h>
190#endif
191#ifdef STDC_HEADERS
192# include <stdlib.h>
193# include <stddef.h>
194#else
195# ifdef HAVE_STDLIB_H
196# include <stdlib.h>
197# endif
198#endif
199#ifdef HAVE_STRING_H
200# if !defined STDC_HEADERS && defined HAVE_MEMORY_H
201# include <memory.h>
202# endif
203# include <string.h>
204#endif
205#ifdef HAVE_STRINGS_H
206# include <strings.h>
207#endif
208#ifdef HAVE_UNISTD_H
209# include <unistd.h>
210#endif
211
212#ifdef HAVE_SYS_PARAM_H
213#include <sys/param.h>
214#endif
215
216#if defined HAVE_MALLOC_H && (defined HAVE_MALLINFO || !defined HAVE_STDLIB_H)
217#include <malloc.h>
218#endif
219
220#ifdef HAVE_SYS_SOCKET_H
221#include <sys/socket.h>
222#endif
223
224#ifdef TIME_WITH_SYS_TIME
225#include <sys/time.h>
226#include <time.h>
227#else
228#ifdef HAVE_SYS_TIME_H
229#include <sys/time.h>
230#else
231#include <time.h>
232#endif
233#endif
234
235#ifdef HAVE_FCNTL_H
236#include <fcntl.h>
237#else
238#ifdef HAVE_SYS_FCNTL_H
239#include <sys/fcntl.h>
240#endif
241#endif
242
243#ifdef HAVE_SYS_IOCTL_H
244#include <sys/ioctl.h>
245#endif
246
247#ifdef HAVE_SYS_FILIO_H
248#include <sys/filio.h>
249#endif
250
251#include <signal.h>
252#ifdef HAVE_SYS_WAIT_H
253#include <sys/wait.h>
254#endif
255#ifdef HAVE_CTYPE_H
256#include <ctype.h>
257#endif
258#ifdef HAVE_GRP_H
259#include <grp.h>
260#endif
261#include <errno.h>
262
263#ifdef HAVE_UTIME_H
264#include <utime.h>
265#endif
266
267#ifdef HAVE_SYS_SELECT_H
268#include <sys/select.h>
269#endif
270
271#ifdef HAVE_SYS_MODE_H
272/* apparently AIX needs this for S_ISLNK */
273#ifndef S_ISLNK
274#include <sys/mode.h>
275#endif
276#endif
277
278#ifdef HAVE_GLOB_H
279#include <glob.h>
280#endif
281
282/* these are needed for the uid/gid mapping code */
283#include <pwd.h>
284#include <grp.h>
285
286#include <stdarg.h>
287#include <netinet/in.h>
288#include <arpa/inet.h>
289#include <netdb.h>
290#include <syslog.h>
291#include <sys/file.h>
292
293#ifdef HAVE_DIRENT_H
294# include <dirent.h>
295#else
296# define dirent direct
297# ifdef HAVE_SYS_NDIR_H
298# include <sys/ndir.h>
299# endif
300# ifdef HAVE_SYS_DIR_H
301# include <sys/dir.h>
302# endif
303# ifdef HAVE_NDIR_H
304# include <ndir.h>
305# endif
306#endif
307
308#ifdef MAJOR_IN_MKDEV
309#include <sys/mkdev.h>
310# if !defined makedev && (defined mkdev || defined _WIN32 || defined __WIN32__)
311# define makedev mkdev
312# endif
313#elif defined MAJOR_IN_SYSMACROS
314#include <sys/sysmacros.h>
315#endif
316
317#ifdef MAKEDEV_TAKES_3_ARGS
318#define MAKEDEV(devmajor,devminor) makedev(0,devmajor,devminor)
319#else
320#define MAKEDEV(devmajor,devminor) makedev(devmajor,devminor)
321#endif
322
323#ifdef HAVE_COMPAT_H
324#include <compat.h>
325#endif
326
327#ifdef HAVE_LIMITS_H
328# include <limits.h>
329#endif
330
331#include <assert.h>
332
333#include "lib/pool_alloc.h"
334
335#define BOOL int
336
337#ifndef uchar
338#define uchar unsigned char
339#endif
340
341#ifdef SIGNED_CHAR_OK
342#define schar signed char
343#else
344#define schar char
345#endif
346
347/* Find a variable that is either exactly 32-bits or longer.
348 * If some code depends on 32-bit truncation, it will need to
349 * take special action in a "#if SIZEOF_INT32 > 4" section. */
350#ifndef int32
351#if SIZEOF_INT == 4
352# define int32 int
353# define SIZEOF_INT32 4
354#elif SIZEOF_LONG == 4
355# define int32 long
356# define SIZEOF_INT32 4
357#elif SIZEOF_SHORT == 4
358# define int32 short
359# define SIZEOF_INT32 4
360#elif SIZEOF_INT > 4
361# define int32 int
362# define SIZEOF_INT32 SIZEOF_INT
363#elif SIZEOF_LONG > 4
364# define int32 long
365# define SIZEOF_INT32 SIZEOF_LONG
366#else
367# error Could not find a 32-bit integer variable
368#endif
369#else
370# define SIZEOF_INT32 4
371#endif
372
373#ifndef uint32
374#define uint32 unsigned int32
375#endif
376
377#if SIZEOF_OFF_T == 8 || !SIZEOF_OFF64_T || !defined HAVE_STRUCT_STAT64
378#define OFF_T off_t
379#define STRUCT_STAT struct stat
380#else
381#define OFF_T off64_t
382#define STRUCT_STAT struct stat64
383#define USE_STAT64_FUNCS 1
384#endif
385
386/* CAVEAT: on some systems, int64 will really be a 32-bit integer IFF
387 * that's the maximum size the file system can handle and there is no
388 * 64-bit type available. The rsync source must therefore take steps
389 * to ensure that any code that really requires a 64-bit integer has
390 * it (e.g. the checksum code uses two 32-bit integers for its 64-bit
391 * counter). */
392#if SIZEOF_OFF64_T == 8
393# define int64 off64_t
394# define SIZEOF_INT64 8
395#elif SIZEOF_LONG == 8
396# define int64 long
397# define SIZEOF_INT64 8
398#elif SIZEOF_INT == 8
399# define int64 int
400# define SIZEOF_INT64 8
401#elif SIZEOF_LONG_LONG == 8
402# define int64 long long
403# define SIZEOF_INT64 8
404#elif SIZEOF_OFF_T == 8
405# define int64 off_t
406# define SIZEOF_INT64 8
407#elif SIZEOF_INT > 8
408# define int64 int
409# define SIZEOF_INT64 SIZEOF_INT
410#elif SIZEOF_LONG > 8
411# define int64 long
412# define SIZEOF_INT64 SIZEOF_LONG
413#elif SIZEOF_LONG_LONG > 8
414# define int64 long long
415# define SIZEOF_INT64 SIZEOF_LONG_LONG
416#else
417/* As long as it gets... */
418# define int64 off_t
419# define SIZEOF_INT64 SIZEOF_OFF_T
420#endif
421
422/* Starting from protocol version 26, we always use 64-bit
423 * ino_t and dev_t internally, even if this platform does not
424 * allow files to have 64-bit inums. That's because the
425 * receiver needs to find duplicate (dev,ino) tuples to detect
426 * hardlinks, and it might have files coming from a platform
427 * that has 64-bit inums.
428 *
429 * The only exception is if we're on a platform with no 64-bit type at
430 * all.
431 *
432 * Because we use read_longint() to get these off the wire, if you
433 * transfer devices or hardlinks with dev or inum > 2**32 to a machine
434 * with no 64-bit types then you will get an overflow error. Probably
435 * not many people have that combination of machines, and you can
436 * avoid it by not preserving hardlinks or not transferring device
437 * nodes. It's not clear that any other behaviour is better.
438 *
439 * Note that if you transfer devices from a 64-bit-devt machine (say,
440 * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the
441 * device numbers will be truncated. But it's a kind of silly thing
442 * to do anyhow.
443 *
444 * FIXME: I don't think the code in flist.c has ever worked on a system
445 * where dev_t is a struct.
446 */
447
448struct idev {
449 int64 inode;
450 int64 dev;
451};
452
453#ifndef MIN
454#define MIN(a,b) ((a)<(b)?(a):(b))
455#endif
456
457#ifndef MAX
458#define MAX(a,b) ((a)>(b)?(a):(b))
459#endif
460
461#ifndef MAXHOSTNAMELEN
462#define MAXHOSTNAMELEN 256
463#endif
464
465/* the length of the md4 checksum */
466#define MD4_SUM_LENGTH 16
467#define SUM_LENGTH 16
468#define SHORT_SUM_LENGTH 2
469#define BLOCKSUM_BIAS 10
470
471#ifndef MAXPATHLEN
472#define MAXPATHLEN 1024
473#endif
474
475/* We want a roomy line buffer that can hold more than MAXPATHLEN,
476 * and significantly more than an overly short MAXPATHLEN. */
477#if MAXPATHLEN < 4096
478#define BIGPATHBUFLEN (4096+1024)
479#else
480#define BIGPATHBUFLEN (MAXPATHLEN+1024)
481#endif
482
483#ifndef NAME_MAX
484#define NAME_MAX 255
485#endif
486
487#ifndef INADDR_NONE
488#define INADDR_NONE 0xffffffff
489#endif
490
491#ifndef IN_LOOPBACKNET
492#define IN_LOOPBACKNET 127
493#endif
494
495#define GID_NONE ((gid_t)-1)
496
497#define HL_CHECK_MASTER 0
498#define HL_SKIP 1
499
500struct hlink {
501 int next;
502 int hlindex;
503};
504
505#define F_DEV link_u.idev->dev
506#define F_INODE link_u.idev->inode
507
508#define F_HLINDEX link_u.links->hlindex
509#define F_NEXT link_u.links->next
510
511struct file_struct {
512 union {
513 dev_t rdev; /* The device number, if this is a device */
514 char *sum; /* Only a normal file can have a checksum */
515 char *link; /* Points to symlink string, if a symlink */
516 } u;
517 OFF_T length;
518 char *basename; /* The current item's name (AKA filename) */
519 char *dirname; /* The directory info inside the transfer */
520 union {
521 char *root; /* Sender-side dir info outside transfer */
522 int depth; /* Receiver-side directory depth info */
523 } dir;
524 union {
525 struct idev *idev;
526 struct hlink *links;
527 } link_u;
528 time_t modtime;
529 uid_t uid;
530 gid_t gid;
531 mode_t mode;
532 uchar flags; /* this item MUST remain last */
533};
534
535/*
536 * Start the flist array at FLIST_START entries and grow it
537 * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
538 */
539#define FLIST_START (32 * 1024)
540#define FLIST_LINEAR (FLIST_START * 512)
541
542/*
543 * Extent size for allocation pools A minimum size of 128KB
544 * is needed to mmap them so that freeing will release the
545 * space to the OS.
546 *
547 * Larger sizes reduce leftover fragments and speed free calls
548 * (when they happen) Smaller sizes increase the chance of
549 * freed allocations freeing whole extents.
550 */
551#define FILE_EXTENT (256 * 1024)
552#define HLINK_EXTENT (128 * 1024)
553
554#define WITH_HLINK 1
555#define WITHOUT_HLINK 0
556
557struct file_list {
558 struct file_struct **files;
559 alloc_pool_t file_pool;
560 alloc_pool_t hlink_pool;
561 int count;
562 int malloced;
563 int low, high;
564};
565
566#define SUMFLG_SAME_OFFSET (1<<0)
567
568struct sum_buf {
569 OFF_T offset; /**< offset in file of this chunk */
570 int32 len; /**< length of chunk of file */
571 uint32 sum1; /**< simple checksum */
572 int32 chain; /**< next hash-table collision */
573 short flags; /**< flag bits */
574 char sum2[SUM_LENGTH]; /**< checksum */
575};
576
577struct sum_struct {
578 OFF_T flength; /**< total file length */
579 struct sum_buf *sums; /**< points to info for each chunk */
580 int32 count; /**< how many chunks */
581 int32 blength; /**< block_length */
582 int32 remainder; /**< flength % block_length */
583 int s2length; /**< sum2_length */
584};
585
586struct map_struct {
587 OFF_T file_size; /* File size (from stat) */
588 OFF_T p_offset; /* Window start */
589 OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */
590 char *p; /* Window pointer */
591 int32 p_size; /* Largest window size we allocated */
592 int32 p_len; /* Latest (rounded) window size */
593 int32 def_window_size; /* Default window size */
594 int fd; /* File Descriptor */
595 int status; /* first errno from read errors */
596};
597
598#define MATCHFLG_WILD (1<<0) /* pattern has '*', '[', and/or '?' */
599#define MATCHFLG_WILD2 (1<<1) /* pattern has '**' */
600#define MATCHFLG_WILD2_PREFIX (1<<2) /* pattern starts with "**" */
601#define MATCHFLG_WILD3_SUFFIX (1<<3) /* pattern ends with "***" */
602#define MATCHFLG_ABS_PATH (1<<4) /* path-match on absolute path */
603#define MATCHFLG_INCLUDE (1<<5) /* this is an include, not an exclude */
604#define MATCHFLG_DIRECTORY (1<<6) /* this matches only directories */
605#define MATCHFLG_WORD_SPLIT (1<<7) /* split rules on whitespace */
606#define MATCHFLG_NO_INHERIT (1<<8) /* don't inherit these rules */
607#define MATCHFLG_NO_PREFIXES (1<<9) /* parse no prefixes from patterns */
608#define MATCHFLG_MERGE_FILE (1<<10)/* specifies a file to merge */
609#define MATCHFLG_PERDIR_MERGE (1<<11)/* merge-file is searched per-dir */
610#define MATCHFLG_EXCLUDE_SELF (1<<12)/* merge-file name should be excluded */
611#define MATCHFLG_FINISH_SETUP (1<<13)/* per-dir merge file needs setup */
612#define MATCHFLG_NEGATE (1<<14)/* rule matches when pattern does not */
613#define MATCHFLG_CVS_IGNORE (1<<15)/* rule was -C or :C */
614#define MATCHFLG_SENDER_SIDE (1<<16)/* rule applies to the sending side */
615#define MATCHFLG_RECEIVER_SIDE (1<<17)/* rule applies to the receiving side */
616#define MATCHFLG_CLEAR_LIST (1<<18)/* this item is the "!" token */
617
618#define MATCHFLGS_FROM_CONTAINER (MATCHFLG_ABS_PATH | MATCHFLG_INCLUDE \
619 | MATCHFLG_DIRECTORY | MATCHFLG_SENDER_SIDE \
620 | MATCHFLG_NEGATE | MATCHFLG_RECEIVER_SIDE)
621
622struct filter_struct {
623 struct filter_struct *next;
624 char *pattern;
625 uint32 match_flags;
626 union {
627 int slash_cnt;
628 struct filter_list_struct *mergelist;
629 } u;
630};
631
632struct filter_list_struct {
633 struct filter_struct *head;
634 struct filter_struct *tail;
635 char *debug_type;
636};
637
638struct stats {
639 int64 total_size;
640 int64 total_transferred_size;
641 int64 total_written;
642 int64 total_read;
643 int64 literal_data;
644 int64 matched_data;
645 int64 flist_buildtime;
646 int64 flist_xfertime;
647 int flist_size;
648 int num_files;
649 int num_transferred_files;
650 int current_file_index;
651};
652
653struct chmod_mode_struct;
654
655#include "byteorder.h"
656#include "lib/mdfour.h"
657#include "lib/wildmatch.h"
658#include "lib/permstring.h"
659#include "lib/addrinfo.h"
660
661#if !defined __GNUC__ || defined __APPLE__
662/* Apparently the OS X port of gcc gags on __attribute__.
663 *
664 * <http://www.opensource.apple.com/bugs/X/gcc/2512150.html> */
665#define __attribute__(x)
666#endif
667
668#define UNUSED(x) x __attribute__((__unused__))
669
670#include "proto.h"
671
672/* We have replacement versions of these if they're missing. */
673#ifndef HAVE_ASPRINTF
674int asprintf(char **ptr, const char *format, ...);
675#endif
676
677#ifndef HAVE_VASPRINTF
678int vasprintf(char **ptr, const char *format, va_list ap);
679#endif
680
681#if !defined HAVE_VSNPRINTF || !defined HAVE_C99_VSNPRINTF
682#define vsnprintf rsync_vsnprintf
683int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
684#endif
685
686#if !defined HAVE_SNPRINTF || !defined HAVE_C99_VSNPRINTF
687#define snprintf rsync_snprintf
688int snprintf(char *str,size_t count,const char *fmt,...);
689#endif
690
691
692#ifndef HAVE_STRERROR
693extern char *sys_errlist[];
694#define strerror(i) sys_errlist[i]
695#endif
696
697#ifndef HAVE_STRCHR
698# define strchr index
699# define strrchr rindex
700#endif
701
702#ifndef HAVE_ERRNO_DECL
703extern int errno;
704#endif
705
706#ifdef HAVE_READLINK
707#define SUPPORT_LINKS 1
708#endif
709#ifdef HAVE_LINK
710#define SUPPORT_HARD_LINKS 1
711#endif
712
713#ifdef HAVE_SIGACTION
714#define SIGACTION(n,h) sigact.sa_handler=(h), sigaction((n),&sigact,NULL)
715#define signal(n,h) we_need_to_call_SIGACTION_not_signal(n,h)
716#else
717#define SIGACTION(n,h) signal(n,h)
718#endif
719
720#ifndef EWOULDBLOCK
721#define EWOULDBLOCK EAGAIN
722#endif
723
724#ifndef STDIN_FILENO
725#define STDIN_FILENO 0
726#endif
727
728#ifndef STDOUT_FILENO
729#define STDOUT_FILENO 1
730#endif
731
732#ifndef STDERR_FILENO
733#define STDERR_FILENO 2
734#endif
735
736#ifndef S_IRUSR
737#define S_IRUSR 0400
738#endif
739
740#ifndef S_IWUSR
741#define S_IWUSR 0200
742#endif
743
744#ifndef ACCESSPERMS
745#define ACCESSPERMS 0777
746#endif
747
748#ifndef S_ISVTX
749#define S_ISVTX 0
750#endif
751
752#define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
753
754#ifndef _S_IFMT
755#define _S_IFMT 0170000
756#endif
757
758#ifndef _S_IFLNK
759#define _S_IFLNK 0120000
760#endif
761
762#ifndef S_ISLNK
763#define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
764#endif
765
766#ifndef S_ISBLK
767#define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
768#endif
769
770#ifndef S_ISCHR
771#define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
772#endif
773
774#ifndef S_ISSOCK
775#ifdef _S_IFSOCK
776#define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
777#else
778#define S_ISSOCK(mode) (0)
779#endif
780#endif
781
782#ifndef S_ISFIFO
783#ifdef _S_IFIFO
784#define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
785#else
786#define S_ISFIFO(mode) (0)
787#endif
788#endif
789
790#ifndef S_ISDIR
791#define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
792#endif
793
794#ifndef S_ISREG
795#define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
796#endif
797
798/* work out what fcntl flag to use for non-blocking */
799#ifdef O_NONBLOCK
800# define NONBLOCK_FLAG O_NONBLOCK
801#elif defined SYSV
802# define NONBLOCK_FLAG O_NDELAY
803#else
804# define NONBLOCK_FLAG FNDELAY
805#endif
806
807#ifndef INADDR_LOOPBACK
808#define INADDR_LOOPBACK 0x7f000001
809#endif
810
811#ifndef INADDR_NONE
812#define INADDR_NONE 0xffffffff
813#endif
814
815#define IS_SPECIAL(mode) (S_ISSOCK(mode) || S_ISFIFO(mode))
816#define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode))
817
818/* Initial mask on permissions given to temporary files. Mask off setuid
819 bits and group access because of potential race-condition security
820 holes, and mask other access because mode 707 is bizarre */
821#define INITACCESSPERMS 0700
822
823/* handler for null strings in printf format */
824#define NS(s) ((s)?(s):"<NULL>")
825
826/* Convenient wrappers for malloc and realloc. Use them. */
827#define new(type) ((type *)malloc(sizeof(type)))
828#define new_array(type, num) ((type *)_new_array(sizeof(type), (num)))
829#define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num)))
830
831/* use magic gcc attributes to catch format errors */
832 void rprintf(enum logcode , const char *, ...)
833 __attribute__((format (printf, 2, 3)))
834;
835
836/* This is just like rprintf, but it also tries to print some
837 * representation of the error code. Normally errcode = errno. */
838void rsyserr(enum logcode, int, const char *, ...)
839 __attribute__((format (printf, 3, 4)))
840 ;
841
842/* Make sure that the O_BINARY flag is defined. */
843#ifndef O_BINARY
844#define O_BINARY 0
845#endif
846
847#ifndef HAVE_STRLCPY
848size_t strlcpy(char *d, const char *s, size_t bufsize);
849#endif
850
851#ifndef HAVE_STRLCAT
852size_t strlcat(char *d, const char *s, size_t bufsize);
853#endif
854
855#ifndef WEXITSTATUS
856#define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
857#endif
858
859#define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
860
861#ifdef HAVE_GETEUID
862#define MY_UID() geteuid()
863#else
864#define MY_UID() getuid()
865#endif
866
867#ifdef HAVE_GETEGID
868#define MY_GID() getegid()
869#else
870#define MY_GID() getgid()
871#endif
872
873extern int verbose;
874
875#ifndef HAVE_INET_NTOP
876const char *inet_ntop(int af, const void *src, char *dst, size_t size);
877#endif
878
879#ifndef HAVE_INET_PTON
880int inet_pton(int af, const char *src, void *dst);
881#endif
882
883#ifdef MAINTAINER_MODE
884const char *get_panic_action(void);
885#endif