-/*
- Copyright (C) Andrew Tridgell 1998
+/* -*- c-file-style: "linux"; -*-
+
+ 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"
+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 (logfile) {
+ if (logfname) {
+ if (!logfile)
+ log_open();
fprintf(logfile,"%s [%d] %s",
timestring(time(NULL)), (int)getpid(), buf);
fflush(logfile);
}
}
-void log_open(void)
+void log_init(void)
{
static int initialised;
int options = LOG_PID;
time_t t;
- char *logf;
if (initialised) return;
initialised = 1;
localtime(&t);
/* optionally use a log file instead of syslog */
- logf = lp_log_file();
- if (logf && *logf) {
- extern int orig_umask;
- int old_umask = umask(022 | orig_umask);
- logfile = fopen(logf, "a");
- umask(old_umask);
- return;
+ logfname = lp_log_file();
+ if (logfname) {
+ if (*logfname) {
+ log_open();
+ return;
+ }
+ logfname = NULL;
}
#ifdef LOG_NDELAY
#endif
}
+void log_open()
+{
+ if (logfname && !logfile) {
+ extern int orig_umask;
+ int old_umask = umask(022 | orig_umask);
+ logfile = fopen(logfname, "a");
+ umask(old_umask);
+ }
+}
+
+void log_close()
+{
+ if (logfile) {
+ fclose(logfile);
+ logfile = NULL;
+ }
+}
+
/* setup the error file descriptor - used when we are a server
that is receiving files */
void set_error_fd(int fd)
{
log_error_fd = fd;
+ set_nonblocking(log_error_fd);
}
/* this is the underlying (unformatted) rsync debugging function. Call
{
FILE *f=NULL;
extern int am_daemon;
+ extern int am_server;
extern int quiet;
/* recursion can happen with certain fatal conditions */
return;
}
- if (io_error_write(log_error_fd, code, buf, strlen(buf))) {
+ /* 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;
}
- if (io_multiplex_write(code, buf, strlen(buf))) {
+ /* if that fails, try to pass it to the other end */
+ if (am_server && io_multiplex_write(code, buf, len)) {
return;
}
depth++;
- log_open();
+ log_init();
logit(priority, buf);
depth--;
}
if (code == FERROR) {
+ log_got_error = 1;
f = stderr;
}
if (code == FINFO) {
- extern int am_server;
if (am_server)
f = stderr;
else
}
-/* this is the rsync debugging function. Call it with FINFO, FERROR or FLOG */
- void rprintf(enum logcode code, const char *format, ...)
+/* This is the rsync debugging function. Call it with FINFO, FERROR or
+ * FLOG. */
+void rprintf(enum logcode code, const char *format, ...)
{
va_list ap;
char buf[1024];
int len;
va_start(ap, format);
- len = vslprintf(buf, sizeof(buf), format, ap);
+ len = vsnprintf(buf, sizeof(buf), format, ap);
+ va_end(ap);
+
+ /* 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);
+}
+
+
+/* This is like rprintf, but it also tries to print some
+ * representation of the error code. Normally errcode = errno.
+ *
+ * Unlike rprintf, this always adds a newline and there should not be
+ * one in the format string.
+ *
+ * Note that since strerror might involve dynamically loading a
+ * message catalog we need to call it once before chroot-ing. */
+void rsyserr(enum logcode code, int errcode, const char *format, ...)
+{
+ va_list ap;
+ char buf[1024];
+ int len, sys_len;
+ char *sysmsg;
+
+ va_start(ap, format);
+ len = vsnprintf(buf, sizeof(buf), format, ap);
va_end(ap);
if (len > sizeof(buf)-1) exit_cleanup(RERR_MESSAGEIO);
+ sysmsg = strerror(errcode);
+ sys_len = strlen(sysmsg);
+ if (len + 3 + sys_len > sizeof(buf) - 1)
+ exit_cleanup(RERR_MESSAGEIO);
+
+ strcpy(buf + len, ": ");
+ len += 2;
+ strcpy(buf + len, sysmsg);
+ len += sys_len;
+ strcpy(buf + len, "\n");
+ len++;
+
rwrite(code, buf, len);
}
+
+
void rflush(enum logcode code)
{
FILE *f = NULL;
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);
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':
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;
}
}
}
-/* 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) {
(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
Matt McCutchen's Web Site / rsync / rsync.git / blobdiff