Vitis IDE プロジェクトの作成

Vitis IDE では、新しいアプリケーション プロジェクトやプラットフォーム開発プロジェクトを作成できます。このセクションでは、ワークスペースをセットアップし、新しい Vitis プロジェクトを作成して、IDE の主要な機能を使用する方法を説明します。

注記: プラットフォーム プロジェクトの作成に関する詳細は、エンベデッド プロセッサ プラットフォーム開発 を参照してください。

Vitis IDE ワークスペースの起動

  1. 次コマンド ラインを使用して Vitis IDE を直接起動します。
    $vitis
    重要: 新しいターゲット プラットフォームを開いて Vitis コア開発キットのコマンドを入力する際は、Vitis 環境の設定 で説明するように設定してください。

    Vitis IDE が開きます。

  2. 次の図に示すようにワークスペースを選択します。

    ワークスペースは、プロジェクト、ソース ファイル、IDE での処理結果を含むフォルダーです。プロジェクトごとに個別のワークスペースを定義したり、複数のプロジェクトおよびタイプに 1 つのワークスペース使用したりできます。Vitis IDE プロジェクトのワークスペースを定義するには、次の手順に従います。

  3. Browse をクリックしてワークスペースを指定するか、[Workspace] フィールドに適切なパスを入力します。
  4. Use this as the default and do not ask again をオンにすると、指定したワークスペースがデフォルトになり、今後このダイアログ ボックスは表示されなくなります。
  5. Launch をクリックします。
    ヒント: Vitis IDE 内から現在のワークスペースを変更するには、File > Switch Workspace をクリックします。

これでワークスペースが作成されたので、プロジェクトを含めます。

アプリケーション プロジェクトの作成

ヒント: サンプル デザインは、Vitis コア開発キットのインストールに含まれますが、ザイリンクス GitHub リポジトリからもダウンロードできます。詳細は、サンプル デザインの概要 を参照してください。

Vitis IDE を起動したら、新規アプリケーション プロジェクトを作成できます。

  1. File > New > Vitis Application Project をクリックするか、これが最初に Vitis IDE を起動した場合であれば、ウェルカム画面で Create Application Project をクリックします。

    New Vitis Project ウィザードが開きます。

  2. [Create a New Vitis Application Project] ページの [Project name] フィールドにプロジェクト名を指定します。

  3. Use default location がデフォルトでオンになっており、プロジェクトはワークスペースのフォルダーに保存されます。このオプションをオフにするにすると、プロジェクトが選択したディレクトリに作成されます。
  4. ディレクトリを指定すると、Choose file system でデフォルトのファイル システム (JSch) を選択したり、Eclipse Remote File System Explorer (RSE) をイネーブルにできます。
    重要: プロジェクトのディレクトリとして Vitis IDE ワークスペースの親フォルダーを指定することはできません。
  5. Next をクリックして [Platform] ダイアログ ボックスを開いて、Vitis ターゲット プラットフォームを指定します。

    ターゲット プラットフォームには、ベース ハードウェア デザインと、宣言されたインターフェイスにアクセラレータを接続するのに使用されたメタデータが含まれます。Vitis コア ツールの特定リリースでサポートされるターゲット プラットフォームについては、Vitis 2019.2 ソフトウェア プラットフォーム リリース ノート を参照してください。

    カスタム定義またはサードパーティのプラットフォームもリポジトリに追加できます。詳細は、プラットフォームおよびリポジトリの管理 を参照してください。

  6. ターゲット プラットフォームを選択して Next をクリックします。
  7. [Platform] ダイアログ ボックスの [Flow] 列に表示されるように Embedded ターゲット プラットフォームを選択すると、次のような [Domain] ページが開きます。Domain を選択し、選択したプラットフォームの Sysroot パスをオプションで指定します。
    • [Domain] では、ターゲット プラットフォームでホスト プログラムを実行するのに使用されるプロセッサ ドメインを定義します。
    • sysroot は、基本システム ルート ファイル構造を定義するプラットフォームの一部です。[Sysroot path] では、アプリケーションの新しい sysroot を定義できます。


  8. Next をクリックすると、次の図に示すような [Templates] ページが表示されます。新規プロジェクトのアプリケーション テンプレートをクリックします。

  9. Empty Application を選択すると、空のプロジェクトが作成され、ファイルをインポートして、最初からプロジェクトを作成できます。ベクター加算 (Vector Addition) テンプレート プロジェクトは、Vitis IDE について学ぶ例として使用できるほか、新規アプリケーション プロジェクトの基盤としても使用できます。
    ヒント: 最初は、[Template] ページには [Empty Application] と [Vector Addition] のみがリストされます。その他の Vitis IDE の例は、サンプル デザインの概要 に示すように、Vitis IDE Examples ボタンをクリックしてその他の例をインストールすると取得できます。
  10. Finish をクリックし、New Vitis Project ウィザードを閉じてプロジェクトを開きます。

