04 ライセンス

原則として、ライセンスはイメージに含めない。コンテナの起動側が実行時に注入する。

4 種類の指定方式

VVD_LICENSE (または --license) の値によって決まる。

いずれの場合も XILINXD_LICENSE_FILE がコンテナ内に設定される。

解決順序

VVD_LICENSE が未設定の場合、次の順序で自動的に探索する。

1. ホストの XILINXD_LICENSE_FILE 環境変数
2. ~/.Xilinx/Xilinx.lic
3. なし (none)

加えて ~/.Xilinx (または VVD_XILINX_DOTDIR) が存在する場合、コンテナの $HOME/.Xilinx に read-only で mount される。このディレクトリには、インストール済み ライセンスのメタデータやツール設定が格納されている。

方式の選択

浮動ライセンス (推奨) ファイルがコンテナに渡らないため最も安全である。ライセンスサーバへ TCP で到達できる ことが条件となる。コンテナは既定でホストのネットワークを共有しないため、社内 VPN 経由のライセンスサーバに到達できない場合は VVD_NETWORK=host を検討する。

# vvd.local.conf
VVD_LICENSE=2100@license.example.com

ノードロック オフライン環境および個人ライセンス向けである。read-only mount のため、コンテナ内から 変更されることはない。

VVD_LICENSE=/home/me/.Xilinx/Xilinx.lic

CI シークレットからファイルを書き出すか、ライセンスサーバのアドレスを変数で渡す。 ファイルを書き出す場合は、ジョブ終了時に確実に削除する。

- name: Write the license
  run: |
    umask 077
    printf '%s' "$" > "$RUNNER_TEMP/Xilinx.lic"
- name: Build
  env:
    VVD_LICENSE: $/Xilinx.lic
  run: vvd flow
- name: Shred the license
  if: always()
  run: rm -f "$RUNNER_TEMP/Xilinx.lic"

確認する

vvd doctor

• サーバ形式の場合は、ホストからポートに到達できるかを実際に試行する
• ファイル形式の場合は、読み取り可能かを確認する

vvd selftest --stage license   # コンテナ内から到達できるかを確認する
vvd selftest --stage synth     # 実際に合成が成功するかを確認する

license ステージが検査するのは到達性のみである。ライセンスが機能していることの 最終的な確認は、小規模な設計を実際に合成できることであり、これを行うのが synth ステージである。

漏洩防止

• docker/Dockerfile の最終ステップで *.lic を探し、見つかればビルドを失敗させる
• .dockerignore が **/*.lic と vvd.local.conf をビルドコンテキストから除外する
• .gitignore が vvd.local.conf をコミット対象から除外する
• CI がビルドしたイメージに対して改めて .lic の有無を検査する (.github/workflows/ci.yml)

よくあるエラー