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

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

  ViewVC Help
Powered by ViewVC 1.1.20