C/C++、Fortran、および Java API 関数

ここでは、データ収集に関係する API 関数について説明します。

• C と C++: collector_sample(char *name)

  Fortran: collector_sample(string name)

  Java: CollectorAPI.sample(String name)

  標本パケットを記録し、その標本に指定された名前または文字列をラベルとして付けます。ラベルは、「パフォーマンスアナライザ」の「イベント」タブで表示されます。Fortran の引数 string の型は、character です。

  標本ポイントに含まれるデータは、プロセスに関するものであり、個々のスレッドに関するものではありません。マルチスレッドアプリケーションの場合、collector_sample() API 関数は、標本の記録中に別の呼び出しが行われても、1 つの標本だけが書き込まれるようにします。記録される標本の数は、呼び出しを行うスレッドの数よりも少なくなります。

  パフォーマンスアナライザは、別々のメカニズムによって記録された標本同士を区別しません。API 呼び出しによって記録された標本だけを見たい場合には、パフォーマンスデータの記録時にほかのあらゆる標本モードを停止します。

• C、C++、Fortran: collector_pause()

  Java: CollectorAPI.pause()

  実験へのイベント固有データの書き込みを停止します。実験はオープン状態のままであり、大域データの書き込みは続けられます。有効な実験がない場合やデータの記録がすでに停止されている場合には、呼び出しは無視されます。この関数は、たとえすべてのイベント固有データの書き込みが collector_thread_resume() 関数によって特定のスレッドに対して有効にされていたとしても、その書き込みを停止します。

• C、C++、Fortran: collector_resume()

  Java: CollectorAPI.resume()

  collector_pause() を呼び出したあとに、実験へのイベント固有データの書き込みを再開します。有効な実験がない場合やデータの記録が有効である場合には、呼び出しは無視されます。

• C と C++ のみ: collector_thread_pause(unsigned int t)

  Java: CollectorAPI.threadPause(Thread t)

  引数リストで指定したスレッドから実験へのイベント固有データの書き込みを停止します。引数 t は、C/C++ プログラムの場合は POSIX スレッド識別子、Java プログラムの場合は Java スレッドです。実験がすでに終了したか、実験が有効でないか、あるいは、そのスレッドに対するデータの書き込みがすでにオフになっている場合、呼び出しは無視されます。この関数は、たとえデータの書き込みが大域的に有効でも、指定したスレッドからのデータの書き込みを停止します。デフォルトでは、個々のスレッドのデータの記録がオンに設定されます。

• C と C++ のみ: collector_thread_resume(unsigned int t)

  Java: CollectorAPI.threadResume(Thread t)

  引数リストで指定したスレッドから実験へのイベント固有データの書き込みを再開します。引数 t は、C/C++ プログラムの場合は POSIX スレッド識別子、Java プログラムの場合は Java スレッドです。実験がすでに終了したか、実験が有効でないか、あるいは、そのスレッドに対するデータの書き込みがすでにオンになっている場合、呼び出しは無視されます。データは、データの書き込みが大域的に有効にされ、スレッドに対して有効にされているときのみ、実験に書き込まれます。

• C、C++、Fortran: collector_terminate_expt()

  Java: CollectorAPI.terminate

  データを収集している実験を終了します。 以降、データの収集は行われませんが、プログラムは正常に動作を続けます。有効な実験がない場合は、呼び出しは無視されます。