export_simulation - 2023.2 日本語

ターゲットシミュレータのシミュレーションスクリプトをエクスポートします。生成されるスクリプトには、デザインをコンパイル、エラボレート、およびシミュレーションするシミュレータコマンドが含まれます。

このコマンドは、指定したオブジェクトのシミュレーションコンパイル順を取得して、この情報をコンパイラコマンドとターゲットシミュレータのデフォルトオプションを使用してシェルスクリプトにエクスポートします。オブジェクトとしては、シミュレーションファイルセットまたは IP を指定できます。Vivado IDE 外でシミュレーションを実行する場合は、スクリプトファイルの生成に launch_simulation -scripts_only ではなく export_simulation を使用できます。

export_simulation [-simulator <arg>] [-of_objects <arg>]
[-step <arg>] [-ip_user_files_dir <arg>] [-
ipstatic_source_dir <arg>]
[-lib_map_path <arg>] [-script_name <arg>]
[-directory <arg>] [-runtime <arg>] [-define <arg>]
[-generic <arg>] [-include <arg>] [-use_ip_compiled_libs]
[-absolute_path] [-export_source_files]
[-generate_hier_access] [-single_step] [-exec] [-force] [-quiet]
[-verbose][-gcc_install_path <arg>] [-more_options <arg>]

使用法

表 1. export_simulation のオプション
名前		説明
`[-simulator]`		指定したシミュレータ用のシミュレーションスクリプトを作成します。有効な値は、all、xsim、modelsim、questa、vcs、xcelium、riviera、および activehdl です。デフォルトは all です。
`[-of_objects]`		指定のオブジェクトのシミュレーションスクリプトをエクスポートします。デフォルトはありません。
`[-step]`		シミュレーションスクリプトを生成する必要のあるステップ名を指定します。デフォルトはありません。
`[-ip_user_files_dir]`		エクスポートされた IP/BD ユーザーファイル (スタティック、ダイナミックおよびデータファイル) のディレクトリパスを指定します。Manage IP プロジェクトのデフォルトパスは、ip_user_files です。デフォルトはありません。
`[-ipstatic_source_dir]`		エクスポートされた IP/BD スタティックファイルへのディレクトリパスを指定します。デフォルトはありません。
`[-lib_map_path]`		コンパイル済みのシミュレーションライブラリのディレクトリパスを指定します。指定しない場合は、生成されたスクリプトのヘッダーの手順に従い、シミュレーションライブラリのマップ情報を手動で供給してください。デフォルトはありません。
`[-gcc_install_path]`		g++/gcc 実行ファイルの GNU コンパイラインストールディレクトリへのパス。指定しない場合は、シミュレータのインストールパスの設定に基づいてツールによって検索されます。デフォルトはありません。
`[-script_name]`		出力シェルスクリプトのファイル名を指定します。指定しない場合は、デフォルトという名前のファイルが生成されます。デフォルトは top_module.sh です。
`[-directory]`		生成したシミュレーションスクリプトの保存先ディレクトリを指定します。デフォルトは export_sim です。
`[-runtime]`		シミュレーションランタイム。デフォルトでは、シミュレーションが完全に実行されるか、論理的なブレークまたは終了条件に達するまで実行されます。
`[-define]`		このオプションで指定したリストから Verilog 定義を読み出します。デフォルトはありません。
`[-generic]`		このオプションで指定したリストから VHDL ジェネリックを読み出します。デフォルトはありません。
`[-include]`		このオプションで指定したリストからインクルードディレクトリパスを読み出します。デフォルトはありません。
`[-more_options]`		指定のオプションをシミュレータツールに渡します。デフォルトはありません。
`-single_step`		シングルステップスクリプトを書き出します。Xcelium のみでサポートされます。
`[-use_ip_compiled_libs]`		コンパイル中にコンパイル済みの IP スタティックライブラリを参照します。このオプションを使用するには、コンパイル済み IP ライブラリを使用してスクリプトを生成するため、`-ip_user_files_dir` オプション `-ipstatic_source_dir` オプションも必要です。
`[-absolute_path]`		すべてのファイルパスを参照ディレクトリに対する絶対パスにします。
`[-export_source_files]`		IP/BD デザインファイルを出力ディレクトリにコピーします。
`[-generate_hier_access]`		階層アクセスシミュレーション用にパスを抽出します。
`-exec`		生成されたスクリプトを実行します。
`[-force]`		既存のファイルを上書きします。
`[-quiet]`		コマンドエラーを表示しません。
`[-verbose]`		メッセージの非表示設定を解除し、すべてのメッセージを表示します。

