github / github/codeql

Can the location of the disk cache be customised, and does CodeQL gracefully handle missing cache?

オープン
#21,663 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
question
主要言語
CodeQL
スター
10.1k
フォーク
2.1k
平均マージ
2日 15時間
マージ済み PR(30日)
141

説明

My key questions here are:

- Can the location of the disk cache (the one whose size is set by the `--max-disk-cache` flag) be set to a custom path?
- What happens if the cache directory disappears (e.g. due to a disk unmount) in the middle of an analysis run? Does CodeQL recover gracefully from this?

I tried looking for a flag to set the cache path but I couldn't find one that looked correct. I saw `--compilation-cache` and `--common-caches` but it didn't seem like they control the path of the intermediate result cache.

My motivation here is that I've got an extremely large codebase that I'm trying to run CodeQL analysis on, but the memory requirements make this analysis infeasible on any local machines I have access to - even with 100GiB of RAM and a 200GiB NVMe disk cache allocated to CodeQL, the queries haven't completed after 36h. The process stats make it clear that this is a memory bottleneck issue.

I would like to run the analysis on a cloud host with 1024 GiB of RAM. Understandably this is quite expensive, but since this is an occasional one-off job and I don't need guaranteed uptime I can save a lot of money by using spot instances on AWS. Spot instances can be much cheaper per hour (I'm looking at 70-80% savings per hour), but they come with no continuous uptime guarantees - at any point the instance can be automatically stopped (hibernated), migrated to other hardware, then resumed. This is _mostly_ transparent to the instance.

On AWS the persistent storage attached to the instance is Elastic Block Storage (EBS), which is backed by a SAN. This means that all EBS IO goes over the network. While the link is reasonably fast (around 30Gbps) it is nowhere near as performant as local storage, especially for high IOPS tasks like disk cache. AWS also offers instances that come with local NVMe storage, which are much more suited for this type of cache. The downside is that this NVMe storage is ephemeral and will not persist if the spot instance is migrated.

I would like to be able to place the CodeQL disk cache on this NVMe storage since it offers a significant performance increase. However, I can't place the CodeQL database itself on the local NVMe storage because it will not be persisted across migrations. This is why I would like to specify the disk cache path. I can probably hack around this by running an analysis pass with a fast dummy query to generate a valid cache directory, copying the cache data to the NVMe, symlinking the cache directory to the NVMe mount path, then running analysis with the actual queries I want to run, but it would be nice to not have to do all that.

However, this still leaves the question of what happens if a migration occurs mid-query. Since the system is hibernated, moved to a new system, then resumed, it will be as if the contents of the cache directory were deleted mid-run. If CodeQL can't handle this gracefully then using the local NVMe for cache is probably a non-starter.

Is this use-case currently workable within CodeQL? If not, would it be feasible to implement?

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

まず、--max-disk-cache、--compilation-cache、--common-caches オプションの動作を調査します。これには、解析中にキャッシュディレクトリが消失した場合に何が起きるかも含まれます。issue にはファイル名やテストが記載されていないため、キャッシュの実装と、既存の復旧に関するカバレッジを特定する必要があります。カスタムキャッシュパスと正常な復旧がサポートされているかを確認するか、その両方に必要な実装を定義できれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
aws
領域
cloud, performance
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
静か
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。