esiaccel.types.ESIType Class Reference

Inheritance diagram for esiaccel.types.ESIType:

Public Member Functions
	__init__ (self, str id)
	wrap_cpp (cls, cpp.Type cpp_type)
str	id (self)
Tuple[bool, Optional[str]]	supports_host (self)
Tuple[bool, Optional[str]]	is_valid (self, obj)
int	bit_width (self)
int	max_size (self)
bytearray	serialize (self, obj)
Tuple[object, bytearray]	deserialize (self, bytearray data)
int	__hash__ (self)
bool	__eq__ (self, other)
str	__str__ (self)

Public Attributes
	cpp_type
	id

Protected Member Functions
	_init_from_cpp (self, cpp.Type cpp_type)

Detailed Description

Definition at line 40 of file types.py.

Constructor & Destructor Documentation

__init__()

esiaccel.types.ESIType.__init__	(		self,
		str	id
	)

Reimplemented in esiaccel.types.VoidType, esiaccel.types.AnyType, esiaccel.types.ListType, esiaccel.types.ArrayType, esiaccel.types.ChannelType, esiaccel.types.BitsType, esiaccel.types.IntType, esiaccel.types.UIntType, esiaccel.types.SIntType, esiaccel.types.BundleType, esiaccel.types.StructType, esiaccel.types.UnionType, esiaccel.types.TypeAlias, and esiaccel.types.WindowType.

Definition at line 42 of file types.py.

References esiaccel.types.ArrayType._init_from_cpp(), esiaccel.types.BundleType._init_from_cpp(), esiaccel.types.ChannelType._init_from_cpp(), esiaccel.types.ListType._init_from_cpp(), esiaccel.types.StructType._init_from_cpp(), esiaccel.types.ESIType._init_from_cpp(), esiaccel.types.TypeAlias._init_from_cpp(), esiaccel.types.UnionType._init_from_cpp(), and esiaccel.types.WindowType._init_from_cpp().

Referenced by synth.LongestPathCollection.drop_non_critical_paths(), and synth.LongestPathCollection.merge().

Member Function Documentation

__eq__()

bool esiaccel.types.ESIType.__eq__	(		self,
			other
	)

Definition at line 100 of file types.py.

References circt::arc::runtime::impl::VCDSignalTableEntry.id, circt::FieldRef.id, circt::ImportVerilog::Context::PendingMonitor.id, esi::Instance.id, esi::BundlePort.id, esi::services::CustomService.id, esi::services::TelemetryService.id, esi::Type.id, WriteTraceChannelPort.id, esiaccel.accelerator.Instance.id(), esiaccel.types.ESIType.id(), esiaccel.types.ESIType.id, InterfaceElemsBuilder.id, and PathTracker::PathInfoTableEntry.id.

__hash__()

int esiaccel.types.ESIType.__hash__

(

self

)

Definition at line 97 of file types.py.

__str__()

str esiaccel.types.ESIType.__str__

(

self

)

Reimplemented in esiaccel.types.UIntType, esiaccel.types.SIntType, and esiaccel.types.TypeAlias.

Definition at line 103 of file types.py.

References esiaccel.types.ESIType.cpp_type.

_init_from_cpp()

esiaccel.types.ESIType._init_from_cpp (   self, cpp.Type  cpp_type  )

protected

Initialize instance attributes from a C++ type object.

Reimplemented in esiaccel.types.ArrayType, esiaccel.types.BundleType, esiaccel.types.ChannelType, esiaccel.types.ListType, esiaccel.types.StructType, esiaccel.types.TypeAlias, esiaccel.types.UnionType, and esiaccel.types.WindowType.

Definition at line 52 of file types.py.

Referenced by esiaccel.types.ESIType.__init__(), esiaccel.types.VoidType.__init__(), esiaccel.types.AnyType.__init__(), esiaccel.types.ListType.__init__(), esiaccel.types.ArrayType.__init__(), esiaccel.types.ChannelType.__init__(), esiaccel.types.BitsType.__init__(), esiaccel.types.IntType.__init__(), esiaccel.types.UIntType.__init__(), esiaccel.types.SIntType.__init__(), esiaccel.types.BundleType.__init__(), esiaccel.types.StructType.__init__(), esiaccel.types.UnionType.__init__(), esiaccel.types.TypeAlias.__init__(), and esiaccel.types.WindowType.__init__().

bit_width()

int esiaccel.types.ESIType.bit_width

(

self

)

Size of this type, in bits. Negative for unbounded types.

Reimplemented in esiaccel.types.ChannelType, esiaccel.types.VoidType, esiaccel.types.AnyType, esiaccel.types.BitsType, esiaccel.types.IntType, esiaccel.types.StructType, esiaccel.types.ArrayType, esiaccel.types.ListType, esiaccel.types.WindowType, esiaccel.types.UnionType, and esiaccel.types.TypeAlias.

Definition at line 76 of file types.py.

Referenced by esiaccel.types.UnionType.deserialize(), esiaccel.types.UIntType.is_valid(), esiaccel.types.SIntType.is_valid(), esiaccel.types.ESIType.max_size(), esiaccel.types.UnionType.serialize(), and esiaccel.types.ESIType.supports_host().

