X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/3e3dcd624fbd178ac714048f244208873624d52c..1c8162a921cbae803b3bf375fda4aa7916bcfc68:/log.c diff --git a/log.c b/log.c index 5832b203..34ff6d3d 100644 --- a/log.c +++ b/log.c @@ -1,6 +1,7 @@ /* -*- c-file-style: "linux"; -*- - Copyright (C) 1998-2001 by Andrew Tridgell + Copyright (C) 1998-2001 by Andrew Tridgell + Copyright (C) 2000-2001 by Martin Pool This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -19,16 +20,20 @@ /* Logging and utility functions. + tridge, May 1998 Mapping to human-readable messages added by Martin Pool , Oct 2000. */ #include "rsync.h" +static int log_initialised; static char *logfname; static FILE *logfile; static int log_error_fd = -1; +struct stats stats; +int log_got_error=0; struct { int code; @@ -37,7 +42,8 @@ struct { { RERR_SYNTAX , "syntax or usage error" }, { RERR_PROTOCOL , "protocol incompatibility" }, { RERR_FILESELECT , "errors selecting input/output files, dirs" }, - { RERR_UNSUPPORTED , "requested action not supported" }, + { RERR_UNSUPPORTED, "requested action not supported" }, + { RERR_STARTCLIENT, "error starting client-server protocol" }, { RERR_SOCKETIO , "error in socket IO" }, { RERR_FILEIO , "error in file IO" }, { RERR_STREAMIO , "error in rsync protocol data stream" }, @@ -46,7 +52,12 @@ struct { { RERR_SIGNAL , "received SIGUSR1 or SIGINT" }, { RERR_WAITCHILD , "some error returned by waitpid()" }, { RERR_MALLOC , "error allocating core memory buffers" }, + { RERR_PARTIAL , "some files could not be transferred" }, { RERR_TIMEOUT , "timeout in data send/receive" }, + { RERR_CMD_FAILED , "remote shell failed" }, + { RERR_CMD_KILLED , "remote shell killed" }, + { RERR_CMD_RUN, "remote command could not be run" }, + { RERR_CMD_NOTFOUND, "remote command not found" }, { 0, NULL } }; @@ -65,6 +76,61 @@ static char const *rerr_name(int code) return NULL; } +struct err_list { + struct err_list *next; + char *buf; + int len; + int written; /* how many bytes we have written so far */ +}; + +static struct err_list *err_list_head; +static struct err_list *err_list_tail; + +/* add an error message to the pending error list */ +static void err_list_add(int code, char *buf, int len) +{ + struct err_list *el; + el = (struct err_list *)malloc(sizeof(*el)); + if (!el) exit_cleanup(RERR_MALLOC); + el->next = NULL; + el->buf = malloc(len+4); + if (!el->buf) exit_cleanup(RERR_MALLOC); + memcpy(el->buf+4, buf, len); + SIVAL(el->buf, 0, ((code+MPLEX_BASE)<<24) | len); + el->len = len+4; + el->written = 0; + if (err_list_tail) { + err_list_tail->next = el; + } else { + err_list_head = el; + } + err_list_tail = el; +} + + +/* try to push errors off the error list onto the wire */ +void err_list_push(void) +{ + if (log_error_fd == -1) return; + + while (err_list_head) { + struct err_list *el = err_list_head; + int n = write(log_error_fd, el->buf+el->written, el->len - el->written); + /* don't check for an error if the best way of handling the error is + to ignore it */ + if (n == -1) break; + if (n > 0) { + el->written += n; + } + if (el->written == el->len) { + free(el->buf); + err_list_head = el->next; + if (!err_list_head) err_list_tail = NULL; + free(el); + } + } +} + static void logit(int priority, char *buf) { @@ -81,12 +147,11 @@ static void logit(int priority, char *buf) void log_init(void) { - static int initialised; int options = LOG_PID; time_t t; - if (initialised) return; - initialised = 1; + if (log_initialised) return; + log_initialised = 1; /* this looks pointless, but it is needed in order for the C library on some systems to fetch the timezone info @@ -119,7 +184,7 @@ void log_init(void) #endif } -void log_open() +void log_open(void) { if (logfname && !logfile) { extern int orig_umask; @@ -129,7 +194,7 @@ void log_open() } } -void log_close() +void log_close(void) { if (logfile) { fclose(logfile); @@ -142,6 +207,7 @@ void log_close() void set_error_fd(int fd) { log_error_fd = fd; + set_nonblocking(log_error_fd); } /* this is the underlying (unformatted) rsync debugging function. Call @@ -165,17 +231,29 @@ void rwrite(enum logcode code, char *buf, int len) return; } - /* first try to pass it off the our sibling */ - if (am_server && io_error_write(log_error_fd, code, buf, len)) { + /* first try to pass it off to our sibling */ + if (am_server && log_error_fd != -1) { + err_list_add(code, buf, len); + err_list_push(); return; } - /* then try to pass it to the other end */ + /* next, if we are a server and multiplexing is enabled, + * pass it to the other side. */ if (am_server && io_multiplex_write(code, buf, len)) { return; } - if (am_daemon) { + /* otherwise, if in daemon mode and either we are not a server + * (that is, we are not running --daemon over a remote shell) or + * the log has already been initialised, log the message on this + * side because we don't want the client to see most errors for + * security reasons. We do want early messages when running daemon + * mode over a remote shell to go to the remote side; those will + * fall through to the next case. + * Note that this is only for the time before multiplexing is enabled. + */ + if (am_daemon && (!am_server || log_initialised)) { static int depth; int priority = LOG_INFO; if (code == FERROR) priority = LOG_WARNING; @@ -192,6 +270,7 @@ void rwrite(enum logcode code, char *buf, int len) } if (code == FERROR) { + log_got_error = 1; f = stderr; } @@ -219,10 +298,35 @@ void rprintf(enum logcode code, const char *format, ...) int len; va_start(ap, format); - len = vslprintf(buf, sizeof(buf), format, ap); + /* Note: might return -1 */ + len = vsnprintf(buf, sizeof(buf), format, ap); va_end(ap); - if (len > sizeof(buf)-1) exit_cleanup(RERR_MESSAGEIO); + /* Deal with buffer overruns. Instead of panicking, just + * truncate the resulting string. Note that some vsnprintf()s + * return -1 on truncation, e.g., glibc 2.0.6 and earlier. */ + if ((size_t) len > sizeof(buf)-1 || len < 0) { + const char ellipsis[] = "[...]"; + + /* Reset length, and zero-terminate the end of our buffer */ + len = sizeof(buf)-1; + buf[len] = '\0'; + + /* Copy the ellipsis to the end of the string, but give + * us one extra character: + * + * v--- null byte at buf[sizeof(buf)-1] + * abcdefghij0 + * -> abcd[...]00 <-- now two null bytes at end + * + * If the input format string has a trailing newline, + * we copy it into that extra null; if it doesn't, well, + * all we lose is one byte. */ + strncpy(buf+len-sizeof(ellipsis), ellipsis, sizeof(ellipsis)); + if (format[strlen(format)-1] == '\n') { + buf[len-1] = '\n'; + } + } rwrite(code, buf, len); } @@ -240,18 +344,23 @@ void rsyserr(enum logcode code, int errcode, const char *format, ...) { va_list ap; char buf[1024]; - int len, sys_len; + int len; + size_t sys_len; char *sysmsg; va_start(ap, format); - len = vslprintf(buf, sizeof(buf), format, ap); + /* Note: might return <0 */ + len = vsnprintf(buf, sizeof(buf), format, ap); va_end(ap); - if (len > sizeof(buf)-1) exit_cleanup(RERR_MESSAGEIO); + /* TODO: Put in RSYNC_NAME at the start. */ + + if ((size_t) len > sizeof(buf)-1) + exit_cleanup(RERR_MESSAGEIO); sysmsg = strerror(errcode); sys_len = strlen(sysmsg); - if (len + 3 + sys_len > sizeof(buf) - 1) + if ((size_t) len + 3 + sys_len > sizeof(buf) - 1) exit_cleanup(RERR_MESSAGEIO); strcpy(buf + len, ": "); @@ -308,12 +417,18 @@ static void log_formatted(enum logcode code, char buf[1024]; char buf2[1024]; char *p, *s, *n; - int l; + size_t l; extern struct stats stats; extern int am_sender; extern int am_daemon; int64 b; + /* We expand % codes one by one in place in buf. We don't + * copy in the terminating nul of the inserted strings, but + * rather keep going until we reach the nul of the format. + * Just to make sure we don't clobber that nul and therefore + * accidentally keep going, we zero the buffer now. */ + memset(buf, 0, sizeof buf); strlcpy(buf, format, sizeof(buf)); for (s=&buf[0]; @@ -325,18 +440,18 @@ static void log_formatted(enum logcode code, case 'h': if (am_daemon) n = client_name(0); break; case 'a': if (am_daemon) n = client_addr(0); break; case 'l': - slprintf(buf2,sizeof(buf2),"%.0f", + snprintf(buf2,sizeof(buf2),"%.0f", (double)file->length); n = buf2; break; case 'p': - slprintf(buf2,sizeof(buf2),"%d", + snprintf(buf2,sizeof(buf2),"%d", (int)getpid()); n = buf2; break; case 'o': n = op; break; case 'f': - slprintf(buf2, sizeof(buf2), "%s/%s", + snprintf(buf2, sizeof(buf2), "%s/%s", file->basedir?file->basedir:"", f_name(file)); clean_fname(buf2); @@ -355,7 +470,7 @@ static void log_formatted(enum logcode code, b = stats.total_read - initial_stats->total_read; } - slprintf(buf2,sizeof(buf2),"%.0f", (double)b); + snprintf(buf2,sizeof(buf2),"%.0f", (double)b); n = buf2; break; case 'c': @@ -366,26 +481,35 @@ static void log_formatted(enum logcode code, b = stats.total_read - initial_stats->total_read; } - slprintf(buf2,sizeof(buf2),"%.0f", (double)b); + snprintf(buf2,sizeof(buf2),"%.0f", (double)b); n = buf2; break; } - if (!n) continue; + /* n is the string to be inserted in place of this % + * code; l is its length not including the trailing + * NUL */ + if (!n) + continue; l = strlen(n); - if ((l-1) + ((int)(s - &buf[0])) > sizeof(buf)) { + if (l + ((int)(s - &buf[0])) >= sizeof(buf)) { rprintf(FERROR,"buffer overflow expanding %%%c - exiting\n", p[0]); exit_cleanup(RERR_MESSAGEIO); } + /* Shuffle the rest of the string along to make space for n */ if (l != 2) { memmove(s+(l-1), s+1, strlen(s+1)+1); } + + /* Copy in n but NOT its nul, because the format sting + * probably continues after this. */ memcpy(p, n, l); + /* Skip over inserted string; continue looking */ s = p+l; } @@ -444,25 +568,7 @@ void log_exit(int code, const char *file, int line) if (!name) name = "unexplained error"; - rprintf(FLOG,"transfer interrupted: %s (code %d) at %s(%d)\n", + rprintf(FERROR,"rsync error: %s (code %d) at %s(%d)\n", name, code, file, line); } } - - - - -/* log the incoming transfer of a file for interactive use, this - will be called at the end where the client was run - - it i called when a file starts to be transferred -*/ -void log_transfer(struct file_struct *file, const char *fname) -{ - extern int verbose; - - if (!verbose) return; - - rprintf(FINFO,"%s\n", fname); -} -