[翻訳] [php拡張機能の開発と組み込み] 第19章 - ホスティング環境のセットアップ

ホスティング環境をセットアップする

PHP API の世界を理解し、zval と言語内部拡張メカニズムを使用して多くのことができるようになったので、ギアを変えて使用してみましょう最適な機能を実行するには: スクリプト コードを説明します。

組み込み SAPI

概要を復習すると、PHP はユーザー空間関数とクラス ライブラリのすべての拡張機能を構築しました。同時に、その下には Web サーバーのインターフェース (Apache、iis、コマンドラインインターフェース cli など) を担うサービス API (SAPI) 層があります

これらの多くの sapi 実装の中に、特別な sapi があります。この sapi 実装がビルドされると、既知のすべての PHP および Zend API 関数と変数を含むライブラリ オブジェクトが作成されます。このライブラリ オブジェクトには、外部プログラムの呼び出しを簡素化するための追加のヘルパー関数とマクロも含まれています。

埋め込み API を生成する ライブラリとヘッダー ファイルは、./configure コマンドに --enable-embed を渡すだけで、エラーのレポートとトレースに役立ちます。 Help.

--enable-maintainer-zts をオンにする必要がある場合もあります。もちろん、その理由はすでによく知られており、コード内のエラーに気づくのに役立ちますが、ここに他の理由があるとします。ある時点で、スクリプト タスクを実行するために PHP 埋め込みライブラリを使用するアプリケーションが複数ある場合、アプリケーションの 1 つは単に寿命が短く、スレッドを使用しないため、効率を高めるために ZTS をオフにすることをお勧めします。

ここで 2 番目のアプリケーションを想像してください。Web サーバーなどのスレッドを使用する場合、各スレッドは独自のリクエスト コンテキストを追跡する必要があります。ただし、ZTS がオンの場合は、最初のアプリケーションのみがこのライブラリを使用できます。両方のアプリケーションが独自のプロセス空間でそれを使用できます。同じ共有オブジェクトを使用します

もちろん、両方のバージョンを同時にビルドして、それらに異なる名前を付けることもできますが、ZTS を含めることによるわずかな効率の低下を上回ります。 ZTS が必要ない場合

デフォルトでは、組み込みライブラリは libphp5.so 共有オブジェクト、または Windows ではダイナミック リンク ライブラリとして構築されますが、オプションの static キーワード (--enable) を使用することも可能です。 -embed =static) は静的ライブラリとしてビルドされます。

静的ライブラリ バージョンとしてビルドすると、システム内に複数の php バージョンが存在する可能性があり、結果としてアプリケーションが作成される可能性があります。 ZendEngine と PHP フレームワーク全体をホストするため、バイナリはかなり大きくなります。そのため、比較的小さいライブラリが必要かどうかを慎重に検討する必要があります

どちらのビルド方法を選択しても、make install を実行すると、 libphp5 は、./configure で指定された PREFIX ディレクトリの下の lib/ ディレクトリにコピーされます。さらに、php_embed.h のヘッダー ファイル、および php 埋め込みライブラリを使用するときに必要な他のいくつかの重要なヘッダー ファイルもコピーされます。プログラムをコンパイルする

ホスト アプリケーションをビルドしてコンパイルする

本質的に、ライブラリは目的のない単なるコードのコレクションです。それを機能させるには、PHP を組み込んだアプリケーションが必要です。まず、Zend エンジンを起動し、リクエストを処理するために PHP を初期化し、リソースのクリーンアップに戻る非常に単純なアプリケーションを完成させましょう。

#include <sapi/embed/php_embed.h>

int main(int argc, char *argv[])
{
    PHP_EMBED_START_BLOCK(argc,argv)
    PHP_EMBED_END_BLOCK()

    return 0;
}

これには非常に多くのヘッダー ファイルが含まれるため、デフォルト (/usr/local) の PREFIX とは異なるパスを使用すると、実際にはこのような小さなスニペットの場合に通常かかるよりも時間がかかります。では、必ず次の方法でパスを指定してください:

gcc -I /usr/local/php-dev/include/php/ \
	-I /usr/local/php-dev/include/php/main/ \
	-I /usr/local/php-dev/include/php/Zend/ \
	-I /usr/local/php-dev/include/php/TSRM/ \
	-lphp5 \
	-o embed1 
	embed1.c

このコマンドを毎回入力するのは面倒なので、代わりに単純な Makefile を使用することをお勧めします:

