third_party/rust/minidump-writer/CHANGELOG.md

   1 <!-- markdownlint-disable blanks-around-headings blanks-around-lists no-duplicate-heading -->
   2
   3 # Changelog
   4 All notable changes to this project will be documented in this file.
   5
   6 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
   7 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
   8
   9 <!-- next-header -->
  10 ## [Unreleased] - ReleaseDate
  11 ## [0.8.3] - 2023-11-07
  12 ### Added
  13 - [PR#94](https://github.com/rust-minidump/minidump-writer/pull/94) added support for writing [file information](https://learn.microsoft.com/en-us/windows/win32/api/minidumpapiset/ns-minidumpapiset-minidump_handle_descriptor) for every file open in the process the dump is being performed for into the [`MINIDUMP_HANDLE_DATA_STREAM`](https://learn.microsoft.com/en-us/windows/win32/api/minidumpapiset/ns-minidumpapiset-minidump_handle_data_stream) stream.
  14 - [PR#90](https://github.com/rust-minidump/minidump-writer/pull/90) added support for including the `/proc/<pid>/limits` file in the [`MozLinuxLimits`](https://docs.rs/minidump-common/latest/minidump_common/format/enum.MINIDUMP_STREAM_TYPE.html#variant.MozLinuxLimits) stream. This information can be used together with the file information described above to diagnose situations where the process was killed by the kernel due to file handle limits being hit. Thanks [@lissyx](https://github.com/lissyx)!
  15
  16 ### Changed
  17 - [PR#94](https://github.com/rust-minidump/minidump-writer/pull/94) updated several dependencies to align with `minidump-common`, which was also bumped.
  18
  19 ## [0.8.2] - 2023-09-21
  20 ### Added
  21 - [PR#86](https://github.com/rust-minidump/minidump-writer/pull/86) added support for `i686-android-linux`.
  22
  23 ### Fixed
  24 - [PR#85](https://github.com/rust-minidump/minidump-writer/pull/85) removed the dependency on `chrono`.
  25 - [PR#89](https://github.com/rust-minidump/minidump-writer/pull/89) resolved [#88](https://github.com/rust-minidump/minidump-writer/issues/88) by merging ranges that were mapped, but had 1 or more unmapped ranges in between them.
  26
  27 ### Changed
  28 - [PR#87](https://github.com/rust-minidump/minidump-writer/pull/87) updated some dependencies.
  29
  30 ## [0.8.1] - 2023-06-21
  31 ### Added
  32 - [PR#70](https://github.com/rust-minidump/minidump-writer/pull/70) resolved [#8](https://github.com/rust-minidump/minidump-writer/issues/8) by adding support for writing `MemoryInfoListStream` on Linux/Android targets, this allows minidump consumers to process minidumps more easily without needing to parse and understand Linux-specific information. Thanks [@afranchuk](https://github.com/afranchuk)!
  33 - [PR#81](https://github.com/rust-minidump/minidump-writer/pull/81) stabilized `arm` and `aarch64` support for `unknown-linux` and `linux-android`, as well as adding support for `x86_64-linux-android`.
  34
  35 ### Changed
  36 - [PR#70](https://github.com/rust-minidump/minidump-writer/pull/70) replaced the custom reading of procfs information used when generating a minidump on Linux to use the `procfs` crate instead, removing a bunch of code.
  37 - [PR#80](https://github.com/rust-minidump/minidump-writer/pull/80) along with [PR#84](https://github.com/rust-minidump/minidump-writer/pull/84) replaced `procfs` with `procfs-core`, removing unneeded dependencies such as `windows-sys`.
  38
  39 ### Fixed
  40 - [PR#78](https://github.com/rust-minidump/minidump-writer/pull/78) resolved [#24](https://github.com/rust-minidump/minidump-writer/issues/24) by ignoring guard pages when dumping the stack to the minidump in the event of a stack overflow.
  41 - [PR#83](https://github.com/rust-minidump/minidump-writer/pull/83) resolved [#82](https://github.com/rust-minidump/minidump-writer/issues/82) by correctly aligning a structure.
  42
  43 ## [0.8.0] - 2023-04-03
  44 ### Removed
  45 - [PR#77](https://github.com/rust-minidump/minidump-writer/pull/77) removed the dependency on `winapi`, all bindings are either part of `minidump-writer` or `crash-context` now.
  46
  47 ### Changed
  48 - [PR#77](https://github.com/rust-minidump/minidump-writer/pull/77) closed [#67](https://github.com/rust-minidump/minidump-writer/issues/67) by allowing the user to specify the `MinidumpType` flags when creating a minidump.
  49
  50 ### Fixed
  51 - [PR#68](https://github.com/rust-minidump/minidump-writer/pull/68) resolved [#29](https://github.com/rust-minidump/minidump-writer/issues/29) by ignoring the bening `ESRCH` error when detaching pthreads. Thanks [@afranchuk](https://github.com/afranchuk)!
  52 - [PR#74](https://github.com/rust-minidump/minidump-writer/pull/74) resolved [#73](https://github.com/rust-minidump/minidump-writer/issues/73) by ensuring the `NT_GNU_BUILD_ID` section had the proper correct `GNU` name before using it as the build identifier.
  53
  54 ## [0.7.0] - 2022-11-17
  55 ### Changed
  56 - [PR#65](https://github.com/rust-minidump/minidump-writer/pull/65) updated `crash-context` to 0.5, which has support for a custom `capture_context` to replace `RtlCaptureContext` on Windows, due to improper bindings and deficiencies, resolving [#63](https://github.com/rust-minidump/minidump-writer/issues/63).
  57 - [PR#65](https://github.com/rust-minidump/minidump-writer/pull/65) replaced _most_ of the custom bindings from [PR#60](https://github.com/rust-minidump/minidump-writer/pull/60) with bindings from either `crash-context` or `winapi`.
  58
  59 ## [0.6.0] - 2022-11-15
  60 ### Changed
  61 - [PR#60](https://github.com/rust-minidump/minidump-writer/pull/60) removed the dependency on `windows-sys` due the massive version churn, resolving [#58](https://github.com/rust-minidump/minidump-writer/issues/58). This should allow projects to more easily integrate this crate into their project without introducing multiple versions of transitive dependencies.
  62 - [PR#62](https://github.com/rust-minidump/minidump-writer/pull/62) replaced `MDExceptionCodeLinux` with `minidump_common::ExceptionCodeLinux`.
  63 - [PR#64](https://github.com/rust-minidump/minidump-writer/pull/64) updated dependencies.
  64
  65 ## [0.5.0] - 2022-10-21
  66 ### Changed
  67 - [PR#53](https://github.com/rust-minidump/minidump-writer/pull/53) made the `mem_writer` and `dir_section` modules public. Thanks [@sage-msft](https://github.com/sage-msft)!
  68 - [PR#55](https://github.com/rust-minidump/minidump-writer/pull/55) bumped `nix`, `minidump-common`, `minidump`, `minidump-processor` and `dump_syms`. Thanks
  69 [@sfackler](https://github.com/sfackler)!
  70 - [PR#57](https://github.com/rust-minidump/minidump-writer/pull/57) bumped `windows-sys` to 0.42.
  71
  72 ### Removed
  73 - [PR#56](https://github.com/rust-minidump/minidump-writer/pull/56) removed the writing of the [HandleOperationListStream](https://learn.microsoft.com/en-us/windows/win32/api/minidumpapiset/ns-minidumpapiset-minidump_handle_operation_list) stream, as it was essentially untested and was of dubious usefulness.
  74
  75 ## [0.4.0] - 2022-07-21
  76 ### Changed
  77 - [PR#50](https://github.com/rust-minidump/minidump-writer/pull/50) updated `minidump-common` and `crash-context`.
  78
  79 ### Fixed
  80 - [PR#50](https://github.com/rust-minidump/minidump-writer/pull/50) resolved [#33](https://github.com/rust-minidump/minidump-writer/issues/33) by encoding the full exception info in the `exception_information` field of the exception stream.
  81 - [PR#50](https://github.com/rust-minidump/minidump-writer/pull/50) resolved [#34](https://github.com/rust-minidump/minidump-writer/issues/34) by unwrapping `EXC_CRASH` exceptions to retrieve the wrapped exception.
  82
  83 ## [0.3.1] - 2022-07-18
  84 ### Fixed
  85 - [PR#47](https://github.com/rust-minidump/minidump-writer/pull/47) resolved [#46](https://github.com/rust-minidump/minidump-writer/issues/46) by handling the special case of `dyld`.
  86
  87 ## [0.3.0] - 2022-07-15
  88 ### Fixed
  89 - [PR#42](https://github.com/rust-minidump/minidump-writer/pull/42) resolved [#41](https://github.com/rust-minidump/minidump-writer/issues/41) by capping the VM read of task memory to avoid a syscall failure, as well as made it so that if an error does occur when reading the module's file path, the module is still written to the minidump, as the file path is less important than the UUID in terms of module identification.
  90 - [PR#44](https://github.com/rust-minidump/minidump-writer/pull/44) resolved [#43](https://github.com/rust-minidump/minidump-writer/issues/43) by correctly calculating the base address of each loaded module. The bug was inherited from Breakpad.
  91 - [PR#44](https://github.com/rust-minidump/minidump-writer/pull/44) and [PR#45](https://github.com/rust-minidump/minidump-writer/pull/45) resolved [#37](https://github.com/rust-minidump/minidump-writer/issues/37) by making the `crash_context::CrashContext` optional on MacOS and Windows, to make creating a minidump without necessarily having an actual crash more convenient for users.
  92
  93 ## [0.2.1] - 2022-05-25
  94 ### Added
  95 - [PR#32](https://github.com/rust-minidump/minidump-writer/pull/32) resolved [#23](https://github.com/rust-minidump/minidump-writer/issues/23) by adding support for the thread names stream on MacOS.
  96
  97 ## [0.2.0] - 2022-05-23
  98 ### Added
  99 - [PR#21](https://github.com/rust-minidump/minidump-writer/pull/21) added an initial implementation for `x86_64-apple-darwin` and `aarch64-apple-darwin`
 100
 101 ## [0.1.0] - 2022-04-26
 102 ### Added
 103 - Initial release, including basic support for `x86_64-unknown-linux-gnu/musl` and `x86_64-pc-windows-msvc`
 104
 105 <!-- next-url -->
 106 [Unreleased]: https://github.com/rust-minidump/minidump-writer/compare/0.8.3...HEAD
 107 [0.8.3]: https://github.com/rust-minidump/minidump-writer/compare/0.8.2...0.8.3
 108 [0.8.2]: https://github.com/rust-minidump/minidump-writer/compare/0.8.1...0.8.2
 109 [0.8.1]: https://github.com/rust-minidump/minidump-writer/compare/0.8.0...0.8.1
 110 [0.8.0]: https://github.com/rust-minidump/minidump-writer/compare/0.7.0...0.8.0
 111 [0.7.0]: https://github.com/rust-minidump/minidump-writer/compare/0.6.0...0.7.0
 112 [0.6.0]: https://github.com/rust-minidump/minidump-writer/compare/0.5.0...0.6.0
 113 [0.5.0]: https://github.com/rust-minidump/minidump-writer/compare/0.4.0...0.5.0
 114 [0.4.0]: https://github.com/rust-minidump/minidump-writer/compare/0.3.1...0.4.0
 115 [0.3.1]: https://github.com/rust-minidump/minidump-writer/compare/0.3.0...0.3.1
 116 [0.3.0]: https://github.com/rust-minidump/minidump-writer/compare/0.2.1...0.3.0
 117 [0.2.1]: https://github.com/rust-minidump/minidump-writer/compare/0.2.0...0.2.1
 118 [0.2.0]: https://github.com/rust-minidump/minidump-writer/compare/0.1.0...0.2.0
 119 [0.1.0]: https://github.com/rust-minidump/minidump-writer/releases/tag/0.1.0