Split code to generate "rwx-----" strings into lib/permstring.c so it
[rsync/rsync.git] / log.c
diff --git a/log.c b/log.c
index 8928a38..3b53a9a 100644 (file)
--- a/log.c
+++ b/log.c
@@ -1,6 +1,7 @@
 /* -*- c-file-style: "linux"; -*-
    
-   Copyright (C) 1998-2000 by Andrew Tridgell
+   Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org>
+   Copyright (C) 2000-2001 by Martin Pool <mbp@samba.org>
    
    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
 */
 
 /*
-  logging and utility functions
-
+  Logging and utility functions.
   tridge, May 1998
+
+  Mapping to human-readable messages added by Martin Pool
+  <mbp@samba.org>, Oct 2000.
   */
 #include "rsync.h"
 
@@ -28,6 +31,104 @@ static char *logfname;
 static FILE *logfile;
 static int log_error_fd = -1;
 
+int log_got_error=0;
+
+struct {
+        int code;
+        char const *name;
+} const rerr_names[] = {
+       { 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_SOCKETIO   , "error in socket IO" }, 
+       { RERR_FILEIO     , "error in file IO" }, 
+       { RERR_STREAMIO   , "error in rsync protocol data stream" }, 
+       { RERR_MESSAGEIO  , "errors with program diagnostics" }, 
+       { RERR_IPC        , "error in IPC code" }, 
+       { RERR_SIGNAL     , "received SIGUSR1 or SIGINT" }, 
+       { RERR_WAITCHILD  , "some error returned by waitpid()" }, 
+       { RERR_MALLOC     , "error allocating core memory buffers" }, 
+       { RERR_PARTIAL    , "partial transfer" }, 
+       { 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 }
+};
+
+
+
+/*
+ * Map from rsync error code to name, or return NULL.
+ */
+static char const *rerr_name(int code)
+{
+        int i;
+        for (i = 0; rerr_names[i].name; i++) {
+                if (rerr_names[i].code == code)
+                        return rerr_names[i].name;
+        }
+        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)
 {
        if (logfname) {
@@ -104,6 +205,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
@@ -127,12 +229,14 @@ 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 */
+       /* if that fails, try to pass it to the other end */
        if (am_server && io_multiplex_write(code, buf, len)) {
                return;
        }
@@ -154,6 +258,7 @@ void rwrite(enum logcode code, char *buf, int len)
        }
 
        if (code == FERROR) {
+               log_got_error = 1;
                f = stderr;
        } 
 
@@ -181,10 +286,34 @@ void rprintf(enum logcode code, const char *format, ...)
        int len;
 
        va_start(ap, format);
-       len = vslprintf(buf, sizeof(buf), format, ap);
+       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 (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);
 }
@@ -206,7 +335,7 @@ void rsyserr(enum logcode code, int errcode, const char *format, ...)
         char *sysmsg;
 
        va_start(ap, format);
-       len = vslprintf(buf, sizeof(buf), format, ap);
+       len = vsnprintf(buf, sizeof(buf), format, ap);
        va_end(ap);
 
        if (len > sizeof(buf)-1) exit_cleanup(RERR_MESSAGEIO);
@@ -287,18 +416,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);
@@ -317,7 +446,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': 
@@ -328,7 +457,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;
                }
@@ -382,7 +511,15 @@ void log_recv(struct file_struct *file, struct stats *initial_stats)
        }
 }
 
-/* called when the transfer is interrupted for some reason */
+
+
+
+/*
+ * Called when the transfer is interrupted for some reason.
+ *
+ * Code is one of the RERR_* codes from errcode.h, or terminating
+ * successfully.
+ */
 void log_exit(int code, const char *file, int line)
 {
        if (code == 0) {
@@ -392,11 +529,20 @@ void log_exit(int code, const char *file, int line)
                        (double)stats.total_read,
                        (double)stats.total_size);
        } else {
-               rprintf(FLOG,"transfer interrupted (code %d) at %s(%d)\n", 
-                       code, file, line);
+                const char *name;
+
+                name = rerr_name(code);
+                if (!name)
+                        name = "unexplained error";
+                
+               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