SILC利用者マニュアル

SILC サーバをコンパイルして動かすには以下のソフトウェアがインストール された Unix/Linux 環境または Windows 環境が必要である．

また, 以下の行列計算ライブラリを SILC サーバに組み込んで利用できる．

SILC の動作が確認されている計算環境（括弧内は後述する make.inc の作成例を示す inc/ ディレクトリ 内のファイル名），OS，およびコンパイラは以下の通りである．「OpenMP」の欄は 当該環境における OpenMP のサポートの有無を示す．

SILC のソースコード（silc-1.3.tar.gz）は以下の 場所から入手できる．

silc-1.3.tar.gz からソースコードを 取り出すには次のコマンドを実行する．これによりカレントディレクトリ の silc-1.3/src/ ディレクトリ内に SILC の ソースコードが展開される．

$ gzip -cd silc-1.3.tar.gz | tar xvf -

SILC をコンパイルするには，計算環境に合わせた内容の make.inc というファイルを silc-1.3/src/ ディレクトリ内に作成する必要がある．上述のテスト環境向けに 作成した make.inc ファイルのサンプル が silc-1.3/src/inc/ ディレクトリ内にある． サンプルファイル名と想定する計算環境，OS，コンパイラの対応関係 は表 1 の通りである．

make.inc ファイルには，make コ マンドの入力ファイルとなる Makefile で用いられる マクロ変数を記述する．マクロ変数には大きく分けて SILC に依存しない一般 的なもの（表 2）と SILC 固有のマクロ 変数（表 3）がある．

BLAS および LAPACK は，SILC サーバとサンプルプログラムからドライバを 介して呼び出される．ドライバには以下の3種がある．用いる BLAS/LAPACK の バージョンに応じて適当なドライバを1つ選んで利用する．

用いるドライバ，コンパイラオプション，およびリンカオプション（リンクする ライブラリ等）を指定するには make.inc ファイルに以下の マクロ変数を定義する．

汎用 BLAS/LAPACK ドライバを用いる場合のマクロ定義例を以下に示す．

BLAS_DRIVER=    blas_dumb.c
BLAS_CFLAGS=
BLAS_LIBS=      /opt/LAPACK/blas.a

LAPACK_DRIVER=  lapack_dumb.c
LAPACK_CFLAGS=  $(BLAS_CFLAGS)
LAPACK_LIBS=    /opt/LAPACK/lapack.a $(BLAS_LIBS)

silc-1.3/src/inc/ ディレクトリ内の make.inc の作成例は -DDEBUG オプションを 付けてコンパイルする設定になっているため，SILC サーバとユーザプログラムの 実行時に多量のメッセージが出力される．make.inc を 修正してこのオプションを削除またはコメントアウトすればメッセージの出力を 抑えることができる．

silc-1.3/src/ ディレクトリ内に make.inc を作成した後，同じディレクトリで次のよう に make コマンドを実行して SILC サーバを コンパイルする．SILC のサンプルプログラムも一緒にコンパイルされる．

$ make

ユーザプログラムを実行する前に SILC サーバを起動しておく必要がある． SILC サーバを起動するには次のように入力する（注: SILC サーバの実行 可能形式ファイルがあるディレクトリをカレントディレクトリにする必要が ある）．SILC サーバはフォアグラウンドで動作する．

$ cd src/server
$ ./server

共有メモリ並列環境では OpenMP で 並列化された SILC サーバが利用できる．スレッド数を制御するには 環境変数 OMP_NUM_THREADS を設定する．例：

$ env OMP_NUM_THREADS=4 ./server

特に指定しない限り SILC サーバが用いるポート番号は毎回変化する． ポート番号を指定するには環境変数 SILC_PORT を 設定する．例：

$ env SILC_PORT=32000 ./server

SILC サーバは起動後に自身のホスト名とポート番号を ‾/.silc に書き出す．後述するクライアントルーチン SILC_INIT（3.1節）は，このファイルに記述されたホスト名 とポート番号に従ってサーバへの接続を確立する．‾/.silc の 内容は以下の通りである．

ホスト名 ポート番号 [EOF]

SILC サーバとユーザプログラムをそれぞれファイルシステムの異なる計算環境で 実行する場合はユーザプログラム側の ‾/.silc を人手に より作成する必要がある．以下のように echo コマンドを 利用するとよい：

$ echo ホスト名 ポート番号 > ‾/.silc

SILC サーバを終了するには， Ctrl-C を入力するか， kill コマンドでサーバプロセスを終了させる．例：

$ kill -9 プロセス番号

SILC のユーザプログラムは，ネットワークを介して SILC サーバに 接続し，以下の関数を用いてサーバが管理するライブラリを利用する． これらの関数をクライアントルーチンと呼ぶ． 引数の詳細は5節で述べる．

