C语言与物联网之数据校验算法之校验和

所谓校验和，就是将被校验数据进行累加，并舍弃累加溢出的位，最终得到的1个或多个字节的结果。

校验和算法用C语言实现

/* 代码片段，摘自：plat_lib.c */
/******************************************************************************
 *  @fn      uint8_t calc_checksum(uint8_t const *p_data, int32_t data_len)
 *
 *  @brief   计算校验和的算法，校验和占用1个字节。
 *
 *  @param   p_data    待校验数据的首地址
 *  @param   data_len  数据长度
 *
 *  @return  checksum, 0x00 ~ 0xFF
 */
uint8_t calc_checksum(uint8_t const *p_data, int32_t data_len)
{
    uint8_t sum = 0;
  
    while (data_len--) {
        sum += *p_data++;
    }
    
    return sum;
}

使用1个字节的校验和还是多个字节的校验和会在协议(protocol)中定义，另外，在数据包中，校验和的计算从哪个字节开始到哪个字节结束，也会在协议中定义。

比如，某通信协议中，对包数据做如下定义：

• 协议头：固定使用0xAA
• 长度：数据部分的长度
• 数据：元数据，最多20字节
• 校验：对协议头、长度、数据进行累加，舍弃溢出的位。

定义数据结构描述如下：

/* 代码片段，摘自：protocol.h */
#define MAX_DATA_LEN  20     /* 元数据的最大长度 */
typedef struct tag_data_pack {
    uint8_t sop;                           /* 协议头 */
    uint8_t len;                           /* 长度 */
    uint8_t datas[MAX_DATA_LEN + 1]; /* 数据 + 1字节的校验 */
}data_pack_t;

C语言测试代码

/* 代码片段，摘自：protocol.c */
/******************************************************************************
 *  @fn      int32_t make_data_pack(uint8_t const *p_data, 
 *               int32_t data_len,
 *               data_pack_t *p_pack)
 *
 *  @brief   根据协议将元数据打包成数据包，并返回数据包的长度。
 *
 *  @param   p_data   元数据首地址
 *  @param   data_len 元数据长度
 *  @param   p_pack   数据包
 *
 *  @return  数据包的总长度
 */
int32_t make_data_pack(uint8_t const *p_data, 
    int32_t data_len, 
    data_pack_t *p_pack)
{
    // PF_ASSERT(NULL != p_data);
    // PF_ASSERT(data_len > 0);
    // PF_ASSERT(NULL != p_pack);
  
    p_pack->sop = 0xAA;
    p_pack->len = (uint8_t)data_len;
    memcpy(p_pack->datas, p_data, data_len);
    p_pack->datas[data_len] = 
        calc_checksum((uint8_t const *)p_pack, data_len + 2);
    
    /* 协议头，1字节；长度，1字节；校验，1字节 */
    return data_len + 3;
}

/* 代码片段，摘自：test.c */
/******************************************************************************
 *  @fn      int main(int argc, char * argv[])
 *
 *  @brief   主函数
 *
 *  @param   argc 命令函传入的参数数量
 *  @param   argv 命令行传入的参数字符串数组
 *
 *  @return  0
 */
int main(int argc, char * argv[])
{
    data_pack_t pack;
    uint8_t user_data[] = {0x01, 0x02, 0x03, 0x04, 0x05};
    int32_t pack_len;

    pack_len = make_data_pack(user_data, sizeof(user_data), &pack);

    /* 以16进制形式打印数据包 */
    log_dump("pack", (uint8_t const *)&pack, pack_len);
    
    return 0;
}

Makefile

TARGET = checksum_test
SOURCE  := $(wildcard *.c) $(wildcard *.cpp)
OBJS    := $(patsubst %.c,%.o,$(patsubst %.cpp,%.o,$(SOURCE)))

$(TARGET): $(OBJS)
    gcc -o $@ $(OBJS)
clean:
    rm -rf *.o $(TARGET)

测试结果

// 编译
[root@localhost checksum]# make
cc    -c -o protocol.o protocol.c
cc    -c -o plat_lib.o plat_lib.c
cc    -c -o plat_log.o plat_log.c
cc    -c -o test.o test.c
gcc -o checksum_test protocol.o plat_lib.o plat_log.o test.o

// 运行测试程序
[root@localhost checksum]# ./checksum_test
[pack], 0xAA, 0x05, 0x01, 0x02, 0x03, 0x04, 0x05, 0xBE

优缺点

校验和校验算法由于规则简单，因此算法也很简单，算法运行时占用系统资源少、计算速度非常快；缺点是当多个字节同时出现错误时，可能无法检出，比如：原始数据为：0xAA, 0x05, 0x01, 0x02, 0x03, 0x04, 0x05, 0xBE，有2个字节的数据出现错误：0xAA, 0x05, 0x02, 0x02, 0x02, 0x04, 0x05, 0xBE，通过校验和无法检出错误。