Commit | Line | Data |
---|---|---|
7a24c346 | 1 | /* -*- c-file-style: "linux" -*- |
880da007 MP |
2 | * |
3 | * Copyright (C) 1996-2001 by Andrew Tridgell | |
4 | * Copyright (C) Paul Mackerras 1996 | |
5 | * Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org> | |
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 | |
18 | * along with this program; if not, write to the Free Software | |
19 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. | |
20 | */ | |
720b47f2 | 21 | |
87ee2481 | 22 | /** |
87ee2481 MP |
23 | * @file io.c |
24 | * | |
25 | * Socket and pipe IO utilities used in rsync. | |
26 | * | |
27 | * rsync provides its own multiplexing system, which is used to send | |
28 | * stderr and stdout over a single socket. We need this because | |
29 | * stdout normally carries the binary data stream, and stderr all our | |
30 | * error messages. | |
31 | * | |
32 | * For historical reasons this is off during the start of the | |
33 | * connection, but it's switched on quite early using | |
34 | * io_start_multiplex_out() and io_start_multiplex_in(). | |
35 | **/ | |
720b47f2 | 36 | |
720b47f2 AT |
37 | #include "rsync.h" |
38 | ||
880da007 | 39 | /** If no timeout is specified then use a 60 second select timeout */ |
8cd9fd4e AT |
40 | #define SELECT_TIMEOUT 60 |
41 | ||
8d9dc9f9 AT |
42 | static int io_multiplexing_out; |
43 | static int io_multiplexing_in; | |
679e7657 AT |
44 | static int multiplex_in_fd; |
45 | static int multiplex_out_fd; | |
8d9dc9f9 | 46 | static time_t last_io; |
7a55d06e MP |
47 | static int no_flush; |
48 | ||
49 | extern int bwlimit; | |
720b47f2 | 50 | extern int verbose; |
6ba9279f | 51 | extern int io_timeout; |
a800434a | 52 | extern struct stats stats; |
720b47f2 | 53 | |
7a55d06e | 54 | |
a86179f4 | 55 | const char phase_unknown[] = "unknown"; |
805edf9d | 56 | |
98b332ed MP |
57 | /** |
58 | * The connection might be dropped at some point; perhaps because the | |
59 | * remote instance crashed. Just giving the offset on the stream is | |
60 | * not very helpful. So instead we try to make io_phase_name point to | |
61 | * something useful. | |
eca2adb4 | 62 | * |
805edf9d MP |
63 | * For buffered/multiplexed IO these names will be somewhat |
64 | * approximate; perhaps for ease of support we would rather make the | |
65 | * buffer always flush when a single application-level IO finishes. | |
66 | * | |
eca2adb4 MP |
67 | * @todo Perhaps we want some simple stack functionality, but there's |
68 | * no need to overdo it. | |
98b332ed | 69 | **/ |
805edf9d MP |
70 | const char *io_write_phase = phase_unknown; |
71 | const char *io_read_phase = phase_unknown; | |
98b332ed | 72 | |
7a55d06e MP |
73 | /** Ignore EOF errors while reading a module listing if the remote |
74 | version is 24 or less. */ | |
75 | int kludge_around_eof = False; | |
76 | ||
77 | ||
554e0a8d | 78 | static int io_error_fd = -1; |
56014c8c WD |
79 | static int io_filesfrom_f_in = -1; |
80 | static int io_filesfrom_f_out = -1; | |
81 | static char io_filesfrom_buf[2048]; | |
82 | static char *io_filesfrom_bp; | |
83 | static char io_filesfrom_lastchar; | |
84 | static int io_filesfrom_buflen; | |
720b47f2 | 85 | |
9dd891bb | 86 | static void read_loop(int fd, char *buf, size_t len); |
ff41a59f | 87 | |
8d9dc9f9 AT |
88 | static void check_timeout(void) |
89 | { | |
0adb99b9 | 90 | extern int am_server, am_daemon; |
8d9dc9f9 | 91 | time_t t; |
90ba34e2 AT |
92 | |
93 | err_list_push(); | |
3151cbae | 94 | |
8d9dc9f9 AT |
95 | if (!io_timeout) return; |
96 | ||
97 | if (!last_io) { | |
98 | last_io = time(NULL); | |
99 | return; | |
100 | } | |
101 | ||
102 | t = time(NULL); | |
103 | ||
86ffe37f | 104 | if (last_io && io_timeout && (t-last_io) >= io_timeout) { |
0adb99b9 | 105 | if (!am_server && !am_daemon) { |
ce6c7c63 | 106 | rprintf(FERROR,"io timeout after %d seconds - exiting\n", |
0adb99b9 AT |
107 | (int)(t-last_io)); |
108 | } | |
65417579 | 109 | exit_cleanup(RERR_TIMEOUT); |
8d9dc9f9 AT |
110 | } |
111 | } | |
112 | ||
c979dad5 | 113 | /** Setup the fd used to propagate errors */ |
554e0a8d AT |
114 | void io_set_error_fd(int fd) |
115 | { | |
116 | io_error_fd = fd; | |
117 | } | |
118 | ||
880da007 | 119 | /** Read some data from the error fd and write it to the write log code */ |
554e0a8d AT |
120 | static void read_error_fd(void) |
121 | { | |
122 | char buf[200]; | |
06ce139f | 123 | size_t n; |
554e0a8d | 124 | int fd = io_error_fd; |
ff41a59f AT |
125 | int tag, len; |
126 | ||
56014c8c WD |
127 | /* io_error_fd is temporarily disabled -- is this meant to |
128 | * prevent indefinite recursion? */ | |
554e0a8d AT |
129 | io_error_fd = -1; |
130 | ||
ff41a59f AT |
131 | read_loop(fd, buf, 4); |
132 | tag = IVAL(buf, 0); | |
133 | ||
134 | len = tag & 0xFFFFFF; | |
135 | tag = tag >> 24; | |
136 | tag -= MPLEX_BASE; | |
137 | ||
138 | while (len) { | |
139 | n = len; | |
3151cbae WD |
140 | if (n > (sizeof buf - 1)) |
141 | n = sizeof buf - 1; | |
ff41a59f AT |
142 | read_loop(fd, buf, n); |
143 | rwrite((enum logcode)tag, buf, n); | |
144 | len -= n; | |
554e0a8d AT |
145 | } |
146 | ||
147 | io_error_fd = fd; | |
148 | } | |
149 | ||
56014c8c WD |
150 | /** |
151 | * When we're the receiver and we have a local --files-from list of names | |
152 | * that needs to be sent over the socket to the sender, we have to do two | |
153 | * things at the same time: send the sender a list of what files we're | |
154 | * processing and read the incoming file+info list from the sender. We do | |
155 | * this by augmenting the read_timeout() function to copy this data. It | |
156 | * uses the io_filesfrom_buf to read a block of data from f_in (when it is | |
157 | * ready, since it might be a pipe) and then blast it out f_out (when it | |
158 | * is ready to receive more data). | |
159 | */ | |
160 | void io_set_filesfrom_fds(int f_in, int f_out) | |
161 | { | |
162 | io_filesfrom_f_in = f_in; | |
163 | io_filesfrom_f_out = f_out; | |
164 | io_filesfrom_bp = io_filesfrom_buf; | |
165 | io_filesfrom_lastchar = '\0'; | |
166 | io_filesfrom_buflen = 0; | |
167 | } | |
720b47f2 | 168 | |
880da007 MP |
169 | /** |
170 | * It's almost always an error to get an EOF when we're trying to read | |
171 | * from the network, because the protocol is self-terminating. | |
172 | * | |
173 | * However, there is one unfortunate cases where it is not, which is | |
174 | * rsync <2.4.6 sending a list of modules on a server, since the list | |
175 | * is terminated by closing the socket. So, for the section of the | |
176 | * program where that is a problem (start_socket_client), | |
177 | * kludge_around_eof is True and we just exit. | |
178 | */ | |
3151cbae | 179 | static void whine_about_eof(void) |
7a55d06e | 180 | { |
7a55d06e | 181 | if (kludge_around_eof) |
3151cbae | 182 | exit_cleanup(0); |
7a55d06e | 183 | else { |
3151cbae WD |
184 | rprintf(FERROR, |
185 | "%s: connection unexpectedly closed " | |
186 | "(%.0f bytes read so far)\n", | |
187 | RSYNC_NAME, (double)stats.total_read); | |
188 | ||
189 | exit_cleanup(RERR_STREAMIO); | |
7a55d06e MP |
190 | } |
191 | } | |
720b47f2 | 192 | |
7a55d06e | 193 | |
3151cbae | 194 | static void die_from_readerr(int err) |
7a55d06e MP |
195 | { |
196 | /* this prevents us trying to write errors on a dead socket */ | |
197 | io_multiplexing_close(); | |
3151cbae | 198 | |
7a55d06e | 199 | rprintf(FERROR, "%s: read error: %s\n", |
3151cbae | 200 | RSYNC_NAME, strerror(err)); |
7a55d06e MP |
201 | exit_cleanup(RERR_STREAMIO); |
202 | } | |
203 | ||
204 | ||
880da007 | 205 | /** |
c3563c46 MP |
206 | * Read from a socket with IO timeout. return the number of bytes |
207 | * read. If no bytes can be read then exit, never return a number <= 0. | |
208 | * | |
8886f8d0 MP |
209 | * TODO: If the remote shell connection fails, then current versions |
210 | * actually report an "unexpected EOF" error here. Since it's a | |
211 | * fairly common mistake to try to use rsh when ssh is required, we | |
212 | * should trap that: if we fail to read any data at all, we should | |
213 | * give a better explanation. We can tell whether the connection has | |
214 | * started by looking e.g. at whether the remote version is known yet. | |
c3563c46 | 215 | */ |
3151cbae | 216 | static int read_timeout(int fd, char *buf, size_t len) |
8d9dc9f9 | 217 | { |
4c36ddbe AT |
218 | int n, ret=0; |
219 | ||
ea2111d1 AT |
220 | io_flush(); |
221 | ||
4c36ddbe | 222 | while (ret == 0) { |
7a55d06e | 223 | /* until we manage to read *something* */ |
56014c8c | 224 | fd_set r_fds, w_fds; |
4c36ddbe | 225 | struct timeval tv; |
554e0a8d | 226 | int fd_count = fd+1; |
a57873b7 | 227 | int count; |
4c36ddbe | 228 | |
56014c8c WD |
229 | FD_ZERO(&r_fds); |
230 | FD_SET(fd, &r_fds); | |
554e0a8d | 231 | if (io_error_fd != -1) { |
56014c8c WD |
232 | FD_SET(io_error_fd, &r_fds); |
233 | if (io_error_fd >= fd_count) fd_count = io_error_fd+1; | |
234 | } | |
235 | if (io_filesfrom_f_out != -1) { | |
236 | int new_fd; | |
237 | if (io_filesfrom_buflen == 0) { | |
238 | if (io_filesfrom_f_in != -1) { | |
239 | FD_SET(io_filesfrom_f_in, &r_fds); | |
240 | new_fd = io_filesfrom_f_in; | |
241 | } else { | |
242 | io_filesfrom_f_out = -1; | |
243 | new_fd = -1; | |
244 | } | |
245 | } else { | |
246 | FD_ZERO(&w_fds); | |
247 | FD_SET(io_filesfrom_f_out, &w_fds); | |
248 | new_fd = io_filesfrom_f_out; | |
249 | } | |
250 | if (new_fd >= fd_count) fd_count = new_fd+1; | |
554e0a8d AT |
251 | } |
252 | ||
8cd9fd4e | 253 | tv.tv_sec = io_timeout?io_timeout:SELECT_TIMEOUT; |
4c36ddbe AT |
254 | tv.tv_usec = 0; |
255 | ||
554e0a8d AT |
256 | errno = 0; |
257 | ||
56014c8c WD |
258 | count = select(fd_count, &r_fds, |
259 | io_filesfrom_buflen? &w_fds : NULL, | |
260 | NULL, &tv); | |
a57873b7 AT |
261 | |
262 | if (count == 0) { | |
263 | check_timeout(); | |
264 | } | |
265 | ||
266 | if (count <= 0) { | |
554e0a8d AT |
267 | if (errno == EBADF) { |
268 | exit_cleanup(RERR_SOCKETIO); | |
269 | } | |
4c36ddbe AT |
270 | continue; |
271 | } | |
272 | ||
56014c8c WD |
273 | |
274 | if (io_error_fd != -1 && FD_ISSET(io_error_fd, &r_fds)) { | |
554e0a8d AT |
275 | read_error_fd(); |
276 | } | |
277 | ||
56014c8c WD |
278 | if (io_filesfrom_f_out != -1) { |
279 | if (io_filesfrom_buflen) { | |
280 | if (FD_ISSET(io_filesfrom_f_out, &w_fds)) { | |
281 | int l = write(io_filesfrom_f_out, | |
282 | io_filesfrom_bp, | |
283 | io_filesfrom_buflen); | |
284 | if (l > 0) { | |
285 | if (!(io_filesfrom_buflen -= l)) | |
286 | io_filesfrom_bp = io_filesfrom_buf; | |
287 | else | |
288 | io_filesfrom_bp += l; | |
289 | } else { | |
290 | /* XXX should we complain? */ | |
291 | io_filesfrom_f_out = -1; | |
292 | } | |
293 | } | |
294 | } else if (io_filesfrom_f_in != -1) { | |
295 | if (FD_ISSET(io_filesfrom_f_in, &r_fds)) { | |
296 | int l = read(io_filesfrom_f_in, | |
297 | io_filesfrom_buf, | |
298 | sizeof io_filesfrom_buf); | |
299 | if (l <= 0) { | |
300 | /* Send end-of-file marker */ | |
301 | io_filesfrom_buf[0] = '\0'; | |
302 | io_filesfrom_buf[1] = '\0'; | |
303 | io_filesfrom_buflen = io_filesfrom_lastchar? 2 : 1; | |
304 | io_filesfrom_f_in = -1; | |
305 | } else { | |
306 | extern int eol_nulls; | |
307 | if (!eol_nulls) { | |
308 | char *s = io_filesfrom_buf + l; | |
309 | /* Transform CR and/or LF into '\0' */ | |
310 | while (s-- > io_filesfrom_buf) { | |
311 | if (*s == '\n' || *s == '\r') | |
312 | *s = '\0'; | |
313 | } | |
314 | } | |
315 | if (!io_filesfrom_lastchar) { | |
316 | /* Last buf ended with a '\0', so don't | |
317 | * let this buf start with one. */ | |
318 | while (l && !*io_filesfrom_bp) | |
319 | io_filesfrom_bp++, l--; | |
320 | } | |
321 | if (!l) | |
322 | io_filesfrom_bp = io_filesfrom_buf; | |
323 | else { | |
324 | char *f = io_filesfrom_bp; | |
325 | char *t = f; | |
326 | char *eob = f + l; | |
327 | /* Eliminate any multi-'\0' runs. */ | |
328 | while (f != eob) { | |
329 | if (!(*t++ = *f++)) { | |
330 | while (f != eob && !*f) | |
331 | f++, l--; | |
332 | } | |
333 | } | |
334 | io_filesfrom_lastchar = f[-1]; | |
335 | } | |
336 | io_filesfrom_buflen = l; | |
337 | } | |
338 | } | |
339 | } | |
340 | } | |
341 | ||
342 | if (!FD_ISSET(fd, &r_fds)) continue; | |
554e0a8d | 343 | |
4c36ddbe AT |
344 | n = read(fd, buf, len); |
345 | ||
8d9dc9f9 AT |
346 | if (n > 0) { |
347 | buf += n; | |
348 | len -= n; | |
4c36ddbe AT |
349 | ret += n; |
350 | if (io_timeout) | |
351 | last_io = time(NULL); | |
352 | continue; | |
7a55d06e | 353 | } else if (n == 0) { |
3151cbae | 354 | whine_about_eof(); |
7a55d06e MP |
355 | return -1; /* doesn't return */ |
356 | } else if (n == -1) { | |
357 | if (errno == EINTR || errno == EWOULDBLOCK || | |
358 | errno == EAGAIN) | |
359 | continue; | |
3151cbae | 360 | die_from_readerr(errno); |
8d9dc9f9 | 361 | } |
4c36ddbe | 362 | } |
8d9dc9f9 | 363 | |
4c36ddbe AT |
364 | return ret; |
365 | } | |
8d9dc9f9 | 366 | |
56014c8c WD |
367 | /** |
368 | * Read a line into the "fname" buffer (which must be at least MAXPATHLEN | |
369 | * characters long). | |
370 | */ | |
371 | int read_filesfrom_line(int fd, char *fname) | |
372 | { | |
373 | char ch, *s, *eob = fname + MAXPATHLEN - 1; | |
374 | int cnt; | |
375 | extern int io_timeout; | |
376 | extern int eol_nulls; | |
377 | extern char *remote_filesfrom_file; | |
378 | extern int am_server; | |
379 | int reading_remotely = remote_filesfrom_file || (am_server && fd == 0); | |
380 | int nulls = eol_nulls || reading_remotely; | |
381 | ||
382 | start: | |
383 | s = fname; | |
384 | while (1) { | |
385 | cnt = read(fd, &ch, 1); | |
386 | if (cnt < 0 && (errno == EWOULDBLOCK | |
387 | || errno == EINTR || errno == EAGAIN)) { | |
388 | struct timeval tv; | |
389 | fd_set fds; | |
390 | FD_ZERO(&fds); | |
391 | FD_SET(fd, &fds); | |
392 | tv.tv_sec = io_timeout? io_timeout : SELECT_TIMEOUT; | |
393 | tv.tv_usec = 0; | |
394 | if (!select(fd+1, &fds, NULL, NULL, &tv)) | |
395 | check_timeout(); | |
396 | continue; | |
397 | } | |
398 | if (cnt != 1) | |
399 | break; | |
400 | if (nulls? !ch : (ch == '\r' || ch == '\n')) { | |
401 | /* Skip empty lines if reading locally. */ | |
402 | if (!reading_remotely && s == fname) | |
403 | continue; | |
404 | break; | |
405 | } | |
406 | if (s < eob) | |
407 | *s++ = ch; | |
408 | } | |
409 | *s = '\0'; | |
7a55d06e | 410 | |
56014c8c WD |
411 | /* Dump comments. */ |
412 | if (*fname == '#' || *fname == ';') | |
413 | goto start; | |
414 | ||
415 | return s - fname; | |
416 | } | |
7a55d06e MP |
417 | |
418 | ||
880da007 MP |
419 | /** |
420 | * Continue trying to read len bytes - don't return until len has been | |
421 | * read. | |
422 | **/ | |
3151cbae | 423 | static void read_loop(int fd, char *buf, size_t len) |
4c36ddbe AT |
424 | { |
425 | while (len) { | |
426 | int n = read_timeout(fd, buf, len); | |
427 | ||
428 | buf += n; | |
429 | len -= n; | |
8d9dc9f9 AT |
430 | } |
431 | } | |
432 | ||
7a55d06e MP |
433 | |
434 | /** | |
435 | * Read from the file descriptor handling multiplexing - return number | |
436 | * of bytes read. | |
437 | * | |
438 | * Never returns <= 0. | |
439 | */ | |
9dd891bb | 440 | static int read_unbuffered(int fd, char *buf, size_t len) |
8d9dc9f9 | 441 | { |
6fe25398 | 442 | static size_t remaining; |
909ce14f | 443 | int tag, ret = 0; |
8d9dc9f9 AT |
444 | char line[1024]; |
445 | ||
7a55d06e | 446 | if (!io_multiplexing_in || fd != multiplex_in_fd) |
4c36ddbe | 447 | return read_timeout(fd, buf, len); |
8d9dc9f9 AT |
448 | |
449 | while (ret == 0) { | |
450 | if (remaining) { | |
451 | len = MIN(len, remaining); | |
452 | read_loop(fd, buf, len); | |
453 | remaining -= len; | |
454 | ret = len; | |
455 | continue; | |
456 | } | |
457 | ||
909ce14f | 458 | read_loop(fd, line, 4); |
ff41a59f | 459 | tag = IVAL(line, 0); |
679e7657 | 460 | |
8d9dc9f9 AT |
461 | remaining = tag & 0xFFFFFF; |
462 | tag = tag >> 24; | |
463 | ||
909ce14f MP |
464 | if (tag == MPLEX_BASE) |
465 | continue; | |
8d9dc9f9 AT |
466 | |
467 | tag -= MPLEX_BASE; | |
468 | ||
469 | if (tag != FERROR && tag != FINFO) { | |
909ce14f | 470 | rprintf(FERROR, "unexpected tag %d\n", tag); |
65417579 | 471 | exit_cleanup(RERR_STREAMIO); |
8d9dc9f9 AT |
472 | } |
473 | ||
3151cbae | 474 | if (remaining > sizeof line - 1) { |
8801138b WD |
475 | rprintf(FERROR, "multiplexing overflow %ld\n\n", |
476 | (long)remaining); | |
65417579 | 477 | exit_cleanup(RERR_STREAMIO); |
8d9dc9f9 AT |
478 | } |
479 | ||
480 | read_loop(fd, line, remaining); | |
481 | line[remaining] = 0; | |
482 | ||
909ce14f | 483 | rprintf((enum logcode) tag, "%s", line); |
8d9dc9f9 AT |
484 | remaining = 0; |
485 | } | |
486 | ||
487 | return ret; | |
488 | } | |
489 | ||
490 | ||
909ce14f | 491 | |
880da007 MP |
492 | /** |
493 | * Do a buffered read from @p fd. Don't return until all @p n bytes | |
494 | * have been read. If all @p n can't be read then exit with an | |
495 | * error. | |
496 | **/ | |
3151cbae | 497 | static void readfd(int fd, char *buffer, size_t N) |
720b47f2 | 498 | { |
6ba9279f | 499 | int ret; |
06ce139f | 500 | size_t total=0; |
3151cbae | 501 | |
6ba9279f | 502 | while (total < N) { |
8d9dc9f9 AT |
503 | io_flush(); |
504 | ||
3151cbae | 505 | ret = read_unbuffered(fd, buffer + total, N-total); |
6ba9279f | 506 | total += ret; |
7f28dbee | 507 | } |
1b7c47cb AT |
508 | |
509 | stats.total_read += total; | |
720b47f2 AT |
510 | } |
511 | ||
512 | ||
b7922338 | 513 | int32 read_int(int f) |
720b47f2 | 514 | { |
4c36ddbe | 515 | char b[4]; |
d730b113 AT |
516 | int32 ret; |
517 | ||
4c36ddbe | 518 | readfd(f,b,4); |
d730b113 AT |
519 | ret = IVAL(b,0); |
520 | if (ret == (int32)0xffffffff) return -1; | |
521 | return ret; | |
720b47f2 AT |
522 | } |
523 | ||
71c46176 | 524 | int64 read_longint(int f) |
3a6a366f | 525 | { |
71c46176 | 526 | int64 ret; |
3a6a366f AT |
527 | char b[8]; |
528 | ret = read_int(f); | |
71c46176 | 529 | |
8de330a3 AT |
530 | if ((int32)ret != (int32)0xffffffff) { |
531 | return ret; | |
532 | } | |
71c46176 | 533 | |
3bee6733 | 534 | #ifdef NO_INT64 |
9486289c | 535 | rprintf(FERROR,"Integer overflow - attempted 64 bit offset\n"); |
65417579 | 536 | exit_cleanup(RERR_UNSUPPORTED); |
71c46176 | 537 | #else |
91c4da3f S |
538 | readfd(f,b,8); |
539 | ret = IVAL(b,0) | (((int64)IVAL(b,4))<<32); | |
71c46176 AT |
540 | #endif |
541 | ||
3a6a366f AT |
542 | return ret; |
543 | } | |
544 | ||
9dd891bb | 545 | void read_buf(int f,char *buf,size_t len) |
720b47f2 | 546 | { |
4c36ddbe | 547 | readfd(f,buf,len); |
720b47f2 AT |
548 | } |
549 | ||
9dd891bb | 550 | void read_sbuf(int f,char *buf,size_t len) |
575f2fca | 551 | { |
3151cbae | 552 | read_buf(f,buf,len); |
575f2fca AT |
553 | buf[len] = 0; |
554 | } | |
555 | ||
182dca5c AT |
556 | unsigned char read_byte(int f) |
557 | { | |
4c36ddbe | 558 | unsigned char c; |
3151cbae | 559 | read_buf(f, (char *)&c, 1); |
4c36ddbe | 560 | return c; |
182dca5c | 561 | } |
720b47f2 | 562 | |
880da007 | 563 | |
08571358 MP |
564 | /** |
565 | * Sleep after writing to limit I/O bandwidth usage. | |
566 | * | |
567 | * @todo Rather than sleeping after each write, it might be better to | |
568 | * use some kind of averaging. The current algorithm seems to always | |
569 | * use a bit less bandwidth than specified, because it doesn't make up | |
570 | * for slow periods. But arguably this is a feature. In addition, we | |
571 | * ought to take the time used to write the data into account. | |
572 | **/ | |
573 | static void sleep_for_bwlimit(int bytes_written) | |
574 | { | |
575 | struct timeval tv; | |
576 | ||
577 | if (!bwlimit) | |
578 | return; | |
e681e820 MP |
579 | |
580 | assert(bytes_written > 0); | |
581 | assert(bwlimit > 0); | |
3151cbae | 582 | |
08571358 | 583 | tv.tv_usec = bytes_written * 1000 / bwlimit; |
e681e820 MP |
584 | tv.tv_sec = tv.tv_usec / 1000000; |
585 | tv.tv_usec = tv.tv_usec % 1000000; | |
08571358 | 586 | |
98b332ed | 587 | select(0, NULL, NULL, NULL, &tv); |
08571358 MP |
588 | } |
589 | ||
590 | ||
880da007 MP |
591 | /** |
592 | * Write len bytes to the file descriptor @p fd. | |
593 | * | |
594 | * This function underlies the multiplexing system. The body of the | |
595 | * application never calls this function directly. | |
596 | **/ | |
9dd891bb | 597 | static void writefd_unbuffered(int fd,char *buf,size_t len) |
720b47f2 | 598 | { |
06ce139f | 599 | size_t total = 0; |
8d9dc9f9 | 600 | fd_set w_fds, r_fds; |
4c36ddbe | 601 | int fd_count, count; |
8d9dc9f9 | 602 | struct timeval tv; |
720b47f2 | 603 | |
90ba34e2 AT |
604 | err_list_push(); |
605 | ||
e44f9a12 AT |
606 | no_flush++; |
607 | ||
4c36ddbe | 608 | while (total < len) { |
8d9dc9f9 | 609 | FD_ZERO(&w_fds); |
8d9dc9f9 | 610 | FD_SET(fd,&w_fds); |
554e0a8d | 611 | fd_count = fd; |
4c36ddbe | 612 | |
554e0a8d | 613 | if (io_error_fd != -1) { |
56014c8c | 614 | FD_ZERO(&r_fds); |
554e0a8d AT |
615 | FD_SET(io_error_fd,&r_fds); |
616 | if (io_error_fd > fd_count) | |
617 | fd_count = io_error_fd; | |
8d9dc9f9 AT |
618 | } |
619 | ||
8cd9fd4e | 620 | tv.tv_sec = io_timeout?io_timeout:SELECT_TIMEOUT; |
8d9dc9f9 | 621 | tv.tv_usec = 0; |
4c36ddbe | 622 | |
554e0a8d AT |
623 | errno = 0; |
624 | ||
625 | count = select(fd_count+1, | |
08f15335 | 626 | io_error_fd != -1?&r_fds:NULL, |
4c36ddbe | 627 | &w_fds,NULL, |
8cd9fd4e | 628 | &tv); |
4c36ddbe | 629 | |
a57873b7 AT |
630 | if (count == 0) { |
631 | check_timeout(); | |
632 | } | |
633 | ||
4c36ddbe | 634 | if (count <= 0) { |
554e0a8d AT |
635 | if (errno == EBADF) { |
636 | exit_cleanup(RERR_SOCKETIO); | |
637 | } | |
8d9dc9f9 AT |
638 | continue; |
639 | } | |
4c36ddbe | 640 | |
554e0a8d AT |
641 | if (io_error_fd != -1 && FD_ISSET(io_error_fd, &r_fds)) { |
642 | read_error_fd(); | |
643 | } | |
644 | ||
8d9dc9f9 | 645 | if (FD_ISSET(fd, &w_fds)) { |
06ce139f MP |
646 | int ret; |
647 | size_t n = len-total; | |
f0359dd0 | 648 | ret = write(fd,buf+total,n); |
4c36ddbe AT |
649 | |
650 | if (ret == -1 && errno == EINTR) { | |
651 | continue; | |
652 | } | |
653 | ||
f0359dd0 AT |
654 | if (ret == -1 && |
655 | (errno == EWOULDBLOCK || errno == EAGAIN)) { | |
e92ee128 | 656 | msleep(1); |
f0359dd0 AT |
657 | continue; |
658 | } | |
659 | ||
4c36ddbe | 660 | if (ret <= 0) { |
befbfe61 MP |
661 | /* Don't try to write errors back |
662 | * across the stream */ | |
663 | io_multiplexing_close(); | |
3ce0f9a6 | 664 | rprintf(FERROR, RSYNC_NAME |
98b332ed | 665 | ": writefd_unbuffered failed to write %ld bytes: phase \"%s\": %s\n", |
eca2adb4 | 666 | (long) len, io_write_phase, |
ce6c7c63 | 667 | strerror(errno)); |
65417579 | 668 | exit_cleanup(RERR_STREAMIO); |
4c36ddbe AT |
669 | } |
670 | ||
08571358 | 671 | sleep_for_bwlimit(ret); |
ef5d23eb | 672 | |
4c36ddbe | 673 | total += ret; |
a800434a | 674 | |
4c36ddbe AT |
675 | if (io_timeout) |
676 | last_io = time(NULL); | |
8d9dc9f9 | 677 | } |
4c36ddbe | 678 | } |
e44f9a12 AT |
679 | |
680 | no_flush--; | |
720b47f2 AT |
681 | } |
682 | ||
8d9dc9f9 | 683 | |
d6dead6b AT |
684 | static char *io_buffer; |
685 | static int io_buffer_count; | |
686 | ||
687 | void io_start_buffering(int fd) | |
688 | { | |
8d9dc9f9 | 689 | if (io_buffer) return; |
679e7657 | 690 | multiplex_out_fd = fd; |
ff41a59f | 691 | io_buffer = (char *)malloc(IO_BUFFER_SIZE); |
d6dead6b AT |
692 | if (!io_buffer) out_of_memory("writefd"); |
693 | io_buffer_count = 0; | |
ff41a59f AT |
694 | } |
695 | ||
880da007 MP |
696 | /** |
697 | * Write an message to a multiplexed stream. If this fails then rsync | |
698 | * exits. | |
699 | **/ | |
9dd891bb | 700 | static void mplex_write(int fd, enum logcode code, char *buf, size_t len) |
ff41a59f AT |
701 | { |
702 | char buffer[4096]; | |
06ce139f | 703 | size_t n = len; |
8d9dc9f9 | 704 | |
ff41a59f AT |
705 | SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len); |
706 | ||
3151cbae WD |
707 | if (n > (sizeof buffer - 4)) { |
708 | n = sizeof buffer - 4; | |
ff41a59f AT |
709 | } |
710 | ||
711 | memcpy(&buffer[4], buf, n); | |
712 | writefd_unbuffered(fd, buffer, n+4); | |
713 | ||
714 | len -= n; | |
715 | buf += n; | |
716 | ||
6d7b6081 AT |
717 | if (len) { |
718 | writefd_unbuffered(fd, buf, len); | |
719 | } | |
d6dead6b AT |
720 | } |
721 | ||
ff41a59f | 722 | |
8d9dc9f9 | 723 | void io_flush(void) |
d6dead6b | 724 | { |
679e7657 | 725 | int fd = multiplex_out_fd; |
90ba34e2 AT |
726 | |
727 | err_list_push(); | |
728 | ||
e44f9a12 | 729 | if (!io_buffer_count || no_flush) return; |
8d9dc9f9 AT |
730 | |
731 | if (io_multiplexing_out) { | |
0f3203c3 | 732 | mplex_write(fd, FNONE, io_buffer, io_buffer_count); |
8d9dc9f9 | 733 | } else { |
4c36ddbe | 734 | writefd_unbuffered(fd, io_buffer, io_buffer_count); |
d6dead6b | 735 | } |
8d9dc9f9 AT |
736 | io_buffer_count = 0; |
737 | } | |
738 | ||
0ba48136 | 739 | |
7b5c3eb0 | 740 | void io_end_buffering(void) |
8d9dc9f9 AT |
741 | { |
742 | io_flush(); | |
743 | if (!io_multiplexing_out) { | |
ff41a59f | 744 | free(io_buffer); |
8d9dc9f9 AT |
745 | io_buffer = NULL; |
746 | } | |
d6dead6b AT |
747 | } |
748 | ||
9dd891bb | 749 | static void writefd(int fd,char *buf,size_t len) |
d6dead6b | 750 | { |
1b7c47cb AT |
751 | stats.total_written += len; |
752 | ||
90ba34e2 AT |
753 | err_list_push(); |
754 | ||
554e0a8d | 755 | if (!io_buffer || fd != multiplex_out_fd) { |
4c36ddbe AT |
756 | writefd_unbuffered(fd, buf, len); |
757 | return; | |
758 | } | |
d6dead6b AT |
759 | |
760 | while (len) { | |
7b5c3eb0 | 761 | int n = MIN((int) len, IO_BUFFER_SIZE-io_buffer_count); |
d6dead6b AT |
762 | if (n > 0) { |
763 | memcpy(io_buffer+io_buffer_count, buf, n); | |
764 | buf += n; | |
765 | len -= n; | |
766 | io_buffer_count += n; | |
767 | } | |
3151cbae | 768 | |
8d9dc9f9 | 769 | if (io_buffer_count == IO_BUFFER_SIZE) io_flush(); |
d6dead6b | 770 | } |
d6dead6b | 771 | } |
720b47f2 AT |
772 | |
773 | ||
b7922338 | 774 | void write_int(int f,int32 x) |
720b47f2 | 775 | { |
8d9dc9f9 AT |
776 | char b[4]; |
777 | SIVAL(b,0,x); | |
4c36ddbe | 778 | writefd(f,b,4); |
720b47f2 AT |
779 | } |
780 | ||
7a24c346 | 781 | |
805edf9d MP |
782 | void write_int_named(int f, int32 x, const char *phase) |
783 | { | |
784 | io_write_phase = phase; | |
785 | write_int(f, x); | |
786 | io_write_phase = phase_unknown; | |
787 | } | |
788 | ||
789 | ||
7a24c346 MP |
790 | /* |
791 | * Note: int64 may actually be a 32-bit type if ./configure couldn't find any | |
792 | * 64-bit types on this platform. | |
793 | */ | |
71c46176 | 794 | void write_longint(int f, int64 x) |
3a6a366f | 795 | { |
3a6a366f | 796 | char b[8]; |
3a6a366f | 797 | |
91c4da3f | 798 | if (x <= 0x7FFFFFFF) { |
3a6a366f AT |
799 | write_int(f, (int)x); |
800 | return; | |
801 | } | |
802 | ||
67863f46 S |
803 | #ifdef NO_INT64 |
804 | rprintf(FERROR,"Integer overflow - attempted 64 bit offset\n"); | |
805 | exit_cleanup(RERR_UNSUPPORTED); | |
806 | #else | |
8de330a3 | 807 | write_int(f, (int32)0xFFFFFFFF); |
3a6a366f AT |
808 | SIVAL(b,0,(x&0xFFFFFFFF)); |
809 | SIVAL(b,4,((x>>32)&0xFFFFFFFF)); | |
810 | ||
4c36ddbe | 811 | writefd(f,b,8); |
67863f46 | 812 | #endif |
3a6a366f AT |
813 | } |
814 | ||
9dd891bb | 815 | void write_buf(int f,char *buf,size_t len) |
720b47f2 | 816 | { |
4c36ddbe | 817 | writefd(f,buf,len); |
720b47f2 AT |
818 | } |
819 | ||
880da007 | 820 | /** Write a string to the connection */ |
6e4fb64e | 821 | static void write_sbuf(int f,char *buf) |
f0fca04e AT |
822 | { |
823 | write_buf(f, buf, strlen(buf)); | |
824 | } | |
825 | ||
720b47f2 | 826 | |
182dca5c AT |
827 | void write_byte(int f,unsigned char c) |
828 | { | |
f0fca04e | 829 | write_buf(f,(char *)&c,1); |
182dca5c AT |
830 | } |
831 | ||
7a55d06e MP |
832 | |
833 | ||
914cc65c MP |
834 | /** |
835 | * Read a line of up to @p maxlen characters into @p buf. Does not | |
836 | * contain a trailing newline or carriage return. | |
837 | * | |
838 | * @return 1 for success; 0 for io error or truncation. | |
839 | **/ | |
9dd891bb | 840 | int read_line(int f, char *buf, size_t maxlen) |
f0fca04e AT |
841 | { |
842 | while (maxlen) { | |
528bfcd7 | 843 | buf[0] = 0; |
f0fca04e | 844 | read_buf(f, buf, 1); |
914cc65c MP |
845 | if (buf[0] == 0) |
846 | return 0; | |
f0fca04e AT |
847 | if (buf[0] == '\n') { |
848 | buf[0] = 0; | |
849 | break; | |
850 | } | |
851 | if (buf[0] != '\r') { | |
852 | buf++; | |
853 | maxlen--; | |
854 | } | |
855 | } | |
856 | if (maxlen == 0) { | |
857 | *buf = 0; | |
858 | return 0; | |
859 | } | |
528bfcd7 | 860 | |
f0fca04e AT |
861 | return 1; |
862 | } | |
863 | ||
864 | ||
865 | void io_printf(int fd, const char *format, ...) | |
866 | { | |
867 | va_list ap; | |
868 | char buf[1024]; | |
869 | int len; | |
3151cbae | 870 | |
f0fca04e | 871 | va_start(ap, format); |
3151cbae | 872 | len = vsnprintf(buf, sizeof buf, format, ap); |
f0fca04e AT |
873 | va_end(ap); |
874 | ||
65417579 | 875 | if (len < 0) exit_cleanup(RERR_STREAMIO); |
f0fca04e AT |
876 | |
877 | write_sbuf(fd, buf); | |
878 | } | |
8d9dc9f9 AT |
879 | |
880 | ||
880da007 | 881 | /** Setup for multiplexing an error stream with the data stream */ |
8d9dc9f9 AT |
882 | void io_start_multiplex_out(int fd) |
883 | { | |
679e7657 AT |
884 | multiplex_out_fd = fd; |
885 | io_flush(); | |
8d9dc9f9 AT |
886 | io_start_buffering(fd); |
887 | io_multiplexing_out = 1; | |
888 | } | |
889 | ||
880da007 | 890 | /** Setup for multiplexing an error stream with the data stream */ |
8d9dc9f9 AT |
891 | void io_start_multiplex_in(int fd) |
892 | { | |
679e7657 AT |
893 | multiplex_in_fd = fd; |
894 | io_flush(); | |
8d9dc9f9 AT |
895 | io_multiplexing_in = 1; |
896 | } | |
897 | ||
880da007 | 898 | /** Write an message to the multiplexed error stream */ |
9dd891bb | 899 | int io_multiplex_write(enum logcode code, char *buf, size_t len) |
8d9dc9f9 AT |
900 | { |
901 | if (!io_multiplexing_out) return 0; | |
902 | ||
903 | io_flush(); | |
1b7c47cb | 904 | stats.total_written += (len+4); |
ff41a59f | 905 | mplex_write(multiplex_out_fd, code, buf, len); |
8d9dc9f9 AT |
906 | return 1; |
907 | } | |
908 | ||
880da007 | 909 | /** Stop output multiplexing */ |
554e0a8d AT |
910 | void io_multiplexing_close(void) |
911 | { | |
912 | io_multiplexing_out = 0; | |
913 | } | |
914 |