/*- Compilations -*/

/**

* An invocation of the compiler. Note that more than one file may be

* compiled per invocation. For example, this command compiles three

* source files:

*

* gcc -c f1.c f2.c f3.c

*

* The `id` simply identifies the invocation, while `cwd` is the working

* directory from which the compiler was invoked.

*/

compilations(

/**

* An invocation of the compiler. Note that more than one file may

* be compiled per invocation. For example, this command compiles

* three source files:

*

* gcc -c f1.c f2.c f3.c

*/

unique int id : @compilation,

string cwd : string ref

);

/**

* The arguments that were passed to the extractor for a compiler

* invocation. If `id` is for the compiler invocation

*

* gcc -c f1.c f2.c f3.c

*

* then typically there will be rows for

*

* num | arg

* --- | ---

* 0 | *path to extractor*

* 1 | `--mimic`

* 2 | `/usr/bin/gcc`

* 3 | `-c`

* 4 | f1.c

* 5 | f2.c

* 6 | f3.c

*/

#keyset[id, num]

compilation_args(

int id : @compilation ref,

int num : int ref,

string arg : string ref

);

/**

* The expanded arguments that were passed to the extractor for a

* compiler invocation. This is similar to `compilation_args`, but

* for a `@someFile` argument, it includes the arguments from that

* file, rather than just taking the argument literally.

*/

#keyset[id, num]

compilation_expanded_args(

int id : @compilation ref,

int num : int ref,

string arg : string ref

);

/**

* Optionally, record the build mode for each compilation.

*/

compilation_build_mode(

unique int id : @compilation ref,

int mode : int ref

);

/*

case @compilation_build_mode.mode of

0 = @build_mode_none

| 1 = @build_mode_manual

| 2 = @build_mode_auto

;

*/

/**

* The source files that are compiled by a compiler invocation.

* If `id` is for the compiler invocation

*

* gcc -c f1.c f2.c f3.c

*

* then there will be rows for

*

* num | arg

* --- | ---

* 0 | f1.c

* 1 | f2.c

* 2 | f3.c

*

* Note that even if those files `#include` headers, those headers

* do not appear as rows.

*/

#keyset[id, num]

compilation_compiling_files(

int id : @compilation ref,

int num : int ref,

int file : @file ref

);

/**

* The time taken by the extractor for a compiler invocation.

*

* For each file `num`, there will be rows for

*

* kind | seconds

* ---- | ---

* 1 | CPU seconds used by the extractor frontend

* 2 | Elapsed seconds during the extractor frontend

* 3 | CPU seconds used by the extractor backend

* 4 | Elapsed seconds during the extractor backend

*/

#keyset[id, num, kind]

compilation_time(

int id : @compilation ref,

int num : int ref,

/* kind:

1 = frontend_cpu_seconds

2 = frontend_elapsed_seconds

3 = extractor_cpu_seconds

4 = extractor_elapsed_seconds

*/

int kind : int ref,

float seconds : float ref

);

/**

* An error or warning generated by the extractor.

* The diagnostic message `diagnostic` was generated during compiler

* invocation `compilation`, and is the `file_number_diagnostic_number`th

* message generated while extracting the `file_number`th file of that

* invocation.

*/

#keyset[compilation, file_number, file_number_diagnostic_number]

diagnostic_for(

int diagnostic : @diagnostic ref,

int compilation : @compilation ref,

int file_number : int ref,

int file_number_diagnostic_number : int ref

);

/**

* If extraction was successful, then `cpu_seconds` and

* `elapsed_seconds` are the CPU time and elapsed time (respectively)

* that extraction took for compiler invocation `id`.

*/

compilation_finished(

unique int id : @compilation ref,

float cpu_seconds : float ref,

float elapsed_seconds : float ref

);

/*- External data -*/

/**

* External data, loaded from CSV files during snapshot creation. See

* [Tutorial: Incorporating external data](https://help.semmle.com/wiki/display/SD/Tutorial%3A+Incorporating+external+data)

* for more information.

*/

