/*
 * Copyright (c) 2025 Ian Marco Moffett and L5 engineers
 * All rights reserved.
 *
 * 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 project 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 OWNER 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.
 */

/*
 * Description: Pirho PIIR AMD64 backend
 * Author: Ian Marco Moffett
 */

#ifndef _MACHINE_PIIR_H_
#define _MACHINE_PIIR_H_ 1

#include <os/np.h>
#include <np/piir.h>

/*
 * Convert an IR byte into one or more machine instruction
 * bytes
 *
 * @work: Current work
 * @vm: Virtual machine state
 * @input: Input to convert
 *
 * Returns length written on success, otherwise a less than
 * zero value on failure.
 */
ssize_t md_piir_decode(
    struct np_work *work, struct piir_vm *vm,
    ir_byte_t input
);

/*
 * Allocate a register ID for use in the IR
 *
 * @work: Current work
 * @vm: Virtual machine state
 * @flags: Optional flags
 *
 * Returns the allocated register ID on success, otherwise
 * a less than zero value on failure
 */
reg_t md_alloc_reg(struct np_work *work, struct piir_vm *vm, int flags);

/*
 * Free one or more registers
 *
 * @work: Current work
 * @vm: Virtual machine state
 * @reg: Register to free
 */
void md_free_reg(struct np_work *work, struct piir_vm *vm, reg_t reg);

#endif  /* !_MACHINE_PIIR_H_ */