def test_get_typedefs(clade_api: Clade):
typedefs_are_ok(clade_api.get_typedefs())
class Source:
"""
Representation of a collection with the data collected by a source code analysis. The collection contains
information about functions, variable initializations, a functions call graph, macros.
"""
def __init__(self, logger, conf, abstract_task):
"""
Setup initial attributes and get logger object.
:param logger: logging object.
:param conf: Source code analysis configuration.
:param abstract_task: Abstract verification task dictionary (given by VTG).
:param conf: Configuration properties dictionary.
"""
self.logger = logger
self._conf = conf
self._source_functions = dict()
self._source_vars = dict()
self._macros = dict()
self.__function_calls_cache = dict()
# Initialize Clade cient to make requests
self._clade = Clade(self._conf['build base'])
# Ask for dependencies for each CC
cfiles, files_map = self._collect_file_dependencies(abstract_task)
# Read file with source analysis
self._import_code_analysis(cfiles, files_map)
@property
def source_functions(self):
"""
Return a list of function names.
:return: function names list.
"""
return list(self._source_functions.keys())
def get_source_function(self, name, path=None, declaration=None):
"""
Provides the function by a given name from the collection.
:param name: Function name.
:param path: File where the function should be declared or defined.
:param declaration: Declaration object representing the function of interest.
:return: Function object or None.
"""
name = self.refined_name(name)
if name and name in self._source_functions:
if path and path in self._source_functions[name]:
return self._source_functions[name][path]
else:
functions = self.get_source_functions(name,
declaration=declaration)
if len(functions) == 1:
return functions[0]
elif len(functions) > 1:
raise ValueError(
"There are several definitions of function {!r} in provided code you must specify "
"scope".format(name))
return None
def get_source_functions(self, name, declaration=None):
"""
Provides all functions found by a given name from the collection.
:param name: Function name.
:param declaration: Declaration object representing the function of interest.
:return: List with Function objects.
"""
name = self.refined_name(name)
result = []
if name and name in self._source_functions:
for func in self._source_functions[name].values():
if func not in result and (
not declaration or
(declaration and declaration.compare(func.declaration))):
result.append(func)
return result
def set_source_function(self, new_obj, path):
"""
Replace an Function object in the collection.
:param new_obj: Function object.
:param path: File where the function should be declared or defined.
:return: None.
"""
if new_obj.name not in self._source_functions:
self._source_functions[new_obj.name] = dict()
self._source_functions[new_obj.name][path] = new_obj
def remove_source_function(self, name):
"""
Delete the function from the collection.
:param name: Function name.
:return: None.
"""
del self._source_functions[name]
@property
def source_variables(self):
"""
Return list of global variables.
:return: Variable names list.
"""
return list(self._source_vars.keys())
def get_source_variable(self, name, path=None):
"""
Provides a gloabal variable by a given name and scope file from the collection.
:param name: Variable name.
:param path: File with the variable declaration or initialization.
:return: Variable object or None.
"""
name = self.refined_name(name)
if name and name in self._source_vars:
if path and path in self._source_vars[name]:
return self._source_vars[name][path]
else:
variables = self.get_source_variables(name)
if len(variables) == 1:
return variables[0]
return None
def get_source_variables(self, name):
"""
Provides all global variables by a given name from the collection.
:param name: Variable name.
:return: List with Variable objects.
"""
name = self.refined_name(name)
result = []
if name and name in self._source_vars:
for var in self._source_vars[name].values():
if var not in result:
result.append(var)
return result
def set_source_variable(self, new_obj, path):
"""
Replace an object in global variables collection.
:param new_obj: Variable object.
:param path: File with the variable declaration or initialization.
:return: None.
"""
if new_obj.name not in self._source_vars:
self._source_vars[new_obj.name] = dict()
self._source_vars[new_obj.name][path] = new_obj
def remove_source_variable(self, name):
"""
Delete the global variable from the collection.
:param name: Variable name.
:return: None.
"""
del self._source_vars[name]
def get_macro(self, name):
"""
Provides a macro by a given name from the collection.
:param name: Macro name.
:return: Macro object or None.
"""
if name in self._macros:
return self._macros[name]
else:
return None
def set_macro(self, new_obj):
"""
Set or replace an object in macros collection.
:param new_obj: Macro object.
:return: None.
"""
self._macros[new_obj.name] = new_obj
def remove_macro(self, name):
"""
Delete the macro from the collection.
:param name: Macro name.
:return: None.
"""
del self._macros[name]
@staticmethod
def refined_name(call):
"""
Resolve function name from simple expressions which contains explicit function name like '& myfunc', '(myfunc)',
'(& myfunc)' or 'myfunc'.
:param call: An expression string.
:return: Extracted function name string.
"""
name_re = re.compile("\(?\s*&?\s*(\w+)\s*\)?$")
if name_re.fullmatch(call):
return name_re.fullmatch(call).group(1)
else:
return None
def _import_code_analysis(self, cfiles, dependencies):
"""
Read global variables, functions and macros to fill up the collection.
:param source_analysis: Dictionary with the content of source analysis.
:param files_map: Dictionary to resolve main file by an included file.
:return: None.
"""
# Import typedefs if there are provided
self.logger.info("Extract complete types definitions")
typedef = self._clade.get_typedefs(
set(dependencies.keys()).union(cfiles))
if typedef:
import_typedefs(typedef, dependencies)
variables = self._clade.get_variables(cfiles)
if variables:
self.logger.info("Import global variables initializations")
for path, vals in variables.items():
for variable in vals:
variable_name = extract_name(variable['declaration'])
if not variable_name:
raise ValueError('Global variable without a name')
var = Variable(variable_name, variable['declaration'])
# Here we know, that if we met a variable in an another file then it is an another variable because
# a program should contain a single global variable initialization
self.set_source_variable(var, path)
var.declaration_files.add(path)
var.initialization_file = path
var.static = is_static(variable['declaration'])
if 'value' in variable:
var.value = variable['value']
# Variables which are used in variables initalizations
self.logger.info("Import source functions")
vfunctions = self._clade.get_used_in_vars_functions()
# Get functions defined in dependencies and in the main functions and have calls
cg = self._clade.get_callgraph(set(dependencies.keys()))
# Function scope definitions
# todo: maybe this should be fixed in Clade
# As we will not get definitions for library functions if there are in compiled parts we should add all scopes
# that are given for all function called from outside of the code we analyze
for scope in (s for s in cfiles if s in cg):
for func in (f for f in cg[scope] if cg[scope][f].get('calls')):
for dep in cg[scope][func].get('calls'):
dependencies.setdefault(dep, set())
dependencies[dep].add(scope)
fs = self._clade.get_functions_by_file(
set(dependencies.keys()).union(cfiles))
# Add called functions
for scope in cg:
for func in cg[scope]:
desc = cg[scope][func]
if scope in cfiles:
# Definition of the function is in the code of interest
self._add_function(func, scope, fs, dependencies, cfiles)
# Add called functions
for def_scope, cf_desc in desc.get('calls',
dict()).items():
if def_scope not in cfiles:
for called_func in (
f for f in cf_desc
if def_scope in fs and f in fs[def_scope]):
self._add_function(called_func, def_scope, fs,
dependencies, cfiles)
elif ('called_in' in desc
and set(desc['called_in'].keys()).intersection(cfiles)
) or func in vfunctions:
if scope in fs and func in fs[scope]:
# Function is called in the target code but defined in dependencies
self._add_function(func, scope, fs, dependencies,
cfiles)
elif scope != 'unknown':
self.logger.warning(
"There is no information on declarations of function {!r} from {!r} scope"
.format(func, scope))
# Add functions missed in the call graph
for scope in (s for s in fs if s in cfiles):
for func in fs[scope]:
func_intf = self.get_source_function(func, scope)
if not func_intf:
self._add_function(func, scope, fs, dependencies, cfiles)
for func in self.source_functions:
for obj in self.get_source_functions(func):
scopes = set(obj.declaration_files).union(set(
obj.header_files))
if not obj.definition_file:
# It is likely be this way
scopes.add('unknown')
for scope in (s for s in scopes
if cg.get(s, dict()).get(func)):
for cscope, desc in ((s, d)
for s, d in cg[scope][func].get(
'called_in', {}).items()
if s in cfiles):
for caller in desc:
for line in desc[caller]:
params = desc[caller][line].get('args')
caller_intf = self.get_source_function(
caller, cscope)
obj.add_call(caller, cscope)
if params:
# Here can be functions which are not defined or visible
for _, passed_func in list(params):
passed_obj = self.get_source_function(
passed_func, cscope)
if not passed_obj:
passed_scope = self._search_function(
passed_func, cscope, fs)
if passed_scope:
self._add_function(
passed_func, passed_scope,
fs, dependencies, cfiles)
else:
self.logger.warning(
"Cannot find function {!r} from scope {!r}"
.format(
passed_func, cscope))
# Ignore this call since model will not be correct without signature
params = None
break
caller_intf.call_in_function(obj, params)
macros_file = get_conf_property(self._conf['source analysis'],
'macros white list')
if macros_file:
macros_file = find_file_or_dir(
self.logger, self._conf['main working directory'], macros_file)
with open(macros_file, 'r', encoding='utf8') as fp:
white_list = ujson.load(fp)
if white_list:
macros = self._clade.get_macros_expansions(cfiles, white_list)
for path, macros in macros.items():
for macro, desc in macros.items():
obj = self.get_macro(macro)
if not obj:
obj = Macro(macro)
for call in desc.get('args', []):
obj.add_parameters(path, call)
self.set_macro(obj)
def _search_function(self, func_name, some_scope, fs):
# Be aware of this funciton - it is costly
if some_scope in fs and func_name in fs[some_scope]:
return some_scope
elif 'unknown' in fs and func_name in fs['unknown']:
return 'unknown'
else:
for s in (s for s in fs if func_name in fs[s]):
return s
return None
def _add_function(self, func, scope, fs, deps, cfiles):
fs_desc = fs[scope][func]
if scope == 'unknown':
key = list(fs_desc['declarations'].keys())[0]
signature = fs_desc['declarations'][key]['signature']
func_intf = Function(func, signature)
# Do not set definition file since it is out of scope of the target program fragment
else:
signature = fs_desc.get('signature')
func_intf = Function(func, signature)
func_intf.definition_file = scope
# Set static
if fs_desc.get('type') == "static":
func_intf.static = True
else:
func_intf.static = False
# Add declarations
files = {func_intf.definition_file
} if func_intf.definition_file else set()
if fs_desc['declarations']:
files.update({
f
for f in fs_desc['declarations']
if f != 'unknown' and f in deps
})
for file in files:
if file not in cfiles and file not in func_intf.header_files:
func_intf.header_files.append(file)
for cfile in deps[file]:
self.set_source_function(func_intf, cfile)
func_intf.declaration_files.add(cfile)
def _collect_file_dependencies(self, abstract_task):
"""
Collect for each included header file or c file its "main" file to which it was included. This is required
since we cannot write aspects and instrument files which have no CC command so me build this map.
:param abstract_task: Abstract task dictionary.
:return: Collection dictionary {included file: {files that include this one}}.
"""
collection = dict()
c_files = set()
def _collect_cc_deps(cfile, deps):
# Collect for each file CC entry to which it is included
for file in deps:
if file not in collection:
collection[file] = set()
collection[file].add(cfile)
# Read each CC description and import map of files to in files
for group in abstract_task['grps']:
for desc in group['Extra CCs']:
cc_desc = self._clade.get_cmd(desc['CC'])
c_file = cc_desc['in'][0]
# Now read deps
_collect_cc_deps(c_file, self._clade.get_cmd_deps(desc['CC']))
c_files.add(c_file)
return c_files, collection