// 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.

#ifndef SRC_TINT_LANG_CORE_IR_ANALYSIS_FOR_LOOP_ANALYSIS_H_
#define SRC_TINT_LANG_CORE_IR_ANALYSIS_FOR_LOOP_ANALYSIS_H_

#include "src/tint/lang/core/ir/loop.h"
#include "src/tint/lang/core/ir/store.h"
#include "src/tint/utils/ice/ice.h"

namespace tint::core::ir::analysis {

/// ForLoopAnalysis is a helper used to find and hoist the condition into the for loop directly.
/// See crbug.com/429187478 for the rationale behind this analysis.
class ForLoopAnalysis {
  public:
    /// Constructor
    /// @param loop the Loop to cache analyses for
    explicit ForLoopAnalysis(const Loop& loop);
    ~ForLoopAnalysis();

    /// Returns the condition for the loop.
    /// Otherwise if no condition can be hoisted it returns nullptr.
    /// @returns the loop condition instruction result
    const core::ir::Value* GetIfCondition() { return for_condition; }

    /// Returns true if the instruction should be removed from the body to support condition
    /// hoisting.
    /// @param inst from the body of the loop
    /// @returns a boolean
    bool IsBodyRemovedInstruction(const core::ir::Instruction* inst) {
        TINT_ASSERT(GetIfCondition());
        return body_removed_instructions.Contains(inst);
    }

    /// @returns the store in a simple continuing block that can be used as a for-loop update
    const core::ir::Store* GetContinuingUpdateStore() { return continuing_update_store; }

  private:
    void AttemptForLoopDeduction(const Loop* loop);

    Hashset<const core::ir::Instruction*, 32> body_removed_instructions;
    const core::ir::Value* for_condition = nullptr;
    const core::ir::Store* continuing_update_store = nullptr;
};

}  // namespace tint::core::ir::analysis

#endif  // SRC_TINT_LANG_CORE_IR_ANALYSIS_FOR_LOOP_ANALYSIS_H_
