/[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.6 Revision 1.91
1# Copyright 1999-2004 Gentoo Foundation 1# Copyright 1999-2011 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.6 2004/12/01 23:26:43 johnm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/linux-info.eclass,v 1.91 2011/12/12 22:01:37 vapier Exp $
4#
5# This eclass provides functions for querying the installed kernel
6# source version, selected kernel options etc.
7#
8 4
9ECLASS=linux-info 5# @ECLASS: linux-info.eclass
10INHERITED="$INHERITED $ECLASS" 6# @MAINTAINER:
7# kernel-misc@gentoo.org
8# @AUTHOR:
9# Original author: John Mylchreest <johnm@gentoo.org>
10# @BLURB: eclass used for accessing kernel related information
11# @DESCRIPTION:
12# This eclass is used as a central eclass for accessing kernel
13# related information for source or binary already installed.
14# It is vital for linux-mod.eclass to function correctly, and is split
15# out so that any ebuild behaviour "templates" are abstracted out
16# using additional eclasses.
17#
18# "kernel config" in this file means:
19# The .config of the currently installed sources is used as the first
20# preference, with a fall-back to bundled config (/proc/config.gz) if available.
21
22# A Couple of env vars are available to effect usage of this eclass
23# These are as follows:
24
25# @ECLASS-VARIABLE: KERNEL_DIR
26# @DESCRIPTION:
27# A string containing the directory of the target kernel sources. The default value is
28# "/usr/src/linux"
29
30# @ECLASS-VARIABLE: CONFIG_CHECK
31# @DESCRIPTION:
32# A string containing a list of .config options to check for before
33# proceeding with the install.
34#
35# e.g.: CONFIG_CHECK="MTRR"
36#
37# You can also check that an option doesn't exist by
38# prepending it with an exclamation mark (!).
39#
40# e.g.: CONFIG_CHECK="!MTRR"
41#
42# To simply warn about a missing option, prepend a '~'.
43# It may be combined with '!'.
44#
45# In general, most checks should be non-fatal. The only time fatal checks should
46# be used is for building kernel modules or cases that a compile will fail
47# without the option.
48#
49# This is to allow usage of binary kernels, and minimal systems without kernel
50# sources.
51
52# @ECLASS-VARIABLE: ERROR_<CFG>
53# @DESCRIPTION:
54# A string containing the error message to display when the check against CONFIG_CHECK
55# fails. <CFG> should reference the appropriate option used in CONFIG_CHECK.
56#
57# e.g.: ERROR_MTRR="MTRR exists in the .config but shouldn't!!"
58
59# @ECLASS-VARIABLE: KBUILD_OUTPUT
60# @DESCRIPTION:
61# A string passed on commandline, or set from the kernel makefile. It contains the directory
62# which is to be used as the kernel object directory.
63
64# There are also a couple of variables which are set by this, and shouldn't be
65# set by hand. These are as follows:
66
67# @ECLASS-VARIABLE: KV_FULL
68# @DESCRIPTION:
69# A read-only variable. It's a string containing the full kernel version. ie: 2.6.9-gentoo-johnm-r1
70
71# @ECLASS-VARIABLE: KV_MAJOR
72# @DESCRIPTION:
73# A read-only variable. It's an integer containing the kernel major version. ie: 2
74
75# @ECLASS-VARIABLE: KV_MINOR
76# @DESCRIPTION:
77# A read-only variable. It's an integer containing the kernel minor version. ie: 6
78
79# @ECLASS-VARIABLE: KV_PATCH
80# @DESCRIPTION:
81# A read-only variable. It's an integer containing the kernel patch version. ie: 9
82
83# @ECLASS-VARIABLE: KV_EXTRA
84# @DESCRIPTION:
85# A read-only variable. It's a string containing the kernel EXTRAVERSION. ie: -gentoo
86
87# @ECLASS-VARIABLE: KV_LOCAL
88# @DESCRIPTION:
89# A read-only variable. It's a string containing the kernel LOCALVERSION concatenation. ie: -johnm
90
91# @ECLASS-VARIABLE: KV_DIR
92# @DESCRIPTION:
93# A read-only variable. It's a string containing the kernel source directory, will be null if
94# KERNEL_DIR is invalid.
95
96# @ECLASS-VARIABLE: KV_OUT_DIR
97# @DESCRIPTION:
98# A read-only variable. It's a string containing the kernel object directory, will be KV_DIR unless
99# KBUILD_OUTPUT is used. This should be used for referencing .config.
100
101# And to ensure all the weirdness with crosscompile
102inherit toolchain-funcs versionator
103
104EXPORT_FUNCTIONS pkg_setup
105
106DEPEND=""
107RDEPEND=""
11 108
12# Overwritable environment Var's 109# Overwritable environment Var's
13# --------------------------------------- 110# ---------------------------------------
14KERNEL_DIR="${KERNEL_DIR:-/usr/src/linux}" 111KERNEL_DIR="${KERNEL_DIR:-${ROOT}usr/src/linux}"
112
113
114# Bug fixes
115# fix to bug #75034
116case ${ARCH} in
117 ppc) BUILD_FIXES="${BUILD_FIXES} TOUT=${T}/.tmp_gas_check";;
118 ppc64) BUILD_FIXES="${BUILD_FIXES} TOUT=${T}/.tmp_gas_check";;
119esac
120
121# @FUNCTION: set_arch_to_kernel
122# @DESCRIPTION:
123# Set the env ARCH to match what the kernel expects.
124set_arch_to_kernel() { export ARCH=$(tc-arch-kernel); }
125# @FUNCTION: set_arch_to_portage
126# @DESCRIPTION:
127# Set the env ARCH to match what portage expects.
128set_arch_to_portage() { export ARCH=$(tc-arch); }
129
130# qeinfo "Message"
131# -------------------
132# qeinfo is a quiet einfo call when EBUILD_PHASE
133# should not have visible output.
134qout() {
135 local outputmsg type
136 type=${1}
137 shift
138 outputmsg="${@}"
139 case "${EBUILD_PHASE}" in
140 depend) unset outputmsg;;
141 clean) unset outputmsg;;
142 preinst) unset outputmsg;;
143 esac
144 [ -n "${outputmsg}" ] && ${type} "${outputmsg}"
145}
146
147qeinfo() { qout einfo "${@}" ; }
148qewarn() { qout ewarn "${@}" ; }
149qeerror() { qout eerror "${@}" ; }
15 150
16# File Functions 151# File Functions
17# --------------------------------------- 152# ---------------------------------------
18 153
19# getfilevar accepts 2 vars as follows: 154# @FUNCTION: getfilevar
20# getfilevar <VARIABLE> <CONFIGFILE> 155# @USAGE: variable configfile
21 156# @RETURN: the value of the variable
157# @DESCRIPTION:
158# It detects the value of the variable defined in the file configfile. This is
159# done by including the configfile, and printing the variable with Make.
160# It WILL break if your makefile has missing dependencies!
22getfilevar() { 161getfilevar() {
23local ERROR workingdir basefname basedname arch 162local ERROR basefname basedname myARCH="${ARCH}"
24 ERROR=0 163 ERROR=0
25 164
26 [ -z "${1}" ] && ERROR=1 165 [ -z "${1}" ] && ERROR=1
27 [ ! -f "${2}" ] && ERROR=1 166 [ ! -f "${2}" ] && ERROR=1
28 167
29 if [ "${ERROR}" = 1 ] 168 if [ "${ERROR}" = 1 ]
30 then 169 then
31 ebeep
32 echo -e "\n" 170 echo -e "\n"
33 eerror "getfilevar requires 2 variables, with the second a valid file." 171 eerror "getfilevar requires 2 variables, with the second a valid file."
34 eerror " getfilevar <VARIABLE> <CONFIGFILE>" 172 eerror " getfilevar <VARIABLE> <CONFIGFILE>"
35 else 173 else
36 workingdir=${PWD}
37 basefname=$(basename ${2}) 174 basefname="$(basename ${2})"
38 basedname=$(dirname ${2}) 175 basedname="$(dirname ${2})"
39 arch=${ARCH}
40 unset ARCH 176 unset ARCH
41
42 cd ${basedname}
43 echo -e "include ${basefname}\ne:\n\t@echo \$(${1})" | make -f - e
44 cd ${workingdir}
45
46 ARCH=${arch}
47 fi
48}
49 177
178 echo -e "e:\\n\\t@echo \$(${1})\\ninclude ${basefname}" | \
179 make -C "${basedname}" M="${S}" ${BUILD_FIXES} -s -f - 2>/dev/null
180
181 ARCH=${myARCH}
182 fi
183}
184
185# @FUNCTION: getfilevar_noexec
186# @USAGE: variable configfile
187# @RETURN: the value of the variable
188# @DESCRIPTION:
189# It detects the value of the variable defined in the file configfile.
190# This is done with sed matching an expression only. If the variable is defined,
191# you will run into problems. See getfilevar for those cases.
50getfilevar_isset() { 192getfilevar_noexec() {
193 local ERROR basefname basedname mycat myARCH="${ARCH}"
194 ERROR=0
195 mycat='cat'
196
197 [ -z "${1}" ] && ERROR=1
198 [ ! -f "${2}" ] && ERROR=1
199 [ "${2%.gz}" != "${2}" ] && mycat='zcat'
200
201 if [ "${ERROR}" = 1 ]
202 then
203 echo -e "\n"
204 eerror "getfilevar_noexec requires 2 variables, with the second a valid file."
205 eerror " getfilevar_noexec <VARIABLE> <CONFIGFILE>"
206 else
207 ${mycat} "${2}" | \
208 sed -n \
209 -e "/^[[:space:]]*${1}[[:space:]]*:\\?=[[:space:]]*\(.*\)\$/{
210 s,^[^=]*[[:space:]]*=[[:space:]]*,,g ;
211 s,[[:space:]]*\$,,g ;
212 p
213 }"
214 fi
215}
216
217# @ECLASS-VARIABLE: _LINUX_CONFIG_EXISTS_DONE
218# @INTERNAL
219# @DESCRIPTION:
220# This is only set if one of the linux_config_*exists functions has been called.
221# We use it for a QA warning that the check for a config has not been performed,
222# as linux_chkconfig* in non-legacy mode WILL return an undefined value if no
223# config is available at all.
224_LINUX_CONFIG_EXISTS_DONE=
225
226linux_config_qa_check() {
227 local f="$1"
228 if [ -z "${_LINUX_CONFIG_EXISTS_DONE}" ]; then
229 ewarn "QA: You called $f before any linux_config_exists!"
230 ewarn "QA: The return value of $f will NOT guaranteed later!"
231 fi
232}
233
234# @FUNCTION: linux_config_src_exists
235# @RETURN: true or false
236# @DESCRIPTION:
237# It returns true if .config exists in a build directory otherwise false
238linux_config_src_exists() {
239 export _LINUX_CONFIG_EXISTS_DONE=1
240 [ -s "${KV_OUT_DIR}/.config" ]
241}
242
243# @FUNCTION: linux_config_bin_exists
244# @RETURN: true or false
245# @DESCRIPTION:
246# It returns true if .config exists in /proc, otherwise false
247linux_config_bin_exists() {
248 export _LINUX_CONFIG_EXISTS_DONE=1
249 [ -s "/proc/config.gz" ]
250}
251
252# @FUNCTION: linux_config_exists
253# @RETURN: true or false
254# @DESCRIPTION:
255# It returns true if .config exists otherwise false
256#
257# This function MUST be checked before using any of the linux_chkconfig_*
258# functions.
259linux_config_exists() {
260 linux_config_src_exists || linux_config_bin_exists
261}
262
263# @FUNCTION: require_configured_kernel
264# @DESCRIPTION:
265# This function verifies that the current kernel is configured (it checks against the existence of .config)
266# otherwise it dies.
267require_configured_kernel() {
268 if ! linux_config_src_exists; then
269 qeerror "Could not find a usable .config in the kernel source directory."
270 qeerror "Please ensure that ${KERNEL_DIR} points to a configured set of Linux sources."
271 qeerror "If you are using KBUILD_OUTPUT, please set the environment var so that"
272 qeerror "it points to the necessary object directory so that it might find .config."
273 die "Kernel not configured; no .config found in ${KV_OUT_DIR}"
274 fi
275}
276
277# @FUNCTION: linux_chkconfig_present
278# @USAGE: option
279# @RETURN: true or false
280# @DESCRIPTION:
281# It checks that CONFIG_<option>=y or CONFIG_<option>=m is present in the current kernel .config
282# If linux_config_exists returns false, the results of this are UNDEFINED. You
283# MUST call linux_config_exists first.
284linux_chkconfig_present() {
285 linux_config_qa_check linux_chkconfig_present
51local RESULT 286 local RESULT
52 RESULT="$(getfilevar ${1} ${2})" 287 local config
288 config="${KV_OUT_DIR}/.config"
289 [ ! -f "${config}" ] && config="/proc/config.gz"
290 RESULT="$(getfilevar_noexec CONFIG_${1} "${config}")"
53 [ "${RESULT}" = "m" -o "${RESULT}" = "y" ] && return 0 || return 1 291 [ "${RESULT}" = "m" -o "${RESULT}" = "y" ] && return 0 || return 1
54} 292}
55 293
56getfilevar_ismodule() { 294# @FUNCTION: linux_chkconfig_module
295# @USAGE: option
296# @RETURN: true or false
297# @DESCRIPTION:
298# It checks that CONFIG_<option>=m is present in the current kernel .config
299# If linux_config_exists returns false, the results of this are UNDEFINED. You
300# MUST call linux_config_exists first.
301linux_chkconfig_module() {
302 linux_config_qa_check linux_chkconfig_module
57local RESULT 303 local RESULT
58 RESULT="$(getfilevar ${1} ${2})" 304 local config
305 config="${KV_OUT_DIR}/.config"
306 [ ! -f "${config}" ] && config="/proc/config.gz"
307 RESULT="$(getfilevar_noexec CONFIG_${1} "${config}")"
59 [ "${RESULT}" = "m" ] && return 0 || return 1 308 [ "${RESULT}" = "m" ] && return 0 || return 1
60} 309}
61 310
62getfilevar_isbuiltin() { 311# @FUNCTION: linux_chkconfig_builtin
312# @USAGE: option
313# @RETURN: true or false
314# @DESCRIPTION:
315# It checks that CONFIG_<option>=y is present in the current kernel .config
316# If linux_config_exists returns false, the results of this are UNDEFINED. You
317# MUST call linux_config_exists first.
318linux_chkconfig_builtin() {
319 linux_config_qa_check linux_chkconfig_builtin
63local RESULT 320 local RESULT
64 RESULT="$(getfilevar ${1} ${2})" 321 local config
322 config="${KV_OUT_DIR}/.config"
323 [ ! -f "${config}" ] && config="/proc/config.gz"
324 RESULT="$(getfilevar_noexec CONFIG_${1} "${config}")"
65 [ "${RESULT}" = "y" ] && return 0 || return 1 325 [ "${RESULT}" = "y" ] && return 0 || return 1
326}
327
328# @FUNCTION: linux_chkconfig_string
329# @USAGE: option
330# @RETURN: CONFIG_<option>
331# @DESCRIPTION:
332# It prints the CONFIG_<option> value of the current kernel .config (it requires a configured kernel).
333# If linux_config_exists returns false, the results of this are UNDEFINED. You
334# MUST call linux_config_exists first.
335linux_chkconfig_string() {
336 linux_config_qa_check linux_chkconfig_string
337 local config
338 config="${KV_OUT_DIR}/.config"
339 [ ! -f "${config}" ] && config="/proc/config.gz"
340 getfilevar_noexec "CONFIG_${1}" "${config}"
66} 341}
67 342
68# Versioning Functions 343# Versioning Functions
69# --------------------------------------- 344# ---------------------------------------
70 345
71# kernel_is returns true when the version is the same as the passed version 346# @FUNCTION: kernel_is
347# @USAGE: [-lt -gt -le -ge -eq] major_number [minor_number patch_number]
348# @RETURN: true or false
349# @DESCRIPTION:
350# It returns true when the current kernel version satisfies the comparison against the passed version.
351# -eq is the default comparison.
72# 352#
353# @CODE
73# For Example where KV = 2.6.9 354# For Example where KV = 2.6.9
74# kernel_is 2 4 returns false 355# kernel_is 2 4 returns false
75# kernel_is 2 returns true 356# kernel_is 2 returns true
76# kernel_is 2 6 returns true 357# kernel_is 2 6 returns true
77# kernel_is 2 6 8 returns false 358# kernel_is 2 6 8 returns false
78# kernel_is 2 6 9 returns true 359# kernel_is 2 6 9 returns true
79# 360# @CODE
80# got the jist yet?
81 361
362# Note: duplicated in kernel-2.eclass
82kernel_is() { 363kernel_is() {
83 # if we haven't determined the version yet, we need too. 364 # if we haven't determined the version yet, we need to.
84 get_version; 365 linux-info_get_any_version
85
86 local RESULT
87 RESULT=1
88
89 if [ -n "${1}" ]
90 then
91 [ "${1}" = "${KV_MAJOR}" ] && RESULT=0
92 fi
93
94 if [ -n "${2}" ]
95 then
96 RESULT=1
97 [ "${2}" = "${KV_MINOR}" ] && RESULT=0
98 fi
99
100 if [ -n "${3}" ]
101 then
102 RESULT=1
103 [ "${3}" = "${KV_PATCH}" ] && RESULT=0
104 fi
105 return ${RESULT}
106}
107 366
367 # Now we can continue
368 local operator test value
369
370 case ${1#-} in
371 lt) operator="-lt"; shift;;
372 gt) operator="-gt"; shift;;
373 le) operator="-le"; shift;;
374 ge) operator="-ge"; shift;;
375 eq) operator="-eq"; shift;;
376 *) operator="-eq";;
377 esac
378 [[ $# -gt 3 ]] && die "Error in kernel-2_kernel_is(): too many parameters"
379
380 : $(( test = (KV_MAJOR << 16) + (KV_MINOR << 8) + KV_PATCH ))
381 : $(( value = (${1:-${KV_MAJOR}} << 16) + (${2:-${KV_MINOR}} << 8) + ${3:-${KV_PATCH}} ))
382 [ ${test} ${operator} ${value} ]
383}
384
385get_localversion() {
386 local lv_list i x
387
388 # ignore files with ~ in it.
389 for i in $(ls ${1}/localversion* 2>/dev/null); do
390 [[ -n ${i//*~*} ]] && lv_list="${lv_list} ${i}"
391 done
392
393 for i in ${lv_list}; do
394 x="${x}$(<${i})"
395 done
396 x=${x/ /}
397 echo ${x}
398}
399
400# Check if the Makefile is valid for direct parsing.
401# Check status results:
402# - PASS, use 'getfilevar' to extract values
403# - FAIL, use 'getfilevar_noexec' to extract values
404# The check may fail if:
405# - make is not present
406# - corruption exists in the kernel makefile
407get_makefile_extract_function() {
408 local a='' b='' mkfunc='getfilevar'
409 a="$(getfilevar VERSION ${KERNEL_MAKEFILE})"
410 b="$(getfilevar_noexec VERSION ${KERNEL_MAKEFILE})"
411 [[ "${a}" != "${b}" ]] && mkfunc='getfilevar_noexec'
412 echo "${mkfunc}"
413}
414
415# internal variable, so we know to only print the warning once
416get_version_warning_done=
417
418# @FUNCTION: get_version
419# @DESCRIPTION:
420# It gets the version of the kernel inside KERNEL_DIR and populates the KV_FULL variable
421# (if KV_FULL is already set it does nothing).
422#
423# The kernel version variables (KV_MAJOR, KV_MINOR, KV_PATCH, KV_EXTRA and KV_LOCAL) are also set.
424#
425# The KV_DIR is set using the KERNEL_DIR env var, the KV_DIR_OUT is set using a valid
426# KBUILD_OUTPUT (in a decreasing priority list, we look for the env var, makefile var or the
427# symlink /lib/modules/${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}${KV_EXTRA}/build).
108get_version() { 428get_version() {
109 local kbuild_output 429 local kbuild_output mkfunc tmplocal
110 430
111 # no need to execute this twice assuming KV_FULL is populated. 431 # no need to execute this twice assuming KV_FULL is populated.
112 # we can force by unsetting KV_FULL 432 # we can force by unsetting KV_FULL
113 [ -n "${KV_FULL}" ] && return 433 [ -n "${KV_FULL}" ] && return 0
114 434
115 # if we dont know KV_FULL, then we need too. 435 # if we dont know KV_FULL, then we need too.
116 # make sure KV_DIR isnt set since we need to work it out via KERNEL_DIR 436 # make sure KV_DIR isnt set since we need to work it out via KERNEL_DIR
117 unset KV_DIR 437 unset KV_DIR
118 438
119 # KV_DIR will contain the full path to the sources directory we should use 439 # KV_DIR will contain the full path to the sources directory we should use
440 [ -z "${get_version_warning_done}" ] && \
120 einfo "Determining the location of the kernel source code" 441 qeinfo "Determining the location of the kernel source code"
121 [ -h "${KERNEL_DIR}" ] && KV_DIR="$(readlink -f ${KERNEL_DIR})" 442 [ -h "${KERNEL_DIR}" ] && KV_DIR="$(readlink -f ${KERNEL_DIR})"
122 [ -d "${KERNEL_DIR}" ] && KV_DIR="${KERNEL_DIR}" 443 [ -d "${KERNEL_DIR}" ] && KV_DIR="${KERNEL_DIR}"
123 444
124 if [ -z "${KV_DIR}" ] 445 if [ -z "${KV_DIR}" ]
125 then 446 then
447 if [ -z "${get_version_warning_done}" ]; then
448 get_version_warning_done=1
126 eerror "Unable to find kernel sources at ${KERNEL_DIR}" 449 qeerror "Unable to find kernel sources at ${KERNEL_DIR}"
127 die 450 #qeinfo "This package requires Linux sources."
451 if [ "${KERNEL_DIR}" == "/usr/src/linux" ] ; then
452 qeinfo "Please make sure that ${KERNEL_DIR} points at your running kernel, "
453 qeinfo "(or the kernel you wish to build against)."
454 qeinfo "Alternatively, set the KERNEL_DIR environment variable to the kernel sources location"
455 else
456 qeinfo "Please ensure that the KERNEL_DIR environment variable points at full Linux sources of the kernel you wish to compile against."
457 fi
128 fi 458 fi
129 459 return 1
460 fi
461
462 if [ -z "${get_version_warning_done}" ]; then
463 qeinfo "Found kernel source directory:"
464 qeinfo " ${KV_DIR}"
465 fi
466
467 if [ ! -s "${KV_DIR}/Makefile" ]
468 then
469 if [ -z "${get_version_warning_done}" ]; then
470 get_version_warning_done=1
471 qeerror "Could not find a Makefile in the kernel source directory."
472 qeerror "Please ensure that ${KERNEL_DIR} points to a complete set of Linux sources"
473 fi
474 return 1
475 fi
476
130 # OK so now we know our sources directory, but they might be using 477 # OK so now we know our sources directory, but they might be using
131 # KBUILD_OUTPUT, and we need this for .config and localversions-* 478 # KBUILD_OUTPUT, and we need this for .config and localversions-*
132 # so we better find it eh? 479 # so we better find it eh?
133 # do we pass KBUILD_OUTPUT on the CLI? 480 # do we pass KBUILD_OUTPUT on the CLI?
134 OUTPUT_DIR="${OUTPUT_DIR:-${KBUILD_OUTPUT}}" 481 OUTPUT_DIR="${OUTPUT_DIR:-${KBUILD_OUTPUT}}"
135 482
483 # keep track of it
484 KERNEL_MAKEFILE="${KV_DIR}/Makefile"
485
486 # Decide the function used to extract makefile variables.
487 mkfunc="$(get_makefile_extract_function "${KERNEL_MAKEFILE}")"
488
136 # And if we didn't pass it, we can take a nosey in the Makefile 489 # And if we didn't pass it, we can take a nosey in the Makefile
137 kbuild_output="$(getfilevar KBUILD_OUTPUT ${KV_DIR}/Makefile)" 490 kbuild_output="$(${mkfunc} KBUILD_OUTPUT ${KERNEL_MAKEFILE})"
138 OUTPUT_DIR="${OUTPUT_DIR:-${kbuild_output}}" 491 OUTPUT_DIR="${OUTPUT_DIR:-${kbuild_output}}"
139 492
140 # And contrary to existing functions I feel we shouldn't trust the 493 # And contrary to existing functions I feel we shouldn't trust the
141 # directory name to find version information as this seems insane. 494 # directory name to find version information as this seems insane.
142 # so we parse ${KV_DIR}/Makefile 495 # so we parse ${KERNEL_MAKEFILE}
143 KV_MAJOR="$(getfilevar VERSION ${KV_DIR}/Makefile)" 496 KV_MAJOR="$(${mkfunc} VERSION ${KERNEL_MAKEFILE})"
144 KV_MINOR="$(getfilevar PATCHLEVEL ${KV_DIR}/Makefile)" 497 KV_MINOR="$(${mkfunc} PATCHLEVEL ${KERNEL_MAKEFILE})"
145 KV_PATCH="$(getfilevar SUBLEVEL ${KV_DIR}/Makefile)" 498 KV_PATCH="$(${mkfunc} SUBLEVEL ${KERNEL_MAKEFILE})"
146 KV_EXTRA="$(getfilevar EXTRAVERSION ${KV_DIR}/Makefile)" 499 KV_EXTRA="$(${mkfunc} EXTRAVERSION ${KERNEL_MAKEFILE})"
147 500
501 if [ -z "${KV_MAJOR}" -o -z "${KV_MINOR}" -o -z "${KV_PATCH}" ]
502 then
503 if [ -z "${get_version_warning_done}" ]; then
504 get_version_warning_done=1
505 qeerror "Could not detect kernel version."
506 qeerror "Please ensure that ${KERNEL_DIR} points to a complete set of Linux sources."
507 fi
508 return 1
509 fi
510
148 # and in newer versions we can also pull LOCALVERSION if it is set. 511 # and in newer versions we can also pull LOCALVERSION if it is set.
149 # but before we do this, we need to find if we use a different object directory. 512 # but before we do this, we need to find if we use a different object directory.
150 # This *WILL* break if the user is using localversions, but we assume it was 513 # This *WILL* break if the user is using localversions, but we assume it was
151 # caught before this if they are. 514 # caught before this if they are.
152 [ "${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}.${KV_EXTRA}" == "$(uname -r)" ] && \
153 OUTPUT_DIR="/lib/modules/${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}.${KV_EXTRA}/build" 515 OUTPUT_DIR="${OUTPUT_DIR:-/lib/modules/${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}${KV_EXTRA}/build}"
154 516
155 [ -h "${OUTPUT_DIR}" ] && KV_OUT_DIR="$(readlink -f ${OUTPUT_DIR})" 517 [ -h "${OUTPUT_DIR}" ] && KV_OUT_DIR="$(readlink -f ${OUTPUT_DIR})"
156 [ -d "${OUTPUT_DIR}" ] && KV_OUT_DIR="${OUTPUT_DIR}" 518 [ -d "${OUTPUT_DIR}" ] && KV_OUT_DIR="${OUTPUT_DIR}"
157 if [ -n "${KV_OUT_DIR}" ]; 519 if [ -n "${KV_OUT_DIR}" ];
158 then 520 then
159 einfo "Found kernel object directory:" 521 qeinfo "Found kernel object directory:"
160 einfo " ${KV_OUT_DIR}" 522 qeinfo " ${KV_OUT_DIR}"
161
162 KV_LOCAL="$(cat ${KV_OUT_DIR}/localversion* 2>/dev/null)"
163 fi 523 fi
164 # and if we STILL haven't got it, then we better just set it to KV_DIR 524 # and if we STILL have not got it, then we better just set it to KV_DIR
165 KV_OUT_DIR="${KV_OUT_DIR:-${KV_DIR}}" 525 KV_OUT_DIR="${KV_OUT_DIR:-${KV_DIR}}"
166 526
167 KV_LOCAL="${KV_LOCAL}$(cat ${KV_DIR}/localversion* 2>/dev/null)" 527 # Grab the kernel release from the output directory.
168 KV_LOCAL="${KV_LOCAL}$(getfilevar CONFIG_LOCALVERSION ${KV_OUT_DIR}/.config | sed 's:"::g')" 528 # TODO: we MUST detect kernel.release being out of date, and 'return 1' from
169 529 # this function.
530 if [ -s "${KV_OUT_DIR}"/include/config/kernel.release ]; then
531 KV_LOCAL=$(<"${KV_OUT_DIR}"/include/config/kernel.release)
532 elif [ -s "${KV_OUT_DIR}"/.kernelrelease ]; then
533 KV_LOCAL=$(<"${KV_OUT_DIR}"/.kernelrelease)
534 else
535 KV_LOCAL=
536 fi
537
538 # KV_LOCAL currently contains the full release; discard the first bits.
539 tmplocal=${KV_LOCAL#${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}${KV_EXTRA}}
540
541 # If the updated local version was not changed, the tree is not prepared.
542 # Clear out KV_LOCAL in that case.
543 # TODO: this does not detect a change in the localversion part between
544 # kernel.release and the value that would be generated.
545 if [ "$KV_LOCAL" = "$tmplocal" ]; then
546 KV_LOCAL=
547 else
548 KV_LOCAL=$tmplocal
549 fi
550
170 # And we should set KV_FULL to the full expanded version 551 # And we should set KV_FULL to the full expanded version
171 KV_FULL="${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}${KV_EXTRA}${KV_LOCAL}" 552 KV_FULL="${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}${KV_EXTRA}${KV_LOCAL}"
172 553
173 if [ -z "${KV_FULL}" ] 554 qeinfo "Found sources for kernel version:"
174 then 555 qeinfo " ${KV_FULL}"
175 eerror "We are unable to find a usable kernel source tree in ${KV_DIR}" 556
176 eerror "Please check a kernel source exists in this directory." 557 return 0
177 die 558}
559
560# @FUNCTION: get_running_version
561# @DESCRIPTION:
562# It gets the version of the current running kernel and the result is the same as get_version() if the
563# function can find the sources.
564get_running_version() {
565 KV_FULL=$(uname -r)
566
567 if [[ -f ${ROOT}/lib/modules/${KV_FULL}/source/Makefile && -f ${ROOT}/lib/modules/${KV_FULL}/build/Makefile ]]; then
568 KERNEL_DIR=$(readlink -f ${ROOT}/lib/modules/${KV_FULL}/source)
569 KBUILD_OUTPUT=$(readlink -f ${ROOT}/lib/modules/${KV_FULL}/build)
570 unset KV_FULL
571 get_version
572 return $?
573 elif [[ -f ${ROOT}/lib/modules/${KV_FULL}/source/Makefile ]]; then
574 KERNEL_DIR=$(readlink -f ${ROOT}/lib/modules/${KV_FULL}/source)
575 unset KV_FULL
576 get_version
577 return $?
578 elif [[ -f ${ROOT}/lib/modules/${KV_FULL}/build/Makefile ]]; then
579 KERNEL_DIR=$(readlink -f ${ROOT}/lib/modules/${KV_FULL}/build)
580 unset KV_FULL
581 get_version
582 return $?
178 else 583 else
179 einfo "Found kernel source directory:" 584 KV_MAJOR=$(get_version_component_range 1 ${KV_FULL})
180 einfo " ${KV_DIR}" 585 KV_MINOR=$(get_version_component_range 2 ${KV_FULL})
181 einfo "with sources for kernel version:" 586 KV_PATCH=$(get_version_component_range 3 ${KV_FULL})
182 einfo " ${KV_FULL}" 587 KV_PATCH=${KV_PATCH//-*}
588 KV_EXTRA="${KV_FULL#${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}}"
183 fi 589 fi
590 return 0
184} 591}
185 592
593# This next function is named with the eclass prefix to avoid conflicts with
594# some old versionator-like eclass functions.
186 595
596# @FUNCTION: linux-info_get_any_version
597# @DESCRIPTION:
598# This attempts to find the version of the sources, and otherwise falls back to
599# the version of the running kernel.
600linux-info_get_any_version() {
601 get_version
602 if [[ $? -ne 0 ]]; then
603 ewarn "Unable to calculate Linux Kernel version for build, attempting to use running version"
604 get_running_version
605 fi
606}
187 607
188 608
189# ebuild check functions 609# ebuild check functions
190# --------------------------------------- 610# ---------------------------------------
191 611
612# @FUNCTION: check_kernel_built
613# @DESCRIPTION:
614# This function verifies that the current kernel sources have been already prepared otherwise it dies.
192check_kernel_built() { 615check_kernel_built() {
193 # if we haven't determined the version yet, we need too. 616 # if we haven't determined the version yet, we need to
617 require_configured_kernel
194 get_version; 618 get_version
195 619
196 if [ ! -f "${KV_OUT_DIR}/System.map" ] 620 if [ ! -f "${KV_OUT_DIR}/include/linux/version.h" ]
197 then 621 then
198 eerror "These sources have not yet been compiled." 622 eerror "These sources have not yet been prepared."
199 eerror "We cannot build against an uncompiled tree." 623 eerror "We cannot build against an unprepared tree."
200 eerror "To resolve this, please type the following:" 624 eerror "To resolve this, please type the following:"
201 eerror 625 eerror
202 eerror "# cd ${KV_DIR}" 626 eerror "# cd ${KV_DIR}"
203 eerror "# make oldconfig" 627 eerror "# make oldconfig"
204 eerror "# make bzImage modules modules_install" 628 eerror "# make modules_prepare"
205 eerror 629 eerror
206 eerror "Then please try merging this module again." 630 eerror "Then please try merging this module again."
207 die "Kernel sources need compiling first" 631 die "Kernel sources need compiling first"
208 fi 632 fi
209} 633}
210 634
635# @FUNCTION: check_modules_supported
636# @DESCRIPTION:
637# This function verifies that the current kernel support modules (it checks CONFIG_MODULES=y) otherwise it dies.
211check_modules_supported() { 638check_modules_supported() {
212 # if we haven't determined the version yet, we need too. 639 # if we haven't determined the version yet, we need too.
640 require_configured_kernel
213 get_version; 641 get_version
214 642
215 getfilevar_isset CONFIG_MODULES ${KV_OUT_DIR}/.config 643 if ! linux_chkconfig_builtin "MODULES"
216 if [ "$?" != 0 ]
217 then 644 then
218 eerror "These sources do not support loading external modules." 645 eerror "These sources do not support loading external modules."
219 eerror "to be able to use this module please enable \"Loadable modules support\"" 646 eerror "to be able to use this module please enable \"Loadable modules support\""
220 eerror "in your kernel, recompile and then try merging this module again." 647 eerror "in your kernel, recompile and then try merging this module again."
221 die No support for external modules in ${KV_FULL} config 648 die "No support for external modules in ${KV_FULL} config"
222 fi 649 fi
223} 650}
224 651
652# @FUNCTION: check_extra_config
653# @DESCRIPTION:
654# It checks the kernel config options specified by CONFIG_CHECK. It dies only when a required config option (i.e.
655# the prefix ~ is not used) doesn't satisfy the directive.
225check_extra_config() { 656check_extra_config() {
226local config negate error 657 local config negate die error reworkmodulenames
658 local soft_errors_count=0 hard_errors_count=0 config_required=0
659 # store the value of the QA check, because otherwise we won't catch usages
660 # after if check_extra_config is called AND other direct calls are done
661 # later.
662 local old_LINUX_CONFIG_EXISTS_DONE="${_LINUX_CONFIG_EXISTS_DONE}"
227 663
228 # if we haven't determined the version yet, we need too. 664 # if we haven't determined the version yet, we need to
229 get_version; 665 linux-info_get_any_version
230 666
231 einfo "Checking for suitable kernel configuration options" 667 # Determine if we really need a .config. The only time when we don't need
668 # one is when all of the CONFIG_CHECK options are prefixed with "~".
232 for config in ${CONFIG_CHECK} 669 for config in ${CONFIG_CHECK}
233 do 670 do
234 negate="${config:0:1}" 671 if [[ "${config:0:1}" != "~" ]]; then
235 if [ "${negate}" == "!" ]; 672 config_required=1
236 then 673 break
674 fi
675 done
676
677 if [[ ${config_required} == 0 ]]; then
678 # In the case where we don't require a .config, we can now bail out
679 # if the user has no .config as there is nothing to do. Otherwise
680 # code later will cause a failure due to missing .config.
681 if ! linux_config_exists; then
682 ewarn "Unable to check for the following kernel config options due"
683 ewarn "to absence of any configured kernel sources or compiled"
684 ewarn "config:"
685 for config in ${CONFIG_CHECK}; do
686 local_error="ERROR_${config#\~}"
687 msg="${!local_error}"
688 if [[ "x${msg}" == "x" ]]; then
689 local_error="WARNING_${config#\~}"
690 msg="${!local_error}"
691 fi
692 ewarn " - ${config#\~}${msg:+ - }${msg}"
693 done
694 ewarn "You're on your own to make sure they are set if needed."
695 export LINUX_CONFIG_EXISTS_DONE="${old_LINUX_CONFIG_EXISTS_DONE}"
696 return 0
697 fi
698 else
699 require_configured_kernel
700 fi
701
702 einfo "Checking for suitable kernel configuration options..."
703
704 for config in ${CONFIG_CHECK}
705 do
706 # if we specify any fatal, ensure we honor them
707 die=1
708 error=0
709 negate=0
710 reworkmodulenames=0
711
712 if [[ ${config:0:1} == "~" ]]; then
713 die=0
237 config="${config:1}" 714 config=${config:1}
238 if getfilevar_isset ${config} ${KV_OUT_DIR}/.config ; 715 elif [[ ${config:0:1} == "@" ]]; then
239 then 716 die=0
240 eerror " ${config}:\tshould not be set in the kernel configuration, but it is." 717 reworkmodulenames=1
718 config=${config:1}
719 fi
720 if [[ ${config:0:1} == "!" ]]; then
721 negate=1
722 config=${config:1}
723 fi
724
725 if [[ ${negate} == 1 ]]; then
726 linux_chkconfig_present ${config} && error=2
727 elif [[ ${reworkmodulenames} == 1 ]]; then
728 local temp_config="${config//*:}" i n
729 config="${config//:*}"
730 if linux_chkconfig_present ${config}; then
731 for i in ${MODULE_NAMES}; do
732 n="${i//${temp_config}}"
733 [[ -z ${n//\(*} ]] && \
734 MODULE_IGNORE="${MODULE_IGNORE} ${temp_config}"
735 done
241 error=1 736 error=2
242 fi 737 fi
243 else 738 else
244 if ! getfilevar_isset ${config} ${KV_OUT_DIR}/.config ; 739 linux_chkconfig_present ${config} || error=1
245 then 740 fi
246 eerror " ${config}:\tshould be set in the kernel configuration, but isn't" 741
247 error=1 742 if [[ ${error} > 0 ]]; then
743 local report_func="eerror" local_error
744 local_error="ERROR_${config}"
745 local_error="${!local_error}"
746
747 if [[ -z "${local_error}" ]]; then
748 # using old, deprecated format.
749 local_error="${config}_ERROR"
750 local_error="${!local_error}"
248 fi 751 fi
752 if [[ ${die} == 0 && -z "${local_error}" ]]; then
753 #soft errors can be warnings
754 local_error="WARNING_${config}"
755 local_error="${!local_error}"
756 if [[ -n "${local_error}" ]] ; then
757 report_func="ewarn"
758 fi
759 fi
760
761 if [[ -z "${local_error}" ]]; then
762 [[ ${error} == 1 ]] \
763 && local_error="is not set when it should be." \
764 || local_error="should not be set. But it is."
765 local_error="CONFIG_${config}:\t ${local_error}"
766 fi
767 if [[ ${die} == 0 ]]; then
768 ${report_func} " ${local_error}"
769 soft_errors_count=$[soft_errors_count + 1]
770 else
771 ${report_func} " ${local_error}"
772 hard_errors_count=$[hard_errors_count + 1]
773 fi
249 fi 774 fi
250 done 775 done
251 776
252 if [ -n "${error}" ] ; 777 if [[ ${hard_errors_count} > 0 ]]; then
253 then
254 eerror "Please check to make sure these options are set correctly." 778 eerror "Please check to make sure these options are set correctly."
779 eerror "Failure to do so may cause unexpected problems."
255 eerror "Once you have satisfied these options, please try merging" 780 eerror "Once you have satisfied these options, please try merging"
256 eerror "this package again." 781 eerror "this package again."
782 export LINUX_CONFIG_EXISTS_DONE="${old_LINUX_CONFIG_EXISTS_DONE}"
257 die Incorrect kernel configuration options 783 die "Incorrect kernel configuration options"
784 elif [[ ${soft_errors_count} > 0 ]]; then
785 ewarn "Please check to make sure these options are set correctly."
786 ewarn "Failure to do so may cause unexpected problems."
787 else
788 eend 0
258 fi 789 fi
790 export LINUX_CONFIG_EXISTS_DONE="${old_LINUX_CONFIG_EXISTS_DONE}"
259} 791}
260 792
261check_zlibinflate() { 793check_zlibinflate() {
262 # if we haven't determined the version yet, we need too. 794 # if we haven't determined the version yet, we need to
795 require_configured_kernel
263 get_version; 796 get_version
264 797
265 # although I restructured this code - I really really really dont support it! 798 # although I restructured this code - I really really really dont support it!
266 799
267 # bug #27882 - zlib routines are only linked into the kernel 800 # bug #27882 - zlib routines are only linked into the kernel
268 # if something compiled into the kernel calls them 801 # if something compiled into the kernel calls them
269 # 802 #
270 # plus, for the cloop module, it appears that there's no way 803 # plus, for the cloop module, it appears that there's no way
271 # to get cloop.o to include a static zlib if CONFIG_MODVERSIONS 804 # to get cloop.o to include a static zlib if CONFIG_MODVERSIONS
272 # is on 805 # is on
273 806
274local INFLATE 807 local INFLATE
275local DEFLATE 808 local DEFLATE
276 809
277 einfo "Determining the usability of ZLIB_INFLATE support in your kernel" 810 einfo "Determining the usability of ZLIB_INFLATE support in your kernel"
278 811
279 ebegin "checking ZLIB_INFLATE" 812 ebegin "checking ZLIB_INFLATE"
280 getfilevar_isbuiltin CONFIG_ZLIB_INFLATE ${KV_DIR}/.config 813 linux_chkconfig_builtin CONFIG_ZLIB_INFLATE
281 eend $? 814 eend $?
282 [ "$?" != 0 ] && die 815 [ "$?" != 0 ] && die
283 816
284 ebegin "checking ZLIB_DEFLATE" 817 ebegin "checking ZLIB_DEFLATE"
285 getfilevar_isbuiltin CONFIG_ZLIB_DEFLATE ${KV_DIR}/.config 818 linux_chkconfig_builtin CONFIG_ZLIB_DEFLATE
286 eend $? 819 eend $?
287 [ "$?" != 0 ] && die 820 [ "$?" != 0 ] && die
288 821
289
290 local LINENO_START 822 local LINENO_START
291 local LINENO_END 823 local LINENO_END
292 local SYMBOLS 824 local SYMBOLS
293 local x 825 local x
294 826
295 LINENO_END="$(grep -n 'CONFIG_ZLIB_INFLATE y' ${KV_DIR}/lib/Config.in | cut -d : -f 1)" 827 LINENO_END="$(grep -n 'CONFIG_ZLIB_INFLATE y' ${KV_DIR}/lib/Config.in | cut -d : -f 1)"
296 LINENO_START="$(head -n $LINENO_END ${KV_DIR}/lib/Config.in | grep -n 'if \[' | tail -n 1 | cut -d : -f 1)" 828 LINENO_START="$(head -n $LINENO_END ${KV_DIR}/lib/Config.in | grep -n 'if \[' | tail -n 1 | cut -d : -f 1)"
297 (( LINENO_AMOUNT = $LINENO_END - $LINENO_START )) 829 (( LINENO_AMOUNT = $LINENO_END - $LINENO_START ))
298 (( LINENO_END = $LINENO_END - 1 )) 830 (( LINENO_END = $LINENO_END - 1 ))
299 SYMBOLS="$(head -n $LINENO_END ${KV_DIR}/lib/Config.in | tail -n $LINENO_AMOUNT | sed -e 's/^.*\(CONFIG_[^\" ]*\).*/\1/g;')" 831 SYMBOLS="$(head -n $LINENO_END ${KV_DIR}/lib/Config.in | tail -n $LINENO_AMOUNT | sed -e 's/^.*\(CONFIG_[^\" ]*\).*/\1/g;')"
305 # we have a winner! 837 # we have a winner!
306 einfo "${x} ensures zlib is linked into your kernel - excellent" 838 einfo "${x} ensures zlib is linked into your kernel - excellent"
307 return 0 839 return 0
308 fi 840 fi
309 done 841 done
310 842
311 eerror 843 eerror
312 eerror "This kernel module requires ZLIB library support." 844 eerror "This kernel module requires ZLIB library support."
313 eerror "You have enabled zlib support in your kernel, but haven't enabled" 845 eerror "You have enabled zlib support in your kernel, but haven't enabled"
314 eerror "enabled any option that will ensure that zlib is linked into your" 846 eerror "enabled any option that will ensure that zlib is linked into your"
315 eerror "kernel." 847 eerror "kernel."
325 eerror "Please remember to recompile and install your kernel, and reboot" 857 eerror "Please remember to recompile and install your kernel, and reboot"
326 eerror "into your new kernel before attempting to load this kernel module." 858 eerror "into your new kernel before attempting to load this kernel module."
327 859
328 die "Kernel doesn't include zlib support" 860 die "Kernel doesn't include zlib support"
329} 861}
862
863################################
864# Default pkg_setup
865# Also used when inheriting linux-mod to force a get_version call
866# @FUNCTION: linux-info_pkg_setup
867# @DESCRIPTION:
868# Force a get_version() call when inherited from linux-mod.eclass and then check if the kernel is configured
869# to support the options specified in CONFIG_CHECK (if not null)
870linux-info_pkg_setup() {
871 linux-info_get_any_version
872
873 if kernel_is 2 4; then
874 if [ "$( gcc-major-version )" -eq "4" ] ; then
875 echo
876 ewarn "Be warned !! >=sys-devel/gcc-4.0.0 isn't supported with"
877 ewarn "linux-2.4 (or modules building against a linux-2.4 kernel)!"
878 echo
879 ewarn "Either switch to another gcc-version (via gcc-config) or use a"
880 ewarn "newer kernel that supports gcc-4."
881 echo
882 ewarn "Also be aware that bugreports about gcc-4 not working"
883 ewarn "with linux-2.4 based ebuilds will be closed as INVALID!"
884 echo
885 epause 10
886 fi
887 fi
888
889 [ -n "${CONFIG_CHECK}" ] && check_extra_config;
890}

Legend:
Removed from v.1.6  
changed lines
  Added in v.1.91

  ViewVC Help
Powered by ViewVC 1.1.20