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

Legend:
Removed from v.1.6  
changed lines
  Added in v.1.52

  ViewVC Help
Powered by ViewVC 1.1.20