SimGrid: APIs Reference

SimGrid 3.10 Versatile Simulation of Distributed Systems

- Home page
- Online documentation
- Dev's Corner

All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
APIs Reference
Here is the hierarchical view of all SimGrid modules. You can reduce the amount of detail with the 'detail level' setting, on the right.
[detail level 1234]

MSG | Simple programming environment
Main MSG simulation Functions | Describes how to setup and control your simulation
Process Management Functions | This section describes the process structure of MSG (msg_process_t) and the functions for managing it
Host Management Functions | This section describes the host structure of MSG
Task Management Functions | This section describes the task structure of MSG (msg_task_t) and the functions for managing it. See Task Actions to see how to put the tasks in action
Mailbox Management Functions | This section describes the mailbox structure of MSG (msg_mailbox_t) and the functions for managing it
Task Actions | This section describes the functions that can be used by a process to execute, communicate or otherwise handle some task
Explicit Synchronization Functions | This section describes several explicit synchronization mechanisms existing in MSG: semaphores (msg_sem_t) and friends
VMs | This section describes the interface created to mimic IaaS clouds
File Management Functions | This section describes the file structure of MSG (msg_file_t) and the functions for managing it. It is based on POSIX functions
Trace-driven simulations | This section describes the functions allowing to build trace-driven simulations
Lua bindings | Lua bindings to MSG (MSG)
MSG examples | MSG examples from examples directory examples/msg
MSG Deprecated | This section describes the deprecated functions. PLEASE STOP USING THEM
XBT | The core toolbox of SimGrid, containing usefull datatypes and friends
Grounding features |
Malloc and friends | Malloc and associated functions, killing the program on error (with Exception support)
String related functions | String manipulation functions
Exception support | A set of macros providing exception a la C++ in ANSI C (grounding feature)
Logging support | A generic logging facility in the spirit of log4j (grounding feature)
Existing log categories | (automatically extracted)
Assert macro familly | Those are the SimGrid version of the good ol' assert macro
Configuration support | Changing the configuration of SimGrid components (grounding feature)
User interface: changing values |
Configuration type declaration and memory management |
Registering stuff |
Getting the stored values |
Mallocators | The mallocator system
Mallocator constructor and destructor |
Mallocator object handling |
Unit testing support | Unit test mechanism (to test a set of functions)
Usual data structures |
Dynar: generic dynamic array | DynArr are dynamically sized vector which may contain any type of variables
Dynar constructor and destructor |
Dynar as a regular array |
Dynar miscellaneous functions |
Perl-like use of dynars |
Direct manipulation to the dynars content |
Speed optimized access to dynars of scalars |
Cursors on dynar |
Dict: generic dictionnary | The dictionary data structure (comparable to hash tables)
Dict constructor and destructor |
Dictionaries basic usage |
Dictionaries with non-nul terminated keys |
Cursors on dictionaries |
Set: generic set datatype | A data container consisting in Dict: generic dictionnary and Dynar: generic dynamic array
Set and set elements, constructor/destructor |
Sets basic usage |
Sets cursors |
Fifo: generic workqueue | This section describes the API to generic workqueue
Fifo constructor and destructor |
Fifo perl-like functions |
Direct access to fifo elements |
Misc fifo functions |
Swag: O(1) set datatype | O(1) set based on linked lists
Swag types |
SWAG functions |
Swag cursor |
Heap: generic heap data structure | This section describes the API to generic heap with O(log(n)) access
Data description |
Misc general purposes library components |
General purpose graph library | A graph data type with several interesting algorithms
Parallel map | Parallel map
Peer | Helper functions to manipulate remote hosts
Queue | Synchronized message exchanging queue
Sock |
Synchro stuff | XBT synchronization tools
Thread stuff | Thread portability layer
Portable context implementation | Contexts are a higher level system than `setjump/longjmp` for non-preemptible threads
Replay |
TRACE | Tracing mechanism and its functions
Tracing categories | Functions to declare tracing categories
Tracing marks | Functions to declare and create tracing marks
Tracing user variables | Functions to declare and define user variables associated to resources
SIMIX | POSIX-like interface for building simulation
SIMIX datatypes management details |
Process Management Functions |
Host Management Functions |
RDV Management Functions |
Communication Management Functions |
Synchronisation Management Functions |
File Management Functions |
SMPI | Programming environment for the simulation of MPI applications
SimDag | Programming environment for DAG applications
SD Data Types | This section describes the different datatypes provided by SD
Workstations | Functions for managing the workstations
Links | Functions for managing the network links
Tasks | Functions for managing the tasks
Tasks dependencies | Functions for managing the task dependencies
Simulation | Functions for creating the environment and launching the simulation
SURF | Internal kernel of all the simulators used in SimGrid, and associated models
Simulation | Functions for creating the environment and launching the simulation
SURF actions | This section describes the different datatypes and operations related to the actions in SURF
SURF resources | This section describes the different datatypes and operations related to the resources in SURF
Create a new API | How to build a new API on top of SURF
Full Index | The alphabetical list of all functions, macros and types defined by SimGrid
Msg_storage_management |