Add renderer trace scope contract

This commit is contained in:
2026-06-02 16:55:23 +02:00
parent 07293c0590
commit bbe3db1747
9 changed files with 305 additions and 101 deletions

View File

@@ -61,6 +61,7 @@ using pp::renderer::max_shader_uniform_bytes;
using pp::renderer::max_mip_levels_for_extent;
using pp::renderer::max_texture_dimension;
using pp::renderer::max_texture_slots;
using pp::renderer::max_trace_label_bytes;
using pp::renderer::panopainter_shader_catalog;
using pp::renderer::primitive_topology_name;
using pp::renderer::readback_byte_size;
@@ -92,6 +93,7 @@ using pp::renderer::validate_texture_copy_descs;
using pp::renderer::validate_texture_desc;
using pp::renderer::validate_texture_slot;
using pp::renderer::validate_texture_usage;
using pp::renderer::validate_trace_label;
using pp::renderer::validate_viewport;
namespace {
@@ -190,14 +192,50 @@ private:
class FakeTrace final : public IRenderTrace {
public:
void marker(const char* component, const char* name) noexcept override
[[nodiscard]] pp::foundation::Status marker(const char* component, const char* name) noexcept override
{
const auto status = validate_trace_label(component, name);
if (!status.ok()) {
return status;
}
last_component = component;
last_name = name;
++marker_count;
return pp::foundation::Status::success();
}
[[nodiscard]] pp::foundation::Status begin_scope(const char* component, const char* name) noexcept override
{
const auto status = validate_trace_label(component, name);
if (!status.ok()) {
return status;
}
last_component = component;
last_name = name;
++begin_scope_count;
++scope_depth;
return pp::foundation::Status::success();
}
[[nodiscard]] pp::foundation::Status end_scope() noexcept override
{
if (scope_depth == 0U) {
return pp::foundation::Status::invalid_argument("trace scope has not begun");
}
++end_scope_count;
--scope_depth;
return pp::foundation::Status::success();
}
const char* last_component = nullptr;
const char* last_name = nullptr;
std::uint32_t marker_count = 0;
std::uint32_t begin_scope_count = 0;
std::uint32_t end_scope_count = 0;
std::uint32_t scope_depth = 0;
};
class FakeCommandContext final : public ICommandContext {
@@ -1223,6 +1261,32 @@ void validates_shader_uniform_writes(pp::tests::Harness& h)
PP_EXPECT(h, excessive.code == StatusCode::out_of_range);
}
void validates_trace_labels(pp::tests::Harness& h)
{
std::array<char, max_trace_label_bytes + 2U> oversized_label {};
oversized_label.fill('x');
oversized_label[max_trace_label_bytes + 1U] = '\0';
PP_EXPECT(h, validate_trace_label("renderer", "frame").ok());
const auto empty_component = validate_trace_label("", "frame");
const auto null_component = validate_trace_label(nullptr, "frame");
const auto empty_name = validate_trace_label("renderer", "");
const auto oversized_component = validate_trace_label(oversized_label.data(), "frame");
const auto oversized_name = validate_trace_label("renderer", oversized_label.data());
PP_EXPECT(h, !empty_component.ok());
PP_EXPECT(h, empty_component.code == StatusCode::invalid_argument);
PP_EXPECT(h, !null_component.ok());
PP_EXPECT(h, null_component.code == StatusCode::invalid_argument);
PP_EXPECT(h, !empty_name.ok());
PP_EXPECT(h, empty_name.code == StatusCode::invalid_argument);
PP_EXPECT(h, !oversized_component.ok());
PP_EXPECT(h, oversized_component.code == StatusCode::out_of_range);
PP_EXPECT(h, !oversized_name.ok());
PP_EXPECT(h, oversized_name.code == StatusCode::out_of_range);
}
void validates_panopainter_shader_catalog(pp::tests::Harness& h)
{
const auto catalog = panopainter_shader_catalog();
@@ -1294,9 +1358,14 @@ void renderer_interfaces_support_backend_neutral_dispatch(pp::tests::Harness& h)
FakeMesh mesh;
PP_EXPECT(h, device.backend_name() == std::string_view("fake"));
device.trace()->marker("renderer", "begin");
PP_EXPECT(h, device.trace()->begin_scope("renderer", "dispatch").ok());
PP_EXPECT(h, device.trace()->marker("renderer", "begin").ok());
PP_EXPECT(h, device.trace()->end_scope().ok());
PP_EXPECT(h, device.trace_recorder.last_component == std::string_view("renderer"));
PP_EXPECT(h, device.trace_recorder.last_name == std::string_view("begin"));
PP_EXPECT(h, device.trace_recorder.marker_count == 1U);
PP_EXPECT(h, device.trace_recorder.begin_scope_count == 1U);
PP_EXPECT(h, device.trace_recorder.end_scope_count == 1U);
auto& context = device.immediate_context();
PP_EXPECT(h, context.begin_render_pass(target, RenderPassDesc {
@@ -1568,7 +1637,9 @@ void recording_renderer_records_valid_command_sequences(pp::tests::Harness& h)
RecordingMesh mesh(MeshDesc { .vertex_count = 3, .index_count = 3, .topology = PrimitiveTopology::triangles });
PP_EXPECT(h, device.backend_name() == std::string_view("recording"));
device.trace()->marker("renderer", "frame");
PP_EXPECT(h, device.trace()->begin_scope("renderer", "recorded-frame").ok());
PP_EXPECT(h, device.trace()->marker("renderer", "frame").ok());
PP_EXPECT(h, device.trace()->end_scope().ok());
auto& context = device.immediate_context();
PP_EXPECT(h, context.begin_render_pass(target, RenderPassDesc {
@@ -1610,57 +1681,63 @@ void recording_renderer_records_valid_command_sequences(pp::tests::Harness& h)
context.end_render_pass();
const auto commands = device.commands();
PP_EXPECT(h, commands.size() == 12U);
PP_EXPECT(h, commands[0].kind == RecordedRenderCommandKind::trace_marker);
PP_EXPECT(h, commands.size() == 14U);
PP_EXPECT(h, commands[0].kind == RecordedRenderCommandKind::trace_begin_scope);
PP_EXPECT(h, commands[0].component == std::string_view("renderer"));
PP_EXPECT(h, commands[0].name == std::string_view("frame"));
PP_EXPECT(h, commands[1].kind == RecordedRenderCommandKind::begin_render_pass);
PP_EXPECT(h, commands[1].target_desc.extent.width == 64U);
PP_EXPECT(h, commands[1].clear_color_enabled);
PP_EXPECT(h, commands[1].clear_color.a == 1.0F);
PP_EXPECT(h, commands[1].clear_depth_enabled);
PP_EXPECT(h, commands[1].clear_depth == 1.0F);
PP_EXPECT(h, commands[1].clear_stencil_enabled);
PP_EXPECT(h, commands[1].clear_stencil == 7U);
PP_EXPECT(h, commands[2].kind == RecordedRenderCommandKind::set_viewport);
PP_EXPECT(h, commands[2].viewport.height == 32U);
PP_EXPECT(h, commands[3].kind == RecordedRenderCommandKind::set_scissor);
PP_EXPECT(h, commands[3].scissor.enabled);
PP_EXPECT(h, commands[3].scissor.x == 4);
PP_EXPECT(h, commands[3].scissor.height == 8U);
PP_EXPECT(h, recorded_render_command_kind_name(commands[3].kind) == std::string_view("set_scissor"));
PP_EXPECT(h, commands[4].kind == RecordedRenderCommandKind::set_blend_state);
PP_EXPECT(h, commands[4].blend_state.enabled);
PP_EXPECT(h, commands[4].blend_state.destination_color == BlendFactor::one_minus_source_alpha);
PP_EXPECT(h, recorded_render_command_kind_name(commands[4].kind) == std::string_view("set_blend_state"));
PP_EXPECT(h, commands[5].kind == RecordedRenderCommandKind::set_depth_state);
PP_EXPECT(h, commands[5].depth_state.test_enabled);
PP_EXPECT(h, commands[5].depth_state.write_enabled);
PP_EXPECT(h, commands[5].depth_state.compare == CompareOp::less_or_equal);
PP_EXPECT(h, recorded_render_command_kind_name(commands[5].kind) == std::string_view("set_depth_state"));
PP_EXPECT(h, commands[6].kind == RecordedRenderCommandKind::bind_shader);
PP_EXPECT(h, commands[6].name == std::string_view("recorded-shader"));
PP_EXPECT(h, commands[7].kind == RecordedRenderCommandKind::bind_texture);
PP_EXPECT(h, commands[7].texture_slot == 1U);
PP_EXPECT(h, commands[7].texture_desc.extent.height == 32U);
PP_EXPECT(h, recorded_render_command_kind_name(commands[7].kind) == std::string_view("bind_texture"));
PP_EXPECT(h, commands[8].kind == RecordedRenderCommandKind::bind_sampler);
PP_EXPECT(h, commands[8].sampler_slot == 1U);
PP_EXPECT(h, commands[8].sampler_desc.mag_filter == SamplerFilter::nearest);
PP_EXPECT(h, commands[8].sampler_desc.address_w == SamplerAddressMode::clamp_to_border);
PP_EXPECT(h, recorded_render_command_kind_name(commands[8].kind) == std::string_view("bind_sampler"));
PP_EXPECT(h, commands[9].kind == RecordedRenderCommandKind::bind_mesh);
PP_EXPECT(h, commands[9].mesh_desc.vertex_count == 3U);
PP_EXPECT(h, commands[9].mesh_desc.index_count == 3U);
PP_EXPECT(h, commands[10].kind == RecordedRenderCommandKind::draw);
PP_EXPECT(h, commands[10].mesh_desc.vertex_count == 3U);
PP_EXPECT(h, commands[10].mesh_desc.index_count == 3U);
PP_EXPECT(h, commands[10].mesh_desc.topology == PrimitiveTopology::triangles);
PP_EXPECT(h, commands[10].draw_desc.vertex_count == 3U);
PP_EXPECT(h, commands[10].draw_desc.index_count == 3U);
PP_EXPECT(h, commands[10].draw_desc.instance_count == 1U);
PP_EXPECT(h, commands[11].kind == RecordedRenderCommandKind::end_render_pass);
PP_EXPECT(h, recorded_render_command_kind_name(commands[10].kind) == std::string_view("draw"));
PP_EXPECT(h, commands[0].name == std::string_view("recorded-frame"));
PP_EXPECT(h, recorded_render_command_kind_name(commands[0].kind) == std::string_view("trace_begin_scope"));
PP_EXPECT(h, commands[1].kind == RecordedRenderCommandKind::trace_marker);
PP_EXPECT(h, commands[1].component == std::string_view("renderer"));
PP_EXPECT(h, commands[1].name == std::string_view("frame"));
PP_EXPECT(h, commands[2].kind == RecordedRenderCommandKind::trace_end_scope);
PP_EXPECT(h, recorded_render_command_kind_name(commands[2].kind) == std::string_view("trace_end_scope"));
PP_EXPECT(h, commands[3].kind == RecordedRenderCommandKind::begin_render_pass);
PP_EXPECT(h, commands[3].target_desc.extent.width == 64U);
PP_EXPECT(h, commands[3].clear_color_enabled);
PP_EXPECT(h, commands[3].clear_color.a == 1.0F);
PP_EXPECT(h, commands[3].clear_depth_enabled);
PP_EXPECT(h, commands[3].clear_depth == 1.0F);
PP_EXPECT(h, commands[3].clear_stencil_enabled);
PP_EXPECT(h, commands[3].clear_stencil == 7U);
PP_EXPECT(h, commands[4].kind == RecordedRenderCommandKind::set_viewport);
PP_EXPECT(h, commands[4].viewport.height == 32U);
PP_EXPECT(h, commands[5].kind == RecordedRenderCommandKind::set_scissor);
PP_EXPECT(h, commands[5].scissor.enabled);
PP_EXPECT(h, commands[5].scissor.x == 4);
PP_EXPECT(h, commands[5].scissor.height == 8U);
PP_EXPECT(h, recorded_render_command_kind_name(commands[5].kind) == std::string_view("set_scissor"));
PP_EXPECT(h, commands[6].kind == RecordedRenderCommandKind::set_blend_state);
PP_EXPECT(h, commands[6].blend_state.enabled);
PP_EXPECT(h, commands[6].blend_state.destination_color == BlendFactor::one_minus_source_alpha);
PP_EXPECT(h, recorded_render_command_kind_name(commands[6].kind) == std::string_view("set_blend_state"));
PP_EXPECT(h, commands[7].kind == RecordedRenderCommandKind::set_depth_state);
PP_EXPECT(h, commands[7].depth_state.test_enabled);
PP_EXPECT(h, commands[7].depth_state.write_enabled);
PP_EXPECT(h, commands[7].depth_state.compare == CompareOp::less_or_equal);
PP_EXPECT(h, recorded_render_command_kind_name(commands[7].kind) == std::string_view("set_depth_state"));
PP_EXPECT(h, commands[8].kind == RecordedRenderCommandKind::bind_shader);
PP_EXPECT(h, commands[8].name == std::string_view("recorded-shader"));
PP_EXPECT(h, commands[9].kind == RecordedRenderCommandKind::bind_texture);
PP_EXPECT(h, commands[9].texture_slot == 1U);
PP_EXPECT(h, commands[9].texture_desc.extent.height == 32U);
PP_EXPECT(h, recorded_render_command_kind_name(commands[9].kind) == std::string_view("bind_texture"));
PP_EXPECT(h, commands[10].kind == RecordedRenderCommandKind::bind_sampler);
PP_EXPECT(h, commands[10].sampler_slot == 1U);
PP_EXPECT(h, commands[10].sampler_desc.mag_filter == SamplerFilter::nearest);
PP_EXPECT(h, commands[10].sampler_desc.address_w == SamplerAddressMode::clamp_to_border);
PP_EXPECT(h, recorded_render_command_kind_name(commands[10].kind) == std::string_view("bind_sampler"));
PP_EXPECT(h, commands[11].kind == RecordedRenderCommandKind::bind_mesh);
PP_EXPECT(h, commands[11].mesh_desc.vertex_count == 3U);
PP_EXPECT(h, commands[11].mesh_desc.index_count == 3U);
PP_EXPECT(h, commands[12].kind == RecordedRenderCommandKind::draw);
PP_EXPECT(h, commands[12].mesh_desc.vertex_count == 3U);
PP_EXPECT(h, commands[12].mesh_desc.index_count == 3U);
PP_EXPECT(h, commands[12].mesh_desc.topology == PrimitiveTopology::triangles);
PP_EXPECT(h, commands[12].draw_desc.vertex_count == 3U);
PP_EXPECT(h, commands[12].draw_desc.index_count == 3U);
PP_EXPECT(h, commands[12].draw_desc.instance_count == 1U);
PP_EXPECT(h, commands[13].kind == RecordedRenderCommandKind::end_render_pass);
PP_EXPECT(h, recorded_render_command_kind_name(commands[12].kind) == std::string_view("draw"));
PP_EXPECT(h, context.upload_texture(
texture,
@@ -1668,12 +1745,12 @@ void recording_renderer_records_valid_command_sequences(pp::tests::Harness& h)
upload_bytes)
.ok());
const auto commands_after_upload = device.commands();
PP_EXPECT(h, commands_after_upload.size() == 13U);
PP_EXPECT(h, commands_after_upload[12].kind == RecordedRenderCommandKind::upload_texture);
PP_EXPECT(h, commands_after_upload[12].texture_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_upload[12].readback_region.x == 4U);
PP_EXPECT(h, commands_after_upload[12].upload_bytes == 96U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_upload[12].kind) == std::string_view("upload_texture"));
PP_EXPECT(h, commands_after_upload.size() == 15U);
PP_EXPECT(h, commands_after_upload[14].kind == RecordedRenderCommandKind::upload_texture);
PP_EXPECT(h, commands_after_upload[14].texture_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_upload[14].readback_region.x == 4U);
PP_EXPECT(h, commands_after_upload[14].upload_bytes == 96U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_upload[14].kind) == std::string_view("upload_texture"));
PP_EXPECT(h, context.copy_texture(
texture,
@@ -1682,13 +1759,13 @@ void recording_renderer_records_valid_command_sequences(pp::tests::Harness& h)
ReadbackRegion { .x = 0, .y = 0, .width = 8, .height = 3 })
.ok());
const auto commands_after_copy = device.commands();
PP_EXPECT(h, commands_after_copy.size() == 14U);
PP_EXPECT(h, commands_after_copy[13].kind == RecordedRenderCommandKind::copy_texture);
PP_EXPECT(h, commands_after_copy[13].source_region.x == 4U);
PP_EXPECT(h, commands_after_copy[13].destination_region.x == 0U);
PP_EXPECT(h, commands_after_copy[13].copy_source_bytes == 96U);
PP_EXPECT(h, commands_after_copy[13].copy_destination_bytes == 96U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_copy[13].kind) == std::string_view("copy_texture"));
PP_EXPECT(h, commands_after_copy.size() == 16U);
PP_EXPECT(h, commands_after_copy[15].kind == RecordedRenderCommandKind::copy_texture);
PP_EXPECT(h, commands_after_copy[15].source_region.x == 4U);
PP_EXPECT(h, commands_after_copy[15].destination_region.x == 0U);
PP_EXPECT(h, commands_after_copy[15].copy_source_bytes == 96U);
PP_EXPECT(h, commands_after_copy[15].copy_destination_bytes == 96U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_copy[15].kind) == std::string_view("copy_texture"));
PP_EXPECT(h, context.read_texture(
texture,
@@ -1696,22 +1773,22 @@ void recording_renderer_records_valid_command_sequences(pp::tests::Harness& h)
readback_buffer)
.ok());
const auto commands_after_readback = device.commands();
PP_EXPECT(h, commands_after_readback.size() == 15U);
PP_EXPECT(h, commands_after_readback[14].kind == RecordedRenderCommandKind::read_texture);
PP_EXPECT(h, commands_after_readback[14].texture_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_readback[14].readback_region.x == 4U);
PP_EXPECT(h, commands_after_readback[14].readback_region.height == 3U);
PP_EXPECT(h, commands_after_readback[14].readback_bytes == 96U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_readback[14].kind) == std::string_view("read_texture"));
PP_EXPECT(h, commands_after_readback.size() == 17U);
PP_EXPECT(h, commands_after_readback[16].kind == RecordedRenderCommandKind::read_texture);
PP_EXPECT(h, commands_after_readback[16].texture_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_readback[16].readback_region.x == 4U);
PP_EXPECT(h, commands_after_readback[16].readback_region.height == 3U);
PP_EXPECT(h, commands_after_readback[16].readback_bytes == 96U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_readback[16].kind) == std::string_view("read_texture"));
PP_EXPECT(h, context.capture_frame(target, readback_buffer).ok());
const auto commands_after_capture = device.commands();
PP_EXPECT(h, commands_after_capture.size() == 16U);
PP_EXPECT(h, commands_after_capture[15].kind == RecordedRenderCommandKind::capture_frame);
PP_EXPECT(h, commands_after_capture[15].target_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_capture[15].target_desc.extent.height == 32U);
PP_EXPECT(h, commands_after_capture[15].capture_bytes == 8192U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_capture[15].kind) == std::string_view("capture_frame"));
PP_EXPECT(h, commands_after_capture.size() == 18U);
PP_EXPECT(h, commands_after_capture[17].kind == RecordedRenderCommandKind::capture_frame);
PP_EXPECT(h, commands_after_capture[17].target_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_capture[17].target_desc.extent.height == 32U);
PP_EXPECT(h, commands_after_capture[17].capture_bytes == 8192U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_capture[17].kind) == std::string_view("capture_frame"));
PP_EXPECT(h, context.blit_render_target(
target,
@@ -1721,16 +1798,16 @@ void recording_renderer_records_valid_command_sequences(pp::tests::Harness& h)
BlitFilter::linear)
.ok());
const auto commands_after_blit = device.commands();
PP_EXPECT(h, commands_after_blit.size() == 17U);
PP_EXPECT(h, commands_after_blit[16].kind == RecordedRenderCommandKind::blit_render_target);
PP_EXPECT(h, commands_after_blit[16].source_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_blit[16].destination_desc.extent.height == 32U);
PP_EXPECT(h, commands_after_blit[16].source_region.width == 16U);
PP_EXPECT(h, commands_after_blit[16].destination_region.x == 2U);
PP_EXPECT(h, commands_after_blit[16].blit_filter == BlitFilter::linear);
PP_EXPECT(h, commands_after_blit[16].blit_source_bytes == 512U);
PP_EXPECT(h, commands_after_blit[16].blit_destination_bytes == 128U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_blit[16].kind) == std::string_view("blit_render_target"));
PP_EXPECT(h, commands_after_blit.size() == 19U);
PP_EXPECT(h, commands_after_blit[18].kind == RecordedRenderCommandKind::blit_render_target);
PP_EXPECT(h, commands_after_blit[18].source_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_blit[18].destination_desc.extent.height == 32U);
PP_EXPECT(h, commands_after_blit[18].source_region.width == 16U);
PP_EXPECT(h, commands_after_blit[18].destination_region.x == 2U);
PP_EXPECT(h, commands_after_blit[18].blit_filter == BlitFilter::linear);
PP_EXPECT(h, commands_after_blit[18].blit_source_bytes == 512U);
PP_EXPECT(h, commands_after_blit[18].blit_destination_bytes == 128U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_blit[18].kind) == std::string_view("blit_render_target"));
device.clear();
PP_EXPECT(h, device.commands().empty());
@@ -1802,6 +1879,23 @@ void recording_renderer_rejects_invalid_command_order_and_targets(pp::tests::Har
RecordingMesh mesh(MeshDesc { .vertex_count = 3, .topology = PrimitiveTopology::triangles });
RecordingMesh empty_mesh(MeshDesc {});
RecordingRenderDevice trace_device;
auto* trace = trace_device.trace();
const auto trace_marker_empty_component = trace->marker("", "frame");
PP_EXPECT(h, !trace_marker_empty_component.ok());
PP_EXPECT(h, trace_marker_empty_component.code == StatusCode::invalid_argument);
const auto trace_scope_empty_name = trace->begin_scope("renderer", "");
PP_EXPECT(h, !trace_scope_empty_name.ok());
PP_EXPECT(h, trace_scope_empty_name.code == StatusCode::invalid_argument);
const auto trace_end_without_begin = trace->end_scope();
PP_EXPECT(h, !trace_end_without_begin.ok());
PP_EXPECT(h, trace_end_without_begin.code == StatusCode::invalid_argument);
PP_EXPECT(h, trace->begin_scope("renderer", "strict").ok());
PP_EXPECT(h, trace->end_scope().ok());
auto& context = device.immediate_context();
const auto draw_before_begin = context.draw(DrawDesc { .vertex_count = 3 });
PP_EXPECT(h, !draw_before_begin.ok());
@@ -2146,6 +2240,7 @@ int main()
harness.run("validates_render_pass_descriptors", validates_render_pass_descriptors);
harness.run("validates_shader_program_descriptors", validates_shader_program_descriptors);
harness.run("validates_shader_uniform_writes", validates_shader_uniform_writes);
harness.run("validates_trace_labels", validates_trace_labels);
harness.run("validates_panopainter_shader_catalog", validates_panopainter_shader_catalog);
harness.run("rejects_invalid_shader_catalogs", rejects_invalid_shader_catalogs);
harness.run("renderer_interfaces_support_backend_neutral_dispatch", renderer_interfaces_support_backend_neutral_dispatch);