説明

ターゲットシミュレータのシミュレーションスクリプトファイルをエクスポートします。サポートされるシミュレータは、下のリストを参照してください。生成されるスクリプトには、デザインをコンパイル、エラボレート、およびシミュレーションするシミュレータコマンドが含まれます。

このコマンドは、指定したオブジェクトのシミュレーションコンパイル順を取得して、この情報をコンパイラコマンドとターゲットシミュレータのデフォルトオプションを使用してシェルスクリプトにエクスポートします。オブジェクトとしては、シミュレーションファイルセット、IP、または BD (ブロックデザイン) を指定できます。

オブジェクトを指定しない場合、アクティブなシミュレーション top のスクリプトが生成されます。Verilog のインクルードディレクトリまたは Verilog の define 文を含むファイルへのパスは、コンパイラコマンドラインに追加されます。

デフォルトでは、コンパイラコマンドラインのデザインソースファイルおよびインクルードディレクトリパスは、生成されるスクリプトで定義される ref_dir 変数に相対するパスとして設定されます。これらのパスを絶対パスにするには、-absolute_path オプションを使用します。

このコマンドでは、ファイルセットからのデータファイル (存在する場合) も出力ディレクトリにコピーされます。デザインに Verilog ソースが含まれる場合は、生成されるスクリプトにより glbl.v もソフトウェアインストールパスから出力ディレクトリにコピーされます。

ターゲットシミュレータ用のシミュレーションスクリプトのコンパイラコマンドで使用されるデフォルト .do ファイルが出力ディレクトリに作成されます。

注記: 生成されたスクリプトでシミュレーションを実行するには、compile_simlib Tcl コマンドを実行し、シミュレーションライブラリをコンパイルする必要があります。このスクリプトを生成する際には、コンパイル済みライブラリディレクトリパスを指定する必要があります。生成されるスクリプトでは、コンパイルライブラリディレクトリからターゲットシミュレータのセットアップファイルが自動的に含まれます。

サポートされるシミュレータ

Vivado シミュレータ (xsim)
ModelSim シミュレータ (modelsim)
Questa Advanced Simulator (questa)
Verilog Compiler Simulator (vcs)
Riviera-PRO Simulator (riviera)
Active-HDL Simulator (activehdl)
Cadence 社 Xcelium Parallel Simulator (xcelium)

引数

-of_objects

(オプション) シミュレーションスクリプトファイルを生成する必要のあるターゲットオブジェクトを指定します。ターゲットオブジェクトとしては、シミュレーションファイルセット (simset) または IP を指定できます。このオプションを使用しない場合、現在のシミュレーションファイルセットに対するファイルが生成されます。

-step

(オプション) シミュレーションスクリプトファイルを生成する必要のあるステップ名を指定します。有効な値は compile、elaborate、simulate です。指定しない場合は、スクリプトにより該当するすべてのステップが実行されます。

-ip_user_files_dir

(オプション) 生成された IP/BD ソースの抽出されたデザインファイルへのディレクトリパスを指定します。Manage IP プロジェクトのデフォルトパスは、ip_user_files です。指定しない場合、抽出されたデザインファイルは、IP.USER_FILES_DIR プロジェクトプロパティで設定したデフォルトのディレクトリパスから選択されます。

