File: strip_debug_info_test.cpp

package info (click to toggle)
spirv-tools 2025.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 28,588 kB
  • sloc: cpp: 470,407; javascript: 5,893; python: 3,326; ansic: 488; sh: 450; ruby: 88; makefile: 18; lisp: 9
file content (232 lines) | stat: -rw-r--r-- 8,927 bytes parent folder | download | duplicates (20)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
// Copyright (c) 2016 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include <vector>

#include "test/opt/pass_fixture.h"
#include "test/opt/pass_utils.h"

namespace spvtools {
namespace opt {
namespace {

using StripLineDebugInfoTest = PassTest<::testing::Test>;

TEST_F(StripLineDebugInfoTest, LineNoLine) {
  std::vector<const char*> text = {
      // clang-format off
               "OpCapability Shader",
          "%1 = OpExtInstImport \"GLSL.std.450\"",
               "OpMemoryModel Logical GLSL450",
               "OpEntryPoint Vertex %2 \"main\"",
          "%3 = OpString \"minimal.vert\"",
               "OpModuleProcessed \"42\"",
               "OpModuleProcessed \"43\"",
               "OpModuleProcessed \"44\"",
               "OpNoLine",
               "OpLine %3 10 10",
       "%void = OpTypeVoid",
               "OpLine %3 100 100",
          "%5 = OpTypeFunction %void",
          "%2 = OpFunction %void None %5",
               "OpLine %3 1 1",
               "OpNoLine",
               "OpLine %3 2 2",
               "OpLine %3 3 3",
          "%6 = OpLabel",
               "OpLine %3 4 4",
               "OpNoLine",
               "OpReturn",
               "OpLine %3 4 4",
               "OpNoLine",
               "OpFunctionEnd",
               "OpNoLine",
               "OpLine %3 4 5"
      // clang-format on
  };
  SinglePassRunAndCheck<StripDebugInfoPass>(JoinAllInsts(text),
                                            JoinNonDebugInsts(text),
                                            /* skip_nop = */ false);

  // Let's add more debug instruction before the "OpString" instruction.
  const std::vector<const char*> more_text = {
      "OpSourceContinued \"I'm a happy shader! Yay! ;)\"",
      "OpSourceContinued \"wahahaha\"",
      "OpSource ESSL 310",
      "OpSource ESSL 310",
      "OpSourceContinued \"wahahaha\"",
      "OpSourceContinued \"wahahaha\"",
      "OpSourceExtension \"save-the-world-extension\"",
      "OpName %2 \"main\"",
  };
  text.insert(text.begin() + 4, more_text.cbegin(), more_text.cend());
  SinglePassRunAndCheck<StripDebugInfoPass>(JoinAllInsts(text),
                                            JoinNonDebugInsts(text),
                                            /* skip_nop = */ false);
}

using StripDebugStringTest = PassTest<::testing::Test>;

TEST_F(StripDebugStringTest, OpDecorateRemoved) {
  std::vector<const char*> input{
      // clang-format off
                     "OpCapability Shader",
                "%1 = OpExtInstImport \"GLSL.std.450\"",
                     "OpMemoryModel Logical GLSL450",
                     "OpEntryPoint Vertex %2 \"main\"",
                "%3 = OpString \"minimal.vert\"",
                     "OpDecorate %3 Location 1337",
             "%void = OpTypeVoid",
                "%5 = OpTypeFunction %void",
                "%2 = OpFunction %void None %5",
                "%6 = OpLabel",
                     "OpReturn",
                     "OpFunctionEnd",
      // clang-format on
  };
  std::vector<const char*> output{
      // clang-format off
                     "OpCapability Shader",
                "%1 = OpExtInstImport \"GLSL.std.450\"",
                     "OpMemoryModel Logical GLSL450",
                     "OpEntryPoint Vertex %2 \"main\"",
             "%void = OpTypeVoid",
                "%5 = OpTypeFunction %void",
                "%2 = OpFunction %void None %5",
                "%6 = OpLabel",
                     "OpReturn",
                     "OpFunctionEnd",
      // clang-format on
  };
  SinglePassRunAndCheck<StripDebugInfoPass>(JoinAllInsts(input),
                                            JoinAllInsts(output),
                                            /* skip_nop = */ false,
                                            /* do_validation */ true);
}

TEST_F(StripDebugStringTest, OpNameRemoved) {
  std::vector<const char*> input{
      // clang-format off
                     "OpCapability Shader",
                "%1 = OpExtInstImport \"GLSL.std.450\"",
                     "OpMemoryModel Logical GLSL450",
                     "OpEntryPoint Vertex %2 \"main\"",
                "%3 = OpString \"minimal.vert\"",
                     "OpName %3 \"bob\"",
             "%void = OpTypeVoid",
                "%5 = OpTypeFunction %void",
                "%2 = OpFunction %void None %5",
                "%6 = OpLabel",
                     "OpReturn",
                     "OpFunctionEnd",
      // clang-format on
  };
  std::vector<const char*> output{
      // clang-format off
                     "OpCapability Shader",
                "%1 = OpExtInstImport \"GLSL.std.450\"",
                     "OpMemoryModel Logical GLSL450",
                     "OpEntryPoint Vertex %2 \"main\"",
             "%void = OpTypeVoid",
                "%5 = OpTypeFunction %void",
                "%2 = OpFunction %void None %5",
                "%6 = OpLabel",
                     "OpReturn",
                     "OpFunctionEnd",
      // clang-format on
  };
  SinglePassRunAndCheck<StripDebugInfoPass>(JoinAllInsts(input),
                                            JoinAllInsts(output),
                                            /* skip_nop = */ false,
                                            /* do_validation */ true);
}

TEST_F(StripDebugStringTest, OpStringRemovedWithNonSemantic) {
  std::vector<const char*> input{
      // clang-format off
                     "OpCapability Shader",
                     "OpExtension \"SPV_KHR_non_semantic_info\"",
                "%1 = OpExtInstImport \"NonSemantic.Testing.Set\"",
                     "OpMemoryModel Logical GLSL450",
                     "OpEntryPoint Vertex %2 \"main\"",
                // this string is not referenced, should be removed fully
                "%3 = OpString \"minimal.vert\"",
                     "OpName %3 \"bob\"",
                // this string is referenced and cannot be removed,
                // but the name should be
                "%4 = OpString \"secondary.inc\"",
                     "OpName %4 \"sue\"",
             "%void = OpTypeVoid",
                "%6 = OpTypeFunction %void",
                "%2 = OpFunction %void None %6",
                "%7 = OpLabel",
                "%8 = OpExtInst %void %1 5 %4",
                     "OpReturn",
                     "OpFunctionEnd",
      // clang-format on
  };
  std::vector<const char*> output{
      // clang-format off
                     "OpCapability Shader",
                     "OpExtension \"SPV_KHR_non_semantic_info\"",
                "%1 = OpExtInstImport \"NonSemantic.Testing.Set\"",
                     "OpMemoryModel Logical GLSL450",
                     "OpEntryPoint Vertex %2 \"main\"",
                "%4 = OpString \"secondary.inc\"",
             "%void = OpTypeVoid",
                "%6 = OpTypeFunction %void",
                "%2 = OpFunction %void None %6",
                "%7 = OpLabel",
                "%8 = OpExtInst %void %1 5 %4",
                     "OpReturn",
                     "OpFunctionEnd",
      // clang-format on
  };
  SinglePassRunAndCheck<StripDebugInfoPass>(JoinAllInsts(input),
                                            JoinAllInsts(output),
                                            /* skip_nop = */ false,
                                            /* do_validation */ true);
}

using StripDebugInfoTest = PassTest<::testing::TestWithParam<const char*>>;

TEST_P(StripDebugInfoTest, Kind) {
  std::vector<const char*> text = {
      "OpCapability Shader",
      "OpMemoryModel Logical GLSL450",
      GetParam(),
  };
  SinglePassRunAndCheck<StripDebugInfoPass>(JoinAllInsts(text),
                                            JoinNonDebugInsts(text),
                                            /* skip_nop = */ false);
}

// Test each possible non-line debug instruction.
// clang-format off
INSTANTIATE_TEST_SUITE_P(
    SingleKindDebugInst, StripDebugInfoTest,
    ::testing::ValuesIn(std::vector<const char*>({
        "OpSourceContinued \"I'm a happy shader! Yay! ;)\"",
        "OpSource ESSL 310",
        "OpSourceExtension \"save-the-world-extension\"",
        "OpName %main \"main\"",
        "OpMemberName %struct 0 \"field\"",
        "%1 = OpString \"name.vert\"",
        "OpModuleProcessed \"42\"",
    })));
// clang-format on

}  // namespace
}  // namespace opt
}  // namespace spvtools