verilator.Verilator Class Reference

Inheritance diagram for verilator.Verilator:

Collaboration diagram for verilator.Verilator:

Public Member Functions
	__init__ (self, SourceFiles sources, Path run_dir, bool debug, Optional[Callable[[str], None]] run_stdout_callback=None, Optional[Callable[[str], None]] run_stderr_callback=None, Optional[Callable[[str], None]] compile_stdout_callback=None, Optional[Callable[[str], None]] compile_stderr_callback=None, bool make_default_logs=True, Optional[Dict[str, str]] macro_definitions=None)
List[List[str]]	compile_commands (self)
	run_command (self, bool gui)
Public Member Functions inherited from simulator.Simulator
int	compile (self)
SimProcess	run_proc (self, bool gui=False)
int	run (self, str inner_command, bool gui=False, bool server_only=False)

Public Attributes
	verilator
Public Attributes inherited from simulator.Simulator
	sources
	run_dir
	debug
	macro_definitions

Static Public Attributes
str	DefaultDriver = CosimCollateralDir / "driver.cpp"
Static Public Attributes inherited from simulator.Simulator
bool	UsesStderr = True

Additional Inherited Members
Static Public Member Functions inherited from simulator.Simulator
Dict[str, str]	get_env ()
Protected Member Functions inherited from simulator.Simulator
int|tuple[subprocess.Popen, List[threading.Thread]]	_start_process_with_callbacks (self, List[str] cmd, Optional[Dict[str, str]] env, Optional[Path] cwd, Optional[Callable[[str], None]] stdout_cb, Optional[Callable[[str], None]] stderr_cb, bool wait)
Protected Attributes inherited from simulator.Simulator
	_compile_stdout_cb
	_compile_stdout_log
	_compile_stderr_cb
	_compile_stderr_log
	_run_stdout_cb
	_run_stdout_log
	_run_stderr_cb
	_run_stderr_log

Detailed Description

Run and compile funcs for Verilator.

Definition at line 12 of file verilator.py.

Constructor & Destructor Documentation

__init__()

verilator.Verilator.__init__	(		self,
		SourceFiles	sources,
		Path	run_dir,
		bool	debug,
		Optional[Callable[[str], None]]	run_stdout_callback = None,
		Optional[Callable[[str], None]]	run_stderr_callback = None,
		Optional[Callable[[str], None]]	compile_stdout_callback = None,
		Optional[Callable[[str], None]]	compile_stderr_callback = None,
		bool	make_default_logs = True,
		Optional[Dict[str, str]]	macro_definitions = None
	)

Simulator base class.

Optional sinks can be provided for capturing output. If not provided,
the simulator will write to log files in `run_dir`.

Args:
  sources: SourceFiles describing RTL/DPI inputs.
  run_dir: Directory where build/run artifacts are placed.
  debug: Enable cosim debug mode.
  run_stdout_callback: Line-based callback for runtime stdout.
  run_stderr_callback: Line-based callback for runtime stderr.
  compile_stdout_callback: Line-based callback for compile stdout.
  compile_stderr_callback: Line-based callback for compile stderr.
  make_default_logs: If True and corresponding callback is not supplied,
    create log file and emit via internally-created callback.
  macro_definitions: Optional dictionary of macro definitions to be defined
    during compilation.

Reimplemented from simulator.Simulator.

Definition at line 17 of file verilator.py.

References verilator.Verilator.__init__().

Referenced by verilator.Verilator.__init__(), and synth.LongestPathCollection.merge().

Member Function Documentation

compile_commands()

List[List[str]] verilator.Verilator.compile_commands

(

self

)

Compile the sources. Returns the exit code of the simulation compiler.

Reimplemented from simulator.Simulator.

Definition at line 44 of file verilator.py.

References esi::CliParser.debug, esi::Logger.debug(), esi::Logger.debug(), simulator.Simulator.debug, simulator.Simulator.macro_definitions, simulator.Simulator.sources, and verilator.Verilator.verilator.

Referenced by simulator.Simulator.compile().

run_command()

verilator.Verilator.run_command	(		self,
		bool	gui
	)

Return the command to run the simulation.

Reimplemented from simulator.Simulator.

Definition at line 88 of file verilator.py.

References simulator.Simulator.sources.

Referenced by Python.setup.CustomBuild.run(), setup.CustomBuild.run(), and simulator.Simulator.run_proc().

Member Data Documentation

DefaultDriver

str verilator.Verilator.DefaultDriver = CosimCollateralDir / "driver.cpp"

static

Definition at line 15 of file verilator.py.

verilator

verilator.Verilator.verilator

Definition at line 40 of file verilator.py.

Referenced by verilator.Verilator.compile_commands().

---

The documentation for this class was generated from the following file:

• /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/python/esiaccel/cosim/verilator.py