優しいXS入門

XS学び方入門

http://d.hatena.ne.jp/tokuhirom/20090624/1245812352

• perlのソースコードをすぐ参照できるようにしておくのは基本
  • http://d.hatena.ne.jp/tokuhirom/20090401/1238600657
• perlapi.podもすぐ参照できるようにしておく
• XSを書いていると頻繁にSEGVを起こすので，-DDEBUGGINGをつけてコンパイルしたperlバイナリがあるといい
  • gdbが使えるとデバッグの手間がだいぶ減る
  • Perlプログラマのためのgdb入門
• sv.c+sv.hとav.c+av.hは比較的読みやすいうえ，これらはSV APIの細かな挙動まで完全に記述されたドキュメントでもある*1ので読む価値があると思います。
  • http://perl5.git.perl.org/perl.git/blob_plain/HEAD:/pod/perlapi.pod
  • http://d.hatena.ne.jp/tokuhirom/20090401/1238600657
• xsubppで生成されたcコードを見てみる
  • XSのマクロがどのように展開されたかを理解するのは意味あり
  • http://perldoc.perl.org/perlapi.html#Stack-Manipulation-Macros

開発のステップ

Cのライブラリをラップするステップ

テンプレートから生成

• h2xsで？
• Module::Install::XSUtilを使ったものにしたほうがいいかも（後で）
  • src, includeの設定

• xssetupというものを作ってみた。これを改善していく。

typemap作成

INPUT, OUTPUT

INPUT

引数に該当の方が指定された場合に挿入されるコードを記述

• $varがXS関数内で使用する変数
• $argが引数
• $typeがC型名

OUTPUT

• $argは戻り値として使われるSV
• $varは戻り値に代入したい変数

Cでのライブラリのラップ

