2 * Logging and utility functions.
4 * Copyright (C) 1998-2001 Andrew Tridgell <tridge@samba.org>
5 * Copyright (C) 2000-2001 Martin Pool <mbp@samba.org>
6 * Copyright (C) 2003-2009 Wayne Davison
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, visit the http://fsf.org website.
30 extern int am_generator;
31 extern int local_server;
34 extern int checksum_len;
35 extern int allow_8bit_chars;
36 extern int protocol_version;
37 extern int always_checksum;
38 extern int preserve_times;
39 extern int msgs2stderr;
42 extern int stdout_format_has_i;
43 extern int stdout_format_has_o_or_i;
44 extern int logfile_format_has_i;
45 extern int logfile_format_has_o_or_i;
46 extern int receiver_symlink_times;
47 extern int64 total_data_written;
48 extern int64 total_data_read;
49 extern mode_t orig_umask;
50 extern char *auth_user;
51 extern char *stdout_format;
52 extern char *logfile_format;
53 extern char *logfile_name;
55 extern iconv_t ic_chck;
58 extern iconv_t ic_recv;
60 extern char curr_dir[MAXPATHLEN];
61 extern char *full_module_path;
62 extern unsigned int module_dirlen;
63 extern char sender_file_sum[MAX_DIGEST_LEN];
64 extern const char undetermined_hostname[];
66 static int log_initialised;
67 static int logfile_was_closed;
68 static FILE *logfile_fp;
71 int got_xfer_error = 0;
72 int output_needs_newline = 0;
73 int send_msgs_to_gen = 0;
75 static int64 initial_data_written;
76 static int64 initial_data_read;
81 } const rerr_names[] = {
82 { RERR_SYNTAX , "syntax or usage error" },
83 { RERR_PROTOCOL , "protocol incompatibility" },
84 { RERR_FILESELECT , "errors selecting input/output files, dirs" },
85 { RERR_UNSUPPORTED, "requested action not supported" },
86 { RERR_STARTCLIENT, "error starting client-server protocol" },
87 { RERR_SOCKETIO , "error in socket IO" },
88 { RERR_FILEIO , "error in file IO" },
89 { RERR_STREAMIO , "error in rsync protocol data stream" },
90 { RERR_MESSAGEIO , "errors with program diagnostics" },
91 { RERR_IPC , "error in IPC code" },
92 { RERR_CRASHED , "sibling process crashed" },
93 { RERR_TERMINATED , "sibling process terminated abnormally" },
94 { RERR_SIGNAL1 , "received SIGUSR1" },
95 { RERR_SIGNAL , "received SIGINT, SIGTERM, or SIGHUP" },
96 { RERR_WAITCHILD , "waitpid() failed" },
97 { RERR_MALLOC , "error allocating core memory buffers" },
98 { RERR_PARTIAL , "some files/attrs were not transferred (see previous errors)" },
99 { RERR_VANISHED , "some files vanished before they could be transferred" },
100 { RERR_TIMEOUT , "timeout in data send/receive" },
101 { RERR_CONTIMEOUT , "timeout waiting for daemon connection" },
102 { RERR_CMD_FAILED , "remote shell failed" },
103 { RERR_CMD_KILLED , "remote shell killed" },
104 { RERR_CMD_RUN , "remote command could not be run" },
105 { RERR_CMD_NOTFOUND,"remote command not found" },
106 { RERR_DEL_LIMIT , "the --max-delete limit stopped deletions" },
111 * Map from rsync error code to name, or return NULL.
113 static char const *rerr_name(int code)
116 for (i = 0; rerr_names[i].name; i++) {
117 if (rerr_names[i].code == code)
118 return rerr_names[i].name;
123 static void logit(int priority, const char *buf)
125 if (logfile_was_closed)
128 fprintf(logfile_fp, "%s [%d] %s",
129 timestring(time(NULL)), (int)getpid(), buf);
132 syslog(priority, "%s", buf);
136 static void syslog_init()
138 static int been_here = 0;
139 int options = LOG_PID;
146 options |= LOG_NDELAY;
150 openlog("rsyncd", options, lp_syslog_facility(module_id));
152 openlog("rsyncd", options);
156 logit(LOG_INFO, "rsyncd started\n");
160 static void logfile_open(void)
162 mode_t old_umask = umask(022 | orig_umask);
163 logfile_fp = fopen(logfile_name, "a");
166 int fopen_errno = errno;
167 /* Rsync falls back to using syslog on failure. */
169 rsyserr(FERROR, fopen_errno,
170 "failed to open log-file %s", logfile_name);
171 rprintf(FINFO, "Ignoring \"log file\" setting.\n");
175 void log_init(int restart)
177 if (log_initialised) {
180 if (strcmp(logfile_name, lp_log_file(module_id)) != 0) {
187 } else if (*logfile_name)
188 return; /* unchanged, non-empty "log file" names */
189 else if (lp_syslog_facility(-1) != lp_syslog_facility(module_id))
192 return; /* unchanged syslog settings */
196 /* This looks pointless, but it is needed in order for the
197 * C library on some systems to fetch the timezone info
198 * before the chroot. */
199 timestring(time(NULL));
201 /* Optionally use a log file instead of syslog. (Non-daemon
202 * rsyncs will have already set logfile_name, as needed.) */
203 if (am_daemon && !logfile_name)
204 logfile_name = lp_log_file(module_id);
205 if (logfile_name && *logfile_name)
211 void logfile_close(void)
214 logfile_was_closed = 1;
220 void logfile_reopen(void)
222 if (logfile_was_closed) {
223 logfile_was_closed = 0;
228 static void filtered_fwrite(FILE *f, const char *buf, int len, int use_isprint)
230 const char *s, *end = buf + len;
231 for (s = buf; s < end; s++) {
233 && *s == '\\' && s[1] == '#'
238 && ((use_isprint && !isPrint(s))
239 || *(uchar*)s < ' '))) {
240 if (s != buf && fwrite(buf, s - buf, 1, f) != 1)
241 exit_cleanup(RERR_MESSAGEIO);
242 fprintf(f, "\\#%03o", *(uchar*)s);
246 if (buf != end && fwrite(buf, end - buf, 1, f) != 1)
247 exit_cleanup(RERR_MESSAGEIO);
250 /* this is the underlying (unformatted) rsync debugging function. Call
251 * it with FINFO, FERROR_*, FWARNING, FLOG, or FCLIENT. Note: recursion
252 * can happen with certain fatal conditions. */
253 void rwrite(enum logcode code, const char *buf, int len, int is_utf8)
255 int trailing_CR_or_NL;
256 FILE *f = msgs2stderr ? stderr : stdout;
258 iconv_t ic = is_utf8 && ic_recv != (iconv_t)-1 ? ic_recv : ic_chck;
261 iconv_t ic = ic_chck;
266 exit_cleanup(RERR_MESSAGEIO);
268 if (msgs2stderr && code != FLOG)
271 if (send_msgs_to_gen) {
273 /* Pass the message to our sibling in native charset. */
274 send_msg((enum msgcode)code, buf, len, 0);
278 if (code == FERROR_SOCKET) /* This gets simplified for a non-sibling. */
280 else if (code == FERROR_UTF8) {
287 else if (am_daemon || logfile_name) {
290 int priority = code == FINFO || code == FLOG ? LOG_INFO : LOG_WARNING;
295 if (!log_initialised)
297 strlcpy(msg, buf, MIN((int)sizeof msg, len + 1));
298 logit(priority, msg);
301 if (code == FLOG || (am_daemon && !am_server))
303 } else if (code == FLOG)
306 if (quiet && code == FINFO)
310 enum msgcode msg = (enum msgcode)code;
311 if (protocol_version < 30) {
312 if (msg == MSG_ERROR)
313 msg = MSG_ERROR_XFER;
314 else if (msg == MSG_WARNING)
317 /* Pass the message to the non-server side. */
318 if (send_msg(msg, buf, len, !is_utf8))
321 /* TODO: can we send the error to the user somehow? */
340 exit_cleanup(RERR_MESSAGEIO);
343 if (output_needs_newline) {
345 output_needs_newline = 0;
348 trailing_CR_or_NL = len && (buf[len-1] == '\n' || buf[len-1] == '\r')
351 if (len && buf[0] == '\r') {
358 if (ic != (iconv_t)-1) {
363 INIT_CONST_XBUF(outbuf, convbuf);
364 INIT_XBUF(inbuf, (char*)buf, len, (size_t)-1);
367 iconvbufs(ic, &inbuf, &outbuf, inbuf.pos ? 0 : ICB_INIT);
370 filtered_fwrite(f, convbuf, outbuf.len, 0);
373 if (!ierrno || ierrno == E2BIG)
375 fprintf(f, "\\#%03o", CVAL(inbuf.buf, inbuf.pos++));
380 filtered_fwrite(f, buf, len, !allow_8bit_chars);
382 if (trailing_CR_or_NL) {
383 fputc(trailing_CR_or_NL, f);
388 /* This is the rsync debugging function. Call it with FINFO, FERROR_*,
389 * FWARNING, FLOG, or FCLIENT. */
390 void rprintf(enum logcode code, const char *format, ...)
393 char buf[BIGPATHBUFLEN];
396 va_start(ap, format);
397 len = vsnprintf(buf, sizeof buf, format, ap);
400 /* Deal with buffer overruns. Instead of panicking, just
401 * truncate the resulting string. (Note that configure ensures
402 * that we have a vsnprintf() that doesn't ever return -1.) */
403 if (len > sizeof buf - 1) {
404 static const char ellipsis[] = "[...]";
406 /* Reset length, and zero-terminate the end of our buffer */
407 len = sizeof buf - 1;
410 /* Copy the ellipsis to the end of the string, but give
411 * us one extra character:
413 * v--- null byte at buf[sizeof buf - 1]
415 * -> abcd[...]00 <-- now two null bytes at end
417 * If the input format string has a trailing newline,
418 * we copy it into that extra null; if it doesn't, well,
419 * all we lose is one byte. */
420 memcpy(buf+len-sizeof ellipsis, ellipsis, sizeof ellipsis);
421 if (format[strlen(format)-1] == '\n') {
426 rwrite(code, buf, len, 0);
429 /* This is like rprintf, but it also tries to print some
430 * representation of the error code. Normally errcode = errno.
432 * Unlike rprintf, this always adds a newline and there should not be
433 * one in the format string.
435 * Note that since strerror might involve dynamically loading a
436 * message catalog we need to call it once before chroot-ing. */
437 void rsyserr(enum logcode code, int errcode, const char *format, ...)
440 char buf[BIGPATHBUFLEN];
443 strlcpy(buf, RSYNC_NAME ": ", sizeof buf);
444 len = (sizeof RSYNC_NAME ": ") - 1;
446 va_start(ap, format);
447 len += vsnprintf(buf + len, sizeof buf - len, format, ap);
450 if (len < sizeof buf) {
451 len += snprintf(buf + len, sizeof buf - len,
452 ": %s (%d)\n", strerror(errcode), errcode);
454 if (len >= sizeof buf)
455 exit_cleanup(RERR_MESSAGEIO);
457 rwrite(code, buf, len, 0);
460 void rflush(enum logcode code)
464 if (am_daemon || code == FLOG)
467 if (!am_server && (code == FINFO || code == FCLIENT))
475 void remember_initial_stats(void)
477 initial_data_read = total_data_read;
478 initial_data_written = total_data_written;
481 /* A generic logging routine for send/recv, with parameter substitiution. */
482 static void log_formatted(enum logcode code, const char *format, const char *op,
483 struct file_struct *file, const char *fname, int iflags,
486 char buf[MAXPATHLEN+1024], buf2[MAXPATHLEN], fmt[32];
494 /* We expand % codes one by one in place in buf. We don't
495 * copy in the terminating null of the inserted strings, but
496 * rather keep going until we reach the null of the format. */
497 total = strlcpy(buf, format, sizeof buf);
498 if (total > MAXPATHLEN) {
499 rprintf(FERROR, "log-format string is WAY too long!\n");
500 exit_cleanup(RERR_MESSAGEIO);
505 for (p = buf; (p = strchr(p, '%')) != NULL; ) {
515 while (isDigit(p) && c - fmt < (int)(sizeof fmt) - 8)
526 /* Note for %h and %a: it doesn't matter what fd we pass to
527 * client_{name,addr} because rsync_module will already have
528 * forced the answer to be cached (assuming, of course, for %h
529 * that lp_reverse_lookup(module_id) is true). */
533 n = lp_reverse_lookup(module_id)
534 ? client_name(0) : undetermined_hostname;
542 strlcat(fmt, "s", sizeof fmt);
543 snprintf(buf2, sizeof buf2, fmt,
544 do_big_num(F_LENGTH(file), humanize, NULL));
548 strlcat(fmt, "u", sizeof fmt);
549 snprintf(buf2, sizeof buf2, fmt,
550 uid_ndx ? F_OWNER(file) : 0);
554 if (!gid_ndx || file->flags & FLAG_SKIP_GROUP)
557 strlcat(fmt, "u", sizeof fmt);
558 snprintf(buf2, sizeof buf2, fmt,
564 strlcat(fmt, "ld", sizeof fmt);
565 snprintf(buf2, sizeof buf2, fmt,
570 n = c = timestring(file->modtime);
571 while ((c = strchr(c, ' ')) != NULL)
575 c = buf2 + MAXPATHLEN - PERMSTRING_SIZE - 1;
576 permstring(c, file->mode);
577 n = c + 1; /* skip the type char */
585 strlcpy(c, fname, MAXPATHLEN);
587 c = f_name(file, NULL);
588 if (am_sender && F_PATHNAME(file)) {
589 pathjoin(buf2, sizeof buf2,
590 F_PATHNAME(file), c);
591 clean_fname(buf2, 0);
593 strlcpy(c, buf2, MAXPATHLEN);
597 } else if (am_daemon && *c != '/') {
598 pathjoin(buf2, sizeof buf2,
599 curr_dir + module_dirlen, c);
600 clean_fname(buf2, 0);
602 strlcpy(c, buf2, MAXPATHLEN);
616 strlcpy(c, fname, MAXPATHLEN);
618 c = f_name(file, NULL);
619 if (S_ISDIR(file->mode))
620 strlcat(c, "/", MAXPATHLEN);
624 if (hlink && *hlink) {
626 strlcpy(buf2, " => ", sizeof buf2);
627 } else if (S_ISLNK(file->mode) && !fname) {
629 strlcpy(buf2, " -> ", sizeof buf2);
634 strlcpy(buf2, " ", sizeof buf2);
636 strlcat(fmt, "s", sizeof fmt);
637 snprintf(buf2 + 4, sizeof buf2 - 4, fmt, n);
641 n = lp_name(module_id);
644 n = timestring(time(NULL));
647 n = full_module_path;
653 if (!(iflags & ITEM_TRANSFER))
656 b = total_data_written - initial_data_written;
658 b = total_data_read - initial_data_read;
659 strlcat(fmt, "s", sizeof fmt);
660 snprintf(buf2, sizeof buf2, fmt,
661 do_big_num(b, humanize, NULL));
665 if (!(iflags & ITEM_TRANSFER))
668 b = total_data_written - initial_data_written;
670 b = total_data_read - initial_data_read;
671 strlcat(fmt, "s", sizeof fmt);
672 snprintf(buf2, sizeof buf2, fmt,
673 do_big_num(b, humanize, NULL));
677 if (protocol_version >= 30
678 && (iflags & ITEM_TRANSFER
679 || (always_checksum && S_ISREG(file->mode)))) {
681 const char *sum = iflags & ITEM_TRANSFER
682 ? sender_file_sum : F_SUM(file);
683 c = buf2 + checksum_len*2;
685 for (i = checksum_len; --i >= 0; ) {
689 *--c = x1 <= 9 ? x1 + '0' : x1 + 'a' - 10;
690 *--c = x2 <= 9 ? x2 + '0' : x2 + 'a' - 10;
693 memset(buf2, ' ', checksum_len*2);
694 buf2[checksum_len*2] = '\0';
699 if (iflags & ITEM_DELETED) {
703 n = c = buf2 + MAXPATHLEN - 32;
704 c[0] = iflags & ITEM_LOCAL_CHANGE
705 ? iflags & ITEM_XNAME_FOLLOWS ? 'h' : 'c'
706 : !(iflags & ITEM_TRANSFER) ? '.'
707 : !local_server && *op == 's' ? '<' : '>';
708 if (S_ISLNK(file->mode)) {
711 c[4] = !(iflags & ITEM_REPORT_TIME) ? '.'
712 : !preserve_times || !receiver_symlink_times
713 || (iflags & ITEM_REPORT_TIMEFAIL) ? 'T' : 't';
715 c[1] = S_ISDIR(file->mode) ? 'd'
716 : IS_SPECIAL(file->mode) ? 'S'
717 : IS_DEVICE(file->mode) ? 'D' : 'f';
718 c[3] = !(iflags & ITEM_REPORT_SIZE) ? '.' : 's';
719 c[4] = !(iflags & ITEM_REPORT_TIME) ? '.'
720 : !preserve_times ? 'T' : 't';
722 c[2] = !(iflags & ITEM_REPORT_CHANGE) ? '.' : 'c';
723 c[5] = !(iflags & ITEM_REPORT_PERMS) ? '.' : 'p';
724 c[6] = !(iflags & ITEM_REPORT_OWNER) ? '.' : 'o';
725 c[7] = !(iflags & ITEM_REPORT_GROUP) ? '.' : 'g';
726 c[8] = !(iflags & ITEM_REPORT_ATIME) ? '.' : 'u';
727 c[9] = !(iflags & ITEM_REPORT_ACL) ? '.' : 'a';
728 c[10] = !(iflags & ITEM_REPORT_XATTR) ? '.' : 'x';
731 if (iflags & (ITEM_IS_NEW|ITEM_MISSING_DATA)) {
732 char ch = iflags & ITEM_IS_NEW ? '+' : '?';
734 for (i = 2; c[i]; i++)
736 } else if (c[0] == '.' || c[0] == 'h' || c[0] == 'c') {
738 for (i = 2; c[i]; i++) {
743 for (i = 2; c[i]; i++)
750 /* "n" is the string to be inserted in place of this % code. */
753 if (n != buf2 && fmt[1]) {
754 strlcat(fmt, "s", sizeof fmt);
755 snprintf(buf2, sizeof buf2, fmt, n);
760 /* Subtract the length of the escape from the string's size. */
763 if (len + total >= (size_t)sizeof buf) {
765 "buffer overflow expanding %%%c -- exiting\n",
767 exit_cleanup(RERR_MESSAGEIO);
770 /* Shuffle the rest of the string along to make space for n */
771 if (len != (size_t)(p - s + 1))
772 memmove(s + len, p + 1, total - (s - buf) + 1);
775 /* Insert the contents of string "n", but NOT its null. */
779 /* Skip over inserted string; continue looking */
783 rwrite(code, buf, total, 0);
786 /* Return 1 if the format escape is in the log-format string (e.g. look for
787 * the 'b' in the "%9b" format escape). */
788 int log_format_has(const char *format, char esc)
795 for (p = format; (p = strchr(p, '%')) != NULL; ) {
796 for (p++; *p == '\''; p++) {}
801 while (*p == '\'') p++;
810 /* Log the transfer of a file. If the code is FCLIENT, the output just goes
811 * to stdout. If it is FLOG, it just goes to the log file. Otherwise we
813 void log_item(enum logcode code, struct file_struct *file, int iflags, const char *hlink)
815 const char *s_or_r = am_sender ? "send" : "recv";
817 if (code != FLOG && stdout_format && !am_server)
818 log_formatted(FCLIENT, stdout_format, s_or_r, file, NULL, iflags, hlink);
819 if (code != FCLIENT && logfile_format && *logfile_format)
820 log_formatted(FLOG, logfile_format, s_or_r, file, NULL, iflags, hlink);
823 void maybe_log_item(struct file_struct *file, int iflags, int itemizing,
826 int significant_flags = iflags & SIGNIFICANT_ITEM_FLAGS;
827 int see_item = itemizing && (significant_flags || *buf
828 || stdout_format_has_i > 1 || (INFO_GTE(NAME, 2) && stdout_format_has_i));
829 int local_change = iflags & ITEM_LOCAL_CHANGE && significant_flags;
831 if (logfile_name && !dry_run && see_item
832 && (significant_flags || logfile_format_has_i))
833 log_item(FLOG, file, iflags, buf);
834 } else if (see_item || local_change || *buf
835 || (S_ISDIR(file->mode) && significant_flags)) {
836 enum logcode code = significant_flags || logfile_format_has_i ? FINFO : FCLIENT;
837 log_item(code, file, iflags, buf);
841 void log_delete(const char *fname, int mode)
844 union file_extras ex[4]; /* just in case... */
845 struct file_struct file;
847 int len = strlen(fname);
852 if (!INFO_GTE(DEL, 1) && !stdout_format)
854 else if (am_server && protocol_version >= 29 && len < MAXPATHLEN) {
856 len++; /* directories include trailing null */
857 send_msg(MSG_DELETED, fname, len, am_generator);
859 fmt = stdout_format_has_o_or_i ? stdout_format : "deleting %n";
860 log_formatted(FCLIENT, fmt, "del.", &x.file, fname, ITEM_DELETED, NULL);
863 if (!logfile_name || dry_run || !logfile_format)
866 fmt = logfile_format_has_o_or_i ? logfile_format : "deleting %n";
867 log_formatted(FLOG, fmt, "del.", &x.file, fname, ITEM_DELETED, NULL);
871 * Called when the transfer is interrupted for some reason.
873 * Code is one of the RERR_* codes from errcode.h, or terminating
876 void log_exit(int code, const char *file, int line)
879 rprintf(FLOG,"sent %s bytes received %s bytes total size %s\n",
880 comma_num(stats.total_written),
881 comma_num(stats.total_read),
882 comma_num(stats.total_size));
883 } else if (am_server != 2) {
886 name = rerr_name(code);
888 name = "unexplained error";
890 /* VANISHED is not an error, only a warning */
891 if (code == RERR_VANISHED) {
892 rprintf(FWARNING, "rsync warning: %s (code %d) at %s(%d) [%s=%s]\n",
893 name, code, file, line, who_am_i(), RSYNC_VERSION);
895 rprintf(FERROR, "rsync error: %s (code %d) at %s(%d) [%s=%s]\n",
896 name, code, file, line, who_am_i(), RSYNC_VERSION);