月度归档:2010年02月

PHP源码阅读笔记十二:return_value 返回值

PHP源码阅读笔记十二:return_value 返回值
阅读PHP的源码有一段时间了,知道在扩展函数中只要使用PHP_FUNCTION,并且将值赋给return_value就可以返回此函数的值。
然后自己跟踪代码,一直以为有一个return_value这样的全局变量或包含 return_value的全局hashtable存在,然后不停的调试,一直没有发现,
直到今天问了鸟哥后才顿然醒悟,鸟哥在邮件中说:“ return_value是php中所有对php脚本提供函数PHP_FUCTION的一个参数,通过宏展开的。 通过复制给这个参数, ZE会将返回值给前端调用脚本。
在此非常感谢鸟哥的指导。鸟哥的blog地址:http://www.laruence.com/

其宏定义如下:

1
2
3
4
#define PHP_FUNCTION ZEND_FUNCTION
#define ZEND_FUNCTION(name) ZEND_NAMED_FUNCTION(ZEND_FN(name))
#define ZEND_NAMED_FUNCTION(name) void name(INTERNAL_FUNCTION_PARAMETERS)
#define INTERNAL_FUNCTION_PARAMETERS int ht, zval *return_value, zval **return_value_ptr, zval *this_ptr, int return_value_used TSRMLS_DC

一些内置的函数(比如each)直接使用ZEND_FUNCTION
扩展函数使用PHP_FUNCTION

在一些扩展函数中我们经常看到一些是没有使用return_value,而是使用了一些包含了return_value的宏代替。
常见的宏如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
//    zend_API.h    500行开始
#define ZVAL_FALSE(z)   ZVAL_BOOL(z, 0)
#define ZVAL_TRUE(z)   ZVAL_BOOL(z, 1)
 
#define RETVAL_RESOURCE(l) ZVAL_RESOURCE(return_value, l)
#define RETVAL_BOOL(b) ZVAL_BOOL(return_value, b)
#define RETVAL_NULL() ZVAL_NULL(return_value)
#define RETVAL_LONG(l) ZVAL_LONG(return_value, l)
#define RETVAL_DOUBLE(d) ZVAL_DOUBLE(return_value, d)
#define RETVAL_STRING(s, duplicate) ZVAL_STRING(return_value, s, duplicate)
#define RETVAL_STRINGL(s, l, duplicate) ZVAL_STRINGL(return_value, s, l, duplicate)
#define RETVAL_EMPTY_STRING() ZVAL_EMPTY_STRING(return_value)
#define RETVAL_ZVAL(zv, copy, dtor) ZVAL_ZVAL(return_value, zv, copy, dtor)
#define RETVAL_FALSE   ZVAL_BOOL(return_value, 0)
#define RETVAL_TRUE   ZVAL_BOOL(return_value, 1)
 
#define RETURN_RESOURCE(l) { RETVAL_RESOURCE(l); return; }
#define RETURN_BOOL(b) { RETVAL_BOOL(b); return; }
#define RETURN_NULL() { RETVAL_NULL(); return;}
#define RETURN_LONG(l) { RETVAL_LONG(l); return; }
#define RETURN_DOUBLE(d) { RETVAL_DOUBLE(d); return; }
#define RETURN_STRING(s, duplicate) { RETVAL_STRING(s, duplicate); return; }
#define RETURN_STRINGL(s, l, duplicate) { RETVAL_STRINGL(s, l, duplicate); return; }
#define RETURN_EMPTY_STRING() { RETVAL_EMPTY_STRING(); return; }
#define RETURN_ZVAL(zv, copy, dtor) { RETVAL_ZVAL(zv, copy, dtor); return; }
#define RETURN_FALSE   { RETVAL_FALSE; return; }
#define RETURN_TRUE   { RETVAL_TRUE; return; }

PHP源码阅读笔记十一: array_key_exists,in_array

PHP源码阅读笔记十一: array_key_exists,in_array
array_key_exists
(PHP 4 >= 4.1.0, PHP 5)

array_key_exists — 检查给定的键名或索引是否存在于数组中
说明
bool array_key_exists ( mixed key, array search )

