Update CHANGES with recently added optimizations
[platform/upstream/SPIRV-Tools.git] / CHANGES
1 Revision history for SPIRV-Tools
2
3 v2016.7-dev 2017-01-06
4  - Add SPIR-V 1.2
5  - OpenCL 2.2 support is now based on SPIR-V 1.2
6  - Support AMD extensions in assembler, disassembler:
7     SPV_AMD_gcn_shader
8     SPV_AMD_shader_ballot
9     SPV_AMD_shader_explicit_vertex_parameter
10     SPV_AMD_shader_trinary_minmax
11     SPV_AMD_gpu_shader_half_float
12     SPV_AMD_texture_gather_bias_lod
13     SPV_AMD_gpu_shader_int16
14  - Optimizer: Add support for:
15    - Inline all function calls in entry points.
16    - Flatten decoration groups.  Fixes #602
17    - Id compaction (minimize Id bound).  Fixes #624
18    - Eliminate redundant composite insert followed by extract
19    - Simplify access chains to local variables
20    - Eliminate local variables with a single store, if possible
21    - Eliminate local variables with a several stores, if possible
22    - Eliminate loads and stores in same block to local variables
23    - Eliminate redundant insert/extract to composite values
24    - Aggressive dead instruction elimination
25    - Eliminate dead branches
26    - Merge blocks when the second can only be preceded by the first
27  - Assembler: Add option to preserve numeric ids. Fixes #625
28  - Add build target spirv-tools-vimsyntax to generate spvasm.vim, a SPIR-V
29    assembly syntax file for Vim.
30  - Version string: Allow overriding of wall clock timestamp with contents
31    of environment variable SOURCE_DATE_EPOCH.
32  - Validator implements relaxed rules for SPV_KHR_16bit_storage.
33  - CMake installation rules use GNUInstallDirs.  For example, libraries
34    will be installed into a lib64 directory if that's the norm for the
35    current system.
36  - Fixes:
37    #500: Parameterize validator limit checks
38    #508: Support compilation under CYGWIN
39    #517: Fix validation when continue (or case) contstruct is also the head of a
40      nested control construct.
41    #551: If a merge block is reachable, it must be *strictly* dominated by its
42      header.
43    #548: Validator: Error when the reserved OpImageSparseSampleProj* opcodes
44      are used.
45    #611: spvtools::Optimizer was failing to save the module to the output
46      binary vector when all passes succeded without changes.
47    #629: The inline-entry-points-all optimization could generate invalidly
48      structured code when the inlined function had early returns.
49    #697: Optimizer's Instruction::ForEachInId method was skipping semantics-id
50      and scope-id.
51
52 v2016.6 2016-12-13
53  - Published the C++ interface for assembling, disassembling, validation, and
54    optimization.
55  - Support SPV_KHR_shader_draw_parameters in assembler, disassembler, parser.
56  - Validator:
57    - Add validator API accepting raw binary words
58    - Increased coverage:
59      - Checks "Data rules" in Universal Validation Rules, section 2.16.1
60      - WIP: Universal Limits.
61        - The minimum mandated upper bounds are checked.
62        - TODO: Parameterize the validator to allow larger limits accepted by
63          a more than minimally capable implementation.
64    - OpSampledImage checks
65    - OpConstantComposite checks
66    - Id bound check
67  - Disasssembler:
68    - Generates friendly GLSL-based names for more builtin variables
69    - Generates friendly names for numeric OpConstant values
70    - Vendor tool info extracted from SPIR-V XML registry file.
71  - Fixes issues:
72    #429: Validator: Allow OpTypeForwardPointer and OpTypeStruct to reference
73      undefined IDs
74    #482: Validator: OpVariable initializer can be an ID of a module-scope variable
75
76 v2016.5 2016-09-16
77  - Support SPV_KHR_shader_ballot in assembler, disassembler, parser.
78  - Disassembler: Generate friendly names for built-in variables.
79  - Partial fixes:
80    #359: Add Emacs helper for automatically diassembling/assembling a SPIR-V
81      binary on file load/save.
82  - Fixes:
83    #414: Validator: Allow OpUndef for composite constants
84    #415: Validator: Phi can use its own value in some cases.
85
86 v2016.4 2016-09-01
87  - Relicensed under Apache 2.0
88  - Add optimization passes (in API and spirv-opt command)
89    - Fold spec constants defined with OpSpecConstantOp and
90        OpSpecConstantComposite to normal constants with fixed value(s).
91  - Fixes issues:
92    #318: Relicensed under Apache 2.0
93
94 v2016.3 2016-08-24
95  - Add target environment enums for OpenCL 2.1, OpenCL 2.2,
96    OpenGL 4.0, OpenGL 4.1, OpenGL 4.2, OpenGL 4.3, OpenGL 4.5.
97  - Add spirv-cfg, an experimental tool to dump the control flow graph
98    as a GraphiViz "dot" graph
99  - Add optimization pass: Eliminate dead constants.
100  - Add spirv-lesspipe.sh filter utility
101  - Fixes issues:
102    #288: Check def-use dominance rules for OpPhi (variable,parent) operands
103    #339: Allow OpUndef in types-constants-global-vars section, as required
104      by SPIR-V 1.0 Rev7, 1.1 Rev 3.
105    #340: Avoid race on mkdir during build
106    #365: Relax PointSize, ClipDistance, CullDistance capability check in all
107      environments not just Vulkan 1.0.
108
109 v2016.2 2016-08-05
110  - Validator is incomplete
111    - Checks ID use block is dominated by definition block
112  - Add optimization passes (in API and spirv-opt command)
113    - Strip debug info instructions
114    - Freeze spec constant to their default values
115  - Allow INotEqual as operation for OpSpecConstantOp
116  - Fixes bugs:
117    #270: validator: crash when continue construct is unreachable
118    #279: validator: infinite loop when analyzing some degenerate control
119      flow graphs
120    #286: validator: don't incorrectly generate def-use error for
121          (variable,parent) parameters to OpPhi
122    #290: disassembler: never generate bare % for an identifier
123    #295: validator: def-use dominance check should ignore unreachable uses
124    #276: validator: allow unreachable continue constructs
125    #297: validator: allow an unreachable block to branch to a reachable
126          merge block
127
128 v2016.1 2016-07-19
129  - Fix https://github.com/KhronosGroup/SPIRV-Tools/issues/261
130    Turn off ClipDistance and CullDistance capability checks for Vulkan.
131  - The disassembler can emit friendly names based on debug info (OpName
132    instructions), and will infer somewhat friendly names for most types.
133    This is turned on by default for the spirv-dis command line tool.
134  - Updated to support SPIR-V 1.1 rev 2
135    - Input StorageClass, Sampled1D capability, and SampledBuffer capability
136      do not require Shader capability anymore.
137
138 v2016.0 2016-07-04
139
140  - Adds v<year>.<index> versioning, with "-dev" indicating
141    work in progress.  The intent is to more easly report
142    and summarize functionality when SPIRV-Tools is incorporated
143    in downstream projects.
144
145  - Summary of functionality (See the README.md for more):
146    - Supports SPIR-V 1.1 Rev 1
147    - Supports SPIR-V 1.0 Rev 5
148    - Supports GLSL std450 extended instructions 1.0 Rev 3
149    - Supports OpenCL extended instructions 1.0 Rev 2
150    - Assembler, disassembler are complete
151      - Supports floating point widths of 16, 32, 64 bits
152      - Supports integer widths up to 64 bits
153    - Validator is incomplete
154      - Checks capability requirements in most cases
155      - Checks module layout constraints
156      - Checks ID use-definition ordering constraints,
157        ignoring control flow
158      - Checks some control flow graph rules
159    - Optimizer is introduced, with few available transforms.
160    - Supported on Linux, OSX, Android, Windows
161
162  - Fixes bugs:
163    - #143: OpenCL pow and pown arguments