Linux_Kernel_map4vehicle/srcxray.py

1483 lines
47 KiB
Python
Executable File

#!/usr/bin/python3
#
# srcxray - source code X-ray
#
# Analyzes interconnections between functions and structures in source code.
#
# Uses doxygen, git grep --show-functionm and cscope to
# reveal references between identifiers.
#
# Since 2018, Costa Shulyupin, costa@MakeLinux.net
#
import inspect
from inspect import (currentframe, getframeinfo, getouterframes, stack,
getmembers, isfunction)
import types
import random
import os
import sys
from sys import *
import collections
from munch import *
from subprocess import *
import re
import networkx as nx
# from networkx.drawing.nx_agraph import read_dot # changes order of successors
# from networkx.drawing.nx_pydot import read_dot # no bad
from networkx.generators.ego import *
from networkx.algorithms.dag import *
from networkx.utils import open_file, make_str
from pprint import pprint
import difflib
import glob
from pathlib import *
import pygraphviz # python3-pygraphviz
import graphviz
import unittest
import types
from xml.dom.minidom import parse
import xml.dom.minidom
import ast
import xml.etree.ElementTree as ET
default_root = 'starts'
stop = list()
ignore = list()
ignored = set()
show_ignored = False
level_limit = 6
lines = 0
lines_limit = int(os.popen('stty size', 'r').read().split()[0]) or 30
cflow_structs = False
scaled = False
verbose = False
files = collections.defaultdict(list)
def print_limited(a, out=None):
# exits when reaches limit of printed lines
out = out if out else sys.stdout
global lines
lines += 1
if lines > lines_limit + 1:
out.write(str(a) + '\n')
out.write('\t\n')
sys.exit(1)
# raise(Exception('Reached lines limit'))
out.write(str(a) + '\n')
def print_limited2(a, out=None):
# exits when reaches limit of printed lines
out = out if out else sys.stdout
global lines
lines += 1
if lines > lines_limit + 1:
global level_limit
level_limit = 2
out.write(str(a) + '\n')
def log(*args, **kwargs):
# log with context function
if not verbose:
return
s = str(*args).rstrip()
frameinfo = getframeinfo(currentframe().f_back)
print("%s:%d %s" % (frameinfo.filename, frameinfo.lineno, stack()[1][3]),
s, file=sys.stderr, **kwargs)
return s
def popen(p):
# shortcut for reading output of subcommand
log(p)
return check_output(p, shell=True).decode('utf-8').splitlines()
def extract_referrer(line):
# Extract referrer function from oupput of
# git grep --show-function.
# With quirks for linux kernel
line = re.sub(r'__ro_after_init', '', line)
line = re.sub(r'FNAME\((\w+)\)', r'\1', line)
line = re.sub(r'.*TRACE_EVENT.*', '', line)
file_num = r'(^[^\s]+)=(\d+)=[^,]*'
# file=(*name)
m = re.match(file_num + r'\(\*(\b\w+)\)\s*[\(\[=][^;]*$', line)
if not m:
m = re.match(file_num + r'(\b\w+)\s*[\(\[=][^;]*$', line)
if not m:
m = re.match(file_num + r'struct (\b\w+)', line)
if m:
return m.groups()
def extract_referrer_test():
# unittest of extract_referrer
passed = 0
for a in {
"f=1=good2()",
"f=2=static int fastop(struct x86_emulate_ctxt *ctxt, "
+ "void (*fop)(struct fastop *))",
"f=3=int good(a, bad (*func)(arg))",
"f=4=EXPORT_SYMBOL_GPL(bad);",
"f=5=bad (*good)()",
"f=6=int FNAME(good)(a)",
"f=7=TRACE_EVENT(bad)",
"f:8: a=in bad()",
"f=9=struct good",
}:
r = extract_referrer(a)
#print(a, '->', r)
if 'bad' in a and r and 'bad' in r[2]:
print("ERROR: ", a, '->', r)
elif 'good' in a and not r:
print("ERROR:", a)
else:
passed += 1
log(passed)
def func_referrers_git_grep(name):
# Subfunction for searching referrers with
# git grep --show-function.
# Works slowly.
# Obsoleted by doxygen_xml.
res = list()
r = None
for line in popen(r'git grep --threads 1 --no-index --word-regexp '
r'--show-function --line-number '
r'"^\s.*\b%s" '
r'**.\[hc\] **.cpp **.cc **.hh || true' % (name)):
# Filter out names in comment afer function,
# when comment start from ' *'
# To see the problem try "git grep -p and"
for p in {
# exludes:
r'.*:\s+\* .*%s',
r'.*/\*.*%s',
r'.*//.*%s',
r'.*".*\b%s\b.*"'}:
if re.match(p % (name), line):
r = None
break
if r and r[2] != name and r[2] not in ignore:
res.append(r)
r = None
r = extract_referrer(line)
# r is list of file line func
if verbose and r:
print("%-40s\t%s" % (("%s:%s" % (r[0], r[1])), r[2]))
return res
cscope_warned = False
def func_referrers_cscope(name):
# Subfunction for searching referrers with cscope.
# Works fast.
# Prefer to use doxygen_xml.
global cscope_warned
if not os.path.isfile('cscope.out'):
if not cscope_warned:
print("Recommended: cscope -Rcbk", file=sys.stderr)
cscope_warned = True
return []
res = list()
r = None
for l in popen(r'cscope -d -L3 "%s"' % (name)):
log(l)
m = re.match(r'([^ ]*) ([^ ]*) ([^ ]*) (.*)', l)
file, func, line_num, line_str = m.groups()
if func in ignore:
continue
res.append([file, line_num, func])
if not res and len(name) > 3:
log(name)
res = func_referrers_git_grep(name)
log(res)
return res
def referrers_tree(name, referrer=None, printed=None, level=0):
'''
prints text referrers outline.
Ex: nfs_root_data
Obsoleted by doxygen_xml.
'''
if not referrer:
if os.path.isfile('cscope.out'):
referrer = func_referrers_cscope
else:
print("Using git grep only, recommended to run: cscope -Rcbk",
file=sys.stderr)
referrer = func_referrers_git_grep
if isinstance(referrer, str):
referrer = eval(referrer)
if not printed:
printed = set()
# definition
# cscope -d -L1 "arv_camera_new"
if level > level_limit - 2:
print_limited(level*'\t' + name + '')
return ''
if name in printed:
print_limited(level*'\t' + name + ' ^')
return
printed.add(name)
print_limited(level*'\t' + name)
for a in referrer(name):
name = a[2]
referrers_tree(name, referrer, printed, level + 1)
def referrers(name):
'''
simply greps referrers of a symbol
Ex: nfs_root_data
Prefer to use doxygen_xml.
'''
print(' '.join([a[2] for a in func_referrers_git_grep(name)]))
def referrers_dep(name, referrer=None, printed=None, level=0):
# prints referrers tree in compact format of
# dependency of make
# Obsoleted by doxygen_xml.
if not referrer:
if os.path.isfile('cscope.out'):
referrer = func_referrers_cscope
else:
print("Using git grep only, recommended to run: cscope -Rcbk",
file=sys.stderr)
referrer = func_referrers_git_grep
if isinstance(referrer, str):
referrer = eval(referrer)
if not printed:
printed = set()
if name in printed:
return
if level > level_limit - 2:
return ''
referrers = [a[2] for a in referrer(name)]
if referrers:
printed.add(name)
print("%s:" % (name), ' '.join(referrers))
for a in referrers:
referrers_dep(a, referrer, printed, level + 1)
else:
pass
# TODO: print terminal
# print('⋮')
def call_tree(node, printed=None, level=0):
'''
prints call tree of a function
Ex: start_kernel
Obsoleted by doxygen_xml.
'''
if not os.path.isfile('cscope.out'):
print("Please run: cscope -Rcbk", file=sys.stderr)
return False
if printed is None:
printed = set()
if node in printed:
print_limited2(level*'\t' + node + ' ^')
return
elif level > level_limit - 2:
print_limited2(level*'\t' + node + '')
return ''
else:
print_limited2(level*'\t' + node)
printed.add(node)
local_printed = set()
for line in popen('cscope -d -L2 "%s"' % (node)):
a = line.split()[1]
if a in local_printed:
continue
if a in stop:
print_limited2((level + 1)*'\t' + a +
(' ^' if a in local_printed else ''))
local_printed.add(a)
continue
if a in ignore:
ignored.add(a)
if show_ignored:
print_limited2((level + 1)*'\t' + '\033[2;30m' + a +
(' ^' if a in local_printed else '') +
'\033[0m')
local_printed.add(a)
continue
local_printed.add(a)
# try:
call_tree(a, printed, level + 1)
# except Exception:
# pass
def call_dep(node, printed=None, level=0):
# prints call tree in compact format of dependency of make
# Obsoleted by doxygen_xml.
if not os.path.isfile('cscope.out'):
print("Please run: cscope -Rcbk", file=sys.stderr)
return False
if printed is None:
printed = set()
if node in printed:
return
calls = list()
for a in [line.split()[1] for line in
popen('cscope -d -L2 "%s"' % (node))]:
if a in ignore:
continue
calls.append(a)
if calls:
if level < level_limit - 1:
printed.add(node)
print("%s:" % (node), ' '.join(list(dict.fromkeys(calls))))
for a in list(dict.fromkeys(calls)):
call_dep(a, printed, level + 1)
else:
pass
# TODO: print terminal
# print('⋮')
def my_graph(name=None):
# common subfunction
g = nx.DiGraph(name=name)
# g.graph.update({'node': {'shape': 'none', 'fontsize': 50}})
# g.graph.update({'rankdir': 'LR', 'nodesep': 0, })
return g
def reduce_graph(g, min_in_degree=None):
'''
removes leaves
Ex2: \"write_dot(reduce_graph(read_dot('doxygen.dot')),'reduced.dot')\"
'''
rm = set()
min_in_degree = g.number_of_nodes() + 1 if not min_in_degree else min_in_degree
log(g.number_of_edges())
rm = [n for (n, d) in g.out_degree if not d and g.in_degree(n)
< min_in_degree]
g.remove_nodes_from(rm)
print(g.number_of_edges())
return g
def includes(sym):
# subfunction, used in syscalls
# extracts include files of a symbol
res = []
# log(a)
for a in popen('man -s 2 %s 2> /dev/null |'
' head -n 20 | grep include || true' % (a)):
m = re.match('.*<(.*)>', a)
if m:
res.append(m.group(1))
if not res:
for a in popen('grep -l -r " %s *(" '
'/usr/include --include "*.h" '
'2> /dev/null || true' % (a)):
# log(a)
a = re.sub(r'.*/(bits)', r'\1', a)
a = re.sub(r'.*/(sys)', r'\1', a)
a = re.sub(r'/usr/include/(.*)', r'\1', a)
# log(a)
res.append(a)
res = set(res)
if res and len(res) > 1:
r = set()
for f in res:
# log('grep " %s \+\(" --include "%s" -r /usr/include/'%(sym, f))
# log(os.system(
# 'grep -w "%s" --include "%s" -r /usr/include/'%(sym, f)))
if 0 != os.system(
'grep " %s *(" --include "%s" -r /usr/include/ -q'
% (sym, os.path.basename(f))):
r.add(f)
res = res.difference(r)
log(res)
return ','.join(list(res)) if res else 'unexported'
def syscalls():
# Experimental function for exporting syscalls info
# from various sources.
# Used in creation of
# https://en.wikibooks.org/wiki/The_Linux_Kernel/Syscalls
# Ex: srcxray.py "write_dot(syscalls(), 'syscalls.dot')"
sc = my_graph('syscalls')
inc = 'includes.list'
if not os.path.isfile(inc):
os.system('ctags --langmap=c:+.h --c-kinds=+pex -I __THROW '
+ ' -R -u -f- /usr/include/ | cut -f1,2 > '
+ inc)
'''
if False:
includes = {}
with open(inc, 'r') as f:
for s in f:
includes[s.split()[0]] = s.split()[1]
log(includes)
'''
scd = 'SYSCALL_DEFINE.list'
if not os.path.isfile(scd):
os.system("grep SYSCALL_DEFINE -r --include='*.c' > " + scd)
with open(scd, 'r') as f:
v = set(['sigsuspend', 'llseek', 'sysfs',
'sync_file_range2', 'ustat', 'bdflush'])
for s in f:
if any(x in s.lower() for x in ['compat', 'stub']):
continue
m = re.match(r'(.*?):.*SYSCALL.*\(([\w]+)', s)
if m:
for p in {
'^old',
'^xnew',
r'.*64',
r'.*32$',
r'.*16$',
}:
if re.match(p, m.group(2)):
m = None
break
if m:
syscall = m.group(2)
syscall = re.sub('^new', '', syscall)
path = m.group(1).split('/')
if (m.group(1).startswith('mm/nommu.c')
or m.group(1).startswith('arch/x86/ia32')
or m.group(1).startswith('arch/')
or syscall.startswith('vm86')
and not m.group(1).startswith('arch/x86')):
continue
if syscall in v:
continue
v.add(syscall)
p2 = '/'.join(path[1:])
p2 = m.group(1)
# if log(difflib.get_close_matches(syscall, v) or ''):
# log(syscall)
# log(syscall + ' ' + (includes.get(syscall) or '------'))
# man -s 2 timerfd_settime | head -n 20
if False:
i = includes(syscall)
log(p2 + ' ' + str(i) + ' ' + syscall)
sc.add_edge(i, i+' - '+p2)
sc.add_edge(i+' - '+p2, 'sys_' + syscall)
else:
sc.add_edge(path[0] + '/', p2)
sc.add_edge(p2, 'sys_' + syscall)
return sc
def cleanup(a):
# cleanups graph file
# wrapper for remove_nodes_from
log('')
g = to_dg(a)
print(dg.number_of_edges())
dg.remove_nodes_from(ignore)
print(dg.number_of_edges())
write_dot(dg, a)
def sort_dict(d):
return [a for a, b in sorted(d.items(), key=lambda k: k[1], reverse=True)]
def starts(dg): # roots of trees in a graph
return {n: dg.out_degree(n) for (n, d) in dg.in_degree if not d}
def exclude(i, excludes_re=[]):
if i in ignore:
return True
for e in excludes_re:
if re.match(e, i):
return True
def digraph_predecessors(dg, starts, levels=100, excludes_re=[]):
'''
extracts referrers subgraph
'''
dg = to_dg(dg)
passed = set()
# for i in [_ for _ in dg.predecessors(start)]:
p = nx.DiGraph()
for e in excludes_re:
log(e)
while levels:
# log(levels)
# log(starts)
s2 = starts
starts = set()
for s in s2:
for i in dg.predecessors(s):
if i in passed or exclude(i, excludes_re):
continue
passed.add(i)
starts.add(i)
p.add_edge(i, s)
levels -= 1
return p
def digraph_tree(dg, starts=None):
'''
extract a subgraph from a graph
Ex2: \"write_dot(digraph_tree(read_dot('doxygen.dot'), ['main']), 'main.dot')\"
'''
tree = nx.DiGraph()
def sub(node):
tree.add_node(node)
for o in dg.successors(node):
if o in ignore or tree.has_edge(node, o) or o in starts:
# print(o)
continue
tree.add_edge(node, o)
sub(o)
printed = set()
if not starts:
starts = {}
for i in [n for (n, d) in dg.in_degree if not d]:
starts[i] = dg.out_degree(i)
starts = [a[0] for a in sorted(
starts.items(), key=lambda k: k[1], reverse=True)]
if len(starts) == 1:
sub(starts[0])
elif len(starts) > 1:
for o in starts:
if o in ignore:
continue
sub(o)
return tree
def digraph_print(dg, starts=None, dst_fn=None, sort=False):
'''
prints graph as text tree
Ex2: \"digraph_print(read_dot('a.dot'))\"
'''
dst = open(dst_fn, 'w') if dst_fn else None
printed = set()
def digraph_print_sub(path='', node=None, level=0):
if node in ignore:
return
if node in printed:
print_limited2(level*'\t' + str(node) + ' ^', dst)
return
outs = {_: dg.out_degree(_) for _ in dg.successors(node)}
if sort:
outs = {a: b for a, b in sorted(
outs.items(), key=lambda k: k[1], reverse=True)}
s = ''
if 'rank' in dg.nodes[node]:
s = str(dg.nodes[node]['rank'])
ranks[dg.nodes[node]['rank']].append(node)
if outs:
s += '' if level > level_limit - 2 else ''
else:
s += ' @' + path
print_limited2(level*'\t' + str(node) + s, dst)
printed.add(node)
if level > level_limit - 2:
return ''
passed = set()
for o in outs.keys():
if o in passed:
continue
passed.add(o)
digraph_print_sub(path + ' ' + str(node), o, level + 1)
if not starts:
starts = {}
for i in [n for (n, d) in dg.in_degree if not d]:
starts[i] = dg.out_degree(i)
starts = [a[0] for a in sorted(
starts.items(), key=lambda k: k[1], reverse=True)]
if len(starts) > 1:
print_limited2(default_root, dst)
for s in starts:
print_limited2('\t' + s + ' ->', dst)
passed = set()
for o in starts:
if o in passed:
continue
passed.add(o)
if o in dg:
digraph_print_sub('', o)
# not yet printed rest:
for o in dg.nodes():
if o not in printed:
digraph_print_sub('', o)
if dst_fn:
print(dst_fn)
dst.close()
def cflow_preprocess(a):
# prepare Linux source for better cflow parsing results
with open(a, 'rb') as f:
for s in f:
try:
s = s.decode('utf-8')
except UnicodeDecodeError:
s = s.decode('latin1')
if cflow_structs:
# treat structs like functions
s = re.sub(r"^static struct (\w+) = ", r"\1()", s)
s = re.sub(r"^static struct (\w+)\[\] = ", r"\1()", s)
s = re.sub(r"^static const struct (\w+)\[\] = ", r"\1()", s)
s = re.sub(r"^struct (.*) =", r"\1()", s)
s = re.sub(r"^static __initdata int \(\*actions\[\]\)\(void\) = ",
"int actions()", s) # init/initramfs.c
s = re.sub(r"^static ", "", s)
s = re.sub(r"SENSOR_DEVICE_ATTR.*\((\w*),",
r"void sensor_dev_attr_\1()(", s)
s = re.sub(r"COMPAT_SYSCALL_DEFINE[0-9]\((\w*),",
r"compat_sys_\1(", s)
s = re.sub(r"SYSCALL_DEFINE[0-9]\((\w*)", r"sys_\1(", s)
s = re.sub(r"__setup\(.*,(.*)\)", r"void __setup() {\1();}", s)
s = re.sub(r"^(\w*)param\(.*,(.*)\)", r"void \1param() {\2();}", s)
s = re.sub(r"^(\w*)initcall\((.*)\)",
r"void \1initcall() {\2();}", s)
s = re.sub(r"^static ", "", s)
s = re.sub(r"^inline ", "", s)
s = re.sub(r"^const ", "", s)
s = re.sub(r"\b__initdata\b", "", s)
s = re.sub(r"DEFINE_PER_CPU\((.*),(.*)\)", r"\1 \2", s)
s = re.sub(r"^(\w+) {$", r"void \1() {", s)
# for line in sys.stdin:
sys.stdout.write(s)
# export CPATH=:include:arch/x86/include:../build/include/:../build/arch/x86/include/generated/:include/uapi
# srcxray.py "'\n'.join(cflow('init/main.c'))"
def cflow(a=None):
'''
configure and use cflow on Linux sources
'''
cflow_param = {
"modifier": "__init __inline__ noinline __initdata __randomize_layout asmlinkage __maybe_unused"
" __visible __init __leaf__ __ref __latent_entropy __init_or_module libmosq_EXPORT",
"wrapper": "__attribute__ __section__ "
"TRACE_EVENT MODULE_AUTHOR MODULE_DESCRIPTION MODULE_LICENSE MODULE_LICENSE MODULE_SOFTDEP "
"INIT_THREAD_INFO "
"BUG READ_ONCE EEXIST MAJOR "
"VM_FAULT_ERROR VM_FAULT_MAJOR VM_FAULT_RETRY VM_PFNMAP VM_READ VM_WRITE "
"FAULT_FLAG_ALLOW_RETRY FAULT_FLAG_KILLABLE "
"VM_BUG_ON_VMA FOLL_TOUCH FOLL_POPULATE FOLL_MLOCK VM_LOCKONFAULT VM_SHARED FOLL_WRITE "
"FOLL_PIN FOLL_NUMA FOLL_GET FOLL_FORCE FOLL_LONGTERM FOLL_FAST_ONLY"
"TASK_SIZE "
"fallthrough EHWPOISON "
"__assume_kmalloc_alignment __malloc "
"__acquires __releases __ATTR",
"type":
"pgd_t p4d_t pud_t pmd_t pte_t vm_flags_t"
# "wrapper": "__setup early_param"
}
if os.path.isfile('include/linux/cache.h'):
for m in popen("ctags -x --c-kinds=d include/linux/cache.h | cut -d' ' -f 1 | sort -u"):
if m in cflow_param['modifier']:
print(m)
else:
cflow_param['modifier'] += ' ' + a
if not a:
a = "$(cat cscope.files)" if os.path.isfile(
'cscope.files') else "*.c *.h *.cpp *.hh "
elif isinstance(a, list):
pass
elif os.path.isdir(a):
a = "$(find {0} -name '*.[ch]' -o -name '*.cpp' -o -name '*.hh')".format(a)
pass
elif os.path.isfile(a):
pass
# "--depth=%d " %(level_limit+1) +
# --debug=1
cflow = (r"cflow -m _ignore_main_get_all_ -v "
# + "-DCONFIG_KALLSYMSZ "
+ "--preprocess='srcxray.py cflow_preprocess' "
+ ''.join([''.join(["--symbol={0}:{1} ".format(w, p)
for w in cflow_param[p].split()])
for p in cflow_param.keys()])
+ " --include=_sxt --brief --level-indent='0=\t' "
+ a)
log(cflow)
return popen(cflow)
def import_cflow(a=None, cflow_out=None):
'''
extract graph with cflow from Linux sources
'''
cf = my_graph()
stack = list()
nprev = -1
cflow_out = open(cflow_out, 'w') if cflow_out else None
for line in cflow(a):
if cflow_out:
cflow_out.write(line + '\n')
# --print-level
m = re.match(r'^([\t]*)([^(^ ^<]+)', str(line))
if m:
n = len(m.group(1))
id = str(m.group(2))
else:
raise Exception(line)
if n <= nprev:
stack = stack[:n - nprev - 1]
# print(n, id, stack)
if id not in ignore:
if len(stack):
cf.add_edge(stack[-1], id)
stack.append(id)
nprev = n
return cf
def import_outline(outline_txt=None):
'''
converts outline to graph
Ex2: \"write_dot(import_outline('outline.txt'),'outline.dot')\"
'''
cf = my_graph()
stack = list()
nprev = -1
with open(outline_txt, 'r') as f:
for line in f:
m = re.match(r'^([\t ]*)(.*)', str(line))
if m:
n = len(m.group(1))
id = str(m.group(2))
else:
raise Exception(line)
if not id:
continue
id = re.sub(' \^$', '', id)
if n <= nprev:
stack = stack[:n - nprev - 1]
# print(n, id, stack)
if id not in ignore:
if len(stack):
cf.add_edge(stack[-1], id)
stack.append(id)
nprev = n
return cf
def rank_couples(dg):
'''
put couples on same rank to reduce total number of ranks and make
graph layout more compact
'''
# a=sys_clone;srcxray.py "write_dot(rank_couples(reduce_graph(remove_loops(read_dot('$a.dot')))),'$a.dot')"
couples = []
ranked = set()
for n in dg:
if n in ranked:
continue
m = n
while True:
if dg.out_degree(m) == 1:
s = list(dg.successors(m))[0]
if dg.in_degree(s) == 1:
couples.append((m, s))
ranked.update(set((m, s)))
dg.nodes[m]['rank1'] = dg.nodes[m]['rank2'] = dg.nodes[s]['rank1'] = dg.nodes[s]['rank2'] = n
m = s
continue
break
return dg
def add_rank(g):
'''
explicitly calculate and store ranks for further processing to
improve xdot output
'''
#
# srcxray.py "write_dot(add_rank('reduced.dot'), 'ranked.dot')"
g = to_dg(g)
passed1 = set()
passed2 = set()
rn1 = 1
rn2 = -1
r1 = [n for (n, d) in g.in_degree if not d]
r2 = [n for (n, d) in g.out_degree if not d]
while r1 or r2:
if r1:
nxt = set()
for n in r1:
g.nodes[n]['rank1'] = max(rn1, g.nodes[n].get('rank1', rn1))
for i in [_ for _ in g.successors(n)]:
nxt.add(i)
passed1.add(i)
rn1 += 1
r1 = nxt
if r2:
nxt = set()
for n in r2:
g.nodes[n]['rank2'] = min(rn2, g.nodes[n].get('rank2', rn2))
for i in [_ for _ in g.predecessors(n)]:
nxt.add(i)
passed2.add(i)
rn2 -= 1
r2 = nxt
g.__dict__['max_rank'] = rn1
return g
def write_dot(g, dot):
'''
writes a graph into a file with custom attributes
'''
# Other similar external functions to_agraph agwrite
def rank(g, n):
try:
if g.nodes[n]['rank1'] == g.nodes[n]['rank2']:
return g.nodes[n]['rank1']
if g.nodes[n]['rank1'] < abs(g.nodes[n]['rank2']):
return g.nodes[n]['rank1']
else:
return g.__dict__['max_rank'] + 1 + g.nodes[n]['rank2']
except KeyError:
return None
def esc(s):
# re.escape(n))
return s
if isinstance(g, graphviz.Digraph):
g.save(dot)
print(dot)
return
dot = str(dot)
dot = open(dot, 'w')
dot.write('strict digraph "None" {\n')
dot.write('rankdir=LR\nnodesep=0\n')
# dot.write('ranksep=50\n')
dot.write('node [fontname=Ubuntu,shape=none];\n')
# dot.write('edge [width=10000];\n')
dot.write('edge [width=1];\n')
if isinstance(g, nx.DiGraph):
g.remove_nodes_from(ignore)
ranks = collections.defaultdict(list)
for n in g.nodes():
r = rank(g, n)
if r:
ranks[r].append(n)
if not g.out_degree(n):
continue
dot.write('"%s" -> { ' % esc(n))
dot.write(' '.join(['"%s"' % (esc(str(a)))
for a in g.successors(n)]))
if scaled and r and int(r):
dot.write(' } [penwidth=%d label=%d];\n' % (100/r, r))
else:
dot.write(' } ;\n')
# pred
dot.write('// "%s" <- { ' % esc(n))
dot.write(' '.join(['"%s"' % (esc(str(a)))
for a in g.predecessors(n)]))
dot.write(' } ;\n')
print(ranks.keys())
for r in ranks.keys():
dot.write("{ rank=same %s }\n" %
(' '.join(['"%s"' % (str(a)) for a in ranks[r]])))
for n in g.nodes():
prop = Munch(g.node[n])
if scaled and len(ranks):
prop.fontsize = 500 + 10000 / (len(ranks[rank(g, n)]) + 1)
prop.fontsize = 30 + min(5 * len(g.edges(n)), 50)
# prop.label = n + ' ' + str(rank(g,n))
if prop:
dot.write('"%s" [%s]\n' % (esc(n), ','.join(
['%s="%s"' % (a, str(prop[a])) for a in prop])))
elif not g.number_of_edges():
dot.write('"%s"\n' % (n))
# else:
# dot.write('"%s"\n'%(n))
dot.write('}\n')
dot.close()
print(dot.name)
@open_file(0, mode='r')
def read_dot(dot):
# faster custom version of eponymous function from external library
# pydot.graph_from_dot_data parse_dot_data from_pydot
dg = nx.DiGraph()
for a in dot:
a = a.strip()
if '->' in a:
m = re.match('"?([^"]+)"? -> {(.+)}', a)
if m:
dg.add_edges_from([(m.group(1), b.strip('"'))
for b in m.group(2).split() if b != m.group(1)])
else:
m = re.match('"?([^"]+)"? -> "?([^"]*)"?;?', a)
if m:
if m.group(1) != m.group(2):
dg.add_edge(m.group(1), m.group(2))
else:
log(a)
elif re.match('.*[=\[\]{}]', a):
continue
else:
m = re.match('"?([^"]+)"?', a)
if m:
if m.group(1):
dg.add_node(m.group(1))
return dg
def to_dg(a):
if isinstance(a, nx.DiGraph):
log(a)
return a
if os.path.isfile(a):
log(a)
return read_dot(a)
raise(Exception(a))
def remove_loops(dg):
# srcxray.py "write_dot(remove_loops(read_dot('reduced.dot')), 'no-loops.dot')"
rm = []
visited = set()
path = [object()]
path_set = set(path)
stack = [iter(dg)]
while stack:
for v in stack[-1]:
if v in path_set:
rm.append((path[-1], v))
elif v not in visited:
visited.add(v)
path.append(v)
path_set.add(v)
stack.append(iter(dg[v]))
break
else:
path_set.remove(path.pop())
stack.pop()
# print(rm)
dg.remove_edges_from(rm)
return dg
def remove_couples(dg):
couples = []
for n in dg:
if dg.out_degree(n) == 1:
s = list(dg.successors(n))[0]
if dg.in_degree(s) == 1:
couples.append((n, s))
pprint(couples)
dg.remove_edges_from(couples)
return dg
def cflow_dir(a):
# generates dot files with cflow for c files
index = nx.DiGraph()
for c in glob.glob(os.path.join(a, "*.c")):
g = None
dot = str(Path(c).with_suffix(".dot"))
if not os.path.isfile(dot):
# c -> cflow and dot
g = import_cflow(c, Path(c).with_suffix(".cflow"))
write_dot(g, dot)
print(dot, popen("ctags -x %s | wc -l" % (c))
[0], len(set(e[0] for e in g.edges())))
else:
print(dot)
try:
# g = nx.drawing.nx_agraph.read_dot(dot)
g = read_dot(dot)
except (TypeError, pygraphviz.agraph.DotError):
print('nx_pydot <- nx_agraph')
g = nx.drawing.nx_pydot.read_dot(dot)
# digraph_print(g, [], Path(c).with_suffix(".tree"))
# index.add_nodes_from(g.nodes())
index.add_edges_from(g.edges())
write_dot(index, str(os.path.join(a, 'index.dot')))
digraph_print(digraph_tree(index), [], os.path.join(a, 'index.tree'))
return index
def cflow_linux():
'''
extracts with cflow various graphs from Linux kernel source
'''
dirs = ('init kernel kernel/time '
'fs fs/ext4 block '
'ipc net '
'lib security security/keys '
'arch/x86/kernel drivers/char drivers/pci '
).split()
# dirs += ('mm net/ipv4 crypto').split()
dirs = ('init kernel arch/x86/kernel fs ').split()
dirs += ['mm']
# fs/notify/fanotify fs/notify/inotify
all = None
try:
print('loading all.dot')
all = read_dot('all.dot')
# all = nx.DiGraph(read_dot('all.dot'))
except FileNotFoundError:
pass
log(all)
if not all:
all = nx.DiGraph()
for a in dirs:
print(a)
index = cflow_dir(a)
# all.add_nodes_from(index.nodes())
all.add_edges_from(index.edges())
write_dot(all, 'all.dot')
remove_loops(all)
print('loops: ' + str(list(all.nodes_with_selfloops())))
print('trees:')
digraph_print(all, ['x86_64_start_kernel', 'start_kernel', 'main', 'initcall', 'early_param',
'__setup', 'sys_write', 'write'],
'all.tree')
start_kernel = digraph_tree(all, ['start_kernel'])
write_dot(start_kernel, 'start_kernel.dot')
write_dot(reduce_graph(start_kernel), 'start_kernel-reduced.dot')
write_dot(reduce_graph(reduce_graph(start_kernel)),
'start_kernel-reduced2.dot')
write_dot(reduce_graph(digraph_tree(all, ['sys_clone'])), 'sys_clone.dot')
def stats(graph):
'''
measures various simple statistical metrics of a graph
Ex: graph.dot
'''
dg = to_dg(graph)
stat = Munch()
im = dict()
om = dict()
leaves = set()
roots = dict()
stat.edge_nodes = 0
stat.couples = 0
for n in dg:
id = dg.in_degree(n)
od = dg.out_degree(n)
if id == 1 and od == 1:
stat.edge_nodes += 1
if id:
im[n] = id
else:
roots[n] = od
if od:
om[n] = od
else:
leaves.add(n)
if od == 1 and dg.in_degree(list(dg.successors(n))[0]) == 1:
stat.couples += 1
stat.max_in_degree = max(dict(dg.in_degree).values())
stat.max_out_degree = max(dict(dg.out_degree).values())
stat.leaves = len(leaves)
stat.roots = len(roots)
stat.big_roots = ' '.join(sort_dict(roots)[:20])
# pprint(im)
# pprint(om)
stat._popular = ' '.join(sort_dict(im)[:10])
stat._biggest = ' '.join(sort_dict(om)[:10])
gd = remove_loops(dg)
stat.dag_longest_path_len = len(dag_longest_path(dg))
stat.__longest_path = ' '.join(dag_longest_path(dg)[:10] + [''])
for a in [nx.DiGraph.number_of_nodes, nx.DiGraph.number_of_edges, nx.DiGraph.number_of_selfloops,
nx.DiGraph.order]:
stat[a.__name__] = a(dg)
pprint(dict(stat))
def dot_expand(a, b):
# nodes from a with edges from b
a = to_dg(a)
b = to_dg(b)
c = my_graph()
log(a.nodes())
c.add_edges_from(b.out_edges(b.nbunch_iter(a.nodes())))
print(list(b.nbunch_iter(a.nodes())))
return c
def import_symbols():
# extracts and import symbols from shared libraries
sym = my_graph('symbols')
for l in popen('(shopt -s globstar; nm -D -C -A **/*.so.*)'):
q = l.split(maxsplit=2)
m = re.match(r'.*lib(.+).so.*:.*', q[0])
if not m:
log(q[0])
continue
if q[1] == 'U':
sym.add_edge(m.group(1), q[2])
elif q[1] == 'T':
sym.add_edge(q[2], m.group(1))
print(m.group(1), q[1], q[2])
return sym
me = os.path.basename(sys.argv[0])
def dir_tree(path='.'):
'''
scans directory into graph
Ex2: "write_dot(dir_tree('.'),'tree.dot')"
'''
stack = list()
nprev = -1
g = my_graph()
# all = nx.DiGraph()
# TODO
for path, dirs, files, fds in os.fwalk(path):
(dir, base) = os.path.split(path)
dir = re.sub(r'^\.\/', '', dir)
path = re.sub(r'^\.\/', '', path)
path2 = path.split(os.sep)
# print(path, fds, len(path2))
if re.match(r'\.repo/', path) or len(path2) > level_limit:
# print("skip", path)
continue
if len(path2) > 1:
# g.add_edge(path2[-2] + str(), path2[-1])
if g.number_of_edges() > lines_limit:
g.add_edge(dir, '')
break
g.add_edge(dir, path)
#g.add_node(path, label=path2[-1], xlabel='<<font point-size="1">'+path+'</font>>')
g.add_node(path, label=path2[-1])
#g.add_node(path, label=path2[-1], xlabel=path)
print(g.number_of_edges())
return g
def doxygen(*sources, output_dir='xml2'):
'''
extracts call graph from sources with doxygen
Ex: *.c
Ex2: "doxygen('init','xml2')"
'''
log(' '.join([i for i in sources]))
p = run(['doxygen', '-'], stdout=PIPE,
input="INPUT=" + ' '.join([i for i in sources]) + """
EXCLUDE_SYMBOLS=*310* *311* SOC_ENUM_SINGLE* EXPORT_SYMBOL*
CALL_GRAPH = YES
EXTRACT_ALL = YES
OPTIMIZE_OUTPUT_FOR_C = YES
EXTRACT_STATIC = YES
RECURSIVE = YES
EXCLUDE = html
#GENERATE_TREEVIEW = YES
#HAVE_DOT = YES
#DOT_FONTSIZE = 15
#CALLER_GRAPH = YES
#INTERACTIVE_SVG = YES
#DOT_TRANSPARENT = YES
#DOT_MULTI_TARGETS = NO
#DOT_FONTNAME = Ubuntu
#CASE_SENSE_NAMES = YES
SOURCE_BROWSER = NO
GENERATE_HTML = NO
GENERATE_LATEX = NO
#QUIET = NO
GENERATE_XML=YES
MACRO_EXPANSION = YES
PREDEFINED = "DECLARE_COMPLETION(work)=struct completion work" \\
"__initdata= "
XML_OUTPUT=""" + output_dir + """
""", encoding='ascii')
print(output_dir)
#write_dot(doxygen_xml(output_dir), 'doxygen.dot')
def doxygen_xml(a):
'''
extracts call graph from xml directory generated by doxygen
Ex2: \"write_dot(doxygen_xml('xml'), 'doxygen.dot')\"
'''
g = my_graph()
for x in list(glob.glob(os.path.join(a, "*.xml")) + [a]):
# print(x)
if os.path.isfile(x):
d = xml.dom.minidom.parse(x)
for m in d.getElementsByTagName("memberdef"):
n = m.getElementsByTagName("name")[0].firstChild.data
file = (m.getElementsByTagName("location")[0]
.getAttribute('file'))
if file not in files:
log(file)
if n == 'main':
n = file + '::' + n
files[file].append(n)
for r in m.getElementsByTagName("references"):
g.add_edge(n, r.firstChild.data)
for r in m.getElementsByTagName("ref"):
g.add_edge(n, r.firstChild.data)
# referencedby
print(g.number_of_edges())
return g
def doxygen_xml_files(a):
'''
extracts call graph from xml directory generated by doxygen
with files as clusters
Ex2: \"write_dot(doxygen_xml_files('xml'), 'doxygen.dot')\"
'''
g = graphviz.Digraph()
g.attr('graph', rankdir='LR', concentrate='true', ranksep='4')
g.attr('node', shape='plaintext')
clusters = collections.defaultdict(list)
edges = list()
for x in list(glob.glob(os.path.join(a, "*.xml")) + [a]):
# print(x)
if os.path.isfile(x):
d = xml.dom.minidom.parse(x)
for m in d.getElementsByTagName("memberdef"):
n = m.getElementsByTagName("name")[0].firstChild.data
file = (m.getElementsByTagName("location")[0]
.getAttribute('file'))
if file not in files:
log(file)
if n == 'main':
n = file + '::' + n
files[file].append(n)
if not clusters.get(file):
clusters[file] = g.subgraph(
name='cluster_' + file.replace('.', '_8'))
clusters[file].graph.attr(
'graph', label=file, fontsize="50")
with clusters[file] as c:
c.node(n)
for r in m.getElementsByTagName("references"):
edges.append((n, r.firstChild.data))
for r in m.getElementsByTagName("ref"):
edges.append((n, r.firstChild.data))
for (a, b) in edges:
g.edge(a, b.replace('::', '__'))
return g
def doxygen_length(a):
'''
calculates length of functions using doxygen xml
'''
g = my_graph()
for x in list(glob.glob(os.path.join(a, "*.xml")) + [a]):
if os.path.isfile(x):
d = xml.dom.minidom.parse(x)
for m in d.getElementsByTagName("memberdef"):
n = m.getElementsByTagName("name")[0].firstChild.data
location = m.getElementsByTagName("location")[0]
# for r in m.getElementsByTagName("references"):
# g.add_edge(n, r.firstChild.data)
# referencedby
e = location.getAttribute('bodyend')
if not e or e == "-1":
continue
l = int(e) - int(location.getAttribute('bodystart'))
if l < 20:
continue
print(location.getAttribute('bodystart'), n, location.getAttribute(
'file'), location.getAttribute('bodyfile'), x, file=sys.stderr)
print("{0}:{1}:".format(location.getAttribute('bodyfile'),
location.getAttribute('bodystart')), n, l, "SLOC")
# <location file="common/log.cpp" line="21" column="1" bodyfile="common/log.cpp" bodystart="21" bodyend="49"/>
return g
def svg_xml(svg=None) -> nx.DiGraph:
'''
extracts call graph from svg
Ex2: \"write_dot(svg_xml('LKM.svg'), 'LKM.dot')\"
'''
if not svg:
return doc()
g = my_graph(svg)
s = xml.dom.minidom.parse(svg)
'''
for p in s.getElementsByTagName("path"):
print(p.getAttribute('inkscape:connection-end'))
print(p.getAttribute('inkscape:connection-start'))
'''
et = ET.parse(svg)
root = et.getroot()
print(svg)
print(et)
print(root)
# for e in root.iter():
# print(e.tag)
def text(c):
for t in root.findall('.//ns0:text[@id="' + c + '"]', ns):
return t.find('.//ns0:tspan', ns).text
ns = {'ns0': 'http://www.w3.org/2000/svg',
'ns1': 'http://www.inkscape.org/namespaces/inkscape'}
# for t in root.findall('.//ns0:text', ns):
# print(t.find('.//ns0:tspan', ns).text)
for p in root.findall('.//ns0:path', ns):
try:
c = (p.get("{"+ns['ns1'] + "}connection-start")[1:],
p.get("{"+ns['ns1'] + "}connection-end")[1:])
print(text(c[0]), text(c[1]))
g.add_edge(text(c[0]), text(c[1]))
except (TypeError):
pass
return g
def doc(m=None):
full = False
if not m:
m = (dict((name, func) for name, func
in getmembers(modules[__name__]))[stack()[1][3]])
full = True
d = inspect.getdoc(m)
if not d:
return False
if full:
print('\033[1m' + m.__name__ + '\033[0m' +
str(inspect.signature(m)) + ' -',
d.replace('Ex:',
'\033[3mExample:\033[0m ' + me + ' ' + m.__name__).
replace('Ex2:',
'\033[3mExample:\033[0m ' + me)
)
else:
print(m.__name__, '-', d.partition('\n')[0])
def usage():
#print('Run', me, 'usage')
for m in getmembers(modules[__name__]):
if isfunction(m[1]) and m[1].__module__ == __name__:
doc(m[1])
print("\nTry this: ")
print("cd linux;", me, "unittest")
print("\nEmergency termination: ^Z, kill %1")
print()
class _unittest_autotest(unittest.TestCase):
def test_1(self):
extract_referrer_test()
write_dot(nx.DiGraph([(1, 2), (2, 3), (2, 4)]), 'test.dot')
g = read_dot("test.dot")
self.assertEqual(list(g.successors("2")), ["3", "4"])
self.assertTrue(os.path.isdir('include/linux/'))
os.chdir('init')
self.assertRegex(popen('srcxray.py referrers_tree nfs_root_data')[-1],
r'.*prepare_namespace.*')
self.assertEqual('initrd_load: prepare_namespace',
popen('srcxray.py referrers_dep nfs_root_data')[-1])
self.assertEqual('calibrate_delay_converge: __delay',
popen('srcxray.py call_dep start_kernel')[-2])
self.assertEqual('\t\tcpu_startup_entry', popen(
'srcxray.py call_tree start_kernel')[-1])
os.chdir('..')
self.assertTrue(syscalls().number_of_edges() > 400)
# digraph_print:
self.assertEqual("\t\tmount_initrd ^", popen(
"srcxray.py import_cflow init/do_mounts_initrd.c")[-1])
self.assertRegex(popen(
'srcxray.py "nx.DiGraph([{1,2},{2,3},{2,4}])"')[-1],
"\t\t4.*")
os.system('srcxray.py doxygen init')
os.system(
"srcxray.py \"write_dot(doxygen_xml('xml2'), 'call_graph_dx.dot')\"")
self.assertTrue(read_dot("call_graph_dx.dot").number_of_edges() > 400)
os.system(
"srcxray.py \"write_dot(doxygen_xml_files('xml2'), 'call_graph_dx_files.dot')\"")
self.assertTrue(
read_dot("call_graph_dx_files.dot").number_of_edges() > 400)
self.assertFalse(0 == os.system(
"grep DECLARE_COMPLETION call_graph_dx_files.dot"))
def main():
global stop
try:
f = open("stop.txt")
stop = f.read().splitlines()
except FileNotFoundError:
pass
global ignore
try:
f = open("ignore.txt")
ignore = f.read().splitlines()
except FileNotFoundError:
pass
try:
ret = False
if len(sys.argv) == 1:
usage()
else:
while sys.argv[1].startswith('--'):
global verbose
global level_limit
log(sys.argv[1][2:])
if sys.argv[1][2:] == 'verbose':
verbose = True
if sys.argv[1][2:] == 'level_limit':
level_limit = int(sys.argv[2])
sys.argv = sys.argv[1:]
global lines_limit
if sys.argv[1][2:] == 'lines_limit':
lines_limit = int(sys.argv[2])
sys.argv = sys.argv[1:]
sys.argv = sys.argv[1:]
a1 = sys.argv[1]
sys.argv = sys.argv[1:]
if '(' in a1:
ret = eval(a1)
# ret = exec(sys.argv[1])
elif len(sys.argv) == 1 and isinstance(eval(a1), types.ModuleType):
ret = eval(a1 + ".main()")
else:
ret = eval(a1 + '(' + ', '.join("'%s'" % (a)
for a in sys.argv[1:]) + ')')
if ignored:
print("Ignored:", " ".join(ignored))
if isinstance(ret, nx.DiGraph):
digraph_print(ret)
elif isinstance(ret, bool) and ret is False:
sys.exit(os.EX_CONFIG)
else:
if (ret is not None):
print(ret)
except KeyboardInterrupt:
log("\nInterrupted")
# -fdump-rtl-expand
if __name__ == "__main__":
main()