2 * lxc: linux Container library
4 * (C) Copyright IBM Corp. 2007, 2008
7 * Cedric Le Goater <legoater@free.fr>
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #define __STDC_FORMAT_MACROS /* Required for PRIu64 to work. */
32 #include <sys/types.h>
47 #include "lxccontainer.h"
50 #include "include/strlcpy.h"
53 /* We're logging in seconds and nanoseconds. Assuming that the underlying
54 * datatype is currently at maximum a 64bit integer, we have a date string that
55 * is of maximum length (2^64 - 1) * 2 = (21 + 21) = 42.
57 #define LXC_LOG_TIME_SIZE ((LXC_NUMSTRLEN64)*2)
60 static int syslog_enable
= 0;
61 int lxc_quiet_specified
;
62 int lxc_log_use_global_fd
;
63 static int lxc_loglevel_specified
;
65 static char log_prefix
[LXC_LOG_PREFIX_SIZE
] = "lxc";
66 static char *log_fname
= NULL
;
67 static char *log_vmname
= NULL
;
69 lxc_log_define(lxc_log
, lxc
);
71 static int lxc_log_priority_to_syslog(int priority
)
74 case LXC_LOG_LEVEL_FATAL
:
76 case LXC_LOG_LEVEL_ALERT
:
78 case LXC_LOG_LEVEL_CRIT
:
80 case LXC_LOG_LEVEL_ERROR
:
82 case LXC_LOG_LEVEL_WARN
:
84 case LXC_LOG_LEVEL_NOTICE
:
85 case LXC_LOG_LEVEL_NOTSET
:
87 case LXC_LOG_LEVEL_INFO
:
89 case LXC_LOG_LEVEL_TRACE
:
90 case LXC_LOG_LEVEL_DEBUG
:
98 /*---------------------------------------------------------------------------*/
99 static int log_append_syslog(const struct lxc_log_appender
*appender
,
100 struct lxc_log_event
*event
)
105 const char *log_container_name
= log_vmname
;
108 if (current_config
&& !log_container_name
)
109 log_container_name
= current_config
->name
;
115 va_copy(args
, *event
->vap
);
116 len
= vsnprintf(NULL
, 0, event
->fmt
, args
) + 1;
119 msg
= malloc(len
* sizeof(char));
123 rc
= vsnprintf(msg
, len
, event
->fmt
, *event
->vap
);
124 if (rc
== -1 || rc
>= len
) {
129 syslog(lxc_log_priority_to_syslog(event
->priority
),
130 "%s%s %s - %s:%s:%d - %s" ,
131 log_container_name
? log_container_name
: "",
132 log_container_name
? ":" : "",
134 event
->locinfo
->file
, event
->locinfo
->func
,
135 event
->locinfo
->line
,
142 /*---------------------------------------------------------------------------*/
143 static int log_append_stderr(const struct lxc_log_appender
*appender
,
144 struct lxc_log_event
*event
)
146 const char *log_container_name
;
148 if (event
->priority
< LXC_LOG_LEVEL_ERROR
)
151 log_container_name
= log_vmname
;
154 if (current_config
&& !log_container_name
)
155 log_container_name
= current_config
->name
;
158 fprintf(stderr
, "%s: %s%s", log_prefix
,
159 log_container_name
? log_container_name
: "",
160 log_container_name
? ": " : "");
161 fprintf(stderr
, "%s: %s: %d ", event
->locinfo
->file
,
162 event
->locinfo
->func
, event
->locinfo
->line
);
163 vfprintf(stderr
, event
->fmt
, *event
->vap
);
164 fprintf(stderr
, "\n");
169 /*---------------------------------------------------------------------------*/
170 int lxc_unix_epoch_to_utc(char *buf
, size_t bufsize
, const struct timespec
*time
)
172 int64_t epoch_to_days
, z
, era
, doe
, yoe
, year
, doy
, mp
, day
, month
,
173 d_in_s
, hours
, h_in_s
, minutes
, seconds
;
174 char nanosec
[LXC_NUMSTRLEN64
];
177 /* See https://howardhinnant.github.io/date_algorithms.html for an
178 * explanation of the algorithm used here.
181 /* Convert Epoch in seconds to number of days. */
182 epoch_to_days
= time
->tv_sec
/ 86400;
184 /* Shift the Epoch from 1970-01-01 to 0000-03-01. */
185 z
= epoch_to_days
+ 719468;
187 /* compute the era from the serial date by simply dividing by the number
188 * of days in an era (146097).
190 era
= (z
>= 0 ? z
: z
- 146096) / 146097;
192 /* The day-of-era (doe) can then be found by subtracting the era number
193 * times the number of days per era, from the serial date.
195 doe
= (z
- era
* 146097);
197 /* From the day-of-era (doe), the year-of-era (yoe, range [0, 399]) can
200 yoe
= (doe
- doe
/ 1460 + doe
/ 36524 - doe
/ 146096) / 365;
202 /* Given year-of-era, and era, one can now compute the year. */
203 year
= yoe
+ era
* 400;
205 /* Also the day-of-year, again with the year beginning on Mar. 1, can be
206 * computed from the day-of-era and year-of-era.
208 doy
= doe
- (365 * yoe
+ yoe
/ 4 - yoe
/ 100);
210 /* Given day-of-year, find the month number. */
211 mp
= (5 * doy
+ 2) / 153;
213 /* From day-of-year and month-of-year we can now easily compute
216 day
= doy
- (153 * mp
+ 2) / 5 + 1;
218 /* Transform the month number from the [0, 11] / [Mar, Feb] system to
219 * the civil system: [1, 12] to find the correct month.
221 month
= mp
+ (mp
< 10 ? 3 : -9);
223 /* The algorithm assumes that a year begins on 1 March, so add 1 before
228 /* Transform days in the epoch to seconds. */
229 d_in_s
= epoch_to_days
* 86400;
231 /* To find the current hour simply substract the Epoch_to_days from the
232 * total Epoch and divide by the number of seconds in an hour.
234 hours
= (time
->tv_sec
- d_in_s
) / 3600;
236 /* Transform hours to seconds. */
237 h_in_s
= hours
* 3600;
239 /* Calculate minutes by substracting the seconds for all days in the
240 * epoch and for all hours in the epoch and divide by the number of
241 * minutes in an hour.
243 minutes
= (time
->tv_sec
- d_in_s
- h_in_s
) / 60;
245 /* Calculate the seconds by substracting the seconds for all days in the
246 * epoch, hours in the epoch and minutes in the epoch.
248 seconds
= (time
->tv_sec
- d_in_s
- h_in_s
- (minutes
* 60));
250 /* Make string from nanoseconds. */
251 ret
= snprintf(nanosec
, LXC_NUMSTRLEN64
, "%"PRId64
, (int64_t)time
->tv_nsec
);
252 if (ret
< 0 || ret
>= LXC_NUMSTRLEN64
)
255 /* Create final timestamp for the log and shorten nanoseconds to 3
258 ret
= snprintf(buf
, bufsize
,
259 "%" PRId64
"%02" PRId64
"%02" PRId64
"%02" PRId64
260 "%02" PRId64
"%02" PRId64
".%.3s",
261 year
, month
, day
, hours
, minutes
, seconds
, nanosec
);
262 if (ret
< 0 || (size_t)ret
>= bufsize
)
268 /* This function needs to make extra sure that it is thread-safe. We had some
269 * problems with that before. This especially involves time-conversion
270 * functions. I don't want to find any localtime() or gmtime() functions or
271 * relatives in here. Not even localtime_r() or gmtime_r() or relatives. They
272 * all fiddle with global variables and locking in various libcs. They cause
273 * deadlocks when liblxc is used multi-threaded and no matter how smart you
274 * think you are, you __will__ cause trouble using them.
275 * (As a short example how this can cause trouble: LXD uses forkstart to fork
276 * off a new process that runs the container. At the same time the go runtime
277 * LXD relies on does its own multi-threading thing which we can't controll. The
278 * fork()ing + threading then seems to mess with the locking states in these
279 * time functions causing deadlocks.)
280 * The current solution is to be good old unix people and use the Epoch as our
281 * reference point and simply use the seconds and nanoseconds that have past
282 * since then. This relies on clock_gettime() which is explicitly marked MT-Safe
283 * with no restrictions! This way, anyone who is really strongly invested in
284 * getting the actual time the log entry was created, can just convert it for
285 * themselves. Our logging is mostly done for debugging purposes so don't try
286 * to make it pretty. Pretty might cost you thread-safety.
288 static int log_append_logfile(const struct lxc_log_appender
*appender
,
289 struct lxc_log_event
*event
)
291 char buffer
[LXC_LOG_BUFFER_SIZE
];
292 char date_time
[LXC_LOG_TIME_SIZE
];
295 const char *log_container_name
= log_vmname
;
298 if (current_config
) {
299 if (!lxc_log_use_global_fd
)
300 fd_to_use
= current_config
->logfd
;
302 if (!log_container_name
)
303 log_container_name
= current_config
->name
;
308 fd_to_use
= lxc_log_fd
;
313 if (lxc_unix_epoch_to_utc(date_time
, LXC_LOG_TIME_SIZE
, &event
->timestamp
) < 0)
316 n
= snprintf(buffer
, sizeof(buffer
),
317 "%s%s%s %s %-8s %s - %s:%s:%d - ",
319 log_container_name
? " " : "",
320 log_container_name
? log_container_name
: "",
322 lxc_log_priority_to_string(event
->priority
),
324 event
->locinfo
->file
, event
->locinfo
->func
,
325 event
->locinfo
->line
);
330 if ((size_t)n
< (sizeof(buffer
) - 1)) {
331 ret
= vsnprintf(buffer
+ n
, sizeof(buffer
) - n
, event
->fmt
, *event
->vap
);
338 if ((size_t)n
>= sizeof(buffer
))
339 n
= sizeof(buffer
) - 1;
343 return write(fd_to_use
, buffer
, n
+ 1);
346 static struct lxc_log_appender log_appender_syslog
= {
348 .append
= log_append_syslog
,
352 static struct lxc_log_appender log_appender_stderr
= {
354 .append
= log_append_stderr
,
358 static struct lxc_log_appender log_appender_logfile
= {
360 .append
= log_append_logfile
,
364 static struct lxc_log_category log_root
= {
366 .priority
= LXC_LOG_LEVEL_ERROR
,
371 struct lxc_log_category lxc_log_category_lxc
= {
373 .priority
= LXC_LOG_LEVEL_ERROR
,
374 .appender
= &log_appender_logfile
,
378 /*---------------------------------------------------------------------------*/
379 static int build_dir(const char *name
)
384 /* Make copy of string since we'll be modifying it. */
387 ERROR("Out of memory while creating directory '%s'.", name
);
392 for (p
= n
+1; p
< e
; p
++) {
396 if (access(n
, F_OK
)) {
397 ret
= lxc_unpriv(mkdir(n
, 0755));
398 if (ret
&& errno
!= EEXIST
) {
399 SYSERROR("failed to create directory '%s'.", n
);
410 /*---------------------------------------------------------------------------*/
411 static int log_open(const char *name
)
416 fd
= lxc_unpriv(open(name
, O_CREAT
| O_WRONLY
|
417 O_APPEND
| O_CLOEXEC
, 0666));
419 ERROR("failed to open log file \"%s\" : %s", name
,
427 newfd
= fcntl(fd
, F_DUPFD_CLOEXEC
, 3);
429 ERROR("failed to dup log fd %d : %s", fd
, strerror(errno
));
436 * Build the path to the log file
437 * @name : the name of the container
438 * @lxcpath : the lxcpath to use as a basename or NULL to use LOGPATH
439 * Returns malloced path on success, or NULL on failure
441 static char *build_log_path(const char *name
, const char *lxcpath
)
444 int len
, ret
, use_dir
;
449 #if USE_CONFIGPATH_LOGS
456 * If USE_CONFIGPATH_LOGS is true or lxcpath is given, the resulting
458 * '$logpath' + '/' + '$name' + '/' + '$name' + '.log' + '\0'
460 * If USE_CONFIGPATH_LOGS is false the resulting path will be:
461 * '$logpath' + '/' + '$name' + '.log' + '\0'
463 len
= strlen(name
) + 6; /* 6 == '/' + '.log' + '\0' */
470 len
+= strlen(lxcpath
) + 1 + strlen(name
) + 1; /* add "/$container_name/" */
472 len
+= strlen(lxcpath
) + 1;
478 ret
= snprintf(p
, len
, "%s/%s/%s.log", lxcpath
, name
, name
);
480 ret
= snprintf(p
, len
, "%s/%s.log", lxcpath
, name
);
482 if (ret
< 0 || ret
>= len
) {
489 extern void lxc_log_close(void)
494 if (lxc_log_fd
== -1)
503 * This can be called:
504 * 1. when a program calls lxc_log_init with no logfile parameter (in which
505 * case the default is used). In this case lxc.loge can override this.
506 * 2. when a program calls lxc_log_init with a logfile parameter. In this
507 * case we don't want lxc.log to override this.
508 * 3. When a lxc.log entry is found in config file.
510 static int __lxc_log_set_file(const char *fname
, int create_dirs
)
512 /* we are overriding the default. */
513 if (lxc_log_fd
!= -1)
519 if (strlen(fname
) == 0) {
524 #if USE_CONFIGPATH_LOGS
525 /* We don't build_dir for the default if the default is i.e.
526 * /var/lib/lxc/$container/$container.log.
530 if (build_dir(fname
)) {
531 ERROR("failed to create dir for log file \"%s\" : %s", fname
,
536 lxc_log_fd
= log_open(fname
);
537 if (lxc_log_fd
== -1)
540 log_fname
= strdup(fname
);
544 static int _lxc_log_set_file(const char *name
, const char *lxcpath
, int create_dirs
)
549 logfile
= build_log_path(name
, lxcpath
);
551 ERROR("could not build log path");
554 ret
= __lxc_log_set_file(logfile
, create_dirs
);
559 extern int lxc_log_syslog(int facility
)
561 struct lxc_log_appender
*appender
;
563 openlog(log_prefix
, LOG_PID
, facility
);
564 if (!lxc_log_category_lxc
.appender
) {
565 lxc_log_category_lxc
.appender
= &log_appender_syslog
;
569 appender
= lxc_log_category_lxc
.appender
;
570 /* Check if syslog was already added, to avoid creating a loop */
572 if (appender
== &log_appender_syslog
) {
573 /* not an error: openlog re-opened the connection */
576 appender
= appender
->next
;
579 appender
= lxc_log_category_lxc
.appender
;
580 while (appender
->next
!= NULL
)
581 appender
= appender
->next
;
582 appender
->next
= &log_appender_syslog
;
587 extern void lxc_log_enable_syslog(void)
594 * Called from lxc front-end programs (like lxc-create, lxc-start) to
595 * initalize the log defaults.
597 extern int lxc_log_init(struct lxc_log
*log
)
599 int lxc_priority
= LXC_LOG_LEVEL_ERROR
;
602 if (lxc_log_fd
!= -1) {
603 WARN("lxc_log_init called with log already initialized");
608 lxc_priority
= lxc_log_priority_to_int(log
->level
);
610 if (!lxc_loglevel_specified
) {
611 lxc_log_category_lxc
.priority
= lxc_priority
;
612 lxc_loglevel_specified
= 1;
615 if (!lxc_quiet_specified
) {
617 lxc_log_category_lxc
.appender
->next
= &log_appender_stderr
;
621 lxc_log_set_prefix(log
->prefix
);
624 log_vmname
= strdup(log
->name
);
627 if (strcmp(log
->file
, "none") == 0)
629 ret
= __lxc_log_set_file(log
->file
, 1);
630 lxc_log_use_global_fd
= 1;
632 /* if no name was specified, there nothing to do */
639 log
->lxcpath
= LOGPATH
;
641 /* try LOGPATH if lxcpath is the default for the privileged containers */
642 if (!geteuid() && strcmp(LXCPATH
, log
->lxcpath
) == 0)
643 ret
= _lxc_log_set_file(log
->name
, NULL
, 0);
647 ret
= _lxc_log_set_file(log
->name
, log
->lxcpath
, 1);
649 /* try LOGPATH in case its writable by the caller */
651 ret
= _lxc_log_set_file(log
->name
, NULL
, 0);
655 * If !file, that is, if the user did not request this logpath, then
656 * ignore failures and continue logging to console
658 if (!log
->file
&& ret
!= 0) {
659 INFO("Ignoring failure to open default logfile.");
667 * This is called when we read a lxc.log.level entry in a lxc.conf file. This
668 * happens after processing command line arguments, which override the .conf
669 * settings. So only set the level if previously unset.
671 extern int lxc_log_set_level(int *dest
, int level
)
673 if (level
< 0 || level
>= LXC_LOG_LEVEL_NOTSET
) {
674 ERROR("invalid log priority %d", level
);
681 extern int lxc_log_get_level(void)
683 return lxc_log_category_lxc
.priority
;
686 extern bool lxc_log_has_valid_level(void)
688 int log_level
= lxc_log_get_level();
689 if (log_level
< 0 || log_level
>= LXC_LOG_LEVEL_NOTSET
)
695 * This is called when we read a lxc.logfile entry in a lxc.conf file. This
696 * happens after processing command line arguments, which override the .conf
697 * settings. So only set the file if previously unset.
699 extern int lxc_log_set_file(int *fd
, const char *fname
)
706 if (build_dir(fname
)) {
707 ERROR("failed to create dir for log file \"%s\" : %s", fname
,
712 *fd
= log_open(fname
);
718 extern const char *lxc_log_get_file(void)
723 extern void lxc_log_set_prefix(const char *prefix
)
725 /* We don't care if thte prefix is truncated. */
726 (void)strlcpy(log_prefix
, prefix
, sizeof(log_prefix
));
729 extern const char *lxc_log_get_prefix(void)
734 extern void lxc_log_options_no_override()
736 lxc_quiet_specified
= 1;
737 lxc_loglevel_specified
= 1;