Versatile Simulation of Distributed Systems
This page presents the current code organization, as you will see it if you dig into the src/ directory. But things will change during the current Gran Refactoring leading to SimGrid 4. So take the information on this page with a grain of salt, and don't be affraid if things are not exactly as documented here.
At some point, we at least extend this page to present the overall design that we are currently pursuing for SimGrid 4.
If you need to extend SimGrid, then you probably need to head to Coding Standard and Technical Considerations once you understant the overall design presented on this page.
SimGrid provides several programming environments built on top of a unique simulation kernel. Each environment targets a specific audience and constitutes a different paradigm. To choose which of them you want to use, you have to think about what you want to do and what would be the result of your work.
If your favorite programming environment/model is not there (BSP, components, OpenMP, etc.) is not represented in the SimGrid toolkit yet, you may consider adding it. You should contact us first on the SimGrid developers mailing list, though.
The core functionalities to simulate a virtual platform are provided by a module called SURF. It is very low-level and is not intended to be used as such by end-users. Instead, it serve as a basis for the higher level layer.
SURF main features are a fast max-min linear solver and the ability to change transparently the model used to describe the platform. This greatly eases the comparison of the several models existing in the literature.
See the SURF section for more details.
The base of the whole toolkit is constituted by the XBT: SimGrid core toolbox (eXtended Bundle of Tools).
XBT also encompass the following convenient C data structures: Dynar: generic dynamic array, Dict: generic dictionnary, Heap: generic heap data structure, and Swag: O(1) set datatype. The code is being migrated in C++ so you should probably want to use standard C++ containers instead of them if possible.
It contains some C++ polyfills and utilities as well.
See the XBT: SimGrid core toolbox section for more details.
Finally, a transversal module allows you to trace your simulation. More documentation in the section TRACE documentation