CC = gcc 
CFLAGS = -c \
    -I /usr/local/php-dev/include/php/ \
    -I /usr/local/php-dev/include/php/main/ \
    -I /usr/local/php-dev/include/php/Zend/ \
    -I /usr/local/php-dev/include/php/TSRM/ \
    -Wall -g
LDFLAGS = -lphp5

all: embed1.c
    $(CC) -o embed1.o embed1.c $(CFLAGS)
    $(CC) -o embed1 embed1.o $(LDFLAGS)

この Makefile には、以前に提供されていたコマンドといくつかの重要な違いがあります。まず、-Wall スイッチを使用してコンパイル時の警告をオンにし、-g を使用してデバッグ情報をオンにします。さらに、コンパイルとリンクのフェーズを 2 つの別々のフェーズに分離します。 . ステージで、後でソース ファイルを追加するのが比較的簡単になるように、この Makefile を自分で再編成してください。ただし、ここでの配置はスペースではなく Tab (水平タブ文字) です。 c ソース ファイルを作成したら、make コマンドを実行して新しい embed1 実行可能プログラムをビルドするだけです。

パッケージを埋め込んで cli を再作成します

これで、アプリケーションで PHP にアクセスして使用できるようになります。この章の残りの部分は、このテスト アプリケーション フレームワークでの cli sapi の再作成を中心に説明します

これは非常に簡単で、cli バイナリ プログラムの最も基本的な機能です。その機能は名前を指定することです。コマンドラインでスクリプトを実行すると、PHP が embed1.c の内容を次のコードに置き換えて、アプリケーションに cli を実装します。

#include <stdio.h>
#include <sapi/embed/php_embed.h>

int main(int argc, char *argv[]) {
    zend_file_handle    script;

    /* 基本的参数检查 */
    if ( argc <= 1 ) {
        fprintf(stderr, "Usage: %s <filename.php> <arguments>\n", argv[0]);
        return -1;
    }
    
    /* 设置一个文件处理结构 */
    script.type             = ZEND_HANDLE_FP;
    script.filename         = argv[1];
    script.opened_path      = NULL;
    script.free_filename    = 0;
    if ( !(script.handle.fp = fopen(script.filename, "rb")) ) {
        fprintf(stderr, "Unable to open: %s\n", argv[1]);
        return -1;
    }
    
    /* 在将命令行参数注册给php时(php中的$argv/$argc), 忽略第一个命令行参数, 因为它对php脚本无意义 */
    argc --;
    argv ++;
    
    PHP_EMBED_START_BLOCK(argc, argv)
        php_execute_script(&script TSRMLS_CC);
    PHP_EMBED_END_BLOCK()
    
    return 0;
}

元の作品のコードを翻訳者の環境で直接実行することはできません。上記のコードは変更されています。

もちろん、テストするためのファイルが必要です。test php という名前の小さな php スクリプトを作成し、実行します。コマンドラインで埋め込みプログラムを使用:

$ ./embed1 test.php

他のパラメータをコマンドラインに渡す場合、PHP スクリプト /$_SERVER['argv] で $_SERVER['argc'] を使用できます。 '] を参照してください。

PHP_EMBED_START_BLOCK() と PHP_EMBED_END_BLOCK() の間のコードがインデントされていることに気づいたかもしれません。これは、これら 2 つのマクロが実際には C 言語のコード ブロック スコープを構成しているためです。 、 PHP_EMBED_START_BLOCK() には開始中括弧 "{" が含まれており、PHP_EMBED_END_BLOCK() には対応する終了中括弧 "}" が含まれています。これは非常に重要です。これは、これらを別々の開始/停止関数に入れることができないことです。この問題の解決策については、次の章で説明します

古い手法、新しい使い方

が PHP_EMBED_START_BLOCK() で呼び出されると、アプリケーションは PHP リクエスト サイクルの開始になります。これは、RINIT コールバック関数の完了と同じです。この時点で、以前と同様に php_execute_script() コマンドを実行することも、PHP_FUNCTION() または RINIT() php/Zend API 命令で実行できるその他の正当なコマンドを実行することもできます。ブロック単位で。

初期変数を設定します

