QML ディスクキャッシュ

最適なパフォーマンスを実現するため、QMLドキュメントはビルドプロセス中に事前にコンパイルされるか、または実行時にコンパイル後にキャッシュされます。このページでは、これらの両方の戦略と、キャッシュ動作の設定方法について説明します。

事前コンパイル

QMLモジュールは、qt_add_qml_moduleを使用して定義する必要があります。これにより、Qt Quick コンパイラがQMLファイルおよびJavaScriptファイルを事前に処理するようになります。これにより、実行時の最適なパフォーマンスが保証されます。

Qt Quick コンパイラは、各関数およびバインディングに対してバイトコードを生成します。このバイトコードは、QMLエンジン内のQMLインタプリタおよびジャストインタイム（JIT）コンパイラで使用できます。さらに、Qt Quick コンパイラは、適切な関数およびバインディングに対してネイティブコードを生成します。 ネイティブコードは直接実行されるため、バイトコードをインタープリタ処理したりジャストインタイム（JIT）コンパイルしたりする場合よりも高いパフォーマンスが得られます。その後、バイトコードとネイティブコードの両方が、アプリケーションのバイナリにコンパイルされます。

Ahead-of-Time（AOT）コンパイルの利点の一つは、QMLドキュメント内の構文エラーが、ファイルが読み込まれる実行時ではなく、アプリケーションのコンパイル時に検出されることです。

CMake を使用する場合

CMake とqt_add_qml_module を併用する場合、QML ファイルは自動的に事前にコンパイルされます。可能な限り、リソースファイルシステムから QML ドキュメントを読み込むようにしてください。これにより、QML エンジンが事前にコンパイルされたコードを確実に検出できるようになります。

qmake を使用する場合

qmake を使用する場合、プロジェクトファイルで `CONFIG += qtquickcompiler ` を指定することで、事前コンパイルを有効にできます。 Qt Creator には、このディレクティブを qmake コマンドラインに渡すことを可能にする設定があります。デフォルトでは、リリースおよびプロファイルビルドで有効になっています。

qmake を使用する場合、プロジェクトを特定の方法で構成する必要があります。

• すべての Qml ドキュメント（JavaScript ファイルを含む）は、Qt のリソースシステムを介してリソースとして含める必要があります。
• アプリケーションは、qrc:/// URL スキームを介して QML ドキュメントを読み込む必要があります。

qmake は、CMake ほど多くの情報をQt Quick コンパイラに渡すことはできない点に注意してください。そのため、コンパイル結果に含まれるネイティブコードの量は少なくなります。

実行時のディスクキャッシュ

実行時にプリコンパイル済みのコードが見つからない場合、またはそのコードが使用できない場合、QMLエンジンはQMLドキュメントをその場でバイトコード形式にコンパイルします。QMLエンジンは、同じドキュメントが読み込まれるたびに再コンパイルを行うのではなく、コンパイル済みのバイトコードをキャッシュします。 このキャッシュ処理は自動的に行われます。変更されたQMLドキュメントを読み込むたびに、キャッシュが自動的に再構築されます。

キャッシュファイルの形式と保存場所

キャッシュファイルには、以下の拡張子が使用されます：

• .qmlc コンパイル済みの QML ドキュメントの場合
• .jsc インポートされた JavaScript ファイル用
• .mjsc ECMAScriptモジュール用

キャッシュファイルは、QStandardPaths::CacheLocation で指定されるシステムのキャッシュディレクトリ内の「qmlcache 」というサブディレクトリに格納されます。

メモリ効率

キャッシュファイルは、POSIX 準拠のオペレーティングシステムではmmap() システムコール、Windows ではCreateFileMapping() を通じて読み込まれます。このメモリマッピング方式により、メモリを大幅に節約できます。さらに、複数のアプリケーションが同じ QML ドキュメントを使用する場合、コードに必要なメモリはアプリケーションプロセス間で共有されるため、メモリのオーバーヘッドがさらに削減されます。

キャッシュの検証

キャッシュファイルおよび事前コンパイル済みコードは、以下のすべての条件が満たされた場合にのみ読み込まれます：

• Qtのバージョンが変更されていないこと
• 元のファイル内のソースコードが変更されていないこと
• QML デバッガが実行されていない
• AOTコードの検証が成功していること

なお、QML_FORCE_DISK_CACHE （後述）は、QMLデバッガの条件を上書きする可能性があります。その他の環境変数は、これらの検証条件に影響を与えません。

事前生成されたネイティブコードの検証

Qt Quick コンパイラによって生成されたネイティブコードには、いくつかの前提条件が組み込まれています。コードが実行される環境がコンパイル時の環境と異なる場合、そのコードの使用は安全でない可能性があります。そのため、ネイティブコードは、それに付随して保存されたメタデータを使用して実行時に検証されます。この検証に合格した場合、コードは通常通り実行されます。 検証に失敗した場合、実行は黙ってバイトコードの解釈に切り替わります。この検証はファイルごとに1回、コードが最初に読み込まれた際に行われ、そのQMLファイル内のすべての関数およびバインディングをまとめて承認または拒否します。

AOTコードの検証はカスタマイズ可能です。

• 実行時の検証を無効にするには、QV4_SKIP_AOT_VALIDATION 環境変数を設定します。これにより、検証を実行する際のわずかなオーバーヘッドを回避できます。

  QV4_SKIP_AOT_VALIDATION=1 ./myQmlApp

• 実行時に検証が確実に成功するようにするには、QV4_FAIL_ON_INVALID_AOT 環境変数を設定します。検証に失敗した場合、プログラムは終了します。これにより、例えば、コンパイルされた関数が確実にネイティブコードとして実行されることを保証できます。

  QV4_FAIL_ON_INVALID_AOT=1 ./myQmlApp

• この機能を完全に無効にし、Qt Quick コンパイラによるメタデータおよび検証ロジックの生成を防ぐには、qt_add_qml_moduleにNO_GENERATE_AOT_VALIDATION を渡してください。

  qt_add_qml_module(... NO_GENERATE_AOT_VALIDATION)

設定

環境変数 `QML_DISK_CACHE` を使用すると、キャッシュの動作を微調整できます。この変数には、カンマ区切りのオプションリストを指定します。例：

QML_DISK_CACHE=aot,qmlc-read

利用可能なオプションは以下の通りです:

さらに、以下の環境変数を使用できます: