PHPの内部関数の定義を理解する

「PHP 開発者のための PHP ソース コード」シリーズの第 2 部へようこそ。

前回の記事で、ircmaxell は、PHP のソース コードがどこにあるか、その基本的なディレクトリ構造を説明し、C 言語を簡単に紹介しました (PHP は C 言語で書かれているため)。その記事を見逃した場合は、この記事を読み始める前に読んでおくとよいでしょう。

この記事では、PHP 内部関数の定義を見つけてその原理を理解することについて話します。

関数の定義を見つける方法

まず、strpos 関数の定義を見つけてみましょう。

最初のステップは、PHP 5.4 ルート ディレクトリに移動し、ページ上部の検索ボックスに strpos と入力することです。検索の結果は、PHP ソース コード内で strpos が出現する場所を示す大きなリストになります。

この結果はあまり役に立たないので、ちょっとしたトリックを使用します。strpos の代わりに、「PHP_FUNCTION strpos」(二重引用符を見逃さないでください。重要です) を検索します。 .

これで 2 つのエントリ リンクが得られます:

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

最初に注意すべきことは、どちらの場所も ext/ にあるということです。標準フォルダ。 strpos 関数 (ほとんどの文字列、配列、ファイル関数と同様) は標準拡張機能の一部であるため、これが期待されるものです。

次に、新しいタブで両方のリンクを開いて、その背後にどのようなコードが隠されているかを確認してください。

最初のリンクで php_string.h ファイルに移動することがわかります。このファイルには次のコードが含まれています。

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

これこれは、一般的なヘッダー ファイル (拡張子 .h で終わるファイル) は次のようになります。別の場所で定義された関数の単純なリストです。実際、私たちは何を探しているのかすでにわかっているので、これらには興味がありません。

2 番目のリンクはさらに興味深いものです。このリンクは、関数の実際のソース コードを含む 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 を指すポインター針を定義します。 zval は、PHP 内の任意の PHP 変数を表す定義です。実際にどのようなものになるかについては、次の記事で説明します。

2 行目は、単一文字へのポインタである haystack を定義します。この時点で、C 言語では配列は最初の要素へのポインターを表すことを覚えておく必要があります。たとえば、haystack 変数は、渡した $haystack 文字列変数の最初の文字を指します。 haystack + 1 は 2 番目の文字を指し、haystack + 2 は 3 番目の文字を指します。したがって、ポインタを 1 つずつインクリメントすることで、文字列全体を読み取ることができます。

問題は、PHP が文字列がどこで終わるかを認識する必要があるということです。それ以外の場合は、停止せずにポインタをインクリメントし続けます。この問題を解決するために、PHP は明示的な長さ (haystack_len 変数) も保存します。

上記の定義で関心があるのは、関数の 3 番目のパラメーター、つまり検索を開始するオフセットを保存するために使用されるオフセット変数です。これは、int と同様に整数データ型である long を使用して定義されます。この 2 つの違いは重要ではありませんが、知っておく必要があるのは、PHP では整数値は長さとして保存され、文字列の長さは int として保存されるということです。

次に、次の 3 行を見てください。

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

これらの 3 行のコードは、渡されたデータを取得することを目的としています。関数パラメータに追加し、上で宣言した変数に格納します。

関数に渡される最初のパラメータは、渡されるパラメータの数です。この数値は、ZEND_NUM_ARGS() マクロを介して提供されます。

次の関数は、PHP の機能である TSRMLS_CC マクロです。この奇妙なマクロは、PHP コード ベースのさまざまな場所に散在していることがわかります。これは、PHP が複数のスレッド間で変数をシャッフルしないようにする Thread-Safe Resource Manager (TSRM) の一部です。これは私たちにとってあまり重要ではありません。コード内に TSRMLS_CC (または TSRMLS_DC) が表示された場合は無視してください。 (注意が必要な奇妙な点は、「引数」の前にコンマがないことです。これは、スレッド セーフを使用して関数を作成したかどうかに関係なく、マクロは空または trsm_ls として解釈されるためです。したがって、コンマは一部です)

ここで重要な点に移ります。「sz|l」文字列は、関数によって受け取られるパラメータをマークします。 :

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

s、z、l 以外にもロゴの種類はありますが、ほとんどのロゴは文字から意味を明​​らかにできます。たとえば、b はブール値、d は double (浮動小数点数)、a は配列、f はコールバック (関数)、o はオブジェクトです。

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

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

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

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

if (offset < 0 || offset > haystack_len) {    php_error_docref(NULL TSRMLS_CC, E_WARNING, "Offset not contained in string");    RETURN_FALSE;}

