dbm数据库源代码分析(8)：hash.c和findkey.c

   现在解剖hash.c和findkey.c的源码。
   （1）hash.c中的哈希函数int _gdm_hash(key)。返回一个31比特的值。这个值的前n比特用来对散列目录表进行索引。它也会用于在一个散列桶中查找桶元素的位置（通过与桶的散列表长度做模运算）。不要对函数中的计算过程有迷惑，它只是为了计算哈希值而设计的一个简单算法，主要用到了移位运算的模运算。

/* hash.c - gdbm的hash函数 */ #include "autoconf.h" #include "gdbmdefs.h" /* hash函数返回一个31比特的值。这个值的前n比特用来对散列目录表进行索引。它也会用于在一个散列桶中查找 桶元素的位置（通过与桶的散列表长度做模运算） */ int _gdbm_hash (key) datum key; { unsigned int value; /* 用来保存计算出的哈希值 */ int index; /* 用来对随机值进行循环的索引 */ /* 设置初始的值 */ value = 0x238F13AF * key.dsize; for (index = 0; index < key.dsize; index++) /* 用一个循环来计算关键字的哈希值 */ value = (value + (key.dptr[index] << (index*5 % 24))) & 0x7FFFFFFF; value = (1103515243 * value + 12345) & 0x7FFFFFFF; /* 返回这个值 */ return((int) value); }

   findkey.c中有两个函数_gdbm_read_entry和_gdbm_findkey。前者用于文件中读取需要的关键字，后者用于查找给定的关键字。
   （2）char* _gdbm_read_entry(dbf,elem_loc)函数。在文件dbf中读取的实际的关键/数据项（注意数据是紧跟在关键字后面存储的，故一般把两者放在一起，返回其起始地址和大小），返回指向它的指针。数据项的大小、对应关键字等信息由桶的索引elem_loc处的缓存项给出，读取后也会把数据缓顾虑到这个缓存项中去。如果关键字/数据在当前缓存项中，则直接返回。否则，释放缓存中原先的存放数据、重新设置好缓存的参数、为要读取的数据分配空间、把数据读入到缓存中，返回指向数据的指针。

   （3）int _gdm_findkey(dbf,key,dptr,new_hash_val)函数。在文件中查找关键字key，并准备读取其关联的数据。返回值为关键字在当前桶中所处的位置，而用dptr来返回关键字/数据的起始地址，用new_hash_val来返回关键字的哈希值。如果找到，则指向这个关键字和数据的指针返回给dptr。如果没有找到，返回-1。在查找时要计算关键字的hash值。程序先判断，如果key在当前缓存项，则直接返回它的地址和桶中位置。如果不在当前缓存项，则要搜索整个桶，对桶中的每个元素，比较桶元素的哈希值、关键字大小、关键字内容，若不相等则到下一个桶元素中去找；若相等，则根据桶元素中给出的位置信息调用_gdbm_read_entry从文件读取相应关键字，与key比较，相等则找到，返回，不相等则同样到下一个桶中去找。

/* findkey.c - 用来在文件中查找关键字的例程 */ #include "autoconf.h" #include "gdbmdefs.h" /* 在文件dbf中读取的实际数据项，返回指向它的指针，数据项的大小、对应关键字等信息由桶的索引elem_loc处的缓存项给出， 读取后也会把数据缓顾虑到这个缓存项中去 */ char * _gdbm_read_entry (dbf, elem_loc) gdbm_file_info *dbf; int elem_loc; { int num_bytes; /* 用于查找和读取 */ int key_size; int data_size; off_t file_pos; data_cache_elem *data_ca; /* 数据如果在当前缓存项的数据缓存元素中，则直接返回它的起始地址 */ if (dbf->cache_entry->ca_data.elem_loc == elem_loc) return dbf->cache_entry->ca_data.dptr; /* 设置关键字和数据的大小、数据缓存元素 */ key_size = dbf->bucket->h_table[elem_loc].key_size; data_size = dbf->bucket->h_table[elem_loc].data_size; data_ca = &dbf->cache_entry->ca_data; /* 设置好缓存 */ if (data_ca->dptr != NULL) free (data_ca->dptr); /* 释放缓存中原先的数据 */ data_ca->key_size = key_size; data_ca->data_size = data_size; data_ca->elem_loc = elem_loc; data_ca->hash_val = dbf->bucket->h_table[elem_loc].hash_value; if (key_size+data_size == 0) data_ca->dptr = (char *) malloc (1); else data_ca->dptr = (char *) malloc (key_size+data_size); /* 为要读取的数据分配空间 */ if (data_ca->dptr == NULL) _gdbm_fatal (dbf, "malloc error"); /* 把数据读到缓存中 */ file_pos = lseek (dbf->desc, dbf->bucket->h_table[elem_loc].data_pointer, L_SET); if (file_pos != dbf->bucket->h_table[elem_loc].data_pointer) _gdbm_fatal (dbf, "lseek error"); num_bytes = read (dbf->desc, data_ca->dptr, key_size+data_size); /* 读取数据 */ if (num_bytes != key_size+data_size) _gdbm_fatal (dbf, "read error"); return data_ca->dptr; } /* 在文件中查找关键字key，并准备读取其关联的数据。返回值为当前桶中关键字所处的位置。如果找到，则 指向这个关键字和数据的指针返回给dptr。如果没有找到，返回-1。在查找时要计算关键字的hash值 */ int _gdbm_findkey (dbf, key, dptr, new_hash_val) gdbm_file_info *dbf; datum key; char **dptr; int *new_hash_val; /* 新的哈希值 */ { int bucket_hash_val; /* 桶的哈希值 */ char *file_key; /* 存储在文件中的完整关键字 */ int elem_loc; /* 桶元素在桶中的位置 */ int home_loc; /* The home location in the bucket. */ int key_size; /* 关键字的大小 */ /* 计算哈希值，并且根据哈希值表示的目录索引，获取此目录项指示的散列桶 */ *new_hash_val = _gdbm_hash (key); _gdbm_get_bucket (dbf, *new_hash_val>> (31-dbf->header->dir_bits)); /* 要找的关键字正好在当前缓存项中，要比较它们的哈希值、关键字大小、关键字内容 */ if (dbf->cache_entry->ca_data.elem_loc != -1 && *new_hash_val == dbf->cache_entry->ca_data.hash_val && dbf->cache_entry->ca_data.key_size == key.dsize && dbf->cache_entry->ca_data.dptr != NULL && bcmp (dbf->cache_entry->ca_data.dptr, key.dptr, key.dsize) == 0) /* bcmp用于比较两个关键字的内容 */ { /* 找到，则返回这个关键字/数据的起始地址 */ *dptr = dbf->cache_entry->ca_data.dptr+key.dsize; return dbf->cache_entry->ca_data.elem_loc; /* 返回关键字在桶缓存数组中的索引位置 */ } /* 如果key不在当前缓存项，则要搜索桶中每个元素 */ elem_loc = *new_hash_val % dbf->header->bucket_elems; home_loc = elem_loc; bucket_hash_val = dbf->bucket->h_table[elem_loc].hash_value; while (bucket_hash_val != -1) { /* 比较桶元素的哈希值、关键字大小、关键字内容 */ key_size = dbf->bucket->h_table[elem_loc].key_size; if (bucket_hash_val != *new_hash_val || key_size != key.dsize || bcmp (dbf->bucket->h_table[elem_loc].key_start, key.dptr, (SMALL < key_size ? SMALL : key_size)) != 0) /* 若比较得出不相等，说明关键字肯定不在这个桶元素中 */ { /* 说明关键字/数据不在当前elem_loc处的的桶元素中，到下一个桶元素中去找 */ elem_loc = (elem_loc + 1) % dbf->header->bucket_elems; if (elem_loc == home_loc) return -1; /* 没找到则返回-1 */ bucket_hash_val = dbf->bucket->h_table[elem_loc].hash_value; } else /* 否则关键字/数据可能在这个桶元素中 */ { file_key = _gdbm_read_entry (dbf, elem_loc); /* 读取它（若缓存的桶元素中没有，则会从文件中读取） */ if (bcmp (file_key, key.dptr, key_size) == 0) /* 如果关键字内容相等 */ { /* 则找到，返回它的指针和所在的桶元素位置 */ *dptr = file_key+key.dsize; return elem_loc; } else /* 否则关键字内容不相等，说明没找到，到下一个桶元素中去找 */ { elem_loc = (elem_loc + 1) % dbf->header->bucket_elems; if (elem_loc == home_loc) return -1; /* 如果没发现，则返回-1 */ bucket_hash_val = dbf->bucket->h_table[elem_loc].hash_value; } } } /* 如果到达这里，说明我们没有找到需要的key */ return -1; }