PHP内核之HashTable

哈希表定义

哈希表(或散列表)，是将键名key按指定的散列函数HASH经过HASH(key)计算后映射到表中一个记录，而这个数组就是哈希表。

这里的HASH指任意的函数，例如MD5、CRC32、SHA1或你自定义的函数实现。

HashTable性能

HashTable是一种查找性能极高的数据结构，在很多语言内部都实现了HashTable。

理想情况下HashTable的性能是O(1)的，性能消耗主要集中在散列函数HASH(key)，通过HASH(key)直接定位到表中的记录。

而在实际情况下经常会发生key1 != key2，但HASH(key1) = HASH(key2)，这种情况即Hash碰撞问题，碰撞的概率越低HashTable的性能越好。当然Hash算法太过复杂也会影响HashTable性能。

理解PHP的哈希表实现

在PHP内核也同样实现了HashTable并广泛应用，包括线程安全、全局变量、资源管理等基本上所有的地方都能看到它的身影。

不仅如此，在PHP脚本中数组（PHP的数组实质就是HashTable）也是被广泛使用的，例如数组形式的配置文件、数据库的查询结果等，可以说是无处不在。

那么既然PHP的数组使用率这么高，内部是如何实现的？它如何解决hash碰撞及实现均匀分布的？PHP脚本使用数组应该注意哪些？

1. HashTable在PHP内核的实现

PHP实现HashTable主要是通过两个数据结构Bucket(桶)和HashTable。

从PHP脚本端来看，HashTable相当于Array对象，而Bucket相当于Array对象里的某个元素。对于多维数组实际就是HashTable的某个Bucket里存储着另一个HashTable。

HashTable结构

typedef struct _hashtable {  
     uint nTableSize; //表长度，并非元素个数  
     uint nTableMask;//表的掩码，始终等于nTableSize-1  
     uint nNumOfElements;//存储的元素个数  
     ulong nNextFreeElement;//指向下一个空的元素位置  
     Bucket *pInternalPointer;//foreach循环时，用来记录当前遍历到的元素位置  
     Bucket *pListHead;  
     Bucket *pListTail;  
     Bucket **arBuckets;//存储的元素数组  
     dtor_func_t pDestructor;//析构函数  
     zend_bool persistent;//是否持久保存。从这可以发现，PHP数组是可以实现持久保存在内存中的，而无需每次请求都重新加载。  
     unsigned char nApplyCount;  
     zend_bool bApplyProtection;  
} HashTable;  

Bucket结构

typedef struct bucket {  
     ulong h; //数组索引  
     uint nKeyLength; //字符串索引的长度  
     void *pData; //实际数据的存储地址  
     void *pDataPtr; //引入的数据存储地址  
     struct bucket *pListNext;  
     struct bucket *pListLast;  
     struct bucket *pNext; //双向链表的下一个元素的地址  
     struct bucket *pLast;//双向链表的下一个元素地址  
     char arKey[1]; /* Must be last element */  
} Bucket;  

PHP内核哈希表的散列函数很简单，直接使用 （HashTable->nTableSize & HashTable->nTableMask）的结果作为散列函数的实现。这样做的目的可能也是为了降低Hash算法的复杂度和提高性能。

1.1 在PHP中初始化一个空数组时，对应内核中是如何创建HashTable的

$array = [];

//省略了部分代码，提出主要的逻辑  
ZEND_API int _zend_hash_init(HashTable *ht, uint nSize, hash_func_t pHashFunction, dtor_func_t pDestructor, zend_bool persistent ZEND_FILE_LINE_DC)  
{  
     uint i = 3;  
     Bucket **tmp;  
  
     SET_INCONSISTENT(HT_OK);  
  
     if (nSize >= 0x80000000) {//数组的最大长度是十进制2147483648  
          /* prevent overflow */  
          ht->nTableSize = 0x80000000;  
     } else {  
          //数组的长度是向2的整次幂取圆整  
          //例如数组的里有10个元素，那么实际被分配的HashTable长度是16。100个元素，则被分配128的长度  
          //HashTable的最小长度是8，而非0。因为默认是将1向右移3位，1<<3=8  
          while ((1U << i) < nSize) {  
               i++;  
          }  
          ht->nTableSize = 1 << i;  
     }  
  
     ht->nTableMask = ht->nTableSize - 1;  
     ....  
      
     return SUCCESS;  
}  

从上看出，即使在PHP中初始化一个空数组或不足8个元素的数组，都会被创建8个长度的HashTable。同样创建100个元素的数组，也会被分配128长度的HashTable。依次类推。

1.2 内核对PHP添加数字索引的处理方式

PHP数组中，键名可以为数字或字符串类型。而在内核中只允许数字索引，对于字符串索引，内核采用了time33算法将字符串转换为整型。具体的实现下面会详细说明。

$array[0] = "hello hashtable";  

