1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

//! Compress and decompress ELF32 relocation sections
//!
//! This crate can be used to compress ELF32 relocation sections post-link time.
//! It also provides a decompressing method which can be used during relocation.
//!
//! The approach might be useful for embedded system if a relocation section
//! uses too much static storage.
//!
//! Decompressing relocations is a trade-off between used static storage and
//! CPU time required to process relocations during initialization.
//!
//! # Compressed section layout for ELF32
//!
//! ```ignore
//! /// ELF32 relocations grouped by relocation type.
//! struct Elf32CRelGroup {
//!     // Type of the relocation.
//!     relocation_type: u8,
//!     // Number of relocations encoded as ULEB128.
//!     count: u32,
//!     // Offsets are encoded as ULEB128.
//!     // First offset is relative to `base_address`,
//!     // otherwise offset[i+1] is relative to offset[i].
//!     offsets: [u32; count],
//! }
//!
//! /// A compressed ELF32 relocation section.
//! struct Elf32CRel {
//!     // Base address of all the relocations.
//!     base_address: u32,
//!     // Number of relocation groups.
//!     count: u8,
//!     // Relocation groups.
//!     groups: [Elf32CRelGroup; count],
//! }
//! ```
//!
//! # Recommended usage
//!
//! On host machines, during post-link time processing,
//! use `host` feature group.
//!
//! When targeting embedded devices use either `embedded` or `embedded_minimal`
//! feature group. The latter one enables `no_bounds_check` and
//! `no_sanity_check` features to further reduce memory footprint.
//!
//! ## List of optional features
//!
//! * `compress`: include methods and structures related to compressing.
//! * `decompress`: include methods and structures related to decompressing.
//! * `no-std`: do not use standard library.
//! * `no_bounds_check`: use `unsafe` code instead of bounds-checking variants.
//! * `no_sanity_check`: do not perform extra sanity checks when processing LEB128
//!   encodings.

#![crate_name = "relox"]
#![cfg_attr(feature = "no_std", no_std)]
#![deny(missing_docs, unused, unused_imports)]

mod error;
mod uleb128;

pub use error::{Error, ErrorKind};

#[cfg(all(feature = "compress", not(feature = "no_std")))]
mod compress;
#[cfg(all(feature = "compress", not(feature = "no_std")))]
pub use compress::*;

#[cfg(feature = "decompress")]
mod decompress;
#[cfg(feature = "decompress")]
pub use decompress::*;