Crate simics

High level bindings to the SIMICS API in idiomatic Rust

Re-exports

• pub use api::*;
• pub use error::*;
• pub use util::*;

Modules

• api
  The SIMICS API
• error
  Error types that can be returned by the Simics crate
• imp 🔒
• log
  Logging utilities for the Simics crate for use with the Simics logging API
• util
  Utility functionality to assist managing SIMICS projects

Macros

• debug
  Log a debug message via the SIMICS logging API. If an object is provided, the message will be logged through that object. If not, the message will be logged through the base sim object.
• error
  Log an error message via the SIMICS logging API.
• info
  Log an informational message via the SIMICS logging API. If an object is provided, the message will be logged through that object. If not, the message will be logged through the base sim object.
• log
  Log a message via the SIMICS logging API.
• simics_alloc
  Allocate memory with a size, of some type
• trace
  Log a trace message via the SIMICS logging API. If an object is provided, the message will be logged through that object. If not, the message will be logged through the base sim object.
• warn
  Log a warning message via the SIMICS logging API. If an object is provided, the message will be logged through that object. If not, the message will be logged through the base sim object.

Statics

• GLOBAL 🔒
  All crates using the SIMICS API must also use the SIMICS allocator as their global allocator, hence we set it here

Functions

• get_panic_info_message
  Attempt to produce a &str message (with a default) from a std::panic::PanicHookInfo. See module docs for usage.
• get_panic_message
  Attempt to produce a &str message from a std::panic::catch_unwind payload. See module docs for usage.
• panic_handler
  Panic handler for Simics modules.
• panic_info_message
  Attempt to produce a &str message (with a default) from a std::panic::PanicHookInfo. See module docs for usage.
• panic_message
  Attempt to produce a &str message (with a default) from a std::panic::catch_unwind payload. See module docs for usage.

Attribute Macros

• class
  Attribute macro for declaring a Simics class for a Rust struct type
• interface
  Declare a struct implementation as a SIMICS API interface.
• simics_exception
  Marks a function as being a SIMICS API that can throw exceptions in called FFI APIs.
• simics_init
  Mark a function as being the initializer of a Simics module.

Derive Macros

• AsConfObject
  Derive macro for implementing conversion to raw ConfObject pointers. This macro implements the AsConfObject trait for the annotated type.
• Class
  Derive macro for implementing the Class trait for the annotated type
• FromAttrValueDict
  Derive Macro for implementing conversion from an AttrValue dict into a struct, where each key, value pair in the dict is a struct field’s name, value pair.
• FromAttrValueList
  Derive Macro for implementing conversion from an AttrValue list into a struct, where each entry in the list is a struct field’s value.
• FromConfObject
  Derive macro for implementing conversion from raw ConfObject pointers. This macro implements the FromConfObject trait for the annotated type.
• IntoAttrValueDict
  Derive Macro for implementing conversion into an AttrValue dictionary, where each struct field’s key, value pair is an entry in the dictionary.
• IntoAttrValueList
  Derive Macro for implementing conversion into an AttrValue list, where each struct field’s value is an entry in the heterogeneous list.