Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
deprecate SIMIX_process_{a,de}tach
[simgrid.git] / docs / source / application.rst
1 .. _application:
2
3 Describing your Application
4 ***************************
5
6 .. raw:: html
7
8    <object id="TOC" data="graphical-toc.svg" width="100%" type="image/svg+xml"></object>
9    <script>
10    window.onload=function() { // Wait for the SVG to be loaded before changing it
11      var elem=document.querySelector("#TOC").contentDocument.getElementById("ApplicationBox")
12      elem.style="opacity:0.93999999;fill:#ff0000;fill-opacity:0.1;stroke:#000000;stroke-width:0.35277778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1";
13    }
14    </script>
15    <br/>
16    <br/>
17
18 Every SimGrid simulation entails a distributed application, that
19 virtually executes on the simulated platform. You can express this
20 application using one of the following interfaces. It is even possible
21 to mix several interfaces in the same simulation.
22
23  - :ref:`Describing Algorithms with the S4U interface <S4U_doc>` (in C++)
24  - :ref:`Simulating existing MPI programs with the SMPI toolsuite <SMPI_doc>`
25    (in C, C++, or Fortran)
26  - In some cases, you may want to replay an execution trace in the simulator. This
27    trace lists the events of your application or of your workload, and
28    your application is decomposed as a list of event handlers that are
29    fired according to the trace. SimGrid comes with a build-in support
30    for MPI traces (with solutions to import traces captured by several
31    MPI profilers). You can reuse this mecanism for any kind of trace
32    that you want to replay, for example to study how a P2P DHT overlay
33    reacts to a given workload.
34  - Simulating algorithms with one of the legacy interfaces: :ref:`MSG
35    for distributed algorithms <MSG_doc>` (in :ref:`C <MSG_doc>` or
36    :ref:`Java <Java_doc>`) and SimDAG for
37    centralized algorithms (in C). SimGrid was founded in 1998, and
38    many interfaces were proposed along the way. MSG (introduced
39    around 2002) and SimDag (introduced before 2000), are still present
40    in SimGrid. They do not evolve anymore, but given their popularity,
41    they will not be removed until at least 2020. That being said, our
42    goal is to make S4U so useful that these legacy APIs become useless
43    and obsolete.
44  - We are currently working on the ability to modify any existing
45    application so that it can run on top of SimGrid. This project,
46    called `Remote-SimGrid
47    <git@framagit.org:simgrid/remote-simgrid.git>`_, is highly
48    experimental at this point.
49
50 As you can see, SimGrid is very modular and can be used in many
51 ways. We are working to improve it along two main directions. First,
52 we plan to further increase the modularity of the simulator so that
53 users can invent the specific API or DSL they need for their usage. We
54 call this project BYOS: Build Your Own Simulator.
55
56 Executing existing applications within the simulator is another
57 long-term goal. SMPI and Remote-SimGrid already allow you to execute some
58 applications, but our long term goal would be to allow for the execution
59 of any legacy application, with absolutely no modification. We call it
60 SimOS, even if it will not become usable before several years of
61 additional work.
62
63 .. The old documentation of the obsolete MSG replay module was removed in
64 ..  https://github.com/simgrid/simgrid/commit/e05361c201fb95d2b7605e59001cd0a49a489739