目次

トランスポート
コネクタ
VM起動オプション
JDBとの接続
サービス・プロバイダ・インタフェース

トランスポート

Javaプラットフォーム・デバッガ・アーキテクチャ(JPDA) 「輸送」は、デバッガと(「ターゲットのVM」)をデバッグする仮想マシンの間の通信メソッドです。 通信は接続指向です。一方の側はサーバーとして機能し、接続をリスニングします。もう一方の側はクライアントとして機能し、サーバーに接続します。 JPDAでは、デバッガ・アプリケーションまたはターゲットVMのどちらかをサーバーとして動作させることができます。 トランスポートを実装することによって、単一のコンピュータまたは別のコンピュータ、あるいはその両方で動作中のプロセス間で通信できるようになります。 接続を確立する場合、「移送アドレス」を使用して接続のエンドポイントを識別します。 トランスポート・アドレスの形式は、トランスポートのタイプに依存します。

JPDA内では、デバッガ・アプリケーションはJavaデバッグ・インタフェースの(JDI)インタフェースとConnector抽象化を使用して、ターゲットVMへの接続を確立します。 「コネクタ」の項を参照してください。 デバッガ・アプリケーションで使用されるConnectorは、トランスポートをカプセル化します。 ターゲットVMでは、Java Debug Wire Protocolをサポートするエージェントを使用してデバッガと通信します。 このエージェント(ターゲットVMに組み込むか、実行時ライブラリからロード可能)は、デバッガと通信するためにトランスポートをカプセル化します。

2つのトランスポート実装がリファレンス実装に付属しています: TCP/IPおよび共有メモリー・トランスポートに基づくソケット・トランスポート。 仕様では、特定のトランスポートの実装を必要としません。 アーキテクチャには、実装で提供されるトランスポートに加えて、追加のトランスポートを開発およびデプロイできるようにするサービス・プロバイダ・インタフェースが含まれています。 「サービス・プロバイダ・インタフェース」の項を参照してください。

ソケット・トランスポート

JPDAリファレンス実装は、Linux、macOSおよびMicrosoft Windowsプラットフォーム用のソケット・トランスポートを提供します。 ソケット・トランスポートを使用する場合は、デバッガ・アプリケーションとターゲットVMは、同じコンピュータ上に存在していても、異なるコンピュータ上に存在していてもかまいません。 ソケット・トランスポートでは、デバッガ・アプリケーションとターゲットVMの間でシングル・ストリームのTCP/IP接続が使用されます。 IPv4とIPv6の両方が、JDI側およびターゲットのVM側のソケット・トランスポートでサポートされています。

コマンドと応答パケットは、JDWPトランスポート・インタフェースを使用して、JDWP仕様に従ってストリームに書き込まれます。 JDWP経由で多数の小規模なパケットを送信できるため、TCP_NO_DELAYソケット・オプションは、ソケット実装が小さなパケットを送信する前にバッファリングした場合に発生する遅延を回避することで、一部のソケット実装のパフォーマンスを向上させることができます。 可能な場合は未送信のデータが送信されるように、ソケットは適切に閉じられます。

ソケット・トランスポートは、dt_socketという一意の文字列で識別されます。 この名前は、ターゲットVMを呼び出すときに、ソケット・トランスポートを選択するために使用できます。 「VM起動オプション」の項を参照してください。 デバッガ・アプリケーション内では、ソケット・トランスポートをカプセル化する対応するConnectorが使用されます。

ソケット転送アドレスの形式は<host>:<port>で、<host>はホスト名またはIPアドレス(大カッコで囲むことができます)、<port>はアタッチまたはリスニングするソケット・ポート番号です。 <host>が空の場合は、ローカル・ループバック・アドレスが使用されます。 サーバーがクライアントの連結を待機しているコンテキストで<host>と"*"が等しい場合、サーバーはすべてのネットワーク・インタフェースでリスニングします。

共用メモリー・トランスポート

JPDAリファレンス実装では、ソケット・トランスポートに加えて、Windowsで共有メモリー・トランスポートを提供します。 共用メモリー・トランスポートでは、デバッガ・アプリケーションとターゲットVMの間のJDWPパケット交換に共用メモリー領域が使用されます。 共用メモリー・トランスポートを使用する場合は、デバッガ・アプリケーションとターゲットVMは同じコンピュータ上に存在しなければなりません。