-ipstatic_source_dir

(オプション) エクスポートされた IP/BD 生成のスタティックソースファイルへのディレクトリパスを指定します。Manage IP プロジェクトのデフォルトパスは、ip_user_files/ipstatic です。指定しない場合、抽出されたデザインファイルは、SIM.IPSTATIC_SOURCE_DIR プロジェクトプロパティで設定したデフォルトのディレクトリパスから選択されます。

-lib_map_path

(オプション) 選択したシミュレータ用の AMD コンパイル済みシミュレーションライブラリへのパスを指定します。シミュレーションライブラリは、compile_simlib を使用してコンパイルします。詳細は、生成されたスクリプトのヘッダーセクションを参照してください。このオプションを指定しない場合、生成されたスクリプトでコンパイル済みシミュレーションライブラリが参照されず、スタティック IP ファイルがローカルでコンパイルされます。

-gcc_install_path

(オプション) ターゲットシミュレータの GNU 実行ファイルへのディレクトリパスを指定します。このオプションは、SystemC、C++ または C ソースを含むデザインで指定する必要があります。このオプションを指定しない場合、シミュレータのインストールパスの設定に基づいて GNU 実行ファイルへのパスが計算されます。

-script_name

(オプション) 生成されたスクリプトの名前を指定します。デフォルト名は <simulation_top>.sh です。-of_objects オプションを指定した場合、スクリプトのデフォルト構文は次のようになります。


-of_objects [current_fileset -simset] .sh
-of_objects [get_ips ] .sh
-of_objects [get_files .xci] .sh
-of_objects [get_files .bd] .sh

-absolute_path

(オプション) ソースおよびインクルードディレクトリパスを絶対パスにするよう指定します。デフォルトでは、すべてのパスは、-directory オプションで指定された出力ディレクトリに相対するパスとして設定されます。

-force

(オプション) 指定したスクリプトファイルが存在する場合に上書きします。スクリプトファイルが存在する場合に -force が指定されていないと、エラーメッセージが表示されます。

-directory

(必須) スクリプトファイルをエクスポートするディレクトリパスを指定します。

-simulator

(必須) シミュレーションスクリプトのターゲットシミュレータを指定します。有効なシミュレータ名は、xsim、modelsim、questa、vcs (または vcs_mx)、xcelium、riviera、および activehdl です。

-quiet

(オプション) コマンドをメッセージを表示せずに実行します。コマンドラインエラーは無視され、エラーメッセージは表示されません。実行中にエラーが発生してもしなくても、TCL_OK が返されます。

-verbose

(オプション) メッセージの非表示設定を一時的に解除し、コマンドからのすべてのメッセージを返します。

-generate_hier_access

(オプション) 階層アクセスシミュレーション用にパスを抽出します。

-runtime

(オプション) シミュレーション実行時間を指定します。このオプションを指定しない場合、論理的なブレークまたは終了宣言に達するまでシミュレーションが実行されます。または、<simulator>.simulate.runtime ファイルセットプロパティを使用して実行時間を指定することもできます。

-define

(オプション) デザインで使用される Verilog 定義のリストを指定します。または、verilog_defines ファイルセットプロパティを使用して定義を指定することもできます。

-generic

(オプション) デザインで使用される VHDL ジェネリックのリストを指定します。または、vhdl_generic ファイルセットプロパティを使用して指定することもできます。

-include

(オプション) デザインの Verilog インクルードファイルへのインクルードディレクトリパスのリストを指定します。または、include_dirs ファイルセットプロパティを使用して指定することも可能です。

-export_source_files

(オプション) 生成されたスクリプトのディレクトリの srcs というサブディレクトリに IP デザインファイルをコピーするよう指定します。生成されたスクリプトでは、この srcs ディレクトリからのデザインファイルを参照します。