PHP 源代码分析 Zend HashTable详解

更新时间：2009年08月10日 10:51:09 作者：

在PHP的Zend引擎中，有一个数据结构非常重要，它无处不在，是PHP数据存储的核心，各种常量、变量、函数、类、对象等都用它来组织，这个数据结构就是HashTable。

因为这个函数是使用字符串作为键名来插入数据的，因此它首先检查nKeyLength的值是否大于0，如果不是的话就直接退出。然后计算arKey对应的hash值h，将其与nTableMask按位与后得到一个无符号整数nIndex。这个nIndex就是将要插入的Bucket在arBuckets数组中的索引位置。
现在已经有了arBuckets数组的一个索引，我们知道它包括的数据是一个指向Bucket的双向链表的指针。如果这个双向链表不为空的话我们首先检查这个双向链表中是否已经包含了用字符串arKey指定的键名的Bucket，这样的Bucket如果存在，并且我们要做的操作是插入新Bucket(通过flag标识)，这时就应该报错 – 因为在HashTable中键名不可以重复。如果存在，并且是修改操作，则使用在HashTable中指定了析构函数pDestructor对原来的pData指向的数据进行析构操作；然后将用新的数据替换原来的数据即可成功返回修改操作。
如果在HashTable中没有找到键名指定的数据，就将该数据封装到Bucket中，然后插入HashTable。这里要注意的是如下的两个宏：
CONNECT_TO_BUCKET_DLLIST(p, ht->arBuckets[nIndex])
CONNECT_TO_GLOBAL_DLLIST(p, ht)
前者是将该Bucket插入到指定索引的Bucket双向链表中，后者是插入到整个HashTable的Bucket双向链表中。两者的插入方式也不同，前者是将该Bucket插入到双向链表的最前面，后者是插入到双向链表的最末端。
下面是第二种插入或修改Bucket的方法，即使用索引的方法：

复制代码代码如下:

ZEND_API int _zend_hash_index_update_or_next_insert(HashTable *ht, ulong h, void *pData, uint nDataSize, void **pDest, int flag ZEND_FILE_LINE_DC) 
{ 
uint nIndex; 
Bucket *p; 
IS_CONSISTENT(ht); 
if (flag & HASH_NEXT_INSERT) { 
h = ht->nNextFreeElement; 
} 
nIndex = h & ht->nTableMask; 
p = ht->arBuckets[nIndex]; 
// 检查是否含有相应的数据 
while (p != NULL) { 
if ((p->nKeyLength == 0) && (p->h == h)) { 
if (flag & HASH_NEXT_INSERT || flag & HASH_ADD) { 
return FAILURE; 
} 
// 
//　...... 修改Bucket数据，略 
// 
if ((long)h >= (long)ht->nNextFreeElement) { 
ht->nNextFreeElement = h + 1; 
} 
if (pDest) { 
*pDest = p->pData; 
} 
return SUCCESS; 
} 
p = p->pNext; 
} 
p = (Bucket *) pemalloc_rel(sizeof(Bucket) - 1, ht->persistent); 
if (!p) { 
return FAILURE; 
} 
p->nKeyLength = 0; /* Numeric indices are marked by making the nKeyLength == 0 */ 
p->h = h; 
INIT_DATA(ht, p, pData, nDataSize); 
if (pDest) { 
*pDest = p->pData; 
} 
CONNECT_TO_BUCKET_DLLIST(p, ht->arBuckets[nIndex]); 
HANDLE_BLOCK_INTERRUPTIONS(); 
ht->arBuckets[nIndex] = p; 
CONNECT_TO_GLOBAL_DLLIST(p, ht); 
HANDLE_UNBLOCK_INTERRUPTIONS(); 
if ((long)h >= (long)ht->nNextFreeElement) { 
ht->nNextFreeElement = h + 1; 
} 
ht->nNumOfElements++; 
ZEND_HASH_IF_FULL_DO_RESIZE(ht); 
return SUCCESS; 
}

flag标志指明当前操作是HASH_NEXT_INSERT(不指定索引插入或修改), HASH_ADD(指定索引插入)还是HASH_UPDATE(指定索引修改)。由于这些操作的实现代码基本相同，因此统一合并成了一个函数，再用flag加以区分。
本函数基本与前一个相同，不同的是如果确定插入到arBuckets数组中的索引的方法。如果操作是HASH_NEXT_INSERT，则直接使用nNextFreeElement作为插入的索引。注意nNextFreeElement的值是如何使用和更新的。
3 访问元素
同样，HashTable用两种方式来访问元素，一种是使用字符串arKey的zend_hash_find()；另一种是使用索引的访问方式zend_hash_index_find()。由于其实现的代码很简单，分析工作就留给读者自已完成。
4 删除元素
HashTable删除数据均使用zend_hash_del_key_or_index()函数来完成，其代码也较为简单，这里也不再详细分析。需要的是注意如何根据arKey或h来计算出相应的下标，以及两个双向链表的指针的处理。
5 遍历元素

复制代码代码如下:

