Annotation of pkgsrc/pkgtools/pkg_rolling-replace/files/pkg_rolling-replace.sh, revision 1.17
1.1 gdt 1: #!/bin/sh
2:
1.17 ! apb 3: # $NetBSD: pkg_rolling-replace.sh,v 1.16 2008/01/11 13:29:37 gdt Exp $
1.1 gdt 4: #<license>
5: # Copyright (c) 2006 BBN Technologies Corp. All rights reserved.
6: #
7: # Redistribution and use in source and binary forms, with or without
8: # modification, are permitted provided that the following conditions
9: # are met:
10: # 1. Redistributions of source code must retain the above copyright
11: # notice, this list of conditions and the following disclaimer.
12: # 2. Redistributions in binary form must reproduce the above copyright
13: # notice, this list of conditions and the following disclaimer in the
14: # documentation and/or other materials provided with the distribution.
15: # 3. Neither the name of BBN Technologies nor the names of its contributors
16: # may be used to endorse or promote products derived from this software
17: # without specific prior written permission.
18: #
19: # THIS SOFTWARE IS PROVIDED BY BBN TECHNOLOGIES AND CONTRIBUTORS ``AS IS''
20: # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21: # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22: # ARE DISCLAIMED. IN NO EVENT SHALL BBN TECHNOLOGIES OR CONTRIBUTORS BE
23: # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24: # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25: # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26: # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27: # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28: # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29: # POSSIBILITY OF SUCH DAMAGE.
30: #
31: # Effort sponsored in part by the Defense Advanced Research Projects
32: # Agency (DARPA) and the Department of the Interior National Business
33: # Center under agreement number NBCHC050166.
34: #</license>
35:
36: # REVIEW NOTATION LEGEND
37: # XXX marks things that are broken/kludgy
38: # TODO marks things that need to be done
39: # FIXED marks items fixed, needs review and deletion of FIXED comment
40:
41: # Items to be completed for initial release:
42:
43: # TODO: move bulk of help into a real man page.
44:
45: # Items for future work (some imply changes in pkgsrc, not necessarily here)
46: #
47: # Make a pass over all packages for build depends, and rememeber
48: # which packages have been so checked. Check newly unsafe packages.
49: # The current lazy evaluation can perhaps fail to do things in the
50: # right order. Alternatively, explain why the current scheme is safe
51: # and preferred.
52: #
53: # Consider expansion to update via binary packages. This raises
54: # interesting questions about ABIs and binary builds
55: #
56: # Deal with conflicts in a smarter way, perhaps more automatically.
57: # This is hard because just removing packages is not ok.
58: #
59: # Handle foo being split into foo and foo-share. Now, make replace
60: # of foo pulls in foo-share which conflicts with foo. This needlessly
61: # loses.
62: #
63:
1.3 tnn 64: # Substituted by pkgsrc at pre-configure time.
1.4 tnn 65: MAKE="@MAKE@"
1.15 tnn 66: AWK="@AWK@"
1.3 tnn 67:
1.4 tnn 68: test -z "$MAKECONF" && MAKECONF="@MAKECONF@"
1.7 tnn 69: test -f "$MAKECONF" && test -z "$PKGSRCDIR" && PKGSRCDIR="` \
70: printf '.include "%s"\n_print_pkgsrcdir:\n\t@echo "${PKGSRCDIR}"\n' \
1.8 tnn 71: "$MAKECONF" | "$MAKE" -f - BSD_PKG_MK=1 _print_pkgsrcdir`"
1.3 tnn 72: test -z "$PKGSRCDIR" && PKGSRCDIR=/usr/pkgsrc
1.12 tnn 73: test -z "$PKG_CHK" && PKG_CHK="@PKG_CHK@"
74: test -z "$PKG_INFO" && PKG_INFO="@PKG_INFO_CMD@"
1.1 gdt 75:
76: unset PKG_PATH || true #or pkgsrc makefiles will complain
77:
78: usage()
79: {
80: echo "Usage: pkg_rolling-replace [opts]
81: -h This help
82: -n Don't actually do make replace
1.13 tnn 83: -r Just replace, don't create binary packages
84: -s Replace even if the ABIs are still compatible ("strict")
1.17 ! apb 85: -u Update outdated packages
1.1 gdt 86: -v Verbose
1.17 ! apb 87: -x <pkg> exclude <pkg> from outdated check
! 88: -X <pkg> exclude <pkg> from being rebuilt
1.1 gdt 89:
90: pkg_rolling-replace does 'make replace' on one package at a time,
91: tsorting the packages being replaced according to their
92: interdependencies, which avoids most duplicate rebuilds.
93:
94: pkg_rolling-replace can be used in one of two ways:
95:
96: - 'make replace' is unsafe in that, if the replaced package's ABI
97: changes, its dependent packages may break. If this happens, run
98: 'pkg_rolling-replace' (no arguments) to rebuild them against the
99: new version.
100:
101: - 'pkg_chk -u' will delete all your mismatched (outdated)
102: packages, then reinstall them one at a time, leaving you without
103: those packages in the meantime. 'pkg_rolling-replace -u' will
104: instead upgrade them in place, allowing you to keep using your
105: system in the meantime (maybe...if you're lucky...because
106: pkg_rolling-replace replaces the \"deepest\" dependency first,
107: things could still break if that happens to be a fundamental
108: library whose ABI has changed).
109: "
110: exit 1
111: }
112:
113: # pkg_rolling-replace's output is intermingled with pkgsrc make
114: # output. Thus, we use a different prefix. pkgsrc uses '===>' for
115: # major steps, and '=>' for minor ones. Thus, we use 'RR>'.
116:
117: OPI='RR>'
118: OPC='rr>' # continuation
119:
120:
121: # Echo the names of packages needing updates, versions stripped. This
122: # has been tested with pkg_chk 1.76. Older versions are not
123: # supported. Newer versions may or may not work (patches welcome).
124: check_packages_mismatched()
125: {
1.12 tnn 126: ${PKG_CHK} -u -q | while read line; do
1.1 gdt 127: # duplicate output of pkg_chk to stderr (bypass $(...) or `...`)
1.11 tnn 128: echo "${OPC} $line" 1>&2
1.1 gdt 129: # Look for the first thing that looks like pkg-version rather
130: # than category/pkg and remove the version.
131: for word in $line; do
1.5 tnn 132: if [ "$(echo $word | egrep '^[^/]+-[0-9][^-/]*$')" ]; then
133: echo $word | sed 's/-[0-9][^-]*$//'
1.1 gdt 134: break #done with this line
135: fi
136: done
137: done
138: }
139:
140: # usage: check_packages_w_flag flag
141: # echo packages with flag=YES
142: check_packages_w_flag()
143: {
144: _flag=$1; shift
1.12 tnn 145: for pkgver in $(${PKG_INFO} -e '*'); do
146: if ${PKG_INFO} -Bq $pkgver \
1.1 gdt 147: | egrep "^$_flag=[Yy][Ee][Ss]" > /dev/null; then
1.5 tnn 148: echo $pkgver | sed 's/-[0-9][^-]*$//'
1.1 gdt 149: fi
150: done
151: }
152:
153: # echo dep->pkg edges for all installed packages
154: depgraph_installed()
155: {
1.15 tnn 156: ${PKG_INFO} -N '*' | ${AWK} ' \
157: /^Information for/ { \
158: pkg=$3; sub("-[0-9][^-]*:$", "", pkg); \
159: print pkg" "pkg; \
160: state=1; \
161: } \
1.16 gdt 162: /^\** PACKAGE MAY NOT BE DELETED \**$/ { state=3; } \
1.15 tnn 163: /^./ { \
164: if (state == 2) { \
165: dep=$1; sub("-[0-9][^-]*$", "", dep); \
166: print dep" "pkg; \
167: } \
168: } \
169: /^Built using/ { \
170: state=2 \
171: } \
172: '
1.1 gdt 173: }
174:
175: # usage: who_requires pkg --in-graph DEPGRAPH
176: who_requires()
177: {
178: _target=$1; shift
179: test "$1" = '--in-graph' && shift || return $((false))
180:
181: while [ $# -gt 0 ]; do
182: _dep=$1; _pkg=$2; shift 2;
183: if [ $_dep = $_target -a $_dep != $_pkg ]; then
184: echo $_pkg
185: fi
186: done
187: }
188:
189: # usage: is_member x list
190: # return true (0) if x appears in list, false (1) otherwise
191: is_member()
192: {
193: _x="$1"; shift;
194: while [ $# -gt 0 -a "$1" != "$_x" ]; do
195: shift
196: done
197:
198: test $# -gt 0
199: }
200:
201: # usage: exclude list1 --from list2
202: # echo list2 with items from list1 excluded
203: exclude()
204: {
205: _excl=
206: while [ $# -gt 0 -a $1 != "--from" ]; do
207: _excl="$_excl $1"
208: shift
209: done
210: if [ $# -gt 0 ]; then
211: shift #discard '--from'
212: fi
213: while [ $# -gt 0 ]; do
214: is_member $1 $_excl || echo $1
215: shift
216: done
217: }
218:
219: # usage: uniquify list
220: # just does sort -u on list (equiv. to sort | uniq)
221: # CAUTION: reorders list
222: uniqify()
223: {
224: for _x in $*; do echo $_x; done | sort -u
225: }
226:
227: verbose()
228: {
229: if [ -n "$opt_v" ]; then
230: echo "$@"
231: fi
232: }
233:
234: vsleep()
235: {
236: if [ -n "$opt_v" ]; then
237: sleep $1
238: fi
239: }
240:
1.13 tnn 241: abort()
242: {
243: echo "*** $1"
244: echo "*** Please read the errors listed above, fix the problem,"
245: echo "*** then re-run pkg_rolling-replace to continue."
246: exit 1
247: }
248:
1.1 gdt 249: ######################################################################
250: ##
251: ## main()
252: ##
253:
254: EXCLUDE=
255:
1.17 ! apb 256: args=$(getopt hnursvx:X: $*)
1.1 gdt 257: if [ $? -ne 0 ]; then
258: opt_h=1
259: fi
260: set -- $args
261: while [ $# -gt 0 ]; do
262: case "$1" in
263: -h) opt_h=1 ;;
264: -n) opt_n=1 ;;
1.13 tnn 265: -r) opt_r=1 ;;
266: -s) opt_s=1 ;;
1.1 gdt 267: -u) opt_u=1 ;;
268: -v) opt_v=1 ;;
269: -x) EXCLUDE="$EXCLUDE $(echo $2 | sed 's/,/ /g')" ; shift ;;
1.17 ! apb 270: -X) REALLYEXCLUDE="$REALLYEXCLUDE $(echo $2 | sed 's/,/ /g')" ; shift ;;
1.1 gdt 271: --) shift; break ;;
272: esac
273: shift
274: done
275:
276: if [ -n "$opt_h" ]; then
277: usage
278: fi
279:
1.13 tnn 280: if [ -n "$opt_s" ]; then
281: UNSAFE_VAR=unsafe_depends_strict
282: else
283: UNSAFE_VAR=unsafe_depends
284: fi
285:
1.1 gdt 286: MISMATCH_TODO=
287: if [ -n "$opt_u" ]; then
288: echo "${OPI} Checking for mismatched installed packages using pkg_chk"
289: MISMATCH_TODO=$(check_packages_mismatched)
290: echo "${OPI} Excluding the following mismatched packages:"
291: echo "${OPC} EXCLUDE=[$EXCLUDE]"
292: MISMATCH_TODO=$(exclude $EXCLUDE --from $MISMATCH_TODO)
293: fi
294:
295: echo "${OPI} Checking for rebuild-requested installed packages (rebuild=YES)"
296: REBUILD_TODO=$(check_packages_w_flag 'rebuild')
297:
1.13 tnn 298: echo "${OPI} Checking for unsafe installed packages (${UNSAFE_VAR}=YES)"
299: UNSAFE_TODO=$(check_packages_w_flag ${UNSAFE_VAR})
1.1 gdt 300:
301: # DEPGRAPH_INSTALLED is rebuilt each round. DEPGRAPH_SRC will collect
302: # edges that we discover using 'make show-depends', but that weren't
303: # listed as depends by the installed version of a package, and
304: # DEPENDS_CHECKED lists packages for which we've already done that
305: # check.
306: DEPGRAPH_INSTALLED=
307: DEPGRAPH_SRC=
308: DEPENDS_CHECKED=
309:
310: verbose "${OPI} Packages to rebuild:"
311: verbose "${OPC} MISMATCH_TODO=[$(echo $MISMATCH_TODO)]" #strip newlines
312: verbose "${OPC} REBUILD_TODO=[$(echo $REBUILD_TODO)]"
313: verbose "${OPC} UNSAFE_TODO=[$(echo $UNSAFE_TODO)]"
314: vsleep 2
315:
316: REPLACE_TODO=$(uniqify $MISMATCH_TODO $REBUILD_TODO $UNSAFE_TODO)
1.17 ! apb 317: REPLACE_TODO=$(exclude $REALLYEXCLUDE --from $REPLACE_TODO)
1.1 gdt 318: depgraph_built=0
319:
320: while [ -n "$REPLACE_TODO" ]; do
321: # don't rebuild depgraph if we continued from new-depends step below
322: if [ "$depgraph_built" -eq 0 ]; then
323: echo "${OPI} Building dependency graph for installed packages"
324: DEPGRAPH_INSTALLED=$(depgraph_installed)
325: depgraph_built=1
326: fi
327:
328: echo "${OPI} Tsorting dependency graph"
329: TSORTED=$(echo $DEPGRAPH_INSTALLED $DEPGRAPH_SRC | tsort)
330: for pkg in $TSORTED; do
331: if is_member $pkg $REPLACE_TODO; then
332: break;
333: fi
334: done
1.15 tnn 335: pkgdir=$(${PKG_INFO} -Bq $pkg | ${AWK} -F= '/PKGPATH=/{print $2}' | sed -e 's/^ //')
1.1 gdt 336: echo "${OPI} Selecting $pkg ($pkgdir) as next package to replace"
337: sleep 1
338:
339: # Newer versions in pkgsrc sometimes have more depends than are
340: # recorded for the installed version (this is entirely to be
341: # expected as packages are split, renamed, and add new features).
342: # When this happens, add the new edges to the graph and re-tsort.
343: # Don't re-tsort if the new edges were already installed once
344: # (otherwise we'll go into a loop).
345:
346: # XXX I'm not sure that DEPENDS_CHECKED is necessary, or whether
347: # simply ignoring new deps that aren't in $REPLACE_TODO would have
348: # been sufficient. The DEPENDS_CHECKED approach causes one extra
349: # tsort in some cases, which isn't overly expensive.
350:
351: # XXX After tsorting and choosing what to 'make replace', we
352: # filter out packages that aren't already installed and marked for
353: # replacement. This is safe, since uninstalled depends will be
354: # pulled in automatically by 'make replace'; but in rare cases it
355: # might be non-optimal, leading to a duplicate rebuild that we
356: # would have avoided had we selected the uninstalled package in
357: # tsorted order and run 'make install' on it. This seems like
358: # such a rare case that the added complexity isn't worth it.
359:
360: if ! is_member $pkg $DEPENDS_CHECKED; then
361: echo "${OPI} Checking if $pkg has new depends..."
1.12 tnn 362: OLD_DEPENDS=$(${PKG_INFO} -Nq $pkg | sed 's/-[0-9][^-]*$//')
1.1 gdt 363: NEW_DEPENDS=
364: cd "$PKGSRCDIR/$pkgdir"
365: bdeps=$(${MAKE} show-depends VARNAME=BUILD_DEPENDS)
366: rdeps=$(${MAKE} show-depends)
367: for depver in $bdeps $rdeps; do
1.10 tnn 368: dep=$(echo $depver | sed -e 's/[:[].*$/0/' -e 's/[<>]=/-/' \
369: -e 's/-[0-9][^-]*$//')
1.1 gdt 370: if ! is_member $dep $OLD_DEPENDS $NEW_DEPENDS; then
371: NEW_DEPENDS="$NEW_DEPENDS $dep"
372: DEPGRAPH_SRC="$DEPGRAPH_SRC $dep $pkg"
373: fi
374: done
375: DEPENDS_CHECKED="$DEPENDS_CHECKED $pkg"
376: if [ -n "$NEW_DEPENDS" ]; then
377: echo "${OPI} $pkg has the following new depends (need to re-tsort):"
378: echo "${OPC} [$(echo $NEW_DEPENDS)]"
379: sleep 2
380: continue
381: fi
382: fi
383:
384: # Do make replace, with clean before, and package and clean afterwards.
1.12 tnn 385: echo "${OPI} Replacing $(${PKG_INFO} -e $pkg)"
1.13 tnn 386: fail=
387: cmd="cd \"$PKGSRCDIR/$pkgdir\" && ${MAKE} clean && ${MAKE} replace || fail=1"
388: if [ -n "$opt_n" ]; then
389: echo "${OPI} Would run: $cmd"
390: else
391: eval "$cmd"
392: [ -z "$fail" ] || abort "'make replace' failed for package $pkg."
393: fi
1.1 gdt 394: if [ -z "$opt_n" ]; then
1.13 tnn 395: [ -z "$(${PKG_INFO} -Q unsafe_depends_strict $pkg)" ] || \
396: abort "package $pkg still has unsafe_depends_strict."
397: [ -z "$(${PKG_INFO} -Q unsafe_depends $pkg)" ] || \
398: abort "package $pkg still has unsafe_depends."
399: [ -z "$(${PKG_INFO} -Q rebuild $pkg)" ] || \
400: abort "package $pkg is still requested to be rebuilt."
1.1 gdt 401: fi
1.13 tnn 402: if [ -z "$opt_r" ]; then
403: echo "${OPI} Packaging $(${PKG_INFO} -e $pkg)"
404: cmd="${MAKE} package && ${MAKE} clean || fail=1"
405: if [ -n "$opt_n" ]; then
406: echo "${OPI} Would run: $cmd"
407: else
408: eval "$cmd"
409: [ -z "$fail" ] || abort "'make package' failed for package $pkg."
410: fi
1.1 gdt 411: fi
412: sleep 1
413:
414: # remove just-replaced package from all *_TODO lists
415: MISMATCH_TODO=$(exclude $pkg --from $MISMATCH_TODO)
416: REBUILD_TODO=$(exclude $pkg --from $REBUILD_TODO)
417: UNSAFE_TODO=$(exclude $pkg --from $UNSAFE_TODO)
418:
1.13 tnn 419: echo "${OPI} Re-checking for unsafe installed packages (${UNSAFE_VAR}=YES)"
1.1 gdt 420: if [ -n "$opt_n" ]; then
421: # With -n, the replace didn't happen, and thus the packages that would
422: # have been marked unsafe_depends=YES were not. Add the set that
423: # would have been marked so we can watch what pkg_rolling-replace
424: # would have done (approximately).
425: UNSAFE_TODO=$(uniqify $UNSAFE_TODO \
426: $(who_requires $pkg --in-graph $DEPGRAPH_INSTALLED))
427: sleep 1
428: else
1.13 tnn 429: UNSAFE_TODO=$(check_packages_w_flag ${UNSAFE_VAR})
1.1 gdt 430: fi
431:
432: verbose "${OPI} Packages to rebuild:"
433: verbose "${OPC} MISMATCH_TODO=[$(echo $MISMATCH_TODO)]" #strips newlines
434: verbose "${OPC} REBUILD_TODO=[$(echo $REBUILD_TODO)]"
435: verbose "${OPC} UNSAFE_TODO=[$(echo $UNSAFE_TODO)]"
436: vsleep 4
437:
438: REPLACE_TODO=$(uniqify $MISMATCH_TODO $REBUILD_TODO $UNSAFE_TODO)
1.17 ! apb 439: REPLACE_TODO=$(exclude $REALLYEXCLUDE --from $REPLACE_TODO)
1.1 gdt 440: depgraph_built=0
441: done
442:
443: echo "${OPI} No more packages to replace; done."
CVSweb <webmaster@jp.NetBSD.org>