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