Skip to content

annotating.md

Latest commit

 

History

History
70 lines (55 loc) · 3.33 KB

annotating.md

File metadata and controls

70 lines (55 loc) · 3.33 KB

Annotating code

The analysis can be fine-tuned by annotating the source code. This page gives an overview of the supported means.

Attributes

Attributes (__attribute__) can be attached to various source code elements.

Function attributes

Attributes cannot be attached to a function definition directly, rather must be attached to a separate declaration. For example:

int f(int x) __attribute__((goblint_context("no-widen")));
int f(int x) {
  // ...
}

Context attributes

The attribute goblint_context can be used to fine-tune function contexts. The following string arguments are supported:

  1. base.interval/base.no-interval to override the ana.base.context.interval option.
  2. base.interval_set/base.no-interval_set to override the ana.base.context.interval_set option.
  3. base.int/base.no-int to override the ana.base.context.interval option.
  4. base.non-ptr/base.no-non-ptr to override the ana.base.context.non-ptr option.
  5. relation.context/relation.no-context to override the ana.relation.context option.
  6. widen/no-widen to override the ana.context.widen option.
  7. no-context to disable context-sensitivity for this function entirely (for all analyses).

Apron attributes

The Apron library can be set to only track variables with the attribute goblint_apron_track

Array attributes

Arrays can be annotated with the domain that should be used for it ("unroll", "partitioned", or "trivial"):

int x[4] __attribute__((goblint_array_domain("unroll")));
__attribute__((goblint_array_domain("trivial"))) int x[4];

struct array {
	int arr[5] __attribute__((goblint_array_domain("partitioned")));
};

It is also possible to annotate a type, so that all arrays of this type without an own attribute will use this one:

typedef int unrollInt __attribute__((goblint_array_domain("trivial")));
unrollInt x[4];

One can also annotate pointer parameters. Inside the function of the parameter, Goblint tries to use the annotated domain for the arrays pointed at by that pointer. This is not guaranteed to work, as following the pointers is done only in the first analyzed function context.

Functions

Goblint-specific functions can be called in the code, where they assist the analyzer but have no runtime effect. Include goblint.h when using these.

  • __goblint_check(exp) checks whether exp holds, but doesn't refine, i.e. doesn't assume it holds for the following code.
  • __goblint_assume(exp) assumes exp holds for the following code, i.e. refines.
  • __goblint_assert(exp) checks whether exp holds and also refines, i.e. assumes it holds for the following code.
  • __goblint_split_begin(exp) begins path-sensitivity w.r.t. the value of exp. Expsplit analysis must be activated.
  • __goblint_split_end(exp) ends path-sensitivity w.r.t. the value of exp. Expsplit analysis must be activated.
  • __goblint_assume_join(id) is like pthread_join(id, NULL), but considers the given thread IDs must-joined even if Goblint cannot, e.g. due to non-uniqueness. Notably, this annotation can be used after a threads joining loop to make the assumption that the loop correctly joined all those threads. Misuse of this annotation can cause unsoundness.
  • __goblint_globalize(ptr) forces all data potentially pointed to by ptr to be treated as global by simulating it escaping the thread.