externalData(

int id : @externalDataElement,

string path : string ref,

int column: int ref,

string value : string ref

);

/*- Source location prefix -*/

/**

* The source location of the snapshot.

*/

sourceLocationPrefix(string prefix : string ref);

/*- Files and folders -*/

/**

* The location of an element.

* The location spans column `startcolumn` of line `startline` to

* column `endcolumn` of line `endline` in file `file`.

* For more information, see

* [Locations](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries/).

*/

locations_default(

unique int id: @location_default,

int file: @file ref,

int beginLine: int ref,

int beginColumn: int ref,

int endLine: int ref,

int endColumn: int ref

);

files(

unique int id: @file,

string name: string ref

);

folders(

unique int id: @folder,

string name: string ref

);

@container = @file | @folder

containerparent(

int parent: @container ref,

unique int child: @container ref

);

/*- Lines of code -*/

numlines(

int element_id: @sourceline ref,

int num_lines: int ref,

int num_code: int ref,

int num_comment: int ref

);

/*- Diagnostic messages -*/

diagnostics(

unique int id: @diagnostic,

int severity: int ref,

string error_tag: string ref,

string error_message: string ref,

string full_error_message: string ref,

int location: @location_default ref

);

/*- C++ dbscheme -*/

extractor_version(

string codeql_version: string ref,

string frontend_version: string ref

)

pch_uses(

int pch: @pch ref,

int compilation: @compilation ref,

int id: @file ref

)

#keyset[pch, compilation]

pch_creations(

int pch: @pch,

int compilation: @compilation ref,

int from: @file ref

)

/** An element for which line-count information is available. */

@sourceline = @file | @function | @variable | @enumconstant | @xmllocatable;

fileannotations(

int id: @file ref,

int kind: int ref,

string name: string ref,

string value: string ref

);

inmacroexpansion(

int id: @element ref,

int inv: @macroinvocation ref

);

affectedbymacroexpansion(

int id: @element ref,

int inv: @macroinvocation ref

);

case @macroinvocation.kind of

1 = @macro_expansion

| 2 = @other_macro_reference

;

macroinvocations(

unique int id: @macroinvocation,

int macro_id: @ppd_define ref,

int location: @location_default ref,

int kind: int ref

);

macroparent(

unique int id: @macroinvocation ref,

int parent_id: @macroinvocation ref

);

// a macroinvocation may be part of another location

// the way to find a constant expression that uses a macro

// is thus to find a constant expression that has a location

// to which a macro invocation is bound

macrolocationbind(

int id: @macroinvocation ref,

int location: @location_default ref

);

#keyset[invocation, argument_index]

macro_argument_unexpanded(

int invocation: @macroinvocation ref,

int argument_index: int ref,

string text: string ref

);

#keyset[invocation, argument_index]

macro_argument_expanded(

int invocation: @macroinvocation ref,

int argument_index: int ref,

string text: string ref

);

case @function.kind of

0 = @unknown_function

| 1 = @normal_function

| 2 = @constructor

| 3 = @destructor

| 4 = @conversion_function

| 5 = @operator

// ... 6 = @builtin_function deprecated // GCC built-in functions, e.g. __builtin___memcpy_chk

| 7 = @user_defined_literal

| 8 = @deduction_guide

;

functions(

unique int id: @function,

string name: string ref,

int kind: int ref

);

builtin_functions(

int id: @function ref

)

function_entry_point(

int id: @function ref,

unique int entry_point: @stmt ref

);

function_return_type(

int id: @function ref,

int return_type: @type ref

);

/**

* If `function` is a coroutine, then this gives the `std::experimental::resumable_traits`

* instance associated with it, and the variables representing the `handle` and `promise`

* for it.

*/

coroutine(

unique int function: @function ref,

int traits: @type ref

);

