package com.seaofnodes.simple.node;

import com.seaofnodes.simple.*;
import com.seaofnodes.simple.codegen.*;
import com.seaofnodes.simple.util.SB;
import com.seaofnodes.simple.util.Utils;

public interface MachNode {

    // Easy access to the abstract Machine
    default Machine machine() { return CodeGen.CODE._mach; }

    // Run a post-instruction-selection action
    default void postSelect( CodeGen code ) { }

    // Register mask allowed on input i.  0 for no register.
    RegMask regmap( int i );
    // Register mask allowed as a result.  0 for no register.
    RegMask outregmap();
    // Multi-reg-defining machine op; idx comes from Proj.
    // Sometimes these Projs have no uses, and just exist to kill a register.
    default RegMask outregmap(int idx) { throw Utils.TODO(); }

    // Set of killed registers
    default RegMask killmap() { return null; }

    // If this op updates the same register as input 'idx', e.g. many X86 "R1 +=
    // R2" style ops.  This forces the output live range to equal the input live
    // range, so they both get the same register.

    // This can hold true for projections, if the instruction updates many
    // registers that it also takes in.  Note that ops also use the same
    // registers for both inputs and outputs but these are pinned and without any
    // choices (e.g. always RCX for both an input and output) and are better
    // served with just declaring as a fixed register.

    // Returns either 0 for not-two-adr or the updated input; for projections
    // this is their Multi's updated input.
    default int twoAddress( ) { return 0; }
    // Ok to switch arguments
    default boolean commutes() { return false; }

    // Instructions cheaper to recreate than to spill, such as loading small constants
    default boolean isClone() { return false; }

    // Make a clone of a cheap instruction
    default Node copy() { return null; }

    // Encoding is appended, relocations gathered.
    void encoding( Encoding enc );

    // Human-readable form appended to the SB.  Things like the encoding,
    // indentation, leading address or block labels not printed here.
    // Just something like "R17=[R18+12] // Load array base".
    // General form: "dst=src+src".
    default void asm(CodeGen code, SB sb) { throw Utils.TODO(); }

    // Human-readable opcode; e.g. "ld4" or "call".
    default String op() { throw Utils.TODO(); }
}