锐客网

  1. 首页 > it技术 > >

Stm32调试之assert_param() 断言机制

stm32

转载自：http://archive.ednchina.com/bbs.ednchina.com/BLOG_ARTICLE_3033910.HTM?source=related_blog
感谢原作者的分享
最近公司不忙，就想着充实下自己，偶然看到了“断言机制”，也认真试验了一番，便赶紧记录下来，也是为了温故而知新，再者与大家分享一下！
首先看一个应用：（网络不好，图片不好上传，原谅我偷懒）
void TIM_DeInit(TIM_TypeDef* TIMx)
{
/* Check the parameters */
assert_param(IS_TIM_ALL_PERIPH(TIMx));

if (TIMx == TIM1)
{
RCC_APB2PeriphResetCmd(RCC_APB2Periph_TIM1, ENABLE);
RCC_APB2PeriphResetCmd(RCC_APB2Periph_TIM1, DISABLE);
}
}
这段代码是Stm32固件库中的，IS_TIM_ALL_PERIPH(TIMx)这个函数的原形是判断TIMx是否等于TIM1-TIM17中的任意一个，若相等则返回一个true，否则，返回false。明白了这个之后呢，我们就来看 assert_param（）这个函数（stm32f10x_conf.h）
#ifdef USE_FULL_ASSERT
//此处本来有英文注释
#define assert_param(expr) ((expr) ? (void)0 : assert_failed((uint8_t *)__FILE__, __LINE__))
/* Exported functions ------------------------------------------------------- */
void assert_failed(uint8_t* file, uint32_t line);
#else
#define assert_param(expr) ((void)0)
#endif /* USE_FULL_ASSERT */
我们可以看到assert_param对参数进行了判断，如果参数为ture，则执行(void)0,空操作。如果为false则执行assert_failed()。下一行则对assert_failed()进行了声明，那么我们则可以在其他C文件中对此函数进行定义
我们在main.c中对此进行了原形定义：
#ifdef USE_FULL_ASSERT
void assert_failed(uint8_t* file, uint32_t line)
{
printf("Wrong parameters value: file %s on line %d\r\n", file, line);
while(1);
}
#end


在进入断言后，则函数停止运行，同时输出错误信息，stm固件库中的大部分函数都有断言机制！
我在实验中发现如果进入断言，则函数好像是不会运行的，比如我设置的Led本来是在进入断言之前的，但是没有能开启led
知道了这些我们也可以在自己的函数中加入断言了(记得定义USE_FULL_ASSERT)


void TTest(uint8_t k)
{
assert_param((k%2)?1:0);
//函数实现
return;
}


上面的函数是对k进行运算，断言机制则判断是k是否是奇数，如果为偶数，则会进入assert，输出报错信息，中止信息，这种机制在调试过程中应该是很有用的！
上面说了，会输出报错信息，但具体会输出什么内容呢？那么我们就把TTest(4); 加入到main中看会出现什么情况，结果串口输出如下信息：（串口信息是通过printf函数重定义进行输出的，至于printf的具体实现，之前写过，现在就不再多说了）
rong parameters value: file ..\User\main.c on line 211
报错信息清晰的输出了错误所在文件和行号，是不是很方便呢
你也许会好奇串口竟然输出了文件和行号，简直太神奇了（我承认刚接触时我自己确实认为太神奇了，哈哈），不要着急咱们继续往下看
我们首先来看几个编译器内置宏
ANSI C标准中有几个标准预定义宏（也是常用的）：

__LINE__：在源代码中插入当前源代码行号；
__FILE__：在源文件中插入当前源文件名；
__DATE__：在源文件中插入当前的编译日期
__TIME__：在源文件中插入当前编译时间；
__STDC__：当要求程序严格遵循ANSI C标准时该标识被赋值为1；
__cplusplus：当编写C++程序时该标识符被定义。

我们在上面用到的呢就是file和line了，，以至于有了错误的位置。到这里呢，其实也就应该结束了，但是有些人会问那么我平常的用差U纽扣进行调试时能否也输出我的printf语句所在的文件和行号呢，这样更便于寻找问题点，那么当然可以了

下面的内容呢是引用了论坛一个朋友的，在此感谢他的整理：

引用分割线///

我们在写程序的时候，总是或多或少会加入一些printf之类的语句用于输出调试信息，但是printf语句有个很不方便的地方就是当我们需要发布程序的时候要一条一条的把这些语句删除，而一旦需要再次调试的时候，这些语句又不得不一条条的加上，这给我们带来了很大的不便，浪费了我们很多的时间，也造成了调试的效率低下。所以，很多人会选择使用宏定义的方式来输出调试语句。

