1 |
# Copyright 1999-2004 Gentoo Foundation |
2 |
# Distributed under the terms of the GNU General Public License v2 |
3 |
# $Header: /var/cvsroot/gentoo-x86/eclass/linux-mod.eclass,v 1.17 2005/01/09 19:10:55 johnm Exp $ |
4 |
|
5 |
# 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 |
# Env Var Option Default Description |
19 |
# KERNEL_DIR <string> /usr/src/linux The directory containing kernel |
20 |
# the target kernel sources. |
21 |
# BUILD_PARAMS <string> The parameters to pass to make. |
22 |
# BUILD_TARGETS <string> clean modules The build targets to pass to make. |
23 |
# MODULE_NAMES <string> This is the modules which are |
24 |
# to be built automatically using the |
25 |
# default pkg_compile/install. They |
26 |
# are explained properly below. |
27 |
# It will only make BUILD_TARGETS once |
28 |
# in any directory. |
29 |
# NO_MODULESD <string> Set this to something to prevent |
30 |
# modulesd file generation |
31 |
|
32 |
|
33 |
# MODULE_NAMES - Detailed Overview |
34 |
# |
35 |
# The structure of each MODULE_NAMES entry is as follows: |
36 |
# modulename(libmodulesdir:modulesourcedir) |
37 |
# for example: |
38 |
# MODULE_NAMES="module_pci(pci:${S}/pci) module_usb(usb:${S}/usb)" |
39 |
# |
40 |
# what this would do is |
41 |
# cd ${S}/pci |
42 |
# make ${BUILD_PARAMS} ${BUILD_TARGETS} |
43 |
# insinto /lib/modules/${KV_FULL}/pci |
44 |
# doins module_pci.${KV_OBJ} |
45 |
# |
46 |
# cd ${S}/usb |
47 |
# make ${BUILD_PARAMS} ${BUILD_TARGETS} |
48 |
# insinto /lib/modules/${KV_FULL}/usb |
49 |
# doins module_usb.${KV_OBJ} |
50 |
# |
51 |
# if the modulessourcedir isnt specified, it assumes ${S} |
52 |
# if the libmodulesdir isnt specified, it assumes misc. |
53 |
# if no seperator is defined ":" then it assumes the argument is modulesourcedir |
54 |
|
55 |
inherit linux-info |
56 |
ECLASS=linux-mod |
57 |
INHERITED="$INHERITED $ECLASS" |
58 |
EXPORT_FUNCTIONS pkg_setup src_install pkg_postinst src_compile |
59 |
|
60 |
DESCRIPTION="Based on the $ECLASS eclass" |
61 |
SLOT=0 |
62 |
DEPEND="virtual/linux-sources |
63 |
sys-apps/sed |
64 |
virtual/modutils" |
65 |
|
66 |
# eclass utilities |
67 |
# ---------------------------------- |
68 |
|
69 |
use_m() { |
70 |
# if we haven't determined the version yet, we need too. |
71 |
get_version; |
72 |
|
73 |
# if the kernel version is greater than 2.6.6 then we should use |
74 |
# M= instead of SUBDIRS= |
75 |
[ ${KV_MAJOR} -eq 2 -a ${KV_MINOR} -gt 5 -a ${KV_PATCH} -gt 5 ] && \ |
76 |
return 0 || return 1 |
77 |
} |
78 |
|
79 |
convert_to_m() { |
80 |
[ ! -f "${1}" ] && die "convert_to_m() requires a filename as an argument" |
81 |
if use_m |
82 |
then |
83 |
ebegin "Converting ${1/${WORKDIR}\//} to use M= instead of SUBDIRS=" |
84 |
sed -i 's:SUBDIRS=:M=:g' ${1} |
85 |
eend $? |
86 |
fi |
87 |
} |
88 |
|
89 |
update_depmod() { |
90 |
# if we haven't determined the version yet, we need too. |
91 |
get_version; |
92 |
|
93 |
ebegin "Updating module dependencies for ${KV_FULL}" |
94 |
if [ -r ${KV_OUT_DIR}/System.map ] |
95 |
then |
96 |
depmod -ae -F ${KV_OUT_DIR}/System.map -b ${ROOT} -r ${KV_FULL} |
97 |
eend $? |
98 |
else |
99 |
ewarn |
100 |
ewarn "${KV_OUT_DIR}/System.map not found." |
101 |
ewarn "You must manually update the kernel module dependencies using depmod." |
102 |
eend 1 |
103 |
ewarn |
104 |
fi |
105 |
} |
106 |
|
107 |
update_modules() { |
108 |
if [ -x /sbin/modules-update ] ; |
109 |
then |
110 |
ebegin "Updating modules.conf" |
111 |
/sbin/modules-update |
112 |
eend $? |
113 |
fi |
114 |
} |
115 |
|
116 |
set_kvobj() { |
117 |
if kernel_is 2 6 |
118 |
then |
119 |
KV_OBJ="ko" |
120 |
else |
121 |
KV_OBJ="o" |
122 |
fi |
123 |
einfo "Using KV_OBJ=${KV_OBJ}" |
124 |
} |
125 |
|
126 |
generate_modulesd() { |
127 |
# This function will generate the neccessary modules.d file from the |
128 |
# information contained in the modules exported parms |
129 |
|
130 |
local selectedmodule selectedmodule_full selectedmodulevars parameter modinfop arg xifs temp |
131 |
local module_docs module_opts module_aliases module_config |
132 |
|
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 |
|
141 |
module_docs="MODULESD_${selectedmodule}_DOCS" |
142 |
module_aliases="$(eval echo \$\{#MODULESD_${selectedmodule}_ALIASES[*]\})" |
143 |
[ ${module_aliases} == 0 ] && unset module_aliases |
144 |
module_docs="${!module_docs}" |
145 |
modinfop="$(modinfo -p ${selectedmodule_full}.${KV_OBJ})" |
146 |
|
147 |
# By now we know if there is anything we can use to generate a file with |
148 |
# so unset empty vars and bail out if we find nothing. |
149 |
for parameter in ${!module_*} |
150 |
do |
151 |
[ -z "${!parameter}" ] && unset ${parameter} |
152 |
done |
153 |
[ -z "${!module_*}" -a -z "${modinfop}" ] && return |
154 |
|
155 |
#so now we can set the configfilevar |
156 |
module_config="${T}/modulesd-${selectedmodule}" |
157 |
|
158 |
# and being working on things. |
159 |
ebegin "Preparing file for modules.d" |
160 |
echo "# modules.d config file for ${selectedmodule}" >> ${module_config} |
161 |
echo "# this file was automatically generated from linux-mod.eclass" >> ${module_config} |
162 |
for temp in ${module_docs} |
163 |
do |
164 |
echo "# Please read ${temp/*\//} for more info" >> ${module_config} |
165 |
done |
166 |
|
167 |
if [ ${module_aliases} > 0 ]; |
168 |
then |
169 |
echo >> ${module_config} |
170 |
echo "# Internal Aliases - Do not edit" >> ${module_config} |
171 |
echo "# ------------------------------" >> ${module_config} |
172 |
|
173 |
(( module_aliases-- )) |
174 |
for temp in $(seq 0 ${module_aliases}) |
175 |
do |
176 |
echo "alias $(eval echo \$\{MODULESD_${selectedmodule}_ALIASES[$temp]\})" >> ${module_config} |
177 |
done |
178 |
fi |
179 |
|
180 |
# and then stating any module parameters defined from the module |
181 |
if [ -n "${modinfop}" ]; |
182 |
then |
183 |
echo >> ${module_config} |
184 |
echo "# Configurable module parameters" >> ${module_config} |
185 |
echo "# ------------------------------" >> ${module_config} |
186 |
|
187 |
xifs="${IFS}" |
188 |
IFS="$(echo -en "\n\b")" |
189 |
for parameter in ${modinfop} |
190 |
do |
191 |
temp="$(echo ${parameter#*:} | grep -e " [0-9][ =]" | sed "s:.*\([01][= ]\).*:\1:")" |
192 |
if [ -n "${temp}" ]; |
193 |
then |
194 |
module_opts="${module_opts} ${parameter%%:*}:${temp}" |
195 |
fi |
196 |
echo -e "# ${parameter%%:*}:\t${parameter#*:}" >> ${module_config} |
197 |
done |
198 |
IFS="${xifs}" |
199 |
fi |
200 |
|
201 |
# and any examples we can gather from them |
202 |
if [ -n "${module_opts}" ]; |
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 |
214 |
insinto /etc/modules.d |
215 |
newins ${module_config} ${selectedmodule_full/*\//} |
216 |
|
217 |
# and install any documentation we might have. |
218 |
[ -n "${module_docs}" ] && dodoc ${module_docs} |
219 |
done |
220 |
eend 0 |
221 |
} |
222 |
|
223 |
display_postinst() { |
224 |
# if we haven't determined the version yet, we need too. |
225 |
get_version; |
226 |
|
227 |
local modulename moduledir sourcedir moduletemp file i |
228 |
|
229 |
file=${ROOT}/etc/modules.autoload.d/kernel-${KV_MAJOR}.${KV_MINOR} |
230 |
file=${file/\/\///} |
231 |
|
232 |
einfo "If you would like to load this module automatically upon boot" |
233 |
einfo "please type the following as root:" |
234 |
for i in ${MODULE_NAMES} |
235 |
do |
236 |
moduletemp="$(echo ${i} | sed -e "s:\(.*\)(\(.*\)):\1 \2:")" |
237 |
modulename="${moduletemp/ */}" |
238 |
moduletemp="${moduletemp/* /}" |
239 |
# if we specify two args, then we can set moduledir |
240 |
[ -z "${moduletemp/*:*/}" ] && moduledir="${moduletemp/:*/}" |
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}" |
247 |
done |
248 |
echo |
249 |
} |
250 |
|
251 |
find_module_params() { |
252 |
local matched_offset=0 matched_opts=0 test="${@}" temp_var result |
253 |
local i=0 y=0 z=0 |
254 |
|
255 |
for((i=0; i<=${#test}; i++)) |
256 |
do |
257 |
case ${test:${i}:1} in |
258 |
\() matched_offset[0]=${i};; |
259 |
\:) matched_opts=$((${matched_opts} + 1)); |
260 |
matched_offset[${matched_opts}]="${i}";; |
261 |
\)) matched_opts=$((${matched_opts} + 1)); |
262 |
matched_offset[${matched_opts}]="${i}";; |
263 |
esac |
264 |
done |
265 |
|
266 |
for((i=0; i<=${matched_opts}; i++)) |
267 |
do |
268 |
# i = offset were working on |
269 |
# y = last offset |
270 |
# z = current offset - last offset |
271 |
# temp_var = temporary name |
272 |
case ${i} in |
273 |
0) tempvar=${test:0:${matched_offset[0]}};; |
274 |
*) y=$((${matched_offset[$((${i} - 1))]} + 1)) |
275 |
z=$((${matched_offset[${i}]} - ${matched_offset[$((${i} - 1))]})); |
276 |
z=$((${z} - 1)) |
277 |
tempvar=${test:${y}:${z}};; |
278 |
esac |
279 |
|
280 |
case ${i} in |
281 |
0) result="${result} modulename:${tempvar}";; |
282 |
1) result="${result} libdir:${tempvar}";; |
283 |
2) result="${result} srcdir:${tempvar}";; |
284 |
3) result="${result} objdir:${tempvar}";; |
285 |
esac |
286 |
done |
287 |
|
288 |
echo ${result} |
289 |
} |
290 |
|
291 |
# default ebuild functions |
292 |
# -------------------------------- |
293 |
|
294 |
linux-mod_pkg_setup() { |
295 |
linux-info_pkg_setup; |
296 |
check_kernel_built; |
297 |
check_modules_supported; |
298 |
set_kvobj; |
299 |
} |
300 |
|
301 |
linux-mod_src_compile() { |
302 |
local modulename libdir srcdir objdir i n |
303 |
|
304 |
BUILD_TARGETS=${BUILD_TARGETS:-clean module} |
305 |
|
306 |
for i in ${MODULE_NAMES} |
307 |
do |
308 |
for n in $(find_module_params ${i}) |
309 |
do |
310 |
eval ${n/:*}=${n/*:/} |
311 |
done |
312 |
libdir=${libdir:-misc} |
313 |
srcdir=${srcdir:-${S}} |
314 |
objdir=${objdir:-${srcdir}} |
315 |
|
316 |
if [ ! -f "${srcdir}/.built" ]; |
317 |
then |
318 |
cd ${srcdir} |
319 |
einfo "Preparing ${modulename} module" |
320 |
env -u ARCH emake ${BUILD_FIXES} ${BUILD_PARAMS} ${BUILD_TARGETS} \ |
321 |
|| die "Unable to make \ |
322 |
${BUILD_FIXES} ${BUILD_PARAMS} ${BUILD_TARGETS}." |
323 |
touch ${srcdir}/.built |
324 |
cd ${OLDPWD} |
325 |
fi |
326 |
done |
327 |
} |
328 |
|
329 |
linux-mod_src_install() { |
330 |
local modulename libdir srcdir objdir i n |
331 |
|
332 |
for i in ${MODULE_NAMES} |
333 |
do |
334 |
for n in $(find_module_params ${i}) |
335 |
do |
336 |
eval ${n/:*}=${n/*:/} |
337 |
done |
338 |
libdir=${libdir:-misc} |
339 |
srcdir=${srcdir:-${S}} |
340 |
objdir=${objdir:-${srcdir}} |
341 |
|
342 |
einfo "Installing ${modulename} module" |
343 |
cd ${objdir} |
344 |
|
345 |
insinto /lib/modules/${KV_FULL}/${libdir} |
346 |
doins ${modulename}.${KV_OBJ} |
347 |
cd ${OLDPWD} |
348 |
|
349 |
[ -z "${NO_MODULESD}" ] && generate_modulesd ${objdir}/${modulename} |
350 |
done |
351 |
} |
352 |
|
353 |
linux-mod_pkg_postinst() { |
354 |
update_depmod; |
355 |
update_modules; |
356 |
display_postinst; |
357 |
} |