RELEASE-NOTES.md

   1 # Version 20.0.0.2
   2
   3 **[HOTFIX]** A patch was applied to fix the RubyPrefetcher with MESI_Three_Level. Prior to this fix a segfault occurred.
   4
   5 # Version 20.0.0.1
   6
   7 **[HOTFIX]** A fix was applied to stop incorrect clock frequences being reported due to rounding errors.
   8
   9 # Version 20.0.0.0
  10
  11 Welcome to our first "official" gem5 release!
  12 gem5 v19.0.0.0 was a "test" release, but this one has release notes, so it must be official!
  13
  14 Thank you to everyone that made this release possible!
  15 This has been a very productive release with over [70 issues closed](https://gem5.atlassian.net/), over 500 commits, and 31 unique contributors.
  16 Below are some of the highlights, though I'm sure I've missed some important changes.
  17
  18 ## New features
  19
  20 * [gem5-resources repository](https://gem5.googlesource.com/public/gem5-resources/)
  21   * This new repository will store all of the *sources* (e.g., code) used to create testing and research resources. This includes disk images, testing binaries, kernel binaries, etc.
  22   * Binaries created with the sources are hosted on dist.gem5.org.
  23   * Details on the new page for resources: <http://www.gem5.org/documentation/general_docs/gem5_resources>.
  24 * Memory SimObjects can now be initialized using an image file using the image_file parameter.
  25 * **[USER-FACING CHANGE]** The m5 utility has been revamped with a new build system based on scons, tests, and updated and more consistent feature support.
  26   * To build, now use `scons build/<arch>/out/m5`, not `make`.
  27   * [Documentation](http://www.gem5.org/documentation/general_docs/m5ops/) coming soon.
  28 * Robust support for marshalling data from a function call inside the simulation to a function within gem5 using a predefined set of rules.
  29   * Developers can specify an ABI for guest<->simulator calls and then "just call functions".
  30   * Unifies pseudo-inst, syscall, and other support.
  31   * Code within gem5 has been updated. However, users which added new pseudo-ops may have to update their code.
  32 * **[PYTHON API CHANGE]** Workload configuration pulled out into its own object, simplifying the System object and making workload configuration more modular and flexible.
  33   * All full system config/run scripts must be updated (e.g., anything that used the `LinuxX86System` or similar SimObject).
  34   * Many of the parameters of `System` are now parameters of the `Workload` (see `src/sim/Workload.py`).
  35     * For instance, many parameters of `LinuxX86System` are now part of `X86FsLinux` which is now the `workload` parameter of the `System` SimObject.
  36   * See https://gem5-review.googlesource.com/c/public/gem5/+/24283/ and https://gem5-review.googlesource.com/c/public/gem5/+/26466 for more details.
  37 * Sv39 paging has been added to the RISC-V ISA, bringing gem5 close to running Linux on RISC-V.
  38   * (Some) Baremetal OSes are now supported.
  39 * Improvements to DRAM model:
  40   * Added support for verifying available command bandwidth.
  41   * Added support for multi-cycle commands.
  42   * Added new timing parameters.
  43   * Added ability to interleave bursts.
  44   * Added LPDDR5 configurations.
  45 * **[Developer change]** We are beginning to document gem5 APIs.
  46   * Currently, only SimObjects and the APIs they depend on have been documented.
  47   * We are using doxygen to mark "stable APIs" and will use manual code review to make sure the APIs stay stable.
  48   * More information will be coming during gem5-20.1 development.
  49
  50 ## Removed features
  51
  52 * Support for the ALPHA ISA has been dropped.
  53   * All ALPHA ISA code has been removed
  54   * Old "rcS" scripts for ALPHA have been removed
  55
  56 ## New supported platforms
  57
  58 * Compiling and running gem5 with Python 3 is now fully supported.
  59   * Lots of code changes required for this.
  60   * There may still be some python code that's not up to date. Please open a [Jira ticket](https://gem5.atlassian.net/) if you find any code that doesn't work with python3.
  61 * gem5 now supports Ubuntu 20.04.
  62 * Compiling gem5 with GCC 8 and 9 is now supported.
  63 * Compiling with clang up to version 9 is now supported.
  64
  65 ## Testing improvements
  66
  67 * Scons-based tests have been migrated to the testlib framework.
  68   * Tests can now be run with `tests/main.py`, except for the unittests.
  69   * Please consult TESTING.md for more information on how these may be run.
  70 * We are continuing to work on CI tests. Most of the plumbing is there for Google Cloud Build integration. See [the Jira issue](https://gem5.atlassian.net/browse/GEM5-237) for details.
  71
  72 ## Other API changes
  73
  74 * **[API CHANGE]** Ruby's prefetcher renamed to RubyPrefetcher.
  75   * Any SLICC protocols with prefetchers need to be updated.
  76   * Some config scripts for Ruby protocols with prefetchers may need to be updated.
  77 * **[API CHANGE]** SE mode improvements.
  78   * Better support for the mmap and related syscalls.
  79   * A new virtual memory area API for tracking SE mode allocations.
  80   * When implementing syscalls, the way that guest memory is allocated changes. All code in gem5 is updated, but if there are any external syscalls, they may need be updated.
  81 * **[COMMAND LINE CHANGE]** The `--disk-image` argument to `fs.py` is now optional.
  82   * However, the disk image names *are no longer implied*.
  83   * The script still implicitly searches `M5_PATH`, but the name of the disk image must be specified.
  84 * **[API CHANGE]** SLICC `queueMemory` is now `enqueue`.
  85   * All protocol configs must be updated with another message buffer in the memory controllers (directories).
  86   * All protocol SLICC files must replace `queueMemoryRead` and `queueMemoryWrite` with `enqueue` to another "special" message buffer named `memQueue`.
  87   * This allows finite buffering between the cache controllers and DRAMCtrl.
  88 * **[API CHANGE]** Added Prefetcher namespace
  89   * All prefetchers' names have changed from `*Prefetcher` to `Prefetcher::*`
  90   * If you have any prefetchers that are not in the gem5 mainline, your code will likely need to be updated.
  91
  92 ## Other changes
  93
  94 * Implemented ARMv8.3-CompNum, SIMD complex number extension.
  95 * Support for Arm Trusted Firmware + u-boot with the new VExpress_GEM5_Foundation platform
  96 * Removed author list from source files.
  97   * This was originally so future people would know who to contact.
  98   * However, it was difficult to maintain and quickly out of date.
  99   * Copyright is unchanged.
 100 * Improvements to gem5's power model.
 101 * MESI_Three_Level Ruby protocol bugfixes.
 102 * Ruby functional reads now work in more cases.
 103 * Indirect branch stats work correctly now.