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

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

  ViewVC Help
Powered by ViewVC 1.1.20