Frama-C:
Plug-ins:
Libraries:

Frama-C API - Callstack

A call is identified by the function called and the call statement

module Call : Frama_c_kernel.Datatype.S with type t = call
type callstack = {
  1. thread : int;
  2. entry_point : Frama_c_kernel.Cil_types.kernel_function;
    (*

    The first function function of the callstack.

    *)
  3. stack : call list;
    (*

    A call stack is a list of calls. The head is the latest call.

    *)
}

Eva callstacks.

include Frama_c_kernel.Datatype.S_with_collections with type t = callstack
include Frama_c_kernel.Datatype.S with type t = callstack
include Frama_c_kernel.Datatype.S_no_copy with type t = callstack
include Frama_c_kernel.Datatype.Ty with type t = callstack
type t = callstack
val datatype_name : string

Unique name of the datatype.

val datatype_descr : t Frama_c_kernel.Descr.t

Datatype descriptor.

Packed version of the descriptor.

val reprs : t list

List of representants of the descriptor.

val equal : t -> t -> bool

Equality: same spec than Stdlib.(=).

val compare : t -> t -> int

Comparison: same spec than Stdlib.compare.

val hash : t -> int

Hash function: same spec than Hashtbl.hash.

val pretty : Stdlib.Format.formatter -> t -> unit

Pretty print each value in an user-friendly way.

val mem_project : (Frama_c_kernel.Project_skeleton.t -> bool) -> t -> bool

mem_project f x must return true iff there is a value p of type Project.t in x such that f p returns true.

val copy : t -> t

Deep copy: no possible sharing between x and copy x.

module Set : Frama_c_kernel.Datatype.Set with type elt = t
module Map : Frama_c_kernel.Datatype.Map with type key = t
val pretty_short : Stdlib.Format.formatter -> t -> unit

Prints a callstack without displaying call sites.

val pretty_hash : Stdlib.Format.formatter -> t -> unit

Prints a hash of the callstack.

val compare_lex : t -> t -> int

compare_lex compares callstack lexicographically, slightly slower than compare but in a more natural order, giving more importance to the function at bottom of the callstack - the first functions called.

val is_empty : t -> bool

is_empty cs returns true if the callstack is empty, i.e., top_callsite would return Kglobal.

val init : thread:int -> entry_point:Frama_c_kernel.Cil_types.kernel_function -> t

Adds a new call to the top of the callstack.

val pop : t -> t option

Removes the topmost call from the callstack.

Removes the topmost call from the callstack and returns it.

val top_callsite : t -> Frama_c_kernel.Cil_types.kinstr

Returns the function that called the topmost function of the callstack and the top callsite.

Conversion

Gives the list of kf in the callstack from the entry point to the top of the callstack (i.e. reverse order of the call stack).

val to_stmt_list : t -> Frama_c_kernel.Cil_types.stmt list

Gives the list of call statements from the bottom to the top of the callstack (i.e. reverse order of the call stack).

Gives the list of call from the bottom to the top of the callstack (i.e. reverse order of the call stack).