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

381850

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

21

381850

    debug_assert_root_at_top_level_only(model, origin);

22

381850

    debug_assert_all_names_resolved(model, origin);

23

381850

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

381850

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

32

381850

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

33

381850

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

34

35

499616

    for table_ptr in collect_reachable_symbol_tables(model) {

36

499616

        let table = table_ptr.read();

37

38

33059392

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

39

33059392

            declared_names.insert(name.clone());

40

41

33059392

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

42

193768

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

43

1450

                    |reference| {

44

1450

                        let name = reference.name();

45

1450

                        canonical_resolution_name(&name).clone()

46

1450

},

47

));

48

32865624

49

50

33059392

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

51

33058952

                referenced_names.extend(

52

33058952

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

53

33058952

                        .into_iter()

54

33058952

                        .map(|reference| {

55

171198

                            let name = reference.name();

56

171198

                            canonical_resolution_name(&name).clone()

57

171198

}),

58

);

59

440

60

61

62

63

381850

    referenced_names.extend(

64

381850

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

65

381850

            .into_iter()

66

8171032

            .map(|reference| {

67

8171032

                let name = reference.name();

68

8171032

                canonical_resolution_name(&name).clone()

69

8171032

}),

70

);

71

72

381850

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

73

30840

        referenced_names.extend(

74

30840

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

75

30840

                .into_iter()

76

465920

                .map(|reference| {

77

465920

                    let name = reference.name();

78

465920

                    canonical_resolution_name(&name).clone()

79

465920

}),

80

);

81

351010

82

83

105947050

    for clause in model.clauses() {

84

220390880

        for literal in clause.iter() {

85

220390880

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

86

220390880

                |reference| {

87

220390880

                    let name = reference.name();

88

220390880

                    canonical_resolution_name(&name).clone()

89

220390880

},

90

));

91

92

93

94

381850

    let unresolved: Vec<Name> = referenced_names

95

381850

        .difference(&declared_names)

96

381850

        .cloned()

97

381850

        .collect();

98

99

381850

    debug_assert!(

100

381850

        unresolved.is_empty(),

101

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

102

);

103

381850

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

229381952

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

111

229381952

    match name {

112

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

113

181472

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

114

229200480

        _ => name,

115

116

229381952

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

381850

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

121

381850

    debug_assert!(

122

381850

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

123

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

124

);

125

126

381850

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

127

381850

        .iter()

128

18109678

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

129

381850

        .count();

130

131

381850

    let root_count_in_clauses = model

132

381850

        .clauses()

133

381850

        .iter()

134

105947050

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

135

220392890

        .map(|expr| {

136

220390880

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

137

220390880

                .iter()

138

368254660

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

139

220390880

                .count()

140

220390880

})

141

381850

        .sum::<usize>();

142

143

381850

    let total_root_count = root_count_in_main_tree + root_count_in_clauses;

144

381850

    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

381850

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

381850

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

156

381850

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

157

381850

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

158

159

381850

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

160

30840

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

161

351010

162

163

105947050

    for clause in model.clauses() {

164

220390880

        for literal in clause.iter() {

165

220390880

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

166

220390880

167

168

169

381850

    let mut seen_tables = HashSet::new();

170

381850

    let mut out = Vec::new();

171

172

934080

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

173

552230

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

174

52614

            continue;

175

499616

176

177

499616

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

178

499616

        if let Some(parent) = parent {

179

117754

            pending_tables.push(parent);

180

399374

181

182

499616

        out.push(table_ptr);

183

184

185

381850

out

186

381850