log_internal.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_LOGGING_LOG_INTERNAL_H_
#define ZEPHYR_INCLUDE_LOGGING_LOG_INTERNAL_H_
 
#include <zephyr/types.h>
#include <zephyr/sys/__assert.h>
#include <zephyr/logging/log_core.h>
#include <zephyr/sys/mpsc_pbuf.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Header contains declarations of functions used internally in the logging,
 * shared between various portions of logging subsystem. Functions are internal
 * not intended to be used outside, including logging backends.
 */
 
struct log_mpsc_pbuf {
        struct mpsc_pbuf_buffer buf;
};
 
struct log_msg_ptr {
        union log_msg_generic *msg;
};
 
void z_log_dropped(bool buffered);
 
uint32_t z_log_dropped_read_and_clear(void);
 
bool z_log_dropped_pending(void);
 
void z_log_free(void *buf);
 
/* Initialize runtime filters */
void z_log_runtime_filters_init(void);
 
/* Initialize links. */
void z_log_links_initiate(void);
 
/* Activate links.
 * Attemp to activate links,
 *
 * @param active_mask     Mask with links to activate. N bit set indicates that Nth
 * link should be activated.
 *
 * @param[in, out] offset Offset assigned to domains. Initialize to 0 before first use.
 *
 * @return Mask with links that still remain inactive.
 */
uint32_t z_log_links_activate(uint32_t active_mask, uint8_t *offset);
 
/* Notify log_core that a backend was enabled. */
void z_log_notify_backend_enabled(void);
 
static inline uint32_t *z_log_dynamic_filters_get(uint32_t source_id)
{
        return &TYPE_SECTION_START(log_dynamic)[source_id].filters;
}
 
static inline uint32_t z_log_sources_count(void)
{
        return log_const_source_id(TYPE_SECTION_END(log_const));
}
 
uint8_t z_log_ext_domain_count(void);
 
void z_log_msg_init(void);
 
void z_log_msg_commit(struct log_msg *msg);
 
union log_msg_generic *z_log_msg_claim(k_timeout_t *backoff);
 
void z_log_msg_free(union log_msg_generic *msg);
 
bool z_log_msg_pending(void);
 
static inline void z_log_notify_drop(const struct mpsc_pbuf_buffer *buffer,
                                     const union mpsc_pbuf_generic *item)
{
        ARG_UNUSED(buffer);
        ARG_UNUSED(item);
 
        z_log_dropped(true);
}
 
const char *z_log_get_tag(void);
 
static inline bool z_log_is_local_domain(uint8_t domain_id)
{
        return !IS_ENABLED(CONFIG_LOG_MULTIDOMAIN) ||
                        (domain_id == Z_LOG_LOCAL_DOMAIN_ID);
}
 
log_timestamp_t z_log_timestamp(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_LOGGING_LOG_INTERNAL_H_ */