Fixed skipping of unneeded updates in a batch file when
[rsync/rsync.git] / io.c
CommitLineData
0f78b815
WD
1/*
2 * Socket and pipe I/O utilities used in rsync.
d62bcc17 3 *
0f78b815
WD
4 * Copyright (C) 1996-2001 Andrew Tridgell
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
d3d07a5e 7 * Copyright (C) 2003-2008 Wayne Davison
d62bcc17 8 *
880da007 9 * This program is free software; you can redistribute it and/or modify
8e41b68e
WD
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
d62bcc17 13 *
880da007
MP
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
d62bcc17 18 *
e7c67065 19 * You should have received a copy of the GNU General Public License along
4fd842f9 20 * with this program; if not, visit the http://fsf.org website.
880da007 21 */
720b47f2 22
0f78b815
WD
23/* Rsync provides its own multiplexing system, which is used to send
24 * stderr and stdout over a single socket.
87ee2481
MP
25 *
26 * For historical reasons this is off during the start of the
27 * connection, but it's switched on quite early using
0f78b815 28 * io_start_multiplex_out() and io_start_multiplex_in(). */
720b47f2 29
720b47f2 30#include "rsync.h"
1b42f628 31#include "ifuncs.h"
5dd14f0c 32#include "inums.h"
720b47f2 33
880da007 34/** If no timeout is specified then use a 60 second select timeout */
8cd9fd4e
AT
35#define SELECT_TIMEOUT 60
36
7a55d06e 37extern int bwlimit;
71e58630 38extern size_t bwlimit_writemax;
6ba9279f 39extern int io_timeout;
d17e1dd2
WD
40extern int am_server;
41extern int am_daemon;
42extern int am_sender;
98f8c9a5 43extern int am_generator;
3ea6e0e7 44extern int inc_recurse;
8ef246e0 45extern int io_error;
e626b29e 46extern int eol_nulls;
8ef246e0 47extern int flist_eof;
7f9bf6b7 48extern int list_only;
3b0a30eb 49extern int read_batch;
ba525f77 50extern int protect_args;
b9f592fb
WD
51extern int checksum_seed;
52extern int protocol_version;
47c11975 53extern int remove_source_files;
cdf236aa 54extern int preserve_hard_links;
a800434a 55extern struct stats stats;
19531e1f 56extern struct file_list *cur_flist;
332cf6df 57#ifdef ICONV_OPTION
ba525f77 58extern int filesfrom_convert;
332cf6df
WD
59extern iconv_t ic_send, ic_recv;
60#endif
720b47f2 61
93465f51
WD
62int csum_length = SHORT_SUM_LENGTH; /* initial value */
63int allowed_lull = 0;
9e2409ab 64int ignore_timeout = 0;
b9f592fb 65int batch_fd = -1;
04c722d5 66int msgdone_cnt = 0;
805edf9d 67
cb2e1f18 68/* Ignore an EOF error if non-zero. See whine_about_eof(). */
574c2500 69int kluge_around_eof = 0;
7a55d06e 70
d17e1dd2
WD
71int msg_fd_in = -1;
72int msg_fd_out = -1;
cdf236aa
WD
73int sock_f_in = -1;
74int sock_f_out = -1;
7a55d06e 75
8ef246e0
WD
76static int iobuf_f_in = -1;
77static char *iobuf_in;
78static size_t iobuf_in_siz;
79static size_t iobuf_in_ndx;
80static size_t iobuf_in_remaining;
81
82static int iobuf_f_out = -1;
83static char *iobuf_out;
84static int iobuf_out_cnt;
85
86int flist_forward_from = -1;
87
1f75bb10
WD
88static int io_multiplexing_out;
89static int io_multiplexing_in;
3b0a30eb
WD
90static time_t last_io_in;
91static time_t last_io_out;
1f75bb10
WD
92static int no_flush;
93
b9f592fb
WD
94static int write_batch_monitor_in = -1;
95static int write_batch_monitor_out = -1;
96
56014c8c
WD
97static int io_filesfrom_f_in = -1;
98static int io_filesfrom_f_out = -1;
ba525f77
WD
99static xbuf ff_buf = EMPTY_XBUF;
100static char ff_lastchar;
332cf6df 101#ifdef ICONV_OPTION
ba525f77 102static xbuf iconv_buf = EMPTY_XBUF;
332cf6df 103#endif
0b789446 104static int defer_forwarding_messages = 0, keep_defer_forwarding = 0;
3b0a30eb 105static int select_timeout = SELECT_TIMEOUT;
d6081c82
WD
106static int active_filecnt = 0;
107static OFF_T active_bytecnt = 0;
7f9bf6b7 108static int first_message = 1;
720b47f2 109
351e23ad
WD
110static char int_byte_extra[64] = {
111 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (00 - 3F)/4 */
112 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* (40 - 7F)/4 */
113 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* (80 - BF)/4 */
114 2, 2, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4, 5, 6, /* (C0 - FF)/4 */
482f48cc
WD
115};
116
7f9bf6b7
WD
117#define REMOTE_OPTION_ERROR "rsync: on remote machine: -"
118#define REMOTE_OPTION_ERROR2 ": unknown option"
119
29349024
WD
120enum festatus { FES_SUCCESS, FES_REDO, FES_NO_SEND };
121
dde5b772 122static void readfd(int fd, char *buffer, size_t N);
8ef246e0
WD
123static void writefd(int fd, const char *buf, size_t len);
124static void writefd_unbuffered(int fd, const char *buf, size_t len);
332cf6df 125static void mplex_write(int fd, enum msgcode code, const char *buf, size_t len, int convert);
ff41a59f 126
c6816b94
WD
127struct flist_ndx_item {
128 struct flist_ndx_item *next;
129 int ndx;
d17e1dd2
WD
130};
131
c6816b94
WD
132struct flist_ndx_list {
133 struct flist_ndx_item *head, *tail;
134};
135
cdf236aa 136static struct flist_ndx_list redo_list, hlink_list;
d17e1dd2 137
08c88178
WD
138struct msg_list_item {
139 struct msg_list_item *next;
332cf6df 140 char convert;
954bbed8 141 char buf[1];
d17e1dd2
WD
142};
143
08c88178
WD
144struct msg_list {
145 struct msg_list_item *head, *tail;
146};
147
e4c877cf 148static struct msg_list msg_queue;
d17e1dd2 149
c6816b94 150static void flist_ndx_push(struct flist_ndx_list *lp, int ndx)
d17e1dd2 151{
c6816b94
WD
152 struct flist_ndx_item *item;
153
154 if (!(item = new(struct flist_ndx_item)))
155 out_of_memory("flist_ndx_push");
156 item->next = NULL;
157 item->ndx = ndx;
158 if (lp->tail)
159 lp->tail->next = item;
d17e1dd2 160 else
c6816b94
WD
161 lp->head = item;
162 lp->tail = item;
163}
164
165static int flist_ndx_pop(struct flist_ndx_list *lp)
166{
167 struct flist_ndx_item *next;
168 int ndx;
169
170 if (!lp->head)
171 return -1;
172
173 ndx = lp->head->ndx;
174 next = lp->head->next;
175 free(lp->head);
176 lp->head = next;
177 if (!next)
178 lp->tail = NULL;
179
180 return ndx;
d17e1dd2
WD
181}
182
29349024
WD
183static void got_flist_entry_status(enum festatus status, const char *buf)
184{
185 int ndx = IVAL(buf, 0);
e982d591 186 struct file_list *flist = flist_for_ndx(ndx, "got_flist_entry_status");
29349024
WD
187
188 if (remove_source_files) {
189 active_filecnt--;
190 active_bytecnt -= F_LENGTH(flist->files[ndx - flist->ndx_start]);
191 }
192
193 if (inc_recurse)
194 flist->in_progress--;
195
196 switch (status) {
197 case FES_SUCCESS:
198 if (remove_source_files)
199 send_msg(MSG_SUCCESS, buf, 4, 0);
200 if (preserve_hard_links) {
201 struct file_struct *file = flist->files[ndx - flist->ndx_start];
37ce1679 202 if (F_IS_HLINKED(file)) {
29349024 203 flist_ndx_push(&hlink_list, ndx);
37ce1679
WD
204 flist->in_progress++;
205 }
29349024
WD
206 }
207 break;
208 case FES_REDO:
209 if (inc_recurse)
210 flist->to_redo++;
211 flist_ndx_push(&redo_list, ndx);
212 break;
213 case FES_NO_SEND:
214 break;
215 }
216}
217
8d9dc9f9
AT
218static void check_timeout(void)
219{
220 time_t t;
90ba34e2 221
9e2409ab 222 if (!io_timeout || ignore_timeout)
d17e1dd2 223 return;
8d9dc9f9 224
3b0a30eb
WD
225 if (!last_io_in) {
226 last_io_in = time(NULL);
8d9dc9f9
AT
227 return;
228 }
229
230 t = time(NULL);
231
3b0a30eb 232 if (t - last_io_in >= io_timeout) {
0adb99b9 233 if (!am_server && !am_daemon) {
4ccfd96c 234 rprintf(FERROR, "io timeout after %d seconds -- exiting\n",
3b0a30eb 235 (int)(t-last_io_in));
0adb99b9 236 }
65417579 237 exit_cleanup(RERR_TIMEOUT);
8d9dc9f9
AT
238 }
239}
240
1f75bb10
WD
241/* Note the fds used for the main socket (which might really be a pipe
242 * for a local transfer, but we can ignore that). */
243void io_set_sock_fds(int f_in, int f_out)
244{
245 sock_f_in = f_in;
246 sock_f_out = f_out;
247}
248
3b0a30eb
WD
249void set_io_timeout(int secs)
250{
251 io_timeout = secs;
252
253 if (!io_timeout || io_timeout > SELECT_TIMEOUT)
254 select_timeout = SELECT_TIMEOUT;
255 else
256 select_timeout = io_timeout;
257
258 allowed_lull = read_batch ? 0 : (io_timeout + 1) / 2;
259}
260
98f8c9a5
WD
261/* Setup the fd used to receive MSG_* messages. Only needed during the
262 * early stages of being a local sender (up through the sending of the
263 * file list) or when we're the generator (to fetch the messages from
264 * the receiver). */
d17e1dd2
WD
265void set_msg_fd_in(int fd)
266{
267 msg_fd_in = fd;
268}
269
98f8c9a5
WD
270/* Setup the fd used to send our MSG_* messages. Only needed when
271 * we're the receiver (to send our messages to the generator). */
d17e1dd2
WD
272void set_msg_fd_out(int fd)
273{
274 msg_fd_out = fd;
275 set_nonblocking(msg_fd_out);
276}
277
278/* Add a message to the pending MSG_* list. */
332cf6df 279static void msg_list_add(struct msg_list *lst, int code, const char *buf, int len, int convert)
554e0a8d 280{
954bbed8
WD
281 struct msg_list_item *m;
282 int sz = len + 4 + sizeof m[0] - 1;
d17e1dd2 283
954bbed8 284 if (!(m = (struct msg_list_item *)new_array(char, sz)))
c6816b94 285 out_of_memory("msg_list_add");
954bbed8 286 m->next = NULL;
332cf6df 287 m->convert = convert;
954bbed8
WD
288 SIVAL(m->buf, 0, ((code+MPLEX_BASE)<<24) | len);
289 memcpy(m->buf + 4, buf, len);
290 if (lst->tail)
291 lst->tail->next = m;
d17e1dd2 292 else
954bbed8
WD
293 lst->head = m;
294 lst->tail = m;
554e0a8d
AT
295}
296
0b789446
WD
297static inline int flush_a_msg(int fd)
298{
299 struct msg_list_item *m = msg_queue.head;
300 int len = IVAL(m->buf, 0) & 0xFFFFFF;
301 int tag = *((uchar*)m->buf+3) - MPLEX_BASE;
302
303 if (!(msg_queue.head = m->next))
304 msg_queue.tail = NULL;
305
306 defer_forwarding_messages++;
307 mplex_write(fd, tag, m->buf + 4, len, m->convert);
308 defer_forwarding_messages--;
309
310 free(m);
311
312 return len;
313}
314
e4c877cf 315static void msg_flush(void)
3be97bf9 316{
e4c877cf 317 if (am_generator) {
0b789446
WD
318 while (msg_queue.head && io_multiplexing_out)
319 stats.total_written += flush_a_msg(sock_f_out) + 4;
e4c877cf 320 } else {
0b789446
WD
321 while (msg_queue.head)
322 (void)flush_a_msg(msg_fd_out);
3be97bf9
WD
323 }
324}
325
7f9bf6b7
WD
326static void check_for_d_option_error(const char *msg)
327{
328 static char rsync263_opts[] = "BCDHIKLPRSTWabceghlnopqrtuvxz";
329 char *colon;
330 int saw_d = 0;
331
332 if (*msg != 'r'
333 || strncmp(msg, REMOTE_OPTION_ERROR, sizeof REMOTE_OPTION_ERROR - 1) != 0)
334 return;
335
336 msg += sizeof REMOTE_OPTION_ERROR - 1;
337 if (*msg == '-' || (colon = strchr(msg, ':')) == NULL
338 || strncmp(colon, REMOTE_OPTION_ERROR2, sizeof REMOTE_OPTION_ERROR2 - 1) != 0)
339 return;
340
341 for ( ; *msg != ':'; msg++) {
342 if (*msg == 'd')
343 saw_d = 1;
344 else if (*msg == 'e')
345 break;
346 else if (strchr(rsync263_opts, *msg) == NULL)
347 return;
348 }
349
350 if (saw_d) {
351 rprintf(FWARNING,
73cb6738 352 "*** Try using \"--old-d\" if remote rsync is <= 2.6.3 ***\n");
7f9bf6b7
WD
353 }
354}
355
98f8c9a5
WD
356/* Read a message from the MSG_* fd and handle it. This is called either
357 * during the early stages of being a local sender (up through the sending
358 * of the file list) or when we're the generator (to fetch the messages
359 * from the receiver). */
d17e1dd2 360static void read_msg_fd(void)
554e0a8d 361{
f9c6b3e7 362 char buf[2048];
06ce139f 363 size_t n;
8ef246e0 364 struct file_list *flist;
d17e1dd2 365 int fd = msg_fd_in;
ff41a59f
AT
366 int tag, len;
367
00bdf899 368 /* Temporarily disable msg_fd_in. This is needed to avoid looping back
af436313 369 * to this routine from writefd_unbuffered(). */
3be97bf9 370 no_flush++;
d17e1dd2 371 msg_fd_in = -1;
be21e29c 372 defer_forwarding_messages++;
554e0a8d 373
dde5b772 374 readfd(fd, buf, 4);
ff41a59f
AT
375 tag = IVAL(buf, 0);
376
377 len = tag & 0xFFFFFF;
d17e1dd2 378 tag = (tag >> 24) - MPLEX_BASE;
ff41a59f 379
d17e1dd2
WD
380 switch (tag) {
381 case MSG_DONE:
cc7b86bf 382 if (len < 0 || len > 1 || !am_generator) {
8ef246e0
WD
383 invalid_msg:
384 rprintf(FERROR, "invalid message %d:%d [%s%s]\n",
385 tag, len, who_am_i(),
3ea6e0e7 386 inc_recurse ? "/inc" : "");
d17e1dd2 387 exit_cleanup(RERR_STREAMIO);
13c7bcbb 388 }
cc7b86bf
WD
389 if (len) {
390 readfd(fd, buf, len);
351e23ad 391 stats.total_read = read_varlong(fd, 3);
cc7b86bf 392 }
04c722d5 393 msgdone_cnt++;
d17e1dd2
WD
394 break;
395 case MSG_REDO:
8ef246e0
WD
396 if (len != 4 || !am_generator)
397 goto invalid_msg;
dde5b772 398 readfd(fd, buf, 4);
29349024 399 got_flist_entry_status(FES_REDO, buf);
8ef246e0
WD
400 break;
401 case MSG_FLIST:
3ea6e0e7 402 if (len != 4 || !am_generator || !inc_recurse)
8ef246e0 403 goto invalid_msg;
dde5b772 404 readfd(fd, buf, 4);
8ef246e0
WD
405 /* Read extra file list from receiver. */
406 assert(iobuf_in != NULL);
407 assert(iobuf_f_in == fd);
951e826b 408 if (DEBUG_GTE(FLIST, 2)) {
1faa1a6d
WD
409 rprintf(FINFO, "[%s] receiving flist for dir %d\n",
410 who_am_i(), IVAL(buf,0));
411 }
8ef246e0
WD
412 flist = recv_file_list(fd);
413 flist->parent_ndx = IVAL(buf,0);
da131912
WD
414#ifdef SUPPORT_HARD_LINKS
415 if (preserve_hard_links)
416 match_hard_links(flist);
417#endif
8ef246e0
WD
418 break;
419 case MSG_FLIST_EOF:
3ea6e0e7 420 if (len != 0 || !am_generator || !inc_recurse)
8ef246e0
WD
421 goto invalid_msg;
422 flist_eof = 1;
d17e1dd2 423 break;
e5f35681
WD
424 case MSG_IO_ERROR:
425 if (len != 4)
426 goto invalid_msg;
427 readfd(fd, buf, len);
428 io_error |= IVAL(buf, 0);
429 break;
0d67e00a 430 case MSG_DELETED:
8ef246e0
WD
431 if (len >= (int)sizeof buf || !am_generator)
432 goto invalid_msg;
dde5b772 433 readfd(fd, buf, len);
332cf6df 434 send_msg(MSG_DELETED, buf, len, 1);
0d67e00a 435 break;
9981c27e 436 case MSG_SUCCESS:
8ef246e0
WD
437 if (len != 4 || !am_generator)
438 goto invalid_msg;
29349024
WD
439 readfd(fd, buf, 4);
440 got_flist_entry_status(FES_SUCCESS, buf);
8ef246e0
WD
441 break;
442 case MSG_NO_SEND:
443 if (len != 4 || !am_generator)
444 goto invalid_msg;
29349024
WD
445 readfd(fd, buf, 4);
446 got_flist_entry_status(FES_NO_SEND, buf);
9981c27e 447 break;
3f0211b6 448 case MSG_ERROR_SOCKET:
7c7462cd 449 case MSG_ERROR_UTF8:
64119c79 450 case MSG_CLIENT:
8ef246e0
WD
451 if (!am_generator)
452 goto invalid_msg;
3f0211b6 453 if (tag == MSG_ERROR_SOCKET)
8ef246e0 454 io_end_multiplex_out();
72f2d1b3 455 /* FALL THROUGH */
d17e1dd2
WD
456 case MSG_INFO:
457 case MSG_ERROR:
3f0211b6
WD
458 case MSG_ERROR_XFER:
459 case MSG_WARNING:
d17e1dd2
WD
460 case MSG_LOG:
461 while (len) {
462 n = len;
463 if (n >= sizeof buf)
464 n = sizeof buf - 1;
dde5b772 465 readfd(fd, buf, n);
332cf6df 466 rwrite((enum logcode)tag, buf, n, !am_generator);
d17e1dd2
WD
467 len -= n;
468 }
469 break;
470 default:
f8b9da1a
WD
471 rprintf(FERROR, "unknown message %d:%d [%s]\n",
472 tag, len, who_am_i());
d17e1dd2
WD
473 exit_cleanup(RERR_STREAMIO);
474 }
475
3be97bf9 476 no_flush--;
d17e1dd2 477 msg_fd_in = fd;
17a4977b 478 if (!--defer_forwarding_messages && !no_flush)
e4c877cf 479 msg_flush();
d17e1dd2
WD
480}
481
d6081c82 482/* This is used by the generator to limit how many file transfers can
47c11975 483 * be active at once when --remove-source-files is specified. Without
d6081c82
WD
484 * this, sender-side deletions were mostly happening at the end. */
485void increment_active_files(int ndx, int itemizing, enum logcode code)
486{
487 /* TODO: tune these limits? */
5b986297 488 while (active_filecnt >= (active_bytecnt >= 128*1024 ? 10 : 50)) {
04c722d5
WD
489 check_for_finished_files(itemizing, code, 0);
490 if (iobuf_out_cnt)
491 io_flush(NORMAL_FLUSH);
492 else
493 read_msg_fd();
d6081c82
WD
494 }
495
496 active_filecnt++;
121bfb2b 497 active_bytecnt += F_LENGTH(cur_flist->files[ndx - cur_flist->ndx_start]);
d6081c82
WD
498}
499
3be97bf9 500/* Write an message to a multiplexed stream. If this fails, rsync exits. */
332cf6df 501static void mplex_write(int fd, enum msgcode code, const char *buf, size_t len, int convert)
d17e1dd2 502{
332cf6df 503 char buffer[BIGPATHBUFLEN]; /* Oversized for use by iconv code. */
3be97bf9 504 size_t n = len;
d17e1dd2 505
332cf6df 506#ifdef ICONV_OPTION
ee6e80c7
WD
507 /* We need to convert buf before doing anything else so that we
508 * can include the (converted) byte length in the message header. */
509 if (convert && ic_send != (iconv_t)-1) {
510 xbuf outbuf, inbuf;
511
512 INIT_XBUF(outbuf, buffer + 4, 0, sizeof buffer - 4);
bb640d32 513 INIT_XBUF(inbuf, (char*)buf, len, (size_t)-1);
332cf6df 514
ee6e80c7
WD
515 iconvbufs(ic_send, &inbuf, &outbuf,
516 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
517 if (inbuf.len > 0) {
518 rprintf(FERROR, "overflowed conversion buffer in mplex_write");
519 exit_cleanup(RERR_UNSUPPORTED);
520 }
521
522 n = len = outbuf.len;
523 } else
524#endif
525 if (n > 1024 - 4) /* BIGPATHBUFLEN can handle 1024 bytes */
526 n = 0; /* We'd rather do 2 writes than too much memcpy(). */
3be97bf9
WD
527 else
528 memcpy(buffer + 4, buf, n);
529
ee6e80c7
WD
530 SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
531
0b789446 532 keep_defer_forwarding++; /* defer_forwarding_messages++ on return */
3be97bf9 533 writefd_unbuffered(fd, buffer, n+4);
0b789446 534 keep_defer_forwarding--;
3be97bf9 535
ee6e80c7
WD
536 if (len > n)
537 writefd_unbuffered(fd, buf+n, len-n);
17a4977b
WD
538
539 if (!--defer_forwarding_messages && !no_flush)
540 msg_flush();
d17e1dd2
WD
541}
542
332cf6df 543int send_msg(enum msgcode code, const char *buf, int len, int convert)
37f35d89
WD
544{
545 if (msg_fd_out < 0) {
12ccc73a 546 if (!defer_forwarding_messages)
332cf6df 547 return io_multiplex_write(code, buf, len, convert);
12ccc73a
WD
548 if (!io_multiplexing_out)
549 return 0;
332cf6df 550 msg_list_add(&msg_queue, code, buf, len, convert);
12ccc73a 551 return 1;
37f35d89 552 }
e4c877cf 553 if (flist_forward_from >= 0)
332cf6df 554 msg_list_add(&msg_queue, code, buf, len, convert);
e4c877cf 555 else
332cf6df 556 mplex_write(msg_fd_out, code, buf, len, convert);
12ccc73a 557 return 1;
37f35d89
WD
558}
559
155d9206
WD
560void send_msg_int(enum msgcode code, int num)
561{
562 char numbuf[4];
563 SIVAL(numbuf, 0, num);
332cf6df 564 send_msg(code, numbuf, 4, 0);
155d9206
WD
565}
566
8ef246e0 567void wait_for_receiver(void)
d17e1dd2 568{
0b789446
WD
569 if (io_flush(FULL_FLUSH))
570 return;
571 read_msg_fd();
8ef246e0 572}
554e0a8d 573
8ef246e0
WD
574int get_redo_num(void)
575{
c6816b94 576 return flist_ndx_pop(&redo_list);
554e0a8d
AT
577}
578
cdf236aa
WD
579int get_hlink_num(void)
580{
581 return flist_ndx_pop(&hlink_list);
582}
583
56014c8c
WD
584/**
585 * When we're the receiver and we have a local --files-from list of names
586 * that needs to be sent over the socket to the sender, we have to do two
587 * things at the same time: send the sender a list of what files we're
588 * processing and read the incoming file+info list from the sender. We do
589 * this by augmenting the read_timeout() function to copy this data. It
ba525f77
WD
590 * uses ff_buf to read a block of data from f_in (when it is ready, since
591 * it might be a pipe) and then blast it out f_out (when it is ready to
592 * receive more data).
56014c8c
WD
593 */
594void io_set_filesfrom_fds(int f_in, int f_out)
595{
596 io_filesfrom_f_in = f_in;
597 io_filesfrom_f_out = f_out;
ba525f77
WD
598 alloc_xbuf(&ff_buf, 2048);
599#ifdef ICONV_OPTION
600 if (protect_args)
601 alloc_xbuf(&iconv_buf, 1024);
602#endif
56014c8c 603}
720b47f2 604
cb2e1f18
WD
605/* It's almost always an error to get an EOF when we're trying to read from the
606 * network, because the protocol is (for the most part) self-terminating.
880da007 607 *
cb2e1f18
WD
608 * There is one case for the receiver when it is at the end of the transfer
609 * (hanging around reading any keep-alive packets that might come its way): if
610 * the sender dies before the generator's kill-signal comes through, we can end
611 * up here needing to loop until the kill-signal arrives. In this situation,
612 * kluge_around_eof will be < 0.
613 *
614 * There is another case for older protocol versions (< 24) where the module
615 * listing was not terminated, so we must ignore an EOF error in that case and
616 * exit. In this situation, kluge_around_eof will be > 0. */
1f75bb10 617static void whine_about_eof(int fd)
7a55d06e 618{
574c2500 619 if (kluge_around_eof && fd == sock_f_in) {
55bb7fff 620 int i;
574c2500
WD
621 if (kluge_around_eof > 0)
622 exit_cleanup(0);
55bb7fff
WD
623 /* If we're still here after 10 seconds, exit with an error. */
624 for (i = 10*1000/20; i--; )
574c2500
WD
625 msleep(20);
626 }
3151cbae 627
00bdf899 628 rprintf(FERROR, RSYNC_NAME ": connection unexpectedly closed "
6d56efa6 629 "(%s bytes received so far) [%s]\n",
adc2476f 630 big_num(stats.total_read), who_am_i());
00bdf899
WD
631
632 exit_cleanup(RERR_STREAMIO);
7a55d06e 633}
720b47f2 634
880da007 635/**
6ed6d7f5 636 * Read from a socket with I/O timeout. return the number of bytes
c3563c46
MP
637 * read. If no bytes can be read then exit, never return a number <= 0.
638 *
8886f8d0
MP
639 * TODO: If the remote shell connection fails, then current versions
640 * actually report an "unexpected EOF" error here. Since it's a
641 * fairly common mistake to try to use rsh when ssh is required, we
642 * should trap that: if we fail to read any data at all, we should
643 * give a better explanation. We can tell whether the connection has
644 * started by looking e.g. at whether the remote version is known yet.
c3563c46 645 */
3151cbae 646static int read_timeout(int fd, char *buf, size_t len)
8d9dc9f9 647{
d8aeda1e 648 int n, cnt = 0;
4c36ddbe 649
dde5b772 650 io_flush(FULL_FLUSH);
ea2111d1 651
d8aeda1e 652 while (cnt == 0) {
7a55d06e 653 /* until we manage to read *something* */
56014c8c 654 fd_set r_fds, w_fds;
4c36ddbe 655 struct timeval tv;
1ea087a7 656 int maxfd = fd;
a57873b7 657 int count;
4c36ddbe 658
56014c8c 659 FD_ZERO(&r_fds);
a7026ba9 660 FD_ZERO(&w_fds);
56014c8c 661 FD_SET(fd, &r_fds);
3309507d 662 if (io_filesfrom_f_out >= 0) {
56014c8c 663 int new_fd;
ba525f77 664 if (ff_buf.len == 0) {
3309507d 665 if (io_filesfrom_f_in >= 0) {
56014c8c
WD
666 FD_SET(io_filesfrom_f_in, &r_fds);
667 new_fd = io_filesfrom_f_in;
668 } else {
669 io_filesfrom_f_out = -1;
670 new_fd = -1;
671 }
672 } else {
56014c8c
WD
673 FD_SET(io_filesfrom_f_out, &w_fds);
674 new_fd = io_filesfrom_f_out;
675 }
1ea087a7
WD
676 if (new_fd > maxfd)
677 maxfd = new_fd;
554e0a8d
AT
678 }
679
e626b29e 680 tv.tv_sec = select_timeout;
4c36ddbe
AT
681 tv.tv_usec = 0;
682
554e0a8d
AT
683 errno = 0;
684
a7026ba9 685 count = select(maxfd + 1, &r_fds, &w_fds, NULL, &tv);
a57873b7 686
a57873b7 687 if (count <= 0) {
2a5df862
WD
688 if (errno == EBADF) {
689 defer_forwarding_messages = 0;
554e0a8d 690 exit_cleanup(RERR_SOCKETIO);
2a5df862 691 }
bd717af8 692 check_timeout();
4c36ddbe
AT
693 continue;
694 }
695
3309507d 696 if (io_filesfrom_f_out >= 0) {
ba525f77 697 if (ff_buf.len) {
56014c8c
WD
698 if (FD_ISSET(io_filesfrom_f_out, &w_fds)) {
699 int l = write(io_filesfrom_f_out,
ba525f77
WD
700 ff_buf.buf + ff_buf.pos,
701 ff_buf.len);
56014c8c 702 if (l > 0) {
ba525f77
WD
703 if (!(ff_buf.len -= l))
704 ff_buf.pos = 0;
56014c8c 705 else
ba525f77 706 ff_buf.pos += l;
47cffb77 707 } else if (errno != EINTR) {
56014c8c
WD
708 /* XXX should we complain? */
709 io_filesfrom_f_out = -1;
710 }
711 }
3309507d 712 } else if (io_filesfrom_f_in >= 0) {
56014c8c 713 if (FD_ISSET(io_filesfrom_f_in, &r_fds)) {
22955408 714#ifdef ICONV_OPTION
ba525f77 715 xbuf *ibuf = filesfrom_convert ? &iconv_buf : &ff_buf;
22955408
WD
716#else
717 xbuf *ibuf = &ff_buf;
718#endif
ba525f77 719 int l = read(io_filesfrom_f_in, ibuf->buf, ibuf->size);
56014c8c 720 if (l <= 0) {
47cffb77
WD
721 if (l == 0 || errno != EINTR) {
722 /* Send end-of-file marker */
ba525f77
WD
723 memcpy(ff_buf.buf, "\0\0", 2);
724 ff_buf.len = ff_lastchar? 2 : 1;
725 ff_buf.pos = 0;
47cffb77
WD
726 io_filesfrom_f_in = -1;
727 }
56014c8c 728 } else {
22955408 729#ifdef ICONV_OPTION
ba525f77
WD
730 if (filesfrom_convert) {
731 iconv_buf.pos = 0;
732 iconv_buf.len = l;
733 iconvbufs(ic_send, &iconv_buf, &ff_buf,
734 ICB_EXPAND_OUT|ICB_INCLUDE_BAD|ICB_INCLUDE_INCOMPLETE);
735 l = ff_buf.len;
736 }
22955408 737#endif
56014c8c 738 if (!eol_nulls) {
ba525f77 739 char *s = ff_buf.buf + l;
56014c8c 740 /* Transform CR and/or LF into '\0' */
ba525f77 741 while (s-- > ff_buf.buf) {
56014c8c
WD
742 if (*s == '\n' || *s == '\r')
743 *s = '\0';
744 }
745 }
ba525f77 746 if (!ff_lastchar) {
56014c8c
WD
747 /* Last buf ended with a '\0', so don't
748 * let this buf start with one. */
ba525f77
WD
749 while (l && ff_buf.buf[ff_buf.pos] == '\0')
750 ff_buf.pos++, l--;
56014c8c
WD
751 }
752 if (!l)
ba525f77 753 ff_buf.pos = 0;
56014c8c 754 else {
ba525f77 755 char *f = ff_buf.buf + ff_buf.pos;
56014c8c
WD
756 char *t = f;
757 char *eob = f + l;
758 /* Eliminate any multi-'\0' runs. */
759 while (f != eob) {
760 if (!(*t++ = *f++)) {
761 while (f != eob && !*f)
762 f++, l--;
763 }
764 }
ba525f77 765 ff_lastchar = f[-1];
56014c8c 766 }
ba525f77 767 ff_buf.len = l;
56014c8c
WD
768 }
769 }
770 }
771 }
772
f89b9368
WD
773 if (!FD_ISSET(fd, &r_fds))
774 continue;
554e0a8d 775
4c36ddbe
AT
776 n = read(fd, buf, len);
777
1ea087a7
WD
778 if (n <= 0) {
779 if (n == 0)
1f75bb10 780 whine_about_eof(fd); /* Doesn't return. */
d62bcc17
WD
781 if (errno == EINTR || errno == EWOULDBLOCK
782 || errno == EAGAIN)
7a55d06e 783 continue;
1f75bb10
WD
784
785 /* Don't write errors on a dead socket. */
72f2d1b3 786 if (fd == sock_f_in) {
8ef246e0 787 io_end_multiplex_out();
3f0211b6 788 rsyserr(FERROR_SOCKET, errno, "read error");
72f2d1b3
WD
789 } else
790 rsyserr(FERROR, errno, "read error");
1f75bb10 791 exit_cleanup(RERR_STREAMIO);
8d9dc9f9 792 }
00bdf899
WD
793
794 buf += n;
795 len -= n;
d8aeda1e 796 cnt += n;
1f75bb10 797
3b0a30eb
WD
798 if (fd == sock_f_in && io_timeout)
799 last_io_in = time(NULL);
4c36ddbe 800 }
8d9dc9f9 801
d8aeda1e 802 return cnt;
4c36ddbe 803}
8d9dc9f9 804
67b8f3df 805/* Read a line into the "buf" buffer. */
ba525f77 806int read_line(int fd, char *buf, size_t bufsiz, int flags)
56014c8c 807{
ba525f77 808 char ch, *s, *eob;
56014c8c 809 int cnt;
56014c8c 810
ba525f77
WD
811#ifdef ICONV_OPTION
812 if (flags & RL_CONVERT && iconv_buf.size < bufsiz)
813 realloc_xbuf(&iconv_buf, bufsiz + 1024);
814#endif
815
56014c8c 816 start:
22955408 817#ifdef ICONV_OPTION
ba525f77 818 s = flags & RL_CONVERT ? iconv_buf.buf : buf;
22955408
WD
819#else
820 s = buf;
821#endif
ba525f77 822 eob = s + bufsiz - 1;
56014c8c
WD
823 while (1) {
824 cnt = read(fd, &ch, 1);
825 if (cnt < 0 && (errno == EWOULDBLOCK
826 || errno == EINTR || errno == EAGAIN)) {
827 struct timeval tv;
6c850772
WD
828 fd_set r_fds, e_fds;
829 FD_ZERO(&r_fds);
830 FD_SET(fd, &r_fds);
831 FD_ZERO(&e_fds);
832 FD_SET(fd, &e_fds);
e626b29e 833 tv.tv_sec = select_timeout;
56014c8c 834 tv.tv_usec = 0;
6c850772 835 if (!select(fd+1, &r_fds, NULL, &e_fds, &tv))
56014c8c 836 check_timeout();
35c8fd76
WD
837 /*if (FD_ISSET(fd, &e_fds))
838 rprintf(FINFO, "select exception on fd %d\n", fd); */
56014c8c
WD
839 continue;
840 }
841 if (cnt != 1)
842 break;
ba525f77 843 if (flags & RL_EOL_NULLS ? ch == '\0' : (ch == '\r' || ch == '\n')) {
67b8f3df 844 /* Skip empty lines if dumping comments. */
ba525f77 845 if (flags & RL_DUMP_COMMENTS && s == buf)
56014c8c
WD
846 continue;
847 break;
848 }
849 if (s < eob)
850 *s++ = ch;
851 }
852 *s = '\0';
7a55d06e 853
ba525f77 854 if (flags & RL_DUMP_COMMENTS && (*buf == '#' || *buf == ';'))
56014c8c
WD
855 goto start;
856
ba525f77
WD
857#ifdef ICONV_OPTION
858 if (flags & RL_CONVERT) {
859 xbuf outbuf;
860 INIT_XBUF(outbuf, buf, 0, bufsiz);
861 iconv_buf.pos = 0;
862 iconv_buf.len = s - iconv_buf.buf;
863 iconvbufs(ic_recv, &iconv_buf, &outbuf,
864 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
865 outbuf.buf[outbuf.len] = '\0';
866 return outbuf.len;
867 }
868#endif
869
67b8f3df
WD
870 return s - buf;
871}
872
53936ef9
WD
873void read_args(int f_in, char *mod_name, char *buf, size_t bufsiz, int rl_nulls,
874 char ***argv_p, int *argc_p, char **request_p)
67b8f3df
WD
875{
876 int maxargs = MAX_ARGS;
877 int dot_pos = 0;
878 int argc = 0;
879 char **argv, *p;
22955408
WD
880 int rl_flags = (rl_nulls ? RL_EOL_NULLS : 0);
881
882#ifdef ICONV_OPTION
883 rl_flags |= (protect_args && ic_recv != (iconv_t)-1 ? RL_CONVERT : 0);
884#endif
67b8f3df
WD
885
886 if (!(argv = new_array(char *, maxargs)))
887 out_of_memory("read_args");
53936ef9 888 if (mod_name && !protect_args)
67b8f3df
WD
889 argv[argc++] = "rsyncd";
890
891 while (1) {
ba525f77 892 if (read_line(f_in, buf, bufsiz, rl_flags) == 0)
67b8f3df
WD
893 break;
894
53936ef9 895 if (argc == maxargs-1) {
67b8f3df
WD
896 maxargs += MAX_ARGS;
897 if (!(argv = realloc_array(argv, char *, maxargs)))
898 out_of_memory("read_args");
899 }
900
901 if (dot_pos) {
902 if (request_p) {
903 *request_p = strdup(buf);
904 request_p = NULL;
905 }
906 if (mod_name)
907 glob_expand_module(mod_name, buf, &argv, &argc, &maxargs);
908 else
909 glob_expand(buf, &argv, &argc, &maxargs);
910 } else {
911 if (!(p = strdup(buf)))
912 out_of_memory("read_args");
913 argv[argc++] = p;
914 if (*p == '.' && p[1] == '\0')
915 dot_pos = argc;
916 }
917 }
53936ef9 918 argv[argc] = NULL;
67b8f3df 919
987a5467
WD
920 glob_expand(NULL, NULL, NULL, NULL);
921
67b8f3df
WD
922 *argc_p = argc;
923 *argv_p = argv;
56014c8c 924}
7a55d06e 925
8ef246e0 926int io_start_buffering_out(int f_out)
1f75bb10 927{
8ef246e0
WD
928 if (iobuf_out) {
929 assert(f_out == iobuf_f_out);
930 return 0;
931 }
1f75bb10
WD
932 if (!(iobuf_out = new_array(char, IO_BUFFER_SIZE)))
933 out_of_memory("io_start_buffering_out");
934 iobuf_out_cnt = 0;
8ef246e0
WD
935 iobuf_f_out = f_out;
936 return 1;
1f75bb10
WD
937}
938
8ef246e0 939int io_start_buffering_in(int f_in)
1f75bb10 940{
8ef246e0
WD
941 if (iobuf_in) {
942 assert(f_in == iobuf_f_in);
943 return 0;
944 }
1f75bb10
WD
945 iobuf_in_siz = 2 * IO_BUFFER_SIZE;
946 if (!(iobuf_in = new_array(char, iobuf_in_siz)))
947 out_of_memory("io_start_buffering_in");
8ef246e0
WD
948 iobuf_f_in = f_in;
949 return 1;
1f75bb10
WD
950}
951
8ef246e0 952void io_end_buffering_in(void)
1f75bb10 953{
8ef246e0
WD
954 if (!iobuf_in)
955 return;
956 free(iobuf_in);
957 iobuf_in = NULL;
958 iobuf_in_ndx = 0;
959 iobuf_in_remaining = 0;
960 iobuf_f_in = -1;
961}
962
963void io_end_buffering_out(void)
964{
965 if (!iobuf_out)
966 return;
967 io_flush(FULL_FLUSH);
968 free(iobuf_out);
969 iobuf_out = NULL;
970 iobuf_f_out = -1;
1f75bb10
WD
971}
972
be91bd81 973void maybe_flush_socket(int important)
626bec8e 974{
be91bd81
WD
975 if (iobuf_out && iobuf_out_cnt
976 && (important || time(NULL) - last_io_out >= 5))
626bec8e
WD
977 io_flush(NORMAL_FLUSH);
978}
979
cdf236aa 980void maybe_send_keepalive(void)
9e2409ab 981{
3b0a30eb 982 if (time(NULL) - last_io_out >= allowed_lull) {
9e2409ab 983 if (!iobuf_out || !iobuf_out_cnt) {
3221f451
WD
984 if (protocol_version < 29)
985 return; /* there's nothing we can do */
8ef246e0 986 if (protocol_version >= 30)
332cf6df 987 send_msg(MSG_NOOP, "", 0, 0);
8ef246e0 988 else {
9decb4d2 989 write_int(sock_f_out, cur_flist->used);
8ef246e0
WD
990 write_shortint(sock_f_out, ITEM_IS_NEW);
991 }
9e2409ab
WD
992 }
993 if (iobuf_out)
994 io_flush(NORMAL_FLUSH);
995 }
996}
997
8ef246e0
WD
998void start_flist_forward(int f_in)
999{
1000 assert(iobuf_out != NULL);
1001 assert(iobuf_f_out == msg_fd_out);
1002 flist_forward_from = f_in;
1003}
1004
1005void stop_flist_forward()
1006{
8ef246e0 1007 flist_forward_from = -1;
dde5b772 1008 io_flush(FULL_FLUSH);
8ef246e0
WD
1009}
1010
880da007
MP
1011/**
1012 * Continue trying to read len bytes - don't return until len has been
1013 * read.
1014 **/
3151cbae 1015static void read_loop(int fd, char *buf, size_t len)
4c36ddbe
AT
1016{
1017 while (len) {
1018 int n = read_timeout(fd, buf, len);
1019
1020 buf += n;
1021 len -= n;
8d9dc9f9
AT
1022 }
1023}
1024
7a55d06e
MP
1025/**
1026 * Read from the file descriptor handling multiplexing - return number
1027 * of bytes read.
d62bcc17
WD
1028 *
1029 * Never returns <= 0.
7a55d06e 1030 */
c399d22a 1031static int readfd_unbuffered(int fd, char *buf, size_t len)
8d9dc9f9 1032{
f2a4853c 1033 size_t msg_bytes;
d8aeda1e 1034 int tag, cnt = 0;
33544bf4 1035 char line[BIGPATHBUFLEN];
8d9dc9f9 1036
8ef246e0 1037 if (!iobuf_in || fd != iobuf_f_in)
4c36ddbe 1038 return read_timeout(fd, buf, len);
8d9dc9f9 1039
8ef246e0
WD
1040 if (!io_multiplexing_in && iobuf_in_remaining == 0) {
1041 iobuf_in_remaining = read_timeout(fd, iobuf_in, iobuf_in_siz);
1f75bb10 1042 iobuf_in_ndx = 0;
76c21947
WD
1043 }
1044
d8aeda1e 1045 while (cnt == 0) {
8ef246e0
WD
1046 if (iobuf_in_remaining) {
1047 len = MIN(len, iobuf_in_remaining);
1f75bb10
WD
1048 memcpy(buf, iobuf_in + iobuf_in_ndx, len);
1049 iobuf_in_ndx += len;
8ef246e0 1050 iobuf_in_remaining -= len;
d8aeda1e 1051 cnt = len;
76c21947 1052 break;
8d9dc9f9
AT
1053 }
1054
909ce14f 1055 read_loop(fd, line, 4);
ff41a59f 1056 tag = IVAL(line, 0);
679e7657 1057
f2a4853c 1058 msg_bytes = tag & 0xFFFFFF;
d17e1dd2 1059 tag = (tag >> 24) - MPLEX_BASE;
8d9dc9f9 1060
d17e1dd2
WD
1061 switch (tag) {
1062 case MSG_DATA:
f2a4853c 1063 if (msg_bytes > iobuf_in_siz) {
1f75bb10 1064 if (!(iobuf_in = realloc_array(iobuf_in, char,
f2a4853c 1065 msg_bytes)))
c399d22a 1066 out_of_memory("readfd_unbuffered");
f2a4853c 1067 iobuf_in_siz = msg_bytes;
76c21947 1068 }
f2a4853c 1069 read_loop(fd, iobuf_in, msg_bytes);
8ef246e0 1070 iobuf_in_remaining = msg_bytes;
1f75bb10 1071 iobuf_in_ndx = 0;
d17e1dd2 1072 break;
8ef246e0
WD
1073 case MSG_NOOP:
1074 if (am_sender)
1075 maybe_send_keepalive();
1076 break;
1077 case MSG_IO_ERROR:
1078 if (msg_bytes != 4)
1079 goto invalid_msg;
1080 read_loop(fd, line, msg_bytes);
e5f35681 1081 send_msg_int(MSG_IO_ERROR, IVAL(line, 0));
8ef246e0
WD
1082 io_error |= IVAL(line, 0);
1083 break;
0d67e00a 1084 case MSG_DELETED:
f2a4853c
WD
1085 if (msg_bytes >= sizeof line)
1086 goto overflow;
332cf6df
WD
1087#ifdef ICONV_OPTION
1088 if (ic_recv != (iconv_t)-1) {
ba525f77
WD
1089 xbuf outbuf, inbuf;
1090 char ibuf[512];
332cf6df 1091 int add_null = 0;
ba525f77
WD
1092
1093 INIT_CONST_XBUF(outbuf, line);
bb640d32 1094 INIT_XBUF(inbuf, ibuf, 0, (size_t)-1);
ba525f77 1095
332cf6df 1096 while (msg_bytes) {
ba525f77
WD
1097 inbuf.len = msg_bytes > sizeof ibuf
1098 ? sizeof ibuf : msg_bytes;
1099 read_loop(fd, inbuf.buf, inbuf.len);
1100 if (!(msg_bytes -= inbuf.len)
1101 && !ibuf[inbuf.len-1])
1102 inbuf.len--, add_null = 1;
1103 if (iconvbufs(ic_send, &inbuf, &outbuf,
1104 ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE) < 0)
1105 goto overflow;
ba525f77
WD
1106 }
1107 if (add_null) {
1108 if (outbuf.len == outbuf.size)
1109 goto overflow;
1110 outbuf.buf[outbuf.len++] = '\0';
332cf6df 1111 }
ba525f77 1112 msg_bytes = outbuf.len;
332cf6df
WD
1113 } else
1114#endif
1115 read_loop(fd, line, msg_bytes);
0d67e00a 1116 /* A directory name was sent with the trailing null */
f2a4853c 1117 if (msg_bytes > 0 && !line[msg_bytes-1])
0d67e00a 1118 log_delete(line, S_IFDIR);
12bda6f7
WD
1119 else {
1120 line[msg_bytes] = '\0';
0d67e00a 1121 log_delete(line, S_IFREG);
12bda6f7 1122 }
0d67e00a 1123 break;
9981c27e 1124 case MSG_SUCCESS:
f2a4853c 1125 if (msg_bytes != 4) {
8ef246e0 1126 invalid_msg:
cdf236aa 1127 rprintf(FERROR, "invalid multi-message %d:%ld [%s]\n",
f2a4853c 1128 tag, (long)msg_bytes, who_am_i());
9981c27e
WD
1129 exit_cleanup(RERR_STREAMIO);
1130 }
f2a4853c 1131 read_loop(fd, line, msg_bytes);
9981c27e 1132 successful_send(IVAL(line, 0));
9981c27e 1133 break;
8ef246e0
WD
1134 case MSG_NO_SEND:
1135 if (msg_bytes != 4)
1136 goto invalid_msg;
1137 read_loop(fd, line, msg_bytes);
1138 send_msg_int(MSG_NO_SEND, IVAL(line, 0));
1139 break;
d17e1dd2
WD
1140 case MSG_INFO:
1141 case MSG_ERROR:
3f0211b6
WD
1142 case MSG_ERROR_XFER:
1143 case MSG_WARNING:
f2a4853c
WD
1144 if (msg_bytes >= sizeof line) {
1145 overflow:
bd9fca47 1146 rprintf(FERROR,
cdf236aa 1147 "multiplexing overflow %d:%ld [%s]\n",
f2a4853c 1148 tag, (long)msg_bytes, who_am_i());
d17e1dd2
WD
1149 exit_cleanup(RERR_STREAMIO);
1150 }
f2a4853c 1151 read_loop(fd, line, msg_bytes);
332cf6df 1152 rwrite((enum logcode)tag, line, msg_bytes, 1);
7f9bf6b7
WD
1153 if (first_message) {
1154 if (list_only && !am_sender && tag == 1) {
1155 line[msg_bytes] = '\0';
1156 check_for_d_option_error(line);
1157 }
1158 first_message = 0;
1159 }
d17e1dd2
WD
1160 break;
1161 default:
cdf236aa
WD
1162 rprintf(FERROR, "unexpected tag %d [%s]\n",
1163 tag, who_am_i());
65417579 1164 exit_cleanup(RERR_STREAMIO);
8d9dc9f9 1165 }
8d9dc9f9
AT
1166 }
1167
8ef246e0 1168 if (iobuf_in_remaining == 0)
d17e1dd2 1169 io_flush(NORMAL_FLUSH);
76c21947 1170
d8aeda1e 1171 return cnt;
8d9dc9f9
AT
1172}
1173
dde5b772
WD
1174/* Do a buffered read from fd. Don't return until all N bytes have
1175 * been read. If all N can't be read then exit with an error. */
3151cbae 1176static void readfd(int fd, char *buffer, size_t N)
720b47f2 1177{
d8aeda1e 1178 int cnt;
d62bcc17 1179 size_t total = 0;
3151cbae 1180
6ba9279f 1181 while (total < N) {
d8aeda1e
WD
1182 cnt = readfd_unbuffered(fd, buffer + total, N-total);
1183 total += cnt;
7f28dbee 1184 }
1b7c47cb 1185
b9f592fb
WD
1186 if (fd == write_batch_monitor_in) {
1187 if ((size_t)write(batch_fd, buffer, total) != total)
1188 exit_cleanup(RERR_FILEIO);
1189 }
1f75bb10 1190
8ef246e0
WD
1191 if (fd == flist_forward_from)
1192 writefd(iobuf_f_out, buffer, total);
1193
1f75bb10
WD
1194 if (fd == sock_f_in)
1195 stats.total_read += total;
720b47f2
AT
1196}
1197
3a993aa4 1198unsigned short read_shortint(int f)
9361f839 1199{
482f48cc
WD
1200 char b[2];
1201 readfd(f, b, 2);
1202 return (UVAL(b, 1) << 8) + UVAL(b, 0);
9361f839
WD
1203}
1204
b7922338 1205int32 read_int(int f)
720b47f2 1206{
4c36ddbe 1207 char b[4];
d8aeda1e 1208 int32 num;
d730b113 1209
482f48cc
WD
1210 readfd(f, b, 4);
1211 num = IVAL(b, 0);
1212#if SIZEOF_INT32 > 4
1213 if (num & (int32)0x80000000)
1214 num |= ~(int32)0xffffffff;
1215#endif
d8aeda1e 1216 return num;
720b47f2
AT
1217}
1218
351e23ad 1219int32 read_varint(int f)
3a6a366f 1220{
351e23ad
WD
1221 union {
1222 char b[5];
1223 int32 x;
1224 } u;
1225 uchar ch;
1226 int extra;
1227
1228 u.x = 0;
1229 readfd(f, (char*)&ch, 1);
1230 extra = int_byte_extra[ch / 4];
1231 if (extra) {
1232 uchar bit = ((uchar)1<<(8-extra));
1233 if (extra >= (int)sizeof u.b) {
1234 rprintf(FERROR, "Overflow in read_varint()\n");
1235 exit_cleanup(RERR_STREAMIO);
1236 }
1237 readfd(f, u.b, extra);
1238 u.b[extra] = ch & (bit-1);
1239 } else
1240 u.b[0] = ch;
1241#if CAREFUL_ALIGNMENT
1242 u.x = IVAL(u.b,0);
1243#endif
1244#if SIZEOF_INT32 > 4
1245 if (u.x & (int32)0x80000000)
1246 u.x |= ~(int32)0xffffffff;
1247#endif
1248 return u.x;
1249}
71c46176 1250
351e23ad
WD
1251int64 read_varlong(int f, uchar min_bytes)
1252{
1253 union {
1254 char b[9];
1255 int64 x;
1256 } u;
1257 char b2[8];
1258 int extra;
71c46176 1259
031fa9ad 1260#if SIZEOF_INT64 < 8
351e23ad 1261 memset(u.b, 0, 8);
031fa9ad 1262#else
351e23ad 1263 u.x = 0;
031fa9ad 1264#endif
351e23ad
WD
1265 readfd(f, b2, min_bytes);
1266 memcpy(u.b, b2+1, min_bytes-1);
1267 extra = int_byte_extra[CVAL(b2, 0) / 4];
1268 if (extra) {
1269 uchar bit = ((uchar)1<<(8-extra));
1270 if (min_bytes + extra > (int)sizeof u.b) {
1271 rprintf(FERROR, "Overflow in read_varlong()\n");
1272 exit_cleanup(RERR_STREAMIO);
1273 }
1274 readfd(f, u.b + min_bytes - 1, extra);
1275 u.b[min_bytes + extra - 1] = CVAL(b2, 0) & (bit-1);
4ea4acf1 1276#if SIZEOF_INT64 < 8
351e23ad 1277 if (min_bytes + extra > 5 || u.b[4] || CVAL(u.b,3) & 0x80) {
4ea4acf1
WD
1278 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1279 exit_cleanup(RERR_UNSUPPORTED);
1280 }
1281#endif
351e23ad
WD
1282 } else
1283 u.b[min_bytes + extra - 1] = CVAL(b2, 0);
1284#if SIZEOF_INT64 < 8
1285 u.x = IVAL(u.b,0);
1286#elif CAREFUL_ALIGNMENT
1287 u.x = IVAL(u.b,0) | (((int64)IVAL(u.b,4))<<32);
1288#endif
1289 return u.x;
1290}
1291
1292int64 read_longint(int f)
1293{
4ea4acf1 1294#if SIZEOF_INT64 >= 8
351e23ad 1295 char b[9];
4ea4acf1 1296#endif
351e23ad 1297 int32 num = read_int(f);
71c46176 1298
351e23ad
WD
1299 if (num != (int32)0xffffffff)
1300 return num;
1301
1302#if SIZEOF_INT64 < 8
1303 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1304 exit_cleanup(RERR_UNSUPPORTED);
1305#else
1306 readfd(f, b, 8);
1307 return IVAL(b,0) | (((int64)IVAL(b,4))<<32);
1308#endif
3a6a366f
AT
1309}
1310
4a19c3b2 1311void read_buf(int f, char *buf, size_t len)
720b47f2 1312{
4c36ddbe 1313 readfd(f,buf,len);
720b47f2
AT
1314}
1315
4a19c3b2 1316void read_sbuf(int f, char *buf, size_t len)
575f2fca 1317{
93095cbe 1318 readfd(f, buf, len);
af436313 1319 buf[len] = '\0';
575f2fca
AT
1320}
1321
9361f839 1322uchar read_byte(int f)
182dca5c 1323{
9361f839 1324 uchar c;
93095cbe 1325 readfd(f, (char *)&c, 1);
4c36ddbe 1326 return c;
182dca5c 1327}
720b47f2 1328
46e99b09
WD
1329int read_vstring(int f, char *buf, int bufsize)
1330{
1331 int len = read_byte(f);
1332
1333 if (len & 0x80)
1334 len = (len & ~0x80) * 0x100 + read_byte(f);
1335
1336 if (len >= bufsize) {
1337 rprintf(FERROR, "over-long vstring received (%d > %d)\n",
1338 len, bufsize - 1);
9a6ed83f 1339 return -1;
46e99b09
WD
1340 }
1341
1342 if (len)
1343 readfd(f, buf, len);
1344 buf[len] = '\0';
1345 return len;
1346}
1347
188fed95
WD
1348/* Populate a sum_struct with values from the socket. This is
1349 * called by both the sender and the receiver. */
1350void read_sum_head(int f, struct sum_struct *sum)
1351{
8bd77e70 1352 int32 max_blength = protocol_version < 30 ? OLD_MAX_BLOCK_SIZE : MAX_BLOCK_SIZE;
188fed95 1353 sum->count = read_int(f);
c638caa6
WD
1354 if (sum->count < 0) {
1355 rprintf(FERROR, "Invalid checksum count %ld [%s]\n",
1356 (long)sum->count, who_am_i());
1357 exit_cleanup(RERR_PROTOCOL);
1358 }
188fed95 1359 sum->blength = read_int(f);
8bd77e70 1360 if (sum->blength < 0 || sum->blength > max_blength) {
cdf236aa
WD
1361 rprintf(FERROR, "Invalid block length %ld [%s]\n",
1362 (long)sum->blength, who_am_i());
188fed95
WD
1363 exit_cleanup(RERR_PROTOCOL);
1364 }
1365 sum->s2length = protocol_version < 27 ? csum_length : (int)read_int(f);
a0456b9c 1366 if (sum->s2length < 0 || sum->s2length > MAX_DIGEST_LEN) {
cdf236aa
WD
1367 rprintf(FERROR, "Invalid checksum length %d [%s]\n",
1368 sum->s2length, who_am_i());
188fed95
WD
1369 exit_cleanup(RERR_PROTOCOL);
1370 }
1371 sum->remainder = read_int(f);
1372 if (sum->remainder < 0 || sum->remainder > sum->blength) {
cdf236aa
WD
1373 rprintf(FERROR, "Invalid remainder length %ld [%s]\n",
1374 (long)sum->remainder, who_am_i());
188fed95
WD
1375 exit_cleanup(RERR_PROTOCOL);
1376 }
1377}
1378
c207d7ec
WD
1379/* Send the values from a sum_struct over the socket. Set sum to
1380 * NULL if there are no checksums to send. This is called by both
1381 * the generator and the sender. */
1382void write_sum_head(int f, struct sum_struct *sum)
1383{
1384 static struct sum_struct null_sum;
1385
1386 if (sum == NULL)
1387 sum = &null_sum;
1388
1389 write_int(f, sum->count);
1390 write_int(f, sum->blength);
1391 if (protocol_version >= 27)
1392 write_int(f, sum->s2length);
1393 write_int(f, sum->remainder);
1394}
1395
08571358
MP
1396/**
1397 * Sleep after writing to limit I/O bandwidth usage.
1398 *
1399 * @todo Rather than sleeping after each write, it might be better to
1400 * use some kind of averaging. The current algorithm seems to always
1401 * use a bit less bandwidth than specified, because it doesn't make up
1402 * for slow periods. But arguably this is a feature. In addition, we
1403 * ought to take the time used to write the data into account.
71e58630
WD
1404 *
1405 * During some phases of big transfers (file FOO is uptodate) this is
1406 * called with a small bytes_written every time. As the kernel has to
1407 * round small waits up to guarantee that we actually wait at least the
1408 * requested number of microseconds, this can become grossly inaccurate.
1409 * We therefore keep track of the bytes we've written over time and only
1410 * sleep when the accumulated delay is at least 1 tenth of a second.
08571358
MP
1411 **/
1412static void sleep_for_bwlimit(int bytes_written)
1413{
71e58630 1414 static struct timeval prior_tv;
0f78b815 1415 static long total_written = 0;
71e58630
WD
1416 struct timeval tv, start_tv;
1417 long elapsed_usec, sleep_usec;
1418
1419#define ONE_SEC 1000000L /* # of microseconds in a second */
08571358 1420
9a0cfff5 1421 if (!bwlimit_writemax)
08571358 1422 return;
e681e820 1423
0f78b815 1424 total_written += bytes_written;
71e58630
WD
1425
1426 gettimeofday(&start_tv, NULL);
1427 if (prior_tv.tv_sec) {
1428 elapsed_usec = (start_tv.tv_sec - prior_tv.tv_sec) * ONE_SEC
1429 + (start_tv.tv_usec - prior_tv.tv_usec);
1430 total_written -= elapsed_usec * bwlimit / (ONE_SEC/1024);
1431 if (total_written < 0)
1432 total_written = 0;
1433 }
3151cbae 1434
71e58630
WD
1435 sleep_usec = total_written * (ONE_SEC/1024) / bwlimit;
1436 if (sleep_usec < ONE_SEC / 10) {
1437 prior_tv = start_tv;
1438 return;
1439 }
08571358 1440
71e58630
WD
1441 tv.tv_sec = sleep_usec / ONE_SEC;
1442 tv.tv_usec = sleep_usec % ONE_SEC;
98b332ed 1443 select(0, NULL, NULL, NULL, &tv);
71e58630
WD
1444
1445 gettimeofday(&prior_tv, NULL);
1446 elapsed_usec = (prior_tv.tv_sec - start_tv.tv_sec) * ONE_SEC
1447 + (prior_tv.tv_usec - start_tv.tv_usec);
1448 total_written = (sleep_usec - elapsed_usec) * bwlimit / (ONE_SEC/1024);
08571358
MP
1449}
1450
1f75bb10 1451/* Write len bytes to the file descriptor fd, looping as necessary to get
0fb2fc4a 1452 * the job done and also (in certain circumstances) reading any data on
af436313 1453 * msg_fd_in to avoid deadlock.
880da007
MP
1454 *
1455 * This function underlies the multiplexing system. The body of the
1f75bb10 1456 * application never calls this function directly. */
4a19c3b2 1457static void writefd_unbuffered(int fd, const char *buf, size_t len)
720b47f2 1458{
1ea087a7 1459 size_t n, total = 0;
6c850772 1460 fd_set w_fds, r_fds, e_fds;
d8aeda1e 1461 int maxfd, count, cnt, using_r_fds;
e4c877cf 1462 int defer_inc = 0;
8d9dc9f9 1463 struct timeval tv;
720b47f2 1464
3be97bf9 1465 if (no_flush++)
e4c877cf 1466 defer_forwarding_messages++, defer_inc++;
e44f9a12 1467
4c36ddbe 1468 while (total < len) {
8d9dc9f9 1469 FD_ZERO(&w_fds);
6c850772
WD
1470 FD_SET(fd, &w_fds);
1471 FD_ZERO(&e_fds);
1472 FD_SET(fd, &e_fds);
1ea087a7 1473 maxfd = fd;
4c36ddbe 1474
954bbed8 1475 if (msg_fd_in >= 0) {
56014c8c 1476 FD_ZERO(&r_fds);
6c850772 1477 FD_SET(msg_fd_in, &r_fds);
1ea087a7
WD
1478 if (msg_fd_in > maxfd)
1479 maxfd = msg_fd_in;
3eeac9bc
WD
1480 using_r_fds = 1;
1481 } else
1482 using_r_fds = 0;
8d9dc9f9 1483
e626b29e 1484 tv.tv_sec = select_timeout;
8d9dc9f9 1485 tv.tv_usec = 0;
4c36ddbe 1486
554e0a8d 1487 errno = 0;
3eeac9bc 1488 count = select(maxfd + 1, using_r_fds ? &r_fds : NULL,
6c850772 1489 &w_fds, &e_fds, &tv);
4c36ddbe
AT
1490
1491 if (count <= 0) {
1ea087a7 1492 if (count < 0 && errno == EBADF)
554e0a8d 1493 exit_cleanup(RERR_SOCKETIO);
bd717af8 1494 check_timeout();
8d9dc9f9
AT
1495 continue;
1496 }
4c36ddbe 1497
35c8fd76
WD
1498 /*if (FD_ISSET(fd, &e_fds))
1499 rprintf(FINFO, "select exception on fd %d\n", fd); */
6c850772 1500
3eeac9bc 1501 if (using_r_fds && FD_ISSET(msg_fd_in, &r_fds))
d17e1dd2 1502 read_msg_fd();
554e0a8d 1503
9a6ed83f 1504 if (!FD_ISSET(fd, &w_fds))
1ea087a7 1505 continue;
4c36ddbe 1506
1ea087a7 1507 n = len - total;
9a0cfff5 1508 if (bwlimit_writemax && n > bwlimit_writemax)
1ea087a7 1509 n = bwlimit_writemax;
d8aeda1e 1510 cnt = write(fd, buf + total, n);
1ea087a7 1511
d8aeda1e
WD
1512 if (cnt <= 0) {
1513 if (cnt < 0) {
3309507d
WD
1514 if (errno == EINTR)
1515 continue;
1516 if (errno == EWOULDBLOCK || errno == EAGAIN) {
1517 msleep(1);
1518 continue;
1519 }
f0359dd0
AT
1520 }
1521
1ea087a7 1522 /* Don't try to write errors back across the stream. */
1f75bb10 1523 if (fd == sock_f_out)
8ef246e0 1524 io_end_multiplex_out();
2a5df862
WD
1525 /* Don't try to write errors down a failing msg pipe. */
1526 if (am_server && fd == msg_fd_out)
1527 exit_cleanup(RERR_STREAMIO);
1ea087a7 1528 rsyserr(FERROR, errno,
b88c2e8f
WD
1529 "writefd_unbuffered failed to write %ld bytes [%s]",
1530 (long)len, who_am_i());
d1b31da7
WD
1531 /* If the other side is sending us error messages, try
1532 * to grab any messages they sent before they died. */
f2179fd3 1533 while (!am_server && fd == sock_f_out && io_multiplexing_in) {
ba525f77 1534 char buf[1024];
3b0a30eb 1535 set_io_timeout(30);
9e2409ab 1536 ignore_timeout = 0;
ba525f77 1537 readfd_unbuffered(sock_f_in, buf, sizeof buf);
d1b31da7 1538 }
1ea087a7
WD
1539 exit_cleanup(RERR_STREAMIO);
1540 }
4c36ddbe 1541
d8aeda1e 1542 total += cnt;
e4c877cf 1543 defer_forwarding_messages++, defer_inc++;
a800434a 1544
1f75bb10 1545 if (fd == sock_f_out) {
626bec8e 1546 if (io_timeout || am_generator)
3b0a30eb 1547 last_io_out = time(NULL);
d8aeda1e 1548 sleep_for_bwlimit(cnt);
1f75bb10 1549 }
4c36ddbe 1550 }
e44f9a12
AT
1551
1552 no_flush--;
0b789446
WD
1553 if (keep_defer_forwarding)
1554 defer_inc--;
17a4977b 1555 if (!(defer_forwarding_messages -= defer_inc) && !no_flush)
e4c877cf 1556 msg_flush();
d6dead6b
AT
1557}
1558
0b789446 1559int io_flush(int flush_it_all)
d6dead6b 1560{
0b789446 1561 int flushed_something = 0;
8d9dc9f9 1562
0b789446
WD
1563 if (no_flush)
1564 return 0;
e4c877cf 1565
0b789446
WD
1566 if (iobuf_out_cnt) {
1567 if (io_multiplexing_out)
1568 mplex_write(sock_f_out, MSG_DATA, iobuf_out, iobuf_out_cnt, 0);
1569 else
1570 writefd_unbuffered(iobuf_f_out, iobuf_out, iobuf_out_cnt);
1571 iobuf_out_cnt = 0;
1572 flushed_something = 1;
1573 }
1574
1575 if (flush_it_all && !defer_forwarding_messages && msg_queue.head) {
e4c877cf 1576 msg_flush();
0b789446
WD
1577 flushed_something = 1;
1578 }
1579
1580 return flushed_something;
8d9dc9f9
AT
1581}
1582
4a19c3b2 1583static void writefd(int fd, const char *buf, size_t len)
d6dead6b 1584{
1f75bb10
WD
1585 if (fd == sock_f_out)
1586 stats.total_written += len;
1587
b9f592fb
WD
1588 if (fd == write_batch_monitor_out) {
1589 if ((size_t)write(batch_fd, buf, len) != len)
1590 exit_cleanup(RERR_FILEIO);
1591 }
1592
8ef246e0 1593 if (!iobuf_out || fd != iobuf_f_out) {
4c36ddbe
AT
1594 writefd_unbuffered(fd, buf, len);
1595 return;
1596 }
d6dead6b
AT
1597
1598 while (len) {
1f75bb10 1599 int n = MIN((int)len, IO_BUFFER_SIZE - iobuf_out_cnt);
d6dead6b 1600 if (n > 0) {
1f75bb10 1601 memcpy(iobuf_out+iobuf_out_cnt, buf, n);
d6dead6b
AT
1602 buf += n;
1603 len -= n;
1f75bb10 1604 iobuf_out_cnt += n;
d6dead6b 1605 }
3151cbae 1606
1f75bb10 1607 if (iobuf_out_cnt == IO_BUFFER_SIZE)
d17e1dd2 1608 io_flush(NORMAL_FLUSH);
d6dead6b 1609 }
d6dead6b 1610}
720b47f2 1611
3a993aa4 1612void write_shortint(int f, unsigned short x)
9361f839 1613{
3a993aa4
WD
1614 char b[2];
1615 b[0] = (char)x;
1616 b[1] = (char)(x >> 8);
1617 writefd(f, b, 2);
9361f839
WD
1618}
1619
351e23ad
WD
1620void write_int(int f, int32 x)
1621{
1622 char b[4];
1623 SIVAL(b, 0, x);
1624 writefd(f, b, 4);
1625}
1626
f31514ad 1627void write_varint(int f, int32 x)
1c3344a1
WD
1628{
1629 char b[5];
351e23ad
WD
1630 uchar bit;
1631 int cnt = 4;
1632
1633 SIVAL(b, 1, x);
1634
1635 while (cnt > 1 && b[cnt] == 0)
1636 cnt--;
1637 bit = ((uchar)1<<(7-cnt+1));
1638 if (CVAL(b, cnt) >= bit) {
1639 cnt++;
1640 *b = ~(bit-1);
1641 } else if (cnt > 1)
1642 *b = b[cnt] | ~(bit*2-1);
1643 else
1644 *b = b[cnt];
1645
1646 writefd(f, b, cnt);
1c3344a1
WD
1647}
1648
351e23ad 1649void write_varlong(int f, int64 x, uchar min_bytes)
720b47f2 1650{
351e23ad
WD
1651 char b[9];
1652 uchar bit;
1653 int cnt = 8;
1654
1655 SIVAL(b, 1, x);
1656#if SIZEOF_INT64 >= 8
1657 SIVAL(b, 5, x >> 32);
1658#else
1659 if (x <= 0x7FFFFFFF && x >= 0)
1660 memset(b + 5, 0, 4);
1661 else {
1662 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1663 exit_cleanup(RERR_UNSUPPORTED);
1664 }
1665#endif
1666
1667 while (cnt > min_bytes && b[cnt] == 0)
1668 cnt--;
1669 bit = ((uchar)1<<(7-cnt+min_bytes));
1670 if (CVAL(b, cnt) >= bit) {
1671 cnt++;
1672 *b = ~(bit-1);
1673 } else if (cnt > min_bytes)
1674 *b = b[cnt] | ~(bit*2-1);
1675 else
1676 *b = b[cnt];
1677
1678 writefd(f, b, cnt);
720b47f2
AT
1679}
1680
7a24c346
MP
1681/*
1682 * Note: int64 may actually be a 32-bit type if ./configure couldn't find any
1683 * 64-bit types on this platform.
1684 */
71c46176 1685void write_longint(int f, int64 x)
3a6a366f 1686{
351e23ad 1687 char b[12], * const s = b+4;
3a6a366f 1688
351e23ad
WD
1689 SIVAL(s, 0, x);
1690 if (x <= 0x7FFFFFFF && x >= 0) {
482f48cc 1691 writefd(f, s, 4);
351e23ad
WD
1692 return;
1693 }
3a6a366f 1694
4ea4acf1 1695#if SIZEOF_INT64 < 8
351e23ad
WD
1696 rprintf(FERROR, "Integer overflow: attempted 64-bit offset\n");
1697 exit_cleanup(RERR_UNSUPPORTED);
4ea4acf1 1698#else
351e23ad
WD
1699 memset(b, 0xFF, 4);
1700 SIVAL(s, 4, x >> 32);
1701 writefd(f, b, 12);
4ea4acf1 1702#endif
3a6a366f
AT
1703}
1704
4a19c3b2 1705void write_buf(int f, const char *buf, size_t len)
720b47f2 1706{
4c36ddbe 1707 writefd(f,buf,len);
720b47f2
AT
1708}
1709
880da007 1710/** Write a string to the connection */
4a19c3b2 1711void write_sbuf(int f, const char *buf)
f0fca04e 1712{
93095cbe 1713 writefd(f, buf, strlen(buf));
f0fca04e
AT
1714}
1715
9361f839 1716void write_byte(int f, uchar c)
182dca5c 1717{
93095cbe 1718 writefd(f, (char *)&c, 1);
182dca5c
AT
1719}
1720
4a19c3b2 1721void write_vstring(int f, const char *str, int len)
46e99b09
WD
1722{
1723 uchar lenbuf[3], *lb = lenbuf;
1724
1725 if (len > 0x7F) {
1726 if (len > 0x7FFF) {
1727 rprintf(FERROR,
1728 "attempting to send over-long vstring (%d > %d)\n",
1729 len, 0x7FFF);
1730 exit_cleanup(RERR_PROTOCOL);
1731 }
1732 *lb++ = len / 0x100 + 0x80;
1733 }
1734 *lb = len;
1735
1736 writefd(f, (char*)lenbuf, lb - lenbuf + 1);
1737 if (len)
1738 writefd(f, str, len);
1739}
1740
8a65e0ce
WD
1741/* Send a file-list index using a byte-reduction method. */
1742void write_ndx(int f, int32 ndx)
1743{
1744 static int32 prev_positive = -1, prev_negative = 1;
1745 int32 diff, cnt = 0;
1746 char b[6];
1747
1748 if (protocol_version < 30 || read_batch) {
1749 write_int(f, ndx);
1750 return;
1751 }
1752
1753 /* Send NDX_DONE as a single-byte 0 with no side effects. Send
1754 * negative nums as a positive after sending a leading 0xFF. */
1755 if (ndx >= 0) {
1756 diff = ndx - prev_positive;
1757 prev_positive = ndx;
1758 } else if (ndx == NDX_DONE) {
1759 *b = 0;
1760 writefd(f, b, 1);
1761 return;
1762 } else {
1763 b[cnt++] = (char)0xFF;
1764 ndx = -ndx;
1765 diff = ndx - prev_negative;
1766 prev_negative = ndx;
1767 }
1768
1769 /* A diff of 1 - 253 is sent as a one-byte diff; a diff of 254 - 32767
1770 * or 0 is sent as a 0xFE + a two-byte diff; otherwise we send 0xFE
1771 * & all 4 bytes of the (non-negative) num with the high-bit set. */
1772 if (diff < 0xFE && diff > 0)
1773 b[cnt++] = (char)diff;
1774 else if (diff < 0 || diff > 0x7FFF) {
1775 b[cnt++] = (char)0xFE;
1776 b[cnt++] = (char)((ndx >> 24) | 0x80);
8a65e0ce 1777 b[cnt++] = (char)ndx;
351e23ad
WD
1778 b[cnt++] = (char)(ndx >> 8);
1779 b[cnt++] = (char)(ndx >> 16);
8a65e0ce
WD
1780 } else {
1781 b[cnt++] = (char)0xFE;
1782 b[cnt++] = (char)(diff >> 8);
1783 b[cnt++] = (char)diff;
1784 }
1785 writefd(f, b, cnt);
1786}
1787
1788/* Receive a file-list index using a byte-reduction method. */
1789int32 read_ndx(int f)
1790{
1791 static int32 prev_positive = -1, prev_negative = 1;
1792 int32 *prev_ptr, num;
1793 char b[4];
1794
1795 if (protocol_version < 30)
1796 return read_int(f);
1797
1798 readfd(f, b, 1);
1799 if (CVAL(b, 0) == 0xFF) {
1800 readfd(f, b, 1);
1801 prev_ptr = &prev_negative;
1802 } else if (CVAL(b, 0) == 0)
1803 return NDX_DONE;
1804 else
1805 prev_ptr = &prev_positive;
1806 if (CVAL(b, 0) == 0xFE) {
1807 readfd(f, b, 2);
1808 if (CVAL(b, 0) & 0x80) {
351e23ad
WD
1809 b[3] = CVAL(b, 0) & ~0x80;
1810 b[0] = b[1];
1811 readfd(f, b+1, 2);
1812 num = IVAL(b, 0);
8a65e0ce 1813 } else
351e23ad 1814 num = (UVAL(b,0)<<8) + UVAL(b,1) + *prev_ptr;
8a65e0ce 1815 } else
351e23ad 1816 num = UVAL(b, 0) + *prev_ptr;
8a65e0ce
WD
1817 *prev_ptr = num;
1818 if (prev_ptr == &prev_negative)
1819 num = -num;
1820 return num;
1821}
1822
67b8f3df
WD
1823/* Read a line of up to bufsiz-1 characters into buf. Strips
1824 * the (required) trailing newline and all carriage returns.
1825 * Returns 1 for success; 0 for I/O error or truncation. */
1826int read_line_old(int f, char *buf, size_t bufsiz)
f0fca04e 1827{
67b8f3df
WD
1828 bufsiz--; /* leave room for the null */
1829 while (bufsiz > 0) {
528bfcd7 1830 buf[0] = 0;
f0fca04e 1831 read_buf(f, buf, 1);
914cc65c
MP
1832 if (buf[0] == 0)
1833 return 0;
6ed6d7f5 1834 if (buf[0] == '\n')
f0fca04e 1835 break;
f0fca04e
AT
1836 if (buf[0] != '\r') {
1837 buf++;
67b8f3df 1838 bufsiz--;
f0fca04e
AT
1839 }
1840 }
6ed6d7f5 1841 *buf = '\0';
67b8f3df 1842 return bufsiz > 0;
f0fca04e
AT
1843}
1844
f0fca04e
AT
1845void io_printf(int fd, const char *format, ...)
1846{
d62bcc17 1847 va_list ap;
33544bf4 1848 char buf[BIGPATHBUFLEN];
f0fca04e 1849 int len;
3151cbae 1850
f0fca04e 1851 va_start(ap, format);
3151cbae 1852 len = vsnprintf(buf, sizeof buf, format, ap);
f0fca04e
AT
1853 va_end(ap);
1854
f89b9368
WD
1855 if (len < 0)
1856 exit_cleanup(RERR_STREAMIO);
f0fca04e 1857
33544bf4
WD
1858 if (len > (int)sizeof buf) {
1859 rprintf(FERROR, "io_printf() was too long for the buffer.\n");
1860 exit_cleanup(RERR_STREAMIO);
1861 }
1862
f0fca04e
AT
1863 write_sbuf(fd, buf);
1864}
8d9dc9f9 1865
d17e1dd2 1866/** Setup for multiplexing a MSG_* stream with the data stream. */
1f75bb10 1867void io_start_multiplex_out(void)
8d9dc9f9 1868{
d17e1dd2 1869 io_flush(NORMAL_FLUSH);
8ef246e0 1870 io_start_buffering_out(sock_f_out);
8d9dc9f9
AT
1871 io_multiplexing_out = 1;
1872}
1873
d17e1dd2 1874/** Setup for multiplexing a MSG_* stream with the data stream. */
1f75bb10 1875void io_start_multiplex_in(void)
8d9dc9f9 1876{
d17e1dd2 1877 io_flush(NORMAL_FLUSH);
8ef246e0 1878 io_start_buffering_in(sock_f_in);
8d9dc9f9
AT
1879 io_multiplexing_in = 1;
1880}
1881
d17e1dd2 1882/** Write an message to the multiplexed data stream. */
332cf6df 1883int io_multiplex_write(enum msgcode code, const char *buf, size_t len, int convert)
8d9dc9f9 1884{
f89b9368
WD
1885 if (!io_multiplexing_out)
1886 return 0;
d17e1dd2 1887 io_flush(NORMAL_FLUSH);
1b7c47cb 1888 stats.total_written += (len+4);
332cf6df 1889 mplex_write(sock_f_out, code, buf, len, convert);
8d9dc9f9
AT
1890 return 1;
1891}
1892
8ef246e0 1893void io_end_multiplex_in(void)
7f459268
WD
1894{
1895 io_multiplexing_in = 0;
8ef246e0 1896 io_end_buffering_in();
7f459268
WD
1897}
1898
d17e1dd2 1899/** Stop output multiplexing. */
8ef246e0 1900void io_end_multiplex_out(void)
554e0a8d
AT
1901{
1902 io_multiplexing_out = 0;
8ef246e0 1903 io_end_buffering_out();
554e0a8d
AT
1904}
1905
b9f592fb
WD
1906void start_write_batch(int fd)
1907{
1908 /* Some communication has already taken place, but we don't
1909 * enable batch writing until here so that we can write a
1910 * canonical record of the communication even though the
1911 * actual communication so far depends on whether a daemon
1912 * is involved. */
1913 write_int(batch_fd, protocol_version);
71456d30
WD
1914 if (protocol_version >= 30)
1915 write_byte(batch_fd, inc_recurse);
b9f592fb 1916 write_int(batch_fd, checksum_seed);
b9f592fb
WD
1917
1918 if (am_sender)
1919 write_batch_monitor_out = fd;
1920 else
1921 write_batch_monitor_in = fd;
1922}
1923
1924void stop_write_batch(void)
1925{
1926 write_batch_monitor_out = -1;
1927 write_batch_monitor_in = -1;
1928}