比如，定义一个宏开关：
#define __DEBUG

当需要调试的时候，使用语句：
#ifdef __DEBUG
printf(xxx);
#endif

这种方式的调试，可以通过undef __DEBUG的方式让告知编译器不编译这些语句，从而不再输出这些语句。但是这种方式的麻烦之处也是显而易见的，每一条调试语句都需要使用两条宏定义来包围，这不但在代码的编写上不便，源码结构也不好看，工作量依然不小。

如果我们能够把这三条语句编程一条，那该多舒服呀~，于是，我们想到使用这样的语句：

#ifdef __DEBUG
#define DEBUG(info) printf(info)
#else
#define DEBUG(info)
#endif

这样，我们在编写代码的时候，使用DEBUG一条语句就可以了，我们把宏开关__DEBUG打开，所有的DEBUG(info)宏定义信息都会被替换为printf(info)，关上则会被替换成空，因此不会被编译。嗯，这次方便多了，一条语句就可以了~~~ 但是，问题也随之而来了，printf是支持多个参数的，而且是不定参数，当你使用下面这样的语句时就会报错：

DEBUG("%s",msg)

这是因为，DEBUG(info)这条宏定义只支持一个参数的替换。

因此，我们希望DEBUG能够像printf那样，支持多个参数，并且这些参数刚好展开成为printf语句本身使用的参数，譬如：我们希望DEBUG("%s",msg)能够展开为printf("%s",msg)

正文：

通过网上的资料查阅，发现自C99规范以后，编译器就开始支持不定参数的宏定义，就像printf一样。

大家可以看看这篇文章：http://blog.csdn.net/aobai219/archive/2010/12/22/6092292.aspx
（这个链接也转的，我已经找不到原始作者到底是谁了，唉，互联网啊。。。）

于是，我们定义了一个这样的东东：
#define DEBUG(format, ...) printf (format, ##__VA_ARGS__)（' ## '的意思是，如果可变参数被忽略或为空，将使预处理器（ preprocessor ）去除掉它前面的那个逗号。）
【Stm32调试之assert_param() 断言机制】

于是乎，我们神奇地发现，DEBUG完全取代了printf，所有的DEBUG(…)都被完成的替换成了printf(…)，再也不会因那个可恶的逗号而烦恼了。

但是，我们发现，光有printf还不够，虽然调试信息是输出了，可是很多的调试信息输出，我们并不能一下子知道这条信息到底是在那里打印出来的，于是，我们又想，能不能把当前所在文件名和源码行位置也打印出来呢，这样不就一目了然了吗，哪里还用的着去想，去找调试信息在哪里输出的呢，都已经打印出来了！

__FILE__和__LINE__正是我们前面想要的输出的，于是，我们的每一条语句都变成了：
DEBUG("FILE: %s, LINE: %d…",__FILE__,__LINE__,…)

其实没有必要，__FILE__本身就会被编译器置换为字符常量，于是乎我们的语句又变成了这样：
DEBUG("FILE:"__FILE__", LINE: %d…",__LINE__,…)

但是，我们还是不满足，依然发现，还是很讨厌，为什么每条语句都要写"FILE:"__FILE__", LINE: %d 以及,__LINE,这两个部分呢？这不是浪费我们时间么？
哈哈，是的，这就是本次大结局，把DEBUG写成这样：
DEBUG(format,...) printf("FILE: "__FILE__", LINE: %d: "format"/n", __LINE__, ##__VA_ARGS__)

没错，就是这样！下面，所有的DEBUG信息都会按照这样的方式输出：
FILE: xxx, LINE: xxx, …….
引用分割线///
还是上传不了图片。。。。。。 直接贴代码吧

宏定义部分：
#define _Debug
#ifdef_Debug
#define debug(format,...) printf("File: "__FILE__",Line: %d,"format"",__LINE__,##__VA_ARGS__)
#else
#define debug(format,...)
#endif
调试输出：
debug("DebugTest!\r\n");
串口信息：
File: ..\User\main.c,Line: 232,DebugTest!
备注：
断言可以对在系统中隐藏很深，用其它手段极难发现的问题进行定位，并且输出信息很详细，可以很好地解决大多数C语言编译器错误信息输出不详细的问题。断言是对某种条件进行检测，若条件成立则无反应，否则程序执行到断言处终止，同时输出为成立的条件。assert是一个宏定义，并不是函数。

    推荐阅读


    上一篇：Linux|linux开机启动动画

    下一篇：Linux|移植安装cartographer_ros