/*

case @coroutine_placeholder_variable.kind of

1 = @handle

| 2 = @promise

| 3 = @init_await_resume

;

*/

coroutine_placeholder_variable(

unique int placeholder_variable: @variable ref,

int kind: int ref,

int function: @function ref

)

/** The `new` function used for allocating the coroutine state, if any. */

coroutine_new(

unique int function: @function ref,

int new: @function ref

);

/** The `delete` function used for deallocating the coroutine state, if any. */

coroutine_delete(

unique int function: @function ref,

int delete: @function ref

);

purefunctions(unique int id: @function ref);

function_deleted(unique int id: @function ref);

function_defaulted(unique int id: @function ref);

function_prototyped(unique int id: @function ref)

deduction_guide_for_class(

int id: @function ref,

int class_template: @usertype ref

)

member_function_this_type(

unique int id: @function ref,

int this_type: @type ref

);

#keyset[id, type_id]

fun_decls(

int id: @fun_decl,

int function: @function ref,

int type_id: @type ref,

string name: string ref,

int location: @location_default ref

);

fun_def(unique int id: @fun_decl ref);

fun_specialized(unique int id: @fun_decl ref);

fun_implicit(unique int id: @fun_decl ref);

fun_decl_specifiers(

int id: @fun_decl ref,

string name: string ref

)

#keyset[fun_decl, index]

fun_decl_throws(

int fun_decl: @fun_decl ref,

int index: int ref,

int type_id: @type ref

);

/* an empty throw specification is different from none */

fun_decl_empty_throws(unique int fun_decl: @fun_decl ref);

fun_decl_noexcept(

int fun_decl: @fun_decl ref,

int constant: @expr ref

);

fun_decl_empty_noexcept(int fun_decl: @fun_decl ref);

fun_decl_typedef_type(

unique int fun_decl: @fun_decl ref,

int typedeftype_id: @usertype ref

);

/*

case @fun_requires.kind of

1 = @template_attached

| 2 = @function_attached

;

*/

fun_requires(

int id: @fun_decl ref,

int kind: int ref,

int constraint: @expr ref

);

param_decl_bind(

unique int id: @var_decl ref,

int index: int ref,

int fun_decl: @fun_decl ref

);

#keyset[id, type_id]

var_decls(

int id: @var_decl,

int variable: @variable ref,

int type_id: @type ref,

string name: string ref,

int location: @location_default ref

);

var_def(unique int id: @var_decl ref);

var_specialized(int id: @var_decl ref);

var_decl_specifiers(

int id: @var_decl ref,

string name: string ref

)

is_structured_binding(unique int id: @variable ref);

var_requires(

int id: @var_decl ref,

int constraint: @expr ref

);

type_decls(

unique int id: @type_decl,

int type_id: @type ref,

int location: @location_default ref

);

type_def(unique int id: @type_decl ref);

type_decl_top(

unique int type_decl: @type_decl ref

);

type_requires(

int id: @type_decl ref,

int constraint: @expr ref

);

namespace_decls(

unique int id: @namespace_decl,

int namespace_id: @namespace ref,

int location: @location_default ref,

int bodylocation: @location_default ref

);

case @using.kind of

1 = @using_declaration

| 2 = @using_directive

| 3 = @using_enum_declaration

;

usings(

unique int id: @using,

int element_id: @element ref,

int location: @location_default ref,

int kind: int ref

);

/** The element which contains the `using` declaration. */

using_container(

int parent: @element ref,

int child: @using ref

);

static_asserts(

unique int id: @static_assert,

int condition : @expr ref,

string message : string ref,

int location: @location_default ref,

int enclosing : @element ref

);

// each function has an ordered list of parameters

#keyset[id, type_id]

#keyset[function, index, type_id]

params(

int id: @parameter,

int function: @parameterized_element ref,

int index: int ref,

int type_id: @type ref

);

overrides(

int new: @function ref,

int old: @function ref

);

