utils: Propagate IncludeHandler file loading failures to DXC instead of a panic #27
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…of a panic
Not all file loading should be fallible; DXC usually invokes the loader
with multiple paths depending on relative includes, and happily accepts
and expects us to return `-2_147_024_894 // ERROR_FILE_NOT_FOUND /
0x80070002` for some. As such the precedent should be to not panic but
let DXC decide if file loading failures should be critical or simply
result in a different path being tested.
In my case though the error seems to originate from DXIL compilation
being largely untested when ran on Linux systems through the WinAadapter
codepath. In this particular stacktrace below DXC seems to "stat" (get
file information) for the current working directory, and somehow ends up
trying to open the directory as file through our include handler:
#11 dxcutil::DxcArgsFileSystemImpl::TryFindOrOpen (this=<optimized out>, this@entry=0x5570a3b0ae10, lpFileName=lpFileName@entry=0x5570a3b5d0d0 L".../hassle-rs", index=<optimized out>)
at .../DirectXShaderCompiler/tools/clang/tools/dxcompiler/dxcfilesystem.cpp:327
#12 0x00007f6e64a41a8d in dxcutil::DxcArgsFileSystemImpl::GetFileAttributesW (this=0x5570a3b0ae10, lpFileName=0x5570a3b5d0d0 L".../hassle-rs")
at .../DirectXShaderCompiler/tools/clang/tools/dxcompiler/dxcfilesystem.cpp:570
#13 0x00007f6e64a42048 in dxcutil::DxcArgsFileSystemImpl::Stat (this=0x5570a3b0ae10, lpFileName=<optimized out>, Status=0x7fff9faec1e8)
at .../DirectXShaderCompiler/tools/clang/tools/dxcompiler/dxcfilesystem.cpp:807
#14 0x00007f6e64debc91 in llvm::sys::fs::status (Path=..., Result=...) at .../DirectXShaderCompiler/lib/Support/Unix/Path.inc:385
#15 0x00007f6e64dec708 in llvm::sys::fs::current_path (result=...) at .../DirectXShaderCompiler/lib/Support/Unix/Path.inc:195
#16 0x00007f6e64e64535 in clang::CodeGen::CGDebugInfo::getCurrentDirname (this=this@entry=0x5570a3b598f0)
at .../DirectXShaderCompiler/tools/clang/lib/CodeGen/CGDebugInfo.cpp:301
#17 0x00007f6e64e6230e in clang::CodeGen::CGDebugInfo::CreateCompileUnit (this=this@entry=0x5570a3b598f0)
at .../DirectXShaderCompiler/tools/clang/lib/CodeGen/CGDebugInfo.cpp:369
This stacktrace originates from the following panic:
thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: Os { code: 21, kind: IsADirectory, message: "Is a directory" }', src/utils.rs:51:48
Jasper-Bekkers
approved these changes
Jan 25, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Not all file loading should be fallible; DXC usually invokes the loader with multiple paths depending on relative includes, and happily accepts and expects us to return
-2_147_024_894 // ERROR_FILE_NOT_FOUND / 0x80070002for some. As such the precedent should be to not panic but let DXC decide if file loading failures should be critical or simply result in a different path being tested.In my case though the error seems to originate from DXIL compilation being largely untested when ran on Linux systems through the WinAadapter codepath. In this particular stacktrace below DXC seems to "stat" (get file information) for the current working directory, and somehow ends up trying to open the directory as file through our include handler:
This stacktrace originates from the following panic: