ptx-90-parser 0.3.0

Parse NVIDIA PTX 9.0 assembly into a structured AST and explore modules via a CLI.
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

use super::common::*;
use super::function::{DwarfDirective, FunctionKernelDirective};
use super::variable::ModuleVariableDirective;
use crate::parser::Span;

/// A full PTX module containing directives and function definitions.
#[derive(Debug, Clone, PartialEq)]
pub struct Module {
    pub directives: Vec<ModuleDirective>,
    pub span: Span,
}

impl Module {
    pub fn with_span(mut self, span: Span) -> Self {
        self.span = span;
        self
    }
}

impl Default for Module {
    fn default() -> Self {
        Self {
            directives: Vec::new(),
            span: 0..0,
        }
    }
}

/// Module-level directives recognised by the parser.
#[derive(Debug, Clone, PartialEq)]
pub enum ModuleDirective {
    ModuleVariable { directive: ModuleVariableDirective, span: Span },
    FunctionKernel { directive: FunctionKernelDirective, span: Span },
    ModuleInfo { directive: ModuleInfoDirectiveKind, span: Span },
    Debug { directive: ModuleDebugDirective, span: Span },
    Linking { directive: LinkingDirective, span: Span },
}

impl ModuleDirective {
    pub fn span(&self) -> Span {
        match self {
            ModuleDirective::ModuleVariable { span, .. } => span.clone(),
            ModuleDirective::FunctionKernel { span, .. } => span.clone(),
            ModuleDirective::ModuleInfo { span, .. } => span.clone(),
            ModuleDirective::Debug { span, .. } => span.clone(),
            ModuleDirective::Linking { span, .. } => span.clone(),
        }
    }
}

/// Directives that apply to the PTX module as a whole.
#[derive(Debug, Clone, PartialEq)]
pub enum ModuleInfoDirectiveKind {
    Version { directive: VersionDirective, span: Span },
    Target { directive: TargetDirective, span: Span },
    AddressSize { directive: AddressSizeDirective, span: Span },
}

impl ModuleInfoDirectiveKind {
    pub fn span(&self) -> Span {
        match self {
            ModuleInfoDirectiveKind::Version { span, .. } => span.clone(),
            ModuleInfoDirectiveKind::Target { span, .. } => span.clone(),
            ModuleInfoDirectiveKind::AddressSize { span, .. } => span.clone(),
        }
    }
}

/// Structured representation of the `.version` directive.
#[derive(Debug, Clone, PartialEq)]
pub struct VersionDirective {
    pub major: u32,
    pub minor: u32,
    pub span: Span,
}

impl VersionDirective {
    pub fn with_span(mut self, span: Span) -> Self {
        self.span = span;
        self
    }
}

/// Structured representation of the `.target` directive.
#[derive(Debug, Clone, PartialEq)]
pub struct TargetDirective {
    pub entries: Vec<String>,
    pub span: Span,
}

impl TargetDirective {
    pub fn with_span(mut self, span: Span) -> Self {
        self.span = span;
        self
    }
}

/// Structured representation of the `.address_size` directive.
#[derive(Debug, Clone, PartialEq)]
pub struct AddressSizeDirective {
    pub size: u32,
    pub span: Span,
}

impl AddressSizeDirective {
    pub fn with_span(mut self, span: Span) -> Self {
        self.span = span;
        self
    }
}

/// Debugging directives defined by the PTX ISA.
#[derive(Debug, Clone, PartialEq)]
pub enum ModuleDebugDirective {
    File { directive: FileDirective, span: Span },
    Section { directive: SectionDirective, span: Span },
    Dwarf { directive: DwarfDirective, span: Span },
}

impl ModuleDebugDirective {
    pub fn span(&self) -> Span {
        match self {
            ModuleDebugDirective::File { span, .. } => span.clone(),
            ModuleDebugDirective::Section { span, .. } => span.clone(),
            ModuleDebugDirective::Dwarf { span, .. } => span.clone(),
        }
    }
}

/// Structured representation of the `.file` directive.
#[derive(Debug, Clone, PartialEq)]
pub struct FileDirective {
    pub index: u32,
    pub path: String,
    pub span: Span,
}

impl FileDirective {
    pub fn with_span(mut self, span: Span) -> Self {
        self.span = span;
        self
    }
}

/// Structured representation of the `.section` directive.
#[derive(Debug, Clone, PartialEq)]
pub struct SectionDirective {
    pub name: String,
    pub attributes: Vec<String>,
    pub span: Span,
}

impl SectionDirective {
    pub fn with_span(mut self, span: Span) -> Self {
        self.span = span;
        self
    }
}

/// Linking directives that influence symbol visibility. TODO: further parse the
/// prototype, which should be a function signature.
#[derive(Debug, Clone, PartialEq)]
pub struct LinkingDirective {
    pub kind: CodeOrDataLinkage,
    pub prototype: String,
    pub span: Span,
}

impl LinkingDirective {
    pub fn with_span(mut self, span: Span) -> Self {
        self.span = span;
        self
    }
}