signals-runtime-wrappers.h

Go to the documentation of this file.

//===- signals-runtime-wrappers.h - Simulation runtime library --*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// Defines the runtime library used in LLHD simulation.
//
//===----------------------------------------------------------------------===//
 
#ifndef CIRCT_DIALECT_LLHD_SIMULATOR_SIGNALS_RUNTIME_WRAPPERS_H
#define CIRCT_DIALECT_LLHD_SIMULATOR_SIGNALS_RUNTIME_WRAPPERS_H
 
#include "circt/Dialect/LLHD/Simulator/State.h"
 
extern "C" {
 
//===----------------------------------------------------------------------===//
// Runtime interfaces
//===----------------------------------------------------------------------===//
 
/// Allocate a new signal. The index of the new signal in the state's list of
/// signals is returned.
int allocSignal(circt::llhd::sim::State *state, int index, char *owner,
                uint8_t *value, int64_t size);
 
/// Add offset and size information for the elements of an array signal.
void addSigArrayElements(circt::llhd::sim::State *state, unsigned index,
                         unsigned size, unsigned numElements);
 
/// Add offset and size information for one element of a struct signal. Elements
/// are assumed to be added (by calling this function) in sequential order, from
/// first to last.
void addSigStructElement(circt::llhd::sim::State *state, unsigned index,
                         unsigned offset, unsigned size);
 
/// Add allocated constructs to a process instance.
void allocProc(circt::llhd::sim::State *state, char *owner,
               circt::llhd::sim::ProcState *procState);
 
/// Add allocated entity state to the given instance.
void allocEntity(circt::llhd::sim::State *state, char *owner,
                 uint8_t *entityState);
 
/// Drive a value onto a signal.
void driveSignal(circt::llhd::sim::State *state,
                 circt::llhd::sim::SignalDetail *index, uint8_t *value,
                 uint64_t width, int time, int delta, int eps);
 
/// Suspend a process.
void llhdSuspend(circt::llhd::sim::State *state,
                 circt::llhd::sim::ProcState *procState, int time, int delta,
                 int eps);
}
 
#endif // CIRCT_DIALECT_LLHD_SIMULATOR_SIGNALS_RUNTIME_WRAPPERS_H