/* This is used to recurse elements and selectively delete certain entries 
* from a hashtable. apply_func() receives the data and decides if the entry 
* should be deleted or recursion should be stopped. The following three 
* return codes are possible: 
* ZEND_HASH_APPLY_KEEP - continue 
* ZEND_HASH_APPLY_STOP - stop iteration 
* ZEND_HASH_APPLY_REMOVE - delete the element, combineable with the former 
*/ 
ZEND_API void zend_hash_apply(HashTable *ht, apply_func_t apply_func TSRMLS_DC) 
{ 
Bucket *p; 
IS_CONSISTENT(ht); 
HASH_PROTECT_RECURSION(ht); 
p = ht->pListHead; 
while (p != NULL) { 
int result = apply_func(p->pData TSRMLS_CC); 
if (result & ZEND_HASH_APPLY_REMOVE) { 
p = zend_hash_apply_deleter(ht, p); 
} else { 
p = p->pListNext; 
} 
if (result & ZEND_HASH_APPLY_STOP) { 
break; 
} 
} 
HASH_UNPROTECT_RECURSION(ht); 
}

因为HashTable中所有Bucket都可以通过pListHead指向的双向链表来访问，因此遍历HashTable的实现也比较简单。这里值得一提的是对当前遍历到的Bucket的处理使用了一个apply_func_t类型的回调函数。根据实际需要，该回调函数返回下面值之一：
ZEND_HASH_APPLY_KEEP
ZEND_HASH_APPLY_STOP
ZEND_HASH_APPLY_REMOVE
它们分别表示继续遍历，停止遍历或删除相应元素后继续遍历。
还有一个要注意的问题就是遍历时的防止递归的问题，也就是防止对同一个HashTable同时进行多次遍历。这是用下面两个宏来实现的：
HASH_PROTECT_RECURSION(ht)
HASH_UNPROTECT_RECURSION(ht)
其主要原理是如果遍历保护标志bApplyProtection为真，则每次进入遍历函数时将nApplyCount值加1，退出遍历函数时将nApplyCount值减1。开始遍历之前如果发现nApplyCount > 3就直接报告错误信息并退出遍历。
上面的apply_func_t不带参数。HashTable还提供带一个参数或可变参数的回调方式，对应的遍历函数分别为:

复制代码代码如下:

 
typedef int (*apply_func_arg_t)(void *pDest,void *argument TSRMLS_DC); 
void zend_hash_apply_with_argument(HashTable *ht, 
apply_func_arg_t apply_func, void *data TSRMLS_DC); 
typedef int (*apply_func_args_t)(void *pDest, 
int num_args, va_list args, zend_hash_key *hash_key); 
void zend_hash_apply_with_arguments(HashTable *ht, 
apply_func_args_t apply_func, int numargs, ...); 

除了上面提供的几种提供外，还有许多其它操作HashTable的API。如排序、HashTable的拷贝与合并等等。只要充分理解了上述HashTable的数据结构，理解这些代码并不困难。

您可能感兴趣的文章:

PHP Session 变量的使用方法详解与实例代码
在php中Session经常用来验证用户注册或登录之后的验证了，下面我来总结session变量的一些常用实例与用法介绍
2013-09-09
用PHP查询搜索引擎排名位置的代码
使用PHP快捷查询关键字在搜索引擎中的排名位置, 原理很简单,不讲了
2010-01-01
php中关于hook钩子函数底层理解
对"钩子"这个概念其实不熟悉，最近看到一个php框架中用到这种机制来扩展项目，所以大概来了解下。所谓Hook机制，是从Windows编程中流行开的一种技术
2023-01-01
PHP中call_user_func_array回调函数的用法示例
这篇文章主要给大家介绍了PHP中call_user_func_array回调函数的用法，文中给出了详细的示例代码，相信对大家的理解和学习很有帮助，有需要的朋友们可以参考借鉴，下面来一起学习学习吧。
2016-11-11
php基于socket实现SMTP发送邮件的方法
这篇文章主要介绍了php基于socket实现SMTP发送邮件的方法,实例分析了php采用socket实现smtp发送邮件的原理与技巧,具有一定参考借鉴价值,需要的朋友可以参考下
2015-03-03
php实现数组中索引关联数据转换成json对象的方法
这篇文章主要介绍了php实现数组中索引关联数据转换成json对象的方法,基于Yii框架分析了php数组与json格式数据的转换技巧,需要的朋友可以参考下
2015-07-07
PHP高并发和大流量解决方案整理
在本篇文章里小编给大家分享的是一篇关于PHP高并发和大流量解决方案内容，有兴趣的朋友们可以参考下。
2019-12-12
PHP生成图表pChart的示例解析
这篇文章主要介绍了PHP生成图表pChart的示例解析，文中通过解析pChartd 工作流程和不同图表的代码展示，讲解的非常详细，对大家的学习或工作具有一定的参考价值，有需要的来和小编一起学习把吧
2020-07-07
PHP实现变色验证码实例
验证码想必大家都有见到过吧，在本文为大家介绍下PHP如何实现变色验证码，感兴趣的朋友可以参考下
2014-01-01
PHP文件与目录操作示例
这篇文章主要介绍了PHP文件与目录操作,涉及php针对文件与目录的遍历、判断与排序相关操作技巧,注释中备有较为详细的说明,需要的朋友可以参考下
2016-12-12