module Logic_utils: sig
.. end
exception raised when a parsed logic expression is
syntactically not well-formed.
exception Not_well_formed of Cil_types.location * string
exception raised when a parsed logic expression is
syntactically not well-formed.
basic utilities for logic terms and predicates. See also Logic_const
to build terms and predicates.
val add_logic_function : Cil_types.logic_info -> unit
val mk_dummy_term : Cil_types.term_node -> Cil_types.typ -> Cil_types.term
Deprecated.since Carbon-20101201 Use
Logic_const.term
instead.
creates a new term
Types
val instantiate : (string * Cil_types.logic_type) list ->
Cil_types.logic_type -> Cil_types.logic_type
instantiate type variables in a logic type.
val unroll_type : ?unroll_typedef:bool -> Cil_types.logic_type -> Cil_types.logic_type
expands logic type definitions. If the unroll_typedef
flag is set to
true
(this is the default), C typedef will be expanded as well.
val type_sig_logic : Cil_types.typ -> Cil_types.typsig
computes a type signature for a C type and removes attributes that
are not meaningful for the logic. See
Cil.typeSig
for more information.
val isLogicType : (Cil_types.typ -> bool) -> Cil_types.logic_type -> bool
isLogicType test typ
is false
for pure logic types and the result
of test for C types.
val isLogicArrayType : Cil_types.logic_type -> bool
Predefined tests over types
val isLogicCharType : Cil_types.logic_type -> bool
val isLogicVoidType : Cil_types.logic_type -> bool
val isLogicPointerType : Cil_types.logic_type -> bool
val isLogicVoidPointerType : Cil_types.logic_type -> bool
Type conversions
val logicCType : Cil_types.logic_type -> Cil_types.typ
Raises Failure
if the type is purely logical
Returns the equivalent C type.
val array_to_ptr : Cil_types.logic_type -> Cil_types.logic_type
transforms an array into pointer.
val typ_to_logic_type : Cil_types.typ -> Cil_types.logic_type
C type to logic type, with implicit conversion for arithmetic types.
Predicates
val named_of_identified_predicate : Cil_types.identified_predicate -> Cil_types.predicate Cil_types.named
val translate_old_label : Cil_types.stmt ->
Cil_types.predicate Cil_types.named -> Cil_types.predicate Cil_types.named
transforms \old and \at(,Old) into \at(,L) for L a label pointing
to the given statement, creating one if needed.
Terms
val insert_logic_cast : Cil_types.typ -> Cil_types.term_node -> Cil_types.term_node
creates a cast.
val is_C_array : Cil_types.term -> bool
true
if the term denotes a C array.
val mk_logic_StartOf : Cil_types.term -> Cil_types.term
creates a TStartOf from an TLval.
val isLogicPointer : Cil_types.term -> bool
true
if the term is a pointer.
val mk_logic_pointer_or_StartOf : Cil_types.term -> Cil_types.term
creates either a TStartOf or the corresponding TLval.
val array_with_range : Cil_types.exp -> Cil_types.term -> Cil_types.term
array_with_range arr size
returns the logic term array'+{0..(size-1)}
,
array'
being array
cast to a pointer to char
Conversion from exp to term
val expr_to_term : cast:bool -> Cil_types.exp -> Cil_types.term
translates a C expression into an "equivalent" logical term.
If cast is
true
: expressions with integral type are cast to corresponding
C type. If cast is
false
: no cast performed to C type, except for
constants since there are no logic integer constants for the time being =>
they keep their C type.
Consult the Plugin Development Guide for additional details.
val lval_to_term_lval : cast:bool -> Cil_types.lval -> Cil_types.term_lval
val host_to_term_host : cast:bool -> Cil_types.lhost -> Cil_types.term_lhost
val offset_to_term_offset : cast:bool -> Cil_types.offset -> Cil_types.term_offset
val remove_term_offset : Cil_types.term_offset -> Cil_types.term_offset * Cil_types.term_offset
remove_term_offset o
returns o
without its last offset and
this last offset.
val lval_contains_result : Cil_types.term_lhost -> bool
true if \result is included in the lval.
val loffset_contains_result : Cil_types.term_offset -> bool
true if \result is included in the offset.
val contains_result : Cil_types.term -> bool
true if \result is included in the term
val get_pred_body : Cil_types.logic_info -> Cil_types.predicate Cil_types.named
returns the body of the given predicate.
Raises Not_found
if the logic_info is not the definition of a predicate.
val is_result : Cil_types.term -> bool
Deprecated.since Carbon-20101201 use Logic_const.is_result instead
true if the term is \result or an offset of \result.
val lhost_c_type : Cil_types.term_lhost -> Cil_types.typ
Structural equality between annotations
val is_same_logic_label : Cil_types.logic_label -> Cil_types.logic_label -> bool
val is_same_type : Cil_types.logic_type -> Cil_types.logic_type -> bool
val is_same_var : Cil_types.logic_var -> Cil_types.logic_var -> bool
val is_same_logic_signature : Cil_types.logic_info -> Cil_types.logic_info -> bool
val is_same_logic_profile : Cil_types.logic_info -> Cil_types.logic_info -> bool
val is_same_builtin_profile : Cil_types.builtin_logic_info -> Cil_types.builtin_logic_info -> bool
val is_same_logic_ctor_info : Cil_types.logic_ctor_info -> Cil_types.logic_ctor_info -> bool
val is_same_constant : Cil_types.constant -> Cil_types.constant -> bool
val is_same_term : Cil_types.term -> Cil_types.term -> bool
val is_same_logic_info : Cil_types.logic_info -> Cil_types.logic_info -> bool
val is_same_logic_body : Cil_types.logic_body -> Cil_types.logic_body -> bool
val is_same_indcase : string * Cil_types.logic_label list * string list *
Cil_types.predicate Cil_types.named ->
string * Cil_types.logic_label list * string list *
Cil_types.predicate Cil_types.named -> bool
val is_same_tlval : Cil_types.term_lval -> Cil_types.term_lval -> bool
val is_same_lhost : Cil_types.term_lhost -> Cil_types.term_lhost -> bool
val is_same_offset : Cil_types.term_offset -> Cil_types.term_offset -> bool
val is_same_predicate : Cil_types.predicate -> Cil_types.predicate -> bool
val is_same_named_predicate : Cil_types.predicate Cil_types.named ->
Cil_types.predicate Cil_types.named -> bool
val is_same_identified_predicate : Cil_types.identified_predicate -> Cil_types.identified_predicate -> bool
val is_same_identified_term : Cil_types.identified_term -> Cil_types.identified_term -> bool
val is_same_deps : Cil_types.identified_term Cil_types.deps ->
Cil_types.identified_term Cil_types.deps -> bool
val is_same_assigns : Cil_types.identified_term Cil_types.assigns ->
Cil_types.identified_term Cil_types.assigns -> bool
val is_same_variant : Cil_types.term Cil_types.variant -> Cil_types.term Cil_types.variant -> bool
val is_same_post_cond : Cil_types.termination_kind * Cil_types.identified_predicate ->
Cil_types.termination_kind * Cil_types.identified_predicate -> bool
val is_same_behavior : Cil_types.funbehavior -> Cil_types.funbehavior -> bool
val is_same_spec : Cil_types.funspec -> Cil_types.funspec -> bool
val is_same_logic_type_def : Cil_types.logic_type_def -> Cil_types.logic_type_def -> bool
val is_same_logic_type_info : Cil_types.logic_type_info -> Cil_types.logic_type_info -> bool
val is_same_loop_pragma : Cil_types.term Cil_types.loop_pragma ->
Cil_types.term Cil_types.loop_pragma -> bool
val is_same_slice_pragma : Cil_types.term Cil_types.slice_pragma ->
Cil_types.term Cil_types.slice_pragma -> bool
val is_same_impact_pragma : Cil_types.term Cil_types.impact_pragma ->
Cil_types.term Cil_types.impact_pragma -> bool
val is_same_pragma : Cil_types.term Cil_types.pragma -> Cil_types.term Cil_types.pragma -> bool
val is_same_code_annotation : Cil_types.code_annotation -> Cil_types.code_annotation -> bool
val is_same_global_annotation : Cil_types.global_annotation -> Cil_types.global_annotation -> bool
val is_same_axiomatic : Cil_types.global_annotation list -> Cil_types.global_annotation list -> bool
val is_same_lexpr : Logic_ptree.lexpr -> Logic_ptree.lexpr -> bool
Merging contracts
val get_behavior_names : ('a, 'b, 'c) Cil_types.spec -> string list
val merge_assigns : Cil_types.identified_term Cil_types.assigns ->
Cil_types.identified_term Cil_types.assigns ->
Cil_types.identified_term Cil_types.assigns
val merge_behaviors : silent:bool ->
Cil_types.funbehavior list ->
Cil_types.funbehavior list -> Cil_types.funbehavior list
val merge_funspec : ?silent_about_merging_behav:bool ->
Cil_types.funspec -> Cil_types.funspec -> unit
Discriminating code_annotations
Functions below allows to test a special kind of code_annotation.
Use them in conjunction with Annotations.get_filter
to retrieve
a particular kind of annotations associated to a statement.
val is_assert : Cil_types.code_annotation -> bool
val is_contract : Cil_types.code_annotation -> bool
val is_stmt_invariant : Cil_types.code_annotation -> bool
val is_loop_invariant : Cil_types.code_annotation -> bool
val is_invariant : Cil_types.code_annotation -> bool
val is_variant : Cil_types.code_annotation -> bool
val is_assigns : Cil_types.code_annotation -> bool
val is_pragma : Cil_types.code_annotation -> bool
val is_loop_pragma : Cil_types.code_annotation -> bool
val is_slice_pragma : Cil_types.code_annotation -> bool
val is_impact_pragma : Cil_types.code_annotation -> bool
val is_loop_annot : Cil_types.code_annotation -> bool
: Cil_types.code_annotation list -> Cil_types.term Cil_types.loop_pragma list
: Cil_types.code_annotation list -> Cil_types.funspec list
Parsing hackery
Values that control the various modes of the parser and lexer for logic.
Use with care.
val kw_c_mode : bool Pervasives.ref
val enter_kw_c_mode : unit -> unit
val exit_kw_c_mode : unit -> unit
val is_kw_c_mode : unit -> bool
val rt_type_mode : bool Pervasives.ref
val enter_rt_type_mode : unit -> unit
val exit_rt_type_mode : unit -> unit
val is_rt_type_mode : unit -> bool