プラットフォームおよびリポジトリの管理

Vitis IDE プロジェクトで使用可能なプラットフォームは、開いているプロジェクトのメイン メニューから Xilinx > Add Custom Platform をクリックするか、アプリケーション プロジェクトの作成 に示す [Platform] ダイアログ ボックスから管理できます。このダイアログ ボックスからは、新しいプラットフォームまたは新しいプラットフォーム リポジトリを追加できます。

[Platform] ダイアログ ボックスからは、次のオプションのいずれかを使用して使用可能なプラットフォームおよびプラットフォーム リポジトリを管理します。

[Add Custom Platform] ()
ユーザーのプラットフォームを使用可能なプラットフォームのリストに追加します。新しいプラットフォームを追加するには、カスタム プラットフォームの最上位ディレクトリを選択して、OK をクリックします。カスタム プラットフォームは、すぐに使用可能なプラットフォームのリストから選択できるようになります。
[Manage Platform Repositories] ()
標準プラットフォームとカスタム プラットフォームを追加または削除します。カスタム プラットフォームを追加すると、その新しいプラットフォームへのパスがリポジトリに自動的に追加されます。プラットフォームがリポジトリのリストから削除されると、使用可能なプラットフォームのリストには表示されなくなります。
[Add Devices/Platforms] ()
標準ソフトウェア インストールに含まれるザイリンクス デバイスおよびプラットフォームを管理します。インストール時にデバイスまたはプラットフォームを選択しなかった場合、このオプションを使用して後から追加できます。クリックすると、Vitis インストーラーが起動し、追加するデバイスまたはプラットフォームを選択できます。ツールにカスタム プラットフォームを直接追加するには、Help > Add Devices/Platforms をクリックします。

Vitis IDE の理解

Vitis IDE でプロジェクトを開くと、ワークスペースにビューおよびエディターが特定の配置 (Eclipse ベースのIDE ではパースペクティブと呼ばれる) で表示されます。次の図に示すデフォルト パースペクティブが開きます。

1: Vitis IDE - デフォルト パースペクティブ

デフォルト パースペクティブには、次のビューおよびエディターが含まれます。

Explorer ビュー
プロジェクト フォルダーおよびソース ファイル、ビルド ファイル、ツールで生成されるレポートをツリー ビューで表示します。この表示を使用して、プロジェクト ファイル階層を確認します。
Assistant ビュー
ワークスペースのプロジェクトおよびプロジェクトのビルドと実行設定を表示して管理できます。さまざまなプロジェクト設定および異なる設定のレポートを管理できます。この表示からは、Vitis アナライザーの使用 に示すように、Vitis IDE アプリケーション プロジェクトをビルドして実行し、Vitis アナライザーを起動して、レポートおよびパフォーマンス データを確認できます。
Project Editor ビュー
現在のプロジェクト、ターゲット プラットフォーム、アクティブなビルド コンフィギュレーション、および指定したハードウェア関数を表示して、プロジェクト設定を直接編集できます。
Console ビュー
コマンド コンソール、デザインのガイダンス、プロジェクト プロパティ、ログ、ターミナル ビューなどの複数のビューを表示します。

Vitis IDE には、[Vitis IDE] パースペクティブ、[Debug] パースペクティブ、および [Performance Analysis] パースペクティブなどの定義済みのパースペクティブが複数含まれます。パースペクティブ間は、Vitis IDE 右上でパースペクティブ名をクリックするとすばやく切り替えることができます。

