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 socket and pipe IO 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;
43 static void read_loop(int fd, char *buf, int len);
45 void setup_readbuffer(int f_in)
50 static void check_timeout(void)
54 if (!io_timeout) return;
63 if (last_io && io_timeout && (t-last_io) >= io_timeout) {
64 rprintf(FERROR,"io timeout after %d second - exiting\n",
66 exit_cleanup(RERR_TIMEOUT);
70 /* setup the fd used to propogate errors */
71 void io_set_error_fd(int fd)
76 /* read some data from the error fd and write it to the write log code */
77 static void read_error_fd(void)
86 read_loop(fd, buf, 4);
95 if (n > (sizeof(buf)-1)) n = sizeof(buf)-1;
96 read_loop(fd, buf, n);
97 rwrite((enum logcode)tag, buf, n);
107 /* read from a socket with IO timeout. return the number of
108 bytes read. If no bytes can be read then exit, never return
110 static int read_timeout(int fd, char *buf, int len)
123 if (io_error_fd != -1) {
124 FD_SET(io_error_fd, &fds);
125 if (io_error_fd > fd) fd_count = io_error_fd+1;
128 tv.tv_sec = io_timeout?io_timeout:SELECT_TIMEOUT;
133 if (select(fd_count, &fds, NULL, NULL, &tv) < 1) {
134 if (errno == EBADF) {
135 exit_cleanup(RERR_SOCKETIO);
141 if (io_error_fd != -1 && FD_ISSET(io_error_fd, &fds)) {
145 if (!FD_ISSET(fd, &fds)) continue;
147 n = read(fd, buf, len);
154 last_io = time(NULL);
158 if (n == -1 && errno == EINTR) {
163 (errno == EWOULDBLOCK || errno == EAGAIN)) {
170 rprintf(FERROR,"unexpected EOF in read_timeout\n");
172 exit_cleanup(RERR_STREAMIO);
175 /* this prevents us trying to write errors on a dead socket */
176 io_multiplexing_close();
178 rprintf(FERROR,"read error: %s\n", strerror(errno));
179 exit_cleanup(RERR_STREAMIO);
185 /* continue trying to read len bytes - don't return until len
187 static void read_loop(int fd, char *buf, int len)
190 int n = read_timeout(fd, buf, len);
197 /* read from the file descriptor handling multiplexing -
198 return number of bytes read
200 static int read_unbuffered(int fd, char *buf, int len)
202 static int remaining;
206 if (!io_multiplexing_in || fd != multiplex_in_fd)
207 return read_timeout(fd, buf, len);
211 len = MIN(len, remaining);
212 read_loop(fd, buf, len);
218 read_loop(fd, line, 4);
221 remaining = tag & 0xFFFFFF;
224 if (tag == MPLEX_BASE) continue;
228 if (tag != FERROR && tag != FINFO) {
229 rprintf(FERROR,"unexpected tag %d\n", tag);
230 exit_cleanup(RERR_STREAMIO);
233 if (remaining > sizeof(line)-1) {
234 rprintf(FERROR,"multiplexing overflow %d\n\n",
236 exit_cleanup(RERR_STREAMIO);
239 read_loop(fd, line, remaining);
242 rprintf((enum logcode)tag,"%s", line);
250 /* do a buffered read from fd. don't return until all N bytes
251 have been read. If all N can't be read then exit with an error */
252 static void readfd(int fd,char *buffer,int N)
260 ret = read_unbuffered(fd,buffer + total,N-total);
264 stats.total_read += total;
268 int32 read_int(int f)
275 if (ret == (int32)0xffffffff) return -1;
279 int64 read_longint(int f)
281 extern int remote_version;
286 if ((int32)ret != (int32)0xffffffff) {
291 rprintf(FERROR,"Integer overflow - attempted 64 bit offset\n");
292 exit_cleanup(RERR_UNSUPPORTED);
294 if (remote_version >= 16) {
296 ret = IVAL(b,0) | (((int64)IVAL(b,4))<<32);
303 void read_buf(int f,char *buf,int len)
308 void read_sbuf(int f,char *buf,int len)
314 unsigned char read_byte(int f)
317 read_buf(f,(char *)&c,1);
323 /* write len bytes to fd, possibly reading from buffer_f_in if set
324 in order to unclog the pipe. don't return until all len
325 bytes have been written */
326 static void writefd_unbuffered(int fd,char *buf,int len)
335 while (total < len) {
341 if (io_error_fd != -1) {
342 FD_SET(io_error_fd,&r_fds);
343 if (io_error_fd > fd_count)
344 fd_count = io_error_fd;
347 tv.tv_sec = io_timeout?io_timeout:SELECT_TIMEOUT;
352 count = select(fd_count+1,
353 io_error_fd != -1?&r_fds:NULL,
358 if (errno == EBADF) {
359 exit_cleanup(RERR_SOCKETIO);
365 if (io_error_fd != -1 && FD_ISSET(io_error_fd, &r_fds)) {
369 if (FD_ISSET(fd, &w_fds)) {
370 int ret, n = len-total;
372 ret = write(fd,buf+total,n);
374 if (ret == -1 && errno == EINTR) {
379 (errno == EWOULDBLOCK || errno == EAGAIN)) {
384 rprintf(FERROR,"erroring writing %d bytes - exiting\n", len);
385 exit_cleanup(RERR_STREAMIO);
391 last_io = time(NULL);
399 static char *io_buffer;
400 static int io_buffer_count;
402 void io_start_buffering(int fd)
404 if (io_buffer) return;
405 multiplex_out_fd = fd;
406 io_buffer = (char *)malloc(IO_BUFFER_SIZE);
407 if (!io_buffer) out_of_memory("writefd");
411 /* write an message to a multiplexed stream. If this fails then rsync
413 static void mplex_write(int fd, enum logcode code, char *buf, int len)
418 SIVAL(buffer, 0, ((MPLEX_BASE + (int)code)<<24) + len);
420 if (n > (sizeof(buffer)-4)) {
421 n = sizeof(buffer)-4;
424 memcpy(&buffer[4], buf, n);
425 writefd_unbuffered(fd, buffer, n+4);
431 writefd_unbuffered(fd, buf, len);
438 int fd = multiplex_out_fd;
439 if (!io_buffer_count || no_flush) return;
441 if (io_multiplexing_out) {
442 mplex_write(fd, FNONE, io_buffer, io_buffer_count);
444 writefd_unbuffered(fd, io_buffer, io_buffer_count);
449 void io_end_buffering(int fd)
452 if (!io_multiplexing_out) {
458 static void writefd(int fd,char *buf,int len)
460 stats.total_written += len;
462 if (!io_buffer || fd != multiplex_out_fd) {
463 writefd_unbuffered(fd, buf, len);
468 int n = MIN(len, IO_BUFFER_SIZE-io_buffer_count);
470 memcpy(io_buffer+io_buffer_count, buf, n);
473 io_buffer_count += n;
476 if (io_buffer_count == IO_BUFFER_SIZE) io_flush();
481 void write_int(int f,int32 x)
488 void write_longint(int f, int64 x)
490 extern int remote_version;
493 if (remote_version < 16 || x <= 0x7FFFFFFF) {
494 write_int(f, (int)x);
498 write_int(f, (int32)0xFFFFFFFF);
499 SIVAL(b,0,(x&0xFFFFFFFF));
500 SIVAL(b,4,((x>>32)&0xFFFFFFFF));
505 void write_buf(int f,char *buf,int len)
510 /* write a string to the connection */
511 static void write_sbuf(int f,char *buf)
513 write_buf(f, buf, strlen(buf));
517 void write_byte(int f,unsigned char c)
519 write_buf(f,(char *)&c,1);
522 int read_line(int f, char *buf, int maxlen)
529 if (buf[0] == 0) return 0;
530 if (buf[0] == '\n') {
534 if (buf[0] != '\r') {
550 void io_printf(int fd, const char *format, ...)
556 va_start(ap, format);
557 len = vslprintf(buf, sizeof(buf), format, ap);
560 if (len < 0) exit_cleanup(RERR_STREAMIO);
566 /* setup for multiplexing an error stream with the data stream */
567 void io_start_multiplex_out(int fd)
569 multiplex_out_fd = fd;
571 io_start_buffering(fd);
572 io_multiplexing_out = 1;
575 /* setup for multiplexing an error stream with the data stream */
576 void io_start_multiplex_in(int fd)
578 multiplex_in_fd = fd;
580 io_multiplexing_in = 1;
583 /* write an message to the multiplexed error stream */
584 int io_multiplex_write(enum logcode code, char *buf, int len)
586 if (!io_multiplexing_out) return 0;
589 stats.total_written += (len+4);
590 mplex_write(multiplex_out_fd, code, buf, len);
594 /* write a message to the special error fd */
595 int io_error_write(int f, enum logcode code, char *buf, int len)
597 if (f == -1) return 0;
598 mplex_write(f, code, buf, len);
602 /* stop output multiplexing */
603 void io_multiplexing_close(void)
605 io_multiplexing_out = 0;
608 void io_close_input(int fd)