src/tint/fuzzers/tint_ast_fuzzer/util.h

// Copyright 2021 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_FUZZERS_TINT_AST_FUZZER_UTIL_H_
#define SRC_TINT_FUZZERS_TINT_AST_FUZZER_UTIL_H_

#include <vector>

#include "src/tint/lang/wgsl/ast/module.h"
#include "src/tint/lang/wgsl/ast/variable_decl_statement.h"
#include "src/tint/lang/wgsl/program/program.h"
#include "src/tint/lang/wgsl/sem/block_statement.h"
#include "src/tint/lang/wgsl/sem/function.h"
#include "src/tint/lang/wgsl/sem/statement.h"
#include "src/tint/lang/wgsl/sem/variable.h"
#include "src/tint/utils/rtti/castable.h"

namespace tint::fuzzers::ast_fuzzer::util {
/// @file

/// @brief Returns all in-scope variables (including formal function parameters)
/// related to statement `curr_stmt`.
///
/// These variables are additionally filtered by applying a predicate `pred`.
///
/// @tparam Pred - a predicate that accepts a `const sem::Variable*` and returns
///     `bool`.
/// @param program - the program to look for variables in.
/// @param curr_stmt - the current statement. Everything below it is not in
///     scope.
/// @param pred - a predicate (e.g. a function pointer, functor, lambda etc) of
///     type `Pred`.
/// @return a vector of all variables that can be accessed from `curr_stmt`.
template <typename Pred>
std::vector<const sem::Variable*> GetAllVarsInScope(const tint::Program& program,
                                                    const sem::Statement* curr_stmt,
                                                    Pred&& pred) {
    std::vector<const sem::Variable*> result;

    // Walk up the hierarchy of blocks in which `curr_stmt` is contained.
    for (const auto* block = curr_stmt->Block(); block;
         block = tint::As<sem::BlockStatement>(block->Parent())) {
        for (const auto* stmt : block->Declaration()->statements) {
            if (stmt == curr_stmt->Declaration()) {
                // `curr_stmt` was found. This is only possible if `block is the
                // enclosing block of `curr_stmt` since the AST nodes are not shared.
                // Because of all this, skip the iteration of the inner loop since
                // the rest of the instructions in the `block` are not visible from the
                // `curr_stmt`.
                break;
            }

            if (const auto* var_node = tint::As<ast::VariableDeclStatement>(stmt)) {
                const auto* sem_var = program.Sem().Get(var_node->variable);
                if (pred(sem_var)) {
                    result.push_back(sem_var);
                }
            }
        }
    }

    // Process function parameters.
    for (const auto* param : curr_stmt->Function()->Parameters()) {
        if (pred(param)) {
            result.push_back(param);
        }
    }

    // Global variables do not belong to any ast::BlockStatement.
    for (const auto* global_decl : program.AST().GlobalDeclarations()) {
        if (global_decl == curr_stmt->Function()->Declaration()) {
            // The same situation as in the previous loop. The current function has
            // been reached. If there are any variables declared below, they won't be
            // visible in this function. Thus, exit the loop.
            break;
        }

        if (const auto* global_var = tint::As<ast::Variable>(global_decl)) {
            const auto* sem_node = program.Sem().Get(global_var);
            if (pred(sem_node)) {
                result.push_back(sem_node);
            }
        }
    }

    return result;
}

}  // namespace tint::fuzzers::ast_fuzzer::util

#endif  // SRC_TINT_FUZZERS_TINT_AST_FUZZER_UTIL_H_