/[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.1 Revision 1.10
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.1 2004/11/24 16:36:38 johnm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/linux-info.eclass,v 1.10 2004/12/14 18:56:46 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}
17 78
18# File Functions 79# File Functions
19# --------------------------------------- 80# ---------------------------------------
20 81
21# getfilevar accepts 2 vars as follows: 82# getfilevar accepts 2 vars as follows:
22# getfilevar <VARIABLE> <CONFIGFILE> 83# getfilevar <VARIABLE> <CONFIGFILE>
23 84
24getfilevar() { 85getfilevar() {
25local ERROR 86local ERROR workingdir basefname basedname xarch
26 ERROR=0 87 ERROR=0
27 88
28 [ -z "${1}" ] && ERROR=1 89 [ -z "${1}" ] && ERROR=1
29 [ -z "${2}" ] && ERROR=1
30 [ ! -f "${2}" ] && ERROR=1 90 [ ! -f "${2}" ] && ERROR=1
31 91
32 if [ "${ERROR}" = 1 ] 92 if [ "${ERROR}" = 1 ]
33 then 93 then
94 ebeep
95 echo -e "\n"
34 eerror "getfilevar requires 2 variables, with the second a valid file." 96 eerror "getfilevar requires 2 variables, with the second a valid file."
35 eerror " getfilevar <VARIABLE> <CONFIGFILE>" 97 eerror " getfilevar <VARIABLE> <CONFIGFILE>"
36 else 98 else
37 grep -e "^$1" $2 | sed 's: = :=:' | cut -d= -f2- 99 workingdir=${PWD}
100 basefname=$(basename ${2})
101 basedname=$(dirname ${2})
102 xarch=${ARCH}
103 unset ARCH
104
105 cd ${basedname}
106 echo -e "include ${basefname}\ne:\n\t@echo \$(${1})" | \
107 make -f - e 2>/dev/null
108 cd ${workingdir}
109
110 ARCH=${xarch}
38 fi 111 fi
39} 112}
40 113
41getfilevar_isset() { 114linux_chkconfig_present() {
42local RESULT 115local RESULT
43 RESULT="$(getfilevar ${1} ${2})" 116 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
44 [ "${RESULT}" = "m" -o "${RESULT}" = "y" ] && return 0 || return 1 117 [ "${RESULT}" = "m" -o "${RESULT}" = "y" ] && return 0 || return 1
45} 118}
46 119
47getfilevar_ismodule() { 120linux_chkconfig_module() {
48local RESULT 121local RESULT
49 RESULT="$(getfilevar ${1} ${2})" 122 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
50 [ "${RESULT}" = "m" ] && return 0 || return 1 123 [ "${RESULT}" = "m" ] && return 0 || return 1
51} 124}
52 125
53getfilevar_isbuiltin() { 126linux_chkconfig_builtin() {
54local RESULT 127local RESULT
55 RESULT="$(getfilevar ${1} ${2})" 128 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
56 [ "${RESULT}" = "y" ] && return 0 || return 1 129 [ "${RESULT}" = "y" ] && return 0 || return 1
130}
131
132linux_chkconfig_string() {
133 getfilevar "CONFIG_${1}" "${KV_OUT_DIR}/.config"
57} 134}
58 135
59# Versioning Functions 136# Versioning Functions
60# --------------------------------------- 137# ---------------------------------------
61 138
95 fi 172 fi
96 return ${RESULT} 173 return ${RESULT}
97} 174}
98 175
99get_version() { 176get_version() {
177 local kbuild_output
178
100 # no need to execute this twice assuming KV_FULL is populated. 179 # no need to execute this twice assuming KV_FULL is populated.
101 # we can force by unsetting KV_FULL 180 # we can force by unsetting KV_FULL
102 if [ -n "${KV_FULL}" ] 181 [ -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 182
109 # if we dont know KV_FULL, then we need too. 183 # 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 184 # make sure KV_DIR isnt set since we need to work it out via KERNEL_DIR
111 unset KV_DIR 185 unset KV_DIR
112 186
116 [ -d "${KERNEL_DIR}" ] && KV_DIR="${KERNEL_DIR}" 190 [ -d "${KERNEL_DIR}" ] && KV_DIR="${KERNEL_DIR}"
117 191
118 if [ -z "${KV_DIR}" ] 192 if [ -z "${KV_DIR}" ]
119 then 193 then
120 eerror "Unable to find kernel sources at ${KERNEL_DIR}" 194 eerror "Unable to find kernel sources at ${KERNEL_DIR}"
121 die 195 einfo "This package requires Linux sources."
196 if [ "${KERNEL_DIR}" == "/usr/src/linux" ] ; then
197 einfo "Please make sure that ${KERNEL_DIR} points at your running kernel, "
198 einfo "(or the kernel you wish to build against)."
199 einfo "Alternatively, set the KERNEL_DIR environment variable to the kernel sources location"
200 else
201 einfo "Please ensure that the KERNEL_DIR environment variable points at full Linux sources of the kernel you wish to compile against."
122 fi 202 fi
203 die "Cannot locate Linux sources at ${KERNEL_DIR}"
204 fi
205
206 einfo "Found kernel source directory:"
207 einfo " ${KV_DIR}"
208
209 if [ ! -s "${KV_DIR}/Makefile" ]
210 then
211 eerror "Could not find a Makefile in the kernel source directory."
212 eerror "Please ensure that ${KERNEL_DIR} points to a complete set of Linux sources"
213 die "Makefile not found in ${KV_DIR}"
214 fi
215
216 # OK so now we know our sources directory, but they might be using
217 # KBUILD_OUTPUT, and we need this for .config and localversions-*
218 # so we better find it eh?
219 # do we pass KBUILD_OUTPUT on the CLI?
220 OUTPUT_DIR="${OUTPUT_DIR:-${KBUILD_OUTPUT}}"
221
222 # And if we didn't pass it, we can take a nosey in the Makefile
223 kbuild_output="$(getfilevar KBUILD_OUTPUT ${KV_DIR}/Makefile)"
224 OUTPUT_DIR="${OUTPUT_DIR:-${kbuild_output}}"
123 225
124 # And contrary to existing functions I feel we shouldn't trust the 226 # And contrary to existing functions I feel we shouldn't trust the
125 # directory name to find version information as this seems insane. 227 # directory name to find version information as this seems insane.
126 # so we parse ${KV_DIR}/Makefile 228 # so we parse ${KV_DIR}/Makefile
127 KV_MAJOR="$(getfilevar VERSION ${KV_DIR}/Makefile)" 229 KV_MAJOR="$(getfilevar VERSION ${KV_DIR}/Makefile)"
128 KV_MINOR="$(getfilevar PATCHLEVEL ${KV_DIR}/Makefile)" 230 KV_MINOR="$(getfilevar PATCHLEVEL ${KV_DIR}/Makefile)"
129 KV_PATCH="$(getfilevar SUBLEVEL ${KV_DIR}/Makefile)" 231 KV_PATCH="$(getfilevar SUBLEVEL ${KV_DIR}/Makefile)"
130 KV_EXTRA="$(getfilevar EXTRAVERSION ${KV_DIR}/Makefile)" 232 KV_EXTRA="$(getfilevar EXTRAVERSION ${KV_DIR}/Makefile)"
233
234 if [ -z "${KV_MAJOR}" -o -z "${KV_MINOR}" -o -z "${KV_PATCH}" ]
235 then
236 eerror "Could not detect kernel version."
237 eerror "Please ensure that ${KERNEL_DIR} points to a complete set of Linux sources"
238 die "Could not parse version info from ${KV_DIR}/Makefile"
239 fi
240
131 # and in newer versions we can also pull LOCALVERSION if it is set. 241 # 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')" 242 # but before we do this, we need to find if we use a different object directory.
243 # This *WILL* break if the user is using localversions, but we assume it was
244 # caught before this if they are.
245 [ "${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}.${KV_EXTRA}" == "$(uname -r)" ] && \
246 OUTPUT_DIR="${OUTPUT_DIR:-/lib/modules/${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}.${KV_EXTRA}/build}"
247
248 [ -h "${OUTPUT_DIR}" ] && KV_OUT_DIR="$(readlink -f ${OUTPUT_DIR})"
249 [ -d "${OUTPUT_DIR}" ] && KV_OUT_DIR="${OUTPUT_DIR}"
250 if [ -n "${KV_OUT_DIR}" ];
251 then
252 einfo "Found kernel object directory:"
253 einfo " ${KV_OUT_DIR}"
254
255 KV_LOCAL="$(cat ${KV_OUT_DIR}/localversion* 2>/dev/null)"
256 fi
257 # and if we STILL haven't got it, then we better just set it to KV_DIR
258 KV_OUT_DIR="${KV_OUT_DIR:-${KV_DIR}}"
259
260 KV_LOCAL="${KV_LOCAL}$(cat ${KV_DIR}/localversion* 2>/dev/null)"
261 KV_LOCAL="${KV_LOCAL}$(linux_chkconfig_string LOCALVERSION)"
262 KV_LOCAL="${KV_LOCAL//\"/}"
133 263
134 # And we should set KV_FULL to the full expanded version 264 # And we should set KV_FULL to the full expanded version
135 KV_FULL="${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}${KV_EXTRA}${KV_LOCAL}" 265 KV_FULL="${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}${KV_EXTRA}${KV_LOCAL}"
136 266
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:" 267 einfo "Found sources for kernel version:"
146 einfo " ${KV_FULL}" 268 einfo " ${KV_FULL}"
269
270 if [ ! -s "${KV_OUT_DIR}/.config" ]
271 then
272 eerror "Could not find a usable .config in the kernel source directory."
273 eerror "Please ensure that ${KERNEL_DIR} points to a configured set of Linux sources"
274 die ".config not found in ${KV_OUT_DIR}"
147 fi 275 fi
148} 276}
149 277
150 278
151 279
155 283
156check_kernel_built() { 284check_kernel_built() {
157 # if we haven't determined the version yet, we need too. 285 # if we haven't determined the version yet, we need too.
158 get_version; 286 get_version;
159 287
160 if [ ! -f "${KV_DIR}/System.map" ] 288 if [ ! -f "${KV_OUT_DIR}/System.map" ]
161 then 289 then
162 eerror "These sources have not yet been compiled." 290 eerror "These sources have not yet been compiled."
163 eerror "We cannot build against an uncompiled tree." 291 eerror "We cannot build against an uncompiled tree."
164 eerror "To resolve this, please type the following:" 292 eerror "To resolve this, please type the following:"
165 eerror 293 eerror
174 302
175check_modules_supported() { 303check_modules_supported() {
176 # if we haven't determined the version yet, we need too. 304 # if we haven't determined the version yet, we need too.
177 get_version; 305 get_version;
178 306
179 getfilevar_isset CONFIG_MODULES ${KV_DIR}/.config 307 if ! linux_chkconfig_builtin "MODULES"
180 if [ "$?" != 0 ]
181 then 308 then
182 eerror "These sources do not support loading external modules." 309 eerror "These sources do not support loading external modules."
183 eerror "to be able to use this module please enable \"Loadable modules support\"" 310 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." 311 eerror "in your kernel, recompile and then try merging this module again."
312 die "No support for external modules in ${KV_FULL} config"
313 fi
314}
315
316check_extra_config() {
317local config negate error local_error
318
319 # if we haven't determined the version yet, we need too.
320 get_version;
321
322 einfo "Checking for suitable kernel configuration options"
323 for config in ${CONFIG_CHECK}
324 do
325 negate="${config:0:1}"
326 if [ "${negate}" == "!" ];
327 then
328 config="${config:1}"
329 if linux_chkconfig_present ${config}
330 then
331 local_error="${config}_ERROR"
332 local_error="${!local_error}"
333 [ -n "${local_error}" ] && eerror " ${local_error}" || \
334 eerror " CONFIG_${config}:\tshould not be set in the kernel configuration, but it is."
335 error=1
336 fi
337 else
338 if ! linux_chkconfig_present ${config}
339 then
340 local_error="${config}_ERROR"
341 local_error="${!local_error}"
342 [ -n "${local_error}" ] && eerror " ${local_error}" || \
343 eerror " CONFIG_${config}:\tshould be set in the kernel configuration, but isn't"
344 error=1
345 fi
346 fi
347 done
348
349 if [ -n "${error}" ] ;
350 then
351 eerror "Please check to make sure these options are set correctly."
352 eerror "Once you have satisfied these options, please try merging"
353 eerror "this package again."
354 die "Incorrect kernel configuration options"
185 fi 355 fi
186} 356}
187 357
188check_zlibinflate() { 358check_zlibinflate() {
189 # if we haven't determined the version yet, we need too. 359 # if we haven't determined the version yet, we need too.
221 391
222 LINENO_END="$(grep -n 'CONFIG_ZLIB_INFLATE y' ${KV_DIR}/lib/Config.in | cut -d : -f 1)" 392 LINENO_END="$(grep -n 'CONFIG_ZLIB_INFLATE y' ${KV_DIR}/lib/Config.in | cut -d : -f 1)"
223 LINENO_START="$(head -n $LINENO_END ${KV_DIR}/lib/Config.in | grep -n 'if \[' | tail -n 1 | cut -d : -f 1)" 393 LINENO_START="$(head -n $LINENO_END ${KV_DIR}/lib/Config.in | grep -n 'if \[' | tail -n 1 | cut -d : -f 1)"
224 (( LINENO_AMOUNT = $LINENO_END - $LINENO_START )) 394 (( LINENO_AMOUNT = $LINENO_END - $LINENO_START ))
225 (( LINENO_END = $LINENO_END - 1 )) 395 (( LINENO_END = $LINENO_END - 1 ))
226 SYMBOLS="$(head -n $LINENO_END ${KERNEL_DIR}/lib/Config.in | tail -n $LINENO_AMOUNT | sed -e 's/^.*\(CONFIG_[^\" ]*\).*/\1/g;')" 396 SYMBOLS="$(head -n $LINENO_END ${KV_DIR}/lib/Config.in | tail -n $LINENO_AMOUNT | sed -e 's/^.*\(CONFIG_[^\" ]*\).*/\1/g;')"
227 397
228 # okay, now we have a list of symbols 398 # okay, now we have a list of symbols
229 # we need to check each one in turn, to see whether it is set or not 399 # we need to check each one in turn, to see whether it is set or not
230 for x in $SYMBOLS ; do 400 for x in $SYMBOLS ; do
231 if [ "${!x}" = "y" ]; then 401 if [ "${!x}" = "y" ]; then
252 eerror "Please remember to recompile and install your kernel, and reboot" 422 eerror "Please remember to recompile and install your kernel, and reboot"
253 eerror "into your new kernel before attempting to load this kernel module." 423 eerror "into your new kernel before attempting to load this kernel module."
254 424
255 die "Kernel doesn't include zlib support" 425 die "Kernel doesn't include zlib support"
256} 426}
427
428################################
429# Default pkg_setup
430# Also used when inheriting linux-mod to force a get_version call
431
432linux-info_pkg_setup() {
433 get_version;
434 [ -n "${CONFIG_CHECK}" ] && check_extra_config;
435}

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.10

  ViewVC Help
Powered by ViewVC 1.1.20