isomatch.h

Go to the documentation of this file.

#pragma once

#include <stdint.h>
#include <stdlib.h>

#ifdef __cplusplus
extern "C" {
#endif

/*****************************************************************************/
/* Type declarations                                                         */
/*****************************************************************************/
typedef uint64_t sign_t;         
typedef void* circuit_handle;   
typedef void* expr_handle;      
typedef const char* wire_handle;    

typedef struct circuit_list {
    circuit_handle circ;             
    struct circuit_list* next;       
} circuit_list;

typedef struct wire_list {
    wire_handle wire;               
    struct wire_list* next;         
} wire_list;

typedef struct {
    circuit_list* parts;
    wire_list* inputs;
    wire_list* outputs;
} single_match;

typedef struct match_results {
    single_match match;             
    struct match_results* next;     
} match_results;

/*****************************************************************************/
/* Error handling                                                            */
/*****************************************************************************/

/***********************************/
/* Return values (aka error codes) */
/***********************************/

typedef enum isom_rc {
    ISOM_RC_OK      = 0, 
    ISOM_RC_NULLPTR = 1, 
    ISOM_RC_DOMAIN  = 2, 
    ISOM_RC_NO_PARENT = 3, 
    ISOM_RC_BADHEX = 4,    
    ISOM_RC_BAD_FREE = 5,  
    ISOM_RC_OUT_OF_RANGE = 6, 
    ISOM_RC_NOT_CONNECTED = 7, 
    ISOM_RC_ERROR   = 255, 
} isom_rc;

/*****************************/
/* Error reporting functions */
/*****************************/

isom_rc isom_last_error();

const char* isom_strerror(isom_rc err_code);

/*****************************************************************************/
/* Enumerations                                                              */
/*****************************************************************************/

/***************/
/* Expressions */
/***************/

enum isom_expr_binop {
    BAnd,           
    BOr,            
    BXor,           
    BAdd,           
    BSub,           
    BMul,           
    BDiv,           
    BMod,           
    BLsr,           
    BLsl,           
    BAsr,           
};

enum isom_expr_unop {
    UNot,           
};

enum isom_expr_unop_cst {
    UCLsr,          
    UCLsl,          
    UCAsr,          
};

/*****************************************************************************/
/* Circuit construction                                                      */
/*****************************************************************************/

/*********************/
/* Generic functions */
/*********************/

int free_circuit(circuit_handle circuit);

int isom_unplug_circuit(circuit_handle circuit);

/****************/
/* Assert gates */
/****************/

circuit_handle build_assert(circuit_handle parent,
        const char* name,
        expr_handle expr);

int build_assert_add_input(circuit_handle self, wire_handle wire);

/**************/
/* Comb gates */
/**************/

circuit_handle build_comb(circuit_handle parent);

int build_comb_add_input(circuit_handle self, wire_handle wire);

int build_comb_add_output(circuit_handle self,
        wire_handle wire,
        expr_handle expr);

/***************/
/* Delay gates */
/***************/

circuit_handle build_delay(circuit_handle parent,
        wire_handle input,
        wire_handle output);

/*************************/
/* Hierarchy group gates */
/*************************/

circuit_handle build_group(const char* name);

int build_group_add_child(circuit_handle self, circuit_handle child);

int build_group_add_input(circuit_handle self,
        wire_handle actual,
        wire_handle formal);

int build_group_add_output(circuit_handle self,
        wire_handle actual,
        wire_handle formal);

/******************/
/* Tristate gates */
/******************/

circuit_handle build_tristate(circuit_handle parent,
        wire_handle from,
        wire_handle to,
        wire_handle enable);

/***************/
/* Expressions */
/***************/

expr_handle build_expr_const(unsigned val);

expr_handle build_expr_longconst(const char* value);

expr_handle build_expr_var(int input_pin);

expr_handle build_expr_binop(enum isom_expr_binop op,
        expr_handle left,
        expr_handle right);

expr_handle build_expr_unop(enum isom_expr_unop op, expr_handle expr);

expr_handle build_expr_unop_cst(enum isom_expr_unop_cst op,
        int param,
        expr_handle expr);

expr_handle build_expr_slice(expr_handle expr, unsigned beg, unsigned end);

expr_handle build_expr_merge(expr_handle left, expr_handle right);

int free_expression(expr_handle expr);

/*****************************************************************************/
/* Accessors                                                                 */
/*****************************************************************************/

int isom_input_count(circuit_handle circuit);

int isom_output_count(circuit_handle circuit);

wire_handle isom_nth_input(circuit_handle circuit, size_t wireId);

wire_handle isom_nth_output(circuit_handle circuit, size_t wireId);

/*****************************************************************************/
/* Signature                                                                 */
/*****************************************************************************/

sign_t sign(circuit_handle circuit);

sign_t sign_with_precision(circuit_handle circuit, unsigned precision_level);

/*****************************************************************************/
/* Circuit matching                                                          */
/*****************************************************************************/

match_results* subcircuit_find(circuit_handle needle, circuit_handle haystack);

void free_match_results(match_results* res);

/*****************************************************************************/
/* Mark and sweep                                                            */
/*****************************************************************************/

void isom_clear_marks();

void isom_mark_circuit(circuit_handle handle);

void isom_sweep();


#ifdef __cplusplus
}
#endif