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

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

  ViewVC Help
Powered by ViewVC 1.1.20