src/*.cに、Cのライブラリをラップするコードを実装して配備。

（全部.xsにかくのも、小さめなのだったらそれでもいいのかも）

ヘッダ配置

includeに.hを置く

XS開発

make

perl Makefile.PL; make

テスト

prove -b t/*.t

use blib したスクリプトで実際に使ってみるとか

イディオム

定数定義

Text::Migemoから。

#define NEED_newCONSTSUB

static void
init_constants()
{
    HV *stash;
    stash = gv_stashpv("Text::Migemo", 1);
    newCONSTSUB(stash, "MIGEMO_DICTID_MIGEMO",      newSViv(MIGEMO_DICTID_MIGEMO));
    newCONSTSUB(stash, "MIGEMO_DICTID_ROMA2HIRA",   newSViv(MIGEMO_DICTID_ROMA2HIRA));
    newCONSTSUB(stash, "MIGEMO_DICTID_HIRA2KATA",   newSViv(MIGEMO_DICTID_HIRA2KATA));
    newCONSTSUB(stash, "MIGEMO_DICTID_HAN2ZEN",     newSViv(MIGEMO_DICTID_HAN2ZEN));
    newCONSTSUB(stash, "MIGEMO_DICTID_INVALID",     newSViv(MIGEMO_DICTID_INVALID));
    newCONSTSUB(stash, "MIGEMO_OPINDEX_OR",         newSViv(MIGEMO_OPINDEX_OR));
    newCONSTSUB(stash, "MIGEMO_OPINDEX_NEST_IN",    newSViv(MIGEMO_OPINDEX_NEST_IN));
    newCONSTSUB(stash, "MIGEMO_OPINDEX_NEST_OUT",   newSViv(MIGEMO_OPINDEX_NEST_OUT));
    newCONSTSUB(stash, "MIGEMO_OPINDEX_SELECT_IN",  newSViv(MIGEMO_OPINDEX_SELECT_IN));
    newCONSTSUB(stash, "MIGEMO_OPINDEX_SELECT_OUT", newSViv(MIGEMO_OPINDEX_SELECT_OUT));
    newCONSTSUB(stash, "MIGEMO_OPINDEX_NEWLINE",    newSViv(MIGEMO_OPINDEX_NEWLINE));
}

XS学習項目

ppport.h

• perlのAPI互換性

typemap

• http://search.cpan.org/~nwclark/perl-5.8.8/ext/XS/Typemap/Typemap.xs
• perl<->Cの型変換
  • http://mt.endeworks.jp/d-6/2006/07/perl-xs-typemap-vs-retval.html
• Magic
  • http://d.hatena.ne.jp/dayflower/20081210/1228882560
• 型変換
  • http://blog.woobling.org/2009/07/sv.html

• tutorial
  • http://d.hatena.ne.jp/ksmemo/20081221/p2
  • http://d.hatena.ne.jp/ksmemo/20090114/p1
    • HashRefをSVに

• OUTPUTセクションは、コンパイラーに対してどのようにしてC の型をPerlが認識できる値に変換するのかを指示します。

TYPEMAPセクションは、コンパイラーに対して指示されたCの型をPerlの値にマッピングするのに使うべきINPUTセク-ションもしくはOUTPUTセクションにあるコード片を指示します。

メモリー管理

• New〜したものはSafefree()、newSV〜したものはsv_free.
• http://d.hatena.ne.jp/gfx/20090701/1246439598

Debugging

printデバッグ

PerlIO_printf(PerlIO_stderr(), "debugdebug")

xsubppで生成されたcコードを見てみる

メモリーリーク

メモリリークのチェック

http://d.hatena.ne.jp/tokuhirom/20090702/1246523440

prove --exec 'perl -Iblib/lib -Iblib/arch -MTest::Valgrind' t/*.t

レファレンスカウントの確認

Devel::Peekでレファレンスカウント見る

use Devel::Peek "Dump";
print Dump(MyXS::hoge()) . "\n";

gdb

• http://vwv.vox.com/library/post/xs-%E3%82%92-gdb-%E3%81%A7-debug-%E3%81%99%E3%82%8B.html
• http://d.hatena.ne.jp/stanaka/20080630/1214780557

ExtUtils::testlib

Profiling

valgrind

valgrind --tool=callgrind --dump-instr=yes --trace-jump=yes PROG

1. kcachegrind

XSの得意領域

• http://d.hatena.ne.jp/gfx/20081203/1228283549

XS高速化Tips

• http://d.hatena.ne.jp/gfx/20090508/1241756870
• http://d.hatena.ne.jp/tokuhirom/20090415/1239803931

参考になるソースコード

Simple

• Ganglia::Gmetric::XS(Makefile.PL がよいのと、シンプル)
  • http://cpansearch.perl.org/src/HIROSE/Ganglia-Gmetric-XS-1.01/XS.xs

wrap系

• Text::Mecab(typemap をつかった例として)
  • http://cpansearch.perl.org/src/DMAKI/Text-MeCab-0.20007/
  • http://cpansearch.perl.org/src/DMAKI/Text-MeCab-0.20007/typemap
• Data::MessagePack
  • http://cpansearch.perl.org/src/TOKUHIROM/Data-MessagePack-0.08/
• Text::Migemo
  • http://cpansearch.perl.org/src/JIRO/Text-Migemo-0.01/lib/Text/Migemo.xs
  • これはシンプルでわかりやすいかも。

expert

• メタXSを使った例, Module::Install::XSUtil
  • http://cpansearch.perl.org/src/GFUJI/Method-Cumulative-0.03/
• Class::MOP
  • http://cpansearch.perl.org/src/DROLSKY/Class-MOP-0.91/xs/

Reference

http://b.hatena.ne.jp/dann/xs

http://d.hatena.ne.jp/tokuhirom/20081209/1228829454

• Shibuya.pm XS Nite
  • http://www.nicovideo.jp/mylist/7281253
• XS関連記事へのリンク
  • http://wiki.livedoor.jp/kurt0027/d/perlxs%A4%CD%A4%BF
  • http://d.hatena.ne.jp/lieutar/20080624/1214284533

始めの一歩

http://subtech.g.hatena.ne.jp/hirose31/20080512/1210582471

• perlxstut
  • http://www.hio.jp/translation/perldoc/pod/perlxstut.html
  • http://perldoc.jp/docs/perl/5.8.8/perlxstut.pod
• perlxs
  • http://perldoc.jp/docs/perl/5.8.8/perlxs.pod
• perlguts
  • http://fleur.hio.jp/perldoc/mix/perldoc-5.8.0/pod/perlguts.html
  • http://www.kt.rim.or.jp/~kbk/perl5.005/perlguts.html
• perlapi

Perl internal

• http://www.perl.org/tpc/1998/Perl_Language_and_Modules/Perl%20Illustrated/
• http://books.simon-cozens.org/index.php/Perl_5_Internals
• Extracting Facts from Perl Code

モダンPerlのXSの章

XSのテンプレート

• http://blog.clouder.jp/archives/001094.html
• h2xs

Module::Install::XSUtil

• http://d.hatena.ne.jp/gfx/20090727/1248659912

tutorial

• http://zigorou.g.hatena.ne.jp/ZIGOROu/20090727/1248711396
• http://d.hatena.ne.jp/hakobe932/20090101/1230823351
• http://d.hatena.ne.jp/amachang/20081213/1229124960

C++でラップ

• Devel::BindPP
  • http://d.hatena.ne.jp/tokuhirom/20090329/1238319133