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

Contents of /eclass/linux-mod.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.42 - (show annotations) (download)
Tue Jul 5 13:39:26 2005 UTC (9 years ago) by johnm
Branch: MAIN
Changes since 1.41: +4 -2 lines
minor change

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.41 2005/07/05 13:34:45 johnm 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
82 inherit linux-info
83 ECLASS=linux-mod
84 INHERITED="$INHERITED $ECLASS"
85 EXPORT_FUNCTIONS pkg_setup pkg_postinst src_install src_compile pkg_postrm
86
87 IUSE="${IUSE}"
88 SLOT="0"
89 DESCRIPTION="Based on the $ECLASS eclass"
90 DEPEND="virtual/linux-sources
91 sys-apps/sed
92 virtual/modutils
93 pcmcia? ( virtual/pcmcia )"
94
95 # eclass utilities
96 # ----------------------------------
97
98 unpack_pcmcia_sources() {
99 # So while the two eclasses exist side-by-side and also the ebuilds inherit
100 # both we need to check for PCMCIA_SOURCE_DIR, and if we find it, then we
101 # bail out and assume pcmcia.eclass is working on it.
102 [[ -n ${PCMCIA_SOURCE_DIR} ]] && return 1
103
104 if [[ -f "${1}" ]]; then
105 PCMCIA_SOURCE_DIR="${WORKDIR}/pcmcia-cs/"
106
107 ebegin "Decompressing pcmcia-cs sources"
108 mkdir -p ${PCMCIA_SOURCE_DIR}
109 tar -xjf ${1} -C ${PCMCIA_SOURCE_DIR}
110 eend $?
111
112 if [[ -f ${PCMCIA_SOURCE_DIR}/pcmcia-cs-version ]]; then
113 PCMCIA_VERSION=$(cat ${PCMCIA_SOURCE_DIR}/pcmcia-cs-version)
114 einfo "Found pcmcia-cs-${PCMCIA_VERSION}"
115 fi
116 fi
117 }
118
119 # Dummy function for compatibility.
120 pcmcia_configure() { return 0; }
121
122 pcmcia_src_unpack() {
123 local pcmcia_tbz="${ROOT}/usr/src/pcmcia-cs/pcmcia-cs-build-env.tbz2"
124
125 # if the kernel has pcmcia support built in, then we just ignore all this.
126 if linux_chkconfig_present PCMCIA; then
127 einfo "Kernel based PCMCIA support has been detected."
128 else
129 if kernel_is 2 4; then
130 unpack_pcmcia_sources ${pcmcia_tbz};
131 else
132 einfo "We have detected that you are running a 2.6 kernel"
133 einfo "but you are not using the built-in PCMCIA support."
134 einfo "We will assume you know what you are doing, but please"
135 einfo "consider using the built in PCMCIA support instead."
136 sleep 10
137
138 unpack_pcmcia_sources ${pcmcia_tbz};
139 fi
140 fi
141 }
142
143 use_m() {
144 # if we haven't determined the version yet, we need too.
145 get_version;
146
147 # if the kernel version is greater than 2.6.6 then we should use
148 # M= instead of SUBDIRS=
149 [ ${KV_MAJOR} -eq 2 -a ${KV_MINOR} -gt 5 -a ${KV_PATCH} -gt 5 ] && \
150 return 0 || return 1
151 }
152
153 convert_to_m() {
154 if use_m
155 then
156 [ ! -f "${1}" ] && \
157 die "convert_to_m() requires a filename as an argument"
158 ebegin "Converting ${1/${WORKDIR}\//} to use M= instead of SUBDIRS="
159 sed -i 's:SUBDIRS=:M=:g' ${1}
160 eend $?
161 fi
162 }
163
164 update_depmod() {
165 # if we haven't determined the version yet, we need too.
166 get_version;
167
168 ebegin "Updating module dependencies for ${KV_FULL}"
169 if [ -r ${KV_OUT_DIR}/System.map ]
170 then
171 depmod -ae -F ${KV_OUT_DIR}/System.map -b ${ROOT} -r ${KV_FULL}
172 eend $?
173 else
174 ewarn
175 ewarn "${KV_OUT_DIR}/System.map not found."
176 ewarn "You must manually update the kernel module dependencies using depmod."
177 eend 1
178 ewarn
179 fi
180 }
181
182 update_modules() {
183 if [ -x /sbin/modules-update ] && \
184 grep -v -e "^#" -e "^$" ${D}/etc/modules.d/* >/dev/null 2>&1; then
185 ebegin "Updating modules.conf"
186 /sbin/modules-update
187 eend $?
188 fi
189 }
190
191 move_old_moduledb() {
192 local OLDDIR=${ROOT}/usr/share/module-rebuild/
193 local NEWDIR=${ROOT}/var/lib/module-rebuild/
194
195 if [[ -f ${OLDDIR}/moduledb ]]; then
196 [[ ! -d ${NEWDIR} ]] && mkdir -p ${NEWDIR}
197 [[ ! -f ${NEWDIR}/moduledb ]] && \
198 mv ${OLDDIR}/moduledb ${NEWDIR}/moduledb
199 rm -f ${OLDDIR}/*
200 rmdir ${OLDDIR}
201 fi
202 }
203
204 update_moduledb() {
205 local MODULEDB_DIR=${ROOT}/var/lib/module-rebuild/
206 move_old_moduledb
207
208 if [[ ! -f ${MODULEDB_DIR}/moduledb ]]; then
209 [[ ! -d ${MODULEDB_DIR} ]] && mkdir -p ${MODULEDB_DIR}
210 touch ${MODULEDB_DIR}/moduledb
211 fi
212 if [[ -z $(grep ${CATEGORY}/${PN}-${PVR} ${MODULEDB_DIR}/moduledb) ]]; then
213 einfo "Adding module to moduledb."
214 echo "a:1:${CATEGORY}/${PN}-${PVR}" >> ${MODULEDB_DIR}/moduledb
215 fi
216 }
217
218 remove_moduledb() {
219 local MODULEDB_DIR=${ROOT}/var/lib/module-rebuild/
220 move_old_moduledb
221
222 if [[ -n $(grep ${CATEGORY}/${PN}-${PVR} ${MODULEDB_DIR}/moduledb) ]]; then
223 einfo "Removing ${CATEGORY}/${PN}-${PVR} from moduledb."
224 sed -ie "/.*${CATEGORY}\/${P}.*/d" ${MODULEDB_DIR}/moduledb
225 fi
226 }
227
228 set_kvobj() {
229 if kernel_is 2 6
230 then
231 KV_OBJ="ko"
232 else
233 KV_OBJ="o"
234 fi
235 # Do we really need to know this?
236 # Lets silence it.
237 # einfo "Using KV_OBJ=${KV_OBJ}"
238 }
239
240 generate_modulesd() {
241 # This function will generate the neccessary modules.d file from the
242 # information contained in the modules exported parms
243
244 local currm_path currm t myIFS myVAR
245 local module_docs module_enabled module_aliases \
246 module_additions module_examples module_modinfo module_opts
247
248 for currm_path in ${@}
249 do
250 currm=${currm_path//*\/}
251 currm=$(echo ${currm} | tr '[:lower:]' '[:upper:]')
252
253 module_docs="$(eval echo \${MODULESD_${currm}_DOCS})"
254 module_enabled="$(eval echo \${MODULESD_${currm}_ENABLED})"
255 module_aliases="$(eval echo \${#MODULESD_${currm/-/_}_ALIASES[*]})"
256 module_additions="$(eval echo \${#MODULESD_${currm/-/_}_ADDITIONS[*]})"
257 module_examples="$(eval echo \${#MODULESD_${currm/-/_}_EXAMPLES[*]})"
258
259 [[ ${module_aliases} -eq 0 ]] && unset module_aliases
260 [[ ${module_additions} -eq 0 ]] && unset module_additions
261 [[ ${module_examples} -eq 0 ]] && unset module_examples
262
263 # If we specify we dont want it, then lets exit, otherwise we assume
264 # that if its set, we do want it.
265 [[ ${module_enabled} == no ]] && return 0
266
267 # unset any unwanted variables.
268 for t in ${!module_*}
269 do
270 [[ -z ${!t} ]] && unset ${t}
271 done
272
273 [[ -z ${!module_*} ]] && return 0
274
275 # OK so now if we have got this far, then we know we want to continue
276 # and generate the modules.d file.
277 module_modinfo="$(modinfo -p ${currm_path}.${KV_OBJ})"
278 module_config="${T}/modulesd-${currm}"
279
280 ebegin "Preparing file for modules.d"
281 #-----------------------------------------------------------------------
282 echo "# modules.d configuration file for ${currm}" >> ${module_config}
283 #-----------------------------------------------------------------------
284 [[ -n ${module_docs} ]] && \
285 echo "# For more information please read:" >> ${module_config}
286 for t in ${module_docs}
287 do
288 echo "# ${t//*\/}" >> ${module_config}
289 done
290 echo >> ${module_config}
291
292 #-----------------------------------------------------------------------
293 if [[ ${module_aliases} -gt 0 ]]
294 then
295 echo "# Internal Aliases - Do not edit" >> ${module_config}
296 echo "# ------------------------------" >> ${module_config}
297
298 for((t=0; t<${module_aliases}; t++))
299 do
300 echo "alias $(eval echo \${MODULESD_${currm}_ALIASES[$t]})" \
301 >> ${module_config}
302 done
303 echo '' >> ${module_config}
304 fi
305
306 #-----------------------------------------------------------------------
307 if [[ -n ${module_modinfo} ]]
308 then
309 echo >> ${module_config}
310 echo "# Configurable module parameters" >> ${module_config}
311 echo "# ------------------------------" >> ${module_config}
312 myIFS="${IFS}"
313 IFS="$(echo -en "\n\b")"
314
315 for t in ${module_modinfo}
316 do
317 myVAR="$(echo ${t#*:} | grep -e " [0-9][ =]" | sed "s:.*\([01][= ]\).*:\1:")"
318 if [[ -n ${myVAR} ]]
319 then
320 module_opts="${module_opts} ${t%%:*}:${myVAR}"
321 fi
322 echo -e "# ${t%%:*}:\t${t#*:}" >> ${module_config}
323 done
324 IFS="${myIFS}"
325 echo '' >> ${module_config}
326 fi
327
328 #-----------------------------------------------------------------------
329 if [[ $(eval echo \${MODULESD_${currm}_ALIASES[0]}) == guess ]]
330 then
331 # So lets do some guesswork eh?
332 if [[ -n ${module_opts} ]]
333 then
334 echo "# For Example..." >> ${module_config}
335 echo "# --------------" >> ${module_config}
336 for t in ${module_opts}
337 do
338 echo "# options ${currm} ${t//:*}=${t//*:}" >> ${module_config}
339 done
340 echo '' >> ${module_config}
341 fi
342 elif [[ ${module_examples} -gt 0 ]]
343 then
344 echo "# For Example..." >> ${module_config}
345 echo "# --------------" >> ${module_config}
346 for((t=0; t<${module_examples}; t++))
347 do
348 echo "options $(eval echo \${MODULESD_${currm}_EXAMPLES[$t]})" \
349 >> ${module_config}
350 done
351 echo '' >> ${module_config}
352 fi
353
354 #-----------------------------------------------------------------------
355 if [[ ${module_additions} -gt 0 ]]
356 then
357 for((t=0; t<${module_additions}; t++))
358 do
359 echo "$(eval echo \${MODULESD_${currm}_ADDITIONS[$t]})" \
360 >> ${module_config}
361 done
362 echo '' >> ${module_config}
363 fi
364
365 #-----------------------------------------------------------------------
366
367 # then we install it
368 insinto /etc/modules.d
369 newins ${module_config} ${currm_path//*\/}
370
371 # and install any documentation we might have.
372 [[ -n ${module_docs} ]] && dodoc ${module_docs}
373 done
374 eend 0
375 return 0
376 }
377
378 display_postinst() {
379 # if we haven't determined the version yet, we need too.
380 get_version;
381
382 local modulename moduledir sourcedir moduletemp file i
383
384 file=${ROOT}/etc/modules.autoload.d/kernel-${KV_MAJOR}.${KV_MINOR}
385 file=${file/\/\///}
386
387 for i in ${MODULE_IGNORE}
388 do
389 MODULE_NAMES=${MODULE_NAMES//${i}(*}
390 done
391
392 if [[ -n ${MODULE_NAMES} ]]
393 then
394 einfo "If you would like to load this module automatically upon boot"
395 einfo "please type the following as root:"
396 for i in ${MODULE_NAMES}
397 do
398 unset libdir srcdir objdir
399 for n in $(find_module_params ${i})
400 do
401 eval ${n/:*}=${n/*:/}
402 done
403 einfo " # echo \"${modulename}\" >> ${file}"
404 done
405 einfo
406 fi
407 }
408
409 find_module_params() {
410 local matched_offset=0 matched_opts=0 test="${@}" temp_var result
411 local i=0 y=0 z=0
412
413 for((i=0; i<=${#test}; i++))
414 do
415 case ${test:${i}:1} in
416 \() matched_offset[0]=${i};;
417 \:) matched_opts=$((${matched_opts} + 1));
418 matched_offset[${matched_opts}]="${i}";;
419 \)) matched_opts=$((${matched_opts} + 1));
420 matched_offset[${matched_opts}]="${i}";;
421 esac
422 done
423
424 for((i=0; i<=${matched_opts}; i++))
425 do
426 # i = offset were working on
427 # y = last offset
428 # z = current offset - last offset
429 # temp_var = temporary name
430 case ${i} in
431 0) tempvar=${test:0:${matched_offset[0]}};;
432 *) y=$((${matched_offset[$((${i} - 1))]} + 1))
433 z=$((${matched_offset[${i}]} - ${matched_offset[$((${i} - 1))]}));
434 z=$((${z} - 1))
435 tempvar=${test:${y}:${z}};;
436 esac
437
438 case ${i} in
439 0) result="${result} modulename:${tempvar}";;
440 1) result="${result} libdir:${tempvar}";;
441 2) result="${result} srcdir:${tempvar}";;
442 3) result="${result} objdir:${tempvar}";;
443 esac
444 done
445
446 echo ${result}
447 }
448
449 # default ebuild functions
450 # --------------------------------
451
452 linux-mod_pkg_setup() {
453 linux-info_pkg_setup;
454 check_kernel_built;
455 check_modules_supported;
456 set_kvobj;
457 }
458
459 linux-mod_src_compile() {
460 local modulename libdir srcdir objdir i n myARCH="${ARCH}"
461 unset ARCH
462
463 BUILD_TARGETS=${BUILD_TARGETS:-clean module}
464
465 for i in ${MODULE_IGNORE}
466 do
467 MODULE_NAMES=${MODULE_NAMES//${i}(*}
468 done
469
470 for i in ${MODULE_NAMES}
471 do
472 unset libdir srcdir objdir
473 for n in $(find_module_params ${i})
474 do
475 eval ${n/:*}=${n/*:/}
476 done
477 libdir=${libdir:-misc}
478 srcdir=${srcdir:-${S}}
479 objdir=${objdir:-${srcdir}}
480
481 if [ ! -f "${srcdir}/.built" ];
482 then
483 cd ${srcdir}
484 einfo "Preparing ${modulename} module"
485 if [[ -n ${ECONF_PARAMS} ]]
486 then
487 econf ${ECONF_PARAMS} || \
488 die "Unable to run econf ${ECONF_PARAMS}"
489 fi
490
491 emake ${BUILD_FIXES} ${BUILD_PARAMS} ${BUILD_TARGETS} \
492 || die "Unable to make \
493 ${BUILD_FIXES} ${BUILD_PARAMS} ${BUILD_TARGETS}."
494 touch ${srcdir}/.built
495 cd ${OLDPWD}
496 fi
497 done
498
499 ARCH="${myARCH}"
500 }
501
502 linux-mod_src_install() {
503 local modulename libdir srcdir objdir i n
504
505 for i in ${MODULE_IGNORE}
506 do
507 MODULE_NAMES=${MODULE_NAMES//${i}(*}
508 done
509
510 for i in ${MODULE_NAMES}
511 do
512 unset libdir srcdir objdir
513 for n in $(find_module_params ${i})
514 do
515 eval ${n/:*}=${n/*:/}
516 done
517 libdir=${libdir:-misc}
518 srcdir=${srcdir:-${S}}
519 objdir=${objdir:-${srcdir}}
520
521 einfo "Installing ${modulename} module"
522 cd ${objdir}
523 insinto ${ROOT}lib/modules/${KV_FULL}/${libdir}
524 doins ${modulename}.${KV_OBJ}
525 cd ${OLDPWD}
526
527 generate_modulesd ${objdir}/${modulename}
528 done
529 }
530
531 linux-mod_pkg_postinst() {
532 update_depmod;
533 update_modules;
534 update_moduledb;
535 display_postinst;
536 }
537
538 linux-mod_pkg_postrm() {
539 remove_moduledb;
540 }

  ViewVC Help
Powered by ViewVC 1.1.20