3 * Copyright (c) 2012-2020 Samsung Electronics Co., Ltd
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to deal
7 * in the Software without restriction, including without limitation the rights
8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 * copies of the Software, and to permit persons to whom the Software is furnished
10 * to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
38 #include <buffer_traits.h>
39 #include "deduplicate.h"
40 #include <dynamic_config.h>
41 #include "extra_sinks.h"
43 #include "logconfig.h"
44 #include "loglimiter.h"
46 #define DEFAULT_CONFIG_LIMITER false
47 #define DEFAULT_CONFIG_PLOG true
48 #define DEFAULT_CONFIG_DEBUGMODE 0
49 #define DEFAULT_CONFIG_LIMITER_APPLY_TO_ALL_BUFFERS 0
52 /* A pseudo-backend that does nothing. Useful for removing the overhead of dlog
53 * for debugging and measurement purposes, also it simplifies some checking as
54 * the `write_to_log` pointer below never needs to be NULL. Note that features
55 * independent of the backend (such as limiter or dynamic config) are controlled
56 * separately if dlog is to be disabled completely and that minimal overhead is
57 * always present (e.g. building the message via vprintf). */
58 static int write_to_log_null (log_id_t log_id, log_priority prio, const char *tag, const char *msg, struct timespec *tp_mono, int32_t pid, int32_t tid)
60 return DLOG_ERROR_NONE;
64 * @brief Points to a function which writes a log message
65 * @details The function pointed to depends on the backend used
66 * @param[in] log_id ID of the buffer to log to. Belongs to (LOG_ID_INVALID, LOG_ID_MAX) non-inclusive
67 * @param[in] prio Priority of the message.
68 * @param[in] tag The message tag, identifies the sender.
69 * @param[in] msg The contents of the message.
70 * @return Returns the number of bytes written on success and a negative error value on error.
71 * @see __dlog_init_backend
73 int (*write_to_log)(log_id_t log_id, log_priority prio, const char *tag, const char *msg, struct timespec *tp_mono, int32_t pid, int32_t tid) = write_to_log_null;
74 void (*destroy_backend)(void);
76 int (*stash_failed_log)(log_id_t log_id, log_priority prio, const char *tag, const char *msg) = NULL;
78 static int stash_critical(log_id_t log_id, log_priority prio, const char *tag, const char *msg);
81 pthread_rwlock_t log_limiter_lock = PTHREAD_RWLOCK_INITIALIZER;
82 static pthread_mutex_t log_construction_lock = PTHREAD_MUTEX_INITIALIZER;
83 static bool is_initialized = false;
85 extern void __dlog_init_pipe(const struct log_config *conf);
86 extern void __dlog_init_android(const struct log_config *conf);
87 extern void __dlog_init_zero_copy();
89 extern void prepend_container_tag_if_in_container(size_t buf_size, char buf[static buf_size], int *len);
92 struct limiter_data *limiter_data;
93 static bool dynamic_config;
94 static bool plog[SINKS_MAX];
95 static bool plog_default_values[SINKS_MAX];
96 static bool enable_secure_logs = true;
97 static bool enable_critical = true;
99 static bool should_disable_cancels;
101 static int debugmode;
102 static int fatal_assert;
103 static int limiter_apply_to_all_buffers;
104 static _Atomic log_priority priority_filter_level = DLOG_VERBOSE;
106 /* Cache pid and tid to avoid up to two syscalls per log.
107 * PID is reset at fork() via pthread_atfork().
108 * TID is reset by being a thread local var. */
109 static int32_t cached_pid = 0;
110 _Thread_local int32_t cached_tid = 0;
112 static inline int32_t get_cached_pid()
117 static inline int32_t get_cached_tid()
119 return (cached_tid = cached_tid ?: gettid());
122 static void update_cached_pid()
124 cached_pid = getpid();
125 // tid is reset passively (to 0) by virtue of being thread-local
128 /* Here, static_config is the original config from /etc/dlog.conf{,.d} which can be overriden,
129 * but comes back if the override is removed. both_config additionally contains dynamic rules
130 * (by default from /run/dlog/filters.d) which can be changed in the runtime.
131 * The static_config has to be kept separately, so that we can go back to it when dynamic rules change.
132 * Note that most functions only use static_config, since the parameters can't be changed in runtime. */
133 static void __configure_limiter(struct log_config *static_config, struct log_config *both_config)
135 assert(static_config);
142 limiter_data = __log_limiter_create(static_config);
143 if (limiter_data && dynamic_config)
144 __log_limiter_update(limiter_data, both_config);
145 limiter = (bool)limiter_data;
147 should_disable_cancels |= limiter; // due to locks
150 static int __configure_backend(struct log_config *config)
154 const char *const backend = log_config_claim_backend(config);
158 if (!strcmp(backend, "pipe")) {
159 __dlog_init_pipe(config);
160 should_disable_cancels = true;
161 } else if (!strcmp(backend, "logger"))
162 __dlog_init_android(config);
163 else if (!strcmp(backend, "zero-copy"))
164 __dlog_init_zero_copy(config);
165 else if (!strcmp(backend, "null"))
166 ; // already the default
173 static void __set_plog_default_values(void)
175 for (size_t i = 0; i < NELEMS(plog); ++i)
176 plog_default_values[i] = plog[i];
179 static void __initialize_plog(const struct log_config *config)
183 /* plog stands for "platform logging", which is why
184 * non-platform (i.e. application) buffers ignore it */
185 const bool plog_default = log_config_get_boolean(config, "plog", DEFAULT_CONFIG_PLOG);
186 for (size_t i = 0; i < NELEMS(plog); ++i)
187 plog[i] = is_platform_buffer(i) ? plog_default : true;
189 __set_plog_default_values();
192 static void __configure_parameters(struct log_config *static_config, struct log_config *both_config)
194 assert(static_config);
197 __initialize_plog(static_config);
198 __update_plog(static_config);
199 /* Like in __configure_limiter, we also check the dynamic rules. However, we make sure to
200 * set the default values to the ones generated by the static rules first. */
201 __set_plog_default_values();
202 __update_plog(both_config);
204 enable_secure_logs = log_config_get_boolean(both_config, "enable_secure_logs", enable_secure_logs);
205 enable_critical = log_config_get_boolean(both_config, "enable_critical", enable_critical);
206 debugmode = log_config_get_int(both_config, "debugmode", DEFAULT_CONFIG_DEBUGMODE);
207 fatal_assert = access(DEBUGMODE_FILE, F_OK) != -1;
208 limiter = log_config_get_boolean(both_config, "limiter", DEFAULT_CONFIG_LIMITER);
209 limiter_apply_to_all_buffers = log_config_get_int(both_config,
210 "limiter_apply_to_all_buffers",
211 DEFAULT_CONFIG_LIMITER_APPLY_TO_ALL_BUFFERS);
213 stash_failed_log = NULL;
214 const char *stash_failed_log_method = log_config_get(both_config, "stash_failed_log_method");
215 if (stash_failed_log_method) {
217 if (strcmp(stash_failed_log_method, "critical") == 0)
218 stash_failed_log = stash_critical;
223 void __update_plog(const struct log_config *conf)
227 for (size_t i = 0; i < NELEMS(plog); ++i) {
228 char key[MAX_CONF_KEY_LEN];
229 const int r = snprintf(key, sizeof key, "enable_%s", log_name_by_id((log_id_t)i));
232 plog[i] = log_config_get_boolean(conf, key, plog_default_values[i]);
237 * @brief Configure the library
238 * @details Reads relevant config values
239 * @remarks This is more or less a constructor, but there are some obstacles
240 * to using it as such (i.e. with attribute constructor):
242 * - some important pieces of the system link to dlog, they start very early
243 * such that dlog can't properly initialize (which lasts for program lifetime)
244 * but don't actually log anything until later on and would be fine under lazy
245 * initialisation. The way to do it "properly" would be to expose this function
246 * into the API so that people can manually call it when they're ready, but
247 * one of the design goals of the current API is that it requires absolutely no
248 * other calls than `dlog_print`. Changing it would require somebody with a
249 * bird's eye view of the system to produce a design so I wouldn't count on it.
251 * - the constructor would need to have as high of a priority as possible (so as
252 * to minimize the risk of another library's constructor using uninitialized data)
253 * but at the same time others might want some room to wrap functions before
254 * dlog uses them (think mprobe/mcheck). This would also require a design pass.
259 bool __configure(void)
261 __attribute__((cleanup(log_config_free))) struct log_config static_config = {};
262 __attribute__((cleanup(log_config_free))) struct log_config both_config = {};
264 cached_pid = getpid();
266 if (log_config_read(&static_config) < 0)
268 log_config_copy(&both_config, &static_config);
270 dynamic_config = __dynamic_config_create(&both_config);
272 __configure_parameters(&static_config, &both_config);
274 if (!__configure_backend(&both_config)) {
275 __dynamic_config_destroy();
276 dynamic_config = false;
280 __configure_deduplicate(&both_config);
281 __configure_limiter(&static_config, &both_config);
283 pthread_atfork(NULL, NULL, update_cached_pid);
288 static void __attribute__((constructor(101))) __install_pipe_handler(void)
290 /* We mask SIGPIPE signal because most applications do not install their
291 * own SIGPIPE handler. Default behaviour in SIGPIPE case is to abort the
292 * process. SIGPIPE occurs when e.g. dlog daemon closes read pipe endpoint.
294 * We do this in the library constructor (at maximum priority) and not
295 * during regular (lazy) initialisation so as to prevent overwriting the
296 * program's actual signal handler, if it has one.
298 * In theory this is not required for the Android logger backend; however,
299 * this early we don't yet know the backend and also it is good to behave
300 * consistently in this regard anyway.
302 * We don't revert this in a destructor because Unix signals are bonkers
303 * and we have no way to do this cleanly. Most libdlog users don't use
304 * runtime linking so this would mostly done at program exit either way. */
305 signal(SIGPIPE, SIG_IGN);
308 static void __attribute__((constructor(102))) __set_output_buffering(void)
310 /* If stdout and/or stderr is redirected to dlog (service, driver)
311 * it is best if we buffer lines, otherwise the following can happen:
312 * - no buffering: service/driver recives every single byte (precisely
313 * every single write*(2) call), causing it to either buffer the data
314 * anyway (service), or print logs at random places (driver)
315 * - full buffering: service/driver receives several hundred lines,
316 * which results in one giant entry being added (driver) or long delays
317 * before logs appear (service) */
318 if (getenv(DLOG_ENV_STDOUT_LINE_BUFFERED))
321 if (getenv(DLOG_ENV_STDERR_LINE_BUFFERED))
325 static bool first = true;
326 static bool initialize(void)
331 /* The mutex acts as a barrier, but otherwise the C language's
332 * machine abstraction is single-threaded. This means that the
333 * compiler is free to rearrange calls inside the mutex according
334 * to the as-if rule because it doesn't care if another thread can
335 * access it in parallel. In particular, `is_initialized = true`
336 * directly after `__configure()` could be rearranged to go in
337 * front of it because it is not touched inside that function
338 * if the compiler thinks it helps somehow (not unlikely: since
339 * it is checked before the mutex, it is very probable for it to
340 * still be in the CPU register or something like that). On top
341 * of that, some architectures (in particular, armv7l) don't have
342 * strict memory guarantees and can reorder actual memory stores
343 * on their own, even if the compiler didn't do anything fancy
344 * when creating machine code. For more info about the issue,
345 * see https://www.aristeia.com/Papers/DDJ_Jul_Aug_2004_revised.pdf
347 * Ultimately this means that there needs to be some sort of
348 * barrier between `__configure` and `is_initialized = true`,
349 * and the simplest way to achieve that is to just wait until
350 * the second entry into the mutex. */
353 pthread_mutex_lock(&log_construction_lock);
355 first = !__configure();
357 is_initialized = true;
359 pthread_mutex_unlock(&log_construction_lock);
364 * @brief Fatal assertion
365 * @details Conditionally crash the sucka who sent the log
366 * @param[in] prio Priority of the log
368 static void __dlog_fatal_assert(int prio)
370 assert(!fatal_assert || (prio != DLOG_FATAL));
374 * @brief Check log validity
375 * @details Checks whether the log is valid and eligible for printing
376 * @param[in] log_id The target buffer ID
377 * @param[in] prio The log's priority
378 * @param[in] tag The log's tag
379 * @param[in] only_core Whether non-core buffers are rejected
380 * @return DLOG_ERROR_NONE on success, else an error code.
381 * @retval DLOG_ERROR_INVALID_PARAMETER Invalid parameter
383 static int dlog_check_validity(log_id_t log_id, int prio, const char *tag, bool only_core)
387 return DLOG_ERROR_INVALID_PARAMETER;
389 if (!is_buffer_valid(log_id))
390 return DLOG_ERROR_INVALID_PARAMETER;
392 /* The interface here is a bit confused. `__dlog_print` is nominally
393 * for platform logging and is not necessarily supposed to use the
394 * APPS buffer (which is a core buffer, but not a platform buffer),
395 * yet the internal interface (dlog-internal.h) exposes macros for
396 * platform programs to log into APPS. The design is probably too
397 * ossified to change at this point though. */
398 if (only_core && !is_core_buffer(log_id))
399 return DLOG_ERROR_INVALID_PARAMETER;
401 return DLOG_ERROR_NONE;
405 * @brief Check log against limiter rules
406 * @details Checks whether the log passes current limiter rules
407 * @param[in] log_id The target buffer ID
408 * @param[in] prio The log's priority
409 * @param[in] tag The log's tag
410 * @return DLOG_ERROR_NONE on success, else an error code.
411 * @retval DLOG_ERROR_NOT_PERMITTED Not permitted
413 static int dlog_check_limiter(log_id_t log_id, int prio, const char *tag)
415 if (!debugmode && prio <= DLOG_DEBUG)
416 return DLOG_ERROR_NOT_PERMITTED;
419 __dynamic_config_update(limiter_data);
422 struct pass_log_result should_log = { .decision = DECISION_DENIED };
424 /* Since the only `wrlock` is done by the dynamic config, we can avoid
425 * the `rdlock` entirely if the config is static. This sounds unsafe
426 * but lets us save an entire syscall, which is a lot (both comparatively
427 * and because it compounds). */
428 if (!dynamic_config || !pthread_rwlock_rdlock(&log_limiter_lock)) {
429 should_log = __log_limiter_pass_log_pid(limiter_data, tag, prio, get_cached_pid());
431 pthread_rwlock_unlock(&log_limiter_lock);
434 switch (should_log.decision) {
435 case DECISION_DENIED:
436 return DLOG_ERROR_NOT_PERMITTED;
438 case DECISION_TAG_LIMIT_EXCEEDED_MESSAGE:
439 case DECISION_PID_LIMIT_EXCEEDED_MESSAGE: {
441 int result = clock_gettime(CLOCK_MONOTONIC, &tp);
443 return DLOG_ERROR_NOT_PERMITTED;
445 snprintf(buf, sizeof(buf),
446 "Your log has been blocked due to per-%s limit of %d logs per %d seconds.",
447 should_log.decision == DECISION_TAG_LIMIT_EXCEEDED_MESSAGE ? "tag" : "PID",
448 should_log.logs_per_period, should_log.period_s);
449 write_to_log(log_id, prio, tag, buf, &tp, get_cached_pid(), get_cached_tid());
450 return DLOG_ERROR_NOT_PERMITTED;
453 case DECISION_ALLOWED:
458 /* This can change due to __dynamic_config_update(), but is atomic and its
459 * value implies nothing else so does not need to be under a lock. */
461 return DLOG_ERROR_NOT_PERMITTED;
463 return DLOG_ERROR_NONE;
466 static int __write_to_log_critical_section(log_id_t log_id, int prio, const char *tag, const char *fmt, va_list ap, bool check_should_log)
468 if ((check_should_log || limiter_apply_to_all_buffers) && (dlog_check_limiter(log_id, prio, tag) < 0))
469 return DLOG_ERROR_NONE;
471 log_id = get_log_id_from_sink(log_id);
473 char buf[LOG_MAX_PAYLOAD_SIZE];
474 int len = vsnprintf(buf, sizeof buf, fmt, ap);
476 return DLOG_ERROR_NONE;
477 else if (len >= sizeof buf)
478 len = sizeof buf - 1;
480 // Temporary workaround, see temporary.c
481 prepend_container_tag_if_in_container(sizeof buf, buf, &len);
485 if (deduplicate_func && !clock_gettime(CLOCK_MONOTONIC, &tp)) {
486 dlog_deduplicate_e ret = deduplicate_func(buf, len, &tp);
487 if (ret == DLOG_DEDUPLICATE)
488 return DLOG_ERROR_NONE;
489 else if (ret == DLOG_DO_NOT_DEDUPLICATE_BUT_WARN)
490 deduplicate_warn(buf, sizeof buf, len);
491 r = write_to_log(log_id, prio, tag, buf, &tp, get_cached_pid(), get_cached_tid());
493 r = write_to_log(log_id, prio, tag, buf, NULL, get_cached_pid(), get_cached_tid());
495 if (r < 0 && stash_failed_log)
496 r = stash_failed_log(log_id, prio, tag, buf);
501 static int __write_to_log(log_id_t log_id, int prio, const char *tag, const char *fmt, va_list ap, bool check_should_log, bool secure_log)
503 int ret = dlog_check_validity(log_id, prio, tag, check_should_log);
507 if (check_should_log && prio < priority_filter_level)
508 return DLOG_ERROR_NONE;
510 /* Threads can be cancelled before they give up a lock.
511 * Therefore cancellation is temporarily disabled as
512 * long as the current set of features uses a lock.
514 * This solution is comparatively simple and cheap.
515 * The other solutions (cleanup handlers, robust mutexes)
516 * would be much more complicated and also inflict larger
517 * runtime costs. The downside of disabling cancellation
518 * is not a problem in our case because it is temporary
519 * and very brief so we don't keep an obsolete thread
520 * for much longer than we otherwise would. */
521 int old_cancel_state;
522 if (should_disable_cancels)
523 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &old_cancel_state);
526 // TODO: We could consider stashing the failed log here
527 ret = DLOG_ERROR_NOT_PERMITTED;
528 else if (secure_log && !enable_secure_logs)
531 ret = __write_to_log_critical_section(log_id, prio, tag, fmt, ap, check_should_log);
533 if (should_disable_cancels)
534 pthread_setcancelstate(old_cancel_state, NULL);
539 int __critical_log_append_timestamp(char *buf, size_t buflen)
541 /* NB: the timestamp may slightly differ from the one that gets
542 * added onto the copy that goes into the regular buffer, and
543 * timestamp acquisition is duplicated. This would ideally be
544 * solved, but timestamps are currently added fairly deep in
545 * backend-specific functions so for now this will have to do.
546 * Also, since we're the sender, there is just this one set of
547 * timestamps, i.e. the send timestamp! The usual alternative
548 * set of receive timestamps will never have the opportunity
549 * to get added to the entry since this log is supposed to end
550 * up straight in the file (there's potentially the trusted
551 * writer binary but we're trying to keep the set of actions
552 * it needs to do to the minimum and those timestamps would
553 * in practice be the same anyway). */
556 clock_gettime(CLOCK_REALTIME, &ts);
557 const time_t tt = ts.tv_sec;
558 const long int real_millisec = ts.tv_nsec / 1000000;
559 clock_gettime(CLOCK_MONOTONIC, &ts);
561 struct tm *const ptm = localtime_r(&tt, &tmBuf);
562 assert(ptm); // we're in a short lived fork so asserts are fine and make things simple
564 int len = strftime(buf, buflen, "%m-%d %H:%M:%S", ptm);
567 int tmp_len = snprintf(buf + len, buflen - len, ".%03ld", real_millisec);
569 assert(tmp_len < buflen - len);
572 tmp_len = strftime(buf + len, buflen - len, "%z ", ptm);
573 assert(tmp_len != 0);
576 tmp_len = snprintf(buf + len, buflen - len, "%5lu.%03ld", ts.tv_sec, ts.tv_nsec / 1000000);
578 assert(tmp_len < buflen - len);
584 int __critical_log_build_msg(char *buf, size_t buflen, pid_t main_pid, pid_t main_tid, log_id_t log_id, int prio, const char *tag, const char *fmt, va_list ap)
586 int len = __critical_log_append_timestamp(buf, buflen);
587 const int metadata_len = snprintf(buf + len, buflen - len, " P%5d T%5d B%-6s %c/%-8s: ",
590 log_name_by_id(log_id),
591 filter_pri_to_char(prio),
592 tag ?: "CRITICAL_NO_TAG");
593 assert(metadata_len > 0);
594 if (metadata_len >= buflen - len)
595 return buflen - 1; // can genuinely happen with an exceedingly large tag
598 const int content_len = vsnprintf(buf + len, buflen - len, fmt, ap);
599 assert(content_len >= 0); // 0 is legit with format == ""
600 if (content_len >= buflen - len)
608 __attribute__ ((noreturn))
610 void __critical_log_child(pid_t main_pid, pid_t main_tid, log_id_t log_id, int prio, const char *tag, const char *fmt, va_list ap)
612 char buf[LOG_MAX_PAYLOAD_SIZE + 128]; // extra space for some metadata
613 const int len = __critical_log_build_msg(buf, sizeof buf - 1, main_pid, main_tid, log_id, prio, tag, fmt, ap);
617 static const char *const path = "/usr/libexec/dlog-log-critical";
618 execl(path, path /* argv[0] convention */, buf, (char *) NULL);
621 /* Compilers are sometimes smart enough to recognize _exit's
622 * noreturn attribute, even if we wrap it with something that
623 * returns. This causes it to behave in unexpected ways, for
624 * example it can blow up the program regardless or it can
625 * optimize some conditionals out (and incorrectly enter them
626 * after the exit call fails to actually exit). This makes it
627 * unsuitable for tests. */
629 _exit(1); // not the regular `exit` so as not to trigger any `atexit` handlers prematurely
633 #ifndef UNIT_TEST // contains forks and exits, these don't work well with wrapping (see above)
634 void __critical_log(log_id_t log_id, int prio, const char *tag, const char *fmt, va_list ap)
636 /* Critical log functionality is mostly done in a separate binary
637 * to handle security correctly (else every process would have to
638 * possess the necessary privilege to write onto that file, which
639 * would be opening a fairly nasty can of worms from the security
640 * point of view). Our use of exec() is why a simple thread would
641 * not suffice and we're resorting to a fork.
643 * The double fork, much like a double barreled 12 gauge shotgun,
644 * is an elegant solution designed to stop a zombie army. We'd be
645 * creating zombie processes if we didn't wait() for the children
646 * we spawn, but we don't really want to do that since it results
647 * in a needless delay. Instead, the writer process is actually a
648 * grandchild, with our direct child exiting immediately just for
649 * us to have something to wait on that is guaranteed not to take
650 * too long. The orphaned grandchild is adopted by init, who will
651 * take care to reap it when it dies. In addition to avoiding the
652 * delay, the client will not have any unexpected children (which
653 * could ruin logic in its own waits).
656 * ┌───────┐ ┌─────────┐ ┌─────────────┐ ┌────────┐
657 * │ pid 1 ├──>│ libdlog ├──>│ immediately ├──>│ execs │
658 * │ init │ │ client │ │ exits │ │ writer │
659 * └───────┘ └─────────┘ └─────────────┘ └────────┘
661 * Afterwards, libdlog has no children:
662 * ┌───────┐ ┌─────────┐ ┌────────┐
663 * │ pid 1 ├──>│ libdlog │ ┌─────────>│ writer │
664 * │ init ├─┐ │ client │ │ │ binary │
665 * └───────┘ │ └─────────┘ │ └────────┘
666 * └──────────────────────┘
671 if (!enable_critical)
674 const pid_t main_pid = getpid();
675 const pid_t main_tid = gettid();
677 const int temporary_exiter_pid = fork();
678 if (temporary_exiter_pid < 0)
680 if (temporary_exiter_pid != 0) {
681 waitpid(temporary_exiter_pid, NULL, 0);
685 const int child_pid = fork();
691 __critical_log_child(main_pid, main_tid, log_id, prio, tag, fmt, ap);
694 // LCOV_EXCL_START : stashing is essentially error handling.
695 static void stash_critical_inner(log_id_t log_id, log_priority prio, const char *tag, const char *fmt, ...)
700 __critical_log(log_id, prio, tag, fmt, ap);
704 static int stash_critical(log_id_t log_id, log_priority prio, const char *tag, const char *msg)
706 stash_critical_inner(log_id, prio, tag, "FAILED TO LOG: %s", msg);
711 EXPORT_API int __dlog_critical_print(log_id_t log_id, int prio, const char *tag, const char *fmt, ...)
716 __critical_log(log_id, prio, tag, fmt, ap);
720 int ret = __dlog_vprint(log_id, prio, tag, fmt, ap);
727 EXPORT_API int dlog_set_minimum_priority(int priority)
729 if (priority < DLOG_DEFAULT || priority > DLOG_PRIO_MAX)
730 return DLOG_ERROR_INVALID_PARAMETER;
732 priority_filter_level = priority;
733 return DLOG_ERROR_NONE;
738 * @details Print a log line
739 * @param[in] log_id The target buffer ID
740 * @param[in] prio Priority
742 * @param[in] fmt Format (same as printf)
743 * @param[in] ap Argument list
744 * @return Bytes written, or negative error
746 EXPORT_API int __dlog_vprint(log_id_t log_id, int prio, const char *tag, const char *fmt, va_list ap)
748 int ret = __write_to_log(log_id, prio, tag, fmt, ap, true, false);
749 __dlog_fatal_assert(prio);
756 * @details Print a log line
757 * @param[in] log_id The target buffer ID
758 * @param[in] prio Priority
760 * @param[in] fmt Format (same as printf)
761 * @return Bytes written, or negative error
763 EXPORT_API int __dlog_print(log_id_t log_id, int prio, const char *tag, const char *fmt, ...)
768 int ret = __dlog_vprint(log_id, prio, tag, fmt, ap);
776 * @details Print a log line
777 * @param[in] log_id The target buffer ID
778 * @param[in] prio Priority
780 * @param[in] fmt Format (same as printf)
781 * @return Bytes written, or negative error
783 EXPORT_API int __dlog_sec_print(log_id_t log_id, int prio, const char *tag, const char *fmt, ...)
785 if (!enable_secure_logs)
791 int ret = __write_to_log(log_id, prio, tag, fmt, ap, true, true);
792 __dlog_fatal_assert(prio);
798 EXPORT_API int dlog_vprint(log_priority prio, const char *tag, const char *fmt, va_list ap)
800 return __write_to_log(LOG_ID_APPS, prio, tag, fmt, ap, false, false);
803 EXPORT_API int dlog_print(log_priority prio, const char *tag, const char *fmt, ...)
808 int ret = dlog_vprint(prio, tag, fmt, ap);
814 EXPORT_API int dlog_vprint_dotnet(log_priority prio, const char *tag, const char *fmt, va_list ap)
816 return __write_to_log(SINK_DOTNET, prio, tag, fmt, ap, false, false);
819 EXPORT_API int dlog_print_dotnet(log_priority prio, const char *tag, const char *fmt, ...)
824 int ret = dlog_vprint_dotnet(prio, tag, fmt, ap);
830 EXPORT_API int dlog_vprint_native(log_priority prio, const char *tag, const char *fmt, va_list ap)
832 return __write_to_log(SINK_NATIVE, prio, tag, fmt, ap, false, false);
835 EXPORT_API int dlog_print_native(log_priority prio, const char *tag, const char *fmt, ...)
840 int ret = dlog_vprint_native(prio, tag, fmt, ap);
846 // LCOV_EXCL_START : for internal use only, not accessible via public API
849 * @brief Finalize DLog
850 * @details Finalizes and deallocates the library
851 * @notes Used directly in tests; brings back the pre-init state
853 void __dlog_fini(void)
855 if (destroy_backend) {
857 destroy_backend = NULL;
859 write_to_log = write_to_log_null;
860 stash_failed_log = NULL;
861 is_initialized = false;
864 enable_secure_logs = true;
865 enable_critical = false;
866 __deduplicate_destroy();
867 __log_limiter_destroy(limiter_data);
869 __dynamic_config_destroy();
870 should_disable_cancels = false;