ビューは IDE 内でドラッグ アンド ドロップして並べ替えることができます。この並べ替えたビューは現在のパースペクティブで保存されます。ウィンドウは、そのタブの Close (X) をクリックすると閉じることができます。新しいウィンドウは、Window > Show View をクリックしてビューを選択すると開きます。

ビューのデフォルトの配置を復元するには、Window > Reset Perspective をクリックしてそのパースペクティブをアクティブにします。

別のパースペクティブを開くには、Window > Open Perspective をクリックします。

ソースの追加

プロジェクトには、C/C++ ファイルおよびヘッダー、OpenCL ファイルおよびヘッダー、RTL カーネル (RTL カーネル を参照) または HLS カーネル (Vivado HLS でのカーネルのコンパイル を参照) を含むコンパイル済みのザイリンクス オブジェクト ファイル (.xo) が含まれます。

ソース ファイルの追加

  1. プロジェクトソース ファイルを追加するには、Vitis IDE でプロジェクトを開き、[Project Explorer] で src フォルダーを右クリックして Import Sources をクリックします。

    次の図に示す [Import Sources] ダイアログ ボックスが表示されます。



  2. このダイアログ ボックスの [From directory] フィールドの Browse をクリックして、ソースをインポートするディレクトリを選択します。
  3. [To directory] フィールドでは、指定したフォルダーがアプリケーション プロジェクトの src フォルダーになるようにします。
  4. 追加するソースファイルを選択し、Finish をクリックします。
  5. ファイル名の横のチェック ボックスをオンにしてソース ファイルを選択したら、Finish をクリックします。
    重要: ソース ファイルをワークスペースにインポートすると、ファイルがワークスペースにコピーされます。ワークスペースを削除すると、ファイルへの変更はすべて失われます。

ソース ファイルをプロジェクトに追加したら、アプリケーションをコンフィギュレーション、ビルド、実行できます。ビルトイン テキスト エディターでソース ファイルを開くには、[Project Explorer] ビューで src フォルダーを展開し、そのファイルをダブルクリックします。

新規ソース ファイルの作成および編集

ソース ファイルは Vitis IDE で直接新しく作成したり、編集することもできます。

  1. 開いているプロジェクトの src フォルダーを右クリックし、New > File をクリックします。

    次の図に示す [New File] ダイアログ ボックスが表示されます。

  2. 新規ファイルを作成するフォルダーを選択してファイル名を入力します。
  3. Finish をクリックすると、ファイルがプロジェクトに追加されます。

ソース ファイルをプロジェクトに追加したら、アプリケーションをコンフィギュレーション、ビルド、実行できます。ビルトイン テキスト エディターでソース ファイルを開くには、[Project Explorer] ビューで src フォルダーを展開し、そのファイルをダブルクリックします。

[Project Editor] ビューの使用

システムのビルドでは、ホスト プログラムと FPGA バイナリ (xclbin) の両方をコンパイルしてリンクする必要があります。ユーザーの定義したアプリケーション プロジェクトは、インポートされたり、プロジェクト内で作成されるので、src フォルダーにホストおよびカーネル コードの両方が含まれます。[Project Editor] ビューには、次の図に示すように、プロジェクトの最上位表示とさまざまなビルド コンフィギュレーションが表示されます。含まれる内容は、次のとおりです。

  • プロジェクトに関する一般的な情報
  • ターゲット プラットフォーム
  • アクティブなビルド コンフィギュレーション
  • そのビルド コンフィギュレーションに関する複数のコンフィギュレーション オプション

    これらには、ホスト プログラムまたはカーネル コードのデバッグ機能を有効にするデバッグ オプション、および レポート生成の制御 に説明されるようなビルドのレポート レベルを選択するメニューが含まれます。

2: [Project Editor] ビュー

[Project Editor] ビューの下部には、バイナリ コンテナーに割り当てられて、xclbin 内に含まれるカーネルを示す [Hardware Functions] ウィンドウが表示されます。カーネルをバイナリ コンテナーを追加するには、ウィンドウ右上の Add Hardware Function ボタン () をクリックします。プロジェクトで定義されているカーネルのリストが表示されます。次の図に示すように、[Add Hardware Functions] ダイアログ ボックスでカーネルを選択します。

