another try at cleanly unlocking the mutexes before destroying them in SMPI::RMA

[simgrid.git] / docs / source / Installing_SimGrid.rst

diff --git a/docs/source/Installing_SimGrid.rst b/docs/source/Installing_SimGrid.rst
index 510603d527a799fbb317272243af82e9fd992e01..39cc872e8fff1e922f9ce5ff40a516c8825f8958 100644 (file)
--- a/docs/source/Installing_SimGrid.rst
+++ b/docs/source/Installing_SimGrid.rst
@@ -1,4 +1,4 @@
-.. Copyright 2005-2022
+.. Copyright 2005-2023

 
 .. _install:
 
 
 .. _install:
 


@@ -7,8 +7,7 @@ Installing SimGrid
 
 
 SimGrid should work out of the box on Linux, macOS, FreeBSD, and
 
 
 SimGrid should work out of the box on Linux, macOS, FreeBSD, and

-Windows (under Windows, you need to install the Windows Subsystem
-Linux to get more than the Java bindings).
+Windows (with WSL).

 
 Pre-compiled Packages
 ---------------------
 
 Pre-compiled Packages
 ---------------------


@@ -22,7 +21,6 @@ following lines, or several lines if you need several languages.
 .. code-block:: console
 
    $ apt install libsimgrid-dev  # if you want to develop in C or C++
 .. code-block:: console
 
    $ apt install libsimgrid-dev  # if you want to develop in C or C++

-   $ apt install simgrid-java    # if you want to develop in Java

    $ apt install python3-simgrid # if you want to develop in Python
 
 If you use the Nix_ package manager, the latest SimGrid release is packaged as ``simgrid`` in Nixpkgs_.
    $ apt install python3-simgrid # if you want to develop in Python
 
 If you use the Nix_ package manager, the latest SimGrid release is packaged as ``simgrid`` in Nixpkgs_.


@@ -45,35 +43,16 @@ email.
 .. _simgrid AUR package: https://aur.archlinux.org/packages/simgrid/
 .. _AUR official documentation: https://wiki.archlinux.org/title/Arch_User_Repository
 
 .. _simgrid AUR package: https://aur.archlinux.org/packages/simgrid/
 .. _AUR official documentation: https://wiki.archlinux.org/title/Arch_User_Repository
 

-.. _install_java_precompiled:
-
-Stable Java Package
+Binaries from macOS

 ^^^^^^^^^^^^^^^^^^^
 
 ^^^^^^^^^^^^^^^^^^^
 

-The jar file can be retrieved from the `Release page
-<https://framagit.org/simgrid/simgrid/-/releases>`_. This file is
-self-contained, including the native components for Linux, macOS and
-Windows. Copy it to your project's classpath and you're set.
-
-Nightly built Java Package
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Head to the corresponding `GitHub Action <https://github.com/simgrid/simgrid/actions/workflows/jarfile.yml>`_
-and pick the last green build. At the bottom of the build page, click on the ``jar-final`` artefact.
-Open this zip file to find the jar you need. This jar can be used under Linux, Mac OSX or Windows, as you wish.
-
-Binary Java Troubleshooting
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+SimGrid can be found in the Homebrew package manager. Troubleshooting:

 
 

-Here are some error messages that you may get when trying to use the
-binary Java package.
+warning: dylib (libsimgrid.dylib) was built for newer macOS version (14.0) than being linked (13.3)
+  This was reported with the SimGrid version from Homebrew on a Mac book air M1 (ARM).
+  The solution is simply to export this variable before the compilation of your binaries:

 
 

-Your architecture is not supported by this jarfile
-   If your system is not supported, you should compile your
-   own jarfile :ref:`by compiling SimGrid <install_src>` from the source.
-Library not found: boost-context
-   You should obviously install the ``boost-context`` library on your
-   machine, for example with ``apt``.
+  ``export MACOSX_DEPLOYMENT_TARGET=14.0``

 
 .. _deprecation_policy:
 
 
 .. _deprecation_policy:
 


@@ -107,12 +86,14 @@ but that's even more so for these unreleased versions).
 Installing from the Source
 --------------------------
 
 Installing from the Source
 --------------------------
 

+.. _install_src_deps:
+

 Getting the Dependencies
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
 C++ compiler (either g++, clang, or icc).
 Getting the Dependencies
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
 C++ compiler (either g++, clang, or icc).

-  We use the C++14 standard, and older compilers tend to fail on
-  us. It seems that g++ 5.0 or higher is required nowadays (because of
+  We use the C++17 standard, and older compilers tend to fail on
+  us. It seems that g++ 7.0 or higher is required nowadays (because of

   boost).  SimGrid compiles well with `clang` or `icc` too.
 Python 3.
   SimGrid should build without Python. That is only needed by our regression test suite.
   boost).  SimGrid compiles well with `clang` or `icc` too.
 Python 3.
   SimGrid should build without Python. That is only needed by our regression test suite.


