2 Copyright (C) Andrew Tridgell 1996
3 Copyright (C) Paul Mackerras 1996
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.
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.
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.
21 Utilities used in rsync
27 /* if no timeout is specified then use a 60 second select timeout */
28 #define SELECT_TIMEOUT 60
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;
37 extern int io_timeout;
38 extern struct stats stats;
40 static int buffer_f_in = -1;
41 static int io_error_fd = -1;
42 static int in_read_check;
44 void setup_readbuffer(int f_in)
49 static void check_timeout(void)
53 if (!io_timeout) return;
62 if (last_io && io_timeout && (t-last_io) >= io_timeout) {
63 rprintf(FERROR,"io timeout after %d second - exiting\n",
65 exit_cleanup(RERR_TIMEOUT);
69 /* setup the fd used to propogate errors */
70 void io_set_error_fd(int fd)
75 /* read some data from the error fd and write it to FERROR */
76 static void read_error_fd(void)
83 n = read(fd, buf, sizeof(buf)-1);
85 rwrite(FERROR, buf, n);
92 static char *read_buffer;
93 static char *read_buffer_p;
94 static int read_buffer_len;
95 static int read_buffer_size;
97 static int no_flush_read;
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
102 static int read_timeout(int fd, char *buf, int len)
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;
122 tv.tv_sec = io_timeout?io_timeout:SELECT_TIMEOUT;
127 if (select(fd_count, &fds, NULL, NULL, &tv) < 1) {
128 if (errno == EBADF) {
129 exit_cleanup(RERR_SOCKETIO);
135 if (io_error_fd != -1 && FD_ISSET(io_error_fd, &fds)) {
139 if (!FD_ISSET(fd, &fds)) continue;
141 n = read(fd, buf, len);
148 last_io = time(NULL);
152 if (n == -1 && errno == EINTR) {
159 rprintf(FERROR,"unexpected EOF in read_timeout\n");
161 exit_cleanup(RERR_STREAMIO);
164 /* this prevents us trying to write errors on a dead socket */
165 io_multiplexing_close();
167 rprintf(FERROR,"read error: %s\n", strerror(errno));
168 exit_cleanup(RERR_STREAMIO);
174 /* continue trying to read len bytes - don't return until len
176 static void read_loop(int fd, char *buf, int len)
179 int n = read_timeout(fd, buf, len);
186 /* read from the file descriptor handling multiplexing -
187 return number of bytes read
189 static int read_unbuffered(int fd, char *buf, int len)
191 static int remaining;
196 if (!io_multiplexing_in || fd != multiplex_in_fd)
197 return read_timeout(fd, buf, len);
201 len = MIN(len, remaining);
202 read_loop(fd, buf, len);
208 read_loop(fd, ibuf, 4);
211 remaining = tag & 0xFFFFFF;
214 if (tag == MPLEX_BASE) continue;
218 if (tag != FERROR && tag != FINFO) {
219 rprintf(FERROR,"unexpected tag %d\n", tag);
220 exit_cleanup(RERR_STREAMIO);
223 if (remaining > sizeof(line)-1) {
224 rprintf(FERROR,"multiplexing overflow %d\n\n",
226 exit_cleanup(RERR_STREAMIO);
229 read_loop(fd, line, remaining);
232 rprintf(tag,"%s", line);
235 if (in_read_check) break;
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)
254 if (read_buffer_len == 0) {
255 read_buffer_p = read_buffer;
258 if (read_buffer_p != read_buffer) {
259 memmove(read_buffer,read_buffer_p,read_buffer_len);
260 read_buffer_p = read_buffer;
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;
270 n = read_unbuffered(f,read_buffer+read_buffer_len,n);
271 read_buffer_len += n;
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)
284 if ((read_buffer_len < N) && (N < 1024)) {
285 read_check(buffer_f_in);
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;
302 ret = read_unbuffered(fd,buffer + total,N-total);
306 stats.total_read += total;
310 int32 read_int(int f)
317 if (ret == (int32)0xffffffff) return -1;
321 int64 read_longint(int f)
323 extern int remote_version;
328 if ((int32)ret != (int32)0xffffffff) {
333 rprintf(FERROR,"Integer overflow - attempted 64 bit offset\n");
334 exit_cleanup(RERR_UNSUPPORTED);
336 if (remote_version >= 16) {
338 ret = IVAL(b,0) | (((int64)IVAL(b,4))<<32);
345 void read_buf(int f,char *buf,int len)
350 void read_sbuf(int f,char *buf,int len)
356 unsigned char read_byte(int f)
359 read_buf(f,(char *)&c,1);
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)
378 while (total < len) {
384 if (!no_flush_read) {
385 reading = (buffer_f_in != -1) &&
386 (read_buffer_len < MAX_READ_BUFFER);
390 FD_SET(buffer_f_in,&r_fds);
391 if (buffer_f_in > fd_count)
392 fd_count = buffer_f_in;
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;
401 tv.tv_sec = io_timeout?io_timeout:SELECT_TIMEOUT;
406 count = select(fd_count+1,
407 (reading || io_error_fd != -1)?&r_fds:NULL,
412 if (errno == EBADF) {
413 exit_cleanup(RERR_SOCKETIO);
419 if (reading && FD_ISSET(buffer_f_in, &r_fds)) {
420 read_check(buffer_f_in);
423 if (io_error_fd != -1 && FD_ISSET(io_error_fd, &r_fds)) {
427 if (FD_ISSET(fd, &w_fds)) {
428 int ret, n = len-total;
430 if (n > PIPE_BUF) n = PIPE_BUF;
432 ret = write(fd,buf+total,n?n:1);
434 if (ret == -1 && errno == EINTR) {
439 rprintf(FERROR,"erroring writing %d bytes - exiting\n", len);
440 exit_cleanup(RERR_STREAMIO);
446 last_io = time(NULL);
454 static char *io_buffer;
455 static int io_buffer_count;
457 void io_start_buffering(int fd)
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");
465 /* leave room for the multiplex header in case it's needed */
471 int fd = multiplex_out_fd;
472 if (!io_buffer_count || no_flush) return;
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);
478 writefd_unbuffered(fd, io_buffer, io_buffer_count);
483 void io_end_buffering(int fd)
486 if (!io_multiplexing_out) {
492 static void writefd(int fd,char *buf,int len)
494 stats.total_written += len;
496 if (!io_buffer || fd != multiplex_out_fd) {
497 writefd_unbuffered(fd, buf, len);
502 int n = MIN(len, IO_BUFFER_SIZE-io_buffer_count);
504 memcpy(io_buffer+io_buffer_count, buf, n);
507 io_buffer_count += n;
510 if (io_buffer_count == IO_BUFFER_SIZE) io_flush();
515 void write_int(int f,int32 x)
522 void write_longint(int f, int64 x)
524 extern int remote_version;
527 if (remote_version < 16 || x <= 0x7FFFFFFF) {
528 write_int(f, (int)x);
532 write_int(f, (int32)0xFFFFFFFF);
533 SIVAL(b,0,(x&0xFFFFFFFF));
534 SIVAL(b,4,((x>>32)&0xFFFFFFFF));
539 void write_buf(int f,char *buf,int len)
544 /* write a string to the connection */
545 static void write_sbuf(int f,char *buf)
547 write_buf(f, buf, strlen(buf));
551 void write_byte(int f,unsigned char c)
553 write_buf(f,(char *)&c,1);
556 int read_line(int f, char *buf, int maxlen)
563 if (buf[0] == 0) return 0;
564 if (buf[0] == '\n') {
568 if (buf[0] != '\r') {
584 void io_printf(int fd, const char *format, ...)
590 va_start(ap, format);
591 len = vslprintf(buf, sizeof(buf), format, ap);
594 if (len < 0) exit_cleanup(RERR_STREAMIO);
600 /* setup for multiplexing an error stream with the data stream */
601 void io_start_multiplex_out(int fd)
603 multiplex_out_fd = fd;
605 io_start_buffering(fd);
606 io_multiplexing_out = 1;
609 /* setup for multiplexing an error stream with the data stream */
610 void io_start_multiplex_in(int fd)
612 multiplex_in_fd = fd;
614 if (read_buffer_len) {
615 exit_cleanup(RERR_STREAMIO);
618 io_multiplexing_in = 1;
621 /* write an message to the multiplexed error stream */
622 int io_multiplex_write(int f, char *buf, int len)
624 if (!io_multiplexing_out) return 0;
628 SIVAL(io_buffer-4, 0, ((MPLEX_BASE + f)<<24) + len);
629 memcpy(io_buffer, buf, len);
631 stats.total_written += (len+4);
633 writefd_unbuffered(multiplex_out_fd, io_buffer-4, len+4);
637 /* write a message to the special error fd */
638 int io_error_write(int f, char *buf, int len)
640 if (f == -1) return 0;
641 writefd_unbuffered(f, buf, len);
645 /* stop output multiplexing */
646 void io_multiplexing_close(void)
648 io_multiplexing_out = 0;
651 void io_close_input(int fd)