sigmd 0.1.0

Windows API signature metadata
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

//! Translation-unit walking.

use super::{
    BuildContext, ScoredMetadata, clang, function::build_function, interface::build_interface,
};

/// Walks the TU and carves a `name -> byte size` map from named type
/// declarations.
pub fn collect_sizeofs(cursor: clang::Entity<'_>, ctx: &mut BuildContext) {
    match cursor.get_kind() {
        clang::EntityKind::TranslationUnit
        | clang::EntityKind::LinkageSpec
        | clang::EntityKind::Namespace
        | clang::EntityKind::UnexposedDecl => {
            for child in cursor.get_children() {
                collect_sizeofs(child, ctx);
            }
        }
        clang::EntityKind::StructDecl
        | clang::EntityKind::ClassDecl
        | clang::EntityKind::UnionDecl
        | clang::EntityKind::TypedefDecl
        | clang::EntityKind::TypeAliasDecl => {
            let name = match cursor.get_name() {
                Some(name) => name,
                None => return,
            };

            let ty = match cursor.get_type() {
                Some(ty) => ty,
                None => return,
            };

            let size = match ty.get_sizeof() {
                Some(size) => size,
                None => return,
            };

            if let Some(prev) = ctx.sizeofs.insert(name.clone(), size)
                && prev != size
            {
                tracing::debug!(name, prev, size, "sizeof conflict; last wins");
            }
        }
        _ => {}
    }
}

pub fn visit(cursor: clang::Entity<'_>, ctx: &BuildContext, out: &mut ScoredMetadata) {
    match cursor.get_kind() {
        clang::EntityKind::TranslationUnit
        | clang::EntityKind::LinkageSpec
        | clang::EntityKind::Namespace
        | clang::EntityKind::UnexposedDecl => {
            for child in cursor.get_children() {
                visit(child, ctx, out);
            }
        }
        clang::EntityKind::FunctionDecl => {
            // Conversion failures are expected for declarations that
            // are not monitored functions (e.g. inlines without SAL).
            match build_function(cursor, ctx) {
                Ok(scored) => out.functions.push(scored),
                Err(err) => tracing::trace!(%err, "skipping non-function decl"),
            }
        }
        clang::EntityKind::StructDecl | clang::EntityKind::ClassDecl => {
            // Most SDK structs are not COM interfaces. They lack the
            // `__UUID|...` annotation.
            match build_interface(cursor, ctx) {
                Ok(scored) => out.interfaces.push(scored),
                Err(err) => tracing::trace!(%err, "skipping non-interface decl"),
            }
        }
        _ => {}
    }
}