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

Diff of /eclass/linux-mod.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

Legend:
Removed from v.1.8  
changed lines
  Added in v.1.38

  ViewVC Help
Powered by ViewVC 1.1.20