blob: 0686fc25e1e42a70fcb82a493bc56d7dd350d2ae [file] [log] [blame]
// 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_EXIT_LOOP_H_
#define SRC_TINT_LANG_CORE_IR_EXIT_LOOP_H_
#include <string>
#include "src/tint/lang/core/ir/exit.h"
#include "src/tint/utils/rtti/castable.h"
// Forward declarations
namespace tint::core::ir {
class Loop;
} // namespace tint::core::ir
namespace tint::core::ir {
/// A exit loop instruction.
class ExitLoop final : public Castable<ExitLoop, Exit> {
public:
/// The base offset in Operands() for the args
static constexpr size_t kArgsOperandOffset = 0;
/// Constructor
/// @param loop the loop being exited
/// @param args the target MultiInBlock arguments
explicit ExitLoop(ir::Loop* loop, VectorRef<Value*> args = tint::Empty);
~ExitLoop() override;
/// @copydoc Instruction::Clone()
ExitLoop* Clone(CloneContext& ctx) override;
/// Re-associates the exit with the given loop instruction
/// @param l the new loop to exit from
void SetLoop(ir::Loop* l);
/// @returns the loop being exited
ir::Loop* Loop();
/// @returns the loop being exited
const ir::Loop* Loop() const;
/// @returns the friendly name for the instruction
std::string FriendlyName() const override { return "exit_loop"; }
};
} // namespace tint::core::ir
#endif // SRC_TINT_LANG_CORE_IR_EXIT_LOOP_H_