[naga xtask] Move validation subcommands into their own module.

This commit is contained in:
Jim Blandy committed 2023-12-27 13:07:09 -08:00
1 parent d7296ac30b
commit 9041bb94db
2 files changed
+262 -251

No files matched your search

+6 -251
View File
@@ -1,19 +1,13 @@
use std::{
io::{BufRead, BufReader},
path::Path,
process::{ExitCode, Stdio},
};
use std::process::ExitCode;
use anyhow::{bail, Context};
use anyhow::Context;
use cli::Args;
use crate::{
cli::{Subcommand, ValidateHlslCommand, ValidateSubcommand},
fs::{open_file, remove_dir_all},
glob::visit_files,
cli::Subcommand,
fs::remove_dir_all,
path::join_path,
process::{which, EasyCommand},
result::{ErrorStatus, LogIfError},
};
mod cli;
@@ -22,6 +16,7 @@ mod glob;
mod path;
mod process;
mod result;
mod validate;
fn main() -> ExitCode {
env_logger::builder()
@@ -42,8 +37,6 @@ fn main() -> ExitCode {
}
fn run(args: Args) -> anyhow::Result<()> {
let snapshots_base_out = join_path(["tests", "out"]);
let Args { subcommand } = args;
assert!(which("cargo").is_ok());
@@ -75,244 +68,6 @@ fn run(args: Args) -> anyhow::Result<()> {
}
EasyCommand::simple("cargo", ["bench"]).success()
}
Subcommand::Validate(cmd) => {
let ack_visiting = |path: &Path| log::info!("Validating {}", path.display());
let err_status = match cmd {
ValidateSubcommand::Spirv => {
let spirv_as = "spirv-as";
which(spirv_as)?;
let spirv_val = "spirv-val";
which(spirv_val)?;
visit_files(snapshots_base_out, "spv/*.spvasm", |path| {
ack_visiting(path);
let second_line = {
let mut file = BufReader::new(open_file(path)?);
let mut buf = String::new();
file.read_line(&mut buf).with_context(|| {
format!("failed to read first line from {path:?}")
})?;
buf.clear();
file.read_line(&mut buf).with_context(|| {
format!("failed to read second line from {path:?}")
})?;
buf
};
let expected_header_prefix = "; Version: ";
let Some(version) =
second_line.strip_prefix(expected_header_prefix) else {
bail!(
"no {expected_header_prefix:?} header found in {path:?}"
);
};
let file = open_file(path)?;
let mut spirv_as_cmd = EasyCommand::new(spirv_as, |cmd| {
cmd.stdin(Stdio::from(file))
.stdout(Stdio::piped())
.arg("--target-env")
.arg(format!("spv{version}"))
.args(["-", "-o", "-"])
});
let child = spirv_as_cmd
.spawn()
.with_context(|| format!("failed to spawn {cmd:?}"))?;
EasyCommand::new(spirv_val, |cmd| cmd.stdin(child.stdout.unwrap()))
.success()
})
}
ValidateSubcommand::Metal => {
let xcrun = "xcrun";
which(xcrun)?;
visit_files(snapshots_base_out, "msl/*.msl", |path| {
ack_visiting(path);
let first_line = {
let mut file = BufReader::new(open_file(path)?);
let mut buf = String::new();
file.read_line(&mut buf)
.with_context(|| format!("failed to read header from {path:?}"))?;
buf
};
let expected_header_prefix = "// language: ";
let Some(language) =
first_line.strip_prefix(expected_header_prefix) else {
bail!(
"no {expected_header_prefix:?} header found in {path:?}"
);
};
let language = language.strip_suffix('\n').unwrap_or(language);
let file = open_file(path)?;
EasyCommand::new(xcrun, |cmd| {
cmd.stdin(Stdio::from(file))
.args(["-sdk", "macosx", "metal", "-mmacosx-version-min=10.11"])
.arg(format!("-std=macos-{language}"))
.args(["-x", "metal", "-", "-o", "/dev/null"])
})
.success()
})
}
ValidateSubcommand::Glsl => {
let glslang_validator = "glslangValidator";
which(glslang_validator)?;
let mut err_status = ErrorStatus::NoFailuresFound;
for (glob, type_arg) in [
("glsl/*.Vertex.glsl", "vert"),
("glsl/*.Fragment.glsl", "frag"),
("glsl/*.Compute.glsl", "comp"),
] {
let type_err_status = visit_files(&snapshots_base_out, glob, |path| {
ack_visiting(path);
let file = open_file(path)?;
EasyCommand::new(glslang_validator, |cmd| {
cmd.stdin(Stdio::from(file))
.args(["--stdin", "-S"])
.arg(type_arg)
})
.success()
});
err_status = err_status.merge(type_err_status);
}
err_status
}
ValidateSubcommand::Dot => {
let dot = "dot";
which(dot)?;
visit_files(snapshots_base_out, "dot/*.dot", |path| {
ack_visiting(path);
let file = open_file(path)?;
EasyCommand::new(dot, |cmd| {
cmd.stdin(Stdio::from(file)).stdout(Stdio::null())
})
.success()
})
}
ValidateSubcommand::Wgsl => {
let mut paths = vec![];
let mut error_status = visit_files(snapshots_base_out, "wgsl/*.wgsl", |path| {
paths.push(path.to_owned());
Ok(())
});
EasyCommand::new("cargo", |cmd| {
cmd.args(["run", "-p", "naga-cli", "--", "--bulk-validate"]).args(paths)
}).success()
.log_if_err_found(&mut error_status);
error_status
}
ValidateSubcommand::Hlsl(cmd) => {
let visit_hlsl = |consume_config_item: &mut dyn FnMut(
&Path,
hlsl_snapshots::ConfigItem,
)
-> anyhow::Result<()>| {
visit_files(snapshots_base_out, "hlsl/*.hlsl", |path| {
ack_visiting(path);
let hlsl_snapshots::Config {
vertex,
fragment,
compute,
} = hlsl_snapshots::Config::from_path(path.with_extension("ron"))?;
let mut status = ErrorStatus::NoFailuresFound;
[vertex, fragment, compute]
.into_iter()
.flatten()
.for_each(|shader| {
consume_config_item(path, shader).log_if_err_found(&mut status);
});
match status {
ErrorStatus::NoFailuresFound => Ok(()),
ErrorStatus::OneOrMoreFailuresFound => bail!(
"one or more shader HLSL shader tests failed for {}",
path.display()
),
}
})
};
let validate = |bin, file: &_, config_item, params: &[_]| {
let hlsl_snapshots::ConfigItem {
entry_point,
target_profile,
} = config_item;
EasyCommand::new(bin, |cmd| {
cmd.arg(file)
.arg("-T")
.arg(&target_profile)
.arg("-E")
.arg(&entry_point)
.args(params)
.stdout(Stdio::null())
})
.success()
.with_context(|| {
format!(
"failed to validate entry point {entry_point:?} with profile \
{target_profile:?}"
)
})
};
match cmd {
ValidateHlslCommand::Dxc => {
let bin = "dxc";
which(bin)?;
visit_hlsl(&mut |file, config_item| {
// Reference:
// <https://github.com/microsoft/DirectXShaderCompiler/blob/6ee4074a4b43fa23bf5ad27e4f6cafc6b835e437/tools/clang/docs/UsingDxc.rst>.
validate(
bin,
file,
config_item,
&[
"-Wno-parentheses-equality",
"-Zi",
"-Qembed_debug",
"-Od",
"-HV",
"2018",
],
)
})
}
ValidateHlslCommand::Fxc => {
let bin = "fxc";
which(bin)?;
visit_hlsl(&mut |file, config_item| {
let Some(Ok(shader_model_major_version)) = config_item
.target_profile
.split('_')
.nth(1)
.map(|segment| segment.parse::<u8>()) else {
bail!(
"expected target profile of the form \
`{{model}}_{{major}}_{{minor}}`, found invalid target \
profile {:?} in file {}",
config_item.target_profile,
file.display()
)
};
// NOTE: This isn't implemented by `fxc.exe`; see
// <https://learn.microsoft.com/en-us/windows/win32/direct3dtools/dx-graphics-tools-fxc-syntax#profiles>.
if shader_model_major_version < 6 {
// Reference:
// <https://learn.microsoft.com/en-us/windows/win32/direct3dtools/dx-graphics-tools-fxc-syntax>.
validate(bin, file, config_item, &["-Zi", "-Od"])
} else {
log::debug!(
"skipping config. item {config_item:?} because the \
shader model major version is > 6"
);
Ok(())
}
})
}
}
}
};
match err_status {
ErrorStatus::NoFailuresFound => Ok(()),
ErrorStatus::OneOrMoreFailuresFound => {
bail!("failed to validate one or more files, see above output for more details")
}
}
}
Subcommand::Validate(cmd) => validate::validate(cmd),
}
}
+256
View File
@@ -0,0 +1,256 @@
use std::{
io::{BufRead, BufReader},
path::Path,
process::Stdio,
};
use anyhow::{bail, Context};
use crate::{
cli::{ValidateHlslCommand, ValidateSubcommand},
fs::open_file,
glob::visit_files,
path::join_path,
process::{which, EasyCommand},
result::{ErrorStatus, LogIfError},
};
pub(crate) fn validate(cmd: ValidateSubcommand) -> anyhow::Result<()> {
let snapshots_base_out = join_path(["tests", "out"]);
let ack_visiting = |path: &Path| log::info!("Validating {}", path.display());
let err_status = match cmd {
ValidateSubcommand::Spirv => {
let spirv_as = "spirv-as";
which(spirv_as)?;
let spirv_val = "spirv-val";
which(spirv_val)?;
visit_files(snapshots_base_out, "spv/*.spvasm", |path| {
ack_visiting(path);
let second_line = {
let mut file = BufReader::new(open_file(path)?);
let mut buf = String::new();
file.read_line(&mut buf)
.with_context(|| format!("failed to read first line from {path:?}"))?;
buf.clear();
file.read_line(&mut buf)
.with_context(|| format!("failed to read second line from {path:?}"))?;
buf
};
let expected_header_prefix = "; Version: ";
let Some(version) =
second_line.strip_prefix(expected_header_prefix) else {
bail!(
"no {expected_header_prefix:?} header found in {path:?}"
);
};
let file = open_file(path)?;
let mut spirv_as_cmd = EasyCommand::new(spirv_as, |cmd| {
cmd.stdin(Stdio::from(file))
.stdout(Stdio::piped())
.arg("--target-env")
.arg(format!("spv{version}"))
.args(["-", "-o", "-"])
});
let child = spirv_as_cmd
.spawn()
.with_context(|| format!("failed to spawn {cmd:?}"))?;
EasyCommand::new(spirv_val, |cmd| cmd.stdin(child.stdout.unwrap())).success()
})
}
ValidateSubcommand::Metal => {
let xcrun = "xcrun";
which(xcrun)?;
visit_files(snapshots_base_out, "msl/*.msl", |path| {
ack_visiting(path);
let first_line = {
let mut file = BufReader::new(open_file(path)?);
let mut buf = String::new();
file.read_line(&mut buf)
.with_context(|| format!("failed to read header from {path:?}"))?;
buf
};
let expected_header_prefix = "// language: ";
let Some(language) =
first_line.strip_prefix(expected_header_prefix) else {
bail!(
"no {expected_header_prefix:?} header found in {path:?}"
);
};
let language = language.strip_suffix('\n').unwrap_or(language);
let file = open_file(path)?;
EasyCommand::new(xcrun, |cmd| {
cmd.stdin(Stdio::from(file))
.args(["-sdk", "macosx", "metal", "-mmacosx-version-min=10.11"])
.arg(format!("-std=macos-{language}"))
.args(["-x", "metal", "-", "-o", "/dev/null"])
})
.success()
})
}
ValidateSubcommand::Glsl => {
let glslang_validator = "glslangValidator";
which(glslang_validator)?;
let mut err_status = ErrorStatus::NoFailuresFound;
for (glob, type_arg) in [
("glsl/*.Vertex.glsl", "vert"),
("glsl/*.Fragment.glsl", "frag"),
("glsl/*.Compute.glsl", "comp"),
] {
let type_err_status = visit_files(&snapshots_base_out, glob, |path| {
ack_visiting(path);
let file = open_file(path)?;
EasyCommand::new(glslang_validator, |cmd| {
cmd.stdin(Stdio::from(file))
.args(["--stdin", "-S"])
.arg(type_arg)
})
.success()
});
err_status = err_status.merge(type_err_status);
}
err_status
}
ValidateSubcommand::Dot => {
let dot = "dot";
which(dot)?;
visit_files(snapshots_base_out, "dot/*.dot", |path| {
ack_visiting(path);
let file = open_file(path)?;
EasyCommand::new(dot, |cmd| {
cmd.stdin(Stdio::from(file)).stdout(Stdio::null())
})
.success()
})
}
ValidateSubcommand::Wgsl => {
let mut paths = vec![];
let mut error_status = visit_files(snapshots_base_out, "wgsl/*.wgsl", |path| {
paths.push(path.to_owned());
Ok(())
});
EasyCommand::new("cargo", |cmd| {
cmd.args(["run", "-p", "naga-cli", "--", "--bulk-validate"])
.args(paths)
})
.success()
.log_if_err_found(&mut error_status);
error_status
}
ValidateSubcommand::Hlsl(cmd) => {
let visit_hlsl = |consume_config_item: &mut dyn FnMut(
&Path,
hlsl_snapshots::ConfigItem,
)
-> anyhow::Result<()>| {
visit_files(snapshots_base_out, "hlsl/*.hlsl", |path| {
ack_visiting(path);
let hlsl_snapshots::Config {
vertex,
fragment,
compute,
} = hlsl_snapshots::Config::from_path(path.with_extension("ron"))?;
let mut status = ErrorStatus::NoFailuresFound;
[vertex, fragment, compute]
.into_iter()
.flatten()
.for_each(|shader| {
consume_config_item(path, shader).log_if_err_found(&mut status);
});
match status {
ErrorStatus::NoFailuresFound => Ok(()),
ErrorStatus::OneOrMoreFailuresFound => bail!(
"one or more shader HLSL shader tests failed for {}",
path.display()
),
}
})
};
let validate = |bin, file: &_, config_item, params: &[_]| {
let hlsl_snapshots::ConfigItem {
entry_point,
target_profile,
} = config_item;
EasyCommand::new(bin, |cmd| {
cmd.arg(file)
.arg("-T")
.arg(&target_profile)
.arg("-E")
.arg(&entry_point)
.args(params)
.stdout(Stdio::null())
})
.success()
.with_context(|| {
format!(
"failed to validate entry point {entry_point:?} with profile \
{target_profile:?}"
)
})
};
match cmd {
ValidateHlslCommand::Dxc => {
let bin = "dxc";
which(bin)?;
visit_hlsl(&mut |file, config_item| {
// Reference:
// <https://github.com/microsoft/DirectXShaderCompiler/blob/6ee4074a4b43fa23bf5ad27e4f6cafc6b835e437/tools/clang/docs/UsingDxc.rst>.
validate(
bin,
file,
config_item,
&[
"-Wno-parentheses-equality",
"-Zi",
"-Qembed_debug",
"-Od",
"-HV",
"2018",
],
)
})
}
ValidateHlslCommand::Fxc => {
let bin = "fxc";
which(bin)?;
visit_hlsl(&mut |file, config_item| {
let Some(Ok(shader_model_major_version)) = config_item
.target_profile
.split('_')
.nth(1)
.map(|segment| segment.parse::<u8>()) else {
bail!(
"expected target profile of the form \
`{{model}}_{{major}}_{{minor}}`, found invalid target \
profile {:?} in file {}",
config_item.target_profile,
file.display()
)
};
// NOTE: This isn't implemented by `fxc.exe`; see
// <https://learn.microsoft.com/en-us/windows/win32/direct3dtools/dx-graphics-tools-fxc-syntax#profiles>.
if shader_model_major_version < 6 {
// Reference:
// <https://learn.microsoft.com/en-us/windows/win32/direct3dtools/dx-graphics-tools-fxc-syntax>.
validate(bin, file, config_item, &["-Zi", "-Od"])
} else {
log::debug!(
"skipping config. item {config_item:?} because the \
shader model major version is > 6"
);
Ok(())
}
})
}
}
}
};
match err_status {
ErrorStatus::NoFailuresFound => Ok(()),
ErrorStatus::OneOrMoreFailuresFound => {
bail!("failed to validate one or more files, see above output for more details")
}
}
}