Files
STM32F4-Base/IEC60870-Slave/test/iec104_tcp_fixture.h
T
STF bdcc8b6500
CI / L0 静态门禁 (pre-commit) (push) Failing after 7m46s
CI / L0.5 主机侧单测 (MSVC) (push) Successful in 21s
添加遥控、参数装载、文件传输等业务
2026-11-16 22:19:17 -08:00

350 lines
18 KiB
C
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/* IEC104主机测试共用的可控TCP环境:真实TcpServer/传输路径 + 内存Net后端。
* 每个测试程序只在一个翻译单元包含本文件;这里包含TcpServer.c并定义全部Net接口,
* 构建时不能再单独链接TcpServer.c或平台Net后端。头文件本身不注册或运行测试用例。
* fake保存本次场景的输入、输出、时钟和故障开关;所有调用串行,不创建socket或真实等待。
* 可用begin/end建立基本STARTDT会话,或由业务专项自行创建Slave并设置sut。
* static inline辅助允许各专项只使用所需操作,避免未用静态函数触发编译警告。 */
#ifndef IEC104_TCP_FIXTURE_H
#define IEC104_TCP_FIXTURE_H
#include "iec104_test_config.h"
#include <IEC104_TcpServer.c>
#include <stdio.h>
#include <stdlib.h>
/* 断言失败立即以非零状态结束测试,不继续使用可能已经不一致的夹具状态。 */
#define CHECK(x) do { if (!(x)) { fprintf(stderr, "%s:%d: %s\n", __func__, __LINE__, #x); exit(1); } } while (0)
/* ============================================================================
* [COMMON/STATE] 跨文件共用夹具:可控Net状态、收发字节及基础APDU
* ============================================================================ */
/* 输入方向为主站 -> 子站,输出方向相反;[offset,length)是尚未被Recv消费的输入,
* [0,sent_bytes)保存Send已经接手的原始字节,不表示主站已接收或ACK。
* recv_limit/send_limit限制单次实际复制量,0表示不人为分段;所有开关和计数均由用例持有。
* 重置fake恢复时钟、缓冲游标及故障开关,但不关闭或销毁协议对象,须先完成上一场景收尾。 */
static struct {
uint64_t now; /* 唯一单调毫秒源;Poll/Wait不会自动推进,倒退边界也由用例显式构造。 */
uint8_t input[65536]; /* push追加的输入原文;数据未全部消费前不压紧。 */
uint8_t output[65536]; /* Send复制的输出原文;解析与确认由各测试负责。 */
size_t length, offset, recv_limit, sent_bytes, send_limit;
/* accept_pending按布尔开关消费;调用次数在错误或WOULD_BLOCK路径也会累计。
* stop_confirmations只统计单次完整写出6字节STOPDT_CON的情形,不是通用流解析计数。 */
unsigned accept_pending, recv_calls, send_calls, stop_confirmations;
/* snapshot_calls统计输入快照次数;send_blocked模拟背压,recv_eof在输入耗尽后生效;
* recv_retry是连续RETRY次数,pending_error使快照查询失败且不改available。 */
unsigned snapshot_calls, send_blocked, recv_eof, recv_retry, pending_error;
unsigned init_error, listen_error, send_error; /* 非零注入对应接口ERROR;0沿用正常路径。 */
} fake;
static IEC104_TcpServer_t *sut; /* 当前被测TCP实例;创建方负责Close、通知排空及Destroy。 */
/* 原始APDU/ASDU模板:启停激活帧,以及CA=1、IOA=1、值=1的单点突发ASDU。 */
static const uint8_t start_act[] = {0x68, 4, 7, 0, 0, 0};
static const uint8_t stop_act[] = {0x68, 4, 0x13, 0, 0, 0};
static const uint8_t asdu[] = {1, 1, 3, 0, 1, 0, 1, 0, 0, 1};
/* ============================================================================
* [COMMON/NET] 跨文件共用后端:Net接口、故障注入与单调时钟
* ============================================================================ */
/**
* 功能:夹具只通过返回枚举表达故障,不模拟平台错误码。
* 输入参数:result——用例预设或期望的处理结果;error——底层错误码存储。
* 输出参数:error——底层错误码存储。
* 返回值:模拟网络操作结果,保留成功、暂不可用、重试及错误状态。
* 说明:error可为NULL。
*/
static inline IEC104_NetResult_t net_result(IEC104_NetResult_t result, int *error)
{
if (error != NULL) { *error = 0; }
return result;
}
/**
* 功能:返回模拟网络初始化结果,按开关注入初始化失败。
* 输入参数:error——底层错误码存储。
* 输出参数:error——底层错误码存储。
* 返回值:模拟网络操作结果,保留成功、暂不可用、重试及错误状态。
* 说明:不申请系统资源;开关仅控制Init结果,不清空fake或重置已有用例设置。
*/
IEC104_NetResult_t IEC104_Net_Init(int *error)
{
return net_result(fake.init_error ? IEC104_NET_ERROR : IEC104_NET_OK, error);
}
/**
* 功能:提供模拟网络清理入口,不分配或释放系统网络资源。
* 输入参数:无。
* 输出参数:无。
* 返回值:无。
* 说明:没有系统网络资源可清理;清理后的缓冲与计数仍保留供用例核对。
*/
void IEC104_Net_Cleanup(void) {}
/**
* 功能:提供夹具固定的无效参数错误码。
* 输入参数:无。
* 输出参数:无。
* 返回值:固定错误码 22,用于模拟无效参数错误。
* 说明:固定的无效参数诊断值;不依赖宿主errno或Winsock错误码。
*/
int IEC104_Net_Invalid_Argument_Error(void) { return 22; }
/**
* 功能:成功时返回固定监听句柄1并原样回填端口。
* 输入参数:address——监听地址或接收报文的公共地址(只读);port——监听端口;listener——监听套接字;bound_port——实际绑定端口的存储;error——底层错误码存储。
* 输出参数:listener——监听套接字;bound_port——实际绑定端口的存储;error——底层错误码存储。
* 返回值:模拟网络操作结果,保留成功、暂不可用、重试及错误状态。
* 说明:不校验地址,也不为port=0分配实际端口。
* listener/bound_port须有效,listen_error失败路径不改两者。
*/
IEC104_NetResult_t IEC104_Net_Listen(const char *address, uint16_t port,
IEC104_NetSocket_t *listener, uint16_t *bound_port, int *error)
{
(void)address;
if (fake.listen_error) { return net_result(IEC104_NET_ERROR, error); }
*listener = 1;
*bound_port = port;
return net_result(IEC104_NET_OK, error);
}
/**
* 功能:每次accept_pending只产生一个固定客户端句柄2。
* 输入参数:listener——监听套接字;client——客户端套接字;peer——对端信息存储;error——底层错误码存储。
* 输出参数:client——客户端套接字;peer——对端信息存储;error——底层错误码存储。
* 返回值:模拟网络操作结果,保留成功、暂不可用、重试及错误状态。
* 说明:下一次接入须由用例重新置位。
* client/peer须有效;无待接入时返回WOULD_BLOCK,并将client设为无效句柄。
*/
IEC104_NetResult_t IEC104_Net_Accept(IEC104_NetSocket_t listener,
IEC104_NetSocket_t *client, IEC104_NetPeer_t *peer, int *error)
{
CHECK(listener == 1);
*client = IEC104_NET_INVALID_SOCKET;
if (!fake.accept_pending) { return net_result(IEC104_NET_WOULD_BLOCK, error); }
fake.accept_pending = 0;
*client = 2;
memset(peer, 0, sizeof(*peer));
memcpy(peer->address, "127.0.0.1", sizeof("127.0.0.1"));
peer->port = 12000;
return net_result(IEC104_NET_OK, error);
}
/**
* 功能:socket须为客户端句柄2,data/capacity由真实接收器提供。
* 输入参数:socket——测试套接字句柄;data——数据片段;capacity——调用方提供的缓冲容量。
* 输出参数:data——写入或读出的数据字节。
* 返回值:网络 I/O 结果结构,包含状态及本次实际传输字节数。
* 说明:最多消费capacity及recv_limit限制的字节。
* RETRY先于数据返回;无输入时按recv_eof选择EOF或WOULD_BLOCK,以模拟FIN之前仍有数据的半关闭连接。
*/
IEC104_NetIoResult_t IEC104_Net_Recv(IEC104_NetSocket_t socket, void *data, size_t capacity)
{
IEC104_NetIoResult_t result = {IEC104_NET_WOULD_BLOCK, 0, 0};
size_t count = fake.length - fake.offset;
CHECK(socket == 2);
++fake.recv_calls;
if (fake.recv_retry) { --fake.recv_retry; result.result = IEC104_NET_RETRY; return result; }
if (count == 0) {
if (fake.recv_eof) { result.result = IEC104_NET_EOF; }
return result;
}
if (count > capacity) { count = capacity; }
if (fake.recv_limit && count > fake.recv_limit) { count = fake.recv_limit; }
memcpy(data, fake.input + fake.offset, count);
fake.offset += count;
result.result = IEC104_NET_OK;
result.transferred = count;
return result;
}
/**
* 功能:socket须为客户端句柄2、available须有效。
* 输入参数:socket——测试套接字句柄;available——当前待接收字节数的存储;error——底层错误码存储。
* 输出参数:available——当前待接收字节数的存储;error——底层错误码存储。
* 返回值:模拟网络操作结果,保留成功、暂不可用、重试及错误状态。
* 说明:只取剩余字节快照,不消费input。
* 调度测试借snapshot_calls检查一次续收批次不重复扩张快照;故障时保留available原值。
*/
IEC104_NetResult_t IEC104_Net_Pending_Input(
IEC104_NetSocket_t socket, uint32_t *available, int *error)
{
CHECK(socket == 2 && available != NULL);
++fake.snapshot_calls;
if (fake.pending_error) { return net_result(IEC104_NET_ERROR, error); }
*available = (uint32_t)(fake.length - fake.offset);
return net_result(IEC104_NET_OK, error);
}
/**
* 功能:socket须为客户端句柄2,data非NULL且length>0。
* 输入参数:socket——测试套接字句柄;data——数据片段(只读);length——字节长度。
* 输出参数:无。
* 返回值:网络 I/O 结果结构,包含状态及本次实际传输字节数。
* 说明:成功只复制实际接手的前缀,允许短写。
* ERROR优先于背压,两者均不改输出缓冲;缓冲装满是用例设置错误,由CHECK直接失败。
*/
IEC104_NetIoResult_t IEC104_Net_Send(IEC104_NetSocket_t socket, const void *data, size_t length)
{
IEC104_NetIoResult_t result = {IEC104_NET_OK, length, 0};
const uint8_t *bytes = (const uint8_t *)data;
CHECK(socket == 2 && data != NULL && length > 0);
++fake.send_calls;
if (fake.send_error) { result.result = IEC104_NET_ERROR; result.transferred = 0; return result; }
if (fake.send_blocked) { result.result = IEC104_NET_WOULD_BLOCK; result.transferred = 0; return result; }
if (fake.send_limit && length > fake.send_limit) { length = fake.send_limit; result.transferred = length; }
CHECK(fake.sent_bytes + length <= sizeof(fake.output));
memcpy(fake.output + fake.sent_bytes, data, length);
fake.sent_bytes += length;
if (length == IEC104_APCI_LEN && bytes[2] == 0x23) { ++fake.stop_confirmations; }
return result;
}
/**
* 功能:根据当前模拟输入和发送状态返回所关注事件的就绪位。
* 输入参数:listener——监听套接字;client——客户端套接字;interest——关注的就绪事件位;timeout——等待或执行期限(毫秒);ready——就绪事件位的存储;error——底层错误码存储。
* 输出参数:ready——就绪事件位的存储;error——底层错误码存储。
* 返回值:模拟网络操作结果,保留成功、暂不可用、重试及错误状态。
* 说明:ready须有效;仅返回interest所请求的就绪位,忽略句柄及timeout,不等待也不推进fake.now。
* READ只由未消费输入决定,不额外为EOF/RETRY置位;WRITE表示可尝试,Send仍可返回WOULD_BLOCK。
*/
IEC104_NetResult_t IEC104_Net_Wait(IEC104_NetSocket_t listener, IEC104_NetSocket_t client,
uint32_t interest, uint32_t timeout, uint32_t *ready, int *error)
{
(void)listener; (void)client; (void)timeout;
*ready = 0;
if (fake.accept_pending && (interest & IEC104_NET_EVENT_ACCEPT)) { *ready |= IEC104_NET_EVENT_ACCEPT; }
if (fake.offset < fake.length && (interest & IEC104_NET_EVENT_READ)) { *ready |= IEC104_NET_EVENT_READ; }
if (interest & IEC104_NET_EVENT_WRITE) { *ready |= IEC104_NET_EVENT_WRITE; }
return net_result(IEC104_NET_OK, error);
}
/**
* 功能:模拟套接字关闭成功,并保留夹具中的收发记录和计数。
* 输入参数:socket——测试套接字句柄;error——底层错误码存储。
* 输出参数:error——底层错误码存储。
* 返回值:模拟网络操作结果,保留成功、暂不可用、重试及错误状态。
* 说明:所有句柄均视为关闭成功;保留收发原文与计数,协议对象的生命周期仍由真实TCP层维护。
*/
IEC104_NetResult_t IEC104_Net_Close(IEC104_NetSocket_t socket, int *error)
{
(void)socket;
return net_result(IEC104_NET_OK, error);
}
/**
* 功能:读取夹具当前单调时刻,供真实协议层进行期限判断。
* 输入参数:无。
* 输出参数:无。
* 返回值:本次采样的时钟毫秒值。
* 说明:无读取副作用;测试可在包含夹具时重命名本符号,再用包装器注入跨读时刻变化。
*/
uint64_t IEC104_Net_Now_Ms(void) { return fake.now; }
/* ============================================================================
* [COMMON/TRANSPORT] 跨文件共用辅助:输入拼帧、Poll、通知消费及连接生命周期
* ============================================================================ */
/**
* 功能:复制主站原文到输入尾部,调用后bytes可复用。
* 输入参数:bytes——报文字节缓冲区(只读);length——字节长度。
* 输出参数:无。
* 返回值:无。
* 说明:本函数不Poll,也不解析帧边界。
* 仅在旧输入全部消费后复用数组起点;仍有输入时须保证数组尾部容得下本次length。
*/
static inline void push(const uint8_t *bytes, size_t length)
{
if (fake.offset == fake.length) { fake.offset = fake.length = 0; }
CHECK(fake.length + length <= sizeof(fake.input));
memcpy(fake.input + fake.length, bytes, length);
fake.length += length;
}
/**
* 功能:ns/nr是未左移的帧序号,按协议序号掩码截取。
* 输入参数:ns——I 帧发送序号 N(S);nr——I 帧接收确认序号 N(R);length——字节长度。
* 输出参数:无。
* 返回值:无。
* 说明:length包含6字节APCI,须在APDU长度范围内。
* 载荷以0x5a填充,仅用于传输测试,不保证是合法业务ASDU;业务专项应自行组包后调用push。
* 这里只追加输入,不推进Poll或自动增加下一帧序号。
*/
static inline void push_i(unsigned ns, unsigned nr, uint16_t length)
{
uint8_t frame[IEC104_MAX_APDU_LEN];
CHECK(length >= IEC104_APCI_LEN && length <= sizeof(frame));
memset(frame, 0x5a, sizeof(frame));
ns &= IEC104_SEQUENCE_MASK;
nr &= IEC104_SEQUENCE_MASK;
frame[0] = 0x68; frame[1] = (uint8_t)(length - 2U);
frame[2] = (uint8_t)(ns << 1); frame[3] = (uint8_t)(ns >> 7);
frame[4] = (uint8_t)(nr << 1); frame[5] = (uint8_t)(nr >> 7);
push(frame, length);
}
/**
* 功能:对已初始化的被测 TCP 实例执行一次轮询并检查返回结果。
* 输入参数:无。
* 输出参数:无。
* 返回值:无。
* 说明:sut须为已初始化实例;只推进一轮零等待Poll,不消费应用通知;默认时钟不会随Poll推进。
*/
static inline void poll_once(void) { CHECK(IEC104_TcpServer_Poll(sut, 0, NULL) == IEC104_TCP_OK); }
/**
* 功能:只消费sut已产生的全部通知并返回数量。
* 输入参数:无。
* 输出参数:无。
* 返回值:本次消费的 TCP 通知数量。
* 说明:不分派业务、不Poll,通知原文被有意丢弃。
* 仅适合无需逐条检查内容的步骤;业务专项应自行读取并分派生命周期及I帧通知。
*/
static inline unsigned drain(void)
{
unsigned count = 0;
IEC104_TcpEvent_t event;
IEC104_TcpEventResult_t result;
while ((result = IEC104_TcpServer_NextEvent(sut, &event)) == IEC104_TCP_EVENT_READY) { ++count; }
CHECK(result == IEC104_TCP_EVENT_EMPTY);
return count;
}
/**
* 功能:建立基本TCP测试会话:清零fake并置时刻1000ms,创建sut,接入客户端,再完成STARTDT。
* 输入参数:无。
* 输出参数:无。
* 返回值:无。
* 说明:确认两轮各产生一条通知并读空,返回时链路已STARTED;发送窗口k取回执容量以配合容量矩阵。
* 调用前须释放上一场景实例;本函数会覆盖sut,并清除用例预先设置的故障或时间值。
*/
static inline void begin(void)
{
IEC104_TcpServerConfig_t config;
memset(&fake, 0, sizeof(fake));
fake.now = 1000;
fake.accept_pending = 1;
sut = IEC104_TcpServer_Create();
CHECK(sut != NULL);
test_transport_config(&config);
config.protocol.link.k = IEC104_TCP_RECORD_CAPACITY;
CHECK(IEC104_TcpServer_Init(sut, &config, NULL) == IEC104_TCP_OK);
poll_once();
CHECK(drain() == 1);
push(start_act, sizeof(start_act));
poll_once();
CHECK(drain() == 1);
CHECK(sut->connection.link_state.dt_state == IEC104_DT_STARTED);
}
/**
* 功能:与begin配对:Close后读空收尾通知,再Destroy归还静态槽。
* 输入参数:无。
* 输出参数:无。
* 返回值:无。
* 说明:失败会立即结束测试。
* 返回后sut不再是可用句柄,fake原文与计数仍可读取;此处不处理业务模块或站点引用。
*/
static inline void end(void)
{
CHECK(IEC104_TcpServer_Close(sut, NULL) == IEC104_TCP_OK);
drain();
CHECK(IEC104_TcpServer_Destroy(sut, NULL) == IEC104_TCP_OK);
}
/**
* 功能:构造S帧并追加到输入。
* 输入参数:nr——I 帧接收确认序号 N(R)。
* 输出参数:无。
* 返回值:无。
* 说明:nr是下一期望接收序号,调用方须给出协议范围内的值。
* 不自动Poll;该ACK何时到达发送管理器由测试下一次网络推进决定。
*/
static inline void push_ack(unsigned nr)
{
uint8_t frame[] = {0x68, 4, 1, 0, 0, 0};
frame[4] = (uint8_t)(nr << 1); frame[5] = (uint8_t)(nr >> 7);
push(frame, sizeof(frame));
}
#endif