|
| 1 | +#! /bin/bash |
| 2 | +# |
| 3 | +# This script is called during external module building to create dependencies |
| 4 | +# both upon the RHEL kernel, and on additional external modules. Symbols that |
| 5 | +# cannot be reconciled against those provided by the kernel are assumed to be |
| 6 | +# provided by an external module and "ksym" replaces th regular "kernel" dep. |
| 7 | + |
| 8 | +IFS=$'\n' |
| 9 | +export LC_ALL=C |
| 10 | + |
| 11 | +# Prevent elfutils from trying to download debuginfos |
| 12 | +unset DEBUGINFOD_URLS |
| 13 | + |
| 14 | +# Extract all of the symbols provided by this module. |
| 15 | +all_provides() { |
| 16 | + for module in "$@"; do |
| 17 | + tmpfile="" |
| 18 | + if [ "x${module%.ko}" = "x${module}" ]; then |
| 19 | + tmpfile=$(mktemp -t ${0##*/}.XXXXXX.ko) |
| 20 | + proc_bin= |
| 21 | + case "${module##*.}" in |
| 22 | + zst) |
| 23 | + proc_bin=zstd |
| 24 | + ;; |
| 25 | + xz) |
| 26 | + proc_bin=xz |
| 27 | + ;; |
| 28 | + bz2) |
| 29 | + proc_bin=bzip2 |
| 30 | + ;; |
| 31 | + gz) |
| 32 | + proc_bin=gzip |
| 33 | + ;; |
| 34 | + esac |
| 35 | + |
| 36 | + [ -n "$proc_bin" ] || continue |
| 37 | + |
| 38 | + "$proc_bin" -d -c - < "$module" > "$tmpfile" || continue |
| 39 | + module="$tmpfile" |
| 40 | + fi |
| 41 | + |
| 42 | + objdump -t "$module" \ |
| 43 | + | awk \ |
| 44 | + -v 'dep_pfx='"$dep_pfx" \ |
| 45 | + -v 'module='"$module" \ |
| 46 | + --non-decimal-data \ |
| 47 | + 'BEGIN { revbytes = 0 } |
| 48 | +
|
| 49 | + function check_endianness( t) { |
| 50 | + if (revbytes) return revbytes; |
| 51 | +
|
| 52 | + revbytes = -1; |
| 53 | + while (("readelf -h \"" module "\"" | getline t) > 0) { |
| 54 | + if (match(t, /^ Data: *2\047s complement, little endian$/)) { |
| 55 | + revbytes = 1; |
| 56 | + break; |
| 57 | + } |
| 58 | + } |
| 59 | +
|
| 60 | + return revbytes; |
| 61 | + } |
| 62 | +
|
| 63 | + function readsect(name, a, t) { |
| 64 | + a = ""; |
| 65 | + while (("readelf -R \"" name "\" \"" module "\"" | getline t) > 0) { |
| 66 | + if (match(t, /^ 0x[0-9a-f]{8}/)) |
| 67 | + a = a substr(t, 14, 8) substr(t, 23, 8) substr(t, 32, 8) substr(t, 41, 8); |
| 68 | + } |
| 69 | + if (revbytes) { a = gensub(/(..)(..)(..)(..)/, "\\4\\3\\2\\1", "g", a); } |
| 70 | + sectdata[name] = a; |
| 71 | + } |
| 72 | +
|
| 73 | + match($0, /^([0-9a-f]+) [gl]...... (.*) [0-9a-f]+ __crc_(.*)$/, a) { |
| 74 | + if (a[2] == "*ABS*") { |
| 75 | + printf("%s(%s) = 0x%08x\n", dep_pfx, a[3], strtonum("0x" a[1])); |
| 76 | + } else { |
| 77 | + if (!(a[2] in sectdata)) { readsect(a[2]) } |
| 78 | + printf("%s(%s) = 0x%08s\n", dep_pfx, a[3], substr(sectdata[a[2]], (strtonum("0x" a[1]) * 2) + 1, 8)) |
| 79 | + } |
| 80 | + }' |
| 81 | + |
| 82 | + [ -z "$tmpfile" ] || rm -f -- "$tmpfile" |
| 83 | + done \ |
| 84 | + | sort -k1,1 -u |
| 85 | +} |
| 86 | + |
| 87 | +# Extract all of the requirements of this module. |
| 88 | +all_requires() { |
| 89 | + for module in "$@"; do |
| 90 | + set -- $(/sbin/modinfo -F vermagic "$module" | sed -e 's: .*::' -e q) |
| 91 | + /sbin/modprobe --dump-modversions "$module" \ |
| 92 | + | awk --non-decimal-data ' |
| 93 | + BEGIN { FS = "\t" ; OFS = "\t" } |
| 94 | + {printf("%s:0x%08x\n", $2, $1)}' \ |
| 95 | + | sed -r -e 's:$:\t'"$1"':' |
| 96 | + done \ |
| 97 | + | sort -k1,1 -u |
| 98 | +} |
| 99 | + |
| 100 | +# Filter out requirements fulfilled by the module itself. |
| 101 | +mod_requires() { |
| 102 | + join -t $'\t' -j 1 -v 1 \ |
| 103 | + <(all_requires "$@") \ |
| 104 | + <(all_provides "$@") \ |
| 105 | + | sort -k1,1 -u |
| 106 | +} |
| 107 | + |
| 108 | +if ! [ -e /sbin/modinfo -a -e /sbin/modprobe ]; then |
| 109 | + cat > /dev/null |
| 110 | + exit 0 |
| 111 | +fi |
| 112 | + |
| 113 | +check_kabi() { |
| 114 | + arch=$(uname -m) |
| 115 | + kabi_file="/lib/modules/kabi-current/kabi_stablelist_$arch" |
| 116 | + |
| 117 | + # If not installed, output a warning and return (continue) |
| 118 | + if [ ! -f "$kabi_file" ]; then |
| 119 | + echo "" >&2 |
| 120 | + echo "********************************************************************************" >&2 |
| 121 | + echo "*********************** KERNEL ABI COMPATIBILITY WARNING ***********************" >&2 |
| 122 | + echo "********************************************************************************" >&2 |
| 123 | + echo "The kernel ABI reference files (provided by "kabi-stablelists") were not found." >&2 |
| 124 | + echo "No compatibility check was performed. Please install the kABI reference files" >&2 |
| 125 | + echo "and rebuild if you would like to verify compatibility with kernel ABI." >&2 |
| 126 | + echo "" >&2 |
| 127 | + return |
| 128 | + fi |
| 129 | + |
| 130 | + unset non_kabi |
| 131 | + for symbol in "$@"; do |
| 132 | + if ! egrep "^[[:space:]]$symbol\$" $kabi_file >/dev/null; then |
| 133 | + non_kabi=("${non_kabi[@]}" "$symbol") |
| 134 | + fi |
| 135 | + done |
| 136 | + |
| 137 | + if [ ${#non_kabi[@]} -gt 0 ]; then |
| 138 | + echo "" >&2 |
| 139 | + echo "********************************************************************************" >&2 |
| 140 | + echo "*********************** KERNEL ABI COMPATIBILITY WARNING ***********************" >&2 |
| 141 | + echo "********************************************************************************" >&2 |
| 142 | + echo "The following kernel symbols are not guaranteed to remain compatible with" >&2 |
| 143 | + echo "future kernel updates to this RHEL release:" >&2 |
| 144 | + echo "" >&2 |
| 145 | + for symbol in "${non_kabi[@]}"; do |
| 146 | + printf "\t$symbol\n" >&2 |
| 147 | + done |
| 148 | + echo "" >&2 |
| 149 | + echo "Red Hat recommends that you consider using only official kernel ABI symbols" >&2 |
| 150 | + echo "where possible. Requests for additions to the kernel ABI can be filed with" >&2 |
| 151 | + echo "your partner or customer representative (component: driver-update-program)." >&2 |
| 152 | + echo "" >&2 |
| 153 | + fi |
| 154 | +} |
| 155 | + |
| 156 | +modules=($(grep -E '/lib/modules/.+\.ko(\.gz|\.bz2|\.xz|\.zst)?$') "$@") |
| 157 | +if [ ${#modules[@]} -gt 0 ]; then |
| 158 | + kernel=$(/sbin/modinfo -F vermagic "${modules[0]}" | sed -e 's: .*::' -e q) |
| 159 | + |
| 160 | + # get all that kernel provides |
| 161 | + symvers=$(mktemp -t ${0##*/}.XXXXX) |
| 162 | + |
| 163 | + cat /usr/src/kernels/$kernel/Module.symvers | awk ' |
| 164 | + BEGIN { FS = "\t" ; OFS = "\t" } |
| 165 | + { print $2 ":" $1 } |
| 166 | + ' \ |
| 167 | + | sed -r -e 's:$:\t'"$kernel"':' \ |
| 168 | + | sort -k1,1 -u > $symvers |
| 169 | + |
| 170 | + # Symbols matching with the kernel get a "kernel" dependency |
| 171 | + mod_req=$(mktemp -t mod_req.XXXXX) |
| 172 | + mod_requires "${modules[@]}" > "$mod_req" |
| 173 | + join -t $'\t' -j 1 $symvers "$mod_req" | sort -u \ |
| 174 | + | awk 'BEGIN { FS = "[\t:]" ; OFS = "\t" } { print "kernel(" $1 ") = " $2 }' |
| 175 | + |
| 176 | + # Symbols from elsewhere get a "ksym" dependency |
| 177 | + join -t $'\t' -j 1 -v 2 $symvers "$mod_req" | sort -u \ |
| 178 | + | awk 'BEGIN { FS = "[\t:]" ; OFS = "\t" } { print "ksym(" $1 ") = " $2 }' |
| 179 | + |
| 180 | + os_id=$(sed -nr '/^ID[[:space:]]*=/{ s/ID[[:space:]]*=[[:space:]]*//; s/^"(.*)"$/\1/; p }' /etc/os-release) |
| 181 | + if [ "rhel" = "$os_id" ]; then |
| 182 | + # Check kABI if the kabi-stablelists package is installed |
| 183 | + # Do this last so we can try to output this error at the end |
| 184 | + kabi_check_symbols=($(join -t $'\t' -j 1 $symvers "$mod_req" | sort -u \ |
| 185 | + | awk 'BEGIN { FS = "[\t:]" ; OFS = "\t" } { print $1 }')) |
| 186 | + check_kabi "${kabi_check_symbols[@]}" |
| 187 | + fi |
| 188 | +fi |
0 commit comments