need a C++ API #2

dneto0 · 2015-11-14T15:01:33Z

The SPIR-V Tools API is a C API to provide ABI stability and a lowest-common-denominator target for multiple languages. However, it's begging for a more convenient C++ API.

antiagainst · 2015-11-16T15:43:09Z

+1

… specified in OpString and print inline source code + column marker for each OpLine (and won't repeat identical OpLines)

antiagainst · 2016-09-22T14:04:27Z

This is done via #410 & #411.

In some shaders there are a lot of very large and deeply nested structures. This creates a lot of work for scalar replacement. Also, since commit ca4457b we have been very aggressive as rewriting variables. This has causes a large increase in compile time in creating and then deleting the instructions. To help low the costs, I want to run a cleanup of some of the easy loads and stores to remove. This reduces the number of symbols sroa has to work on. It also reduces the amount of code the simplifier has to simplify because it was not generated by sroa. To confirm the improvement, I ran numbers on three different sets of shaders: Time to run --legalize-hlsl: Set #1: 55.89s -> 12.0s Set #2: 1m44s -> 1m40.5s Set #3: 6.8s -> 5.7s Time to run -O Set #1: 18.8s -> 10.9s Set #2: 5m44s -> 4m17s Set #3: 7.8s -> 7.8s Contributes to #1328.

… specified in OpString and print inline source code + column marker for each OpLine (and won't repeat identical OpLines)

`DebugInfoManager::AddDebugValueIfVarDeclIsVisible()` adds OpenCL.DebugInfo.100 DebugValue from DebugDeclare only when the DebugDeclare is visible to the give scope. It helps us correctly handle a reference variable e.g., { // scope KhronosGroup#1. int foo = /* init */; { // scope KhronosGroup#2. int& bar = foo; ... in the above code, we must not propagate DebugValue of `int& bar` for store instructions in the scope KhronosGroup#1 because it is alive only in the scope KhronosGroup#2. We have an exception: If the given DebugDeclare is used for a function parameter, `DebugInfoManager::AddDebugValueIfVarDeclIsVisible()` has to always add DebugValue instruction regardless of the scope. It is because the initializer (store instruction) for the function parameter can be out of the function parameter's scope (the function) in particular when the function was inlined. Without this change, the function parameter value information always disappears whenever we run the function inlining pass and `DebugInfoManager::AddDebugValueIfVarDeclIsVisible()`.

`DebugInfoManager::AddDebugValueIfVarDeclIsVisible()` adds OpenCL.DebugInfo.100 DebugValue from DebugDeclare only when the DebugDeclare is visible to the give scope. It helps us correctly handle a reference variable e.g., { // scope #1. int foo = /* init */; { // scope #2. int& bar = foo; ... in the above code, we must not propagate DebugValue of `int& bar` for store instructions in the scope #1 because it is alive only in the scope #2. We have an exception: If the given DebugDeclare is used for a function parameter, `DebugInfoManager::AddDebugValueIfVarDeclIsVisible()` has to always add DebugValue instruction regardless of the scope. It is because the initializer (store instruction) for the function parameter can be out of the function parameter's scope (the function) in particular when the function was inlined. Without this change, the function parameter value information always disappears whenever we run the function inlining pass and `DebugInfoManager::AddDebugValueIfVarDeclIsVisible()`.

… specified in OpString and print inline source code + column marker for each OpLine (and won't repeat identical OpLines)

* allow building on FreeBSD (pretend it's Linux) * added spirv_container: this implements a simple SPIR-V container format that can be used to easily bundle multiple SPIR-V modules in a single file. Alternatively, it can also wrap a singular SPIR-V binary, thus providing the same interface for both file types. * make use of spirv_container in spirv-dis (output everything to a single file or stdout), spirv-val (fails/returns on the first module error) and spirv-cfg (output multiple .dot files, or everything to stdout) * initial debug-asm commit: this disassembly output mode/format is solely intended as a read-only debugging aid that has more human-friendly formatting (-> this will _not_ reassemble into a SPIR-V binary) * added DebugNameMapper, which inherits from and extends FriendlyNameMapper: type names are more C/LLVM like with this and constants are assigned their value as a name (e.g. %42u for a 32-bit uint constant with value 42), will also figure out the maximum name length that is generated/used in the module * modified Disassembler, when using debug-asm: * all text will be centered on and align to the "=" (will add padding on the lhs for all names < max name length) * function and label printing will be more C/LLVM like (will have a proper function header, body is wrapped in {}, labels are written directly on the left) * OpPhi has nicer printing (id <- label, ...) * OpName / OpMemberName opcodes are skipped, because proper names will already be printed with FriendlyNameMapper * red text is used instead of blue text for lhs result ids (easier to read on black/transparent backgrounds, also works on white) * "Op" part of opcode names is skipped (we know these are opcodes) * also get rid of "gl_" builtin naming while I'm at it (some of these are used for OpenCL as well and SPIR-V is essentially language-agnostic) * debug-asm part KhronosGroup#2: will now (lazily) load source files specified in OpString and print inline source code + column marker for each OpLine (and won't repeat identical OpLines) * actually do the invalid line/column number checking properly * fixed gcc warning/error * post-rebase fixes * cmake: disable python 3 requirement if we don't build tests anyways * post-rebase fixes 20201227 * use "debug ASM" mode when printing a validator error * spirv_container: added support for rudimentary container/module metadata (function names + types), added supporting for writing a container * opt: added initial container support * added missing headers * post-rebase fixes 20221006

* allow building on FreeBSD (pretend it's Linux) * added spirv_container: this implements a simple SPIR-V container format that can be used to easily bundle multiple SPIR-V modules in a single file. Alternatively, it can also wrap a singular SPIR-V binary, thus providing the same interface for both file types. * make use of spirv_container in spirv-dis (output everything to a single file or stdout), spirv-val (fails/returns on the first module error) and spirv-cfg (output multiple .dot files, or everything to stdout) * initial debug-asm commit: this disassembly output mode/format is solely intended as a read-only debugging aid that has more human-friendly formatting (-> this will _not_ reassemble into a SPIR-V binary) * added DebugNameMapper, which inherits from and extends FriendlyNameMapper: type names are more C/LLVM like with this and constants are assigned their value as a name (e.g. %42u for a 32-bit uint constant with value 42), will also figure out the maximum name length that is generated/used in the module * modified Disassembler, when using debug-asm: * all text will be centered on and align to the "=" (will add padding on the lhs for all names < max name length) * function and label printing will be more C/LLVM like (will have a proper function header, body is wrapped in {}, labels are written directly on the left) * OpPhi has nicer printing (id <- label, ...) * OpName / OpMemberName opcodes are skipped, because proper names will already be printed with FriendlyNameMapper * red text is used instead of blue text for lhs result ids (easier to read on black/transparent backgrounds, also works on white) * "Op" part of opcode names is skipped (we know these are opcodes) * also get rid of "gl_" builtin naming while I'm at it (some of these are used for OpenCL as well and SPIR-V is essentially language-agnostic) * debug-asm part KhronosGroup#2: will now (lazily) load source files specified in OpString and print inline source code + column marker for each OpLine (and won't repeat identical OpLines) * actually do the invalid line/column number checking properly * fixed gcc warning/error * post-rebase fixes * cmake: disable python 3 requirement if we don't build tests anyways * post-rebase fixes 20201227 * use "debug ASM" mode when printing a validator error * spirv_container: added support for rudimentary container/module metadata (function names + types), added supporting for writing a container * opt: added initial container support * added missing headers * post-rebase fixes 20221006, 20221229

* allow building on FreeBSD (pretend it's Linux) * added spirv_container: this implements a simple SPIR-V container format that can be used to easily bundle multiple SPIR-V modules in a single file. Alternatively, it can also wrap a singular SPIR-V binary, thus providing the same interface for both file types. * make use of spirv_container in spirv-dis (output everything to a single file or stdout), spirv-val (fails/returns on the first module error) and spirv-cfg (output multiple .dot files, or everything to stdout) * initial debug-asm commit: this disassembly output mode/format is solely intended as a read-only debugging aid that has more human-friendly formatting (-> this will _not_ reassemble into a SPIR-V binary) * added DebugNameMapper, which inherits from and extends FriendlyNameMapper: type names are more C/LLVM like with this and constants are assigned their value as a name (e.g. %42u for a 32-bit uint constant with value 42), will also figure out the maximum name length that is generated/used in the module * modified Disassembler, when using debug-asm: * all text will be centered on and align to the "=" (will add padding on the lhs for all names < max name length) * function and label printing will be more C/LLVM like (will have a proper function header, body is wrapped in {}, labels are written directly on the left) * OpPhi has nicer printing (id <- label, ...) * OpName / OpMemberName opcodes are skipped, because proper names will already be printed with FriendlyNameMapper * red text is used instead of blue text for lhs result ids (easier to read on black/transparent backgrounds, also works on white) * "Op" part of opcode names is skipped (we know these are opcodes) * also get rid of "gl_" builtin naming while I'm at it (some of these are used for OpenCL as well and SPIR-V is essentially language-agnostic) * debug-asm part KhronosGroup#2: will now (lazily) load source files specified in OpString and print inline source code + column marker for each OpLine (and won't repeat identical OpLines) * actually do the invalid line/column number checking properly * fixed gcc warning/error * post-rebase fixes * cmake: disable python 3 requirement if we don't build tests anyways * post-rebase fixes 20201227 * use "debug ASM" mode when printing a validator error * spirv_container: added support for rudimentary container/module metadata (function names + types), added supporting for writing a container * opt: added initial container support * added missing headers * validation_state: added support for printing more than one instruction in a diagnostic message * validate_cfg/validate_memory: make use of this in several diag calls (mainly cfg structurization issues) * debug_name_mapper: allow '=' and '!' characters * disassemble: set the max possible indentation to 160 chars * post-rebase fixes 20221006, 20221229, 20230507

* allow building on FreeBSD (pretend it's Linux) * added spirv_container: this implements a simple SPIR-V container format that can be used to easily bundle multiple SPIR-V modules in a single file. Alternatively, it can also wrap a singular SPIR-V binary, thus providing the same interface for both file types. * make use of spirv_container in spirv-dis (output everything to a single file or stdout), spirv-val (fails/returns on the first module error) and spirv-cfg (output multiple .dot files, or everything to stdout) * initial debug-asm commit: this disassembly output mode/format is solely intended as a read-only debugging aid that has more human-friendly formatting (-> this will _not_ reassemble into a SPIR-V binary) * added DebugNameMapper, which inherits from and extends FriendlyNameMapper: type names are more C/LLVM like with this and constants are assigned their value as a name (e.g. %42u for a 32-bit uint constant with value 42), will also figure out the maximum name length that is generated/used in the module * modified Disassembler, when using debug-asm: * all text will be centered on and align to the "=" (will add padding on the lhs for all names < max name length) * function and label printing will be more C/LLVM like (will have a proper function header, body is wrapped in {}, labels are written directly on the left) * OpPhi has nicer printing (id <- label, ...) * OpName / OpMemberName opcodes are skipped, because proper names will already be printed with FriendlyNameMapper * red text is used instead of blue text for lhs result ids (easier to read on black/transparent backgrounds, also works on white) * "Op" part of opcode names is skipped (we know these are opcodes) * also get rid of "gl_" builtin naming while I'm at it (some of these are used for OpenCL as well and SPIR-V is essentially language-agnostic) * debug-asm part KhronosGroup#2: will now (lazily) load source files specified in OpString and print inline source code + column marker for each OpLine (and won't repeat identical OpLines) * actually do the invalid line/column number checking properly * fixed gcc warning/error * post-rebase fixes * cmake: disable python 3 requirement if we don't build tests anyways * post-rebase fixes 20201227 * use "debug ASM" mode when printing a validator error * spirv_container: added support for rudimentary container/module metadata (function names + types), added supporting for writing a container * opt: added initial container support * added missing headers * validation_state: added support for printing more than one instruction in a diagnostic message * validate_cfg/validate_memory: make use of this in several diag calls (mainly cfg structurization issues) * debug_name_mapper: allow '=' and '!' characters * disassemble: set the max possible indentation to 160 chars * post-rebase fixes 20221006, 20221229, 20230507, 20240317

This was referenced Nov 23, 2015

Fix use of relative include paths in libspirv.h #24

Closed

Several unit tests for spvBinaryParse #28

Merged

a2flo added a commit to a2flo/SPIRV-Tools that referenced this issue Sep 19, 2016

* debug-asm part KhronosGroup#2: will now (lazily) load source files…

30c8306

… specified in OpString and print inline source code + column marker for each OpLine (and won't repeat identical OpLines)

This was referenced Sep 19, 2016

4. C++ interface for assembling, disassembling, & validating #410

Merged

5. C++ interface for optimization #411

Merged

antiagainst closed this as completed Sep 22, 2016

dneto0 mentioned this issue Sep 19, 2017

spirv-opt: assert/crash with --eliminate-local-multi-store pass #824

Closed

dnovillo mentioned this issue Oct 6, 2017

Add -O, -Os and -Oconfig flags. #817

Closed

This was referenced Nov 24, 2017

use-after-free in Instruction::unique_id() #1004

Closed

Change IRContext::KillInst to delete instructions. #1005

Merged

s-perron mentioned this issue Feb 22, 2018

Clean up variables before sroa #1344

Merged

This was referenced Jan 16, 2019

PassManagerTest is leaking an Instruction object #2296

Closed

Parsing of -Oconfig is leaking #2297

Closed

a2flo added a commit to a2flo/SPIRV-Tools that referenced this issue May 12, 2019

* debug-asm part KhronosGroup#2: will now (lazily) load source files…

ec8fb32

… specified in OpString and print inline source code + column marker for each OpLine (and won't repeat identical OpLines)

jaebaek mentioned this issue Oct 15, 2020

Add DebugValue for function param regardless of scope #3923

Merged

a2flo added a commit to a2flo/SPIRV-Tools that referenced this issue Dec 27, 2020

* debug-asm part KhronosGroup#2: will now (lazily) load source files…

c3d4eb7

… specified in OpString and print inline source code + column marker for each OpLine (and won't repeat identical OpLines)

a2flo added a commit to a2flo/SPIRV-Tools that referenced this issue Oct 13, 2021

* debug-asm part KhronosGroup#2: will now (lazily) load source files…

4036419

… specified in OpString and print inline source code + column marker for each OpLine (and won't repeat identical OpLines)

dneto0 mentioned this issue Jun 24, 2022

spirv-val: Validate zero product workgroup size #4828

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

need a C++ API #2

need a C++ API #2

dneto0 commented Nov 14, 2015

antiagainst commented Nov 16, 2015

antiagainst commented Sep 22, 2016

need a C++ API #2

need a C++ API #2

Comments

dneto0 commented Nov 14, 2015

antiagainst commented Nov 16, 2015

antiagainst commented Sep 22, 2016