1 /* $OpenBSD: extern.h,v 1.45 2023/04/28 10:24:38 claudio Exp $ */ 2 /* 3 * Copyright (c) 2019 Kristaps Dzonsons <kristaps@bsd.lv> 4 * 5 * Permission to use, copy, modify, and distribute this software for any 6 * purpose with or without fee is hereby granted, provided that the above 7 * copyright notice and this permission notice appear in all copies. 8 * 9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16 */ 17 #ifndef EXTERN_H 18 #define EXTERN_H 19 20 /* 21 * This is the rsync protocol version that we support. 22 */ 23 #define RSYNC_PROTOCOL (27) 24 25 /* 26 * Maximum amount of file data sent over the wire at once. 27 */ 28 #define MAX_CHUNK (32 * 1024) 29 30 /* 31 * This is the minimum size for a block of data not including those in 32 * the remainder block. 33 */ 34 #define BLOCK_SIZE_MIN (700) 35 36 /* 37 * Maximum number of base directories that can be used. 38 */ 39 #define MAX_BASEDIR 20 40 41 #define BASE_MODE_COMPARE 1 42 #define BASE_MODE_COPY 2 43 #define BASE_MODE_LINK 3 44 45 /* 46 * The sender and receiver use a two-phase synchronisation process. 47 * The first uses two-byte hashes; the second, 16-byte. 48 * (The second must hold a full MD4 digest.) 49 */ 50 #define CSUM_LENGTH_PHASE1 (2) 51 #define CSUM_LENGTH_PHASE2 (16) 52 53 /* 54 * Rsync error codes. 55 */ 56 #define ERR_SYNTAX 1 57 #define ERR_PROTOCOL 2 58 #define ERR_SOCK_IO 10 59 #define ERR_FILE_IO 11 60 #define ERR_WIREPROTO 12 61 #define ERR_IPC 14 /* catchall for any kind of syscall error */ 62 #define ERR_TERMIMATED 16 63 #define ERR_WAITPID 21 64 #define ERR_NOMEM 22 65 66 /* 67 * Use this for --timeout. 68 * All poll events will use it and catch time-outs. 69 */ 70 extern int poll_timeout; 71 72 /* 73 * Use this for --contimeout. 74 */ 75 extern int poll_contimeout; 76 77 /* 78 * Operating mode for a client or a server. 79 * Sender means we synchronise local files with those from remote. 80 * Receiver is the opposite. 81 * This is relative to which host we're running on. 82 */ 83 enum fmode { 84 FARGS_SENDER, 85 FARGS_RECEIVER 86 }; 87 88 /* 89 * File arguments given on the command line. 90 * See struct opts. 91 */ 92 struct fargs { 93 char *host; /* hostname or NULL if local */ 94 char **sources; /* transfer source */ 95 size_t sourcesz; /* number of sources */ 96 char *sink; /* transfer endpoint */ 97 enum fmode mode; /* mode of operation */ 98 int remote; /* uses rsync:// or :: for remote */ 99 char *module; /* if rsync://, the module */ 100 }; 101 102 /* 103 * The subset of stat(2) information that we need. 104 * (There are some parts we don't use yet.) 105 */ 106 struct flstat { 107 mode_t mode; /* mode */ 108 uid_t uid; /* user */ 109 gid_t gid; /* group */ 110 dev_t rdev; /* device type */ 111 off_t size; /* size */ 112 time_t mtime; /* modification */ 113 unsigned int flags; 114 #define FLSTAT_TOP_DIR 0x01 /* a top-level directory */ 115 116 }; 117 118 /* 119 * A list of files with their statistics. 120 */ 121 struct flist { 122 char *path; /* path relative to root */ 123 const char *wpath; /* "working" path for receiver */ 124 struct flstat st; /* file information */ 125 char *link; /* symlink target or NULL */ 126 }; 127 128 /* 129 * Options passed into the command line. 130 * See struct fargs. 131 */ 132 struct opts { 133 int sender; /* --sender */ 134 int server; /* --server */ 135 int recursive; /* -r */ 136 int dry_run; /* -n */ 137 int preserve_times; /* -t */ 138 int preserve_perms; /* -p */ 139 int preserve_links; /* -l */ 140 int preserve_gids; /* -g */ 141 int preserve_uids; /* -u */ 142 int del; /* --delete */ 143 int devices; /* --devices */ 144 int specials; /* --specials */ 145 int no_motd; /* --no-motd */ 146 int numeric_ids; /* --numeric-ids */ 147 int one_file_system; /* -x */ 148 int ignore_times; /* -I */ 149 int size_only; /* --size-only */ 150 int alt_base_mode; 151 off_t max_size; /* --max-size */ 152 off_t min_size; /* --min-size */ 153 char *rsync_path; /* --rsync-path */ 154 char *ssh_prog; /* --rsh or -e */ 155 char *port; /* --port */ 156 char *address; /* --address */ 157 char *basedir[MAX_BASEDIR]; 158 }; 159 160 enum rule_type { 161 RULE_NONE, 162 RULE_EXCLUDE, 163 RULE_INCLUDE, 164 RULE_CLEAR, 165 #ifdef NOTYET 166 RULE_MERGE, 167 RULE_DIR_MERGE, 168 RULE_SHOW, 169 RULE_HIDE, 170 RULE_PROTECT, 171 RULE_RISK, 172 #endif 173 }; 174 175 /* 176 * An individual block description for a file. 177 * See struct blkset. 178 */ 179 struct blk { 180 off_t offs; /* offset in file */ 181 size_t idx; /* block index */ 182 size_t len; /* bytes in block */ 183 uint32_t chksum_short; /* fast checksum */ 184 unsigned char chksum_long[CSUM_LENGTH_PHASE2]; /* slow checksum */ 185 }; 186 187 enum blkstatst { 188 BLKSTAT_NONE = 0, 189 BLKSTAT_NEXT, 190 BLKSTAT_DATA, 191 BLKSTAT_TOK, 192 BLKSTAT_HASH, 193 BLKSTAT_DONE, 194 BLKSTAT_PHASE, 195 }; 196 197 /* 198 * Information for the sender updating receiver blocks reentrantly. 199 */ 200 struct blkstat { 201 off_t offs; /* position in sender file */ 202 off_t total; /* total amount processed */ 203 off_t dirty; /* total amount sent */ 204 size_t hint; /* optimisation: next probable match */ 205 void *map; /* mapped file or MAP_FAILED otherwise */ 206 size_t mapsz; /* size of file or zero */ 207 int fd; /* descriptor girding the map */ 208 enum blkstatst curst; /* FSM for sending file blocks */ 209 off_t curpos; /* sending: position in file to send */ 210 off_t curlen; /* sending: length of send */ 211 int32_t curtok; /* sending: next matching token or zero */ 212 struct blktab *blktab; /* hashtable of blocks */ 213 uint32_t s1; /* partial sum for computing fast hash */ 214 uint32_t s2; /* partial sum for computing fast hash */ 215 }; 216 217 /* 218 * When transferring file contents, we break the file down into blocks 219 * and work with those. 220 */ 221 struct blkset { 222 off_t size; /* file size */ 223 size_t rem; /* terminal block length if non-zero */ 224 size_t len; /* block length */ 225 size_t csum; /* checksum length */ 226 struct blk *blks; /* all blocks */ 227 size_t blksz; /* number of blks */ 228 }; 229 230 /* 231 * Values required during a communication session. 232 */ 233 struct sess { 234 const struct opts *opts; /* system options */ 235 int32_t seed; /* checksum seed */ 236 int32_t lver; /* local version */ 237 int32_t rver; /* remote version */ 238 uint64_t total_read; /* non-logging wire/reads */ 239 uint64_t total_size; /* total file size */ 240 uint64_t total_write; /* non-logging wire/writes */ 241 int mplex_reads; /* multiplexing reads? */ 242 size_t mplex_read_remain; /* remaining bytes */ 243 int mplex_writes; /* multiplexing writes? */ 244 }; 245 246 /* 247 * Combination of name and numeric id for groups and users. 248 */ 249 struct ident { 250 int32_t id; /* the gid_t or uid_t */ 251 int32_t mapped; /* if receiving, the mapped gid */ 252 char *name; /* resolved name */ 253 }; 254 255 typedef struct arglist arglist; 256 struct arglist { 257 char **list; 258 u_int num; 259 u_int nalloc; 260 }; 261 void addargs(arglist *, const char *, ...) 262 __attribute__((format(printf, 2, 3))); 263 void freeargs(arglist *); 264 265 struct download; 266 struct upload; 267 268 extern int verbose; 269 270 #define MINIMUM(a, b) (((a) < (b)) ? (a) : (b)) 271 272 #define LOG0(_fmt, ...) \ 273 rsync_log( -1, (_fmt), ##__VA_ARGS__) 274 #define LOG1(_fmt, ...) \ 275 rsync_log( 0, (_fmt), ##__VA_ARGS__) 276 #define LOG2(_fmt, ...) \ 277 rsync_log( 1, (_fmt), ##__VA_ARGS__) 278 #define LOG3(_fmt, ...) \ 279 rsync_log( 2, (_fmt), ##__VA_ARGS__) 280 #define LOG4(_fmt, ...) \ 281 rsync_log( 3, (_fmt), ##__VA_ARGS__) 282 #define ERRX1(_fmt, ...) \ 283 rsync_errx1( (_fmt), ##__VA_ARGS__) 284 #define WARNX(_fmt, ...) \ 285 rsync_warnx( (_fmt), ##__VA_ARGS__) 286 #define WARN(_fmt, ...) \ 287 rsync_warn(0, (_fmt), ##__VA_ARGS__) 288 #define WARN1(_fmt, ...) \ 289 rsync_warn(1, (_fmt), ##__VA_ARGS__) 290 #define WARN2(_fmt, ...) \ 291 rsync_warn(2, (_fmt), ##__VA_ARGS__) 292 #define ERR(_fmt, ...) \ 293 rsync_err( (_fmt), ##__VA_ARGS__) 294 #define ERRX(_fmt, ...) \ 295 rsync_errx( (_fmt), ##__VA_ARGS__) 296 297 void rsync_log(int, const char *, ...) 298 __attribute__((format(printf, 2, 3))); 299 void rsync_warnx1(const char *, ...) 300 __attribute__((format(printf, 1, 2))); 301 void rsync_warn(int, const char *, ...) 302 __attribute__((format(printf, 2, 3))); 303 void rsync_warnx(const char *, ...) 304 __attribute__((format(printf, 1, 2))); 305 void rsync_err(const char *, ...) 306 __attribute__((format(printf, 1, 2))); 307 void rsync_errx(const char *, ...) 308 __attribute__((format(printf, 1, 2))); 309 void rsync_errx1(const char *, ...) 310 __attribute__((format(printf, 1, 2))); 311 312 int flist_del(struct sess *, int, const struct flist *, size_t); 313 int flist_gen(struct sess *, size_t, char **, struct flist **, size_t *); 314 int flist_gen_local(struct sess *, const char *, struct flist **, size_t *); 315 void flist_free(struct flist *, size_t); 316 int flist_recv(struct sess *, int, struct flist **, size_t *); 317 int flist_send(struct sess *, int, int, const struct flist *, size_t); 318 int flist_gen_dels(struct sess *, const char *, struct flist **, size_t *, 319 const struct flist *, size_t); 320 321 const char *alt_base_mode(int); 322 char **fargs_cmdline(struct sess *, const struct fargs *, size_t *); 323 324 int io_read_buf(struct sess *, int, void *, size_t); 325 int io_read_byte(struct sess *, int, uint8_t *); 326 int io_read_check(int); 327 int io_read_flush(struct sess *, int); 328 int io_read_int(struct sess *, int, int32_t *); 329 int io_read_uint(struct sess *, int, uint32_t *); 330 int io_read_long(struct sess *, int, int64_t *); 331 int io_read_size(struct sess *, int, size_t *); 332 int io_read_ulong(struct sess *, int, uint64_t *); 333 int io_write_buf(struct sess *, int, const void *, size_t); 334 int io_write_byte(struct sess *, int, uint8_t); 335 int io_write_int(struct sess *, int, int32_t); 336 int io_write_uint(struct sess *, int, uint32_t); 337 int io_write_line(struct sess *, int, const char *); 338 int io_write_long(struct sess *, int, int64_t); 339 int io_write_ulong(struct sess *, int, uint64_t); 340 341 int io_lowbuffer_alloc(struct sess *, void **, size_t *, size_t *, size_t); 342 void io_lowbuffer_int(struct sess *, void *, size_t *, size_t, int32_t); 343 void io_lowbuffer_buf(struct sess *, void *, size_t *, size_t, const void *, 344 size_t); 345 346 void io_buffer_int(void *, size_t *, size_t, int32_t); 347 void io_buffer_buf(void *, size_t *, size_t, const void *, size_t); 348 349 void io_unbuffer_int(const void *, size_t *, size_t, int32_t *); 350 int io_unbuffer_size(const void *, size_t *, size_t, size_t *); 351 void io_unbuffer_buf(const void *, size_t *, size_t, void *, size_t); 352 353 int rsync_receiver(struct sess *, int, int, const char *); 354 int rsync_sender(struct sess *, int, int, size_t, char **); 355 int rsync_client(const struct opts *, int, const struct fargs *); 356 int rsync_connect(const struct opts *, int *, const struct fargs *); 357 int rsync_socket(const struct opts *, int, const struct fargs *); 358 int rsync_server(const struct opts *, size_t, char *[]); 359 int rsync_downloader(struct download *, struct sess *, int *); 360 int rsync_set_metadata(struct sess *, int, int, const struct flist *, 361 const char *); 362 int rsync_set_metadata_at(struct sess *, int, int, const struct flist *, 363 const char *); 364 int rsync_uploader(struct upload *, int *, struct sess *, int *); 365 int rsync_uploader_tail(struct upload *, struct sess *); 366 367 struct download *download_alloc(struct sess *, int, const struct flist *, 368 size_t, int); 369 void download_free(struct download *); 370 struct upload *upload_alloc(const char *, int, int, size_t, 371 const struct flist *, size_t, mode_t); 372 void upload_free(struct upload *); 373 374 struct blktab *blkhash_alloc(void); 375 int blkhash_set(struct blktab *, const struct blkset *); 376 void blkhash_free(struct blktab *); 377 378 struct blkset *blk_recv(struct sess *, int, const char *); 379 void blk_recv_ack(char [20], const struct blkset *, int32_t); 380 void blk_match(struct sess *, const struct blkset *, 381 const char *, struct blkstat *); 382 int blk_send(struct sess *, int, size_t, const struct blkset *, 383 const char *); 384 int blk_send_ack(struct sess *, int, struct blkset *); 385 386 uint32_t hash_fast(const void *, size_t); 387 void hash_slow(const void *, size_t, unsigned char *, 388 const struct sess *); 389 void hash_file(const void *, size_t, unsigned char *, 390 const struct sess *); 391 392 void copy_file(int, const char *, const struct flist *); 393 394 int mkpath(char *); 395 396 int mkstempat(int, char *); 397 char *mkstemplinkat(char*, int, char *); 398 char *mkstempfifoat(int, char *); 399 char *mkstempnodat(int, char *, mode_t, dev_t); 400 char *mkstempsock(const char *, char *); 401 int mktemplate(char **, const char *, int); 402 403 int parse_rule(char *line, enum rule_type); 404 void parse_file(const char *, enum rule_type); 405 void send_rules(struct sess *, int); 406 void recv_rules(struct sess *, int); 407 int rules_match(const char *, int); 408 409 int rmatch(const char *, const char *, int); 410 411 char *symlink_read(const char *); 412 char *symlinkat_read(int, const char *); 413 414 int sess_stats_send(struct sess *, int); 415 int sess_stats_recv(struct sess *, int); 416 417 int idents_add(int, struct ident **, size_t *, int32_t); 418 void idents_assign_gid(struct sess *, struct flist *, size_t, 419 const struct ident *, size_t); 420 void idents_assign_uid(struct sess *, struct flist *, size_t, 421 const struct ident *, size_t); 422 void idents_free(struct ident *, size_t); 423 int idents_recv(struct sess *, int, struct ident **, size_t *); 424 void idents_remap(struct sess *, int, struct ident *, size_t); 425 int idents_send(struct sess *, int, const struct ident *, size_t); 426 427 #endif /*!EXTERN_H*/ 428