OpenXM/src/ox_toolkit/README - diff

Return to README CVS log

Up to [local] / OpenXM / src / ox_toolkit

Diff for /OpenXM/src/ox_toolkit/README between version 1.7 and 1.14

version 1.7, 2000/01/14 10:23:34

version 1.14, 2000/11/20 17:59:34

Line 1

# Author: 小原功任 @ 金沢大学理学部計算科学教室

# URI: http://omega.s.kanazawa-u.ac.jp/ohara/

# $OpenXM: OpenXM/src/ox_toolkit/README,v 1.6 1999/12/22 11:29:15 ohara Exp $

# $OpenXM: OpenXM/src/ox_toolkit/README,v 1.13 2000/10/11 20:34:28 ohara Exp $

/*&ja ox_toolkit ユーザガイド

Line 25 In order to use libox.a, you need to include the follo

/*&common

#include <oxtag.h>

#include <ox_toolkit.h>

#include <ox.h>

#include <parse.h>

/*&ja

Line 42 In order to use libox.a, you need to include the follo

Line 40 In order to use libox.a, you need to include the follo

1. Types

1.1 CMO (Common Math Object)

The following structures are defined in ox.h:

The following structures are defined in ox_toolkit.h:

/*&common

Line 82 class.

Line 80 class.

/*&en

1.2 OX objects

The following structures are defined in ox.h:

The following structures are defined in ox_toolkit.h:

/*&common

Line 131 new_cmo_error2(cmo* ob);

Line 129 new_cmo_error2(cmo* ob);

/*&ja

3. 高水準 API

3. コネクション

OXFILE は OpenXM での通信路を表現するクラスである。このクラスのオブジェ

クトを明示的には生成しないこと。必ずコンストラクタを利用しなければなら

ない。これはクライアントとサーバで接続時の手順が異なることに由来する。

バイトオーダに関連した処理はこのクラスのメソッドで実現される。このクラ

スのメソッドとして次のものが用意されている。

3.1 コンストラクタ

OXFILE *oxf_connect_active(char *hostname, short port);

能動的に接続する場合のコンストラクタ。通常、サーバで利用する。

OXFILE *oxf_connect_passive(int listened);

受動的に接続するためのコンストラクタ。

内部で accept() を呼ぶので、listened には mysocketListen() の返した値が必要。

OXFILE *oxf_open(int fd);

インスタンスを生成するだけで、接続は行わない。すでにオープンされたファ

イルディスクリプタを fd に指定する。計算サーバでの利用を想定。

3.2 認証に関連したメソッド

int oxf_confirm_client(OXFILE *oxfp, char *passwd);

クライアント側での認証を行う。返り値が1のときに成功、0のときに失敗。

int oxf_confirm_server(OXFILE *oxfp, char *passwd);

サーバ側での認証を行う。常に成功する。

void oxf_determine_byteorder_client(OXFILE *oxfp);

void oxf_determine_byteorder_server(OXFILE *oxfp);

oxfp の指す通信路でのバイトオーダを決定し、oxfp のインスタンスを書き換える。

void oxf_setopt(OXFILE *oxfp, int mode);

oxfp の設定を行う。oxf_determine_byteorder_XXX() で用いられている。

3.3 その他のメソッド

int oxf_read(void *buffer, size_t size, size_t num, OXFILE *oxfp);

int oxf_write(void *buffer, size_t size, size_t num, OXFILE *oxfp);

void oxf_flush(OXFILE *oxfp);

void oxf_close(OXFILE *oxfp);

fread, fwrite, fflush, fclose に準拠。

/*&ja

4. 高水準 API(この記述は古いので使わないこと)

高水準 API は「OpenXM クライアント」から利用することを前提に設計されている。

3.1 通信の開始

4.1 通信の開始

通信を開始する場合には、次の関数のいずれかを利用する。

/*&en

3. High-level API

4. High-level API

High-level API is prepared to help an implementation of OpenXM clients.

3.1 How to make connections to OpenXM servers?

4.1 How to make connections to OpenXM servers?

In order to open a connection to an OpenXM server, you need to call

ox_start() or to call ox_start_insecure_nonreverse().

/*&common

ox_file_t ox_start(char* host, char* prog1, char* prog2);

OXFILE *ox_start(char* host, char* prog1, char* prog2);

ox_file_t ox_start_insecure_nonreverse(char* host, short portControl, short portStream);

OXFILE *ox_start_insecure_nonreverse(char* host, short portControl, short portStream);

/*&ja

Line 182 OpenXM server run on a remote host and you need to pro

Line 234 OpenXM server run on a remote host and you need to pro

/*&ja

3.2 通信の終了

4.2 通信の終了

通信の終了のためには次の二つの関数が用意されている。

/*&en

3.2 How to close connections to OpenXM servers?

4.2 How to close connections to OpenXM servers?

In order to close a connection to an OpenXM server, you need to call

ox_close() or to call ox_shutdown().

/*&common

void ox_close(ox_file_t sv);

void ox_close(OXFILE *sv);

void ox_shutdown(ox_file_t sv);

void ox_shutdown(OXFILE *sv);

/*&ja

Line 206 void ox_shutdown(ox_file_t sv);

Line 258 void ox_shutdown(ox_file_t sv);

/*&ja

3.3 SM コマンドの送信

4.3 SM コマンドの送信

/*&en

3.3 How to command to OpenXM stack machines?

4.3 How to command to OpenXM stack machines?

/*&common

void ox_push_cmd(ox_file_t sv, int sm_code);

void ox_push_cmd(OXFILE *sv, int sm_code);

/*&ja

Line 222 void ox_push_cmd(ox_file_t sv, int sm_code);

Line 274 void ox_push_cmd(ox_file_t sv, int sm_code);

/*&en

ox_push_cmd() sends an operation code to an OpenXM stack machine.

See OpenXM/src/ox_toolkit/oxtag.h for a list of operation codes.

See OpenXM/include/ox_toolkit_tags.h for a list of operation codes.

/*&ja

3.4 CMO の送受信

4.4 CMO の送受信

/*&en

3.4 How to receive a CMO?

4.4 How to receive a CMO?

/*&common

void ox_push_cmo(ox_file_t sv, cmo *c);

void ox_push_cmo(OXFILE *sv, cmo *c);

cmo* ox_pop_cmo(ox_file_t sv);

cmo* ox_pop_cmo(OXFILE *sv);

char* ox_popString(ox_file_t sv);

char* ox_popString(OXFILE *sv);

/*&ja

Line 247 ox_push_cmo は cmo を送信、ox_pop_cmo は cmo を受信す�

Line 299 ox_push_cmo は cmo を送信、ox_pop_cmo は cmo を受信す�

/*&en

/*&ja

3.5 スタック処理

4.5 スタック処理

/*&common

int ox_pops(ox_file_t sv, int num);

int ox_pops(OXFILE *sv, int num);

/*&ja

Line 259 int ox_pops(ox_file_t sv, int num);

Line 311 int ox_pops(ox_file_t sv, int num);

/*&ja

3.6 通信路のフラッシュ

4.6 通信路のフラッシュ

/*&common

int ox_flush(ox_file_t sv);

int ox_flush(OXFILE *sv);

/*&ja

Line 271 int ox_flush(ox_file_t sv);

Line 323 int ox_flush(ox_file_t sv);

/*&ja

3.7 通信の中断

4.7 通信の中断

/*&common

void ox_reset(ox_file_t sv);

void ox_reset(OXFILE *sv);

/*&ja

Line 283 void ox_reset(ox_file_t sv);

Line 335 void ox_reset(ox_file_t sv);

/*&ja

3.8 ローカル言語で書かれたコマンドの評価

4.8 ローカル言語で書かれたコマンドの評価

/*&common

void ox_execute_string(ox_file_t sv, char* str);

void ox_execute_string(OXFILE *sv, char* str);

/*&ja

Line 295 void ox_execute_string(ox_file_t sv, char* str);

Line 347 void ox_execute_string(ox_file_t sv, char* str);

/*&ja

3.9 関数呼び出し

4.9 関数呼び出し

/*&common

int ox_cmo_rpc(ox_file_t sv, char *function, int argc, cmo *argv[]);

int ox_cmo_rpc(OXFILE *sv, char *function, int argc, cmo *argv[]);

/*&ja

Line 307 function(argv[1], ...) を計算し、結果をスタックに積む�

Line 359 function(argv[1], ...) を計算し、結果をスタックに積む�

/*&ja

3.10 Mathcap の受信

4.10 Mathcap の受信

/*&common

cmo_mathcap* ox_mathcap(ox_file_t sv);

cmo_mathcap* ox_mathcap(OXFILE *sv);

/*&ja

Line 320 Mathcap を受け取る。現在は Mathcap の処理はユーザプロ�

Line 372 Mathcap を受け取る。現在は Mathcap の処理はユーザプロ�

/*&ja

4. 低水準 API

5. 低水準 API

低水準 API はファイルディスクリプタを直接利用する。

4.1 通信に使われるバイトオーダの決定

5.1 通信に使われるバイトオーダの決定

/*&en

4. Low-level API.

5. Low-level API.

In this section, ``fd'' is an identifier of an OpenXM connection.

4.1 How to decide a byte order of integers?

5.1 How to decide a byte order of integers?

/*&common

Line 353 as an expression for integers.

Line 405 as an expression for integers.

/*&common

4.2

5.2

/*&common

Line 371 receive_int32() reads 32bits integer from an OpenXM co

Line 423 receive_int32() reads 32bits integer from an OpenXM co

/*&common

4.3

5.3

/*&common

Line 389 receive_cmo() reads an CMObject from an OpenXM connect

Line 441 receive_cmo() reads an CMObject from an OpenXM connect

/*&common

4.4

5.4

/*&common

Line 404 next_serial() generates a serial number for ox message

Line 456 next_serial() generates a serial number for ox message

/*&common

4.5

5.5

/*&common

Line 424 receive_ox_tag() reads a tag and a serial number of an

Line 476 receive_ox_tag() reads a tag and a serial number of an

/*&common

4.6

5.6 Sending OX messages.

/*&common

Line 434 void send_ox_command(int fd, int sm_command);

Line 486 void send_ox_command(int fd, int sm_command);

/*&ja

ox メッセージを送信する。

OX メッセージを送信する。

/*&ja

5. OX expression パーサ

6. OX expression パーサ

/*&en

6. Parser for OX expressions

/*&ja

OpenXM C library には文字列表現された

OpenXM C library には文字列表現された OX expression および CMO

OX expression および CMO expression から、

expression から、ox 構造体または cmo 構造体を生成するためのパーサが付

ox 構造体または cmo 構造体を生成するためのパーサが付属している。

属している。ここではこのパーサについて説明する。

/*&en

We have a parser which generate an OX object or a CMO from a string

encoded OX/CMO expression. In this section, we explain the parser.

/*&en

ここではこのパーサについて説明する。

6.1 Setting an option

/*&ja

6.1 オプション

/*&common

int setflag_parse(int flag);

/*&ja

setflag_parse(PFLAG_ADDREV) によって、CMO の短縮表現を許す。

/*&en

We set an option for the parser. If we call

setflag_parse(PFLAG_ADDREV), then the parser admits external

expressios.

/*&en

6.2 Initializing

/*&ja

6.2 初期化

/*&common

int init_parser(char *str);

/*&ja

パーサが処理すべき文字列をセットする。

/*&en

We give the parser an OX/CMO expression, that is, a Lisp style string.

/*&en

6.3 Getting an object

/*&ja

6.3 結果を得る

/*&common

cmo *parse();

Line 474 cmo *parse();

Line 565 cmo *parse();

Lisp 表現による OX expression, CMO expression の構文解析器。あらかじめ

設定された文字列を解析して ox 構造体、あるいは cmo 構造体を生成する。

/*&en

The parser returns an OX/CMO object. If the given string is illegal,

then the parser returns NULL.

/*&ja

7. 付属プログラムについて

7. Mathcap データベース

7.1. 概要

Mathcap データベースは、各通信路ごとに生成される局所データベースと、通

信路に関係なく保持される大域データベースからなる。大域データベースは、

局所データベースの生成時に初期値としても利用される。局所データベースと

$大域データベースの関係は次のように理解すればよい。すなわち、Mathcap ク

ラスのインスタンスが局所データベースであり、静的メンバが大域データベー

スである。

7.2. メソッド

Mathcap データベースは mathcap.c で実装されている。ユーザは次の関数を

介して、Mathcap データベースにアクセスすることができる。

void mathcap_global_init(int version, char *id, char *sysname, int cmo[], sm_cmd[]);

大域データベースを初期化する。クライアントおよびサーバはプログラムを開

始するときに、この関数を呼ばなければならない。cmo は CMO のタグのリス

トであって、0 で終端しなければならない。sm_cmd も同様。

cmo_mathcap *mathcap_get(mathcap *this);

Mathcap クラスのインスタンスを cmo_mathcap クラスのインスタンスに変換する。

mathcap *mathcap_update(mathcap *this, cmo_mathcap *mc);

通信相手から入手したcmo_mathcap オブジェクトを用いて、Mathcap データベー

スを更新する。

7.3. ox_toolkit における実装の問題点(obsolete)

現在はシステム全体で一つの Mathcap データベースしかもたないような実装

になっている。ところが、OpenXM クライアントは複数の計算サーバと同時に

接続されることが許されている。これらの計算サーバは同種あるいは異種であ

るが、異種の場合、それら OX サーバの許容する CMO の範囲は異なる。した

がって、計算サーバごとに Mathcap データベースをもつ必要がある。具体的

には OXFILE クラスの(static ではない)メンバになるような実装でなければ

ならない。

/*&ja

8. 付属プログラムについて

/*&en

7. Sample programs.

8. Sample programs.

/*&common

Line 512 bconv

Line 650 bconv

A byte code encoder. It shows a byte stream which corresponds to an

OX expression.

/*&common

ox_Xsample

Line 520 ox_Xsample

Line 659 ox_Xsample

GUI 表示する OpenXM サーバのサンプル。

/*&ja

9. 付録

9.1 ox.c における関数の命名規則

(1) receive_cmo 関数はCMOタグとデータ本体を受信する. この関数は CMOタ

グの値が事前に分からないときに使用する. 返り値として、cmo へのポインタ

を返す.

(2) receive_cmo_X 関数は, CMOタグを親の関数で受信してから呼び出される

関数で、データ本体のみを受信し、cmo_X へのポインタを返す. しかも、関

数内部で new_cmo_X 関数を呼び出す.

(3) send_cmo 関数はCMOタグとデータ本体を送信する.

(4) send_cmo_X 関数はCMOタグを親の関数で送信してから呼び出される関数で、

データ本体のみを送信する.

(5) ただし receive_ox_tag を除いて, receive_ox_X 関数は作らない.

receive_cmo を利用する.

(6) send_ox_X 関数は OX タグを含めて送信する.

(7) ox_X 関数は一連の送受信を含むより抽象的な操作を表現する. ox_X 関

数は、第一引数として、ox_file_t型の変数 sv をとる.

(8) Y_cmo 関数と Y_cmo_X 関数の関係は次の通り:

まず Y_cmo 関数で cmo のタグを処理し、タグを除いた残りの部分をY_cmo_X

関数が処理する. cmo の内部に cmo_Z へのポインタがあるときには、その種

類によらずに Y_cmo 関数を呼び出す.

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>