dotscope 0.6.0

A high-performance, cross-platform framework for analyzing and reverse engineering .NET PE executables
Documentation 
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

//! `FieldLayout` metadata table implementation.
//!
//! This module provides structures and utilities for working with the `FieldLayout` metadata table,
//! which specifies explicit field positioning within types. The `FieldLayout` table defines the
//! byte offset of fields in classes and value types, enabling precise control over memory layout.
//!
//! # Overview
//! The `FieldLayout` table is used when explicit field layout control is required, such as:
//! - **Interop scenarios**: P/Invoke, COM interop requiring specific layouts
//! - **Performance optimization**: Cache-line alignment, memory layout control
//! - **Platform compatibility**: Ensuring consistent layouts across platforms
//! - **Legacy compatibility**: Matching existing native data structure layouts
//!
//! # Components
//! - [`crate::metadata::tables::fieldlayout::raw::FieldLayoutRaw`]: Raw field layout data read directly from metadata tables
//! - [`crate::metadata::tables::fieldlayout::owned::FieldLayout`]: Owned field layout data with resolved references
//! - [`crate::metadata::tables::fieldlayout::loader::FieldLayoutLoader`]: Processes and loads field layout metadata
//! - [`crate::metadata::tables::fieldlayout::FieldLayoutMap`]: Thread-safe collection of field layouts indexed by token
//! - [`crate::metadata::tables::fieldlayout::FieldLayoutList`]: Vector-based collection of field layouts
//! - [`crate::metadata::tables::fieldlayout::FieldLayoutRc`]: Reference-counted field layout for shared ownership
//!
//! # Table Structure
//! Each `FieldLayout` entry contains:
//! - **Offset**: 4-byte field offset within the containing type
//! - **Field**: Reference to the field in the Field table
//!
//! # Field Layout Scenarios
//! - **Sequential Layout**: Default .NET field ordering (no `FieldLayout` entries)
//! - **Explicit Layout**: Specific byte offsets defined (`FieldLayout` entries present)
//! - **Auto Layout**: Runtime-optimized positioning (no `FieldLayout` entries)
//!
//! # ECMA-335 Reference
//! See ECMA-335, Partition II, ยง22.16 for the complete `FieldLayout` table specification.

use crate::metadata::token::Token;
use crossbeam_skiplist::SkipMap;
use std::sync::Arc;

mod builder;
mod loader;
mod owned;
mod raw;
mod reader;
mod writer;

pub use builder::*;
pub(crate) use loader::*;
pub use owned::*;
pub use raw::*;

/// Thread-safe map of field layout entries indexed by field token.
///
/// This skip list-based map provides efficient concurrent access to field layout
/// information, allowing multiple threads to query field offsets during metadata
/// processing and type resolution operations.
pub type FieldLayoutMap = SkipMap<Token, FieldLayoutRc>;

/// Thread-safe vector of field layout entries.
///
/// This collection provides ordered access to field layout entries, useful for
/// sequential processing and bulk operations during metadata analysis.
pub type FieldLayoutList = Arc<boxcar::Vec<FieldLayoutRc>>;

/// Reference-counted field layout entry.
///
/// Provides shared ownership of [`crate::metadata::tables::fieldlayout::owned::FieldLayout`] instances, enabling efficient
/// sharing of field layout data across multiple data structures and threads.
pub type FieldLayoutRc = Arc<FieldLayout>;