RT-Thread vsnprintf来替代rt_vsnprintf来打印浮点

发布于 2022-02-03 21:42:01 浏览：3051 订阅该版

[tocm]

[RT-Thread 入门学习笔记 - 目录](https://club.rt-thread.org/ask/article/3420.html)

## 备注

- 这里提供一种调试的思路，并非强调：使用 `vsnprintf` 来替代 `rt_vsnprintf`

- 终极解决方法是：完善 `rt_vsnprintf`，增加浮点的格式化功能

- 本篇为个人在使用或熟悉 RT-Thread 时的个人【学习笔记】

## 前言

- 有童鞋说在 gcc下，`vsnprintf` 来替代 `rt_vsnprintf` 来打印浮点会引发死机

- 经过实际验证，没有发现死机

- 但并不建议直接用 `vsnprintf` 来替代 `rt_vsnprintf`，打印浮点多半用于调试，可以独立成一个专门的打印函数

- `vsnprintf` 只是用于把浮点格式化到字符串，只要字符串长度不溢出，理论上不会造成死机

- 如果发现死机，需要确认打印的环境，如中断中，尤其在串口输出的情况下

## 测试例程

- RT-Thread Studio `arm-none-eabi-gcc` 环境：未发现死机现象

- Keil MDK5 环境：未发现死机现象

- cygwin gcc 环境：未发现死机现象

- 可以正常的用于浮点数的调试打印

```c
/*
 * Copyright (c) 2006-2018, RT-Thread Development Team
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Change Logs:
 * Date           Author       Notes
 * 2018-11-06     SummerGift   change to new framework
 */

#include <rtthread.h>
#include <rtdevice.h>
#include <board.h>
#include "drv_gpio.h"
/* defined the LED0 pin: PA5 */
#define LED0_PIN    GET_PIN(A, 5)

#include <stdio.h>

#define DBG_BUFF_MAX_LEN          256

/* debug print : support float double */
int dbg_printf(const char *fmt, ...)
{
    va_list args;
    static char rt_log_buf[DBG_BUFF_MAX_LEN] = { 0 };

va_start(args, fmt);
    int length = vsnprintf(rt_log_buf, sizeof(rt_log_buf) - 1, fmt, args);

rt_kputs(rt_log_buf);

return length;
}

int main(void)
{
    double a = 334455.00123345;
    double b = 667788.14234234;
    dbg_printf("double a = %lf\r\n", a);
    int count = 1;
    /* set LED0 pin mode to output */
    rt_pin_mode(LED0_PIN, PIN_MODE_OUTPUT);

while (count++)
    {
        rt_pin_write(LED0_PIN, PIN_HIGH);
        dbg_printf("double a + b = %lf\r\n", a+b+count);
        rt_thread_mdelay(1000);
        rt_pin_write(LED0_PIN, PIN_LOW);
        rt_thread_mdelay(2000);
    }

return RT_EOK;
}
```

- cygwin的测试

```c
/* vsnprintf example */
#include <stdarg.h>
#include <stdio.h>

#define DBG_BUFF_MAX_LEN            256

/* debug print : support float double */
int dbg_printf(const char *fmt, ...)
{
    va_list args;
    static char rt_log_buf[DBG_BUFF_MAX_LEN] = { 0 };

va_start(args, fmt);
    int length = vsnprintf(rt_log_buf, sizeof(rt_log_buf) - 1, fmt, args);

printf("%s\r\n", rt_log_buf);

return length;
}
 
int main ()
{
    double a = 123453.0001444;
    dbg_printf("%lf", a);
    return 0;
}
```

## 输出效果

```c
msh >
 \ | /
- RT -     Thread Operating System
 / | \     4.1.0 build Feb  3 2022 21:11:28
 2006 - 2022 Copyright by RT-Thread team
double a = 334455.001233
double a + b = 1002245.143576
msh >double a + b = 1002246.143576
double a + b = 1002247.143576
double a + b = 1002248.143576
double a + b = 1002249.143576
double a + b = 1002250.143576
double a + b = 1002251.143576
double a + b = 1002252.143576
double a + b = 1002253.143576
double a + b = 1002254.143576
double a + b = 1002255.143576
double a + b = 1002256.143576
double a + b = 1002257.143576
double a + b = 1002258.143576
double a + b = 1002259.143576
double a + b = 1002260.143576
double a + b = 1002261.143576
```

- cygwin的打印：

```c
$ ./a.exe
123453.000144
```

## 小结

- `rt_kprintf`，采用不依赖标准C库的方式，主要目的是为了减少ROM（Flash）的占用

- 如果实际中需要浮点打印（如打印到串口、打印到文件），可以基于 `vsnprintf` 编写一个简单的全功能格式打印函数

- RT-Thread ulog 可以开启浮点支持，开启后使用：`vsnprintf`

- `vsnprintf`使用需要考虑【线程安全】问题

15 条评论

mysterywolf 2022-02-04

https://github.com/mysterywolf

张世争 2022-02-04

学以致用

mysterywolf 2022-02-04

https://github.com/mysterywolf

张世争 2022-02-04

学以致用

mysterywolf 2022-02-04

https://github.com/mysterywolf

@张世争 大佬谦虚了，你可不是初学者，术业有专攻而已😂 我也是最近一年维护libc的时候发现的这个问题，这个问题已经潜伏了10多年了，最早在2013年就有人报告在gcc下打印浮点死机的问题，但是都没有在意。随后2014年FreeRTOS社区也遭遇了类似的问题，此后2019年，Zephyr社区也同样遭遇了类似的问题。由于使用RTT的中国工程师大多习惯使用IAR和Keil来开发单片机，这两个编译器内置的vsnprintf函数是线程安全的，多线程打印浮点数没有任何问题。但是由于这两年我们推行studio，使得使用gcc/newlib来编译工程的人变多，这个问题逐渐暴露出来了。直到去年，我们社区的阿嘉博士反应这个问题之后我才仔细调研了这个问题的来龙去脉。最终发现是newlib那边的问题，并且波及的并不只是我们一个社区/项目。我参考了FreeRTOS的解决方法，但是代价过大，并不是一个最优解。同时由于我们支持多个不同的编译平台，需要一套我们自己可控的vsnprintf函数，因此，最终方案是对rt_vsnprintf函数进行加强。采用补丁软件包的方式，让用户自由选择。

此外newlib那边的memcpy和memset函数也不是什么好东西，强烈建议用rt_memcpy以及rt_memset代替。目前rtt核心代码都是采用的rt_memset来替换了memset
https://github.com/RT-Thread/rt-thread/pull/5460

对此次问题的梳理，意识到一个非常严重问题就是RTT的安全性目前被编译器内置c库函数所左右，编译器C库函数是内置的，我们看不见，掌控不了，实现了什么，怎么实现的根本不知道。因此后续libc这块还会再补充一个我们自己的精简版c库函数（类似于以前的minilibc，但是会有改进），来保证rtt 标准C库的绝对安全。

如果想了解更多，我这里有一份调研的时候的一份随记，可以看一下：https://github.com/mysterywolf/rt-thread-test-bench/blob/master/newlib-threadsafe/newlib%E7%9A%84%E9%97%AE%E9%A2%98.docx

请使用以下三个软件包进行增强，三个软件包可以任意组合使用：
https://github.com/mysterywolf/rt_kprintf_threadsafe
https://github.com/mysterywolf/rt_vsnprintf_full
https://github.com/mysterywolf/rt_memcpy_cm

张世争 2022-02-04

学以致用

chenyingchun 2022-02-07

这家伙很懒，什么也没写！

浪子->StevenChen 2022-02-07

这家伙很懒，什么也没写！

hfmm 2022-02-08

这家伙很懒，什么也没写！

mysterywolf 2022-02-09

https://github.com/mysterywolf

yipenghaha 2022-02-16

这家伙很懒，什么也没写！

__聪 2022-03-28

这家伙很懒，什么也没写！

mysterywolf 2022-04-06

https://github.com/mysterywolf

apingrtt 2023-07-25

这家伙很懒，什么也没写！

[@mysterywolf](/u/1b577fc99a1827a7)我也遇到了您前面提出的问题，RTT版本4.1.1，在studio环境下setting printf的升级补丁包选项时，显示如下错误：
scons: Reading SConscript files ...
[Use Gitee server]
Tips : 
The system needs to be upgraded.
Please use the <pkgs --upgrade> command to upgrade packages index.
Start to download package :  
https://github.com/mysterywolf/rt_kprintf_threadsafe/archive/refs/tags/v1.0.0.zip
error message:[Errno 2] No such file or directory: u'D:/Programs/RT-ThreadStudio/platform/env_released/env\\local_pkgs\\'	
https://github.com/mysterywolf/rt_kprintf_threadsafe/archive/refs/tags/v1.0.0.zip
error message:[Errno 2] No such file or directory: u'D:/Programs/RT-ThreadStudio/platform/env_released/env\\local_pkgs\\'	
https://github.com/mysterywolf/rt_kprintf_threadsafe/archive/refs/tags/v1.0.0.zip
error message:[Errno 2] No such file or directory: u'D:/Programs/RT-ThreadStudio/platform/env_released/env\\local_pkgs\\'	
https://github.com/mysterywolf/rt_kprintf_threadsafe/archive/refs/tags/v1.0.0.zip
error message:[Errno 2] No such file or directory: u'D:/Programs/RT-ThreadStudio/platform/env_released/env\\local_pkgs\\'	
https://github.com/mysterywolf/rt_kprintf_threadsafe/archive/refs/tags/v1.0.0.zip
error message:[Errno 2] No such file or directory: u'D:/Programs/RT-ThreadStudio/platform/env_released/env\\local_pkgs\\'	
https://github.com/mysterywolf/rt_kprintf_threadsafe/archive/refs/tags/v1.0.0.zip
error message:[Errno 2] No such file or directory: u'D:/Programs/RT-ThreadStudio/platform/env_released/env\\local_pkgs\\'	
D:/Programs/RT-ThreadStudio/platform/env_released/env\local_pkgs\ download fail!
({'path': '/packages/system/enhanced-kservice/rt_kprintf_threadsafe', 'ver': 'v1.0.0', 'name': 'RT_KPRINTF_THREADSAFE'}, 'download failed.')
请问是什么原因？另外github容易连接不上，是否在gitee上也有仓库？