SimGrid  3.12
Versatile Simulation of Distributed Systems
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]
 MSGSimple programming environment
 Main MSG simulation FunctionsDescribes how to setup and control your simulation
 Process Management FunctionsThis section describes the process structure of MSG (msg_process_t) and the functions for managing it
 Host Management FunctionsThis section describes the host structure of MSG
 Task Management FunctionsThis 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 FunctionsThis section describes the mailbox structure of MSG (msg_mailbox_t) and the functions for managing it
 Task ActionsThis section describes the functions that can be used by a process to execute, communicate or otherwise handle some task
 Explicit Synchronization FunctionsThis section describes several explicit synchronization mechanisms existing in MSG: semaphores (msg_sem_t) and friends
 VMsThis section describes the interface created to mimic IaaS clouds
 Storage Management FunctionsThis section describes the storage structure of MSG (msg_storage_t) and the functions for managing it. It is based on POSIX functions
 File Management FunctionsThis section describes the file structure of MSG (msg_file_t) and the functions for managing it. It is based on POSIX functions
 Trace-driven simulationsThis section describes the functions allowing to build trace-driven simulations
 Lua bindingsLua bindings to MSG (MSG)
 MSG examplesMSG examples from examples directory examples/msg
 MSG DeprecatedThis section describes the deprecated functions. PLEASE STOP USING THEM
 XBTThe core toolbox of SimGrid, containing usefull datatypes and friends
 Grounding features
 Malloc and friendsMalloc and associated functions, killing the program on error (with Exception support)
 String related functionsString manipulation functions
 Exception supportA set of macros providing exception a la C++ in ANSI C (grounding feature)
 Logging supportA generic logging facility in the spirit of log4j (grounding feature)
 Assert macro famillyThose are the SimGrid version of the good ol' assert macro
 Configuration supportChanging the configuration of SimGrid components (grounding feature)
 MallocatorsThe mallocator system
 Unit testing supportUnit test mechanism (to test a set of functions)
 Usual data structures
 Dynar: generic dynamic arrayDynArr are dynamically sized vector which may contain any type of variables
 Dict: generic dictionnaryThe dictionary data structure (comparable to hash tables)
 Set: generic set datatypeA data container consisting in Dict: generic dictionnary and Dynar: generic dynamic array
 Fifo: generic workqueueThis section describes the API to generic workqueue
 Swag: O(1) set datatypeO(1) set based on linked lists
 Heap: generic heap data structureThis section describes the API to generic heap with O(log(n)) access
 Data description
 Misc general purposes library components
 General purpose graph libraryA graph data type with several interesting algorithms
 Parallel mapParallel map
 PeerHelper functions to manipulate remote hosts
 QueueSynchronized message exchanging queue
 Sock
 Synchro stuffXBT synchronization tools
 Thread stuffThread portability layer
 Portable context implementationContexts are a higher level system than setjump/longjmp for non-preemptible threads
 Replay
 TRACETracing mechanism and its functions
 Tracing categoriesFunctions to declare tracing categories
 Tracing marksFunctions to declare and create tracing marks
 Tracing user variablesFunctions to declare and define user variables associated to resources
 SIMIXPOSIX-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
 SMPIProgramming environment for the simulation of MPI applications
 SimDagProgramming environment for DAG applications
 SD Data TypesThis section describes the different datatypes provided by SD
 WorkstationsFunctions for managing the workstations
 LinksFunctions for managing the network links
 TasksFunctions for managing the tasks
 Tasks dependenciesFunctions for managing the task dependencies
 SimulationFunctions for creating the environment and launching the simulation
 SURFInternal kernel of all the simulators used in SimGrid, and associated models
 Simulation ModelsFunctions to declare the kind of models that you want to use
 SimulationFunctions for creating the environment and launching the simulation
 Create a new APIHow to build a new API on top of SURF
 SURF C bindingsDescribes the c bindings of SURF
 SURF InterfaceDescribes the general interface for all components (Cpu, Network, Storage, Host, VM)
 SURF Routing InterfaceDescribes the routing interface
 SURF Cpu InterfaceDescribes the general Cpu interface for all Cpu implementations
 SURF Network InterfaceDescribes the general Network interface for all Network implementations
 SURF Storage InterfaceDescribes the general interface for all Storage implementations
 SURF Host InterfaceDescribes the general interface for all Host implementations
 SURF VM InterfaceDescribes the general interface for all VM implementations
 SURF Linear MaxMinDescribes how the linear MaxMin system work
 SURF callbacksDescribes how to use the SURF callbacks
 SURF Energy PluginDescribes how to use the energy plugin
 Full IndexThe alphabetical list of all functions, macros and types defined by SimGrid
 XBT_fileFile manipulation functions