/[gentoo-x86]/eclass/multilib-build.eclass
Gentoo

Contents of /eclass/multilib-build.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.25 - (hide annotations) (download)
Tue Dec 31 18:31:47 2013 UTC (7 months, 3 weeks ago) by mgorny
Branch: MAIN
Changes since 1.24: +9 -10 lines
Improve documentation on multilib_is_native_abi & multilib_build_binaries to make it clear which one to use. Requested and reviewed by okias.

1 mgorny 1.1 # Copyright 1999-2013 Gentoo Foundation
2     # Distributed under the terms of the GNU General Public License v2
3 mgorny 1.25 # $Header: /var/cvsroot/gentoo-x86/eclass/multilib-build.eclass,v 1.24 2013/12/28 18:23:25 jlec Exp $
4 mgorny 1.1
5     # @ECLASS: multilib-build.eclass
6     # @MAINTAINER:
7     # Michał Górny <mgorny@gentoo.org>
8     # @BLURB: flags and utility functions for building multilib packages
9     # @DESCRIPTION:
10     # The multilib-build.eclass exports USE flags and utility functions
11     # necessary to build packages for multilib in a clean and uniform
12     # manner.
13     #
14     # Please note that dependency specifications for multilib-capable
15     # dependencies shall use the USE dependency string in ${MULTILIB_USEDEP}
16     # to properly request multilib enabled.
17    
18     if [[ ! ${_MULTILIB_BUILD} ]]; then
19    
20 mgorny 1.12 # EAPI=4 is required for meaningful MULTILIB_USEDEP.
21 mgorny 1.1 case ${EAPI:-0} in
22 mgorny 1.12 4|5) ;;
23 mgorny 1.1 *) die "EAPI=${EAPI} is not supported" ;;
24     esac
25    
26 mgorny 1.8 inherit multibuild multilib
27 mgorny 1.1
28     # @ECLASS-VARIABLE: _MULTILIB_FLAGS
29     # @INTERNAL
30     # @DESCRIPTION:
31 mgorny 1.21 # The list of multilib flags and corresponding ABI values. If the same
32     # flag is reused for multiple ABIs (e.g. x86 on Linux&FreeBSD), multiple
33     # ABIs may be separated by commas.
34 mgorny 1.1 _MULTILIB_FLAGS=(
35 mgorny 1.21 abi_x86_32:x86,x86_fbsd
36     abi_x86_64:amd64,amd64_fbsd
37 mgorny 1.6 abi_x86_x32:x32
38 mattst88 1.17 abi_mips_n32:n32
39     abi_mips_n64:n64
40     abi_mips_o32:o32
41 mgorny 1.1 )
42    
43     # @ECLASS-VARIABLE: MULTILIB_USEDEP
44     # @DESCRIPTION:
45     # The USE-dependency to be used on dependencies (libraries) needing
46     # to support multilib as well.
47     #
48     # Example use:
49     # @CODE
50     # RDEPEND="dev-libs/libfoo[${MULTILIB_USEDEP}]
51     # net-libs/libbar[ssl,${MULTILIB_USEDEP}]"
52     # @CODE
53    
54     _multilib_build_set_globals() {
55     local flags=( "${_MULTILIB_FLAGS[@]%:*}" )
56     local usedeps=${flags[@]/%/(-)?}
57    
58     IUSE=${flags[*]}
59     MULTILIB_USEDEP=${usedeps// /,}
60     }
61     _multilib_build_set_globals
62    
63     # @FUNCTION: multilib_get_enabled_abis
64     # @DESCRIPTION:
65     # Return the ordered list of enabled ABIs if multilib builds
66     # are enabled. The best (most preferred) ABI will come last.
67     #
68     # If multilib is disabled, the default ABI will be returned
69     # in order to enforce consistent testing with multilib code.
70     multilib_get_enabled_abis() {
71     debug-print-function ${FUNCNAME} "${@}"
72    
73     local abis=( $(get_all_abis) )
74    
75     local abi i found
76     for abi in "${abis[@]}"; do
77     for i in "${_MULTILIB_FLAGS[@]}"; do
78 mgorny 1.21 local m_abis=${i#*:} m_abi
79 mgorny 1.1 local m_flag=${i%:*}
80    
81 mgorny 1.22 # split on ,; we can't switch IFS for function scope because
82     # paludis is broken (bug #486592), and switching it locally
83 mgorny 1.23 # for the split is more complex than cheating like this
84     for m_abi in ${m_abis//,/ }; do
85 mgorny 1.21 if [[ ${m_abi} == ${abi} ]] && use "${m_flag}"; then
86     echo "${abi}"
87     found=1
88     break 2
89     fi
90     done
91 mgorny 1.1 done
92     done
93    
94     if [[ ! ${found} ]]; then
95 mgorny 1.7 # ${ABI} can be used to override the fallback (multilib-portage),
96     # ${DEFAULT_ABI} is the safe fallback.
97     local abi=${ABI:-${DEFAULT_ABI}}
98    
99     debug-print "${FUNCNAME}: no ABIs enabled, fallback to ${abi}"
100     debug-print "${FUNCNAME}: ABI=${ABI}, DEFAULT_ABI=${DEFAULT_ABI}"
101     echo ${abi}
102 mgorny 1.1 fi
103     }
104    
105 mgorny 1.8 # @FUNCTION: _multilib_multibuild_wrapper
106     # @USAGE: <argv>...
107     # @INTERNAL
108     # @DESCRIPTION:
109     # Initialize the environment for ABI selected for multibuild.
110     _multilib_multibuild_wrapper() {
111     debug-print-function ${FUNCNAME} "${@}"
112    
113     local ABI=${MULTIBUILD_VARIANT}
114     multilib_toolchain_setup "${ABI}"
115     "${@}"
116     }
117    
118 mgorny 1.1 # @FUNCTION: multilib_foreach_abi
119     # @USAGE: <argv>...
120     # @DESCRIPTION:
121     # If multilib support is enabled, sets the toolchain up for each
122     # supported ABI along with the ABI variable and correct BUILD_DIR,
123     # and runs the given commands with them.
124     #
125     # If multilib support is disabled, it just runs the commands. No setup
126     # is done.
127     multilib_foreach_abi() {
128 mgorny 1.8 debug-print-function ${FUNCNAME} "${@}"
129 mgorny 1.1
130 mgorny 1.8 local MULTIBUILD_VARIANTS=( $(multilib_get_enabled_abis) )
131     multibuild_foreach_variant _multilib_multibuild_wrapper "${@}"
132 mgorny 1.1 }
133    
134     # @FUNCTION: multilib_parallel_foreach_abi
135     # @USAGE: <argv>...
136     # @DESCRIPTION:
137     # If multilib support is enabled, sets the toolchain up for each
138     # supported ABI along with the ABI variable and correct BUILD_DIR,
139     # and runs the given commands with them. The commands are run
140     # in parallel with number of jobs being determined from MAKEOPTS.
141     #
142     # If multilib support is disabled, it just runs the commands. No setup
143     # is done.
144     #
145     # Useful for running configure scripts.
146     multilib_parallel_foreach_abi() {
147 mgorny 1.8 debug-print-function ${FUNCNAME} "${@}"
148 mgorny 1.1
149 mgorny 1.8 local MULTIBUILD_VARIANTS=( $(multilib_get_enabled_abis) )
150     multibuild_parallel_foreach_variant _multilib_multibuild_wrapper "${@}"
151 mgorny 1.1 }
152    
153 mgorny 1.9 # @FUNCTION: multilib_for_best_abi
154     # @USAGE: <argv>...
155     # @DESCRIPTION:
156     # Runs the given command with setup for the 'best' (usually native) ABI.
157     multilib_for_best_abi() {
158     debug-print-function ${FUNCNAME} "${@}"
159    
160     local MULTIBUILD_VARIANTS=( $(multilib_get_enabled_abis) )
161    
162     multibuild_for_best_variant _multilib_multibuild_wrapper "${@}"
163     }
164    
165 mgorny 1.2 # @FUNCTION: multilib_check_headers
166     # @DESCRIPTION:
167     # Check whether the header files are consistent between ABIs.
168     #
169     # This function needs to be called after each ABI's installation phase.
170     # It obtains the header file checksums and compares them with previous
171     # runs (if any). Dies if header files differ.
172     multilib_check_headers() {
173     _multilib_header_cksum() {
174 mgorny 1.4 [[ -d ${ED}usr/include ]] && \
175 mgorny 1.2 find "${ED}"usr/include -type f \
176     -exec cksum {} + | sort -k2
177     }
178    
179     local cksum=$(_multilib_header_cksum)
180     local cksum_file=${T}/.multilib_header_cksum
181    
182     if [[ -f ${cksum_file} ]]; then
183     local cksum_prev=$(< "${cksum_file}")
184    
185     if [[ ${cksum} != ${cksum_prev} ]]; then
186     echo "${cksum}" > "${cksum_file}.new"
187    
188     eerror "Header files have changed between ABIs."
189    
190     if type -p diff &>/dev/null; then
191     eerror "$(diff -du "${cksum_file}" "${cksum_file}.new")"
192     else
193     eerror "Old checksums in: ${cksum_file}"
194     eerror "New checksums in: ${cksum_file}.new"
195     fi
196    
197     die "Header checksum mismatch, aborting."
198     fi
199     else
200     echo "${cksum}" > "${cksum_file}"
201     fi
202     }
203    
204 mgorny 1.10 # @FUNCTION: multilib_copy_sources
205     # @DESCRIPTION:
206     # Create a single copy of the package sources for each enabled ABI.
207     #
208     # The sources are always copied from initial BUILD_DIR (or S if unset)
209     # to ABI-specific build directory matching BUILD_DIR used by
210     # multilib_foreach_abi().
211     multilib_copy_sources() {
212     debug-print-function ${FUNCNAME} "${@}"
213    
214     local MULTIBUILD_VARIANTS=( $(multilib_get_enabled_abis) )
215     multibuild_copy_sources
216     }
217    
218 mgorny 1.11 # @ECLASS-VARIABLE: MULTILIB_WRAPPED_HEADERS
219     # @DESCRIPTION:
220     # A list of headers to wrap for multilib support. The listed headers
221     # will be moved to a non-standard location and replaced with a file
222     # including them conditionally to current ABI.
223     #
224     # This variable has to be a bash array. Paths shall be relative to
225     # installation root (${ED}), and name regular files. Recursive wrapping
226     # is not supported.
227     #
228     # Please note that header wrapping is *discouraged*. It is preferred to
229     # install all headers in a subdirectory of libdir and use pkg-config to
230     # locate the headers. Some C preprocessors will not work with wrapped
231     # headers.
232     #
233     # Example:
234     # @CODE
235     # MULTILIB_WRAPPED_HEADERS=(
236     # /usr/include/foobar/config.h
237     # )
238     # @CODE
239    
240     # @FUNCTION: multilib_prepare_wrappers
241     # @USAGE: [<install-root>]
242     # @DESCRIPTION:
243     # Perform the preparation of all kinds of wrappers for the current ABI.
244     # This function shall be called once per each ABI, after installing
245     # the files to be wrapped.
246     #
247     # Takes an optional custom <install-root> from which files will be
248     # used. If no root is specified, uses ${ED}.
249     #
250     # The files to be wrapped are specified using separate variables,
251     # e.g. MULTILIB_WRAPPED_HEADERS. Those variables shall not be changed
252     # between the successive calls to multilib_prepare_wrappers
253     # and multilib_install_wrappers.
254     #
255     # After all wrappers are prepared, multilib_install_wrappers shall
256     # be called to commit them to the installation tree.
257     multilib_prepare_wrappers() {
258     debug-print-function ${FUNCNAME} "${@}"
259    
260     [[ ${#} -le 1 ]] || die "${FUNCNAME}: too many arguments"
261    
262     local root=${1:-${ED}}
263     local f
264    
265     for f in "${MULTILIB_WRAPPED_HEADERS[@]}"; do
266     # drop leading slash if it's there
267     f=${f#/}
268    
269     if [[ ${f} != usr/include/* ]]; then
270     die "Wrapping headers outside of /usr/include is not supported at the moment."
271     fi
272     # and then usr/include
273     f=${f#usr/include}
274    
275     local dir=${f%/*}
276    
277     if [[ ! -f ${ED}/tmp/multilib-include${f} ]]; then
278     dodir "/tmp/multilib-include${dir}"
279     # a generic template
280 mgorny 1.13 cat > "${ED}/tmp/multilib-include${f}" <<_EOF_
281 mgorny 1.11 /* This file is auto-generated by multilib-build.eclass
282     * as a multilib-friendly wrapper. For the original content,
283     * please see the files that are #included below.
284     */
285    
286     #if defined(__x86_64__) /* amd64 */
287     # if defined(__ILP32__) /* x32 ABI */
288     # error "abi_x86_x32 not supported by the package."
289     # else /* 64-bit ABI */
290     # error "abi_x86_64 not supported by the package."
291     # endif
292     #elif defined(__i386__) /* plain x86 */
293     # error "abi_x86_32 not supported by the package."
294 mattst88 1.17 #elif defined(__mips__)
295     # if(_MIPS_SIM == _ABIN32) /* n32 */
296     # error "abi_mips_n32 not supported by the package."
297     # elif(_MIPS_SIM == _ABI64) /* n64 */
298     # error "abi_mips_n64 not supported by the package."
299     # elif(_MIPS_SIM == _ABIO32) /* o32 */
300     # error "abi_mips_o32 not supported by the package."
301     # endif
302 mgorny 1.11 #else
303     # error "No ABI matched, please report a bug to bugs.gentoo.org"
304     #endif
305     _EOF_
306     fi
307    
308 mgorny 1.18 # Some ABIs may have install less files than others.
309     if [[ -f ${root}/usr/include${f} ]]; then
310     # $CHOST shall be set by multilib_toolchain_setup
311     dodir "/tmp/multilib-include/${CHOST}${dir}"
312     mv "${root}/usr/include${f}" "${ED}/tmp/multilib-include/${CHOST}${dir}/" || die
313    
314     # XXX: get abi_* directly
315     local abi_flag
316     case "${ABI}" in
317     amd64|amd64_fbsd)
318     abi_flag=abi_x86_64;;
319     x86|x86_fbsd)
320     abi_flag=abi_x86_32;;
321     x32)
322     abi_flag=abi_x86_x32;;
323     n32)
324     abi_flag=abi_mips_n32;;
325     n64)
326     abi_flag=abi_mips_n64;;
327     o32)
328     abi_flag=abi_mips_o32;;
329     *)
330     die "Header wrapping for ${ABI} not supported yet";;
331     esac
332    
333     # Note: match a space afterwards to avoid collision potential.
334     sed -e "/${abi_flag} /s&error.*&include <${CHOST}${f}>&" \
335     -i "${ED}/tmp/multilib-include${f}" || die
336     fi
337 mgorny 1.11 done
338     }
339    
340     # @FUNCTION: multilib_install_wrappers
341     # @USAGE: [<install-root>]
342     # @DESCRIPTION:
343     # Install the previously-prepared wrappers. This function shall
344     # be called once, after all wrappers were prepared.
345     #
346     # Takes an optional custom <install-root> to which the wrappers will be
347     # installed. If no root is specified, uses ${ED}. There is no need to
348     # use the same root as when preparing the wrappers.
349     #
350     # The files to be wrapped are specified using separate variables,
351     # e.g. MULTILIB_WRAPPED_HEADERS. Those variables shall not be changed
352     # between the calls to multilib_prepare_wrappers
353     # and multilib_install_wrappers.
354     multilib_install_wrappers() {
355     debug-print-function ${FUNCNAME} "${@}"
356    
357     [[ ${#} -le 1 ]] || die "${FUNCNAME}: too many arguments"
358    
359     local root=${1:-${ED}}
360    
361     if [[ -d "${ED}"/tmp/multilib-include ]]; then
362     multibuild_merge_root \
363     "${ED}"/tmp/multilib-include "${root}"/usr/include
364     # it can fail if something else uses /tmp
365     rmdir "${ED}"/tmp &>/dev/null
366     fi
367     }
368    
369 mgorny 1.15 # @FUNCTION: multilib_is_native_abi
370     # @DESCRIPTION:
371     # Determine whether the currently built ABI is the profile native.
372     # Return true status (0) if that is true, otherwise false (1).
373     #
374 mgorny 1.25 # This function is not intended to be used directly. Please use
375     # multilib_build_binaries instead.
376 mgorny 1.15 multilib_is_native_abi() {
377     debug-print-function ${FUNCNAME} "${@}"
378    
379     [[ ${#} -eq 0 ]] || die "${FUNCNAME}: too many arguments"
380    
381     [[ ${ABI} == ${DEFAULT_ABI} ]]
382     }
383    
384 tommy 1.20 # @FUNCTION: multilib_build_binaries
385     # @DESCRIPTION:
386 mgorny 1.25 # Determine whether to build binaries for the currently build ABI.
387     # Returns true status (0) if the currently built ABI is the profile
388     # native or COMPLETE_MULTILIB variable is set to 'yes', otherwise
389 tommy 1.20 # false (1).
390     #
391 mgorny 1.25 # This is often useful for configure calls when some of the options are
392     # supposed to be disabled for multilib ABIs (like those used for
393     # executables only).
394 tommy 1.19 multilib_build_binaries() {
395     debug-print-function ${FUNCNAME} "${@}"
396    
397     [[ ${#} -eq 0 ]] || die "${FUNCNAME}: too many arguments"
398    
399     [[ ${COMPLETE_MULTILIB} == yes ]] || multilib_is_native_abi
400     }
401 tommy 1.20
402 mgorny 1.1 _MULTILIB_BUILD=1
403     fi

  ViewVC Help
Powered by ViewVC 1.1.20