C からの Perl 呼び出し規約 The purpose of this document is to show you how to call Perl subroutines directly from C, i.e., how to write callbacks. このドキュメントの目的は、どのようにして Perl のサブルーチンを C から 直接呼び出すか、つまり コールバック の書き方を示すことです。 Apart from discussing the C interface provided by Perl for writing callbacks the document uses a series of examples to show how the interface actually works in practice. In addition some techniques for coding callbacks are covered. コールバックを記述するための Perl から提供される C の インターフェースについての議論とは別に、本ドキュメントでは実践的な インターフェースを例で示します。 それに加え、コールバックをコーディングするための幾つかの テクニックがカバーされます。 Examples where callbacks are necessary include 必要に応じて、例を示すようにしてあります。 An Error Handler (エラーハンドラ) You have created an XSUB interface to an application's C API. あるアプリケーションの C API へのインタフェース XSUB を作成しました。 A fairly common feature in applications is to allow you to define a C function that will be called whenever something nasty occurs. What we would like is to be able to specify a Perl subroutine that will be called instead. アプリケーションでかなり一般的な機能として、なにか面倒が起こったときに 呼ぶことのできる C の関数を定義することができるようにすることが 挙げられます。 やりたいことは、代わりに Perl サブルーチンを呼ぶということです。 An Event Driven Program (イベント駆動プログラム) The classic example of where callbacks are used is when writing an event driven program like for an X windows application. In this case you register functions to be called whenever specific events occur, e.g., a mouse button is pressed, the cursor moves into a window or a menu item is selected. どこでコールバックが使われるかの古典的な例は、 X window アプリケーションのようなイベントドリブンなプログラムに 見られます。 この場合登録内容は、マウスのボタンが押されたりカーソルが ウィンドウやメニューアイテムを選択したといった特定のイベントが 発生したときに呼びだされるように機能します。 Although the techniques described here are applicable when embedding Perl in a C program, this is not the primary goal of this document. There are other details that must be considered and are specific to embedding Perl. For details on embedding Perl in C refer to perlembed. 記述したテクニックは、Perl プログラムを C のプログラムに埋め込むときにも 適用できますが、それはこのドキュメントの本来の目的ではありません。 C に Perl を埋め込むことの詳細は perlembed を参照してください。 Before you launch yourself head first into the rest of this document, it would be a good idea to have read the following two documents - perlxs and perlguts. このドキュメントの先に進む前に、perlxs と perlguts という 二つのドキュメントを読んでおいたほうが良いでしょう。 (CALL_ 関数) Although this stuff is easier to explain using examples, you first need be aware of a few important definitions. これらの性質は例を使って説明するのが簡単であるにも関らず、あなたは まず幾つかの重要な定義を知ることが必要です。 Perl has a number of C functions that allow you to call Perl subroutines. They are Perl には、Perl のサブルーチンを呼ぶことを許している C の関数が たくさんあります。 それを以下に示します。 The key function is call_sv. All the other functions are fairly simple wrappers which make it easier to call Perl subroutines in special cases. At the end of the day they will all call call_sv to invoke the Perl subroutine. 中心となる関数は call_sv です。 他の全ての関数は特別な状況で Perl サブルーチンを呼び出しやすくするための単純なラッパーです。 最終的にはこれらの関数はすべて call_sv を呼び出して Perl サブルーチンを起動します。 All the call_* functions have a flags parameter which is used to pass a bit mask of options to Perl. This bit mask operates identically for each of the functions. The settings available in the bit mask are discussed in FLAG VALUES. 関数 call_* は Perl に対するオプションのビットマスクを 渡すのに使われる flags 引数を取ります。 このビットマスクはそれぞれの関数で全く同じように働きます。 設定可能なビットマスクは FLAG VALUES で述べられています。 Each of the functions will now be discussed in turn. 関数のそれぞれに対する説明を始めましょう。 call_sv call_sv takes two parameters, the first, sv, is an SV*. This allows you to specify the Perl subroutine to be called either as a C string (which has first been converted to an SV) or a reference to a subroutine. The section, Using call_sv, shows how you can make use of call_sv. call_sv は二つのパラメータをとります。 第一引数が SV* である sv です。 これにより、呼び出す Perl サブルーチンを C の文字列(この場合 最初に SV に変換されます)としても、サブルーチンに対する リファレンスとしても指定することができます。 セクション Using call_sv で、 どのように call_sv を使えるかを示します。 call_pv The function, call_pv, is similar to call_sv except it expects its first parameter to be a C char* which identifies the Perl subroutine you want to call, e.g., call_pv("fred", 0). If the subroutine you want to call is in another package, just include the package name in the string, e.g., "pkg::fred". 関数 call_pv は call_sv と似ていますが、 call_pv("fred", 0) のように呼び出したい Perl サブルーチンを 指定する第一引数に C の char * が来ることを期待しているという点が 異なります。 呼び出したいサブルーチンが別のパッケージに置かれている場合、 文字列にパッケージ名を含め "pkg::fred" のようにします。 call_method The function call_method is used to call a method from a Perl class. The parameter methname corresponds to the name of the method to be called. Note that the class that the method belongs to is passed on the Perl stack rather than in the parameter list. This class can be either the name of the class (for a static method) or a reference to an object (for a virtual method). See perlobj for more information on static and virtual methods and Using call_method for an example of using call_method. 関数 call_method は Perl のクラスからメソッドを呼び出すのに使われます。 methname というパラメータは呼び出すメソッドの名前に対応します。 メソッドの所属するクラスは、パラメータリストではなく Perlのスタックで渡されるということに注意してください。 このクラスは、クラスの名前(静的メソッドに対する場合)であっても オブジェクトに対するリファレンスであってもかまいません。 静的メソッドと仮想メソッドに関する詳細は perlobj を、call_method を 使った例は Using call_method を参照してください。 call_argv call_argv calls the Perl subroutine specified by the C string stored in the subname parameter. It also takes the usual flags parameter. The final parameter, argv, consists of a NULL terminated list of C strings to be passed as parameters to the Perl subroutine. See Using call_argv. call_argv はパラメータ subname に格納された C 文字列で 指定された Perl サブルーチンを呼び出します。 これはまた、flags パラメータを取ります。 最後のパラメータ argv は、Perl サブルーチンに渡されるパラメータである C 文字列の、NULL で終端されたリストから構成されます。 Using call_argv を参照してください。 All the functions return an integer. This is a count of the number of items returned by the Perl subroutine. The actual items returned by the subroutine are stored on the Perl stack. 上記の関数はすべて整数値を返します。 これは、Perl サブルーチンが返したアイテムの数です。 サブルーチンから返された実際のアイテムは Perl スタックに 格納されています。 As a general rule you should always check the return value from these functions. Even if you are expecting only a particular number of values to be returned from the Perl subroutine, there is nothing to stop someone from doing something unexpected--don't say you haven't been warned. 一般的な規則として、あなたは いつでも これらの関数の戻り値を チェックすべきです。 あなたが Perl サブルーチンから返される値として、 ある特定の数だけを期待していたとしても、誰かが予期しないなにかを 行うことを止める手だてはないので -- 自分は警告されていない、とは 云わないでください。 (フラグの値) The flags parameter in all the call_* functions is a bit mask which can consist of any combination of the symbols defined below, OR'ed together. すべての call_* 関数のパラメータ flags は、以下に定義する シンボルを“論理和”で組み合わせて用います。 Calls the Perl subroutine in a void context. Perl のサブルーチンを無効コンテキストで呼び出します。 This flag has 2 effects: このフラグには二つの効果があります。 1. It indicates to the subroutine being called that it is executing in a void context (if it executes wantarray the result will be the undefined value). サブルーチンの呼び出しが無効コンテキスト(もし wantarray を実行すると その結果は未定義値となります)において実行されることを示します。 2. It ensures that nothing is actually returned from the subroutine. サブルーチンから実際に返されるものがなにもないことを保証します。 The value returned by the call_* function indicates how many items have been returned by the Perl subroutine - in this case it will be 0. 関数 call_* の戻り値は Perl のサブルーチンがアイテムを幾つ 返したのかを示します。 この例の場合は、0 となります。 Calls the Perl subroutine in a scalar context. This is the default context flag setting for all the call_* functions. Perl のサブルーチンをスカラコンテキストで呼び出します。 これはすべての call_* 関数に対するデフォルトのコンテキストの設定です。 This flag has 2 effects: このフラグは二つの効果があります。 1. It indicates to the subroutine being called that it is executing in a scalar context (if it executes wantarray the result will be false). サブルーチンに対して、スカラコンテキストで実行されるということを 示します(wantarray を実行した場合、結果は偽となります)。 2. It ensures that only a scalar is actually returned from the subroutine. The subroutine can, of course, ignore the wantarray and return a list anyway. If so, then only the last element of the list will be returned. サブルーチンから実際に返されるものはスカラだけであるということを 保証します。 もちろん、サブルーチンは wantarray を無視し、リストを 返すこともできます。 そうした場合、そうしたリストの最後の要素だけが返されることになります。 The value returned by the call_* function indicates how many items have been returned by the Perl subroutine - in this case it will be either 0 or 1. 関数 call_* により返された値は、Perl サブルーチンが幾つの アイテムを返したかということを示します。 この場合、0 か 1 かのいずれかになります。 If 0, then you have specified the G_DISCARD flag. 0 であれば、G_DISCARD フラグを指定したということです。 If 1, then the item actually returned by the Perl subroutine will be stored on the Perl stack - the section Returning a Scalar shows how to access this value on the stack. Remember that regardless of how many items the Perl subroutine returns, only the last one will be accessible from the stack - think of the case where only one value is returned as being a list with only one element. Any other items that were returned will not exist by the time control returns from the call_* function. The section Returning a list in a scalar context shows an example of this behavior. 1 の場合、Perl サブルーチンが実際に返したアイテムは Perl スタックに 積まれます。 スタックにあるこの値にどのようにアクセスするかはセクション Returning a Scalar にあります。 Perlサブルーチンが幾つのアイテムを返したかに関係なく、最後の一つだけが スタック上でアクセス可能であるということを忘れないでください。 つまり、ただ一つの要素からなるリストのように、値が一つだけ 置かれるのです。 他のすべてのアイテムは、call_* 関数から制御が戻ったときには 存在しません。 この振る舞いについての例はセクション Returning a list in a scalar context にあります。 Calls the Perl subroutine in a list context. Perl サブルーチンをリストコンテキストで呼び出します。 As with G_SCALAR, this flag has 2 effects: G_SCALAR を指定したときと同様、このフラグも二つの効果を持ちます。 1. It indicates to the subroutine being called that it is executing in a list context (if it executes wantarray the result will be true). サブルーチンが、リストコンテキストで実行されることを示します (wantarray を実行すると、その結果は真となります)。 2. It ensures that all items returned from the subroutine will be accessible when control returns from the call_* function. 関数 call_* から制御が戻ったときに、サブルーチンから返された すべてのアイテムがアクセス可能であることを保証します。 The value returned by the call_* function indicates how many items have been returned by the Perl subroutine. 関数 call_* から返される値は、Perl サブルーチンがアイテムを 幾つ返したかを示すものです。 If 0, then you have specified the G_DISCARD flag. 0 の場合、G_DISCARD フラグが指定されたということです。 If not 0, then it will be a count of the number of items returned by the subroutine. These items will be stored on the Perl stack. The section Returning a list of values gives an example of using the G_ARRAY flag and the mechanics of accessing the returned items from the Perl stack. 0 以外の場合、サブルーチンが返したアイテムの個数となります。 これらのアイテムは Perl スタックに置かれます。 セクション Returning a list of values には G_ARRAY フラグを使った例と、 Perl スタックに置かれたアイテムをアクセスする仕組みの例があります。 By default, the call_* functions place the items returned from by the Perl subroutine on the stack. If you are not interested in these items, then setting this flag will make Perl get rid of them automatically for you. Note that it is still possible to indicate a context to the Perl subroutine by using either G_SCALAR or G_ARRAY. デフォルトでは、関数 call_* は Perl サブルーチンの返したアイテムを スタックに置きます。 こういったアイテムに用がない場合、このフラグを設定することによって Perl が自動的にこれらのアイテムを取り除くようにすることを指定できます。 このフラグを使った場合でも、 Perl サブルーチンに対して G_SCALAR か G_ARRAY のいずれかをさらに 指定することで、(Perl サブルーチンが実行される)コンテキストを 指示できるということに注意してください。 If you do not set this flag then it is very important that you make sure that any temporaries (i.e., parameters passed to the Perl subroutine and values returned from the subroutine) are disposed of yourself. The section Returning a Scalar gives details of how to dispose of these temporaries explicitly and the section Using Perl to dispose of temporaries discusses the specific circumstances where you can ignore the problem and let Perl deal with it for you. このフラグを設定しなかった場合、なんらかの一時変数(たとえば、Perl サブルーチンに渡されたパラメータであるとかサブルーチンからの戻り値)を 自分自身で破棄することを確実に行うことが非常に重要です。 Returning a Scalar というセクションでは、これら一時変数をどのようにして 陽に破棄するかを説明しており、 Using Perl to dispose of temporaries というセクションではこの 問題を無視できる特定の場所や、Perlに後始末をさせることについて 述べています。 Whenever a Perl subroutine is called using one of the call_* functions, it is assumed by default that parameters are to be passed to the subroutine. If you are not passing any parameters to the Perl subroutine, you can save a bit of time by setting this flag. It has the effect of not creating the @_ array for the Perl subroutine. call_* の一つを使って Perl サブルーチンを呼び出したときはいつでも、 サブルーチンに対してパラメータが渡されたということが デフォルトで仮定されます。 Perl サブルーチンに対してなんのパラメータも渡さないという場合、この フラグをセットすることで時間を少々節約することができます。 これは Perl サブルーチンに対して、@_ を生成しないという 効果を持っています。 Although the functionality provided by this flag may seem straightforward, it should be used only if there is a good reason to do so. The reason for being cautious is that even if you have specified the G_NOARGS flag, it is still possible for the Perl subroutine that has been called to think that you have passed it parameters. このフラグにより提供される機能が直接的なもののように見えるにも関らず、 これを使うのはそうすべき適当な理由があるときのみにすべきでしょう。 このように用心する理由は、G_NOARGS フラグを指定した場合であっても、 呼び出された Perl サブルーチンがパラメータを渡されたと 思い込んでいる可能性があるからです。 In fact, what can happen is that the Perl subroutine you have called can access the @_ array from a previous Perl subroutine. This will occur when the code that is executing the call_* function has itself been called from another Perl subroutine. The code below illustrates this 事実、起こりうる可能性として、呼び出した Perl サブルーチンが以前の Perl サブルーチンの配列 @_ にアクセスできてしまうというものがあります。 これは、call_* 関数を実行するコード自身が、他の Perl サブルーチンから 呼ばれたときに起こり得ます。 以下のコードはこれを説明するものです。 This will print この結果は次のようになります。 What has happened is that fred accesses the @_ array which belongs to joe. ここで起こったことは、fred が joe に属する配列 @_ に アクセスしているということです。 It is possible for the Perl subroutine you are calling to terminate abnormally, e.g., by calling die explicitly or by not actually existing. By default, when either of these events occurs, the process will terminate immediately. If you want to trap this type of event, specify the G_EVAL flag. It will put an eval { } around the subroutine call. 呼び出す Perl サブルーチンを、die を陽に呼び出したり、何かが 存在しなかったことにより即座に終了させることを可能にします。 デフォルトでは、そういったイベントが起こった場合にはプロセスは即座に 終了します。 しかしこの種のイベントをトラップしたいのなら、G_EVAL フラグを指定します。 それによって、サブルーチンの呼び出しを eval { } で囲むようになります。 Whenever control returns from the call_* function you need to check the $@ variable as you would in a normal Perl script. call_* 関数から戻ってきたときは、いつでも通常の Perl スクリプトで そうするように変数 $@ をチェックする必要があります。 The value returned from the call_* function is dependent on what other flags have been specified and whether an error has occurred. Here are all the different cases that can occur: call_* から返された値は、他に指定したフラグとエラーが 起きたかどうかに依存します。 以下に起こりうるすべてのケースを挙げます。 If the call_* function returns normally, then the value returned is as specified in the previous sections. 関数 call_* から正常に戻ってきた場合、戻り値は前のセクションで 説明したようなものです。 If G_DISCARD is specified, the return value will always be 0. G_DISCARD が指定されていた場合、戻り値は常に 0 になります。 If G_ARRAY is specified and an error has occurred, the return value will always be 0. G_ARRAY が指定されていて、かつ、エラーが発生した場合には戻り値は 常に 0 となります。 If G_SCALAR is specified and an error has occurred, the return value will be 1 and the value on the top of the stack will be undef. This means that if you have already detected the error by checking $@ and you want the program to continue, you must remember to pop the undef from the stack. G_SCALAR が指定されていて、かつ、エラーが発生した場合には戻り値は 1となり、そしてスタックトップにある値は undef となります。 これは $@ を検査することで既にエラーを検出していていてプログラムの 継続を望んでいる場合には、スタックから undef を忘れずに ポップしなければならないということです。 See Using G_EVAL for details on using G_EVAL. G_EVAL の使用についての詳細は Using G_EVAL を参照してください。 You may have noticed that using the G_EVAL flag described above will always clear the $@ variable and set it to a string describing the error iff there was an error in the called code. This unqualified resetting of $@ can be problematic in the reliable identification of errors using the eval {} mechanism, because the possibility exists that perl will call other code (end of block processing code, for example) between the time the error causes $@ to be set within eval {}, and the subsequent statement which checks for the value of $@ gets executed in the user's script. 先に述べた G_EVAL フラグの使用が 常に 変数 $@ をクリアして、 呼び出したコードにエラーがなかったときにエラーを表現する文字列を セットするということに気付いたかもしれません。 この適切でない $@ のリセットは、eval {} 機構を使ったエラーの 確認において問題となりうるものです。 なぜなら、eval {} の中で $@ に設定されたエラーが発生した時点と $@ の値をチェックする(後続の)ステートメントが 実行される間に、他のコード(たとえば、ブロック終端の処理コード)を perl が呼び出す可能性があるからです。 This scenario will mostly be applicable to code that is meant to be called from within destructors, asynchronous callbacks, signal handlers, __DIE__ or __WARN__ hooks, and tie functions. In such situations, you will not want to clear $@ at all, but simply to append any new errors to any existing value of $@. このシナリオは、デストラクターの中から呼ばれるようなコード、非同期な コールバック、シグナルハンドラー、__DIE__ や __WARN__ のフック、 tie 関数といったもので最も有用です。 このような状況において、$@ をクリアすることを 望まないこともあるでしょうが、 すでにある $@ の内容に新たなエラーを単に追加するだけです。 The G_KEEPERR flag is meant to be used in conjunction with G_EVAL in call_* functions that are used to implement such code. This flag has no effect when G_EVAL is not used. G_KEEPERR フラグは、実装したコードを使用する call_* において G_EVAL と組み合わせて使われます。 このフラグは G_EVAL が使われていないときにはなんの効果も持ちません。 When G_KEEPERR is used, any errors in the called code will be prefixed with the string "\t(in cleanup)", and appended to the current value of $@. an error will not be appended if that same error string is already at the end of $@. G_KEEPERR が使われたとき、コードの呼び出しで発生したすべてのエラーは "\t(in cleanup)" という文字列が前置され、さらに $@ の現在の値が 追加されます。 $@ の最後に既に同じエラーメッセージがある場合、エラーは追加されません。 In addition, a warning is generated using the appended string. This can be disabled using no warnings 'misc'. 更に、追加した文字列を使って警告が生成されます。 これは no warnings 'misc' を使って無効化できます。 The G_KEEPERR flag was introduced in Perl version 5.002. G_KEEPERR フラグは Perl のバージョン 5.002 で導入されました。 See Using G_KEEPERR for an example of a situation that warrants the use of this flag. このフラグを使うことが正当である状況の例が Using G_KEEPERR にあります。 (コンテキストを決定する) As mentioned above, you can determine the context of the currently executing subroutine in Perl with wantarray. The equivalent test can be made in C by using the GIMME_V macro, which returns G_ARRAY if you have been called in a list context, G_SCALAR if in a scalar context, or G_VOID if in a void context (i.e. the return value will not be used). An older version of this macro is called GIMME; in a void context it returns G_SCALAR instead of G_VOID. An example of using the GIMME_V macro is shown in section Using GIMME_V. 先に説明したように、wantarray を使ってサブルーチンが実行されている コンテキストを判定することができます。 これと同じことが、GIMME_V マクロを使うことでも可能です。 このマクロはリストコンテキストで 呼ばれた場合には G_ARRAY を、スカラコンテキストで呼ばれた場合には G_SCALAR を、無効コンテキストの場合(たとえば戻り値が 使われないとき)には G_VOID を返します。 このマクロの古いバージョンは GIMME という名前で、 無効コンテキストのときに G_VOID の代わりに G_SCALAR を返していました。 GIMME_V マクロの使用例は セクション Using GIIME_V にあります。 (例) Enough of the definition talk, let's have a few examples. 定義の話は十分でしょうから、いくつか例を示します。 Perl provides many macros to assist in accessing the Perl stack. Wherever possible, these macros should always be used when interfacing to Perl internals. We hope this should make the code less vulnerable to any changes made to Perl in the future. Perl では、Perl スタックをアクセスする手助けのためのマクロをたくさん 用意しています。 Perl の内部ルーチンとのインターフェースには、 常にこれらのマクロを使うようにすべきでしょう。 将来 Perl に施される変更に対しても、これを使うことで、コードの方への 影響が少なくなるはずです。 Another point worth noting is that in the first series of examples I have made use of only the call_pv function. This has been done to keep the code simpler and ease you into the topic. Wherever possible, if the choice is between using call_pv and call_sv, you should always try to use call_sv. See Using call_sv for details. もう一つ余計なことを言っておくと、最初のいくつかの例では、 call_pv 関数だけを使っています。 これは、単にみなさんがこの話題に入り込みやすいようにと 考えただけのことです。 call_pv と call_sv のどちらも使える場合、常に call_sv を 使うことを試してください。 詳しくは Using call_sv を参照してください。 (引数なし、戻り値なしの場合) This first trivial example will call a Perl subroutine, PrintUID, to print out the UID of the process. 最初の明快な例は、プロセスの UID を出力するために Perl サブルーチン PrintUID を呼びだします。 and here is a C function to call it と、これを呼ぶ C 側です Simple, eh. ね、単純でしょう。 A few points to note about this example. この例についていくつか注意点をあげておきましょう。 1. Ignore dSP and PUSHMARK(SP) for now. They will be discussed in the next example. 今のところ、dSP と PUSHMARK(SP) は無視してください。 これについては、次の例でお話します。 2. We aren't passing any parameters to PrintUID so G_NOARGS can be specified. PrintUID に引数を渡しませんので、G_NOARGS を指定できます。 3. We aren't interested in anything returned from PrintUID, so G_DISCARD is specified. Even if PrintUID was changed to return some value(s), having specified G_DISCARD will mean that they will be wiped by the time control returns from call_pv. PrintUID から返されるものは、特に必要ありませんので G_DISCARD を 指定しています。 PrintUID が何か値を返すように変更されても、 G_DISCARD を指定しておくと call_pv から制御が戻るときにその値が 捨てられることになります。 4. As call_pv is being used, the Perl subroutine is specified as a C string. In this case the subroutine name has been 'hard-wired' into the code. call_pv が使われていますから、Perl サブルーチンは C の文字列として 表現されています。 5. Because we specified G_DISCARD, it is not necessary to check the value returned from call_pv. It will always be 0. G_DISCARD を指定しましたので、call_sv からの戻り値をチェックする 必要はありません。 常に 0 となります。 (引数を渡す) Now let's make a slightly more complex example. This time we want to call a Perl subroutine, LeftString, which will take 2 parameters--a string ($s) and an integer ($n). The subroutine will simply print the first $n characters of the string. さて、今度はもう少し込み入った例です。 今回は、二つの引数として、 文字列 ($s) と整数 ($n) をとる Perl サブルーチン LeftString を 呼び出してみましょう -- このサブルーチンでは、単純に文字列の最初の $n 文字を出力します。 So the Perl subroutine would look like this Perl サブルーチンは以下のようなものです: The C function required to call LeftString would look like this. LeftString を呼ぶための C の関数は、以下のようになります: Here are a few notes on the C function call_LeftString. C の関数 call_LeftString の注意点を示します。 1. Parameters are passed to the Perl subroutine using the Perl stack. This is the purpose of the code beginning with the line dSP and ending with the line PUTBACK. The dSP declares a local copy of the stack pointer. This local copy should always be accessed as SP. パラメータは、Perl スタックを使って Perl サブルーチンに渡されます。 これが、dSP で始まり PUTBACK 行で終わるコードの目的です。 dSP はスタックポインタのローカルなコピーを宣言します。 このローカルなコピーは 常に SP として アクセスするようにすべきです。 2. If you are going to put something onto the Perl stack, you need to know where to put it. This is the purpose of the macro dSP--it declares and initializes a local copy of the Perl stack pointer. Perl スタックに何かを置こうとする場合には、どこにおけばよいかを 知る必要があります。 これが、マクロ dSP の目的です -- Perl スタックポインタの ローカルな コピーを宣言し、初期化します。 All the other macros which will be used in this example require you to have used this macro. この例で使う他のすべてのマクロは、このマクロの使用を前提にしています。 The exception to this rule is if you are calling a Perl subroutine directly from an XSUB function. In this case it is not necessary to use the dSP macro explicitly--it will be declared for you automatically. Perl サブルーチンを直接 XSUB 関数から呼ぶ場合はこの規則の例外で、 dSP マクロを陽に使う必要はありません -- 自動的に宣言されます。 3. Any parameters to be pushed onto the stack should be bracketed by the PUSHMARK and PUTBACK macros. The purpose of these two macros, in this context, is to count the number of parameters you are pushing automatically. Then whenever Perl is creating the @_ array for the subroutine, it knows how big to make it. スタック上に積まれるパラメータはすべて、PUSHMARK マクロと PUTBACK マクロで囲まなければなりません。 この 二つのマクロは、 この文脈では、自動的にプッシュした引数の数を数えるために使われます。 これによりPerl がサブルーチンに対して @_ 配列を作るときに、 その大きさがわかるという仕組みになっているのです。 The PUSHMARK macro tells Perl to make a mental note of the current stack pointer. Even if you aren't passing any parameters (like the example shown in the section No Parameters, Nothing returned) you must still call the PUSHMARK macro before you can call any of the call_* functions--Perl still needs to know that there are no parameters. PUSHMARKマクロは、Perl に対して、内的にその時点のスタックポインタに 注目するように伝えます。 (例 1 の場合のように) 引数を渡さない場合であっても、call_* 関数を 呼ぶ場合には、その前に PUSHMARK マクロを呼ばなくてはなりません -- Perl からすると、引数が ないことを知る必要があるのです。 The PUTBACK macro sets the global copy of the stack pointer to be the same as our local copy. If we didn't do this call_pv wouldn't know where the two parameters we pushed were--remember that up to now all the stack pointer manipulation we have done is with our local copy, not the global copy. 少し先へ飛んで、PUTBACK マクロは、グローバルなスタックポインタを、 先に作ったローカルなものに合わせます。 これを行わないと、どこに引数を置いたかを call_pv が 判断することができません -- ここまで、すべてのスタックポインタの 操作は、ローカルなものに対して行なってきたのであって、 グローバルなものは触っていなかったのです。 4. Next, we come to XPUSHs. This is where the parameters actually get pushed onto the stack. In this case we are pushing a string and an integer. 元に戻って、次に XPUSH を引数分呼んでいます。 ここで、実際に引数がスタックに積まれます。 今回の場合、文字列と整数を積んでいます。 See perlguts/"XSUBs and the Argument Stack" for details on how the XPUSH macros work. XPUSH マクロがどのように動作するのかについて詳しくは、 perlguts/"XSUBs and the Argument Stack" を参照してください。 5. Because we created temporary values (by means of sv_2mortal() calls) we will have to tidy up the Perl stack and dispose of mortal SVs. 私たちはここで一時的な値を(sv_2motral() の呼び出しによって)作り出したので、 Perl のスタックを調整することと mortal な SV を消去する必要が生じます。 This is the purpose of これが関数の先頭に at the start of the function, and を置き、 at the end. The ENTER/SAVETMPS pair creates a boundary for any temporaries we create. This means that the temporaries we get rid of will be limited to those which were created after these calls. を関数の末尾に置く理由です。 ENTER/SAVETMPS のペアは作成した一時変数に対する境界を 生成します。 つまり、私たちが取り扱う一時変数がこれらの呼び出しの後で 生成されたものに限定されるだろうということです。 The FREETMPS/LEAVE pair will get rid of any values returned by the Perl subroutine (see next example), plus it will also dump the mortal SVs we have created. Having ENTER/SAVETMPS at the beginning of the code makes sure that no other mortals are destroyed. FREETMPS/LEAVE のペアは Perl のサブルーチンが返す任意の値を扱い (次の例を参照してください)、それに加えて私たちが作成した mortal な SV を ダンプします。 コードの先頭で ENTER/SAVETMPS を使うことによって、mortals 以外の ものが削除されないようにします。 Think of these macros as working a bit like using { and } in Perl to limit the scope of local variables. これらのマクロは、Perl を使っているときに { と } を使った ローカル変数のスコープの制限に似たような働きをすると考えてください。 See the section Using Perl to dispose of temporaries for details of an alternative to using these macros. これらのマクロを使った別の例については セクション Using Perl to dispose of temporaries を 参照してください。 6. Finally, LeftString can now be called via the call_pv function. The only flag specified this time is G_DISCARD. Because we are passing 2 parameters to the Perl subroutine this time, we have not specified G_NOARGS. ここまでで、LeftString を call_pv 関数を介して呼ぶことが できます。 今回指定しているフラグは G_DISCARD のみです。 今回 Perl サブルーチン に 二つのパラメータを渡しますので、G_NOARGS は 指定していません。 (スカラを返す) Now for an example of dealing with the items returned from a Perl subroutine. さて、Perl サブルーチンからの戻り値を扱う例を見てみましょう。 Here is a Perl subroutine, Adder, that takes 2 integer parameters and simply returns their sum. ここに挙げる Perl サブルーチンは、二つの整数引数をとって単にその和を 返す Adder というものです。 Because we are now concerned with the return value from Adder, the C function required to call it is now a bit more complex. Adder からの戻り値を扱う必要がありますので、C 関数側は今回、 多少複雑になります。 Points to note this time are ここでの注意点は、 1. The only flag specified this time was G_SCALAR. That means the @_ array will be created and that the value returned by Adder will still exist after the call to call_pv. 今回は、フラグとして G_SCALAR だけを使用しています。 これは、@_ 配列が作られ、Adder から返された値は、call_pv の 呼び出し後も存在することを表わします。 2. The purpose of the macro SPAGAIN is to refresh the local copy of the stack pointer. This is necessary because it is possible that the memory allocated to the Perl stack has been reallocated whilst in the call_pv call. SPAGAIN マクロの目的は、ローカルなスタックポインタを リフレッシュすることです。 call_pv の呼び出しの間に再配置された Perl スタックへメモリ配置を 行なうことができますから、これが必要になります。 If you are making use of the Perl stack pointer in your code you must always refresh the local copy using SPAGAIN whenever you make use of the call_* functions or any other Perl internal function. コードの中で Perl スタックポインタを利用する場合には、call_* 関数や 他の Perl の内部関数を利用するときには必ず、SPAGAIN を使って ローカルなポインタをリフレッシュしなくてはなりません。 3. Although only a single value was expected to be returned from Adder, it is still good practice to check the return code from call_pv anyway. Adder から返されるのは、単一の値のみのはずですが、いずれにしても call_pv からの返却値をチェックするのが良いでしょう。 Expecting a single value is not quite the same as knowing that there will be one. If someone modified Adder to return a list and we didn't check for that possibility and take appropriate action the Perl stack would end up in an inconsistent state. That is something you really don't want to happen ever. 単一の値を期待するのは、一つであることを知っていることとは違います。 誰かが Adder を改造してリストを返すようにし、その可能性を チェックしていなかったときにこの操作を行なってしまうと、Perl スタックの 状態は矛盾したものになってしまいます。 こんなことは誰も望みはしないでしょう。 4. The POPi macro is used here to pop the return value from the stack. In this case we wanted an integer, so POPi was used. スタックから、返却値をポップするのに、ここでは POPi マクロを 使用しています。 ここでは整数が必要であったため、POPi を使用したのです。 Here is the complete list of POP macros available, along with the types they return. 返された値の型に応じて、以下の POP マクロを使用することができます。 5. The final PUTBACK is used to leave the Perl stack in a consistent state before exiting the function. This is necessary because when we popped the return value from the stack with POPi it updated only our local copy of the stack pointer. Remember, PUTBACK sets the global stack pointer to be the same as our local copy. 最後の PUTBACK は、関数を抜ける前に、Perl スタックを矛盾の無い 状態にしておくために使用しています。 これは、POPi でスタックから返却値を取り出したときに、ローカルな スタックポインタのみを更新するため、必要となります。 先の例で説明したように PUTBACK は、グローバルなスタックポインタを ローカルなスタックポインタの値にあわせるように設定します。 (値のリストを返す) Now, let's extend the previous example to return both the sum of the parameters and the difference. さて、今度は、先の例を改造して、二つの引数の和と差の両方を返すように してみましょう。 Here is the Perl subroutine Perl サブルーチンは and this is the C function のようになり、C 関数は If call_AddSubtract is called like this call_AddSubtract が以下のように呼ばれた場合、 then here is the output 出力はこうなります。 Notes 注意事項 1. We wanted list context, so G_ARRAY was used. リストコンテキストが必要なので、G_ARRAY を使用します。 2. Not surprisingly POPi is used twice this time because we were retrieving 2 values from the stack. The important thing to note is that when using the POP* macros they come off the stack in reverse order. スタックから 二つの値を取り出すために今回 二つの POPi を 使っていることは驚くに値しないでしょう。 それよりも注目すべきは、POP* マクロを使ってスタックから 取り出したときに 逆順 となることです。 (スカラコンテキストでリストを返す) Say the Perl subroutine in the previous section was called in a scalar context, like this 前のセクションにあった Perl サブルーチンは、この例のように スカラコンテキストで呼ばれていました。 The other modification made is that call_AddSubScalar will print the number of items returned from the Perl subroutine and their value (for simplicity it assumes that they are integer). So if call_AddSubScalar is called 別の変更点は、call_AddSubScalar が Perl サブルーチンから返された アイテムの数を出力するようになり、サブルーチンの戻り値 (単純化のために、ここではこれは整数と仮定します)を 出力するようになったと言うことです。 ですから、call_AddSubScalar は then the output will be のように呼び出され、以下のような出力を行います。 In this case the main point to note is that only the last item in the list is returned from the subroutine, AddSubtract actually made it back to call_AddSubScalar. この場合に注意すべき点は、サブルーチンからは(AddSubtract が実際に call_AddSubScalar に返しているのと同じ)リストの最後にある アイテムだけが返されるということです。 (引数リストを使って Perl からデータを返す) It is also possible to return values directly via the parameter list - whether it is actually desirable to do it is another matter entirely. 引数リストを使って直接値を返すことも可能です。 ただし、これが実際に望ましい方法であるか否かについては、まったく別の 問題です。 The Perl subroutine, Inc, below takes 2 parameters and increments each directly. 以下の Perl サブルーチン Inc は二つの引数をとり、それぞれを インクリメントします。 and here is a C function to call it. そして、これを呼び出す C 関数です。 To be able to access the two parameters that were pushed onto the stack after they return from call_pv it is necessary to make a note of their addresses--thus the two variables sva and svb. call_pv からリターンした後で、スタック上にプッシュされた 二つのパラメータにアクセスするために、これらのアドレスを記録しておく 必要があります -- このため 二つの変数 sva と svb を使っています。 The reason this is necessary is that the area of the Perl stack which held them will very likely have been overwritten by something else by the time control returns from call_pv. これらの値を保持する Perl スタックのエリアは、call_pv から 制御が戻るときまでに何ものかによって破壊されていることが十分に 有り得るので、こういった操作が必要になるのです。 (G_EVAL を使う) Now an example using G_EVAL. Below is a Perl subroutine which computes the difference of its 2 parameters. If this would result in a negative result, the subroutine calls die. 今度は G_EVAL を使う例です。 以下は、二つの引数の差を計算する Perl サブルーチンです。 結果が負になった場合、このサブルーチンは die を呼びます。 and some C to call it これを呼ぶ C の方は、 If call_Subtract is called thus となります。 call_Subtract が the following will be printed のように呼ばれると、以下のように表示されます。 Notes 注意点 1. We want to be able to catch the die so we have used the G_EVAL flag. Not specifying this flag would mean that the program would terminate immediately at the die statement in the subroutine Subtract. die を捕捉するために、G_EVAL フラグを使用しました。 このフラグを使用しないと、サブルーチン Sbutract 中にある die 文の場所でプログラムは途中終了してしまいます。 2. The code C 関数の中の is the direct equivalent of this bit of Perl という部分は、Perl の書くところの以下と同じです PL_errgv is a perl global of type GV * that points to the symbol table entry containing the error. ERRSV therefore refers to the C equivalent of $@. PL_errgv は、エラーを保持するシンボルテーブルのエントリーを指し示す、 型 GV * の perl のグローバル変数です。 ですから ERRGV は、Cプログラムににおいて $@ と等価なものを 参照します。 3. Note that the stack is popped using POPs in the block where SvTRUE(ERRSV) is true. This is necessary because whenever a call_* function invoked with G_EVAL|G_SCALAR returns an error, the top of the stack holds the value undef. Because we want the program to continue after detecting this error, it is essential that the stack is tidied up by removing the undef. スタックは SvTRUE(ERRGV) が真であるブロックの中で POPs を 使ってポップされていることに注意してください。 これは、関数 call_* が G_EVAL|G_SCALAR をつけて起動された場合に エラーを返していて、スタックトップに undef 値があるときには常に 必要となります。 エラーを検出した後でプログラムを継続させたいので、undef を 取り除いてスタックを片付けることが重要なのです。 (G_KEEPERR を使う) Consider this rather facetious example, where we have used an XS version of the call_Subtract example above inside a destructor: 以下の滑稽な例について考えてみましょう。 ここでは、先の例での XS バージョンの call_Subtract を デストラクターの中で使っています。 new->foo }; print "Saw: $@" if $@; # should be, but isn't ]]> This example will fail to recognize that an error occurred inside the eval {}. Here's why: the call_Subtract code got executed while perl was cleaning up temporaries when exiting the eval block, and because call_Subtract is implemented with call_pv using the G_EVAL flag, it promptly reset $@. This results in the failure of the outermost test for $@, and thereby the failure of the error trap. この例では、eval {} の内側で起きたエラーを認識するのに失敗します。 その理由はこうです: call_Subtract のコードは eval ブロックを抜ける 際にPerlが一時変数を片付ける最中に実行されます。 そして call_Subtract が G_EVAL フラグを使った call_pv を 使って実装されているので $@ をリセットするからなのです。 この結果は $@ を最も外側の検査での失敗で、エラートラップに 失敗するということです。 Appending the G_KEEPERR flag, so that the call_pv call in call_Subtract reads: G_KEEPERR フラグを追加して call_Subtract の中にある call_pv 呼び出しを will preserve the error and restore reliable error handling. のようにすると、エラーを保存し、信頼性のあるエラーハンドリングを 取り戻します (call_sv を使う) In all the previous examples I have 'hard-wired' the name of the Perl subroutine to be called from C. Most of the time though, it is more convenient to be able to specify the name of the Perl subroutine from within the Perl script. これまでの例では、Perl サブルーチンの名前を C から呼ばれるように 扱ってきました。 ですが、ときには Perl スクリプトの中から Perl サブルーチンの名前を 指定することができないと困ることがあります。 Consider the Perl code below のような Perl コードを考えてみましょう。 Here is a snippet of XSUB which defines CallSubPV. これは CallSubPV を定義する XSUB の一部です。 That is fine as far as it goes. The thing is, the Perl subroutine can be specified as only a string. For Perl 4 this was adequate, but Perl 5 allows references to subroutines and anonymous subroutines. This is where call_sv is useful. 今のところは、これで良いのかもしれません。 問題は、Perl サブルーチンが文字列でしか表現できないということです。 Perl 4 ではこれで十分なのですが、Perl 5 ではサブルーチンへの リファレンスや名前を持たないサブルーチンが許されています。 そういった場合に、call_sv が役に立つのです。 The code below for CallSubSV is identical to CallSubPV except that the name parameter is now defined as an SV* and we use call_sv instead of call_pv. 次の CallSubSv のコードは、CallSubPV と同一ですが、引数 name を SV* で定義し、call_pv の代わりに call_sv を使っています。 Because we are using an SV to call fred the following can all be used fred を呼ぶのに SV を使っていますから、Perl 側では As you can see, call_sv gives you much greater flexibility in how you can specify the Perl subroutine. といった記法がすべて可能になります。 ご覧のように call_sv を使えば、Perl サブルーチンをかなり柔軟に 指定することができるようになります。 You should note that if it is necessary to store the SV (name in the example above) which corresponds to the Perl subroutine so that it can be used later in the program, it not enough just to store a copy of the pointer to the SV. Say the code above had been like this プログラムの後の部分で使えるように Perl サブルーチンに対応する SV (先の例では name)に格納する必要があるのなら、SV へのポインタの コピーを格納するだけでは十分ではないということに注意すべきです。 先のプログラムが以下のようなものだったとしましょう。 The reason this is wrong is that by the time you come to use the pointer rememberSub in CallSavedSub1, it may or may not still refer to the Perl subroutine that was recorded in SaveSub1. This is particularly true for these cases これがまずいという理由は、CallSavedSub1 の中で rememberSub を 使ったときに、SaveSub1 に保持されているPerlサブルーチンをまだ 参照するかもしれない(し、しないかもしれない)ということです。 これは、特に以下のような場合に真となります。 By the time each of the SaveSub1 statements above have been executed, the SV*s which corresponded to the parameters will no longer exist. Expect an error message from Perl of the form 上記の SaveSub1 が実行される度に、そのパラメータに対応する SV* は存在しなくなります。 このため、 for each of the CallSavedSub1 lines. Perl が上記のエラーメッセージを出すことが予想されます。 Similarly, with this code 同様に、 you can expect one of these messages (which you actually get is dependent on the version of Perl you are using) 上記のコードを使った場合、これらのメッセージのいずれかが 出力されるでしょう(これは使っているPerlのバージョンによります)。 The variable $ref may have referred to the subroutine fred whenever the call to SaveSub1 was made but by the time CallSavedSub1 gets called it now holds the number 47. Because we saved only a pointer to the original SV in SaveSub1, any changes to $ref will be tracked by the pointer rememberSub. This means that whenever CallSavedSub1 gets called, it will attempt to execute the code which is referenced by the SV* rememberSub. In this case though, it now refers to the integer 47, so expect Perl to complain loudly. 変数 $ref は SaveSub1 を呼び出したときにはサブルーチン fred を 参照するように生成されるかもしれませんが、CallSavedSub1 が 呼び出されている時点では、今や数値 47 を保持しているのです。 SaveSub1 にある元々の SV へのポインタしか保存しないので、 $ref に対するなんらかの変更はポインタ rememberSub によって 反映され、SV* rememberSub によって参照されるコードが実行されることが 試みられるでしょう。 しかし上記の例では、rememberSub は整数値 47 を参照していますので、 Perl は不満を漏らすというわけです。 A similar but more subtle problem is illustrated with this code 同様の、しかし微妙な問題を以下のプログラム片で説明します。 This time whenever CallSavedSub1 get called it will execute the Perl subroutine joe (assuming it exists) rather than fred as was originally requested in the call to SaveSub1. CallSavedSub1 が呼び出されたときに実行する Perl サブルーチンは SaveSub1 を呼び出したときに要求した fred ではなく、 (それがあるとして)joe なのです。 To get around these problems it is necessary to take a full copy of the SV. The code below shows SaveSub2 modified to do that これらの問題に対処するためには、SV の完全なコピーをとる必要があります。 以下のコードはそれを行った SaveSub2 です。 To avoid creating a new SV every time SaveSub2 is called, the function first checks to see if it has been called before. If not, then space for a new SV is allocated and the reference to the Perl subroutine, name is copied to the variable keepSub in one operation using newSVsv. Thereafter, whenever SaveSub2 is called the existing SV, keepSub, is overwritten with the new value using SvSetSV. SaveSub2 が呼び出される度に新たなSVを生成してしまうのを防ぐために、 関数はまず最初に自分が以前に呼び出されたことがあるかどうかを 確認します。 もしそれまでに呼び出されたことがなければ、新しい SV のための領域が 割り当てられ、そして Perl サブルーチンへの参照 name が、 newSVsv を使った操作によって変数 keepSub へコピーされます。 その後で SaveSub2 が呼び出されたときは常に、存在するSV keepSub が SVSetSV を使って新しい値で上書きされます。 (call_argv を使う) Here is a Perl subroutine which prints whatever parameters are passed to it. 次に挙げるのは渡された引数を表示する Perl サブルーチンです。 and here is an example of call_argv which will call PrintList. そして、PrintList を呼ぶ call_argv の例です。 Note that it is not necessary to call PUSHMARK in this instance. This is because call_argv will do it for you. 注目したいのは、この場合には、PUSHMARK を呼ぶ必要がないということです。 call_argv 側で自動的に行なうからです。 (call_method を使う) Consider the following Perl code 以下のような Perl コードを考えてみましょう。 It implements just a very simple class to manage an array. Apart from the constructor, new, it declares methods, one static and one virtual. The static method, PrintID, prints out simply the class name and a version number. The virtual method, Display, prints out a single element of the array. Here is an all Perl example of using it. これは配列を管理するための非常に単純なクラスを実装しています。 コンストラクター new を除けば、一つのスタティックメソッドと一つの 仮想メソッドを宣言しています。 スタティックメソッド PrintID は、 単純にクラス名とバージョン番号を出力します。 仮想メソッド Display は配列の要素一つを出力します。 以下にこれを使った例を示します。 Display(1); PrintID Mine; ]]> will print これは次のような出力をします。 Calling a Perl method from C is fairly straightforward. The following things are required C からの Perl メソッドの呼び出しは実に直接的なものです。 以下に挙げるようなことが要求されます。 a reference to the object for a virtual method or the name of the class for a static method. 仮想メソッドのオブジェクトへの参照、もしくはスタティックメソッドの クラスの名前。 the name of the method. メソッドの名前。 any other parameters specific to the method. メソッドに対するパラメータ。 Here is a simple XSUB which illustrates the mechanics of calling both the PrintID and Display methods from C. 以下の例は、C から PrintID, Display の両方のメソッドを呼び出す 仕組みを説明するための簡単なXSUBです。 So the methods PrintID and Display can be invoked like this これで PrintID, Display は次のようにして呼び出すことができます。 The only thing to note is that in both the static and virtual methods, the method name is not passed via the stack--it is used as the first parameter to call_method. 唯一注意すべきことは、スタティックメソッドと仮想メソッドの両方に おいてメソッド名はスタックを通しては渡されない、ということです -- これは call_method の第一引数として使用されます。 (GIMME_V を使う) Here is a trivial XSUB which prints the context in which it is currently executing. 以下は、その時点で実行されているコンテキストを出力するちょっとした XSUB です。 and here is some Perl to test it そしてこれをテストするための Perl プログラムです。 The output from that will be 出力はこうなります。 (一時変数の始末に Perl を使う) In the examples given to date, any temporaries created in the callback (i.e., parameters passed on the stack to the call_* function or values returned via the stack) have been freed by one of these methods これまでのところに使った例では、すべての一時変数(call_* 関数に対してスタックを通して渡されるパラメータ、もしくはスタックを 通して関数から返される値)はコールバックの中で生成され、以下に 挙げる手法のいずれかを使って解放されていました。 specifying the G_DISCARD flag with call_*. call_* に対して G_DISCARD フラグを指定する。 explicitly disposed of using the ENTER/SAVETMPS - FREETMPS/LEAVE pairing. ENTER/SAVETMPS - FREETMPS/LEAVE の組を使って陽に 破棄を行う。 There is another method which can be used, namely letting Perl do it for you automatically whenever it regains control after the callback has terminated. This is done by simply not using the これとは別の手法があります。 それは、コールバックが完了して制御を取り戻したときにはいつでも Perl に自動的に後始末をさせるというものです。 これは単に以下のような sequence in the callback (and not, of course, specifying the G_DISCARD flag). シーケンスをコールバックの中で使うことで行なわれます (もちろん、G_DISCARD フラグは指定しません)。 If you are going to use this method you have to be aware of a possible memory leak which can arise under very specific circumstances. To explain these circumstances you need to know a bit about the flow of control between Perl and the callback routine. この手法を使おうとするなら、非常に特定された状況においてメモリリークが 発生する可能性があることを考慮しなければなりません。 その状況を説明するには、Perl とコールバックとの間での制御の流れについて 知っておく必要があります。 The examples given at the start of the document (an error handler and an event driven program) are typical of the two main sorts of flow control that you are likely to encounter with callbacks. There is a very important distinction between them, so pay attention. 本ドキュメントの最初に挙げたサンプル(エラーハンドラとイベント駆動 プログラム)は、コールバックに遭遇するような典型的な制御の流れです。 これら二つの間には非常に重要な違いがありますから、注意しましょう。 In the first example, an error handler, the flow of control could be as follows. You have created an interface to an external library. Control can reach the external library like this 最初の例、エラーハンドラでは、制御の流れは以下の様になるでしょう。 外部ライブラリに対するインターフェースは既に作っています。 制御は以下のようにして外部ライブラリに到達できます。 XSUB --> external library ]]> Whilst control is in the library, an error condition occurs. You have previously set up a Perl callback to handle this situation, so it will get executed. Once the callback has finished, control will drop back to Perl again. Here is what the flow of control will be like in that situation 制御がライブラリにある間にエラー状況が発生します。 これに対処するためのPerlのコールバックは既に設定していますので、 それがここで実行されます。 コールバックでの処理が完了すれば、制御はPerlの元へと戻ります。 以下はそのような状況における制御の流れです。 XSUB --> external library ... error occurs ... external library --> call_* --> perl | perl <-- XSUB <-- external library <-- call_* <----+ ]]> After processing of the error using call_* is completed, control reverts back to Perl more or less immediately. call_* を使ったエラー処理が完了した後で、制御はほぼ即座に Perl へと戻ります。 In the diagram, the further right you go the more deeply nested the scope is. It is only when control is back with perl on the extreme left of the diagram that you will have dropped back to the enclosing scope and any temporaries you have left hanging around will be freed. このダイアグラムにおいて、より正確にはもっと深いスコープになります。 これは、スコープを囲む部分に戻ったり放っておいた一時変数が 解放されるようなダイアグラムの残りの部分に制御が戻ってきたのみです。 In the second example, an event driven program, the flow of control will be more like this 二番目の例であるイベント駆動のプログラムでは、制御の流れは以下のように なります。 XSUB --> event handler ... event handler --> call_* --> perl | event handler <-- call_* <----+ ... event handler --> call_* --> perl | event handler <-- call_* <----+ ... event handler --> call_* --> perl | event handler <-- call_* <----+ ]]> In this case the flow of control can consist of only the repeated sequence この場合の制御の以下のような流れは、 call_* --> perl ]]> for practically the complete duration of the program. This means that control may never drop back to the surrounding scope in Perl at the extreme left. 現実的なプログラムの生存期間を通じてシーケンスの繰り返しからのみ 構成されます。 これはつまり、制御は 決して そのスコープを囲む部分には 戻ってこないということです。 So what is the big problem? Well, if you are expecting Perl to tidy up those temporaries for you, you might be in for a long wait. For Perl to dispose of your temporaries, control must drop back to the enclosing scope at some stage. In the event driven scenario that may never happen. This means that as time goes on, your program will create more and more temporaries, none of which will ever be freed. As each of these temporaries consumes some memory your program will eventually consume all the available memory in your system--kapow! 大きな問題っていったいなんでしょうか? そう、Perl があなたのために一時変数を用意するのを期待しているのなら、 そのために長く待たされるかもしれないということです。 Perl が一時変数を破棄するために、制御をその場所を囲んでいるスコープに 戻さなければなりません。 イベント駆動のシナリオにおいてはこれは決して起こりません。 これはつまり、 あなたのプログラムが時がたつにつれて解放されることのない一時変数を どんどん生成するということです。 こういった一時変数は幾らかのメモリを使うので、プログラムもシステムで 使えるメモリのすべてを使いきってしまうかもしれないので -- kapow! So here is the bottom line--if you are sure that control will revert back to the enclosing Perl scope fairly quickly after the end of your callback, then it isn't absolutely necessary to dispose explicitly of any temporaries you may have created. Mind you, if you are at all uncertain about what to do, it doesn't do any harm to tidy up anyway. 重要な点はこうです -- コールバックの終了後に制御が(コールバックを 囲んでいる)Perl スコープに即座に戻るということを確信しているので あれば、あなたが生成したすべての一時変数を陽に破棄する必要はないのだと いうことです。 気をつけて欲しいのは、すべきことについて良く わからないことがあるのなら、整頓されたものを壊すような真似をしては いけないということです。 (コールバックのコンテキスト情報の格納についての戦略) Potentially one of the trickiest problems to overcome when designing a callback interface can be figuring out how to store the mapping between the C callback function and the Perl equivalent. コールバックインターフェースを割り当てるときに現れる最も分かりづらい 潜在的な問題は、C のコールバック関数とそれと等価な Perl ルーチンとの間の マッピングをどのように格納するかということで説明することができます。 To help understand why this can be a real problem first consider how a callback is set up in an all C environment. Typically a C API will provide a function to register a callback. This will expect a pointer to a function as one of its parameters. Below is a call to a hypothetical function register_fatal which registers the C function to get called when a fatal error occurs. これが実際の問題になりうるのを理解するため、まず最初にコールバックが すべての C 環境においてどのようにセットアップされるのかを考えてみましょう。 典型的な C API はコールバックを登録するための関数を提供します。 この関数はその引数の一つとして関数へのポインタを期待します。 以下の例では致命的なエラーが発生したときに呼び出される C 関数を登録する仮想関数 register_fatal を呼び出します。 The single parameter cb1 is a pointer to a function, so you must have defined cb1 in your code, say something like this パラメータ cb1 は関数へのポインタなので、cb1 をプログラム中で 以下の様に定義しておかなければなりません。 Now change that to call a Perl subroutine instead ここで、register_fatal と等価な Perl ルーチンで Perl サブルーチンを 呼ぶように変更します。 where the Perl equivalent of register_fatal and the callback it registers, pcb1, might look like this コールバック pcb1 を以下の様に登録します。 The mapping between the C callback and the Perl equivalent is stored in the global variable callback. C のコールバックと Perl との間のマッピングをするために、グローバル変数 callback に格納されます。 This will be adequate if you ever need to have only one callback registered at any time. An example could be an error handler like the code sketched out above. Remember though, repeated calls to register_fatal will replace the previously registered callback function with the new one. これは単に一つのコールバックを好きなときに登録できればよい、というのなら 十分でしょう。 その一つの例は、上で説明したエラーハンドラのようなものです。 しかし忘れないで欲しいのは、register_fatal を繰り返し呼び出すことで、 以前に登録していたコールバック関数を新しいもので 置き換えてしまうということです。 Say for example you want to interface to a library which allows asynchronous file i/o. In this case you may be able to register a callback whenever a read operation has completed. To be of any use we want to be able to call separate Perl subroutines for each file that is opened. As it stands, the error handler example above would not be adequate as it allows only a single callback to be defined at any time. What we require is a means of storing the mapping between the opened file and the Perl subroutine we want to be called for that file. 非同期ファイル入出力のライブラリに対するインターフェースが 欲しいとしましょう。 この場合、読み込み操作が終了したときに常にコールバックされるものを 登録することができるでしょう。 私たちは何かをするために、分割された Perl サブルーチンを オープンされているファイル毎に呼び出すことができます。 現状では、一度に一つのコールバックしか許していないために上の例に あるようなエラーハンドラは十分なものではありません。 私たちが必要としているのは、オープンされたファイルとそのファイルに 対応して呼び出したい Perl サブルーチンとの間のマッピングを 格納するということです。 Say the i/o library has a function asynch_read which associates a C function ProcessRead with a file handle fh--this assumes that it has also provided some routine to open the file and so obtain the file handle. ファイルハンドル fh を伴った ProcessRead という C の関数に 結び付けられた asynch_read を持った入出力ライブラリを 考えてみましょう -- これは、その関数がファイルをオープンし、 ファイルハンドルを取得するいくつかのルーチンを提供していることを 仮定しています。 This may expect the C ProcessRead function of this form これは以下のような形式の C の関数 ProcessRead を期待しているでしょう。 To provide a Perl interface to this library we need to be able to map between the fh parameter and the Perl subroutine we want called. A hash is a convenient mechanism for storing this mapping. The code below shows a possible implementation このライブラリに対する Perl インターフェースを提供するためには、 パラメータ fh と、呼び出しをしたい Perl サブルーチンとの間の マップが可能であることが必要です。 ハッシュはこのマッピングを格納するために便利な機構です。 以下のコードは可能な実装の一例です。 callback mapping */ hv_store(Mapping, (char*)&fh, sizeof(fh), newSVsv(callback), 0); ]]> and asynch_read_if could look like this そして、asynch_read_if は以下のようになるでしょう。 For completeness, here is asynch_close. This shows how to remove the entry from the hash Mapping. 完全のため、asynch_close も例示します。 これはハッシュ Mapping からエントリーを取り除く方法を示すものです。 So the Perl interface would look like this このため、Perl のインターフェースは次のようになります。 The mapping between the C callback and Perl is stored in the global hash Mapping this time. Using a hash has the distinct advantage that it allows an unlimited number of callbacks to be registered. C のコールバックと Perl との間のマッピングは、このときに Mapping という グローバルハッシュに格納されます。 ハッシュを使うことによって、登録できるコールバックの数に 制限がなくなります。 What if the interface provided by the C callback doesn't contain a parameter which allows the file handle to Perl subroutine mapping? Say in the asynchronous i/o package, the callback function gets passed only the buffer parameter like this ファイルハンドルと Perl サブルーチンとのマッピングを許しているパラメータを 含んでいないコールバックによって提供されている インターフェースだとするとどうでしょう? 非同期の I/O パッケージを考えてみましょう。 コールバック関数は以下のように、buffer パラメータのみを取ります。 Without the file handle there is no straightforward way to map from the C callback to the Perl subroutine. ファイルハンドルなしに、直接 C のコールバック関数を Perl のサブルーチンに マップする方法はありません。 In this case a possible way around this problem is to predefine a series of C functions to act as the interface to Perl, thus このような場合に可能な方法は、Perl に対するインターフェースのように C 関数の並びをあらかじめ定義してしまうことです。 したがって、 In this case the functions fn1, fn2, and fn3 are used to remember the Perl subroutine to be called. Each of the functions holds a separate hard-wired index which is used in the function Pcb to access the Map array and actually call the Perl subroutine. この場合、fn1, fn2, fn3 といった関数は呼び出される Perlサブルーチンを記憶するために使われます。 それぞれの関数は関数 Pcb 中で配列 Map にアクセスするためと、 実際に Perl サブルーチンを呼び出すための独立した hard-wired な添え字を 保持しています。 There are some obvious disadvantages with this technique. この技法に関して、幾つかの明らかな短所があります。 Firstly, the code is considerably more complex than with the previous example. 第一に、前の例に比べるとプログラムがより複雑になっているということ。 Secondly, there is a hard-wired limit (in this case 3) to the number of callbacks that can exist simultaneously. The only way to increase the limit is by modifying the code to add more functions and then recompiling. None the less, as long as the number of functions is chosen with some care, it is still a workable solution and in some cases is the only one available. 第二に、同時に存在できるコールバックの数について作り付け(hard-wired)の 限界があるということです(先の例では3)。 この限界を大きくする唯一の方法は、プログラムそのものを変更して より多くの関数を使えるようにし、さらに再コンパイルするというものです。 それでもなお、関数の数を注意深く選択する限りにおいては、この方法は 実用的な解決策であり、また、一部の状況においては唯一の選択肢なのです。 To summarize, here are a number of possible methods for you to consider for storing the mapping between C and the Perl callback まとめとして、C と Perl コールバックとの間のマッピングを格納するために 使うことのできる手法を以下に挙げました。 1. Ignore the problem - Allow only 1 callback (問題を無視する - ただ一つのコールバックだけを許す) For a lot of situations, like interfacing to an error handler, this may be a perfectly adequate solution. 多くの状況で、エラーハンドラへのインターフェースと同じく、 これは十分適切な解決策となるでしょう。 2. Create a sequence of callbacks - hard wired limit (コールバックの並びを作成する - 作り付けの限界) If it is impossible to tell from the parameters passed back from the C callback what the context is, then you may need to create a sequence of C callback interface functions, and store pointers to each in an array. C のコールバックから渡されたパラメータを区別することができなければ、 C のコールバックインターフェース関数の並びを生成して、 配列にポインタを格納する必要があるでしょう。 3. Use a parameter to map to the Perl callback (Perlのコールバックへマップするためのパラメータを使う) A hash is an ideal mechanism to store the mapping between C and Perl. ハッシュは C と Perl との間のマッピングを格納するのに 最適なメカニズムです。 (代替スタックの操作) Although I have made use of only the POP* macros to access values returned from Perl subroutines, it is also possible to bypass these macros and read the stack using the ST macro (See perlxs for a full description of the ST macro). POP* マクロを、Perl サブルーチンからの戻り値にアクセスすることのみに 使用するようにしたにも関らず、これらのマクロをバイパスして ST マクロ(ST マクロに関する記述は perlxs を参照してください)を 使ってスタックを読み取ることが可能です。 Most of the time the POP* macros should be adequate, the main problem with them is that they force you to process the returned values in sequence. This may not be the most suitable way to process the values in some cases. What we want is to be able to access the stack in a random order. The ST macro as used when coding an XSUB is ideal for this purpose. POP* マクロが適切であるべき場合のほとんどにおける主な問題は、 それらのマクロが戻り値をシーケンシャルに処理することを 強制するということです。 これは一部のケースにおいては、値を処理する方法として最も適切な 方法ではありません。 私たちが欲しているのは、スタックに対してのアクセスをランダムな 順序で行えるということです。 ST マクロは、XSUB をコーディングする際にこの目的のために 適切であるときに使われます。 The code below is the example given in the section Returning a list of values recoded to use ST instead of POP*. 以下に挙げたプログラム片は、セクション Returning a list of values に あった例で、POP* の代わりに ST を記録のために使っています。 Notes 注意点 1. Notice that it was necessary to define the variable ax. This is because the ST macro expects it to exist. If we were in an XSUB it would not be necessary to define ax as it is already defined for you. ax という変数を定義する必要があったことに注意してください。 これは、ST マクロがその変数が存在することを期待しているからです。 XSUB の中でなければ、(すでにあるかのようにみなしてしまって)ax を 定義する必要はなかったでしょう。 2. The code このようなコードは sets the stack up so that we can use the ST macro. スタックのセットアップを行うので、ST マクロを使うことができます。 3. Unlike the original coding of this example, the returned values are not accessed in reverse order. So ST(0) refers to the first value returned by the Perl subroutine and ST(count-1) refers to the last. この例のオリジナルのコーディングとは異なり、戻り値は逆順で アクセスされることはありません。 このため、ST(0) は Perl サブルーチンの戻り値の最初の 要素を参照し、ST(count-1) は最後の要素を参照します。 (C の中で無名サブルーチンの作成と呼び出しを行う) As we've already shown, call_sv can be used to invoke an anonymous subroutine. However, our example showed a Perl script invoking an XSUB to perform this operation. Let's see how it can be done inside our C code: 既に述べてきたように、call_sv は無名サブルーチンを起動するために 使うことができます。 しかしながら、一つの例が Perl スクリプトがどのように XSUB を起動して この操作を行うかを示しました。 C プログラムの内側でどのようにするかをお見せしましょう。 eval_pv is used to compile the anonymous subroutine, which will be the return value as well (read more about eval_pv in perlapi/eval_pv). Once this code reference is in hand, it can be mixed in with all the previous examples we've shown. eval_pv は無名サブルーチンをコンパイルするために 使われ、この関数は値を返します (eval_pv の詳細は perlapi/eval_pv を参照してください)。 このコードリファレンスが作用してしまえば、先に挙げた例と 組み合わせることができます。 (軽量コールバック) Sometimes you need to invoke the same subroutine repeatedly. This usually happens with a function that acts on a list of values, such as Perl's built-in sort(). You can pass a comparison function to sort(), which will then be invoked for every pair of values that needs to be compared. The first() and reduce() functions from List::Util follow a similar pattern. 同じサブルーチンを繰り返し起動する必要がある場合もあります。 これは普通、Perl 組み込みの sort() のように、値のリストに対して動作する 関数で起こります。 sort() に比較関数を渡せますが、これは比較が必要な値の組毎に起動されます。 List::Util の first() 関数と reduce() 関数は同様なパターンに従います。 In this case it is possible to speed up the routine (often quite substantially) by using the lightweight callback API. The idea is that the calling context only needs to be created and destroyed once, and the sub can be called arbitrarily many times in between. この場合、軽量コールバック API を使ってルーチンを(しばしばかなり大幅に) 高速化できます。 考え方としては、呼び出しコンテキストは作成時と破壊時に 1 回ずつしか 必要ではなく、サブルーチンはその間に任意の関数呼び出すことができます。 It is usual to pass parameters using global variables -- typically $_ for one parameter, or $a and $b for two parameters -- rather than via @_. (It is possible to use the @_ mechanism if you know what you're doing, though there is as yet no supported API for it. It's also inherently slower.) グローバル変数を使ってパラメータを渡すのはよくあることです -- 典型的には 1 パラメータ用には $_ を、あるいは 2 パラメータのためには $a と $b を -- @_ よりも使われます。 (もし何をしようとしているのかが分かっているなら @_ 機構を使うことも できますが、これのための支援 API はまだありません。 これはまた、本質的に低速です。) The pattern of macro calls is like this: マクロ呼び出しのパターンは以下のようなものです: For some concrete examples, see the implementation of the first() and reduce() functions of List::Util 1.18. There you will also find a header file that emulates the multicall API on older versions of perl. 具体的な例としては、List::Util 1.18 の first() 関数と reduce() 関数の実装を 参照してください。 また、より古いバージョンの perl のための多重呼び出し API をエミュレートする ヘッダファイルもあります。 perlxs, perlguts, perlembed Paul Marquess Special thanks to the following people who assisted in the creation of the document. Jeff Okamoto, Tim Bunce, Nick Gianniotis, Steve Kelem, Gurusamy Sarathy and Larry Wall. Version 1.3, 14th Apr 1997 Created: KIMURA Koichi (5.005) Updated: Kentaro Shirakata <argrath@ub32.org> (5.10.0-)