/* ************************************************************************
 * Copyright (C) 2025-2026 Advanced Micro Devices, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * ************************************************************************ */
#pragma once

#include <memory>

#include "stinkytofu/Export.hpp"

namespace stinkytofu {
class Pass;

/// Creates a pass that absorbs s_set_vgpr_msb side-channel state into operand
/// register identity, then deletes the s_set_vgpr_msb instructions.
///
/// Inverse of InsertVgprMsbPass. After this pass runs, every VGPR operand
/// carries its full physical index in reg.reg.idx with reg.reg.offset = 0,
/// and no s_set_vgpr_msb instructions remain in the IR.
///
/// Intended for the st-opt path when the input assembly was already lowered
/// (i.e. contains s_set_vgpr_msb + encoded VGPR indices). Run before any
/// def-use / dependency-analysis pass; re-lower with InsertVgprMsbPass before
/// emit to preserve round-trip.
///
/// State is reset to MSB=0 at every label boundary (matching the convention
/// in InsertVgprMsbPass).
STINKYTOFU_EXPORT std::unique_ptr<Pass> createRaiseVgprMsbPass();

}  // namespace stinkytofu
