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

Contents of /eclass/linux-info.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.10 - (show annotations) (download)
Tue Dec 14 18:56:46 2004 UTC (9 years, 8 months ago) by johnm
Branch: MAIN
Changes since 1.9: +47 -3 lines
adding documentation, and changing the MODULE_NAMES parsing slightly

1 # Copyright 1999-2004 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.9 2004/12/10 22:43:03 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 # <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
51
52 ECLASS=linux-info
53 INHERITED="$INHERITED $ECLASS"
54 EXPORT_FUNCTIONS pkg_setup
55
56 # Overwritable environment Var's
57 # ---------------------------------------
58 KERNEL_DIR="${KERNEL_DIR:-/usr/src/linux}"
59
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
63 set_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
75 set_arch_to_portage() {
76 export ARCH="${PORTAGE_ARCH}"
77 }
78
79 # File Functions
80 # ---------------------------------------
81
82 # getfilevar accepts 2 vars as follows:
83 # getfilevar <VARIABLE> <CONFIGFILE>
84
85 getfilevar() {
86 local ERROR workingdir basefname basedname xarch
87 ERROR=0
88
89 [ -z "${1}" ] && ERROR=1
90 [ ! -f "${2}" ] && ERROR=1
91
92 if [ "${ERROR}" = 1 ]
93 then
94 ebeep
95 echo -e "\n"
96 eerror "getfilevar requires 2 variables, with the second a valid file."
97 eerror " getfilevar <VARIABLE> <CONFIGFILE>"
98 else
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}
111 fi
112 }
113
114 linux_chkconfig_present() {
115 local RESULT
116 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
117 [ "${RESULT}" = "m" -o "${RESULT}" = "y" ] && return 0 || return 1
118 }
119
120 linux_chkconfig_module() {
121 local RESULT
122 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
123 [ "${RESULT}" = "m" ] && return 0 || return 1
124 }
125
126 linux_chkconfig_builtin() {
127 local RESULT
128 RESULT="$(getfilevar CONFIG_${1} ${KV_OUT_DIR}/.config)"
129 [ "${RESULT}" = "y" ] && return 0 || return 1
130 }
131
132 linux_chkconfig_string() {
133 getfilevar "CONFIG_${1}" "${KV_OUT_DIR}/.config"
134 }
135
136 # Versioning Functions
137 # ---------------------------------------
138
139 # kernel_is returns true when the version is the same as the passed version
140 #
141 # For Example where KV = 2.6.9
142 # kernel_is 2 4 returns false
143 # kernel_is 2 returns true
144 # kernel_is 2 6 returns true
145 # kernel_is 2 6 8 returns false
146 # kernel_is 2 6 9 returns true
147 #
148 # got the jist yet?
149
150 kernel_is() {
151 # if we haven't determined the version yet, we need too.
152 get_version;
153
154 local RESULT
155 RESULT=1
156
157 if [ -n "${1}" ]
158 then
159 [ "${1}" = "${KV_MAJOR}" ] && RESULT=0
160 fi
161
162 if [ -n "${2}" ]
163 then
164 RESULT=1
165 [ "${2}" = "${KV_MINOR}" ] && RESULT=0
166 fi
167
168 if [ -n "${3}" ]
169 then
170 RESULT=1
171 [ "${3}" = "${KV_PATCH}" ] && RESULT=0
172 fi
173 return ${RESULT}
174 }
175
176 get_version() {
177 local kbuild_output
178
179 # no need to execute this twice assuming KV_FULL is populated.
180 # we can force by unsetting KV_FULL
181 [ -n "${KV_FULL}" ] && return
182
183 # if we dont know KV_FULL, then we need too.
184 # make sure KV_DIR isnt set since we need to work it out via KERNEL_DIR
185 unset KV_DIR
186
187 # KV_DIR will contain the full path to the sources directory we should use
188 einfo "Determining the location of the kernel source code"
189 [ -h "${KERNEL_DIR}" ] && KV_DIR="$(readlink -f ${KERNEL_DIR})"
190 [ -d "${KERNEL_DIR}" ] && KV_DIR="${KERNEL_DIR}"
191
192 if [ -z "${KV_DIR}" ]
193 then
194 eerror "Unable to find kernel sources at ${KERNEL_DIR}"
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."
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}}"
225
226 # And contrary to existing functions I feel we shouldn't trust the
227 # directory name to find version information as this seems insane.
228 # so we parse ${KV_DIR}/Makefile
229 KV_MAJOR="$(getfilevar VERSION ${KV_DIR}/Makefile)"
230 KV_MINOR="$(getfilevar PATCHLEVEL ${KV_DIR}/Makefile)"
231 KV_PATCH="$(getfilevar SUBLEVEL ${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
241 # and in newer versions we can also pull LOCALVERSION if it is set.
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//\"/}"
263
264 # And we should set KV_FULL to the full expanded version
265 KV_FULL="${KV_MAJOR}.${KV_MINOR}.${KV_PATCH}${KV_EXTRA}${KV_LOCAL}"
266
267 einfo "Found sources for kernel version:"
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}"
275 fi
276 }
277
278
279
280
281 # ebuild check functions
282 # ---------------------------------------
283
284 check_kernel_built() {
285 # if we haven't determined the version yet, we need too.
286 get_version;
287
288 if [ ! -f "${KV_OUT_DIR}/System.map" ]
289 then
290 eerror "These sources have not yet been compiled."
291 eerror "We cannot build against an uncompiled tree."
292 eerror "To resolve this, please type the following:"
293 eerror
294 eerror "# cd ${KV_DIR}"
295 eerror "# make oldconfig"
296 eerror "# make bzImage modules modules_install"
297 eerror
298 eerror "Then please try merging this module again."
299 die "Kernel sources need compiling first"
300 fi
301 }
302
303 check_modules_supported() {
304 # if we haven't determined the version yet, we need too.
305 get_version;
306
307 if ! linux_chkconfig_builtin "MODULES"
308 then
309 eerror "These sources do not support loading external modules."
310 eerror "to be able to use this module please enable \"Loadable modules support\""
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
316 check_extra_config() {
317 local 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"
355 fi
356 }
357
358 check_zlibinflate() {
359 # if we haven't determined the version yet, we need too.
360 get_version;
361
362 # although I restructured this code - I really really really dont support it!
363
364 # bug #27882 - zlib routines are only linked into the kernel
365 # if something compiled into the kernel calls them
366 #
367 # plus, for the cloop module, it appears that there's no way
368 # to get cloop.o to include a static zlib if CONFIG_MODVERSIONS
369 # is on
370
371 local INFLATE
372 local DEFLATE
373
374 einfo "Determining the usability of ZLIB_INFLATE support in your kernel"
375
376 ebegin "checking ZLIB_INFLATE"
377 getfilevar_isbuiltin CONFIG_ZLIB_INFLATE ${KV_DIR}/.config
378 eend $?
379 [ "$?" != 0 ] && die
380
381 ebegin "checking ZLIB_DEFLATE"
382 getfilevar_isbuiltin CONFIG_ZLIB_DEFLATE ${KV_DIR}/.config
383 eend $?
384 [ "$?" != 0 ] && die
385
386
387 local LINENO_START
388 local LINENO_END
389 local SYMBOLS
390 local x
391
392 LINENO_END="$(grep -n 'CONFIG_ZLIB_INFLATE y' ${KV_DIR}/lib/Config.in | 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)"
394 (( LINENO_AMOUNT = $LINENO_END - $LINENO_START ))
395 (( LINENO_END = $LINENO_END - 1 ))
396 SYMBOLS="$(head -n $LINENO_END ${KV_DIR}/lib/Config.in | tail -n $LINENO_AMOUNT | sed -e 's/^.*\(CONFIG_[^\" ]*\).*/\1/g;')"
397
398 # okay, now we have a list of symbols
399 # we need to check each one in turn, to see whether it is set or not
400 for x in $SYMBOLS ; do
401 if [ "${!x}" = "y" ]; then
402 # we have a winner!
403 einfo "${x} ensures zlib is linked into your kernel - excellent"
404 return 0
405 fi
406 done
407
408 eerror
409 eerror "This kernel module requires ZLIB library support."
410 eerror "You have enabled zlib support in your kernel, but haven't enabled"
411 eerror "enabled any option that will ensure that zlib is linked into your"
412 eerror "kernel."
413 eerror
414 eerror "Please ensure that you enable at least one of these options:"
415 eerror
416
417 for x in $SYMBOLS ; do
418 eerror " * $x"
419 done
420
421 eerror
422 eerror "Please remember to recompile and install your kernel, and reboot"
423 eerror "into your new kernel before attempting to load this kernel module."
424
425 die "Kernel doesn't include zlib support"
426 }
427
428 ################################
429 # Default pkg_setup
430 # Also used when inheriting linux-mod to force a get_version call
431
432 linux-info_pkg_setup() {
433 get_version;
434 [ -n "${CONFIG_CHECK}" ] && check_extra_config;
435 }

  ViewVC Help
Powered by ViewVC 1.1.20