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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

//! # `ModuleRef` Table Loader
//!
//! This module provides the loader implementation for the [`ModuleRef`](crate::metadata::tables::ModuleRef) table,
//! which contains references to external modules that are required by the current assembly.
//! `ModuleRef` entries identify multi-module assemblies and their dependencies.
//!
//! ## Purpose
//!
//! The [`ModuleRefLoader`] processes [`crate::metadata::tables::ModuleRefRaw`] entries during metadata loading,
//! converting them to owned [`ModuleRef`](crate::metadata::tables::ModuleRef) instances with resolved module names.
//! These entries represent references to external modules that contain types or methods
//! used by the current assembly.
//!
//! ## Table Dependencies
//!
//! The `ModuleRef` table has no dependencies on other metadata tables:
//! - Only depends on the string heap for module name resolution
//! - Can be loaded early in the dependency resolution process
//! - Serves as a foundation for cross-module references
//!
//! ## Error Conditions
//!
//! - String heap entries are malformed or missing
//! - `ModuleRef` table contains invalid data
//! - Token conflicts occur during storage

use crate::{
    metadata::{
        diagnostics::DiagnosticCategory,
        loader::{LoaderContext, MetadataLoader},
        tables::ModuleRefRaw,
    },
    prelude::TableId,
    Result,
};

/// Loader implementation for the `ModuleRef` metadata table.
///
/// This loader processes [`crate::metadata::tables::ModuleRefRaw`] entries, converting them to
/// owned [`crate::metadata::tables::ModuleRef`] instances with resolved module names.
/// `ModuleRef` entries represent references to external modules that contain types or methods
/// used by the current assembly.
pub(crate) struct ModuleRefLoader;

impl MetadataLoader for ModuleRefLoader {
    /// Loads and processes all `ModuleRef` table entries.
    ///
    /// ## Arguments
    /// * `context` - The loader context containing metadata tables and storage
    ///
    /// ## Errors
    /// Returns an error if:
    /// - String heap entries cannot be resolved or are malformed
    /// - `ModuleRef` table contains invalid or corrupted data
    /// - Storage operations fail due to token conflicts
    fn load(&self, context: &LoaderContext) -> Result<()> {
        let (Some(header), Some(strings)) = (context.meta, context.strings) else {
            return Ok(());
        };
        let Some(table) = header.table::<ModuleRefRaw>() else {
            return Ok(());
        };

        table.par_iter().try_for_each(|row| {
            let token_msg = || format!("module ref 0x{:08x}", row.token.value());

            let Some(res) = context.handle_result(
                row.to_owned(strings),
                DiagnosticCategory::Table,
                token_msg,
            )?
            else {
                return Ok(());
            };

            context.module_ref.insert(row.token, res.clone());
            Ok(())
        })
    }

    /// Returns the table identifier for `ModuleRef`.
    ///
    /// ## Returns
    /// [`crate::metadata::tables::TableId::ModuleRef`] (0x1A)
    fn table_id(&self) -> Option<TableId> {
        Some(TableId::ModuleRef)
    }

    /// Returns the table dependencies for `ModuleRef` loading.
    ///
    /// The `ModuleRef` table has no dependencies as it only references the string heap
    /// for module name resolution. It can be loaded early in the dependency resolution
    /// process and serves as a foundation for cross-module references.
    ///
    /// ## Returns
    /// Empty array as `ModuleRef` table has no table dependencies
    fn dependencies(&self) -> &'static [TableId] {
        &[]
    }
}