第2章"变量的里里外外"中介绍了操纵符号表的概念, 第5至18章则介绍了怎样通过用户空间脚本调用内部函数使用这些技术. 到这里这些处理也并没有发生变化, 虽然这里并没有激活的用户空间脚本, 但是你的包装应用仍然可以操纵符号表. 将你的PHP_EMBED_START_BLOCK()/PHP_EMBED_END_BLOCK()代码块替换为下面的代码:

    PHP_EMBED_START_BLOCK(argc, argv)
        zval    *type;

        ALLOC_INIT_ZVAL(type);
        ZVAL_STRING(type, "Embedded", 1);
        ZEND_SET_SYMBOL(&EG(symbol_table), "type", type);
        
        php_execute_script(&script TSRMLS_CC);
    PHP_EMBED_END_BLOCK()

现在使用make重新构建embed1, 并用下面的测试脚本进行测试:

<?php
	var_dump($type);
?>

当然, 这个简单的概念可以很容易的扩展为填充这个类型信息到$_SERVER超级全局变量数组中.

    PHP_EMBED_START_BLOCK(argc, argv)
        zval    **SERVER_PP, *type;

        /* 注册$_SERVER超级全局变量 */
        zend_is_auto_global_quick("_SERVER", sizeof("_SERVER") - 1, 0 TSRMLS_CC);
        /* 查找$_SERVER超级全局变量 */
        zend_hash_find(&EG(symbol_table), "_SERVER", sizeof("_SERVER"), (void **)&SERVER_PP) ;

        /* $_SERVER['SAPI_TYPE'] = "Embedded"; */
        ALLOC_INIT_ZVAL(type);
        ZVAL_STRING(type, "Embedded", 1);
        ZEND_SET_SYMBOL(Z_ARRVAL_PP(SERVER_PP), "SAPI_TYPE", type);

        php_execute_script(&script TSRMLS_CC);
    PHP_EMBED_END_BLOCK()

译注: 译者的环境中代码运行到zend_hash_find()处$_SERVER尚未注册, 经过跟踪, 发现它是直到编译用户空间代码的时候, 发现用户空间使用了$_SERVER变量才进行的注册. 因此, 上面的代码中增加了zend_is_auto_global_quick()的调用, 通过这个调用将完成对$_SERVER的注册.

覆写INI选项

在第13章"INI设置"中, 有一部分是讲INI修改处理器的, 在那里看到的是INI阶段的处理. PHP_EMBED_START_BLOCK()宏则将这些代码放到了运行时阶段. 也就是说这个时候修改某些设置(比如register_globals/magic_quotes_gpc)已经有点迟了.

不过在内部访问也没有什么不好. 所谓的"管理设置"比如safe_mode在这个略迟的阶段可以使用下面的zend_alter_ini_entry()命令打开或关闭:

int zend_alter_ini_entry(char *name, uint name_length,
                         char *new_value, uint new_value_length,
                         int modify_type, int stage);

name, new_value以及它们对应的长度参数的含义正如你所预期的: 修改名为name的INI设置的值为new_value. 要注意name_length包含了末尾的NULL字节, 然而new_value_length则不包含; 然而, 无论如何, 两个字符串都必须是NULL终止的.

modify_type则提供简化的访问控制检查. 回顾每个INI设置都有一个modifiable属性, 它是PHP_INI_SYSTEM, PHP_INI_PERDIR, PHP_INI_USER等常量的组合值. 当使用zend_alter_ini_entry()修改INI设置时, modify_type参数必须包含至少一个INI设置的modifiable属性值.

用户空间的ini_set()函数通过传递PHP_INI_USER利用了这个特性, 也就是说只有modifiable属性包含PHP_INI_USER标记的INI设置才能使用这个函数修改. 当在你的嵌入式应用中使用这个API调用时, 你可以通过传递PHP_INI_ALL标记短路这个访问控制系统, 它将包含所有的INI访问级别.

stage必须对应于Zend Engine的当前状态; 对于这些简单的嵌入式示例, 总是PHP_INI_STAGE_RUNTIME. 如果这是一个扩展或更高端的嵌入式应用, 你可能就需要将这个值设置为PHP_INI_STAGE_STARTUP或PHP_INI_STAGE_ACTIVE.

