Commit | Line | Data |
---|---|---|
720b47f2 AT |
1 | /* |
2 | Copyright (C) Andrew Tridgell 1996 | |
3 | Copyright (C) Paul Mackerras 1996 | |
4 | ||
5 | This program is free software; you can redistribute it and/or modify | |
6 | it under the terms of the GNU General Public License as published by | |
7 | the Free Software Foundation; either version 2 of the License, or | |
8 | (at your option) any later version. | |
9 | ||
10 | This program is distributed in the hope that it will be useful, | |
11 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | GNU General Public License for more details. | |
14 | ||
15 | You should have received a copy of the GNU General Public License | |
16 | along with this program; if not, write to the Free Software | |
17 | Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. | |
18 | */ | |
19 | ||
20 | /* | |
21 | Utilities used in rsync | |
22 | ||
23 | tridge, June 1996 | |
24 | */ | |
25 | #include "rsync.h" | |
26 | ||
71c46176 AT |
27 | static int64 total_written; |
28 | static int64 total_read; | |
720b47f2 | 29 | |
8d9dc9f9 AT |
30 | static int io_multiplexing_out; |
31 | static int io_multiplexing_in; | |
679e7657 AT |
32 | static int multiplex_in_fd; |
33 | static int multiplex_out_fd; | |
8d9dc9f9 | 34 | static time_t last_io; |
528bfcd7 | 35 | static int eof_error=1; |
720b47f2 | 36 | extern int verbose; |
6ba9279f | 37 | extern int io_timeout; |
720b47f2 | 38 | |
528bfcd7 | 39 | |
71c46176 | 40 | int64 write_total(void) |
720b47f2 | 41 | { |
8d9dc9f9 | 42 | return total_written; |
720b47f2 AT |
43 | } |
44 | ||
71c46176 | 45 | int64 read_total(void) |
720b47f2 | 46 | { |
8d9dc9f9 | 47 | return total_read; |
720b47f2 AT |
48 | } |
49 | ||
50 | static int buffer_f_in = -1; | |
51 | ||
4c36ddbe | 52 | void setup_readbuffer(int f_in) |
720b47f2 | 53 | { |
22d6234e | 54 | buffer_f_in = f_in; |
720b47f2 AT |
55 | } |
56 | ||
8d9dc9f9 AT |
57 | static void check_timeout(void) |
58 | { | |
59 | time_t t; | |
60 | ||
61 | if (!io_timeout) return; | |
62 | ||
63 | if (!last_io) { | |
64 | last_io = time(NULL); | |
65 | return; | |
66 | } | |
67 | ||
68 | t = time(NULL); | |
69 | ||
70 | if (last_io && io_timeout && (t-last_io)>io_timeout) { | |
71 | rprintf(FERROR,"read timeout after %d second - exiting\n", | |
72 | (int)(t-last_io)); | |
73 | exit_cleanup(1); | |
74 | } | |
75 | } | |
76 | ||
720b47f2 | 77 | |
3a6a366f AT |
78 | static char *read_buffer; |
79 | static char *read_buffer_p; | |
80 | static int read_buffer_len; | |
81 | static int read_buffer_size; | |
720b47f2 | 82 | |
4c36ddbe AT |
83 | /* read from a socket with IO timeout. return the number of |
84 | bytes read. If no bytes can be read then exit, never return | |
85 | a number <= 0 */ | |
86 | static int read_timeout(int fd, char *buf, int len) | |
8d9dc9f9 | 87 | { |
4c36ddbe AT |
88 | int n, ret=0; |
89 | ||
ea2111d1 AT |
90 | io_flush(); |
91 | ||
4c36ddbe AT |
92 | while (ret == 0) { |
93 | fd_set fds; | |
94 | struct timeval tv; | |
95 | ||
96 | FD_ZERO(&fds); | |
97 | FD_SET(fd, &fds); | |
98 | tv.tv_sec = io_timeout; | |
99 | tv.tv_usec = 0; | |
100 | ||
101 | if (select(fd+1, &fds, NULL, NULL, | |
102 | io_timeout?&tv:NULL) != 1) { | |
103 | check_timeout(); | |
104 | continue; | |
105 | } | |
106 | ||
107 | n = read(fd, buf, len); | |
108 | ||
8d9dc9f9 AT |
109 | if (n > 0) { |
110 | buf += n; | |
111 | len -= n; | |
4c36ddbe AT |
112 | ret += n; |
113 | if (io_timeout) | |
114 | last_io = time(NULL); | |
115 | continue; | |
8d9dc9f9 | 116 | } |
4c36ddbe AT |
117 | |
118 | if (n == -1 && errno == EINTR) { | |
119 | continue; | |
120 | } | |
121 | ||
8d9dc9f9 | 122 | if (n == 0) { |
528bfcd7 AT |
123 | if (eof_error) { |
124 | rprintf(FERROR,"EOF in read_timeout\n"); | |
125 | } | |
8d9dc9f9 AT |
126 | exit_cleanup(1); |
127 | } | |
8d9dc9f9 | 128 | |
4c36ddbe AT |
129 | rprintf(FERROR,"read error: %s\n", strerror(errno)); |
130 | exit_cleanup(1); | |
131 | } | |
8d9dc9f9 | 132 | |
4c36ddbe AT |
133 | return ret; |
134 | } | |
8d9dc9f9 | 135 | |
4c36ddbe AT |
136 | /* continue trying to read len bytes - don't return until len |
137 | has been read */ | |
138 | static void read_loop(int fd, char *buf, int len) | |
139 | { | |
140 | while (len) { | |
141 | int n = read_timeout(fd, buf, len); | |
142 | ||
143 | buf += n; | |
144 | len -= n; | |
8d9dc9f9 AT |
145 | } |
146 | } | |
147 | ||
4c36ddbe AT |
148 | /* read from the file descriptor handing multiplexing - |
149 | return number of bytes read | |
150 | never return <= 0 */ | |
8d9dc9f9 AT |
151 | static int read_unbuffered(int fd, char *buf, int len) |
152 | { | |
153 | static int remaining; | |
154 | char ibuf[4]; | |
155 | int tag, ret=0; | |
156 | char line[1024]; | |
157 | ||
679e7657 | 158 | if (!io_multiplexing_in || fd != multiplex_in_fd) |
4c36ddbe | 159 | return read_timeout(fd, buf, len); |
8d9dc9f9 AT |
160 | |
161 | while (ret == 0) { | |
162 | if (remaining) { | |
163 | len = MIN(len, remaining); | |
164 | read_loop(fd, buf, len); | |
165 | remaining -= len; | |
166 | ret = len; | |
167 | continue; | |
168 | } | |
169 | ||
170 | read_loop(fd, ibuf, 4); | |
171 | tag = IVAL(ibuf, 0); | |
679e7657 | 172 | |
8d9dc9f9 AT |
173 | remaining = tag & 0xFFFFFF; |
174 | tag = tag >> 24; | |
175 | ||
176 | if (tag == MPLEX_BASE) continue; | |
177 | ||
178 | tag -= MPLEX_BASE; | |
179 | ||
180 | if (tag != FERROR && tag != FINFO) { | |
181 | rprintf(FERROR,"unexpected tag %d\n", tag); | |
182 | exit_cleanup(1); | |
183 | } | |
184 | ||
185 | if (remaining > sizeof(line)-1) { | |
186 | rprintf(FERROR,"multiplexing overflow %d\n\n", | |
187 | remaining); | |
188 | exit_cleanup(1); | |
189 | } | |
190 | ||
191 | read_loop(fd, line, remaining); | |
192 | line[remaining] = 0; | |
193 | ||
194 | rprintf(tag,"%s", line); | |
195 | remaining = 0; | |
196 | } | |
197 | ||
198 | return ret; | |
199 | } | |
200 | ||
201 | ||
4c36ddbe | 202 | |
720b47f2 AT |
203 | /* This function was added to overcome a deadlock problem when using |
204 | * ssh. It looks like we can't allow our receive queue to get full or | |
205 | * ssh will clag up. Uggh. */ | |
206 | static void read_check(int f) | |
207 | { | |
4c36ddbe | 208 | int n = 8192; |
720b47f2 | 209 | |
5dd7e031 | 210 | if (f == -1) return; |
05c629f7 | 211 | |
5dd7e031 AT |
212 | if (read_buffer_len == 0) { |
213 | read_buffer_p = read_buffer; | |
214 | } | |
720b47f2 | 215 | |
5dd7e031 AT |
216 | if (n > MAX_READ_BUFFER/4) |
217 | n = MAX_READ_BUFFER/4; | |
720b47f2 | 218 | |
5dd7e031 AT |
219 | if (read_buffer_p != read_buffer) { |
220 | memmove(read_buffer,read_buffer_p,read_buffer_len); | |
221 | read_buffer_p = read_buffer; | |
222 | } | |
720b47f2 | 223 | |
5dd7e031 AT |
224 | if (n > (read_buffer_size - read_buffer_len)) { |
225 | read_buffer_size += n; | |
226 | if (!read_buffer) | |
227 | read_buffer = (char *)malloc(read_buffer_size); | |
228 | else | |
229 | read_buffer = (char *)realloc(read_buffer,read_buffer_size); | |
230 | if (!read_buffer) out_of_memory("read check"); | |
231 | read_buffer_p = read_buffer; | |
232 | } | |
233 | ||
8d9dc9f9 | 234 | n = read_unbuffered(f,read_buffer+read_buffer_len,n); |
4c36ddbe | 235 | read_buffer_len += n; |
720b47f2 AT |
236 | } |
237 | ||
4c36ddbe AT |
238 | |
239 | /* do a buffered read from fd. don't return until all N bytes | |
240 | have been read. If all N can't be read then exit with an error */ | |
241 | static void readfd(int fd,char *buffer,int N) | |
720b47f2 | 242 | { |
6ba9279f AT |
243 | int ret; |
244 | int total=0; | |
6ba9279f | 245 | |
4c36ddbe | 246 | if (read_buffer_len < N && N < 1024) { |
6ba9279f | 247 | read_check(buffer_f_in); |
4c36ddbe | 248 | } |
6ba9279f AT |
249 | |
250 | while (total < N) { | |
251 | if (read_buffer_len > 0 && buffer_f_in == fd) { | |
252 | ret = MIN(read_buffer_len,N-total); | |
253 | memcpy(buffer+total,read_buffer_p,ret); | |
254 | read_buffer_p += ret; | |
255 | read_buffer_len -= ret; | |
a070c37b | 256 | total += ret; |
6ba9279f AT |
257 | continue; |
258 | } | |
259 | ||
8d9dc9f9 AT |
260 | io_flush(); |
261 | ||
4c36ddbe | 262 | ret = read_unbuffered(fd,buffer + total,N-total); |
6ba9279f | 263 | total += ret; |
7f28dbee | 264 | } |
720b47f2 AT |
265 | } |
266 | ||
267 | ||
b7922338 | 268 | int32 read_int(int f) |
720b47f2 | 269 | { |
4c36ddbe AT |
270 | char b[4]; |
271 | readfd(f,b,4); | |
272 | total_read += 4; | |
273 | return IVAL(b,0); | |
720b47f2 AT |
274 | } |
275 | ||
71c46176 | 276 | int64 read_longint(int f) |
3a6a366f AT |
277 | { |
278 | extern int remote_version; | |
71c46176 | 279 | int64 ret; |
3a6a366f AT |
280 | char b[8]; |
281 | ret = read_int(f); | |
71c46176 | 282 | |
b7922338 | 283 | if ((int32)ret != (int32)0xffffffff) return ret; |
71c46176 | 284 | |
3bee6733 | 285 | #ifdef NO_INT64 |
9486289c | 286 | rprintf(FERROR,"Integer overflow - attempted 64 bit offset\n"); |
71c46176 AT |
287 | exit_cleanup(1); |
288 | #else | |
289 | if (remote_version >= 16) { | |
4c36ddbe | 290 | readfd(f,b,8); |
3a6a366f | 291 | total_read += 8; |
71c46176 | 292 | ret = IVAL(b,0) | (((int64)IVAL(b,4))<<32); |
3a6a366f | 293 | } |
71c46176 AT |
294 | #endif |
295 | ||
3a6a366f AT |
296 | return ret; |
297 | } | |
298 | ||
720b47f2 AT |
299 | void read_buf(int f,char *buf,int len) |
300 | { | |
4c36ddbe AT |
301 | readfd(f,buf,len); |
302 | total_read += len; | |
720b47f2 AT |
303 | } |
304 | ||
575f2fca AT |
305 | void read_sbuf(int f,char *buf,int len) |
306 | { | |
307 | read_buf(f,buf,len); | |
308 | buf[len] = 0; | |
309 | } | |
310 | ||
182dca5c AT |
311 | unsigned char read_byte(int f) |
312 | { | |
4c36ddbe AT |
313 | unsigned char c; |
314 | read_buf(f,(char *)&c,1); | |
315 | return c; | |
182dca5c | 316 | } |
720b47f2 | 317 | |
7bec6a5c | 318 | |
7bec6a5c | 319 | |
4c36ddbe AT |
320 | /* write len bytes to fd, possibly reading from buffer_f_in if set |
321 | in order to unclog the pipe. don't return until all len | |
322 | bytes have been written */ | |
323 | static void writefd_unbuffered(int fd,char *buf,int len) | |
720b47f2 | 324 | { |
8d9dc9f9 AT |
325 | int total = 0; |
326 | fd_set w_fds, r_fds; | |
4c36ddbe | 327 | int fd_count, count; |
8d9dc9f9 | 328 | struct timeval tv; |
4c36ddbe | 329 | int reading; |
720b47f2 | 330 | |
4c36ddbe | 331 | reading = (buffer_f_in != -1 && read_buffer_len < MAX_READ_BUFFER); |
720b47f2 | 332 | |
4c36ddbe | 333 | while (total < len) { |
8d9dc9f9 AT |
334 | FD_ZERO(&w_fds); |
335 | FD_ZERO(&r_fds); | |
336 | FD_SET(fd,&w_fds); | |
4c36ddbe AT |
337 | fd_count = fd+1; |
338 | ||
339 | if (reading) { | |
8d9dc9f9 AT |
340 | FD_SET(buffer_f_in,&r_fds); |
341 | if (buffer_f_in > fd) | |
342 | fd_count = buffer_f_in+1; | |
343 | } | |
344 | ||
4c36ddbe | 345 | tv.tv_sec = io_timeout; |
8d9dc9f9 | 346 | tv.tv_usec = 0; |
4c36ddbe AT |
347 | |
348 | count = select(fd_count, | |
349 | reading?&r_fds:NULL, | |
350 | &w_fds,NULL, | |
351 | io_timeout?&tv:NULL); | |
352 | ||
353 | if (count <= 0) { | |
8d9dc9f9 AT |
354 | check_timeout(); |
355 | continue; | |
356 | } | |
4c36ddbe | 357 | |
8d9dc9f9 | 358 | if (FD_ISSET(fd, &w_fds)) { |
4c36ddbe AT |
359 | int ret = write(fd,buf+total,len-total); |
360 | ||
361 | if (ret == -1 && errno == EINTR) { | |
362 | continue; | |
363 | } | |
364 | ||
365 | if (ret <= 0) { | |
366 | rprintf(FERROR,"erroring writing %d bytes - exiting\n", len); | |
367 | exit_cleanup(1); | |
368 | } | |
369 | ||
370 | total += ret; | |
371 | if (io_timeout) | |
372 | last_io = time(NULL); | |
373 | continue; | |
8d9dc9f9 | 374 | } |
8d9dc9f9 | 375 | |
4c36ddbe AT |
376 | if (reading && FD_ISSET(buffer_f_in, &r_fds)) { |
377 | read_check(buffer_f_in); | |
378 | } | |
379 | } | |
720b47f2 AT |
380 | } |
381 | ||
8d9dc9f9 | 382 | |
d6dead6b AT |
383 | static char *io_buffer; |
384 | static int io_buffer_count; | |
385 | ||
386 | void io_start_buffering(int fd) | |
387 | { | |
8d9dc9f9 | 388 | if (io_buffer) return; |
679e7657 | 389 | multiplex_out_fd = fd; |
8d9dc9f9 | 390 | io_buffer = (char *)malloc(IO_BUFFER_SIZE+4); |
d6dead6b AT |
391 | if (!io_buffer) out_of_memory("writefd"); |
392 | io_buffer_count = 0; | |
8d9dc9f9 AT |
393 | |
394 | /* leave room for the multiplex header in case it's needed */ | |
395 | io_buffer += 4; | |
d6dead6b AT |
396 | } |
397 | ||
8d9dc9f9 | 398 | void io_flush(void) |
d6dead6b | 399 | { |
679e7657 | 400 | int fd = multiplex_out_fd; |
8d9dc9f9 AT |
401 | if (!io_buffer_count) return; |
402 | ||
403 | if (io_multiplexing_out) { | |
404 | SIVAL(io_buffer-4, 0, (MPLEX_BASE<<24) + io_buffer_count); | |
4c36ddbe | 405 | writefd_unbuffered(fd, io_buffer-4, io_buffer_count+4); |
8d9dc9f9 | 406 | } else { |
4c36ddbe | 407 | writefd_unbuffered(fd, io_buffer, io_buffer_count); |
d6dead6b | 408 | } |
8d9dc9f9 AT |
409 | io_buffer_count = 0; |
410 | } | |
411 | ||
412 | void io_end_buffering(int fd) | |
413 | { | |
414 | io_flush(); | |
415 | if (!io_multiplexing_out) { | |
416 | free(io_buffer-4); | |
417 | io_buffer = NULL; | |
418 | } | |
d6dead6b AT |
419 | } |
420 | ||
4c36ddbe | 421 | static void writefd(int fd,char *buf,int len) |
d6dead6b | 422 | { |
4c36ddbe AT |
423 | if (!io_buffer) { |
424 | writefd_unbuffered(fd, buf, len); | |
425 | return; | |
426 | } | |
d6dead6b AT |
427 | |
428 | while (len) { | |
429 | int n = MIN(len, IO_BUFFER_SIZE-io_buffer_count); | |
430 | if (n > 0) { | |
431 | memcpy(io_buffer+io_buffer_count, buf, n); | |
432 | buf += n; | |
433 | len -= n; | |
434 | io_buffer_count += n; | |
435 | } | |
436 | ||
8d9dc9f9 | 437 | if (io_buffer_count == IO_BUFFER_SIZE) io_flush(); |
d6dead6b | 438 | } |
d6dead6b | 439 | } |
720b47f2 AT |
440 | |
441 | ||
b7922338 | 442 | void write_int(int f,int32 x) |
720b47f2 | 443 | { |
8d9dc9f9 AT |
444 | char b[4]; |
445 | SIVAL(b,0,x); | |
4c36ddbe | 446 | writefd(f,b,4); |
8d9dc9f9 | 447 | total_written += 4; |
720b47f2 AT |
448 | } |
449 | ||
71c46176 | 450 | void write_longint(int f, int64 x) |
3a6a366f AT |
451 | { |
452 | extern int remote_version; | |
453 | char b[8]; | |
3a6a366f AT |
454 | |
455 | if (remote_version < 16 || x <= 0x7FFFFFFF) { | |
456 | write_int(f, (int)x); | |
457 | return; | |
458 | } | |
459 | ||
460 | write_int(f, -1); | |
461 | SIVAL(b,0,(x&0xFFFFFFFF)); | |
462 | SIVAL(b,4,((x>>32)&0xFFFFFFFF)); | |
463 | ||
4c36ddbe | 464 | writefd(f,b,8); |
3a6a366f AT |
465 | total_written += 8; |
466 | } | |
467 | ||
720b47f2 AT |
468 | void write_buf(int f,char *buf,int len) |
469 | { | |
4c36ddbe | 470 | writefd(f,buf,len); |
8d9dc9f9 | 471 | total_written += len; |
720b47f2 AT |
472 | } |
473 | ||
f0fca04e AT |
474 | /* write a string to the connection */ |
475 | void write_sbuf(int f,char *buf) | |
476 | { | |
477 | write_buf(f, buf, strlen(buf)); | |
478 | } | |
479 | ||
720b47f2 | 480 | |
182dca5c AT |
481 | void write_byte(int f,unsigned char c) |
482 | { | |
f0fca04e | 483 | write_buf(f,(char *)&c,1); |
182dca5c AT |
484 | } |
485 | ||
f0fca04e AT |
486 | int read_line(int f, char *buf, int maxlen) |
487 | { | |
528bfcd7 AT |
488 | eof_error = 0; |
489 | ||
f0fca04e | 490 | while (maxlen) { |
528bfcd7 | 491 | buf[0] = 0; |
f0fca04e | 492 | read_buf(f, buf, 1); |
528bfcd7 | 493 | if (buf[0] == 0) return 0; |
f0fca04e AT |
494 | if (buf[0] == '\n') { |
495 | buf[0] = 0; | |
496 | break; | |
497 | } | |
498 | if (buf[0] != '\r') { | |
499 | buf++; | |
500 | maxlen--; | |
501 | } | |
502 | } | |
503 | if (maxlen == 0) { | |
504 | *buf = 0; | |
505 | return 0; | |
506 | } | |
528bfcd7 AT |
507 | |
508 | eof_error = 1; | |
509 | ||
f0fca04e AT |
510 | return 1; |
511 | } | |
512 | ||
513 | ||
514 | void io_printf(int fd, const char *format, ...) | |
515 | { | |
516 | va_list ap; | |
517 | char buf[1024]; | |
518 | int len; | |
519 | ||
520 | va_start(ap, format); | |
e42c9458 | 521 | len = vslprintf(buf, sizeof(buf)-1, format, ap); |
f0fca04e AT |
522 | va_end(ap); |
523 | ||
524 | if (len < 0) exit_cleanup(1); | |
525 | ||
526 | write_sbuf(fd, buf); | |
527 | } | |
8d9dc9f9 AT |
528 | |
529 | ||
530 | /* setup for multiplexing an error stream with the data stream */ | |
531 | void io_start_multiplex_out(int fd) | |
532 | { | |
679e7657 AT |
533 | multiplex_out_fd = fd; |
534 | io_flush(); | |
8d9dc9f9 AT |
535 | io_start_buffering(fd); |
536 | io_multiplexing_out = 1; | |
537 | } | |
538 | ||
539 | /* setup for multiplexing an error stream with the data stream */ | |
540 | void io_start_multiplex_in(int fd) | |
541 | { | |
679e7657 AT |
542 | multiplex_in_fd = fd; |
543 | io_flush(); | |
8d9dc9f9 AT |
544 | if (read_buffer_len) { |
545 | fprintf(stderr,"ERROR: data in read buffer at mplx start\n"); | |
546 | exit_cleanup(1); | |
547 | } | |
548 | ||
549 | io_multiplexing_in = 1; | |
550 | } | |
551 | ||
552 | /* write an message to the error stream */ | |
553 | int io_multiplex_write(int f, char *buf, int len) | |
554 | { | |
555 | if (!io_multiplexing_out) return 0; | |
556 | ||
557 | io_flush(); | |
558 | ||
559 | SIVAL(io_buffer-4, 0, ((MPLEX_BASE + f)<<24) + len); | |
560 | memcpy(io_buffer, buf, len); | |
561 | ||
679e7657 | 562 | writefd_unbuffered(multiplex_out_fd, io_buffer-4, len+4); |
8d9dc9f9 AT |
563 | return 1; |
564 | } | |
565 | ||
566 | void io_close_input(int fd) | |
567 | { | |
568 | buffer_f_in = -1; | |
569 | } |