PHP extensionの作り方 ５分でできるHello world!

このドキュメントの内容は、以下の通りです。

• はじめに
• CodeGen_PECLのインストール
• XMLの準備
• ファイル helloworld.xml
• スケルトンの生成
• ビルド
• ソースの修正
• 根本的解決
• テスト
• 実行
• インストール

はじめに

PHPエクステンションを爆速で作るサンプルです。

CodeGen_PECLのインストール

sudo pear install --alldeps CodeGen_PECL

FreeBSD で ports から入れたのですが、pecl-gen コマンドが入ってこなかったので pear コマンドでインストールしました。

XMLの準備

pecl-gen コマンドでソースコード類を生成します。pecl-genコマンドには、specファイルが必要です。

ファイル helloworld.xml

<?xml version="1.0" encoding="UTF-8"?>
<extension name="helloworld" version="1.0.0">
  <summary>Hello, World!</summary>
  <description><?data
This is PHP extension module.
  ?></description>

  <maintainers>
    <maintainer>
      <user>kaoru</user>
      <name>kaoru</name>
      <email>kaoru@foo.com</email>
      <role>lead</role>
    </maintainer>
  </maintainers>

  <license>PHP</license>

  <channel>__uri</channel>

  <release>
    <version>1.0.0</version>
    <date>2013-02-16</date>
    <state>stable</state>
    <notes><?data
- Initial release.
    ?></notes>
  </release>

  <function name="helloworld" role="public">
    <proto>void helloworld()</proto>
    <summary>Hello, World!</summary>
    <description><?data
Print "Hello, World!".
    ?></description>
    <code><?data
php_printf("Hello, World!%s", PHP_EOL);
    ?></code>
    <test>
      <code><?data
helloworld();
      ?></code>
      <result mode="plain"><?data
Hello, World!
      ?></result>
    </test>  
  </function>
</extension>

スケルトンの生成

pecl-gen helloworld.xml

ビルド

cd helloworld
phpize
./configure
gmake

ソースの修正

function_entry がないとエラーが出ました。

error: expected '=', ',', ';', 'asm' or '__attribute__' before 'xxx'

function_entry は、 zend_function_entry と直します。
修正したら、gmake を実行します。

根本的解決

pecl-gen を何度も叩くことになるので、CodeGen_PECL のコードを修正してしまったほうがよいです。

対象ファイルは /usr/local/share/pear/CodeGen/PECL/Extension.php です。

suvo vim /usr/local/share/pear/CodeGen/PECL/Extension.php

対象となるコードは、この部分です。

function generateFunctionRegistrations()
{
	$code  = "/* {{{ {$this->name}_functions[] */\n";
	$code .= "function_entry {$this->name}_functions[] = {\n";
	foreach ($this->functions as $function) {

zend_function_entry に修正します。

$code .= "zend_function_entry {$this->name}_functions[] = {\n";

テスト

ビルドができたらテストをします。

% make test

Build complete.
Don't forget to run 'make test'.


=====================================================================
PHP         : /usr/local/bin/php
PHP_SAPI    : cli
PHP_VERSION : 5.4.11
ZEND_VERSION: 2.4.0
PHP_OS      : FreeBSD - FreeBSD vm2.local 9.0-RELEASE FreeBSD 9.0-RELEASE #0: Tue Jan  3 07:15:25 UTC 2012     root@obrian.cse.buffalo.edu:/usr/obj/usr/src/sys/GENERIC i386
INI actual  : /home/foo/php/helloworld/tmp-php.ini
More .INIs  :
CWD         : /home/foo/php/helloworld
Extra dirs  :
VALGRIND    : Not used
=====================================================================
TIME START 2013-02-16 18:28:44
=====================================================================
PASS helloworld() function [tests/helloworld.phpt]
=====================================================================
TIME END 2013-02-16 18:28:44

=====================================================================
TEST RESULT SUMMARY
---------------------------------------------------------------------
Exts skipped    :    0
Exts tested     :   10
---------------------------------------------------------------------

Number of tests :    1                 1
Tests skipped   :    0 (  0.0%) --------
Tests warned    :    0 (  0.0%) (  0.0%)
Tests failed    :    0 (  0.0%) (  0.0%)
Expected fail   :    0 (  0.0%) (  0.0%)
Tests passed    :    1 (100.0%) (100.0%)
---------------------------------------------------------------------
Time taken      :    0 seconds
=====================================================================

This report can be automatically sent to the PHP QA team at
http://qa.php.net/reports and http://news.php.net/php.qa.reports
This gives us a better understanding of PHP's behavior.
If you don't want to send the report immediately you can choose
option "s" to save it.  You can then email it to qa-reports@lists.php.net later.
Do you want to send this report now? [Yns]: n

実行

このようなコマンドラインで実行します。

php -d extension=modules/helloworld.so -r 'helloworld();'

Hello, World! と表示されたでしょうか？

インストール

sudo make install

以上で、Hello World ができました。

---