共用メモリー・トランスポートは、dt_shmemという一意の文字列で識別されます。 この名前は、ターゲットVMを呼び出すときに、ソケット・トランスポートを選択するために使用できます。 「VM起動オプション」の項を参照してください。 デバッガ・アプリケーション内では、共有メモリー・トランスポートをカプセル化する対応するConnectorが使用されます。

共有メモリー・トランスポート・アドレスは、Windowsファイル・マッピング・オブジェクト名として使用できる名前です。 この名前の文字列には、バックスラッシュを除く任意の文字を含めることができます。

コネクタ

コネクタとは、デバッガ・アプリケーション(JDIを対象にして作成されたもの)とターゲットVMの間の接続を確立するときに使用されるJDIの抽象化のことです。 JDIおよびコネクタはさまざまな組み合わせで実装できるため、各JDIでサポートされているトランスポートおよびVMと一致させることができます。 コネクタ・インタフェースは非常に一般的であり、様々なコネクタ実装でJDIを使用できます。 コネクタは、名前と値のペアのセットを使用して構成されます。 特定のコネクタには、異なる名前と値のペアを使用できます。

適切なJDIクライアント・アプリケーションを使用すると、ユーザーは存在する可能性のあるコネクタを選択して構成できますが、特定のコネクタに関する知識をデバッガに組み込んで、構成をより快適なユーザー・エクスペリエンスにすることができます。 JPDAで提供されているJDBの実装例では、この方法が採用されています。 「JDBとの接続」の項を参照してください。

JDIリファレンス実装には、使用可能なトランスポート・タイプおよび接続モード(起動、リスニングおよびアタッチ)にマップする複数のコネクタが用意されています。 それらのコネクタについて、このあとのセクションで説明します。 これらのコネクタを含むListは、JDIメソッドVirtualMachineManager.allConnectors()によって返されます。 また、各アタッチ、リスニングおよび起動コネクタは、対応するVirtualMachineManagerメソッドattachingConnectors()、listeningConnectors()およびlaunchingConnectors()によって返されるリストに含まれています。

コマンドライン起動コネクタ

デバッガ・アプリケーションは、このコネクタを使用して、「VM起動オプション」のセクションで説明したのと同じ呼び出しデバッグ・オプションをサポートする任意のVMを起動できます。 VMの起動および必要なデバッグ・オプションの指定の詳細は、コネクタによって制御されます。 このコネクタで使用される背後のトランスポートは、プラットフォームに依存しています。 Windowsでは、共有メモリー・トランスポートが使用されます。 LinuxおよびmacOSでは、ソケット・トランスポートが使用されます。

このコネクタは、com.sun.jdi.CommandLineLaunchという名前で一意に識別されます。

RAWコマンドライン起動コネクタ

デバッガ・アプリケーションは、このコネクタを使用して任意のVMを起動できます。 コマンド行全体を指定する必要があり、いかなる方法でも編集されません。 指定したコマンド行でVMを起動する際の詳細は、コネクタによって制御されます。 このコネクタで使用される背後のトランスポートは、プラットフォームに依存しています。 Windowsでは、共有メモリー・トランスポートが使用されます。 LinuxおよびmacOSでは、ソケット・トランスポートが使用されます。

このコネクタは、com.sun.jdi.RawCommandLineLaunchという名前で一意に識別されます。

ソケット接続コネクタ

このコネクタは、現在動作中のターゲットVMにソケット・トランスポートを介して接続するときに、デバッガ・アプリケーションから使用できます。 このターゲットVMは、次の表で説明するこのコネクタの引数と対応するオプションで呼び出されたものである必要があります。 「VM起動オプション」の項では、必要なオプションについて説明します。

このコネクタは、com.sun.jdi.SocketAttachという名前で一意に識別されます。

共用メモリー接続コネクタ

このコネクタは、共用メモリー・トランスポートを介して現在実行中のターゲットVMに接続するときに、デバッガ・アプリケーションから使用できます。 Windowsでのみ使用できます。 このターゲットVMは、次の表で説明するこのコネクタの引数と対応するオプションで呼び出されたものである必要があります。 「VM起動オプション」の項では、必要なオプションについて説明します。

このコネクタは、com.sun.jdi.SharedMemoryAttachという名前で一意に識別されます。

ソケット待機コネクタ

このコネクタはデバッガ・アプリケーションで使用して、ソケット・トランスポートを介して個別に起動されたターゲットVMから接続を受け入れることができます。 このターゲットVMは、次の表で説明するこのコネクタの引数と対応するオプションで呼び出されたものである必要があります。 「VM起動オプション」の項では、必要なオプションについて説明します。

