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

#ifndef IA32SUBTRACTANALYSER_INCL
#define IA32SUBTRACTANALYSER_INCL

#include <stdint.h>
#include "codegen/Analyser.hpp"
#include "codegen/InstOpCode.hpp"

namespace TR {
class CodeGenerator;
class Node;
} // namespace TR

#define EvalChild1 0x01
#define EvalChild2 0x02
#define CopyReg1 0x04
#define SubReg1Reg2 0x08
#define SubReg3Reg2 0x10
#define SubReg1Mem2 0x20
#define SubReg3Mem2 0x40

class TR_X86SubtractAnalyser : public TR_Analyser {
    static const uint8_t _actionMap[NUM_ACTIONS];
    TR::CodeGenerator *_cg;

public:
    TR_X86SubtractAnalyser(TR::CodeGenerator *cg)
        : _cg(cg)
    {}

    void integerSubtractAnalyser(TR::Node *root, TR::InstOpCode::Mnemonic regRegOpCode,
        TR::InstOpCode::Mnemonic regMemOpCode, TR::InstOpCode::Mnemonic copyOpCode, bool needsEflags = false,
        TR::Node *borrow = 0);

    void integerSubtractAnalyserWithExplicitOperands(TR::Node *root, TR::Node *firstChild, TR::Node *secondChild,
        TR::InstOpCode::Mnemonic regRegOpCode, TR::InstOpCode::Mnemonic regMemOpCode,
        TR::InstOpCode::Mnemonic copyOpCode, bool needsEflags = false, TR::Node *borrow = 0);

    TR::Register *integerSubtractAnalyserImpl(TR::Node *root, TR::Node *firstChild, TR::Node *secondChild,
        TR::InstOpCode::Mnemonic regRegOpCode, TR::InstOpCode::Mnemonic regMemOpCode,
        TR::InstOpCode::Mnemonic copyOpCode, bool needsEflags, TR::Node *borrow);

    void longSubtractAnalyser(TR::Node *root);
    void longSubtractAnalyserWithExplicitOperands(TR::Node *root, TR::Node *firstChild, TR::Node *secondChild);
    TR::Register *longSubtractAnalyserImpl(TR::Node *root, TR::Node *&firstChild, TR::Node *&secondChild);

    bool getEvalChild1() { return (_actionMap[getInputs()] & EvalChild1) ? true : false; }

    bool getEvalChild2() { return (_actionMap[getInputs()] & EvalChild2) ? true : false; }

    bool getCopyReg1() { return (_actionMap[getInputs()] & CopyReg1) ? true : false; }

    bool getSubReg1Reg2() { return (_actionMap[getInputs()] & SubReg1Reg2) ? true : false; }

    bool getSubReg3Reg2() { return (_actionMap[getInputs()] & SubReg3Reg2) ? true : false; }

    bool getSubReg1Mem2() { return (_actionMap[getInputs()] & SubReg1Mem2) ? true : false; }

    bool getSubReg3Mem2() { return (_actionMap[getInputs()] & SubReg3Mem2) ? true : false; }

    bool isVolatileMemoryOperand(TR::Node *node);
};

#endif
