src/emdawnwebgpu/pkg/emdawnwebgpu.port.py - dawn - Git at Google

 # Copyright 2025 The Dawn & Tint Authors
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
 #
 # 1. Redistributions of source code must retain the above copyright notice, this
 #    list of conditions and the following disclaimer.
 #
 # 2. Redistributions in binary form must reproduce the above copyright notice,
 #    this list of conditions and the following disclaimer in the documentation
 #    and/or other materials provided with the distribution.
 #
 # 3. Neither the name of the copyright holder nor the names of its
 #    contributors may be used to endorse or promote products derived from
 #    this software without specific prior written permission.
 #
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 # Emscripten port file for webgpu and webgpu_cpp. See README for how to use.
 #
 # Style note: Variables starting with _ are local. The rest are part of the
 # Python module interface for Emscripten ports.

 import os
 import zlib
 from typing import Union, Dict, Optional

 LICENSE = "Some files: BSD 3-Clause License. Other files: Emscripten's license (available under both MIT License and University of Illinois/NCSA Open Source License)"

 # User options. (See README.md for how to use these.)
 OPTIONS = {
     'cpp_bindings':
     "Add the include path for Dawn-like <webgpu/webgpu_cpp.h> C++ bindings. Default: true.",

     # The following options are generally not needed, as they are automatically
     # derived from the linker flags. However, if using embuilder, these must be
     # used as they are the only way to control these options
     # (https://github.com/emscripten-core/emscripten/issues/24421). For example:
     #
     #     embuilder build path/to/port/file.py:opt_level=2:shared_memory=true
     'opt_level':
     "Optimization (-O) level for the bindings' Wasm layer. Default: choose based on -sASSERTIONS.",
     'shared_memory':
     "Enable -sSHARED_MEMORY. Default: choose based on whether linker has -sSHARED_MEMORY enabled.",
 }
 _VALID_OPTION_VALUES = {
     'cpp_bindings': ['true', 'false'],
     'opt_level': ['auto', '0', '2'],
     'shared_memory': ['auto', 'true', 'false'],
 }
 _opts: Dict[str, Optional[str]] = {
     'cpp_bindings': 'true',
     'opt_level': 'auto',
     'shared_memory': 'auto',
 }


 def _walk(path):
     for (dirpath, dirnames, filenames) in os.walk(path):
         for filename in filenames:
             yield os.path.join(dirpath, filename)


 _pkg_dir = os.path.dirname(os.path.realpath(__file__))
 _c_include_dir = os.path.join(_pkg_dir, 'webgpu', 'include')
 _cpp_include_dir = os.path.join(_pkg_dir, 'webgpu_cpp', 'include')
 _src_dir = os.path.join(_pkg_dir, 'webgpu', 'src')
 _srcs = [
     os.path.join(_src_dir, 'webgpu.cpp'),
 ]

 # Check for a generated file that would only be there in the built package
 if not os.path.isfile(os.path.join(_c_include_dir, 'webgpu', 'webgpu.h')):
     raise Exception(
         "emdawnwebgpu.port.py may only be used from a built emdawnwebgpu_pkg, "
         "not from Dawn's source tree. You can use pre-built packages from "
         "https://github.com/google/dawn/releases or build it locally.")

 # Collect a list of all files that affect the compiled port so that we know
 # when to recompile it. (Normally Emscripten handles this, but not here because
 # of the way that we "misuse" the ports system.)
 _files_affecting_port_build = sorted([
     __file__,
     *_srcs,
     *_walk(_c_include_dir),
 ])

 # Hooks that affect compiler invocations


 def _check_option(option, value, error_handler):
     if value not in _VALID_OPTION_VALUES[option]:
         error_handler(
             f'[{option}] can be {list(_VALID_OPTION_VALUES[option])}, got [{value}]'
         )
     return value


 def handle_options(options, error_handler):
     for option, value in options.items():
         value = value.lower()
         _opts[option] = _check_option(option, value, error_handler)


 def process_args(ports):
     # It's important that these take precedent over Emscripten's builtin
     # system/include/, which also currently has webgpu headers.
     args = ['-isystem', _c_include_dir]
     if _opts['cpp_bindings'] == 'true':
         args += ['-isystem', _cpp_include_dir]
     return args


 # Hooks that affect linker invocations

 def _compute_library_compile_flags(settings):
     # Emscripten automatically handles many necessary compile flags (LTO, PIC,
     # wasm64). The ones it does not handle are handled below.
     lib_name_suffix = ''
     flags = []

     # If not explicitly set, use -O0 when linking with -sASSERTIONS builds, and
     # -O2 otherwise. (ASSERTIONS implicitly affects library_webgpu.js, so it
     # makes sense for it to control this too - debuggability is most useful with
     # assertions.)
     opt_level = _opts['opt_level']
     if opt_level == 'auto':
         opt_level = '0' if settings.ASSERTIONS else '2'
     lib_name_suffix += f'-O{opt_level}'
     flags.append(f'-O{opt_level}')
     # Set NDEBUG if -O0 (similar to emcc's defaulting of -sASSERTIONS from -O).
     if opt_level != '0':
         flags.append('-DNDEBUG')

     # If not explicitly set, inherit -sSHARED_MEMORY from the linker invocation.
     # This affects how std::atomic<> is compiled. (It may be fine to link a
     # -sSHARED_MEMORY=1 object into a -sSHARED_MEMORY=0 executable, but it still
     # emits unnecessary atomic operations, so we prefer not to do that.)
     shared_memory = _opts['shared_memory']
     if shared_memory == 'auto':
         shared_memory = 'true' if settings.SHARED_MEMORY else 'false'
     if shared_memory == 'true':
         lib_name_suffix += '-shared_memory'
         flags.append('-sSHARED_MEMORY')

     return (lib_name_suffix, flags)


 # Create a unique lib name for this version of the port and compile flags.
 def _get_lib_name(settings):
     # Compute a hash from all of the inputs to ports.build_port() so that
     # Emscripten knows when it needs to recompile.
     hash_value = 0

     def add(x):
         nonlocal hash_value
         hash_value = zlib.adler32(x, hash_value)

     for filename in _files_affecting_port_build:
         add(open(filename, 'rb').read())

     (lib_name_suffix, _) = _compute_library_compile_flags(settings)
     return f'libemdawnwebgpu-{hash_value:08x}{lib_name_suffix}.a'


 def linker_setup(ports, settings):
     if settings.USE_WEBGPU:
         raise Exception('emdawnwebgpu may not be used with -sUSE_WEBGPU=1')

     # These will be processed in order; library_webgpu.js must come after
     # the generated files, because it depends on them.
     settings.JS_LIBRARIES += [
         os.path.join(_src_dir, 'library_webgpu_enum_tables.js'),
         os.path.join(_src_dir, 'library_webgpu_generated_struct_info.js'),
         os.path.join(_src_dir, 'library_webgpu_generated_sig_info.js'),
         os.path.join(_src_dir, 'library_webgpu.js'),
     ]
     if 'CLOSURE_ARGS' in settings.keys():
         # This works in Emscripten >4.0.7. In <=4.0.7, the user has to pass it.
         settings.CLOSURE_ARGS += [
             '--externs=' + os.path.join(_src_dir, 'webgpu-externs.js'),
         ]


 def get(ports, settings, shared):
     if settings.allowed_settings:
         # We are in the compile phase. The lib_emdawnwebgpu-*.a library file
         # isn't needed until linking.
         return []

     def create(final):
         # Note we don't use ports.install_header; instead we directly add the
         # include path via process_args(). The only thing we cache is the
         # compiled webgpu.cpp (which also includes webgpu/webgpu.h).
         includes = [_c_include_dir]
         # Always use -g. The linker can remove debug symbols in release builds.
         (_, flags) = _compute_library_compile_flags(settings)
         flags += ['-g', '-std=c++20', '-fno-exceptions']

         # IMPORTANT: Keep `_files_affecting_port_build` in sync with this.
         ports.build_port(_src_dir,
                          final,
                          'emdawnwebgpu',
                          includes=includes,
                          flags=flags,
                          srcs=_srcs)

     lib_name = _get_lib_name(settings)
     return [shared.cache.get_lib(lib_name, create, what='port')]


 def clear(ports, settings, shared):
     shared.cache.erase_lib(_get_lib_name(settings))
	# Copyright 2025 The Dawn & Tint Authors
	#
	# Redistribution and use in source and binary forms, with or without
	# modification, are permitted provided that the following conditions are met:
	#
	# 1. Redistributions of source code must retain the above copyright notice, this
	# list of conditions and the following disclaimer.
	#
	# 2. Redistributions in binary form must reproduce the above copyright notice,
	# this list of conditions and the following disclaimer in the documentation
	# and/or other materials provided with the distribution.
	#
	# 3. Neither the name of the copyright holder nor the names of its
	# contributors may be used to endorse or promote products derived from
	# this software without specific prior written permission.
	#
	# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
	# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
	# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
	# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
	# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
	# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

	# Emscripten port file for webgpu and webgpu_cpp. See README for how to use.
	#
	# Style note: Variables starting with _ are local. The rest are part of the
	# Python module interface for Emscripten ports.

	import os
	import zlib
	from typing import Union, Dict, Optional

	LICENSE = "Some files: BSD 3-Clause License. Other files: Emscripten's license (available under both MIT License and University of Illinois/NCSA Open Source License)"

	# User options. (See README.md for how to use these.)
	OPTIONS = {
	'cpp_bindings':
	"Add the include path for Dawn-like <webgpu/webgpu_cpp.h> C++ bindings. Default: true.",

	# The following options are generally not needed, as they are automatically
	# derived from the linker flags. However, if using embuilder, these must be
	# used as they are the only way to control these options
	# (https://github.com/emscripten-core/emscripten/issues/24421). For example:
	#
	# embuilder build path/to/port/file.py:opt_level=2:shared_memory=true
	'opt_level':
	"Optimization (-O) level for the bindings' Wasm layer. Default: choose based on -sASSERTIONS.",
	'shared_memory':
	"Enable -sSHARED_MEMORY. Default: choose based on whether linker has -sSHARED_MEMORY enabled.",
	}
	_VALID_OPTION_VALUES = {
	'cpp_bindings': ['true', 'false'],
	'opt_level': ['auto', '0', '2'],
	'shared_memory': ['auto', 'true', 'false'],
	}
	_opts: Dict[str, Optional[str]] = {
	'cpp_bindings': 'true',
	'opt_level': 'auto',
	'shared_memory': 'auto',
	}


	def _walk(path):
	for (dirpath, dirnames, filenames) in os.walk(path):
	for filename in filenames:
	yield os.path.join(dirpath, filename)


	_pkg_dir = os.path.dirname(os.path.realpath(__file__))
	_c_include_dir = os.path.join(_pkg_dir, 'webgpu', 'include')
	_cpp_include_dir = os.path.join(_pkg_dir, 'webgpu_cpp', 'include')
	_src_dir = os.path.join(_pkg_dir, 'webgpu', 'src')
	_srcs = [
	os.path.join(_src_dir, 'webgpu.cpp'),
	]

	# Check for a generated file that would only be there in the built package
	if not os.path.isfile(os.path.join(_c_include_dir, 'webgpu', 'webgpu.h')):
	raise Exception(
	"emdawnwebgpu.port.py may only be used from a built emdawnwebgpu_pkg, "
	"not from Dawn's source tree. You can use pre-built packages from "
	"https://github.com/google/dawn/releases or build it locally.")

	# Collect a list of all files that affect the compiled port so that we know
	# when to recompile it. (Normally Emscripten handles this, but not here because
	# of the way that we "misuse" the ports system.)
	_files_affecting_port_build = sorted([
	__file__,
	*_srcs,
	*_walk(_c_include_dir),
	])

	# Hooks that affect compiler invocations


	def _check_option(option, value, error_handler):
	if value not in _VALID_OPTION_VALUES[option]:
	error_handler(
	f'[{option}] can be {list(_VALID_OPTION_VALUES[option])}, got [{value}]'
	)
	return value


	def handle_options(options, error_handler):
	for option, value in options.items():
	value = value.lower()
	_opts[option] = _check_option(option, value, error_handler)


	def process_args(ports):
	# It's important that these take precedent over Emscripten's builtin
	# system/include/, which also currently has webgpu headers.
	args = ['-isystem', _c_include_dir]
	if _opts['cpp_bindings'] == 'true':
	args += ['-isystem', _cpp_include_dir]
	return args


	# Hooks that affect linker invocations

	def _compute_library_compile_flags(settings):
	# Emscripten automatically handles many necessary compile flags (LTO, PIC,
	# wasm64). The ones it does not handle are handled below.
	lib_name_suffix = ''
	flags = []

	# If not explicitly set, use -O0 when linking with -sASSERTIONS builds, and
	# -O2 otherwise. (ASSERTIONS implicitly affects library_webgpu.js, so it
	# makes sense for it to control this too - debuggability is most useful with
	# assertions.)
	opt_level = _opts['opt_level']
	if opt_level == 'auto':
	opt_level = '0' if settings.ASSERTIONS else '2'
	lib_name_suffix += f'-O{opt_level}'
	flags.append(f'-O{opt_level}')
	# Set NDEBUG if -O0 (similar to emcc's defaulting of -sASSERTIONS from -O).
	if opt_level != '0':
	flags.append('-DNDEBUG')

	# If not explicitly set, inherit -sSHARED_MEMORY from the linker invocation.
	# This affects how std::atomic<> is compiled. (It may be fine to link a
	# -sSHARED_MEMORY=1 object into a -sSHARED_MEMORY=0 executable, but it still
	# emits unnecessary atomic operations, so we prefer not to do that.)
	shared_memory = _opts['shared_memory']
	if shared_memory == 'auto':
	shared_memory = 'true' if settings.SHARED_MEMORY else 'false'
	if shared_memory == 'true':
	lib_name_suffix += '-shared_memory'
	flags.append('-sSHARED_MEMORY')

	return (lib_name_suffix, flags)


	# Create a unique lib name for this version of the port and compile flags.
	def _get_lib_name(settings):
	# Compute a hash from all of the inputs to ports.build_port() so that
	# Emscripten knows when it needs to recompile.
	hash_value = 0

	def add(x):
	nonlocal hash_value
	hash_value = zlib.adler32(x, hash_value)

	for filename in _files_affecting_port_build:
	add(open(filename, 'rb').read())

	(lib_name_suffix, _) = _compute_library_compile_flags(settings)
	return f'libemdawnwebgpu-{hash_value:08x}{lib_name_suffix}.a'


	def linker_setup(ports, settings):
	if settings.USE_WEBGPU:
	raise Exception('emdawnwebgpu may not be used with -sUSE_WEBGPU=1')

	# These will be processed in order; library_webgpu.js must come after
	# the generated files, because it depends on them.
	settings.JS_LIBRARIES += [
	os.path.join(_src_dir, 'library_webgpu_enum_tables.js'),
	os.path.join(_src_dir, 'library_webgpu_generated_struct_info.js'),
	os.path.join(_src_dir, 'library_webgpu_generated_sig_info.js'),
	os.path.join(_src_dir, 'library_webgpu.js'),
	]
	if 'CLOSURE_ARGS' in settings.keys():
	# This works in Emscripten >4.0.7. In <=4.0.7, the user has to pass it.
	settings.CLOSURE_ARGS += [
	'--externs=' + os.path.join(_src_dir, 'webgpu-externs.js'),
	]


	def get(ports, settings, shared):
	if settings.allowed_settings:
	# We are in the compile phase. The lib_emdawnwebgpu-*.a library file
	# isn't needed until linking.
	return []

	def create(final):
	# Note we don't use ports.install_header; instead we directly add the
	# include path via process_args(). The only thing we cache is the
	# compiled webgpu.cpp (which also includes webgpu/webgpu.h).
	includes = [_c_include_dir]
	# Always use -g. The linker can remove debug symbols in release builds.
	(_, flags) = _compute_library_compile_flags(settings)
	flags += ['-g', '-std=c++20', '-fno-exceptions']

	# IMPORTANT: Keep `_files_affecting_port_build` in sync with this.
	ports.build_port(_src_dir,
	final,
	'emdawnwebgpu',
	includes=includes,
	flags=flags,
	srcs=_srcs)

	lib_name = _get_lib_name(settings)
	return [shared.cache.get_lib(lib_name, create, what='port')]


	def clear(ports, settings, shared):
	shared.cache.erase_lib(_get_lib_name(settings))