array_key_exists() 在给定的 key 存在于数组中时返回 TRUE。key 可以是任何能作为数组索引的值。array_key_exists() 也可用于对象。
程序会针对三种不同的类型分别处理,
1、字符串: case IS_STRING:
==> static inline int zend_symtable_exists(HashTable *ht, char *arKey, uint nKeyLength)
==>#define HANDLE_NUMERIC(key, length, func) // 将处理字符串类型的key值,如果是数字则取func值所得的值,否则转下一步
==> ZEND_API int zend_hash_exists(HashTable *ht, char *arKey, uint nKeyLength) // 判断在数组所在的hashtable中是否存在此字符串
2、数字:case IS_LONG:
==>ZEND_API int zend_hash_index_exists(HashTable *ht, ulong h) // 此函数取索引值为h的bucket,如果此索引存在多个值,则遍历取key值为数字型的bucket
3、字值:case IS_NULL:
==>zend_hash_exists(HASH_OF(*array), “”, 1) // 判断数组所在hashtable中是否存在空值
以上的函数如此存在则:RETURN_TRUE;否则:RETURN_FALSE;

in_array
(PHP 4, PHP 5)

in_array — 检查数组中是否存在某个值
说明
bool in_array ( mixed needle, array haystack [, bool strict] )

在 haystack 中搜索 needle,如果找到则返回 TRUE,否则返回 FALSE。

如果第三个参数 strict 的值为 TRUE 则 in_array() 函数还会检查 needle 的类型是否和 haystack 中的相同。

注意: 如果 needle 是字符串,则比较是区分大小写的。

注意: 在 PHP 版本 4.2.0 之前,needle 不允许是一个数组。

程序实现非常简单,遍历数组所在的hash table,依据strict选择比较函数,如果为真则使用is_identical_function,否则为is_equal_function,strict的默认值为FALSE
然后使用此函数判断是否相等,如果存在则直接返回TRUE

但是在程序中我们有看到 target_hash = HASH_OF(*array);
宏源码如下:

1
#define HASH_OF(p) (Z_TYPE_P(p)==IS_ARRAY ? Z_ARRVAL_P(p) : ((Z_TYPE_P(p)==IS_OBJECT ? Z_OBJ_HT_P(p)->get_properties((p) TSRMLS_CC) : NULL)))

此方法的作用是判断是否是数组,如果是数组返回数组,否则判断是否是对象,如果为对象,则返回对象的所有属性,否则返回NULL
但是在前面又有判断参数是否为数组的判断,如下代码:

1
2
3
4
 if (Z_TYPE_PP(array) != IS_ARRAY) {
  php_error_docref(NULL TSRMLS_CC, E_WARNING, "Wrong datatype for second argument");
  RETURN_FALSE;
 }

难道是历史遗留问题?
奇怪!
EOF

PHP源码阅读笔记十:array_keys,array_values函数

PHP源码阅读笔记十:array_keys,array_values函数
新年的第一篇文章,首先给各位朋友拜年
今天有空看了下代码,写点东西,留作纪念!

array array_keys ( array input [, mixed search_value [, bool strict]] )

array_keys() 返回 input 数组中的数字或者字符串的键名。

如果指定了可选参数 search_value,则只返回该值的键名。否则 input 数组中的所有键名都会被返回。自 PHP 5 起,可以用 strict 参数来进行全等比较(===)。

array_keys 函数的实现在standard/array.c文件的2416行 PHP_FUNCTION(array_keys)

程序依照PHP一贯的风格,先判断输入是否正确,如果有第三个参数,则判断大小的函数使用is_identical_function(默认情况下是使用 is_equal_function函数)
然后初始化返回的数组,遍历所给的数组,取每个元素的key值,赋值给返回的数组,这个key值又分为数字和字符串两种,其中最主要的函数是hash操作函数zend_hash_get_current_key_ex(取当前元素的key值)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
ZEND_API int zend_hash_get_current_key_ex(HashTable *ht, char **str_index, uint *str_length, ulong *num_index, zend_bool duplicate, HashPosition *pos)
{
    Bucket *p;
 
    p = pos ? (*pos) : ht->pInternalPointer;
 
    IS_CONSISTENT(ht);
 
    if (p) {
        if (p->nKeyLength) {    //    数字型的nKeyLength长度为0
            if (duplicate) {
                *str_index = estrndup(p->arKey, p->nKeyLength - 1);
            } else {
                *str_index = p->arKey;    //    /* arKey存储key名称(字符串类型的key)必须是最后一个成员,*/
            }
            if (str_length) {
                *str_length = p->nKeyLength;
            }
            return HASH_KEY_IS_STRING;
        } else {
            *num_index = p->h;    //    存储数字key值
            return HASH_KEY_IS_LONG;
        }
    }
    return HASH_KEY_NON_EXISTANT;
}

对于此函数的理解主要是对bucket定义的了解
与bucket相关的内容请移步 http://www.phppan.com/2009/12/php-hashtable-demo/

array array_values ( array input )

array_values() 返回 input 数组中所有的值并给其建立数字索引。
array_values 函数与array_keys的函数实现基本类似,并且还少了一个zend_hash_get_current_key_ex操作和判断值类型的操作,