-
Notifications
You must be signed in to change notification settings - Fork 12
/
cyclic_dependency.py
executable file
·229 lines (207 loc) · 8.72 KB
/
cyclic_dependency.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
#!/usr/bin/env python3
# Script to do analyze the dependencies in Quickstep particularly cycles in the
# dependency graph. This script can be used to find:
# 1. Cycles in the dependency graph.
# 2. Strongly connected components in the dependency graph.
# 3. Find shortest path between two targets.
#
# Dependency:
# pip3 install networkx
#
# Usage:
# Find the shortest path between target1 and target2.
# cyclic_dependency.py --path [target1] [target2]
# Find strongly connected components in the dependency graph.
# cyclic_dependency.py --components
# Find cycles in the graph.
# cyclic_dependency.py --cycles
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
import itertools
import networkx as nx
from optparse import OptionParser
import os
import pprint
import sys
# Don't scan these directories for quickstep modules.
EXCLUDED_TOP_LEVEL_DIRS = ["build", "third_party"]
# Explicitly ignored dependencies (special headers with no other quickstep
# dependencies).
IGNORED_DEPENDENCIES = frozenset(["quickstep_threading_WinThreadsAPI"])
# States when scanning a CMakeLists.txt file.
CMAKE_SCANNING_NONE = 0
CMAKE_SCANNING_TARGET_LINK_LIBRARIES = 1
# Process a CMake target_link_libraries() command with arguments
# 'target_link_libraries_args', adding all the quickstep libraries specified
# to the target's set of dependencies in 'deps_in_cmake'.
def process_target_link_libraries(directory,
target_link_libraries_args,
deps_in_cmake):
components = target_link_libraries_args.split()
if components[0].startswith("quickstep"):
deps = set()
# Intentionally count the first part for self-includes
for component in components:
if component.startswith("quickstep"):
deps.add(component)
if components[0] in deps_in_cmake:
deps_in_cmake[components[0]].update(deps)
else:
deps_in_cmake[components[0]] = deps
# Scan a CMake file, building up the dependency sets for targets from included
# C++ headers and from target_link_libraries() specified in CMakeLists.txt and
# comparing the two for discrepancies.
def process_cmakelists_file(cmakelists_filename, qs_module_dirs):
cmakelists_file = open(cmakelists_filename, "r")
directory = os.path.dirname(cmakelists_filename)
deps_in_cmake = {}
scan_state = CMAKE_SCANNING_NONE
stitched_string = ""
for line in cmakelists_file:
if scan_state == CMAKE_SCANNING_NONE:
target_link_libraries_pos = line.find("target_link_libraries(")
if target_link_libraries_pos != -1:
scan_state = CMAKE_SCANNING_TARGET_LINK_LIBRARIES
stitched_string = line[target_link_libraries_pos
+ len("target_link_libraries("):]
closing_paren_pos = stitched_string.find(")")
if closing_paren_pos != -1:
stitched_string = stitched_string[:closing_paren_pos]
process_target_link_libraries(directory,
stitched_string,
deps_in_cmake)
stitched_string = ""
scan_state = CMAKE_SCANNING_NONE
elif scan_state == CMAKE_SCANNING_TARGET_LINK_LIBRARIES:
closing_paren_pos = line.find(")")
if closing_paren_pos == -1:
stitched_string += line
else:
stitched_string += line[:closing_paren_pos]
process_target_link_libraries(directory,
stitched_string,
deps_in_cmake)
stitched_string = ""
scan_state = CMAKE_SCANNING_NONE
return deps_in_cmake
# Create dependency graph in networkx, and returns Digraph() object, node to
# target mapping, and target to node mapping.
def create_graph(deps_in_cmake):
nodes = set()
for source, dest_set in iter(deps_in_cmake.items()):
nodes.add(source)
nodes.update(dest_set)
nodes_list = list(nodes)
nodes_map = {}
for i, n in zip(range(len(nodes_list)), nodes_list):
nodes_map[n] = i
G = nx.DiGraph()
for source, dest_set in iter(deps_in_cmake.items()):
source_node = nodes_map[source]
for dest in dest_set:
if source == dest: continue
dest_node = nodes_map[dest]
G.add_edge(source_node, dest_node)
return G, nodes_list, nodes_map
# Lists the strongly connected components in the graph.
def find_strongly_connected_components(G, nodes_list):
components = 0
for n in nx.strongly_connected_components(G):
if len(n) > 1:
components += 1
# Only output components bigger than 1.
print([nodes_list[i] for i in n])
return components
# Lists cycles in the graph truncating to 100 cycles.
def find_cycles(G, nodes_list, truncate):
cycles = 0
for n in nx.simple_cycles(G):
print([nodes_list[i] for i in n])
cycles += 1
if cycles >= truncate:
print("Many cycles found. Truncating to {0} cycles.".format(truncate))
break
return cycles
# Find the shortest path from source to target.
def find_path(G, nodes_list, nodes_map, source, target):
source_node = nodes_map[source]
target_node = nodes_map[target]
if nx.has_path(G, source_node, target_node):
print([nodes_list[i] for i in nx.shortest_path(G,
source_node,
target_node)])
else:
print('No path.')
def main():
if not os.path.isfile("cyclic_dependency.py"):
print("WARNING: you don't appear to be running in the root quickstep "
"source directory. Don't blame me if something goes wrong.")
qs_module_dirs = []
for filename in os.listdir("."):
if (os.path.isdir(filename)
and not filename.startswith(".")
and filename not in EXCLUDED_TOP_LEVEL_DIRS):
qs_module_dirs.append(filename)
cmakelists_to_process = []
for (dirpath, dirnames, filenames) in os.walk('.'):
skip = False
for excluded_dir in EXCLUDED_TOP_LEVEL_DIRS:
if dirpath.startswith(excluded_dir):
skip = True
break
if not skip:
if "CMakeLists.txt" in filenames:
cmakelists_to_process.append(
os.path.join(dirpath, "CMakeLists.txt"))
dependencies = {}
for cmakelists_filename in cmakelists_to_process:
dependencies.update(process_cmakelists_file(cmakelists_filename,
qs_module_dirs))
parser = OptionParser()
parser.add_option("--components", action='store_true',
help='List strongly connected components in the dependency graph.')
parser.add_option("--cycles", action='store_true',
help='List cycles in the dependency graph.')
parser.add_option("--path", action='store_true',
help='Output the shortest path between two targets.')
parser.add_option("--dependency", action='store_true',
help='Output the dependencies graph.')
parser.add_option("--truncate", type=int, default=100,
help='Truncate cycles to this number. Default: 100.')
(options, args) = parser.parse_args()
if options.dependency:
pprint.pprint(dependencies)
G, nodes_list, nodes_map = create_graph(dependencies)
if options.path:
if len(args) != 2:
raise ValueError
find_path(G, nodes_list, nodes_map, args[0], args[1])
return 0
elif options.cycles:
return find_cycles(G, nodes_list, options.truncate)
else:
return find_strongly_connected_components(G, nodes_list)
if __name__ == "__main__":
return_code = main()
if return_code > 0:
sys.exit(1)
else:
sys.exit(0)