Grcov report - assertions.rs

1

//! Debug-only structural assertions for AST/model integrity.

2

//!

3

//! The assertions in this module validate a few key invariants:

4

//! - `Root` exists exactly once, at the top-level model root, and nowhere else.

5

//! - all referenced names resolve to declarations present in reachable symbol tables.

6

//! - a combined model well-formedness check that applies all assertions.

7

8

use super::Model;

9

10

#[cfg(debug_assertions)]

11

use std::collections::{BTreeSet, HashSet};

12

13

#[cfg(debug_assertions)]

14

use super::{Expression, Name, Reference, SymbolTablePtr, serde::HasId};

15

#[cfg(debug_assertions)]

16

use uniplate::Biplate;

17

18

/// Debug-assert that a model is well-formed by applying all AST assertions in this module.

19

#[cfg(debug_assertions)]

20

149434

pub fn debug_assert_model_well_formed(model: &Model, origin: &str) {

21

149434

    debug_assert_root_at_top_level_only(model, origin);

22

149434

    debug_assert_all_names_resolved(model, origin);

23

149434

24

25

/// Debug-assert that a model is well-formed by applying all AST assertions in this module.

26

#[cfg(not(debug_assertions))]

27

pub fn debug_assert_model_well_formed(_model: &Model, _origin: &str) {}

28

29

/// Debug-assert that all names referenced by expressions/domains resolve to declared symbols.

30

#[cfg(debug_assertions)]

31

149434

pub fn debug_assert_all_names_resolved(model: &Model, origin: &str) {

32

149434

    let mut declared_names: BTreeSet<Name> = BTreeSet::new();

33

149434

    let mut referenced_names: BTreeSet<Name> = BTreeSet::new();

34

35

218694

    for table_ptr in collect_reachable_symbol_tables(model) {

36

218694

        let table = table_ptr.read();

37

38

6330290

        for (name, decl) in table.iter_local() {

39

6330290

            declared_names.insert(name.clone());

40

41

6330290

            if let Some(expr) = decl.as_value_letting() {

42

134574

                referenced_names.extend(Biplate::<Reference>::universe_bi(&*expr).into_iter().map(

43

161460

                    |reference| {

44

161460

                        let name = reference.name();

45

161460

                        canonical_resolution_name(&name).clone()

46

161460

},

47

));

48

6195716

49

50

6330290

            if let Some(domain) = decl.domain() {

51

6330170

                referenced_names.extend(

52

6330170

                    Biplate::<Reference>::universe_bi(domain.as_ref())

53

6330170

                        .into_iter()

54

6330170

                        .map(|reference| {

55

141580

                            let name = reference.name();

56

141580

                            canonical_resolution_name(&name).clone()

57

141580

}),

58

);

59

120

60

61

62

63

149434

    referenced_names.extend(

64

149434

        Biplate::<Reference>::universe_bi(model.root())

65

149434

            .into_iter()

66

2978128

            .map(|reference| {

67

2978128

                let name = reference.name();

68

2978128

                canonical_resolution_name(&name).clone()

69

2978128

}),

70

);

71

72

149434

    if let Some(dominance) = &model.dominance {

73

        referenced_names.extend(

74

            Biplate::<Reference>::universe_bi(dominance)

75

                .into_iter()

76

                .map(|reference| {

77

                    let name = reference.name();

78

                    canonical_resolution_name(&name).clone()

79

}),

80

);

81

149434

82

83

10279814

    for clause in model.clauses() {

84

22120100

        for literal in clause.iter() {

85

22120100

            referenced_names.extend(Biplate::<Reference>::universe_bi(literal).into_iter().map(

86

22120100

                |reference| {

87

22120100

                    let name = reference.name();

88

22120100

                    canonical_resolution_name(&name).clone()

89

22120100

},

90

));

91

92

93

94

149434

    let unresolved: Vec<Name> = referenced_names

95

149434

        .difference(&declared_names)

96

149434

        .cloned()

97

149434

        .collect();

98

99

149434

    debug_assert!(

100

149434

        unresolved.is_empty(),

101

        "Model from '{origin}' contains unresolved names: {unresolved:?}"

102

);

103

149434

104

105

/// Debug-assert that all names referenced by expressions/domains resolve to declared symbols.

106

#[cfg(not(debug_assertions))]

107

pub fn debug_assert_all_names_resolved(_model: &Model, _origin: &str) {}

108

109

#[cfg(debug_assertions)]

110

25560440

fn canonical_resolution_name(name: &Name) -> &Name {

111

25560440

    match name {

112

        // Names wrapped in a selected representation still resolve through the source declaration.

113

159172

        Name::WithRepresentation(inner, _) => canonical_resolution_name(inner),

114

25401268

        _ => name,

115

116

25560440

117

118

/// Debug-assert that there is exactly one `Root` expression, and it is the model's top-level root.

119

#[cfg(debug_assertions)]

120

149434

pub fn debug_assert_root_at_top_level_only(model: &Model, origin: &str) {

121

149434

    debug_assert!(

122

149434

        matches!(model.root(), Expression::Root(_, _)),

123

        "Model from '{origin}' does not have Root at top-level"

124

);

125

126

149434

    let root_count_in_main_tree = Biplate::<Expression>::universe_bi(model)

127

149434

        .iter()

128

6529186

        .filter(|expr| matches!(expr, Expression::Root(_, _)))

129

149434

        .count();

130

131

149434

    let root_count_in_clauses = model

132

149434

        .clauses()

133

149434

        .iter()

134

10279814

        .flat_map(|clause| clause.iter())

135

22120534

        .map(|expr| {

136

22120100

            Biplate::<Expression>::universe_bi(expr)

137

22120100

                .iter()

138

34821020

                .filter(|inner| matches!(inner, Expression::Root(_, _)))

139

22120100

                .count()

140

22120100

})

141

149434

        .sum::<usize>();

142

143

149434

    let total_root_count = root_count_in_main_tree + root_count_in_clauses;

144

149434

    debug_assert_eq!(

145

        total_root_count, 1,

146

        "Model from '{origin}' should contain exactly one Root expression at top-level, found {total_root_count}"

147

);

148

149434

149

150

/// Debug-assert that there is exactly one `Root` expression, and it is the model's top-level root.

151

#[cfg(not(debug_assertions))]

152

pub fn debug_assert_root_at_top_level_only(_model: &Model, _origin: &str) {}

153

154

#[cfg(debug_assertions)]

155

149434

fn collect_reachable_symbol_tables(model: &Model) -> Vec<SymbolTablePtr> {

156

149434

    let mut pending_tables: Vec<SymbolTablePtr> = vec![model.symbols_ptr_unchecked().clone()];

157

149434

    pending_tables.extend(Biplate::<SymbolTablePtr>::universe_bi(model.root()));

158

159

149434

    if let Some(dominance) = &model.dominance {

160

        pending_tables.extend(Biplate::<SymbolTablePtr>::universe_bi(dominance));

161

149434

162

163

10279814

    for clause in model.clauses() {

164

22120100

        for literal in clause.iter() {

165

22120100

            pending_tables.extend(Biplate::<SymbolTablePtr>::universe_bi(literal));

166

22120100

167

168

169

149434

    let mut seen_tables = HashSet::new();

170

149434

    let mut out = Vec::new();

171

172

390072

    while let Some(table_ptr) = pending_tables.pop() {

173

240638

        if !seen_tables.insert(table_ptr.id()) {

174

21944

            continue;

175

218694

176

177

218694

        let parent = table_ptr.read().parent().clone();

178

218694

        if let Some(parent) = parent {

179

69260

            pending_tables.push(parent);

180

149434

181

182

218694

        out.push(table_ptr);

183

184

185

149434

out

186

149434