@@ -120,13 +101,26 @@ cmake (v3.5).
   ``ccmake`` provides a nicer graphical interface compared to ``cmake``.
   Press ``t`` in ``ccmake`` if you need to see absolutely all
   configuration options (e.g., if your Python installation is not standard).
   ``ccmake`` provides a nicer graphical interface compared to ``cmake``.
   Press ``t`` in ``ccmake`` if you need to see absolutely all
   configuration options (e.g., if your Python installation is not standard).

-boost (at least v1.48, v1.59 recommended)
-  - On Debian / Ubuntu: ``apt install libboost-dev libboost-context-dev``
+boost mandatory components (at least v1.48, v1.59 recommended)
+  - On Debian / Ubuntu: ``apt install libboost-dev``
+  - On CentOS / Fedora: ``dnf install boost-devel``

   - On macOS with homebrew: ``brew install boost``
   - On macOS with homebrew: ``brew install boost``

-Java (optional):
-  - Debian / Ubuntu: ``apt install default-jdk libgcj18-dev`` (or
-    any version of libgcj)
-  - macOS or Windows: Grab a `full JDK <http://www.oracle.com/technetwork/java/javase/downloads>`_
+boost recommended components (optional).
+  - boost-context may be used instead of our own fast context switching code which only works on amd64.
+  - boost-stacktrace is used to get nice stacktraces on errors in SimGrid.
+  - On Debian / Ubuntu: ``apt install libboost-context-dev libboost-stacktrace-dev``
+python bindings (optional):
+  - On Debian / Ubuntu: ``apt install pybind11-dev python3-dev``
+Model-checking mandatory dependencies
+  - On Debian / Ubuntu: ``apt install libevent-dev``
+Eigen3 (optional)
+  - On Debian / Ubuntu: ``apt install libeigen3-dev``
+  - On CentOS / Fedora: ``dnf install eigen3-devel``
+  - On macOS with homebrew: ``brew install eigen``
+  - Use EIGEN3_HINT to specify where it's installed if cmake doesn't find it automatically. Set EIGEN3_HINT=OFF to disable detection even if it could be found.
+JSON (optional, for the DAG wfcommons loader)
+  - On Debian / Ubuntu: ``apt install nlohmann-json3-dev``
+  - Use nlohmann_json_HINT to specify where it's installed if cmake doesn't find it automatically.

 
 For platform-specific details, please see below.
 
 
 For platform-specific details, please see below.
 


