/[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.55 Revision 1.56
1# Copyright 1999-2006 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.55 2008/03/21 11:11:27 dsd Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/linux-info.eclass,v 1.56 2008/10/31 22:01:32 dsd Exp $
4#
5# Description: This eclass is used as a central eclass for accessing kernel
6# related information for sources already installed.
7# It is vital for linux-mod to function correctly, and is split
8# out so that any ebuild behaviour "templates" are abstracted out
9# using additional eclasses.
10# 4#
11# Original author: John Mylchreest <johnm@gentoo.org> 5# Original author: John Mylchreest <johnm@gentoo.org>
12# Maintainer: kernel-misc@gentoo.org 6# Maintainer: kernel-misc@gentoo.org
13# 7#
14# Please direct your bugs to the current eclass maintainer :) 8# Please direct your bugs to the current eclass maintainer :)
15 9
10# @ECLASS: linux-info.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
16# A Couple of env vars are available to effect usage of this eclass 21# A Couple of env vars are available to effect usage of this eclass
17# These are as follows: 22# These are as follows:
18# 23
19# Env Var Option Description 24# @ECLASS-VARIABLE: KERNEL_DIR
20# KERNEL_DIR <string> The directory containing kernel the target kernel 25# @DESCRIPTION:
21# sources. 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:
22# CONFIG_CHECK <string> a list of .config options to check for before 31# A string containing a list of .config options to check for before
23# proceeding with the install. ie: CONFIG_CHECK="MTRR" 32# proceeding with the install.
33#
34# e.g.: CONFIG_CHECK="MTRR"
35#
24# You can also check that an option doesn't exist by 36# You can also check that an option doesn't exist by
25# prepending it with an exclamation mark (!). 37# prepending it with an exclamation mark (!).
38#
26# ie: CONFIG_CHECK="!MTRR" 39# e.g.: CONFIG_CHECK="!MTRR"
40#
27# To simply warn about a missing option, prepend a '~'. 41# To simply warn about a missing option, prepend a '~'.
28# ERROR_CFG <string> The error message to display when the above check 42
43# @ECLASS-VARIABLE: ERROR_<CFG>
44# @DESCRIPTION:
45# A string containing the error message to display when the check against CONFIG_CHECK
29# fails. <CFG> should reference the appropriate option 46# fails. <CFG> should reference the appropriate option used in CONFIG_CHECK.
30# as above. ie: ERROR_MTRR="MTRR exists in the .config 47#
31# but shouldn't!!" 48# e.g.: ERROR_MTRR="MTRR exists in the .config but shouldn't!!"
32# KBUILD_OUTPUT <string> This is passed on commandline, or can be set from 49
33# the kernel makefile. This contains the directory 50# @ECLASS-VARIABLE: KBUILD_OUTPUT
51# @DESCRIPTION:
52# A string passed on commandline, or set from the kernel makefile. It contains the directory
34# which is to be used as the kernel object directory. 53# which is to be used as the kernel object directory.
35 54
36# There are also a couple of variables which are set by this, and shouldn't be 55# There are also a couple of variables which are set by this, and shouldn't be
37# set by hand. These are as follows: 56# set by hand. These are as follows:
38# 57
39# Env Var Option Description 58# @ECLASS-VARIABLE: KV_FULL
40# KV_FULL <string> The full kernel version. ie: 2.6.9-gentoo-johnm-r1 59# @DESCRIPTION:
41# KV_MAJOR <integer> The kernel major version. ie: 2 60# A read-only variable. It's a string containing the full kernel version. ie: 2.6.9-gentoo-johnm-r1
42# KV_MINOR <integer> The kernel minor version. ie: 6 61
43# KV_PATCH <integer> The kernel patch version. ie: 9 62# @ECLASS-VARIABLE: KV_MAJOR
44# KV_EXTRA <string> The kernel EXTRAVERSION. ie: -gentoo 63# @DESCRIPTION:
45# KV_LOCAL <string> The kernel LOCALVERSION concatenation. ie: -johnm 64# A read-only variable. It's an integer containing the kernel major version. ie: 2
46# KV_DIR <string> The kernel source directory, will be null if 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
47# KERNEL_DIR is invalid. 85# KERNEL_DIR is invalid.
48# KV_OUT_DIR <string> The kernel object directory. will be KV_DIR unless 86
49# koutput is used. This should be used for referencing 87# @ECLASS-VARIABLE: KV_OUT_DIR
50# .config. 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.
51 91
52# And to ensure all the weirdness with crosscompile 92# And to ensure all the weirdness with crosscompile
53inherit toolchain-funcs versionator 93inherit toolchain-funcs versionator
54 94
55EXPORT_FUNCTIONS pkg_setup 95EXPORT_FUNCTIONS pkg_setup
99qeerror() { qout eerror "${@}" ; } 139qeerror() { qout eerror "${@}" ; }
100 140
101# File Functions 141# File Functions
102# --------------------------------------- 142# ---------------------------------------
103 143
104# getfilevar accepts 2 vars as follows: 144# @FUNCTION: getfilevar
105# getfilevar <VARIABLE> <CONFIGFILE> 145# @USAGE: variable configfile
106 146# @RETURN: the value of the variable
147# @DESCRIPTION:
148# It detects the value of the variable defined in the file configfile
107getfilevar() { 149getfilevar() {
108local ERROR workingdir basefname basedname myARCH="${ARCH}" 150local ERROR workingdir basefname basedname myARCH="${ARCH}"
109 ERROR=0 151 ERROR=0
110 152
111 [ -z "${1}" ] && ERROR=1 153 [ -z "${1}" ] && ERROR=1
130 ARCH=${myARCH} 172 ARCH=${myARCH}
131 fi 173 fi
132} 174}
133 175
134 176
177# @FUNCTION: linux_config_exists
178# @RETURN: true or false
179# @DESCRIPTION:
180# It returns true if .config exists otherwise false
135linux_config_exists() { 181linux_config_exists() {
136 [ -s "${KV_OUT_DIR}/.config" ] 182 [ -s "${KV_OUT_DIR}/.config" ]
137} 183}
138 184
185# @FUNCTION: require_configured_kernel
186# @DESCRIPTION:
187# This function verifies that the current kernel is configured (it checks against the existence of .config)
188# otherwise it dies.
139require_configured_kernel() { 189require_configured_kernel() {
140 if ! linux_config_exists; then 190 if ! linux_config_exists; then
141 qeerror "Could not find a usable .config in the kernel source directory." 191 qeerror "Could not find a usable .config in the kernel source directory."
142 qeerror "Please ensure that ${KERNEL_DIR} points to a configured set of Linux sources." 192 qeerror "Please ensure that ${KERNEL_DIR} points to a configured set of Linux sources."
143 qeerror "If you are using KBUILD_OUTPUT, please set the environment var so that" 193 qeerror "If you are using KBUILD_OUTPUT, please set the environment var so that"
144 qeerror "it points to the necessary object directory so that it might find .config." 194 qeerror "it points to the necessary object directory so that it might find .config."
145 die "Kernel not configured; no .config found in ${KV_OUT_DIR}" 195 die "Kernel not configured; no .config found in ${KV_OUT_DIR}"
146 fi 196 fi
147} 197}
148 198
199# @FUNCTION: linux_chkconfig_present
200# @USAGE: option
201# @RETURN: true or false
202# @DESCRIPTION:
203# It checks that CONFIG_<option>=y or CONFIG_<option>=n is present in the current kernel .config
149linux_chkconfig_present() { 204linux_chkconfig_present() {
150local RESULT 205local RESULT
151 require_configured_kernel 206 require_configured_kernel
152 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)" 207 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
153 [ "${RESULT}" = "m" -o "${RESULT}" = "y" ] && return 0 || return 1 208 [ "${RESULT}" = "m" -o "${RESULT}" = "y" ] && return 0 || return 1
154} 209}
155 210
211# @FUNCTION: linux_chkconfig_module
212# @USAGE: option
213# @RETURN: true or false
214# @DESCRIPTION:
215# It checks that CONFIG_<option>=m is present in the current kernel .config
156linux_chkconfig_module() { 216linux_chkconfig_module() {
157local RESULT 217local RESULT
158 require_configured_kernel 218 require_configured_kernel
159 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)" 219 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
160 [ "${RESULT}" = "m" ] && return 0 || return 1 220 [ "${RESULT}" = "m" ] && return 0 || return 1
161} 221}
162 222
223# @FUNCTION: linux_chkconfig_builtin
224# @USAGE: option
225# @RETURN: true or false
226# @DESCRIPTION:
227# It checks that CONFIG_<option>=y is present in the current kernel .config
163linux_chkconfig_builtin() { 228linux_chkconfig_builtin() {
164local RESULT 229local RESULT
165 require_configured_kernel 230 require_configured_kernel
166 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)" 231 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
167 [ "${RESULT}" = "y" ] && return 0 || return 1 232 [ "${RESULT}" = "y" ] && return 0 || return 1
168} 233}
169 234
235# @FUNCTION: linux_chkconfig_string
236# @USAGE: option
237# @RETURN: CONFIG_<option>
238# @DESCRIPTION:
239# It prints the CONFIG_<option> value of the current kernel .config (it requires a configured kernel).
170linux_chkconfig_string() { 240linux_chkconfig_string() {
171 require_configured_kernel 241 require_configured_kernel
172 getfilevar "CONFIG_${1}" "${KV_OUT_DIR}/.config" 242 getfilevar "CONFIG_${1}" "${KV_OUT_DIR}/.config"
173} 243}
174 244
175# Versioning Functions 245# Versioning Functions
176# --------------------------------------- 246# ---------------------------------------
177 247
178# kernel_is returns true when the version is the same as the passed version 248# @FUNCTION: kernel_is
249# @USAGE: [-lt -gt -le -ge -eq] major_number [minor_number patch_number]
250# @RETURN: true or false
251# @DESCRIPTION:
252# It returns true when the current kernel version satisfies the comparison against the passed version.
253# -eq is the default comparison.
179# 254#
255# @CODE
180# For Example where KV = 2.6.9 256# For Example where KV = 2.6.9
181# kernel_is 2 4 returns false 257# kernel_is 2 4 returns false
182# kernel_is 2 returns true 258# kernel_is 2 returns true
183# kernel_is 2 6 returns true 259# kernel_is 2 6 returns true
184# kernel_is 2 6 8 returns false 260# kernel_is 2 6 8 returns false
185# kernel_is 2 6 9 returns true 261# kernel_is 2 6 9 returns true
186# 262# @CODE
263
187# got the jist yet? 264# got the jist yet?
188 265
189kernel_is() { 266kernel_is() {
190 # if we haven't determined the version yet, we need to. 267 # if we haven't determined the version yet, we need to.
191 get_version 268 get_version
232 done 309 done
233 x=${x/ /} 310 x=${x/ /}
234 echo ${x} 311 echo ${x}
235} 312}
236 313
314# @FUNCTION: get_version
315# @DESCRIPTION:
316# It gets the version of the kernel inside KERNEL_DIR and populates the KV_FULL variable
317# (if KV_FULL is already set it does nothing).
318#
319# The kernel version variables (KV_MAJOR, KV_MINOR, KV_PATCH, KV_EXTRA and KV_LOCAL) are also set.
320#
321# The KV_DIR is set using the KERNEL_DIR env var, the KV_DIR_OUT is set using a valid
322# KBUILD_OUTPUT (in a decreasing priority list, we look for the env var, makefile var or the
323# symlink /lib/modules/${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}${KV_EXTRA}/build).
237get_version() { 324get_version() {
238 local kbuild_output 325 local kbuild_output
239 326
240 # no need to execute this twice assuming KV_FULL is populated. 327 # no need to execute this twice assuming KV_FULL is populated.
241 # we can force by unsetting KV_FULL 328 # we can force by unsetting KV_FULL
336 qeinfo " ${KV_FULL}" 423 qeinfo " ${KV_FULL}"
337 424
338 return 0 425 return 0
339} 426}
340 427
428# @FUNCTION: get_running_version
429# @DESCRIPTION:
430# It gets the version of the current running kernel and the result is the same as get_version() if the
431# function can find the sources.
341get_running_version() { 432get_running_version() {
342 KV_FULL=$(uname -r) 433 KV_FULL=$(uname -r)
343 434
344 if [[ -f ${ROOT}/lib/modules/${KV_FULL}/source/Makefile ]]; then 435 if [[ -f ${ROOT}/lib/modules/${KV_FULL}/source/Makefile ]]; then
345 KERNEL_DIR=$(readlink -f ${ROOT}/lib/modules/${KV_FULL}/source) 436 KERNEL_DIR=$(readlink -f ${ROOT}/lib/modules/${KV_FULL}/source)
364 455
365 456
366# ebuild check functions 457# ebuild check functions
367# --------------------------------------- 458# ---------------------------------------
368 459
460# @FUNCTION: check_kernel_built
461# @DESCRIPTION:
462# This function verifies that the current kernel sources have been already prepared otherwise it dies.
369check_kernel_built() { 463check_kernel_built() {
370 # if we haven't determined the version yet, we need to 464 # if we haven't determined the version yet, we need to
371 require_configured_kernel 465 require_configured_kernel
372 get_version 466 get_version
373 467
384 eerror "Then please try merging this module again." 478 eerror "Then please try merging this module again."
385 die "Kernel sources need compiling first" 479 die "Kernel sources need compiling first"
386 fi 480 fi
387} 481}
388 482
483# @FUNCTION: check_modules_supported
484# @DESCRIPTION:
485# This function verifies that the current kernel support modules (it checks CONFIG_MODULES=y) otherwise it dies.
389check_modules_supported() { 486check_modules_supported() {
390 # if we haven't determined the version yet, we need too. 487 # if we haven't determined the version yet, we need too.
391 require_configured_kernel 488 require_configured_kernel
392 get_version 489 get_version
393 490
398 eerror "in your kernel, recompile and then try merging this module again." 495 eerror "in your kernel, recompile and then try merging this module again."
399 die "No support for external modules in ${KV_FULL} config" 496 die "No support for external modules in ${KV_FULL} config"
400 fi 497 fi
401} 498}
402 499
500# @FUNCTION: check_extra_config
501# @DESCRIPTION:
502# It checks the kernel config options specified by CONFIG_CHECK. It dies only when a required config option (i.e.
503# the prefix ~ is not used) doesn't satisfy the directive.
403check_extra_config() { 504check_extra_config() {
404 local config negate die error reworkmodulenames 505 local config negate die error reworkmodulenames
405 local soft_errors_count=0 hard_errors_count=0 config_required=0 506 local soft_errors_count=0 hard_errors_count=0 config_required=0
406 507
407 # if we haven't determined the version yet, we need to 508 # if we haven't determined the version yet, we need to
588} 689}
589 690
590################################ 691################################
591# Default pkg_setup 692# Default pkg_setup
592# Also used when inheriting linux-mod to force a get_version call 693# Also used when inheriting linux-mod to force a get_version call
593 694# @FUNCTION: linux-info_pkg_setup
695# @DESCRIPTION:
696# Force a get_version() call when inherited from linux-mod.eclass and then check if the kernel is configured
697# to support the options specified in CONFIG_CHECK (if not null)
594linux-info_pkg_setup() { 698linux-info_pkg_setup() {
595 get_version || die "Unable to calculate Linux Kernel version" 699 get_version || die "Unable to calculate Linux Kernel version"
596 700
597 if kernel_is 2 4; then 701 if kernel_is 2 4; then
598 if [ "$( gcc-major-version )" -eq "4" ] ; then 702 if [ "$( gcc-major-version )" -eq "4" ] ; then

Legend:
Removed from v.1.55  
changed lines
  Added in v.1.56

  ViewVC Help
Powered by ViewVC 1.1.20