X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/4a81463880f9ba9d25b2e06ddc67628aa4768787..0c5a792ac7e8d9f415aaafd18f7500256de133af:/log.c diff --git a/log.c b/log.c index 61a8bd05..aef3ac8a 100644 --- a/log.c +++ b/log.c @@ -1,5 +1,7 @@ -/* - Copyright (C) Andrew Tridgell 1998 +/* -*- c-file-style: "linux"; -*- + + 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 @@ -17,18 +19,60 @@ */ /* - logging and utility functions - + Logging and utility functions. tridge, May 1998 + + Mapping to human-readable messages added by Martin Pool + , Oct 2000. */ #include "rsync.h" +static char *logfname; static FILE *logfile; static int log_error_fd = -1; + +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_TIMEOUT , "timeout in data send/receive" }, + { 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; +} + + 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); @@ -37,12 +81,11 @@ static void logit(int priority, char *buf) } } -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; @@ -54,13 +97,13 @@ void log_open(void) 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 @@ -78,6 +121,24 @@ void log_open(void) #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) @@ -111,7 +172,7 @@ void rwrite(enum logcode code, char *buf, int len) 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; } @@ -125,7 +186,7 @@ void rwrite(enum logcode code, char *buf, int len) depth++; - log_open(); + log_init(); logit(priority, buf); depth--; @@ -151,8 +212,9 @@ void rwrite(enum logcode code, char *buf, int len) } -/* 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]; @@ -167,6 +229,45 @@ void rwrite(enum logcode code, char *buf, int len) 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 = vslprintf(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; @@ -321,7 +422,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) { @@ -331,11 +440,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(FLOG,"transfer interrupted: %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