@@ -140,7 +134,7 @@ Grab the last **stable release** from `FramaGit
 
    $ tar xf simgrid-3-XX.tar.gz
    $ cd simgrid-*
 
    $ tar xf simgrid-3-XX.tar.gz
    $ cd simgrid-*

-   $ cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid .
+   $ cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid -GNinja .

    $ make
    $ make install
 
    $ make
    $ make install
 


@@ -177,8 +171,7 @@ cmake itself.
    files in the tree, you may need to wipe out your complete tree and
    start with a fresh one when you install new dependencies.
 
    files in the tree, you may need to wipe out your complete tree and
    start with a fresh one when you install new dependencies.
 

-   Another (better) solution is to :ref:`build out of the source tree
-   <install_cmake_outsrc>`.
+   A better solution is to :ref:`build out of the source tree <install_cmake_outsrc>`.

 
 Generic build-time options
 """"""""""""""""""""""""""
 
 Generic build-time options
 """"""""""""""""""""""""""


@@ -213,7 +206,7 @@ Note that the dot at the end is mandatory (see :ref:`install_cmake_outsrc`).
 
 .. code-block:: console
 
 
 .. code-block:: console
 

-   $ cmake -DCC=clang -DCXX=clang++ .
+   $ cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ .

 
 SimGrid compilation options
 """""""""""""""""""""""""""
 
 SimGrid compilation options
 """""""""""""""""""""""""""


@@ -247,13 +240,6 @@ enable_documentation (on/OFF)
   as easy as it used to be, and you should probably use the online
   version for now.
 
   as easy as it used to be, and you should probably use the online
   version for now.
 

-enable_java (on/OFF)
-  Generates the java bindings of SimGrid. You must also enable MSG for
-  this to work.
-
-enable_lib_in_jar (ON/off)
-  Embeds the native java bindings into the produced jar file.
-

 enable_lto (ON/off)
   Enables the *Link Time Optimization* in the C++ compiler.
   This feature really speeds up the code produced, but it is fragile
 enable_lto (ON/off)
   Enables the *Link Time Optimization* in the C++ compiler.
   This feature really speeds up the code produced, but it is fragile


@@ -266,36 +252,39 @@ enable_mallocators (ON/off)
   Activates our internal memory caching mechanism. This produces faster
   code, but it may fool the debuggers.
 
   Activates our internal memory caching mechanism. This produces faster
   code, but it may fool the debuggers.
 

-enable_model-checking (on/OFF)
-  Activates the formal verification mode. This will **hinder
-  simulation speed** even when the model checker is not activated at
-  run time.
-
-enable_msg (on/OFF)
-  Activates the :ref:`MSG <MSG_doc>` legacy interface.
+enable_model-checking (ON/off)
+  Activates the verification mode. This should not impact the performance of your simulations if you build it but don't use it,
+  but you can still disable it to save some compilation time.

 
 enable_ns3 (on/OFF)
 
 enable_ns3 (on/OFF)

-  Activates the ns-3 bindings. See section :ref:`model_ns3`.
+  Activates the ns-3 bindings. See section :ref:`models_ns3`.

 
 enable_smpi (ON/off)
   Allows one to run MPI code on top of SimGrid.
 
 
 enable_smpi (ON/off)
   Allows one to run MPI code on top of SimGrid.
 

-enable_smpi_MBI_testsuite (on/OFF)
-  Adds many extra tests for the model checker module.
+enable_testsuite_McMini (on/OFF)
+  Adds several extra tests for the model checker module (targeting threaded applications).

 
 

-enable_smpi_MPICH3_testsuite (on/OFF)
+enable_testsuite_smpi_MBI (on/OFF)
+  Adds many extra tests for the model checker module (targeting MPI applications).
+
+enable_testsuite_smpi_MPICH3 (on/OFF)

   Adds many extra tests for the MPI module.
 
 minimal-bindings (on/OFF)
   Take as few optional dependencies as possible, to get minimal
   Adds many extra tests for the MPI module.
 
 minimal-bindings (on/OFF)
   Take as few optional dependencies as possible, to get minimal

-  library bindings in Java and Python.
+  library bindings in Python.

 
 NS3_HINT (empty by default)
   Alternative path into which ns-3 should be searched for.
 
 
 NS3_HINT (empty by default)
   Alternative path into which ns-3 should be searched for.
 

+EIGEN3_HINT (empty by default)
+  Alternative path into which Eigen3 should be searched for.
+  Providing the value OFF as an hint will disable the detection alltogether.
+

 SIMGRID_PYTHON_LIBDIR (auto-detected)
 SIMGRID_PYTHON_LIBDIR (auto-detected)

-  Where to install the Python module library. By default, it is set to the cmake Python3_SITEARCH variable if installing to /usr, 
-  and a modified version of that variable if installing to another path. Just force another value if the auto-detected default 
+  Where to install the Python module library. By default, it is set to the cmake Python3_SITEARCH variable if installing to /usr,
+  and a modified version of that variable if installing to another path. Just force another value if the auto-detected default

   does not fit your setup.
 
 SMPI_C_FLAGS, SMPI_CXX_FLAGS, SMPI_Fortran_FLAGS (string)
   does not fit your setup.
 
 SMPI_C_FLAGS, SMPI_CXX_FLAGS, SMPI_Fortran_FLAGS (string)


@@ -348,13 +337,12 @@ existing targets are not really for public consumption so don't worry
 if some do not work for you.
 
 - **make**: Build the core of SimGrid that gets installed, but not any example.
 if some do not work for you.
 
 - **make**: Build the core of SimGrid that gets installed, but not any example.

-- **make tests**: Build the tests and examples.
+- **make examples**: Build the examples, which are needed by the tests.

 - **make simgrid**: Build only the SimGrid library. Not any example nor the helper tools.
 - **make s4u-comm-pingpong**: Build only this example (works for any example)
 - **make simgrid**: Build only the SimGrid library. Not any example nor the helper tools.
 - **make s4u-comm-pingpong**: Build only this example (works for any example)

-- **make java-all**: Build all Java examples and their dependencies
+- **make python-bindings**: Build the Python bindings

 - **make clean**: Clean the results of a previous compilation
 - **make install**: Install the project (doc/ bin/ lib/ include/)
 - **make clean**: Clean the results of a previous compilation
 - **make install**: Install the project (doc/ bin/ lib/ include/)

-- **make uninstall**: Uninstall the project (doc/ bin/ lib/ include/)

 - **make dist**: Build a distribution archive (tar.gz)
 - **make distcheck**: Check the dist (make + make dist + tests on the distribution)
 - **make documentation**: Create SimGrid documentation
 - **make dist**: Build a distribution archive (tar.gz)
 - **make distcheck**: Check the dist (make + make dist + tests on the distribution)
 - **make documentation**: Create SimGrid documentation


@@ -425,25 +413,15 @@ Windows-specific instructions
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The best solution to get SimGrid working on windows is to install the
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The best solution to get SimGrid working on windows is to install the

-Ubuntu subsystem of Windows 10. All of SimGrid (but the model checker)
-works in this setting.
-
-Native builds not very well supported. Have a look to our `appveypor
-configuration file
-<https://framagit.org/simgrid/simgrid/blob/master/.appveyor.yml>`_ to
-see how we manage to use mingw-64 to build the DLL that the Java file
-needs.
-
-The drawback of MinGW-64 is that the produced DLL are not compatible
-with MS Visual C. Some clang-based tools seem promising to fix this,
-but this is of rather low priority for us. It it's important for you
-and if you get it working, please @ref community_contact "tell us".
+Ubuntu subsystem of Windows 10. All of SimGrid 
+works in this setting. Native builds never really worked, and they are
+disabled starting with SimGrid v3.33.

 
 Python-specific instructions
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Once you have the Python development headers installed as well as a
 
 Python-specific instructions
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Once you have the Python development headers installed as well as a