deserialize()

Tuple[object, bytearray] esiaccel.types.ESIType.deserialize	(		self,
		bytearray	data
	)

Convert a bytearray to a Python object. Return the object and the
leftover bytes.

Reimplemented in esiaccel.types.ChannelType, esiaccel.types.VoidType, esiaccel.types.AnyType, esiaccel.types.BitsType, esiaccel.types.UIntType, esiaccel.types.SIntType, esiaccel.types.StructType, esiaccel.types.ArrayType, esiaccel.types.ListType, esiaccel.types.WindowType, esiaccel.types.UnionType, and esiaccel.types.TypeAlias.

Definition at line 92 of file types.py.

id()

str esiaccel.types.ESIType.id

(

self

)

Get the stable id of this type.

Definition at line 57 of file types.py.

References esiaccel.types.ESIType.cpp_type.

Referenced by esiaccel.types.ESIType.__eq__().

is_valid()

Tuple[bool, Optional[str]] esiaccel.types.ESIType.is_valid	(		self,
			obj
	)

Is a Python object compatible with HW type?  Returns either '(True,
None)' if it is, or '(False, reason)' if it is not.

Reimplemented in esiaccel.types.ChannelType, esiaccel.types.VoidType, esiaccel.types.AnyType, esiaccel.types.BitsType, esiaccel.types.UIntType, esiaccel.types.SIntType, esiaccel.types.StructType, esiaccel.types.ArrayType, esiaccel.types.ListType, esiaccel.types.WindowType, esiaccel.types.UnionType, and esiaccel.types.TypeAlias.

Definition at line 70 of file types.py.

max_size()

int esiaccel.types.ESIType.max_size

(

self

)

Maximum size of a value of this type, in bytes.

Definition at line 81 of file types.py.

References esiaccel.types.ESIType.bit_width(), esiaccel.types.ChannelType.bit_width(), esiaccel.types.VoidType.bit_width(), esiaccel.types.AnyType.bit_width(), esiaccel.types.BitsType.bit_width(), esiaccel.types.IntType.bit_width(), esiaccel.types.StructType.bit_width(), esiaccel.types.ArrayType.bit_width(), esiaccel.types.ListType.bit_width(), esiaccel.types.WindowType.bit_width(), esiaccel.types.UnionType.bit_width(), and esiaccel.types.TypeAlias.bit_width().

Referenced by esiaccel.types.BitsType.deserialize(), esiaccel.types.UIntType.deserialize(), esiaccel.types.SIntType.deserialize(), and esiaccel.types.BitsType.is_valid().

serialize()

bytearray esiaccel.types.ESIType.serialize	(		self,
			obj
	)

Convert a Python object to a bytearray.

Reimplemented in esiaccel.types.UIntType, esiaccel.types.SIntType, esiaccel.types.ArrayType, esiaccel.types.ChannelType, esiaccel.types.VoidType, esiaccel.types.AnyType, esiaccel.types.StructType, esiaccel.types.ListType, esiaccel.types.WindowType, esiaccel.types.UnionType, esiaccel.types.TypeAlias, and esiaccel.types.BitsType.

Definition at line 88 of file types.py.

supports_host()

Tuple[bool, Optional[str]] esiaccel.types.ESIType.supports_host

(

self

)

Does this type support host communication via Python? Returns either
'(True, None)' if it is, or '(False, reason)' if it is not.

Reimplemented in esiaccel.types.ChannelType, esiaccel.types.ListType, and esiaccel.types.WindowType.

Definition at line 62 of file types.py.

References esiaccel.types.ESIType.bit_width(), esiaccel.types.ChannelType.bit_width(), esiaccel.types.VoidType.bit_width(), esiaccel.types.AnyType.bit_width(), esiaccel.types.BitsType.bit_width(), esiaccel.types.IntType.bit_width(), esiaccel.types.StructType.bit_width(), esiaccel.types.ArrayType.bit_width(), esiaccel.types.ListType.bit_width(), esiaccel.types.WindowType.bit_width(), esiaccel.types.UnionType.bit_width(), and esiaccel.types.TypeAlias.bit_width().

wrap_cpp()

esiaccel.types.ESIType.wrap_cpp	(		cls,
		cpp.Type	cpp_type
	)

Wrap a C++ ESI type with its corresponding Python ESI Type.

Definition at line 46 of file types.py.

References esiaccel.types.BundlePort.__new__().

Member Data Documentation

cpp_type

esiaccel.types.ESIType.cpp_type

Definition at line 54 of file types.py.

Referenced by esiaccel.types.ESIType.__str__(), esiaccel.types.BitsType.bit_width(), esiaccel.types.IntType.bit_width(), esiaccel.types.StructType.deserialize(), esiaccel.types.ESIType.id(), and esiaccel.types.StructType.serialize().

id

esiaccel.types.ESIType.id

Definition at line 98 of file types.py.

Referenced by esiaccel.types.ESIType.__eq__().

---

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/types.py