+SimGrid (3.32.1) not released yet (target december 22)
+
+General:
+ - Remove the MSG API: its EOL was scheduled for 2020.
+ - Remove the Java bindings: they were limited to the MSG interface.
+ - On Windows, you now need to install WSL2 as the native builds are now disabled.
+ It was not really working anyway.
+ - Support for 32bits architecture is not tested anymore on our CI infrastructure.
+ It may break in the future, but we think that nobody's using SimGrid on 32 bits.
+ - Remove the surf module. It was replaced by the kernel/models module, and that
+ refactoring took almost 10 years to properly complete.
+
+S4U:
+ - Activity::set_remaining() is not public anymore. Use for example
+ Comm::set_payload_size() to change the size of the simulated data.
+ - New function: Engine::flatify_platform(), to get a fully detailed vision of the
+ configured platform.
+ - Full simDAG integration: Activity::start() actually starts only when all dependencies
+ are fullfiled. If it cannot be started right away, it will start as soon as it becomes
+ possible.
+
+Kernel:
+ - optimize an internal datastructure (use a set instead of a list for ongoing activities),
+ leading to a potentially big performance gain, in particular with many detached comms.
+
+MPI:
+ - New option smpi/barrier-collectives to add a barrier to some collectives
+ to detect dangerous code that /may/ work on some MPI implems.
+ - New function SMPI_app_instance_start() to easily start a MPI instance in your S4U simulation.
+
+Models:
+ - Write the section of the manual about models, at least.
+ - WiFi: the total capacity of a link depends on the amout of flows on that link.
+ - Use the nonlinear callback feature of LMM to reflect this.
+ - Calibration values can be changed to match different MCS configurations
+ - See the example teshsuite/models/wifi_usage_decay/wifi_usage_decay.cpp
+ - See also "A Flow-Level Wi-Fi Model for Large Scale Network Simulation"
+ https://hal.archives-ouvertes.fr/hal-03777726
+ - Merge parameters network/bandwidth-factor and smpi/bw-factor that serve the same purpose.
+ - Same for the latency
+ - Rewrite the corresponding documentation.
+ - Allow to disable the TCP windowing modeling by setting network/TCP-gamma to 0.
+ - Finally kill the 'compound' host model. You can change the CPU or network model
+ with the default host model, as it should.
+ - Rename option "surf/precision" to "precision/timing" for clarity.
+ - Rename option "maxmin/precision" to "precision/work-amount" for clarity.
+ - New function: Engine::flatify_platform() to debug your platform.
+
+sthread:
+ - Implement pthread_join in MC mode.
+ - Implement semaphore functions in sthread.
+ - Add an intricated way to verify the access to non-reentrant data structures
+ It requires code annotation, as shown in examples/sthread/stdobject/stdobject.cpp
+
+Model checking:
+ - Synchronize the MBI tests with upstream.
+ - Show the full actor bactraces when replaying a MC trace (with model-check/replay)
+ and the status of all actors on deadlocks in MC mode.
+
+XBT:
+ - simgrid::xbt::cmdline and simgrid::xbt::binary_name are gone.
+ Please use simgrid::s4u::Engine::get_cmdline() instead.
+
+Documentation:
+ - New section in the user guide on the provided performance models.
+ - New section presenting some technical good practices for (potential) contributors.
+ - Add a section on errors and exceptions to the API documentation.
+ - Move the s4u examples to a section on their own to ease navigation.
+
+Fixed bugs (FG#.. -> FramaGit bugs; FG!.. -> FG merge requests)
+ (FG: issues on Framagit; GH: issues on GitHub)
+ - FG#18: Java bindings should be redone or removed
+ - FG!118: Wi-Fi callback mechanism
+ - FG!119: SMPI: add option to inject a barrier before every collective call
+ - GH#383: Segfault when adding a disk after load_platform(xml)
+
----------------------------------------------------------------------------
-SimGrid (3.28.1) NOT RELEASED YET (v3.29 expected September 22. 2021, 19:21 UTC)
+SimGrid (3.32) October 3. 2022.
-New features:
- - Non-linear resource sharing: allows to dynamically change the resource
- capacity. Users can change this capacity by setting a callback which will
- be called when SimGrid is sharing the resource between the active
- activities. An activity can be a task running, a read/write IO operation or a
- communication flow.
- - Callback signature: double (double capacity, int n_activities): given the
- current resource's capacity and number of activities running on it,
- returns the new capacity.
- - Note that this callback is in the critical path of the system solve and
- should not take long to execute.
- - Examples:
- - Disk: examples/cpp/io-degradation
- - Link: examples/cpp/network-nonlinear
- - CPU: examples/cpp/exec-cpu-nonlinear
- - Dynamic factors for CPU and disk: similarly to dynamic network factors,
- allows the user to set a callback which can affect the progress of activities
- (multiplicative factor applied when updating the amount of work remaining).
- - Example: examples/cpp/exec-cpu-factors
+The Wiedervereinigung release. Germany was reunited 32 years ago.
+
+General:
+ - SimGrid now requires a compiler with C++17 support to compile the lib.
+ Our public headers still allow the user code to be compiled in C++14.
+ - Support graphviz v3 and ns-3 v3.36 (older versions are still supported).
+ - Tested with clang (v11, v13, v14 and v16), gcc (v7 to v13) and IntelCC v2022.2
+
+S4U:
+ - API evolutions:
+ - kill signal Comm::on_completion that was not working anyway.
+ - Expose signals Activity::on_suspend and Activity::on_resume
+ - New macro xbt_enforce(): similar to xbt_assert(), but throws an AssertionError
+ instead of calling abort().
+ - New: s4u::Exec::get_thread_count()
+ - Various cleanups around virtual machines:
+ - host_by_name() and friends now only return hosts. VMs are now excluded.
+ - It is now impossible to search a VM by name globally.
+ You can only search VM by name on a given PM, so either you know
+ the PM on which your VM runs and you can search by name, or you need
+ to manually iterate over all PMs to search this VM.
+ - The s4u::VirtualMachine constructor is now deprecated.
+ Please use s4u::Host::create_vm() instead.
+ - Rename s4u::VirtualMachine::on_creation() to on_vm_creation() to
+ avoid confusion with s4u:Host::on_creation() that is inherited.
+ Also s4u::VirtualMachine::on_destruction -> on_vm_destruction().
+ - Bug fixes:
+ - One-sided communications (Comm::sendto) can now be detached,
+ and should now be more resilient to network and host faults.
+
+Python:
+ - Added the following bindings / examples:
+ - Comm (now 100% covers the C++ interface):
+ - Comm.dst_data_size, Comm.mailbox, Comm.sender, Comm.start_time, Comm.finish_time
+ - Comm.state_str [examples: examples/python/comm-failure/, examples/python/comm-host2host/]
+ - Comm.remaining [examples: examples/python/comm-host2host/, examples/python/comm-suspend/]
+ - Comm.set_payload_size [example: examples/python/comm-host2host/]
+ - Comm.set_rate [example: examples/python/comm-throttling/]
+ - Comm.sendto, Comm.sendto_init, Comm.sendto_async [example: examples/python/comm-host2host/]
+ - Comm.start, Comm.suspend, Comm.resume [example: examples/python/comm-host2host/]
+ - Comm.test_any [example: examples/python/comm-testany/]
+ - Comm.wait_until [example: examples/python/comm-waituntil/]
+ - Engine:
+ - Engine.host_by_name [example: examples/python/comm-host2host/]
+ - Engine.mailbox_by_name_or_create [example: examples/python/comm-pingpong/]
+ - Engine.set_config
+ - Mailbox: Mailbox.ready [example: examples/python/comm-ready/]
+ - Ptask [example: examples/python/exec-ptask/]:
+ - this_actor.exec_init
+ - this_actor.parallel_execute
+ - Exec.suspend
+ - Exec.wait_for
+ - Added an AssertionError exception that may be thrown in case of error.
+ For instance, creating two hosts with the same name will now throw this exception
+ instead of killing the interpreter.
+
+SMPI:
+ - Implement MPI_File_get_type_extent(), MPI_File_s/get_atomicity() and
+ MPI_File_get_byte_offset()
+ - Intercept getpid() calls to return the simulated ones.
+ - Fix various bugs in MPI IO.
+
+Platform description & visualization:
+ - More robust sanity checks for platforms, to reject forbidden topologies with
+ a proper error message.
+ - New platform example: supernode.cpp and supernode.py.
+ The Python version generates a nice graphical representation of the platform.
+ - Bug fixes around fat-tree topologies.
+ - Allow to dump the platform topology as a CSV file representing the graph edges
+ with platform_graph_export_csv() (similar to the DOT export).
+ - Fix graphicator for "cluster" topologies (e.g. fat-tree, dragonfly).
+
+Models:
+ - Fix a bug when using ptasks with multicores (FG!111).
+
+Model-Checker:
+ - First bits of sthread, that intercepts pthread operations at runtime.
+ The intend is to use it together with simgrid-mc, but it is TBD.
+ - Sync MBI generators with upstream changes.
+ - Various cosmetics, small bug fixes and inner refactorings
+
+Fixed bugs (FG#.. -> FramaGit bugs; FG!.. -> FG merge requests)
+ (FG: issues on Framagit; GH: issues on GitHub)
+ - FG#105: "Variable penalty should not be negative!" with in-flight messages and bandwidth profiles
+ - FG#109: Application time reported by --cfg=smpi/display-timing:yes is wrong
+ - FG#110: Wait_any does not trigger new model solve when host events occur
+ - FG#111: Wrong execution time in rare cases when using multicore
+ - FG!98: Re-enable the tests for legacy stochastic profiles
+ - FG!109: Trigger new engine solve upon host events such as host on/off
+ - FG!116: SMPI/replay: Fix issue with recv of size =0
+
+----------------------------------------------------------------------------
+
+SimGrid (3.31) March 22. 2022.
+
+The ненасильство release. We stand against war.
+
+Against the agression by a sick system that forces peoples to take arms against each other.
+
+MC:
+ - Rework the internals, for simpler and modern code. This shall unlock many future improvements.
+ - You can now define plugins onto the DFS explorer (previously called SafetyChecker), using the
+ declared signals. See CommunicationDeterminism for an example.
+ - Support mutex, semaphore and barrier in DPOR reduction
+ - Seems to work on Arm64 architectures too.
+ - Display a nice error message when ptrace is not usable.
+ - New test suite, imported from the MPI Bugs Initiative (MBI). Not all MBI generators are integrated yet.
+ - Remove the ISP test suite: it's not free software, and it's superseeded by MBI.
+
+SMPI:
+ - fix for FG#100 by ensuring small asynchronous messages never overtake larger
+ ones, conforming to the standard.
+ - replay: fix waitall behaviour to avoid forgetting requests and leaking
+ their handles.
+ - tracing: ensure that we dump the TI traces continuously during execution and
+ not just at the end, reducing memory cost and performance hit.
+ - Update OpenMPI collectives selection logic to match current one (4.1.2)
+ - Add a coherence check for collective operation order and root/MPI_Op
+ coherence. Potentially costly so not activated unless smpi:pendantic is set
+ or -analyze is given.
+
+S4U:
+ - New signal: Engine::on_simulation_start_cb()
+ - Introduce a new execution mode with this_actor::thread_execute(). This simulate
+ the execution of a certain amount of flops by multiple threads ran by a host. Each
+ thread executes the same number of flops, given as argument. An example of this new
+ function can be found in examples/cpp/exec-threads.
+ - Reimplementation of barriers natively.
+ Previously, they were implemented on top of s4u::Mutex and s4u::ConditionVariable.
+ The new version should be faster (and can be used in the model-checker).
+ - Actor::get_restart_count(): Returns the number of reboots that this actor did.
+
+MSG:
+ - MSG_barrier_destroy now expects a non-const msg_barrier parameter.
+
+New plugin: the Chaos Monkey (killing actors at any time)
+ - Along with the new simgrid-monkey script, it tests whether your simulation
+ resists resource failures at any possible timestamp in your simulation.
+ - It is mostly intended to test the simgrid core in extreme conditions,
+ but some users may find it interesting too.
+
+Models:
+ - New solver for parallel task: BMF.
+ - More realistic sharing of heterogeneous resources compared to the fair
+ bottleneck solver used by ptask_L07.
+ - Implement the BMF (Bottleneck max fairness) fairness.
+ - Improved resource sharing for parallel tasks with sub-flows (parallel
+ communications between same source and destination inside the ptask).
+ - Parameters:
+ - "--cfg=host/model:ptask_L07 --cfg=host/solver:bmf": enable the ptask
+ model with BMF solver.
+ - "--cfg=bmf/max-iterations: <N>": maximum number of iterations performed
+ by BMF solver (default: 1000).
+ - "--cfg=bmf/precision: <N>": numerical precision used when computing
+ resource sharing (default: 1e-12).
+ - This model requires Eigen3 library. Make sure Eigen3 is installed to use BMF.
+
+General:
+ - Modifications of the Profile mechanism, with some impact on users
+ - Addition of a new (S4U) method to init profiles from generic functions to improve versatility
+ - Fix initial behaviour of state_profiles
+ - Modify periodicity to behave like a period, and not like a loop delay
+
+XBT:
+ - Drop xbt_dynar_shrink().
+
+Python:
+ - Made the following bindings static (previously member functions):
+ - Actor: Actor.kill_all(), Actor.by_pid()
+ - Host: Host.by_name(), Host.current(), Host.on_creation_cb()
+ - Mailbox: Mailbox.by_name()
+ - Added the following bindings:
+ - this_actor.warning()
+ - Mailbox.put_init() [example: examples/python/comm-waitallfor/]
+ - Comm.detach() [example: examples/python/comm-waitallfor/]
+ - Comm.wait_for() [example: examples/python/comm-waitfor/]
+ - Comm.wait_any_for()
+ - Comm.wait_all_for() [example: examples/python/comm-waitallfor/]
+ - Mutex [example: examples/python/synchro-mutex/]
+ - Barrier [example: examples/python/synchro-barrier/]
+ - Semaphore [example: examples/python/synchro-semaphore/]
+
+Build System:
+ - Remove target "make uninstall" which was incomplete and no longer maintained.
+
+Fixed bugs (FG#.. -> FramaGit bugs; FG!.. -> FG merge requests)
+ (FG: issues on Framagit; GH: issues on GitHub)
+ - FG#57: Mc SimGrid should test whether ptrace is usable
+ - FG#87: Smpi scripts fail with spaces in paths
+ - FG#100: [SMPI] Order of the message matching is not guaranteed
+ - FG#101: LGPL 2.1 is deprecated license
+ - FG#104: "make uninstall" not up-to-date
+ - GH#151: Missing mutexes for DPOR.
+
+----------------------------------------------------------------------------
+
+SimGrid (3.30) January 30. 2022.
+
+The Sunday Bloody Sunday release.
+
+Main user-visible changes:
+ - The SimDag API for the simulation of the scheduling of Directed Acyclic
+ Graphs has been dropped. It was marked as deprecated for a couple of years.
+ We finally complete the implementation of what has been called SimDag++
+ internally, i.e., porting the different features of SimDag on top of S4U.
+ The new way to simulate the execution of dependent activities directly by
+ maestro (without any other actor) is details in the examples/cpp/dag-* series
+ of examples.
+ - The removal of SimDag led us to also remove the export to Jedule files that
+ was tightly coupled to SimDag. The instrumentation of DAG simulation is still
+ possible through the regular instrumentation API based on the Paje format.
+ - We also dropped the old and clumsy Lua bindings to create platforms in a
+ programmatic way. It can be done in C++ in a much cleaner way now, which
+ motivates this suppression.
+
+S4U:
+ - Introduce on_X_cb() functions for all signals, to attach a new
+ callback to the signal X. The signal variables are now hidden and
+ only these functions should be used.
+ Rationale: this enables the usual deprecation scheme where functions
+ remain for 4 releases if we need to modify the signals, while the
+ current code with the signal variables directly visible prevents any
+ smooth transition.
+ - New function: Engine::run_until(date), to split the simulation.
+ - New signal: Activity::on_veto, to detect when an activity fails to start.
+ - Signal change: Comm::on_start(Comm&, bool) has been replaced by
+ Comm::on_send and Comm::recv. These two signals respectively correspond to
+ when the sending or receiving side of a Comm is ready. They are raised at
+ the same locations as the former Comm::on_start signal.
+ - New function: Engine::track_vetoed_activities() to interrupt run()
+ when an activity fails to start, and to keep track of such activities.
+ Please see the corresponding example for more info.
+ - New functions: s4u::Comm::{sendto_init, set_source, set_destination} to enable
+ the use of vetoers with direct host-to-host communications. Both source and
+ destination have to set for a comm to start. Each call to these setters check
+ if all vetoes are satisfied. When it is the case, the comm starts. A use case of
+ these functions is given in examples/cpp/dag-scheduling.
+ - New functions: {Exec, Io}::update_priority allow you to modify the priority of
+ these kinds of activities during their execution. Behavior is detailed in
+ examples/cpp/io-priority/.
+
+SMPI:
+ - Dynamic costs for MPI operations: New API to allow users to dynamically
+ change injected costs for MPI_Recv, MPI_Send and MPI_Isend operations.
+ Alternative for smpi/or, smpi/os and smpi/ois configuration options.
+ - Fix some issues with the replay mechanism.
+
+XBT:
+ - Function xbt::Extendable::get_data() is now templated with the type of the
+ pointee. Untyped function is deprecated. Use get_data<void>() if you still
+ want to retrieve void*.
+
+Documentation:
+ - New section: "SimGrid MPI calibration of a Grid5000 cluster"
+ presenting how to properly calibrate MPI communications in SimGrid.
+ - Complete and reword the platform section, which is now completed.
+
+Python:
+ - Thread contexts are used by default with Python bindings. Other kinds of
+ contexts revealed unstable, specially starting with pybind11 v2.8.0.
+
+Fixed bugs (FG#.. -> FramaGit bugs; FG!.. -> FG merge requests)
+ (FG: issues on Framagit; GH: issues on GitHub)
+ - FG#95: Wrong computation time for multicore execution after pstate change
+ - FG#97: Wrong computation time for ptask+multicore+pstates
+ - FG#98: SMPI offline simulation is inconsistent with the online simulation
+ (deadlocks / message truncation)
+ - FG#99: Weird segfault when not sealing an host
+
+----------------------------------------------------------------------------
+
+SimGrid (3.29) October 7. 2021
+
+The "Ask a stupid question" release.
+
+We wish that every user ask one question about SimGrid to celebrate.
+On Mattermost, Stack Overflow or using the issues tracker.
+
+New modeling features:
+ - Non-linear resource sharing, modeling resources whose performance heavily degrades with contention:
+ - The total capacity may be updated dynamically through a callback
+ and depends mainly on the number of concurrent flows.
+ - Examples (both cpp and python): io-degradation, network-nonlinear, exec-cpu-nonlinear
+
+ - Dynamic factors: model variability in the speed of activities
+ - Each action can now have a factor that affects its progression.
+ This multiplicative factor is applied when updating the amount of work
+ remaining, thereby an activity with factor=0.5 only uses half of the
+ instantaneous power/bandwidth it is allocated and will appear twice
+ slower than what it actually consumes.
+ - This can be used to model a overhead (e.g., there is a 20 bytes
+ header in a 480 bytes TCP packet so the factor 0.9583) but the novelty
+ is this factor can now easily be adjusted depending on activity's and
+ resources characteristics.
+ - This existed for network (e.g., the effective bandwidth depends
+ on the message in SMPI piecewise-linear network model) but it is now
+ more general (the factor may depend on the source and destination and
+ thus account to different behaviors for intra-node communications and
+ extra-node communications) and is available for CPUs (e.g., if you
+ want to model an affinity as in the "Unrelated Machines" problem in
+ scheduling) and disks (e.g., if you want to model a stochastic
+ capacity) too.
+ - For that, resources can be provided with a callback that computes
+ the activity factor when creating the action.
+ - Example: examples/cpp/exec-cpu-factors
+ - The same mechanism is also available for the latency, which
+ allows to easily introduce complex variability patterns.
Python:
- Added support to programmatic platform creation in Python.
- - Several new methods were added to Python interface. For more details, see
- the corresponding documentation.
- - New python examples:
- - Clusters: examples/python/clusters-multicpu
- - Disk: examples/python/io-degradation
- - CPU: examples/python/exec-cpu-nonlienar
- - Link: examples/python/network-nonlinear
+ Example: examples/python/clusters-multicpu
S4U:
- - New: s4u::Disk::set_sharing_policy() and s4u::Host::set_sharing_policy().
- Allows the configuration of non-linear resource sharing for hosts and
- disks.
+ - Disk and Host now have a set_sharing_policy() too, for non-linear sharing.
+ This can only be set through the API, not through XML files.
SMPI:
- TI Tracing/Replay:
- - Multiple fixes to ensure reproducibility of tracing
- - scan/excan can now be replayed
- - wait action now uses ranks and not pid, as the other ones.
- - smpi/init and smpi/finalization-barrier are now valid for replays.
+ - Multiple fixes to ensure reproducibility of tracing
+ - scan/excan can now be replayed
+ - wait action now uses ranks and not pid, as the other ones.
+ - smpi/init and smpi/finalization-barrier are now valid for replays.
+ - exit() is now intercepted by SMPI to avoid premature shutdown of
+ simulation. First non 0 return codes is returned as simulation return
+ code.
Documentation:
* New section "Release Notes" documenting recent and current developments.
- * New section "Modeling I/O: the realistic way" presenting how to properly
- model disks in SimGrid.
+ * New section "Modeling I/O: the realistic way" presenting how to properly model disks in SimGrid.
* Improvements in API Reference for C++ and Python interfaces.
ns-3 model:
- Make wifi creation compatible with ns-3 version 3.34 too.
Fixed bugs (FG#.. -> FramaGit bugs; FG!.. -> FG merge requests)
- (FG: issues on Framagit; GF: issues on GForge; GH: issues on GitHub)
+ (FG: issues on Framagit; GH: issues on GitHub)
+ - FG#77: Search feature of doc is broken (update sphinx theme version)
- FG#78: Multiple fixes for SMPI replay:
- TI tracing of allotallv/w was outputting wrong values
- MPI_LOGICAL in fortran is actually 32 bits wide, and not 8.
- - FG#77: Search feature of doc is broken (update sphinx theme version)
+
----------------------------------------------------------------------------
SimGrid (3.28) July 14. 2021
- Legacy functions deprecated in this release: SIMIX_get_clock(), SIMIX_run().
Fixed bugs (FG#.. -> FramaGit bugs; FG!.. -> FG merge requests)
- (FG: issues on Framagit; GF: issues on GForge; GH: issues on GitHub)
+ (FG: issues on Framagit; GH: issues on GitHub)
- FG#47: Complete and fix tests from teshuite/s4u/activity-lifecycle
- FG#64: Configuring smpi/IB-penalty-factors
- FG#67: Running computation concurrently with MPI_Iallreduce
available as sg_actor_start_() and sg_actor_create_().
Fixed bugs (FG#.. -> FramaGit bugs; FG!.. -> FG merge requests)
- (FG: issues on Framagit; GF: issues on GForge; GH: issues on GitHub)
+ (FG: issues on Framagit; GH: issues on GitHub)
- FG#37: Parallel tasks are limited to 1 core per host
- FG#62: Running "smpirun -replay" on large networks
- FG!46: Fix a few potential memory leaks in SMPI colls