#keyset[id, type_id]

membervariables(

int id: @membervariable,

int type_id: @type ref,

string name: string ref

);

#keyset[id, type_id]

globalvariables(

int id: @globalvariable,

int type_id: @type ref,

string name: string ref

);

#keyset[id, type_id]

localvariables(

int id: @localvariable,

int type_id: @type ref,

string name: string ref

);

autoderivation(

unique int var: @variable ref,

int derivation_type: @type ref

);

orphaned_variables(

int var: @localvariable ref,

int function: @function ref

)

enumconstants(

unique int id: @enumconstant,

int parent: @usertype ref,

int index: int ref,

int type_id: @type ref,

string name: string ref,

int location: @location_default ref

);

@variable = @localscopevariable | @globalvariable | @membervariable;

@localscopevariable = @localvariable | @parameter;

/**

* Built-in types are the fundamental types, e.g., integral, floating, and void.

*/

case @builtintype.kind of

1 = @errortype

| 2 = @unknowntype

| 3 = @void

| 4 = @boolean

| 5 = @char

| 6 = @unsigned_char

| 7 = @signed_char

| 8 = @short

| 9 = @unsigned_short

| 10 = @signed_short

| 11 = @int

| 12 = @unsigned_int

| 13 = @signed_int

| 14 = @long

| 15 = @unsigned_long

| 16 = @signed_long

| 17 = @long_long

| 18 = @unsigned_long_long

| 19 = @signed_long_long

// ... 20 Microsoft-specific __int8

// ... 21 Microsoft-specific __int16

// ... 22 Microsoft-specific __int32

// ... 23 Microsoft-specific __int64

| 24 = @float

| 25 = @double

| 26 = @long_double

| 27 = @complex_float // C99-specific _Complex float

| 28 = @complex_double // C99-specific _Complex double

| 29 = @complex_long_double // C99-specific _Complex long double

| 30 = @imaginary_float // C99-specific _Imaginary float

| 31 = @imaginary_double // C99-specific _Imaginary double

| 32 = @imaginary_long_double // C99-specific _Imaginary long double

| 33 = @wchar_t // Microsoft-specific

| 34 = @decltype_nullptr // C++11

| 35 = @int128 // __int128

| 36 = @unsigned_int128 // unsigned __int128

| 37 = @signed_int128 // signed __int128

| 38 = @float128 // __float128

| 39 = @complex_float128 // _Complex __float128

| 40 = @decimal32 // _Decimal32

| 41 = @decimal64 // _Decimal64

| 42 = @decimal128 // _Decimal128

| 43 = @char16_t

| 44 = @char32_t

| 45 = @std_float32 // _Float32

| 46 = @float32x // _Float32x

| 47 = @std_float64 // _Float64

| 48 = @float64x // _Float64x

| 49 = @std_float128 // _Float128

// ... 50 _Float128x

| 51 = @char8_t

| 52 = @float16 // _Float16

| 53 = @complex_float16 // _Complex _Float16

| 54 = @fp16 // __fp16

| 55 = @std_bfloat16 // __bf16

| 56 = @std_float16 // std::float16_t

| 57 = @complex_std_float32 // _Complex _Float32

| 58 = @complex_float32x // _Complex _Float32x

| 59 = @complex_std_float64 // _Complex _Float64

| 60 = @complex_float64x // _Complex _Float64x

| 61 = @complex_std_float128 // _Complex _Float128

| 62 = @mfp8 // __mfp8

| 63 = @scalable_vector_count // __SVCount_t

| 64 = @complex_fp16 // _Complex __fp16

| 65 = @complex_std_bfloat16 // _Complex __bf16

| 66 = @complex_std_float16 // _Complex std::float16_t

;

builtintypes(

unique int id: @builtintype,

string name: string ref,

int kind: int ref,

int size: int ref,

int sign: int ref,

int alignment: int ref

);