//省略了部分代码，提出主要的逻辑  
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)  
{      
     ulong h;  
     uint nIndex;  
     Bucket *p;  
     //省略了部分代码，提出主要的逻辑  
     nIndex = h & ht->nTableMask;  
     p = ht->arBuckets[nIndex];  
     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;  
     }  
  
     ht->arBuckets[nIndex] = p;  
  
     ht->nNumOfElements++;  
  
     return SUCCESS;  
}  

上述也说明了，内核中哈希表的散列函数就是简单的h & ht->nTableMask，其中h代表PHP中设置的索引号，nTableMask等于哈希表分配的长度-1。

1.3 内核对PHP中字符串索引的处理方式

$array[0] = "hello hashtable";  

与数字索引相比，只是多了一步将字符串转换为整型。用到的算法是time33

下面贴出了算法的实现，就是对字符串的每个字符转换为ASCII码乘上33并且相加得到的结果。

static inline ulong zend_inline_hash_func(const char *arKey, uint nKeyLength)  
{  
     register ulong hash = 5381;  
  
     /* variant with the hash unrolled eight times */  
     for (; nKeyLength >= 8; nKeyLength -= 8) {  
          hash = ((hash << 5) + hash) + *arKey++;  
          hash = ((hash << 5) + hash) + *arKey++;  
          hash = ((hash << 5) + hash) + *arKey++;  
          hash = ((hash << 5) + hash) + *arKey++;  
          hash = ((hash << 5) + hash) + *arKey++;  
          hash = ((hash << 5) + hash) + *arKey++;  
          hash = ((hash << 5) + hash) + *arKey++;  
          hash = ((hash << 5) + hash) + *arKey++;  
     }  
     switch (nKeyLength) {  
          case 7: hash = ((hash << 5) + hash) + *arKey++; /* fallthrough... */  
          case 6: hash = ((hash << 5) + hash) + *arKey++; /* fallthrough... */  
          case 5: hash = ((hash << 5) + hash) + *arKey++; /* fallthrough... */  
          case 4: hash = ((hash << 5) + hash) + *arKey++; /* fallthrough... */  
          case 3: hash = ((hash << 5) + hash) + *arKey++; /* fallthrough... */  
          case 2: hash = ((hash << 5) + hash) + *arKey++; /* fallthrough... */  
          case 1: hash = ((hash << 5) + hash) + *arKey++; break;  
          case 0: break;  
     }  
     return hash;  
}  
  
zend_hash.c  
//下面省略了部分代码，提出主要的逻辑  
ZEND_API int _zend_hash_add_or_update(HashTable *ht, const char *arKey, uint nKeyLength, void *pData, uint nDataSize, void **pDest, int flag ZEND_FILE_LINE_DC)  
{       
     ulong h;  
     uint nIndex;  
     Bucket *p;  
       
     h = zend_inline_hash_func(arKey, nKeyLength); //字符串转整型  
     nIndex = h & ht->nTableMask;  
     p = ht->arBuckets[nIndex];  
     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;  
     }  
  
     ht->arBuckets[nIndex] = p;  
  
     ht->nNumOfElements++;  
  
     return SUCCESS;  
}  

2. 内核中如何实现均匀分布和解决hash碰撞问题的

2.1 均匀分布

均匀分布是指，将需要存储的各个元素均匀的分布到HashTable中。

而负责计算具体分布到表中哪个位置的函数就是散列函数做的事情，所以散列函数的实现直接关系到均匀分布的效率。

上面也提到了PHP内核中用了简单的方式实现：h & ht->nTableMask;

2.2 Hash碰撞

Hash碰撞是指，经过Hash算法后得到的值会出现key1 != key2, 但Hash(key1)却等于Hash(key2)的情况，这就是碰撞问题。

在PHP内核来看，就是会出现key1 != key2, 但key1 & ht->nTableMask却等于 key2 & ht->nTableMask的情况。

PHP内核使用双向链表的方式来存储冲突的数据。即Bucket本身也是一个双向链表，当发生冲突时，会将数据按顺序向后排列。
如果不发生冲突，Bucket即是长度为1的的双向链表。

ZEND_API int zend_hash_find(const HashTable *ht, const char *arKey, uint nKeyLength, void **pData)  
{  
     ulong h;  
     uint nIndex;  
     Bucket *p;  
  
     IS_CONSISTENT(ht);  
  
     h = zend_inline_hash_func(arKey, nKeyLength);  
     nIndex = h & ht->nTableMask;  
  
     p = ht->arBuckets[nIndex];  
     //找到元素时，并非立即返回，而是要再对比h与nKeyLength，防止hash碰撞。此段代码就是遍历链表,直到链表尾部。  
     while (p != NULL) {  
          if ((p->h == h) && (p->nKeyLength == nKeyLength)) {  
               if (!memcmp(p->arKey, arKey, nKeyLength)) {  
                    *pData = p->pData;  
                    return SUCCESS;  
               }  
          }  
          p = p->pNext;  
     }  
     return FAILURE;  
}