Files
STM32F4-Base/App/iec60870/104/IEC104_Log.h
T
wandering1 c0cef2fca0 refactor(app): 去掉 App/protocol 层,104 迁入 App/iec60870/104_port
IEC 60870 是标准族(含 104/101),原 App/protocol/ 把它拆成
iec60870/(vendor 核心)+ iec104/(我方适配)两棵同级树,多一层且
看不出「104 只维护一个」。现按标准族收口:

  App/protocol/iec60870        -> App/iec60870
  App/protocol/iec104          -> App/iec60870/104_port
  App/protocol/{README.md,.gitkeep}  删除
  App/protocol/iec104/iec104_asdu.h  删除(零 include / 零注册的孤儿)

vendor 子树(104/ common/ examples/)逐字节未改:91 个 R100 重命名、
git diff --cached -M 后 0 insertions / 0 deletions,另按字节直比 89/89
一致;UPSTREAM.sha256 差异集仍等于既有 17 项受控差异,非篡改。
适配层只改注释里的路径字样,无逻辑行。

门禁配套:
- coding-standard 的 exclude 不能写祖先 App/iec60870/——rename_ref 机械
  改出的祖先形态会把 2,191 行适配层一起豁免掉。改为三条精确前缀
  common/ 104/ examples/,适配层 11/11 回到受检;vendor 直调脚本仍报
  88 处违规而钩子 Skipped,证明确实由 exclude 生效而非空跑。
- check_registration 的 KNOWN_GAPS 键与理由文本同步到新路径。

验证:Keil 0 errors 0 warnings(Code=367464 RO-data=48492
RW-data=2288 ZI-data=173544),构建日志与 .d 依赖证明 5 个适配 .o
真被编入;模拟器 0 警告并跑通 iec104-tcp 13/13 真实 TCP 回环;
pre-commit 25 Passed / 0 Failed;doc-links 30 处问题全在
IEC60870-Slave/ 供应商快照,我方文档零新增。

顺带删掉仓根误入库且零引用的 _all_hook.txt 与 _scope.txt。
2026-11-18 14:15:10 +08:00

104 lines
3.5 KiB
C

/**
* IEC104_Log.h —— IEC 60870-5-104 通用日志接口。
*
* 本模块独立于报文解析和链路状态,只负责:
* 1. 按最低日志级别过滤消息;
* 2. 为消息添加本地时间和级别前缀;
* 3. 将完整消息交给用户回调或默认标准流。
*
* 公共名称全部使用 IEC104_ 前缀,可与 POSIX <syslog.h> 同时使用。
* 构建与测试命令见 IEC104测试文档.md。
*/
#ifndef IEC104_LOG_H
#define IEC104_LOG_H
#ifdef __cplusplus
extern "C" {
#endif
/**
* 日志级别。
*
* 数值必须按严重程度递增,因为过滤条件为:
* message_level >= minimum_level
*/
typedef enum {
IEC104_LOG_LEVEL_DEBUG = 0,
IEC104_LOG_LEVEL_INFO = 1,
IEC104_LOG_LEVEL_WARN = 2,
IEC104_LOG_LEVEL_ERR = 3
} IEC104_LogLevel_t;
/**
* 日志回调。
*
* level:本条消息的 IEC104_LOG_LEVEL_* 级别。
* msg 指向已经拼接时间戳和级别、但不含行末换行的临时字符串;
* 字符串只在本次回调期间有效,需要保留时应由回调自行复制。
* 回调可能从不同调用线程执行,如需共享数据应自行同步。
*/
typedef void (*IEC104_LogCb_t)(int level, const char *msg);
/**
* 功能:设置日志输出回调。
* 输入参数:cb——回调函数;传入空指针时恢复默认标准流输出。
* 输出参数:无。
* 返回值:无。
* 说明:应在开始并发输出日志之前完成配置。
*/
extern void IEC104_Set_Log_Callback(IEC104_LogCb_t cb);
/**
* 功能:设置允许输出的最低日志级别。
* 输入参数:min_level——IEC104_LOG_LEVEL_* 之一。
* 输出参数:无。
* 返回值:无。
* 说明:应在开始并发输出日志之前完成配置。
*/
extern void IEC104_Set_Log_Level(int min_level);
/**
* 功能:格式化并输出一条日志。
* 输入参数:level——日志级别;fmt——非空且不含行末换行的 printf 风格格式串;
* 其后为格式化参数。
* 输出参数:无;日志交给回调,或默认写入 stdout/stderr。
* 返回值:无。
* 说明:时间戳、级别与正文合计最多保留511字节,不含结尾空字符及默认输出追加的换行;
* 超出部分按字节截断,不保证UTF-8等多字节字符的边界完整。
*/
#if defined(__GNUC__) || defined(__clang__)
extern void IEC104_Log_Emit(int level, const char *fmt, ...)
__attribute__((format(printf, 2, 3)));
#else
/**
* 功能:格式化并输出一条带时间戳和级别前缀的日志。
* 输入参数:level——日志级别;fmt——非空且不含行末换行的 printf 格式串;
* 其后为格式化参数。
* 输出参数:无;优先交给用户回调,否则写入默认标准流。
* 返回值:无。
* 说明:低级别消息直接忽略;超出固定缓冲区的内容按字节截断,可能截断多字节字符。
*/
extern void IEC104_Log_Emit(int level, const char *fmt, ...);
#endif
/*
* 便捷输出宏。
*
* 使用模块前缀,避免与 POSIX <syslog.h> 的 LOG_DEBUG、LOG_INFO、
* LOG_ERR 等常量冲突。宏至少需要传入一个格式串参数。
*/
#define IEC104_LOG_DEBUG(...) \
IEC104_Log_Emit(IEC104_LOG_LEVEL_DEBUG, __VA_ARGS__)
#define IEC104_LOG_INFO(...) \
IEC104_Log_Emit(IEC104_LOG_LEVEL_INFO, __VA_ARGS__)
#define IEC104_LOG_WARN(...) \
IEC104_Log_Emit(IEC104_LOG_LEVEL_WARN, __VA_ARGS__)
#define IEC104_LOG_ERR(...) \
IEC104_Log_Emit(IEC104_LOG_LEVEL_ERR, __VA_ARGS__)
#ifdef __cplusplus
}
#endif
#endif /* IEC104_LOG_H */