espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-06-05 21:14:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cb4b28313bf69796b3aba0844584507bf9cf2e00
openthread/include/openthread/platform/logging.h
T
Abtin Keshavarzian cb4b28313b [logging] add support for per-instance log levels (#12740) 
This commit introduces the ability to set and manage log levels on a
per-instance basis when dynamic logging is enabled, while maintaining
backward compatibility with existing logging behaviors.

The existing `otLoggingGetLevel()` and `otLoggingSetLevel()` APIs are
repurposed to manage the "global" log level. They continue to behave
exactly as before in both single-instance and multi-instance
configurations, ensuring that existing users of these APIs do not need
to change their implementations. To provide more granular control, new
APIs `otGetLogLevel()` and `otSetLogLevel()` are added to handle
per-instance log levels.

Specifically, this commit makes the following changes:
- Adds `mLogLevel` to `Instance` to track the instance-specific log
  level.
- Renames the global log level static variable to `sGlobalLogLevel` and
  introduces `GetGlobalLogLevel()` and `SetGlobalLogLevel()` to manage
  it in a multi-instance configuration.
- Updates `otGetLogLevel()` and `otSetLogLevel()` APIs to handle
  per-instance log level retrieval and configuration. If a specific
  level is not set for an instance, it falls back to the global
  log level.
- Adds `mIsLogLevelSet` to distinguish between an explicitly set
  instance log level and the global fallback in multi-instance builds.
- Introduces `otPlatLogHandleLogLevelChanged()` platform callback to
  notify the platform when an instance-specific log level is updated.
- Updates Nexus tests to use `SetGlobalLogLevel()` instead of the
  deprecated instance `SetLogLevel()` method.
2026-03-27 00:24:49 -05:00

214 lines
7.8 KiB
C
Raw Blame History

/*
* Copyright (c) 2016, The OpenThread Authors.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @file
* @brief
* This file includes the platform abstraction for the debug log service.
*/
#ifndef OPENTHREAD_PLATFORM_LOGGING_H_
#define OPENTHREAD_PLATFORM_LOGGING_H_
#include <openthread/instance.h>
#include <openthread/platform/toolchain.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @addtogroup plat-logging
*
* @brief
* This module includes the platform abstraction for the debug log service.
*
* @{
*/
/**
* Log level None.
*
* @note Log Levels are defines so that embedded implementations can eliminate code at compile time via
* #if/#else/#endif.
*/
#define OT_LOG_LEVEL_NONE 0
/**
* Log level Critical.
*
* @note Log Levels are defines so that embedded implementations can eliminate code at compile time via
* #if/#else/#endif.
*/
#define OT_LOG_LEVEL_CRIT 1
/**
* Log level Warning.
*
* @note Log Levels are defines so that embedded implementations can eliminate code at compile time via
* #if/#else/#endif.
*/
#define OT_LOG_LEVEL_WARN 2
/**
* Log level Notice.
*
* @note Log Levels are defines so that embedded implementations can eliminate code at compile time via
* #if/#else/#endif.
*/
#define OT_LOG_LEVEL_NOTE 3
/**
* Log level Informational.
*
* @note Log Levels are defines so that embedded implementations can eliminate code at compile time via
* #if/#else/#endif.
*/
#define OT_LOG_LEVEL_INFO 4
/**
* Log level Debug.
*
* @note Log Levels are defines so that embedded implementations can eliminate code at compile time via
* #if/#else/#endif.
*/
#define OT_LOG_LEVEL_DEBG 5
/**
* Represents the log level.
*/
typedef int otLogLevel;
/**
* Represents log regions.
*
* The support for log region is removed and instead each core module can define its own name to appended to the logs.
* However, the `otLogRegion` enumeration is still defined as before to help with platforms which we may be using it
* in their `otPlatLog()` implementation. The OT core will always emit all logs with `OT_LOG_REGION_CORE`.
*/
typedef enum otLogRegion
{
OT_LOG_REGION_API = 1, ///< OpenThread API
OT_LOG_REGION_MLE = 2, ///< MLE
OT_LOG_REGION_ARP = 3, ///< EID-to-RLOC mapping.
OT_LOG_REGION_NET_DATA = 4, ///< Network Data
OT_LOG_REGION_ICMP = 5, ///< ICMPv6
OT_LOG_REGION_IP6 = 6, ///< IPv6
OT_LOG_REGION_TCP = 7, ///< TCP
OT_LOG_REGION_MAC = 8, ///< IEEE 802.15.4 MAC
OT_LOG_REGION_MEM = 9, ///< Memory
OT_LOG_REGION_NCP = 10, ///< NCP
OT_LOG_REGION_MESH_COP = 11, ///< Mesh Commissioning Protocol
OT_LOG_REGION_NET_DIAG = 12, ///< Network Diagnostic
OT_LOG_REGION_PLATFORM = 13, ///< Platform
OT_LOG_REGION_COAP = 14, ///< CoAP
OT_LOG_REGION_CLI = 15, ///< CLI
OT_LOG_REGION_CORE = 16, ///< OpenThread Core
OT_LOG_REGION_UTIL = 17, ///< Utility module
OT_LOG_REGION_BBR = 18, ///< Backbone Router (available since Thread 1.2)
OT_LOG_REGION_MLR = 19, ///< Multicast Listener Registration (available since Thread 1.2)
OT_LOG_REGION_DUA = 20, ///< Domain Unicast Address (available since Thread 1.2)
OT_LOG_REGION_BR = 21, ///< Border Router
OT_LOG_REGION_SRP = 22, ///< Service Registration Protocol (SRP)
OT_LOG_REGION_DNS = 23, ///< DNS
} otLogRegion;
/**
* Outputs logs.
*
* This platform API is used to output logs when the configuration `OPENTHREAD_CONFIG_LOG_INSTANCE_AWARE_API_ENABLE`
* is disabled. When the configuration is enabled, `otPlatLogOutput()` is used instead.
*
* Note that the support for log region is removed. The OT core will always emit all logs with `OT_LOG_REGION_CORE`
* as @p aLogRegion.
*
* @param[in] aLogLevel The log level.
* @param[in] aLogRegion The log region.
* @param[in] aFormat A pointer to the format string.
* @param[in] ... Arguments for the format specification.
*/
void otPlatLog(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, ...)
OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3, 4);
/**
* Outputs a log line.
*
* This platform API is an alternative to `otPlatLog()` and is used when the configuration
* `OPENTHREAD_CONFIG_LOG_INSTANCE_AWARE_API_ENABLE` is enabled.
*
* Unlike `otPlatLog()`, this API also provides a pointer to the OpenThread instance (`otInstance*`) from which the
* log is generated. This is particularly helpful in a multi-instance setup to distinguish logs from different
* instances. Additionally, it provides the log line as a fully formatted null-terminated string instead of
* a format string and variable arguments.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[in] aLogLevel The log level.
* @param[in] aLogLine A pointer to the null-terminated string containing the log line.
*/
void otPlatLogOutput(otInstance *aInstance, otLogLevel aLogLevel, const char *aLogLine);
/**
* Handles OpenThread log level changes.
*
* This platform function is optional. An empty weak implementation is provided by OpenThread core.
*
* This platform function is called whenever the OpenThread log level changes:
* - In a single-instance configuration, this is called when the log level changes.
* - In a multi-instance configuration, this is called when the global log level changes.
*
* @note Only applicable when `OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE=1`.
*
* @param[in] aLogLevel The new OpenThread log level.
*/
void otPlatLogHandleLevelChanged(otLogLevel aLogLevel);
/**
* Handles OpenThread instance-specific log level changes.
*
* This platform function is optional. An empty weak implementation is provided by OpenThread core.
*
* This platform function is called whenever the instance-specific log level changes:
* - In a single-instance configuration, this is called along with `otPlatLogHandleLevelChanged()`.
* - In a multi-instance configuration, if `OPENTHREAD_CONFIG_LOG_INSTANCE_AWARE_API_ENABLE` is used, this is called
* when the instance-specific log level changes.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[in] aLogLevel The new OpenThread log level for the instance.
*/
void otPlatLogHandleLogLevelChanged(otInstance *aInstance, otLogLevel aLogLevel);
/**
* @}
*/
#ifdef __cplusplus
} // extern "C"
#endif
#endif // OPENTHREAD_PLATFORM_LOGGING_H_
Reference in New Issue View Git Blame Copy Permalink