Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Document recent changes
[simgrid.git] / ChangeLog
1 SimGrid (3.32.1) not released yet (target december 22)
2
3 General:
4  - Remove the MSG API: its EOL was scheduled for 2020.
5  - Remove the Java bindings: they were limited to the MSG interface.
6  - On Windows, you now need to install WSL2 as the native builds are now disabled.
7    It was not really working anyway.
8
9 S4U:
10  - Activity::set_remaining() is not public anymore. Use for example
11    Comm::set_payload_size() to change the size of the simulated data.
12
13 Kernel:
14  - optimize an internal datastructure, leading to a potentially big
15    performance gain (in particular with many detached comms)
16
17 MPI:
18  - New option smpi/barrier-collectives to add a barrier to some collectives
19    to detect dangerous code that /may/ work on some MPI implems.
20
21 Models:
22  - Write the section of the manual about models, at least.
23  - WiFi: the total capacity of a link depends on the amout of flows on that link.
24    - Use the nonlinear callback feature of LMM to reflect this.
25    - Calibration values can be changed to match different MCS configurations
26    - See the example teshsuite/models/wifi_usage_decay/wifi_usage_decay.cpp
27    - See also "A Flow-Level Wi-Fi Model for Large Scale Network Simulation"
28      https://hal.archives-ouvertes.fr/hal-03777726
29  - Merge parameters network/bandwidth-factor and smpi/bw-factor that serve the same purpose.
30    - Same for the latency
31    - Rewrite the corresponding documentation.
32  - Allow to disable the TCP windowing modeling by setting network/TCP-gamma to 0.
33
34 sthread:
35  - Implement pthread_join in MC mode.
36
37 Documentation:
38  - New section in the user guide on the provided performance models.
39  - New section presenting some technical good practices for (potential) contributors.
40  - Add a section on errors and exceptions to the API documentation.
41  - Move the s4u examples to a section on their own to ease navigation.
42
43 Fixed bugs (FG#.. -> FramaGit bugs; FG!.. -> FG merge requests)
44  (FG: issues on Framagit; GH: issues on GitHub)
45  - FG#18: Java bindings should be redone or removed
46  - FG!118: Wi-Fi callback mechanism
47  - FG!119: SMPI: add option to inject a barrier before every collective call, to allow...
48
49 ----------------------------------------------------------------------------
50
51 SimGrid (3.32) October 3. 2022.
52
53 The Wiedervereinigung release. Germany was reunited 32 years ago.
54
55 General:
56  - SimGrid now requires a compiler with C++17 support to compile the lib.
57    Our public headers still allow the user code to be compiled in C++14.
58  - Support graphviz v3 and ns-3 v3.36 (older versions are still supported).
59  - Tested with clang (v11, v13, v14 and v16), gcc (v7 to v13) and IntelCC v2022.2
60
61 S4U:
62  - API evolutions:
63    - kill signal Comm::on_completion that was not working anyway.
64    - Expose signals Activity::on_suspend and Activity::on_resume
65    - New macro xbt_enforce(): similar to xbt_assert(), but throws an AssertionError
66      instead of calling abort().
67    - New: s4u::Exec::get_thread_count()
68  - Various cleanups around virtual machines:
69    - host_by_name() and friends now only return hosts. VMs are now excluded.
70    - It is now impossible to search a VM by name globally.
71      You can only search VM by name on a given PM, so either you know
72      the PM on which your VM runs and you can search by name, or you need
73      to manually iterate over all PMs to search this VM.
74    - The s4u::VirtualMachine constructor is now deprecated.
75      Please use s4u::Host::create_vm() instead.
76    - Rename s4u::VirtualMachine::on_creation() to on_vm_creation() to
77      avoid confusion with s4u:Host::on_creation() that is inherited.
78      Also s4u::VirtualMachine::on_destruction -> on_vm_destruction().
79  - Bug fixes:
80    - One-sided communications (Comm::sendto) can now be detached,
81      and should now be more resilient to network and host faults.
82
83 Python:
84  - Added the following bindings / examples:
85    - Comm (now 100% covers the C++ interface):
86      - Comm.dst_data_size, Comm.mailbox, Comm.sender, Comm.start_time, Comm.finish_time
87      - Comm.state_str [examples: examples/python/comm-failure/, examples/python/comm-host2host/]
88      - Comm.remaining [examples: examples/python/comm-host2host/, examples/python/comm-suspend/]
89      - Comm.set_payload_size [example: examples/python/comm-host2host/]
90      - Comm.set_rate [example: examples/python/comm-throttling/]
91      - Comm.sendto, Comm.sendto_init, Comm.sendto_async [example: examples/python/comm-host2host/]
92      - Comm.start, Comm.suspend, Comm.resume [example: examples/python/comm-host2host/]
93      - Comm.test_any [example: examples/python/comm-testany/]
94      - Comm.wait_until [example: examples/python/comm-waituntil/]
95    - Engine:
96      - Engine.host_by_name [example: examples/python/comm-host2host/]
97      - Engine.mailbox_by_name_or_create [example: examples/python/comm-pingpong/]
98      - Engine.set_config
99    - Mailbox: Mailbox.ready [example: examples/python/comm-ready/]
100    - Ptask [example: examples/python/exec-ptask/]:
101      - this_actor.exec_init
102      - this_actor.parallel_execute
103      - Exec.suspend
104      - Exec.wait_for
105  - Added an AssertionError exception that may be thrown in case of error.
106    For instance, creating two hosts with the same name will now throw this exception
107    instead of killing the interpreter.
108
109 SMPI:
110  - Implement MPI_File_get_type_extent(), MPI_File_s/get_atomicity() and
111    MPI_File_get_byte_offset()
112  - Intercept getpid() calls to return the simulated ones.
113  - Fix various bugs in MPI IO.
114
115 Platform description & visualization:
116  - More robust sanity checks for platforms, to reject forbidden topologies with
117    a proper error message.
118  - New platform example: supernode.cpp and supernode.py.
119    The Python version generates a nice graphical representation of the platform.
120  - Bug fixes around fat-tree topologies.
121  - Allow to dump the platform topology as a CSV file representing the graph edges
122    with platform_graph_export_csv() (similar to the DOT export).
123  - Fix graphicator for "cluster" topologies (e.g. fat-tree, dragonfly).
124
125 Models:
126  - Fix a bug when using ptasks with multicores (FG!111).
127
128 Model-Checker:
129  - First bits of sthread, that intercepts pthread operations at runtime.
130    The intend is to use it together with simgrid-mc, but it is TBD.
131  - Sync MBI generators with upstream changes.
132  - Various cosmetics, small bug fixes and inner refactorings
133
134 Fixed bugs (FG#.. -> FramaGit bugs; FG!.. -> FG merge requests)
135  (FG: issues on Framagit; GH: issues on GitHub)
136  - FG#105: "Variable penalty should not be negative!" with in-flight messages and bandwidth profiles
137  - FG#109: Application time reported by --cfg=smpi/display-timing:yes is wrong
138  - FG#110: Wait_any does not trigger new model solve when host events occur
139  - FG#111: Wrong execution time in rare cases when using multicore
140  - FG!98: Re-enable the tests for legacy stochastic profiles
141  - FG!109: Trigger new engine solve upon host events such as host on/off
142  - FG!116: SMPI/replay: Fix issue with recv of size =0
143
144 ----------------------------------------------------------------------------
145
146 SimGrid (3.31) March 22. 2022.
147
148 The ненасильство release. We stand against war.
149
150 Against the agression by a sick system that forces peoples to take arms against each other.
151
152 MC:
153  - Rework the internals, for simpler and modern code. This shall unlock many future improvements.
154  - You can now define plugins onto the DFS explorer (previously called SafetyChecker), using the
155    declared signals. See CommunicationDeterminism for an example.
156  - Support mutex, semaphore and barrier in DPOR reduction
157  - Seems to work on Arm64 architectures too.
158  - Display a nice error message when ptrace is not usable.
159  - New test suite, imported from the MPI Bugs Initiative (MBI). Not all MBI generators are integrated yet.
160  - Remove the ISP test suite: it's not free software, and it's superseeded by MBI.
161
162 SMPI:
163  - fix for FG#100 by ensuring small asynchronous messages never overtake larger
164    ones, conforming to the standard.
165  - replay: fix waitall behaviour to avoid forgetting requests and leaking
166    their handles.
167  - tracing: ensure that we dump the TI traces continuously during execution and
168    not just at the end, reducing memory cost and performance hit.
169  - Update OpenMPI collectives selection logic to match current one (4.1.2)
170  - Add a coherence check for collective operation order and root/MPI_Op
171    coherence. Potentially costly so not activated unless smpi:pendantic is set
172    or -analyze is given.
173
174 S4U:
175  - New signal: Engine::on_simulation_start_cb()
176  - Introduce a new execution mode with this_actor::thread_execute(). This simulate
177    the execution of a certain amount of flops by multiple threads ran by a host. Each
178    thread executes the same number of flops, given as argument. An example of this new
179    function can be found in examples/cpp/exec-threads.
180  - Reimplementation of barriers natively.
181    Previously, they were implemented on top of s4u::Mutex and s4u::ConditionVariable.
182    The new version should be faster (and can be used in the model-checker).
183  - Actor::get_restart_count(): Returns the number of reboots that this actor did.
184
185 MSG:
186  - MSG_barrier_destroy now expects a non-const msg_barrier parameter.
187
188 New plugin: the Chaos Monkey (killing actors at any time)
189  - Along with the new simgrid-monkey script, it tests whether your simulation
190    resists resource failures at any possible timestamp in your simulation.
191  - It is mostly intended to test the simgrid core in extreme conditions,
192    but some users may find it interesting too.
193
194 Models:
195  - New solver for parallel task: BMF.
196    - More realistic sharing of heterogeneous resources compared to the fair
197    bottleneck solver used by ptask_L07.
198    - Implement the BMF (Bottleneck max fairness) fairness.
199    - Improved resource sharing for parallel tasks with sub-flows (parallel
200      communications between same source and destination inside the ptask).
201    - Parameters:
202      - "--cfg=host/model:ptask_L07 --cfg=host/solver:bmf": enable the ptask
203          model with BMF solver.
204      - "--cfg=bmf/max-iterations: <N>": maximum number of iterations performed
205         by BMF solver (default: 1000).
206      - "--cfg=bmf/precision: <N>": numerical precision used when computing
207          resource sharing (default: 1e-12).
208    - This model requires Eigen3 library. Make sure Eigen3 is installed to use BMF.
209
210 General:
211   - Modifications of the Profile mechanism, with some impact on users
212     - Addition of a new (S4U) method to init profiles from generic functions to improve versatility
213     - Fix initial behaviour of state_profiles
214     - Modify periodicity to behave like a period, and not like a loop delay
215
216 XBT:
217  - Drop xbt_dynar_shrink().
218
219 Python:
220  - Made the following bindings static (previously member functions):
221    - Actor: Actor.kill_all(), Actor.by_pid()
222    - Host: Host.by_name(), Host.current(), Host.on_creation_cb()
223    - Mailbox: Mailbox.by_name()
224  - Added the following bindings:
225      - this_actor.warning()
226      - Mailbox.put_init() [example: examples/python/comm-waitallfor/]
227      - Comm.detach() [example: examples/python/comm-waitallfor/]
228      - Comm.wait_for() [example: examples/python/comm-waitfor/]
229      - Comm.wait_any_for()
230      - Comm.wait_all_for() [example: examples/python/comm-waitallfor/]
231      - Mutex [example: examples/python/synchro-mutex/]
232      - Barrier [example: examples/python/synchro-barrier/]
233      - Semaphore [example: examples/python/synchro-semaphore/]
234
235 Build System:
236  - Remove target "make uninstall" which was incomplete and no longer maintained.
237
238 Fixed bugs (FG#.. -> FramaGit bugs; FG!.. -> FG merge requests)
239  (FG: issues on Framagit; GH: issues on GitHub)
240  - FG#57: Mc SimGrid should test whether ptrace is usable
241  - FG#87: Smpi scripts fail with spaces in paths
242  - FG#100: [SMPI] Order of the message matching is not guaranteed
243  - FG#101: LGPL 2.1 is deprecated license
244  - FG#104: "make uninstall" not up-to-date
245  - GH#151: Missing mutexes for DPOR.
246
247 ----------------------------------------------------------------------------
248
249 SimGrid (3.30) January 30. 2022.
250
251 The Sunday Bloody Sunday release.
252
253 Main user-visible changes:
254  - The SimDag API for the simulation of the scheduling of Directed Acyclic
255    Graphs has been dropped. It was marked as deprecated for a couple of years.
256    We finally complete the implementation of what has been called SimDag++
257    internally, i.e., porting the different features of SimDag on top of S4U.
258    The new way to simulate the execution of dependent activities directly by
259    maestro (without any other actor) is details in the examples/cpp/dag-* series
260    of examples.
261  - The removal of SimDag led us to also remove the export to Jedule files that
262    was tightly coupled to SimDag. The instrumentation of DAG simulation is still
263    possible through the regular instrumentation API based on the Paje format.
264  - We also dropped the old and clumsy Lua bindings to create platforms in a
265    programmatic way. It can be done in C++ in a much cleaner way now, which
266    motivates this suppression.
267
268 S4U:
269  - Introduce on_X_cb() functions for all signals, to attach a new
270    callback to the signal X. The signal variables are now hidden and
271    only these functions should be used.
272    Rationale: this enables the usual deprecation scheme where functions
273    remain for 4 releases if we need to modify the signals, while the
274    current code with the signal variables directly visible prevents any
275    smooth transition.
276  - New function: Engine::run_until(date), to split the simulation.
277  - New signal: Activity::on_veto, to detect when an activity fails to start.
278  - Signal change: Comm::on_start(Comm&, bool) has been replaced by
279    Comm::on_send and Comm::recv. These two signals respectively correspond to
280    when the sending or receiving side of a Comm is ready. They are raised at
281    the same locations as the former Comm::on_start signal.
282  - New function: Engine::track_vetoed_activities() to interrupt run()
283    when an activity fails to start, and to keep track of such activities.
284    Please see the corresponding example for more info.
285  - New functions: s4u::Comm::{sendto_init, set_source, set_destination} to enable
286    the use of vetoers with direct host-to-host communications. Both source and
287    destination have to set for a comm to start. Each call to these setters check
288    if all vetoes are satisfied. When it is the case, the comm starts. A use case of
289    these functions is given in examples/cpp/dag-scheduling.
290  - New functions: {Exec, Io}::update_priority allow you to modify the priority of
291    these kinds of activities during their execution. Behavior is detailed in
292    examples/cpp/io-priority/.
293
294 SMPI:
295  - Dynamic costs for MPI operations: New API to allow users to dynamically
296    change injected costs for MPI_Recv, MPI_Send and MPI_Isend operations.
297    Alternative for smpi/or, smpi/os and smpi/ois configuration options.
298  - Fix some issues with the replay mechanism.
299
300 XBT:
301  - Function xbt::Extendable::get_data() is now templated with the type of the
302    pointee. Untyped function is deprecated. Use get_data<void>() if you still
303    want to retrieve void*.
304
305 Documentation:
306  - New section: "SimGrid MPI calibration of a Grid5000 cluster"
307    presenting how to properly calibrate MPI communications in SimGrid.
308  - Complete and reword the platform section, which is now completed.
309
310 Python:
311  - Thread contexts are used by default with Python bindings.  Other kinds of
312    contexts revealed unstable, specially starting with pybind11 v2.8.0.
313
314 Fixed bugs (FG#.. -> FramaGit bugs; FG!.. -> FG merge requests)
315  (FG: issues on Framagit; GH: issues on GitHub)
316  - FG#95: Wrong computation time for multicore execution after pstate change
317  - FG#97: Wrong computation time for ptask+multicore+pstates
318  - FG#98: SMPI offline simulation is inconsistent with the online simulation
319           (deadlocks / message truncation)
320  - FG#99: Weird segfault when not sealing an host
321
322 ----------------------------------------------------------------------------
323
324 SimGrid (3.29) October 7. 2021
325
326 The "Ask a stupid question" release.
327
328 We wish that every user ask one question about SimGrid to celebrate.
329 On Mattermost, Stack Overflow or using the issues tracker.
330
331 New modeling features:
332  - Non-linear resource sharing, modeling resources whose performance heavily degrades with contention:
333    - The total capacity may be updated dynamically through a callback
334      and depends mainly on the number of concurrent flows.
335    - Examples (both cpp and python): io-degradation, network-nonlinear, exec-cpu-nonlinear
336
337  - Dynamic factors: model variability in the speed of activities
338     - Each action can now have a factor that affects its progression.
339       This multiplicative factor is applied when updating the amount of work
340       remaining, thereby an activity with factor=0.5 only uses half of the
341       instantaneous power/bandwidth it is allocated and will appear twice
342       slower than what it actually consumes.
343     - This can be used to model a overhead (e.g., there is a 20 bytes
344       header in a 480 bytes TCP packet so the factor 0.9583) but the novelty
345       is this factor can now easily be adjusted depending on activity's and
346       resources characteristics.
347     - This existed for network (e.g., the effective bandwidth depends
348       on the message in SMPI piecewise-linear network model) but it is now
349       more general (the factor may depend on the source and destination and
350       thus account to different behaviors for intra-node communications and
351       extra-node communications) and is available for CPUs (e.g., if you
352       want to model an affinity as in the "Unrelated Machines" problem in
353       scheduling) and disks (e.g., if you want to model a stochastic
354       capacity) too.
355     - For that, resources can be provided with a callback that computes
356       the activity factor when creating the action.
357     - Example: examples/cpp/exec-cpu-factors
358     - The same mechanism is also available for the latency, which
359       allows to easily introduce complex variability patterns.
360
361 Python:
362  - Added support to programmatic platform creation in Python.
363    Example: examples/python/clusters-multicpu
364
365 S4U:
366  - Disk and Host now have a set_sharing_policy() too, for non-linear sharing.
367    This can only be set through the API, not through XML files.
368
369 SMPI:
370  - TI Tracing/Replay:
371    - Multiple fixes to ensure reproducibility of tracing
372    - scan/excan can now be replayed
373    - wait action now uses ranks and not pid, as the other ones.
374    - smpi/init and smpi/finalization-barrier are now valid for replays.
375  - exit() is now intercepted by SMPI to avoid premature shutdown of
376    simulation. First non 0 return codes is returned as simulation return
377    code.
378
379 Documentation:
380   * New section "Release Notes" documenting recent and current developments.
381   * New section "Modeling I/O: the realistic way" presenting how to properly model disks in SimGrid.
382   * Improvements in API Reference for C++ and Python interfaces.
383
384 ns-3 model:
385  - Make wifi creation compatible with ns-3 version 3.34 too.
386
387 Fixed bugs (FG#.. -> FramaGit bugs; FG!.. -> FG merge requests)
388  (FG: issues on Framagit; GH: issues on GitHub)
389  - FG#77: Search feature of doc is broken (update sphinx theme version)
390  - FG#78: Multiple fixes for SMPI replay:
391     - TI tracing of allotallv/w was outputting wrong values
392     - MPI_LOGICAL in fortran is actually 32 bits wide, and not 8.
393
394 ----------------------------------------------------------------------------
395
396 SimGrid (3.28) July 14. 2021
397
398 The Victoriadagarna Release.
399
400 New features:
401  - C++ platform interface: Users can now describe their platform directly in C++.
402    This provides greatly flexibility and performance improvement for complex
403    platforms. Main features:
404      - Fat-Tree/DragonFly/Torus composing: allows you to create clusters of
405        "zones", instead of single hosts. This feature enables the description
406        of clusters with complex hosts, composed of several CPUs, GPUs, etc.
407      - StarZone: new zone with a Star-like topology. The routes are defined
408        as a set of links used to communicate from node to everybody (node<->ALL).
409      - Split-Duplex links: auxiliary method to create split-duplex links in
410        the platform, easing its utilisation. It automatically creates both UP
411        and DOWN links (similarly as done in XML).
412      - Please refer to the documentation and the examples included:
413        e.g. examples/cpp/clusters-multicpu/ and examples/platforms/*.cpp.
414  - New plugin: Producer-Consumer with monitor. Just requires to include the
415    include/simgrid/plugins/ProducerConsumer.hpp header to be used. See the
416    associated example (examples/cpp/plugin-prodcons).
417
418 S4U:
419  - New: s4u::Comm::wait_all_for() (like s4u::Comm::wait_all, but with a timeout),
420         s4u::Io::wait_any(), s4u::Io::wait_any_for().
421  - Methods test_all/test_any/wait_all/wait_any in s4u now take their vector
422    parameter by reference, instead of a pointer.
423  - Fixed a bug where Activity::wait_for() killed the activity on timeout.
424    Explicitly cancel the activity to get back to previous behavior.
425  - New: Link::set_concurrency_limit() to limit the amount of concurrent flows.
426
427 SMPI:
428  - The default SMPI compiler flags are no more taken from the environment.
429    They can be explicitly set through cmake parameters SMPI_C_FLAGS,
430    SMPI_CXX_FLAGS, or SMPI_Fortran_FLAGS.
431  - New options:
432     --cfg=smpi/finalization-barrier: which can be used to add
433       a barrier inside MPI_Finalize. This can help for some codes which cleanup
434       data attached to a process, but still used in other SMPI processes.
435     --cfg=smpi/errors-are-fatal: True by default, behaves like if MPI_ERRORS_RETURN
436       is active when set to false, to keep going after a small error
437     --cfg=smpi/pedantic: True by default. Do not report some harmless MPI errors
438       which may or may not be problematic in the end.
439  - Sampling:
440     - fix behaviour, as maximum iteration count could be ignored
441     - add SMPI_SAMPLE_LOCAL_TAG and SMPI_SAMPLE_GLOBAL_TAG macros, to allow user to
442       use sampling when the same kernel is called with a different set of parameters
443       which have an impact on the timing.
444  - realloc is now intercepted, to be coherent, as malloc/calloc/free were already.
445    It should now work with smpi/auto-shared-malloc-thresh.
446  - Improve error handling and reporting in multiple places
447  - Improve correctness checks on the MPI code.(MPI_Op and MPI_Datatype
448    validity checks, truncated messages are now an error, return errors
449    when explicitely deleted handles are reused, ...)
450  - RMA: multiple fixes and stability improvements.
451  - analysis (-analyze flag in smpirun):
452     - SMPI can now report buffer leaks as well as MPI handles leaks,
453       if code was compiled without SMPI_NO_OVERRIDE_MALLOC.
454     - if -trace-call-location is used when compiling, SMPI can report
455       origin of leaked handles/buffers
456     - group leaks by type/origin in output message if possible
457  - New implemented MPI calls: MPI_Comm_test_inter
458
459 Models:
460  - Changed internal implementation of bandwidth factors in network models.
461    Models affected: CM02, LV08 (default), SMPI, IB.
462    Configuration affected: "network/bandwidth-factors" and "smpi/bw-factors".
463    Bandwidth factors are applied to communications to describe that users
464    cannot use 100% of the available bandwidth. For example, the default network model,
465    LV08, applies a factor of 0.97 to the bandwidth. In older versions, this
466    behavior was implemented by limiting the bandwidth available in the LMM
467    system for this flow. This may give the false impression that there is
468    bandwidth available for other flows due to its underutilization, especially
469    for the dynamic bandwidth factors used in SMPI models.
470    To avoid this, we have modified the implementation so that each flow uses the
471    maximum physical bandwidth according to the LMM system.
472    However, the actual throughput of the flow seen by the user is defined by
473    the physical bandwidth multiplied by the bandwidth factor.
474    This change impacts on the simulation results for all network models on
475    which we have bandwidth factors configured.
476    *****************************************
477    *DO NOT MIX 3.28 RESULTS WITH OLDER ONES*
478    *****************************************
479    This change may impact on the timing of your simulation results.
480    Take care when comparing simulations from different SimGrid's
481    versions. Sorry for the inconvenience.
482  - Dynamic network factors: users can configure a callback to define
483    the network factors dynamically. This API is available at
484    simgrid::kernel::resource::NetworkModelIntf.
485    - Users have access to complete information about the current communication
486      to decide which factor to apply. This includes: message size, source and
487      destination hosts, links and zones traversed.
488    - Dynamic factors for both latency and bandwidth.
489    - For more details, see the example in (examples/cpp/network-factors).
490  - Plugin host_energy: the "watt_off" and "watt_per_state" host properties,
491    deprecated since version 3.24, are no longer supported. Instead, use
492    "wattage_off" and "wattage_per_state".
493
494 XBT:
495  - xbt_assert is not disabled anymore, even when built with enable_debug=off.
496
497 Documentation:
498  - New tutorial: Model-checking and formal assessment
499  - New sections: "Demystifying the routing" and "C++ platforms"
500  - Update and improve the part on visualization in MPI and Algo tutorials.
501  - Improve the section on routing: how to define it, how it's used internally
502  - Fix many issues, broken links and missing references in doxygen and Sphinx
503
504 LUA:
505  - Lua platform files are deprecated. Their support will be dropped after v3.31.
506
507 Simix:
508  - Legacy functions deprecated in this release: SIMIX_get_clock(), SIMIX_run().
509
510 Fixed bugs (FG#.. -> FramaGit bugs; FG!.. -> FG merge requests)
511  (FG: issues on Framagit; GH: issues on GitHub)
512  - FG#47: Complete and fix tests from teshuite/s4u/activity-lifecycle
513  - FG#64: Configuring smpi/IB-penalty-factors
514  - FG#67: Running computation concurrently with MPI_Iallreduce
515  - FG#69: Tutorial misleading users of pre-v3.26 versions of SimGrid
516  - FG#71: Segmentation fault on invalid gw_src/gw_dst
517  - GH#322: Issue when an actor kills his host vm
518
519 ----------------------------------------------------------------------------
520
521 SimGrid (3.27) March 29. 2021
522
523 The Ragnar Release (anniversary of the siege of Paris by Vikings in 845)
524
525 Main user-visible changes:
526  - All functions marked as deprecated for one year were removed.
527  - Removed all that was related to the "Storage" type in all APIs and bindings.
528    "Disks" have been introduced more than a year ago to replace them for the better.
529    It's time to finish this replacement.
530  - SMPI ABI breaks from previous version: MPI global handles (predefined datatypes,
531    ops, COMM_WORLD) are now defined differently, and can be used in initializers,
532    avoiding "initializer element is not constant" errors with some codes. Please be
533    careful to recompile your MPI codes if switching to this new SimGrid version.
534  - Network model ns-3 now requires version ns-3.28 or higher.
535  - Removed some option aliases that were deprecated since v3.23 (June 2019)
536    - 'verbose-exit' is now 'debug/verbose-exit'
537    - 'simix/breakpoint' is now 'debug/breakpoint'
538    - 'clean-atexit' is now 'debug/clean-atexit'
539
540 S4U:
541  - New functions: Comm::sendto_{init,async} to initiate a communication
542    on between two (possibly remote) hosts.
543  - Define new template functions Mailbox::get_unique(), returning a std::unique_ptr.
544  - Functions Mailbox::get() and Mailbox::get_async() are now templated with the
545    type of the pointee. Untyped functions are deprecated. Use Mailbox::get<void>()
546    or Mailbox::get_async<void>() if you really want to play with void*.
547  - Unify the interface of Activity::on_{start/activity}
548  - New function: Comm::get_dst_data()
549  - New function: Comm::set_payload_size() to set the amount of bytes to simulate.
550
551 Models:
552  - ptask should now work better with multicore hosts (FG#37).
553  - Internal cleanups and refactoring around activities, to prepare for SimDAG++.
554  - Internal cleanups and refactoring around models, to prepare for programmatic
555    platform creation.
556  - Modernize our tests of the performance models
557
558 Documentation:
559  - User manual:
560    - New section: Configuring the logs from the command line.
561    - New section: Programming API of logs.
562    - New section: Getting realistic results
563    - New section: Examples of SMPI Usage
564  - New part: SimGrid's Internals, with a section on Design goals
565  - Move back to the classical Breathe tool chain, and fix many small glitches.
566
567 SMPI:
568  - Handle leak checking: SMPI will now display a message if MPI handles are still
569    present at the end of a simulation. Option smpi/list-leaks:n will display the n
570    first leaked pointers and their types.
571  - smpi/display-allocs option : Display Memory allocations analysis, with hints
572    about the largest allocations. This only works for allocations with malloc/calloc
573    and not compiled with SMPI_NO_OVERRIDE_MALLOC
574  - "-analyze" option in smpirun will activate smpi/display-allocs and smpi/display-timing
575  - New implemented MPI calls: MPI_File_set_size, MPI_Aint_add, MPI_Aint_diff,
576    MPI_Type_get_extent_x, MPI_Type_get_true_extent_x, MPI_Status_set_elements_x
577  - Support for MPI C++ datatypes (MPI_CXX_BOOL, MPI_CXX_FLOAT_COMPLEX,
578    MPI_CXX_DOUBLE_COMPLEX, MPI_CXX_LONG_DOUBLE_COMPLEX)
579  - Replay now opens and parses the trace file only once for all ranks when possible.
580  - Misc fixes:
581    - better handling of MPI_PROC_NULL
582    - MPI_Group_incl was broken in some cases
583    - PAPI tracing now fixed
584    - MPI_Errhandlers are properly handled for MPI_COMM_WORLD
585    - SMPI will now fail properly when receive size < sent size, instead of
586      just setting MPI_ERR_TRUNCATE and keep going.
587  - Proxy Apps ( https://framagit.org/simgrid/SMPI-proxy-apps ):
588    - Remove useless build patches and split build/run patches on the page
589    - Build in parallel when possible
590    - Test on yum-based systems
591    - New nightly tested Proxy-apps:
592      - OpenMPI mpi-test-suite
593      - Coral MCB, LSMS, Qbox, CLOMP
594      - ECP/Mantevo Cloverleaf3D, Ember
595      - Codevault bhtree_mpi
596
597 Model checker:
598  - Only initialize the Dwarf parser when needed, saving 10 seconds in most cases.
599  - Start to overhaul the implementation to modernize it (still ongoing).
600
601 XBT:
602  - Drop simgrid::xbt::demangle(). Please use boost::core::demangle() instead.
603  - Drop xbt_dynar_cursor_rm(), xbt_dynar_search_or_negative(),
604    xbt_str_split_quoted(), xbt_str_split_quoted_in_place().
605  - Deprecate xbt_dynar_to_array().
606  - When an exception occurs in kernel mode, display both the actor and kernel stacks.
607
608 C binding and interface:
609  - Rename (lowercase) functions sg_actor_get_PID, sg_actor_get_PPID, sg_actor_by_PID.
610  - Constness requirement has been lowered for parameter argv of sg_actor_start()
611    and sg_actor_create() It's now (char* const*). The previous version is still
612    available as sg_actor_start_() and sg_actor_create_().
613
614 Fixed bugs (FG#.. -> FramaGit bugs; FG!.. -> FG merge requests)
615  (FG: issues on Framagit; GH: issues on GitHub)
616  - FG#37: Parallel tasks are limited to 1 core per host
617  - FG#62: Running "smpirun -replay" on large networks
618  - FG!46: Fix a few potential memory leaks in SMPI colls
619  - GH#343: Wrong consumed energy when an exec timeouts
620
621 ----------------------------------------------------------------------------
622
623 SimGrid (3.26) December 15. 2020
624
625 The Release release (the French lockdown was eased today).
626
627 Important user-visible changes:
628  - SimGrid now requires a compiler with C++14 support.
629    Sibling projects should upgrade their FindSimgrid.cmake
630  - Surf precision default value is now 1e-9, instead of 1e-5. This was changed as
631    several users had difficulties to understand issues when using high bandwidth or
632    small latency events. The new value was already the default for SMPI and
633    should not cause too much performance hit. It can change some simulation
634    timings if simulation was skipping a lot of small events (which was actually
635    an issue per see). The old value can be restored with --cfg=surf/precision:1e-5.
636  - On some network models (L07, CM02, LV08), an implicit loopback link is created
637    for local communication. Default bandwidth was 500MBps and latency was 15µs,
638    which was rather bad. Default values have been changed to 10GBps and 0 latency.
639    Options network/loopback-lat and network/loopback-bw have been added to adapt
640    these values if needed. Network and routing models already providing separate
641    loopbacks (clusters and such) are not impacted by this change.
642  - SMPI now adds 16 bytes of header to each message sent, in order to simulate
643    metadata that are added to each MPI message by MPI libraries (tag,
644    src/dest, and communicator information). This may change simulation times
645    for very small message sizes, but should be more realistic.
646
647 New features:
648  - New routing 'WiFi' that makes it easier to specify a wifi network zone.
649  - New plugins: wifi_energy and link_load. See the associated examples.
650  - New examples: wifi networks, and communication suspend.
651
652 General:
653  - LTO is now enabled for Intel/clang compilers.
654  - LTO behavior on GCC can be parameterized using LTO_EXTRA_FLAG in cmake.
655    Setting it to "auto" will use all available cores, while setting it to n will
656    use n cores to speedup link step (usage: cmake -DLTO_EXTRA_FLAG=4).
657  - Remove obsolete runtime option 'contexts/parallel-threshold'.
658  - Runtime option 'tracing/msg/process' renamed to 'tracing/actor'. The old name
659    has been kept for compatibility.
660  - Finally remove obsolete snake_case() aliases for runtime options.
661  - Further improve the documentation.
662
663 S4U:
664  - the on_exit() of each actor is also executed when the simulation deadlocks.
665  - New functions: s4u::Activity:: suspend(), resume() and is_suspended()
666    An example is provided for s4u::Comm but it should work with Exec and Io.
667
668 SMPI:
669  - Update proxy apps coverage of new ECP apps: 60+ apps now tested nightly on
670    https://framagit.org/simgrid/SMPI-proxy-apps
671  - MPI/IO: supports names starting with "./"
672  - Fortran: many MPI/IO bindings, support for MPI_UB/LB, C MPI_INT/FLOAT/DOUBLE
673    datatypes.
674  - smpicc/cxx/ff/f90 now will actually perform definition checks at link time. When
675    building shared libraries, this may cause issues, so environment variable
676    SMPI_NO_UNDEFINED_CHECK can be added to disable this.
677  - most temporary files should now be created in /tmp dir (or equivalent).
678    If this one does not allow execution of code (noexec flag), this may cause issues.
679    Please use another tmp directory (using TMPDIR or equivalent system variable)
680    in this case.
681
682 Model-Checker:
683  - A large refactoring is ongoing, but this should be transparent for users so far.
684
685 XBT:
686  - Drop xbt_str_split().
687
688 C binding and interface:
689  - The return type of the sg_actor_on_exit() callbacks is now 'void'
690    (int value was previously ignored)
691  - Many C functions were renamed to follow a common naming style
692    (sg_object_get_something and sg_object_set_something). As usual, the deprecated
693    names are kept until version 3.30.
694  - Many MSG tests were converted to the new S4U's interface in C, that
695    was extended for that.
696
697 Fixed bugs (FG#.. -> FramaGit bugs; FG!.. -> FG merge requests)
698  (FG: issues on Framagit; GF: issues on GForge; GH: issues on GitHub)
699  - FG#41: Add sg_actor_create C interface
700  - FG#43: xbt::random needs some care
701  - FG#48: The Impossible Did Happen (yet again)
702  - FG#50: Suspending an actor executed at the current timestamp fails
703  - FG#52: Zero-seconds timeout : "That's in the past already"
704  - FG#53: Crash while using ns-3 network model
705  - FG#54: How to suspend a comm?
706  - FG!22: Stochastic Profiles
707  - FG!24: Documentation and fix for xbt/random
708  - FG!35: Add a modeling hint for parallel links in doc
709  - FG!36: [xbt/random] Read/Write the state of the RNG
710  - FG!42: Link cumulated load plugin
711  - FG!44: Test condition variable wait_until+notify_all
712  - GF#18137: Allow different stack sizes?
713  - GH#128: Parallelization of simulation with --cfg=contexts/nthreads
714  - GH#139: Allow pthread creation in SMPI
715  - GH#336: Packet-level simulation using SMPI?
716  - GH#345: Error in the LMM while migrating a VM
717  - GH#346: [SMPI] error while loading shared libraries: libsimgrid.so
718  - GH#352: pip install / python setup.py install fail to find pybind11
719  - GH!337: Fix link_energy plugin for wifi platforms
720  - GH!339: Add Mailbox set_receiver method to python binding
721  - GH!344: Cast hugepages macros parameters to int64
722
723 ----------------------------------------------------------------------------
724
725 SimGrid (3.25) February 2. 2020 (aka 02 02 2020)
726
727 The Palindrom Day Release.
728
729 Important user-visible changes:
730  - Improve the Python usability (stability and documentation).
731    - A nasty synchronization bug was ironed out, see also below.
732    - Python's doc was organized as a separate tree, now integrated with C++.
733    - C bindings of S4U were not part of the doc.
734    - The C++ doc was also improved as methods are now split by theme.
735  - Further deprecate MSG: you now have to pass -Denable_msg=ON to cmake.
736    - This is mandatory to use the Java bindings.
737    - OFF by default; The plan is to completely remove MSG by 2020Q4 or 2021Q1.
738  - SimDAG++: Automatic dependencies on S4U activities (experimental)
739    - Some features are already implemented but not all of them
740    - Cannot block an activity until it's scheduled on a resource
741    - No heterogeneous wait_any() that would mix Exec/Comm/Io activities.
742    - See examples/s4u/{io,exec,comm}-dependent for what's already there.
743
744 General:
745  - Upgrade documented Java dependency to Java 8 (earlier versions don't work).
746  - Drop support for Viva/Triva (old visualization tools), hence removed
747    TRACE_get_node_types() and TRACE_get_edge_types() functions.
748
749 Python:
750  - Require pybind11 version 2.4.
751  - Greatly improve locking during context switches with Python.
752    - Declaring Python callbacks to this_actor::on_exit is now working.
753    - No more tests are failing currently, even on win32.
754
755 S4U:
756  - Actor: Merge signals on_migration_start/end into on_host_change
757  - Actor: Rename migrate() into set_host()
758  - Disk: Allow users to get the read and write nominal bandwidth values
759  - Exec: Implement wait_for(timeout)
760  - Io: Implement wait_for(timeout)
761
762 XML:
763  - Parse errors now raise a simgrid::ParseError that you may want to catch.
764
765 Kernel:
766  - In simgrid::kernel::resource::Model, the methods next_occuring_event*() have
767    been renamed to fix a spelling error. As usual, the previous definitions are
768    kept with a deprecation warning. However, to avoid runtime errors, it is now
769    forbidden to override these deprecated methods in a derived class. Please use
770    the new names immediately if you need to override them.
771
772 XBT:
773  - Remove unused parameter 'free_ctn' for xbt_dict_set() and xbt_dict_set_ext().
774  - Drop unused functions for dicts and dynars: xbt_dict_cursor_get_elm,
775    xbt_dict_get, xbt_dict_get_elm, xbt_dict_get_ext, xbt_dict_get_key,
776    xbt_dict_remove, xbt_dict_reset, xbt_dynar_compare, xbt_dynar_dump,
777    xbt_dynar_foreach_ptr, xbt_dynar_free_data, xbt_dynar_free_voidp,
778    xbt_dynar_init, xbt_dynar_insert_at_as, xbt_dynar_merge,
779    xbt_dynar_remove_n_at, xbt_dynar_replace, xbt_dynar_search, xbt_dynar_set.
780  - New module: random, providing classical random numbers generators.
781
782 SMPI:
783  - New option : "smpi/auto-shared-malloc-thresh" which sets a value for
784    allocations' size above which they are considered "shared" by default (as if
785    they were performed through SMPI_SHARED_MALLOC macros).
786    Default = 0 = disabled feature.
787    Note : malloc, calloc and free are now overridden by smpicc/cxx by default.
788    This can cause some troubles if codes are already overriding these. If this
789    is the case, defining SMPI_NO_OVERRIDE_MALLOC in the compilation flags can
790    help, but will make this feature unusable.
791  - Input check is now performed much more consistently and outputs precise
792    warnings for each error found
793  - New supported calls : MPI_File_set_view, MPI_File_get_view
794  - MPI I/O now only supports disks, as storage is discontinued.
795  - MPI I/O allows opening files without specifying absolute path
796  - Note : SMPI configuration options are now initialized by smpi_init_options()
797    call, which should be called if SMPI is not being used through smpirun.
798
799 Fixed bugs (FG#.. -> framagit bugs; FG!.. -> framagit merge requests):
800  - FG#9: Python bindings crashing
801  - FG#39: Missing s4u::Comm::wait_any_for example
802  - FG#42: Add support for ThreadSanitizer (TSan)
803  - FG!19: Removing RngStream
804  - FG!20: A module for RNG calls
805  - FG!21: Choice between ad-hoc and standard distributions implementations
806  - FG!23: Master
807  - FG!25: Fix link in Mutex doc
808  - FG!26: Fix links in SMPI interface doc
809  - GH#31: [MC] please provide an option to make MPI_Send asynchronous
810  - GH#305: Unscheduled tasks are still excuted
811  - GH#313: smpirun: manual outdated w.r.t. --help
812  - GH#321: [S4U] Get task remaining work ratio
813  - GH#323: Crash when an actor turn off his physical host
814  - GH#335: Missing links on dragonfly example svg
815  - https://lists.gforge.inria.fr/pipermail/simgrid-user/2019-November/004653.html:
816    MPI_Cart_sub was not working properly. Kudos to Jonathan Borne for the report.
817
818 ----------------------------------------------------------------------------
819
820 SimGrid (3.24) October 9. 2019
821
822 The Clean Disk Release.
823
824 S4U:
825  - Introduce a s4u::Disk interface to manage the newly introduced <disk>
826    tag. s4u::Disk is called to supplant s4u::Storage in a near future. It
827    thus becomes the default resource to execute I/O operations. Examples
828    and the file system plugin have been modified to use disks instead of
829    storage elements. Storage can still be used but is doomed to disappear.
830    Users are thus adviced to update their simulators accordingly.
831  - Barrier::wait returns SG_BARRIER_SERIAL_THREAD for (only) one actor
832    for consistency with pthread_barrier_wait()
833  - Host::get_englobing_zone() returns the englobing netzone
834  - Actor::on_destruction is now called in the destructor
835    Actor::on_termination new signal called when the actor terminates
836    its code.
837  - Global signals are now part of the Engine:
838    - on_platform_creation: after config settings, before the XML parsing
839    - on_platform_created: right after the XML parsing
840    - on_time_advance: each time the clock advances
841    - on_simulation_end: after simulation, before cleanups
842    - on_deadlock: as the name implies.
843  - C bindings:
844    - sg_{actor,host,link}_{data,data_set}() now all exist.
845      Use them to attach user data to the object and retrieve it.
846
847 Models:
848  - Introduce an experimental Wifi model. It sounds reasonable
849    according to the state of the art, but it still has to be properly
850    validated, at least against ns-3 if not against reality.
851  - Improved the usability of ns-3. Several bugs were ironed out.
852  - host_energy: Wattage was expressed as 'idle:oneCore:allCores'.
853    It is now expressed as 'idle:epsilon:allCores' to properly model the
854    consumption of non-whole tasks on mono-core hosts. More info in the doc.
855
856 MSG:
857  - convert a new set of functions to the S4U C interface and move the old MSG
858    versions to legacy (MSG_process_self*, MSG_process_{un}ref, ...)
859
860 SMPI:
861  - Fortran bindings for DVFS have been removed.
862  - Add support for MPI_Irsend, MPI_Rsend, MPI_Rsend_init, MPI_Bsend,
863    MPI_Ibsend, MPI_Bsend_init, MPI_Buffer_attach, MPI_Buffer_detach
864  - SMPI can now be selected by cmake's find_module(MPI) with
865    MPI_C_COMPILER, MPI_CXX_COMPILER, MPI_Fortran_COMPILER variables.
866  - Add support for MPI Errhandlers in Comm, File or Win. Default errhandler is now
867    MPI_ERRORS_ARE_FATAL, so codes which were sending warnings may start failing.
868  - trace-call-location can be used with TI traces, and replayed, and is compatible
869    with smpi/comp-adjustment-file.
870  - sleep events are now correctly traced/replayed.
871  - Default for trace-call-location is now to use file names and not full paths.
872    To revert to previous behavior (in case of collision of filenames), option
873    "smpi/trace-call-use-absolute-path" can be set to yes.
874
875 Model-Checker:
876  - Use the included xxHash as an hash implem when C++14 is usable.
877  - Option model-checker/hash was removed. This is always activated now.
878  - New option smpi/buffering controls the MPI buffering in MC mode.
879  - MPI calls now MC_assert() that no MPI_ERR_* code is returned.
880    This is useful to check for MPI compliance.
881
882 Documentation:
883  - New section on plugins: how to define a new one, and existing ones.
884
885 XBT:
886  - xbt_mutex_t and xbt_cond_t are now marked as deprecated, a new C interface
887    on S4U is already available to replace them by sg_mutex_t and sg_cond_t.
888
889 XML:
890  - Introduce the <disk> tag as a replacement of the <storage>, <storage_type>,
891    and <mount> tags. The rationale is finish to decouple what should be handle
892    by SimGrid kernel (i.e., resources and activities) from plugins built in
893    user space (e.g., the file system plugin). This new tag currently accepts
894    only three attributes (id, read_bw, and write_bw). All the other information
895    that was declared with the storage related tags now has to be expressed as
896    properties. An example of platform using this new tag is available at
897    examples/platforms/hosts_with_disks.xml
898
899 tesh:
900  - 'expect signal' can now accept more than one potential signal.
901
902 Fixed bugs (FG#.. -> framagit bugs; FG!.. -> framagit merge requests):
903  - FG#28: add sg_actor_self (and other wrappers on this_actor methods)
904  - FG#29 and FG#33: provide a new C API to mutexes and condition variables
905  - FG#30: convert MSG_process_{un}ref to sg_actor_{un}ref
906  - FG#31: per-actor data
907  - FG#34: SG_BARRIER_SERIAL_THREAD?
908  - FG#35: model-checker does not like buster-produced binaries
909  - FG!13: MC: complete workaround in the error msg seen on modern systems
910  - FG!15: execute_flops now logs compute
911  - FG!16: Fix the ns-3 bindings when several flows are simultaneously finishing
912  - FG!17: ns-3: unblock the right number of communications + others issues
913  - FG!18: Improving the performance of the ns-3 bindings
914  - GH#189: Energy consumption of parallel tasks
915  - GH#219: Error in the throughput of TCP transfer
916  - GH!330: Minor polishing of English: Configuring_Simgrid
917  - GH!331: Fix a doc error about actors (Tutorial_algorithms)
918  - GH!332: Add '-O0' flag for: cmake -DCMAKE_BUILD_TYPE=Debug
919  - GH!334: Rework energy plugin, again
920
921 ----------------------------------------------------------------------------
922
923 SimGrid (3.23.2) July 8. 2019
924
925 Documentation:
926  - Nicer introduction page.
927  - Migrate the "Deploy your application" page to the new doc.
928  - Move Java as a subtree of MSG.
929
930 General:
931  - Rename simgrid::TimeoutError to simgrid::TimeoutException.
932
933 XBT:
934  - Drop xbt_dynar_sort_strings().
935
936 Bugs:
937  - Really fix FG#26: Turning off a link should raise NetworkFailureException
938  - FG#27: Wrong exception thrown to wait_any when link is turned off
939  - GH#328: Java: Canceling multiple tasks in a single vm/host
940
941 ----------------------------------------------------------------------------
942
943 SimGrid (3.23) June 25. 2019
944
945 The Exotic Solstice Release.
946
947 General:
948  - SunOS and Haiku OS support. Because exotic platforms are fun.
949  - Stop setting random seed with srand48() at initialization.
950  - Use addr2line as a fallback for stacktraces when backtrace is not available.
951  - Build option -Denable_documentation is now OFF by default.
952  - Network model 'NS3' was renamed into 'ns-3'.
953
954 Python:
955  - Simgrid can now hopefully be installed with pip.
956
957 S4U:
958  - wait_any can now be used for asynchronous executions too.
959
960 XBT:
961  - New log appenders: stdout and stderr. Use stdout for xbt_help.
962  - Drop xbt_dict_dump.
963
964 SMPI:
965  - SMPI now reports support of MPI3.1. This does not mean SMPI supports all MPI 3 calls, but it was already the case with 2.2
966  - MPI/IO is now supported over the Storage API (no files are written or read, storage is simulated). Supported calls are all synchronous ones.
967  - MPI interface is now const correct for input parameters
968  - MPI_Ireduce, MPI_Iallreduce, MPI_Iscan, MPI_Iexscan, MPI_Ireduce_scatter, MPI_Ireduce_scatter_block support
969  - Fortran bindings for async collectives.
970  - MPI_Comm_get_name, MPI_Comm_set_name, MPI_Count support.
971
972 Model-checker:
973  - Remove option 'model-check/record': Paths are recorded in any cases now.
974  - Remove option 'model-check/sparse-checkpoint': Checkpoints are now
975    always sparse. That's an immense gain in memory, and can even be
976    faster because of cache effects. So there is no need to clutter the
977    code to allow the user to go for the unefficient mode.
978
979 Network models:
980  - Remove the lagrange-based models (Reno/Reno2/Vegas). The regular
981    models proved to be more accurate than these old experiments.
982
983 Fixed bugs (FG=FramaGit; GH=GitHub -- Please prefer framagit for new bugs)
984  - FG#1: Broken link in error messages
985  - FG#2: missing installation documentation
986  - FG#3: missing documentation in smpirun
987  - FG#6: Python bindings not available on PyPI
988  - FG#7: simple cmake call requires doxygen
989  - FG#8: make python bindings an optional dependency
990  - FG#10: Can not use MSG_process_set_data from SMPI any more
991  - FG#11: Auto-restart actors forget their on_exit behavior
992  - FG#12: -Denable_lto=OFF doesn't disable LTO
993  - FG#13: Installs unstripped file 'bin/graphicator'
994  - FG#14: Installs the empty directory 'doc/simgrid/html'
995  - FG#15: Setting -Denable_python=OFF doesn't disable the search for pybind11
996  - FG#17: Dead link in doc (pls_ns3)
997  - FG#20: 'tesh --help' should return 0
998  - FG#21: Documentation link on http://simgrid.org/ broken
999  - FG#22: Debian installation instruction are broken
1000  - FG#26: Turning off a link should raise NetworkFailureException exceptions
1001  - GH#133: Java: a process can run on a VM even if its host is off
1002  - GH#320: Stacktrace: Avoid the backtrace variant of Boost.Stacktrace?
1003  - GH#326: Valgrind-detected error for join() when energy plugin is activated
1004
1005 ----------------------------------------------------------------------------
1006
1007 SimGrid (3.22) April 1. 2019
1008
1009 The Easter Christmas Release (this one is somewhat late).
1010
1011 Python:
1012  - We are excited to introduce the SimGrid/S4U interface to your neighborhood
1013  - Not complete yet: asynchronous activities (amongst others) are still missing
1014  - Still ongoing: the interface may change in the future. We need more
1015    testers! Please report any glitches.
1016  - No new project using Java should start now. Please switch to Python.
1017
1018 General:
1019  - Some of the internal cleanups may lead to speed improvements:
1020    - The hard limitation on the amount of simulated actors with
1021      Java+Mac was removed. Now, the  available memory is the only limit.
1022    - Our refcounting was tidyied, leading to 10% speedups in some cases.
1023  - We are still working on making our code robust to the actor kills
1024    and hosts' churn. Things are improving, but it's not perfect yet.
1025  - Replaced our own code to display a backtrace (that was forking addr2line)
1026    with the Boost.Stacktrace library.
1027    You won't see your backtraces without this optional dependency.
1028  - Bump cmake dependency to 3.5 (provided by Ubuntu 16.04).
1029  - Stop setting random seed with srand() at initialization.
1030
1031 XML
1032  - In <host> and <peer>, 'availability_file' is now 'speed_file'.
1033    XML file version remains 4.2 since old files are still compatible.
1034
1035 Java:
1036  - Process termination which was broken at version 3.21 has been repaired.
1037  - Expose host load plugin: loadInit, getCurrentLoad, getComputedFlops, getAvgLoad
1038  - Hide the examples into examples/deprecated. New users should use Python.
1039
1040 MSG:
1041  - Drop MSG_process_create_from_stdfunc() from the API.
1042    This C++ function was a pimple in the C API, made necessary at some
1043    point by the Java bindings. This is fixed now.
1044  - Hide the examples into examples/deprecated. New users should use S4U.
1045  - MSG_process_create and MSG_process_attach now crash if the host used
1046    to run this process is off.
1047  - Fix the protype of MSG_process_on_exit()
1048    Now use (int,void*) callbacks instead of (void*,void*) ones.
1049    The implementation was ways too messy to actually work, I guess.
1050
1051 SMPI:
1052  - Change the way SMPI_SAMPLE_* macros work to avoid invalidating cache
1053    too often and provide more accurate timings.
1054  - Add -gdb, -lldb, and -vgdb shortcuts to help debug MPI codes with smpirun
1055  - MPI_Alltoallw support
1056  - Partial MPI nonblocking collectives implementation: MPI_Ibcast, MPI_Ibarrier,
1057    MPI_Iallgather, MPI_Iallgatherv, MPI_Ialltoall, MPI_Ialltoallv, MPI_Igather,
1058    MPI_Igatherv, MPI_Iscatter, MPI_Iscatterv, MPI_Ialltoallw.
1059  - MPI_Request_get_status, MPI_Status_set_cancelled, MPI_Status_set_elements
1060    support
1061  - Basic implementation of generalized requests (SMPI doesn't
1062    allow MPI_THREAD_MULTIPLE) : MPI_Grequest_complete, MPI_Grequest_start
1063
1064 XBT:
1065  - Drop sg_cmdline. Please use xbt_cmdline instead.
1066  - Drop the C xbt_os_mutex_t; Use the C++11 std::mutex.
1067  - Drop the C xbt_os_sem_t; Use the C++ xbt::OsSemaphore.
1068    OsSemaphore is implemented in a portable way with C++11 threads.
1069    This should allow much more threads to be created at the same time,
1070    allowing Mac and Java users to simulate many more actors.
1071  - Implement the 'thread' factory with std::thread instead of xbt ones.
1072    It is not possible to set the stack size with threads anymore, but
1073    -fsplit-stack is the way to go nowadays when using threads.
1074  - Drop the xbt_os_thread_t module (now unused)
1075  - Drop xbt_ex_display(), use simgrid::xbt::log_exception() instead.
1076  - Drop xbt_str_join_array().
1077  - Drop cunit, use Catch2 instead.
1078
1079 Kernel:
1080  - Many cleanups in the kernel::activity namespace. This was long
1081    overdue, and shall open the path to many future endeavors.
1082
1083 Fixed bugs:
1084  - #132: Java: a process can not shut down its own host
1085  - #220: S4U: detached send causes exception if sender terminates soon after sending
1086  - #261: Document the parameters of parallel execution's constructor
1087  - #300: [s4u] BarrierPtr is missing
1088  - #314: SMPI args internal cleanup
1089  - #316: Fix a bug related to the CPU utilization of multi-core VM
1090  - #318: Invalid trace file when using option --cfg=tracing/smpi/display-sizes:yes
1091  - #324: S4U: Attempting to create an actor on turned off host segfaults instead of throwing
1092  - #325: Turning off a host has different behavior on sleeping actors and computing actors
1093
1094 ----------------------------------------------------------------------------
1095
1096 SimGrid (3.21) October 3. 2018
1097
1098 The Restarting Documentation (TRD) Release.
1099
1100 Documentation:
1101  - Convert the user manual to Sphinx for improved usability.
1102    Unstable version now hosted on https://simgrid.frama.io/simgrid
1103    Many glitches remain; stay tuned.
1104  - Restrict the Doxygen reference API to the installed header files.
1105    (documenting all internals this way is overkill + doxygen scales badly)
1106  - New tutorial on S4U (highly inspired from the old MSG one, but with
1107    a git repository to fork as a starting point, and a docker image)
1108  - Started but not finished an SMPI tutorial inspired from the JLPC'14 one.
1109  - The Developper manual is still to be converted (not compiled until then)
1110  - Some parts are still missing in this conversion (such as the
1111    platform and deployment sections) while others were blindly converted
1112    and would need more love (such as the configuration flags).
1113    Things will certainly further improve in the future releases.
1114
1115 S4U new features:
1116  - Fully reimplement auto_restart mechanism that was utterly broken
1117    (fix #22, #131 and #281 that were all very related)
1118  - Implement semaphores (fix #303 and #291)
1119  - When creating an actor from a function and its parameters,
1120    move-only parameters are not allowed anymore, as it would prevent
1121    the actor to be restartable if its parameters are consumed on run.
1122  - s4u::Io: IOs go asynchronous as activities. New methods in s4u::Storage:
1123      - io_init(sg_size_t, s4u::Io::OpType) to create a READ or WRITE asynchronous
1124        IO operations that can be started, waited for, or canceled as a regular
1125        activity.
1126      - read_async(sg_size_t) and write_async(sg_size_t) which are wrappers on
1127        io_init() + start()
1128
1129 Tracing:
1130  - Rename 'power' and 'power_used' variables into 'speed' and 'speed_used'
1131  - New host variable: 'core_count'
1132
1133 XBT:
1134  - Remove xbt_os_thread_specific features
1135  - Remove portability wrapper to condition variables
1136  - Remove xbt_os_thread_yield()
1137
1138 SMPI:
1139  - MPICH collective selector now mimics MPICH 3.3b
1140  - OpenMPI collective selector now mimics OpenMPI 3.1.2 (default "tuned" setting)
1141  - MPI_Init(NULL,NULL) is now allowed
1142  - smpi/wtime option now injects time in gettimeofday or clock_gettime calls
1143  - Command-line arguments should now be handled properly in Fortran simulations
1144  - MPI Attributes and related callbacks should work in Fortran
1145  - Apps using C + Fortran should now work
1146  - MPI_* calls now check for non MPI_SUCCESS return values and emit warnings
1147  - Support MPI_Error_String
1148
1149 Java:
1150  - Due to an internal bug, Msg.run() must now be your last line.
1151    We hope to fix it in a future release, and we are sorry for the inconvenience.
1152
1153 Fixed bugs:
1154  - #22: Process autorestart seem to only work with CAS01 cpus
1155  - #56: Feature request: dynamic SMPI replay
1156  - #93: simgrid should not eat --help
1157  - #111: How to change the loopback link characteristics?
1158  - #116: Platform cluster radical
1159  - #117: Platform cluster/host order
1160  - #129: Replay_multiple on steroid
1161  - #131: Java : autostart does not work
1162  - #143: Setting a breakpoint at a given time
1163  - #235: Network energy models should be integrated
1164  - #264: Add ptask L07 resource tracing
1165  - #271: Dynamic and manual replay of SMPI traces
1166  - #279: Breakpoints option uses time deltas instead of absolute time
1167  - #281: Daemonized actor no longer daemonized after an auto-restart
1168  - #282: TIT convertor erase traces when using absolute path in the trace list file
1169  - #285: segfault when a s4u actor kills itself with msg process tracing activated
1170  - #286: Pajé traces are not exposing the number of cores
1171  - #287: Command-line parsing should stop when encountering '--'
1172  - #288: MPI_Init(NULL, NULL)
1173  - #289: Improve documentation of Actor::on_destruction and this_actor::on_exit()
1174  - #290: Method to check if a mailbox has a message ready to be consumed
1175  - #291: [s4u] semaphores do not seem available yet
1176  - #294: Alltoall collective implementation of mpich
1177  - #295: Starting a Host as OFF is not supported
1178  - #296: DTD too permissive
1179  - #299: Add a s4u barrier example
1180
1181 ----------------------------------------------------------------------------
1182
1183 SimGrid (3.20) Released June 24. 2018
1184
1185 The proxy snake_case() release.
1186
1187 S4U:
1188  - The whole API is now using snake_case() instead of mixing it with camelCase.
1189    Compatibility wrappers in place for one year.
1190  - We took the opportunity to increase the consistency of the API.
1191    Please report any remaining glitches.
1192  - New function simgrid::s4u::Host::get_actor_count:
1193    Returns the number of actors running on a specific host.
1194
1195 SMPI:
1196  - SMPI is now tested with ~45 proxy apps from various sources, with none or
1197    only minor patching needed: check https://github.com/simgrid/SMPI-proxy-apps
1198  - Replay: The replay file has been re-written in C++.
1199  - Replay: Tags used for messages sent via MPI_Send / MPI_Recv are now
1200    supported. They are stored in the trace and used when replayed.
1201  - Basic support of MPI_Cancel. Robustness not guaranteed.
1202  - Support of MPI_Win_allocate_shared, MPI_Win_shared_query, MPI_Comm_split_type
1203    (only for MPI_COMM_TYPE_SHARED).
1204  - New option: smpi/privatize-libs, to add external shared libs to be privatized
1205    by SMPI. They will be copied locally and loaded separately by each process.
1206    Example --cfg=smpi/privatize-libs:"libgfortran.so.3;libscalapack.so".
1207  - Tracing: add tracing for MPI_Start, Startall, Testall, Testany
1208  - Interception of getopt, getopt_long and getopt_long_only calls to avoid issues
1209    with internal index optind with multiple processes. Only works if MPI_Init has
1210    already been called.
1211  - Fortran: SMPI builds a mpi.mod file which should allow use of "use mpi"
1212    syntax without preprocessing tricks.
1213
1214 TRACE
1215  - Change --cfg=tracing/msg/vm to --cfg=tracing/vm as virtual machine
1216    behavior tracing is no longer limited to MSG
1217  - TIT (Time Independent Traces): We finally support tags. Unfortunately,
1218    this means that traces now need to be updated or re-obtained; both Irecv
1219    and Isend lines in your traces have now in total 5 mandatory fields:
1220       <rankid> <command> <to/from rankid> <tag> <size>
1221    To update your traces, it suffices to add a 0 for the tag here.
1222  - TIT now also supports waiting for a distinct request via MPI_Wait.
1223    Wait/Test now wait for a specific request, not just the last one that was
1224    issued. This unfortunately means another update, because we need to
1225    identify which request you want to wait for. We do this via the
1226    triplet (sender, receiver, tag), which needs to be added:
1227       <rankid> <command> <sender> <receiver> <tag>
1228  - Actions are now in lower case (e.g., "allReduce" becomes "allreduce").
1229    New script simgrid_convert_TI_traces.py: upgrade your TI traces.
1230
1231 MSG
1232  - The deprecation of MSG is ongoing (but this should not impact you).
1233    Many MSG functions are now simple wrappers on the C API of S4U. If
1234    you wish to convert your code to S4U, find the S4U counterparts of
1235    your MSG calls in src/msg/msg_legacy.cpp.
1236  - MSG can still be used, but won't evolve anymore.
1237
1238 Plugins:
1239  - Allow to run the Link energy plugin from the command line with
1240    --cfg=plugin:link_energy
1241  - Rename Energy plugin into host_energy
1242  - Rename Load plugin into host_load
1243
1244 Simix:
1245  - Add parameter --cfg=simix/breakpoint to raise a SIGTRAP at given time.
1246  - kill simix::onDeadlock() that was somewhat dupplicating s4u::on_deadlock()
1247  - Improve performance when handling timeouts of simix synchros.
1248
1249 XBT:
1250  - Config: the C API is now deprecated (will be removed in 3.23), and
1251            the C++ API has been slightly improved.
1252
1253 Other:
1254  - Fix several build issues on OSX.
1255  - Move simgrid_config.h to simgrid/config.h (old header still working)
1256
1257 Fixed bugs:
1258  - #143: Setting a breakpoint at a given time
1259  - #150: Inconsistent event names in SMPI replay
1260  - #258: daemonized actors hang after all non-daemonized actors have completed
1261  - #267: Linker error on unit_tmgr
1262  - #269: SMPI: tracing of MPI_Wait/all/any broken
1263  - SMPI: Fix various crashes with combined use of MPI_PROC_NULL and MPI_IGNORE_STATUS
1264
1265 ----------------------------------------------------------------------------
1266
1267 SimGrid (3.19.1) Released March 22 2018
1268
1269  The Fixed ABI Release.
1270
1271  As you may know, we are currently refactoring SimGrid in deep.
1272  Upcoming SimGrid4 will be really different from SimGrid3: modular,
1273  standard and extensible vs. layered, homegrown and rigid. C++ vs. C.
1274
1275  Our goal is to smooth this transition, with backward compatibility
1276  and automatic update paths, while still progressing toward SimGrid4.
1277
1278  SimGrid remains open during works: The last pure SimGrid3 release was
1279  v3.12 while all subsequent versions are usable alpha versions of
1280  SimGrid4: Existing interfaces remain unchanged, but the new S4U
1281  interface is budding and the internals are deeply reorganized.
1282
1283  Since 2015, we work hard to reduce the changes to public APIs. When
1284  we need to rename a public library symbol in S4U, we let your
1285  compiler issue an explicative warning when you use the deprecated
1286  function. These messages remain for four releases, i.e. for one full
1287  year, before turning into an error. Starting with v3.15, your can
1288  also adapt to API changes with the SIMGRID_VERSION macro, that is
1289  defined to 31500 for v3.15, to 31901 for v3.19.1 and so on.
1290
1291  Starting with this v3.19.1, our commitment to reduce the changes to
1292  the public interfaces is extended from the API to the ABI: a program
1293  using only MSG or SimDag and compiled against a given version of
1294  simgrid can probably be used with a later version of SimGrid without
1295  recompilation. We will do our best... but don't expect too much of
1296  it, that's a really difficult goal during such profund refactoring.
1297
1298  The difference between v3.19 and v3.19.1 is that the former was
1299  accidentally breaking the ABI of MSG, while the later is restoring
1300  the previous ABI.
1301
1302  S4U and kernel APIs will still evolve until SimGrid4, with one-year
1303  deprecation warnings as currently. In fact, cleaning up these
1304  interfaces and converting them to snake_case() is one release goal of
1305  v3.20. But don't worry, we are working to smooth this upgrade path.
1306
1307  In summary, new projects should start with S4U to benefit of the
1308  future, but old MSG projects should still be usable with no change.
1309
1310 ----------------------------------------------------------------------------
1311
1312 SimGrid (3.19) Released March 20 2018
1313
1314  The Moscovitly-cold Spring release.
1315
1316  SMPI user-visible improvements:
1317  - Support of MPI_Type_create_subarray
1318  - Unimplemented MPI calls now abort (instead of issuing a warning)
1319    Some harmless calls around errhandlers still only issue a warning.
1320  - MPI_Sendrecv was behaving badly when MPI_PROC_NULL was sender or receiver.
1321  - Starting MPI ranks (or even MSG/S4U actors) once the simulation started
1322    is now possible (mmap privatization was refactored to this end).
1323    Adding new SMPI instances should also be technically doable now.
1324
1325  SMPI internal cleanups:
1326  - Removed index notion from SMPI -- no more "getPid() - 1"!
1327    In tracing files, actors are called rank-<PROCESS-ID> but these are
1328    NOT the real ranks (tracing several communicators is not supported yet).
1329  - Deprecate smpi_process_index() (will be removed in 3.22)
1330  - Better testing on classical proxy apps, through an external project:
1331    https://github.com/simgrid/SMPI-proxy-apps/
1332
1333  Documentation
1334  - Use a graphical TOC to make it easier to find the documentation you need
1335  - Revamp the MSG tutorial
1336
1337  MSG
1338  - Fix MSG_task_get_remaining_work_ratio(): return 1.0 for unstarted tasks.
1339  - Remove parameter of MSG_process_killall().
1340    Resetting the PID was bogus anyway (several actors could have the same PID).
1341
1342  S4U
1343  - Execution->setHost() can be called after start(), to migrate it.
1344  - Comm::test_any() is now implemented.
1345  - s4u::Actor now has onCreation() and onDestruction() signals.
1346  - Install some kernel header files for the users' plugins and more.
1347    Warning, their API is really not stable yet.
1348     include/simgrid/kernel/resource/{Action,Resource,Model}.hpp
1349     include/simgrid/kernel/routing/*Zone.hpp
1350
1351  SimDag
1352  - SD_task_dependency_add(): remove unused parameters 'name' and 'data'.
1353
1354  Build System and other cleanups:
1355  - Remove unused run-time parameter "tracing/onelink-only".
1356  - SimGrid now works with intel compilers (MC still buggy)
1357  - Remove XBT_LOG_CONNECT, it should be useless nowadays.
1358  - tesh kills subprocesses on timeout (but not on windows)
1359
1360  PLATFORM:
1361  - Rename FULLDUPLEX into SPLITDUPLEX (old name still accepted)
1362
1363  Fixed bugs:
1364  - #194: Feature request: simgrid::s4u::Comm::test_any()
1365  - #245: migrating an actor does not migrate its execution
1366  - #253: Feature Request: expose clusters as objects
1367  - #254: Something seems wrong with s4u::Actor::kill(aid_t)
1368  - #255: Tesh broken on Windows
1369  - #256: Modernize FindSimGrid.cmake
1370  - #257: Fix (ab)use of CMake install
1371
1372 ----------------------------------------------------------------------------
1373
1374 SimGrid (3.18) Released December 24 2017
1375
1376  The "Ho Ho Ho! SimGrid 4 beta is coming to town" release.
1377
1378  MSG IS NOW DEPRECATED. Please use S4U for new projects.
1379  - Support for MSG should not be removed from SimGrid before 2020,
1380    but future evolutions will be limited to the integration of
1381    user-provided patches.
1382
1383  S4U New features
1384  - s4u::onDeadlock() signal, run before stopping the simulation.
1385  - s4u::Exec: asynchronous executions (abstraction of background
1386    threads)
1387  - s4u::Host->getLoad() returns the achieved speed in flops/s
1388
1389  S4U API changes
1390  - Link::name() is deprecated and will be removed in v3.21, use
1391    Link::getCname() instead.
1392  - Mailbox::getName() changed to return a std::string, use
1393    Mailbox::getCname() instead to get a char*.
1394  - Storage::getName() changed to return a std::string, use
1395    Storage::getCname() instead to get a char*.
1396  - s4u::allStorages() becomes s4u::getStorageList(whereTo)
1397    to have both allocation and deallocation of the map in user space.
1398
1399  MSG
1400  - Forbid the use of MSG_task_get_flops_amount() on parallel tasks:
1401    The amount of flops remaining to do is a vector, not a scalar.
1402  - Introduce MSG_task_get_remaining_work_ratio(), which does what its
1403    name implies on both sequential and parallel tasks.
1404  - Both changes fix GitHub's #223 using PR #237 as a basis.
1405    Thanks Michael Mercier.
1406  - Most examples were converted to S4U and hidden elsewhere at tests.
1407    Rationale: we still want MSG to work; we want newcomers to use S4U.
1408
1409  SURF
1410  - LMM stuff moved to its own namespace: simgrid::kernel::lmm.
1411  - Renamed LMM classes (e.g. s_lmm_system_t -> System).
1412
1413  SMPI
1414  - Switch to the faster dlopen privatization mechanism by default
1415  - Documentation improvments
1416
1417  Virtual Machines
1418  - Live migration is getting moved to a plugin. Dirty page tracking is
1419    the first part of this plugin. This imply that VM migration is now
1420    only possible if one this function is called:
1421     - C/MSG: MSG_vm_live_migration_plugin_init()
1422     - C/C++: sg_vm_live_migration_plugin_init()
1423     - Java:  Msg.liveMigrationInit()
1424    For C and C++, "simgrid/plugins/live_migration.h" also has to be
1425    included.
1426
1427  XBT
1428  - Define class simgrid::xbt::Path to manage file names.
1429  - Removed unused functions:
1430    - xbt/file.h: xbt_basename(), xbt_dirname(), xbt_getline()
1431    - xbt/graph.h: xbt_graph_edge_get_length(), xbt_graph_edge_set_length,
1432        xbt_graph_export_graphviz()
1433    - xbt/str.h: xbt_str_join()
1434  - Remove unused datatypes:
1435    - xbt/heap.h: use std::priority_queue or boost::heap instead
1436    - xbt/swag.h: use boost::intrusive::list instead
1437
1438  PLUGINS:
1439  - New link_energy plugin for the consumption of the links.
1440  - All of the operations on files and storage contents have been
1441    packaged into a plugin (src/plugins/file_system). The current
1442    public interface can be found in
1443    include/simgrid/plugins/file_system.h
1444    To use these functions you now have to initialize the plugin by
1445    calling MSG_storage_file_system_init() just after calling
1446    MSG_init() or sg_storage_file_system_init() just after creating
1447    the Engine.
1448
1449  XML
1450  - Remove the undocumented/untested tag <include>
1451
1452  TRACE
1453  - Remove viva specific tracing as the tool is no longer maintained
1454
1455  Fixed bugs:
1456  - #248: Kill of finished processes leads to segfault
1457  - #240: xbt_cond_wait_timeout should gracefully return for C apps
1458  - #239: please implement signal s4u::onDeadlock()
1459  - #230: segfaults when exit() without run()
1460  - #225: s4u::Actor::kill() doesn not really kill victims in a join()
1461  - #223: MSG_task_get_flops_amount() not working with parallel tasks
1462  - #222: Actor::kill() doesn't really kill and segfaults
1463  - #221: odd LMM warning when killing an actor
1464  - #120: Memory leak when the processes are forcefully killed
1465
1466 ----------------------------------------------------------------------------
1467
1468 SimGrid (3.17) Released October 8 2017
1469
1470  The Drained Leaks release: (almost) no known leaks despite the tests.
1471
1472  Even very long simulations will preserve your memory: our testsuite
1473  stresses SimGrid for over 45mn on fast machines for a coverage of
1474  over 80%, and there is only one single known leak, of about 4kb.
1475
1476
1477  S4U
1478   - Comm.detach(): start and forget about asynchronous emission. A cleanup
1479     handler may be given to free resources if the comm cannot be completed.
1480   - this_actor::send(mailbox) is now mailbox->put()
1481   - New: simgrid::s4u::Comm::wait_all()
1482   - New: Host.execute() for remote executions.
1483
1484  SURF
1485   - Unused option network/sender-gap is removed.
1486
1487  MSG
1488   - Deprecate MSG_task_isend_with_matching(): This unused feature
1489     really complicates our internals. Will be removed in v3.20.
1490
1491  Simix
1492   - Improved context termination.  It is now possible to free resources, even
1493     when a process is forcibly killed.
1494   - ContextBoost: add support for Boost versions above 1.61.
1495
1496  XBT
1497  - Bring back run-time option --cfg=exception/cutpath to remove exception
1498    backtraces.
1499  - Removed unused functions:
1500    - xbt/str.h: xbt_str_split_str(), xbt_str_subst(), xbt_str_ltrim(),
1501        xbt_str_rtrim(), xbt_str_trim().
1502    - xbt/xbt_os_thread.h: xbt_os_thread_cancel(), xbt_os_thread_detach().
1503
1504  Misc
1505  - Removed header files obsolete since SimGrid 3.12:
1506    msg/datatypes.h, msg/msg.h, simdag/datatypes.h, simdag/simdag.h.
1507  - Fix many bugs:
1508    - #3: SD_exit should be made optional
1509    - #120: Memory leak when the processes are forcefully killed
1510    - #159: Threading test regression in Actor refcounting
1511    - #170: simgrid::s4u::Comm::wait_any() returns too many comms
1512    - #185: simgrid::s4u::Engine::instance()->shutdown() segfaults
1513    - #186: Actor::killAll() segfaults if some process is blocked on wait()
1514    - #191: VM migration and pstate
1515    - #192: Updating the energy consumptions of all hosts crashes with VMs
1516    - #195: All actors have PID=0 in the logs
1517    - #204: Sometimes segfault with thread contexts and mmap privatization
1518    - #222: Actor::kill() doesn't really kill and segfaults
1519    - #225: Actor::kill() doesn't really kill when victims are doing a join()
1520
1521 ----------------------------------------------------------------------------
1522
1523 SimGrid (3.16) Released June 22. 2017.
1524
1525  The Blooming Spring Release: developments are budding.
1526
1527  Portability status:
1528   - FreeBSD: Disable SMPI mmap privatization, switch automatically to dlopen.
1529   - Mac, BSD: dlopen+thread broken, switch automatically to raw contexts.
1530   - Java JAR file should be finally fully working on Mac OSX too.
1531
1532  XML platforms: Switch to platform v4.1 format.
1533  * This is (mainly) a backward compatible change: v4 are valid v4.1 files
1534    - <zone> can be used as a synonym for the now deprecated <as>
1535    - <zoneRoute> can be used as a synonym for the now deprecated <asroute>
1536    - <bypassZoneRoute> can be used as a synonym for the now deprecated <bypassAsRoute>
1537    - <actor> can be used as a synonym for the now deprecated <process>
1538    - state_file and avail_file periodicity is now easier to express
1539      (check the documentation) the old behavior should still work.
1540  * Storage: not backward compatible, but it seems that nobody ever used it
1541    - Remove attribute 'content_type' of <storage_type>: was never used
1542    - Make attribute 'model' of <storage_type> optional: for future usage
1543    - Remove Bconnection model property: was never (in)validated. Replaced by
1544       the maximum of the read and write bandwidth as a resource constraint.
1545
1546  SimDag
1547   - New and Backwards Compatibility break:
1548     SD_simulate_with_update (double how_long, xbt_dynar_t changed_tasks_dynar)
1549     When one wants to get the list of tasks whose states have changed during a
1550     simulation round, s/he has to allocate and free a dynar and use it as
1551     argument to this function. The former SD_simulate (double how_long)
1552     now returns void.
1553
1554  Virtual Machines
1555   - Allow multicore VMs, with the correct sharing (unless you overcommit)
1556     BUG: vCPU overcommitting still leads to buggy sharing, though. WIP.
1557
1558  Energy
1559   - New function to update the consumption of all hosts at once.
1560   - Fix the model for multi-core hosts, linear in the amount of busy
1561     cores with an abnormality for pIdle (see paper).
1562     BUG: Still not satisfactory for ptask on mono-cores.
1563
1564  MSG
1565   - The netzone are now available from the MSG API.
1566     The old names still work, but are now deprecated.
1567
1568  SMPI
1569   - New algorithm to privatize globals: dlopen, with dynamic loading tricks
1570   - New option: smpi/keep-temps to not cleanup temp files
1571   - New option: smpi/shared-malloc-blocksize . Relevant only when global shared
1572     mallocs mode is used, allows to change the size of the fake file used
1573     (default 1MB), to potentially limit the number of mappings for large runs.
1574   - Support for sparse privatized malloc with SMPI_PARTIAL_SHARED_MALLOC()
1575   - Fortran ifort and flang compilers support
1576   - New RMA calls supported (experimental):
1577       - MPI_Win_allocate, MPI_Win_create_dynamic, MPI_Win_attach
1578       - MPI_Win_detach, MPI_Win_set_info, MPI_Win_get_info
1579       - MPI_Win_lock_all, MPI_Win_unlock_all, MPI_Win_flush
1580       - MPI_Win_flush_local, MPI_Win_flush_all, MPI_Win_flush_local_all
1581       - MPI_Op_commutative, MPI_Fetch_and_Op, MPI_Compare_and_swap
1582       - MPI_Rput, MPI_Rget, MPI_Raccumulate, MPI_Rget_accumulate
1583
1584  S4U
1585   - New: this_actor::isMaestro() returns whether we are in kernel mode.
1586   - Behind the scene, ActivityImpl are now automatically refcounted.
1587     Removing this nasty bottleneck will greatly simplify our internals.
1588
1589  XBT
1590   - Replay: New function xbt_replay_action_get():
1591     Retrieve the function previously associated to an event type.
1592   - DROPPED FUNCTION: xbt_str_varsubst()
1593   - DROPPED MODULE: strbuff. We don't need it anymore.
1594   - DROPPED MODULE: matrix. We don't need it anymore.
1595   - DROPPED MODULE: lib. We don't need it anymore.
1596
1597  -- Thu Jun 22 22:48:12 CEST 2017   -- Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
1598
1599 SimGrid (3.15) Released March 22. 2017
1600
1601  The Spring Release: continuous integration servers become green
1602  We fixed even the transient bugs on all target architectures:
1603    Linux (CentOS, Debian, Ubuntu, Fedora), Mac OSX (Mavericks, El Capitan)
1604    Windows, FreeBSD, NetBSD.
1605
1606  - Rename NetCards to NetPoints.
1607    This was intended to help NS3 users, but that's not a netcard.
1608    That's a point in the routing algorithm, let's avoid wrong simplifications.
1609
1610  MSG
1611  - New: MSG_process_yield(). Stop and yield to other processes.
1612  - New: MSG_process_daemon(). Daemon processes are automatically killed
1613    when the last non-daemon process terminates
1614  - New: MSG_process_ref/unref(). Fiddle with the process refcounting.
1615  - Renamed MSG_energy_plugin_init() -> MSG_host_energy_plugin_init()
1616    to make room for the upcoming network energy plugin.
1617  - Drop MSG_host_get_current_power_peak: duplicates MSG_host_get_speed
1618
1619  Java
1620  - Ensure that an actor can kill itself with Process::exit()
1621  - Kill the obscure NativeException. Nobody want to survive the issues
1622    it denotes, so use JniException that is a RuntimeException (not to
1623    be caught explicitly).
1624  - Partial bug fix in initialization. SimGrid flags on command line were
1625    consumed at C level but stayed in the original Java String[] args.
1626    This could mess users' args[i] if SG flags were not put at the end of
1627    the command line.
1628    The SimGrid flags are now removed from the Java arguments. However,
1629    the number of arguments REMAINS UNCHANGED. It is then UNSAFE to test
1630    if args.length is greater than the number of YOUR OWN ARGUMENTS.
1631    It might be if you have --log or --cfg flags in the command line.
1632  - Fix numerous memleaks all around the place. In particular, around VMs.
1633
1634  S4U
1635  - New callbacks:
1636    - s4u::onPlatformCreated: right before the simulation starts
1637    - s4u::onSimulationEnd: right after the main simulation loop
1638    - s4u::onTimeAdvance: right after a clock change (time is discrete)
1639    - s4u::Host::onSpeedChange: when the pstate is changed, or when an
1640      event from the availability_file changes the avail speed.
1641  - Links are now usable from s4u
1642  - New: Engine::hostList() and Engine::hostCount(). Still clumsy.
1643  - New: Actor::suspend(), Actor::resume(), and Actor::migrate(new_host)
1644  - New examples: The conversion of MSG examples to S4U has begun
1645     - Actors: create, kill, migration, and suspend
1646     - Applications: master-worker and token-ring
1647     - Action replay: communications and storage
1648  - Drop Host::getPstateSpeedCurrent() which duplicates Host::speed()
1649
1650  SimDag
1651  - Backwards Compatibility breaks
1652     - The SD_route_get_list and SD_route_get_size functions have been removed.
1653       They are replaced by the unique
1654          void sg_host_route(sg_host_t src, sg_host_t dst, xbt_dynar_t links)
1655       The route from src to dst is built in the links dynar whose size can
1656       be obtained with xbt_dynar_length.
1657     - The SD_route_bandwidth and SD_route_latency functions have been replaced by
1658         sg_host_route_bandwidth and sg_host_route_latency.
1659       Macros ensure the backwards compatibility, but you should fix your code
1660
1661  SMPI
1662  - Major C++ rewrite ongoing (SMPI used to be C compiled in C++).
1663    This can break codes using SMPI internals (from private.h instead of the public smpi.h).
1664  - Bump our claim of support from MPI 1.1 to MPI 2.2.
1665    We don't support 100% of it, but it should be enough. Contact us if not.
1666  - MPI_Win_lock/unlock, MPI_Get_accumulate support added (as for all RMA, implementation is
1667    naive and probably inaccurate)
1668  - New algorithm for SMPI_SHARED_MALLOC: global, where all blocks are
1669    mapped onto a unique small file using some system magic.
1670  - Bugfix: smpirun was sometimes misusing hostfile when wrongly terminated
1671  - Fortran: cleanups, fixes, support of user-added operations
1672  - RMA: MPI_Accumulate are applied in correct order.
1673  - RMA:  MPI_Win_{complete/post} shouldn't miss messages anymore.
1674  - Better support for MPI_IN_PLACE
1675  - Support for MPI_Win attrs and keyvals.
1676  - Support MPI_Comm_group_create, MPI_Type_size_x
1677  - MPI ops should be properly applied to all allowed types
1678  - Replace implementation of MPI_Bcast "scatter followed by rdb allgather"
1679    algorithm by a non failing one from mpich.
1680
1681  XBT
1682  - Kill the fifo data container: we don't use it anymore.
1683
1684  XML
1685  - A <cluster> can now be created with different speed values to represent pstates.
1686    see examples/platforms/energy_cluster.xml for an example.
1687
1688 SimGrid (3.14.159) Released December 28. 2016
1689
1690  The previous release was only a crude approximation of a Pi release;
1691  this one should be a bit better.
1692
1693  - Revert a last minute change that broke on Mac OSX.
1694  - Fix the changelog and NEWS files.
1695  - Improve the documentation, in particular of the routing module.
1696  - Integrate some patches flying around in Debian.
1697
1698 SimGrid (3.14) Released December 24. 2016
1699
1700  Documentation
1701  * The whole documentation was reworked and reorganized. There is
1702    still much room for improvement here, but we're on it.
1703
1704  Infrastructure
1705  * We now need python3 for our testing infrastructure.
1706  * Model checking needs libevent
1707
1708  MC
1709  * Now works on FreeBSD
1710
1711  SMPI
1712  * Privatization now works on FreeBSD
1713
1714  * Privatization is now activated by default in smpirun
1715    You can turn it off with -no-privatize if something goes wrong.
1716
1717  * Call-location tracing for SMPI.
1718    You can add the exact location (filename / linenumber) of an MPI call to
1719    your trace files and slow down or speed up the simulation between two
1720    consecutive calls by using an adjustment file (see the documentation).
1721
1722  * Fixed computation of timings for MPI_Send, MPI_Recv & possibly also others
1723    We've found a bug that prevented SMPI to account for MPI_Send, MPI_Recv
1724    and others (in some cases) in a correct way. That is, the smpi/os, smpi/or
1725    values were ignored in some cases. The timings of these functions can now
1726    be significantly different.
1727
1728  * smpi/cpu-threshold:-1 should become smpi/simulate-computation:no
1729    smpi/running-power    is renamed to smpi/host-speed
1730
1731  * smpi/grow-injected-times option to enable or disable multiplication of the
1732    timings injected in MPI_Iprobe, or MPI_Test. Enabled by default, which can
1733    make simulation less precise (but also much faster).
1734
1735  * smpirun script should be (much) faster for large deployments.
1736
1737  * SMPI tracing: fixed issue with poor matching of send/receives.
1738
1739  * Replay: Fix broken waitall
1740
1741  New functions and features
1742  * MSG_parallel_task_execute_with_timeout, to timeout computations.
1743
1744  Dropped / renamed functions and features
1745  * msg_mailbox_t and associated functions. Use s4u::Mailbox instead.
1746    - MSG_mailbox_is_empty() -> Mailbox::empty()
1747    - MSG_mailbox_front() -> Mailbox::front()
1748    - MSG_mailbox_get_by_alias() -> simgrid::s4u::Mailbox::byName(name)
1749    - MSG_mailbox_get_task_ext() -> MSG_task_receive_ext()
1750    - MSG_mailbox_get_task_ext_bounded -> MSG_task_receive_ext_bounded
1751    - MSG_host_(get/set)_params -> MSG_vm_(get/set)_params
1752  * Don't pass the free_f parameter to property related functions:
1753    - MSG_host_set_property_value()
1754    - MSG_as_router_set_property_value()
1755    - MSG_storage_set_property_value()
1756  * VM properties. Since msg_vm_t are msg_host_t, just use
1757    MSG_host_get_property_value() and friends
1758  * VM I/O related things:
1759    - Ignored parameter of vm_create: core_nb, disk_path and disk_size.
1760    - Unimplemented save/restore methods
1761  * MSG_as_router_get_property_value() was redundant with
1762    MSG_environment_as_get_property_value().
1763    - Removed MSG_as_router_*propert*() functions
1764    - Added MSG_environment_as_set_property_value() for consistency
1765  * xbt heterogeneous dictionaries (created with xbt_dict_new()).
1766    Well, they are still there for now, but deprecated with a warning.
1767    Please switch to xbt_dict_new_homogeneous() before this is removed
1768    for real.
1769  * Task affinity. Its intended behavior (that was very badly tested
1770    and probably not really working) was deceiving what most users
1771    would have hoped here.
1772  * xbt_os_sem_get_value: unused internally, deprecated on OS X El Capitan
1773  * Option network/coordinates is now useless and should be dropped.
1774
1775  Storage:
1776  * Added option storage/max_file_descriptors to allow more than 1024 files opened
1777
1778  SURF:
1779  * Added option maxmin/concurrency_limit to allow more than 100 processes per host
1780  * Added Dragonfly topology support
1781
1782  XML:
1783  * Add Exa- and Peta- units such as EiB, EB, Eib, Eb for size, and
1784    EiBps, EBps, Eibps, Ebps for bandwidth.
1785    They may become useful to some lucky ones.
1786
1787  Java:
1788  * New functions: msg.Comm.waitAll() and msg.Comm.waitAny()
1789  * ex/app_tokenring: new example, very similar to the MSG Token Ring
1790  * ex/async_waitAll: new example, on asynchronous communications
1791
1792  MSG:
1793  * Memory usage should be decreased for simulations with a large number
1794    of processes. This also helps for SMPI.
1795
1796 SimGrid (3.13) stable; urgency=low
1797
1798  The Half Release, a.k.a. the Zealous Easter Trim.
1799
1800  - We removed half of the lines, that were mostly experimental cruft.
1801    v3.12 lasted 286000 lines of code, v3.13 is only 142000 lines
1802    (not counting blanks and comments -- according to openhub.net)
1803  - The internals are now compiled in C++ (and will soon be clean C++)
1804  - We removed 75 klines of XML, 12 klines of Java, 5 klines of cmake,
1805    59 klines of C, etc. We added only 29 klines of C++ in replacement.
1806
1807  * Backwards Compatibility breaks
1808    - Removed Lua simulation bindings (switch to C or Java for that).
1809      Lua can still be used to describe platforms
1810    - Removed Java kernel plug-ins.
1811      Will be reintroduced after the ongoing major internals reorg.
1812    - In MSG
1813       - the following functions were removed.
1814         They were too specific and should be reimplemented in a generic
1815         way, with filter function.
1816           - MSG_task_listen_from_host
1817           - MSG_mailbox_get_count_host_waiting_tasks
1818           - MSG_mailbox_put_with_timeout was removed.
1819             Please use MSG_task_send_with_timeout instead.
1820    - In SimDag
1821       - the SD_application_reinit function was removed. It has been a noop for a while.
1822       - The ACCESS_MODE of SD_workstation has been removed. This feature was not really usable and should soon be
1823         replaced by a more flexible mechanism.
1824       - The following functions thus do not exist anymore
1825          - SD_workstation_get_access_mode
1826          - SD_workstation_set_access_mode
1827          - SD_workstation_get_current_task
1828       - Basic estimation functions have been removed but can easily be replaced
1829         - SD_route_get_communication_time => SG_route_get_latency() + amount / SD_route_get_bandwidth()
1830         - SD_workstation_get_computation_time => amount / sg_host_speed()
1831    - In Java
1832       - VM.setBound(int load) is now VM.setBound(double bound) to meet the MSG semantics.
1833         Use VM.getSpeed()*load/100 for the legacy behavior.
1834    - In CMake
1835       - option enable_tracing was removed. It was not doing anything for a while.
1836    - In the ModelChecker:
1837       - the model-checker now ptraces the model-checked process which means
1838         you cannot use a debugger on the latter anymore (we might make this
1839         optional in the feature);
1840       - removed soft-dirty page tracking;
1841       - remove model-checked side snapshot management,
1842         MC_snapshot() and MC_compare_snapshot();
1843       - keep the MC_cut() function as a stub (it was not really working
1844         in the previous release).
1845
1846  Options:
1847  * All options are consistently in kebab-case. Old names are kept as alias.
1848
1849  XML platforms:
1850  * Switch to platform v4 format.
1851    - Rename from 'power' to 'speed' the attributes describing the amount of
1852      flops that a <host>, <peer>, <cluster> or <cabinet> can deliver per second.
1853    - In <trace_connect>, attribute kind="POWER" is now kind="SPEED".
1854    - In <host> and <link>, attributes availability and state are gone.
1855      It was redundant with state and availability traces, and with peak values.
1856    - In <cluster>, attributes availability_file and state_file are gone.
1857      It was too complex and unused.
1858    - Kill <gpu>. Was not doing anything.
1859    - The DOCTYPE points to the right URL:
1860      http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd
1861      (the file at this address now documents the changelog since its v1)
1862    - A warning is emitted for unit-less values (they are still accepted).
1863      - speed. Default: 'f' or 'flops'. Also defined:
1864         'Yf',         'Zf',         'Ef',       'Pf',        'Tf',        'Gf',        'Mf',        'kf'
1865         'yottaflops', 'zettaflops', 'exaflops', 'petaflops', 'teraflops', 'gigaflops', 'megaflops', 'kiloflops'
1866      - bandwidth. Default: 'Bps' bytes per second (or 'bps' for bits but 1 Bps = 8 bps)
1867        Also defined in bytes: 'TiBps', 'GiBps', 'MiBps', 'KiBps', 'TBps', 'GBps', 'MBps', 'kBps', 'Bps'
1868        And the same in bits:  'Tibps', 'Gibps', 'Mibps', 'Kibps', 'Tbps', 'Gbps', 'Mbps', 'kbps', 'bps'
1869      - latency. Default: 's' second. Also defined:
1870        'w' week, 'd' day, 'h' hour, 'm' minute, 'ms' millisecond, 'us' microsecond, 'ns' nanosecond, 'ps' picosecond
1871
1872  * bin/simgrid_update_xml can upgrade your files automatically (won't convert unit-less values)
1873    tools/sg_xml_unit_converter.py may help (but it's just a warning and will probably ever be).
1874
1875  S4U
1876  * s4u::Host is now the preferred public interface to the Host features.
1877    sg_host_* functions are C bindings to the exact same behavior
1878    MSG_host_* and SD_workstation_* are #define to the sg_host_* ones
1879
1880  MSG
1881  * The examples were completely reorganized (in C and Java), for your browsing pleasure.
1882  * Kill all deprecated functions (the ones you had when declaring MSG_DEPRECATED).
1883    They were deprecated since a few years, and probably did not even compile anymore.
1884
1885  SimDag
1886  * The API has been profoundly modified to directly use the core objects instead of redefining its own.
1887    SD_Workstation_t and SD_link_t are now sg_host_t and sg_link_t respectively.
1888    Some functions have also been renamed for consistency. Backward compatibility is maintained, but users are
1889    encouraged to update their codes. A list of the modified functions can be found at the end of
1890    include/simgrid/simdag.h
1891
1892  Simix
1893  * simgrid::simix::kernelImmediate() is the closure callback. It ensures that
1894     the lambda or closure passed as a parameter will run in kernel mode.
1895    All the callback functions should be rewritten to that interface at some point.
1896
1897  Surf
1898  * Reorganizing and cleaning the internals all around the place.
1899
1900  SMPI
1901  * Remove old default barrier/bcast buggy algorithms (see #18407)
1902  * Various bug fixes to handle more codes
1903  * Remove the need for the --foreground option of smpirun (it is still
1904    accepted for backward compatibility).
1905
1906  XBT
1907  * Kill the setset data container: MC don't use it anymore.
1908  * Kill the queue data container: it made more sense with GRAS.
1909  * Kill the xbt_peer_t data type: it's useless without GRAS.
1910  * Kill rm_cb feature of config sets: it was never useful.
1911  * Kill graphxml parsing feature. It was not used.
1912  * Kill the deprecated code protected by XBT_USE_DEPRECATED
1913  * New functions:
1914    - xbt_dynar_sort_strings(), when the content is char*
1915    - xbt_str_parse_int / xbt_str_parse_double, wrapping strtol/strtod
1916      They throw exceptions on invalid input;
1917  * C++ support for declaring CLI flags (simgrid::config::Flag);
1918  * class for abstracting different signal backends (simgrid::xbt::signal).
1919    with no external dependencies (we need very simple signals).
1920
1921  MC
1922  * refactoring and cleanup of the code;
1923  * ongoing process to cleanly separate the model-checking algorithms
1924    from the code model-checking support.
1925
1926  -- Wed Apr 27 21:00:53 CEST 2016 Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
1927
1928 SimGrid (3.12) stable; urgency=low
1929
1930  The Facelift Release.
1931
1932  Build System
1933   * Require g++ v4.7 at least to not speak prehistorical C++.
1934   * Require Boost 1.48 (for signal2 component).
1935   * Java must be version 7 at least when activated.
1936   * Builds on Windows again (including Java bindings).
1937   * Tracing is now always enabled (no way to turn it out)
1938   * Remove GTNetS. It was not working anyway.
1939   * Various cleanups in the cmake scripts.
1940   * Move headers around to sort them out on installed systems:
1941     - instr/instr.h  -> simgrid/instr.h
1942     - instr/jedule/* -> simgrid/jedule
1943     - simdag/datatypes.h was removed
1944     - simdag/simdag.h -> simgrid/simdag.h
1945     - msg/datatypes.h was removed
1946     - msg/msg.h -> simgrid/msg.h
1947
1948  cMSG:
1949  * Interface improvement:
1950    - Rename MSG_host_is_avail(h) to MSG_host_is_on(h)
1951    - Sanitize the interface in MSG_task_ module:
1952      - Merge two functions that were close enough but misleading:
1953        set_compute_duration(t)      -> set_flops_amount(t)
1954        get_remaining_computation(t) -> get_flops_amount(t)
1955      - set_data_size(t) -> set_bytes_amount(t)
1956        get_data_size(t) -> get_bytes_amount(t)
1957    - Massive cleanups in the functions related to the energy
1958      - MSG_host_get_pstate_number() -> MSG_host_get_nb_pstates()
1959    - New: MSG_host_get_pstate()
1960  * New example:
1961    - msg/energy/onoff: switching hosts on and off
1962  jMSG:
1963  * Interface improvement:
1964    - Rename Host.isAvail() to Host.isOn()
1965    - Rename Process.currentProcess() to Process.getCurrentProcess()
1966    - Rename Task.setDataSize() to Task.setBytesAmount()
1967    - Merge Task.getRemainingDuration() and Task.getComputeDuration() into Task.getFlopsAmount()
1968  * Bug fixes:
1969    - #18874: Actually allows the GC to reclaim tasks
1970
1971  SIMIX:
1972  * New functions
1973    - SIMIX_process_throw: raises an exception in a remote process
1974  * Refactoring: Separate sub-modules
1975    - libsmx: the public interface, as libc in a real system
1976    - popping: the strange dance that converts a user request into a kernel handling
1977    - smx_context_*: the virtualization mechanisms that embed the user code
1978    - smx_*: the handling of each simcalls
1979  * Interface cleanup:
1980    - simcall_host_set_power_peak_at -> simcall_host_set_pstate
1981  * Rename smx_action_t into smx_synchro_t, making explicit that these
1982    things are used to synchronize processes with their environment.
1983    For example, a communication is a sort of synchronization involving
1984    the communicating processes (that may block until the exchange) and
1985    the platform. The same can be said from computations, etc.
1986  * Bug fixes:
1987    - #18888: segfault when a process ends before its kill_time
1988
1989  SMPI:
1990  * New functions
1991    - Onesided early support for: MPI_Win_(create, free, fence, get_name, set_name, get_group), MPI_Get, MPI_Put, MPI_Accumulate, MPI_Alloc_mem, MPI_Free_mem.
1992    - MPI_Keyval*, MPI_Attr* functions, as well as MPI_Comm_attr*, MPI_Type_attr* variants (C only, no Fortran support yet)
1993    - MPI_Type_set_name, MPI_Type_get_name
1994    - MPI_*_c2f and MPI_*_f2c functions
1995    - MPI_Info_* functions (beware, get_nthkey may not follow the insertion order)
1996    - MPI_Pack, MPI_Unpack and MPI_Pack_size functions
1997    - Activate a lot of new tests from the mpich 3 testsuite
1998  * Features
1999    - Constant times can be injected inside MPI_Wtime and MPI_Test through options smpi/wtime and smpi/test
2000    - InfiniBand network model added: Based on the works of Jerome Vienne
2001      http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
2002    - When smpi/display_timing is set, also display global simulation time and application times
2003    - Have smpirun, smpicc and friends display the simgrid git hash version on --git-version
2004  * Collective communications
2005    - SMP-aware algorithms are now dynamically handled. An internal communicator is created for each node, and an external one to handle communications between "leaders" of each node
2006    - MVAPICH2 (1.9) collective algorithms selector: normal and SMP algorithms are handled, and selection logic is based on the one used on TACC's Stampede cluster (https://www.tacc.utexas.edu/stampede/).
2007    - Support for Rabenseifner Reduce/Allreduce algorithms (https://fs.hlrs.de/projects/par/mpi//myreduce.html)
2008  * Replay
2009    - Replay now uses algorithms from wanted collective selector
2010    - Replay can be used with SMP-aware algorithms
2011    - Memory occupation of replay should now be contained (temporary buffers allocated in collective algorithms should be shared between processes)
2012    - Replay can now replay several traces at the same time (check examples/smpi/replay_multiple example), to simulate interactions between several applications on a given platform. User can specify the start time of each instance. This should also allow replay + actual applications to run.
2013  * Bug fixes
2014    - [#17799]: have mpi_group_range_incl and mpi_group_range_excl better test some corner cases
2015    - Correctly use loopback on fat-tree clusters
2016    - Asynchronous small messages shouldn't trigger deadlocks anymore
2017  * Energy/DVFS cleanup and improvement
2018    - smpi_set_host_power_peak_at() -> smpi_set_host_pstate()
2019    - new: smpi_get_host_pstate()
2020  SURF
2021   * Bug fixes
2022    - "Full" network optimization flag was broken since Surf++
2023    - Better handling of precision flags in maxmin
2024    - Fix bug causing sometimes "Impossible" errors
2025    - Properly pass cluster properties to included hosts
2026   * Improvement of the Energy plugin.
2027     - Always update the consumption before returning that value
2028     - New property: watt_off to denote the dissipation when the host is off
2029     - New functions getWattMinAt and getWattMaxAt to retrieve the
2030       dissipation of pstates that we are not currently at.
2031   * Java: class NetworkLink renamed to Link
2032   * New function: simcall_process_get_kill_time()
2033   * Massive rename s/workstation/host/
2034     - That's intrusive, but that's good for the project consistency. Sorry.
2035     - Change config option "workstation/model" into "host/model"
2036  XBT
2037   * New functions
2038    - Add a xbt_heap_update function, to avoid costly xbt_heap_remove+xbt_heap_insert use
2039    - Add a xbt wrapper for simcall_mutex_trylock (asked in [#17878])
2040    - Add two new log appenders: rollfile and splitfile. Patch by Fabien Chaix.
2041    - xbt_dirname and xbt_basename for non-POSIX systems
2042  MC
2043   * The model checker now runs as a separate process.
2044   * The model checker runs must now be launched with the new simgrid-mc program.
2045   * Record/Replay: the MC can display a textual representation of a path in the
2046     execution graph. It can then be replayed outside of the model checker.
2047
2048  -- Mon Oct 12 06:02:41 CEST 2015 Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
2049
2050 SimGrid (3.11) stable; urgency=low
2051
2052  The Class Release.
2053
2054  Tools:
2055  * Normalizing pointers addresses tool for better diff between logs
2056
2057  Examples:
2058  * Add cloud examples using new VMs
2059    - examples/msg/cloud/two_tasks_vm.tesh
2060    - examples/msg/cloud/simple_vm.tesh
2061    - examples/java/cloud/cloud.tesh
2062    - examples/java/cloud/migration/migration.tesh
2063  * Add java surf examples:
2064    - examples/java/surfPlugin/surf_plugin.tesh
2065    - examples/java/reservationSurfPlugin/reservation_surf_plugin.tes
2066    - examples/java/surfCpuModel/surf_cpu_model.tesh
2067  * Add SMPI+MSG example:
2068    - examples/smpi/smpi_msg_masterslave/
2069
2070  TeshSuite:
2071  * Add tests:
2072    - msg process test
2073    - msg task destroy cancel test
2074    - msg_host on/off test
2075  * Move all tests in testsuite to teshsuite (adding tesh files)
2076  * Restructure teshsuites
2077    - one folder for each kind of test
2078  * Restructure AddTests.cmake
2079    - unify tests names
2080    - structure the order of tests (with sections)
2081
2082  MSG:
2083  * Add virtual machine
2084    - creation of a VM on a PM
2085    - migration of a VM from a PM to another PM
2086  * New functions
2087    - MSG_process_join(msg_process_t process, double timeout)
2088    - msg_bar_t MSG_barrier_init(unsigned int count)
2089    - int MSG_barrier_wait(msg_bar_t barrier)
2090    - void MSG_barrier_destroy(msg_bar_t barrier)
2091    - msg_as_t MSG_environment_as_get_by_name(const char * name)
2092  * New option "msg/debug_multiple_use" to help debugging when a task is used
2093    several times
2094  * MSG IO
2095    - Improvements and finalization of MSG_storage, MSG_file APIs and their
2096      documentation
2097    - Increase code coverage in test suites
2098    - Bug fixes
2099
2100  SIMIX:
2101  * Protect context stacks against stack overflow. The number of protected memory
2102    pages allocated on the top of each stack (1 by default) can be configured
2103    with the new command line option --cfg=contexts/guard_size:<value>.
2104  * Simcalls are now generated by a python script that
2105    - generates files included by SimGrid
2106    - checks that all the functions exist, and proposes prototypes
2107  * Clean simcalls
2108    - remove sem_destroy, file_set_data, comm_destroy, vm_set_state,
2109      host_set_data, host_get_data
2110  * New simcalls
2111    - simcall_process_join(smx_process_t process, double timeout)
2112  * Fix bug where sleeping processing could not be suspended.
2113
2114  SURF:
2115  * Translate surf models from C to C++
2116    - Generic classes for all models: Model, Resource, Action
2117    - A generic interface for each kind of model (CPU, Network, Storage
2118      Workstation, WorkstationVM)
2119    - C bindings
2120  * Translate surf routings from C to C++
2121  * Add callbacks using sigc++ or boost::signals2
2122    - Add callback functions for resource creation/destruction
2123    - Add callback functions for action state change
2124    - Handle Energy as a plugin
2125  * Replace swag by boost::intrusive
2126  * Add new routing models for clusters. For documentation, see
2127    http://simgrid.gforge.inria.fr/simgrid/latest/doc/platform.html#pf_cluster
2128    - tori, with topology="TORUS" and topo_parameters="ndim1,ndim2,...,ndimn"
2129      parameters for cluster tag
2130    - Fat trees, with topology="FAT_TREE" and
2131      topo_parameters="h;m1,...,mh;w1,...,wh;p1,...,ph" parameters for cluster tag
2132    - see examples/platforms/torus_cluster.xml and
2133      examples/platforms/fat_tree_cluster.xml
2134  * More documentation
2135
2136  SMPI:
2137  * Hostfiles support host:nb_processes construct to deploy several processes on
2138    one node.
2139  * Collective communication algorithms should not crash if used with
2140    improper number of nodes and report the error.
2141  * SMPI now partially supports MPI_Topologies: MPI_Cart_create, MPI_Cart_shift,
2142    MPI_Cart_rank, MPI_Cart_get, MPI_Cart_coords, MPI_Cartdim_get,
2143    MPI_Dims_create, MPI_Cart_sub are supported.
2144  * New interface to use SMPI programmatically (still depends on MSG for
2145    some parts, see examples/smpi/smpi_msg_masterslave):
2146    - SMPI_app_instance_register(const char *name, xbt_main_func_t code,
2147         int num_processes)
2148    - SMPI_init()
2149    - SMPI_finalize();
2150  * Global variables privatization in MPI executables is now performed at runtime
2151    with the option smpi/privatize_global_variables (default:no).
2152    Limitations: Linux/BSD only, with mmap enabled. Global variables inside
2153    dynamic libraries loaded by the application are not privatized (static
2154    linking with these libraries is advised in this case)
2155
2156  Tracing:
2157  * Options defined in XML work correctly now.
2158
2159  Java:
2160  * New cmake option, enable_lib_in_jar, to control whether native libraries are
2161    copied into simgrid.jar or not (ON by default).  Use this option if you want
2162    to reduce the size of the installed simgrid.jar, *and* the native libraries
2163    are kept installed elsewhere.
2164  * Surf binding with SWIG (code generated in maintainer mode only):
2165    - plugin to handle callbacks
2166    - CPU model only for the moment
2167
2168  Build System:
2169  * Supernovae build mode is definitively removed. It was used to improve
2170    inlining and inter-module optimizations. It is nowadays superseded by
2171    link-time optimizations commonly available in compilers.
2172  * Update ns-3 find lib. Bindings for ns-3 should work again now.
2173  * Add boost dependency for surf++
2174  * Add new macro for tests
2175    - ADD_TESH(name <tesh_args>)
2176    - ADD_TESH_FACTORIES(name "thread;ucontext;raw" <tesh_args>)
2177
2178  XBT:
2179  * New functions
2180    - xbt_bar_t XBT_barrier_init(unsigned int count)
2181    - int XBT_barrier_wait(xbt_bar_t barrier)
2182    - void XBT_barrier_destroy(xbt_bar_t barrier)
2183  * Make the xbt_os_time module public
2184
2185  -- Sat May 31 22:39:38 CEST 2014 Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
2186
2187 SimGrid (3.10) stable; urgency=low
2188
2189  The Clean Diaper Release, a.k.a. SimGrid is leak-free.
2190
2191  Java:
2192  * Reintegrate Java to the main archive as desynchronizing these
2193    package is not acceptable anymore (Java is now considered stable)
2194  * Add explicit synchronization facilities through semaphores
2195  * Bug fix: Task.setDataSize() only changed the C world, not the value
2196    cached in the Java world
2197
2198  MSG:
2199  * Dramatically change the way files are handled. API and internals changed, but
2200    this part of MSG was not considered as production grade either.
2201  * Add explicit synchronization facilities through semaphores
2202  * Add a new function MSG_host_get_process_list()
2203  * Preliminary DVFS support (see examples/msg/energy/ for details)
2204
2205  SMPI:
2206  * SMPI is now included directly in the libsimgrid as the windows
2207    linker doesn't force us on splitting it anymore.
2208  * Improvements of the SMPI replay tool:
2209    - Most of the collective communications are now rooted in the same process as
2210      in the original application.
2211    - Traces now rely on the same MPI data type as the application (MPI_BYTE was
2212      used until now). Multiple data types can now be used in a trace.
2213    - The replay tool now supports traces produce either by TAU or a modified
2214      version of MPE.
2215    - Bug Fix: the compute part of the reduce action is now taken into account.
2216    - Gatherv collective is now supported
2217    - SimGrid (SMPI for now) can generate replay traces as well. Option -trace-ti
2218      of smpirun outputs time independent traces for the current run. One file
2219      is created per process. If too many processes are simulated, this behavior
2220      can be changed to one file for all processes by using the
2221      tracing/smpi/format/ti_one_file flag
2222  * smpirun generates the host file if needed (with given host count and platform)
2223  * Integration of more than 100 STAR-MPI, MPICH, OpenMPI collective algorithms
2224    - allows to select one in particular with --cfg=smpi/coll_name:algorithm
2225    - allows to use the decision logic of OpenMPI(1.7) or MPICH(3.0.4) by setting
2226      --cfg=smpi/coll_selector:(mpich/ompi)
2227  * Support for new functions: MPI_Issend, MPI_Ssend, Commutative operations in
2228    Reduce
2229  * Add a --cfg:tracing/smpi/internals option, to trace internal communications
2230    happening inside a collective SMPI call.
2231  * Fix the behavior of complex data types handling.
2232  * Make MPI_Wtime another synchronization point to take computations into
2233    account.
2234  * Replace MPICH-1 test suite by the one from MPICH 3.0.4. Can be built using
2235    enable_smpi_MPICH3_testsuite flag in cmake. Run with ctest.
2236  * Add all missing Fortran bindings, SMPI should work with Fortran 90
2237    (no privatization of global variables yet)
2238  * Preliminary DVFS support (see examples/smpi/energy/ for details)
2239
2240  Model-Checking;
2241  * Verification of liveness properties is now available for SMPI applications
2242    (in addition to MSG applications)
2243  * Bugged examples using SMPI in examples/smpi/mc/
2244  * Add --cfg=model-check/visited option. Allows the verification of infinite
2245    programs. Detection of loops in the execution thanks to the system state
2246    comparison and reduction of the state space to explore. Can be combined with
2247    DPOR for safety properties.
2248
2249  SimDag:
2250  * Allow to change SimGrid configuration (see --help) within the code
2251    thanks to SD_config() as it can be done in MSG.
2252  * Add a new function SD_task_set_amount() upon user request.
2253
2254  PLATFORM:
2255  * Handle units for values (10ms, 10kiloflops, 10Bps, 1GB, ...)
2256  * Remove rule based routing (no more PCRE dependency)
2257  * Add a limiter_link option to cluster tag, to specify a maximum reachable
2258    bandwidth in fullduplex mode when it is less than twice the nominal bandwidth.
2259  * Add a loopback_bw and loopback_lat options to cluster tag.
2260  * Fix the peer tag that could not be mixed with other AS within a Vivaldi
2261    routing. Now peers are encapsulated in an AS and have their own private
2262    router but this is transparent.
2263
2264  XBT:
2265  * Our own implementation of getline is renamed xbt_getline, and gets
2266    used even if the OS provide a getline(). This should reduce the
2267    configuration complexity by using the same code on all platforms.
2268  * New type: xbt_cfg_elm_boolean.
2269  * Allow to use yes/no for boolean configuration options in the command line.
2270  * Allow to disable SimGrid cleanups at exit from command line option.
2271    There are situations where one may want a simulation to end with an exit.
2272    Unfortunately, calling exit may cause SimGrid to segfault, which is quite
2273    annoying when scripting around the simulator. Adding a
2274    --cfg=clean_atexit:no allows to circumvent this issue.
2275
2276  Build System:
2277  * Lots of memory leaks were corrected in this release.
2278    There is no known memory leaks anymore, in all of our 600+ tests.
2279  * New command line option --version, to get SimGrid version information.
2280    Packagers may want to add extra words to SIMGRID_VERSION_EXTRA defined in
2281    CMakeLists.txt.
2282  * Supernovae builds are deprecated, and expected to be removed in the next
2283    version of SimGrid.
2284
2285  -- Sun Nov 17 00:26:44 CET 2013 Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
2286
2287 SimGrid (3.9) stable; urgency=low
2288
2289  The Grasgory release: GRAS is really dead now.
2290
2291  * Complete overhaul of the internal host structures scheme.
2292
2293  GRAS:
2294  * If you use GRAS, you should stay at SimGrid 3.5 (at most) since it
2295    was considered as experimental and badly maintained since then.
2296  * Keeping it was thus a trap to our potential users, that could take
2297    it instead of MSG or SMPI by mistake despite is pity state.
2298  * GRAS seems to have very few users (if any), and no one volunteered
2299    to maintain it further. It also induces a lot of XBT code (for
2300    portability sake), that must be maintained too.
2301  * For all these reasons, we killed GRAS. If someone wants to revive it
2302    in the future, don't cry, our git history still remembers of GRAS.
2303
2304  Documentation:
2305  * Major overhaul. Merge our documentation again as time proved that
2306    splitting it was really not helping our users.
2307  * Further improve the developer documentation to help newcomers
2308    hacking on SimGrid itself. The user documentation (and in
2309    particular, the beginner documentation) is still in a sorry state.
2310
2311  SMPI:
2312  * Now works on Windows too!
2313  * Much more extensive test suite, from MPICH
2314
2315  SIMDAG:
2316  * Add a new loader (SD_PTG_dotload) that creates a parallel task graph
2317   (i.e., a DAG whose nodes are parallel tasks) from a dot file. Creates a
2318   dynar of SD_TASK_COMP_PAR_AMDAHL and SD_TASK_COMM_MXN_1D_BLOCK tasks.
2319  * Bug fix: let task be scheduled when the last dependency to be solved is
2320    a control dependency.
2321  * Remove SD_load_environment_script function.
2322    Use the C sg_platf function if you want to declare a platform
2323    programmatically.
2324
2325  MSG:
2326  * New function: MSG_process_get_number()
2327  * Old function documented: MSG_config()
2328  * Remove MSG_load_platform_script function
2329    Use the C sg_platf function if you want to declare a platform
2330    programmatically.
2331
2332  SURF:
2333  * Change the default value of the TCP_gamma constant (maximal size of TCP
2334    congestion window) to a more realistic 4MiB value. If you notice changes in
2335    your simulation results, you can fall back to the previous 20k tiny window
2336    by adding --cfg=network/TCP_gamma:20000 on command line.
2337  * (Hopefully) fix a bug wrt periodic availability and state traces
2338  * Bug fix: use default values at start when first event in availability/state
2339    trace is not at time 0.
2340
2341  PLATFORM:
2342  * remove the "new_" part of function name sg_platf_new_trace_connect
2343    (resulting in sg_platf_trace_connect), since it does not create
2344    anything new
2345
2346  XBT:
2347  * Kill synchronized dynars, and xbt_dynar_dopar(). We cannot think of a
2348    use case where it's really mandatory, and maintaining it was a pain in
2349    our code base.
2350  * New: xbt_fifo_search(), search an item with a user-provided
2351    comparison function instead of dumb pointer comparison.
2352
2353  LUA:
2354  * Fix the lua deployment:
2355    Use `simgrid.init_application()` before deployment instead of
2356    `simgrid.msg_register_application()` after.
2357
2358  TRACING:
2359  * Transfer the tracing files into the corresponding modules.
2360
2361  -- Tue Feb  5 11:31:43 CET 2013 Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
2362
2363 SimGrid (3.8.1) stable; urgency=low
2364
2365  The "we are told that some people want to also *install* the simgrid
2366  framework" release.
2367
2368  * Add missing file "tesh.1" to the archive.
2369
2370  -- Sat Oct 27 16:12:11 CEST 2012 Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
2371
2372 SimGrid (3.8) stable; urgency=low
2373
2374  The Psssshiiiit release: SimGrid jumps into the Cloud.
2375
2376  MSG:
2377  * Add an experimental interface to manipulate VMs. They are mainly
2378    process groups with very few intrinsic semantic, but they should
2379    allow you to build the semantic you want easily.
2380  * New function: MSG_host_set_property_value()
2381  * New function: MSG_process_on_exit(). To clean memory in all cases.
2382  * Bug fixes that made the host (and link) failures unusable.
2383  * Add a way to auto-restart process when the host in which they are
2384    executing comes back (ON_FAILURE="RESTART" on deployment file,
2385    MSG_process_auto_restart_set).
2386  * Use the "msg_" prefix for all datatypes (instead of m_, msg_ and MSG_),
2387    please stop using the old ones, they are DEPRECATED.
2388
2389  * Deprecate functions MSG_global_init() / MSG_global_init_args()
2390    Please use MSG_init() instead. (reducing the amount of entry
2391    points in the library helps us).
2392  * Make it impossible to link against the wrong version of the lib
2393  * Deprecate MSG_clean(). No need to call it anymore.
2394  * Function MSG_get_host_number() is not deprecated anymore.
2395
2396  Documentation:
2397  * Split the doc into a user guide and a reference guide.
2398  * Start a developper guide to help people hacking on SimGrid.
2399
2400  Cmake:
2401  * Enable tracing by default. This modules rocks you should use it.
2402  * Remove option custom_flags. Now use environment variables CFLAGS
2403    and LDFLAGS.
2404  * Use default cmake things to detect lua instead of home grown ones.
2405  * New option "enable_mallocators" to disable mallocators, for debugging
2406    purpose ("on" by default).
2407
2408  SIMIX:
2409  * Bug fixes around the resource failures: don't let the processes
2410    survive the host they are running onto.
2411  * Add an interface to auto-restart processes when the host in which they are
2412    executing comes back.
2413  * Ensures that SIMIX_clean is called automatically. It's not part of
2414    the public interface anymore (bindings should be updated).
2415
2416  SimDag:
2417  * Bug fix for when SD_Simulate is called with a positive value: be careful
2418    when comparing doubles. Sometimes they are different for non significant
2419    digits only.
2420  * New types of typed tasks. SD_TASK_COMP_PAR_AMDAHL represents a
2421    parallel task whose initial work is distributed among host according
2422    to the Amdahl's law. Such tasks are created with a parameter alpha
2423    that corresponds to the non-parallelizable part of the computation.
2424    SD_TASK_COMM_PAR_MXN_1D_BLOCK represents a complex data redistribution
2425    between two sets of workstations assuming a 1D block distribution (each
2426    workstation owns a similar share of data) on both sides.
2427
2428    These tasks can be scheduled with SD_task_schedulel or SD_task_schedulev.
2429    Data redistribution will be automatically scheduled once parent and child
2430    are both scheduled. The filling of computation_amount and
2431    communication_amount structures is now done seamlessly thanks to the chosen
2432    assumptions.
2433  * New function SD_workstation_dump to display various information
2434  * New function SD_task_set_rate to throttle the bandwidth allowed to be used
2435    by a SD_TASK_COMM_E2E typed task. This rate depends on both the nominal
2436    bandwidth on the route onto which the task is  scheduled and the amount of
2437    data to transfer.
2438    To divide the nominal bandwidth by 2, the rate then has to be:
2439                      rate = bandwidth/(2*amount)
2440  * Compute tasks that have failed can now be rescheduled and executed again
2441    (from their beginning)
2442  * Increasing source code coverage (src/simdag is now covered at 95.8%
2443    on average)
2444
2445  SMPI:
2446  * Re-implement time-independent trace replay using SMPI (at the
2447    smpi_smp_* level) instead of MSG. This should replace
2448    examples/msg/actions/actions.c
2449  * Implement support of MPI Datatypes (vectors, hvectors, indexed,
2450    hindexed and structs)
2451  * Implement the exchange of non-contiguous data.
2452    [Khalid Hasanov & Jean-Noel Quintin] Thanks for the patch, guys.
2453  * Correct behavior of smpi/sender_gap and set its default value to 0
2454  * Add option to asynchronously send small messages to allow better
2455    simulation of pt2pt communications. --cfg=smpi/async_small_threshold:value
2456    specifies the size in bytes under which messages will be asynchronously sent.
2457  * Add support of MPI_Iprobe, MPI_Probe, MPI_Testall, MPI_Wtick functions
2458  * SMPI now handles more MPI specific values in input. Closes [#14389] and [#14388]
2459
2460  SimGrid:
2461  * New C interface to define a platform: XML is now optional.
2462    For more info, please check include/simgrid/platf.h.
2463  * New interface to define random platforms from the C:
2464    For more info, please check include/simgrid/platf_generator.h and
2465    examples/msg/masterslave/masterslave_platfgen.c
2466  * Export a sg_cmdline dynar containing all the arguments we got from
2467    the command line.
2468
2469  TRACE:
2470  * Two new tracing options for adding comments to trace file so you
2471    can track your experiments (see --help-tracing for details).
2472  * New option to generate an impoverished trace file (--cfg=tracing/basic:1)
2473  * Adding the SimGrid version that generated the trace file as a comment.
2474  * Instrumenting other MSG functions (MSG_task_isend_with_matching and MSG_task_dsend)
2475  * Fix to avoid key clashes on Paje links
2476  * Other minor fixes related to the Paje specification
2477
2478  XBT:
2479  * Functions xbt_dict_hash() and xbt_dict_hash_ext() are made public,
2480    and renamed to xbt_str_hash() and xbt_str_hash_ext().
2481  * New function: xbt_os_timer_resume() to restart a timer w/o resetting it.
2482  * Greatly improve the robustness of mmalloc to user errors (such as
2483    using an area after freeing it, or freeing it twice)
2484
2485  -- Thu Oct 25 17:30:06 CEST 2012 Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
2486
2487 SimGrid-java (3.8.1) stable; urgency=low
2488
2489  * New module: org.simgrid.trace.Trace (SimGrid trace bindings)
2490    Warning: all methods are visible, but only some of them are
2491    implemented so far. Check the source (src/jtrace.c)
2492    for further information.
2493  * New module: org.simgrid.msg.File (SimGrid File management functions)
2494  * New Module: org.simgrid.msg.VM (SimGrid interface to mimick IAAS clouds)
2495  * Change the meaning of Process.restart: now restart the process from
2496    the beginning, like MSG_process_restart in C.
2497  * Add Process.setAutoRestart: handling of process restart when failed
2498    host comes back.
2499  * Add Process.getProperty, Host.getProperty, Host.getProperty: allows
2500    you to retrieve the properties of the processes/hosts
2501  * Deprecate Msg.clean(): you can just forget about it now.
2502  * New function Process.getCount(), that only works when compiling
2503    with the not yet released version 3.9 of the C library.
2504
2505  * New context factory based on Coroutines. It mandates a modified JVM
2506    but then, the simulations run about five times faster, and there is
2507    no limit to the amount of processes (beside of the available memory).
2508
2509  -- 2012-12-04 Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
2510
2511 SimGrid (3.7.1) stable; urgency=low
2512
2513  MSG:
2514  * Restore the prototype of MSG_process_create_with_environment() to
2515    the pre-3.7 situation by removing the kill_time argument.
2516  * Add a MSG_process_set_kill_time() function instead.
2517
2518  SURF:
2519  * Fix weird behaviors when dealing with parallel tasks.
2520
2521  WINDOWS:
2522  * Simgrid is now built as a dll.
2523  * Simgrid-java now works on Windows.
2524  * Simgrid-Java is now included into Windows package.
2525
2526  MacOS:
2527  * First pre-build package for MacOSX.
2528
2529  Build System:
2530  * Fix compilation when using MSG_USE_DEPRECATED.
2531  * Fix some compilation issues on Macs and Windows.
2532  * Reduce the number of failing tests on exotic systems, like Debian/Hurd.
2533  * Environment variables CFLAGS and LDFLAGS are now honored by cmake.
2534
2535  We discovered that the Lua console is broken, but we are missing the
2536  manpower to fix it right now. The problem existed in 3.7 too, so we
2537  are not blocking the release for that. Sorry if you depended on this
2538  feature, any help would be really welcome.
2539
2540  -- Thu Jun 7 2012 Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
2541
2542
2543 SimGrid-java (3.7.1) stable; urgency=low
2544
2545  The "Java aint got to be bloated and slow" release
2546
2547  Major cleanups:
2548  * Various internal cleanups and performance improvement
2549    Simulations are expected to run up to twice faster or so
2550  * Make Process.kill(process) an instance method, not a static one
2551  * User processes are not java.lang.Thread subclasses.
2552    This breaks the compatibility (sorry), but previous API was
2553    brain-dead, making it impossible to have non-trivial
2554    initializations in the process constructor.
2555  * Require a full constructor per Process sub-class.
2556    Kinda breaks the compatibility (sorry), but this allows a much more
2557    efficient way to launch the processes at simulation startup.
2558  * Do not embeed our version of semaphores, java 1.5 can be considered
2559    as sufficiently prevalent for us to not dupplicate its features.
2560  * Lot of bug fixes
2561
2562  Extend the API:
2563  * Add examples for almost every part of the API
2564    We spotted and fixed a lot of bugs in the process
2565
2566  * New module: asynchronous communication API
2567  * New function: Process.sleep()
2568    It takes milliseconds as argument, just as java.lang.Thread.sleep()
2569  * New module: org.simgrid.msg.Mutex (SimGrid mutexes)
2570  * New module: org.simgrid.msg.RngStream (RngStreams random generators)
2571
2572  -- 2012-06-12 Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
2573
2574 SimGrid (3.7) stable; urgency=low
2575
2576   The "spring cleanups (before the next Big Project kicks in)" release.
2577
2578   Models:
2579   * We can specify the SMPI latency/bandwidth factor with command line
2580     add --cfg=smpi/bw_factor:"threshold0:value0;...;thresholdN:valueN"
2581     or add --cfg=smpi/lat_factor:"threshold0:value0;...;thresholdN:valueN"
2582     You can also use the "config tag" from platform file by adding this line
2583     <prop id="smpi/bw_factor" value="threshold0:value0;...;thresholdN:valueN"></prop>
2584     (see "example/platforms/tag_config.xml" to use "config tag").
2585     Note that the command line supersedes the platform file configuration.
2586   * Change the correction factors used in LMM model, according to
2587     the latest experiments described in INRIA RR-7821.
2588     Accuracy should be improved this way.
2589   * Use the partial invalidation optimization by default for the
2590     network too. Should produce the exact same results, only faster.
2591   * Major cleanup in surf to merge models and split some optimization
2592     mechanisms from the core of the models. As a result you can now
2593     specify which model to use (e.g., --cfg=network/model:LV08
2594     --cfg=cpu/model:Cas01) and which optimization mode to use
2595     (e.g., --cfg=network/optim:lazy --cfg=cpu/optim:TI).
2596     Incompatible combinations should err at initialization. See
2597     --help-models for the list of all models and optimization modes.
2598   * The CLM03 workstation model was dropped for simplicity because it
2599     used the deprecated CM02 network model. Use default instead.
2600   * Rename the TCP_gamma configuration option to network/TCP_gamma
2601   * Rename the coordinates configuration option to
2602     network/coordinates, and document it
2603   * Use now crosstraffic keyword instead of the terribly misleading
2604     fullduplex keyword. It is activated by default now in the current
2605     default model, use --cfg=network/crosstraffic:0 to turn it off.
2606   * Ongoing refactoring the model parsing to make XML files optional
2607     See include/simgrid/platf.h for details (still to be completed)
2608
2609   MSG:
2610   * Major overhaul of the documentation. Almost instructive now :/
2611   * Deprecate the use of m_channel_t mechanism like MSG_task_{get,put}
2612     functions and friends. This interface was considered as
2613     deprecated since over 2 years, it's time to inform our users that it is.
2614     Switch to MSG_task_{send,recv} instead, or compile SimGrid command line
2615     'cmake -Dcustom_flags="-DMSG_USE_DEPRECATED" .' if you really need to
2616      use these (crappy) functions in your code.
2617     These functions will be removed soon. Stop using them now.
2618   * Deprecate MSG_get_host_{table,number}
2619     Implement MSG_hosts_as_dynar() instead.
2620   * Implement MSG_processes_as_dynar() (Closes gforge #13642)
2621   * Remove the public field msg_host_t->name. Use MSG_host_get_name()
2622
2623   Simix:
2624   * Stabilize the parallel execution mode of user contexts
2625   * Introduce configuration variables to control parallel execution:
2626     - contexts/synchro: Synchronization mode to use when running
2627       contexts in parallel (either futex, posix or busy_wait)
2628     - contexts/parallel_threshold: Minimal number of user contexts
2629       that must be part of a scheduling round to switch to parallel
2630       execution mode (raw contexts only)
2631   * Fix bugs that prevented to use suspend/resume along with
2632     synchronization structures.
2633   * Fix bugs in process termination that lead to invalid memory access
2634     in very specific conditions.
2635
2636   SURF:
2637   * Introduce a parallel mode for the models (controlled by surf/nthreads
2638      configuration item). In our tests, running the models in parallel
2639      never lead to any speedups because they are so fast that the gain
2640      of computing each model in parallel does not amortizes the
2641      synchronization costs, even when ultra fast futexes are used.
2642     This is released anyway because YMMV.
2643
2644   SimDag:
2645   * Performance boost by using a swag internally to compute the set of
2646     tasks that are finished and should constitute the return value of
2647     SD_simulate.
2648
2649   SMPI:
2650   * Enable it by default now that it is considered rather stable.
2651
2652   TRACE:
2653   * Documentation of the tracing functions.
2654   * Performance gains when tracing categorized/uncategorized resource
2655     utilization by avoiding calls to get route when updating resource
2656     variables. LMM constraints are being used instead.
2657   * API changed to set task categories. Use MSG_task_set_category instead
2658     of TRACE_msg_set_task_category, and SD_task_set_category instead
2659     of TRACE_sd_set_task_category. They only work if ENABLE_TRACING is ON.
2660   * Bugfix for graphicator, routes not correctly obtained, memory leaks
2661   * Examples for link user variables added (see at examples/msg/tracing/)
2662   * Deprecated function TRACE_msg_set_process_category completely removed
2663   * Trace header updated according to the latest Paje file format
2664   * Tracing network lazy updates, no longer obligate users to use full updates
2665   * --cfg=tracing/platform:1 also registers power/bandwidth variables
2666   * Experimental: let user code declare/set/push/pop application states for hosts
2667   * API changed to allow the manual creation of graph configuration files
2668     for Triva. See TRACE_get_node_types() and TRACE_get_edge_types().
2669
2670   Lua:
2671   * Improve the API of Lua MSG bindings, using the Lua spirit.
2672   * Each simulated process now lives in its own Lua world (globals are
2673     automatically duplicated). It helps writing simulators. Will allow
2674     to run Splay programs within SimGrid in the future.
2675   * Add a Chord example in Lua, equivalent to the MSG one.
2676
2677   MODEL-CHECKING:
2678   * Start the implementation of a solution to express temporal
2679     properties, not only local assertions. This is still an
2680     experimental work in progress, stay clear from it to be safe.
2681
2682   XBT:
2683   * Logs:
2684     - Add new runtime parameters --help-logs and --help-log-categories
2685       to display information about supported logging parameters and
2686       categories.
2687     - Old deprecated parameters --{gras,surf,msg,simix,xbt}-log=...
2688       don't exists anymore.
2689   * Mallocators: allow value NULL for the reset function.
2690   * Dicts:
2691     - New function xbt_dict_new_homogeneous(void(*)(void*)) to
2692       create homogeneous dictionaries, where all the elements share the
2693       same free function. Non homogeneous dictionaries will be
2694       deprecated in the next release.
2695     - Dicts of scalar elements (xbt_dicti_*) are deprecated.
2696     - Multi-level dictionaries are deprecated.
2697   * Dynars:
2698     - new function xbt_dynar_search_or_negative() that is useful when
2699       you have less than 2 million elements in your dynar and don't
2700       want of the extra complexity of catching exceptions when the
2701       element is not found.
2702   * Portability layer
2703     - Make xbt_os_thread module (for thread portability) public.
2704       Documentation is still to come, sorry.
2705   * mmalloc module:
2706     - Cleanups and simplifications to make it maintainable again.
2707     - Exotic features (such as memalign and valloc) were removed.
2708     - The metadata were extended and improved so that the
2709       model-checker becomes able to explore and inspect the heaps.
2710     - This may induce a performance drop when enable_model-checking is
2711       ON in cmake (even if it's not used in the simulation), but it is
2712       necessary at this point to get MC working.
2713
2714       Turn model-checking OFF if simulation performance matters to you.
2715       Not enabling it at runtime is not enough, disable it in cmake.
2716
2717  -- Tue May 15 11:30:19 UTC 2012 Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
2718
2719
2720 SimGrid (3.6.2) stable; urgency=low
2721
2722  The "Not coding new stuff allows to polish old things" release.
2723
2724  General
2725  * New bindings to the NS3 packet level simulator (experimental)
2726  * Use the raw (efficient) execution contexts instead of the sysv
2727    (portable) ones when possible.
2728  * libpcre is now mandatory in any cases since not using it led to
2729     severe performance loss and possibly other issues
2730  * Update the XML platforms:
2731    - G5K: include the latest machine in Nancy
2732    - GridPP and LCG: new platforms
2733  * Documentation was partially updated, at least (more to come)
2734
2735  Bug fixes, cosmetics and small improvements
2736  * Free terminated processes before the end of the simulation to avoid
2737    exhausting the memory of users having very dynamic amount of
2738    processes.
2739  * Bug fix and cosmetics about canceling non-running tasks
2740  * Bug fix about the dot loader's issues when using libcgraph
2741
2742  Portability
2743  * Create an installer for windows with nsis (amd64 and win32)
2744    - Add an hello world project to illustrate simgrid project creation.
2745    - Embed libpcre into the Simgrid installer to avoid
2746      its compilation burden
2747  * The raw execution contexts should work on Apple now
2748  * Port to Windows 64 bits
2749     - Sysv contexts now have an implementation for this arch
2750     - GRAS communication features now support this arch
2751  * Drop support for borland compiler on windows
2752     - this code was not maintained, and we kinda depend on gcc nowadays
2753  * Fix portability issues on kfreebsd/gnu: build error about semaphores
2754  * Fix portability issue on unstable ubuntu: linker became picky on
2755    argument order
2756
2757  -- Wed Oct  5 15:51:01 CEST 2011 Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
2758
2759 SimGrid (3.6.1) stable; urgency=low
2760
2761  The "Oops, we broke Macs too" release
2762
2763  Portability
2764  * Fixed contexts detection so that raw ones are used when possible
2765  * On Mac, do not use Posix Ucontexts with gcc v4.[1-5] since this
2766    leads to a strange error, with user code segfaulting sometimes when
2767    the generated code is not perfectly aligned (which is not
2768    controllable from the user side, depends on the amount of code)
2769
2770  XBT
2771  * New macro: CATCH_ANONYMOUS, which is like CATCH(e) but without argument.
2772
2773  -- Mon Jun 27 13:59:03 CEST 2011 Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
2774
2775 SimGrid-java (3.6) unstable; urgency=low
2776
2777  * Initial release.
2778  * Split of every thing from simgrid v3.5 into a separate package.
2779
2780  -- 2011-10-05 Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
2781
2782 SimGrid (3.6) stable; urgency=medium
2783
2784  The Summer Release, also known as the "OMG! They Killed Kenny!" version
2785
2786  Java and Ruby:
2787  * Bindings now constitute their own package, separated from the main one.
2788    Rationale: reduce our maintenance nightmare by reducing the module coupling
2789    They will soon be released on their own on gforge.
2790  * In the meanwhile:
2791    svn co svn://scm.gforge.inria.fr/svn/simgrid/contrib/trunk/simgrid-java
2792    svn co svn://scm.gforge.inria.fr/svn/simgrid/contrib/trunk/simgrid-ruby
2793
2794  GRAS: It is not considered as stable anymore, but experimental. Sorry.
2795  * It's not quite deprecated for now because we have no replacement,
2796    but it may soon become the case.
2797
2798  SMPI
2799  * New MPI functions supported: MPI_Comm_disconnect, MPI_Comm_get_name
2800  * Fortran: New user-level cache variable to store the rank of the running
2801    process. This improves performance by an order of magnitude.
2802  * C: New coccinelle script to automatically locate and modify global and
2803    local static variables.
2804  * Improved SMPI network model with a sender-side gap to account for multiple
2805    parallel sends.
2806
2807  MSG
2808  * New function MSG_comm_get_status(). MSG_comm_test() and MSG_comm_testany()
2809    only say if a communication is finished, no matter whether it succeeded or
2810    failed. You can call MSG_comm_get_status() to know the status of a finished
2811    communication.
2812  * New function MSG_task_dsend() to send a task and detach it. When a
2813    communication is detached, you are never notified of its success or failure
2814    and the memory is released automatically once it is finished. This function
2815    is useful when you don't care about the end nor the success of a
2816    communication.
2817  * Change the prototypes of action replay. Sorry for inconvenience,
2818    but this is really more efficient this way (and to adapt your code,
2819    you just have to fix the initialization, that shouldn't be too long)
2820  * Kill the braindead MSG_task_refcount_dec() function. I guess nobody
2821    ever managed to do anything useful with it.
2822  * New function MSG_comm_testany(). Similarly to MSG_comm_waitany(), it
2823    takes a dynar of communications. It returns immediately and gives the
2824    index of a finished communication (if any).
2825  * New example: a basic implementation of the Chord P2P algorithm.
2826
2827  SURF
2828  * New model for multi-core CPUs. You can now use the core attribute to
2829    precise the number of cores of a host. This is a basic model. Every
2830    process running on the host receives at most the power provided in
2831    the DTD (throughput<=power). Total throughput of process cannot exceed
2832    power * num_cores.
2833  * New peer tag. This peer tag creates a tiny AS comprising a host and a
2834    router linked by an up-link and a down-link (possibly asymmetrical).
2835    This kind of pattern allows to easily build last-mile model style platforms.
2836    Aggregating such patterns in a rule-based AS is thus the technique of
2837    choice for modeling large peer-to-peer/volunteer computing/cloud platforms.
2838  * New model for Vivaldi routing. We transformed the Vivaldi network model
2839    into a Vivaldi routing model (based on the rule-based model). This allows to
2840    combine Vivaldi based latencies with last-mile platforms.
2841
2842  SIMIX
2843  * Added a check for NaN of IEEE754 infinite in the double entries of
2844    the smx_user.c file
2845  * Introduce a new context factory "raw", highly inspirated from the
2846    ucontext factory, but using manually crafted functions in assembly to
2847    do the work in an efficient manner.
2848  * Allow to change the used context factory at run time, not only at
2849    compilation time. Use --cfg=contexts/factory:raw for maximal speed.
2850  * Add an option --cfg=contexts/stacksize:N to set the stack size of the user
2851    contexts at runtime (only with raw contexts or ucontexts).
2852  * Completely rewrote this module to allow parallel execution of user
2853    processes. Use --cfg=contexts/nthreads:N to execute user processes
2854    with N parallel threads (the default is 1, meaning no parallelism).
2855  * Allow to decide dynamically between sequential and parallel modes.
2856    When nthreads > 1, you can use --cfg=contexts/threshold:P to run the user
2857    processes in parallel only when their number is greater than or equal to P
2858    (the default is 2).
2859  * Added a check for NaN of IEEE754 infinite in the double entries of
2860    the smx_user.c file
2861
2862  XBT
2863  * New command line option: if you pass --cfg=verbose-exit:0, SimGrid
2864    won't output the state of processes when interrupted with Ctrl-C
2865  * Add a new function xbt_dynar_to_array that transforms a dynar into a
2866    NULL-terminated array. This may solve backward compatibility issues
2867    due to the change to return type of SD_simulate. See also:
2868    http://lists.gforge.inria.fr/pipermail/simgrid-user/2010-December/002206.html
2869  * Add new macros with variable number of arguments.
2870    - in xbt/log.h: XBT_DEBUG, XBT_VERB, XBT_INFO, etc.
2871    - in xbt/asserts.h: xbt_assert
2872    - in xbt/cunit.h: xbt_test_{add,fail,assert,log}
2873    - in xbt/ex.h: THROWF and RETHROWF.
2874    Define XBT_USE_DEPRECATED if you want to use the old numbered macros like
2875    INFO1, INFO2, etc.
2876  * Change xbt_die() to accept a format string with arguments, just like printf.
2877  * New data structure: xbt_lib_t, like a dict but more general and with better
2878    memory handling.
2879
2880  INSTR
2881  * New configuration options
2882    Options triva/categorized and triva/uncategorized can be used to generate
2883    graph configuration files for Triva visualization tool.
2884  * Configuration option tracing/platform is renamed to tracing/categorized
2885  * XBT logging makes tracing error checks easier, new root log hierarchy: instr
2886  * New TRACE_user_link_variable interface:
2887    User provides the name of the link and the tracing variable to attach to it
2888  * the declaration of tracing categories must be done after the environment
2889    creation
2890  * simpler tracing interface, just one way to declare categories
2891     TRACE_category or TRACE_category_with_color, it is up to you
2892  * links in the trace file are again identified by their names
2893  * trace contains the full platform hierarchy exactly as declared using the ASes
2894  * Options tracing/msg/[task|process]:1 groups the process by hosts
2895    for both cases, tasks and processes must have names that are unique during the simulation
2896    these options generate traces that are suited to gantt-charts, such as the space-time view of Paje
2897  * The experimental option tracing/msg/volume is deprecated
2898    its functionality may be reincorporated if needed
2899  * Buffering
2900    The tracing generates a trace file with unordered timestamped events,
2901    because of the way the core simulator (surf) works. A script available
2902    at the tools directory (fix-paje-trace.sh) can be used to put the events
2903    in order. We have changed the tracing so it can generate ordered timestamped
2904    events in the final trace, but depending on the simulator (and how much time
2905    is simulated) that can lead to a huge memory utilization. It is deactivated
2906    by default, but it can be activated using the --cfg=tracing/buffer:1 switch.
2907
2908  Build Infrastructure
2909  * Define a SIMGRID_VERSION macro in simgrid_config.h.
2910    - We are trying hard to keep the API stable, but it may happen that
2911      some things change (we're a research project after all, not a
2912      nuclear plant operating system). If such things should happen, you
2913      could rely on that macro to adapt.
2914    - current value: 30600 for 3.06.00, aka 3.6
2915  * Define macro MAKE_SIMGRID_VERSION(major, minor, patch) to help building
2916    a number that can be compared with SIMGRID_VERSION.
2917  * Add a build option -Denable_debug (set to ON by default): when set to OFF,
2918    assertions and verbose/debug logging events are disabled at compile time.
2919
2920  -- Tue Jun 21 08:57:43 CEST 2011 Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
2921
2922 SimGrid (3.5) stable; urgency=medium
2923
2924  Model Checking
2925  * New feature to any SimGrid-based simulator: Model-Checking
2926    Check SIN#1 for more details.
2927
2928  SMPI
2929  * New Model SMPI (three-interval linear regression for correction factors)
2930    See RR-7426, available at http://hal.inria.fr/inria-00527150
2931  * Ability to use FORTRAN MPI code (through f2c, automatically privatized)
2932  * New MPI functions supported: MPI_Get_count(), MPI_Comm_split()
2933  * New: RAM folding (see RR-7426 and examples/smpi/NAS/DT-folding)
2934  * New: execution sampling (see RR-7426 and examples/smpi/NAS/EP-sampling)
2935  * See also src/smpi/README
2936
2937  Tracing:
2938  Tracing:
2939  * Tracing system
2940    - Tracing API changes: TRACE_start and TRACE_end should not be called
2941      by user-code. They are automatically called by simulators created
2942      with SimDAG, MSG and SMPI if the toolkit is compiled with
2943      tracing_enabled=ON. Categories declaration and utilization remain the
2944      same for MSG and SimDag.
2945    - A function was added to the tracing API to declare categories with
2946      colors:
2947         - TRACE_category_with_color (char *category, char *color)
2948                 where color must be in the following format
2949                     "%f %f %f", red, green, blue
2950                 and red, green, blue are float values in the interval [0, 1]
2951         - User can specify NULL as color parameter, or continue calling
2952             TRACE_category (cat)
2953           On that case, the tracing system will define random colors
2954    - The following command-line options are supported:
2955         --cfg=tracing/filename:msg.trace
2956         --cfg=tracing:1               (activate tracing, needed to use others)
2957         --cfg=tracing/platform:1      (categorized resource use)
2958         --cfg=tracing/uncategorized:1 (uncategorized resource use)
2959         --cfg=tracing/msg/task:1      (task creation)
2960         --cfg=tracing/msg/process:1   (process creation, migration)
2961         --cfg=tracing/msg/volume:1    (volume of MSG send/recv)
2962         --cfg=tracing/smpi:1          (SMPI interface tracing)
2963         --cfg=tracing/simdag:1        (allow SimDAG tasks receive categories)
2964    - examples of examples/msg/tracing updated
2965  * Tracing SimDag
2966    - DAXLoader and DOTLoader functions can generate tasks with categories
2967    - A new function to attribute a category to SD tasks:
2968         TRACE_sd_set_task_category (SD_task_t task, char *category)
2969  * Tracing the MPI interface implemented by SMPI
2970    - Collective operations are traced with states
2971    - Point-to-Point operations are traced with states/links
2972    - Tracing activated by a parameter "-trace filename" passed
2973      to smpirun during execution (considering that simgrid
2974      is compiled with tracing enabled)
2975    - To run the simulation with gdb, the simulator
2976      accepts --cfg=tracing/smpi:1 to trace SMPI
2977    - tesh files to check if smpi tracing is ok
2978    - See examples/smpi/NAS/DT-trace
2979  * GTNetS tracing re-worked
2980    - adaptation to the tracing system of GTNets to cope
2981      with modifications regarding the fullduplex mode
2982    - new tesh files to check if gtnets tracing is ok
2983
2984  MSG
2985  * Asynchronous communications through the functions:
2986    MSG_task_isend/irecv and MSG_comm_test/wait/waitall
2987  * New function: MSG_load_platform_script()
2988    to make possible using a lua script instead of XML files to set up platforms
2989  * New function: MSG_set_function
2990    to associate functions to processes, used when bypassing the parser
2991  * New functions: MSG_task_set_name(), MSG_task_set_compute_duration()
2992
2993  Platforms: Add some more examples in examples/platforms
2994  * Grid'5000: see www.grid5000.fr
2995  * *_30000_hosts.xml: various huge files [mainly scalability testing]
2996
2997  SURF
2998  * Change the XML format. This is a very important modification. SimGrid
2999    3.5 introduces a new hierarchical format based on the notion of
3000    Autonomous Systems. Compatibility with old format is ensured
3001    through the perl script provided in the install bin directory
3002    bin/simgrid_update_xml.
3003    It is now possible to build platforms with specific routing
3004    mechanism (Full/Dijkstra/DijkstraCache/Floyd) and to easily
3005    connect several platforms together. We will try to provide soon
3006    set of realistic platforms exploiting these properties (have a
3007    look at examples/platforms/ for the moment).
3008  * Take the opportunity of the XML format change to be a good XML citizen:
3009    rename link:ctn to link_ctn and similar changes (also dealt with by
3010    simgrid_update_xml)
3011  * Add a new routing scheme (rule-based) using regular expressions. It
3012    enables to have an extremely low memory footprint when the
3013    underlying routing is simple and can be compactly described. You
3014    need to have libpcre4-dev (perl regular expressions) installed if
3015    you want to use this routing scheme.
3016  * Revive the cluster TAG and allow to easily and efficiently (both in
3017    term of memory and speed) connect clusters together. Have a look
3018    at teshsuite/simdag/platforms/ to see how this can be done. With
3019    this tag, you can create clusters with thousands of tasks at no
3020    cost (have a look at examples/platforms/).
3021    Note: clusters are implemented as ASes, so there is no need for an
3022    enclosing AS tag if you have only one cluster in your platform.
3023  * Add new generic functions in the public interface that allows the user
3024    to call SURF 'create_resource' methods from your code (same
3025    functionality as the XML bypass mechanism but with a much lighter
3026    burden).
3027  * Add a new model (enabled through command line --cfg=network/model:SMPI)
3028    that uses a piecewise linear approximation to produce better
3029    results when exchanging small messages.
3030  * Add a new parameter to handle correctly full duplex link and account
3031    for interferences between uplink and downlink communications
3032    (activate with --cfg=fullduplex:1).
3033
3034  SIMDAG
3035  * Rename the SD_READY (all dependencies are satisfied and task is
3036    scheduled) state in SD_RUNNABLE and define a new SD_SCHEDULABLE (all
3037    dependencies are satisfied) state.
3038    This prevents a confusion between the notion of "ready to schedule"
3039    (SD_SCHEDULABLE) used in DAG scheduling and that of "ready to be
3040    simulated" (SD_RUNNABLE) used by the simulation kernel.
3041  * Change the way a task is considered as ready. Instead of removing
3042    dependencies when a task is done, a counter is decreased. This way,
3043    it is always possible to reach ancestors thanks to the
3044    SD_taks_get_parents function (even after the end of the simulation.)
3045  * Change the return type of SD_Simulate from (SD_task_t*) into
3046    xbt_dynar_t. This function was in handling a dynar internally and
3047    converted it into a NULL terminated array for historical reasons.
3048  * New function SD_dotload(char*) to load a DAG described in dot
3049    format. This loader and the corresponding examples require the
3050    installation of the graphviz library.
3051  * Fix a bug in the management of tasks of size 0 in the surf network
3052    models. This problem was only visible with SIMDAG and you should
3053    thus disregard results produced with earlier versions if you
3054    relied on this feature (some tasks were blocked because of this).
3055  * Fix a bunch of stuff that prevented to use classical models with SIMDAG
3056    even though your applications were doing only point-to-point
3057    communications and sequential computations. Now you can really use any
3058    model you want (of course, if you create real parallel tasks, which are
3059    not implemented in most models beside ptaskL07, this will abort).
3060  * Add an example that schedules a DAX on an heterogeneous platform
3061    using a Min-Min strategy.
3062  * New function SD_workstation_get_current_task() that returns the kind
3063    of task currently running on a workstation in the sequential access
3064    mode.
3065  * Raise some warnings when unexecuted tasks remains at the end of the
3066    simulation. This is usually caused by cycles in the DAG.
3067
3068  SIMIX
3069  * New function: SIMIX_process_set_function() called by MSG_set_function
3070  * Change the underlying waiting queue in semaphores so that a process
3071    can wait on several of them simultaneously (as in waitany).
3072  * Fix the way to handle tokens in semaphores so that all access patterns
3073    work: {acquire, acquire_timeout, waitany} / {release, release_forever}.
3074  * kill the dirty pimple SIMIX_message_sizes_output()
3075    Please use (proper) visualization instead
3076
3077  XBT
3078  * New data container: setset (set of sets of elements)
3079  * New module: mmalloc (mapped malloc, allowing to have several
3080    independent segments of malloc)
3081  * New function: xbt_dict_cursor_set_data()
3082  * New functions: xbt_dynar_sort(), xbt_dynar_compare()
3083  * New function: xbt_dynar_is_empty()
3084  * New function: xbt_fifo_get_last_item()
3085  * Fix xbt_dynar_shrink(): use the right element size.
3086  * Fix xbt_dynar_set*(): allow index larger than current size and memset 0
3087    uninitialized areas during expand.
3088  * Fix semaphores: previous implementation was severely broken.
3089  * Use library init/fini functions for our initialization.
3090    - you can use logs and other feature as soon as you want in your
3091      code (even before the xbt_init / MSG_init)
3092    - xbt_exit is now a no-op and produce a warning when used.
3093
3094  GRAS:
3095  * Port GRAS to new SIMIX mechanisms. This allows gras users to
3096    benefit from the latest improvement to the simulation kernel.
3097  * Kill measurement sockets for now. If you rely on them, sorry. This
3098    release is not for you. This feature will be reintroduced in the
3099    future, but we cannot delay the release any further.
3100  * New function: gras_msgtype_get_name().
3101  * Implement gras_agent_spawn in RL too (the prototype changed a bit)
3102  * Fix (at last) the pmm example: it should not randomly fail anymore.
3103
3104  Build chain: bug fixes and overall polishing
3105  * Cmake is now stable enough. Hence, we killed the autotools.
3106  * Port to windows ( TM :)
3107  * Fix the 'make install' target.
3108    No need to use 'make install-simgrid' anymore
3109  * Introduce a 'make dist' target compiling a *source* archive
3110    'make package' compiles a binary archive
3111  * Compile java files only on need
3112  * Add --cd and --setenv command line options to tesh
3113  * Out of source builds are not fully supported yet, but we are close
3114  * Enable supernovae and optimization flags by default for our users
3115
3116  LUA Bindings
3117  * Add layer to set up environment directly from lua, without XML.
3118  * The effect of gras_stub_generator can be achieved through
3119    lua too (check examples/gras/console/ping_generator.lua)
3120
3121  -- Wed, 01 Dec 2010 22:09:23 +0100 Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>
3122
3123 SimGrid (3.4.1) stable; urgency=low
3124
3125  The "Polishing easter eggs is probably a good idea" release.
3126  This is a bug fixes release only.
3127
3128
3129  Java Bindings
3130  * Fix a bug preventing the tasks from begin garbage collected.
3131
3132  MSG
3133  * Fix a bug occurring when a host involved in a communication fails.
3134    This was not detected properly by the other peer involved in the
3135    communication. Now, it's reported as a network error.
3136
3137  SimDag
3138  * Warn the user about loop dependencies in data flow of DAX files
3139  * Obey the control-flow dependencies of DAX files
3140
3141  Cmake
3142  * Add option "enable_smpi" allowing to not compile SMPI.
3143    Probably useful for the (Mac) users experiencing a build error here
3144  * Improve the detection of lua5.1 and ruby1.8
3145
3146  -- Da SimGrid team <simgrid-devel@lists.gforge.inria.fr> Tus, 04 May 2010 28 16:11:16 +0100
3147
3148 SimGrid (3.4) stable; urgency=low
3149
3150  The "Easter in Cargese" release. Also known as (major changes):
3151
3152   * the "se habla Java, Ruby 話せます, fala-se Lua (and deaf-friendly)"
3153     ~> bindings were greatly improved
3154     ~> new tracing infrastructure for better visualization introduced
3155
3156   * the "Welcome to configury modernity" release.
3157     ~> we switched from autotools to cmake, and improved our cdash
3158
3159
3160  A more detailled list of changes follow (full detail in svn log).
3161
3162  Java Bindings: Various Cleanups
3163   * (install java-gcj-compat-dev on debian-like to use them)
3164   * Remove put/get: no need to export deprecated interface in Java
3165     Use send/receive instead.
3166   * Cleanup the examples and add a README per directory
3167   * Remove example autoDestination (that's the only way to go now)
3168   * Remove example explicitDestination (was a plain copy of basic)
3169   * Make JniException a runtime exception, so that there is no need to
3170     declare the fact that you may encounter such a beast. I guess that
3171     nobody will ever want to survive such error.
3172   * Create specific errors for each MSG case of failure:
3173     host failure, transfer failure, timeout, task cancelled
3174   * Cleanup the exceptions that may get thrown by each function
3175   * Other internal cleanups in Java bindings. Performance still bad :/
3176  Ruby and Lua Bindings: create them
3177   * (install ruby1.8-dev/liblua5.1-0-dev on debian-like to use them)
3178   * That's new and great, you should try them out.
3179     Same functionalities than Java bindings, only even less polished
3180  SimDag:
3181   * Kill the useless "rate" argument of SD_task_get_execution_time()
3182     Everyone used to provide -1 as a value, it was not used, and the
3183     semantic of a possible use wasn't even clear.
3184   * SD_SCHED_NO_COST: Constant to use as cost in SD_task_schedule()
3185     either as comm costs or compute costs to mean that there is no
3186     such thing for that specific task.
3187   * Add a SD_task_set_name() function
3188   * Fix SD_task_unschedule() on typed tasks
3189   * Fix SD_task_get_execution_time() to return seconds, not flop*sec
3190   * In DAX loader, accept useless 'level' attributes to <job> since
3191     LIGO DAGs have them (seem to be to ease graphical representation).
3192  MSG:
3193   * Add an example masterslave_mailbox.c using send/receive and not
3194     the deprecated put/get interface.
3195   * Kill the MSG_paje_output() function. It's a noop since 2 years.
3196   * Kill MSG_WARNING and MSG_FATAL return codes: they were not used
3197     anywere in source.
3198   * Rename MSG_TIMEOUT_FAILURE into MSG_TIMEOUT for sake of logic
3199     (declare MSG_USE_DEPRECATED to still have the old name)
3200   * Add a MSG_task_set_data() function
3201   * About trace replay (see examples/msg/actions):
3202     - implement barrier
3203     - Allow to work with splitted trace files for each process
3204       Give the specific trace file as argument of each process,
3205         and call MSG_action_trace_run(NULL)
3206       You can still have one merged file for all processes.
3207     - Fix implementation of collective operations
3208   * Allow task_execute() on 0-sized tasks (closes #10063)
3209  SMPI:
3210   * This is the first release of SimGrid where SMPI is not considered
3211     beta anymore (even if some corners should still be improved)
3212   * Port over the new SIMIX_network submodule (internal refactoring)
3213   * Basic support to log events as with SMPE (use --cfg=SMPE:1)
3214   * Implement more missing elements of the standard:
3215     - MPI_COMM_SELF
3216     - MPI_MAXLOC MPI_MINLOC + all associated datatype MPI_DOUBLE_INT,
3217       MPI_FLOAT_INT, etc.
3218     - MPI_Address() MPI_Get_count() MPI_Type_free() MPI_Type_extent()
3219       MPI_Scan() MPI_Get_processor_name()
3220     - Added implementation of missing case for Alltoall (warning: it's
3221       *not* the bruck variant from OpenMPI; based on Alltoallv instead)
3222     - SMPI_MPI_Gather() SMPI_MPI_Gatherv() SMPI_MPI_Scatterv()
3223       SMPI_MPI_Reduce_scatter() SMPI_MPI_Allgather()
3224       SMPI_MPI_Allgatherv()
3225   * Bug fixes include:
3226     - MPI_Waitsome() was broken
3227     - Allow relative includes in smpicc
3228     - Command line cfg argument 'reference_speed' was ignored...
3229     - Some functions did not properly lead to auto-benching of user code
3230     - smpicc passes -O2 by default (just like openmpi one)
3231  SIMIX:
3232   * add SIMIX_action_suspend() and SIMIX_action_resume() functions
3233   * Bug fixes about timeouts during communications
3234   * add SIMIX_message_sizes_output() as a pimple to write to file the
3235     amount of messages per size. Use gnuplot to get histogram.
3236     Pimple because that's the only user-visible function of simix,
3237      defined directly in xbt.h (irk, sorry)
3238   * About semaphores:
3239      - Add a SIMIX_sem_get_capacity() function
3240      - Fix interactions with processe resume/suspende
3241      - release_forever() was stupidly broken
3242      - Fix SIMIX_display_process_status() for processes in a semaphore
3243      - Make SIMIX_sem_block_onto() user-visible
3244   * Refactoring context stuff:
3245     - Use pseudo-OOP for better modularity
3246     - reimplement SIMIX_process_kill() without process_schedule() so
3247       that the latter can take as invariant that it is called from
3248       maestro.
3249     - Merge context_start into context_new for sake of simplicity
3250  SURF:
3251   * Add a Vivaldi network model, coded live during SUD'10 ;)
3252   * Rename configuration variables to start a hierarchy:
3253     o cpu_model -> cpu/model
3254     o network_model -> network/model
3255     o workstation_model -> workstation/model
3256   * New configuration variables:
3257     o network/bandwidth_factor: correction to bandwidth
3258     o network/latency_factor: correction to latency
3259     o netwotk/weight_S: correction to the weight of competing streams
3260   * Add a long description to the models, that users can see with such
3261     argument on the command line: --cfg=cpu/model:help
3262   * --help-models display the long description of all known models
3263  XBT:
3264   * config: add the ability to set a default value after registration
3265     Does not override any previously set value (e.g. from cmd line)
3266   * dict: allow to have integer key and data.
3267     When so, you need to use the following functions
3268      void xbt_dicti_set(xbt_dict_t dict, uintptr_t key, uintptr_t data);
3269      uintptr_t xbt_dicti_get(xbt_dict_t dict, uintptr_t key);
3270      void xbt_dicti_remove(xbt_dict_t dict, uintptr_t key);
3271     In contrary to regular dicts, the key is not malloced before copy.
3272     Mixing scalar and regular elements in the same dict is not tested
3273       (but may work).
3274   * Allow to use xbt_dynar_shrink() to expend the dynar instead
3275  Tracing for Visualization:
3276   * SimGrid is now instrumented in order to generate a trace file for
3277     visualization analysis: to use it, need to compile SimGrid with the
3278     "tracing" option enabled, and instrument the program using SimGrid with
3279     TRACE_start, TRACE_category, TRACE_msg_set_task_category and TRACE_end
3280     (among other functions).
3281   * The instrumentation only traces the platform utilization for now
3282   * Documentation to use the tracing functions and how to analyze the
3283     traces with the Triva tool is written.
3284   * More information about: SimGrid FAQ (in the section Tracing Simulations
3285     for Visualization)
3286  Build system:
3287   * We moved to cmake as default build system. Autotools support will
3288     be dropped soon. Check the FAQ for more info about how to use it.
3289   * Greatly improved our cdash/ctest interactions
3290     Check http://cdash.inria.fr/CDash/index.php?project=Simgrid
3291   * Added memory checking tests with valgrind; lot of memleak fixing.
3292     This may be the first release of simgrid with so few memory issues
3293   * Added code coverage tests.
3294     Our coverage is still improvable, but at least we see it on cdash.
3295
3296  -- Da SimGrid team <simgrid-devel@lists.gforge.inria.fr> Wed, 28 Apr 2010 28 17:11:16 +0100
3297
3298 SimGrid (3.3.4) stable; urgency=low
3299
3300  The "Desktop Grid needs love too" release (also called Xmas release).
3301
3302  Models improvements:
3303  * Major speedup in the maxmin system solving by using lazy evaluation
3304    Instead of solving completely the maxmin system at each iteration,
3305      only invalidate (and recompute) the modified parts.
3306    This new feature is enabled in default models but you can try to
3307      turn it on with "--cfg:maxmin-selective-update=1" for other models.
3308  * Cas01 IMproved as default CPU model
3309    This CPU model is the same Cas01 model, but it uses the
3310      maxmin-selective-update flag and a heap structure to manage
3311      actions on SURF kernel.
3312    It reduces the complexity to find the next action to finish and,
3313      consequently, it's faster than the old Cas01.
3314    This is the new default CPU model (Cas01).
3315  * Rename the old Cas01 model to Cas01_fullupdate
3316    Keep the old cpu model Cas01 with the new name of Cas01_fullupdate.
3317    Use "--cfg=cpu_model:Cas01_fullupdate" to use the old default CPU model.
3318  * CpuTI (CPU Trace Integration)
3319    A new CPU model whose objective is simulate faster when using
3320      availability trace files.
3321    Instead of using a full featured, over engineered maxmin system for
3322      CPU modeling, this model does the pre-integration of traces files
3323      to calculate the amount of CPU power available, and so, executes
3324      faster than the old CPU models.
3325    Use "--cfg=cpu_model:CpuTI" to change to this CPU model.
3326  * Use LV08 as default network model since it gives better accuracy
3327     for small messages and shouldn't change things for big ones.
3328    Use --cfg=network_model:CM02 to get the previous behavior.
3329
3330
3331          ******************************************
3332          *DO NOT MIX 3.3.4 RESULTS WITH OLDER ONES*
3333          ******************************************
3334    * The new CPU model may changes simulations!
3335      The point is that events occurring at the exact same timestamp
3336         are not scheduled in the same order with the old and new
3337         version. This may be enough to completely change the execution
3338         of simulations in some cases.
3339    * The new network model will change simulations!
3340      This new model is more realistic than the previous one, so you
3341        should consider redoing your old experiments with this model.
3342      Sorry for the inconvenience.
3343
3344  Build System:
3345  * Introduce the supernovae compilation mode
3346    When compiled that way, the whole SimGrid (or almost) is put in a
3347      single compilation unit and compiled in one shoot.
3348   This is to help gcc which has difficulties to inline stuff from one
3349      file into another.
3350   The speedup seem to be above 15%, althrough more tests are needed on
3351      amd64 to confirm that gain.
3352
3353  MSG:
3354  * Port of MSG's mailbox on top of SIMIX network
3355    The put/get mechanism was greatly simplified on the way.
3356
3357  SIMIX:
3358  * New SIMIX network module. Provides:
3359    - Mailbox: rendez-vous mechanism to find with who you want to speak
3360    - Synchronous send/recv: easier and hopefully faster since the
3361      logic is handled in the maestro process directly now
3362    - Asynchronous send/recv: you dreamt of it? It's here now
3363      Too bad that nobody cared enough to propagate the change to MSG.
3364  * Add semaphores as SIMIX synchronization mechanism.
3365
3366  SimDag:
3367  * new function SD_daxload(char*) to load a DAX file
3368    (see http://vtcpc.isi.edu/pegasus/index.php/WorkflowGenerator)
3369  * Introduce typed tasks. Specify its kind and cost at creation.
3370    At scheduling, just give where it should be placed, and the cost
3371    for each involved resource is automatically computed.
3372    Existing constructors so far (more to come of course):
3373     - SD_task_create_comm_e2e() for end-to-end communication
3374     - SD_task_create_comp_seq() for sequential computation
3375    Use SD_task_schedulev() / SD_task_schedulel() to schedule them.
3376  * new function SD_task_dump() for debugging display
3377  * new function SD_task_dotty(task,FILE*) writing to file the info
3378    about the task in dotty format
3379  * SD_task_dependency_exists() can now cope with having one of its
3380    arguments NULL. If so, it tests whether the other argument has any
3381    dependency.
3382  * Add getters on list of preceding/following tasks:
3383     SD_task_get_parents(task) and SD_task_get_children(task)
3384  * Add getters on amount of workstations and list:
3385     SD_task_get_workstation_count(t) and SD_task_get_workstation_list(t)
3386  * Add getter on task kind: SD_task_get_kind(task)
3387  * Update the start_time and finish_time of tasks on completion/failure
3388  * Bugfix: Remove task from state swags when destroyed
3389
3390  GRAS:
3391  * New function: void gras_cpu_burn(double flops) -- a simple CPU burner
3392
3393  XBT:
3394  * New function: xbt_dynar_dopar(dynar,fun) to map a function over the
3395    dynar with one separate thread per value of the dynar.
3396  * Change the prototype of xbt_thread_create(), sorry.
3397    Added a boolean parameter indicating whether we want to join this
3398    thread (used in SG only for now)
3399  * Implement xbt_thread_join and xbt_thread_yield in SG also.
3400
3401  Bug fixes:
3402  * GTNetS wrappers should now be usable again (and betterly tested too)
3403  * Fix a major regression from 3.2 where the timeout provided to
3404    MSG_task_put_with_timeout() was used as absolute time before which
3405    the comm should be done.
3406  * Start to fix the <cluster> tag.
3407    - Internal links should be good now (beside of the loopback, which
3408      use the private link instead)
3409    - paths to the external world is still rather broken
3410    - the <route:multi> tag is just broken. Actually that's brain-dead.
3411      We need sth like <route:multi src="myCluster" dst="$*-${myCluster}">
3412      to make it less stupid
3413    ** Check your platform with teshsuite/simdag/platforms/flatifier **
3414  * Fix a source-level compatibility glitch from 3.2: after defining
3415    MSG_USE_DEPRECATED, you can use the old name
3416    MSG_task_put_with_time_out() for MSG_task_put_with_timeout()
3417  * Allow to compile from the SVN with automake 1.11
3418  * Fix some problems when using the "start_time" tag in deployment XMLs.
3419  * Fix #8569: XBT/synchro.h has redundant declarations
3420  * Fix #8563: MSG return values and exceptions
3421    Introduce a MSG_TIMEOUT_FAILURE return code and use it consistently.
3422  * Integrate patch #8636: Obey DESTDIR when installing documentation.
3423    Thanks to Robson Peixoto.
3424  * Fix a vicious bug in dictionaries inducing that some elements were
3425    not freed on xbt_dict_free()
3426
3427  Portability report of this version:
3428   * Main portability targets:
3429     - linux (ubuntu (804/810/910) /debian (4/5/testing) /fedora (core11))
3430       on (amd64/i386/ia64)
3431     - mac leopard on i386
3432     Known problems: http://cdash.inria.fr/CDash/index.php?project=Simgrid
3433      but nothing critical.
3434   * Other platforms: windows, AIX and others were not tested for this release
3435
3436  Timing report of this version:
3437   * Lazy evaluation brings arbitrary speedup (ie, speedup depending on
3438     scenario parameters). From 8h to a few seconds in desktop grid settings.
3439   * Supernovae brings about 25% speedup on i386.
3440
3441  -- Da SimGrid team <simgrid-devel@lists.gforge.inria.fr> Thu, 24 Dec 2009 19:07:39 +0100
3442
3443 SimGrid (3.3.3) stable; urgency=low
3444
3445  The "Need for Speed" release.
3446
3447  The timings done to validate the 3.3.2 were faulty.
3448  Instead of being 5% faster, it was 15% slower (compared to 3.3.1).
3449
3450  The problem was a conversion from a manually handled vector to
3451    xbt_dynar_t on the critical path.
3452  xbt_dynar_foreach calls functions, inducing stack management crap.
3453
3454  We inlined these functions and xbt_dynar_foreach is now breath taking.
3455  We also inlined xbt_swag_belong on the way.
3456
3457  Here are some approximate speedup measurements (on master/slaves
3458   simulations lasting between 10s and 20s each):
3459    3.3.1                   -> 3.3.2: about same performance
3460    3.3.2                   -> 3.3.3: 40% speedup
3461    3.3.1                   -> 3.3.3: 40% speedup
3462    3.3.1 with inline patch -> 3.3.3: 30% speedup
3463
3464  Our reading is that the refactoring which occurred in 3.3.2 made us
3465   suffer much more from the xbt_dynar_foreach low performance, but
3466   once we solved this, this refactoring proved to be very performance
3467   effective. From the 40% speedup, somehow, 10% are due to the
3468   inlining and 30% to the refactoring.
3469
3470  That's a pitty that gcc cannot inline functions placed in other files
3471   alone. We have to choose between:
3472   - break the encapsulation (by putting private data structures and
3473     accessors in headers files to help gcc)
3474   - live with low performance
3475   - switch to a decent compiler such as icc (not quite possible).
3476
3477  -- Da SimGrid team <simgrid-devel@lists.gforge.inria.fr> Thu, 20 Aug 2009 21:21:33 +0200
3478
3479 SimGrid (3.3.2) stable; urgency=low
3480
3481  The "Simplicity does not preceed complexity, but follows it" release.
3482
3483  The main contributors of this release were (lexical order):
3484    Silas De Munck, Stéphane Genaud, Martin Quinson, Cristian Rosa.
3485
3486  SURF:
3487   * Extract the routing logic into its own object.
3488     (was dupplicated in network.c and workstation_LV07.c;
3489      Allows to implement other ways of storing that info)
3490     => kill now useless network_card concept
3491     - Use dynar to represent routes (instead of void** + int*)
3492     - kill link_set (use surf_network_model->resource_set instead)
3493     - Add a command-line option to choose the routing schema to use
3494     - Add three new models:
3495       * Floyd (shortest path computed at initialization)
3496       * Dijikstra (shortest path recomputed all the time)
3497       * Cached Dijikstra (shortest path computed on need)
3498       All these models where contributed by Silas De Munck, and are
3499       described in his ICCS09 paper.
3500
3501   * Simplify model declaration
3502     (less redirections, less function to write when defining a model)
3503     - Factorize stuff between models:
3504       - model_init/exit
3505       - Set of resources:
3506         surf_model_resource_set(model)
3507         surf_model_resource_by_name(model, name)
3508     - Unify the types of models in s_surf_model_t (using an union)
3509     - Embeed fields of common_public directly into s_surf_model_t
3510     - Rename model methods:
3511       action_free ~> action_unref
3512       action_change_state ~> action_state_set
3513       action_get_state    ~> action_state_get
3514     - Change model methods into functions:
3515       (model)->common_public->action_use  ~> surf_action_ref
3516
3517   * Implement a generic resource; use it as ancestor to specific ones
3518     (allows to kill duplicated code in models)
3519     Drawback: timer command don't need no name nor properties;
3520               workstation_CLM03 don't need no properties
3521     (but I guess we can live with those few bytes wasted)
3522
3523   * Improve the action object model
3524     - implement a constructor avoiding dupplicated code about field
3525       initialization in generic_action part.
3526
3527   * Kill the SDP model: it has an external dependency, is deprecated
3528     in flavor of modern lmm models, and didn't compile since a while
3529
3530  SIMIX:
3531   * Relocation of the context module from XBT to SIMIX.
3532     (the context were decoupled from the simix processes, duplicating a lot of code)
3533     => a lot of code was factorized
3534     - less overhead is introduced during scheduling
3535     - simpler API for the context factory
3536     - the logic for process creation,destruction and manipulation was simplified
3537   * Simplification of the s_smx_process_t data structure.
3538     => accesing the simix level data associated to a process is faster now,
3539        and the code is a lot more readable.
3540
3541  SMPI:
3542   * Implement some more MPI primitives:
3543     MPI_Bcast, MPI_Waitany, MPI_Waitall, MPI_Reduce, MPI_Allreduce, MPI_Scatter, MPI_Sendrecv, MPI_Alltoall
3544     -implementation: Bcast: flat or 2-ary tree (default),
3545                      Barrier: 4-ary tree,
3546                      Reduce: flat tree
3547                      Allreduce: Reduce then Bcast
3548                      Alltoall: "basic_linear" if data per proc < 3Kb, "otherwise pairwise".
3549                                Not yet implemented: "Bruck" for data per proc < 200b and comm size > 12
3550                      Alltoallv: flat tree, like ompi
3551                      Scatter: flat tree
3552   * Add support for optimized collectives (Bcast is now binomial by default)
3553   * Port smpirun and smpicc to OS X
3554
3555  SimDag:
3556   * Kill SD_link_get_properties: hard to maintain and makes very little sense
3557     Shout out if you used it.
3558
3559  GRAS:
3560   * Display the list of still queued messages in SG mode when existing
3561     the process.
3562
3563  XBT:
3564   * Add xbt_set_get_by_name_or_null() [Silas De Munck]
3565   * Add xbt_graph_node_get_outedges() [Silas De Munck]
3566   * Add xbt_str_from_file(FILE*)
3567   * Add xbt_dict_get_key achieving a linear reverse search
3568   * Remove the context module
3569
3570  Portability report of this version:
3571   * Main portability targets:
3572     - Linux(debian)/x86/context
3573     - Linux(debian)/x86/pthreads
3574     - Linux(debian)/amd64/context
3575     - Linux(debian)/amd64/pthreads
3576     On these, we still have the eratic breakages of gras/pmm and
3577       amok/saturate_sg reported in previous version. We still think
3578       that the tests are the cause of the fault, not the tested code.
3579
3580     - Mac OSX Leopard/x86/context
3581     Still false negative in tesh autotesting.
3582     Smpi still fails, but this time because readlink does not accept -f
3583     Everything seems to work properly beside of that.
3584
3585   * Exotic platforms:
3586     - AIX version 5.3 (only tested contexts this time)
3587       Smpi still fails there because mktemp is not installed.
3588       Everything seems to work properly beside of that.
3589     - OpenSolaris 11
3590       I managed to compile it for the first time, but several breakages.
3591       Won't delay the release for this exotic platform.
3592
3593   * Windows: it's still lagging behind. If you want to help, please
3594     stand up.
3595
3596  Timing report of this version:
3597   This version seem to be more than 5% faster than 3.3.1 (on linux
3598     64bits with contextes). The gain is less than expected, we are
3599     investigating this for next release.
3600
3601  -- Da SimGrid team <simgrid-devel@lists.gforge.inria.fr> Wed, 19 Aug 2009 17:07:12 +0200
3602
3603 SimGrid (3.3.1) stable; urgency=low
3604
3605  OVERALL CHANGES:
3606   * Implement a --cfg-help to show existing configuration variables
3607   * Build chain do not require doxygen in maintainer mode
3608
3609  GRAS:
3610   * fix a bug on struct sizeof computation, which prevented the
3611     exchange of arrays of structs in some conditions
3612     - added a regression test about this in datadesc_usage
3613   * Allow the exchange of 0-long dynamic vectors.
3614     - for that, use -1 as indicator of dynamic size instead of 0
3615     - This implied to change any size from unsigned long to long,
3616       reducing a bit communication abilities, but I guess that with
3617       64bits being quite common, this is more than enough.
3618     - This also induce a protocol change, thus bumping network protocol
3619       version from 0 to 1 (if we have external users, we have to get
3620       clean on that point too ;)
3621     - added two regression tests about this in datadesc_usage
3622   * Be more verbose when propagating local exceptions
3623     This helps debugging.
3624   * Display the status of simulated processes when receiving SIGINT in
3625     simulation mode
3626
3627  MSG:
3628   * Allow to control the simulation from a trace file.
3629     New functions MSG_action_register() and MSG_action_trace_run()
3630     The first one allows to associate a function execution to each
3631      kind of action while the second one parses a trace file and
3632      triggers the corresponding actions within the system.
3633     For now, only a toy example is provided in examples/msg/actions
3634   * Add an example of process migration in examples/msg/migration
3635   * Fix a bug in task exchange which broke MSG_task_get_sender()
3636     Add a teshsuite regression test for that.
3637     [Bug: if MSG_task_get_sender() is called after sender exit,
3638      bad things happen]
3639   * Fix a bug which prevented suspend/resume to work properly
3640   * Display the status of simulated processes when receiving SIGINT
3641     This fixes a regression of v3.3. due to the introduction of SIMIX
3642   * Bug fixing in failure management:
3643     - trace could not start by a failure at time 0
3644     - failure during communications were not working
3645
3646  SIMIX:
3647   * Add SIMIX_process_set_name() to change the name of the current
3648     process in the log messages.
3649   * Store smx_hosts in a dict since we only retrieve them by name
3650   * Move the configuration infrastructure to surf
3651
3652  SIMDAG:
3653   * Move the configuration infrastructure to surf
3654
3655  SMPI:
3656   * Massive internal cleanups:
3657     - Store internal structures on processes instead of hosts (allows
3658       to have more than one process per host, in addition of being more
3659       logical)
3660     - Cleanup the initialization/finalization process
3661     - Kill a whole bunch of unneeded synchronization:
3662       processes run in exclusive manner within the simulator
3663     - Move queues from global tables to process data fields
3664   * Improve smpirun:
3665     - now accept -platform and -hostfile arguments
3666     - Pass the right rank value to processes according to the hostfile
3667   * Compile the examples by default, and use them as regression tests
3668   * Implement MPI_Wtime()
3669   * Change the reference speed to a command line option
3670
3671  SURF:
3672   * TCP_gamma can now be specified as command line option using
3673     --cfg=TCP_gamma:10000000.0
3674   * Change the --surf-path cmd line option into --cfg=path:
3675
3676  XBT:
3677   * Also include strbuff from xbt.h public header
3678   * xbt_ex_display(): do not free the exception after displaying
3679     This allows to do more with the given exception afterward.
3680     Users should call xbt_ex_free() themselves.
3681
3682
3683
3684  Portability report of this version:
3685   * Main portability targets:
3686     - Linux(debian)/x86/context
3687     - Linux(debian)/x86/pthreads
3688     - Linux(debian)/amd64/context
3689     - Linux(debian)/amd64/pthreads
3690     These targets fail about 1/10 of times on gras/pmm, but we believe
3691       that this is because of the test, not because of simgrid.
3692     amok/saturate_sg fails even more rarely, and the test may not be
3693       the problem.
3694
3695     - Mac OSX Leopard/x86/context
3696     The test suite still spits tons of errors because some obscure
3697       force prevents us from removing the temporary directories
3698       arguing that they still contain some metadata I've never heard of.
3699     Smpi fails because seq is not installed.
3700     Everything seems to work properly beside of that.
3701
3702   * Exotic platforms:
3703     - AIX version 5.3 (both contexts and pthread)
3704       Smpi still fails there because mktemp is not installed.
3705       XML inclusions seems rosty on AIX.
3706
3707   * Windows: it's still lagging behind. If you want to help, please
3708     stand up.
3709
3710  -- Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>  Sat, 27 Jun 2009 00:14:30 +0200
3711
3712 SimGrid (3.3) stable; urgency=high
3713
3714  OVERALL CHANGES:
3715
3716   * JAVA BINDINGS for MSG (you dreamt of them? We made them)
3717     [Malek Cherier & Mt]
3718
3719   * Introduce the SIMIX module: factorize code between MSG and GRAS.
3720     [Bruno Donassolo]
3721
3722     Until now, GRAS were using MSG as an interface to SURF. It was
3723     quite difficult because both interface have several differences
3724     (MSG channels vs GRAS sockets were the most notable point).
3725
3726     This also opens the gate to SMPI (which should occur soon) and speed
3727     up simulations by to 40% (even if it were not the main goal).
3728
3729     **************************************
3730     *DO NOT MIX 3.2 RESULTS WITH 3.3 ONES* Simix may changes simulations!
3731     **************************************
3732     The point is that events occurring at the exact same timestamp are
3733     not scheduled in the same order with the old and new version. This
3734     may be enough to completely change the execution of simulations in
3735     some cases. Sorry for the inconvenience.
3736
3737   * Cleanup and upgrade the XML format to push further scalability
3738     issues (check http://hal.inria.fr/inria-00256883/ for more info)
3739
3740   * Improve the testing infrastructure with tesh. Now a very large part of
3741     the code is tested not only by being run but also by checking that the
3742     output match an expected output [Mt].
3743
3744   * Move on to FleXML v1.7 for the embeeded XML parsers. This version
3745     is really less memory-demanding, which should allow you to use
3746     larger files in SimGrid [AL].
3747
3748   * Inform valgrind about our contextes, so that it becomes usable
3749     with the default (and more effecient) version of SimGrid
3750     [contributed by Sékou Diakite, many thanks]
3751
3752  GRAS:
3753   * Introduce a listener thread in charge of receiving incoming
3754     messages from the network. It allows to overlap communication and
3755     computation but most notably, it removes some stupid deadlocks due
3756     to the fact that so far, a process could not send and receive at
3757     the same time. This made most non trivial communication schema
3758     impossible.
3759   * Convert the PIDs from long int to int to match the MSG ones (and
3760     linux ones too) [Mt]
3761   * New function: gras_agent_spawn() to launch a new process on
3762     current host. Only working in simulation for now. [Mt]
3763   * New function: gras_os_hostport() returning a constant form (ie,
3764     not needing to be freed) of "gras_os_hostname():gras_os_myport()"
3765
3766  XBT:
3767   * Make the backtrace of exceptions more human readable [Mt]
3768   * New module: xbt/str [Mt]
3769     a ton of string utility functions (split, join, printf to a newly
3770     allocated buffer, trim, etc)
3771   * New module: xbt/hash [Mt]
3772     SHA1 hashing algorithm (more to come if needed)
3773   * New module: xbt/synchro [Mt]
3774     synchronization tools (mutex and conditions) working the same way
3775     in simulation and in real life (mainly useful for GRAS, but not
3776     only).
3777   * New module: xbt/queue [Mt]
3778     classical producer/consumer synchronization scheme
3779   * xbt_dynar_new_sync() creates a synchronized dynar. All access
3780     (using the classical functions will get serialized) [Mt]
3781   * Make dictionary internal table dynamic. No need to specify its size
3782     anymore; functions xbt_dict_new_ext() and xbt_dict_hashsize_set()
3783     thus dropped. [Mt].
3784   * Make sure the log channels are organized as a tree under windows
3785     (because of ANSI C compatibility issue, any channel were child of
3786      root directly) [Mt].
3787
3788  SURF:
3789   * Cleaned many thing in surf and fixed a few bugs [AL].
3790   * Add a nice command line configuration mechanism to compose models [AL].
3791   * Add a new model for parallel tasks (ptask_L07) that is less buggy than
3792     the previous one (KCCFLN05). It relies on something that looks like
3793     a max-min sharing mechanism but cannot be written as such. A new solver
3794     was thus designed [AL].
3795   * Add a new solver to lmm. Based on Lagrange optimization and
3796     gradient-based descent, it enables to efficiently maximise systems s.a
3797
3798      sum f_i(x_i) s.t Ax<= b  with A_{i,j}>=0 and f_i a concave function.
3799
3800     This solver enables to propose two new network models for TCP Reno and
3801     TCP Vegas based on Low's work. These models still need to be fully
3802     tested though [Pedro Velho].
3803
3804  SIMDAG [AL]:
3805   * Bug fix in SD_simulate. Now the time bound given as argument is
3806     used.
3807   * Use the new parallel task model (ptask_L07) as default.
3808   * Use the SURF command line configuration mechanism.
3809   * 0-size tasks (for synchronization) should now work.
3810
3811  -- Da SimGrid team <simgrid-devel@lists.gforge.inria.fr> Sun Apr 12 05:20:36 CEST 2009
3812
3813 SimGrid (3.2) stable; urgency=high
3814
3815   OVERALL CHANGES:
3816    * Port to windows.
3817      We still experience issues on this platform, but we believe that at
3818      least MSG is usable.
3819
3820   GRAS API BREAKAGE (for simplification purpose, sorry):
3821    * the gras_msgtype_by_name is not used anymore. Instead of
3822        gras_msg_send(toserver, gras_msgtype_by_name("request"), &request);
3823      you can write (and must)
3824        gras_msg_send(toserver, "request", &request);
3825    - If you still want to pass a gras_msgtype_t to the function (to cache
3826      the type and avoid the lookup time), use the gras_msg_send_() variant.
3827    - Impacted functions:
3828      gras_cb_register, gras_cb_unregister, gras_msg_send, gras_msg_wait,
3829      gras_msg_rpccall, gras_msg_rpc_async_call, gras_msg_wait_ext
3830    * The callbacks are now expected to return 0 when everything went well
3831      (just like the main() function)
3832
3833   GRAS new features and improvements:
3834   * New module mechanism where user code can use per process globals [Mt]
3835     This is similar to gras_userdata_*() functions, but for libraries. It
3836       factorize some code developped over and over in the examples and AMOK.
3837     It has still to be documented and used (only amok/peermanagement is
3838       converted for now).
3839   * Fix a vicious bug in the TCP buffering mechanism which leaded to message
3840     loss when they were small enough to fit into the buffer and sent quickly
3841     enough so that they can all get received in one shoot.
3842   * gras_datadesc_by_name and gras_msgtype_by_name: now raise an exception
3843     if not found. Use the *_or_null() variant for the old semantic.
3844   * In gras_msg_handle, do not discard messages without callback.
3845     They are probably messages to be explicitly awaited later (ie, proofs of
3846     mis-synchronization in userland since they are sent before being awaited)
3847     No big deal usually.
3848   * gras_socket_meas_send/recv: semantic changed!
3849     The numerical arguments used to be (1) the total amount of data to send
3850     and (2) msg_size. This was changed to (1) msg_size and (2) amount of
3851     messages. This was need for the fool willing to send more than MAXINT
3852     bytes on quite fat pipes.
3853
3854   AMOK:
3855   * Do really rename the hostmanagement module to peermanagement. [Mt]
3856     Ie, rename functions from amok_hm_* to amok_pm_*. This breaks the API,
3857     but this is rather new and this was documented in the module
3858     documentation (poor excuses, I admit)
3859   * Bandwidth measurement semantic changed! This follows the changes to
3860     gras_socket_meas_send/recv explained above.
3861
3862   SIMDAG:
3863   * A sequential mode has been added to the workstations. When a workstation
3864     is in sequential mode, it can execute only one task, and the other tasks
3865     are waiting in a FIFO. [Christophe Thiery]
3866
3867   SURF:
3868   * The KCCFLN05 workstation model now handles parallel tasks. It is the
3869     model for SIMDAG. [Christophe Thiery]
3870   * Bug fix in the maxmin solver: Some values were close to 0 instead of
3871     equal to 0, which caused some bad behaviors in
3872     saturated_constraint_set_update. I now use a threshold mechanism like in
3873     surf. [AL]
3874
3875   XBT:
3876   * When running manually src/testall, you select specific units [Mt]
3877     testall is the result of our cunit mechanism, and should replace all
3878     the scripty thingy around since bash don't run easily on billware.
3879
3880   * A mallocator system has been added. [Christophe Thiery]
3881     Mallocators allow you to recycle your unused objects instead of freeing them
3882     and allocating new ones.
3883
3884   Documentation update:
3885   * FAQ reworking + New FAQs:
3886     - "Valgrind spits tons of errors!" [Mt]
3887     - "How to repport bugs" [Mt]
3888     - "Cross-compiling a Windows DLL of SimGrid from Linux" [Mt]
3889     - "What is the difference between MSG, SimDag, and GRAS?" [Mt]
3890     - Communication time measurement within MSG [AL]
3891     - I experience weird communication times when I change the latency [AL]
3892   * GRAS tutorial [Mt]
3893     It contains:
3894      - an introduction to the framework and to the used communication model
3895      - an initiatic tour introducing the most proheminent features:
3896        o Part 1: Bases
3897          . Lesson 0: Installing GRAS
3898          . Lesson 1: Setting up your own project
3899        o Part 2: Message passing
3900          . Lesson 2: Exchanging simple messages
3901          . Lesson 3: Passing arguments to the processes (in SG)
3902          . Lesson 4: Attaching callbacks to messages
3903          . Lesson 5: Using globals in processes
3904          . Lesson 6: Logging information properly
3905          . Lesson 7: Using internal timers
3906          . Lesson 8: Handling errors through exceptions
3907          . Lesson 9: Exchanging simple data
3908          . Lesson 10: Remote Procedure Calling (RPC)
3909          . Lesson 11: Explicitly waiting for messages
3910          . Recapping of message passing features in GRAS
3911      - A HOWTO section containing:
3912        o HOWTO design a GRAS application
3913        More are due, of course. They will come latter. In the meanwhile, you can
3914        check the examples which are still here.
3915
3916  -- Da SimGrid team <simgrid-devel@lists.gforge.inria.fr> Fri Mar 16 21:11:46 CET 2007
3917
3918 SimGrid (3.1) stable; urgency=high
3919
3920   General:
3921   * Port to gcc 4.x
3922     There was a stack corruption somewhere, visible only when optimizing
3923     with these versions. [Vince]
3924
3925   SIMDAG:
3926   * This is a NEW module! SimDAG (SD for short) is a revival of the old SG
3927     module that enabled to play with Directed Acyclic Graphs. It is built
3928     directly on top of SURF and provides an API rather close to the old
3929     SG. Some old codes using SG are currently under rewrite to check that
3930     all needful functions are provided. [Christophe Thiery]
3931
3932   SURF:
3933   * Complete rewrite of the KCCFLN05 workstation model. It is now an
3934     extension of the classical CLM03 model that gracefully handles
3935     failures. This is now the default model for MSG and GRAS. It doesn't
3936     handle parallel tasks yet though. [AL]
3937   * Bug fix: Weights were not correctly set in the network part.
3938     WARNING: This may have resulted in incorrect results with simulations
3939     where there are more than one flow on a given link. [AL]
3940
3941   SURF, MSG, GRAS:
3942   * After a (long ?) discussion on simgrid-devel, we have decided that the
3943     convention we had on units was stupid. That is why it has been decided
3944     to move from (MBits, MFlops, seconds) to (Bits, Flops, seconds).
3945     WARNING: This means that all previous platform files will not work as
3946     such with this version! A warning is issued to ask users to update
3947     their files. [AL]
3948     A conversion script can be found in the contrib module of the CVS, under
3949     the name contrib/platform_generation/surfxml_update.pl [MQ]
3950
3951   MSG,GRAS:
3952   * Bug fix: Processes were started in reverse order, wrt deployment file.
3953     WARNING: if your code relies on this bug, please fix it.    [AL]
3954   * Bug fix: Add a test in MSG_task_execute to stop whenever a task is
3955     being executed on two different locations.                  [AL]
3956   * Bug fix: Failures are now better supported thanks to Derrick's tests
3957     (there was many failure situations I hadn't thought of and that weren't
3958     correctly handled). [AL]
3959   * New function: MSG_host_is_avail indicates you whether a given m_host_t
3960     is up or down. [AL]
3961
3962   GRAS:
3963   * New! a real RPC mechanism, as it ought to be since too long. [MQ]
3964       Exception occurring on server-side are propagated back to client (!).
3965
3966     API CHANGE: the callback changed their prototype. Change:
3967         int my_handler(gras_socket_t expeditor, void *payload_data) {
3968       to:
3969         int my_handler(gras_msg_cb_ctx_t ctx  , void *payload_data) {
3970           gras_socket_t expeditor=gras_msg_cb_ctx_from(ctx);
3971       and you're set.
3972   * New! function: gras_msg_handleall to deal with all messages arriving
3973       within a given period.
3974   * New! function: gras_socket_server_range to get a server socket in a
3975     range of port numbers (ease to avoid port number conflicts) [MQ]
3976   * New! gras processes display their backtrace when they get a SIGUSR1
3977       or when Ctrl-C is pressed. Use Ctrl-C Ctrl-C to exit.
3978       Sweet to debug RL processes [MQ]
3979
3980   AMOK:
3981   * Bandwidth module:
3982     - Do not force experiment sizes to be expressed in kb, or it becomes
3983       impossible to measure the latency this way (needs one byte-long tests)
3984     WARNING: this changes the amok_bw_* function semantic. [MQ]
3985     - Implements the link saturation stuff. [MQ]
3986   * Peer management module:
3987     New! module factorizing code that we wrote over and over [MQ].
3988
3989   XBT:
3990   * New module: cunit (my jUnit implementation in ansi C) [MQ]
3991     - Test units are placed directly into the library code, they get extracted
3992       automatically and placed into the src/testall binary.
3993     - Convert most of the XBT tests to this system.
3994   * New functions: xbt_dynar_getfirst_as() and xbt_dynar_getlast_as() [MQ]
3995   * XML parsing: rewrote parts of flexml to enable multiple xml parsers to
3996     live in the same C code. This required to change a little bit the API
3997     of surfxml parsing but shouldn't be an issue for end-users. [AL]
3998   * New module: sparse graph structure with basic algorithms (this is work
3999     in progress and the API is not considered to be frozen yet). [AL]
4000   * Display more information on backtraces: source line & function names are
4001     now displayed just like valgrind does (rely on addr2line tool) [MQ]
4002   * New function: xbt_backtrace_display(). Sweet while debugging [MQ]
4003   * Reworked a little bit some #include statements to load only required
4004     headers. Some user code that relied on SimGrid to include stdlib or
4005     stdio may need to include it by themselves. [AL]
4006   * Fixed xbt/log.h. A missing SG_BEGIN_DECL prevented compilation with
4007     g++. [AL]
4008   * Renamed xbt_host_t into xbt_peer_t since it betterly describes what I
4009     meant. This breaks the API of AMOK and of xbt/config. Sorry about this,
4010     but I guess that almost nobody used those parts. [MQ]
4011
4012  -- Da SimGrid team <simgrid-devel@lists.gforge.inria.fr> Fri, 14 Jul 2006 01:32:27 +0200
4013
4014 SimGrid (3.0.1) stable; urgency=low
4015
4016   XBT:
4017   * Unfortunately, I had missed 5 misnamed functions:
4018       xbt_fifo_item_t xbt_fifo_newitem(void);
4019       void xbt_fifo_freeitem(xbt_fifo_item_t);
4020       xbt_fifo_item_t xbt_fifo_getFirstItem(xbt_fifo_t l);
4021       xbt_fifo_item_t xbt_fifo_getNextItem(xbt_fifo_item_t i);
4022       xbt_fifo_item_t xbt_fifo_getPrevItem(xbt_fifo_item_t i);
4023     They're now deprecated. Please use their new versions:
4024       xbt_fifo_item_t xbt_fifo_new_item(void);
4025       void xbt_fifo_free_item(xbt_fifo_item_t);
4026       xbt_fifo_item_t xbt_fifo_get_first_item(xbt_fifo_t l);
4027       xbt_fifo_item_t xbt_fifo_get_next_item(xbt_fifo_item_t i);
4028       xbt_fifo_item_t xbt_fifo_get_prev_item(xbt_fifo_item_t i);
4029     [AL]
4030   * Bugfix: really disconnect fifo items which are remove_item()ed [AL]
4031   * Documentation: xbt_log module unmercifully reworked [MQ]
4032   * Bugfix: there was a problem with the ending of contexts with
4033     the pthread backend. It caused some weird deadlock or behavior
4034     depending on the pthread implementation. [AL]
4035   * Bugfix: get the exceptions raised in the simulator repport where
4036     and why they come from when they are not caught in time [AL, MQ]
4037
4038   SURF:
4039   * Bugfix: Do repport the error when two non-connected hosts try to
4040     exchange data (Thanks to Flavien for stumbling into this one) [AL]
4041
4042   SURF:
4043   * Add additionnal checkings on communications. Assert that two
4044     communicating hosts are connected by a set of links... [AL]
4045
4046   MSG:
4047   * Add additionnal checkings on channel values in communication [AL]
4048   * New: MSG_task_get_source to see on which host a task was generated [HC]
4049   * New: int MSG_task_probe_from_host(int channel, m_host_t host): returns
4050     the number of tasks waiting to be received on channel and sent
4051     by host. [AL]
4052   * New: MSG_error_t MSG_task_get_from_host(m_task_t * task, int channel, m_host_t host);
4053     waits for the first task coming from a given host.. [AL]
4054
4055   GRAS new functionnalities: [MQ]
4056   * Enhance the parsing macro to allow the size of multidimentional objects
4057     to be given thru annotations.
4058   * New example (and documentation): Matrix Multiplication a la RPC
4059     (as when I was young!) and fix a bunch of bugs found on the way.
4060
4061   GRAS performance improvements: [MQ]
4062   [DataDesc]
4063   * Reduce the amount of cbps creation/destruction by making it static to
4064     datadesc_send/recv() and using a (newly created) cbps_reset (based on
4065     dynar_reset ())
4066   [Virtu]
4067   * Change libdata to a set so that we can search for stuff by ID (and thus
4068     reduce the insane amount of dict lookups)
4069
4070   [Transport]
4071   * Actually implement gras_datadesc_copy() so that we don't have to mimick
4072     RL communication on top of SG since it's so uneffective.
4073     It may also be used for inter-thread communication in RL, one day.
4074   * Use gras_datadesc_copy() to exchange messages on top of SG
4075     Allows to:
4076     - improve message exchange performance on top of SG
4077     - deprecate transport_plugin_sg.c:gras_trp_sg_chunk_send() & recv()
4078   * Don't exchange on the network the size of the used part of buffer,
4079     instead, specify the possible buffer size to read().
4080     Advantages:
4081      - reduces the amount of read/write calls (one pair per exchange)
4082      - reduces the amount of exchanged data (the size)
4083      - allows to retrieve all arrived data on receiver side, if we don't need
4084        it right now (subsequent read will peek the buffer)
4085      - allows the receiver to proceed with the beginning of the stream before
4086        everything is arrived
4087      - make it possible to build an iov transport (using readv/writev)
4088     Extra difficulty:
4089      - take care of the data with non-stable storage (like stacked data),
4090        and bufferize them.
4091   * If possible, TCP send uses vector I/O (when writev() is here)
4092      - Don't use it for receive since we send data sizes and data on the
4093        same stream, so we wouldn't be able to chain large amount of chunks
4094        before having to flush the stuff to read the size.
4095   * Rework the transport plugin mechanism to simplify it and reduce the
4096     amount of pointer dereferencement when searching for the right function
4097     to use.
4098
4099   * I guess that now, we do almost as few system calls as possible while
4100     doing as few data copy as possible.
4101
4102     To improve it further, we could try to send all the sizes first and then
4103     all the data (to use iov on receiving size), but it's only a partial
4104     solution: when you have 2 dimensional data, the sizes of the second
4105     dimension is data of the first dimension, so you need 3 streams.
4106
4107     I'm not sure the potential performance gains justify the coding burden.
4108
4109  -- Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>  Fri, 21 Oct 2005 14:42:20 +0200
4110
4111 SimGrid (3.00) stable; urgency=high
4112
4113  SURF:
4114   * New! Give the possibility to hijack the surf parser and thus bypass
4115     MSG_create_environment and MSG_launch_application. Have a look at
4116     examples/msg/msg_test_surfxml_bypassed.c to see how it can be done.
4117
4118  -- Arnaud Legrand <simgrid-devel@lists.gforge.inria.fr>  Sat, 20 Aug 2005 23:25:25 -0700
4119
4120 SimGrid (2.96) unstable; urgency=low
4121
4122   AKA SimGrid 3 rc 2.
4123
4124   XBT:
4125   * New! Exception handling with setjmp or such (code from OSSP ex) [MQ]
4126     This deprecates the xbt_error_t mechanisms.
4127     It modifies (simplifies) all XBT and GRAS API.
4128     MSG API keeps unchanged (exceptions raised by XBT are caught from
4129      within MSG and masked with existing error handling facilities)
4130
4131   SURF:
4132   * New! Add a FATPIPE model. [AL]
4133   * New! Add a parallel task model. [AL]
4134   * New! Add automatically a loopback interface (in the default
4135     network model) if none was precised.
4136
4137   MSG
4138   * Bugfix: MSG_process_resume now works with the current running process.
4139     [AL]
4140   * New! Add MSG_parallel_task_create and MSG_parallel_task_execute. [AL]
4141   * Modification of MSG_task_get_compute_duration. Once a task has been
4142     processed, the value returned by this function is now equal to 0. [AL]
4143   * New! Add double MSG_task_get_remaining_computation(m_task_t task) and
4144     MSG_error_t MSG_task_cancel(m_task_t task). Add a state
4145     (MSG_TASK_CANCELLED) to MSG_error_t corresponding to the cancelation
4146     of a m_task. For now, MSG_task_cancel only works with computation
4147     tasks. [AL]
4148   * New! Add double MSG_get_host_speed(m_host_t h) that returns the speed
4149     of the processor (in Mflop/s) regardless of the current load on the
4150     machine. [AL]
4151   * API Change: use proper naming convention for MSG_getClock and
4152     MSG_process_isSuspended: MSG_get_clock and MSG_process_is_suspended.
4153     [AL]
4154   * New! Add void MSG_task_set_priority(m_task_t task, double priority).
4155     This function changes the priority of a computation task. This priority
4156     doesn't affect the transfer rate. A priority of 2 will make a task
4157     receive two times more cpu power than the other ones. This function
4158     has been added to suit the needs of Nguyen The Loc and hasn't been that
4159     much tested yet. So if it fails, please report it and send me your code.
4160     [AL]
4161   * API Change: removed all functions and types that were marked "deprecated"
4162     since many months. Renamed MSG_global_init_args to MSG_global_init.
4163
4164  -- Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>  Mon,  8 Aug 2005 17:58:47 -0700
4165
4166 SimGrid (2.95) unstable; urgency=low
4167
4168   XBT
4169   * Steal some nice code to GNU pth to fix context detection and usage [AL]
4170   * Cleanup in the xbt_config API; add configuration callbacks. [MQ]
4171   * Cleanup in the initialization API: the unused "defaultlog" is dead. [MQ]
4172
4173   SURF
4174   * Bugfix: Allow absolute paths for platform description files [MQ]
4175   * Bugfix: do free the variables after use. Leads to drastic performance
4176     improvement [AL]
4177   * Implement max_duration (ie, timeouts) on resources [AL]
4178
4179   MSG
4180   * Implement MSG_config to configure MSG at runtime. xbt_cfg test on a real
4181     case ;) [MQ]
4182   * Implement MSG_channel_select_from() to help GRAS now that SURF provide
4183     the needed support (timeouts) [AL]
4184
4185   GRAS (new features)
4186   * Implement measurement sockets. You can now get the bandwidth between two
4187     hosts thanks to AMOK (see below). [MQ]
4188   * gras_datadesc_dynar() builds a dynar type descriptor, allowing to send
4189     dynar over the network (yeah) [MQ]
4190   * Real (even if simplistic) implementation of gras_os_myname() on RL [MQ]
4191   * simple/static token-ring example. [Alexandre Colucci and MQ]
4192   * Use MSG_channel_select_from() and remove the *slow* hack we had to put
4193     in place before [MQ]
4194
4195   GRAS (bug fixes)
4196   * Differentiate the types "char[22]" and "unsigned char[22]" in automatic
4197     type parsing. "short" and "long" modifiers were also ignored; other
4198     modifier (such as reference level) are still ignored. [MQ]
4199   * Embeed the buffer size within the buffer itself on SG. [MQ]
4200     That way, send() are atomic and cannot get intermixed anymore (at least
4201     the ones which are less than 100k; bigger messages still have the issue)
4202   * Array size pushed by the field, not by the field type (or each
4203     and every long int will push stuff to the cbps) [MQ]
4204   * use select() to sleep since it allows to portably sleep less than one
4205     second. [MQ]
4206
4207   GRAS (minor cleanups)
4208   * <project>.Makefile.local (generated from gras_stub_generator) |MQ]:
4209     - Do clean .o files
4210     - Compile with -g
4211   * Type Callbacks now receive the gras_datadesc_type_t they work on as argument.
4212   * type category 'ignored' killed as it was never used and were difficult
4213     to transmit.
4214   * whether a type can cycle or not is now a flag, leaving room for more
4215     flags (as "ignored", if we feel the need one day ;)
4216   * Rename raw sockets to measurement sockets since "raw" has another
4217     meaning in networking community.
4218
4219   AMOK
4220   * Advanced Metacomputing Overlay Kit introduction. It is based over GRAS
4221     and offers features not belonging to GRAS but that most applications
4222     need. One day, it may be a set of plugins loadable at runtime.
4223   * New module: bandwidth
4224     bandwidth measurement between arbitrary nodes running this module. [MQ]
4225
4226  -- Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>  Thu, 30 Jun 2005 16:29:20 -0700
4227
4228 SimGrid (2.94) unstable; urgency=low
4229
4230   The first beta release of SimGrid 3 !
4231
4232   >>>Arnaud<<<
4233   (documentation)
4234   * Update the main page and the FAQ. Adding references to gforge.
4235
4236   (gras)
4237   * Add a gras_os_getpid function.
4238
4239   (msg)
4240   * Add MSG_task_get_compute_duration() and MSG_task_get_data_size()
4241   * Extend the logs so that they also print PID, hostname, date, ... if
4242     available.
4243   * Convert the MSG example to the use of xbt_logs instead of PRINT_MESSAGE,
4244     and kill the old version which were in testsuite/
4245   * Rewrite tools/MSG_visualization/colorize.pl for using with logs instead
4246     of PRINT_MESSAGE
4247
4248   (xbt)
4249   * Add xbt_os_time(). As the rest of xbt/portability, this is not public
4250     for users. Instead, each programming environment (GRAS, MSG,...) use it
4251     when needed to provide such a feature to users.
4252     Don't shortcut the mechanism or you will also shortcut the virtualization
4253     you need on the simulator.
4254
4255   >>>Martin<<<
4256   (infrastructure)
4257   * Cleanups in configury with regard to compile optimization/warning flags.
4258     Also add -fno-loop-optimize to any powerpc since it's the optimization
4259     killing gcc (< 3.4.0).
4260   * Doxygen cleanups: move MSG examples, kill the second Doxygen phase
4261     needed by MSG examples complications
4262   * Borrow configury beautifications from PHP
4263
4264   (xbt)
4265   * Bugfix: XBT_LOG_NEW_DEFAULT_CATEGORY now compiles without compiler
4266     warning (thanks loris for stumbling into this one).
4267   * Bugfix: stop loading private headers (gras_config.h) from the public
4268     ones (xbt/swag.h).
4269
4270   (gras)
4271   * Change SIMGRID_INSTALL_PATH to GRAS_ROOT in Makefiles generated for user.
4272   * Rename gras_get_my_fqdn to gras_os_myname and implement it in the simulator
4273     RL would imply a DNS resolver, which is *hard* to do in a portable way
4274     (and therefore delayed).
4275   * Implement a real timer mechanism and use it in timing macros. This allows
4276     to avoid rounding errors and get a 0.000005 sec precision in timing
4277     macros. While I was at it, various cleanups:
4278      - allow to declare more than one timed section per file (fix a stupid bug)
4279      - move some private declaration to the right place
4280      - merge conditional execution and timing macros into emulation module
4281      - document the module
4282      - make sure the module cleanups its mess on gras_exit
4283   * Documentation improvements:
4284      - (new) how to compile applications using GRAS
4285      - (new) emulation support (timing macros)
4286
4287  -- Da SimGrid team <simgrid-devel@lists.gforge.inria.fr>  Fri, 13 May 2005 10:49:31 +0200
4288
4289 SimGrid (2.93) unstable; urgency=low
4290
4291   Alpha 4 on the path to SimGrid 3 (aka the "neuf-trois" version)
4292
4293   [Arnaud]
4294    - Use Paje properly where used. Still to be sanitized properly.
4295    - Portability fix: Add an implementation of the contexts using pthread
4296
4297   [Martin]
4298   (misc)
4299    - Add xbt_procname(): returns the name of the current process.
4300      Use it to show the current process's name in all logging.
4301   (infrastructure)
4302    - fix detection of older flex version and the reaction, since we do
4303      depend on modern ones (we use lex_destroy)
4304    - Better separation of SG and RL in the libs: remove all simulation code
4305      from libgras. As a result, this lib is now only 200k when stripped.
4306      Some of the xbt modules may also be duplicated (two sets and such) and
4307      should be cleaned/killed before SG3.
4308    - Insist on using xlC on AIX because of weird problems involving gcc there.
4309    - Cleanup the make remote stuff. This is now done by scripts
4310      tools/graspe-{master,slave} (GRAS Platform Expender). This is still
4311      mainly for our private use, but we're working on changing them to user
4312      tools, too.
4313   (gras)
4314    - Bugfix: flush the socket on close only if there is some *output*.
4315    - Bugfix: flush idempotent when there's nothing to send (don't send size=0)
4316   (msg)
4317    - Add MSG_task_get_name. The task names are mainly for debugging purpose,
4318      but anyway.
4319
4320  -- SimGrid team <simgrid2-users@listes.ens-lyon.fr>  Fri,  4 Mar 2005 14:32:37 -0800
4321
4322 SimGrid (2.92) unstable; urgency=low
4323
4324   Alpha 3 on the path to SimGrid 3
4325
4326   [Arnaud]
4327   (gras)
4328    - New! First try of benchmarking macros.
4329    - New! First try so that gras_stub_generator generate deployment and
4330      remote compilation helpers.
4331   (msg)
4332    - Bugfix: Initialization fix in msg_test.
4333
4334   [Martin]
4335   (surf)
4336    - Bugfix: applied patch to lexer so that it doesn't need a huge heap.
4337   (xbt)
4338    - Bugfix: let dicts work with NULL content (_foreach didn't) and cleanups
4339   (gras)
4340    - API Change: gras_os_sleep to take the amount of seconds as a double.
4341      Accepting an int was error prone since it was the only location where
4342      seconds were coded as such. It leaded to damn rounding errors.
4343    - Bugfix: Hard to belive that timers ever worked before this.
4344
4345  -- SimGrid team <simgrid2-users@listes.ens-lyon.fr>  Wed, 23 Feb 2005 22:09:21 +0100
4346
4347 SimGrid (2.91) unstable; urgency=low
4348
4349   Alpha 2 on the path to SimGrid 3
4350
4351   [Arnaud]
4352   (surf)
4353    - Bug fix in the lmm_solver.
4354   (msg)
4355    - New! Interface to Paje (see http://www-id.imag.fr/Logiciels/paje/)
4356      through the function MSG_paje_output.
4357    - New! Introducing two new functions MSG_process_kill() and MSG_process_killall().
4358    - It is possible to bound the rate of a communication in MSG with
4359      MSG_task_put_bounded() (was already in the previous version but I had forgotten
4360      to write it in the changelog).
4361    - Bug fix to let GRAS run on top of MSG until we move it directly on top
4362      of the SURF.
4363
4364   [Martin]
4365   (infrastructure)
4366    - Various cleanups to the autotools stuff
4367    - Begin to move Gras examples to examples/gras/
4368    - Let make distcheck work again (yeah!)
4369   (documentation)
4370    - documentation overhauled using doxygen.
4371      gtk-doc-tools is dead in SimGrid now.
4372    - Automatically extract all existing logging categories, and add the list
4373      to the documentation (long standing one, to say the less)
4374   (gras)
4375    - Cleanup the known architecture table. Reorder the entries to group what
4376      should be, and use a more consistent naming scheme.
4377      (some of the test dataset are still to be regenerated)
4378    - New! Allow library to register globals on each process just as userdata
4379      does.
4380       This is implemented using a xbt_dict and not a xbt_set, so we loose the
4381        lookup time (for now).
4382       Use it in msg and trp.
4383       This cleans a lot the internals and helps enforcing privacy of the
4384        headers between the gras components.
4385    - New! Add a timer mechanism, not unlike cron(8) and at(1).
4386    - Bugfix: gras_os_time was delirious in RL.
4387    - Bugfix: gras_trp_select/RL don't run into the wall when asked to select
4388      onto 0 sockets.
4389    - Reenable GRAS now that it works.
4390
4391  -- Arnaud Legrand <Arnaud.Legrand@imag.fr>  Mon, 14 Feb 2005 14:02:13 -0800
4392
4393 SimGrid (2.90) unstable; urgency=low
4394
4395   Alpha 1 on the path to SimGrid 3
4396
4397   * It is a long time since the last release of SimGrid. I'm sorry about
4398     that but as I had told you, I was rewriting a lot of things. I apologize
4399     to those who had been reporting bugs to me and that I had not answered.
4400     If your bug is still in the new version, please tell me. Here is a
4401     summary of the main changes.
4402
4403   * REVOLUTION 1: The SimGrid project has merged with the GRAS project
4404     lead by Martin Quinson. As a consequence SimGrid gains a lot in
4405     portability, speed, and a lot more but you'll figure it out later.
4406     SimGrid now comprises 3 different projects: MSG, GRAS and SMPI.
4407     I wanted to release the new MSG as soon as possible and I have
4408     broken GRAS, which is the reason why, for now, only MSG is fully
4409     functional. A laconic description of these projects is available
4410     in the documentation.
4411
4412   * REVOLUTION 2: I have removed SG and I am now using a new simulation
4413     kernel optimized for our needs (called SURF but only the developers
4414     should use it). Hence, MSG is now roughly 30 times faster and I think
4415     that by rewriting a little bit MSG, I could event speed it up a little
4416     bit more. Beside the gain in speed, it is also much easier to encode a
4417     new platform model with SURF than it was with SG. More to come...
4418
4419   * REVOLUTION 3: I have tried to change a little as possible the API of
4420     MSG but a few things really had to disappear. The main differences
4421     with the previous version are:
4422        1) no more m_links_t and the corresponding functions. Platforms are
4423          directly read from an XML description and cannot be hard-coded
4424          anymore. The same format is used for application deployment
4425          description. The new format is described in the documentation.
4426          Have a look in tools/platform_generation. There is a tiny script
4427          that converts from the old platform format to the new one. Concerning
4428          the application deployment format, parsing the old one is tricky.
4429          I think most of you should however be able to convert your files.  If
4430          it is really an issue, I can write a C code that does the conversion.
4431          Let me know.
4432        2) the toolbox tbx does not exist anymore. We now have a library
4433           with much more data-structures but without the hash-tables (we have
4434           dictionaries that are much faster).
4435
4436  -- Arnaud Legrand <Arnaud.Legrand@imag.fr>  Mon, 31 Jan 2005 10:45:53 -0800
4437
4438 *****************************************************************************
4439 * Follows the old GRAS changelog. It does not follow the same syntax, but I *
4440 * don't feel like converting the oldies. (Mt)                                *
4441 *****************************************************************************
4442
4443 2005-01-31 Arnaud
4444   Version 2.90: "the long awaited one"
4445   - Finished rewriting and debugging MSG. Rewrote the documentation.
4446   - disable GRAS for now since it needs to be ported to the newest SG
4447
4448 2004-12-16 Martin
4449   - Finish the port to windows (using mingw32 for cross-compile)
4450
4451 2004-11-28 Arnaud
4452   - Main loop and datastructures of SURF. A cpu resource object is
4453     functional. Surf can thus be used to create cpu's with variable
4454     performance on which you can execute some actions.
4455
4456 2004-11-15 Martin Quinson
4457   - Port to ARM. Simply added the alignment and size descriptions. Should
4458     work, but the ARM machines are so slow that I didn't had the opportunity
4459     to 'make check' over there yet.
4460
4461 2004-11-15 Arnaud Legrand
4462   - Trace manager now written. It uses a heap structure and is therefore
4463     expected to be efficient. It may however be speeded up (particularly
4464     when many events occur at the same date) by using red and black
4465     trees. One day maybe...
4466   - Max-min linear system solver written. It uses a sparse matrix
4467     structure taking advantage of its expected use. Most operations are
4468     O(1) and free/calloc are called as few as possible. The computation of
4469     the minimum could however be improved by using a red and black tree
4470     (again ! ;).
4471
4472 2004-11-03 Arnaud Legrand
4473   - Rename every gras_* function that was in xbt/ to its xbt_
4474     counterpart.
4475   - Add a heap and a doubly-linked list to xbt
4476   - Added a dichotomy to the dictionaries. make check works as well before
4477     so I assume that the patch is correct. I do not know however if things
4478     run effectively faster than before now. :)
4479
4480   Inclusion of the SimGrid tree in the GRAS one. The archive is renamed to
4481   SimGrid, and the version number is bumped to 2.x
4482
4483 2004-10-29 Martin Quinson
4484   - Introduction of the remote errors.
4485     They are the result of a RMI/RPC on the remote machine.
4486     ErrCodes being scalar values, you can't get the host on which those
4487     errors did happen. Extending the error mechanism as in Gnome is possible.
4488     No idea yet whether it is a good idea.
4489
4490 2004-10-28 Martin Quinson
4491   - Interface revolution: the Starred Structure Eradication.
4492     I used to do typedef struct {} toto_t; and then handle *toto_t.
4493     Arnaud (and Oli) didn't like it, and I surrendered. Now, you have:
4494       - ???_t is a valid type (builded with typedef)
4495       - s_toto_t is a structure (access to fields with .)
4496       - s_toto   is a structure needing 'struct' keyword to be used
4497       - e_toto_t is an enum
4498       -   toto_t is an 'object' (struct*)
4499     Example:
4500       typedef struct s_toto {} s_toto_t, *toto_t;
4501       typedef enum {} e_toto_t;
4502     Moreover, only toto_t (and e_toto_t) are public. The rest (mainly
4503      s_toto_t) is private.
4504
4505   - While I was at it, all gras_<obj>_free() functions want a gras_<obj>_t*
4506     so that it can set the variable to NULL. It was so for dicts and sets,
4507     it changed for dynars.
4508
4509   - Fix a bunch of memleaks in dict_remove
4510   - Fix a bug in sg/server_socket opening: it failed all the time.
4511
4512 2004-10-07 Martin Quinson
4513   - Speed up dynar lookup operation a bit.
4514
4515     gras_dynar_get is dead.
4516
4517     Now, you can choose between gras_dynar_get_cpy (the old gras_dynar_get
4518     but should be avoided for efficiency reasons) and gras_dynar_get_ptr
4519     (which gives you the address of the stored data).
4520
4521     gras_dynar_get_as is an helpful macro which allows you to retrieve a
4522     copy of the data using an affectation to do the job and not a memcpy.
4523
4524     int toto = gras_dynar_get_as(dyn,0,int); rewrites itself to
4525     int toto = *(int*)gras_dynar_get_ptr(dyn,0);
4526
4527     It does not really speedup the dynar test because they are
4528     setting elements all the time (and look them seldom). But the dict does
4529     far more lookup than setting.
4530
4531     So, this brings the dict_crash test from ~33s to ~25s (200000 elms).
4532
4533 2004-10-05 Martin Quinson
4534   - Allow to (en/dis)able the cycle detection at run time.
4535
4536     Whether we should check for cycle or not is now a property of each
4537     datatype. When you think there may be some cycle, use datadesc_cycle_set.
4538     datadesc_cycle_unset allow to remove this property when previously set.
4539
4540     Note that the cycle detection is off by default since it impacts the
4541     performance. Watch the data you feed GRAS with ;)
4542
4543     This property is hereditary. Any element embedded in a structure having it
4544     set have it set for the time of this data exchange.
4545
4546     You should set it both on sender and receiver side. If you don't set it on
4547     sender side, it will enter an endless loop. If you forget on receiver
4548     side, the cycles won't be recreated after communication.
4549
4550   - Header reorganization.
4551     Kill gras_private.h, each submodule must load the headers it needs.
4552
4553 2004-10-04 Martin Quinson
4554   - Interface revolution: do not try to survive to malloc failure.
4555
4556     Now, gras_malloc and friends call gras_abort() on failure.
4557     As a conclusion, malloc_error is not a valid error anymore, and all
4558       functions for which it was the only gras_error_t return value are
4559       changed. They now return void, or there result directly.
4560     This simplify the API a lot.
4561
4562 2004-09-29 Martin Quinson
4563   - Re-enable raw sockets.
4564     Created by gras_socket_{client,server}_ext;
4565     Used with gras_raw_{send,recv}
4566     No select possible.
4567
4568     It should allow to kill the last bits of gras first version soon.
4569
4570     This is not completely satisfactory yet (duplicate code with
4571      chunk_{send,recv}; a bit out of the plugin mechanism), but it should
4572      work.
4573
4574   - Simplify transport plugin (internal) interface by not passing any
4575     argument to _server and _client, but embedding them in the socket
4576     struct directly.
4577
4578 2004-09-28 Martin Quinson
4579   - Finish the port to AIX.
4580     autoconf was my problem (segfault within the malloc replacement
4581     function. No idea why)
4582
4583 2004-09-16 Martin Quinson
4584   - Fix some size_t madness on 64bit architectures.
4585
4586 2004-09-08 Martin Quinson
4587   - Reduce the number of system headers loaded, overload some more system
4588     calls (such as malloc to cast the result of the system one, and work
4589     properly on AIX)
4590   - Fix and reintroduce the config support
4591
4592 2004-09-07 Martin Quinson
4593   - Source code reorganization to allow Arnaud to surf all over there.
4594   - Allow to document the logging categories.
4595   - Remove all uppercase from logging categories and useless cleanup in names.
4596
4597 2004-08-18 Martin Quinson
4598   Version 0.6.2 (protocol not changed; API changed)
4599   - Interface cleanup: gras_msgtype_by_name returns the type (instead of a
4600      gras_error_t), and NULL when not found. Functions expecting a msgtype
4601      as argument (msg_wait; msg_send) deal with NULL argument by providing a
4602      hopefully usefull message.
4603   - Portability to prehistoric sparcs again
4604
4605 2004-08-17 Martin Quinson
4606   Version 0.6.1 (protocol not changed; ABI not changed)
4607   - prealloc some buffers to speed things up
4608
4609 2004-08-11 Martin Quinson
4610   Version 0.6 (protocol not changed; ABI expended)
4611   - The parsing macro can deal with the references, provided that you add
4612     the relevant annotations (using GRAS_ANNOTE(size,field_name))
4613
4614 2004-08-09 Martin Quinson
4615   Version 0.5 (protocol not changed; ABI changed)
4616   - Allow to off turn the cycle detection code in data exchange at
4617     compilation time. It should be at run time, but I'm short of time (and
4618     the config stuff is still broken). That way, we keep dict out of the
4619     critical path, which is good because the performance is poor:
4620      - search not dichotomial yet
4621      - dynar give no way to access their content and memcpy everytime
4622   - In composed data description (struct, ref and so on), stop foolness of
4623     keeping the subtype's ID, but store the type itself. This keeps sets out
4624     of the critical path, which is good since they rely on dynar and
4625     dictionaries. The only loose of that is that we cannot detect the
4626     redeclaration of a structure/union with another content (but I'm not sure
4627     the code detected well this error before anyway). We still can detect
4628     the redefinition discrepancy for the other types.
4629   - Use a whole bunch of optimisation flags (plus -fno-strict-aliasing since
4630     it breaks the code because of type-punning used all over the place).
4631     This breaks on all non-gcc architectures (for now).
4632
4633   All those changes (plus the buffer of last time) allow me to gain 2 order
4634   of magnitude on cruel tests consisting of 800000 array of integers on two
4635   level of a hierarchical structure (200 secondes -> 4 secondes)
4636
4637   API change:
4638     - the selector of reference must now return the type it points to, not
4639       the ID of this type.
4640
4641 2004-08-06 Martin Quinson
4642   Version 0.4 (protocol changed; ABI not changed)
4643   - Allow to pass --gras-log argument to processes in simulation mode. Really.
4644   - New debugging level: trace (under debug) to see effect of GRAS_IN/OUT
4645   - Implement a buffer transport, and use it by default (it relies on tcp in
4646      real life and on sg in simulation).
4647     That's a bit hackish since I had a new field to the structure to store
4648      its data without interfering with the subtype ones. Inheritance
4649      is tricky in C. And that's a kind of reverse inheritance with one class
4650      derivating two classes. Or maybe a game with java interfaces. Anyway,
4651      that's damn hard in C (at least).
4652     Moreover, I got tired while trying to ensure plugin separation and
4653      genericity in SG mode. MSG wants me to do weird things, so let's go for
4654      cruel hacks (temporarily of course ;).
4655      See comment in transport_private.h:71
4656   - do not include all the _interface headers in private but in the files
4657     which really need them (to cut the compilation time when they are
4658     modified)
4659
4660 2004-07-26 Martin Quinson
4661   Version 0.3 (protocol not changed; ABI changed)
4662   - Major overhault of the datadesc interface to simplify it:
4663     - shorted the function names:
4664       s/gras_datadesc_declare_struct/gras_datadesc_struct/ and so on
4665     - add a trivial way to push/pop integers into the cbps without malloc.
4666       This allows to make really generic sub_type description, which simply
4667         pop their size of the stack.
4668     - add a function gras_datadesc_ref_pop_arr() which does what users want
4669       most of the time: Declare a dynamic array (which pops its size of the
4670       stack) and declare a reference to it. Poor name, but anyway.
4671     - kill the post-send callback, add a post-receive one
4672
4673 2004-07-23 Martin Quinson
4674   Version 0.2 (protocol changed; ABI changed)
4675   - add some testing for cpbs in the test cases, and fix some more bugs.
4676     This invalidate again the little64 data file, since I cannot regenerate
4677     it myself.
4678   - remove an awfull optimization in the logging stuff, allowing me to:
4679     - understand it again
4680     - learn gcc how to check that the argument match the provided format
4681     - fix all errors revealed by gcc after that
4682   - internal keys of dict are not \0 terminated. Deal with it properly in
4683     loggings instead of segfaulting when the user want to see the logs :-/
4684
4685 2004-07-22 Martin Quinson
4686   - Fix some stupid bug preventing cbps (callback postit) from working
4687
4688 2004-07-21 Martin Quinson
4689   - Some documentation cleanups
4690   - remove the useless last argument of msgtype_declare
4691   - rename the Virtu functions to fit into the 'os' namespace
4692   - move headers src/include -> src/include/gras/ and stop fooling with
4693     gras -> . symbolic link
4694   - make distcheck is now successful
4695
4696 2004-07-19 Martin Quinson
4697   Version 0.1.1
4698   - Build shared library also
4699   - Install html doc to the right location
4700   - stop removing maintainer files in make clean
4701   - build tests only on make check
4702
4703 2004-07-13 Martin Quinson
4704   version 0.1
4705   - No major issue in previous version => change versioning schema
4706   - Re-enable little64 convertion test now that Abdou kindly regenerated the
4707     corresponding dataset.
4708
4709 2004-07-11 Martin Quinson
4710   version 0.0.4
4711   - Get it working with any kind of structure (we can compute the padding
4712     bytes remotely for all the architectures I have access to)
4713   - Implement the structure parsing macro (still not quite robust/complete)
4714   - Improvement to the remote testing toysuite
4715
4716 2004-07-10 Martin Quinson
4717  [autoconf mechanism]
4718   - get ride of a bunch of deprecated macros
4719   - actually run the test for two-compliment, not only compile it :-/
4720   - test whether the structures get packed (and bail out if yes. Damn.
4721     Alignment is a serious matter)
4722   - test whether the structures get compacted (but respecting the alignment
4723     constraints of each types)
4724   - test whether the array fields of structures can straddle alignment boundaries
4725  [base]
4726   - Damnit, double are bigger than float (typo in creation of 'double' datadesc)
4727     (took me 2 hours to find that bug, looking at the wrong place)
4728   - Add gras_datadesc_declare_{union,struct}_close(). They must be used
4729     before sending/receiving and are used to compute the offsets of fields
4730   - Given that padding size depend even on compiler options, keep track of
4731     alignment and aligned_size only for the current architecture. Not a big
4732     deal since we send structure fields one after the other (seems
4733     reasonable).
4734   - Add the datastructure used for IEEE paper by the PBIO guys to the test
4735     program, let it work on linux/gcc/little32. portability todo.
4736
4737 2004-07-08 Martin Quinson
4738   - import and improve remote compilation support from FAST
4739   - make sure make check works on half a dozen of machines out there
4740
4741 2004-07-07 Martin Quinson
4742  Let's say it's version 0.0.3 ;)
4743   - Implement conversions (yuhu!)
4744   - Let it work on solaris (beside conversion, of course)
4745   - Stupid me, using rand() to generate the conversion datatests in not wise.
4746
4747 2004-07-06 Martin Quinson
4748   - Let make dist work, since I'm gonna need it to compile on remote hosts
4749   - Let Tests/datadesc_usage write the architecture on which the file was
4750     generated as first byte.
4751   - Add PowerPC (being also IRIX64), SPARC (also power4) and ALPHA
4752     architecture descriptions.
4753   - Add datadesc_usage.{i386,ppc,sparc} files being the result of execution
4754     on those architectures.
4755   - Optimization: send/recv array of scalar in one shoot
4756
4757 2004-07-05 Martin Quinson
4758   - YEAH! GRAS/SG and GRAS/RL are both able to run the ping example !
4759
4760   - Plug a whole bunch of memleaks
4761   - each process now have to call gras_{init,exit}. One day, their log
4762     settings will be separated
4763   - Continue the code factorisation between SG, RL and common in Transport.
4764
4765 2004-07-04 Martin Quinson
4766  [Transport]
4767   - Redistribution between SG and RL.
4768     We wanna have to accept in SG, so move accepted related parts of RL in
4769     the common part. (more precisely, the dynar of all known sockets is no
4770     more a static in transport.c, but part of the process_data)
4771  [Core/module.c]
4772  [gras_stub_generator]
4773   - Bug fix: Do call gras_process_init from gras_init (wasnt called in RL).
4774
4775 2004-07-03 Martin Quinson
4776   - Create a new log channel tbx containing dict, set, log, dynar (to shut
4777     them all up in one shot)
4778  [DataDesc]
4779   - Fix the ugly case of reference to dynamic array.
4780   - New (semi-public) function gras_datadesc_size to allow the messaging
4781     layer to malloc the needed space for the buffer.
4782  [Transport]
4783   - gras_socket_close now expect the socket to close (and not its address to
4784     put NULL in it after it). This is because the socket passed to handlers
4785     is one of their argument (=> not writable).
4786  [Messaging]
4787   - propagate the interface cleanup from last week in datadesc, ie remove a
4788     superfluous level of indirection. User pass adress of variable
4789     containing data (both when sending and receiving), and not of a variable
4790     being a pointer to the data. Let's say that I like it better ;)
4791       The price for that is constructs like "int msg=*(int*)payload" in
4792     handlers, but it's a fine price, IMHO.
4793  [examples/ping]
4794   - Let it work in RL (yuhu)
4795
4796 2004-06-21 Martin Quinson
4797  [Transport]
4798    - porting SG plugin and SG select to new standards (works almost).
4799    - plug memleaks and fix bugs around.
4800
4801  [DataDesc]
4802    - cleanup the prototype of data recv and force users to specify when they
4803      want to handle references to objects. Test case working even for cycles.
4804    - plug memleaks. Valgrind is perfectly ok with this.
4805
4806 2004-06-12 Martin Quinson
4807  [Transport]
4808    - cleanup the separation between plugin and main code in plugin creation
4809
4810 2004-06-11 Martin Quinson
4811  [Transport]
4812    - Reput hook for raw sockets, needed for BW experiments
4813    - kill a few lines of dead code
4814  [Data description] Interface cleanup
4815    - gras_datadesc_by_name returns the searched type or NULL.
4816      That way, no variable is needed to use a type desc once, which makes
4817       the code clearer.
4818    - gras_datadesc_declare_[struct|union]_append_name is removed. The last
4819       two parameters were strings (field name, type name), leading to
4820       common errors.
4821  [Dicos] Interface cleanup
4822    - gras_dico_retrieve -> gras_dico_get ; gras_dico_insert -> gras_dico_set
4823      This is consistant with the dynar API.
4824
4825 2004-04-21 Martin Quinson
4826  [Messaging]
4827    - Porting to new standards.
4828  [Data description]
4829    - interface cleanup.
4830      There is no bag anymore, no need to take extra provision to mask the
4831        pointers behind "ID".
4832      Better splitup of functions between files create/exchange/convert.
4833        This is still a bit artificial since convert and receive are so
4834        interleaved, but anyway.
4835  [Virtu(process)]
4836    - add a queued message list to procdata (the ones not matching criteria
4837      in msg_wait)
4838    - factorize some more code between SG and RL wrt procdata
4839  [Tests]
4840    - use gras_exit in example to track memleaks
4841    - get rid of gs_example now that GS is properly integrated into gras
4842    - update run_test to integrate the latest tests (datadesc)
4843  [Logging]
4844    - rename WARNINGn macros to WARNn since it prooved error-prone
4845
4846 2004-04-19 Martin Quinson
4847  [Data description]
4848    - register init/exit functions within gras module mechanism
4849    - send/receive function.
4850    Convertion is not implemented, but short-cutted if not needed.
4851    struct/array elements are sent one by one (instead of block-wise), but
4852      nobody really cares (yet). Get a prototype before optimizing.
4853    - tests (using a file socket) for DD send/receive on:
4854      - base types: int, float
4855      - array: fixed size, string (ie ref to dynamic string)
4856      - structure: homogeneous, heterogeneous
4857      - chained list, graph with cycle
4858    Believe it or not, valgrind is not too unhappy with the results. The
4859     cycle happily segfaults, but the others are ok. And I'm sick of pointers
4860     for now.
4861  [Transport]
4862    [File plugin]
4863      - Bugfix when using a filename explicitly (instead of '-')
4864
4865 2004-04-09 Martin Quinson
4866  [Transport plugins]
4867    - factorize more code between RL and SG in socket creation
4868    - Complete the implementation and tests of:
4869      o TCP
4870      o file (only in RL, and mainly for debugging)
4871
4872      I lost 3 days to design a portable address resolver, and then decided
4873        that the prototype mainly have to run on my box.
4874      Addressing portability too early may be like optimizing too early :-/
4875  [Tests]
4876    - use gras_init in the Tests instead of the crappy parse_log_opt
4877      (the latter function is removed)
4878  [Conditional execution]
4879    - New functions: gras_if_RL/gras_if_SG (basic support for this)
4880  [Code reorganisation]
4881   - Get rid of libgrasutils.a since it makes more trouble than it solves.
4882     Build examples against the RL library, since there is no way to disable
4883     its creation for now.
4884
4885 For information, the beginning of coding on GRAS was back in june
4886 2003. I guess that every line has been rewritten at least twice since
4887 then.