JOB

pc

オプションの後置条件式です。Caché は、後置条件式が True (0 以外の数値に評価される) の場合に JOB コマンドを実行します。Caché は、後置条件式が False (0) の場合はコマンドを実行しません。詳細は、"Caché ObjectScript の使用法" の "コマンド後置条件式" を参照してください。

routine

開始されるプロセスです。以下の形式のいずれかで指定することができます。

プロシージャ・ブロック内では、JOB コマンドを呼び出すと、プロシージャ・ブロックの範囲外にある子プロセスが開始します。そのため、プロシージャ・ブロック内の label 参照を解決できません。この結果、プロシージャ内のラベルを参照する JOB では、プロシージャはプロシージャ・ブロックを使用できません。

存在しないラベルを指定した場合、Caché は <NOLINE> エラーを返します。存在しないルーチンを指定した場合、Caché は <NOROUTINE> エラーを返します。これらのエラーの詳細は、"$ZERROR" 特殊変数を参照してください。

routine-params

コンマで区切られた値のリスト、式、または既存のローカル変数名です。括弧は必須です。このリストは、実パラメータ・リストと呼ばれます。ルーチンには、仮パラメータ・リストが必須です。また、このリスト内のパラメータ数は、実パラメータ・リスト内のパラメータ数以上でなければなりません。指定した実パラメータの方が多い場合、Caché は <PARAMETER> エラーを返します。呼び出されるルーチンに仮パラメータ・リストが含まれている場合は、それを囲む括弧を指定する必要があります。パラメータを渡さない場合も同様です。routine-params のリストから項目を省略することはできません。

ルーチン・パラメータは値によってのみ渡すことができますつまり、配列を渡すことはできないということです。この点で、値でも参照でもパラメータを渡すことができる DO コマンドとは異なります。この制限により、JOB コマンドでは配列を渡すことができません。配列は、参照でしか渡すことができないからです。

ジョブ起動プロセスにオブジェクト参照 (oref) を渡すことはできません。呼び出し元のプロセス・コンテキスト内に存在するオブジェクトへの参照は、新しいジョブ起動プロセス・コンテキスト内では参照できないためです。oref を渡そうとすると、ジョブ起動プロセスに空文字列 ("") が渡されます。

ルーチンを開始するとき、Caché はすべての式を評価し、実リスト内の各パラメータの値をその位置に従って、対応する仮リストの変数にマップします。仮リスト内の変数が、実リスト内のパラメータよりも多い場合は、余った変数は未定義のままになります。

ルーチン・パラメータは、ローカル・プロセスにのみ渡されます。リモート・ジョブを作成しているときは、ルーチン・パラメータを指定することはできません。"リモート・ジョブ" を参照してください。

process-params

コロンで区切られた位置パラメータのリスト。ジョブの環境内のさまざまな要素を設定するために使用されます。先頭のコロンと括弧は必須です。すべての位置パラメータはオプションです。process-params には、最大 7 つの位置パラメータを指定できます。これらの 6 つのパラメータは以下のとおりです。

(nspace:switch:principal-input:principal-output:priority:os-directory)

timeout

ジョブがタイムアウトし、中止される前に、ジョブ起動プロセスの開始を待機する秒数です。最初のコロンは必須です。timeout は、整数値または式として指定する必要があります。ジョブ化したプロセスがタイムアウトになると、Caché はプロセスを中止し、$TEST 特殊変数を 0 (FALSE) に設定します。実行は、呼び出しルーチンの次のコマンドから続行します。エラー・メッセージは発行されません。ジョブ化したプロセスが成功すると、Caché は $TEST を 1 (TRUE) に設定します。$TEST は、ユーザが設定することもできます。また、LOCK、OPEN、または READ のタイムアウトで設定されることもあります。

タイムアウトは、ローカル・プロセスに対してのみ指定できます。

Caché が割り当てるジョブ番号とメモリ・パーティション

ジョブ起動プロセスの開始後、Caché は、そのプロセスに個別のメモリ・パーティションと、一意のジョブ番号 (またはプロセス ID、PID とも呼ばれます) を割り当てます。ジョブ番号は、特殊変数 $JOB に保存されます。ジョブの状態 (そのジョブが JOB コマンドで開始されたか否かも含む) は、$ZJOB 特殊変数に格納されます。

ジョブ起動プロセスは、それぞれ別個のメモリ・パーティションを保持しているので、そのプロセスを作成したプロセスやジョブ起動プロセスが共通のローカル変数環境を共有することはありません。ジョブ起動プロセスを開始するときには、パラメータ渡し (routine–params) により、現在のプロセスからジョブ起動プロセスに値を渡すことができます。

JOB コマンドが失敗する一般的な原因は以下のとおりです。

• 空きパーティションがない

• process—params で指定された特性でパーティションを作成する十分なメモリがない

プラットフォームで異なるジョブ起動プロセスの許可

JOB コマンドにより作成されたプロセスは、Caché サービス・アカウント・ユーザとして実行します。つまり、Caché サービス・アカウントに、必要なすべてのリソースへの明示的なアクセス権が付与されていることを確認する必要があります。

生成されたジョブ・プロセスは JOB コマンドを発行したプロセスのユーザ ID 以外で実行することもできます。生成されたジョブ・プロセスのユーザ ID はプラットフォームによって、以下のように異なります。

• Windows プラットフォームでは、ジョブ・プロセスは Caché インスタンス用に確立されたユーザ ID を使用します。

• UNIX® プラットフォームでは、ジョブ・プロセスは JOB コマンドを発行したプロセスのユーザ ID を使用します。

したがって、ジョブを生成するときは、ジョブ・プロセスのユーザ ID に、ジョブ実行中に読み書きされるファイルを使用するために必要な許可があることを確認する必要があります。

ジョブ間の通信

値渡しのパラメータは、1 方向のみ、およびジョブの起動時のみ発生します。プロセス相互の通信を行うには、双方が合意したグローバル変数を使用する必要があります。このような変数は、プロセス間の情報交換を可能にすることだけが目的なので、一般にスクラッチ・グローバルと呼ばれます。

• プロセスでは、%SYSTEM.EventOpens in a new tab クラス・メソッドを使用して、ジョブ間の通信を行えます。

• 特殊なプロセス・パラメータを指定することによって、現在のプロセスのすべてのローカル変数を、呼び出されたプロセスに渡すことができます。

• プロセスでは、IPC (プロセス間通信) デバイス (デバイス番号 224 ～ 255) を介してジョブ間の通信を行うこともできます。また、UNIX® オペレーティング・システムの場合は、UNIX® のパイプを介した通信が可能です。

デバイス所有権の設定

Caché は、呼び出されるルーチンが新しいプロセスのデバイス所有権を扱うコード (OPEN コマンドや USE コマンド) を含むと想定しています。既定のデバイスは、NULL デバイスです。

Caché は、サインイン時に開始されたプロセス以外のプロセスには、既定のデバイスを割り当てません。

ジョブ優先度の設定

%PRIO ユーティリティを使用すると、UNIX® のジョブ起動プロセスの実行優先度を制御できます。使用可能なオプションは、NORMAL (負荷分散を使用して CPU の使用効率を調整)、LOW および HIGH です。優先度が HIGH の場合、ジョブ起動プロセスは、対話型プロセスと対等に CPU リソースを取り合います。

Caché で、ジョブ起動プロセスに対して既定の優先度を設定することもできます。

SetBatch()Opens in a new tab メソッドを使用すると、プロセスをバッチ・モードで実行するように設定できます。バッチ・モードのプロセスは、バッチでないプロセスよりも優先度が低くなります。

Raw パーティションで JOB コマンドを使用する (UNIX®)

以下のいずれかの方法で、JOB コマンドを Raw パーティションで使用できます。

• Raw パーティションで JOB コマンドを実行する

• 他のネームスペースで JOB コマンドを実行し、JOB コマンドのプロセス・パラメータ nspace として、ロー・パーティションを指定するこの nspace は、暗黙のネームスペースです。暗黙のネームスペースは、"^^dir" のように 2 つのキャレット文字が先行するディレクトリ・パスです。暗黙のネームスペース構文に関する詳細は、"Caché グローバルの使用法" の "グローバル構造" を参照してください。

Raw パーティションで実行しているコマンドとジョブ起動プロセスの場合、ファイル名を参照するときは常に、フル・パス名を指定する必要があります。また、"." や ".." で開始するパス名は使用してはなりません。これらは特殊な UNIX® ファイルであり、Raw パーティションには存在しないからです。これらの規則のいずれかに違反すると、<DIRECTORY> エラーが発生します。

現在のネームスペースのフル・パス名を取得するには、以下の例に示すように、NormalizeDirectory()Opens in a new tab メソッドを呼び出します。

   WRITE ##class(%Library.File).NormalizeDirectory("")

また、ObjectScript の JOB コマンドの代わりに、UNIX® のバッチ・コマンド & を使用することもできます。例えば、Test という名前のルーチンを Raw ディスク・パーティションでバッチ・ジョブとして開始するには、以下のように入力して、Caché を呼び出します。

$cache "^Test" &

リモート・ジョブ

リモート・ジョブを開始する前に、ECP 接続を確立し、netjob パラメータを True に設定する必要があります。これにより、サーバはリモート ECP クライアント・システムからのジョブ要求を処理することができます。

リモート・ジョブ要求を受信する予定のシステムには、あらかじめその機能を設定しておく必要があります。

受信システムで管理ポータルに進み、[システム管理]、[構成]、[追加設定]、[詳細メモリ] の順に選択します。表示して編集する netjob を見つけます。“true” の場合、ECP を介して着信するリモート・ジョブ要求は、このサーバで処理されます。既定は “true” です。

リモート・システムのライセンスでは、リモートで開始されるジョブを実行できる十分なユーザがサポートされている必要があります。"インターシステムズ・クラス・リファレンス" の説明に従って、%SYSTEM.LicenseOpens in a new tab クラスのクラス・メソッドを使用して、使用できる Caché ライセンスの数を決定できます。

JOB routine[joblocation] 
JOB routine|joblocation|

特殊変数 $ZCHILD と $ZPARENT の使用

$ZPARENT には、現在のプロセスをジョブ化したプロセスの PID (プロセス ID) が含まれます。現在のプロセスが JOB コマンドで作成されなかった場合は、0 が含まれます。

$ZCHILD には、JOB コマンドによって最後に作成されたプロセスの PID が含まれています。このプロセスは成功したものではない場合もあります。

$ZCHILD を使用すると、JOB コマンドを実行する前後の $ZCHILD 値を比較することにより、リモート・ジョブの実行状態を判断することができます。前後の値が異なり、後の値がゼロ以外の場合、後の $ZCHILD 値は、新しく作成されたリモート・ジョブの PID であり、プロセスが正常に作成されたことを示します。後の値がゼロの場合、または後の値が前の値と同じ場合、リモート・ジョブは作成されていません。

$ZCHILD からは、リモート・ジョブが作成されたことのみがわかります。リモート・ジョブが正常に実行されたかどうかはわかりません。リモート・プロセスがエラーなく実行され、完了まで実行されたかどうかを判断する最も良い方法は、実行中のコードにある種のログとエラー・トラップを用意することです。リモート・ジョブ・メカニズムは、リモート・プロセス・エラーやリモート・プロセスの終了、正常に実行されたかどうかなどについて、親プロセスに一切通知しません。

JOB サーバの使用

JOB サーバは、JOB 要求の処理を待つ Caché プロセスです。JOB サーバに付属しているジョブ起動プロセスは、新しいプロセスを作成する必要があるというオーバーヘッドの付加を回避します。使用可能な場合、JOB サーバを使用するように設定された switch パラメータを指定して JOB コマンドが発行されるたびに、Caché は、これに対処できる JOB Server があるかどうかをチェックします。JOB サーバがない場合は、Caché がプロセスを作成します。使用できる JOB サーバがある場合、JOB はその JOB サーバに付属します。

JOB サーバで実行されている JOB で HALT が実行された場合、JOB サーバは他の JOB 要求を受け取るまで、ハイバネーション状態になります。JOB サーバで動作していないジョブ起動プロセスは終了し、そのプロセスは削除されます。

JOB サーバ環境と、ジョブ起動プロセス環境では回避できない相違点がいくつかあります。ジョブ起動プロセスを JOB サーバで実行する場合に、これらがセキュリティ上の問題になる可能性があります。ジョブ起動プロセスは、Caché レベルで JOB コマンドを発行したプロセスのセキュリティ属性を受け付けます。

実行されないジョブに関するトラブルシューティング

ジョブが開始しない場合は、入出力指定をチェックしてください。Caché が要求されたデバイスを開くことができない場合、ジョブは開始されません。なお、NULL デバイス (UNIX® では /dev/null) はいつでも利用できます。

ジョブが開始されてもすぐに停止される場合は、適切なスワップ領域があることを確認してください。十分なスワップ領域がない場合、ジョブはエラーを受け取ります。

ジョブが開始されない場合は、JOB コマンドで正しいネームスペースを使用していることを確認してください。Exists()Opens in a new tab メソッドを使用して、ネームスペースが定義されているかどうかをテストすることができます。

   WRITE ##class(%SYS.Namespace).Exists("USER"),!  ; an existing namespace
   WRITE ##class(%SYS.Namespace).Exists("LOSER")   ; a nonexistent namespace

JOB コマンドが目的どおりに実行されない場合は、以下を試してください。

• ルーチンを DO コマンドで実行します。

• Caché でライセンス付与されているプロセス数を、超えていないことを確認してください。"インターシステムズ・クラス・リファレンス" の説明に従って、%SYSTEM.LicenseOpens in a new tab クラスのクラス・メソッドを使用して、使用できる Caché ライセンスの数を決定できます。

• JOB コマンドに timeout パラメータがある場合は、システムの速度により指定されたタイムアウト時間に達していないかどうかを確認してください。

多数のジョブを同時に実行している場合、ルーチン・バッファもしくはライセンス・スロットを待っている間に、JOB コマンドが停止することがあります。Ctrl-C を使用して、JOB コマンドに割り込むことができます。

JOB コマンドの終了

ジョブ起動プロセスは、終了する前にそれを作成したプロセスがログオフされた場合でも、最後まで続行されます。

TCP デバイスを使用した JOB コマンド

JOB コマンドを使用して、TCP 並行サーバ を実装することができます。TCP 並行サーバを使用すると、複数のクライアントを同時に処理できます。このモードでは、クライアントは、サーバが他のクライアントのサービスを終了するまで待機する必要はありません。代わりに、クライアントがサーバに要求を送信するたびに、開いているクライアントに対して必要に応じて個別のサブジョブを生成します。このサブジョブが生成された直後に (JOB コマンドから制御が戻ります)、他のクライアントが処理を要求することがあります。サーバは、そのクライアントのサブジョブも同様に生成します。

並行サーバは、ビット 4 またはビット 16 のビット・マスクが設定された switch プロセス・パラメータを指定して JOB コマンドを使用し、生成されたプロセスに入力および出力のプロセス・パラメータを渡します。

• switch にビット 4 を指定する場合、常に、プロセス・パラメータ principal-input および principal-output の両方の TCP デバイスを指定する必要があります。以下のように、principal-input と principal-output の両方に同デバイスを使用する必要があります。

    JOB child:(:4:tcp:tcp)

  

  その後、生成されたプロセスは、この単一の入出力デバイスを以下のように設定します。

    SET tcp=$IO

  

• switch にビット 16 を指定する場合、以下のように、プロセス・パラメータ principal-input および principal-output の TCP デバイスに異なるデバイスを指定できます。

    USE tcp
    JOB child:(:16:input:output)

  

  JOB コマンドの前の USE tcp は、(主デバイスではなく) 現在のデバイスを TCP デバイスとして指定します。その後、生成されたプロセスはこれらのデバイスを以下のように設定できます。

    SET tcp=##class(%SYSTEM.INetInfo).TCPName()
    SET input=$PRINCIPAL
    SET output=$IO
    WRITE tcp," ",input," ",output

  

4 ビットまたは 16 ビットが設定されている場合、JOB コマンドが、ジョブ起動プロセスに TCP ソケットを渡すことが重要となります。追加の機能ごとに適切なビット・コードを追加すると、JOB コマンドの他の機能と組み合わせることができます。例えば、switch が値 1 のビットを含むときは、シンボル・テーブルが渡されます。並行モードをオンにし、シンボル・テーブルを渡すには、switch の値を 5 (4+1) または 17 (16+1) にします。

JOB コマンドを実行する前に、TCP デバイスは以下の状態になる必要があります。

• 接続されている

• TCP ポートで待ち受け状態にある

• 接続を受け入れ済みである

JOB コマンドの後、生成されているプロセスのデバイスは継続して TCP ポートで待ち受け状態にありますが、アクティブな接続は既に存在していません。アプリケーションは、JOB コマンドの実行後 $ZA 特殊変数をチェックし、TCP デバイスで CONNECTED ビットがリセットされていることを確認する必要があります。

生成されたプロセスは、指定の TCP デバイスを principal-input デバイスおよび principal-output デバイスに使用し、指定のエントリ・ポイントで開始します。子プロセスの TCP デバイス名は、親プロセスの名前と同じです。TCP デバイスには、付属のソケットが 1 つあります。USE コマンドは、“M” モードで TCP デバイス構築するために使用されます。これは “PSTE” と同等です。“P” (pad) オプションは、レコード・ターミネータ文字で出力を埋め込む際に必要です。このモードを設定すると、WRITE ! では LF (改行)、WRITE # では FF (改ページ) が送信されます。さらに、書き込みバッファがフラッシュされます。

生成したプロセスの TCP デバイスは、接続状態です。これは、デバイスをクライアントから開いた後に受け取る状態と同じです。生成されたプロセスは、TCP デバイスを明示的な USE 文で使用します。また、TCP デバイスを明示的に使用することもできます。

以下の例は、非常に単純な並行サーバです。このサーバは、クライアントからの接続を検出するたびに子ジョブを生成します。JOB は、並行サーバ・ビット 16 およびシンボル・テーブル・ビット 1 で構成される switch 値 17 を使用します。

server ;
     SET io="|TCP|1"
     SET ^serverport=7001
     OPEN io:(:^serverport:"MA"):200
     IF $TEST=0 {
      WRITE !,"Cannot open server port"
      QUIT }
     ELSE { WRITE !,"Server port opened" }
loop  ;
     USE io READ x   ; Read for accept
     USE 0  WRITE !,"Accepted connection"
     USE io 
     JOB child:(:17::)  ; Concurrent server bit is on
     GOTO loop
child ;
     SET io=##class(%SYSTEM.INetInfo).TCPName()
     SET input=$PRINCIPAL
     SET output=$IO
     USE io:(::"M")  ; Ensure that "M" mode is used
     WRITE $JOB,!  ; Send job id on TCP device to be read by client
     QUIT