/**

* Derived types are types that are directly derived from existing types and

* point to, refer to, transform type data to return a new type.

*/

case @derivedtype.kind of

1 = @pointer

| 2 = @reference

| 3 = @type_with_specifiers

| 4 = @array

| 5 = @gnu_vector

| 6 = @routineptr

| 7 = @routinereference

| 8 = @rvalue_reference // C++11

// ... 9 type_conforming_to_protocols deprecated

| 10 = @block

| 11 = @scalable_vector // Arm SVE

;

derivedtypes(

unique int id: @derivedtype,

string name: string ref,

int kind: int ref,

int type_id: @type ref

);

pointerishsize(unique int id: @derivedtype ref,

int size: int ref,

int alignment: int ref);

arraysizes(

unique int id: @derivedtype ref,

int num_elements: int ref,

int bytesize: int ref,

int alignment: int ref

);

tupleelements(

unique int id: @derivedtype ref,

int num_elements: int ref

);

typedefbase(

unique int id: @usertype ref,

int type_id: @type ref

);

/**

* An instance of the C++11 `decltype` operator or C23 `typeof`/`typeof_unqual`

* operator taking an expression as its argument. For example:

* ```

* int a;

* decltype(1+a) b;

* typeof(1+a) c;

* ```

* Here `expr` is `1+a`.

*

* Sometimes an additional pair of parentheses around the expression

* changes the semantics of the decltype, e.g.

* ```

* struct A { double x; };

* const A* a = new A();

* decltype( a->x ); // type is double

* decltype((a->x)); // type is const double&

* ```

* (Please consult the C++11 standard for more details).

* `parentheses_would_change_meaning` is `true` iff that is the case.

*/

/*

case @decltype.kind of

| 0 = @decltype

| 1 = @typeof // The frontend does not differentiate between typeof and typeof_unqual

;

*/

#keyset[id, expr]

decltypes(

int id: @decltype,

int expr: @expr ref,

int kind: int ref,

int base_type: @type ref,

boolean parentheses_would_change_meaning: boolean ref

);

case @type_operator.kind of

0 = @typeof // The frontend does not differentiate between typeof and typeof_unqual

| 1 = @underlying_type

| 2 = @bases

| 3 = @direct_bases

| 4 = @add_lvalue_reference

| 5 = @add_pointer

| 6 = @add_rvalue_reference

| 7 = @decay

| 8 = @make_signed

| 9 = @make_unsigned

| 10 = @remove_all_extents

| 11 = @remove_const

| 12 = @remove_cv

| 13 = @remove_cvref

| 14 = @remove_extent

| 15 = @remove_pointer

| 16 = @remove_reference_t

| 17 = @remove_restrict

| 18 = @remove_volatile

| 19 = @remove_reference

;

type_operators(

unique int id: @type_operator,

int arg_type: @type ref,

int kind: int ref,

int base_type: @type ref

)

case @usertype.kind of

0 = @unknown_usertype

| 1 = @struct

| 2 = @class

| 3 = @union

| 4 = @enum

// ... 5 = @typedef deprecated // classic C: typedef typedef type name

// ... 6 = @template deprecated

| 7 = @template_parameter

| 8 = @template_template_parameter

| 9 = @proxy_class // a proxy class associated with a template parameter

// ... 10 objc_class deprecated

// ... 11 objc_protocol deprecated

// ... 12 objc_category deprecated

| 13 = @scoped_enum

// ... 14 = @using_alias deprecated // a using name = type style typedef

| 15 = @template_struct

| 16 = @template_class

| 17 = @template_union

| 18 = @alias

;

usertypes(

unique int id: @usertype,

string name: string ref,

int kind: int ref

);

usertypesize(

unique int id: @usertype ref,

int size: int ref,

int alignment: int ref

);

usertype_final(unique int id: @usertype ref);

usertype_uuid(

unique int id: @usertype ref,

string uuid: string ref

);

/*

case @usertype.alias_kind of

| 0 = @typedef

| 1 = @alias

*/

usertype_alias_kind(

int id: @usertype ref,

int alias_kind: int ref

)

nontype_template_parameters(

int id: @expr ref

);

type_template_type_constraint(

int id: @usertype ref,

int constraint: @expr ref

);

mangled_name(

unique int id: @declaration ref,

int mangled_name : @mangledname,

boolean is_complete: boolean ref

);

is_pod_class(unique int id: @usertype ref);

is_standard_layout_class(unique int id: @usertype ref);

is_complete(unique int id: @usertype ref);

is_class_template(unique int id: @usertype ref);

class_instantiation(

int to: @usertype ref,

int from: @usertype ref

);

class_template_argument(

int type_id: @usertype ref,

int index: int ref,

int arg_type: @type ref

);

class_template_argument_value(

int type_id: @usertype ref,

int index: int ref,

int arg_value: @expr ref

);

@user_or_decltype = @usertype | @decltype;

is_proxy_class_for(

unique int id: @usertype ref,

int templ_param_id: @user_or_decltype ref

);

type_mentions(

unique int id: @type_mention,

int type_id: @type ref,

int location: @location_default ref,

// a_symbol_reference_kind from the frontend.

int kind: int ref

);

is_function_template(unique int id: @function ref);

function_instantiation(

unique int to: @function ref,

int from: @function ref

);

function_template_argument(

int function_id: @function ref,

int index: int ref,

int arg_type: @type ref

);

function_template_argument_value(

int function_id: @function ref,

int index: int ref,

int arg_value: @expr ref

);

is_variable_template(unique int id: @variable ref);

variable_instantiation(

unique int to: @variable ref,

int from: @variable ref

);

variable_template_argument(

int variable_id: @variable ref,

int index: int ref,

int arg_type: @type ref

);

variable_template_argument_value(

int variable_id: @variable ref,

int index: int ref,

int arg_value: @expr ref

);

template_template_instantiation(

int to: @usertype ref,

int from: @usertype ref

);

template_template_argument(

int type_id: @usertype ref,

int index: int ref,

int arg_type: @type ref

);

template_template_argument_value(

int type_id: @usertype ref,

int index: int ref,

int arg_value: @expr ref

);

@concept = @concept_template | @concept_id;

concept_templates(

unique int concept_id: @concept_template,

string name: string ref,

int location: @location_default ref

);

concept_instantiation(

unique int to: @concept_id ref,

int from: @concept_template ref

);

is_type_constraint(int concept_id: @concept_id ref);

concept_template_argument(

int concept_id: @concept ref,

int index: int ref,

int arg_type: @type ref

);

concept_template_argument_value(

int concept_id: @concept ref,

int index: int ref,

int arg_value: @expr ref

);

routinetypes(

unique int id: @routinetype,

int return_type: @type ref

);

routinetypeargs(

int routine: @routinetype ref,

int index: int ref,

int type_id: @type ref

);

ptrtomembers(

unique int id: @ptrtomember,

int type_id: @type ref,

int class_id: @type ref

);

/*

specifiers for types, functions, and variables

"public",

"protected",

"private",

"const",

"volatile",

"static",

"pure",

"virtual",

"sealed", // Microsoft

"__interface", // Microsoft

"inline",

"explicit",

"near", // near far extension

"far", // near far extension

"__ptr32", // Microsoft

"__ptr64", // Microsoft

"__sptr", // Microsoft

"__uptr", // Microsoft

"dllimport", // Microsoft

"dllexport", // Microsoft

"thread", // Microsoft

"naked", // Microsoft

"microsoft_inline", // Microsoft

"forceinline", // Microsoft

"selectany", // Microsoft

"nothrow", // Microsoft

"novtable", // Microsoft

"noreturn", // Microsoft

"noinline", // Microsoft

"noalias", // Microsoft

"restrict", // Microsoft

*/