[译] 理解PHP内部函数的定义（给PHP开发者的PHP源码-第二部分），开发者源码_PHP教程

[译] 理解PHP内部函数的定义（给PHP开发者的PHP源码-第二部分），开发者源码

文章来自：http://www.aintnot.com/2016/02/10/understanding-phps-internal-function-definitions-ch
原文：https://nikic.github.io/2012/03/16/Understanding-PHPs-internal-function-definitions.html

欢迎来到"给PHP开发者的PHP源码"系列的第二部分。

在上一篇中，ircmaxell说明了你可以在哪里找到PHP的源码，它的基本目录结构以及简单地介绍了一些C语言（因为PHP是用C语言来写的）。如果你错过了那篇文章，在你开始读这篇文章之前也许你应该读一下它。

在这篇文章中，我们谈论的是定位PHP内部函数的定义，以及理解它们的原理。

如何找到函数的定义

作为开始，让我们尝试找出strpos函数的定义。

尝试的第一步，就是去PHP 5.4根目录然后在页面顶部的搜索框输入strpos。搜索的结果是一个很大的列表，展示了strpos在PHP源码中出现的位置。

因为这个结果对我们并没有太大的帮助，我们使用一个小技巧：我们搜索"PHP_FUNCTION strpos"（不要漏了双引号，它们很重要），而不是strpos.

现在我们得到两个入口链接：

/PHP_5_4/ext/standard/ 　　php_string.h 48 PHP_FUNCTION(strpos); 　　string.c 1789 PHP_FUNCTION(strpos)

第一个要注意的事情是，两个位置都是在ext/standard文件夹。这就是我们希望找到的，因为strpos函数（跟大部分string，array和文件函数一样）是standard扩展的一部分。

现在，在新标签页打开两个链接，然后看看它们背后藏了什么代码。

你会看到第一个链接带你到了php_string.h文件，它包含了下面的代码：

　　

       // ...
　　PHP_FUNCTION(strpos);
　　PHP_FUNCTION(stripos);
　　PHP_FUNCTION(strrpos);
　　PHP_FUNCTION(strripos);
　　PHP_FUNCTION(strrchr);
　　PHP_FUNCTION(substr);
　　// ...

这就是一个典型的头文件（以.h后缀结尾的文件）的样子：单纯的函数列表，函数在其他地方定义。事实上，我们对这些并不感兴趣，因为我们已经知道我们要找的是什么。

第二个链接更有趣：它带我们到string.c文件，这个文件包含了函数真正的源代码。

在我带你一步一步地查阅这个函数之前，我推荐你自己尝试理解这个函数。这是一个很简单的函数，尽管你不知道真正的细节，但大多数代码看起来都很清晰。

PHP函数的骨架

所有的PHP函数都使用同一个基本结构。在函数顶部定义了各个变量，然后调用zend_parse_parameters函数，然后到了主要的逻辑，当中有RETURN_***和php_error_docref的调用。

那么，让我们以函数的定义来开始：

zval *needle;
char *haystack;
char *found = NULL;
char  needle_char[2];
long  offset = 0;
int   haystack_len;




第一行定义了一个指向zval的指针needle。zval是在PHP内部代表任意一个PHP变量的定义。它真正是怎么样的会在下一篇文章重点谈论。

第二行定义了指向单个字符的指针haystack。这时候，你需要记住，在C语言里面，数组代表指向它们第一个元素的指针。比如说，haystack变量会指向你所传递的$haystack字符串变量的第一个字符。haystack + 1会指向第二个字符，haystack + 2指向第三个，以此类推。因此，通过逐个递增指针，可以读取整个字符串。

那么问题来了，PHP需要知道字符串在哪里结束。不然的话，它会一直递增指针而不会停止。为了解决这个问题，PHP也保存了明确的长度，这就是haystack_len变量。

现在，在上面的定义中，我们感兴趣的是offset变量，这个变量用来保存函数的第三个参数：开始搜索的偏移量。它使用long来定义，跟int一样，也是整型数据类型。现在这两者的差异并不重要，但你需要知道的是在PHP中，整型值使用long来存储，字符串的长度使用int来存储。

现在来看看下面的三行：

if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sz|l", &haystack, &haystack_len, &needle, &offset) == FAILURE) {
    return;
}




这三行代码做的事情就是，获取传递到函数的参数，然后把它们存储到上面声明的变量中。

传递给函数的第一个参数是传递参数的数量。这个数字通过ZEND_NUM_ARGS()宏提供。

下一个函数是TSRMLS_CC宏，这是PHP的一种特性。你会发现这个奇怪的宏分散在PHP代码库的很多地方。是线程安全资源管理器（TSRM）的一部分，它保证PHP不会在多线程之间混乱变量。这对我们来说不是很重要，当你在代码中看到TSRMLS_CC（或者TSRMLS_DC）的时候，忽略它就行。（有一个奇怪的地方你需要注意的是，在"argument"之前没有逗号。这是因为不管你是否使用线程安全创建函数，该宏会被解释为空或者, trsm_ls。因此，逗号是宏的一部分。）

现在，我们来到重要的东西："sz\|l"字符串标记了函数接收的参数。：

s  // 第一个参数是字符串
z  // 第二个参数是一个zval结构体，任意的变量
|  // 标识接下来的参数是可选的
l  // 第三个参数是long类型（整型）

除了s，z，l之外，还有更多的标识类型，但是大部分都能从字符中清楚其意思。例如b是boolean，d是double（浮点型数字），a是array，f是回调（function），o是object。

接下来的参数&haystack，&haystack_len，&needle，&offset指定了需要赋值的参数的变量。你可以看到，它们都是使用引用（&）传递的，意味着它们传递的不是变量本身，而是指向它们的指针。

这个函数调用之后，haystack会包含haystack字符串，haystack_len是字符串的长度，needle是needle的值，offset是开始的偏移量。

而且，这个函数使用FAILURE（当你尝试传递无效参数到函数时会发生，比如传递一个数组赋值到字符串）来检查。这种情况下zend_parse_parameters函数会抛出警告，而此函数马上返回（会返回null给PHP的用户层代码）。

在参数解析完毕以后，主函数体开始：

if (offset 0