/*******************************************************************************
 * Copyright IBM Corp. and others 2000
 *
 * This program and the accompanying materials are made available under
 * the terms of the Eclipse Public License 2.0 which accompanies this
 * distribution and is available at https://www.eclipse.org/legal/epl-2.0/
 * or the Apache License, Version 2.0 which accompanies this distribution
 * and is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License, v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception [1] and GNU General Public
 * License, version 2 with the OpenJDK Assembly Exception [2].
 *
 * [1] https://www.gnu.org/software/classpath/license.html
 * [2] https://openjdk.org/legal/assembly-exception.html
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 OR GPL-2.0-only WITH OpenJDK-assembly-exception-1.0
 *******************************************************************************/

// On zOS XLC linker can't handle files with same name at link time
// This workaround with pragma is needed. What this does is essentially
// give a different name to the codesection (csect) for this file. So it
// doesn't conflict with another file with same name.
#pragma csect(CODE, "TRZRegBase#C")
#pragma csect(STATIC, "TRZRegtBase#S")
#pragma csect(TEST, "TRZRegBase#T")

#include <stddef.h>
#include <stdint.h>
#include "codegen/Register.hpp"
#include "codegen/RegisterConstants.hpp"
#include "infra/Flags.hpp"

OMR::Z::Register::Register(uint32_t f)
    : OMR::Register(f)
{
    _liveRegisterInfo._liveRegister = NULL;
    _memRef = NULL;
}

OMR::Z::Register::Register(TR_RegisterKinds rk)
    : OMR::Register(rk)
{
    _liveRegisterInfo._liveRegister = NULL;
    _memRef = NULL;
}

OMR::Z::Register::Register(TR_RegisterKinds rk, uint16_t ar)
    : OMR::Register(rk, ar)
{
    _liveRegisterInfo._liveRegister = NULL;
    _memRef = NULL;
}

bool OMR::Z::Register::usesRegister(TR::Register *reg) { return (reg == self()) ? true : false; }

bool OMR::Z::Register::usesAnyRegister(TR::Register *reg)
{
    if (self()->getRegisterPair()) {
        if (reg->getRegisterPair())
            return (reg == self());
        else
            return (self()->getHighOrder()->usesRegister(reg) || self()->getLowOrder()->usesRegister(reg));
    } else {
        if (reg->getRegisterPair())
            return (self()->usesRegister(reg->getHighOrder()) || self()->usesRegister(reg->getLowOrder()));
        else
            return (reg == self());
    }
}

void OMR::Z::Register::setPlaceholderReg()
{
#if defined(TR_TARGET_64BIT)
    if (self()->getKind() == TR_GPR) {
        self()->setIs64BitReg(true);
    }
#endif

    OMR::Register::setPlaceholderReg();
}

ncount_t OMR::Z::Register::decFutureUseCount(ncount_t fuc) { return OMR::Register::decFutureUseCount(fuc); }

bool OMR::Z::Register::containsCollectedReference() { return OMR::Register::containsCollectedReference(); }

void OMR::Z::Register::setContainsCollectedReference() { _flags.set(ContainsCollectedReference); }

#if defined(TR_TARGET_64BIT)
bool OMR::Z::Register::is64BitReg()
{
    return (_flags.testAny(Is64Bit) || self()->containsCollectedReference() || self()->containsInternalPointer());
}
#else
bool OMR::Z::Register::is64BitReg() { return _flags.testAny(Is64Bit); }
#endif

void OMR::Z::Register::setIs64BitReg(bool b)
{
    TR_ASSERT_FATAL(self()->getKind() == TR_GPR, "Setting is64BitReg flag on a non-GPR register [%p]", self());

    _flags.set(Is64Bit, b);
}
