blob: 6963cdd27bfa99c5c2821977db1c2d9b8a36049b [file] [log] [blame]
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +01001#!/usr/bin/env python3
2
Hans-Kristian Arntzen47044822021-01-14 16:07:49 +01003# Copyright 2015-2021 Arm Limited
Jon Leechf2a65542021-05-08 01:47:48 -07004# SPDX-License-Identifier: Apache-2.0
Hans-Kristian Arntzenf9818f02020-01-16 15:24:37 +01005#
6# Licensed under the Apache License, Version 2.0 (the "License");
7# you may not use this file except in compliance with the License.
8# You may obtain a copy of the License at
9#
10# http://www.apache.org/licenses/LICENSE-2.0
11#
12# Unless required by applicable law or agreed to in writing, software
13# distributed under the License is distributed on an "AS IS" BASIS,
14# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15# See the License for the specific language governing permissions and
16# limitations under the License.
Sarah Mashayekhieed84682019-11-26 14:46:19 -050017
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +010018import sys
19import os
Arseny Kapoulkinef45075b2017-01-24 22:26:39 -080020import os.path
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +010021import subprocess
22import tempfile
23import re
24import itertools
25import hashlib
26import shutil
Hans-Kristian Arntzen0a5b3a62016-03-22 14:44:12 +010027import argparse
Hans-Kristian Arntzenad0c5c62017-02-04 10:19:44 +010028import codecs
Brad Davis709d3c62018-06-03 11:16:37 -070029import json
Brad Davisd0a67ba2018-06-19 14:35:25 -070030import multiprocessing
Hans-Kristian Arntzen26107ba2018-07-02 13:12:58 +020031import errno
Brad Davisd0a67ba2018-06-19 14:35:25 -070032from functools import partial
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +010033
Hans-Kristian Arntzen074f7652019-03-07 12:36:16 +010034class Paths():
Hans-Kristian Arntzen3a7cb0c2019-04-12 14:44:24 +020035 def __init__(self, spirv_cross, glslang, spirv_as, spirv_val, spirv_opt):
36 self.spirv_cross = spirv_cross
Hans-Kristian Arntzen074f7652019-03-07 12:36:16 +010037 self.glslang = glslang
38 self.spirv_as = spirv_as
39 self.spirv_val = spirv_val
40 self.spirv_opt = spirv_opt
41
Hans-Kristian Arntzencd442b92018-04-27 10:31:39 +020042def remove_file(path):
43 #print('Removing file:', path)
44 os.remove(path)
45
46def create_temporary(suff = ''):
47 f, path = tempfile.mkstemp(suffix = suff)
48 os.close(f)
49 #print('Creating temporary:', path)
50 return path
51
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +010052def parse_stats(stats):
53 m = re.search('([0-9]+) work registers', stats)
54 registers = int(m.group(1)) if m else 0
55
56 m = re.search('([0-9]+) uniform registers', stats)
57 uniform_regs = int(m.group(1)) if m else 0
58
59 m_list = re.findall('(-?[0-9]+)\s+(-?[0-9]+)\s+(-?[0-9]+)', stats)
60 alu_short = float(m_list[1][0]) if m_list else 0
61 ls_short = float(m_list[1][1]) if m_list else 0
62 tex_short = float(m_list[1][2]) if m_list else 0
63 alu_long = float(m_list[2][0]) if m_list else 0
64 ls_long = float(m_list[2][1]) if m_list else 0
65 tex_long = float(m_list[2][2]) if m_list else 0
66
67 return (registers, uniform_regs, alu_short, ls_short, tex_short, alu_long, ls_long, tex_long)
68
69def get_shader_type(shader):
70 _, ext = os.path.splitext(shader)
71 if ext == '.vert':
72 return '--vertex'
73 elif ext == '.frag':
74 return '--fragment'
75 elif ext == '.comp':
76 return '--compute'
77 elif ext == '.tesc':
78 return '--tessellation_control'
79 elif ext == '.tese':
80 return '--tessellation_evaluation'
81 elif ext == '.geom':
82 return '--geometry'
83 else:
84 return ''
85
86def get_shader_stats(shader):
Hans-Kristian Arntzencd442b92018-04-27 10:31:39 +020087 path = create_temporary()
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +010088
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +010089 p = subprocess.Popen(['malisc', get_shader_type(shader), '--core', 'Mali-T760', '-V', shader], stdout = subprocess.PIPE, stderr = subprocess.PIPE)
90 stdout, stderr = p.communicate()
Hans-Kristian Arntzencd442b92018-04-27 10:31:39 +020091 remove_file(path)
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +010092
93 if p.returncode != 0:
94 print(stderr.decode('utf-8'))
95 raise OSError('malisc failed')
96 p.wait()
97
98 returned = stdout.decode('utf-8')
99 return parse_stats(returned)
100
Bill Hollingsbe4cb172017-01-30 22:55:21 -0500101def print_msl_compiler_version():
102 try:
103 subprocess.check_call(['xcrun', '--sdk', 'iphoneos', 'metal', '--version'])
Hans-Kristian Arntzen2e000a02021-03-12 12:51:53 +0100104 print('... are the Metal compiler characteristics.\n') # display after so xcrun FNF is silent
Bill Hollingsbe4cb172017-01-30 22:55:21 -0500105 except OSError as e:
Hans-Kristian Arntzen26107ba2018-07-02 13:12:58 +0200106 if (e.errno != errno.ENOENT): # Ignore xcrun not found error
Bill Hollingsbe4cb172017-01-30 22:55:21 -0500107 raise
Hans-Kristian Arntzen2e000a02021-03-12 12:51:53 +0100108 print('Metal SDK is not present.\n')
Hans-Kristian Arntzenbe1e27a2019-06-17 16:06:14 +0200109 except subprocess.CalledProcessError:
110 pass
111
Chip Davis2219c4a2020-09-28 23:07:55 -0500112def msl_compiler_supports_version(version):
Hans-Kristian Arntzenbe1e27a2019-06-17 16:06:14 +0200113 try:
Chip Davis2219c4a2020-09-28 23:07:55 -0500114 subprocess.check_call(['xcrun', '--sdk', 'macosx', 'metal', '-x', 'metal', '-std=macos-metal' + version, '-'],
Hans-Kristian Arntzenbe1e27a2019-06-17 16:06:14 +0200115 stdin = subprocess.DEVNULL, stdout = subprocess.DEVNULL, stderr = subprocess.DEVNULL)
Chip Davis2219c4a2020-09-28 23:07:55 -0500116 print('Current SDK supports MSL {0}. Enabling validation for MSL {0} shaders.'.format(version))
Hans-Kristian Arntzenbe1e27a2019-06-17 16:06:14 +0200117 return True
118 except OSError as e:
Chip Davis2219c4a2020-09-28 23:07:55 -0500119 print('Failed to check if MSL {} is not supported. It probably is not.'.format(version))
Hans-Kristian Arntzenbe1e27a2019-06-17 16:06:14 +0200120 return False
121 except subprocess.CalledProcessError:
Chip Davis2219c4a2020-09-28 23:07:55 -0500122 print('Current SDK does NOT support MSL {0}. Disabling validation for MSL {0} shaders.'.format(version))
Hans-Kristian Arntzenbe1e27a2019-06-17 16:06:14 +0200123 return False
Bill Hollingsbe4cb172017-01-30 22:55:21 -0500124
Hans-Kristian Arntzen32823b02018-09-07 09:33:34 +0200125def path_to_msl_standard(shader):
Chip Davis3a9af962018-09-26 20:06:05 -0500126 if '.ios.' in shader:
127 if '.msl2.' in shader:
128 return '-std=ios-metal2.0'
129 elif '.msl21.' in shader:
130 return '-std=ios-metal2.1'
Hans-Kristian Arntzenfccf1d02019-06-12 09:30:41 +0200131 elif '.msl22.' in shader:
132 return '-std=ios-metal2.2'
Chip Davis2219c4a2020-09-28 23:07:55 -0500133 elif '.msl23.' in shader:
134 return '-std=ios-metal2.3'
丛越d52ec1e2021-10-21 17:46:45 +0800135 elif '.msl24.' in shader:
136 return '-std=ios-metal2.4'
Chip Davis3a9af962018-09-26 20:06:05 -0500137 elif '.msl11.' in shader:
138 return '-std=ios-metal1.1'
139 elif '.msl10.' in shader:
140 return '-std=ios-metal1.0'
141 else:
142 return '-std=ios-metal1.2'
Hans-Kristian Arntzen32823b02018-09-07 09:33:34 +0200143 else:
Chip Davis3a9af962018-09-26 20:06:05 -0500144 if '.msl2.' in shader:
145 return '-std=macos-metal2.0'
146 elif '.msl21.' in shader:
147 return '-std=macos-metal2.1'
Hans-Kristian Arntzenfccf1d02019-06-12 09:30:41 +0200148 elif '.msl22.' in shader:
149 return '-std=macos-metal2.2'
Chip Davis2219c4a2020-09-28 23:07:55 -0500150 elif '.msl23.' in shader:
151 return '-std=macos-metal2.3'
丛越d52ec1e2021-10-21 17:46:45 +0800152 elif '.msl24.' in shader:
153 return '-std=macos-metal2.4'
Chip Davis3a9af962018-09-26 20:06:05 -0500154 elif '.msl11.' in shader:
155 return '-std=macos-metal1.1'
156 else:
157 return '-std=macos-metal1.2'
Hans-Kristian Arntzen32823b02018-09-07 09:33:34 +0200158
Hans-Kristian Arntzen652d8262018-09-07 09:45:25 +0200159def path_to_msl_standard_cli(shader):
160 if '.msl2.' in shader:
161 return '20000'
162 elif '.msl21.' in shader:
163 return '20100'
Hans-Kristian Arntzenfccf1d02019-06-12 09:30:41 +0200164 elif '.msl22.' in shader:
165 return '20200'
Chip Davis2219c4a2020-09-28 23:07:55 -0500166 elif '.msl23.' in shader:
167 return '20300'
丛越d52ec1e2021-10-21 17:46:45 +0800168 elif '.msl24.' in shader:
169 return '20400'
Hans-Kristian Arntzen652d8262018-09-07 09:45:25 +0200170 elif '.msl11.' in shader:
171 return '10100'
172 else:
173 return '10200'
174
Hans-Kristian Arntzen230a0122017-11-21 09:52:53 +0100175def validate_shader_msl(shader, opt):
176 msl_path = reference_path(shader[0], shader[1], opt)
Bill Hollingsbe4cb172017-01-30 22:55:21 -0500177 try:
Chip Davis3a9af962018-09-26 20:06:05 -0500178 if '.ios.' in msl_path:
179 msl_os = 'iphoneos'
180 else:
181 msl_os = 'macosx'
Hans-Kristian Arntzen32823b02018-09-07 09:33:34 +0200182 subprocess.check_call(['xcrun', '--sdk', msl_os, 'metal', '-x', 'metal', path_to_msl_standard(msl_path), '-Werror', '-Wno-unused-variable', msl_path])
Bill Hollingsbe4cb172017-01-30 22:55:21 -0500183 print('Compiled Metal shader: ' + msl_path) # display after so xcrun FNF is silent
184 except OSError as oe:
Hans-Kristian Arntzen26107ba2018-07-02 13:12:58 +0200185 if (oe.errno != errno.ENOENT): # Ignore xcrun not found error
Bill Hollingsbe4cb172017-01-30 22:55:21 -0500186 raise
187 except subprocess.CalledProcessError:
188 print('Error compiling Metal shader: ' + msl_path)
Hans-Kristian Arntzen973b3152019-01-14 11:23:46 +0100189 raise RuntimeError('Failed to compile Metal shader')
Hans-Kristian Arntzen0a5b3a62016-03-22 14:44:12 +0100190
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200191def cross_compile_msl(shader, spirv, opt, iterations, paths):
Hans-Kristian Arntzencd442b92018-04-27 10:31:39 +0200192 spirv_path = create_temporary()
193 msl_path = create_temporary(os.path.basename(shader))
Hans-Kristian Arntzendb5d49f2017-09-29 11:07:11 +0200194
Hans-Kristian Arntzen6382f152021-10-13 15:52:04 +0200195 spirv_14 = '.spv14.' in shader
196 spirv_env = 'vulkan1.1spv1.4' if spirv_14 else 'vulkan1.1'
Hans-Kristian Arntzen9012a392020-01-06 11:47:26 +0100197
198 spirv_cmd = [paths.spirv_as, '--target-env', spirv_env, '-o', spirv_path, shader]
Hans-Kristian Arntzend2cc43e2019-02-19 17:00:49 +0100199 if '.preserve.' in shader:
200 spirv_cmd.append('--preserve-numeric-ids')
201
Hans-Kristian Arntzendb5d49f2017-09-29 11:07:11 +0200202 if spirv:
Hans-Kristian Arntzend2cc43e2019-02-19 17:00:49 +0100203 subprocess.check_call(spirv_cmd)
Hans-Kristian Arntzendb5d49f2017-09-29 11:07:11 +0200204 else:
Hans-Kristian Arntzen6382f152021-10-13 15:52:04 +0200205 glslang_env = 'spirv1.4' if spirv_14 else 'vulkan1.1'
206 subprocess.check_call([paths.glslang, '--amb' ,'--target-env', glslang_env, '-V', '-o', spirv_path, shader])
Hans-Kristian Arntzendb5d49f2017-09-29 11:07:11 +0200207
Dan Sinclaire5af4122019-11-05 10:59:41 -0500208 if opt and (not shader_is_invalid_spirv(shader)):
Lukas Hermannse1b161b2019-10-21 16:39:53 -0400209 if '.graphics-robust-access.' in shader:
210 subprocess.check_call([paths.spirv_opt, '--skip-validation', '-O', '--graphics-robust-access', '-o', spirv_path, spirv_path])
211 else:
212 subprocess.check_call([paths.spirv_opt, '--skip-validation', '-O', '-o', spirv_path, spirv_path])
Hans-Kristian Arntzen230a0122017-11-21 09:52:53 +0100213
Hans-Kristian Arntzen3a7cb0c2019-04-12 14:44:24 +0200214 spirv_cross_path = paths.spirv_cross
Hans-Kristian Arntzene8ca39b2018-04-03 14:26:24 +0200215
Hans-Kristian Arntzenc4ff1292021-01-04 09:40:11 +0100216 msl_args = [spirv_cross_path, '--output', msl_path, spirv_path, '--msl', '--iterations', str(iterations)]
Hans-Kristian Arntzen652d8262018-09-07 09:45:25 +0200217 msl_args.append('--msl-version')
218 msl_args.append(path_to_msl_standard_cli(shader))
Hans-Kristian Arntzenc4ff1292021-01-04 09:40:11 +0100219 if not '.nomain.' in shader:
220 msl_args.append('--entry')
221 msl_args.append('main')
Chip Davis25833212018-09-19 20:36:33 -0500222 if '.swizzle.' in shader:
223 msl_args.append('--msl-swizzle-texture-samples')
Chip Davis3a9af962018-09-26 20:06:05 -0500224 if '.ios.' in shader:
225 msl_args.append('--msl-ios')
Hans-Kristian Arntzenb8033d72019-01-14 14:53:47 +0100226 if '.pad-fragment.' in shader:
227 msl_args.append('--msl-pad-fragment-output')
Chip Davisc51e5b72019-01-08 16:33:32 -0600228 if '.capture.' in shader:
229 msl_args.append('--msl-capture-output')
Chip Davis41d94242019-02-05 23:47:50 -0600230 if '.domain.' in shader:
231 msl_args.append('--msl-domain-lower-left')
Hans-Kristian Arntzene47a77d2019-03-14 10:29:34 +0100232 if '.argument.' in shader:
233 msl_args.append('--msl-argument-buffers')
Hans-Kristian Arntzenfc4f39b2019-04-23 12:17:21 +0200234 if '.texture-buffer-native.' in shader:
235 msl_args.append('--msl-texture-buffer-native')
Lukas Hermannsf3a6d282019-09-27 15:49:54 -0400236 if '.framebuffer-fetch.' in shader:
237 msl_args.append('--msl-framebuffer-fetch')
Lukas Hermannsffbd8012019-10-09 11:22:25 -0400238 if '.invariant-float-math.' in shader:
239 msl_args.append('--msl-invariant-float-math')
Lukas Hermannsf3a6d282019-09-27 15:49:54 -0400240 if '.emulate-cube-array.' in shader:
241 msl_args.append('--msl-emulate-cube-array')
Hans-Kristian Arntzene2aadf82019-03-15 21:53:21 +0100242 if '.discrete.' in shader:
Hans-Kristian Arntzenb3380ec2019-03-15 14:07:03 +0100243 # Arbitrary for testing purposes.
Hans-Kristian Arntzene2aadf82019-03-15 21:53:21 +0100244 msl_args.append('--msl-discrete-descriptor-set')
Hans-Kristian Arntzenb3380ec2019-03-15 14:07:03 +0100245 msl_args.append('2')
Hans-Kristian Arntzene2aadf82019-03-15 21:53:21 +0100246 msl_args.append('--msl-discrete-descriptor-set')
Hans-Kristian Arntzenb3380ec2019-03-15 14:07:03 +0100247 msl_args.append('3')
Hans-Kristian Arntzenc3bd1362020-01-16 11:07:30 +0100248 if '.force-active.' in shader:
249 msl_args.append('--msl-force-active-argument-buffer-resources')
Hans-Kristian Arntzen65af09d2019-05-28 13:41:46 +0200250 if '.line.' in shader:
251 msl_args.append('--emit-line-directives')
Chip Davis7eecf5a2019-05-31 12:06:20 -0500252 if '.multiview.' in shader:
253 msl_args.append('--msl-multiview')
Chip Daviscab73352020-08-23 16:44:41 -0500254 if '.no-layered.' in shader:
255 msl_args.append('--msl-multiview-no-layered-rendering')
Chip Davis6a585542019-07-12 21:50:50 -0500256 if '.viewfromdev.' in shader:
257 msl_args.append('--msl-view-index-from-device-index')
Chip Davisfb5ee4c2019-07-22 13:08:04 -0500258 if '.dispatchbase.' in shader:
259 msl_args.append('--msl-dispatch-base')
Chip Daviscb359342019-09-05 23:14:12 -0500260 if '.dynamic-buffer.' in shader:
261 # Arbitrary for testing purposes.
262 msl_args.append('--msl-dynamic-buffer')
263 msl_args.append('0')
264 msl_args.append('0')
265 msl_args.append('--msl-dynamic-buffer')
266 msl_args.append('1')
267 msl_args.append('2')
Chip Davisfedbc352019-12-16 22:58:16 -0600268 if '.inline-block.' in shader:
269 # Arbitrary for testing purposes.
270 msl_args.append('--msl-inline-uniform-block')
271 msl_args.append('0')
272 msl_args.append('0')
Hans-Kristian Arntzen4bb673a2019-10-14 12:51:48 +0200273 if '.device-argument-buffer.' in shader:
274 msl_args.append('--msl-device-argument-buffer')
275 msl_args.append('0')
276 msl_args.append('--msl-device-argument-buffer')
277 msl_args.append('1')
Hans-Kristian Arntzenc9d4f9c2020-02-24 12:47:14 +0100278 if '.force-native-array.' in shader:
279 msl_args.append('--msl-force-native-arrays')
Hans-Kristian Arntzenb8905bb2020-03-26 11:21:23 +0100280 if '.zero-initialize.' in shader:
281 msl_args.append('--force-zero-initialized-variables')
Chip Davisb29f83c2020-04-10 01:13:33 -0500282 if '.frag-output.' in shader:
283 # Arbitrary for testing purposes.
284 msl_args.append('--msl-disable-frag-depth-builtin')
285 msl_args.append('--msl-disable-frag-stencil-ref-builtin')
286 msl_args.append('--msl-enable-frag-output-mask')
287 msl_args.append('0x000000ca')
Hans-Kristian Arntzenebf46362020-04-20 09:48:20 +0200288 if '.no-user-varying.' in shader:
289 msl_args.append('--msl-no-clip-distance-user-varying')
Chip Davis5281d992020-06-13 23:03:30 -0500290 if '.shader-inputs.' in shader:
291 # Arbitrary for testing purposes.
292 msl_args.append('--msl-shader-input')
293 msl_args.append('0')
294 msl_args.append('u8')
295 msl_args.append('2')
296 msl_args.append('--msl-shader-input')
297 msl_args.append('1')
298 msl_args.append('u16')
299 msl_args.append('3')
300 msl_args.append('--msl-shader-input')
301 msl_args.append('6')
302 msl_args.append('other')
303 msl_args.append('4')
Chip Davis688c5fc2020-02-20 21:38:28 -0600304 if '.multi-patch.' in shader:
305 msl_args.append('--msl-multi-patch-workgroup')
306 # Arbitrary for testing purposes.
307 msl_args.append('--msl-shader-input')
308 msl_args.append('0')
309 msl_args.append('any32')
310 msl_args.append('3')
311 msl_args.append('--msl-shader-input')
312 msl_args.append('1')
313 msl_args.append('any16')
314 msl_args.append('2')
315 if '.for-tess.' in shader:
316 msl_args.append('--msl-vertex-for-tessellation')
Tomek Ponitka18f23c42020-07-22 18:37:17 +0200317 if '.fixed-sample-mask.' in shader:
318 msl_args.append('--msl-additional-fixed-sample-mask')
319 msl_args.append('0x00000022')
Chip Davis4cf840e2020-08-27 19:24:20 -0500320 if '.arrayed-subpass.' in shader:
321 msl_args.append('--msl-arrayed-subpass-input')
Chip Davis5845e002020-10-14 20:48:52 -0500322 if '.1d-as-2d.' in shader:
323 msl_args.append('--msl-texture-1d-as-2d')
Chip Davis68908352020-11-18 23:16:46 -0600324 if '.simd.' in shader:
325 msl_args.append('--msl-ios-use-simdgroup-functions')
326 if '.emulate-subgroup.' in shader:
327 msl_args.append('--msl-emulate-subgroups')
328 if '.fixed-subgroup.' in shader:
329 # Arbitrary for testing purposes.
330 msl_args.append('--msl-fixed-subgroup-size')
331 msl_args.append('32')
Chip Davisfd738e32020-11-20 15:41:46 -0600332 if '.force-sample.' in shader:
333 msl_args.append('--msl-force-sample-rate-shading')
Hans-Kristian Arntzen3136e342021-01-07 14:30:35 +0100334 if '.decoration-binding.' in shader:
335 msl_args.append('--msl-decoration-binding')
Hans-Kristian Arntzen88b54f52021-04-06 11:49:07 +0200336 if '.mask-location-0.' in shader:
337 msl_args.append('--mask-stage-output-location')
338 msl_args.append('0')
339 msl_args.append('0')
340 if '.mask-location-1.' in shader:
341 msl_args.append('--mask-stage-output-location')
342 msl_args.append('1')
343 msl_args.append('0')
344 if '.mask-position.' in shader:
345 msl_args.append('--mask-stage-output-builtin')
346 msl_args.append('Position')
347 if '.mask-point-size.' in shader:
348 msl_args.append('--mask-stage-output-builtin')
349 msl_args.append('PointSize')
350 if '.mask-clip-distance.' in shader:
351 msl_args.append('--mask-stage-output-builtin')
352 msl_args.append('ClipDistance')
Hans-Kristian Arntzene8ca39b2018-04-03 14:26:24 +0200353
354 subprocess.check_call(msl_args)
Hans-Kristian Arntzen146ea762018-04-11 10:28:39 +0200355
356 if not shader_is_invalid_spirv(msl_path):
Hans-Kristian Arntzen9012a392020-01-06 11:47:26 +0100357 subprocess.check_call([paths.spirv_val, '--scalar-block-layout', '--target-env', spirv_env, spirv_path])
Hans-Kristian Arntzen146ea762018-04-11 10:28:39 +0200358
Hans-Kristian Arntzen1c28ec62017-01-18 19:05:57 +0100359 return (spirv_path, msl_path)
360
Hans-Kristian Arntzen95073252017-12-12 11:03:46 +0100361def shader_model_hlsl(shader):
362 if '.vert' in shader:
Hans-Kristian Arntzen0312c982018-09-12 09:44:35 +0200363 if '.sm30.' in shader:
364 return '-Tvs_3_0'
365 else:
366 return '-Tvs_5_1'
Hans-Kristian Arntzen95073252017-12-12 11:03:46 +0100367 elif '.frag' in shader:
Hans-Kristian Arntzen0312c982018-09-12 09:44:35 +0200368 if '.sm30.' in shader:
369 return '-Tps_3_0'
370 else:
371 return '-Tps_5_1'
Hans-Kristian Arntzen95073252017-12-12 11:03:46 +0100372 elif '.comp' in shader:
373 return '-Tcs_5_1'
374 else:
375 return None
376
Hans-Kristian Arntzen789fa912017-12-12 13:23:56 +0100377def shader_to_win_path(shader):
378 # It's (very) convenient to be able to run HLSL testing in wine on Unix-likes, so support that.
379 try:
380 with subprocess.Popen(['winepath', '-w', shader], stdout = subprocess.PIPE, stderr = subprocess.PIPE) as f:
381 stdout_data, stderr_data = f.communicate()
382 return stdout_data.decode('utf-8')
383 except OSError as oe:
Hans-Kristian Arntzen26107ba2018-07-02 13:12:58 +0200384 if (oe.errno != errno.ENOENT): # Ignore not found errors
Hans-Kristian Arntzen789fa912017-12-12 13:23:56 +0100385 return shader
386 except subprocess.CalledProcessError:
387 raise
388
Hans-Kristian Arntzen51a48a72017-12-12 13:33:13 +0100389 return shader
390
Hans-Kristian Arntzend0c829b2018-04-18 16:43:28 +0200391ignore_fxc = False
Hans-Kristian Arntzen074f7652019-03-07 12:36:16 +0100392def validate_shader_hlsl(shader, force_no_external_validation, paths):
Hans-Kristian Arntzenc7eda1b2019-07-17 11:24:31 +0200393 test_glslang = True
394 if '.nonuniformresource.' in shader:
395 test_glslang = False
396 if '.fxconly.' in shader:
397 test_glslang = False
398
Hans-Kristian Arntzen8f716942020-07-01 11:37:03 +0200399 hlsl_args = [paths.glslang, '--amb', '-e', 'main', '-D', '--target-env', 'vulkan1.1', '-V', shader]
400 if '.sm30.' in shader:
401 hlsl_args.append('--hlsl-dx9-compatible')
402
Hans-Kristian Arntzenc7eda1b2019-07-17 11:24:31 +0200403 if test_glslang:
Hans-Kristian Arntzen8f716942020-07-01 11:37:03 +0200404 subprocess.check_call(hlsl_args)
405
Hans-Kristian Arntzen789fa912017-12-12 13:23:56 +0100406 is_no_fxc = '.nofxc.' in shader
Hans-Kristian Arntzend0c829b2018-04-18 16:43:28 +0200407 global ignore_fxc
Hans-Kristian Arntzen6157bf32018-10-26 10:53:11 +0200408 if (not ignore_fxc) and (not force_no_external_validation) and (not is_no_fxc):
Hans-Kristian Arntzen789fa912017-12-12 13:23:56 +0100409 try:
410 win_path = shader_to_win_path(shader)
Hans-Kristian Arntzen647ddae2019-05-13 14:58:27 +0200411 args = ['fxc', '-nologo', shader_model_hlsl(shader), win_path]
412 if '.nonuniformresource.' in shader:
413 args.append('/enable_unbounded_descriptor_tables')
414 subprocess.check_call(args)
Hans-Kristian Arntzen789fa912017-12-12 13:23:56 +0100415 except OSError as oe:
Hans-Kristian Arntzen26107ba2018-07-02 13:12:58 +0200416 if (oe.errno != errno.ENOENT): # Ignore not found errors
Hans-Kristian Arntzen973b3152019-01-14 11:23:46 +0100417 print('Failed to run FXC.')
418 ignore_fxc = True
Hans-Kristian Arntzen789fa912017-12-12 13:23:56 +0100419 raise
Hans-Kristian Arntzend0c829b2018-04-18 16:43:28 +0200420 else:
Hans-Kristian Arntzen973b3152019-01-14 11:23:46 +0100421 print('Could not find FXC.')
Hans-Kristian Arntzend0c829b2018-04-18 16:43:28 +0200422 ignore_fxc = True
Hans-Kristian Arntzen789fa912017-12-12 13:23:56 +0100423 except subprocess.CalledProcessError:
424 print('Failed compiling HLSL shader:', shader, 'with FXC.')
Hans-Kristian Arntzen973b3152019-01-14 11:23:46 +0100425 raise RuntimeError('Failed compiling HLSL shader')
Robert Konradddbeea22017-01-26 11:46:29 +0100426
Hans-Kristian Arntzenecf56cf2017-06-30 10:34:21 +0200427def shader_to_sm(shader):
Hans-Kristian Arntzen2d520062020-06-04 11:35:21 +0200428 if '.sm62.' in shader:
429 return '62'
430 elif '.sm60.' in shader:
Hans-Kristian Arntzenc2664292018-04-11 15:02:02 +0200431 return '60'
432 elif '.sm51.' in shader:
Hans-Kristian Arntzenecf56cf2017-06-30 10:34:21 +0200433 return '51'
crosire3d396522018-09-11 20:57:56 +0200434 elif '.sm30.' in shader:
435 return '30'
Hans-Kristian Arntzenecf56cf2017-06-30 10:34:21 +0200436 else:
437 return '50'
438
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200439def cross_compile_hlsl(shader, spirv, opt, force_no_external_validation, iterations, paths):
Hans-Kristian Arntzencd442b92018-04-27 10:31:39 +0200440 spirv_path = create_temporary()
441 hlsl_path = create_temporary(os.path.basename(shader))
Hans-Kristian Arntzendb5d49f2017-09-29 11:07:11 +0200442
Hans-Kristian Arntzen6382f152021-10-13 15:52:04 +0200443 spirv_14 = '.spv14.' in shader
444 spirv_env = 'vulkan1.1spv1.4' if spirv_14 else 'vulkan1.1'
Hans-Kristian Arntzenea02a0c2021-01-22 13:48:16 +0100445 spirv_cmd = [paths.spirv_as, '--target-env', spirv_env, '-o', spirv_path, shader]
Hans-Kristian Arntzend2cc43e2019-02-19 17:00:49 +0100446 if '.preserve.' in shader:
447 spirv_cmd.append('--preserve-numeric-ids')
448
Hans-Kristian Arntzendb5d49f2017-09-29 11:07:11 +0200449 if spirv:
Hans-Kristian Arntzend2cc43e2019-02-19 17:00:49 +0100450 subprocess.check_call(spirv_cmd)
Hans-Kristian Arntzendb5d49f2017-09-29 11:07:11 +0200451 else:
Hans-Kristian Arntzen6382f152021-10-13 15:52:04 +0200452 glslang_env = 'spirv1.4' if spirv_14 else 'vulkan1.1'
453 subprocess.check_call([paths.glslang, '--amb', '--target-env', glslang_env, '-V', '-o', spirv_path, shader])
Hans-Kristian Arntzendb5d49f2017-09-29 11:07:11 +0200454
Dan Sinclaire5af4122019-11-05 10:59:41 -0500455 if opt and (not shader_is_invalid_spirv(hlsl_path)):
Hans-Kristian Arntzen074f7652019-03-07 12:36:16 +0100456 subprocess.check_call([paths.spirv_opt, '--skip-validation', '-O', '-o', spirv_path, spirv_path])
Hans-Kristian Arntzen230a0122017-11-21 09:52:53 +0100457
Hans-Kristian Arntzen3a7cb0c2019-04-12 14:44:24 +0200458 spirv_cross_path = paths.spirv_cross
Hans-Kristian Arntzenecf56cf2017-06-30 10:34:21 +0200459
460 sm = shader_to_sm(shader)
Hans-Kristian Arntzen65af09d2019-05-28 13:41:46 +0200461
462 hlsl_args = [spirv_cross_path, '--entry', 'main', '--output', hlsl_path, spirv_path, '--hlsl-enable-compat', '--hlsl', '--shader-model', sm, '--iterations', str(iterations)]
463 if '.line.' in shader:
464 hlsl_args.append('--emit-line-directives')
Hans-Kristian Arntzenc27e1ef2020-03-04 16:32:52 +0100465 if '.force-uav.' in shader:
466 hlsl_args.append('--hlsl-force-storage-buffer-as-uav')
Hans-Kristian Arntzenb8905bb2020-03-26 11:21:23 +0100467 if '.zero-initialize.' in shader:
468 hlsl_args.append('--force-zero-initialized-variables')
Hans-Kristian Arntzen28bf9052020-04-03 11:21:41 +0200469 if '.nonwritable-uav-texture.' in shader:
470 hlsl_args.append('--hlsl-nonwritable-uav-texture-as-srv')
Hans-Kristian Arntzen2d520062020-06-04 11:35:21 +0200471 if '.native-16bit.' in shader:
472 hlsl_args.append('--hlsl-enable-16bit-types')
Hans-Kristian Arntzenb3344172020-11-03 11:18:32 +0100473 if '.flatten-matrix-vertex-input.' in shader:
474 hlsl_args.append('--hlsl-flatten-matrix-vertex-input-semantics')
Hans-Kristian Arntzenb8905bb2020-03-26 11:21:23 +0100475
Hans-Kristian Arntzen65af09d2019-05-28 13:41:46 +0200476 subprocess.check_call(hlsl_args)
Hans-Kristian Arntzen146ea762018-04-11 10:28:39 +0200477
478 if not shader_is_invalid_spirv(hlsl_path):
Hans-Kristian Arntzenea02a0c2021-01-22 13:48:16 +0100479 subprocess.check_call([paths.spirv_val, '--scalar-block-layout', '--target-env', spirv_env, spirv_path])
Robert Konradcec9c702017-01-26 09:45:17 +0100480
Hans-Kristian Arntzen074f7652019-03-07 12:36:16 +0100481 validate_shader_hlsl(hlsl_path, force_no_external_validation, paths)
Dan Sinclaire5af4122019-11-05 10:59:41 -0500482
Robert Konrade7179532017-01-26 10:06:05 +0100483 return (spirv_path, hlsl_path)
Robert Konradcec9c702017-01-26 09:45:17 +0100484
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200485def cross_compile_reflect(shader, spirv, opt, iterations, paths):
Brad Davis709d3c62018-06-03 11:16:37 -0700486 spirv_path = create_temporary()
487 reflect_path = create_temporary(os.path.basename(shader))
488
Ryan Harrisond3c59e72019-05-08 14:03:35 -0400489 spirv_cmd = [paths.spirv_as, '--target-env', 'vulkan1.1', '-o', spirv_path, shader]
Hans-Kristian Arntzend2cc43e2019-02-19 17:00:49 +0100490 if '.preserve.' in shader:
491 spirv_cmd.append('--preserve-numeric-ids')
492
Brad Davis709d3c62018-06-03 11:16:37 -0700493 if spirv:
Hans-Kristian Arntzend2cc43e2019-02-19 17:00:49 +0100494 subprocess.check_call(spirv_cmd)
Brad Davis709d3c62018-06-03 11:16:37 -0700495 else:
Ryan Harrisoncf1bf1c2019-09-18 15:56:51 -0400496 subprocess.check_call([paths.glslang, '--amb', '--target-env', 'vulkan1.1', '-V', '-o', spirv_path, shader])
Brad Davis709d3c62018-06-03 11:16:37 -0700497
Dan Sinclaire5af4122019-11-05 10:59:41 -0500498 if opt and (not shader_is_invalid_spirv(reflect_path)):
Hans-Kristian Arntzen074f7652019-03-07 12:36:16 +0100499 subprocess.check_call([paths.spirv_opt, '--skip-validation', '-O', '-o', spirv_path, spirv_path])
Brad Davis709d3c62018-06-03 11:16:37 -0700500
Hans-Kristian Arntzen3a7cb0c2019-04-12 14:44:24 +0200501 spirv_cross_path = paths.spirv_cross
Brad Davis709d3c62018-06-03 11:16:37 -0700502
503 sm = shader_to_sm(shader)
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200504 subprocess.check_call([spirv_cross_path, '--entry', 'main', '--output', reflect_path, spirv_path, '--reflect', '--iterations', str(iterations)])
Brad Davis709d3c62018-06-03 11:16:37 -0700505 return (spirv_path, reflect_path)
506
Hans-Kristian Arntzen074f7652019-03-07 12:36:16 +0100507def validate_shader(shader, vulkan, paths):
Arseny Kapoulkinef45075b2017-01-24 22:26:39 -0800508 if vulkan:
Hans-Kristian Arntzen2097c302021-01-08 11:37:29 +0100509 spirv_14 = '.spv14.' in shader
510 glslang_env = 'spirv1.4' if spirv_14 else 'vulkan1.1'
511 subprocess.check_call([paths.glslang, '--amb', '--target-env', glslang_env, '-V', shader])
Arseny Kapoulkinef45075b2017-01-24 22:26:39 -0800512 else:
Hans-Kristian Arntzen074f7652019-03-07 12:36:16 +0100513 subprocess.check_call([paths.glslang, shader])
Arseny Kapoulkinef45075b2017-01-24 22:26:39 -0800514
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200515def cross_compile(shader, vulkan, spirv, invalid_spirv, eliminate, is_legacy, flatten_ubo, sso, flatten_dim, opt, push_ubo, iterations, paths):
Hans-Kristian Arntzencd442b92018-04-27 10:31:39 +0200516 spirv_path = create_temporary()
517 glsl_path = create_temporary(os.path.basename(shader))
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +0100518
Hans-Kristian Arntzen2097c302021-01-08 11:37:29 +0100519 spirv_14 = '.spv14.' in shader
520 spirv_env = 'vulkan1.1spv1.4' if spirv_14 else 'vulkan1.1'
Hans-Kristian Arntzen9012a392020-01-06 11:47:26 +0100521
Hans-Kristian Arntzen45ad58a2016-05-10 23:39:41 +0200522 if vulkan or spirv:
Hans-Kristian Arntzencd442b92018-04-27 10:31:39 +0200523 vulkan_glsl_path = create_temporary('vk' + os.path.basename(shader))
Hans-Kristian Arntzendbee4e42016-05-05 10:16:22 +0200524
Hans-Kristian Arntzen9012a392020-01-06 11:47:26 +0100525 spirv_cmd = [paths.spirv_as, '--target-env', spirv_env, '-o', spirv_path, shader]
Hans-Kristian Arntzend2cc43e2019-02-19 17:00:49 +0100526 if '.preserve.' in shader:
527 spirv_cmd.append('--preserve-numeric-ids')
528
Hans-Kristian Arntzen45ad58a2016-05-10 23:39:41 +0200529 if spirv:
Hans-Kristian Arntzend2cc43e2019-02-19 17:00:49 +0100530 subprocess.check_call(spirv_cmd)
Hans-Kristian Arntzen45ad58a2016-05-10 23:39:41 +0200531 else:
Hans-Kristian Arntzen2097c302021-01-08 11:37:29 +0100532 glslang_env = 'spirv1.4' if spirv_14 else 'vulkan1.1'
533 subprocess.check_call([paths.glslang, '--amb', '--target-env', glslang_env, '-V', '-o', spirv_path, shader])
Hans-Kristian Arntzen45ad58a2016-05-10 23:39:41 +0200534
Hans-Kristian Arntzencdca1922017-11-21 16:52:01 +0100535 if opt and (not invalid_spirv):
Hans-Kristian Arntzen074f7652019-03-07 12:36:16 +0100536 subprocess.check_call([paths.spirv_opt, '--skip-validation', '-O', '-o', spirv_path, spirv_path])
Hans-Kristian Arntzen230a0122017-11-21 09:52:53 +0100537
Hans-Kristian Arntzen706d3ea2016-09-12 20:11:30 +0200538 if not invalid_spirv:
Hans-Kristian Arntzen9012a392020-01-06 11:47:26 +0100539 subprocess.check_call([paths.spirv_val, '--scalar-block-layout', '--target-env', spirv_env, spirv_path])
Hans-Kristian Arntzendbee4e42016-05-05 10:16:22 +0200540
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200541 extra_args = ['--iterations', str(iterations)]
Arseny Kapoulkine24c66252017-01-16 14:19:49 -0800542 if eliminate:
543 extra_args += ['--remove-unused-variables']
Hans-Kristian Arntzen41f7e5b2017-01-13 16:41:27 +0100544 if is_legacy:
Arseny Kapoulkine24c66252017-01-16 14:19:49 -0800545 extra_args += ['--version', '100', '--es']
546 if flatten_ubo:
547 extra_args += ['--flatten-ubo']
Hans-Kristian Arntzen36650c82017-05-22 15:30:43 +0200548 if sso:
549 extra_args += ['--separate-shader-objects']
Hans-Kristian Arntzen470ae7a2017-05-22 17:40:00 +0200550 if flatten_dim:
551 extra_args += ['--flatten-multidimensional-arrays']
Hans-Kristian Arntzen04748482019-03-19 10:58:37 +0100552 if push_ubo:
553 extra_args += ['--glsl-emit-push-constant-as-ubo']
Hans-Kristian Arntzen65af09d2019-05-28 13:41:46 +0200554 if '.line.' in shader:
555 extra_args += ['--emit-line-directives']
Hans-Kristian Arntzen12ca9d12019-07-25 11:07:14 +0200556 if '.no-samplerless.' in shader:
557 extra_args += ['--vulkan-glsl-disable-ext-samplerless-texture-functions']
Hans-Kristian Arntzen95cd20f2020-03-04 16:41:00 +0100558 if '.no-qualifier-deduction.' in shader:
559 extra_args += ['--disable-storage-image-qualifier-deduction']
Hans-Kristian Arntzen04e877d2020-03-19 14:20:37 +0100560 if '.framebuffer-fetch.' in shader:
561 extra_args += ['--glsl-remap-ext-framebuffer-fetch', '0', '0']
562 extra_args += ['--glsl-remap-ext-framebuffer-fetch', '1', '1']
563 extra_args += ['--glsl-remap-ext-framebuffer-fetch', '2', '2']
564 extra_args += ['--glsl-remap-ext-framebuffer-fetch', '3', '3']
Hans-Kristian Arntzen26a49862021-05-21 14:21:13 +0200565 if '.framebuffer-fetch-noncoherent.' in shader:
566 extra_args += ['--glsl-ext-framebuffer-fetch-noncoherent']
Hans-Kristian Arntzenb8905bb2020-03-26 11:21:23 +0100567 if '.zero-initialize.' in shader:
568 extra_args += ['--force-zero-initialized-variables']
Hans-Kristian Arntzen57c93d42020-07-28 15:15:24 +0200569 if '.force-flattened-io.' in shader:
570 extra_args += ['--glsl-force-flattened-io-blocks']
Hans-Kristian Arntzen41f7e5b2017-01-13 16:41:27 +0100571
Hans-Kristian Arntzen3a7cb0c2019-04-12 14:44:24 +0200572 spirv_cross_path = paths.spirv_cross
Hans-Kristian Arntzendbee4e42016-05-05 10:16:22 +0200573
Hans-Kristian Arntzen8869a162016-05-11 19:55:57 +0200574 # A shader might not be possible to make valid GLSL from, skip validation for this case.
Hans-Kristian Arntzen04e877d2020-03-19 14:20:37 +0100575 if (not ('nocompat' in glsl_path)) or (not vulkan):
Hans-Kristian Arntzen146ea762018-04-11 10:28:39 +0200576 subprocess.check_call([spirv_cross_path, '--entry', 'main', '--output', glsl_path, spirv_path] + extra_args)
Hans-Kristian Arntzen04e877d2020-03-19 14:20:37 +0100577 if not 'nocompat' in glsl_path:
578 validate_shader(glsl_path, False, paths)
Hans-Kristian Arntzen146ea762018-04-11 10:28:39 +0200579 else:
Hans-Kristian Arntzencd442b92018-04-27 10:31:39 +0200580 remove_file(glsl_path)
Hans-Kristian Arntzen146ea762018-04-11 10:28:39 +0200581 glsl_path = None
Hans-Kristian Arntzendbee4e42016-05-05 10:16:22 +0200582
Hans-Kristian Arntzenbae76d72020-06-29 12:50:31 +0200583 if (vulkan or spirv) and (not is_legacy):
Hans-Kristian Arntzence18d1b2021-01-08 10:47:46 +0100584 subprocess.check_call([spirv_cross_path, '--entry', 'main', '-V', '--output', vulkan_glsl_path, spirv_path] + extra_args)
Hans-Kristian Arntzen074f7652019-03-07 12:36:16 +0100585 validate_shader(vulkan_glsl_path, True, paths)
Hans-Kristian Arntzencd442b92018-04-27 10:31:39 +0200586 # SPIR-V shaders might just want to validate Vulkan GLSL output, we don't always care about the output.
587 if not vulkan:
588 remove_file(vulkan_glsl_path)
Hans-Kristian Arntzendbee4e42016-05-05 10:16:22 +0200589
590 return (spirv_path, glsl_path, vulkan_glsl_path if vulkan else None)
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +0100591
Hans-Kristian Arntzenad0c5c62017-02-04 10:19:44 +0100592def make_unix_newline(buf):
593 decoded = codecs.decode(buf, 'utf-8')
594 decoded = decoded.replace('\r', '')
595 return codecs.encode(decoded, 'utf-8')
596
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +0100597def md5_for_file(path):
598 md5 = hashlib.md5()
599 with open(path, 'rb') as f:
Hans-Kristian Arntzenad0c5c62017-02-04 10:19:44 +0100600 for chunk in iter(lambda: make_unix_newline(f.read(8192)), b''):
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +0100601 md5.update(chunk)
602 return md5.digest()
603
604def make_reference_dir(path):
605 base = os.path.dirname(path)
606 if not os.path.exists(base):
607 os.makedirs(base)
608
Hans-Kristian Arntzen230a0122017-11-21 09:52:53 +0100609def reference_path(directory, relpath, opt):
Hans-Kristian Arntzen78c9a802016-05-11 19:39:38 +0200610 split_paths = os.path.split(directory)
Hans-Kristian Arntzen230a0122017-11-21 09:52:53 +0100611 reference_dir = os.path.join(split_paths[0], 'reference/' + ('opt/' if opt else ''))
Hans-Kristian Arntzen78c9a802016-05-11 19:39:38 +0200612 reference_dir = os.path.join(reference_dir, split_paths[1])
613 return os.path.join(reference_dir, relpath)
614
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200615def regression_check_reflect(shader, json_file, args):
616 reference = reference_path(shader[0], shader[1], args.opt) + '.json'
Brad Davis709d3c62018-06-03 11:16:37 -0700617 joined_path = os.path.join(shader[0], shader[1])
618 print('Reference shader reflection path:', reference)
619 if os.path.exists(reference):
Hans-Kristian Arntzen309e9942019-10-04 11:04:52 +0200620 actual = md5_for_file(json_file)
621 expected = md5_for_file(reference)
622 if actual != expected:
Hans-Kristian Arntzen9ae91c22019-04-10 11:33:52 +0200623 if args.update:
Brad Davis709d3c62018-06-03 11:16:37 -0700624 print('Generated reflection json has changed for {}!'.format(reference))
625 # If we expect changes, update the reference file.
626 if os.path.exists(reference):
627 remove_file(reference)
628 make_reference_dir(reference)
629 shutil.move(json_file, reference)
630 else:
631 print('Generated reflection json in {} does not match reference {}!'.format(json_file, reference))
632 with open(json_file, 'r') as f:
633 print('')
634 print('Generated:')
635 print('======================')
636 print(f.read())
637 print('======================')
638 print('')
639
640 # Otherwise, fail the test. Keep the shader file around so we can inspect.
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200641 if not args.keep:
Brad Davis709d3c62018-06-03 11:16:37 -0700642 remove_file(json_file)
Hans-Kristian Arntzen973b3152019-01-14 11:23:46 +0100643
644 raise RuntimeError('Does not match reference')
Brad Davis709d3c62018-06-03 11:16:37 -0700645 else:
646 remove_file(json_file)
647 else:
648 print('Found new shader {}. Placing generated source code in {}'.format(joined_path, reference))
649 make_reference_dir(reference)
650 shutil.move(json_file, reference)
Dan Sinclaire5af4122019-11-05 10:59:41 -0500651
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200652def regression_check(shader, glsl, args):
653 reference = reference_path(shader[0], shader[1], args.opt)
Hans-Kristian Arntzen78c9a802016-05-11 19:39:38 +0200654 joined_path = os.path.join(shader[0], shader[1])
655 print('Reference shader path:', reference)
656
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +0100657 if os.path.exists(reference):
658 if md5_for_file(glsl) != md5_for_file(reference):
Hans-Kristian Arntzen9ae91c22019-04-10 11:33:52 +0200659 if args.update:
Bill Hollings77f58122017-08-11 14:54:58 -0400660 print('Generated source code has changed for {}!'.format(reference))
Hans-Kristian Arntzen0a5b3a62016-03-22 14:44:12 +0100661 # If we expect changes, update the reference file.
662 if os.path.exists(reference):
Hans-Kristian Arntzencd442b92018-04-27 10:31:39 +0200663 remove_file(reference)
Hans-Kristian Arntzen0a5b3a62016-03-22 14:44:12 +0100664 make_reference_dir(reference)
665 shutil.move(glsl, reference)
666 else:
Bill Hollings77f58122017-08-11 14:54:58 -0400667 print('Generated source code in {} does not match reference {}!'.format(glsl, reference))
Hans-Kristian Arntzen45c797d2016-12-16 13:48:30 +0100668 with open(glsl, 'r') as f:
669 print('')
670 print('Generated:')
671 print('======================')
672 print(f.read())
673 print('======================')
674 print('')
675
Hans-Kristian Arntzene50e04c2016-03-22 14:56:50 +0100676 # Otherwise, fail the test. Keep the shader file around so we can inspect.
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200677 if not args.keep:
Hans-Kristian Arntzencd442b92018-04-27 10:31:39 +0200678 remove_file(glsl)
Hans-Kristian Arntzen973b3152019-01-14 11:23:46 +0100679 raise RuntimeError('Does not match reference')
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +0100680 else:
Hans-Kristian Arntzencd442b92018-04-27 10:31:39 +0200681 remove_file(glsl)
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +0100682 else:
Bill Hollings77f58122017-08-11 14:54:58 -0400683 print('Found new shader {}. Placing generated source code in {}'.format(joined_path, reference))
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +0100684 make_reference_dir(reference)
685 shutil.move(glsl, reference)
686
Hans-Kristian Arntzen8869a162016-05-11 19:55:57 +0200687def shader_is_vulkan(shader):
688 return '.vk.' in shader
689
Hans-Kristian Arntzen2c7d2e42016-07-11 12:47:46 +0200690def shader_is_desktop(shader):
691 return '.desktop.' in shader
692
Hans-Kristian Arntzenf61a5d12016-08-26 12:58:50 +0200693def shader_is_eliminate_dead_variables(shader):
694 return '.noeliminate.' not in shader
695
Hans-Kristian Arntzen45ad58a2016-05-10 23:39:41 +0200696def shader_is_spirv(shader):
697 return '.asm.' in shader
698
Hans-Kristian Arntzen706d3ea2016-09-12 20:11:30 +0200699def shader_is_invalid_spirv(shader):
700 return '.invalid.' in shader
701
Hans-Kristian Arntzen41f7e5b2017-01-13 16:41:27 +0100702def shader_is_legacy(shader):
703 return '.legacy.' in shader
704
Arseny Kapoulkine24c66252017-01-16 14:19:49 -0800705def shader_is_flatten_ubo(shader):
706 return '.flatten.' in shader
707
Hans-Kristian Arntzen36650c82017-05-22 15:30:43 +0200708def shader_is_sso(shader):
709 return '.sso.' in shader
710
Hans-Kristian Arntzen470ae7a2017-05-22 17:40:00 +0200711def shader_is_flatten_dimensions(shader):
712 return '.flatten_dim.' in shader
713
Hans-Kristian Arntzen7e02f7f2017-11-22 11:04:29 +0100714def shader_is_noopt(shader):
715 return '.noopt.' in shader
716
Hans-Kristian Arntzen04748482019-03-19 10:58:37 +0100717def shader_is_push_ubo(shader):
718 return '.push-ubo.' in shader
719
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200720def test_shader(stats, shader, args, paths):
Hans-Kristian Arntzen78c9a802016-05-11 19:39:38 +0200721 joined_path = os.path.join(shader[0], shader[1])
Hans-Kristian Arntzen8869a162016-05-11 19:55:57 +0200722 vulkan = shader_is_vulkan(shader[1])
Hans-Kristian Arntzen2c7d2e42016-07-11 12:47:46 +0200723 desktop = shader_is_desktop(shader[1])
Hans-Kristian Arntzenf61a5d12016-08-26 12:58:50 +0200724 eliminate = shader_is_eliminate_dead_variables(shader[1])
Hans-Kristian Arntzenb6847162016-09-10 12:52:23 +0200725 is_spirv = shader_is_spirv(shader[1])
Hans-Kristian Arntzen706d3ea2016-09-12 20:11:30 +0200726 invalid_spirv = shader_is_invalid_spirv(shader[1])
Hans-Kristian Arntzen41f7e5b2017-01-13 16:41:27 +0100727 is_legacy = shader_is_legacy(shader[1])
Arseny Kapoulkine24c66252017-01-16 14:19:49 -0800728 flatten_ubo = shader_is_flatten_ubo(shader[1])
Hans-Kristian Arntzen36650c82017-05-22 15:30:43 +0200729 sso = shader_is_sso(shader[1])
Hans-Kristian Arntzen470ae7a2017-05-22 17:40:00 +0200730 flatten_dim = shader_is_flatten_dimensions(shader[1])
Hans-Kristian Arntzen7e02f7f2017-11-22 11:04:29 +0100731 noopt = shader_is_noopt(shader[1])
Hans-Kristian Arntzen04748482019-03-19 10:58:37 +0100732 push_ubo = shader_is_push_ubo(shader[1])
Hans-Kristian Arntzen78c9a802016-05-11 19:39:38 +0200733
734 print('Testing shader:', joined_path)
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200735 spirv, glsl, vulkan_glsl = cross_compile(joined_path, vulkan, is_spirv, invalid_spirv, eliminate, is_legacy, flatten_ubo, sso, flatten_dim, args.opt and (not noopt), push_ubo, args.iterations, paths)
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +0100736
Hans-Kristian Arntzen8869a162016-05-11 19:55:57 +0200737 # Only test GLSL stats if we have a shader following GL semantics.
Hans-Kristian Arntzenb6847162016-09-10 12:52:23 +0200738 if stats and (not vulkan) and (not is_spirv) and (not desktop):
Hans-Kristian Arntzen0a5b3a62016-03-22 14:44:12 +0100739 cross_stats = get_shader_stats(glsl)
740
Hans-Kristian Arntzen146ea762018-04-11 10:28:39 +0200741 if glsl:
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200742 regression_check(shader, glsl, args)
Hans-Kristian Arntzendbee4e42016-05-05 10:16:22 +0200743 if vulkan_glsl:
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200744 regression_check((shader[0], shader[1] + '.vk'), vulkan_glsl, args)
Hans-Kristian Arntzencd442b92018-04-27 10:31:39 +0200745
746 remove_file(spirv)
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +0100747
Hans-Kristian Arntzenb6847162016-09-10 12:52:23 +0200748 if stats and (not vulkan) and (not is_spirv) and (not desktop):
Hans-Kristian Arntzen78c9a802016-05-11 19:39:38 +0200749 pristine_stats = get_shader_stats(joined_path)
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +0100750
Hans-Kristian Arntzen0a5b3a62016-03-22 14:44:12 +0100751 a = []
Hans-Kristian Arntzen78c9a802016-05-11 19:39:38 +0200752 a.append(shader[1])
Hans-Kristian Arntzen0a5b3a62016-03-22 14:44:12 +0100753 for i in pristine_stats:
754 a.append(str(i))
755 for i in cross_stats:
756 a.append(str(i))
757 print(','.join(a), file = stats)
758
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200759def test_shader_msl(stats, shader, args, paths):
Hans-Kristian Arntzen1c28ec62017-01-18 19:05:57 +0100760 joined_path = os.path.join(shader[0], shader[1])
Bill Hollingsbe4cb172017-01-30 22:55:21 -0500761 print('\nTesting MSL shader:', joined_path)
Hans-Kristian Arntzendb5d49f2017-09-29 11:07:11 +0200762 is_spirv = shader_is_spirv(shader[1])
Hans-Kristian Arntzen7e02f7f2017-11-22 11:04:29 +0100763 noopt = shader_is_noopt(shader[1])
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200764 spirv, msl = cross_compile_msl(joined_path, is_spirv, args.opt and (not noopt), args.iterations, paths)
765 regression_check(shader, msl, args)
Bill Hollingsa68b3272017-12-26 16:32:45 -0500766
767 # Uncomment the following line to print the temp SPIR-V file path.
768 # This temp SPIR-V file is not deleted until after the Metal validation step below.
769 # If Metal validation fails, the temp SPIR-V file can be copied out and
770 # used as input to an invocation of spirv-cross to debug from Xcode directly.
771 # To do so, build spriv-cross using `make DEBUG=1`, then run the spriv-cross
772 # executable from Xcode using args: `--msl --entry main --output msl_path spirv_path`.
773# print('SPRIV shader: ' + spirv)
Hans-Kristian Arntzen70743b92017-02-05 11:04:45 +0100774
Hans-Kristian Arntzen33fc2ad2019-06-18 10:35:17 +0200775 shader_is_msl22 = 'msl22' in joined_path
Chip Davis2219c4a2020-09-28 23:07:55 -0500776 shader_is_msl23 = 'msl23' in joined_path
丛越d52ec1e2021-10-21 17:46:45 +0800777 shader_is_msl24 = 'msl24' in joined_path
778 skip_validation = (shader_is_msl22 and (not args.msl22)) or (shader_is_msl23 and (not args.msl23)) or (shader_is_msl24 and (not args.msl24))
Hans-Kristian Arntzen33fc2ad2019-06-18 10:35:17 +0200779 if '.invalid.' in joined_path:
780 skip_validation = True
Hans-Kristian Arntzenbe1e27a2019-06-17 16:06:14 +0200781
782 if (not args.force_no_external_validation) and (not skip_validation):
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200783 validate_shader_msl(shader, args.opt)
Hans-Kristian Arntzen1c28ec62017-01-18 19:05:57 +0100784
Hans-Kristian Arntzencd442b92018-04-27 10:31:39 +0200785 remove_file(spirv)
Bill Hollingsa68b3272017-12-26 16:32:45 -0500786
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200787def test_shader_hlsl(stats, shader, args, paths):
Robert Konradcec9c702017-01-26 09:45:17 +0100788 joined_path = os.path.join(shader[0], shader[1])
789 print('Testing HLSL shader:', joined_path)
Hans-Kristian Arntzendb5d49f2017-09-29 11:07:11 +0200790 is_spirv = shader_is_spirv(shader[1])
Hans-Kristian Arntzen7e02f7f2017-11-22 11:04:29 +0100791 noopt = shader_is_noopt(shader[1])
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200792 spirv, hlsl = cross_compile_hlsl(joined_path, is_spirv, args.opt and (not noopt), args.force_no_external_validation, args.iterations, paths)
793 regression_check(shader, hlsl, args)
Hans-Kristian Arntzencd442b92018-04-27 10:31:39 +0200794 remove_file(spirv)
Robert Konradcec9c702017-01-26 09:45:17 +0100795
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200796def test_shader_reflect(stats, shader, args, paths):
Brad Davis709d3c62018-06-03 11:16:37 -0700797 joined_path = os.path.join(shader[0], shader[1])
798 print('Testing shader reflection:', joined_path)
799 is_spirv = shader_is_spirv(shader[1])
800 noopt = shader_is_noopt(shader[1])
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200801 spirv, reflect = cross_compile_reflect(joined_path, is_spirv, args.opt and (not noopt), args.iterations, paths)
802 regression_check_reflect(shader, reflect, args)
Brad Davis709d3c62018-06-03 11:16:37 -0700803 remove_file(spirv)
804
Hans-Kristian Arntzen852e63e2019-03-07 12:43:00 +0100805def test_shader_file(relpath, stats, args, backend):
Hans-Kristian Arntzen3a7cb0c2019-04-12 14:44:24 +0200806 paths = Paths(args.spirv_cross, args.glslang, args.spirv_as, args.spirv_val, args.spirv_opt)
Hans-Kristian Arntzen973b3152019-01-14 11:23:46 +0100807 try:
808 if backend == 'msl':
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200809 test_shader_msl(stats, (args.folder, relpath), args, paths)
Hans-Kristian Arntzen973b3152019-01-14 11:23:46 +0100810 elif backend == 'hlsl':
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200811 test_shader_hlsl(stats, (args.folder, relpath), args, paths)
Hans-Kristian Arntzen973b3152019-01-14 11:23:46 +0100812 elif backend == 'reflect':
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200813 test_shader_reflect(stats, (args.folder, relpath), args, paths)
Hans-Kristian Arntzen973b3152019-01-14 11:23:46 +0100814 else:
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200815 test_shader(stats, (args.folder, relpath), args, paths)
Hans-Kristian Arntzen973b3152019-01-14 11:23:46 +0100816 return None
817 except Exception as e:
818 return e
Brad Davisd0a67ba2018-06-19 14:35:25 -0700819
Hans-Kristian Arntzen6157bf32018-10-26 10:53:11 +0200820def test_shaders_helper(stats, backend, args):
Brad Davisd0a67ba2018-06-19 14:35:25 -0700821 all_files = []
822 for root, dirs, files in os.walk(os.path.join(args.folder)):
Bill Hollingsbe4cb172017-01-30 22:55:21 -0500823 files = [ f for f in files if not f.startswith(".") ] #ignore system files (esp OSX)
Hans-Kristian Arntzen78c9a802016-05-11 19:39:38 +0200824 for i in files:
825 path = os.path.join(root, i)
Brad Davisd0a67ba2018-06-19 14:35:25 -0700826 relpath = os.path.relpath(path, args.folder)
827 all_files.append(relpath)
Hans-Kristian Arntzen78c9a802016-05-11 19:39:38 +0200828
Dan Sinclaire5af4122019-11-05 10:59:41 -0500829 # The child processes in parallel execution mode don't have the proper state for the global args variable, so
Brad Davisd0a67ba2018-06-19 14:35:25 -0700830 # at this point we need to switch to explicit arguments
831 if args.parallel:
Hans-Kristian Arntzen35a9b792020-04-27 16:44:14 +0200832 with multiprocessing.Pool(multiprocessing.cpu_count()) as pool:
833 results = []
834 for f in all_files:
835 results.append(pool.apply_async(test_shader_file,
836 args = (f, stats, args, backend)))
Hans-Kristian Arntzen973b3152019-01-14 11:23:46 +0100837
Hans-Kristian Arntzen35a9b792020-04-27 16:44:14 +0200838 pool.close()
839 pool.join()
840 results_completed = [res.get() for res in results]
Hans-Kristian Arntzen973b3152019-01-14 11:23:46 +0100841
Hans-Kristian Arntzen35a9b792020-04-27 16:44:14 +0200842 for error in results_completed:
843 if error is not None:
844 print('Error:', error)
845 sys.exit(1)
846
Brad Davisd0a67ba2018-06-19 14:35:25 -0700847 else:
848 for i in all_files:
Hans-Kristian Arntzen852e63e2019-03-07 12:43:00 +0100849 e = test_shader_file(i, stats, args, backend)
Hans-Kristian Arntzen973b3152019-01-14 11:23:46 +0100850 if e is not None:
851 print('Error:', e)
852 sys.exit(1)
Brad Davisd0a67ba2018-06-19 14:35:25 -0700853
Hans-Kristian Arntzen6157bf32018-10-26 10:53:11 +0200854def test_shaders(backend, args):
Brad Davisd0a67ba2018-06-19 14:35:25 -0700855 if args.malisc:
Hans-Kristian Arntzen0a5b3a62016-03-22 14:44:12 +0100856 with open('stats.csv', 'w') as stats:
857 print('Shader,OrigRegs,OrigUniRegs,OrigALUShort,OrigLSShort,OrigTEXShort,OrigALULong,OrigLSLong,OrigTEXLong,CrossRegs,CrossUniRegs,CrossALUShort,CrossLSShort,CrossTEXShort,CrossALULong,CrossLSLong,CrossTEXLong', file = stats)
Hans-Kristian Arntzen6157bf32018-10-26 10:53:11 +0200858 test_shaders_helper(stats, backend, args)
Hans-Kristian Arntzen0a5b3a62016-03-22 14:44:12 +0100859 else:
Hans-Kristian Arntzen6157bf32018-10-26 10:53:11 +0200860 test_shaders_helper(None, backend, args)
Hans-Kristian Arntzen0a5b3a62016-03-22 14:44:12 +0100861
862def main():
863 parser = argparse.ArgumentParser(description = 'Script for regression testing.')
864 parser.add_argument('folder',
865 help = 'Folder containing shader files to test.')
866 parser.add_argument('--update',
867 action = 'store_true',
868 help = 'Updates reference files if there is a mismatch. Use when legitimate changes in output is found.')
Hans-Kristian Arntzene50e04c2016-03-22 14:56:50 +0100869 parser.add_argument('--keep',
870 action = 'store_true',
871 help = 'Leave failed GLSL shaders on disk if they fail regression. Useful for debugging.')
Hans-Kristian Arntzen0a5b3a62016-03-22 14:44:12 +0100872 parser.add_argument('--malisc',
873 action = 'store_true',
Hans-Kristian Arntzen147e53a2016-04-04 09:36:04 +0200874 help = 'Use malisc offline compiler to determine static cycle counts before and after spirv-cross.')
Bill Hollings5ad73f32017-03-19 21:06:21 -0400875 parser.add_argument('--msl',
Hans-Kristian Arntzen1c28ec62017-01-18 19:05:57 +0100876 action = 'store_true',
877 help = 'Test Metal backend.')
Bill Hollings6fdb5342017-03-19 21:46:06 -0400878 parser.add_argument('--metal',
879 action = 'store_true',
880 help = 'Deprecated Metal option. Use --msl instead.')
Robert Konradcec9c702017-01-26 09:45:17 +0100881 parser.add_argument('--hlsl',
882 action = 'store_true',
883 help = 'Test HLSL backend.')
Hans-Kristian Arntzen70743b92017-02-05 11:04:45 +0100884 parser.add_argument('--force-no-external-validation',
885 action = 'store_true',
886 help = 'Disable all external validation.')
Hans-Kristian Arntzen230a0122017-11-21 09:52:53 +0100887 parser.add_argument('--opt',
888 action = 'store_true',
889 help = 'Run SPIRV-Tools optimization passes as well.')
Brad Davis709d3c62018-06-03 11:16:37 -0700890 parser.add_argument('--reflect',
891 action = 'store_true',
892 help = 'Test reflection backend.')
Brad Davisd0a67ba2018-06-19 14:35:25 -0700893 parser.add_argument('--parallel',
894 action = 'store_true',
895 help = 'Execute tests in parallel. Useful for doing regression quickly, but bad for debugging and stat output.')
Hans-Kristian Arntzen3a7cb0c2019-04-12 14:44:24 +0200896 parser.add_argument('--spirv-cross',
897 default = './spirv-cross',
898 help = 'Explicit path to spirv-cross')
Hans-Kristian Arntzen074f7652019-03-07 12:36:16 +0100899 parser.add_argument('--glslang',
900 default = 'glslangValidator',
901 help = 'Explicit path to glslangValidator')
902 parser.add_argument('--spirv-as',
903 default = 'spirv-as',
904 help = 'Explicit path to spirv-as')
905 parser.add_argument('--spirv-val',
906 default = 'spirv-val',
907 help = 'Explicit path to spirv-val')
908 parser.add_argument('--spirv-opt',
909 default = 'spirv-opt',
910 help = 'Explicit path to spirv-opt')
Hans-Kristian Arntzenc60b9a12019-04-08 11:53:13 +0200911 parser.add_argument('--iterations',
912 default = 1,
913 type = int,
914 help = 'Number of iterations to run SPIRV-Cross (benchmarking)')
Dan Sinclaire5af4122019-11-05 10:59:41 -0500915
Hans-Kristian Arntzen0a5b3a62016-03-22 14:44:12 +0100916 args = parser.parse_args()
Hans-Kristian Arntzen0a5b3a62016-03-22 14:44:12 +0100917 if not args.folder:
918 sys.stderr.write('Need shader folder.\n')
919 sys.exit(1)
920
Brad Davis76204002018-06-20 10:25:38 -0700921 if (args.parallel and (args.malisc or args.force_no_external_validation or args.update)):
922 sys.stderr.write('Parallel execution is disabled when using the flags --update, --malisc or --force-no-external-validation\n')
Brad Davisd0a67ba2018-06-19 14:35:25 -0700923 args.parallel = False
Dan Sinclaire5af4122019-11-05 10:59:41 -0500924
Hans-Kristian Arntzen856a8d22019-06-18 12:22:46 +0200925 args.msl22 = False
Chip Davis2219c4a2020-09-28 23:07:55 -0500926 args.msl23 = False
丛越d52ec1e2021-10-21 17:46:45 +0800927 args.msl24 = False
Bill Hollings5ad73f32017-03-19 21:06:21 -0400928 if args.msl:
Bill Hollingsbe4cb172017-01-30 22:55:21 -0500929 print_msl_compiler_version()
Chip Davis2219c4a2020-09-28 23:07:55 -0500930 args.msl22 = msl_compiler_supports_version('2.2')
931 args.msl23 = msl_compiler_supports_version('2.3')
丛越d52ec1e2021-10-21 17:46:45 +0800932 args.msl24 = msl_compiler_supports_version('2.4')
Arseny Kapoulkine49baf412017-01-25 00:01:53 -0800933
Hans-Kristian Arntzen6157bf32018-10-26 10:53:11 +0200934 backend = 'glsl'
Dan Sinclaire5af4122019-11-05 10:59:41 -0500935 if (args.msl or args.metal):
Brad Davis709d3c62018-06-03 11:16:37 -0700936 backend = 'msl'
Dan Sinclaire5af4122019-11-05 10:59:41 -0500937 elif args.hlsl:
Brad Davis709d3c62018-06-03 11:16:37 -0700938 backend = 'hlsl'
939 elif args.reflect:
940 backend = 'reflect'
Hans-Kristian Arntzen70743b92017-02-05 11:04:45 +0100941
Hans-Kristian Arntzen6157bf32018-10-26 10:53:11 +0200942 test_shaders(backend, args)
Hans-Kristian Arntzen0a5b3a62016-03-22 14:44:12 +0100943 if args.malisc:
944 print('Stats in stats.csv!')
Hans-Kristian Arntzene50e04c2016-03-22 14:56:50 +0100945 print('Tests completed!')
Hans-Kristian Arntzen75471fb2016-03-02 18:09:16 +0100946
947if __name__ == '__main__':
Hans-Kristian Arntzen0a5b3a62016-03-22 14:44:12 +0100948 main()