下面是扩展embed1.c源文件, 让它在执行脚本文件之前强制开启safe_mode.

    PHP_EMBED_START_BLOCK(argc, argv)
        zval    **SERVER_PP, *type;

        /* 不论php.ini中如何设置都强制开启safe_mode */
        zend_alter_ini_entry("safe_mode", sizeof("safe_mode"), "1", sizeof("1") - 1, PHP_INI_ALL, PHP_INI_STAGE_RUNTIME);
        
        /* 注册$_SERVER超级全局变量 */
        zend_is_auto_global_quick("_SERVER", sizeof("_SERVER") - 1, 0 TSRMLS_CC);
        /* 查找$_SERVER超级全局变量 */
        zend_hash_find(&EG(symbol_table), "_SERVER", sizeof("_SERVER"), (void **)&SERVER_PP) ;
        
        /* $_SERVER['SAPI_TYPE'] = "Embedded"; */
        ALLOC_INIT_ZVAL(type);
        ZVAL_STRING(type, "Embedded", 1);
        ZEND_SET_SYMBOL(Z_ARRVAL_PP(SERVER_PP), "SAPI_TYPE", type);
        
        php_execute_script(&script TSRMLS_CC);
    PHP_EMBED_END_BLOCK()

定义附加的超级全局变量

在第12章"启动, 终止, 以及其中的一些点"中, 你知道了用户空间全局变量以及超级全局变量可以在启动(MINIT)阶段定义. 同样, 本章介绍的嵌入式直接跳过了启动阶段, 处于运行时状态. 和覆写INI一样, 这并不会显得太迟.

超级全局变量的定义实际上只需要在脚本编译之前定义即可, 并且在php的进程生命周期中它只应该出现一次. 在扩展中的正常情况下, MINIT是唯一可以保证这些条件的地方.

由于你的包装应用现在是在控制中的, 因此可以保证定义用户空间自动全局变量的这些点位于真正编译脚本源文件的php_execute_script()命令之前. 我们定义一个$_EMBED超级全局变量并给它设置一个初始值来进行测试:

    PHP_EMBED_START_BLOCK(argc, argv)
        zval    **SERVER_PP, *type, *EMBED, *foo;

        /* 在全局作用域创建$_EMBED数组 */
        ALLOC_INIT_ZVAL(EMBED);
        array_init(EMBED);
        ZEND_SET_SYMBOL(&EG(symbol_table), "_EMBED", EMBED);

        /* $_EMBED['foo'] = 'Bar'; */
        ALLOC_INIT_ZVAL(foo);
        ZVAL_STRING(foo, "Bar", 1); 
        add_assoc_zval_ex(EMBED, "foo", sizeof("foo"), foo);

        /* 注册超级全局变量$_EMBED */
        zend_register_auto_global("_EMBED", sizeof("_EMBED")
#ifdef ZEND_ENGINE_2
            , 1, NULL TSRMLS_CC);
#else
            , 1 TSRMLS_CC);
#endif

        /* 不论php.ini中如何设置都强制开启safe_mode */
        zend_alter_ini_entry("safe_mode", sizeof("safe_mode"), "1", sizeof("1") - 1, PHP_INI_ALL, PHP_INI_STAGE_RUNTIME);

        /* 注册$_SERVER超级全局变量 */
        zend_is_auto_global_quick("_SERVER", sizeof("_SERVER") - 1, 0 TSRMLS_CC);
        /* 查找$_SERVER超级全局变量 */
        zend_hash_find(&EG(symbol_table), "_SERVER", sizeof("_SERVER"), (void **)&SERVER_PP) ;

        /* $_SERVER['SAPI_TYPE'] = "Embedded"; */
        ALLOC_INIT_ZVAL(type);
        ZVAL_STRING(type, "Embedded", 1); 
        ZEND_SET_SYMBOL(Z_ARRVAL_PP(SERVER_PP), "SAPI_TYPE", type);

        php_execute_script(&script TSRMLS_CC);
    PHP_EMBED_END_BLOCK()

要记住, Zend Engine 2(php 5.0或更高)使用了不同的zend_register_auto_global()元婴, 因此你需要用前面讲php 4兼容时候讲过的#ifdef. 如果你不关心旧版本php的兼容性, 则可以丢弃这些指令让代码变得更加整洁.

小结

如你所见, 将完整的Zend Engine和PHP语言嵌入到你的应用中相比如扩展新功能来说工作量要少. 由于它们共享相同的基础API, 我们可以学习尝试让其他实例可访问.

通过本章的学习, 你了解了最简单的嵌入式脚本代码格式, 同时还有all-in-one的宏PHP_EBED_START_BLOCK()和PHP_EMBED_END_BLOCK(). 下一章你将回到这些宏的层的使用, 利用它们将php和你的宿主系统结合起来.

以上就是[翻译][php扩展开发和嵌入式]第19章-设置宿主环境的内容，更多相关内容请关注PHP中文网（www.php.cn）！