1 /* -*- c-file-style: "linux"; -*-
3 Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org>
4 Copyright (C) 2000-2001 by Martin Pool <mbp@samba.org>
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 Logging and utility functions.
25 Mapping to human-readable messages added by Martin Pool
26 <mbp@samba.org>, Oct 2000.
30 static int log_initialised;
31 static char *logfname;
33 static int log_error_fd = -1;
41 } const rerr_names[] = {
42 { RERR_SYNTAX , "syntax or usage error" },
43 { RERR_PROTOCOL , "protocol incompatibility" },
44 { RERR_FILESELECT , "errors selecting input/output files, dirs" },
45 { RERR_UNSUPPORTED, "requested action not supported" },
46 { RERR_STARTCLIENT, "error starting client-server protocol" },
47 { RERR_SOCKETIO , "error in socket IO" },
48 { RERR_FILEIO , "error in file IO" },
49 { RERR_STREAMIO , "error in rsync protocol data stream" },
50 { RERR_MESSAGEIO , "errors with program diagnostics" },
51 { RERR_IPC , "error in IPC code" },
52 { RERR_SIGNAL , "received SIGUSR1 or SIGINT" },
53 { RERR_WAITCHILD , "some error returned by waitpid()" },
54 { RERR_MALLOC , "error allocating core memory buffers" },
55 { RERR_PARTIAL , "some files could not be transferred" },
56 { RERR_VANISHED , "some files vanished before they could be transfered" },
57 { RERR_TIMEOUT , "timeout in data send/receive" },
58 { RERR_CMD_FAILED , "remote shell failed" },
59 { RERR_CMD_KILLED , "remote shell killed" },
60 { RERR_CMD_RUN, "remote command could not be run" },
61 { RERR_CMD_NOTFOUND, "remote command not found" },
68 * Map from rsync error code to name, or return NULL.
70 static char const *rerr_name(int code)
73 for (i = 0; rerr_names[i].name; i++) {
74 if (rerr_names[i].code == code)
75 return rerr_names[i].name;
81 struct err_list *next;
84 int written; /* how many bytes we have written so far */
87 static struct err_list *err_list_head;
88 static struct err_list *err_list_tail;
90 /* add an error message to the pending error list */
91 static void err_list_add(int code, char *buf, int len)
94 el = new(struct err_list);
95 if (!el) exit_cleanup(RERR_MALLOC);
97 el->buf = new_array(char, len+4);
98 if (!el->buf) exit_cleanup(RERR_MALLOC);
99 memcpy(el->buf+4, buf, len);
100 SIVAL(el->buf, 0, ((code+MPLEX_BASE)<<24) | len);
104 err_list_tail->next = el;
112 /* try to push errors off the error list onto the wire */
113 void err_list_push(void)
115 if (log_error_fd == -1) return;
117 while (err_list_head) {
118 struct err_list *el = err_list_head;
119 int n = write(log_error_fd, el->buf+el->written, el->len - el->written);
120 /* don't check for an error if the best way of handling the error is
126 if (el->written == el->len) {
128 err_list_head = el->next;
129 if (!err_list_head) err_list_tail = NULL;
136 static void logit(int priority, char *buf)
141 fprintf(logfile,"%s [%d] %s",
142 timestring(time(NULL)), (int)getpid(), buf);
145 syslog(priority, "%s", buf);
151 int options = LOG_PID;
154 if (log_initialised) return;
157 /* this looks pointless, but it is needed in order for the
158 * C library on some systems to fetch the timezone info
159 * before the chroot */
163 /* optionally use a log file instead of syslog */
164 logfname = lp_log_file();
174 options |= LOG_NDELAY;
178 openlog("rsyncd", options, lp_syslog_facility());
180 openlog("rsyncd", options);
184 logit(LOG_INFO,"rsyncd started\n");
190 if (logfname && !logfile) {
191 extern int orig_umask;
192 int old_umask = umask(022 | orig_umask);
193 logfile = fopen(logfname, "a");
206 /* setup the error file descriptor - used when we are a server
207 * that is receiving files */
208 void set_error_fd(int fd)
211 set_nonblocking(log_error_fd);
214 /* this is the underlying (unformatted) rsync debugging function. Call
215 * it with FINFO, FERROR or FLOG */
216 void rwrite(enum logcode code, char *buf, int len)
219 extern int am_daemon;
220 extern int am_server;
222 /* recursion can happen with certain fatal conditions */
224 if (quiet && code == FINFO) return;
226 if (len < 0) exit_cleanup(RERR_MESSAGEIO);
231 if (am_daemon) logit(LOG_INFO, buf);
235 /* first try to pass it off to our sibling */
236 if (am_server && log_error_fd != -1) {
237 err_list_add(code, buf, len);
242 /* next, if we are a server and multiplexing is enabled,
243 * pass it to the other side. */
244 if (am_server && io_multiplex_write(code, buf, len)) {
248 /* otherwise, if in daemon mode and either we are not a server
249 * (that is, we are not running --daemon over a remote shell) or
250 * the log has already been initialised, log the message on this
251 * side because we don't want the client to see most errors for
252 * security reasons. We do want early messages when running daemon
253 * mode over a remote shell to go to the remote side; those will
254 * fall through to the next case.
255 * Note that this is only for the time before multiplexing is enabled.
257 if (am_daemon && (!am_server || log_initialised)) {
259 int priority = LOG_INFO;
260 if (code == FERROR) priority = LOG_WARNING;
267 logit(priority, buf);
273 if (code == FERROR) {
285 if (!f) exit_cleanup(RERR_MESSAGEIO);
287 if (fwrite(buf, len, 1, f) != 1) exit_cleanup(RERR_MESSAGEIO);
289 if (buf[len-1] == '\r' || buf[len-1] == '\n') fflush(f);
293 /* This is the rsync debugging function. Call it with FINFO, FERROR or
295 void rprintf(enum logcode code, const char *format, ...)
301 va_start(ap, format);
302 /* Note: might return -1 */
303 len = vsnprintf(buf, sizeof(buf), format, ap);
306 /* Deal with buffer overruns. Instead of panicking, just
307 * truncate the resulting string. Note that some vsnprintf()s
308 * return -1 on truncation, e.g., glibc 2.0.6 and earlier. */
309 if ((size_t) len > sizeof(buf)-1 || len < 0) {
310 const char ellipsis[] = "[...]";
312 /* Reset length, and zero-terminate the end of our buffer */
316 /* Copy the ellipsis to the end of the string, but give
317 * us one extra character:
319 * v--- null byte at buf[sizeof(buf)-1]
321 * -> abcd[...]00 <-- now two null bytes at end
323 * If the input format string has a trailing newline,
324 * we copy it into that extra null; if it doesn't, well,
325 * all we lose is one byte. */
326 strncpy(buf+len-sizeof(ellipsis), ellipsis, sizeof(ellipsis));
327 if (format[strlen(format)-1] == '\n') {
332 rwrite(code, buf, len);
336 /* This is like rprintf, but it also tries to print some
337 * representation of the error code. Normally errcode = errno.
339 * Unlike rprintf, this always adds a newline and there should not be
340 * one in the format string.
342 * Note that since strerror might involve dynamically loading a
343 * message catalog we need to call it once before chroot-ing. */
344 void rsyserr(enum logcode code, int errcode, const char *format, ...)
352 va_start(ap, format);
353 /* Note: might return <0 */
354 len = vsnprintf(buf, sizeof(buf), format, ap);
357 /* TODO: Put in RSYNC_NAME at the start. */
359 if ((size_t) len > sizeof(buf)-1)
360 exit_cleanup(RERR_MESSAGEIO);
362 sysmsg = strerror(errcode);
363 sys_len = strlen(sysmsg);
364 if ((size_t) len + 3 + sys_len > sizeof(buf) - 1)
365 exit_cleanup(RERR_MESSAGEIO);
367 strcpy(buf + len, ": ");
369 strcpy(buf + len, sysmsg);
371 strcpy(buf + len, "\n");
374 rwrite(code, buf, len);
379 void rflush(enum logcode code)
382 extern int am_daemon;
392 if (code == FERROR) {
397 extern int am_server;
404 if (!f) exit_cleanup(RERR_MESSAGEIO);
410 /* a generic logging routine for send/recv, with parameter
412 static void log_formatted(enum logcode code,
413 char *format, char *op, struct file_struct *file,
414 struct stats *initial_stats)
416 extern int module_id;
417 extern char *auth_user;
422 extern struct stats stats;
423 extern int am_sender;
424 extern int am_daemon;
427 /* We expand % codes one by one in place in buf. We don't
428 * copy in the terminating nul of the inserted strings, but
429 * rather keep going until we reach the nul of the format.
430 * Just to make sure we don't clobber that nul and therefore
431 * accidentally keep going, we zero the buffer now. */
432 memset(buf, 0, sizeof buf);
433 strlcpy(buf, format, sizeof(buf));
435 for (s = &buf[0]; s && (p = strchr(s,'%')); ) {
440 case 'h': if (am_daemon) n = client_name(0); break;
441 case 'a': if (am_daemon) n = client_addr(0); break;
443 snprintf(buf2,sizeof(buf2),"%.0f",
444 (double)file->length);
448 snprintf(buf2,sizeof(buf2),"%d",
452 case 'o': n = op; break;
454 snprintf(buf2, sizeof(buf2), "%s/%s",
455 file->basedir?file->basedir:"",
461 case 'm': n = lp_name(module_id); break;
462 case 't': n = timestring(time(NULL)); break;
463 case 'P': n = lp_path(module_id); break;
464 case 'u': n = auth_user; break;
467 b = stats.total_written -
468 initial_stats->total_written;
470 b = stats.total_read -
471 initial_stats->total_read;
473 snprintf(buf2,sizeof(buf2),"%.0f", (double)b);
478 b = stats.total_written -
479 initial_stats->total_written;
481 b = stats.total_read -
482 initial_stats->total_read;
484 snprintf(buf2,sizeof(buf2),"%.0f", (double)b);
489 /* n is the string to be inserted in place of this %
490 * code; l is its length not including the trailing
497 if (l + ((int)(s - &buf[0])) >= sizeof(buf)) {
498 rprintf(FERROR,"buffer overflow expanding %%%c - exiting\n",
500 exit_cleanup(RERR_MESSAGEIO);
503 /* Shuffle the rest of the string along to make space for n */
505 memmove(s+(l-1), s+1, strlen(s+1)+1);
508 /* Copy in n but NOT its nul, because the format sting
509 * probably continues after this. */
512 /* Skip over inserted string; continue looking */
516 rprintf(code,"%s\n", buf);
519 /* log the outgoing transfer of a file */
520 void log_send(struct file_struct *file, struct stats *initial_stats)
522 extern int module_id;
523 extern int am_server;
524 extern char *log_format;
526 if (lp_transfer_logging(module_id)) {
527 log_formatted(FLOG, lp_log_format(module_id), "send", file, initial_stats);
528 } else if (log_format && !am_server) {
529 log_formatted(FINFO, log_format, "send", file, initial_stats);
533 /* log the incoming transfer of a file */
534 void log_recv(struct file_struct *file, struct stats *initial_stats)
536 extern int module_id;
537 extern int am_server;
538 extern char *log_format;
540 if (lp_transfer_logging(module_id)) {
541 log_formatted(FLOG, lp_log_format(module_id), "recv", file, initial_stats);
542 } else if (log_format && !am_server) {
543 log_formatted(FINFO, log_format, "recv", file, initial_stats);
551 * Called when the transfer is interrupted for some reason.
553 * Code is one of the RERR_* codes from errcode.h, or terminating
556 void log_exit(int code, const char *file, int line)
559 extern struct stats stats;
560 rprintf(FLOG,"wrote %.0f bytes read %.0f bytes total size %.0f\n",
561 (double)stats.total_written,
562 (double)stats.total_read,
563 (double)stats.total_size);
567 name = rerr_name(code);
569 name = "unexplained error";
571 /* VANISHED is not an error, only a warning */
572 if (code == RERR_VANISHED) {
573 rprintf(FINFO, "rsync warning: %s (code %d) at %s(%d)\n",
574 name, code, file, line);
576 rprintf(FERROR, "rsync error: %s (code %d) at %s(%d)\n",
577 name, code, file, line);