c - 哈希表中的读取无效

Question

我正在使用 uthash.h为了存储我的应用程序的配置。由于配置来自在运行时读取的文件，哈希中的键和值都是动态分配的 char *:

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

如用户指南中所述，我实现了自己的功能以将键添加到配置哈希以确保唯一性。在这里:

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 运行测试来检查内存泄漏，我总是会得到以下信息:

==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;
    }
}

不知何故，在 cfg_put 中覆盖旧的 name 指针后，我似乎正在访问 cfg_get 中的旧指针。该问题仅出现在 name 上，而不出现在 value 上。我太笨了，想不出来，谢谢任何建议。

Answer 1

您必须提供完整的程序，即重现 valgrind 问题的完整最小示例。您在问题中发布的代码看起来不错，因此该错误一定隐藏在其他地方；例如在 cfg_clear() 或 cfg_count() 的代码中。

(最初我认为 cfg_count() 必须是 return HASH_COUNT(config_); — 但该实现不会通过您的测试用例，所以您必须做更奇怪的东西。这意味着 cfg_count 可能是该函数的错误名称。)

---

从风格上讲，如果您避免使用全局变量 (config_)，您可能会发现您的代码更易于调试，并且肯定如果您存储“释放此值的必要性”位直接与“值”位并排，而不是要求用户自行跟踪 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" );
}