删除 Splint 中的空警告

Question

我一直在用我最近编写的 C 程序尝试 Splint 并尝试理解并删除它给出的警告。一个我理解但无法理解如何删除它的代码片段来自以下代码片段：

static MyType_t *findById(const int id)
{
    int i;

    for (i = 0; i < MY_ARR_SIZE; i++) {
            if (my_arr[i].id == NOT_SET) {
                    /* Items are sorted so that items with 
                    NOT_SET as ID are at the end of the array */
                    break;
            }
            if (my_arr[i].id == id) {
                    return &(my_arr[i]);
            }
    }
    return NULL; 
}

Splint 不高兴该函数可以返回 NULL，但在这种情况下它非常有意义。

我尝试使用 /@nullwhenfalse@/ 但似乎只有在函数返回 true/false 时才有效，并且还尝试更改代码以使用 retVal 并尝试了 /@null@< /em>/ 和 /@relnull@/ 位于声明前面，但这些没有任何作用。

（顺便说一句，这张桌子只有 20 个大 atm，所以使用聪明的搜索算法是没有意义的。）

Answer 1

您应该仔细检查声明前面的 /*@null@*/ 的使用。

在示例的以下可编译版本中，它确实删除了警告（使用夹板 3.1.2）：

typedef struct { int id; } MyType_t;
#define NOT_SET -1
#define MY_ARR_SIZE 20
static MyType_t my_arr[MY_ARR_SIZE];

/*@null@*/ static MyType_t *findById(const int id)
{
    int i;
    for (i = 0; i < MY_ARR_SIZE; i++) {
            if (my_arr[i].id == NOT_SET) {
                    /* Items are sorted so that items with 
                    NOT_SET as ID are at the end of the array */
                    break;
            }
            if (my_arr[i].id == id) {
                    return &(my_arr[i]);
            }
    }
    return NULL;
}

int main() {
    (void)findById(10);
    return 0;
}

如果您仍然有类似的警告，是否可能与代码的另一部分有关？

Answer 2

splint -nullret 将消除该警告（全局），这可能是也可能不是您想要做的事情。在某些情况下，除非您确信返回 NULL 的类型是正确的，否则您可能想要警告。

我测试了杰罗姆的示例，它确实消除了该特定函数的警告。

Answer 3

无论您做什么，我强烈建议不要将夹板代码直接嵌入到源代码中，而是将该功能包装在宏中。

例如，在 Parrot 项目中，我有这些宏

#  define ARGIN(x)                    /*@in@*/ /*@notnull@*/
#  define ARGIN_NULLOK(x)             /*@in@*/ /*@null@*/
    /* The pointer target must be completely defined before being passed */
    /* to the function. */

#  define ARGOUT(x)                   /*@out@*/ /*@notnull@*/
#  define ARGOUT_NULLOK(x)            /*@out@*/ /*@null@*/
    /* The pointer target will be defined by the function */

然后使用宏，以便我们可以使用：

void copy_string( ARGOUT(char *target), ARGIN(const char *source ) ) ...

如果我们想更改 ARGIN() 参数的处理方式，我们可以更改它的一处。我们还可以支持多个工具或编译器的多种符号。