[libclang][reproducers] Add compilation caching support to reproducers for explicitly-built modules. #11960
Conversation
…s for explicitly-built modules. Add API to provide CAS options for reproducer generation and use these options to generate compilation commands. Instead of copying relevant files and providing them through VFS, create a new CAS object storage and copy relevant CAS trees there. rdar://158780270
|
An example of API usage is swiftlang/swift-build#964 |
|
|
||
| //--- cas-script-expectations.txt | ||
| CHECK: -fcas-path "reproducer.cache/cas" | ||
| CHECK: "-fcas-include-tree" "llvmcas:// |
There was a problem hiding this comment.
I don't know if it is worth it (or common) to check the presence of an include tree in a generated CAS.
There was a problem hiding this comment.
For swift, I just find a way to execute the reproducer.
There was a problem hiding this comment.
Thanks for the suggestion, it seems to be a more reliable way to check the logic.
| << toString(std::move(Err)); | ||
| } | ||
| } else { | ||
| SmallString<128> VFSCachePath = FileCachePath; |
There was a problem hiding this comment.
For the sake of simplifying the review I can outdent this block to show that it matches the previously existing code.
There was a problem hiding this comment.
You can just return from the if block to avoid else
There was a problem hiding this comment.
The return is non-trivial and I don't want to duplicate it. For now outdented the old code and noticed a mistake.
| if (auto Err = transplantCASIncludeTree(TU.IncludeTreeID)) | ||
| return ReportFailure() | ||
| << "failed to transplant a translation unit include tree due to " | ||
| << toString(std::move(Err)); | ||
| for (const ModuleDeps &ModuleDep : TU.ModuleGraph) { | ||
| if (auto Err = transplantCASIncludeTree(ModuleDep.IncludeTreeID)) | ||
| return ReportFailure() | ||
| << "failed to transplant a module '" + ModuleDep.ID.ModuleName + | ||
| "' include tree due to " | ||
| << toString(std::move(Err)); | ||
| } |
There was a problem hiding this comment.
I've made this code not as involved as in Swift reproducers on purpose as I don't have corresponding use cases. @cachemeifyoucan do you have any use cases in mind that I should address?
There was a problem hiding this comment.
What use case are you talking about here? clang inputs are entirely captured in include tree but swift doesn't have such a representation so it has to be more involved.
There was a problem hiding this comment.
Thanks for the explanation. I didn't know about this difference between swift and clang.
I don't have a specific use case in mind. I was concerned my test case wasn't representative enough and worked by accident. But seems like my approach is sufficient (both in testing and in code).
| //--- cas-script-expectations.txt | ||
| CHECK: -fcas-path "reproducer.cache/cas" | ||
| CHECK: "-fcas-include-tree" "llvmcas:// | ||
| CHECKL "-fmodule-file-cache-key" "reproducer.cache/explicitly-built-modules/Test-{{.*}}.pcm" "llvmcas:// |
There was a problem hiding this comment.
Yes, thank you so much for noticing it.
|
|
||
| //--- cas-script-expectations.txt | ||
| CHECK: -fcas-path "reproducer.cache/cas" | ||
| CHECK: "-fcas-include-tree" "llvmcas:// |
There was a problem hiding this comment.
For swift, I just find a way to execute the reproducer.
| if (auto Err = transplantCASIncludeTree(TU.IncludeTreeID)) | ||
| return ReportFailure() | ||
| << "failed to transplant a translation unit include tree due to " | ||
| << toString(std::move(Err)); | ||
| for (const ModuleDeps &ModuleDep : TU.ModuleGraph) { | ||
| if (auto Err = transplantCASIncludeTree(ModuleDep.IncludeTreeID)) | ||
| return ReportFailure() | ||
| << "failed to transplant a module '" + ModuleDep.ID.ModuleName + | ||
| "' include tree due to " | ||
| << toString(std::move(Err)); | ||
| } |
There was a problem hiding this comment.
What use case are you talking about here? clang inputs are entirely captured in include tree but swift doesn't have such a representation so it has to be more involved.
| << toString(std::move(Err)); | ||
| } | ||
| } else { | ||
| SmallString<128> VFSCachePath = FileCachePath; |
There was a problem hiding this comment.
You can just return from the if block to avoid else
2 participants
Add API to provide CAS options for reproducer generation and use these options to generate compilation commands. Instead of copying relevant files and providing them through VFS, create a new CAS object storage and copy relevant CAS trees there.
rdar://158780270