3: バイナリ コンテナーへのハードウェア関数の追加

カーネルを追加すると、複数のカーネル インスタンスの作成 に示すように、[Hardware Functions] ウィンドウの [Compute Units] の下に値を入力して、カーネルの複数インスタンスがインスタンシエートされるようにします。

[Assistant] ビューの使用

[Assistant] ビューには、ビルド コンフィを管理し、コンフィギュレーションを実行し、これらのコンフィギュレーションの属性を設定するプロジェクト ツリーが含まれます。このビューは [Project Explorer] ビューと連動し、デフォルトの Vitis IDE パースペクティブのビューの下に直接表示されます。次は、[Assistant] ビューとそのツリー構造の例です。

4: [Assistant] ビューのツリー構造例

[Assistant] ビューの階層には、最上位システム プロジェクト、アプリケーション プロジェクト、ソフトウェアおよびハードウェア エミュレーションのビルド コンフィギュレーション、システム ハードウェアのビルド コンフィギュレーションなどのオブジェクトが表示されます。

ビルド コンフィギュレーションは、ビルド ターゲット に説明するように、ビルド ターゲットを定義して、ビルド プロセスのオプションを指定します。[Emulation-HW] ビルドなどのビルド コンフィギュレーションを選択してSettings アイコン () をクリックすると、Vitis ビルド コンィギュレーション設定のダイアログ ボックスが開きます。この [Settings] ダイアログ ボックスでは、特定のエミュレーションまたはハードウェア ターゲットのビルド プロセスを設定できます。

ヒント: [Settings] ダイアログ ボックスは、コンフィギュレーション オブジェクトをダブルクリックしても開きます。

各ビルド コンフィギュレーションの階層内には、バイナリ コンテナー (または .xclbin)、ハードウェア関数またはバイナリ コンテナーの関数、run コンフィギュレーション、およびビルドや実行プロセスで生成されたレポートまたはサマリなどが含まれます。特定のビルド コンフィギュレーションのハードウェア関数を選択して Settings アイコンをクリックすると、Vitis のハードウェア関数設定のダイアログ ボックスが表示されます。この [Hardware Function Settings] ダイアログ ボックスを使用して、各カーネルの計算ユニット数を指定し、計算ユニットを SLR へ割り当て、カーネル ポートをグローバル メモリに割り当てます。

run コンフィギュレーションは、コンパイルおよびリンク済みのアプリケーションを実行されるプロファイルで、アプリケーションを実行する環境およびオプションを定義します。ビルド コンフィギュレーションを選択して右クリックして Run > Run Configurations をクリックし、Vitis の run コンィギュレーション設定のダイアログ ボックスを開いて run を設定します。

5: [Assistant] ビューの [View] メニュー

[Assistant] ビューの [View] メニューには、[Assistant] ビューの表示に関するオプションが含まれますが、これらのオプションはプロジェクト データには影響しません。下向き矢印のアイコンをクリックして [View] メニューを開くと、次のオプションが表示されます。

Show Active Build Configurations Only
オンにすると、[Assistant] ビューには各プロジェクトのアクティブなビルド コンフィギュレーションのみが表示されます。このオプションは、[Assistant] ビューのデータ量を削減するために使用します。[Project Editor] ビューの [Application Project Settings] タブの Active build configuration をクリックします。
Link with Console
オンにすると、[Console] ビューのビルド コンフィギュレーションが [Assistant] ビューで現在選択されているビルド コンフィギュレーションと同じになるように自動的に切り替わります。オフにすると、自動的には変更されません。
Link with Guidance
オンにすると、[Console] ビューの [Guidance] タブが [Assistant] ビューのビューで現在選択されているものと同じになるように自動的に切り替わります。

ビルドおよび実行プロセス中には、ビルド コンフィギュレーションごとにレポートが生成され、次のように [Assistant] ビューに表示されます。レポートを右クリックして Open in Vitis Analyzer をクリックして、Vitis アナライザーの使用 で説明するように結果を確認します。

6: Vitis アナライザーの開始