Question

我使用uthash.h来存储我的应用程序的配置。由于配置来自在运行时读取的文件，因此散列中的键和值都是动态分配的char *：

typedef struct config_entry {
    char *name;
    char *value;
    UT_hash_handle hh;
} CONFIG_ENTRY;

正如用户指南中所解释的，我实现了自己的函数来向config-hash添加键，以确保唯一性。这是：

void cfg_put( char *name, char *value, FREE_FLAGS flags ) {

    CONFIG_ENTRY *entry;

    //first, check if the key is already in the hash
    HASH_FIND_STR( config_, name, entry );
    if( entry == NULL ) {
        //key doesn't exist yet => create new one
        entry = (CONFIG_ENTRY *)malloc( sizeof( CONFIG_ENTRY ) );
        entry->name = name;
        HASH_ADD_KEYPTR( hh, config_, entry->name, strlen(entry->name), entry );
    } else {
        //key exists => possibly free existing pointers before setting value

        if( (flags & FREE_NAME) == FREE_NAME ) {        //
            free( entry->name );                        // these lines seem to be
        }                                               // problematic.
        entry->name = name;                             //

        if( (flags & FREE_VALUE) == FREE_VALUE ) {
            free( entry->value );
        }
    }

    //Finally, set the value
    entry->value = value;
}

我还写了一些测试用来检查我的实现，它们似乎运行得很好。但是，如果我使用valgrind运行测试来检查memleaks，我总是得到以下结果：

==2561== Invalid read of size 1
==2561==    at 0x4026097: bcmp (mc_replace_strmem.c:541)
==2561==    by 0x804ADF5: cfg_get (in /home/gj/..../test/config_test)
==2561==    by 0x804B2C7: test_config1 (in /home/..../test/config_test)
==2561==    by 0x402E446: run_single_test (in /usr/local/lib/libcunit.so.1.0.1)
[...]
==2561==  Address 0x4194210 is 0 bytes inside a block of size 4 free'd
==2561==    at 0x4023B6A: free (vg_replace_malloc.c:366)
==2561==    by 0x804A872: cfg_put (in /home/..../test/config_test)
==2561==    by 0x804B27D: test_config1 (in /home/..../test/config_test)
==2561==    by 0x402E446: run_single_test (in /usr/local/lib/libcunit.so.1.0.1)
[...]

这里是测试用例和cfg_get的完整性实现：

void test_config1( void ) {

    cfg_clear( FREE_ALL );

    cfg_put( strdup("foo"), "bar", FREE_NONE );
    CU_ASSERT_EQUAL( cfg_count(), 1 );
    CU_ASSERT_STRING_EQUAL( cfg_get("foo"), "bar" );

    cfg_dump();

    cfg_put( "foo", "baz", FREE_NAME );
    CU_ASSERT_EQUAL( cfg_count(), 2 );
    CU_ASSERT_STRING_EQUAL( cfg_get("foo"), "baz" );

    cfg_clear( FREE_NONE );

    cfg_dump();
}

cfg_get：

char *cfg_get( const char *name ) {

    CONFIG_ENTRY *entry = NULL;
    HASH_FIND_STR( config_, name, entry );

    if( entry ) {
        return entry->value;
    } else {
        return NULL;
    }
}

不知何故，似乎我在name中覆盖cfg_get之后，在cfg_put中访问旧的name指针。问题仅发生在value上，而不是{{1}}。对于任何建议，我都太愚蠢了，不管怎么说。

Answer 1

您必须提供完整的程序 - 也就是说，这是一个重现valgrind问题的完整最小示例。您在问题中发布的代码看起来不错，因此错误必须隐藏在其他地方;例如代码为cfg_clear()或cfg_count()。

（原来我认为cfg_count()必须是return HASH_COUNT(config_); - 但是这种实现方式无法通过您的测试用例，因此您必须做一些更奇怪的事情。这意味着cfg_count是可能是该函数的错误名称。）

从风格上讲，如果您避免使用全局变量（config_），您可能会发现您的代码更容易调试，并且肯定如果您存储了以下内容，您会发现它更容易＆＃34;释放这个价值的必要性＆＃34;直接位于＆＃34;值＆＃34;位，而不是要求用户自己跟踪FREE_NAME，FREE_VALUE等。也就是说，而不是

typedef struct config_entry {
    char *name;
    char *value;
    UT_hash_handle hh;
} CONFIG_ENTRY;

void cfg_put(char *name, char *value, FREE_FLAGS flags);
void cfg_clear(FREE_FLAGS flags);

你应该只提供

typedef struct config_entry {
    char *name;
    char *value;
    UT_hash_handle hh;
    bool must_free_name;
    bool must_free_value;
} CONFIG_ENTRY;

void cfg_put(char *name, char *value, FREE_FLAGS flags);
void cfg_clear(void);

此时您的测试用例变得更易于管理

void test_config1()
{
    cfg_clear();  // use the stored bits to figure out what needs freeing
    cfg_put(strdup("foo"), "bar", FREE_NAME);  // name is alloc'ed, so name must be freed later
    CU_ASSERT_EQUAL( cfg_count(), 1 );
    CU_ASSERT_STRING_EQUAL( cfg_get("foo"), "bar" );

    cfg_put("foo", "baz", FREE_NONE);  // neither name nor value is alloc'ed
    CU_ASSERT_EQUAL( cfg_count(), 2 );
    CU_ASSERT_STRING_EQUAL( cfg_get("foo"), "baz" );
}

Answer 2

您的config_put()函数存在问题：它会修改已插入哈希值的项目的键。你不应该这样做。可以将name指针更改为指向相同字符串的指针，但可能不是，uthash.h的实现有点模糊。

我建议您更改API，以便config_put()执行所有字符串管理，让config_哈希拥有所有字符串，并且不再调用strdup()中的test_config1。这要简单得多，并且避免了哈希结构之外的字符串值生命周期的潜在复杂和容易出错的跟踪：

void cfg_put(const char *name, const char *value) {

    CONFIG_ENTRY *entry;

    //first, check if the key is already in the hash
    HASH_FIND_STR(config_, name, entry);
    if (entry == NULL) {
        //key doesn't exist yet => create new one
        entry = malloc(sizeof(*entry));
        entry->name = strdup(name);
        HASH_ADD_KEYPTR(hh, config_, entry->name, strlen(entry->name), entry );
    } else {
        //key exists => free existing value pointer if any
        free(entry->value);
    }

    //Finally, set the value
    entry->value = value ? strdup(value) : NULL;
}

哈希表中的读取无效

2 个答案: