/[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.19 Revision 1.27
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.19 2005/01/15 21:19:02 johnm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/linux-mod.eclass,v 1.27 2005/02/01 09:58:36 johnm Exp $
4 4
5# Description: This eclass is used to interface with linux-info in such a way 5# Description: This eclass is used to interface with linux-info in such a way
6# to provide the functionality required and initial functions 6# to provide the functionality required and initial functions
7# required to install external modules against a kernel source 7# required to install external modules against a kernel source
8# tree. 8# tree.
13# Please direct your bugs to the current eclass maintainer :) 13# Please direct your bugs to the current eclass maintainer :)
14 14
15# A Couple of env vars are available to effect usage of this eclass 15# A Couple of env vars are available to effect usage of this eclass
16# These are as follows: 16# These are as follows:
17# 17#
18# Env Var Option Default Description 18# Env Var Option Default Description
19# KERNEL_DIR <string> /usr/src/linux The directory containing kernel 19# KERNEL_DIR <string> /usr/src/linux The directory containing kernel
20# the target kernel sources. 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.
21# BUILD_PARAMS <string> The parameters to pass to make. 24# BUILD_PARAMS <string> The parameters to pass to emake.
22# BUILD_TARGETS <string> clean modules The build targets to pass to make. 25# BUILD_TARGETS <string> clean modules The build targets to pass to
26# make.
23# MODULE_NAMES <string> This is the modules which are 27# MODULE_NAMES <string> This is the modules which are
24# to be built automatically using the 28# to be built automatically using
25# default pkg_compile/install. They 29# the default pkg_compile/install.
26# are explained properly below. 30# They are explained properly
27# It will only make BUILD_TARGETS once 31# below. It will only make
32# BUILD_TARGETS once in any
28# in any directory. 33# directory.
29# NO_MODULESD <string> Set this to something to prevent
30# modulesd file generation
31
32 34
33# MODULE_NAMES - Detailed Overview 35# MODULE_NAMES - Detailed Overview
34# 36#
35# The structure of each MODULE_NAMES entry is as follows: 37# The structure of each MODULE_NAMES entry is as follows:
36# modulename(libmodulesdir:modulesourcedir) 38# modulename(libdir:srcdir:objdir)
37# for example: 39# for example:
38# MODULE_NAMES="module_pci(pci:${S}/pci) module_usb(usb:${S}/usb)" 40# MODULE_NAMES="module_pci(pci:${S}/pci:${S}) module_usb(usb:${S}/usb:${S})"
39# 41#
40# what this would do is 42# what this would do is
41# cd ${S}/pci 43# cd ${S}/pci
42# make ${BUILD_PARAMS} ${BUILD_TARGETS} 44# make ${BUILD_PARAMS} ${BUILD_TARGETS}
45# cd ${S}
43# insinto /lib/modules/${KV_FULL}/pci 46# insinto /lib/modules/${KV_FULL}/pci
44# doins module_pci.${KV_OBJ} 47# doins module_pci.${KV_OBJ}
45# 48#
46# cd ${S}/usb 49# cd ${S}/usb
47# make ${BUILD_PARAMS} ${BUILD_TARGETS} 50# make ${BUILD_PARAMS} ${BUILD_TARGETS}
51# cd ${S}
48# insinto /lib/modules/${KV_FULL}/usb 52# insinto /lib/modules/${KV_FULL}/usb
49# doins module_usb.${KV_OBJ} 53# doins module_usb.${KV_OBJ}
50# 54#
51# if the modulessourcedir isnt specified, it assumes ${S} 55# if the srcdir isnt specified, it assumes ${S}
52# if the libmodulesdir isnt specified, it assumes misc. 56# if the libdir isnt specified, it assumes misc.
53# if no seperator is defined ":" then it assumes the argument is modulesourcedir 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
54 81
55inherit linux-info 82inherit linux-info
56ECLASS=linux-mod 83ECLASS=linux-mod
57INHERITED="$INHERITED $ECLASS" 84INHERITED="$INHERITED $ECLASS"
58EXPORT_FUNCTIONS pkg_setup src_install pkg_postinst src_compile 85EXPORT_FUNCTIONS pkg_setup pkg_postinst src_install src_compile \
86 src_compile_userland src_install_userland
59 87
88SLOT="0"
60DESCRIPTION="Based on the $ECLASS eclass" 89DESCRIPTION="Based on the $ECLASS eclass"
61SLOT=0
62DEPEND="virtual/linux-sources 90DEPEND="virtual/linux-sources
63 sys-apps/sed 91 sys-apps/sed
64 virtual/modutils" 92 virtual/modutils"
93
65 94
66# eclass utilities 95# eclass utilities
67# ---------------------------------- 96# ----------------------------------
68 97
69use_m() { 98use_m() {
103 ewarn 132 ewarn
104 fi 133 fi
105} 134}
106 135
107update_modules() { 136update_modules() {
108 if [ -x /sbin/modules-update ] ; 137 if [ -x /sbin/modules-update -a \
109 then 138 -n "$(grep -v -e "^#" -e "^$" ${D}/etc/modules.d/*)" ] ; then
110 ebegin "Updating modules.conf" 139 ebegin "Updating modules.conf"
111 /sbin/modules-update 140 /sbin/modules-update
112 eend $? 141 eend $?
113 fi 142 fi
114} 143}
118 then 147 then
119 KV_OBJ="ko" 148 KV_OBJ="ko"
120 else 149 else
121 KV_OBJ="o" 150 KV_OBJ="o"
122 fi 151 fi
152 # Do we really need to know this?
153 # Lets silence it.
123 einfo "Using KV_OBJ=${KV_OBJ}" 154 # einfo "Using KV_OBJ=${KV_OBJ}"
124} 155}
125 156
126generate_modulesd() { 157generate_modulesd() {
127 # This function will generate the neccessary modules.d file from the 158 # This function will generate the neccessary modules.d file from the
128 # information contained in the modules exported parms 159 # information contained in the modules exported parms
129 160
130 local selectedmodule selectedmodule_full selectedmodulevars parameter modinfop arg xifs temp 161 local currm_path currm t myIFS myVAR
131 local module_docs module_opts module_aliases module_config 162 local module_docs module_enabled module_aliases \
132 163 module_additions module_examples module_modinfo module_opts
133 for arg in ${@}
134 do
135 selectedmodule_full="${arg}"
136 # strip the directory
137 selectedmodule="${selectedmodule_full/*\//}"
138 # convert the modulename to uppercase
139 selectedmodule="$(echo ${selectedmodule} | tr '[:lower:]' '[:upper:]')"
140 164
141 module_docs="MODULESD_${selectedmodule}_DOCS" 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})"
142 module_aliases="$(eval echo \$\{#MODULESD_${selectedmodule}_ALIASES[*]\})" 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
143 [ ${module_aliases} == 0 ] && unset module_aliases 176 [[ ${module_aliases} -eq 0 ]] && unset module_aliases
144 module_docs="${!module_docs}" 177 [[ ${module_additions} -eq 0 ]] && unset module_additions
145 modinfop="$(modinfo -p ${selectedmodule_full}.${KV_OBJ})" 178 [[ ${module_examples} -eq 0 ]] && unset module_examples
146 179
147 # By now we know if there is anything we can use to generate a file with 180 # If we specify we dont want it, then lets exit, otherwise we assume
148 # so unset empty vars and bail out if we find nothing. 181 # that if its set, we do want it.
182 [[ ${module_enabled} == no ]] && return 0
183
184 # unset any unwanted variables.
149 for parameter in ${!module_*} 185 for t in ${!module_*}
150 do 186 do
151 [ -z "${!parameter}" ] && unset ${parameter} 187 [[ -z ${!t} ]] && unset ${t}
152 done 188 done
153 [ -z "${!module_*}" -a -z "${modinfop}" ] && return
154 189
155 #so now we can set the configfilevar 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})"
156 module_config="${T}/modulesd-${selectedmodule}" 195 module_config="${T}/modulesd-${currm}"
157 196
158 # and being working on things.
159 ebegin "Preparing file for modules.d" 197 ebegin "Preparing file for modules.d"
198 einfo "Using: ${module_config}"
199 #-----------------------------------------------------------------------
160 echo "# modules.d config file for ${selectedmodule}" >> ${module_config} 200 echo "# modules.d configuration file for ${currm}" >> ${module_config}
161 echo "# this file was automatically generated from linux-mod.eclass" >> ${module_config} 201 #-----------------------------------------------------------------------
202 [[ -n ${module_docs} ]] && \
203 echo "# For more information please read:" >> ${module_config}
162 for temp in ${module_docs} 204 for t in ${module_docs}
163 do 205 do
164 echo "# Please read ${temp/*\//} for more info" >> ${module_config} 206 echo "# ${t//*\/}" >> ${module_config}
165 done 207 done
166
167 if [ ${module_aliases} > 0 ];
168 then
169 echo >> ${module_config} 208 echo >> ${module_config}
209
210 #-----------------------------------------------------------------------
211 if [[ ${module_aliases} -gt 0 ]]
212 then
170 echo "# Internal Aliases - Do not edit" >> ${module_config} 213 echo "# Internal Aliases - Do not edit" >> ${module_config}
171 echo "# ------------------------------" >> ${module_config} 214 echo "# ------------------------------" >> ${module_config}
172 215
173 (( module_aliases-- )) 216 for((t=0; t<${module_aliases}; t++))
174 for temp in $(seq 0 ${module_aliases})
175 do 217 do
176 echo "alias $(eval echo \$\{MODULESD_${selectedmodule}_ALIASES[$temp]\})" >> ${module_config} 218 echo "alias $(eval echo \${MODULESD_${currm}_ALIASES[$t]})" \
219 >> ${module_config}
177 done 220 done
221 echo '' >> ${module_config}
178 fi 222 fi
179 223
180 # and then stating any module parameters defined from the module 224 #-----------------------------------------------------------------------
181 if [ -n "${modinfop}" ]; 225 if [[ -n ${module_modinfo} ]]
182 then 226 then
183 echo >> ${module_config} 227 echo >> ${module_config}
184 echo "# Configurable module parameters" >> ${module_config} 228 echo "# Configurable module parameters" >> ${module_config}
185 echo "# ------------------------------" >> ${module_config} 229 echo "# ------------------------------" >> ${module_config}
186 230 myIFS="${IFS}"
187 xifs="${IFS}"
188 IFS="$(echo -en "\n\b")" 231 IFS="$(echo -en "\n\b")"
189 for parameter in ${modinfop} 232
233 for t in ${module_modinfo}
190 do 234 do
191 temp="$(echo ${parameter#*:} | grep -e " [0-9][ =]" | sed "s:.*\([01][= ]\).*:\1:")" 235 myVAR="$(echo ${t#*:} | grep -e " [0-9][ =]" | sed "s:.*\([01][= ]\).*:\1:")"
192 if [ -n "${temp}" ]; 236 if [[ -n ${myVAR} ]]
193 then 237 then
194 module_opts="${module_opts} ${parameter%%:*}:${temp}" 238 module_opts="${module_opts} ${t%%:*}:${myVAR}"
195 fi 239 fi
196 echo -e "# ${parameter%%:*}:\t${parameter#*:}" >> ${module_config} 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}
197 done 268 done
198 IFS="${xifs}" 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}
199 fi 281 fi
200 282
201 # and any examples we can gather from them 283 #-----------------------------------------------------------------------
202 if [ -n "${module_opts}" ]; 284
203 then
204 echo >> ${module_config}
205 echo "# For Example..." >> ${module_config}
206 echo "# ------------------------------" >> ${module_config}
207 for parameter in ${module_opts}
208 do
209 echo "# options ${selectedmodule_full/*\//} ${parameter//:*}=${parameter//*:}" >> ${module_config}
210 done
211 fi
212
213 # then we install it 285 # then we install it
214 insinto /etc/modules.d 286 insinto /etc/modules.d
215 newins ${module_config} ${selectedmodule_full/*\//} 287 newins ${module_config} ${currm_path//*\/}
216 288
217 # and install any documentation we might have. 289 # and install any documentation we might have.
218 [ -n "${module_docs}" ] && dodoc ${module_docs} 290 [[ -n ${module_docs} ]] && dodoc ${module_docs}
219 done 291 done
220 eend 0 292 eend 0
293 return 0
221} 294}
222 295
223display_postinst() { 296display_postinst() {
224 # if we haven't determined the version yet, we need too. 297 # if we haven't determined the version yet, we need too.
225 get_version; 298 get_version;
227 local modulename moduledir sourcedir moduletemp file i 300 local modulename moduledir sourcedir moduletemp file i
228 301
229 file=${ROOT}/etc/modules.autoload.d/kernel-${KV_MAJOR}.${KV_MINOR} 302 file=${ROOT}/etc/modules.autoload.d/kernel-${KV_MAJOR}.${KV_MINOR}
230 file=${file/\/\///} 303 file=${file/\/\///}
231 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
232 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"
233 einfo "please type the following as root:" 313 einfo "please type the following as root:"
234 for i in ${MODULE_NAMES} 314 for i in ${MODULE_NAMES}
235 do 315 do
236 moduletemp="$(echo ${i} | sed -e "s:\(.*\)(\(.*\)):\1 \2:")" 316 unset libdir srcdir objdir
237 modulename="${moduletemp/ */}" 317 for n in $(find_module_params ${i})
238 moduletemp="${moduletemp/* /}" 318 do
239 # if we specify two args, then we can set moduledir 319 eval ${n/:*}=${n/*:/}
240 [ -z "${moduletemp/*:*/}" ] && moduledir="${moduletemp/:*/}" 320 done
241 # if we didnt pass the brackets, then we shouldnt accept anything
242 [ -n "${moduletemp/${modulename}/}" ] && sourcedir="${moduletemp/*:/}"
243 moduledir="${moduledir:-misc}"
244 sourcedir="${sourcedir:-${S}}"
245
246 einfo " # echo \"${modulename}\" >> ${file}" 321 einfo " # echo \"${modulename}\" >> ${file}"
247 done 322 done
248 echo 323 einfo
324 fi
249} 325}
250 326
251find_module_params() { 327find_module_params() {
252 local matched_offset=0 matched_opts=0 test="${@}" temp_var result 328 local matched_offset=0 matched_opts=0 test="${@}" temp_var result
253 local i=0 y=0 z=0 329 local i=0 y=0 z=0
296 check_kernel_built; 372 check_kernel_built;
297 check_modules_supported; 373 check_modules_supported;
298 set_kvobj; 374 set_kvobj;
299} 375}
300 376
377linux-mod_src_compile_userland() {
378 return 0
379}
380
381linux-mod_src_install_userland() {
382 return 0
383}
384
301linux-mod_src_compile() { 385linux-mod_src_compile() {
302 local modulename libdir srcdir objdir i n 386 local modulename libdir srcdir objdir i n myARCH="${ARCH}"
303 387 unset ARCH
388
304 BUILD_TARGETS=${BUILD_TARGETS:-clean module} 389 BUILD_TARGETS=${BUILD_TARGETS:-clean module}
390
391 for i in ${MODULE_IGNORE}
392 do
305 MODULE_NAMES=${MODULE_NAMES//${MODULE_IGNORE}} 393 MODULE_NAMES=${MODULE_NAMES//${i}(*}
394 done
306 395
307 for i in ${MODULE_NAMES} 396 for i in ${MODULE_NAMES}
308 do 397 do
398 unset libdir srcdir objdir
309 for n in $(find_module_params ${i}) 399 for n in $(find_module_params ${i})
310 do 400 do
311 eval ${n/:*}=${n/*:/} 401 eval ${n/:*}=${n/*:/}
312 done 402 done
313 libdir=${libdir:-misc} 403 libdir=${libdir:-misc}
316 406
317 if [ ! -f "${srcdir}/.built" ]; 407 if [ ! -f "${srcdir}/.built" ];
318 then 408 then
319 cd ${srcdir} 409 cd ${srcdir}
320 einfo "Preparing ${modulename} module" 410 einfo "Preparing ${modulename} module"
411 if [[ -n ${ECONF_PARAMS} ]]
412 then
413 econf ${ECONF_PARAMS} || \
414 die "Unable to run econf ${ECONF_PARAMS}"
415 fi
416
321 env -u ARCH emake ${BUILD_FIXES} ${BUILD_PARAMS} ${BUILD_TARGETS} \ 417 emake ${BUILD_FIXES} ${BUILD_PARAMS} ${BUILD_TARGETS} \
322 || die "Unable to make \ 418 || die "Unable to make \
323 ${BUILD_FIXES} ${BUILD_PARAMS} ${BUILD_TARGETS}." 419 ${BUILD_FIXES} ${BUILD_PARAMS} ${BUILD_TARGETS}."
324 touch ${srcdir}/.built 420 touch ${srcdir}/.built
325 cd ${OLDPWD} 421 cd ${OLDPWD}
326 fi 422 fi
327 done 423 done
424
425 ARCH="${myARCH}"
328} 426}
329 427
330linux-mod_src_install() { 428linux-mod_src_install() {
331 local modulename libdir srcdir objdir i n 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
332 435
333 for i in ${MODULE_NAMES} 436 for i in ${MODULE_NAMES}
334 do 437 do
438 unset libdir srcdir objdir
335 for n in $(find_module_params ${i}) 439 for n in $(find_module_params ${i})
336 do 440 do
337 eval ${n/:*}=${n/*:/} 441 eval ${n/:*}=${n/*:/}
338 done 442 done
339 libdir=${libdir:-misc} 443 libdir=${libdir:-misc}
340 srcdir=${srcdir:-${S}} 444 srcdir=${srcdir:-${S}}
341 objdir=${objdir:-${srcdir}} 445 objdir=${objdir:-${srcdir}}
342 446
343 einfo "Installing ${modulename} module" 447 einfo "Installing ${modulename} module"
344 cd ${objdir} 448 cd ${objdir}
345
346 insinto /lib/modules/${KV_FULL}/${libdir} 449 insinto ${ROOT}lib/modules/${KV_FULL}/${libdir}
347 doins ${modulename}.${KV_OBJ} 450 doins ${modulename}.${KV_OBJ}
348 cd ${OLDPWD} 451 cd ${OLDPWD}
349 452
350 [ -z "${NO_MODULESD}" ] && generate_modulesd ${objdir}/${modulename} 453 generate_modulesd ${objdir}/${modulename}
351 done 454 done
352} 455}
353 456
354linux-mod_pkg_postinst() { 457linux-mod_pkg_postinst() {
355 update_depmod; 458 update_depmod;

Legend:
Removed from v.1.19  
changed lines
  Added in v.1.27

  ViewVC Help
Powered by ViewVC 1.1.20