/[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.40
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.40 2005/07/05 11:37:03 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 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? ( virtual/pcmcia )"
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 local MODULEDB_DIR=${ROOT}/var/lib/module-rebuild/
193
194 if [[ ! -f ${MODULEDB_DIR}/moduledb ]]; then
195 [[ ! -d ${MODULEDB_DIR} ]] && mkdir -p ${MODULEDB_DIR}
196 touch ${MODULEDB_DIR}/moduledb
197 fi
198 if [[ -z $(grep ${CATEGORY}/${PN}-${PVR} ${MODULEDB_DIR}/moduledb) ]]; then
199 einfo "Adding module to moduledb."
200 echo "a:1:${CATEGORY}/${PN}-${PVR}" >> ${MODULEDB_DIR}/moduledb
201 fi
202}
203
204remove_moduledb() {
205 local MODULEDB_DIR=${ROOT}/var/lib/module-rebuild/
206
207 if [[ -n $(grep ${CATEGORY}/${PN}-${PVR} ${MODULEDB_DIR}/moduledb) ]]; then
208 einfo "Removing ${CATEGORY}/${PN}-${PVR} from moduledb."
209 sed -ie "/.*${CATEGORY}\/${P}.*/d" ${MODULEDB_DIR}/moduledb
69 fi 210 fi
70} 211}
71 212
72set_kvobj() { 213set_kvobj() {
73 if kernel_is 2 6 214 if kernel_is 2 6
74 then 215 then
75 KV_OBJ="ko" 216 KV_OBJ="ko"
76 else 217 else
77 KV_OBJ="o" 218 KV_OBJ="o"
78 fi 219 fi
220 # Do we really need to know this?
221 # Lets silence it.
79 einfo "Using KV_OBJ=${KV_OBJ}" 222 # einfo "Using KV_OBJ=${KV_OBJ}"
223}
224
225generate_modulesd() {
226 # This function will generate the neccessary modules.d file from the
227 # information contained in the modules exported parms
228
229 local currm_path currm t myIFS myVAR
230 local module_docs module_enabled module_aliases \
231 module_additions module_examples module_modinfo module_opts
232
233 for currm_path in ${@}
234 do
235 currm=${currm_path//*\/}
236 currm=$(echo ${currm} | tr '[:lower:]' '[:upper:]')
237
238 module_docs="$(eval echo \${MODULESD_${currm}_DOCS})"
239 module_enabled="$(eval echo \${MODULESD_${currm}_ENABLED})"
240 module_aliases="$(eval echo \${#MODULESD_${currm/-/_}_ALIASES[*]})"
241 module_additions="$(eval echo \${#MODULESD_${currm/-/_}_ADDITIONS[*]})"
242 module_examples="$(eval echo \${#MODULESD_${currm/-/_}_EXAMPLES[*]})"
243
244 [[ ${module_aliases} -eq 0 ]] && unset module_aliases
245 [[ ${module_additions} -eq 0 ]] && unset module_additions
246 [[ ${module_examples} -eq 0 ]] && unset module_examples
247
248 # If we specify we dont want it, then lets exit, otherwise we assume
249 # that if its set, we do want it.
250 [[ ${module_enabled} == no ]] && return 0
251
252 # unset any unwanted variables.
253 for t in ${!module_*}
254 do
255 [[ -z ${!t} ]] && unset ${t}
256 done
257
258 [[ -z ${!module_*} ]] && return 0
259
260 # OK so now if we have got this far, then we know we want to continue
261 # and generate the modules.d file.
262 module_modinfo="$(modinfo -p ${currm_path}.${KV_OBJ})"
263 module_config="${T}/modulesd-${currm}"
264
265 ebegin "Preparing file for modules.d"
266 #-----------------------------------------------------------------------
267 echo "# modules.d configuration file for ${currm}" >> ${module_config}
268 #-----------------------------------------------------------------------
269 [[ -n ${module_docs} ]] && \
270 echo "# For more information please read:" >> ${module_config}
271 for t in ${module_docs}
272 do
273 echo "# ${t//*\/}" >> ${module_config}
274 done
275 echo >> ${module_config}
276
277 #-----------------------------------------------------------------------
278 if [[ ${module_aliases} -gt 0 ]]
279 then
280 echo "# Internal Aliases - Do not edit" >> ${module_config}
281 echo "# ------------------------------" >> ${module_config}
282
283 for((t=0; t<${module_aliases}; t++))
284 do
285 echo "alias $(eval echo \${MODULESD_${currm}_ALIASES[$t]})" \
286 >> ${module_config}
287 done
288 echo '' >> ${module_config}
289 fi
290
291 #-----------------------------------------------------------------------
292 if [[ -n ${module_modinfo} ]]
293 then
294 echo >> ${module_config}
295 echo "# Configurable module parameters" >> ${module_config}
296 echo "# ------------------------------" >> ${module_config}
297 myIFS="${IFS}"
298 IFS="$(echo -en "\n\b")"
299
300 for t in ${module_modinfo}
301 do
302 myVAR="$(echo ${t#*:} | grep -e " [0-9][ =]" | sed "s:.*\([01][= ]\).*:\1:")"
303 if [[ -n ${myVAR} ]]
304 then
305 module_opts="${module_opts} ${t%%:*}:${myVAR}"
306 fi
307 echo -e "# ${t%%:*}:\t${t#*:}" >> ${module_config}
308 done
309 IFS="${myIFS}"
310 echo '' >> ${module_config}
311 fi
312
313 #-----------------------------------------------------------------------
314 if [[ $(eval echo \${MODULESD_${currm}_ALIASES[0]}) == guess ]]
315 then
316 # So lets do some guesswork eh?
317 if [[ -n ${module_opts} ]]
318 then
319 echo "# For Example..." >> ${module_config}
320 echo "# --------------" >> ${module_config}
321 for t in ${module_opts}
322 do
323 echo "# options ${currm} ${t//:*}=${t//*:}" >> ${module_config}
324 done
325 echo '' >> ${module_config}
326 fi
327 elif [[ ${module_examples} -gt 0 ]]
328 then
329 echo "# For Example..." >> ${module_config}
330 echo "# --------------" >> ${module_config}
331 for((t=0; t<${module_examples}; t++))
332 do
333 echo "options $(eval echo \${MODULESD_${currm}_EXAMPLES[$t]})" \
334 >> ${module_config}
335 done
336 echo '' >> ${module_config}
337 fi
338
339 #-----------------------------------------------------------------------
340 if [[ ${module_additions} -gt 0 ]]
341 then
342 for((t=0; t<${module_additions}; t++))
343 do
344 echo "$(eval echo \${MODULESD_${currm}_ADDITIONS[$t]})" \
345 >> ${module_config}
346 done
347 echo '' >> ${module_config}
348 fi
349
350 #-----------------------------------------------------------------------
351
352 # then we install it
353 insinto /etc/modules.d
354 newins ${module_config} ${currm_path//*\/}
355
356 # and install any documentation we might have.
357 [[ -n ${module_docs} ]] && dodoc ${module_docs}
358 done
359 eend 0
360 return 0
80} 361}
81 362
82display_postinst() { 363display_postinst() {
83 # if we haven't determined the version yet, we need too. 364 # if we haven't determined the version yet, we need too.
84 get_version; 365 get_version;
85 366
86 local modulename moduledir sourcedir module_temp file i 367 local modulename moduledir sourcedir moduletemp file i
87 368
88 file=${ROOT}/etc/modules.autoload.d/kernel-${KV_MAJOR}.${KV_MINOR} 369 file=${ROOT}/etc/modules.autoload.d/kernel-${KV_MAJOR}.${KV_MINOR}
89 file=${file/\/\///} 370 file=${file/\/\///}
90 371
372 for i in ${MODULE_IGNORE}
373 do
374 MODULE_NAMES=${MODULE_NAMES//${i}(*}
375 done
376
377 if [[ -n ${MODULE_NAMES} ]]
378 then
91 einfo "If you would like to load this module automatically upon boot" 379 einfo "If you would like to load this module automatically upon boot"
92 einfo "please type the following as root:" 380 einfo "please type the following as root:"
93 for i in ${MODULE_NAMES} 381 for i in ${MODULE_NAMES}
94 do 382 do
95 module_temp="$(echo ${i} | sed -e "s:.*(\(.*\)):\1:")" 383 unset libdir srcdir objdir
96 modulename="${i/(*/}" 384 for n in $(find_module_params ${i})
97 moduledir="${module_temp/:*/}" 385 do
98 moduledir="${moduledir:-misc}" 386 eval ${n/:*}=${n/*:/}
99 sourcedir="${module_temp/*:/}" 387 done
100 sourcedir="${sourcedir:-${S}}" 388 einfo " # echo \"${modulename}\" >> ${file}"
389 done
390 einfo
391 fi
392}
393
394find_module_params() {
395 local matched_offset=0 matched_opts=0 test="${@}" temp_var result
396 local i=0 y=0 z=0
397
398 for((i=0; i<=${#test}; i++))
399 do
400 case ${test:${i}:1} in
401 \() matched_offset[0]=${i};;
402 \:) matched_opts=$((${matched_opts} + 1));
403 matched_offset[${matched_opts}]="${i}";;
404 \)) matched_opts=$((${matched_opts} + 1));
405 matched_offset[${matched_opts}]="${i}";;
406 esac
407 done
408
409 for((i=0; i<=${matched_opts}; i++))
410 do
411 # i = offset were working on
412 # y = last offset
413 # z = current offset - last offset
414 # temp_var = temporary name
415 case ${i} in
416 0) tempvar=${test:0:${matched_offset[0]}};;
417 *) y=$((${matched_offset[$((${i} - 1))]} + 1))
418 z=$((${matched_offset[${i}]} - ${matched_offset[$((${i} - 1))]}));
419 z=$((${z} - 1))
420 tempvar=${test:${y}:${z}};;
421 esac
101 422
102 einfo " # echo \"${modulename}\" >> ${file}" 423 case ${i} in
424 0) result="${result} modulename:${tempvar}";;
425 1) result="${result} libdir:${tempvar}";;
426 2) result="${result} srcdir:${tempvar}";;
427 3) result="${result} objdir:${tempvar}";;
428 esac
103 done 429 done
104 echo 430
431 echo ${result}
105} 432}
106 433
107# default ebuild functions 434# default ebuild functions
108# -------------------------------- 435# --------------------------------
109 436
110linux-mod_pkg_setup() { 437linux-mod_pkg_setup() {
111 linux-info_pkg_setup; 438 linux-info_pkg_setup;
112 check_kernel_built; 439 check_kernel_built;
113 check_modules_supported; 440 check_modules_supported;
114 check_extra_config;
115 set_kvobj; 441 set_kvobj;
116} 442}
117 443
118linux-mod_src_compile() { 444linux-mod_src_compile() {
119 local modulename moduledir sourcedir module_temp xarch i 445 local modulename libdir srcdir objdir i n myARCH="${ARCH}"
120 xarch="${ARCH}"
121 unset ARCH 446 unset ARCH
122 447
448 BUILD_TARGETS=${BUILD_TARGETS:-clean module}
449
450 for i in ${MODULE_IGNORE}
451 do
452 MODULE_NAMES=${MODULE_NAMES//${i}(*}
453 done
454
123 for i in "${MODULE_NAMES}" 455 for i in ${MODULE_NAMES}
456 do
457 unset libdir srcdir objdir
458 for n in $(find_module_params ${i})
124 do 459 do
125 module_temp="$(echo ${i} | sed -e "s:.*(\(.*\)):\1:")" 460 eval ${n/:*}=${n/*:/}
126 modulename="${i/(*/}" 461 done
127 moduledir="${module_temp/:*/}" 462 libdir=${libdir:-misc}
128 moduledir="${moduledir:-misc}"
129 sourcedir="${module_temp/*:/}"
130 sourcedir="${sourcedir:-${S}}" 463 srcdir=${srcdir:-${S}}
131 464 objdir=${objdir:-${srcdir}}
465
466 if [ ! -f "${srcdir}/.built" ];
467 then
468 cd ${srcdir}
132 einfo "Preparing ${modulename} module" 469 einfo "Preparing ${modulename} module"
133 cd ${sourcedir} 470 if [[ -n ${ECONF_PARAMS} ]]
134 emake ${BUILD_PARAMS} ${BUILD_TARGETS:-clean module} || die Unable to make ${BUILD_PARAMS} ${BUILD_TARGETS:-clean module}. 471 then
472 econf ${ECONF_PARAMS} || \
473 die "Unable to run econf ${ECONF_PARAMS}"
474 fi
475
476 emake ${BUILD_FIXES} ${BUILD_PARAMS} ${BUILD_TARGETS} \
477 || die "Unable to make \
478 ${BUILD_FIXES} ${BUILD_PARAMS} ${BUILD_TARGETS}."
479 touch ${srcdir}/.built
480 cd ${OLDPWD}
481 fi
135 done 482 done
136 ARCH="${xarch}" 483
484 ARCH="${myARCH}"
137} 485}
138 486
139linux-mod_src_install() { 487linux-mod_src_install() {
140 local modulename moduledir sourcedir module_temp i 488 local modulename libdir srcdir objdir i n
489
490 for i in ${MODULE_IGNORE}
491 do
492 MODULE_NAMES=${MODULE_NAMES//${i}(*}
493 done
141 494
142 for i in "${MODULE_NAMES}" 495 for i in ${MODULE_NAMES}
496 do
497 unset libdir srcdir objdir
498 for n in $(find_module_params ${i})
143 do 499 do
144 module_temp="$(echo ${i} | sed -e "s:.*(\(.*\)):\1:")" 500 eval ${n/:*}=${n/*:/}
145 modulename="${i/(*/}" 501 done
146 moduledir="${module_temp/:*/}" 502 libdir=${libdir:-misc}
147 moduledir="${moduledir:-misc}"
148 sourcedir="${module_temp/*:/}"
149 sourcedir="${sourcedir:-${S}}" 503 srcdir=${srcdir:-${S}}
504 objdir=${objdir:-${srcdir}}
150 505
151 einfo "Installing ${modulename} module" 506 einfo "Installing ${modulename} module"
152 cd ${sourcedir} 507 cd ${objdir}
153 insinto /lib/modules/${KV_FULL}/${moduledir} 508 insinto ${ROOT}lib/modules/${KV_FULL}/${libdir}
154 doins ${modulename}.${KV_OBJ} 509 doins ${modulename}.${KV_OBJ}
510 cd ${OLDPWD}
511
512 generate_modulesd ${objdir}/${modulename}
155 done 513 done
156} 514}
157 515
158linux-mod_pkg_postinst() { 516linux-mod_pkg_postinst() {
159 update_depmod; 517 update_depmod;
160 update_modules; 518 update_modules;
519 update_moduledb;
161 display_postinst; 520 display_postinst;
162} 521}
522
523linux-mod_pkg_postrm() {
524 remove_moduledb;
525}

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

  ViewVC Help
Powered by ViewVC 1.1.20