このコネクタでは、複数のターゲットVMからの接続を受け入れることができます。

このコネクタは、com.sun.jdi.SocketListenという名前で一意に識別されます。

共用メモリー待機コネクタ

このコネクタは、共用メモリー・トランスポートを介して個別に呼び出されたターゲットVMからの接続を受け入れるときに、デバッガ・アプリケーションから使用できます。 Windowsでのみ使用できます。 ターゲットVMは、次の表で説明するこのコネクタ引数と一致するオプションを使用して呼び出す必要があります。 「VM起動オプション」の項では、必要なオプションについて説明します。

このコネクタでは、複数のターゲットVMからの接続を受け入れることができます。

このコネクタは、com.sun.jdi.SharedMemoryListenという名前で一意に識別されます。

プロセス接続コネクタ

このコネクタは、デバッガ・アプリケーションで使用して、「VM起動オプション」の項で説明されているserver=yデバッグ・サブオプションで起動された現在実行中のターゲットVMにアタッチできます。 このターゲットVMは、Java SE 6以降である必要があります。

プロセス接続コネクタにトランスポートが関連付けられていません。 その代わりに、実際に接続されると、トランスポートが動的に決定されます。 このため、このコネクタのtransport().name()メソッドはlocalを返します。

このコネクタはcom.sun.jdi.ProcessAttachという名前で一意に識別されます。

VM起動オプション

このセクションでは、デバッグのためにVMを呼び出すために必要なオプションについて説明します。

Oracle VMの実装では、デバッグのためにJDWPエージェントをロードするためにコマンド行オプションが必要です。 JDWPエージェントをロードしたり、そのオプションを指定したりするために-agentlib:jdwpオプションが使用されます。

-agentlib:jdwpオプションは、次のように指定されます。

-agentlib:jdwp=<suboptions>

JDWPのJPDAリファレンス実装をロードする。 このライブラリはターゲットVMに存在し、Java Virtual Machineツール・インタフェース(JVM TI)およびJava Native Interface (JNI)を使用して対話します。 別のデバッガ・アプリケーションと通信するときは、トランスポートとJDWPプロトコルが使用される。 セクション「-agentlib:jdwpおよび-Xrunjdwpサブオプション」では、特定のサブオプションについて説明します。

-agentlib:jdwpおよび-Xrunjdwpサブオプション

-agentlib:jdwpおよび-Xrunjdwpオプションは、さらにサブオプションで修飾できます。 サブオプションは次のように指定されます:

    -agentlib:jdwp=<name1>[=<value1>],<name2>[=<value2>]...

or

    -Xrunjdwp:<name1>[=<value1>],<name2>[=<value2>]...

次の表では、使用可能なオプションについて説明します。

例

-agentlib:jdwp=transport=dt_socket,server=y,address=8000

ループバック・アドレスのみでポート8000のソケット接続をリスニングします。 メイン・クラスが(デフォルトではsuspend=y)をロードする前に、このVMを一時停止します。 デバッガ・アプリケーションが接続されたあと、そのアプリケーションがJDWPコマンドを送信してVMを再開する。

-agentlib:jdwp=transport=dt_socket,server=y,address=*:8000,allow=192.168.1.0/24+::1,timeout=5000

すべてのネットワーク・インタフェースでポート8000のソケット接続をリスニングします。 192.168.1.00アドレスからのみデバッガの接続を許可 - IPv6アドレス(::1)による192.168.1.255およびローカル・マシンから。 デバッガが5秒以内に接続しない場合は終了する。 メイン・クラスが(デフォルトではsuspend=y)をロードする前に、このVMを一時停止します。 デバッガ・アプリケーションが接続されたあと、そのアプリケーションがJDWPコマンドを送信してVMを再開する。

-agentlib:jdwp=transport=dt_shmem,server=y,suspend=n

使用可能な共用メモリー・トランスポートのアドレスを選択して、標準出力に出力する。 そのアドレスで共用メモリー接続を待機する。 デバッガ・アプリケーションが接続される前に、VMは実行を開始する。

-agentlib:jdwp=transport=dt_socket,address=myhost:8000

ポート8000でホストmyhostのソケットを介して、実行中のデバッガ・アプリケーションにアタッチしてください。 メイン・クラスがロードされる前に、このVMを中断する。

-agentlib:jdwp=transport=dt_shmem,address=mysharedmemory

トランスポート・アドレスmysharedmemoryで共有メモリー経由で実行中のデバッガ・アプリケーションにアタッチします。 メイン・クラスがロードされる前に、このVMを中断する。

-agentlib:jdwp=transport=dt_socket,server=y,address=192.168.1.18:8000,allow=*,onthrow=java.io.IOException,launch=/usr/local/bin/debugstub

このVMでjava.io.IOExceptionのインスタンスがスローされるまで待機します。 VM (デフォルトではsuspend=y)を中断します。 ポート8000で、アドレス192.168.1.18でソケット接続をリスニングします。 デバッガが任意のアドレスから接続できるようにします。 「/usr/local/bin/debugstub dt_socket myhost:8000」を実行する。このプログラムによって、別のウィンドウでデバッガ・プロセスが起動されてこのVMに接続され、デバッグが開始される。

-agentlib:jdwp=transport=dt_shmem,server=y,onuncaught=y,launch=d:\bin\debugstub.exe

uncaught例外がこのVMでスローされるのを待機する。 VMを中断する。 共用メモリー・トランスポートのアドレスを選択し、そのアドレスで接続を待機する。 「d:\bin\debugstub.exe dt_shmem <address>」を実行する。<address>は、選択された共用メモリー・アドレス。 このプログラムによって、別のウィンドウでデバッガ・プロセスが起動されてこのVMに接続され、デバッグが開始される。

JDBとの接続

JPDAで提供されるJavaデバッガ(JDB)の実装例は、JDIコネクタの使用方法を示しています。 JDBには、「ショートカット」オプションがあります。このオプションでは、JDBに認識されているコネクタ(リファレンス実装に存在するコネクタ)が使用されることが前提です。 また、任意のコネクタを使用して一般的な接続を確立することもできます。 JDBは最良のデバッガ・インタフェースの例ではありませんが、コネクタの簡単な使用例として参照できます。

JDBでは、-attachオプションにより、リファレンス実装(Windows上の共有メモリー、LinuxおよびmacOS上のソケット)のいずれかのアタッチ・コネクタにアクセスできます。 -listenオプションを使用すると、リファレンス実装(Windows上の共有メモリー、LinuxおよびmacOS上のソケット)のいずれかのリスニング・コネクタにアクセスできます。 コマンド行にクラス名と引数を直接指定すると、コマンド行起動コネクタにアクセスできます。

たとえば:

jdb -attach myhost:8000

は、ソケット・アタッチ・コネクタ (macOS上のLinux)を使用してターゲットVMに簡単にアタッチする方法です

jdb Hello 1 2 3

コマンドライン起動コネクタを使用してターゲットVMを起動する簡単な方法です。

ただし、-connectオプションは、コネクタ名と任意の名前と値の引数ペアのセットを取得して、任意のコネクタを処理するためにJDBによって提供されます。 たとえば、前のコマンド行行の意味は次のとおりです:

jdb -connect com.sun.jdi.SocketAttach:hostname=myhost,port=8000
jdb -connect "com.sun.jdi.CommandLineLaunch:main=Hello 1 2 3"

これらのコマンド行は上記よりも扱いにくいですが、-connectオプションは任意のコネクタで使用できます。 これらの操作から、JDIデバッガでは、任意のコネクタを使用できることがわかります。また、よく使われるコネクタを使用するための簡単なインタフェースも提供されています。

サービス・プロバイダ・インタフェース

JPDAに含まれているサービス・プロバイダ・インタフェースを使うと、コネクタやトランスポートの実装を開発および配置できます。 これらのサービス・プロバイダ・インタフェースにより、デバッガや他のツール・ベンダーで新しいコネクタ実装を開発し、Oracleが提供するソケットおよび共用メモリー・トランスポートを超える別のトランスポート・メカニズムを提供できます。 JDIのサービス・プロバイダ・インタフェースは、 com.sun.jdi.connect.spiパッケージで指定されます。

JDIのサービス・プロバイダ・インタフェースに加えて、Oracle実装には「Java Debug Wire Protocol転送インタフェース」と呼ばれるトランスポート・ライブラリ・インタフェースも含まれています。 トランスポート・ライブラリは、ターゲットVMのJDWPエージェントによってロードされ、デバッガとの接続の確立、およびデバッガとVM間のJDWPパケットのトランスポートに使用されます。

詳細については、「Javaプラットフォーム・デバッガ・アーキテクチャ - サービス・プロバイダ・インタフェース」を参照してください。