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