source: BLFS/libs/func_dependencies@ 5afaf7c

ablfs-more legacy trunk
Last change on this file since 5afaf7c was 5afaf7c, checked in by Pierre Labastie <pierre@…>, 7 years ago

BLFS/libs/func_dependencies: fix 2 stupid bug in function path_to

  • Property mode set to 100644
File size: 19.4 KB
Line 
1#!/bin/bash
2#
3# $Id$
4#
5
6#-----------------------------------------------------------------------------#
7# This is a set of (recursive) functions for manipulating a dependency graph. #
8# We use algorithms and definitions from chapter 4 (mainly section 4.2) of #
9# https://algs4.cs.princeton.edu/. The graph we manipulate is the directed #
10# graph of the dependencies: nodes are packages in the BLFS book. A node A is #
11# connected to a node B if package A depends on B. A topological order (rev- #
12# erted) is exactly what we want for a build order. But a topological order #
13# only exists if the graph is acyclic. We'll therefore have to remove cycles. #
14# There are a number of other features we want to consider: #
15# - edges are weighted according to the dependency requirement: #
16# 1 for required #
17# 2 for recommended #
18# 3 for optional #
19# 4 for external #
20# We should consider only edges with weight lower or equal to that #
21# specified by the user, but see below. #
22# - we do not want to build the whole book. The user specifies a set of #
23# packages, and we have to consider only nodes reachable from this set #
24# using edges of weight not exceeding the specified weight. #
25# - when doing the topological sort, we want to consider all the edges and #
26# not only those not exceeding the specified weight: If a package A in the #
27# reachable subgraph depends optionally on another package B in the same #
28# subgraph, we want to build B before A. But this means we'll have to #
29# remove cycles for all weights. #
30# - dependencies have another qualifier: before or after. The problem: if a #
31# package A depends on B with an "after" qualifier, and a package C depends #
32# on A with a "before" qualifier, C may need B to be able to use A. So the #
33# only safe way to consider "after" qualifiers is to consider that they are #
34# "before" deps for any parent of the packages considered. #
35# We'll therefore have a 3 pass procedure. First build the set of nodes #
36# reachable from the root set. Second, remove dangling edges (those pointing #
37# to packages outside the node set), and move "after" edges to "before" edges #
38# originating from the parents. Third remove cycles and generate a #
39# topological sort. #
40# #
41# TODO: document each pass
42# Data layout: #
43# TODO: needs also to document the .tree files, and the "f" qualifier
44# #
45# A node of the tree is represented by a text file <nodeName>.dep. Each edge #
46# starting from this node is represented by a line in this file. We keep #
47# those files in the same directory. We introduce a special node named root, #
48# whose edges point to the list of nodes requested by the user. Each line #
49# contains three fields: #
50# - the weight of the edge #
51# - the "before" (b) or "after" (a) qualifier #
52# - the name of the destination of the edge #
53# #
54# TODO: The following is obsolete
55# Circular dependencies: #
56# #
57# In case we find a cirdular dependency, it has the form : #
58# parent->dependency_0->...->dependency_n->dependency_0 #
59# If we want to build dependency_n before dependency_0, no problem: #
60# we just prune the tree at dependency_n. If we want to build first #
61# dependency_0, we need to put dependency_n as a dependency of parent, #
62# then erase and rebuild the subtree from there. Now, we may have met #
63# another circular dependency in the subtree, and erasing the tree makes #
64# us forget the decision which was made. So, after first generating the #
65# list of dependencies from packages.xml, we keep the generated list in #
66# a file <nodeName>.odep, which we modify according to the decision which #
67# was made. #
68#---------------------------------------------------------------------------#
69
70# Global variables:
71# A string of spaces for indenting:
72declare -a spaceSTR=" "
73# When we are backing up from a circular dependency, `parentNode'
74# contains the node which has an edge entering the cycle
75declare parentNode
76
77#---------------------#
78generate_subgraph() { #
79#---------------------#
80: <<inline_doc
81 function: Create a subgraph of all the nodes reachable from the node
82 represented by the file whose name is $1. The edges considered
83 are those with maximal weight DEP_LEVEL (recursive function).
84 input vars: $1 : file name corresponding to the node whose edges will be
85 followed for the DFS
86 $2 : weight of the edge leading to this node
87 $3 : depth (root is 1)
88 $4 : qualifier (a for after, b for before)
89 externals: vars: DEP_LEVEL contains 1 if we want to build the
90 tree only for required dependencies,
91 2 if we want also recommended ones,
92 3 if we want also optional ones, but only
93 for the requested packages,
94 4 if we want all the dependencies
95 MAIL_SERVER contains the name of the MTA we want to use.
96 files: ../xsl/dependencies.xsl: stylesheet for creating the
97 .dep files
98 ../packages.xml: File containing packages id
99 and dependencies
100 returns: 0 if the tree has been successfully created
101 output: files: for each node reachable from $1, a file <node>.dep.
102 on error: nothing
103 on success: nothing
104inline_doc
105
106local depFile=$1
107local -i weight=$2
108local -i depth=$3
109local qualifier=$4
110local -i spacing=0
111local priostring
112local buildstring
113local id_of_dep
114local prio_of_dep
115local build_of_dep
116local dep_level
117
118if (( depth < 10 )); then spacing=1; fi
119case $weight in
120 1) priostring=required ;;
121 2) priostring=recommended ;;
122 3) priostring=optional ;;
123esac
124case $qualifier in
125 a) buildstring=runtime ;;
126 b) buildstring= ;;
127esac
128dep_level=$DEP_LEVEL
129if [ "$dep_level" = 3 ] && [ "$depth" -gt 2 ]; then dep_level=2; fi
130if [ "$dep_level" -gt 3 ]; then dep_level=3; fi
131echo -en "\nNode: $depth${spaceSTR:0:$(( depth + spacing ))}${RED}${depFile%.dep}${OFF} $priostring $buildstring"
132
133depth=$(( depth + 1 ))
134if (( depth < 10 )); then spacing=1; else spacing=0; fi
135# Start of loop
136{
137while read prio_of_dep build_of_dep id_of_dep; do
138case $prio_of_dep in
139 1) priostring=required ;;
140 2) priostring=recommended ;;
141 3) priostring=optional ;;
142 4) priostring=external ;;
143esac
144case $build_of_dep in
145 a) buildstring=runtime ;;
146 b) buildstring= ;;
147esac
148# Has this entry already been seen
149 if [ -f ${id_of_dep}.dep ] ; then
150# Just display it and proceed.
151 echo -en "\nEdge: $depth${spaceSTR:0:$((depth + spacing))}${MAGENTA}${id_of_dep}${OFF} $priostring $buildstring"
152 continue
153 fi
154# Is the weight higher than requested?
155 if [ "$prio_of_dep" -gt $dep_level ]; then
156# Just display it and proceed.
157 echo -en "\n Out: $depth${spaceSTR:0:$((depth + spacing))}${YELLOW}${id_of_dep}${OFF} $priostring $buildstring"
158 continue
159 fi
160# Otherwise, let's build the corresponding subgraph.
161 xsltproc --stringparam idofdep "$id_of_dep" \
162 --stringparam MTA "$MAIL_SERVER" \
163 -o ${id_of_dep}.dep \
164 ../xsl/dependencies.xsl ../packages.xml
165
166 if [[ -s ${id_of_dep}.dep ]]; then # this dependency has dependencies
167 generate_subgraph ${id_of_dep}.dep $prio_of_dep $depth $build_of_dep
168 else # id_of_dep has no dependencies, just touch the file and display
169 touch ${id_of_dep}.dep
170 echo -en "\nLeaf: $depth${spaceSTR:0:$((depth + spacing))}${CYAN}${id_of_dep}${OFF} $priostring $buildstring"
171 fi
172done
173} <$depFile
174depth=$(( depth - 1 ))
175if (( depth < 10 )); then spacing=1; else spacing=0; fi
176echo -en "\n End: $depth${spaceSTR:0:$((depth + spacing))}${GREEN}${depFile%.dep}${OFF}"
177return 0
178}
179
180#-----------#
181path_to() { #
182#-----------#
183: <<inline_doc
184 function: check whether there is a path from $1 to $2 on the graph
185 input vars: $1 contains the filename of the starting node.
186 $2 contains the name of the node to reach
187 $3 contains the weight above which we do not want to
188 follow an edge
189 "seen" (global) contains the list of already seen nodes
190 returns: 0 if the node has been found
191 1 if not
192 on error: nothing
193 on success: nothing
194inline_doc
195local start=$1
196local seek=$2
197local prio=$3
198local prio_of_dep
199local build_of_dep
200local id_of_dep
201local r
202
203if test "${start%.dep}" = "$seek"; then return 0; fi
204seen="$seen$start "
205if test -s $start; then
206 {
207 while read prio_of_dep build_of_dep id_of_dep; do
208 if test "$prio" -lt "$prio_of_dep"; then continue; fi
209 if ! test "${seen% $id_of_dep *}" = "$seen"; then continue; fi
210 if path_to ${id_of_dep}.dep $seek $prio; then return 0; fi
211 done
212 } < $start
213fi
214return 1
215}
216#------------------#
217clean_subgraph() { #
218#------------------#
219: <<inline_doc
220 function: Remove dangling edges and create groups of deps for "after"
221 deps: A-before->B-after->C becomes:
222 A -before-> Bgroupxx -before-> B
223 \
224 -before-> C
225 the name of the group is chosen so that it is unlikely as
226 a package name (so that it is removed when building the
227 xml book).
228 input vars: None
229 files: <node>.dep files containing dangling edges and
230 "after" qualifiers
231 returns: 0
232 output: files: <node>.dep files containing no dangling edges and
233 no "after" qualifiers
234 on error: nothing
235 on success: nothing
236inline_doc
237
238local node
239local id_of_dep
240local prio_of_dep
241local build_of_dep
242local lines_to_remove
243local lines_to_change
244local parent
245local p
246local b
247local start
248local seen
249
250for node in $(ls *.dep); do
251 if test $node = root.dep; then continue; fi
252 lines_to_remove=
253 {
254 while read prio_of_dep build_of_dep id_of_dep; do
255 if ! test -f ${id_of_dep}.dep; then
256 lines_to_remove="$lines_to_remove $id_of_dep"
257 continue
258 fi
259 done
260 } <$node
261 for id_of_dep in $lines_to_remove; do
262 sed "/\ $id_of_dep\$/d" -i $node
263 done
264done
265for node in $(grep -l ' a ' *.dep); do
266 lines_to_remove=
267 if ! [ -e ${node%.dep}groupxx.dep ]; then
268 for parent in $(grep -l ${node%.dep}\$ *); do
269 p=0
270 for start in $(grep ' a ' $node | cut -d' ' -f3); do
271 seen=" "
272 if path_to ${start}.dep ${parent%.dep} 3; then p=1; break; fi
273 done
274 if test $p = 0; then
275 sed -i "s/\ ${node%.dep}\$/&groupxx/" $parent
276 fi
277 done
278 echo "1 b ${node%.dep}" > ${node%.dep}groupxx.dep
279 fi
280 {
281 while read prio_of_dep build_of_dep id_of_dep; do
282 if test $build_of_dep = a; then
283 if ! grep -q ${id_of_dep} ${node%.dep}groupxx.dep; then
284 echo "$prio_of_dep b ${id_of_dep}" >> ${node%.dep}groupxx.dep
285 fi
286 lines_to_remove="$lines_to_remove $id_of_dep"
287 fi
288 done
289 } <$node
290 for id_of_dep in $lines_to_remove; do
291 sed "/\ $id_of_dep\$/d" -i $node
292 done
293done
294for node in $(grep -l ' f ' *); do
295 lines_to_change=
296 {
297 while read prio_of_dep build_of_dep id_of_dep; do
298 if test $build_of_dep = f; then
299 if ! test -f ${id_of_dep}-pass1.dep; then
300 cp ${id_of_dep}{,-pass1}.dep;
301 fi
302 lines_to_change="$lines_to_change $id_of_dep"
303 unset lr
304 {
305 while read p b start; do
306 seen=" "
307 if path_to ${start}.dep ${node%.dep} $p; then
308 lr="$lr $start"
309 fi
310 done
311 } < ${id_of_dep}-pass1.dep
312 for p in $lr; do
313 sed "/\ $p\$/d" -i ${id_of_dep}-pass1.dep
314 done
315 fi
316 done
317 } <$node
318 for id_of_dep in $lines_to_change; do
319 sed "/\ $id_of_dep\$/"'{s/ f / b /;s/$/-pass1/}' -i $node
320 done
321done
322} # End clean_subgraph
323
324#----------------------------#
325generate_dependency_tree() { #
326#----------------------------#
327: <<inline_doc
328 function: Create a subtree of the dependency tree
329 (recursive function)
330 input vars: $1 : file with a list of targets (child nodes)
331 the first line of the file is the link
332 $2 : priority (1=req, 2=rec, 3=opt)
333 returns: 0 if the tree has been successfully created
334 1 if we are backing up to the parent of a circular dep
335 and there are only required deps in the cycle
336 2 if we are backing up to the parent of a circular dep
337 and there are recommended deps and no optional deps in the
338 cycle
339 3 if we are backing up to the parent of a circular dep
340 and there are optiional deps in the cycle
341 modifies: vars: ParentNode is set when return is not 0
342 output: files: for each <pkg> with dependencies in $1,
343 a file <pkg>.tree and its dependencies
344 on error: nothing
345 on success: nothing
346inline_doc
347
348local depFile=$1
349local priority=$2
350local -a rootlink
351local -a priolink
352local -a otherlink
353local -i depth
354local -i count=0
355local id_of_dep
356local build_of_dep
357local prio_of_dep
358local parent
359local lines_to_remove=
360local srootlink
361local priostring
362local dpriostring
363local i
364
365{
366read -a rootlink
367depth=${#rootlink[*]}
368read -a priolink
369srootlink="${rootlink[*]} "
370case $priority in
371 1) priostring=required ;;
372 2) priostring=recommended ;;
373 3) priostring=optional ;;
374esac
375# start of depFile
376echo -en "\nNode: $depth${spaceSTR:0:$depth}${RED}${depFile%.tree}${OFF} $priostring"
377
378while read prio_of_dep build_of_dep id_of_dep; do
379 case $prio_of_dep in
380 1) dpriostring=required ;;
381 2) dpriostring=recommended ;;
382 3) dpriostring=optional ;;
383 esac
384# count entries in file
385 (( count++ ))
386# Has this entry already been seen?
387 if [ -f ${id_of_dep}.tree ]; then # found ${id_of_dep}.tree already in tree
388 otherlink=($(head -n 1 ${id_of_dep}.tree))
389 if [ -z "${otherlink[*]}" ]
390 then echo otherlink empty for $id_of_dep.tree
391 echo This should not happen, but happens to happen...
392 exit 1
393 fi
394#Do not use "${rootlink[*]}" =~ "${otherlink[*]}": case rootlink=(1 11)
395# and otherlink=(1 1)
396 if [[ ${srootlink#"${otherlink[*]} "} != ${srootlink} ]]; then # cir. dep
397 echo -en "\nCirc: $((depth+1))${spaceSTR:0:$((depth+1))}${YELLOW}${id_of_dep}${OFF} $dpriostring"
398# Find lowest priority in branch from parent to depFile:
399 p2=0
400 for (( i=${#otherlink[*]}; i < $depth ; i++ )) ; do
401 if (( ${priolink[i]} > $p2 )); then p2=${priolink[i]}; fi
402 done
403 if (( $prio_of_dep >= $p2 )); then # prune
404 lines_to_remove="$lines_to_remove $id_of_dep"
405 sed -i "/$id_of_dep/d" ${depFile/.tree/.dep}
406 else # find and set parent, then return lowest priority
407# The parent has the same link without the last entry.
408# We do not need otherlink anymore so just destroy the last element
409 unset otherlink[-1]
410 parentNode=$(grep ^"${otherlink[*]}"\$ -l *)
411 return $p2
412 fi
413 else # not circular: prune tree (but not .dep, since it may happen that
414 # the tree is destroyed and rebuilt in another order)
415 lines_to_remove="$lines_to_remove $id_of_dep"
416 fi # circular or not
417 continue # this dependency has already been seen, and the associated
418 # subtree computed. We are done
419 fi # Has this entry already been seen?
420# So, this entry has not already been seen. Let's build the corresponding
421# subtree. First check there is a subtree...
422# Use -s, because it may happen that after removing lines, .dep exists
423# but is empty.
424 if [[ -s ${id_of_dep}.dep ]]; then # this dependency has dependencies
425 sed "1i${rootlink[*]} $count\\
426${priolink[*]} $prio_of_dep" < ${id_of_dep}.dep \
427 > ${id_of_dep}.tree # add link and priolink
428 generate_dependency_tree ${id_of_dep}.tree $prio_of_dep
429# Test return value, in case we exchange dependencies
430 p2=$?
431 case $p2 in
432 0) # Normal return
433 ;;
434 $prio_of_dep) # we remove this dep, but since it may become unreachable,
435 # move it to be built later (as a dep of parent).
436 tree_erase ${id_of_dep}.tree
437 lines_to_remove="$lines_to_remove $id_of_dep"
438 sed -i "/${id_of_dep}/d" ${depFile/.tree/.dep}
439 echo "$prio_of_dep b $id_of_dep" >> $parentNode
440# must be added to .dep in case parentNode is destroyed when erasing
441# the tree
442 echo "$prio_of_dep b $id_of_dep" >> ${parentNode/.tree/.dep}
443 continue
444 ;;
445 *) # We are backing up
446 return $p2
447 ;;
448 esac
449 else # id_of_dep has no dependencies, just record the link in a file
450 # and print
451 echo "${rootlink[*]} $count" > ${id_of_dep}.tree
452 echo -en "\nLeaf: $(($depth+1))${spaceSTR:0:$(($depth+1))}${CYAN}${id_of_dep}${OFF} $dpriostring"
453 fi
454done
455echo -en "\n End: $depth${spaceSTR:0:$depth}${GREEN}${depFile%.tree}${OFF}"
456} <$depFile
457# It may happen that a file is created with several times
458# the same line. Normally, all those lines but one
459# would be flagged to be removed (or all of them if
460# the dependency appeared before). A simple sed /$line/d
461# destroys all the lines. We should instead remove
462# only one for each appearance of it in lines_to_remove.
463# so first get the position of last line and then delete
464# that line
465for line in $lines_to_remove
466 do lineno=$(sed -n /^[[:digit:]]\ b\ $line\$/= $depFile | tail -n1)
467 sed -i ${lineno}d $depFile
468done
469return 0
470}
471
472
473#---------------#
474tree_browse() { #
475#---------------#
476local file=$1
477local f
478
479#echo file=$file
480for f in $(grep '[^0-9 ]' $file | sed 's/.* //'); do
481# echo f=$f
482 if grep -q '[^0-9 ]' ${f}.tree ; then
483 tree_browse ${f}.tree
484 fi
485 echo $f
486done
487}
488
489#--------------#
490tree_erase() { #
491#--------------#
492local file=$1
493local f
494local rootlink
495local rootlink2
496
497#echo file=$file
498rootlink="$(head -n1 $file) "
499for f in $(grep '[^0-9 ]' $file | sed 's/.* //'); do
500 if [ -f ${f}.tree ]; then
501 rootlink2="$(head -n1 ${f}.tree) "
502# We want two things:
503# i) do not erase the file if it is in another branch
504# ii) do not erase the file if there is a circular dependency
505# for case i), we test that rootlink is contained in rootlink2
506# for case ii), we test that rootlink2 is not contained in
507# rootlink.
508# See comment above about srootlink
509 if [[ ${rootlink2#${rootlink}} != ${rootlink2} &&
510 ${rootlink#${rootlink2}} == ${rootlink} ]] ; then
511 tree_erase ${f}.tree
512 fi
513 fi
514done
515rm -f $file
516}
Note: See TracBrowser for help on using the repository browser.