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-2007 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 msg_fd_out
;
35 extern int allow_8bit_chars
;
36 extern int protocol_version
;
37 extern int preserve_times
;
40 extern int stdout_format_has_i
;
41 extern int stdout_format_has_o_or_i
;
42 extern int logfile_format_has_i
;
43 extern int logfile_format_has_o_or_i
;
44 extern mode_t orig_umask
;
45 extern char *auth_user
;
46 extern char *stdout_format
;
47 extern char *logfile_format
;
48 extern char *logfile_name
;
50 extern iconv_t ic_chck
;
53 extern iconv_t ic_send
, ic_recv
;
55 extern char curr_dir
[];
56 extern char *module_dir
;
57 extern unsigned int module_dirlen
;
59 static int log_initialised
;
60 static int logfile_was_closed
;
61 static FILE *logfile_fp
;
64 int got_xfer_error
= 0;
69 } const rerr_names
[] = {
70 { RERR_SYNTAX
, "syntax or usage error" },
71 { RERR_PROTOCOL
, "protocol incompatibility" },
72 { RERR_FILESELECT
, "errors selecting input/output files, dirs" },
73 { RERR_UNSUPPORTED
, "requested action not supported" },
74 { RERR_STARTCLIENT
, "error starting client-server protocol" },
75 { RERR_SOCKETIO
, "error in socket IO" },
76 { RERR_FILEIO
, "error in file IO" },
77 { RERR_STREAMIO
, "error in rsync protocol data stream" },
78 { RERR_MESSAGEIO
, "errors with program diagnostics" },
79 { RERR_IPC
, "error in IPC code" },
80 { RERR_CRASHED
, "sibling process crashed" },
81 { RERR_TERMINATED
, "sibling process terminated abnormally" },
82 { RERR_SIGNAL1
, "received SIGUSR1" },
83 { RERR_SIGNAL
, "received SIGINT, SIGTERM, or SIGHUP" },
84 { RERR_WAITCHILD
, "waitpid() failed" },
85 { RERR_MALLOC
, "error allocating core memory buffers" },
86 { RERR_PARTIAL
, "some files could not be transferred" },
87 { RERR_VANISHED
, "some files vanished before they could be transferred" },
88 { RERR_TIMEOUT
, "timeout in data send/receive" },
89 { RERR_CONTIMEOUT
, "timeout waiting for daemon connection" },
90 { RERR_CMD_FAILED
, "remote shell failed" },
91 { RERR_CMD_KILLED
, "remote shell killed" },
92 { RERR_CMD_RUN
, "remote command could not be run" },
93 { RERR_CMD_NOTFOUND
,"remote command not found" },
94 { RERR_DEL_LIMIT
, "the --max-delete limit stopped deletions" },
99 * Map from rsync error code to name, or return NULL.
101 static char const *rerr_name(int code
)
104 for (i
= 0; rerr_names
[i
].name
; i
++) {
105 if (rerr_names
[i
].code
== code
)
106 return rerr_names
[i
].name
;
111 static void logit(int priority
, const char *buf
)
113 if (logfile_was_closed
)
116 fprintf(logfile_fp
, "%s [%d] %s",
117 timestring(time(NULL
)), (int)getpid(), buf
);
120 syslog(priority
, "%s", buf
);
124 static void syslog_init()
126 static int been_here
= 0;
127 int options
= LOG_PID
;
134 options
|= LOG_NDELAY
;
138 openlog("rsyncd", options
, lp_syslog_facility(module_id
));
140 openlog("rsyncd", options
);
144 logit(LOG_INFO
, "rsyncd started\n");
148 static void logfile_open(void)
150 mode_t old_umask
= umask(022 | orig_umask
);
151 logfile_fp
= fopen(logfile_name
, "a");
154 int fopen_errno
= errno
;
155 /* Rsync falls back to using syslog on failure. */
157 rsyserr(FERROR
, fopen_errno
,
158 "failed to open log-file %s", logfile_name
);
159 rprintf(FINFO
, "Ignoring \"log file\" setting.\n");
163 void log_init(int restart
)
165 if (log_initialised
) {
168 if (strcmp(logfile_name
, lp_log_file(module_id
)) != 0) {
175 } else if (*logfile_name
)
176 return; /* unchanged, non-empty "log file" names */
177 else if (lp_syslog_facility(-1) != lp_syslog_facility(module_id
))
180 return; /* unchanged syslog settings */
184 /* This looks pointless, but it is needed in order for the
185 * C library on some systems to fetch the timezone info
186 * before the chroot. */
187 timestring(time(NULL
));
189 /* Optionally use a log file instead of syslog. (Non-daemon
190 * rsyncs will have already set logfile_name, as needed.) */
191 if (am_daemon
&& !logfile_name
)
192 logfile_name
= lp_log_file(module_id
);
193 if (logfile_name
&& *logfile_name
)
199 void logfile_close(void)
202 logfile_was_closed
= 1;
208 void logfile_reopen(void)
210 if (logfile_was_closed
) {
211 logfile_was_closed
= 0;
216 static void filtered_fwrite(FILE *f
, const char *buf
, int len
, int use_isprint
)
218 const char *s
, *end
= buf
+ len
;
219 for (s
= buf
; s
< end
; s
++) {
221 && *s
== '\\' && s
[1] == '#'
226 && ((use_isprint
&& !isPrint(s
))
227 || *(uchar
*)s
< ' '))) {
228 if (s
!= buf
&& fwrite(buf
, s
- buf
, 1, f
) != 1)
229 exit_cleanup(RERR_MESSAGEIO
);
230 fprintf(f
, "\\#%03o", *(uchar
*)s
);
234 if (buf
!= end
&& fwrite(buf
, end
- buf
, 1, f
) != 1)
235 exit_cleanup(RERR_MESSAGEIO
);
238 /* this is the underlying (unformatted) rsync debugging function. Call
239 * it with FINFO, FERROR_*, FWARNING, FLOG, or FCLIENT. Note: recursion
240 * can happen with certain fatal conditions. */
241 void rwrite(enum logcode code
, const char *buf
, int len
, int is_utf8
)
243 int trailing_CR_or_NL
;
246 iconv_t ic
= is_utf8
&& ic_recv
!= (iconv_t
)-1 ? ic_recv
: ic_chck
;
249 iconv_t ic
= ic_chck
;
254 exit_cleanup(RERR_MESSAGEIO
);
256 if (am_server
&& msg_fd_out
>= 0) {
258 /* Pass the message to our sibling. */
259 send_msg((enum msgcode
)code
, buf
, len
, 0);
263 if (code
== FERROR_SOCKET
) /* This gets simplified for a non-sibling. */
268 else if (am_daemon
|| logfile_name
) {
271 int priority
= code
== FINFO
|| code
== FLOG
? LOG_INFO
: LOG_WARNING
;
276 if (!log_initialised
)
278 strlcpy(msg
, buf
, MIN((int)sizeof msg
, len
+ 1));
279 logit(priority
, msg
);
282 if (code
== FLOG
|| (am_daemon
&& !am_server
))
284 } else if (code
== FLOG
)
287 if (quiet
&& code
== FINFO
)
291 enum msgcode msg
= (enum msgcode
)code
;
292 if (protocol_version
< 30) {
293 if (msg
== MSG_ERROR
)
294 msg
= MSG_ERROR_XFER
;
295 else if (msg
== MSG_WARNING
)
298 /* Pass the message to the non-server side. */
299 if (send_msg(msg
, buf
, len
, !is_utf8
))
302 /* TODO: can we send the error to the user somehow? */
316 f
= am_server
? stderr
: stdout
;
319 exit_cleanup(RERR_MESSAGEIO
);
322 trailing_CR_or_NL
= len
&& (buf
[len
-1] == '\n' || buf
[len
-1] == '\r')
326 if (ic
!= (iconv_t
)-1) {
331 INIT_CONST_XBUF(outbuf
, convbuf
);
332 INIT_XBUF(inbuf
, (char*)buf
, len
, -1);
335 iconvbufs(ic
, &inbuf
, &outbuf
, 0);
338 filtered_fwrite(f
, convbuf
, outbuf
.len
, 0);
341 if (!ierrno
|| ierrno
== E2BIG
)
343 fprintf(f
, "\\#%03o", CVAL(inbuf
.buf
, inbuf
.pos
++));
348 filtered_fwrite(f
, buf
, len
, !allow_8bit_chars
);
350 if (trailing_CR_or_NL
) {
351 fputc(trailing_CR_or_NL
, f
);
356 /* This is the rsync debugging function. Call it with FINFO, FERROR_*,
357 * FWARNING, FLOG, or FCLIENT. */
358 void rprintf(enum logcode code
, const char *format
, ...)
361 char buf
[BIGPATHBUFLEN
];
364 va_start(ap
, format
);
365 len
= vsnprintf(buf
, sizeof buf
, format
, ap
);
368 /* Deal with buffer overruns. Instead of panicking, just
369 * truncate the resulting string. (Note that configure ensures
370 * that we have a vsnprintf() that doesn't ever return -1.) */
371 if (len
> sizeof buf
- 1) {
372 static const char ellipsis
[] = "[...]";
374 /* Reset length, and zero-terminate the end of our buffer */
375 len
= sizeof buf
- 1;
378 /* Copy the ellipsis to the end of the string, but give
379 * us one extra character:
381 * v--- null byte at buf[sizeof buf - 1]
383 * -> abcd[...]00 <-- now two null bytes at end
385 * If the input format string has a trailing newline,
386 * we copy it into that extra null; if it doesn't, well,
387 * all we lose is one byte. */
388 memcpy(buf
+len
-sizeof ellipsis
, ellipsis
, sizeof ellipsis
);
389 if (format
[strlen(format
)-1] == '\n') {
394 rwrite(code
, buf
, len
, 0);
397 /* This is like rprintf, but it also tries to print some
398 * representation of the error code. Normally errcode = errno.
400 * Unlike rprintf, this always adds a newline and there should not be
401 * one in the format string.
403 * Note that since strerror might involve dynamically loading a
404 * message catalog we need to call it once before chroot-ing. */
405 void rsyserr(enum logcode code
, int errcode
, const char *format
, ...)
408 char buf
[BIGPATHBUFLEN
];
411 strlcpy(buf
, RSYNC_NAME
": ", sizeof buf
);
412 len
= (sizeof RSYNC_NAME
": ") - 1;
414 va_start(ap
, format
);
415 len
+= vsnprintf(buf
+ len
, sizeof buf
- len
, format
, ap
);
418 if (len
< sizeof buf
) {
419 len
+= snprintf(buf
+ len
, sizeof buf
- len
,
420 ": %s (%d)\n", strerror(errcode
), errcode
);
422 if (len
>= sizeof buf
)
423 exit_cleanup(RERR_MESSAGEIO
);
425 rwrite(code
, buf
, len
, 0);
428 void rflush(enum logcode code
)
432 if (am_daemon
|| code
== FLOG
)
435 if (code
== FINFO
&& !am_server
)
443 /* A generic logging routine for send/recv, with parameter substitiution. */
444 static void log_formatted(enum logcode code
, const char *format
, const char *op
,
445 struct file_struct
*file
, const char *fname
,
446 struct stats
*initial_stats
, int iflags
,
449 char buf
[MAXPATHLEN
+1024], buf2
[MAXPATHLEN
], fmt
[32];
457 /* We expand % codes one by one in place in buf. We don't
458 * copy in the terminating null of the inserted strings, but
459 * rather keep going until we reach the null of the format. */
460 total
= strlcpy(buf
, format
, sizeof buf
);
461 if (total
> MAXPATHLEN
) {
462 rprintf(FERROR
, "log-format string is WAY too long!\n");
463 exit_cleanup(RERR_MESSAGEIO
);
468 for (p
= buf
; (p
= strchr(p
, '%')) != NULL
; ) {
473 while (isDigit(p
) && c
- fmt
< (int)(sizeof fmt
) - 8)
490 strlcat(fmt
, ".0f", sizeof fmt
);
491 snprintf(buf2
, sizeof buf2
, fmt
,
492 (double)F_LENGTH(file
));
496 strlcat(fmt
, "u", sizeof fmt
);
497 snprintf(buf2
, sizeof buf2
, fmt
,
498 uid_ndx
? F_OWNER(file
) : 0);
502 if (!gid_ndx
|| file
->flags
& FLAG_SKIP_GROUP
)
505 strlcat(fmt
, "u", sizeof fmt
);
506 snprintf(buf2
, sizeof buf2
, fmt
,
512 strlcat(fmt
, "ld", sizeof fmt
);
513 snprintf(buf2
, sizeof buf2
, fmt
,
518 n
= c
= timestring(file
->modtime
);
519 while ((c
= strchr(p
, ' ')) != NULL
)
523 c
= buf2
+ MAXPATHLEN
- PERMSTRING_SIZE
- 1;
524 permstring(c
, file
->mode
);
525 n
= c
+ 1; /* skip the type char */
533 strlcpy(c
, fname
, MAXPATHLEN
);
535 c
= f_name(file
, NULL
);
536 if (am_sender
&& F_PATHNAME(file
)) {
537 pathjoin(buf2
, sizeof buf2
,
538 F_PATHNAME(file
), c
);
539 clean_fname(buf2
, 0);
541 strlcpy(c
, buf2
, MAXPATHLEN
);
545 } else if (am_daemon
&& *c
!= '/') {
546 pathjoin(buf2
, sizeof buf2
,
547 curr_dir
+ module_dirlen
, c
);
548 clean_fname(buf2
, 0);
550 strlcpy(c
, buf2
, MAXPATHLEN
);
564 strlcpy(c
, fname
, MAXPATHLEN
);
566 c
= f_name(file
, NULL
);
567 if (S_ISDIR(file
->mode
))
568 strlcat(c
, "/", MAXPATHLEN
);
572 if (hlink
&& *hlink
) {
574 strlcpy(buf2
, " => ", sizeof buf2
);
575 } else if (S_ISLNK(file
->mode
) && !fname
) {
577 strlcpy(buf2
, " -> ", sizeof buf2
);
582 strlcpy(buf2
, " ", sizeof buf2
);
584 strlcat(fmt
, "s", sizeof fmt
);
585 snprintf(buf2
+ 4, sizeof buf2
- 4, fmt
, n
);
589 n
= lp_name(module_id
);
592 n
= timestring(time(NULL
));
602 b
= stats
.total_written
-
603 initial_stats
->total_written
;
605 b
= stats
.total_read
-
606 initial_stats
->total_read
;
608 strlcat(fmt
, ".0f", sizeof fmt
);
609 snprintf(buf2
, sizeof buf2
, fmt
, (double)b
);
614 b
= stats
.total_written
-
615 initial_stats
->total_written
;
617 b
= stats
.total_read
-
618 initial_stats
->total_read
;
620 strlcat(fmt
, ".0f", sizeof fmt
);
621 snprintf(buf2
, sizeof buf2
, fmt
, (double)b
);
625 if (iflags
& ITEM_DELETED
) {
629 n
= c
= buf2
+ MAXPATHLEN
- 32;
630 c
[0] = iflags
& ITEM_LOCAL_CHANGE
631 ? iflags
& ITEM_XNAME_FOLLOWS
? 'h' : 'c'
632 : !(iflags
& ITEM_TRANSFER
) ? '.'
633 : !local_server
&& *op
== 's' ? '<' : '>';
634 c
[1] = S_ISDIR(file
->mode
) ? 'd'
635 : IS_SPECIAL(file
->mode
) ? 'S'
636 : IS_DEVICE(file
->mode
) ? 'D'
637 : S_ISLNK(file
->mode
) ? 'L' : 'f';
638 c
[2] = !(iflags
& ITEM_REPORT_CHECKSUM
) ? '.' : 'c';
639 c
[3] = !(iflags
& ITEM_REPORT_SIZE
) ? '.' : 's';
640 c
[4] = !(iflags
& ITEM_REPORT_TIME
) ? '.'
641 : !preserve_times
|| S_ISLNK(file
->mode
) ? 'T' : 't';
642 c
[5] = !(iflags
& ITEM_REPORT_PERMS
) ? '.' : 'p';
643 c
[6] = !(iflags
& ITEM_REPORT_OWNER
) ? '.' : 'o';
644 c
[7] = !(iflags
& ITEM_REPORT_GROUP
) ? '.' : 'g';
645 c
[8] = !(iflags
& ITEM_REPORT_ATIME
) ? '.' : 'u';
646 c
[9] = !(iflags
& ITEM_REPORT_ACL
) ? '.' : 'a';
647 c
[10] = !(iflags
& ITEM_REPORT_XATTR
) ? '.' : 'x';
650 if (iflags
& (ITEM_IS_NEW
|ITEM_MISSING_DATA
)) {
651 char ch
= iflags
& ITEM_IS_NEW
? '+' : '?';
653 for (i
= 2; c
[i
]; i
++)
655 } else if (c
[0] == '.' || c
[0] == 'h' || c
[0] == 'c') {
657 for (i
= 2; c
[i
]; i
++) {
662 for (i
= 2; c
[i
]; i
++)
669 /* "n" is the string to be inserted in place of this % code. */
672 if (n
!= buf2
&& fmt
[1]) {
673 strlcat(fmt
, "s", sizeof fmt
);
674 snprintf(buf2
, sizeof buf2
, fmt
, n
);
679 /* Subtract the length of the escape from the string's size. */
682 if (len
+ total
>= (size_t)sizeof buf
) {
684 "buffer overflow expanding %%%c -- exiting\n",
686 exit_cleanup(RERR_MESSAGEIO
);
689 /* Shuffle the rest of the string along to make space for n */
690 if (len
!= (size_t)(p
- s
+ 1))
691 memmove(s
+ len
, p
+ 1, total
- (s
- buf
) + 1);
694 /* Insert the contents of string "n", but NOT its null. */
698 /* Skip over inserted string; continue looking */
702 rwrite(code
, buf
, total
, 0);
705 /* Return 1 if the format escape is in the log-format string (e.g. look for
706 * the 'b' in the "%9b" format escape). */
707 int log_format_has(const char *format
, char esc
)
714 for (p
= format
; (p
= strchr(p
, '%')) != NULL
; ) {
727 /* Log the transfer of a file. If the code is FCLIENT, the output just goes
728 * to stdout. If it is FLOG, it just goes to the log file. Otherwise we
730 void log_item(enum logcode code
, struct file_struct
*file
,
731 struct stats
*initial_stats
, int iflags
, const char *hlink
)
733 const char *s_or_r
= am_sender
? "send" : "recv";
735 if (code
!= FLOG
&& stdout_format
&& !am_server
) {
736 log_formatted(FCLIENT
, stdout_format
, s_or_r
,
737 file
, NULL
, initial_stats
, iflags
, hlink
);
739 if (code
!= FCLIENT
&& logfile_format
&& *logfile_format
) {
740 log_formatted(FLOG
, logfile_format
, s_or_r
,
741 file
, NULL
, initial_stats
, iflags
, hlink
);
745 void maybe_log_item(struct file_struct
*file
, int iflags
, int itemizing
,
748 int significant_flags
= iflags
& SIGNIFICANT_ITEM_FLAGS
;
749 int see_item
= itemizing
&& (significant_flags
|| *buf
750 || stdout_format_has_i
> 1 || (verbose
> 1 && stdout_format_has_i
));
751 int local_change
= iflags
& ITEM_LOCAL_CHANGE
&& significant_flags
;
753 if (logfile_name
&& !dry_run
&& see_item
754 && (significant_flags
|| logfile_format_has_i
))
755 log_item(FLOG
, file
, &stats
, iflags
, buf
);
756 } else if (see_item
|| local_change
|| *buf
757 || (S_ISDIR(file
->mode
) && significant_flags
)) {
758 enum logcode code
= significant_flags
|| logfile_format_has_i
? FINFO
: FCLIENT
;
759 log_item(code
, file
, &stats
, iflags
, buf
);
763 void log_delete(const char *fname
, int mode
)
766 union file_extras ex
[4]; /* just in case... */
767 struct file_struct file
;
769 int len
= strlen(fname
);
774 if (!verbose
&& !stdout_format
)
776 else if (am_server
&& protocol_version
>= 29 && len
< MAXPATHLEN
) {
778 len
++; /* directories include trailing null */
779 send_msg(MSG_DELETED
, fname
, len
, am_generator
);
781 fmt
= stdout_format_has_o_or_i
? stdout_format
: "deleting %n";
782 log_formatted(FCLIENT
, fmt
, "del.", &x
.file
, fname
, &stats
,
786 if (!logfile_name
|| dry_run
|| !logfile_format
)
789 fmt
= logfile_format_has_o_or_i
? logfile_format
: "deleting %n";
790 log_formatted(FLOG
, fmt
, "del.", &x
.file
, fname
, &stats
, ITEM_DELETED
, NULL
);
794 * Called when the transfer is interrupted for some reason.
796 * Code is one of the RERR_* codes from errcode.h, or terminating
799 void log_exit(int code
, const char *file
, int line
)
802 rprintf(FLOG
,"sent %.0f bytes received %.0f bytes total size %.0f\n",
803 (double)stats
.total_written
,
804 (double)stats
.total_read
,
805 (double)stats
.total_size
);
806 } else if (am_server
!= 2) {
809 name
= rerr_name(code
);
811 name
= "unexplained error";
813 /* VANISHED is not an error, only a warning */
814 if (code
== RERR_VANISHED
) {
815 rprintf(FWARNING
, "rsync warning: %s (code %d) at %s(%d) [%s=%s]\n",
816 name
, code
, file
, line
, who_am_i(), RSYNC_VERSION
);
818 rprintf(FERROR
, "rsync error: %s (code %d) at %s(%d) [%s=%s]\n",
819 name
, code
, file
, line
, who_am_i(), RSYNC_VERSION
);