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

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

  ViewVC Help
Powered by ViewVC 1.1.20