函数可重入性

一、可重入函数

1）什么是可重入性？

可重入（reentrant）函数可以由多于一个任务并发使用，而不必担心数据错误。相反， 不可重入（non-reentrant）函数不能由超过一个任务所共享，除非能确保函数的互斥（或者使用信号量，或者在代码的关键部分禁用中断）。可重入函数可以在任意时刻被中断，稍后再继续运行，不会丢失数据。可重入函数要么使用本地变量，要么在使用全局变量时保护自己的数据。

2）可重入函数：
不为连续的调用持有静态数据。 
不返回指向静态数据的指针；所有数据都由函数的调用者提供。 
使用本地数据，或者通过制作全局数据的本地拷贝来保护全局数据。
如果必须访问全局变量，记住利用互斥信号量来保护全局变量。
绝不调用任何不可重入函数。
3）不可重入函数：
函数中使用了静态变量，无论是全局静态变量还是局部静态变量。 
函数返回静态变量。 
函数中调用了不可重入函数。
函数体内使用了静态的数据结构；
函数体内调用了malloc()或者free()函数；
函数体内调用了其他标准I/O函数。
函数是singleton中的成员函数而且使用了不使用线程独立存储的成员变量 。
总的来说，如果一个函数在重入条件下使用了未受保护的共享的资源，那么它是不可重入的
4）示例
在多线程条件下，函数应当是线程安全的，进一步，更强的条件是可重入的。可重入函数保证了在多线程条件下，函数的状态不会出现错误。以下分别是一个不可重入和可重入函数的示例：
//c code
static int tmp;
void func1(int* x, int* y) {
    tmp=*x; 
    *x=*y; 
    *y=tmp;
}
void func2(int* x, int* y) {
    int tmp; 
    tmp=*x; 
    *x=*y; 
    *y=tmp;
}
func1是不可重入的，func2是可重入的。因为在多线程条件下，操作系统会在func1还没有执行完的情况下，切换到另一个线程中，那个线程可能再次调用func1，这样状态就错了。

问题1，如何编写可重入的函数？

答：在函数体内不访问那些全局变量，不使用静态局部变量，坚持只使用局部变量，写出的函数就将是可重入的。如果必须访问全局变量，记住利用互斥信号量来保护全局变量。

 

问题2，如何将一个不可重入的函数改写成可重入的函数？

答：把一个不可重入函数变成可重入的唯一方法是用可重入规则来重写它。其实很简单，只要遵守了几条很容易理解的规则，那么写出来的函数就是可重入的。

1) 不要使用全局变量。因为别的代码很可能覆盖这些变量值。

2) 在和硬件发生交互的时候，切记执行类似disinterrupt()之类的操作，就是关闭硬件中断。完成交互记得打开中断，在有些系列上，这叫做“进入/退出核心”。

3) 不能调用其它任何不可重入的函数。

4) 谨慎使用堆栈。最好先在使用前先OS_ENTER_KERNAL。

堆栈操作涉及内存分配，稍不留神就会造成益出导致覆盖其他任务的数据，所以，请谨慎使用堆栈！最好别用！

很多黑客程序就利用了这一点以便系统执行非法代码从而轻松获得系统控制权。

还有一些规则，总之，时刻记住一句话：保证中断是安全的！

实例问题：曾经设计过如下一个函数，在代码检视的时候被提醒有bug，因为这个函数是不可重入的，为什么？

unsigned int sum_int( unsigned int base )

{

    unsigned int index;

    static unsigned int sum= 0; // 注意，是static类型的。

    for (index = 1; index<= base; index++)

       sum +=index;

    return sum;

}

 

分析：所谓的函数是可重入的（也可以说是可预测的），即只要输入数据相同就应产生相同的输出。这个函数之所以是不可预测的，就是因为函数中使用了static变量，因为static变量的特征，这样的函数被称为：带“内部存储器”功能的的函数。因此如果需要一个可重入的函数，一定要避免函数中使用static变量，这种函数中的static变量，使用原则是，能不用尽量不用。

将上面的函数修改为可重入的函数，只要将声明sum变量中的static关键字去掉，变量sum即变为一个auto 类型的变量，函数即变为一个可重入的函数。

当然，有些时候，在函数中是必须要使用static变量的，比如当某函数的返回值为函数内部使用的某块空间的指针时，则必须是static的局部变量的地址作为返回值，若为auto类型，则返回为错指针。