Skip to content

Commit

Permalink
fmt everything using imports_granularity = "Item"
Browse files Browse the repository at this point in the history
In the years since I first started `gdbstub`, I've grown fond of
one-import-per-line formatting.
  • Loading branch information
daniel5151 committed Apr 30, 2023
1 parent 20d51b0 commit e2329b8
Show file tree
Hide file tree
Showing 96 changed files with 296 additions and 265 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Expand Up @@ -9,12 +9,17 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
- `GdbStubError` has been overhauled. Instead of being an `enum`, it is now an opaque `struct` with a handful of methods to extract concrete user-defined error data.
- _This change will enable future versions of `gdbstub` to fearlessly improve error messages and infrastructure without making semver breaking changes._
- `Signal` is not longer an `enum`, and is instead a `struct` with a single `pub u8` field + a collection of associated constants.
- _As a result, yet another instance of `unsafe` could be removed from the codebase!_
- `Arch` API:
- Entirely removed `single_step_behavior`. See [\#132](https://github.com/daniel5151/gdbstub/pull/132) for details and rationale
- `Target` APIs:
- `SingleThreadBase`/`MultiThreadBase`
- `read_addrs` now returns a `usize` instead of a `()`, allowing implementations to report cases where only a subset of memory could be read.

#### Internal Improvements

- `rustfmt`: Switched to using `imports_granularity = "Item"`

# 0.6.6

#### New Features
Expand Down
12 changes: 7 additions & 5 deletions example_no_std/src/gdb.rs
@@ -1,9 +1,11 @@
use gdbstub::common::{Signal, Tid};
use gdbstub::target;
use gdbstub::target::ext::base::multithread::{MultiThreadBase, MultiThreadResume};
use gdbstub::target::{Target, TargetResult};

use crate::print_str::print_str;
use gdbstub::common::Signal;
use gdbstub::common::Tid;
use gdbstub::target;
use gdbstub::target::ext::base::multithread::MultiThreadBase;
use gdbstub::target::ext::base::multithread::MultiThreadResume;
use gdbstub::target::Target;
use gdbstub::target::TargetResult;

pub struct DummyTarget {}

Expand Down
6 changes: 3 additions & 3 deletions example_no_std/src/main.rs
Expand Up @@ -4,16 +4,16 @@
#![no_std]
#![no_main]

use crate::print_str::print_str;
use gdbstub::stub::state_machine::GdbStubStateMachine;
use gdbstub::stub::DisconnectReason;
use gdbstub::stub::GdbStubBuilder;
use gdbstub::stub::MultiThreadStopReason;
use gdbstub::stub::{DisconnectReason, GdbStubBuilder};

mod conn;
mod gdb;
mod print_str;

use crate::print_str::print_str;

#[panic_handler]
fn panic(_info: &core::panic::PanicInfo<'_>) -> ! {
loop {}
Expand Down
10 changes: 7 additions & 3 deletions examples/armv4t/emu.rs
@@ -1,7 +1,11 @@
use armv4t_emu::{reg, Cpu, ExampleMem, Memory, Mode};

use crate::mem_sniffer::{AccessKind, MemSniffer};
use crate::mem_sniffer::AccessKind;
use crate::mem_sniffer::MemSniffer;
use crate::DynResult;
use armv4t_emu::reg;
use armv4t_emu::Cpu;
use armv4t_emu::ExampleMem;
use armv4t_emu::Memory;
use armv4t_emu::Mode;
use gdbstub::common::Pid;

const HLE_RETURN_ADDR: u32 = 0x12345678;
Expand Down
5 changes: 2 additions & 3 deletions examples/armv4t/gdb/auxv.rs
@@ -1,8 +1,7 @@
use gdbstub::target;
use gdbstub::target::TargetResult;

use super::copy_range_to_buf;
use crate::emu::Emu;
use gdbstub::target;
use gdbstub::target::TargetResult;

impl target::ext::auxv::Auxv for Emu {
fn get_auxv(&self, offset: u64, length: usize, buf: &mut [u8]) -> TargetResult<usize, Self> {
Expand Down
3 changes: 1 addition & 2 deletions examples/armv4t/gdb/breakpoints.rs
@@ -1,9 +1,8 @@
use crate::emu::Emu;
use gdbstub::target;
use gdbstub::target::ext::breakpoints::WatchKind;
use gdbstub::target::TargetResult;

use crate::emu::Emu;

impl target::ext::breakpoints::Breakpoints for Emu {
#[inline(always)]
fn support_sw_breakpoint(
Expand Down
3 changes: 1 addition & 2 deletions examples/armv4t/gdb/catch_syscalls.rs
@@ -1,8 +1,7 @@
use crate::gdb::Emu;
use gdbstub::target;
use gdbstub::target::ext::catch_syscalls::SyscallNumbers;

use crate::gdb::Emu;

// This implementation is for illustrative purposes only. If the target doesn't
// support syscalls then there is no need to implement this extension

Expand Down
5 changes: 2 additions & 3 deletions examples/armv4t/gdb/exec_file.rs
@@ -1,10 +1,9 @@
use super::copy_range_to_buf;
use crate::emu::Emu;
use gdbstub::common::Pid;
use gdbstub::target;
use gdbstub::target::TargetResult;

use super::copy_range_to_buf;
use crate::emu::Emu;

impl target::ext::exec_file::ExecFile for Emu {
fn get_exec_file(
&self,
Expand Down
7 changes: 4 additions & 3 deletions examples/armv4t/gdb/extended_mode.rs
@@ -1,10 +1,11 @@
use crate::emu::Emu;
use gdbstub::common::Pid;
use gdbstub::target;
use gdbstub::target::ext::extended_mode::{Args, AttachKind, ShouldTerminate};
use gdbstub::target::ext::extended_mode::Args;
use gdbstub::target::ext::extended_mode::AttachKind;
use gdbstub::target::ext::extended_mode::ShouldTerminate;
use gdbstub::target::TargetResult;

use crate::emu::Emu;

/*=====================================
= Extended Mode =
=====================================*/
Expand Down
21 changes: 13 additions & 8 deletions examples/armv4t/gdb/host_io.rs
@@ -1,13 +1,18 @@
use std::io::{Read, Seek, Write};

use gdbstub::target;
use gdbstub::target::ext::host_io::{
FsKind, HostIoErrno, HostIoError, HostIoOpenFlags, HostIoOpenMode, HostIoResult, HostIoStat,
};

use super::{copy_range_to_buf, copy_to_buf};
use super::copy_range_to_buf;
use super::copy_to_buf;
use crate::emu::Emu;
use crate::TEST_PROGRAM_ELF;
use gdbstub::target;
use gdbstub::target::ext::host_io::FsKind;
use gdbstub::target::ext::host_io::HostIoErrno;
use gdbstub::target::ext::host_io::HostIoError;
use gdbstub::target::ext::host_io::HostIoOpenFlags;
use gdbstub::target::ext::host_io::HostIoOpenMode;
use gdbstub::target::ext::host_io::HostIoResult;
use gdbstub::target::ext::host_io::HostIoStat;
use std::io::Read;
use std::io::Seek;
use std::io::Write;

const FD_RESERVED: u32 = 1;

Expand Down
13 changes: 8 additions & 5 deletions examples/armv4t/gdb/lldb_register_info_override.rs
@@ -1,12 +1,15 @@
use gdbstub::arch::lldb::{Encoding, Format, Generic, Register};
use crate::gdb::custom_arch::ArmCoreRegIdCustom;
use crate::gdb::Emu;
use gdbstub::arch::lldb::Encoding;
use gdbstub::arch::lldb::Format;
use gdbstub::arch::lldb::Generic;
use gdbstub::arch::lldb::Register;
use gdbstub::arch::RegId;
use gdbstub::target;
use gdbstub::target::ext::lldb_register_info_override::{Callback, CallbackToken};
use gdbstub::target::ext::lldb_register_info_override::Callback;
use gdbstub::target::ext::lldb_register_info_override::CallbackToken;
use gdbstub_arch::arm::reg::id::ArmCoreRegId;

use crate::gdb::custom_arch::ArmCoreRegIdCustom;
use crate::gdb::Emu;

// (LLDB extension) This implementation is for illustrative purposes only.
//
// Note: In this implementation, we have r0-pc from 0-16 but cpsr is at offset
Expand Down
5 changes: 2 additions & 3 deletions examples/armv4t/gdb/memory_map.rs
@@ -1,8 +1,7 @@
use gdbstub::target;
use gdbstub::target::TargetResult;

use super::copy_range_to_buf;
use crate::emu::Emu;
use gdbstub::target;
use gdbstub::target::TargetResult;

impl target::ext::memory_map::MemoryMap for Emu {
fn memory_map_xml(
Expand Down
27 changes: 17 additions & 10 deletions examples/armv4t/gdb/mod.rs
@@ -1,14 +1,17 @@
use crate::emu::Emu;
use crate::emu::ExecMode;
use armv4t_emu::reg;
use armv4t_emu::Memory;
use core::convert::TryInto;

use armv4t_emu::{reg, Memory};
use gdbstub::common::Signal;
use gdbstub::target;
use gdbstub::target::ext::base::singlethread::{SingleThreadBase, SingleThreadResume};
use gdbstub::target::{Target, TargetError, TargetResult};
use gdbstub::target::ext::base::singlethread::SingleThreadBase;
use gdbstub::target::ext::base::singlethread::SingleThreadResume;
use gdbstub::target::Target;
use gdbstub::target::TargetError;
use gdbstub::target::TargetResult;
use gdbstub_arch::arm::reg::id::ArmCoreRegId;

use crate::emu::{Emu, ExecMode};

// Additional GDB extensions

mod auxv;
Expand Down Expand Up @@ -390,10 +393,14 @@ impl target::ext::base::singlethread::SingleThreadRangeStepping for Emu {

mod custom_arch {
use core::num::NonZeroUsize;

use gdbstub::arch::lldb::{Encoding, Format, Generic, Register, RegisterInfo};
use gdbstub::arch::{Arch, RegId, Registers};

use gdbstub::arch::lldb::Encoding;
use gdbstub::arch::lldb::Format;
use gdbstub::arch::lldb::Generic;
use gdbstub::arch::lldb::Register;
use gdbstub::arch::lldb::RegisterInfo;
use gdbstub::arch::Arch;
use gdbstub::arch::RegId;
use gdbstub::arch::Registers;
use gdbstub_arch::arm::reg::id::ArmCoreRegId;
use gdbstub_arch::arm::reg::ArmCoreRegs;
use gdbstub_arch::arm::ArmBreakpointKind;
Expand Down
6 changes: 3 additions & 3 deletions examples/armv4t/gdb/monitor_cmd.rs
@@ -1,7 +1,7 @@
use gdbstub::target;
use gdbstub::target::ext::monitor_cmd::{outputln, ConsoleOutput};

use crate::gdb::Emu;
use gdbstub::target;
use gdbstub::target::ext::monitor_cmd::outputln;
use gdbstub::target::ext::monitor_cmd::ConsoleOutput;

impl target::ext::monitor_cmd::MonitorCmd for Emu {
fn handle_monitor_cmd(
Expand Down
3 changes: 1 addition & 2 deletions examples/armv4t/gdb/section_offsets.rs
@@ -1,8 +1,7 @@
use crate::gdb::Emu;
use gdbstub::target;
use gdbstub::target::ext::section_offsets::Offsets;

use crate::gdb::Emu;

// This implementation is for illustrative purposes only. If the offsets are
// guaranteed to be zero, this extension does not need to be implemented.

Expand Down
5 changes: 2 additions & 3 deletions examples/armv4t/gdb/target_description_xml_override.rs
@@ -1,10 +1,9 @@
use super::copy_range_to_buf;
use crate::emu::Emu;
use gdbstub::target;
use gdbstub::target::TargetError;
use gdbstub::target::TargetResult;

use super::copy_range_to_buf;
use crate::emu::Emu;

impl target::ext::target_description_xml_override::TargetDescriptionXmlOverride for Emu {
fn target_description_xml(
&self,
Expand Down
18 changes: 11 additions & 7 deletions examples/armv4t/main.rs
Expand Up @@ -2,16 +2,20 @@
//! `arm-none-eabi-cc -march=armv4t`. It's not modeled after any real-world
//! system.

use std::net::{TcpListener, TcpStream};

#[cfg(unix)]
use std::os::unix::net::{UnixListener, UnixStream};

use gdbstub::common::Signal;
use gdbstub::conn::{Connection, ConnectionExt};
use gdbstub::conn::Connection;
use gdbstub::conn::ConnectionExt;
use gdbstub::stub::run_blocking;
use gdbstub::stub::DisconnectReason;
use gdbstub::stub::GdbStub;
use gdbstub::stub::SingleThreadStopReason;
use gdbstub::stub::{run_blocking, DisconnectReason, GdbStub};
use gdbstub::target::Target;
use std::net::TcpListener;
use std::net::TcpStream;
#[cfg(unix)]
use std::os::unix::net::UnixListener;
#[cfg(unix)]
use std::os::unix::net::UnixStream;

type DynResult<T> = Result<T, Box<dyn std::error::Error>>;

Expand Down
13 changes: 8 additions & 5 deletions examples/armv4t_multicore/emu.rs
Expand Up @@ -9,12 +9,15 @@
//! system that can be debugged, it would really merit a re-write, since it's
//! not a good example of "proper Rust coding practices"

use std::collections::HashMap;

use armv4t_emu::{reg, Cpu, ExampleMem, Memory, Mode};

use crate::mem_sniffer::{AccessKind, MemSniffer};
use crate::mem_sniffer::AccessKind;
use crate::mem_sniffer::MemSniffer;
use crate::DynResult;
use armv4t_emu::reg;
use armv4t_emu::Cpu;
use armv4t_emu::ExampleMem;
use armv4t_emu::Memory;
use armv4t_emu::Mode;
use std::collections::HashMap;

const HLE_RETURN_ADDR: u32 = 0x12345678;

Expand Down
19 changes: 12 additions & 7 deletions examples/armv4t_multicore/gdb.rs
@@ -1,12 +1,17 @@
use armv4t_emu::{reg, Memory};

use gdbstub::common::{Signal, Tid};
use crate::emu::CpuId;
use crate::emu::Emu;
use crate::emu::ExecMode;
use armv4t_emu::reg;
use armv4t_emu::Memory;
use gdbstub::common::Signal;
use gdbstub::common::Tid;
use gdbstub::target;
use gdbstub::target::ext::base::multithread::{MultiThreadBase, MultiThreadResume};
use gdbstub::target::ext::base::multithread::MultiThreadBase;
use gdbstub::target::ext::base::multithread::MultiThreadResume;
use gdbstub::target::ext::breakpoints::WatchKind;
use gdbstub::target::{Target, TargetError, TargetResult};

use crate::emu::{CpuId, Emu, ExecMode};
use gdbstub::target::Target;
use gdbstub::target::TargetError;
use gdbstub::target::TargetResult;

pub fn cpuid_to_tid(id: CpuId) -> Tid {
match id {
Expand Down
19 changes: 12 additions & 7 deletions examples/armv4t_multicore/main.rs
Expand Up @@ -3,15 +3,20 @@
//! `gdbstub`'s multi-process support. It's not modeled after any real-world
//! system.

use std::net::{TcpListener, TcpStream};

#[cfg(unix)]
use std::os::unix::net::{UnixListener, UnixStream};

use gdbstub::common::Signal;
use gdbstub::conn::{Connection, ConnectionExt};
use gdbstub::stub::{run_blocking, DisconnectReason, GdbStub, MultiThreadStopReason};
use gdbstub::conn::Connection;
use gdbstub::conn::ConnectionExt;
use gdbstub::stub::run_blocking;
use gdbstub::stub::DisconnectReason;
use gdbstub::stub::GdbStub;
use gdbstub::stub::MultiThreadStopReason;
use gdbstub::target::Target;
use std::net::TcpListener;
use std::net::TcpStream;
#[cfg(unix)]
use std::os::unix::net::UnixListener;
#[cfg(unix)]
use std::os::unix::net::UnixStream;

type DynResult<T> = Result<T, Box<dyn std::error::Error>>;

Expand Down
1 change: 0 additions & 1 deletion gdbstub_arch/src/aarch64/reg/aarch64_core.rs
@@ -1,5 +1,4 @@
use core::convert::TryInto;

use gdbstub::arch::Registers;

/// AArch64 core registers.
Expand Down
1 change: 0 additions & 1 deletion gdbstub_arch/src/aarch64/reg/id.rs
@@ -1,5 +1,4 @@
use core::num::NonZeroUsize;

use gdbstub::arch::RegId;

/// AArch64 Architectural Registers.
Expand Down
1 change: 0 additions & 1 deletion gdbstub_arch/src/arm/reg/id.rs
@@ -1,5 +1,4 @@
use core::num::NonZeroUsize;

use gdbstub::arch::RegId;

/// 32-bit ARM core register identifier.
Expand Down
1 change: 0 additions & 1 deletion gdbstub_arch/src/mips/reg/id.rs
@@ -1,5 +1,4 @@
use core::num::NonZeroUsize;

use gdbstub::arch::RegId;

/// MIPS register identifier.
Expand Down

0 comments on commit e2329b8

Please sign in to comment.