veryl-analyzer 0.20.0

A modern hardware description language
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

use crate::analyzer_error::{AnalyzerError, InvalidModportItemKind, MismatchTypeKind};
use crate::attribute::ExpandItem;
use crate::attribute_table;
use crate::conv::{Affiliation, Context};
use crate::symbol::Direction as SymDirection;
use crate::symbol::{Symbol, SymbolKind, TypeKind};
use crate::symbol_path::SymbolPathNamespace;
use crate::symbol_table;
use veryl_parser::resource_table::StrId;
use veryl_parser::veryl_grammar_trait::*;

fn is_target_modport(context: &mut Context, identifier: &Identifier) -> bool {
    context.is_affiliated(Affiliation::Function)
        || attribute_table::is_expand(&identifier.identifier_token.token, ExpandItem::Modport)
}

fn is_unexpandable_modport(context: &mut Context, symbol: &Symbol) -> bool {
    if let SymbolKind::Port(x) = &symbol.kind {
        if !matches!(x.direction, SymDirection::Modport) {
            return false;
        }

        let port_type = &x.r#type;
        match &x.r#type.kind {
            TypeKind::UserDefined(x) => {
                let Ok(symbol) = symbol_table::resolve((&x.path.generic_path(), &symbol.namespace))
                else {
                    return false;
                };

                if let SymbolKind::Modport(modport) = &symbol.found.kind
                    && let Some(symbol) = symbol_table::get(modport.interface)
                {
                    let SymbolKind::Interface(x) = symbol.kind else {
                        unreachable!()
                    };

                    let is_expandable = x.parameters.is_empty()
                        && (!context.is_affiliated(Affiliation::Function)
                            || port_type.array.is_empty());
                    if !is_expandable {
                        return true;
                    }
                }
            }
            TypeKind::AbstractInterface(_) => return true,
            _ => {}
        }
    }

    false
}

fn is_function_defined_in_interface(symbol: &Symbol) -> bool {
    match &symbol.kind {
        SymbolKind::Function(x) => x.affiliation == Affiliation::Interface,
        SymbolKind::ProtoFunction(x) => x.affiliation == Affiliation::Interface,
        _ => false,
    }
}

pub fn check_modport_in_port(context: &mut Context, arg: &PortDeclarationItem) {
    if is_target_modport(context, &arg.identifier)
        && let Ok(symbol) = symbol_table::resolve(arg.identifier.as_ref())
        && is_unexpandable_modport(context, &symbol.found)
    {
        context.insert_error(AnalyzerError::unexpandable_modport(
            &arg.identifier.identifier_token.token.to_string(),
            &arg.identifier.as_ref().into(),
        ));
    }
}

pub fn check_modport(context: &mut Context, arg: &ModportItem) {
    let mut path: SymbolPathNamespace = arg.identifier.as_ref().into();
    path.pop_namespace();

    if let Ok(symbol) = symbol_table::resolve(path) {
        match &*arg.direction {
            Direction::Modport(_) => {}
            Direction::Import(_) => {
                if !is_function_defined_in_interface(&symbol.found) {
                    context.insert_error(AnalyzerError::invalid_modport_item(
                        InvalidModportItemKind::Function,
                        &arg.identifier.identifier_token.token.to_string(),
                        &arg.identifier.as_ref().into(),
                    ));
                }
            }
            _ => {
                if !matches!(symbol.found.kind, SymbolKind::Variable(_)) {
                    context.insert_error(AnalyzerError::invalid_modport_item(
                        InvalidModportItemKind::Variable,
                        &arg.identifier.identifier_token.token.to_string(),
                        &arg.identifier.as_ref().into(),
                    ));
                }
            }
        }
    }
}

pub fn check_modport_default(context: &mut Context, arg: &ModportDefault, name: StrId) {
    let default_member_identifiers: Vec<_> = match arg {
        ModportDefault::SameLParenModportDefaultListRParen(x) => {
            x.modport_default_list.as_ref().into()
        }
        ModportDefault::ConverseLParenModportDefaultListRParen(x) => {
            x.modport_default_list.as_ref().into()
        }
        _ => return,
    };

    for identifier in default_member_identifiers {
        let Ok(symbol) = symbol_table::resolve(identifier) else {
            return;
        };

        if !matches!(symbol.found.kind, SymbolKind::Modport(_)) {
            // Check modport default member type
            context.insert_error(AnalyzerError::mismatch_type(
                MismatchTypeKind::SymbolKind {
                    name: symbol.found.token.to_string(),
                    expected: "modport".to_string(),
                    actual: symbol.found.kind.to_kind_name(),
                },
                &identifier.identifier_token.token.into(),
            ));
        } else if symbol.found.token.text == name {
            // Check self reference
            context.insert_error(AnalyzerError::mismatch_type(
                MismatchTypeKind::SymbolKind {
                    name: symbol.found.token.to_string(),
                    expected: "other modport".to_string(),
                    actual: "ownself".to_string(),
                },
                &identifier.identifier_token.token.into(),
            ));
        }
    }
}