C 言語用クライアントルーチン:

Fortran 用クライアントルーチン:

これらのクライアントルーチンは C 言語用，Fortran 用とも に silc-1.3/src/client/libsilc.a に 定義されている．このライブラリファイルをユーザプログラムに リンクすることにより上記のクライアントルーチン群が利用 できる．libsilc.a は SILC サーバの コンパイル時に一緒に作成される．

また，クライアントルーチンの呼び出しに用いる構造体や 定数（5節参照）は silc-1.3/src/client/client.h（C 言語用）および silc-1.3/src/client/fortran/client.h（Fortran 用）に 定義されている．

なお，ユーザプログラムは逐次プログラムでもマルチスレッド化された 並列プログラムでもよいが，クライアントルーチンの呼び出しは同一 スレッドから行なわなければならない．

C 言語によるユーザプログラムの構成例（solve.c）を 以下に示す．このプログラムは疎行列 A を係数とする連立一次方程式 Ax = b を 解くプログラムの例である．

#include "client.h"

int main(int argc, char *argv[])
{
  silc_envelope_t object;  /* データの授受に用いる構造体 */
  double *value, *b, *x;
  int *index, *row;

  /* 疎行列 A（CRS 形式）およびベクトル b の生成 */

  SILC_INIT();

  object.v = value;
  object.type = SILC_MATRIX_TYPE;
  object.format = SILC_FORMAT_CRS;
  object.precision = SILC_DOUBLE;
  object.m = object.n = N;  /* 次数 */
  object.nnz = NNZ;  /* 非ゼロ要素数 */
  object.row = row;
  object.index = index;
  SILC_PUT("A", &object);

  object.v = b;
  object.type = SILC_COLUMN_VECTOR_TYPE;
  object.precision = SILC_DOUBLE;
  object.length = N;
  SILC_PUT("b", &object);

  /* 連立一次方程式 Ax = b の求解 */
  SILC_EXEC("x = A ¥¥ b");

  object.v = x;
  SILC_GET(&object, "x");

  SILC_FINALIZE();

  /* 解（ベクトル x）の出力 */
}

上記のユーザプログラムと同じ計算を行なう Fortran プログラムの 構成例（solve.f）を以下に示す．

    INCLUDE 'client.h'

    REAL *8 VALUE(NNZ), B(N), X(N)
    INTEGER *4 ROW(N+1), INDEX(NNZ), IERR

C   疎行列 A（CRS 形式）およびベクトル b の生成

    CALL SILC_INIT(IERR)

    CALL SILC_PUT_MATRIX_CRS('A', VALUE, N, N, NNZ, ROW, INDEX,
   &                         SILC_DOUBLE, IERR)

    CALL SILC_PUT_COLUMN_VECTOR('b', B, N, SILC_DOUBLE, IERR)

C   連立一次方程式 Ax = b の求解
    CALL SILC_EXEC('x = A ¥ b', IERR)

    CALL SILC_GET_COLUMN_VECTOR('x', X, IERR)

    CALL SILC_FINALIZE(IERR)

C   解（ベクトル x）の出力

ユーザプログラムをコンパイルするには， （1）ヘッダファイル（client.h）と ライブラリファイル（libsilc.a）の あるディレクトリを指定するオプション， （2）リンクするライブラリ（libsilc.a および 後述の追加ライブラリ）を指定するオプションをコンパイラに与える．

例えば，GNU C コンパイラを用いて前節の C プログラム（solve.c）をコンパイルするには次のように gcc コマンドを実行する．以下の例ではホームディレクトリ 配下に ‾/silc-1.3/src/ ディレクトリがあると 仮定している．

$ gcc -I‾/silc-1.3/src/client -c solve.c
$ gcc -L‾/silc-1.3/src/client -o solve solve.o -lsilc

-I オプションと -L オプションはそれ ぞれ client.h と libsilc.a があるディレクトリを指定するオプション，-lsilc は libsilc.a のリンクを指示するオプションである．

なお，プログラムを繰返し修正してコンパイルする場合はユーザプログラムと 同じディレクトリに次のような Makefile を作成すると 便利である．

all: solve

CC=      gcc
CFLAGS=  -I$$HOME/silc-1.3/src/client
LDFLAGS= -L$$HOME/silc-1.3/src/client
LIBS=    

solve: solve.c
	$(CC) $(CFLAGS) -c solve.c
	$(CC) $(LDFLAGS) -o $@ solve.o -lsilc $(LIBS)

このファイルを用いて solve.c をコンパイルするには 次のように make コマンドを実行する．

$ make

また，GNU Fortran コンパイラを用いて前節の Fortran プログラム（solve.f）をコンパイルするには次のように g77 コマンドを実行する．

