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

Contents of /eclass/linux-mod.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.66 - (show annotations) (download)
Tue Jun 20 19:47:37 2006 UTC (8 years, 6 months ago) by vapier
Branch: MAIN
Changes since 1.65: +4 -5 lines
kill off pointless whitespace

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-mod.eclass,v 1.65 2006/05/22 09:27:50 genstef Exp $
4
5 # Description: This eclass is used to interface with linux-info in such a way
6 # to provide the functionality required and initial functions
7 # required to install external modules against a kernel source
8 # tree.
9 #
10 # Maintainer: John Mylchreest <johnm@gentoo.org>
11 # Copyright 2004 Gentoo Linux
12 #
13 # Please direct your bugs to the current eclass maintainer :)
14
15 # A Couple of env vars are available to effect usage of this eclass
16 # These are as follows:
17 #
18 # Env Var Option Default Description
19 # KERNEL_DIR <string> /usr/src/linux The directory containing kernel
20 # the target kernel sources.
21 # ECONF_PARAMS <string> The parameters to pass to econf.
22 # If this is not set, then econf
23 # isn't run.
24 # BUILD_PARAMS <string> The parameters to pass to emake.
25 # BUILD_TARGETS <string> clean modules The build targets to pass to
26 # make.
27 # MODULE_NAMES <string> This is the modules which are
28 # to be built automatically using
29 # the default pkg_compile/install.
30 # They are explained properly
31 # below. It will only make
32 # BUILD_TARGETS once in any
33 # directory.
34
35 # MODULE_NAMES - Detailed Overview
36 #
37 # The structure of each MODULE_NAMES entry is as follows:
38 # modulename(libdir:srcdir:objdir)
39 # for example:
40 # MODULE_NAMES="module_pci(pci:${S}/pci:${S}) module_usb(usb:${S}/usb:${S})"
41 #
42 # what this would do is
43 # cd ${S}/pci
44 # make ${BUILD_PARAMS} ${BUILD_TARGETS}
45 # cd ${S}
46 # insinto /lib/modules/${KV_FULL}/pci
47 # doins module_pci.${KV_OBJ}
48 #
49 # cd ${S}/usb
50 # make ${BUILD_PARAMS} ${BUILD_TARGETS}
51 # cd ${S}
52 # insinto /lib/modules/${KV_FULL}/usb
53 # doins module_usb.${KV_OBJ}
54 #
55 # if the srcdir isnt specified, it assumes ${S}
56 # if the libdir isnt specified, it assumes misc.
57 # if the objdir isnt specified, it assumes srcdir
58
59 # There is also support for automatyed modules.d file generation.
60 # This can be explicitly enabled by setting any of the following variables.
61 #
62 #
63 # MODULESD_${modulename}_ENABLED This enables the modules.d file
64 # generation even if we dont
65 # specify any additional info.
66 # MODULESD_${modulename}_EXAMPLES This is a bash array containing
67 # a list of examples which should
68 # be used. If you want us to try and
69 # take a guess. Set this to "guess"
70 # MODULESD_${modulename}_ALIASES This is a bash array containing
71 # a list of associated aliases.
72 # MODULESD_${modulename}_ADDITIONS This is a bash array containing
73 # A list of additional things to
74 # add to the bottom of the file.
75 # This can be absolutely anything.
76 # Each entry is a new line.
77 # MODULES_${modulename}_DOCS This is a string list which contains
78 # the full path to any associated
79 # documents for $modulename
80
81 # The order of these is important as both of linux-info and eutils contain
82 # set_arch_to_kernel and set_arch_to_portage functions and the ones in eutils
83 # are deprecated in favor of the ones in linux-info.
84 # See http://bugs.gentoo.org/show_bug.cgi?id=127506
85
86 inherit eutils linux-info multilib
87 EXPORT_FUNCTIONS pkg_setup pkg_preinst pkg_postinst src_install src_compile pkg_postrm
88
89 IUSE="" # don't put pcmcia here, rather in the ebuilds that actually support pcmcia
90 SLOT="0"
91 DESCRIPTION="Based on the $ECLASS eclass"
92 RDEPEND="kernel_linux? ( virtual/modutils
93 pcmcia? ( virtual/pcmcia ) )"
94 DEPEND="${RDEPEND}
95 sys-apps/sed"
96
97 # eclass utilities
98 # ----------------------------------
99
100 check_vermagic() {
101 local curr_gcc_ver=$(gcc -dumpversion)
102 local tmpfile old_chost old_gcc_ver result=0
103
104 tmpfile=`find ${KV_DIR}/ -iname "*.o.cmd" -exec grep usr/lib/gcc {} \; -quit`
105 tmpfile=${tmpfile//*usr/lib}
106 tmpfile=${tmpfile//\/include*}
107 old_chost=${tmpfile//*gcc\/}
108 old_chost=${old_chost//\/*}
109 old_gcc_ver=${tmpfile//*\/}
110
111 if [[ -z ${old_gcc_ver} || -z ${old_chost} ]]; then
112 ewarn ""
113 ewarn "Unable to detect what version of GCC was used to compile"
114 ewarn "the kernel. Build will continue, but you may experience problems."
115 elif [[ ${curr_gcc_ver} != ${old_gcc_ver} ]]; then
116 ewarn ""
117 ewarn "The version of GCC you are using (${curr_gcc_ver}) does"
118 ewarn "not match the version of GCC used to compile the"
119 ewarn "kernel (${old_gcc_ver})."
120 result=1
121 elif [[ ${CHOST} != ${old_chost} ]]; then
122 ewarn ""
123 ewarn "The current CHOST (${CHOST}) does not match the chost"
124 ewarn "used when compiling the kernel (${old_chost})."
125 result=1
126 fi
127
128 if [[ ${result} -gt 0 ]]; then
129 ewarn ""
130 ewarn "Build will not continue, because you will experience problems."
131 ewarn "To fix this either change the version of GCC you wish to use"
132 ewarn "to match the kernel, or recompile the kernel first."
133 die "GCC Version Mismatch."
134 fi
135 }
136
137 unpack_pcmcia_sources() {
138 # So while the two eclasses exist side-by-side and also the ebuilds inherit
139 # both we need to check for PCMCIA_SOURCE_DIR, and if we find it, then we
140 # bail out and assume pcmcia.eclass is working on it.
141 [[ -n ${PCMCIA_SOURCE_DIR} ]] && return 1
142
143 if [[ -f "${1}" ]]; then
144 PCMCIA_SOURCE_DIR="${WORKDIR}/pcmcia-cs/"
145
146 ebegin "Decompressing pcmcia-cs sources"
147 mkdir -p ${PCMCIA_SOURCE_DIR}
148 tar -xjf ${1} -C ${PCMCIA_SOURCE_DIR}
149 eend $?
150
151 if [[ -f ${PCMCIA_SOURCE_DIR}/pcmcia-cs-version ]]; then
152 PCMCIA_VERSION=$(cat ${PCMCIA_SOURCE_DIR}/pcmcia-cs-version)
153 einfo "Found pcmcia-cs-${PCMCIA_VERSION}"
154 fi
155 fi
156 }
157
158 # Dummy function for compatibility.
159 pcmcia_configure() { return 0; }
160
161 pcmcia_src_unpack() {
162 local pcmcia_tbz="${ROOT}/usr/src/pcmcia-cs/pcmcia-cs-build-env.tbz2"
163
164 # if the kernel has pcmcia support built in, then we just ignore all this.
165 if linux_chkconfig_present PCMCIA; then
166 einfo "Kernel based PCMCIA support has been detected."
167 else
168 if kernel_is 2 4; then
169 unpack_pcmcia_sources ${pcmcia_tbz};
170 else
171 einfo "We have detected that you are running a 2.6 kernel"
172 einfo "but you are not using the built-in PCMCIA support."
173 einfo "We will assume you know what you are doing, but please"
174 einfo "consider using the built in PCMCIA support instead."
175 epause 10
176
177 unpack_pcmcia_sources ${pcmcia_tbz};
178 fi
179 fi
180 }
181
182 use_m() {
183 # if we haven't determined the version yet, we need too.
184 get_version;
185
186 # if the kernel version is greater than 2.6.6 then we should use
187 # M= instead of SUBDIRS=
188 [ ${KV_MAJOR} -eq 2 -a ${KV_MINOR} -gt 5 -a ${KV_PATCH} -gt 5 ] && \
189 return 0 || return 1
190 }
191
192 convert_to_m() {
193 if use_m
194 then
195 [ ! -f "${1}" ] && \
196 die "convert_to_m() requires a filename as an argument"
197 ebegin "Converting ${1/${WORKDIR}\//} to use M= instead of SUBDIRS="
198 sed -i 's:SUBDIRS=:M=:g' ${1}
199 eend $?
200 fi
201 }
202
203 update_depmod() {
204 # if we haven't determined the version yet, we need too.
205 get_version;
206
207 ebegin "Updating module dependencies for ${KV_FULL}"
208 if [ -r ${KV_OUT_DIR}/System.map ]
209 then
210 depmod -ae -F ${KV_OUT_DIR}/System.map -b ${ROOT} -r ${KV_FULL}
211 eend $?
212 else
213 ewarn
214 ewarn "${KV_OUT_DIR}/System.map not found."
215 ewarn "You must manually update the kernel module dependencies using depmod."
216 eend 1
217 ewarn
218 fi
219 }
220
221 update_modules() {
222 if [ -x /sbin/modules-update ] && \
223 grep -v -e "^#" -e "^$" ${D}/etc/modules.d/* >/dev/null 2>&1; then
224 ebegin "Updating modules.conf"
225 /sbin/modules-update
226 eend $?
227 fi
228 }
229
230 move_old_moduledb() {
231 local OLDDIR=${ROOT}/usr/share/module-rebuild/
232 local NEWDIR=${ROOT}/var/lib/module-rebuild/
233
234 if [[ -f ${OLDDIR}/moduledb ]]; then
235 [[ ! -d ${NEWDIR} ]] && mkdir -p ${NEWDIR}
236 [[ ! -f ${NEWDIR}/moduledb ]] && \
237 mv ${OLDDIR}/moduledb ${NEWDIR}/moduledb
238 rm -f ${OLDDIR}/*
239 rmdir ${OLDDIR}
240 fi
241 }
242
243 update_moduledb() {
244 local MODULEDB_DIR=${ROOT}/var/lib/module-rebuild/
245 move_old_moduledb
246
247 if [[ ! -f ${MODULEDB_DIR}/moduledb ]]; then
248 [[ ! -d ${MODULEDB_DIR} ]] && mkdir -p ${MODULEDB_DIR}
249 touch ${MODULEDB_DIR}/moduledb
250 fi
251 if [[ -z $(grep ${CATEGORY}/${PN}-${PVR} ${MODULEDB_DIR}/moduledb) ]]; then
252 einfo "Adding module to moduledb."
253 echo "a:1:${CATEGORY}/${PN}-${PVR}" >> ${MODULEDB_DIR}/moduledb
254 fi
255 }
256
257 remove_moduledb() {
258 local MODULEDB_DIR=${ROOT}/var/lib/module-rebuild/
259 move_old_moduledb
260
261 if [[ -n $(grep ${CATEGORY}/${PN}-${PVR} ${MODULEDB_DIR}/moduledb) ]]; then
262 einfo "Removing ${CATEGORY}/${PN}-${PVR} from moduledb."
263 sed -ie "/.*${CATEGORY}\/${PN}-${PVR}.*/d" ${MODULEDB_DIR}/moduledb
264 fi
265 }
266
267 set_kvobj() {
268 if kernel_is 2 6
269 then
270 KV_OBJ="ko"
271 else
272 KV_OBJ="o"
273 fi
274 # Do we really need to know this?
275 # Lets silence it.
276 # einfo "Using KV_OBJ=${KV_OBJ}"
277 }
278
279 generate_modulesd() {
280 # This function will generate the neccessary modules.d file from the
281 # information contained in the modules exported parms
282
283 local currm_path currm currm_t t myIFS myVAR
284 local module_docs module_enabled module_aliases \
285 module_additions module_examples module_modinfo module_opts
286
287 for currm_path in ${@}
288 do
289 currm=${currm_path//*\/}
290 currm=$(echo ${currm} | tr '[:lower:]' '[:upper:]')
291 currm_t=${currm}
292 while [[ -z ${currm_t//*-*} ]]; do
293 currm_t=${currm_t/-/_}
294 done
295
296 module_docs="$(eval echo \${MODULESD_${currm_t}_DOCS})"
297 module_enabled="$(eval echo \${MODULESD_${currm_t}_ENABLED})"
298 module_aliases="$(eval echo \${#MODULESD_${currm_t}_ALIASES[*]})"
299 module_additions="$(eval echo \${#MODULESD_${currm_t}_ADDITIONS[*]})"
300 module_examples="$(eval echo \${#MODULESD_${currm_t}_EXAMPLES[*]})"
301
302 [[ ${module_aliases} -eq 0 ]] && unset module_aliases
303 [[ ${module_additions} -eq 0 ]] && unset module_additions
304 [[ ${module_examples} -eq 0 ]] && unset module_examples
305
306 # If we specify we dont want it, then lets exit, otherwise we assume
307 # that if its set, we do want it.
308 [[ ${module_enabled} == no ]] && return 0
309
310 # unset any unwanted variables.
311 for t in ${!module_*}
312 do
313 [[ -z ${!t} ]] && unset ${t}
314 done
315
316 [[ -z ${!module_*} ]] && return 0
317
318 # OK so now if we have got this far, then we know we want to continue
319 # and generate the modules.d file.
320 module_modinfo="$(modinfo -p ${currm_path}.${KV_OBJ})"
321 module_config="${T}/modulesd-${currm}"
322
323 ebegin "Preparing file for modules.d"
324 #-----------------------------------------------------------------------
325 echo "# modules.d configuration file for ${currm}" >> ${module_config}
326 #-----------------------------------------------------------------------
327 [[ -n ${module_docs} ]] && \
328 echo "# For more information please read:" >> ${module_config}
329 for t in ${module_docs}
330 do
331 echo "# ${t//*\/}" >> ${module_config}
332 done
333 echo >> ${module_config}
334
335 #-----------------------------------------------------------------------
336 if [[ ${module_aliases} -gt 0 ]]
337 then
338 echo "# Internal Aliases - Do not edit" >> ${module_config}
339 echo "# ------------------------------" >> ${module_config}
340
341 for((t=0; t<${module_aliases}; t++))
342 do
343 echo "alias $(eval echo \${MODULESD_${currm}_ALIASES[$t]})" \
344 >> ${module_config}
345 done
346 echo '' >> ${module_config}
347 fi
348
349 #-----------------------------------------------------------------------
350 if [[ -n ${module_modinfo} ]]
351 then
352 echo >> ${module_config}
353 echo "# Configurable module parameters" >> ${module_config}
354 echo "# ------------------------------" >> ${module_config}
355 myIFS="${IFS}"
356 IFS="$(echo -en "\n\b")"
357
358 for t in ${module_modinfo}
359 do
360 myVAR="$(echo ${t#*:} | grep -e " [0-9][ =]" | sed "s:.*\([01][= ]\).*:\1:")"
361 if [[ -n ${myVAR} ]]
362 then
363 module_opts="${module_opts} ${t%%:*}:${myVAR}"
364 fi
365 echo -e "# ${t%%:*}:\t${t#*:}" >> ${module_config}
366 done
367 IFS="${myIFS}"
368 echo '' >> ${module_config}
369 fi
370
371 #-----------------------------------------------------------------------
372 if [[ $(eval echo \${MODULESD_${currm}_ALIASES[0]}) == guess ]]
373 then
374 # So lets do some guesswork eh?
375 if [[ -n ${module_opts} ]]
376 then
377 echo "# For Example..." >> ${module_config}
378 echo "# --------------" >> ${module_config}
379 for t in ${module_opts}
380 do
381 echo "# options ${currm} ${t//:*}=${t//*:}" >> ${module_config}
382 done
383 echo '' >> ${module_config}
384 fi
385 elif [[ ${module_examples} -gt 0 ]]
386 then
387 echo "# For Example..." >> ${module_config}
388 echo "# --------------" >> ${module_config}
389 for((t=0; t<${module_examples}; t++))
390 do
391 echo "options $(eval echo \${MODULESD_${currm}_EXAMPLES[$t]})" \
392 >> ${module_config}
393 done
394 echo '' >> ${module_config}
395 fi
396
397 #-----------------------------------------------------------------------
398 if [[ ${module_additions} -gt 0 ]]
399 then
400 for((t=0; t<${module_additions}; t++))
401 do
402 echo "$(eval echo \${MODULESD_${currm}_ADDITIONS[$t]})" \
403 >> ${module_config}
404 done
405 echo '' >> ${module_config}
406 fi
407
408 #-----------------------------------------------------------------------
409
410 # then we install it
411 insinto /etc/modules.d
412 newins ${module_config} ${currm_path//*\/}
413
414 # and install any documentation we might have.
415 [[ -n ${module_docs} ]] && dodoc ${module_docs}
416 done
417 eend 0
418 return 0
419 }
420
421 find_module_params() {
422 local matched_offset=0 matched_opts=0 test="${@}" temp_var result
423 local i=0 y=0 z=0
424
425 for((i=0; i<=${#test}; i++))
426 do
427 case ${test:${i}:1} in
428 \() matched_offset[0]=${i};;
429 \:) matched_opts=$((${matched_opts} + 1));
430 matched_offset[${matched_opts}]="${i}";;
431 \)) matched_opts=$((${matched_opts} + 1));
432 matched_offset[${matched_opts}]="${i}";;
433 esac
434 done
435
436 for((i=0; i<=${matched_opts}; i++))
437 do
438 # i = offset were working on
439 # y = last offset
440 # z = current offset - last offset
441 # temp_var = temporary name
442 case ${i} in
443 0) tempvar=${test:0:${matched_offset[0]}};;
444 *) y=$((${matched_offset[$((${i} - 1))]} + 1))
445 z=$((${matched_offset[${i}]} - ${matched_offset[$((${i} - 1))]}));
446 z=$((${z} - 1))
447 tempvar=${test:${y}:${z}};;
448 esac
449
450 case ${i} in
451 0) result="${result} modulename:${tempvar}";;
452 1) result="${result} libdir:${tempvar}";;
453 2) result="${result} srcdir:${tempvar}";;
454 3) result="${result} objdir:${tempvar}";;
455 esac
456 done
457
458 echo ${result}
459 }
460
461 # default ebuild functions
462 # --------------------------------
463
464 linux-mod_pkg_setup() {
465 linux-info_pkg_setup;
466 check_kernel_built;
467 strip_modulenames;
468 [[ -n ${MODULE_NAMES} ]] && check_modules_supported
469 set_kvobj;
470 # Commented out with permission from johnm until a fixed version for arches
471 # who intentionally use different kernel and userland compilers can be
472 # introduced - Jason Wever <weeve@gentoo.org>, 23 Oct 2005
473 #check_vermagic;
474 }
475
476 strip_modulenames() {
477 local i
478 for i in ${MODULE_IGNORE}; do
479 MODULE_NAMES=${MODULE_NAMES//${i}(*}
480 done
481 }
482
483 linux-mod_src_compile() {
484 local modulename libdir srcdir objdir i n myARCH="${ARCH}" myABI="${ABI}"
485 ARCH="$(tc-arch-kernel)"
486 ABI="${KERNEL_ABI}"
487 CC_HOSTCC=$(tc-getBUILD_CC)
488 CC_CC=$(tc-getCC)
489
490 BUILD_TARGETS=${BUILD_TARGETS:-clean module}
491 strip_modulenames;
492 for i in ${MODULE_NAMES}
493 do
494 unset libdir srcdir objdir
495 for n in $(find_module_params ${i})
496 do
497 eval ${n/:*}=${n/*:/}
498 done
499 libdir=${libdir:-misc}
500 srcdir=${srcdir:-${S}}
501 objdir=${objdir:-${srcdir}}
502
503 if [ ! -f "${srcdir}/.built" ];
504 then
505 cd ${srcdir}
506 einfo "Preparing ${modulename} module"
507 if [[ -n ${ECONF_PARAMS} ]]
508 then
509 econf ${ECONF_PARAMS} || \
510 die "Unable to run econf ${ECONF_PARAMS}"
511 fi
512
513 emake HOSTCC=${CC_HOSTCC} CC=${CC_CC}\
514 ${BUILD_FIXES} ${BUILD_PARAMS} ${BUILD_TARGETS} \
515 || die "Unable to make ${BUILD_FIXES} ${BUILD_PARAMS} ${BUILD_TARGETS}."
516 touch ${srcdir}/.built
517 cd ${OLDPWD}
518 fi
519 done
520
521 ARCH="${myARCH}"
522 ABI="${myABI}"
523 }
524
525 linux-mod_src_install() {
526 local modulename libdir srcdir objdir i n
527
528 strip_modulenames;
529 for i in ${MODULE_NAMES}
530 do
531 unset libdir srcdir objdir
532 for n in $(find_module_params ${i})
533 do
534 eval ${n/:*}=${n/*:/}
535 done
536 libdir=${libdir:-misc}
537 srcdir=${srcdir:-${S}}
538 objdir=${objdir:-${srcdir}}
539
540 einfo "Installing ${modulename} module"
541 cd ${objdir} || die "${objdir} does not exist"
542 insinto /lib/modules/${KV_FULL}/${libdir}
543 doins ${modulename}.${KV_OBJ} || die "doins ${modulename}.${KV_OBJ} failed"
544 cd ${OLDPWD}
545
546 generate_modulesd ${objdir}/${modulename}
547 done
548 }
549
550 linux-mod_pkg_preinst() {
551 [ -d ${IMAGE}/lib/modules ] && UPDATE_DEPMOD=true || UPDATE_DEPMOD=false
552 [ -d ${IMAGE}/etc/modules.d ] && UPDATE_MODULES=true || UPDATE_MODULES=false
553 [ -d ${IMAGE}/lib/modules ] && UPDATE_MODULEDB=true || UPDATE_MODULEDB=false
554 }
555
556 linux-mod_pkg_postinst() {
557 ${UPDATE_DEPMOD} && update_depmod;
558 ${UPDATE_MODULES} && update_modules;
559 ${UPDATE_MODULEDB} && update_moduledb;
560 }
561
562 linux-mod_pkg_postrm() {
563 remove_moduledb;
564 }

  ViewVC Help
Powered by ViewVC 1.1.20