1# Changelog 2 3All notable changes to this project will be documented in this file. 4 5This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 6 7# 0.4.5 8 9#### New Protocol Extensions 10 11- `TargetDescriptionXmlOverride` - Allow targets to override the target description XML file (`target.xml`) specified by `Target::Arch::target_description_xml`. This is useful in cases where a `Target` is expected to be generic over multiple architectures. [\#43](https://github.com/daniel5151/gdbstub/pull/43) (with help from [DrChat](https://github.com/DrChat)) 12 13# 0.4.4 14 15#### Bugfixes 16 17- use `write!` instead of `writeln!` in `output!` macro [\#41](https://github.com/daniel5151/gdbstub/issues/41) 18 19# 0.4.3 20 21#### New Arch Implementations 22 23- Implement `RegId` for Mips/Mips64 [\#38](https://github.com/daniel5151/gdbstub/pull/38) ([starfleetcadet75](https://github.com/starfleetcadet75)) 24- Implement `RegId` for MSP430 [\#38](https://github.com/daniel5151/gdbstub/pull/38) ([starfleetcadet75](https://github.com/starfleetcadet75)) 25 26# 0.4.2 27 28#### Packaging 29 30- Exclude test object files from package [\#37](https://github.com/daniel5151/gdbstub/pull/37) ([keiichiw](https://github.com/keiichiw)) 31 32# 0.4.1 33 34#### New Arch Implementations 35 36- Implement `RegId` for x86/x86_64 [\#34](https://github.com/daniel5151/gdbstub/pull/34) ([keiichiw](https://github.com/keiichiw)) 37 38#### Bugfixes 39 40- Switch fatal error signal from `T06` to `S05`, 41- specify cfg-if 0.1.10 or later [\#33](https://github.com/daniel5151/gdbstub/pull/33) ([keiichiw](https://github.com/keiichiw)) 42 - `cargo build` fails if cfg-if is 0.1.9 or older 43 44#### Misc 45 46- Don't hard-code u64 when parsing packets (use big-endian byte arrays + late conversion to `Target::Arch::Usize`). 47 48# 0.4.0 49 50This version includes a _major_ API overhaul, alongside a slew of new features and general improvements. While updating to `0.4.0` will require some substantial code modifications, it's well worth the effort, as `0.4.0` is the safest, leanest, and most featureful release of `gdbstub` yet! 51 52Fun fact: Even after adding a _bunch_ of new features and bug-fixes, the in-tree `example_no_std` has remained just as small! The example on the `semver-fix-0.2.2` branch is `20251` bytes, while the example on `0.4.0` is `20246` bytes. 53 54#### API Changes 55 56- Rewrite the `Target` API in terms of "Inlineable Dyn Extension Traits" (IDETs) 57 - _By breaking up `Target` into smaller pieces which can be mixed-and-matched, it not only makes it easier to get up-and-running with `gdbstub`, but it also unlocks a lot of awesome internal optimizations:_ 58 - Substantially reduces binary-size footprint by guaranteeing dead-code-elimination of parsing/handling unimplemented GDB protocol features. 59 - Compile-time enforcement that certain groups of methods are implemented in-tandem (e.g: `add_sw_breakpoint` and `remove_sw_breakpoint`). 60- Update the `Target` API with support for non-fatal error handling. 61 - _The old approach of only allowing \*fatal\* errors was woefully inadequate when dealing with potentially fallible operations such as reading from unauthorized memory (which GDB likes to do a bunch), or handling non-fatal `std::io::Error` that occur as a result of `ExtendedMode` operations. The new `TargetResult`/`TargetError` result is much more robust, and opens to door to supporting additional error handling extensions (such as LLDB's ASCII Errors)._ 62- Update the `Connection` trait with new methods (`flush` - required, `write_all`, `on_session_start`) 63- Lift `Registers::RegId` to `Arch::RegId`, and introduce new temporary `RegIdImpl` solution for avoiding breaking API changes due to new `RegId` implementations (see [\#29](https://github.com/daniel5151/gdbstub/pull/29)) 64- Mark various `RegId` enums as `#[non_exhaustive]`, allowing more registers to be added if need be. 65- Error types are now marked as `#[non_exhaustive]`. 66 67#### New Protocol Extensions 68 69- `ExtendedMode` - Allow targets to run new processes / attach to existing processes / restart execution. 70 - Includes support for `set disable-randomization`, `set environment`, `set startup-with-shell`, and `set cwd` and `cd`. 71- `SectionOffsets` - Get section/segment relocation offsets from the target. [\#30](https://github.com/daniel5151/gdbstub/pull/30) ([mchesser](https://github.com/mchesser)) 72 - Uses the `qOffsets` packet under-the-hood. 73 74#### Bugfixes 75 76- Fix issues related to selecting the incorrect thread after hitting a breakpoint in multi-threaded targets. 77- Ensure that `set_nodelay` is set when using a `TcpStream` as a `Connection` (via the new `Connection::on_session_start` API) 78 - _This should result in a noticeable performance improvement when debugging over TCP._ 79 80#### Misc 81 82- Removed `btou` dependency. 83- Removed all `UTF-8` aware `str` handling code. 84 - _GDB uses a pure ASCII protocol, so including code to deal with UTF-8 resulted in unnecessary binary bloat._ 85 86# 0.3.0 (formerly 0.2.2) 87 88This version contains a few minor breaking changes from `0.2.1`. These are only surface-level changes, and can be fixed with minimal effort. 89 90Version `0.3.0` is identical to the yanked version `0.2.2`, except that it adheres to `cargo`'s [modified SemVer rule](https://doc.rust-lang.org/cargo/reference/manifest.html#the-version-field) which states that the pre-`0.x.y` breaking changes should still bump the minor version. 91 92Thanks to [h33p](https://github.com/h33p) for reporting this issue ([\#27](https://github.com/daniel5151/gdbstub/issues/27)) 93 94#### API Changes 95 96- Update `Target::resume` API to replace raw `&mut dyn Iterator` with a functionally identical concrete `Actions` iterator. 97- Mark the `StopReason` enum as `#[non_exhaustive]`, allowing further types to be added without being considered as an API breaking change. 98 99#### New Protocol Extensions 100 101- Add `Target::read/write_register` support (to support single register accesses) [\#22](https://github.com/daniel5151/gdbstub/pull/22) ([thomashk0](https://github.com/thomashk0)) 102- Add `StopReason::Signal(u8)` variant, to send arbitrary signal codes [\#19](https://github.com/daniel5151/gdbstub/pull/19) ([mchesser](https://github.com/mchesser)) 103 104#### New Arch Implementations 105 106- Add partial RISC-V support (only integer ISA at the moment) [\#21](https://github.com/daniel5151/gdbstub/pull/21) ([thomashk0](https://github.com/thomashk0)) 107- Add i386 (x86) support [\#23](https://github.com/daniel5151/gdbstub/pull/23) ([jamcleod](https://github.com/jamcleod)) 108- Add 32-bit PowerPC support [\#25](https://github.com/daniel5151/gdbstub/pull/25) ([jamcleod](https://github.com/jamcleod)) 109 110# 0.2.1 111 112#### New Arch Implementations 113 114- Add x86_86 support [\#11](https://github.com/daniel5151/gdbstub/pull/11) ([jamcleod](https://github.com/jamcleod)) 115- Add Mips and Mips64 support [\#13](https://github.com/daniel5151/gdbstub/pull/13) ([starfleetcadet75](https://github.com/starfleetcadet75)) 116 117#### Misc 118 119- Documentation improvements 120 - Document PC adjustment requirements in `Target::resume` 121 - Add docs on handling non-fatal invalid memory reads/writes in `Target::read/write_addrs`. 122 123# 0.2.0 124 125_start of changelog_ 126