$ g77 -I‾/silc-1.3/src/client/fortran -fno-second-underscore -c solve.f
$ g77 -L‾/silc-1.3/src/client -o solve solve.o -lsilc

C プログラムの場合と同様に次のような Makefile を作成しておくと便利である．

all: solve

FC=      g77 -fno-second-underscore
FFLAGS=  -I$$HOME/silc-1.3/src/client/fortran
LDFLAGS= -L$$HOME/silc-1.3/src/client
LIBS=    

solve: solve.f
	$(FC) $(FFLAGS) -c solve.f
	$(FC) $(LDFLAGS) -o $@ solve.o -lsilc $(LIBS)

なお，いくつかの計算環境では libsilc.a と共に ソケット通信機能を利用するためのライブラリをリンクする必要がある． 主な計算環境と追加ライブラリの有無を以下に示す．上記の Makefile では LIBS に追加ライブラリを 記述すればよい．

ユーザプログラムと SILC サーバのあいだで授受できるデータ型には 以下の5つがある．データ型の指定には括弧内の定数を用いる． これらの定数は client.h に定義されて いる（5節参照）．

利用可能なデータの精度を以下に示す．精度の指定には括弧内の定数を 用いる．各精度に対応するC言語と Fortran のデータ型（精度）を示す．

行列を授受する場合はデータ型（SILC_MATRIX_TYPE）と共に 格納形式を指定する必要がある．現在サポートしている行列の格納形式は 以下の2種である．

代入文には次の2種がある．

代入文の右辺には式を指定する．式の構成要素を以下に示す． ここで，x, y, e1, e2, ..., eN は任意の式である． なお，単項演算子および二項演算子のオペランドとして有効なデータ型に ついては4.4節を，利用可能な 組込み関数については5.3節をそれぞれ参照．

手続き呼び出し文は，手続き名と引数の並びから成る．以下に例を示す．

手続き呼び出し文の引数には以下の3種がある．

上記の手続き split の例では，第1引数 は in 引数， 残りは out 引数である．各引数の in/out/inout の区別， および引数として認められるデータ型は手続きごとに異なる． 利用可能な組込み手続きについては5.3節を参照．

システム文は SILC サーバの動作を制御するための文であり，以下のものがある．

演算子のオペランドには任意の式を記述できるが，オペランドとして 有効なデータ型は演算子ごとに異なる．演算子と有効なデータ型の組み合わせ を表 6 と表 7 に 示す．二項演算子のオペランドに関する制限は 累算代入文（4.1節）にも適用される．

二項演算子のオペランドの精度が異なる場合，計算前に精度を変換して2つの オペランドの精度を合わせる．精度変換には以下のルールを適用する．

代入文の左辺（変数名），および任意の式に添字を付加できる． 添字は1から始まる．添字の記法を以下に示す．

ここで x, y, z は任意の式である．式の値はスカラー整数 または整数の列ベクトルでなければならない（それ以外の値ならば実行時 エラーとなる）．

添字の式として範囲（range）を用いる場合，始点と終点の式は各々省略できる． 例えば，a を次数 n の ベクトルとすれば，a[:5] と a[1:5]， a[5:] と A[5:n]， a[:] と a[1:n] は それぞれ等しい．

添字を用いることのできる文脈とその機能，および用例を以下に示す．

SILC 命令記述言語における演算子，関数，および手続きは，モジュー ル関数と呼ぶラッパーを介してライブラリ関数の呼び出しに置き換えら れ実行される．モジュール関数は，いくつかのモジュールにまとめられ ている．用意されているモジュールとそれに含まれるモジュール関数の 概要を以下に示す．

また，以下の実験的なモジュールがある．

SILC サーバは，数式を構成する個々の演算子，関数，および手続きに ついて上記のモジュールから適当なモジュール関数を1つ選択して実行 する．いくつかの演算子，関数，手続きには，対応するモジュール関数が 複数存在する（例えば，leq_cg，leq_gs，leq_lu の3つにはそれぞれ 連立一次方程式の求解演算子に対応するモジュール関数が含まれる）． また，モジュール群は SILC サーバにおいてリスト構造で管理されている． SILC サーバは，リストの先頭から順にモジュール内のモジュール関数を 調べてゆき，最初に見つかったモジュール関数を演算に用いる．同名の 関数および手続きが複数のモジュールに定義されている場合の選択方法も 同様であり，最初に見つかったモジュール関数が用いられる．

リスト内のモジュールの順序を変更するには SILC_EXEC で prefer 文（4.3節）を用いる． prefer 文は指定されたモジュールをリストの先頭に移動する．これにより 演算子，関数，および手続きとモジュール関数の対応関係を容易に変更できる．

以下の関数はいずれも正常終了なら 0，エラーなら −1 を返す．

後述のクライアントルーチンに共通する引数を以下に示す．

また，下記の type には次のデータ型を用いる．