/[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.11
1# Copyright 1999-2004 Gentoo Foundation 1# Copyright 1999-2004 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.11 2004/12/17 15:12:07 johnm Exp $
4# 4#
5# This eclass provides functions for querying the installed kernel 5# Description: This eclass is used as a central eclass for accessing kernel
6# source version, selected kernel options etc. 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.
7# 10#
11# Maintainer: John Mylchreest <johnm@gentoo.org>
12# Copyright 2004 Gentoo Linux
13#
14# Please direct your bugs to the current eclass maintainer :)
15
16# A Couple of env vars are available to effect usage of this eclass
17# These are as follows:
18#
19# Env Var Option Description
20# KERNEL_DIR <string> The directory containing kernel the target kernel
21# sources.
22# CONFIG_CHECK <string> a list of .config options to check for before
23# proceeding with the install. ie: CONFIG_CHECK="MTRR"
24# You can also check that an option doesn't exist by
25# prepending it with an exclamation mark (!).
26# ie: CONFIG_CHECK="!MTRR"
27# <CFG>_ERROR <string> The error message to display when the above check
28# fails. <CFG> should reference the appropriate option
29# as above. ie: MTRR_ERROR="MTRR exists in the .config
30# but shouldn't!!"
31# KBUILD_OUTPUT <string> This is passed on commandline, or can be set from
32# the kernel makefile. This contains the directory
33# which is to be used as the kernel object directory.
34
35# There are also a couple of variables which are set by this, and shouldn't be
36# set by hand. These are as follows:
37#
38# Env Var Option Description
39# KV_FULL <string> The full kernel version. ie: 2.6.9-gentoo-johnm-r1
40# KV_MAJOR <integer> The kernel major version. ie: 2
41# KV_MINOR <integer> The kernel minor version. ie: 6
42# KV_PATCH <integer> The kernel patch version. ie: 9
43# KV_EXTRA <string> The kernel EXTRAVERSION. ie: -gentoo
44# KV_LOCAL <string> The kernel LOCALVERSION concatenation. ie: -johnm
45# KV_DIR <string> The kernel source directory, will be null if
46# KERNEL_DIR is invalid.
47# KV_OUT_DIR <string> The kernel object directory. will be KV_DIR unless
48# koutput is used. This should be used for referencing
49# .config.
50
8 51
9ECLASS=linux-info 52ECLASS=linux-info
10INHERITED="$INHERITED $ECLASS" 53INHERITED="$INHERITED $ECLASS"
54EXPORT_FUNCTIONS pkg_setup
11 55
12# Overwritable environment Var's 56# Overwritable environment Var's
13# --------------------------------------- 57# ---------------------------------------
14KERNEL_DIR="${KERNEL_DIR:-/usr/src/linux}" 58KERNEL_DIR="${KERNEL_DIR:-/usr/src/linux}"
15 59
16 60
61# Pulled from eutils as it might be more useful only being here since
62# very few ebuilds which dont use this eclass will ever ever use these functions
63set_arch_to_kernel() {
64 export PORTAGE_ARCH="${ARCH}"
65 case ${ARCH} in
66 x86) export ARCH="i386";;
67 amd64) export ARCH="x86_64";;
68 hppa) export ARCH="parisc";;
69 mips) export ARCH="mips";;
70 *) export ARCH="${ARCH}";;
71 esac
72}
73
74# set's ARCH back to what portage expects
75set_arch_to_portage() {
76 export ARCH="${PORTAGE_ARCH}"
77}
78
79
80#
81# qeinfo "Message"
82# -------------------
83# qeinfo is a queit einfo call when EBUILD_PHASE
84# should not have visible output.
85#
86qeinfo() {
87 local outputmsg
88 outputmsg="${@}"
89 case "${EBUILD_PHASE}" in
90 depend) unset outputmsg;;
91 clean) unset outputmsg;;
92 preinst) unset outputmsg;;
93 esac
94 [ -n "${outputmsg}" ] && einfo "${outputmsg}"
95}
96
97qeerror() {
98 local outputmsg
99 outputmsg="${@}"
100 case "${EBUILD_PHASE}" in
101 depend) unset outputmsg;;
102 clean) unset outputmsg;;
103 preinst) unset outputmsg;;
104 esac
105 [ -n "${outputmsg}" ] && einfo "${outputmsg}"
106}
107
108
17 109
18# File Functions 110# File Functions
19# --------------------------------------- 111# ---------------------------------------
20 112
21# getfilevar accepts 2 vars as follows: 113# getfilevar accepts 2 vars as follows:
22# getfilevar <VARIABLE> <CONFIGFILE> 114# getfilevar <VARIABLE> <CONFIGFILE>
23 115
24getfilevar() { 116getfilevar() {
25local ERROR 117local ERROR workingdir basefname basedname xarch
26 ERROR=0 118 ERROR=0
27 119
28 [ -z "${1}" ] && ERROR=1 120 [ -z "${1}" ] && ERROR=1
29 [ -z "${2}" ] && ERROR=1
30 [ ! -f "${2}" ] && ERROR=1 121 [ ! -f "${2}" ] && ERROR=1
31 122
32 if [ "${ERROR}" = 1 ] 123 if [ "${ERROR}" = 1 ]
33 then 124 then
125 ebeep
126 echo -e "\n"
34 eerror "getfilevar requires 2 variables, with the second a valid file." 127 eerror "getfilevar requires 2 variables, with the second a valid file."
35 eerror " getfilevar <VARIABLE> <CONFIGFILE>" 128 eerror " getfilevar <VARIABLE> <CONFIGFILE>"
36 else 129 else
37 grep -e "^$1[= ]" $2 | sed 's: = :=:' | cut -d= -f2- 130 workingdir=${PWD}
131 basefname=$(basename ${2})
132 basedname=$(dirname ${2})
133 xarch=${ARCH}
134 unset ARCH
135
136 cd ${basedname}
137 echo -e "include ${basefname}\ne:\n\t@echo \$(${1})" | \
138 make -f - e 2>/dev/null
139 cd ${workingdir}
140
141 ARCH=${xarch}
38 fi 142 fi
39} 143}
40 144
41getfilevar_isset() { 145linux_chkconfig_present() {
42local RESULT 146local RESULT
43 RESULT="$(getfilevar ${1} ${2})" 147 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
44 [ "${RESULT}" = "m" -o "${RESULT}" = "y" ] && return 0 || return 1 148 [ "${RESULT}" = "m" -o "${RESULT}" = "y" ] && return 0 || return 1
45} 149}
46 150
47getfilevar_ismodule() { 151linux_chkconfig_module() {
48local RESULT 152local RESULT
49 RESULT="$(getfilevar ${1} ${2})" 153 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
50 [ "${RESULT}" = "m" ] && return 0 || return 1 154 [ "${RESULT}" = "m" ] && return 0 || return 1
51} 155}
52 156
53getfilevar_isbuiltin() { 157linux_chkconfig_builtin() {
54local RESULT 158local RESULT
55 RESULT="$(getfilevar ${1} ${2})" 159 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
56 [ "${RESULT}" = "y" ] && return 0 || return 1 160 [ "${RESULT}" = "y" ] && return 0 || return 1
161}
162
163linux_chkconfig_string() {
164 getfilevar "CONFIG_${1}" "${KV_OUT_DIR}/.config"
57} 165}
58 166
59# Versioning Functions 167# Versioning Functions
60# --------------------------------------- 168# ---------------------------------------
61 169
95 fi 203 fi
96 return ${RESULT} 204 return ${RESULT}
97} 205}
98 206
99get_version() { 207get_version() {
208 local kbuild_output
209
100 # no need to execute this twice assuming KV_FULL is populated. 210 # no need to execute this twice assuming KV_FULL is populated.
101 # we can force by unsetting KV_FULL 211 # we can force by unsetting KV_FULL
102 if [ -n "${KV_FULL}" ] 212 [ -n "${KV_FULL}" ] && return
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 213
109 # if we dont know KV_FULL, then we need too. 214 # 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 215 # make sure KV_DIR isnt set since we need to work it out via KERNEL_DIR
111 unset KV_DIR 216 unset KV_DIR
112 217
113 # KV_DIR will contain the full path to the sources directory we should use 218 # KV_DIR will contain the full path to the sources directory we should use
114 einfo "Determining the location of the kernel source code" 219 qeinfo "Determining the location of the kernel source code"
115 [ -h "${KERNEL_DIR}" ] && KV_DIR="$(readlink -f ${KERNEL_DIR})" 220 [ -h "${KERNEL_DIR}" ] && KV_DIR="$(readlink -f ${KERNEL_DIR})"
116 [ -d "${KERNEL_DIR}" ] && KV_DIR="${KERNEL_DIR}" 221 [ -d "${KERNEL_DIR}" ] && KV_DIR="${KERNEL_DIR}"
117 222
118 if [ -z "${KV_DIR}" ] 223 if [ -z "${KV_DIR}" ]
119 then 224 then
120 eerror "Unable to find kernel sources at ${KERNEL_DIR}" 225 qeerror "Unable to find kernel sources at ${KERNEL_DIR}"
121 die 226 qeinfo "This package requires Linux sources."
227 if [ "${KERNEL_DIR}" == "/usr/src/linux" ] ; then
228 qeinfo "Please make sure that ${KERNEL_DIR} points at your running kernel, "
229 qeinfo "(or the kernel you wish to build against)."
230 qeinfo "Alternatively, set the KERNEL_DIR environment variable to the kernel sources location"
231 else
232 qeinfo "Please ensure that the KERNEL_DIR environment variable points at full Linux sources of the kernel you wish to compile against."
122 fi 233 fi
234 die "Cannot locate Linux sources at ${KERNEL_DIR}"
235 fi
236
237 qeinfo "Found kernel source directory:"
238 qeinfo " ${KV_DIR}"
239
240 if [ ! -s "${KV_DIR}/Makefile" ]
241 then
242 qeerror "Could not find a Makefile in the kernel source directory."
243 qeerror "Please ensure that ${KERNEL_DIR} points to a complete set of Linux sources"
244 die "Makefile not found in ${KV_DIR}"
245 fi
246
247 # OK so now we know our sources directory, but they might be using
248 # KBUILD_OUTPUT, and we need this for .config and localversions-*
249 # so we better find it eh?
250 # do we pass KBUILD_OUTPUT on the CLI?
251 OUTPUT_DIR="${OUTPUT_DIR:-${KBUILD_OUTPUT}}"
252
253 # And if we didn't pass it, we can take a nosey in the Makefile
254 kbuild_output="$(getfilevar KBUILD_OUTPUT ${KV_DIR}/Makefile)"
255 OUTPUT_DIR="${OUTPUT_DIR:-${kbuild_output}}"
123 256
124 # And contrary to existing functions I feel we shouldn't trust the 257 # And contrary to existing functions I feel we shouldn't trust the
125 # directory name to find version information as this seems insane. 258 # directory name to find version information as this seems insane.
126 # so we parse ${KV_DIR}/Makefile 259 # so we parse ${KV_DIR}/Makefile
127 KV_MAJOR="$(getfilevar VERSION ${KV_DIR}/Makefile)" 260 KV_MAJOR="$(getfilevar VERSION ${KV_DIR}/Makefile)"
128 KV_MINOR="$(getfilevar PATCHLEVEL ${KV_DIR}/Makefile)" 261 KV_MINOR="$(getfilevar PATCHLEVEL ${KV_DIR}/Makefile)"
129 KV_PATCH="$(getfilevar SUBLEVEL ${KV_DIR}/Makefile)" 262 KV_PATCH="$(getfilevar SUBLEVEL ${KV_DIR}/Makefile)"
130 KV_EXTRA="$(getfilevar EXTRAVERSION ${KV_DIR}/Makefile)" 263 KV_EXTRA="$(getfilevar EXTRAVERSION ${KV_DIR}/Makefile)"
264
265 if [ -z "${KV_MAJOR}" -o -z "${KV_MINOR}" -o -z "${KV_PATCH}" ]
266 then
267 qeerror "Could not detect kernel version."
268 qeerror "Please ensure that ${KERNEL_DIR} points to a complete set of Linux sources"
269 die "Could not parse version info from ${KV_DIR}/Makefile"
270 fi
271
131 # and in newer versions we can also pull LOCALVERSION if it is set. 272 # 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')" 273 # but before we do this, we need to find if we use a different object directory.
274 # This *WILL* break if the user is using localversions, but we assume it was
275 # caught before this if they are.
276 [ "${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}.${KV_EXTRA}" == "$(uname -r)" ] && \
277 OUTPUT_DIR="${OUTPUT_DIR:-/lib/modules/${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}.${KV_EXTRA}/build}"
278
279 [ -h "${OUTPUT_DIR}" ] && KV_OUT_DIR="$(readlink -f ${OUTPUT_DIR})"
280 [ -d "${OUTPUT_DIR}" ] && KV_OUT_DIR="${OUTPUT_DIR}"
281 if [ -n "${KV_OUT_DIR}" ];
282 then
283 qeinfo "Found kernel object directory:"
284 qeinfo " ${KV_OUT_DIR}"
285
286 KV_LOCAL="$(cat ${KV_OUT_DIR}/localversion* 2>/dev/null)"
287 fi
288 # and if we STILL haven't got it, then we better just set it to KV_DIR
289 KV_OUT_DIR="${KV_OUT_DIR:-${KV_DIR}}"
290
291 KV_LOCAL="${KV_LOCAL}$(cat ${KV_DIR}/localversion* 2>/dev/null)"
292 KV_LOCAL="${KV_LOCAL}$(linux_chkconfig_string LOCALVERSION)"
293 KV_LOCAL="${KV_LOCAL//\"/}"
133 294
134 # And we should set KV_FULL to the full expanded version 295 # And we should set KV_FULL to the full expanded version
135 KV_FULL="${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}${KV_EXTRA}${KV_LOCAL}" 296 KV_FULL="${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}${KV_EXTRA}${KV_LOCAL}"
136 297
137 if [ -z "${KV_FULL}" ]
138 then
139 eerror "We are unable to find a usable kernel source tree in ${KV_DIR}"
140 eerror "Please check a kernel source exists in this directory."
141 die
142 else
143 einfo "Found kernel source directory:"
144 einfo " ${KV_DIR}"
145 einfo "with sources for kernel version:" 298 qeinfo "Found sources for kernel version:"
146 einfo " ${KV_FULL}" 299 qeinfo " ${KV_FULL}"
300
301 if [ ! -s "${KV_OUT_DIR}/.config" ]
302 then
303 qeerror "Could not find a usable .config in the kernel source directory."
304 qeerror "Please ensure that ${KERNEL_DIR} points to a configured set of Linux sources"
305 die ".config not found in ${KV_OUT_DIR}"
147 fi 306 fi
148} 307}
149 308
150 309
151 310
155 314
156check_kernel_built() { 315check_kernel_built() {
157 # if we haven't determined the version yet, we need too. 316 # if we haven't determined the version yet, we need too.
158 get_version; 317 get_version;
159 318
160 if [ ! -f "${KV_DIR}/System.map" ] 319 if [ ! -f "${KV_OUT_DIR}/System.map" ]
161 then 320 then
162 eerror "These sources have not yet been compiled." 321 eerror "These sources have not yet been compiled."
163 eerror "We cannot build against an uncompiled tree." 322 eerror "We cannot build against an uncompiled tree."
164 eerror "To resolve this, please type the following:" 323 eerror "To resolve this, please type the following:"
165 eerror 324 eerror
174 333
175check_modules_supported() { 334check_modules_supported() {
176 # if we haven't determined the version yet, we need too. 335 # if we haven't determined the version yet, we need too.
177 get_version; 336 get_version;
178 337
179 getfilevar_isset CONFIG_MODULES ${KV_DIR}/.config 338 if ! linux_chkconfig_builtin "MODULES"
180 if [ "$?" != 0 ]
181 then 339 then
182 eerror "These sources do not support loading external modules." 340 eerror "These sources do not support loading external modules."
183 eerror "to be able to use this module please enable \"Loadable modules support\"" 341 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." 342 eerror "in your kernel, recompile and then try merging this module again."
185 die No support for external modules in ${KV_FUll} config 343 die "No support for external modules in ${KV_FULL} config"
186 fi 344 fi
187} 345}
188 346
189check_extra_config() { 347check_extra_config() {
190local config negate error 348local config negate error local_error
191 349
192 # if we haven't determined the version yet, we need too. 350 # if we haven't determined the version yet, we need too.
193 get_version; 351 get_version;
194 352
195 einfo "Checking for suitable kernel configuration options" 353 einfo "Checking for suitable kernel configuration options"
197 do 355 do
198 negate="${config:0:1}" 356 negate="${config:0:1}"
199 if [ "${negate}" == "!" ]; 357 if [ "${negate}" == "!" ];
200 then 358 then
201 config="${config:1}" 359 config="${config:1}"
202 if getfilevar_isset ${config} ${KV_DIR}/.config ; 360 if linux_chkconfig_present ${config}
203 then 361 then
362 local_error="${config}_ERROR"
363 local_error="${!local_error}"
364 [ -n "${local_error}" ] && eerror " ${local_error}" || \
204 eerror " ${config}:\tshould not be set in the kernel configuration, but it is." 365 eerror " CONFIG_${config}:\tshould not be set in the kernel configuration, but it is."
205 error=1 366 error=1
206 fi 367 fi
207 else 368 else
208 if ! getfilevar_isset ${config} ${KV_DIR}/.config ; 369 if ! linux_chkconfig_present ${config}
209 then 370 then
371 local_error="${config}_ERROR"
372 local_error="${!local_error}"
373 [ -n "${local_error}" ] && eerror " ${local_error}" || \
210 eerror " ${config}:\tshould be set in the kernel configuration, but isn't" 374 eerror " CONFIG_${config}:\tshould be set in the kernel configuration, but isn't"
211 error=1 375 error=1
212 fi 376 fi
213 fi 377 fi
214 done 378 done
215 379
216 if [ -n "${error}" ] ; 380 if [ -n "${error}" ] ;
217 then 381 then
218 eerror "Please check to make sure these options are set correctly." 382 eerror "Please check to make sure these options are set correctly."
219 eerror "Once you have satisfied these options, please try merging" 383 eerror "Once you have satisfied these options, please try merging"
220 eerror "this package again." 384 eerror "this package again."
221 die Incorrect kernel configuration options 385 die "Incorrect kernel configuration options"
222 fi 386 fi
223} 387}
224 388
225check_zlibinflate() { 389check_zlibinflate() {
226 # if we haven't determined the version yet, we need too. 390 # if we haven't determined the version yet, we need too.
258 422
259 LINENO_END="$(grep -n 'CONFIG_ZLIB_INFLATE y' ${KV_DIR}/lib/Config.in | cut -d : -f 1)" 423 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)" 424 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 )) 425 (( LINENO_AMOUNT = $LINENO_END - $LINENO_START ))
262 (( LINENO_END = $LINENO_END - 1 )) 426 (( 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;')" 427 SYMBOLS="$(head -n $LINENO_END ${KV_DIR}/lib/Config.in | tail -n $LINENO_AMOUNT | sed -e 's/^.*\(CONFIG_[^\" ]*\).*/\1/g;')"
264 428
265 # okay, now we have a list of symbols 429 # 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 430 # we need to check each one in turn, to see whether it is set or not
267 for x in $SYMBOLS ; do 431 for x in $SYMBOLS ; do
268 if [ "${!x}" = "y" ]; then 432 if [ "${!x}" = "y" ]; then
289 eerror "Please remember to recompile and install your kernel, and reboot" 453 eerror "Please remember to recompile and install your kernel, and reboot"
290 eerror "into your new kernel before attempting to load this kernel module." 454 eerror "into your new kernel before attempting to load this kernel module."
291 455
292 die "Kernel doesn't include zlib support" 456 die "Kernel doesn't include zlib support"
293} 457}
458
459################################
460# Default pkg_setup
461# Also used when inheriting linux-mod to force a get_version call
462
463linux-info_pkg_setup() {
464 get_version;
465 [ -n "${CONFIG_CHECK}" ] && check_extra_config;
466}

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.11

  ViewVC Help
Powered by ViewVC 1.1.20