Merge pull request #316 from philipc/release

Release 0.25.0

Author: philipc

CHANGELOG.md

@@ -0,0 +1,54 @@
+# `object` Change Log
+
+--------------------------------------------------------------------------------
+
+## 0.25.0
+
+Released 2021/06/02.
+
+### Breaking changes
+
+* Added `non_exhaustive` to most public enums.
+  [#306](https://github.com/gimli-rs/object/pull/306)
+
+* `MachHeader::parse` and `MachHeader::load_commands` now require a header offset.
+  [#304](https://github.com/gimli-rs/object/pull/304)
+
+* Added `ReadRef::read_bytes_at_until`.
+  [#308](https://github.com/gimli-rs/object/pull/308)
+
+* `PeFile::entry`, `PeSection::address` and `PeSegment::address` now return a
+  virtual address instead of a RVA.
+  [#315](https://github.com/gimli-rs/object/pull/315)
+
+### Added
+
+* Added `pod::from_bytes_mut`, `pod::slice_from_bytes_mut`, `pod::bytes_of_mut`,
+  and `pod::bytes_of_slice_mut`.
+  [#296](https://github.com/gimli-rs/object/pull/296)
+  [#297](https://github.com/gimli-rs/object/pull/297)
+
+* Added `Object::pdb_info`.
+  [#298](https://github.com/gimli-rs/object/pull/298)
+
+* Added `read::macho::DyldCache`, other associated definitions,
+  and support for these in the examples.
+  [#308](https://github.com/gimli-rs/object/pull/308)
+
+* Added more architecture support.
+  [#303](https://github.com/gimli-rs/object/pull/303)
+  [#309](https://github.com/gimli-rs/object/pull/309)
+
+* Derive more traits for enums.
+  [#311](https://github.com/gimli-rs/object/pull/311)
+
+* Added `Object::relative_address_base`.
+  [#315](https://github.com/gimli-rs/object/pull/315)
+
+### Changed
+
+* Improved performance for string parsing.
+  [#302](https://github.com/gimli-rs/object/pull/302)
+
+* `objdump` example allows selecting container members.
+  [#308](https://github.com/gimli-rs/object/pull/308)

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "object"
-version = "0.24.0"
+version = "0.25.0"
 authors = [
     "Nick Fitzgerald <fitzgen@gmail.com>",
     "Philip Craig <philipjcraig@gmail.com>",

src/pod.rs

@@ -343,6 +343,7 @@ impl BytesMut {
     }
 
     #[inline]
+    #[allow(dead_code)]
     pub fn write<T: Pod>(&mut self, val: &T) {
         self.0.extend_from_slice(bytes_of(val))
     }

src/read/any.rs

@@ -19,6 +19,7 @@ use crate::read::{
     SectionIndex, SectionKind, SymbolFlags, SymbolIndex, SymbolKind, SymbolMap, SymbolMapName,
     SymbolScope, SymbolSection,
 };
+#[allow(unused_imports)]
 use crate::Endianness;
 
 /// Evaluate an expression on the contents of a file format enum.
@@ -226,15 +227,16 @@ impl<'data, R: ReadRef<'data>> File<'data, R> {
     /// where multiple images, located at different offsets, share the same address
     /// space.
     pub fn parse_at(data: R, offset: u64) -> Result<Self> {
-        let inner = match FileKind::parse_at(data, offset)? {
+        let _inner = match FileKind::parse_at(data, offset)? {
             #[cfg(feature = "macho")]
             FileKind::MachO32 => FileInternal::MachO32(macho::MachOFile32::parse_at(data, offset)?),
             #[cfg(feature = "macho")]
             FileKind::MachO64 => FileInternal::MachO64(macho::MachOFile64::parse_at(data, offset)?),
             #[allow(unreachable_patterns)]
             _ => return Err(Error("Unsupported file format")),
         };
-        Ok(File { inner })
+        #[allow(unreachable_code)]
+        Ok(File { inner: _inner })
     }
 
     /// Return the file format.

src/read/mod.rs

@@ -5,7 +5,7 @@ use alloc::vec::Vec;
 use core::{fmt, result};
 
 use crate::common::*;
-use crate::{ByteString, Endianness};
+use crate::ByteString;
 
 mod read_ref;
 pub use read_ref::*;
@@ -18,7 +18,21 @@ pub use read_cache::*;
 mod util;
 pub use util::StringTable;
 
+#[cfg(any(
+    feature = "coff",
+    feature = "elf",
+    feature = "macho",
+    feature = "pe",
+    feature = "wasm"
+))]
 mod any;
+#[cfg(any(
+    feature = "coff",
+    feature = "elf",
+    feature = "macho",
+    feature = "pe",
+    feature = "wasm"
+))]
 pub use any::*;
 
 #[cfg(feature = "archive")]
@@ -86,7 +100,7 @@ impl<T> ReadError<T> for Option<T> {
     target_pointer_width = "32",
     feature = "elf"
 ))]
-pub type NativeFile<'data, R = &'data [u8]> = elf::ElfFile32<'data, Endianness, R>;
+pub type NativeFile<'data, R = &'data [u8]> = elf::ElfFile32<'data, crate::Endianness, R>;
 
 /// The native executable file for the target platform.
 #[cfg(all(
@@ -95,15 +109,15 @@ pub type NativeFile<'data, R = &'data [u8]> = elf::ElfFile32<'data, Endianness,
     target_pointer_width = "64",
     feature = "elf"
 ))]
-pub type NativeFile<'data, R = &'data [u8]> = elf::ElfFile64<'data, Endianness, R>;
+pub type NativeFile<'data, R = &'data [u8]> = elf::ElfFile64<'data, crate::Endianness, R>;
 
 /// The native executable file for the target platform.
 #[cfg(all(target_os = "macos", target_pointer_width = "32", feature = "macho"))]
-pub type NativeFile<'data, R = &'data [u8]> = macho::MachOFile32<'data, Endianness, R>;
+pub type NativeFile<'data, R = &'data [u8]> = macho::MachOFile32<'data, crate::Endianness, R>;
 
 /// The native executable file for the target platform.
 #[cfg(all(target_os = "macos", target_pointer_width = "64", feature = "macho"))]
-pub type NativeFile<'data, R = &'data [u8]> = macho::MachOFile64<'data, Endianness, R>;
+pub type NativeFile<'data, R = &'data [u8]> = macho::MachOFile64<'data, crate::Endianness, R>;
 
 /// The native executable file for the target platform.
 #[cfg(all(target_os = "windows", target_pointer_width = "32", feature = "pe"))]

src/read/util.rs

@@ -2,12 +2,13 @@ use core::convert::TryInto;
 
 use crate::pod::Bytes;
 
-#[allow(unused)]
+#[allow(dead_code)]
 #[inline]
 pub(crate) fn align(offset: usize, size: usize) -> usize {
     (offset + (size - 1)) & !(size - 1)
 }
 
+#[allow(dead_code)]
 pub(crate) fn data_range(
     data: &[u8],
     data_address: u64,

src/write/elf.rs

@@ -7,6 +7,7 @@ use crate::pod::{bytes_of, BytesMut, WritableBuffer};
 use crate::write::string::*;
 use crate::write::util::*;
 use crate::write::*;
+use crate::AddressSize;
 
 #[derive(Default, Clone, Copy)]
 struct ComdatOffsets {

src/write/macho.rs

@@ -6,6 +6,7 @@ use crate::pod::{bytes_of, WritableBuffer};
 use crate::write::string::*;
 use crate::write::util::*;
 use crate::write::*;
+use crate::AddressSize;
 
 #[derive(Default, Clone, Copy)]
 struct SectionOffsets {

src/write/mod.rs

@@ -8,8 +8,8 @@ use std::{error, fmt, result, str};
 use crate::endian::{Endianness, U32, U64};
 use crate::pod::{BytesMut, WritableBuffer};
 use crate::{
-    AddressSize, Architecture, BinaryFormat, ComdatKind, FileFlags, RelocationEncoding,
-    RelocationKind, SectionFlags, SectionKind, SymbolFlags, SymbolKind, SymbolScope,
+    Architecture, BinaryFormat, ComdatKind, FileFlags, RelocationEncoding, RelocationKind,
+    SectionFlags, SectionKind, SymbolFlags, SymbolKind, SymbolScope,
 };
 
 #[cfg(feature = "coff")]
@@ -103,6 +103,7 @@ impl Object {
     /// Return the name for a standard segment.
     ///
     /// This will vary based on the file format.
+    #[allow(unused_variables)]
     pub fn segment_name(&self, segment: StandardSegment) -> &'static [u8] {
         match self.format {
             #[cfg(feature = "coff")]
@@ -241,6 +242,7 @@ impl Object {
         (segment, name, kind)
     }
 
+    #[allow(unused_variables)]
     fn subsection_name(&self, section: &[u8], value: &[u8]) -> Vec<u8> {
         debug_assert!(!self.has_subsections_via_symbols());
         match self.format {
@@ -432,6 +434,7 @@ impl Object {
     ///
     /// For Mach-O, this also creates a `__thread_vars` entry for TLS symbols, and the
     /// symbol will indirectly point to the data via the `__thread_vars` entry.
+    #[allow(unused_mut)]
     pub fn set_symbol_data(
         &mut self,
         mut symbol_id: SymbolId,

src/write/util.rs

@@ -4,6 +4,7 @@ pub(crate) fn align(offset: usize, size: usize) -> usize {
     (offset + (size - 1)) & !(size - 1)
 }
 
+#[allow(dead_code)]
 pub(crate) fn align_u64(offset: u64, size: u64) -> u64 {
     (offset + (size - 1)) & !(size - 1)
 }