-recent version of the `pybind11 <https://pybind11.readthedocs.io/en/stable/>`
+recent version of the `pybind11 <https://pybind11.readthedocs.io/en/stable/>`_

 module (version at least 2.4), recompiling the Python bindings from
 the source should be as easy as:
 
 module (version at least 2.4), recompiling the Python bindings from
 the source should be as easy as:
 


@@ -459,68 +437,16 @@ simgrid without downloading the source with pip:
 
   $ pip install simgrid
 
 
   $ pip install simgrid
 

-Java-specific instructions
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Once you have the `full JDK <http://www.oracle.com/technetwork/java/javase/downloads>`_ installed,
-things should be as simple as:
-
-.. code-block:: console
-
-   $ cmake -Denable_java=ON -Dminimal-bindings=ON .
-   $ make  simgrid-java_jar # Only build the jarfile
-
-After the compilation, the file ```simgrid.jar``` is produced in the
-root directory.
-
-**Troubleshooting Java Builds**
-
-Sometimes, the build system fails to find the JNI headers. First locate them as follows:
-
-.. code-block:: console
-
-  $ locate jni.h
-  /usr/lib/jvm/java-8-openjdk-amd64/include/jni.h
-  /usr/lib/jvm/java-9-openjdk-amd64/include/jni.h
-  /usr/lib/jvm/java-10-openjdk-amd64/include/jni.h
-
-
-Then, set the JAVA_INCLUDE_PATH environment variable to the right
-path, and relaunch cmake. If you have several versions of JNI installed
-(as above), pick the one corresponding to the report of
-``javac -version``
+If you installed SimGrid to a non-standard directory (such as ``/opt/simgrid`` as advised earlier), you should tell python where
+to find the libraries as follows (notice the elements suffixed to the configured prefix).

 
 .. code-block:: console
 
 
 .. code-block:: console
 

-  $ export JAVA_INCLUDE_PATH=/usr/lib/jvm/java-8-openjdk-amd64/include/
-  $ cmake -Denable_java=ON .
-  $ make
-
-Note that the filename ```jni.h``` was removed from the path.
+  $ PYTHONPATH="/opt/simgrid/lib/python3/dist-packages" LD_LIBRARY_PATH="/opt/simgrid/lib" python your_script.py

 
 

-Linux Multi-Arch specific instructions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-On a multiarch x86_64 Linux, it should be possible to compile a 32-bit
-version of SimGrid with something like:
+You can add those variables to your bash profile to not specify it each time by adding these lines to your ``~/.profile``:

 
 .. code-block:: console
 
 
 .. code-block:: console
 

-  $ CFLAGS=-m32                                                      \
-    CXXFLAGS=-m32                                                    \
-    FFLAGS=-m32                                                      \
-    PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu/pkgconfig/             \
-    cmake .                                                          \
-      -DCMAKE_SYSTEM_PROCESSOR=i386                                  \
-      -DCMAKE_Fortran_COMPILER=/some/path/to/i686-linux-gnu-gfortran \
-      -DGFORTRAN_EXE=/some/path/to/i686-linux-gnu-gfortran           \
-      -DSMPI_C_FLAGS=-m32                                            \
-      -DSMPI_CXX_FLAGS=-m32                                          \
-      -DSMPI_Fortran_FLAGS=-m32
-
-If needed, implement ``i686-linux-gnu-gfortran`` as a script:
-
-.. code-block:: shell
-
-  #!/usr/bin/env sh
-  exec gfortran -m32 "$@"
+  export PYTHONPATH="$PYTHONPATH:/opt/simgrid/lib/python3/dist-packages"
+  export LD_LIBRARY_PATH="$PYTHONPATH:/opt/simgrid/lib"