/[gentoo-x86]/eclass/linux-mod.eclass
Gentoo

Contents of /eclass/linux-mod.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.31 - (hide annotations) (download)
Fri Mar 11 23:11:05 2005 UTC (9 years, 9 months ago) by kingtaco
Branch: MAIN
Changes since 1.30: +3 -3 lines
linux-mod.eclass: fixed grep in update_modules() so it's not a subshell, and doesn't output when no files are found

1 johnm 1.1 # Copyright 1999-2004 Gentoo Foundation
2     # Distributed under the terms of the GNU General Public License v2
3 kingtaco 1.31 # $Header: /var/cvsroot/gentoo-x86/eclass/linux-mod.eclass,v 1.30 2005/03/08 21:41:31 johnm Exp $
4 johnm 1.1
5 johnm 1.10 # Description: This eclass is used to interface with linux-info in such a way
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 johnm 1.26 # 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 johnm 1.10
35     # MODULE_NAMES - Detailed Overview
36     #
37     # The structure of each MODULE_NAMES entry is as follows:
38 johnm 1.26 # modulename(libdir:srcdir:objdir)
39 johnm 1.10 # for example:
40 johnm 1.26 # MODULE_NAMES="module_pci(pci:${S}/pci:${S}) module_usb(usb:${S}/usb:${S})"
41 johnm 1.10 #
42     # what this would do is
43     # cd ${S}/pci
44     # make ${BUILD_PARAMS} ${BUILD_TARGETS}
45 johnm 1.26 # cd ${S}
46 johnm 1.10 # insinto /lib/modules/${KV_FULL}/pci
47     # doins module_pci.${KV_OBJ}
48     #
49     # cd ${S}/usb
50     # make ${BUILD_PARAMS} ${BUILD_TARGETS}
51 johnm 1.26 # cd ${S}
52 johnm 1.10 # insinto /lib/modules/${KV_FULL}/usb
53     # doins module_usb.${KV_OBJ}
54     #
55 johnm 1.26 # 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    
81 johnm 1.1
82     inherit linux-info
83     ECLASS=linux-mod
84     INHERITED="$INHERITED $ECLASS"
85 johnm 1.26 EXPORT_FUNCTIONS pkg_setup pkg_postinst src_install src_compile \
86     src_compile_userland src_install_userland
87 johnm 1.1
88 johnm 1.26 SLOT="0"
89 johnm 1.1 DESCRIPTION="Based on the $ECLASS eclass"
90     DEPEND="virtual/linux-sources
91 johnm 1.11 sys-apps/sed
92 johnm 1.17 virtual/modutils"
93 johnm 1.1
94 johnm 1.26
95 johnm 1.1 # eclass utilities
96     # ----------------------------------
97    
98     use_m() {
99     # if we haven't determined the version yet, we need too.
100     get_version;
101    
102     # if the kernel version is greater than 2.6.6 then we should use
103 johnm 1.8 # M= instead of SUBDIRS=
104 johnm 1.1 [ ${KV_MAJOR} -eq 2 -a ${KV_MINOR} -gt 5 -a ${KV_PATCH} -gt 5 ] && \
105     return 0 || return 1
106     }
107    
108     convert_to_m() {
109     [ ! -f "${1}" ] && die "convert_to_m() requires a filename as an argument"
110     if use_m
111     then
112 johnm 1.8 ebegin "Converting ${1/${WORKDIR}\//} to use M= instead of SUBDIRS="
113 johnm 1.1 sed -i 's:SUBDIRS=:M=:g' ${1}
114     eend $?
115     fi
116     }
117    
118     update_depmod() {
119     # if we haven't determined the version yet, we need too.
120     get_version;
121    
122     ebegin "Updating module dependencies for ${KV_FULL}"
123 johnm 1.5 if [ -r ${KV_OUT_DIR}/System.map ]
124 johnm 1.1 then
125 johnm 1.5 depmod -ae -F ${KV_OUT_DIR}/System.map -b ${ROOT} -r ${KV_FULL}
126 johnm 1.18 eend $?
127 johnm 1.1 else
128     ewarn
129 johnm 1.5 ewarn "${KV_OUT_DIR}/System.map not found."
130 johnm 1.1 ewarn "You must manually update the kernel module dependencies using depmod."
131 johnm 1.18 eend 1
132 johnm 1.1 ewarn
133     fi
134     }
135    
136 johnm 1.3 update_modules() {
137 kingtaco 1.31 if [ -x /sbin/modules-update ] && \
138     grep -v -e "^#" -e "^$" ${D}/etc/modules.d/* >/dev/null 2>&1; then
139 johnm 1.3 ebegin "Updating modules.conf"
140     /sbin/modules-update
141     eend $?
142     fi
143     }
144    
145 johnm 1.1 set_kvobj() {
146     if kernel_is 2 6
147     then
148     KV_OBJ="ko"
149     else
150     KV_OBJ="o"
151     fi
152 johnm 1.26 # Do we really need to know this?
153     # Lets silence it.
154     # einfo "Using KV_OBJ=${KV_OBJ}"
155 johnm 1.1 }
156    
157 johnm 1.11 generate_modulesd() {
158     # This function will generate the neccessary modules.d file from the
159     # information contained in the modules exported parms
160 johnm 1.26
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 johnm 1.11 do
167 johnm 1.26 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 johnm 1.30 module_aliases="$(eval echo \${#MODULESD_${currm/-/_}_ALIASES[*]})"
173     module_additions="$(eval echo \${#MODULESD_${currm/-/_}_ADDITIONS[*]})"
174     module_examples="$(eval echo \${#MODULESD_${currm/-/_}_EXAMPLES[*]})"
175 johnm 1.26
176 johnm 1.27 [[ ${module_aliases} -eq 0 ]] && unset module_aliases
177     [[ ${module_additions} -eq 0 ]] && unset module_additions
178     [[ ${module_examples} -eq 0 ]] && unset module_examples
179 johnm 1.26
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 johnm 1.11 do
187 johnm 1.26 [[ -z ${!t} ]] && unset ${t}
188 johnm 1.11 done
189    
190 johnm 1.26 [[ -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 johnm 1.11 ebegin "Preparing file for modules.d"
198 johnm 1.26 #-----------------------------------------------------------------------
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 johnm 1.11 do
205 johnm 1.26 echo "# ${t//*\/}" >> ${module_config}
206 johnm 1.11 done
207 johnm 1.26 echo >> ${module_config}
208 johnm 1.11
209 johnm 1.26 #-----------------------------------------------------------------------
210 johnm 1.27 if [[ ${module_aliases} -gt 0 ]]
211 johnm 1.11 then
212     echo "# Internal Aliases - Do not edit" >> ${module_config}
213     echo "# ------------------------------" >> ${module_config}
214 johnm 1.12
215 johnm 1.26 for((t=0; t<${module_aliases}; t++))
216 johnm 1.11 do
217 johnm 1.26 echo "alias $(eval echo \${MODULESD_${currm}_ALIASES[$t]})" \
218     >> ${module_config}
219 johnm 1.12 done
220 johnm 1.26 echo '' >> ${module_config}
221 johnm 1.11 fi
222    
223 johnm 1.26 #-----------------------------------------------------------------------
224     if [[ -n ${module_modinfo} ]]
225 johnm 1.11 then
226     echo >> ${module_config}
227     echo "# Configurable module parameters" >> ${module_config}
228     echo "# ------------------------------" >> ${module_config}
229 johnm 1.26 myIFS="${IFS}"
230 johnm 1.11 IFS="$(echo -en "\n\b")"
231 johnm 1.26
232     for t in ${module_modinfo}
233 johnm 1.11 do
234 johnm 1.26 myVAR="$(echo ${t#*:} | grep -e " [0-9][ =]" | sed "s:.*\([01][= ]\).*:\1:")"
235     if [[ -n ${myVAR} ]]
236 johnm 1.11 then
237 johnm 1.26 module_opts="${module_opts} ${t%%:*}:${myVAR}"
238 johnm 1.11 fi
239 johnm 1.26 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 johnm 1.27 elif [[ ${module_examples} -gt 0 ]]
260 johnm 1.26 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 johnm 1.11 done
268 johnm 1.26 echo '' >> ${module_config}
269 johnm 1.11 fi
270 johnm 1.26
271     #-----------------------------------------------------------------------
272 johnm 1.27 if [[ ${module_additions} -gt 0 ]]
273 johnm 1.11 then
274 johnm 1.26 for((t=0; t<${module_additions}; t++))
275 johnm 1.11 do
276 johnm 1.26 echo "$(eval echo \${MODULESD_${currm}_ADDITIONS[$t]})" \
277     >> ${module_config}
278 johnm 1.11 done
279 johnm 1.26 echo '' >> ${module_config}
280 johnm 1.11 fi
281    
282 johnm 1.26 #-----------------------------------------------------------------------
283    
284 johnm 1.12 # then we install it
285 johnm 1.11 insinto /etc/modules.d
286 johnm 1.27 newins ${module_config} ${currm_path//*\/}
287    
288 johnm 1.12 # and install any documentation we might have.
289 johnm 1.26 [[ -n ${module_docs} ]] && dodoc ${module_docs}
290 johnm 1.11 done
291     eend 0
292 johnm 1.26 return 0
293 johnm 1.11 }
294    
295 johnm 1.1 display_postinst() {
296     # if we haven't determined the version yet, we need too.
297     get_version;
298    
299 johnm 1.10 local modulename moduledir sourcedir moduletemp file i
300 johnm 1.1
301     file=${ROOT}/etc/modules.autoload.d/kernel-${KV_MAJOR}.${KV_MINOR}
302     file=${file/\/\///}
303    
304 johnm 1.20 for i in ${MODULE_IGNORE}
305     do
306     MODULE_NAMES=${MODULE_NAMES//${i}(*}
307     done
308    
309 johnm 1.22 if [[ -n ${MODULE_NAMES} ]]
310     then
311     einfo "If you would like to load this module automatically upon boot"
312     einfo "please type the following as root:"
313     for i in ${MODULE_NAMES}
314 johnm 1.20 do
315 johnm 1.23 unset libdir srcdir objdir
316 johnm 1.22 for n in $(find_module_params ${i})
317     do
318     eval ${n/:*}=${n/*:/}
319     done
320     einfo " # echo \"${modulename}\" >> ${file}"
321 johnm 1.20 done
322 johnm 1.22 einfo
323     fi
324 johnm 1.1 }
325    
326 johnm 1.18 find_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
354    
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
361     done
362    
363     echo ${result}
364     }
365    
366 johnm 1.1 # default ebuild functions
367     # --------------------------------
368    
369     linux-mod_pkg_setup() {
370 johnm 1.6 linux-info_pkg_setup;
371     check_kernel_built;
372 johnm 1.1 check_modules_supported;
373     set_kvobj;
374     }
375    
376 johnm 1.26 linux-mod_src_compile_userland() {
377     return 0
378     }
379    
380     linux-mod_src_install_userland() {
381     return 0
382     }
383    
384 johnm 1.1 linux-mod_src_compile() {
385 johnm 1.26 local modulename libdir srcdir objdir i n myARCH="${ARCH}"
386 johnm 1.21 unset ARCH
387 johnm 1.26
388 johnm 1.16 BUILD_TARGETS=${BUILD_TARGETS:-clean module}
389 johnm 1.20
390     for i in ${MODULE_IGNORE}
391     do
392     MODULE_NAMES=${MODULE_NAMES//${i}(*}
393     done
394 johnm 1.1
395 johnm 1.9 for i in ${MODULE_NAMES}
396 johnm 1.1 do
397 johnm 1.23 unset libdir srcdir objdir
398 johnm 1.18 for n in $(find_module_params ${i})
399     do
400     eval ${n/:*}=${n/*:/}
401     done
402     libdir=${libdir:-misc}
403     srcdir=${srcdir:-${S}}
404     objdir=${objdir:-${srcdir}}
405 johnm 1.10
406 johnm 1.18 if [ ! -f "${srcdir}/.built" ];
407 johnm 1.16 then
408 johnm 1.18 cd ${srcdir}
409 johnm 1.16 einfo "Preparing ${modulename} module"
410 johnm 1.22 if [[ -n ${ECONF_PARAMS} ]]
411     then
412     econf ${ECONF_PARAMS} || \
413     die "Unable to run econf ${ECONF_PARAMS}"
414     fi
415    
416 johnm 1.21 emake ${BUILD_FIXES} ${BUILD_PARAMS} ${BUILD_TARGETS} \
417 johnm 1.18 || die "Unable to make \
418     ${BUILD_FIXES} ${BUILD_PARAMS} ${BUILD_TARGETS}."
419     touch ${srcdir}/.built
420 johnm 1.16 cd ${OLDPWD}
421     fi
422 johnm 1.1 done
423 johnm 1.26
424     ARCH="${myARCH}"
425 johnm 1.1 }
426    
427     linux-mod_src_install() {
428 johnm 1.18 local modulename libdir srcdir objdir i n
429 johnm 1.20
430     for i in ${MODULE_IGNORE}
431     do
432     MODULE_NAMES=${MODULE_NAMES//${i}(*}
433     done
434 johnm 1.1
435 johnm 1.9 for i in ${MODULE_NAMES}
436 johnm 1.1 do
437 johnm 1.23 unset libdir srcdir objdir
438 johnm 1.18 for n in $(find_module_params ${i})
439     do
440     eval ${n/:*}=${n/*:/}
441     done
442     libdir=${libdir:-misc}
443     srcdir=${srcdir:-${S}}
444     objdir=${objdir:-${srcdir}}
445 johnm 1.1
446     einfo "Installing ${modulename} module"
447 johnm 1.18 cd ${objdir}
448 johnm 1.26 insinto ${ROOT}lib/modules/${KV_FULL}/${libdir}
449 johnm 1.1 doins ${modulename}.${KV_OBJ}
450 johnm 1.16 cd ${OLDPWD}
451 johnm 1.11
452 johnm 1.26 generate_modulesd ${objdir}/${modulename}
453 johnm 1.1 done
454     }
455    
456     linux-mod_pkg_postinst() {
457     update_depmod;
458 johnm 1.3 update_modules;
459 johnm 1.1 display_postinst;
460     }

  ViewVC Help
Powered by ViewVC 1.1.20