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

Contents of /eclass/linux-info.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.43 - (show annotations) (download)
Sun May 7 22:14:25 2006 UTC (8 years, 2 months ago) by mrness
Branch: MAIN
Changes since 1.42: +30 -27 lines
check_extra_config() : correct result report and die decision

1 # Copyright 1999-2006 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/linux-info.eclass,v 1.42 2006/03/03 22:11:28 johnm 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 #
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 # To simply warn about a missing option, prepend a '~'.
28 # ERROR_CFG <string> The error message to display when the above check
29 # fails. <CFG> should reference the appropriate option
30 # as above. ie: ERROR_MTRR="MTRR exists in the .config
31 # but shouldn't!!"
32 # KBUILD_OUTPUT <string> This is passed on commandline, or can be set from
33 # the kernel makefile. This contains the directory
34 # which is to be used as the kernel object directory.
35
36 # There are also a couple of variables which are set by this, and shouldn't be
37 # set by hand. These are as follows:
38 #
39 # Env Var Option Description
40 # KV_FULL <string> The full kernel version. ie: 2.6.9-gentoo-johnm-r1
41 # KV_MAJOR <integer> The kernel major version. ie: 2
42 # KV_MINOR <integer> The kernel minor version. ie: 6
43 # KV_PATCH <integer> The kernel patch version. ie: 9
44 # KV_EXTRA <string> The kernel EXTRAVERSION. ie: -gentoo
45 # KV_LOCAL <string> The kernel LOCALVERSION concatenation. ie: -johnm
46 # KV_DIR <string> The kernel source directory, will be null if
47 # KERNEL_DIR is invalid.
48 # KV_OUT_DIR <string> The kernel object directory. will be KV_DIR unless
49 # koutput is used. This should be used for referencing
50 # .config.
51
52 # And to ensure all the weirdness with crosscompile
53 inherit toolchain-funcs versionator
54
55 EXPORT_FUNCTIONS pkg_setup
56
57 DEPEND="kernel_linux? ( virtual/linux-sources )"
58 RDEPEND=""
59
60 # Overwritable environment Var's
61 # ---------------------------------------
62 KERNEL_DIR="${KERNEL_DIR:-${ROOT}usr/src/linux}"
63
64
65 # Bug fixes
66 # fix to bug #75034
67 case ${ARCH} in
68 ppc) BUILD_FIXES="${BUILD_FIXES} TOUT=${T}/.tmp_gas_check";;
69 ppc64) BUILD_FIXES="${BUILD_FIXES} TOUT=${T}/.tmp_gas_check";;
70 esac
71
72 # These are legacy wrappers for toolchain-funcs.
73 # I dont like them here, but oh well.
74 set_arch_to_kernel() { export ARCH="$(tc-arch-kernel)"; }
75 set_arch_to_portage() { export ARCH="$(tc-arch)"; }
76
77 # qeinfo "Message"
78 # -------------------
79 # qeinfo is a quiet einfo call when EBUILD_PHASE
80 # should not have visible output.
81 qout() {
82 local outputmsg type
83 type=${1}
84 shift
85 outputmsg="${@}"
86 case "${EBUILD_PHASE}" in
87 depend) unset outputmsg;;
88 clean) unset outputmsg;;
89 preinst) unset outputmsg;;
90 esac
91 [ -n "${outputmsg}" ] && ${type} "${outputmsg}"
92 }
93
94 qeinfo() { qout einfo "${@}" ; }
95 qeerror() { qout eerror "${@}" ; }
96
97 # File Functions
98 # ---------------------------------------
99
100 # getfilevar accepts 2 vars as follows:
101 # getfilevar <VARIABLE> <CONFIGFILE>
102
103 getfilevar() {
104 local ERROR workingdir basefname basedname myARCH="${ARCH}"
105 ERROR=0
106
107 [ -z "${1}" ] && ERROR=1
108 [ ! -f "${2}" ] && ERROR=1
109
110 if [ "${ERROR}" = 1 ]
111 then
112 echo -e "\n"
113 eerror "getfilevar requires 2 variables, with the second a valid file."
114 eerror " getfilevar <VARIABLE> <CONFIGFILE>"
115 else
116 workingdir="${PWD}"
117 basefname="$(basename ${2})"
118 basedname="$(dirname ${2})"
119 unset ARCH
120
121 cd "${basedname}"
122 echo -e "e:\\n\\t@echo \$(${1})\\ninclude ${basefname}" | \
123 make ${BUILD_FIXES} -s -f - 2>/dev/null
124 cd "${workingdir}"
125
126 ARCH=${myARCH}
127 fi
128 }
129
130 linux_chkconfig_present() {
131 local RESULT
132 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
133 [ "${RESULT}" = "m" -o "${RESULT}" = "y" ] && return 0 || return 1
134 }
135
136 linux_chkconfig_module() {
137 local RESULT
138 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
139 [ "${RESULT}" = "m" ] && return 0 || return 1
140 }
141
142 linux_chkconfig_builtin() {
143 local RESULT
144 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
145 [ "${RESULT}" = "y" ] && return 0 || return 1
146 }
147
148 linux_chkconfig_string() {
149 getfilevar "CONFIG_${1}" "${KV_OUT_DIR}/.config"
150 }
151
152 # Versioning Functions
153 # ---------------------------------------
154
155 # kernel_is returns true when the version is the same as the passed version
156 #
157 # For Example where KV = 2.6.9
158 # kernel_is 2 4 returns false
159 # kernel_is 2 returns true
160 # kernel_is 2 6 returns true
161 # kernel_is 2 6 8 returns false
162 # kernel_is 2 6 9 returns true
163 #
164 # got the jist yet?
165
166 kernel_is() {
167 # if we haven't determined the version yet, we need too.
168 get_version;
169 local operator test value x=0 y=0 z=0
170
171 case ${1} in
172 lt) operator="-lt"; shift;;
173 gt) operator="-gt"; shift;;
174 le) operator="-le"; shift;;
175 ge) operator="-ge"; shift;;
176 eq) operator="-eq"; shift;;
177 *) operator="-eq";;
178 esac
179
180 for x in ${@}; do
181 for((y=0; y<$((3 - ${#x})); y++)); do value="${value}0"; done
182 value="${value}${x}"
183 z=$((${z} + 1))
184
185 case ${z} in
186 1) for((y=0; y<$((3 - ${#KV_MAJOR})); y++)); do test="${test}0"; done;
187 test="${test}${KV_MAJOR}";;
188 2) for((y=0; y<$((3 - ${#KV_MINOR})); y++)); do test="${test}0"; done;
189 test="${test}${KV_MINOR}";;
190 3) for((y=0; y<$((3 - ${#KV_PATCH})); y++)); do test="${test}0"; done;
191 test="${test}${KV_PATCH}";;
192 *) die "Error in kernel-2_kernel_is(): Too many parameters.";;
193 esac
194 done
195
196 [ ${test} ${operator} ${value} ] && return 0 || return 1
197 }
198
199 get_localversion() {
200 local lv_list i x
201
202 # ignore files with ~ in it.
203 for i in $(ls ${1}/localversion* 2>/dev/null); do
204 [[ -n ${i//*~*} ]] && lv_list="${lv_list} ${i}"
205 done
206
207 for i in ${lv_list}; do
208 x="${x}$(<${i})"
209 done
210 x=${x/ /}
211 echo ${x}
212 }
213
214 get_version() {
215 local kbuild_output
216
217 # no need to execute this twice assuming KV_FULL is populated.
218 # we can force by unsetting KV_FULL
219 [ -n "${KV_FULL}" ] && return 0
220
221 # if we dont know KV_FULL, then we need too.
222 # make sure KV_DIR isnt set since we need to work it out via KERNEL_DIR
223 unset KV_DIR
224
225 # KV_DIR will contain the full path to the sources directory we should use
226 qeinfo "Determining the location of the kernel source code"
227 [ -h "${KERNEL_DIR}" ] && KV_DIR="$(readlink -f ${KERNEL_DIR})"
228 [ -d "${KERNEL_DIR}" ] && KV_DIR="${KERNEL_DIR}"
229
230 if [ -z "${KV_DIR}" ]
231 then
232 qeerror "Unable to find kernel sources at ${KERNEL_DIR}"
233 qeinfo "This package requires Linux sources."
234 if [ "${KERNEL_DIR}" == "/usr/src/linux" ] ; then
235 qeinfo "Please make sure that ${KERNEL_DIR} points at your running kernel, "
236 qeinfo "(or the kernel you wish to build against)."
237 qeinfo "Alternatively, set the KERNEL_DIR environment variable to the kernel sources location"
238 else
239 qeinfo "Please ensure that the KERNEL_DIR environment variable points at full Linux sources of the kernel you wish to compile against."
240 fi
241 return 1
242 fi
243
244 qeinfo "Found kernel source directory:"
245 qeinfo " ${KV_DIR}"
246
247 if [ ! -s "${KV_DIR}/Makefile" ]
248 then
249 qeerror "Could not find a Makefile in the kernel source directory."
250 qeerror "Please ensure that ${KERNEL_DIR} points to a complete set of Linux sources"
251 return 1
252 fi
253
254 # OK so now we know our sources directory, but they might be using
255 # KBUILD_OUTPUT, and we need this for .config and localversions-*
256 # so we better find it eh?
257 # do we pass KBUILD_OUTPUT on the CLI?
258 OUTPUT_DIR="${OUTPUT_DIR:-${KBUILD_OUTPUT}}"
259
260 # And if we didn't pass it, we can take a nosey in the Makefile
261 kbuild_output="$(getfilevar KBUILD_OUTPUT ${KV_DIR}/Makefile)"
262 OUTPUT_DIR="${OUTPUT_DIR:-${kbuild_output}}"
263
264 # And contrary to existing functions I feel we shouldn't trust the
265 # directory name to find version information as this seems insane.
266 # so we parse ${KV_DIR}/Makefile
267 KV_MAJOR="$(getfilevar VERSION ${KV_DIR}/Makefile)"
268 KV_MINOR="$(getfilevar PATCHLEVEL ${KV_DIR}/Makefile)"
269 KV_PATCH="$(getfilevar SUBLEVEL ${KV_DIR}/Makefile)"
270 KV_EXTRA="$(getfilevar EXTRAVERSION ${KV_DIR}/Makefile)"
271
272 if [ -z "${KV_MAJOR}" -o -z "${KV_MINOR}" -o -z "${KV_PATCH}" ]
273 then
274 qeerror "Could not detect kernel version."
275 qeerror "Please ensure that ${KERNEL_DIR} points to a complete set of Linux sources."
276 return 1
277 fi
278
279 # and in newer versions we can also pull LOCALVERSION if it is set.
280 # but before we do this, we need to find if we use a different object directory.
281 # This *WILL* break if the user is using localversions, but we assume it was
282 # caught before this if they are.
283 [ "${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}.${KV_EXTRA}" == "$(uname -r)" ] && \
284 OUTPUT_DIR="${OUTPUT_DIR:-/lib/modules/${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}.${KV_EXTRA}/build}"
285
286 [ -h "${OUTPUT_DIR}" ] && KV_OUT_DIR="$(readlink -f ${OUTPUT_DIR})"
287 [ -d "${OUTPUT_DIR}" ] && KV_OUT_DIR="${OUTPUT_DIR}"
288 if [ -n "${KV_OUT_DIR}" ];
289 then
290 qeinfo "Found kernel object directory:"
291 qeinfo " ${KV_OUT_DIR}"
292
293 KV_LOCAL="$(get_localversion ${KV_OUT_DIR})"
294 fi
295 # and if we STILL have not got it, then we better just set it to KV_DIR
296 KV_OUT_DIR="${KV_OUT_DIR:-${KV_DIR}}"
297
298 if [ ! -s "${KV_OUT_DIR}/.config" ]
299 then
300 qeerror "Could not find a usable .config in the kernel source directory."
301 qeerror "Please ensure that ${KERNEL_DIR} points to a configured set of Linux sources."
302 qeerror "If you are using KBUILD_OUTPUT, please set the environment var so that"
303 qeerror "it points to the necessary object directory so that it might find .config."
304 return 1
305 fi
306
307 KV_LOCAL="${KV_LOCAL}$(get_localversion ${KV_DIR})"
308 KV_LOCAL="${KV_LOCAL}$(linux_chkconfig_string LOCALVERSION)"
309 KV_LOCAL="${KV_LOCAL//\"/}"
310
311 # And we should set KV_FULL to the full expanded version
312 KV_FULL="${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}${KV_EXTRA}${KV_LOCAL}"
313
314 qeinfo "Found sources for kernel version:"
315 qeinfo " ${KV_FULL}"
316
317 return 0
318 }
319
320 get_running_version() {
321 KV_FULL=$(uname -r)
322
323 if [[ -f ${ROOT}/lib/modules/${KV_FULL}/source/Makefile ]]; then
324 KERNEL_DIR=$(readlink -f ${ROOT}/lib/modules/${KV_FULL}/source)
325 unset KV_FULL
326 get_version
327 return $?
328 elif [[ -f ${ROOT}/lib/modules/${KV_FULL}/build/Makefile ]]; then
329 KERNEL_DIR=$(readlink -f ${ROOT}/lib/modules/${KV_FULL}/build)
330 unset KV_FULL
331 get_version
332 return $?
333 else
334 KV_MAJOR=$(get_version_component_range 1 ${KV_FULL})
335 KV_MINOR=$(get_version_component_range 2 ${KV_FULL})
336 KV_PATCH=$(get_version_component_range 3- ${KV_FULL})
337 KV_PATCH=${KV_PATCH//-*}
338 [[ -n ${KV_FULL#*-} ]] && [[ -n ${KV_FULL//${KV_FULL#*-}} ]] \
339 && KV_EXTRA="-${KV_FULL#*-}"
340 fi
341 return 0
342 }
343
344
345 # ebuild check functions
346 # ---------------------------------------
347
348 check_kernel_built() {
349 # if we haven't determined the version yet, we need too.
350 get_version;
351
352 if [ ! -f "${KV_OUT_DIR}/include/linux/version.h" ]
353 then
354 eerror "These sources have not yet been prepared."
355 eerror "We cannot build against an unprepared tree."
356 eerror "To resolve this, please type the following:"
357 eerror
358 eerror "# cd ${KV_DIR}"
359 eerror "# make oldconfig"
360 eerror "# make modules_prepare"
361 eerror
362 eerror "Then please try merging this module again."
363 die "Kernel sources need compiling first"
364 fi
365 }
366
367 check_modules_supported() {
368 # if we haven't determined the version yet, we need too.
369 get_version;
370
371 if ! linux_chkconfig_builtin "MODULES"
372 then
373 eerror "These sources do not support loading external modules."
374 eerror "to be able to use this module please enable \"Loadable modules support\""
375 eerror "in your kernel, recompile and then try merging this module again."
376 die "No support for external modules in ${KV_FULL} config"
377 fi
378 }
379
380 check_extra_config() {
381 local config negate error local_error i n
382 local temp_config die reworkmodulenames
383 local soft_errors_count=0 hard_errors_count=0
384
385 # if we haven't determined the version yet, we need too.
386 get_version;
387
388 einfo "Checking for suitable kernel configuration options..."
389 for config in ${CONFIG_CHECK}
390 do
391 # if we specify any fatal, ensure we honor them
392 die=1
393 error=0
394 negate=0
395 reworkmodulenames=0
396
397 if [[ -z ${config/\~*} ]]; then
398 die=0
399 config=${config:1}
400 fi
401 if [[ -z ${config//\!*} ]]; then
402 negate=1
403 config=${config:1}
404 fi
405 if [[ -z ${config/\@*} ]]; then
406 die=2
407 reworkmodulenames=1
408 config=${config:1}
409 fi
410
411 if [[ ${negate} == 1 ]]; then
412 linux_chkconfig_present ${config} && error=2
413 elif [[ ${reworkmodulenames} == 1 ]]; then
414 temp_config="${config//*:}"
415 config="${config//:*}"
416 if linux_chkconfig_present ${config}; then
417 for i in ${MODULE_NAMES}; do
418 n="${i//${temp_config}}"
419 [[ -z ${n//\(*} ]] && \
420 MODULE_IGNORE="${MODULE_IGNORE} ${temp_config}"
421 done
422 error=2
423 fi
424 else
425 linux_chkconfig_present ${config} || error=1
426 fi
427
428 if [[ ${error} > 0 ]]; then
429 if [[ ${die} == 0 ]]; then
430 soft_errors_count=$[soft_errors_count + 1]
431 else
432 hard_errors_count=$[hard_errors_count + 1]
433 fi
434 local_error="ERROR_${config}"
435 local_error="${!local_error}"
436
437 if [[ -z "${local_error}" ]]; then
438 # using old, deprecated format.
439 local_error="${config}_ERROR"
440 local_error="${!local_error}"
441 fi
442
443 if [[ -z "${local_error}" ]]; then
444 [[ ${error} == 1 ]] \
445 && local_error="is not set when it should be." \
446 || local_error="should not be set. But it is."
447 local_error="CONFIG_${config}:\t ${local_error}"
448 fi
449 eerror " ${local_error}"
450 fi
451 done
452
453 if [[ $[soft_errors_count + hard_errors_count] > 0 ]]; then
454 eerror "Please check to make sure these options are set correctly."
455 eerror "Failure to do so may cause unexpected problems."
456 if [[ ${hard_errors_count} > 0 ]]; then
457 eerror "Once you have satisfied these options, please try merging"
458 eerror "this package again."
459 die "Incorrect kernel configuration options"
460 fi
461 else
462 eend 0
463 fi
464 }
465
466 check_zlibinflate() {
467 # if we haven't determined the version yet, we need too.
468 get_version;
469
470 # although I restructured this code - I really really really dont support it!
471
472 # bug #27882 - zlib routines are only linked into the kernel
473 # if something compiled into the kernel calls them
474 #
475 # plus, for the cloop module, it appears that there's no way
476 # to get cloop.o to include a static zlib if CONFIG_MODVERSIONS
477 # is on
478
479 local INFLATE
480 local DEFLATE
481
482 einfo "Determining the usability of ZLIB_INFLATE support in your kernel"
483
484 ebegin "checking ZLIB_INFLATE"
485 getfilevar_isbuiltin CONFIG_ZLIB_INFLATE ${KV_DIR}/.config
486 eend $?
487 [ "$?" != 0 ] && die
488
489 ebegin "checking ZLIB_DEFLATE"
490 getfilevar_isbuiltin CONFIG_ZLIB_DEFLATE ${KV_DIR}/.config
491 eend $?
492 [ "$?" != 0 ] && die
493
494 local LINENO_START
495 local LINENO_END
496 local SYMBOLS
497 local x
498
499 LINENO_END="$(grep -n 'CONFIG_ZLIB_INFLATE y' ${KV_DIR}/lib/Config.in | cut -d : -f 1)"
500 LINENO_START="$(head -n $LINENO_END ${KV_DIR}/lib/Config.in | grep -n 'if \[' | tail -n 1 | cut -d : -f 1)"
501 (( LINENO_AMOUNT = $LINENO_END - $LINENO_START ))
502 (( LINENO_END = $LINENO_END - 1 ))
503 SYMBOLS="$(head -n $LINENO_END ${KV_DIR}/lib/Config.in | tail -n $LINENO_AMOUNT | sed -e 's/^.*\(CONFIG_[^\" ]*\).*/\1/g;')"
504
505 # okay, now we have a list of symbols
506 # we need to check each one in turn, to see whether it is set or not
507 for x in $SYMBOLS ; do
508 if [ "${!x}" = "y" ]; then
509 # we have a winner!
510 einfo "${x} ensures zlib is linked into your kernel - excellent"
511 return 0
512 fi
513 done
514
515 eerror
516 eerror "This kernel module requires ZLIB library support."
517 eerror "You have enabled zlib support in your kernel, but haven't enabled"
518 eerror "enabled any option that will ensure that zlib is linked into your"
519 eerror "kernel."
520 eerror
521 eerror "Please ensure that you enable at least one of these options:"
522 eerror
523
524 for x in $SYMBOLS ; do
525 eerror " * $x"
526 done
527
528 eerror
529 eerror "Please remember to recompile and install your kernel, and reboot"
530 eerror "into your new kernel before attempting to load this kernel module."
531
532 die "Kernel doesn't include zlib support"
533 }
534
535 ################################
536 # Default pkg_setup
537 # Also used when inheriting linux-mod to force a get_version call
538
539 linux-info_pkg_setup() {
540 get_version || die "Unable to calculate Linux Kernel version"
541 [ -n "${CONFIG_CHECK}" ] && check_extra_config;
542 }

  ViewVC Help
Powered by ViewVC 1.1.20