client ;
     SET io="|TCP|2"
     SET host="127.0.0.1"
     OPEN io:(host:^serverport:"M"):200  ; Connect to server
     IF $TEST=0 {
      WRITE !,"Cannot open connection"
      QUIT }
     ELSE { WRITE !,"Client connection opened" }
     USE io READ x#3:200  ; Reads from subjob
     IF x="" {
        USE 0
        WRITE !,"No message from child"
        CLOSE io
        QUIT }
     ELSE { 
        USE 0
        WRITE !,"Child is on job ",x
        CLOSE io
        QUIT }

子ジョブは、継承した TCP 接続を使用して、ジョブ ID (この場合は 3 文字とします) をクライアントに渡します。その後、子プロセスは終了します。クライアントは、サーバとの接続を開き、その状態で子のジョブ ID を読み取ります。この例では、変数 "host" の IPv4 の値 "127.0.0.1" がローカル・ホスト・マシンへのループバック接続を示しています (対応する IPv6 ループバックの値は "0:0:0:0:0:0:0:1" または "::1" です)。"host" にそのサーバの IP アドレス、または名前が設定される場合は、そのサーバからクライアントを別のマシンにセットアップすることもできます。IPv4 および IPv6 の形式に関する詳細は、"Caché プログラミング入門ガイド" の “サーバ構成オプション” の章にある “IPv6 アドレスの使用” のセクションを参照してください。

原則では、子プロセスとクライアントは広範囲の通信を実行できます。複数のクライアントが同時に対応するサーバの子と通信できます。

子プロセスのパーティション・サイズを指定する

バックグラウンド・ジョブのパーティション・サイズ ($ZSTORAGE size) は、以下のように決定されます。

• ジョブ・サーバがアクティブな場合、すべてのジョブ・サーバ・プロセスについて、ジョブ・パーティション・サイズは常に 262144 (キロバイト単位) になります。

• ジョブ・サーバが非アクティブの場合、ジョブ・パーティション・サイズは、非バックグラウンド・ジョブの既定のパーティション・サイズ (bbsiz) に既定で設定されます。これは、JOB を発行する親プロセスのパーティション・サイズに関わらず、JOB を実行した際に有効になるシステム全体の既定です。

  ジョブ・サーバが有効化されているが、それらのすべてがアクティブであり、ユーザが新しいジョブを開始した場合、そのジョブ・プロセスはジョブ・サーバ・プロセスにならないため、その $ZSTORAGE 値は bbsiz に既定で設定されます。これはジョブ・サーバがアクティブの場合にも当てはまりますが、ジョブのロードがジョブ・サーバ以外のプロセスで実行されるためです。

• ジョブ・サーバが非アクティブの場合、JOB 文でジョブ起動子プロセスのパーティション・サイズを指定できます。ジョブ起動プロセスのパーティション・サイズ (キロバイト単位) は、JOB コマンドの第 2 プロセス・パラメータで指定します。例えば、JOB ^myroutine:(:8192) のように指定します。 指定する値は、32 の倍数で、範囲は、128 ～ 16384 です。また、既定のパーティション・サイズを超える値は指定できません。これは、既定未満の値を指定する目的でのみ使用できます。

  オプションで、通常 JOB の第 2 プロセス・パラメータに入れる他のプロセス情報と組み合わせて、パーティション・サイズのプロセス・パラメータの値を指定することもできます。JOB コマンド JOB ^myroutine:(:544+1) について考えてみましょう。このコマンドは、ジョブを実行しているプロセスのシンボル・テーブルをジョブ起動プロセスに渡すこと、また、ジョブ起動プロセスのパーティション・サイズを 544 K にすることを指定しています。この第 2 パラメータで、2 つの値 (544 と 1) を 545 として渡すように指定することもできますが、544+1 とした方が分かりやすく、まったく同じ効果が得られます。

ジョブ自体が SET $ZSTORAGE を使用してプログラマチックに独自のパーティション・サイズを設定できることに注意してください。