这段代码做的事情很明显，如果offset超出了边界，一个E_WARNING级别的错误会通过php_error_docref函数抛出，然后函数使用RETURN_FALSE宏返回false。

php_error_docref是一个错误函数，你可以在扩展目录找到它（比如，ext文件夹）。它的名字根据它在错误页面中返回文档参考（就是那些不会正常工作的函数）定义。还有一个zend_error函数，它主要被Zend Engine使用，但也经常出现在扩展代码中。

两个函数都使用sprintf函数，比如格式化信息，因此错误信息可以包含占位符，那些占位符会被后面的参数填充。下面有一个例子：

php_error_docref(NULL TSRMLS_CC, E_WARNING, "Failed to write %d bytes to %s", Z_STRLEN_PP(tmp), filename);// %d is filled with Z_STRLEN_PP(tmp)// %s is filled with filename

让我们继续解析代码：

if (Z_TYPE_P(needle) == IS_STRING) {    if (!Z_STRLEN_P(needle)) {        php_error_docref(NULL TSRMLS_CC, E_WARNING, "Empty delimiter");        RETURN_FALSE;    }    found = php_memnstr(haystack + offset,                        Z_STRVAL_P(needle),                        Z_STRLEN_P(needle),                        haystack + haystack_len);}

前面的5行非常清晰：这个分支只会在needle为字符串的情况下执行，而且如果它是空的话会抛出错误。然后到了比较有趣的一部分：php_memnstr被调用了，这个函数做了主要的工作。跟往常一样，你可以点击该函数名然后查看它的源码。

php_memnstr返回指向needle在haystack第一次出现的位置的指针（这就是为什么found变量要定义为char *，例如，指向字符的指针）。从这里可以知道，偏移量（offset）可以通过减法被简单地计算，可以在函数的最后看到：

RETURN_LONG(found - haystack);

最后，让我们来看看当needle作为非字符串的时候的分支：

else {    if (php_needle_char(needle, needle_char TSRMLS_CC) != SUCCESS) {        RETURN_FALSE;    }    needle_char[1] = 0;    found = php_memnstr(haystack + offset,                        needle_char,                        1,                        haystack + haystack_len);}

我只引用在手册上写的”如果 needle 不是一个字符串，那么它将被转换为整型并被视为字符顺序值。”这基本上说明，除了写strpos($str, 'A')，你还可以写strpos($str, 65)，因为A字符的编码是65。

如果你再查看变量定义，你可以看到needle_char被定义为char needle_char[2]，即有两个字符的字符串，php_needle_char会将真正的字符（在这里是’A’）到needle_char[0]。然后strpos函数会设置needle_char[1]为0。这背后的原因是因为，在C里面，字符串是使用’’结尾，就是说，最后一个字符被设置为NUL（编码为0的字符）。在PHP的语法环境里，这样的情况不存在，因为PHP存储了所有字符串的长度（因此它不需要0来帮助找到字符串的结尾），但是为了保证与C函数的兼容性，还是在PHP的内部实现了。

Zend functions

我对strpos这个函数感觉好累，让我们找另一个函数吧：strlen。我们使用之前的方法：

从PHP5.4源码根目录开始搜索strlen。

你会看到一堆无关的函数的使用，因此，搜索“PHP_FUNCTION strlen”。当你这么搜索的时候，你会发现一些奇怪的事情发生了：没有任何的结果。

原因是，strlen是少数通过Zend Engine而不是PHP扩展定义的函数。这种情况下，函数不是使用PHP_FUNCTION(strlen)定义，而是ZEND_FUNCTION(strlen)。因此，我们也要搜索“ZEND_FUNCTION strlen”。

我们都知道，我们需要点击没有分号结尾的链接跳到源码的定义。这个链接带我们到下面的函数定义：

ZEND_FUNCTION(strlen){    char *s1;    int s1_len;    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &s1, &s1_len) == FAILURE) {        return;    }    RETVAL_LONG(s1_len);}

这个函数实现太简单了，我不觉得我还需要进一步的解释。

方法

我们会谈论类和对象如何工作的更多细节在其他文章里，但作为一个小小的剧透：你可以通过在搜索框搜索ClassName::methodName来搜索对象方法。例如，尝试搜索SplFixedArray::getSize。

下一部分

下一部分会再次发表在。会谈论到zval是什么，它们是怎么工作的，以及它们是怎么在源码中被使用的（所有的Z_***宏）。

打赏支持我翻译更多好文章，谢谢！

打赏译者

打赏支持我翻译更多好文章，谢谢！

任选一种支付方式

著者について: hoohack

社会人新人の個人ホームページ · 私の記事 · 15 · >