/[gentoo-x86]/eclass/linux-info.eclass
Gentoo

Diff of /eclass/linux-info.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.3 Revision 1.58
1# Copyright 1999-2004 Gentoo Foundation 1# Copyright 1999-2006 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/linux-info.eclass,v 1.3 2004/11/27 11:26:52 johnm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/linux-info.eclass,v 1.58 2009/01/12 23:04:54 maekke Exp $
4# 4#
5# This eclass provides functions for querying the installed kernel 5# Original author: John Mylchreest <johnm@gentoo.org>
6# source version, selected kernel options etc. 6# Maintainer: kernel-misc@gentoo.org
7# 7#
8# Please direct your bugs to the current eclass maintainer :)
8 9
9ECLASS=linux-info 10# @ECLASS: linux-info.eclass
10INHERITED="$INHERITED $ECLASS" 11# @MAINTAINER:
12# kernel-misc@gentoo.org
13# @BLURB: eclass used for accessing kernel related information
14# @DESCRIPTION:
15# This eclass is used as a central eclass for accessing kernel
16# related information for sources already installed.
17# It is vital for linux-mod.eclass to function correctly, and is split
18# out so that any ebuild behaviour "templates" are abstracted out
19# using additional eclasses.
20
21# A Couple of env vars are available to effect usage of this eclass
22# These are as follows:
23
24# @ECLASS-VARIABLE: KERNEL_DIR
25# @DESCRIPTION:
26# A string containing the directory of the target kernel sources. The default value is
27# "/usr/src/linux"
28
29# @ECLASS-VARIABLE: CONFIG_CHECK
30# @DESCRIPTION:
31# A string containing a list of .config options to check for before
32# proceeding with the install.
33#
34# e.g.: CONFIG_CHECK="MTRR"
35#
36# You can also check that an option doesn't exist by
37# prepending it with an exclamation mark (!).
38#
39# e.g.: CONFIG_CHECK="!MTRR"
40#
41# To simply warn about a missing option, prepend a '~'.
42
43# @ECLASS-VARIABLE: ERROR_<CFG>
44# @DESCRIPTION:
45# A string containing the error message to display when the check against CONFIG_CHECK
46# fails. <CFG> should reference the appropriate option used in CONFIG_CHECK.
47#
48# e.g.: ERROR_MTRR="MTRR exists in the .config but shouldn't!!"
49
50# @ECLASS-VARIABLE: KBUILD_OUTPUT
51# @DESCRIPTION:
52# A string passed on commandline, or set from the kernel makefile. It contains the directory
53# which is to be used as the kernel object directory.
54
55# There are also a couple of variables which are set by this, and shouldn't be
56# set by hand. These are as follows:
57
58# @ECLASS-VARIABLE: KV_FULL
59# @DESCRIPTION:
60# A read-only variable. It's a string containing the full kernel version. ie: 2.6.9-gentoo-johnm-r1
61
62# @ECLASS-VARIABLE: KV_MAJOR
63# @DESCRIPTION:
64# A read-only variable. It's an integer containing the kernel major version. ie: 2
65
66# @ECLASS-VARIABLE: KV_MINOR
67# @DESCRIPTION:
68# A read-only variable. It's an integer containing the kernel minor version. ie: 6
69
70# @ECLASS-VARIABLE: KV_PATCH
71# @DESCRIPTION:
72# A read-only variable. It's an integer containing the kernel patch version. ie: 9
73
74# @ECLASS-VARIABLE: KV_EXTRA
75# @DESCRIPTION:
76# A read-only variable. It's a string containing the kernel EXTRAVERSION. ie: -gentoo
77
78# @ECLASS-VARIABLE: KV_LOCAL
79# @DESCRIPTION:
80# A read-only variable. It's a string containing the kernel LOCALVERSION concatenation. ie: -johnm
81
82# @ECLASS-VARIABLE: KV_DIR
83# @DESCRIPTION:
84# A read-only variable. It's a string containing the kernel source directory, will be null if
85# KERNEL_DIR is invalid.
86
87# @ECLASS-VARIABLE: KV_OUT_DIR
88# @DESCRIPTION:
89# A read-only variable. It's a string containing the kernel object directory, will be KV_DIR unless
90# KBUILD_OUTPUT is used. This should be used for referencing .config.
91
92# And to ensure all the weirdness with crosscompile
93inherit toolchain-funcs versionator
94
95EXPORT_FUNCTIONS pkg_setup
96
97DEPEND="kernel_linux? ( virtual/linux-sources )"
98RDEPEND=""
11 99
12# Overwritable environment Var's 100# Overwritable environment Var's
13# --------------------------------------- 101# ---------------------------------------
14KERNEL_DIR="${KERNEL_DIR:-/usr/src/linux}" 102KERNEL_DIR="${KERNEL_DIR:-${ROOT}usr/src/linux}"
15 103
16 104
105# Bug fixes
106# fix to bug #75034
107case ${ARCH} in
108 ppc) BUILD_FIXES="${BUILD_FIXES} TOUT=${T}/.tmp_gas_check";;
109 ppc64) BUILD_FIXES="${BUILD_FIXES} TOUT=${T}/.tmp_gas_check";;
110esac
111
112# @FUNCTION: set_arch_to_kernel
113# @DESCRIPTION:
114# Set the env ARCH to match what the kernel expects.
115set_arch_to_kernel() { export ARCH=$(tc-arch-kernel); }
116# @FUNCTION: set_arch_to_portage
117# @DESCRIPTION:
118# Set the env ARCH to match what portage expects.
119set_arch_to_portage() { export ARCH=$(tc-arch); }
120
121# qeinfo "Message"
122# -------------------
123# qeinfo is a quiet einfo call when EBUILD_PHASE
124# should not have visible output.
125qout() {
126 local outputmsg type
127 type=${1}
128 shift
129 outputmsg="${@}"
130 case "${EBUILD_PHASE}" in
131 depend) unset outputmsg;;
132 clean) unset outputmsg;;
133 preinst) unset outputmsg;;
134 esac
135 [ -n "${outputmsg}" ] && ${type} "${outputmsg}"
136}
137
138qeinfo() { qout einfo "${@}" ; }
139qeerror() { qout eerror "${@}" ; }
17 140
18# File Functions 141# File Functions
19# --------------------------------------- 142# ---------------------------------------
20 143
21# getfilevar accepts 2 vars as follows: 144# @FUNCTION: getfilevar
22# getfilevar <VARIABLE> <CONFIGFILE> 145# @USAGE: variable configfile
23 146# @RETURN: the value of the variable
147# @DESCRIPTION:
148# It detects the value of the variable defined in the file configfile
24getfilevar() { 149getfilevar() {
25local ERROR 150local ERROR basefname basedname myARCH="${ARCH}"
26 ERROR=0 151 ERROR=0
27 152
28 [ -z "${1}" ] && ERROR=1 153 [ -z "${1}" ] && ERROR=1
29 [ -z "${2}" ] && ERROR=1
30 [ ! -f "${2}" ] && ERROR=1 154 [ ! -f "${2}" ] && ERROR=1
31 155
32 if [ "${ERROR}" = 1 ] 156 if [ "${ERROR}" = 1 ]
33 then 157 then
158 echo -e "\n"
34 eerror "getfilevar requires 2 variables, with the second a valid file." 159 eerror "getfilevar requires 2 variables, with the second a valid file."
35 eerror " getfilevar <VARIABLE> <CONFIGFILE>" 160 eerror " getfilevar <VARIABLE> <CONFIGFILE>"
36 else 161 else
37 grep -e "^$1[= ]" $2 | sed 's: = :=:' | cut -d= -f2- 162 basefname="$(basename ${2})"
38 fi 163 basedname="$(dirname ${2})"
39} 164 unset ARCH
40 165
41getfilevar_isset() { 166 echo -e "e:\\n\\t@echo \$(${1})\\ninclude ${basefname}" | \
167 make -C "${basedname}" M="${S}" ${BUILD_FIXES} -s -f - 2>/dev/null
168
169 ARCH=${myARCH}
170 fi
171}
172
173
174# @FUNCTION: linux_config_exists
175# @RETURN: true or false
176# @DESCRIPTION:
177# It returns true if .config exists otherwise false
178linux_config_exists() {
179 [ -s "${KV_OUT_DIR}/.config" ]
180}
181
182# @FUNCTION: require_configured_kernel
183# @DESCRIPTION:
184# This function verifies that the current kernel is configured (it checks against the existence of .config)
185# otherwise it dies.
186require_configured_kernel() {
187 if ! linux_config_exists; then
188 qeerror "Could not find a usable .config in the kernel source directory."
189 qeerror "Please ensure that ${KERNEL_DIR} points to a configured set of Linux sources."
190 qeerror "If you are using KBUILD_OUTPUT, please set the environment var so that"
191 qeerror "it points to the necessary object directory so that it might find .config."
192 die "Kernel not configured; no .config found in ${KV_OUT_DIR}"
193 fi
194}
195
196# @FUNCTION: linux_chkconfig_present
197# @USAGE: option
198# @RETURN: true or false
199# @DESCRIPTION:
200# It checks that CONFIG_<option>=y or CONFIG_<option>=n is present in the current kernel .config
201linux_chkconfig_present() {
42local RESULT 202local RESULT
43 RESULT="$(getfilevar ${1} ${2})" 203 require_configured_kernel
204 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
44 [ "${RESULT}" = "m" -o "${RESULT}" = "y" ] && return 0 || return 1 205 [ "${RESULT}" = "m" -o "${RESULT}" = "y" ] && return 0 || return 1
45} 206}
46 207
47getfilevar_ismodule() { 208# @FUNCTION: linux_chkconfig_module
209# @USAGE: option
210# @RETURN: true or false
211# @DESCRIPTION:
212# It checks that CONFIG_<option>=m is present in the current kernel .config
213linux_chkconfig_module() {
48local RESULT 214local RESULT
49 RESULT="$(getfilevar ${1} ${2})" 215 require_configured_kernel
216 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
50 [ "${RESULT}" = "m" ] && return 0 || return 1 217 [ "${RESULT}" = "m" ] && return 0 || return 1
51} 218}
52 219
53getfilevar_isbuiltin() { 220# @FUNCTION: linux_chkconfig_builtin
221# @USAGE: option
222# @RETURN: true or false
223# @DESCRIPTION:
224# It checks that CONFIG_<option>=y is present in the current kernel .config
225linux_chkconfig_builtin() {
54local RESULT 226local RESULT
55 RESULT="$(getfilevar ${1} ${2})" 227 require_configured_kernel
228 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
56 [ "${RESULT}" = "y" ] && return 0 || return 1 229 [ "${RESULT}" = "y" ] && return 0 || return 1
230}
231
232# @FUNCTION: linux_chkconfig_string
233# @USAGE: option
234# @RETURN: CONFIG_<option>
235# @DESCRIPTION:
236# It prints the CONFIG_<option> value of the current kernel .config (it requires a configured kernel).
237linux_chkconfig_string() {
238 require_configured_kernel
239 getfilevar "CONFIG_${1}" "${KV_OUT_DIR}/.config"
57} 240}
58 241
59# Versioning Functions 242# Versioning Functions
60# --------------------------------------- 243# ---------------------------------------
61 244
62# kernel_is returns true when the version is the same as the passed version 245# @FUNCTION: kernel_is
246# @USAGE: [-lt -gt -le -ge -eq] major_number [minor_number patch_number]
247# @RETURN: true or false
248# @DESCRIPTION:
249# It returns true when the current kernel version satisfies the comparison against the passed version.
250# -eq is the default comparison.
63# 251#
252# @CODE
64# For Example where KV = 2.6.9 253# For Example where KV = 2.6.9
65# kernel_is 2 4 returns false 254# kernel_is 2 4 returns false
66# kernel_is 2 returns true 255# kernel_is 2 returns true
67# kernel_is 2 6 returns true 256# kernel_is 2 6 returns true
68# kernel_is 2 6 8 returns false 257# kernel_is 2 6 8 returns false
69# kernel_is 2 6 9 returns true 258# kernel_is 2 6 9 returns true
70# 259# @CODE
260
71# got the jist yet? 261# got the jist yet?
72 262
73kernel_is() { 263kernel_is() {
74 # if we haven't determined the version yet, we need too. 264 # if we haven't determined the version yet, we need to.
75 get_version; 265 get_version
76 266 local operator test value x=0 y=0 z=0
77 local RESULT
78 RESULT=1
79
80 if [ -n "${1}" ]
81 then
82 [ "${1}" = "${KV_MAJOR}" ] && RESULT=0
83 fi
84
85 if [ -n "${2}" ]
86 then
87 RESULT=1
88 [ "${2}" = "${KV_MINOR}" ] && RESULT=0
89 fi
90
91 if [ -n "${3}" ]
92 then
93 RESULT=1
94 [ "${3}" = "${KV_PATCH}" ] && RESULT=0
95 fi
96 return ${RESULT}
97}
98 267
268 case ${1} in
269 lt) operator="-lt"; shift;;
270 gt) operator="-gt"; shift;;
271 le) operator="-le"; shift;;
272 ge) operator="-ge"; shift;;
273 eq) operator="-eq"; shift;;
274 *) operator="-eq";;
275 esac
276
277 for x in ${@}; do
278 for((y=0; y<$((3 - ${#x})); y++)); do value="${value}0"; done
279 value="${value}${x}"
280 z=$((${z} + 1))
281
282 case ${z} in
283 1) for((y=0; y<$((3 - ${#KV_MAJOR})); y++)); do test="${test}0"; done;
284 test="${test}${KV_MAJOR}";;
285 2) for((y=0; y<$((3 - ${#KV_MINOR})); y++)); do test="${test}0"; done;
286 test="${test}${KV_MINOR}";;
287 3) for((y=0; y<$((3 - ${#KV_PATCH})); y++)); do test="${test}0"; done;
288 test="${test}${KV_PATCH}";;
289 *) die "Error in kernel-2_kernel_is(): Too many parameters.";;
290 esac
291 done
292
293 [ ${test} ${operator} ${value} ] && return 0 || return 1
294}
295
296get_localversion() {
297 local lv_list i x
298
299 # ignore files with ~ in it.
300 for i in $(ls ${1}/localversion* 2>/dev/null); do
301 [[ -n ${i//*~*} ]] && lv_list="${lv_list} ${i}"
302 done
303
304 for i in ${lv_list}; do
305 x="${x}$(<${i})"
306 done
307 x=${x/ /}
308 echo ${x}
309}
310
311# @FUNCTION: get_version
312# @DESCRIPTION:
313# It gets the version of the kernel inside KERNEL_DIR and populates the KV_FULL variable
314# (if KV_FULL is already set it does nothing).
315#
316# The kernel version variables (KV_MAJOR, KV_MINOR, KV_PATCH, KV_EXTRA and KV_LOCAL) are also set.
317#
318# The KV_DIR is set using the KERNEL_DIR env var, the KV_DIR_OUT is set using a valid
319# KBUILD_OUTPUT (in a decreasing priority list, we look for the env var, makefile var or the
320# symlink /lib/modules/${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}${KV_EXTRA}/build).
99get_version() { 321get_version() {
322 local kbuild_output
323
100 # no need to execute this twice assuming KV_FULL is populated. 324 # no need to execute this twice assuming KV_FULL is populated.
101 # we can force by unsetting KV_FULL 325 # we can force by unsetting KV_FULL
102 if [ -n "${KV_FULL}" ] 326 [ -n "${KV_FULL}" ] && return 0
103 then
104 # Lets keep this quiet eh?
105 # einfo "\${KV_FULL} is already set. Not running get_version again"
106 return
107 fi
108 327
109 # if we dont know KV_FULL, then we need too. 328 # if we dont know KV_FULL, then we need too.
110 # make sure KV_DIR isnt set since we need to work it out via KERNEL_DIR 329 # make sure KV_DIR isnt set since we need to work it out via KERNEL_DIR
111 unset KV_DIR 330 unset KV_DIR
112 331
113 # KV_DIR will contain the full path to the sources directory we should use 332 # KV_DIR will contain the full path to the sources directory we should use
114 einfo "Determining the location of the kernel source code" 333 qeinfo "Determining the location of the kernel source code"
115 [ -h "${KERNEL_DIR}" ] && KV_DIR="$(readlink -f ${KERNEL_DIR})" 334 [ -h "${KERNEL_DIR}" ] && KV_DIR="$(readlink -f ${KERNEL_DIR})"
116 [ -d "${KERNEL_DIR}" ] && KV_DIR="${KERNEL_DIR}" 335 [ -d "${KERNEL_DIR}" ] && KV_DIR="${KERNEL_DIR}"
117 336
118 if [ -z "${KV_DIR}" ] 337 if [ -z "${KV_DIR}" ]
119 then 338 then
120 eerror "Unable to find kernel sources at ${KERNEL_DIR}" 339 qeerror "Unable to find kernel sources at ${KERNEL_DIR}"
121 die 340 qeinfo "This package requires Linux sources."
341 if [ "${KERNEL_DIR}" == "/usr/src/linux" ] ; then
342 qeinfo "Please make sure that ${KERNEL_DIR} points at your running kernel, "
343 qeinfo "(or the kernel you wish to build against)."
344 qeinfo "Alternatively, set the KERNEL_DIR environment variable to the kernel sources location"
345 else
346 qeinfo "Please ensure that the KERNEL_DIR environment variable points at full Linux sources of the kernel you wish to compile against."
122 fi 347 fi
123 348 return 1
349 fi
350
351 qeinfo "Found kernel source directory:"
352 qeinfo " ${KV_DIR}"
353
354 if [ ! -s "${KV_DIR}/Makefile" ]
355 then
356 qeerror "Could not find a Makefile in the kernel source directory."
357 qeerror "Please ensure that ${KERNEL_DIR} points to a complete set of Linux sources"
358 return 1
359 fi
360
361 # OK so now we know our sources directory, but they might be using
362 # KBUILD_OUTPUT, and we need this for .config and localversions-*
363 # so we better find it eh?
364 # do we pass KBUILD_OUTPUT on the CLI?
365 OUTPUT_DIR="${OUTPUT_DIR:-${KBUILD_OUTPUT}}"
366
367 # And if we didn't pass it, we can take a nosey in the Makefile
368 kbuild_output="$(getfilevar KBUILD_OUTPUT ${KV_DIR}/Makefile)"
369 OUTPUT_DIR="${OUTPUT_DIR:-${kbuild_output}}"
370
124 # And contrary to existing functions I feel we shouldn't trust the 371 # And contrary to existing functions I feel we shouldn't trust the
125 # directory name to find version information as this seems insane. 372 # directory name to find version information as this seems insane.
126 # so we parse ${KV_DIR}/Makefile 373 # so we parse ${KV_DIR}/Makefile
127 KV_MAJOR="$(getfilevar VERSION ${KV_DIR}/Makefile)" 374 KV_MAJOR="$(getfilevar VERSION ${KV_DIR}/Makefile)"
128 KV_MINOR="$(getfilevar PATCHLEVEL ${KV_DIR}/Makefile)" 375 KV_MINOR="$(getfilevar PATCHLEVEL ${KV_DIR}/Makefile)"
129 KV_PATCH="$(getfilevar SUBLEVEL ${KV_DIR}/Makefile)" 376 KV_PATCH="$(getfilevar SUBLEVEL ${KV_DIR}/Makefile)"
130 KV_EXTRA="$(getfilevar EXTRAVERSION ${KV_DIR}/Makefile)" 377 KV_EXTRA="$(getfilevar EXTRAVERSION ${KV_DIR}/Makefile)"
378
379 if [ -z "${KV_MAJOR}" -o -z "${KV_MINOR}" -o -z "${KV_PATCH}" ]
380 then
381 qeerror "Could not detect kernel version."
382 qeerror "Please ensure that ${KERNEL_DIR} points to a complete set of Linux sources."
383 return 1
384 fi
385
131 # and in newer versions we can also pull LOCALVERSION if it is set. 386 # and in newer versions we can also pull LOCALVERSION if it is set.
132 KV_LOCAL="$(cat ${KV_DIR}/localversion* 2>/dev/null)$(getfilevar CONFIG_LOCALVERSION ${KV_DIR}/.config | sed 's:"::g')" 387 # but before we do this, we need to find if we use a different object directory.
133 388 # This *WILL* break if the user is using localversions, but we assume it was
389 # caught before this if they are.
390 [ "${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}${KV_EXTRA}" == "$(uname -r)" ] && \
391 OUTPUT_DIR="${OUTPUT_DIR:-/lib/modules/${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}${KV_EXTRA}/build}"
392
393 [ -h "${OUTPUT_DIR}" ] && KV_OUT_DIR="$(readlink -f ${OUTPUT_DIR})"
394 [ -d "${OUTPUT_DIR}" ] && KV_OUT_DIR="${OUTPUT_DIR}"
395 if [ -n "${KV_OUT_DIR}" ];
396 then
397 qeinfo "Found kernel object directory:"
398 qeinfo " ${KV_OUT_DIR}"
399
400 KV_LOCAL="$(get_localversion ${KV_OUT_DIR})"
401 fi
402 # and if we STILL have not got it, then we better just set it to KV_DIR
403 KV_OUT_DIR="${KV_OUT_DIR:-${KV_DIR}}"
404
405 KV_LOCAL="${KV_LOCAL}$(get_localversion ${KV_DIR})"
406 if linux_config_exists; then
407 KV_LOCAL="${KV_LOCAL}$(linux_chkconfig_string LOCALVERSION)"
408 KV_LOCAL="${KV_LOCAL//\"/}"
409
410 # For things like git that can append extra stuff:
411 [ -e ${KV_DIR}/scripts/setlocalversion ] &&
412 linux_chkconfig_builtin LOCALVERSION_AUTO &&
413 KV_LOCAL="${KV_LOCAL}$(sh ${KV_DIR}/scripts/setlocalversion ${KV_DIR})"
414 fi
415
134 # And we should set KV_FULL to the full expanded version 416 # And we should set KV_FULL to the full expanded version
135 KV_FULL="${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}${KV_EXTRA}${KV_LOCAL}" 417 KV_FULL="${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}${KV_EXTRA}${KV_LOCAL}"
136 418
137 if [ -z "${KV_FULL}" ] 419 qeinfo "Found sources for kernel version:"
138 then 420 qeinfo " ${KV_FULL}"
139 eerror "We are unable to find a usable kernel source tree in ${KV_DIR}" 421
140 eerror "Please check a kernel source exists in this directory." 422 return 0
141 die 423}
424
425# @FUNCTION: get_running_version
426# @DESCRIPTION:
427# It gets the version of the current running kernel and the result is the same as get_version() if the
428# function can find the sources.
429get_running_version() {
430 KV_FULL=$(uname -r)
431
432 if [[ -f ${ROOT}/lib/modules/${KV_FULL}/source/Makefile ]]; then
433 KERNEL_DIR=$(readlink -f ${ROOT}/lib/modules/${KV_FULL}/source)
434 unset KV_FULL
435 get_version
436 return $?
437 elif [[ -f ${ROOT}/lib/modules/${KV_FULL}/build/Makefile ]]; then
438 KERNEL_DIR=$(readlink -f ${ROOT}/lib/modules/${KV_FULL}/build)
439 unset KV_FULL
440 get_version
441 return $?
142 else 442 else
143 einfo "Found kernel source directory:" 443 KV_MAJOR=$(get_version_component_range 1 ${KV_FULL})
144 einfo " ${KV_DIR}" 444 KV_MINOR=$(get_version_component_range 2 ${KV_FULL})
145 einfo "with sources for kernel version:" 445 KV_PATCH=$(get_version_component_range 3- ${KV_FULL})
146 einfo " ${KV_FULL}" 446 KV_PATCH=${KV_PATCH//-*}
447 [[ -n ${KV_FULL#*-} ]] && [[ -n ${KV_FULL//${KV_FULL#*-}} ]] \
448 && KV_EXTRA="-${KV_FULL#*-}"
147 fi 449 fi
450 return 0
148} 451}
149
150
151 452
152 453
153# ebuild check functions 454# ebuild check functions
154# --------------------------------------- 455# ---------------------------------------
155 456
457# @FUNCTION: check_kernel_built
458# @DESCRIPTION:
459# This function verifies that the current kernel sources have been already prepared otherwise it dies.
156check_kernel_built() { 460check_kernel_built() {
157 # if we haven't determined the version yet, we need too. 461 # if we haven't determined the version yet, we need to
462 require_configured_kernel
158 get_version; 463 get_version
159 464
160 if [ ! -f "${KV_DIR}/System.map" ] 465 if [ ! -f "${KV_OUT_DIR}/include/linux/version.h" ]
161 then 466 then
162 eerror "These sources have not yet been compiled." 467 eerror "These sources have not yet been prepared."
163 eerror "We cannot build against an uncompiled tree." 468 eerror "We cannot build against an unprepared tree."
164 eerror "To resolve this, please type the following:" 469 eerror "To resolve this, please type the following:"
165 eerror 470 eerror
166 eerror "# cd ${KV_DIR}" 471 eerror "# cd ${KV_DIR}"
167 eerror "# make oldconfig" 472 eerror "# make oldconfig"
168 eerror "# make bzImage modules modules_install" 473 eerror "# make modules_prepare"
169 eerror 474 eerror
170 eerror "Then please try merging this module again." 475 eerror "Then please try merging this module again."
171 die "Kernel sources need compiling first" 476 die "Kernel sources need compiling first"
172 fi 477 fi
173} 478}
174 479
480# @FUNCTION: check_modules_supported
481# @DESCRIPTION:
482# This function verifies that the current kernel support modules (it checks CONFIG_MODULES=y) otherwise it dies.
175check_modules_supported() { 483check_modules_supported() {
176 # if we haven't determined the version yet, we need too. 484 # if we haven't determined the version yet, we need too.
485 require_configured_kernel
177 get_version; 486 get_version
178 487
179 getfilevar_isset CONFIG_MODULES ${KV_DIR}/.config 488 if ! linux_chkconfig_builtin "MODULES"
180 if [ "$?" != 0 ]
181 then 489 then
182 eerror "These sources do not support loading external modules." 490 eerror "These sources do not support loading external modules."
183 eerror "to be able to use this module please enable \"Loadable modules support\"" 491 eerror "to be able to use this module please enable \"Loadable modules support\""
184 eerror "in your kernel, recompile and then try merging this module again." 492 eerror "in your kernel, recompile and then try merging this module again."
185 die No support for external modules in ${KV_FUll} config 493 die "No support for external modules in ${KV_FULL} config"
186 fi 494 fi
187} 495}
188 496
497# @FUNCTION: check_extra_config
498# @DESCRIPTION:
499# It checks the kernel config options specified by CONFIG_CHECK. It dies only when a required config option (i.e.
500# the prefix ~ is not used) doesn't satisfy the directive.
189check_extra_config() { 501check_extra_config() {
190local config negate error 502 local config negate die error reworkmodulenames
503 local soft_errors_count=0 hard_errors_count=0 config_required=0
191 504
192 # if we haven't determined the version yet, we need too. 505 # if we haven't determined the version yet, we need to
193 get_version; 506 get_version
194 507
195 einfo "Checking for suitable kernel configuration options" 508 # Determine if we really need a .config. The only time when we don't need
509 # one is when all of the CONFIG_CHECK options are prefixed with "~".
196 for config in ${CONFIG_CHECK} 510 for config in ${CONFIG_CHECK}
197 do 511 do
198 negate="${config:0:1}" 512 if [[ "${config:0:1}" != "~" ]]; then
199 if [ "${negate}" == "!" ]; 513 config_required=1
200 then 514 break
515 fi
516 done
517
518 if [[ ${config_required} == 0 ]]; then
519 # In the case where we don't require a .config, we can now bail out
520 # if the user has no .config as there is nothing to do. Otherwise
521 # code later will cause a failure due to missing .config.
522 if ! linux_config_exists; then
523 return 0
524 fi
525 else
526 require_configured_kernel
527 fi
528
529 einfo "Checking for suitable kernel configuration options..."
530
531 for config in ${CONFIG_CHECK}
532 do
533 # if we specify any fatal, ensure we honor them
534 die=1
535 error=0
536 negate=0
537 reworkmodulenames=0
538
539 if [[ ${config:0:1} == "~" ]]; then
540 die=0
201 config="${config:1}" 541 config=${config:1}
202 if getfilevar_isset ${config} ${KV_DIR}/.config ; 542 elif [[ ${config:0:1} == "@" ]]; then
203 then 543 die=0
204 eerror " ${config}:\tshould not be set in the kernel configuration, but it is." 544 reworkmodulenames=1
545 config=${config:1}
546 fi
547 if [[ ${config:0:1} == "!" ]]; then
548 negate=1
549 config=${config:1}
550 fi
551
552 if [[ ${negate} == 1 ]]; then
553 linux_chkconfig_present ${config} && error=2
554 elif [[ ${reworkmodulenames} == 1 ]]; then
555 local temp_config="${config//*:}" i n
556 config="${config//:*}"
557 if linux_chkconfig_present ${config}; then
558 for i in ${MODULE_NAMES}; do
559 n="${i//${temp_config}}"
560 [[ -z ${n//\(*} ]] && \
561 MODULE_IGNORE="${MODULE_IGNORE} ${temp_config}"
562 done
205 error=1 563 error=2
206 fi 564 fi
207 else 565 else
208 if ! getfilevar_isset ${config} ${KV_DIR}/.config ; 566 linux_chkconfig_present ${config} || error=1
209 then 567 fi
210 eerror " ${config}:\tshould be set in the kernel configuration, but isn't" 568
211 error=1 569 if [[ ${error} > 0 ]]; then
570 local report_func="eerror" local_error
571 local_error="ERROR_${config}"
572 local_error="${!local_error}"
573
574 if [[ -z "${local_error}" ]]; then
575 # using old, deprecated format.
576 local_error="${config}_ERROR"
577 local_error="${!local_error}"
212 fi 578 fi
579 if [[ ${die} == 0 && -z "${local_error}" ]]; then
580 #soft errors can be warnings
581 local_error="WARNING_${config}"
582 local_error="${!local_error}"
583 if [[ -n "${local_error}" ]] ; then
584 report_func="ewarn"
585 fi
586 fi
587
588 if [[ -z "${local_error}" ]]; then
589 [[ ${error} == 1 ]] \
590 && local_error="is not set when it should be." \
591 || local_error="should not be set. But it is."
592 local_error="CONFIG_${config}:\t ${local_error}"
593 fi
594 if [[ ${die} == 0 ]]; then
595 ${report_func} " ${local_error}"
596 soft_errors_count=$[soft_errors_count + 1]
597 else
598 ${report_func} " ${local_error}"
599 hard_errors_count=$[hard_errors_count + 1]
600 fi
213 fi 601 fi
214 done 602 done
215 603
216 if [ -n "${error}" ] ; 604 if [[ ${hard_errors_count} > 0 ]]; then
217 then
218 eerror "Please check to make sure these options are set correctly." 605 eerror "Please check to make sure these options are set correctly."
606 eerror "Failure to do so may cause unexpected problems."
219 eerror "Once you have satisfied these options, please try merging" 607 eerror "Once you have satisfied these options, please try merging"
220 eerror "this package again." 608 eerror "this package again."
221 die Incorrect kernel configuration options 609 die "Incorrect kernel configuration options"
610 elif [[ ${soft_errors_count} > 0 ]]; then
611 ewarn "Please check to make sure these options are set correctly."
612 ewarn "Failure to do so may cause unexpected problems."
613 else
614 eend 0
222 fi 615 fi
223} 616}
224 617
225check_zlibinflate() { 618check_zlibinflate() {
226 # if we haven't determined the version yet, we need too. 619 # if we haven't determined the version yet, we need to
620 require_configured_kernel
227 get_version; 621 get_version
228 622
229 # although I restructured this code - I really really really dont support it! 623 # although I restructured this code - I really really really dont support it!
230 624
231 # bug #27882 - zlib routines are only linked into the kernel 625 # bug #27882 - zlib routines are only linked into the kernel
232 # if something compiled into the kernel calls them 626 # if something compiled into the kernel calls them
233 # 627 #
234 # plus, for the cloop module, it appears that there's no way 628 # plus, for the cloop module, it appears that there's no way
235 # to get cloop.o to include a static zlib if CONFIG_MODVERSIONS 629 # to get cloop.o to include a static zlib if CONFIG_MODVERSIONS
236 # is on 630 # is on
237 631
238local INFLATE 632 local INFLATE
239local DEFLATE 633 local DEFLATE
240 634
241 einfo "Determining the usability of ZLIB_INFLATE support in your kernel" 635 einfo "Determining the usability of ZLIB_INFLATE support in your kernel"
242 636
243 ebegin "checking ZLIB_INFLATE" 637 ebegin "checking ZLIB_INFLATE"
244 getfilevar_isbuiltin CONFIG_ZLIB_INFLATE ${KV_DIR}/.config 638 getfilevar_isbuiltin CONFIG_ZLIB_INFLATE ${KV_DIR}/.config
245 eend $? 639 eend $?
246 [ "$?" != 0 ] && die 640 [ "$?" != 0 ] && die
247 641
248 ebegin "checking ZLIB_DEFLATE" 642 ebegin "checking ZLIB_DEFLATE"
249 getfilevar_isbuiltin CONFIG_ZLIB_DEFLATE ${KV_DIR}/.config 643 getfilevar_isbuiltin CONFIG_ZLIB_DEFLATE ${KV_DIR}/.config
250 eend $? 644 eend $?
251 [ "$?" != 0 ] && die 645 [ "$?" != 0 ] && die
252 646
253
254 local LINENO_START 647 local LINENO_START
255 local LINENO_END 648 local LINENO_END
256 local SYMBOLS 649 local SYMBOLS
257 local x 650 local x
258 651
259 LINENO_END="$(grep -n 'CONFIG_ZLIB_INFLATE y' ${KV_DIR}/lib/Config.in | cut -d : -f 1)" 652 LINENO_END="$(grep -n 'CONFIG_ZLIB_INFLATE y' ${KV_DIR}/lib/Config.in | cut -d : -f 1)"
260 LINENO_START="$(head -n $LINENO_END ${KV_DIR}/lib/Config.in | grep -n 'if \[' | tail -n 1 | cut -d : -f 1)" 653 LINENO_START="$(head -n $LINENO_END ${KV_DIR}/lib/Config.in | grep -n 'if \[' | tail -n 1 | cut -d : -f 1)"
261 (( LINENO_AMOUNT = $LINENO_END - $LINENO_START )) 654 (( LINENO_AMOUNT = $LINENO_END - $LINENO_START ))
262 (( LINENO_END = $LINENO_END - 1 )) 655 (( LINENO_END = $LINENO_END - 1 ))
263 SYMBOLS="$(head -n $LINENO_END ${KERNEL_DIR}/lib/Config.in | tail -n $LINENO_AMOUNT | sed -e 's/^.*\(CONFIG_[^\" ]*\).*/\1/g;')" 656 SYMBOLS="$(head -n $LINENO_END ${KV_DIR}/lib/Config.in | tail -n $LINENO_AMOUNT | sed -e 's/^.*\(CONFIG_[^\" ]*\).*/\1/g;')"
264 657
265 # okay, now we have a list of symbols 658 # okay, now we have a list of symbols
266 # we need to check each one in turn, to see whether it is set or not 659 # we need to check each one in turn, to see whether it is set or not
267 for x in $SYMBOLS ; do 660 for x in $SYMBOLS ; do
268 if [ "${!x}" = "y" ]; then 661 if [ "${!x}" = "y" ]; then
269 # we have a winner! 662 # we have a winner!
270 einfo "${x} ensures zlib is linked into your kernel - excellent" 663 einfo "${x} ensures zlib is linked into your kernel - excellent"
271 return 0 664 return 0
272 fi 665 fi
273 done 666 done
274 667
275 eerror 668 eerror
276 eerror "This kernel module requires ZLIB library support." 669 eerror "This kernel module requires ZLIB library support."
277 eerror "You have enabled zlib support in your kernel, but haven't enabled" 670 eerror "You have enabled zlib support in your kernel, but haven't enabled"
278 eerror "enabled any option that will ensure that zlib is linked into your" 671 eerror "enabled any option that will ensure that zlib is linked into your"
279 eerror "kernel." 672 eerror "kernel."
… …
289 eerror "Please remember to recompile and install your kernel, and reboot" 682 eerror "Please remember to recompile and install your kernel, and reboot"
290 eerror "into your new kernel before attempting to load this kernel module." 683 eerror "into your new kernel before attempting to load this kernel module."
291 684
292 die "Kernel doesn't include zlib support" 685 die "Kernel doesn't include zlib support"
293} 686}
687
688################################
689# Default pkg_setup
690# Also used when inheriting linux-mod to force a get_version call
691# @FUNCTION: linux-info_pkg_setup
692# @DESCRIPTION:
693# Force a get_version() call when inherited from linux-mod.eclass and then check if the kernel is configured
694# to support the options specified in CONFIG_CHECK (if not null)
695linux-info_pkg_setup() {
696 get_version || die "Unable to calculate Linux Kernel version"
697
698 if kernel_is 2 4; then
699 if [ "$( gcc-major-version )" -eq "4" ] ; then
700 echo
701 ewarn "Be warned !! >=sys-devel/gcc-4.0.0 isn't supported with"
702 ewarn "linux-2.4 (or modules building against a linux-2.4 kernel)!"
703 echo
704 ewarn "Either switch to another gcc-version (via gcc-config) or use a"
705 ewarn "newer kernel that supports gcc-4."
706 echo
707 ewarn "Also be aware that bugreports about gcc-4 not working"
708 ewarn "with linux-2.4 based ebuilds will be closed as INVALID!"
709 echo
710 epause 10
711 fi
712 fi
713
714 [ -n "${CONFIG_CHECK}" ] && check_extra_config;
715}
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.58
  ViewVC Help
Powered by ViewVC 1.1.13