espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-03 17:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[build] add printf literal string format checks for va_list functions (#12236)

Browse Source 
This commit introduces enhanced format string checking. It activates a
new compiler warning to identify potential issues with non-literal
format strings and systematically applies format attribute macros to
functions that handle variable arguments.
This commit is contained in:
Yakun Xu
2025-12-23 19:31:08 -08:00
committed by GitHub
parent 4c152b91aa
commit 40e693762d
10 changed files with 26 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
etc/gn/toolchain/BUILD.gn
+1
View File
@@ -31,6 +31,7 @@ toolchain("toolchain") {
"-Wall",
"-Wextra",
"-Wundef",
"-Wformat-nonliteral",
]
if (use_clang) {
cc = "clang"
include/openthread/cli.h
+4 -2
View File
@@ -41,6 +41,7 @@
#include <openthread/error.h>
#include <openthread/instance.h>
#include <openthread/platform/logging.h>
#include <openthread/platform/toolchain.h>
#ifdef __cplusplus
extern "C" {
@@ -119,7 +120,7 @@ void otCliOutputBytes(const uint8_t *aBytes, uint8_t aLength);
* @param[in] aFmt A pointer to the format string.
* @param[in] ... A matching list of arguments.
*/
void otCliOutputFormat(const char *aFmt, ...);
void otCliOutputFormat(const char *aFmt, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1, 2);
/**
* Write error code to the CLI console
@@ -138,7 +139,8 @@ void otCliAppendResult(otError aError);
* @param[in] aFormat A pointer to the format string.
* @param[in] aArgs va_list matching aFormat.
*/
void otCliPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs);
void otCliPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3, 0);
/**
* Callback to allow vendor specific commands to be added to the user command table.
include/openthread/instance.h
+1 -1
View File
@@ -52,7 +52,7 @@ extern "C" {
*
* @note This number versions both OpenThread platform and user APIs.
*/
#define OPENTHREAD_API_VERSION (564)
#define OPENTHREAD_API_VERSION (565)
/**
* @addtogroup api-instance
include/openthread/logging.h
+2 -1
View File
@@ -227,7 +227,8 @@ void otLogPlat(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aF
* @param[in] aFormat The format string.
* @param[in] aArgs Arguments for the format specification.
*/
void otLogPlatArgs(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, va_list aArgs);
void otLogPlatArgs(otLogLevel aLogLevel, const char *aPlatModuleName, const char *aFormat, va_list aArgs)
OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3, 0);
/**
* Emits a log message at a given log level.
src/cli/cli_utils.hpp
+2 -2
View File
@@ -99,7 +99,7 @@ public:
private:
static constexpr uint16_t kInputOutputLogStringSize = OPENTHREAD_CONFIG_CLI_LOG_INPUT_OUTPUT_LOG_STRING_SIZE;
void OutputV(const char *aFormat, va_list aArguments);
void OutputV(const char *aFormat, va_list aArguments) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2, 0);
otCliOutputCallback mCallback;
void *mCallbackContext;
@@ -728,7 +728,7 @@ public:
static const char *BorderRoutingStateToString(otBorderRoutingState aState);
protected:
void OutputFormatV(const char *aFormat, va_list aArguments);
void OutputFormatV(const char *aFormat, va_list aArguments) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2, 0);
#if OPENTHREAD_CONFIG_CLI_LOG_INPUT_OUTPUT_ENABLE
void LogInput(const Arg *aArgs);
src/core/common/log.hpp
+2 -1
View File
@@ -312,7 +312,8 @@ public:
static void LogAtLevel(const char *aModuleName, const char *aFormat, ...)
OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2, 3);
static void LogVarArgs(const char *aModuleName, LogLevel aLogLevel, const char *aFormat, va_list aArgs);
static void LogVarArgs(const char *aModuleName, LogLevel aLogLevel, const char *aFormat, va_list aArgs)
OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(3, 0);
#if OT_SHOULD_LOG_AT(OT_LOG_LEVEL_WARN)
static void LogOnError(const char *aModuleName, Error aError, const char *aText);
src/core/common/string.hpp
+1 -1
View File
@@ -461,7 +461,7 @@ public:
*
* @returns The string writer.
*/
StringWriter &AppendVarArgs(const char *aFormat, va_list aArgs);
StringWriter &AppendVarArgs(const char *aFormat, va_list aArgs) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2, 0);
/**
* Appends an array of bytes in hex representation (using "%02x" style) to the buffer.
src/lib/spinel/logger.cpp
+8 -5
View File
@@ -311,7 +311,7 @@ void Logger::LogSpinelFrame(const uint8_t *aFrame, uint16_t aLength, bool aTx)
VerifyOrExit(unpacked > 0, error = OT_ERROR_PARSE);
name = (key == SPINEL_PROP_RCP_TIMESTAMP) ? "timestamp" : "counter";
start += Snprintf(start, static_cast<uint32_t>(end - start), ", %s:%u", name, value);
start += Snprintf(start, static_cast<uint32_t>(end - start), ", %s:%u", name, static_cast<unsigned int>(value));
}
break;
@@ -422,7 +422,8 @@ void Logger::LogSpinelFrame(const uint8_t *aFrame, uint16_t aLength, bool aTx)
maskLength -= static_cast<spinel_size_t>(unpacked);
}
start += Snprintf(start, static_cast<uint32_t>(end - start), ", channelMask:0x%08x", channelMask);
start += Snprintf(start, static_cast<uint32_t>(end - start), ", channelMask:0x%08x",
static_cast<unsigned int>(channelMask));
}
break;
@@ -507,8 +508,9 @@ void Logger::LogSpinelFrame(const uint8_t *aFrame, uint16_t aLength, bool aTx)
start += Snprintf(start, static_cast<uint32_t>(end - start),
"... csmaCaEnabled:%u, isHeaderUpdated:%u, isARetx:%u, skipAes:%u"
", txDelay:%u, txDelayBase:%u",
csmaCaEnabled, isHeaderUpdated, isARetx, skipAes, frame.mInfo.mTxInfo.mTxDelay,
frame.mInfo.mTxInfo.mTxDelayBaseTime);
csmaCaEnabled, isHeaderUpdated, isARetx, skipAes,
static_cast<unsigned int>(frame.mInfo.mTxInfo.mTxDelay),
static_cast<unsigned int>(frame.mInfo.mTxInfo.mTxDelayBaseTime));
}
}
break;
@@ -672,7 +674,8 @@ void Logger::LogSpinelFrame(const uint8_t *aFrame, uint16_t aLength, bool aTx)
LogDebg(" stopped:%u", metrics.mStopped);
start = buf;
start += Snprintf(start, static_cast<uint32_t>(end - start), " grantGlitch:%u", metrics.mNumGrantGlitch);
start += Snprintf(start, static_cast<uint32_t>(end - start), " grantGlitch:%u",
static_cast<unsigned int>(metrics.mNumGrantGlitch));
}
break;
src/lib/spinel/logger.hpp
+3 -2
View File
@@ -50,8 +50,9 @@ protected:
void LogInfo(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2, 3);
void LogDebg(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2, 3);
uint32_t Snprintf(char *aDest, uint32_t aSize, const char *aFormat, ...);
void LogSpinelFrame(const uint8_t *aFrame, uint16_t aLength, bool aTx);
uint32_t Snprintf(char *aDest, uint32_t aSize, const char *aFormat, ...)
OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(4, 5);
void LogSpinelFrame(const uint8_t *aFrame, uint16_t aLength, bool aTx);
enum
{
third_party/tcplp/tcplp.h
Vendored
+2 -2
View File
@@ -81,8 +81,8 @@ bool tcplp_sys_accepted_connection(struct tcpcb_listen *aTcbListen,
uint16_t aPort);
void tcplp_sys_connection_lost(struct tcpcb *aTcb, uint8_t aErrNum);
void tcplp_sys_on_state_change(struct tcpcb *aTcb, int aNewState);
void tcplp_sys_log(const char *aFormat, ...);
void tcplp_sys_panic(const char *aFormat, ...);
void tcplp_sys_log(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1, 2);
void tcplp_sys_panic(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1, 2);
bool tcplp_sys_autobind(otInstance * aInstance,
const otSockAddr *aPeer,
otSockAddr * aToBind,