def test_equal_simplified(self) -> None:
self.assertEqual(
Equal(Variable("X"), Add(Number(21), Number(21))).simplified(),
Equal(Variable("X"), Number(42)),
)
def context_predicate(message: Message, composite_fields: Sequence[Field], prefix: str) -> Expr:
def valid_predecessors_invariant() -> Expr:
return AndThen(
*[
If(
[
(
Call(
"Structural_Valid",
[Indexed(Variable("Cursors"), Variable(f.affixed_name))],
),
Or(
*[
AndThen(
Call(
"Structural_Valid"
if l.source in composite_fields
else "Valid",
[
Indexed(
Variable("Cursors"),
Variable(l.source.affixed_name),
)
],
),
Equal(
Selected(
Indexed(
Variable("Cursors"), Variable(f.affixed_name),
),
"Predecessor",
),
Variable(l.source.affixed_name),
),
l.condition.substituted(
substitution(message, embedded=True)
),
).simplified()
for l in message.incoming(f)
]
),
)
]
)
for f in message.fields
if f not in message.direct_successors(INITIAL)
]
)
def invalid_successors_invariant() -> Expr:
return AndThen(
*[
If(
[
(
AndThen(
*[
Call(
"Invalid",
[Indexed(Variable("Cursors"), Variable(p.affixed_name))],
)
for p in message.direct_predecessors(f)
]
),
Call(
"Invalid", [Indexed(Variable("Cursors"), Variable(f.affixed_name))],
),
)
]
)
for f in message.fields
if f not in message.direct_successors(INITIAL)
]
)
return AndThen(
If(
[
(
NotEqual(Variable("Buffer"), Variable("null")),
And(
Equal(First("Buffer"), Variable("Buffer_First")),
Equal(Last("Buffer"), Variable("Buffer_Last")),
),
)
]
),
public_context_predicate(),
ForAllIn(
"F",
ValueRange(First("Field"), Last("Field")),
If(
[
(
Call("Structural_Valid", [Indexed(Variable("Cursors"), Variable("F"))]),
And(
GreaterEqual(
Selected(Indexed(Variable("Cursors"), Variable("F")), "First"),
Variable("First"),
),
LessEqual(
Selected(Indexed(Variable("Cursors"), Variable("F")), "Last"),
Variable("Last"),
),
LessEqual(
Selected(Indexed(Variable("Cursors"), Variable("F")), "First"),
Add(
Selected(Indexed(Variable("Cursors"), Variable("F")), "Last"),
Number(1),
),
),
Equal(
Selected(
Selected(Indexed(Variable("Cursors"), Variable("F")), "Value"),
"Fld",
),
Variable("F"),
),
),
)
]
),
),
valid_predecessors_invariant(),
invalid_successors_invariant(),
message_structure_invariant(message, prefix, embedded=True),
)
def test_pdu_fields_ethernet(self) -> None:
expected = OrderedDict([
('Destination',
Field('Destination',
ModularInteger('UINT48', Pow(Number(2), Number(48))),
TRUE,
{
'0':
Variant(
[],
TRUE,
{
Length('Destination'): Number(48),
First('Destination'): Number(0),
Last('Destination'): Number(47)
})
})),
('Source',
Field('Source',
ModularInteger('UINT48', Pow(Number(2), Number(48))),
TRUE,
{
'00':
Variant(
[
('Destination', '0')
],
TRUE,
{
Length('Destination'): Number(48),
First('Destination'): Number(0),
Last('Destination'): Number(47),
Length('Source'): Number(48),
First('Source'): Number(48),
Last('Source'): Number(95)
})
})),
('TPID',
Field('TPID',
RangeInteger('UINT16',
Number(0),
Sub(Pow(Number(2), Number(16)), Number(1)),
Number(16)),
Or(NotEqual(Value('TPID'), Number(0x8100)),
Equal(Value('TPID'), Number(0x8100))),
{
'000':
Variant(
[
('Destination', '0'),
('Source', '00')
],
TRUE,
{
Length('Destination'): Number(48),
First('Destination'): Number(0),
Last('Destination'): Number(47),
Length('Source'): Number(48),
First('Source'): Number(48),
Last('Source'): Number(95),
Length('TPID'): Number(16),
First('TPID'): Number(96),
Last('TPID'): Number(111)
})
})),
('TCI',
Field('TCI',
RangeInteger('UINT16',
Number(0),
Sub(Pow(Number(2), Number(16)), Number(1)),
Number(16)),
TRUE,
{
'0000':
Variant(
[
('Destination', '0'),
('Source', '00'),
('TPID', '000')
],
Equal(Value('TPID'), Number(0x8100)),
{
Length('Destination'): Number(48),
First('Destination'): Number(0),
Last('Destination'): Number(47),
Length('Source'): Number(48),
First('Source'): Number(48),
Last('Source'): Number(95),
Length('TPID'): Number(16),
First('TPID'): Number(96),
Last('TPID'): Number(111),
Length('TCI'): Number(16),
First('TCI'): Number(112),
Last('TCI'): Number(127)
})
})),
('EtherType',
Field('EtherType',
RangeInteger('UINT16',
Number(0),
Sub(Pow(Number(2), Number(16)), Number(1)),
Number(16)),
Or(GreaterEqual(Value('EtherType'), Number(1536)),
LessEqual(Value('EtherType'), Number(1500))),
{
'00000':
Variant(
[
('Destination', '0'),
('Source', '00'),
('TPID', '000'),
('TCI', '0000')
],
TRUE,
{
Length('Destination'): Number(48),
First('Destination'): Number(0),
Last('Destination'): Number(47),
Length('Source'): Number(48),
First('Source'): Number(48),
Last('Source'): Number(95),
Length('TPID'): Number(16),
First('TPID'): Number(96),
Last('TPID'): Number(111),
Length('TCI'): Number(16),
First('TCI'): Number(112),
Last('TCI'): Number(127),
Length('EtherType'): Number(16),
First('EtherType'): Number(128),
Last('EtherType'): Number(143)
}),
'0001':
Variant(
[
('Destination', '0'),
('Source', '00'),
('TPID', '000')
],
NotEqual(Value('TPID'), Number(0x8100)),
{
Length('Destination'): Number(48),
First('Destination'): Number(0),
Last('Destination'): Number(47),
Length('Source'): Number(48),
First('Source'): Number(48),
Last('Source'): Number(95),
Length('TPID'): Number(16),
First('TPID'): Number(96),
Last('TPID'): Number(111),
Length('EtherType'): Number(16),
First('EtherType'): Number(96),
Last('EtherType'): Number(111)
})
})),
('Payload',
Field('Payload',
Array('Payload_Array'),
And(GreaterEqual(Div(Length('Payload'), Number(8)), Number(46)),
LessEqual(Div(Length('Payload'), Number(8)), Number(1500))),
{
'000000':
Variant(
[
('Destination', '0'),
('Source', '00'),
('TPID', '000'),
('TCI', '0000'),
('EtherType', '00000')
],
LessEqual(Value('EtherType'), Number(1500)),
{
Length('Destination'): Number(48),
First('Destination'): Number(0),
Last('Destination'): Number(47),
Length('Source'): Number(48),
First('Source'): Number(48),
Last('Source'): Number(95),
Length('TPID'): Number(16),
First('TPID'): Number(96),
Last('TPID'): Number(111),
Length('TCI'): Number(16),
First('TCI'): Number(112),
Last('TCI'): Number(127),
Length('EtherType'): Number(16),
First('EtherType'): Number(128),
Last('EtherType'): Number(143),
Length('Payload'): Mul(LengthValue('EtherType'), Number(8)),
First('Payload'): Number(144),
Last('Payload'): Add(Mul(LengthValue('EtherType'), Number(8)),
Number(143))
}),
'000001':
Variant(
[
('Destination', '0'),
('Source', '00'),
('TPID', '000'),
('TCI', '0000'),
('EtherType', '00000')
],
GreaterEqual(Value('EtherType'), Number(1536)),
{
Length('Destination'): Number(48),
First('Destination'): Number(0),
Last('Destination'): Number(47),
Length('Source'): Number(48),
First('Source'): Number(48),
Last('Source'): Number(95),
Length('TPID'): Number(16),
First('TPID'): Number(96),
Last('TPID'): Number(111),
Length('TCI'): Number(16),
First('TCI'): Number(112),
Last('TCI'): Number(127),
Length('EtherType'): Number(16),
First('EtherType'): Number(128),
Last('EtherType'): Number(143),
Length('Payload'): Add(Last('Message'), Number(-143)),
First('Payload'): Number(144),
Last('Payload'): Last('Message')
}),
'00010':
Variant(
[
('Destination', '0'),
('Source', '00'),
('TPID', '000'),
('EtherType', '0001')
],
LessEqual(Value('EtherType'), Number(1500)),
{
Length('Destination'): Number(48),
First('Destination'): Number(0),
Last('Destination'): Number(47),
Length('Source'): Number(48),
First('Source'): Number(48),
Last('Source'): Number(95),
Length('TPID'): Number(16),
First('TPID'): Number(96),
Last('TPID'): Number(111),
Length('EtherType'): Number(16),
First('EtherType'): Number(96),
Last('EtherType'): Number(111),
Length('Payload'): Mul(LengthValue('EtherType'), Number(8)),
First('Payload'): Number(112),
Last('Payload'): Add(Mul(LengthValue('EtherType'), Number(8)),
Number(111))
}),
'00011':
Variant(
[
('Destination', '0'),
('Source', '00'),
('TPID', '000'),
('EtherType', '0001')
],
GreaterEqual(Value('EtherType'), Number(1536)),
{
Length('Destination'): Number(48),
First('Destination'): Number(0),
Last('Destination'): Number(47),
Length('Source'): Number(48),
First('Source'): Number(48),
Last('Source'): Number(95),
Length('TPID'): Number(16),
First('TPID'): Number(96),
Last('TPID'): Number(111),
Length('EtherType'): Number(16),
First('EtherType'): Number(96),
Last('EtherType'): Number(111),
Length('Payload'): Add(Last('Message'), Number(-111)),
First('Payload'): Number(112),
Last('Payload'): Last('Message')
})
})),
('FINAL',
Field('FINAL',
Null(),
TRUE,
{
'0000000':
Variant(
[
('Destination', '0'),
('Source', '00'),
('TPID', '000'),
('TCI', '0000'),
('EtherType', '00000'),
('Payload', '000000')
],
And(GreaterEqual(Div(Length('Payload'), Number(8)), Number(46)),
LessEqual(Div(Length('Payload'), Number(8)), Number(1500))),
{
Length('Destination'): Number(48),
First('Destination'): Number(0),
Last('Destination'): Number(47),
Length('Source'): Number(48),
First('Source'): Number(48),
Last('Source'): Number(95),
Length('TPID'): Number(16),
First('TPID'): Number(96),
Last('TPID'): Number(111),
Length('TCI'): Number(16),
First('TCI'): Number(112),
Last('TCI'): Number(127),
Length('EtherType'): Number(16),
First('EtherType'): Number(128),
Last('EtherType'): Number(143),
Length('Payload'): Mul(LengthValue('EtherType'), Number(8)),
First('Payload'): Number(144),
Last('Payload'): Add(Mul(LengthValue('EtherType'), Number(8)),
Number(143))
}),
'0000010':
Variant(
[
('Destination', '0'),
('Source', '00'),
('TPID', '000'),
('TCI', '0000'),
('EtherType', '00000'),
('Payload', '000001')
],
And(GreaterEqual(Div(Length('Payload'), Number(8)), Number(46)),
LessEqual(Div(Length('Payload'), Number(8)), Number(1500))),
{
Length('Destination'): Number(48),
First('Destination'): Number(0),
Last('Destination'): Number(47),
Length('Source'): Number(48),
First('Source'): Number(48),
Last('Source'): Number(95),
Length('TPID'): Number(16),
First('TPID'): Number(96),
Last('TPID'): Number(111),
Length('TCI'): Number(16),
First('TCI'): Number(112),
Last('TCI'): Number(127),
Length('EtherType'): Number(16),
First('EtherType'): Number(128),
Last('EtherType'): Number(143),
Length('Payload'): Add(Last('Message'), Number(-143)),
First('Payload'): Number(144),
Last('Payload'): Last('Message')
}),
'000100':
Variant(
[
('Destination', '0'),
('Source', '00'),
('TPID', '000'),
('EtherType', '0001'),
('Payload', '00010')
],
And(GreaterEqual(Div(Length('Payload'), Number(8)), Number(46)),
LessEqual(Div(Length('Payload'), Number(8)), Number(1500))),
{
Length('Destination'): Number(48),
First('Destination'): Number(0),
Last('Destination'): Number(47),
Length('Source'): Number(48),
First('Source'): Number(48),
Last('Source'): Number(95),
Length('TPID'): Number(16),
First('TPID'): Number(96),
Last('TPID'): Number(111),
Length('EtherType'): Number(16),
First('EtherType'): Number(96),
Last('EtherType'): Number(111),
Length('Payload'): Mul(LengthValue('EtherType'), Number(8)),
First('Payload'): Number(112),
Last('Payload'): Add(Mul(LengthValue('EtherType'), Number(8)),
Number(111))
}),
'000110':
Variant(
[
('Destination', '0'),
('Source', '00'),
('TPID', '000'),
('EtherType', '0001'),
('Payload', '00011')
],
And(GreaterEqual(Div(Length('Payload'), Number(8)), Number(46)),
LessEqual(Div(Length('Payload'), Number(8)), Number(1500))),
{
Length('Destination'): Number(48),
First('Destination'): Number(0),
Last('Destination'): Number(47),
Length('Source'): Number(48),
First('Source'): Number(48),
Last('Source'): Number(95),
Length('TPID'): Number(16),
First('TPID'): Number(96),
Last('TPID'): Number(111),
Length('EtherType'): Number(16),
First('EtherType'): Number(96),
Last('EtherType'): Number(111),
Length('Payload'): Add(Last('Message'), Number(-111)),
First('Payload'): Number(112),
Last('Payload'): Last('Message')
})
}))
])
self.assertEqual(ETHERNET_PDU.fields(), expected)
def message_structure_invariant(
self, message: Message, link: Link = None, prefix: bool = True
) -> Expr:
def prefixed(name: str) -> Expr:
return Selected(Name("Ctx"), name) if prefix else Name(name)
if not link:
return self.message_structure_invariant(message, message.outgoing(INITIAL)[0], prefix)
source = link.source
target = link.target
if target is FINAL:
return TRUE
field_type = message.types[target]
condition = link.condition.simplified(self.substitution(message, prefix))
length = (
Size(base_type_name(field_type))
if isinstance(field_type, Scalar)
else link.length.simplified(self.substitution(message, prefix))
)
first = (
Name(prefixed("First"))
if source == INITIAL
else link.first.simplified(
{
**self.substitution(message, prefix),
**{
UNDEFINED: Add(
Selected(
Indexed(prefixed("Cursors"), Name(source.affixed_name)), "Last"
),
Number(1),
)
},
}
)
)
return If(
[
(
AndThen(
Call(
"Structural_Valid",
[Indexed(prefixed("Cursors"), Name(target.affixed_name))],
),
condition,
),
AndThen(
Equal(
Add(
Sub(
Selected(
Indexed(prefixed("Cursors"), Name(target.affixed_name)),
"Last",
),
Selected(
Indexed(prefixed("Cursors"), Name(target.affixed_name)),
"First",
),
),
Number(1),
),
length,
),
Equal(
Selected(
Indexed(prefixed("Cursors"), Name(target.affixed_name)),
"Predecessor",
),
Name(source.affixed_name),
),
Equal(
Selected(
Indexed(prefixed("Cursors"), Name(target.affixed_name)), "First"
),
first,
),
*[
self.message_structure_invariant(message, l, prefix)
for l in message.outgoing(target)
],
),
)
]
).simplified()
def substitution_facts(
message: Message,
embedded: bool = False,
public: bool = False,
target_type: ID = const.TYPES_U64,
) -> Mapping[Name, Expr]:
def prefixed(name: str) -> Expr:
return Variable(f"Ctx.{name}") if not embedded else Variable(name)
first = prefixed("First")
last = prefixed("Last")
cursors = prefixed("Cursors")
def field_first(field: Field) -> Expr:
if public:
return Call("Field_First", [Variable("Ctx"), Variable(field.affixed_name)])
return Selected(Indexed(cursors, Variable(field.affixed_name)), "First")
def field_last(field: Field) -> Expr:
if public:
return Call("Field_Last", [Variable("Ctx"), Variable(field.affixed_name)])
return Selected(Indexed(cursors, Variable(field.affixed_name)), "Last")
def field_length(field: Field) -> Expr:
if public:
return Call("Field_Length", [Variable("Ctx"), Variable(field.affixed_name)])
return Add(
Sub(
Selected(Indexed(cursors, Variable(field.affixed_name)), "Last"),
Selected(Indexed(cursors, Variable(field.affixed_name)), "First"),
),
Number(1),
)
def field_value(field: Field, field_type: Type) -> Expr:
if isinstance(field_type, Enumeration):
if public:
return Call(
target_type, [Call("To_Base", [Call(f"Get_{field.name}", [Variable("Ctx")])])],
)
return Call(
target_type,
[
Selected(
Indexed(cursors, Variable(field.affixed_name)), f"Value.{field.name}_Value"
)
],
)
if isinstance(field_type, Scalar):
if public:
return Call(target_type, [Call(f"Get_{field.name}", [Variable("Ctx")])])
return Call(
target_type,
[
Selected(
Indexed(cursors, Variable(field.affixed_name)), f"Value.{field.name}_Value"
)
],
)
if isinstance(field_type, Composite):
return Variable(field.name)
assert False, f'unexpected type "{type(field_type).__name__}"'
return UNDEFINED
return {
**{First("Message"): first},
**{Last("Message"): last},
**{Length("Message"): Add(last, -first, Number(1))},
**{First(f.name): field_first(f) for f in message.fields},
**{Last(f.name): field_last(f) for f in message.fields},
**{Length(f.name): field_length(f) for f in message.fields},
**{Variable(f.name): field_value(f, t) for f, t in message.types.items()},
**{
Variable(l): Call(target_type, [Call("To_Base", [Variable(l)])])
for t in message.types.values()
if isinstance(t, Enumeration)
for l in t.literals.keys()
},
**{
Variable(t.package * l): Call(target_type, [Call("To_Base", [Variable(t.package * l)])])
for t in message.types.values()
if isinstance(t, Enumeration)
for l in t.literals.keys()
},
}
def create_composite_initialize_procedures(self, message: Message) -> UnitPart:
def specification(field: Field) -> ProcedureSpecification:
return ProcedureSpecification(
f"Initialize_{field.name}", [InOutParameter(["Ctx"], "Context")]
)
def specification_bounded(field: Field) -> ProcedureSpecification:
return ProcedureSpecification(
f"Initialize_Bounded_{field.name}",
[InOutParameter(["Ctx"], "Context"), Parameter(["Length"], self.types.bit_length)],
)
return UnitPart(
[
SubprogramDeclaration(
specification(f),
[
Precondition(
AndThen(
*self.setter_preconditions(f),
*self.unbounded_composite_setter_preconditions(message, f),
)
),
Postcondition(
And(
*self.composite_setter_postconditions(message, f, message.types[f]),
)
),
],
)
for f, t in message.types.items()
if isinstance(t, Payload) and unbounded_setter_required(message, f)
]
+ [
SubprogramDeclaration(
specification_bounded(f),
[
Precondition(
AndThen(
*self.setter_preconditions(f),
*self.bounded_composite_setter_preconditions(message, f),
)
),
Postcondition(
And(
*self.composite_setter_postconditions(message, f, message.types[f]),
)
),
],
)
for f, t in message.types.items()
if isinstance(t, Payload) and bounded_setter_required(message, f)
],
[
SubprogramBody(
specification(f),
self.common.field_bit_location_declarations(Name(f.affixed_name)),
self.common.initialize_field_statements(message, f),
)
for f, t in message.types.items()
if isinstance(t, Payload) and unbounded_setter_required(message, f)
]
+ [
SubprogramBody(
specification_bounded(f),
[
ObjectDeclaration(
["First"],
self.types.bit_index,
Call("Field_First", [Name("Ctx"), Name(f.affixed_name)]),
True,
),
ObjectDeclaration(
["Last"],
self.types.bit_index,
Add(Name("First"), Name("Length"), -Number(1)),
True,
),
],
self.common.initialize_field_statements(message, f),
)
for f, t in message.types.items()
if isinstance(t, Payload) and bounded_setter_required(message, f)
],
)
def test_range_invalid_first_variable(self) -> None:
with self.assertRaises(ModelError):
RangeInteger("P.T", Add(Number(1), Variable("X")), Number(15), Number(4))
def test_add_ge(self) -> None:
self.assertEqual(
Add(Value('X'), Number(1)) >= Add(Value('X'), Number(2)), False)
self.assertEqual(
Add(Value('X'), Number(2)) >= Add(Value('X'), Number(2)), True)
self.assertEqual(
Add(Value('X'), Number(3)) >= Add(Value('X'), Number(2)), True)
self.assertEqual(
Add(Value('X'), Number(1)) >= Add(Value('Y'), Number(2)), False)
self.assertEqual(
Add(Value('X'), Number(2)) >= Add(Value('Y'), Number(1)), False)
self.assertEqual(
Add(Value('X'), Number(2)) >= Add(Value('Y'), Value('Z'),
Number(1)), False)
def test_term_simplified(self) -> None:
self.assertEqual(
Add(Mul(Number(1), Number(6)), Sub(Value('X'), Number(10)),
Add(Number(1), Number(3))).simplified(), Value('X'))
def test_quantified_expression_simplified(self) -> None:
self.assertEqual(
ForAllOf("X", Name("List"), Add(Last("Y"), Add(Number(21), Number(21)))).simplified(),
ForAllOf("X", Name("List"), Add(Last("Y"), Number(42))),
)
def test_add_to_bytes(self) -> None:
self.assertEqual(
Add(Value('X'), Number(8)).to_bytes(), Add(Value('X'), Number(1)))
def test_value_range_simplified(self) -> None:
self.assertEqual(
ValueRange(Number(1), Add(Number(21), Number(21))).simplified(),
ValueRange(Number(1), Number(42)),
)
def test_not_in_simplified(self) -> None:
self.assertEqual(
NotIn(Variable("X"), Add(Number(21), Number(21))).simplified(),
NotIn(Variable("X"), Number(42)),
)
def test_greater_simplified(self) -> None:
self.assertEqual(
Greater(Variable("X"), Add(Number(21), Number(21))).simplified(),
Greater(Variable("X"), Number(42)),
)
def test_add() -> None:
assert Add(Number(42), Number(1)).z3expr() == z3.IntVal(0) + z3.IntVal(42) + z3.IntVal(1)
assert_equal(
Add(Number(42), Number(1), Number(10)).z3expr(),
z3.IntVal(0) + z3.IntVal(42) + z3.IntVal(1) + z3.IntVal(10),
)
def test_term_to_bytes(self) -> None:
self.assertEqual(
Add(Mul(Number(8), Number(48)), Sub(Value('X'), Number(80)),
Div(Number(8), Number(24))).to_bytes(),
Add(Mul(Number(1), Number(6)), Sub(Value('X'), Number(10)),
Div(Number(1), Number(3))))
def create_composite_setter_procedures(self, message: Message) -> UnitPart:
def specification(field: Field) -> ProcedureSpecification:
return ProcedureSpecification(f"Set_{field.name}", [InOutParameter(["Ctx"], "Context")])
def specification_bounded(field: Field) -> ProcedureSpecification:
return ProcedureSpecification(
f"Set_Bounded_{field.name}",
[InOutParameter(["Ctx"], "Context"), Parameter(["Length"], self.types.bit_length)],
)
formal_parameters = [
FormalSubprogramDeclaration(
ProcedureSpecification(
"Process_Payload", [OutParameter(["Payload"], self.types.bytes)],
)
)
]
return UnitPart(
[
SubprogramDeclaration(
specification(f),
[
Precondition(
AndThen(
*self.setter_preconditions(f),
*self.unbounded_composite_setter_preconditions(message, f),
)
),
Postcondition(
And(
*self.composite_setter_postconditions(message, f, message.types[f]),
)
),
],
formal_parameters,
)
for f, t in message.types.items()
if isinstance(t, Payload) and unbounded_setter_required(message, f)
]
+ [
SubprogramDeclaration(
specification_bounded(f),
[
Precondition(
AndThen(
*self.setter_preconditions(f),
*self.bounded_composite_setter_preconditions(message, f),
)
),
Postcondition(
And(
*self.composite_setter_postconditions(message, f, message.types[f]),
)
),
],
formal_parameters,
)
for f, t in message.types.items()
if isinstance(t, Payload) and bounded_setter_required(message, f)
],
[
SubprogramBody(
specification(f),
[
*self.common.field_bit_location_declarations(Name(f.affixed_name)),
ExpressionFunctionDeclaration(
FunctionSpecification("Buffer_First", self.types.index),
Call(self.types.byte_index, [Name("First")]),
),
ExpressionFunctionDeclaration(
FunctionSpecification("Buffer_Last", self.types.index),
Call(self.types.byte_index, [Name("Last")]),
),
],
[
CallStatement(f"Initialize_{f.name}", [Name("Ctx")]),
CallStatement(
"Process_Payload",
[
Slice(
Selected(Selected("Ctx", "Buffer"), "all"),
Name("Buffer_First"),
Name("Buffer_Last"),
),
],
),
],
)
for f, t in message.types.items()
if isinstance(t, Payload) and unbounded_setter_required(message, f)
]
+ [
SubprogramBody(
specification_bounded(f),
[
ObjectDeclaration(
["First"],
self.types.bit_index,
Call("Field_First", [Name("Ctx"), Name(f.affixed_name)]),
True,
),
ObjectDeclaration(
["Last"],
self.types.bit_index,
Add(Name("First"), Name("Length"), -Number(1)),
True,
),
ExpressionFunctionDeclaration(
FunctionSpecification("Buffer_First", self.types.index),
Call(self.types.byte_index, [Name("First")]),
),
ExpressionFunctionDeclaration(
FunctionSpecification("Buffer_Last", self.types.index),
Call(self.types.byte_index, [Name("Last")]),
),
],
[
CallStatement(
f"Initialize_Bounded_{f.name}", [Name("Ctx"), Name("Length")]
),
CallStatement(
"Process_Payload",
[
Slice(
Selected(Selected("Ctx", "Buffer"), "all"),
Name("Buffer_First"),
Name("Buffer_Last"),
),
],
),
],
)
for f, t in message.types.items()
if isinstance(t, Payload) and bounded_setter_required(message, f)
],
)
def test_less_equal_simplified(self) -> None:
self.assertEqual(
LessEqual(Value('X'), Add(Number(21), Number(21))).simplified(),
LessEqual(Value('X'), Number(42)))
def create_internal_functions(
self, message: Message, scalar_fields: Mapping[Field, Scalar]
) -> UnitPart:
return UnitPart(
[],
[
SubprogramBody(
ProcedureSpecification(
"Set_Field_Value",
[
InOutParameter(["Ctx"], "Context"),
Parameter(["Val"], "Field_Dependent_Value"),
OutParameter(["Fst", "Lst"], self.types.bit_index),
],
),
[
*self.common.field_bit_location_declarations(Selected("Val", "Fld")),
*self.common.field_byte_location_declarations(),
],
[
Assignment("Fst", Name("First")),
Assignment("Lst", Name("Last")),
CaseStatement(
Selected("Val", "Fld"),
[
(
Name(f.affixed_name),
[
CallStatement(
"Insert",
[
Selected("Val", f"{f.name}_Value"),
Slice(
Selected(Selected("Ctx", "Buffer"), "all"),
Name("Buffer_First"),
Name("Buffer_Last"),
),
Name("Offset"),
],
)
if f in scalar_fields
else NullStatement()
],
)
for f in message.all_fields
],
),
],
[
Precondition(
AndThen(
Not(Constrained("Ctx")),
Call("Has_Buffer", [Name("Ctx")]),
In(Selected("Val", "Fld"), Range("Field")),
Call("Valid_Next", [Name("Ctx"), Selected("Val", "Fld")]),
self.common.sufficient_space_for_field_condition(
Selected("Val", "Fld")
),
ForAllIn(
"F",
Range("Field"),
If(
[
(
Call(
"Structural_Valid",
[
Indexed(
Selected("Ctx", "Cursors"), Name("F"),
)
],
),
LessEqual(
Selected(
Indexed(
Selected("Ctx", "Cursors"), Name("F"),
),
"Last",
),
Call(
"Field_Last",
[Name("Ctx"), Selected("Val", "Fld")],
),
),
)
]
),
),
)
),
Postcondition(
And(
Call("Has_Buffer", [Name("Ctx")]),
Equal(
Name("Fst"),
Call("Field_First", [Name("Ctx"), Selected("Val", "Fld")]),
),
Equal(
Name("Lst"),
Call("Field_Last", [Name("Ctx"), Selected("Val", "Fld")]),
),
GreaterEqual(Name("Fst"), Selected("Ctx", "First")),
LessEqual(Name("Fst"), Add(Name("Lst"), Number(1))),
LessEqual(
Call(self.types.byte_index, [Name("Lst")]),
Selected("Ctx", "Buffer_Last"),
),
ForAllIn(
"F",
Range("Field"),
If(
[
(
Call(
"Structural_Valid",
[
Indexed(
Selected("Ctx", "Cursors"), Name("F"),
)
],
),
LessEqual(
Selected(
Indexed(
Selected("Ctx", "Cursors"), Name("F"),
),
"Last",
),
Name("Lst"),
),
)
]
),
),
*[
Equal(e, Old(e))
for e in [
Selected("Ctx", "Buffer_First"),
Selected("Ctx", "Buffer_Last"),
Selected("Ctx", "First"),
Selected("Ctx", "Cursors"),
]
],
)
),
],
)
],
)
def test_greater_equal_simplified(self) -> None:
self.assertEqual(
GreaterEqual(Value('X'), Add(Number(21), Number(21))).simplified(),
GreaterEqual(Value('X'), Number(42)))
def test_range_invalid_size_variable(self) -> None:
with self.assertRaises(ModelError):
RangeInteger("P.T", Number(0), Number(256), Add(Number(8), Variable("X")))
def test_not_equal_simplified(self) -> None:
self.assertEqual(
NotEqual(Value('X'), Add(Number(21), Number(21))).simplified(),
NotEqual(Value('X'), Number(42)))
def context_predicate(self, message: Message, composite_fields: Sequence[Field]) -> Expr:
def valid_predecessors_invariant() -> Expr:
return AndThen(
*[
If(
[
(
Call(
"Structural_Valid", [Indexed("Cursors", Name(f.affixed_name))]
),
Or(
*[
AndThen(
Call(
"Structural_Valid"
if l.source in composite_fields
else "Valid",
[Indexed("Cursors", Name(l.source.affixed_name))],
),
Equal(
Selected(
Indexed("Cursors", Name(f.affixed_name)),
"Predecessor",
),
Name(l.source.affixed_name),
),
l.condition,
).simplified(self.substitution(message, False))
for l in message.incoming(f)
]
),
)
]
)
for f in message.fields
if f not in message.direct_successors(INITIAL)
]
)
def invalid_successors_invariant() -> Expr:
return AndThen(
*[
If(
[
(
AndThen(
*[
Call("Invalid", [Indexed("Cursors", Name(p.affixed_name))])
for p in message.direct_predecessors(f)
]
),
Call("Invalid", [Indexed("Cursors", Name(f.affixed_name))]),
)
]
)
for f in message.fields
if f not in message.direct_successors(INITIAL)
]
)
return AndThen(
If(
[
(
NotEqual(Name(Name("Buffer")), NULL),
And(
Equal(First(Name("Buffer")), Name(Name("Buffer_First"))),
Equal(Last(Name("Buffer")), Name(Name("Buffer_Last"))),
),
)
]
),
GreaterEqual(
Call(self.types.byte_index, [Name(Name("First"))]), Name(Name("Buffer_First"))
),
LessEqual(Call(self.types.byte_index, [Name(Name("Last"))]), Name(Name("Buffer_Last"))),
LessEqual(Name(Name("First")), Name(Name("Last"))),
LessEqual(Name(Name("Last")), Div(Last(self.types.bit_index), Number(2))),
ForAllIn(
"F",
ValueRange(First("Field"), Last("Field")),
If(
[
(
Call("Structural_Valid", [Indexed(Name("Cursors"), Name("F"))]),
And(
GreaterEqual(
Selected(Indexed(Name("Cursors"), Name("F")), "First"),
Name(Name("First")),
),
LessEqual(
Selected(Indexed(Name("Cursors"), Name("F")), "Last"),
Name(Name("Last")),
),
LessEqual(
Selected(Indexed(Name("Cursors"), Name("F")), "First"),
Add(
Selected(Indexed(Name("Cursors"), Name("F")), "Last"),
Number(1),
),
),
Equal(
Selected(
Selected(Indexed(Name("Cursors"), Name("F")), "Value"),
"Fld",
),
Name("F"),
),
),
)
]
),
),
valid_predecessors_invariant(),
invalid_successors_invariant(),
self.message_structure_invariant(message, prefix=False),
)
def test_add_neg(self) -> None:
self.assertEqual(-Add(Value('X'), Number(1)),
Add(Value('X', True), Number(-1)))
def message_structure_invariant(
message: Message, prefix: str, link: Link = None, embedded: bool = False
) -> Expr:
def prefixed(name: str) -> Expr:
return Selected(Variable("Ctx"), name) if not embedded else Variable(name)
if not link:
return message_structure_invariant(message, prefix, message.outgoing(INITIAL)[0], embedded)
source = link.source
target = link.target
if target is FINAL:
return TRUE
field_type = message.types[target]
condition = link.condition.substituted(substitution(message, embedded)).simplified()
length = (
Size(prefix * full_base_type_name(field_type))
if isinstance(field_type, Scalar)
else link.length.substituted(
substitution(message, embedded, target_type=const.TYPES_BIT_LENGTH)
).simplified()
)
first = (
prefixed("First")
if source == INITIAL
else link.first.substituted(substitution(message, embedded))
.substituted(
mapping={
UNDEFINED: Add(
Selected(Indexed(prefixed("Cursors"), Variable(source.affixed_name)), "Last"),
Number(1),
)
}
)
.simplified()
)
return If(
[
(
AndThen(
Call(
"Structural_Valid",
[Indexed(prefixed("Cursors"), Variable(target.affixed_name))],
),
condition,
),
AndThen(
Equal(
Add(
Sub(
Selected(
Indexed(prefixed("Cursors"), Variable(target.affixed_name)),
"Last",
),
Selected(
Indexed(prefixed("Cursors"), Variable(target.affixed_name)),
"First",
),
),
Number(1),
),
length,
),
Equal(
Selected(
Indexed(prefixed("Cursors"), Variable(target.affixed_name)),
"Predecessor",
),
Variable(source.affixed_name),
),
Equal(
Selected(
Indexed(prefixed("Cursors"), Variable(target.affixed_name)), "First"
),
first,
),
*[
message_structure_invariant(message, prefix, l, embedded)
for l in message.outgoing(target)
],
),
)
]
).simplified()
def array_functions(array: Array, package: str) -> List[Subprogram]:
common_precondition = LogCall(f'Is_Contained (Buffer)')
return [
Function('Valid_First', 'Boolean', [('Buffer', 'Types.Bytes')], [], [
ReturnStatement(
LogCall('Valid_Next (Buffer, Offset_Type (Buffer\'First))'))
], [Precondition(common_precondition)]),
Procedure('Get_First', [
('Buffer', 'Types.Bytes'), ('Offset', 'out Offset_Type'),
('First', 'out Types.Index_Type'), ('Last', 'out Types.Index_Type')
], [], [
Assignment('Offset', Value('Offset_Type (Buffer\'First)')),
CallStatement('Get_Next', ['Buffer', 'Offset', 'First', 'Last'])
], [
Precondition(
And(common_precondition, LogCall('Valid_First (Buffer)'))),
Postcondition(
And(
And(GreaterEqual(Value('First'), First('Buffer')),
LessEqual(Value('Last'), Last('Buffer'))),
LogCall(f'{package}.{array.element_type}.Is_Contained '
'(Buffer (First .. Last))')))
]),
Function('Valid_Next', 'Boolean', [
('Buffer', 'Types.Bytes'), ('Offset', 'Offset_Type')
], [], [
PragmaStatement('Assume', [
(f'{package}.{array.element_type}.Is_Contained '
'(Buffer (Types.Index_Type (Offset) .. Buffer\'Last))')
]),
ReturnStatement(
LogCall(
f'{package}.{array.element_type}.Is_Valid '
'(Buffer (Types.Index_Type (Offset) .. Buffer\'Last))'))
], [Precondition(common_precondition)]),
Procedure(
'Get_Next', [('Buffer', 'Types.Bytes'),
('Offset', 'in out Offset_Type'),
('First', 'out Types.Index_Type'),
('Last', 'out Types.Index_Type')], [],
[
Assignment('First', Value('Types.Index_Type (Offset)')),
Assignment(
'Last',
Add(
Value('First'),
Cast(
'Types.Length_Type',
MathCall(f'{package}.{array.element_type}.'
'Message_Length (Buffer (First '
'.. Buffer\'Last))')), Number(-1))),
Assignment('Offset', Value('Offset_Type (Last + 1)')),
PragmaStatement(
'Assume', [(f'{package}.{array.element_type}.Is_Contained '
'(Buffer (First .. Last))')])
], [
Precondition(
And(common_precondition,
LogCall('Valid_Next (Buffer, Offset)'))),
Postcondition(
And(
And(GreaterEqual(Value('First'), First('Buffer')),
LessEqual(Value('Last'), Last('Buffer'))),
LogCall(f'{package}.{array.element_type}.Is_Contained '
'(Buffer (First .. Last))')))
])
]
def test_pdu_fields_length_after_payload(self) -> None:
int_type = ModularInteger('T', Number(256))
payload_type = Array('Payload_Type')
initial = InitialNode()
version = Node('Version', int_type)
payload = Node('Payload', payload_type)
length = Node('Length', int_type)
initial.edges = [Edge(version, TRUE)]
version.edges = [Edge(payload, length=Value('Length'))]
payload.edges = [Edge(length, first=Add(Last('Buffer'),
-Length('Length'),
Number(1)))]
length.edges = [Edge(FINAL)]
pdu = PDU('Foo', initial)
expected = OrderedDict([
('Version',
Field('Version',
int_type,
TRUE,
{
'0':
Variant(
[],
TRUE,
{
Length('Version'): Number(8),
First('Version'): Number(0),
Last('Version'): Number(7)
})
})),
('Payload',
Field('Payload',
payload_type,
TRUE,
{
'00':
Variant(
[('Version', '0')],
TRUE,
{
Length('Version'): Number(8),
First('Version'): Number(0),
Last('Version'): Number(7),
Length('Payload'): Value('Length'),
First('Payload'): Number(8),
Last('Payload'): Add(Value('Length'), Number(7))
})
})),
('Length',
Field('Length',
int_type,
TRUE,
{
'000':
Variant(
[('Version', '0'),
('Payload', '00')],
TRUE,
{
Length('Version'): Number(8),
First('Version'): Number(0),
Last('Version'): Number(7),
Length('Payload'): Value('Length'),
First('Payload'): Number(8),
Last('Payload'): Add(Value('Length'), Number(7)),
Length('Length'): Number(8),
First('Length'): Add(Last('Buffer'), Number(-7)),
Last('Length'): Last('Buffer')
})
})),
('FINAL',
Field('FINAL',
Null(),
TRUE,
{
'0000':
Variant(
[('Version', '0'),
('Payload', '00'),
('Length', '000')],
TRUE,
{
Length('Version'): Number(8),
First('Version'): Number(0),
Last('Version'): Number(7),
Length('Payload'): Value('Length'),
First('Payload'): Number(8),
Last('Payload'): Add(Value('Length'), Number(7)),
Length('Length'): Number(8),
First('Length'): Add(Last('Buffer'), Number(-7)),
Last('Length'): Last('Buffer')
})
}))
])
self.assertEqual(pdu.fields(), expected)
def __process_pdus(self, pdus: List[PDU]) -> None:
seen_types: List[str] = []
for pdu in pdus:
if pdu.package not in self.__units:
self.__units[pdu.package] = Unit(COMMON_CONTEXT,
Package(pdu.package, [], []))
context: List[ContextItem] = []
package = Package(pdu.full_name, [], [])
self.__units[pdu.full_name] = Unit(context, package)
package.subprograms.extend(contain_functions())
facts: Dict[Attribute, MathExpr] = {
First('Message'):
Mul(First('Buffer'), Number(8)),
Last('Message'):
Mul(Last('Buffer'), Number(8)),
Length('Message'):
Sub(Add(Mul(Last('Buffer'), Number(8)), Number(8)),
Mul(First('Buffer'), Number(8)))
}
fields = pdu.fields(facts, First('Buffer'))
self.__pdu_fields[pdu.full_name] = list(fields.keys())
for field in fields.values():
if field.name == 'FINAL':
continue
if f'{pdu.package}.{field.type.name}' not in seen_types:
seen_types.append(f'{pdu.package}.{field.type.name}')
self.__create_type(field.type, pdu.package)
if isinstance(field.type,
Array) and 'Payload' not in field.type.name:
with_clause = WithClause(
[f'{pdu.package}.{field.type.name}'])
if with_clause not in context:
context.append(with_clause)
for variant_id, variant in field.variants.items():
package.subprograms.append(
variant_validation_function(field, variant_id,
variant))
package.subprograms.extend(
variant_accessor_functions(field, variant_id, variant))
package.subprograms.append(field_validation_function(field))
package.subprograms.extend(
field_accessor_functions(field, pdu.package))
package.subprograms.append(
message_validation_function(
list(fields['FINAL'].variants.values())))
package.subprograms.append(
message_length_function(list(
fields['FINAL'].variants.values())))
self.__create_unreachable_functions(pdus)
def test_range_invalid_last_variable(self) -> None:
with self.assertRaises(ModelError):
RangeInteger('X', Number(1), Add(Number(1), Value('X')), Number(4))
def test_less_simplified(self) -> None:
self.assertEqual(
Less(Variable("X"), Add(Number(21), Number(21))).simplified(),
Less(Variable("X"), Number(42)),
)
