// Copyright 2023 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. #ifndef SRC_TINT_LANG_CORE_IR_VALIDATOR_H_ #define SRC_TINT_LANG_CORE_IR_VALIDATOR_H_ #include <string> #include "src/tint/utils/containers/enum_set.h" #include "src/tint/utils/result/result.h" // Forward declarations namespace tint::core::ir { class Module; } // namespace tint::core::ir namespace tint::core::ir { /// Enumerator of optional IR capabilities. enum class Capability : uint8_t { … }; /// Capabilities is a set of Capability Capabilities; /// Validates that a given IR module is correctly formed /// @param mod the module to validate /// @param capabilities the optional capabilities that are allowed /// @returns success or failure Result<SuccessType> Validate(const Module& mod, Capabilities capabilities = { … }; /// Validates the module @p ir and dumps its contents if required by the build configuration. /// @param ir the module to transform /// @param msg the msg to accompany the output /// @param capabilities the optional capabilities that are allowed /// @returns success or failure Result<SuccessType> ValidateAndDumpIfNeeded(const Module& ir, const char* msg, Capabilities capabilities = { … }; } // namespace tint::core::ir #endif // SRC_TINT_LANG_CORE_IR_VALIDATOR_H_