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

Diff of /eclass/multilib-build.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.6 Revision 1.47
1# Copyright 1999-2013 Gentoo Foundation 1# Copyright 1999-2014 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/multilib-build.eclass,v 1.6 2013/02/27 23:23:11 mgorny Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/multilib-build.eclass,v 1.47 2014/05/07 17:33:49 mgorny Exp $
4 4
5# @ECLASS: multilib-build.eclass 5# @ECLASS: multilib-build.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# gx86-multilib team <multilib@gentoo.org>
8# @AUTHOR:
7# Michał Górny <mgorny@gentoo.org> 9# Author: Michał Górny <mgorny@gentoo.org>
8# @BLURB: flags and utility functions for building multilib packages 10# @BLURB: flags and utility functions for building multilib packages
9# @DESCRIPTION: 11# @DESCRIPTION:
10# The multilib-build.eclass exports USE flags and utility functions 12# The multilib-build.eclass exports USE flags and utility functions
11# necessary to build packages for multilib in a clean and uniform 13# necessary to build packages for multilib in a clean and uniform
12# manner. 14# manner.
15# dependencies shall use the USE dependency string in ${MULTILIB_USEDEP} 17# dependencies shall use the USE dependency string in ${MULTILIB_USEDEP}
16# to properly request multilib enabled. 18# to properly request multilib enabled.
17 19
18if [[ ! ${_MULTILIB_BUILD} ]]; then 20if [[ ! ${_MULTILIB_BUILD} ]]; then
19 21
20# EAPI=5 is required for meaningful MULTILIB_USEDEP. 22# EAPI=4 is required for meaningful MULTILIB_USEDEP.
21case ${EAPI:-0} in 23case ${EAPI:-0} in
22 5) ;; 24 4|5) ;;
23 *) die "EAPI=${EAPI} is not supported" ;; 25 *) die "EAPI=${EAPI} is not supported" ;;
24esac 26esac
25 27
26inherit multilib multiprocessing 28inherit multibuild multilib
27 29
28# @ECLASS-VARIABLE: _MULTILIB_FLAGS 30# @ECLASS-VARIABLE: _MULTILIB_FLAGS
29# @INTERNAL 31# @INTERNAL
30# @DESCRIPTION: 32# @DESCRIPTION:
31# The list of multilib flags and corresponding ABI values. 33# The list of multilib flags and corresponding ABI values. If the same
34# flag is reused for multiple ABIs (e.g. x86 on Linux&FreeBSD), multiple
35# ABIs may be separated by commas.
36#
37# Please contact multilib before modifying this list. This way we can
38# ensure that every *preliminary* work is done and the multilib can be
39# extended safely.
32_MULTILIB_FLAGS=( 40_MULTILIB_FLAGS=(
33 abi_x86_32:x86 41 abi_x86_32:x86,x86_fbsd
34 abi_x86_64:amd64 42 abi_x86_64:amd64,amd64_fbsd
35 abi_x86_x32:x32 43 abi_x86_x32:x32
44 abi_mips_n32:n32
45 abi_mips_n64:n64
46 abi_mips_o32:o32
36) 47)
48
49# @ECLASS-VARIABLE: MULTILIB_COMPAT
50# @DEFAULT_UNSET
51# @DESCRIPTION:
52# List of multilib ABIs supported by the ebuild. If unset, defaults to
53# all ABIs supported by the eclass.
54#
55# This variable is intended for use in prebuilt multilib packages that
56# can provide binaries only for a limited set of ABIs. If ABIs need to
57# be limited due to a bug in source code, package.use.mask is
58# recommended instead.
59#
60# Example use:
61# @CODE
62# # Upstream provides binaries for x86 & amd64 only
63# MULTILIB_COMPAT=( abi_x86_{32,64} )
64# @CODE
37 65
38# @ECLASS-VARIABLE: MULTILIB_USEDEP 66# @ECLASS-VARIABLE: MULTILIB_USEDEP
39# @DESCRIPTION: 67# @DESCRIPTION:
40# The USE-dependency to be used on dependencies (libraries) needing 68# The USE-dependency to be used on dependencies (libraries) needing
41# to support multilib as well. 69# to support multilib as well.
46# net-libs/libbar[ssl,${MULTILIB_USEDEP}]" 74# net-libs/libbar[ssl,${MULTILIB_USEDEP}]"
47# @CODE 75# @CODE
48 76
49_multilib_build_set_globals() { 77_multilib_build_set_globals() {
50 local flags=( "${_MULTILIB_FLAGS[@]%:*}" ) 78 local flags=( "${_MULTILIB_FLAGS[@]%:*}" )
79
80 if [[ ${MULTILIB_COMPAT[@]} ]]; then
81 # Validate MULTILIB_COMPAT and filter out the flags.
82 local f
83 for f in "${MULTILIB_COMPAT[@]}"; do
84 if ! has "${f}" "${flags[@]}"; then
85 die "Invalid value in MULTILIB_COMPAT: ${f}"
86 fi
87 done
88
89 flags=( "${MULTILIB_COMPAT[@]}" )
90 fi
91
51 local usedeps=${flags[@]/%/(-)?} 92 local usedeps=${flags[@]/%/(-)?}
52 93
53 IUSE=${flags[*]} 94 IUSE=${flags[*]}
54 MULTILIB_USEDEP=${usedeps// /,} 95 MULTILIB_USEDEP=${usedeps// /,}
55} 96}
68 local abis=( $(get_all_abis) ) 109 local abis=( $(get_all_abis) )
69 110
70 local abi i found 111 local abi i found
71 for abi in "${abis[@]}"; do 112 for abi in "${abis[@]}"; do
72 for i in "${_MULTILIB_FLAGS[@]}"; do 113 for i in "${_MULTILIB_FLAGS[@]}"; do
73 local m_abi=${i#*:} 114 local m_abis=${i#*:} m_abi
74 local m_flag=${i%:*} 115 local m_flag=${i%:*}
75 116
117 # split on ,; we can't switch IFS for function scope because
118 # paludis is broken (bug #486592), and switching it locally
119 # for the split is more complex than cheating like this
120 for m_abi in ${m_abis//,/ }; do
76 if [[ ${m_abi} == ${abi} ]] && use "${m_flag}"; then 121 if [[ ${m_abi} == ${abi} ]] && use "${m_flag}"; then
77 echo "${abi}" 122 echo "${abi}"
78 found=1 123 found=1
124 break 2
79 fi 125 fi
126 done
80 done 127 done
81 done 128 done
82 129
83 if [[ ! ${found} ]]; then 130 if [[ ! ${found} ]]; then
131 # ${ABI} can be used to override the fallback (multilib-portage),
132 # ${DEFAULT_ABI} is the safe fallback.
133 local abi=${ABI:-${DEFAULT_ABI}}
134
84 debug-print "${FUNCNAME}: no ABIs enabled, fallback to ${DEFAULT_ABI}" 135 debug-print "${FUNCNAME}: no ABIs enabled, fallback to ${abi}"
85 echo ${DEFAULT_ABI} 136 debug-print "${FUNCNAME}: ABI=${ABI}, DEFAULT_ABI=${DEFAULT_ABI}"
137 echo ${abi}
86 fi 138 fi
139}
140
141# @FUNCTION: _multilib_multibuild_wrapper
142# @USAGE: <argv>...
143# @INTERNAL
144# @DESCRIPTION:
145# Initialize the environment for ABI selected for multibuild.
146_multilib_multibuild_wrapper() {
147 debug-print-function ${FUNCNAME} "${@}"
148
149 local ABI=${MULTIBUILD_VARIANT}
150 multilib_toolchain_setup "${ABI}"
151 "${@}"
87} 152}
88 153
89# @FUNCTION: multilib_foreach_abi 154# @FUNCTION: multilib_foreach_abi
90# @USAGE: <argv>... 155# @USAGE: <argv>...
91# @DESCRIPTION: 156# @DESCRIPTION:
94# and runs the given commands with them. 159# and runs the given commands with them.
95# 160#
96# If multilib support is disabled, it just runs the commands. No setup 161# If multilib support is disabled, it just runs the commands. No setup
97# is done. 162# is done.
98multilib_foreach_abi() { 163multilib_foreach_abi() {
99 local initial_dir=${BUILD_DIR:-${S}} 164 debug-print-function ${FUNCNAME} "${@}"
100 165
101 local ABI 166 local MULTIBUILD_VARIANTS=( $(multilib_get_enabled_abis) )
102 for ABI in $(multilib_get_enabled_abis); do 167 multibuild_foreach_variant _multilib_multibuild_wrapper "${@}"
103 multilib_toolchain_setup "${ABI}"
104 BUILD_DIR=${initial_dir%%/}-${ABI} "${@}"
105 done
106} 168}
107 169
108# @FUNCTION: multilib_parallel_foreach_abi 170# @FUNCTION: multilib_parallel_foreach_abi
109# @USAGE: <argv>... 171# @USAGE: <argv>...
110# @DESCRIPTION: 172# @DESCRIPTION:
116# If multilib support is disabled, it just runs the commands. No setup 178# If multilib support is disabled, it just runs the commands. No setup
117# is done. 179# is done.
118# 180#
119# Useful for running configure scripts. 181# Useful for running configure scripts.
120multilib_parallel_foreach_abi() { 182multilib_parallel_foreach_abi() {
121 local initial_dir=${BUILD_DIR:-${S}} 183 debug-print-function ${FUNCNAME} "${@}"
122 184
123 multijob_init 185 local MULTIBUILD_VARIANTS=( $(multilib_get_enabled_abis) )
186 multibuild_parallel_foreach_variant _multilib_multibuild_wrapper "${@}"
187}
124 188
125 local ABI 189# @FUNCTION: multilib_for_best_abi
126 for ABI in $(multilib_get_enabled_abis); do 190# @USAGE: <argv>...
127 ( 191# @DESCRIPTION:
128 multijob_child_init 192# Runs the given command with setup for the 'best' (usually native) ABI.
193multilib_for_best_abi() {
194 debug-print-function ${FUNCNAME} "${@}"
129 195
130 multilib_toolchain_setup "${ABI}" 196 local MULTIBUILD_VARIANTS=( $(multilib_get_enabled_abis) )
131 BUILD_DIR=${initial_dir%%/}-${ABI}
132 "${@}"
133 ) &
134 197
135 multijob_post_fork 198 multibuild_for_best_variant _multilib_multibuild_wrapper "${@}"
136 done
137
138 multijob_finish
139} 199}
140 200
141# @FUNCTION: multilib_check_headers 201# @FUNCTION: multilib_check_headers
142# @DESCRIPTION: 202# @DESCRIPTION:
143# Check whether the header files are consistent between ABIs. 203# Check whether the header files are consistent between ABIs.
175 else 235 else
176 echo "${cksum}" > "${cksum_file}" 236 echo "${cksum}" > "${cksum_file}"
177 fi 237 fi
178} 238}
179 239
240# @FUNCTION: multilib_copy_sources
241# @DESCRIPTION:
242# Create a single copy of the package sources for each enabled ABI.
243#
244# The sources are always copied from initial BUILD_DIR (or S if unset)
245# to ABI-specific build directory matching BUILD_DIR used by
246# multilib_foreach_abi().
247multilib_copy_sources() {
248 debug-print-function ${FUNCNAME} "${@}"
249
250 local MULTIBUILD_VARIANTS=( $(multilib_get_enabled_abis) )
251 multibuild_copy_sources
252}
253
254# @ECLASS-VARIABLE: MULTILIB_WRAPPED_HEADERS
255# @DESCRIPTION:
256# A list of headers to wrap for multilib support. The listed headers
257# will be moved to a non-standard location and replaced with a file
258# including them conditionally to current ABI.
259#
260# This variable has to be a bash array. Paths shall be relative to
261# installation root (${ED}), and name regular files. Recursive wrapping
262# is not supported.
263#
264# Please note that header wrapping is *discouraged*. It is preferred to
265# install all headers in a subdirectory of libdir and use pkg-config to
266# locate the headers. Some C preprocessors will not work with wrapped
267# headers.
268#
269# Example:
270# @CODE
271# MULTILIB_WRAPPED_HEADERS=(
272# /usr/include/foobar/config.h
273# )
274# @CODE
275
276# @ECLASS-VARIABLE: MULTILIB_CHOST_TOOLS
277# @DESCRIPTION:
278# A list of tool executables to preserve for each multilib ABI.
279# The listed executables will be renamed to ${CHOST}-${basename},
280# and the native variant will be symlinked to the generic name.
281#
282# This variable has to be a bash array. Paths shall be relative to
283# installation root (${ED}), and name regular files or symbolic
284# links to regular files. Recursive wrapping is not supported.
285#
286# If symbolic link is passed, both symlink path and symlink target
287# will be changed. As a result, the symlink target is expected
288# to be wrapped as well (either by listing in MULTILIB_CHOST_TOOLS
289# or externally).
290#
291# Please note that tool wrapping is *discouraged*. It is preferred to
292# install pkg-config files for each ABI, and require reverse
293# dependencies to use that.
294#
295# Packages that search for tools properly (e.g. using AC_PATH_TOOL
296# macro) will find the wrapper executables automatically. Other packages
297# will need explicit override of tool paths.
298#
299# Example:
300# @CODE
301# MULTILIB_CHOST_TOOLS=(
302# /usr/bin/foo-config
303# )
304
305# @CODE
306# @FUNCTION: multilib_prepare_wrappers
307# @USAGE: [<install-root>]
308# @DESCRIPTION:
309# Perform the preparation of all kinds of wrappers for the current ABI.
310# This function shall be called once per each ABI, after installing
311# the files to be wrapped.
312#
313# Takes an optional custom <install-root> from which files will be
314# used. If no root is specified, uses ${ED}.
315#
316# The files to be wrapped are specified using separate variables,
317# e.g. MULTILIB_WRAPPED_HEADERS. Those variables shall not be changed
318# between the successive calls to multilib_prepare_wrappers
319# and multilib_install_wrappers.
320#
321# After all wrappers are prepared, multilib_install_wrappers shall
322# be called to commit them to the installation tree.
323multilib_prepare_wrappers() {
324 debug-print-function ${FUNCNAME} "${@}"
325
326 [[ ${#} -le 1 ]] || die "${FUNCNAME}: too many arguments"
327
328 local root=${1:-${ED}}
329 local f
330
331 if [[ ${COMPLETE_MULTILIB} == yes ]]; then
332 # symlink '${CHOST}-foo -> foo' to support abi-wrapper while
333 # keeping ${CHOST}-foo calls correct.
334
335 for f in "${MULTILIB_CHOST_TOOLS[@]}"; do
336 # drop leading slash if it's there
337 f=${f#/}
338
339 local dir=${f%/*}
340 local fn=${f##*/}
341
342 ln -s "${fn}" "${root}/${dir}/${CHOST}-${fn}" || die
343 done
344
345 return
346 fi
347
348 for f in "${MULTILIB_CHOST_TOOLS[@]}"; do
349 # drop leading slash if it's there
350 f=${f#/}
351
352 local dir=${f%/*}
353 local fn=${f##*/}
354
355 if [[ -L ${root}/${f} ]]; then
356 # rewrite the symlink target
357 local target=$(readlink "${root}/${f}")
358 local target_dir
359 local target_fn=${target##*/}
360
361 [[ ${target} == */* ]] && target_dir=${target%/*}
362
363 ln -f -s "${target_dir+${target_dir}/}${CHOST}-${target_fn}" \
364 "${root}/${f}" || die
365 fi
366
367 mv "${root}/${f}" "${root}/${dir}/${CHOST}-${fn}" || die
368
369 # symlink the native one back
370 if multilib_is_native_abi; then
371 ln -s "${CHOST}-${fn}" "${root}/${f}" || die
372 fi
373 done
374
375 if [[ ${MULTILIB_WRAPPED_HEADERS[@]} ]]; then
376 # XXX: get abi_* directly
377 local abi_flag
378 case "${ABI}" in
379 amd64|amd64_fbsd)
380 abi_flag=abi_x86_64;;
381 x86|x86_fbsd)
382 abi_flag=abi_x86_32;;
383 x32)
384 abi_flag=abi_x86_x32;;
385 n32)
386 abi_flag=abi_mips_n32;;
387 n64)
388 abi_flag=abi_mips_n64;;
389 o32)
390 abi_flag=abi_mips_o32;;
391 esac
392
393 # If abi_flag is unset, then header wrapping is unsupported
394 # on this ABI. This could mean either that:
395 #
396 # 1) the arch doesn't support multilib at all -- in this case,
397 # the headers are not wrapped and everything works as expected,
398 #
399 # 2) someone added new ABI and forgot to update the function --
400 # in this case, the header consistency check will notice one of
401 # those ABIs has an extra header (compared to the header moved
402 # for wrapping) and will fail.
403
404 if [[ ${abi_flag} ]]; then
405 for f in "${MULTILIB_WRAPPED_HEADERS[@]}"; do
406 # drop leading slash if it's there
407 f=${f#/}
408
409 if [[ ${f} != usr/include/* ]]; then
410 die "Wrapping headers outside of /usr/include is not supported at the moment."
411 fi
412 # and then usr/include
413 f=${f#usr/include}
414
415 local dir=${f%/*}
416
417 if [[ ! -f ${ED}/tmp/multilib-include${f} ]]; then
418 dodir "/tmp/multilib-include${dir}"
419 # a generic template
420 cat > "${ED}/tmp/multilib-include${f}" <<_EOF_
421/* This file is auto-generated by multilib-build.eclass
422 * as a multilib-friendly wrapper. For the original content,
423 * please see the files that are #included below.
424 */
425
426#if defined(__x86_64__) /* amd64 */
427# if defined(__ILP32__) /* x32 ABI */
428# error "abi_x86_x32 not supported by the package."
429# else /* 64-bit ABI */
430# error "abi_x86_64 not supported by the package."
431# endif
432#elif defined(__i386__) /* plain x86 */
433# error "abi_x86_32 not supported by the package."
434#elif defined(__mips__)
435# if(_MIPS_SIM == _ABIN32) /* n32 */
436# error "abi_mips_n32 not supported by the package."
437# elif(_MIPS_SIM == _ABI64) /* n64 */
438# error "abi_mips_n64 not supported by the package."
439# elif(_MIPS_SIM == _ABIO32) /* o32 */
440# error "abi_mips_o32 not supported by the package."
441# endif
442#else
443# error "No ABI matched, please report a bug to bugs.gentoo.org"
444#endif
445_EOF_
446 fi
447
448 # Some ABIs may have install less files than others.
449 if [[ -f ${root}/usr/include${f} ]]; then
450 # $CHOST shall be set by multilib_toolchain_setup
451 dodir "/tmp/multilib-include/${CHOST}${dir}"
452 mv "${root}/usr/include${f}" "${ED}/tmp/multilib-include/${CHOST}${dir}/" || die
453
454 # Note: match a space afterwards to avoid collision potential.
455 sed -e "/${abi_flag} /s&error.*&include <${CHOST}${f}>&" \
456 -i "${ED}/tmp/multilib-include${f}" || die
457
458 # Hack for emul-linux-x86 compatibility.
459 # It assumes amd64 will come after x86, and will use amd64
460 # headers if no specific x86 headers were installed.
461 if [[ ${ABI} == amd64 ]]; then
462 sed -e "/abi_x86_32 /s&error.*&include <${CHOST}${f}>&" \
463 -i "${ED}/tmp/multilib-include${f}" || die
464 fi
465 fi
466 done
467 fi
468 fi
469}
470
471# @FUNCTION: multilib_install_wrappers
472# @USAGE: [<install-root>]
473# @DESCRIPTION:
474# Install the previously-prepared wrappers. This function shall
475# be called once, after all wrappers were prepared.
476#
477# Takes an optional custom <install-root> to which the wrappers will be
478# installed. If no root is specified, uses ${ED}. There is no need to
479# use the same root as when preparing the wrappers.
480#
481# The files to be wrapped are specified using separate variables,
482# e.g. MULTILIB_WRAPPED_HEADERS. Those variables shall not be changed
483# between the calls to multilib_prepare_wrappers
484# and multilib_install_wrappers.
485multilib_install_wrappers() {
486 debug-print-function ${FUNCNAME} "${@}"
487
488 [[ ${#} -le 1 ]] || die "${FUNCNAME}: too many arguments"
489
490 [[ ${COMPLETE_MULTILIB} == yes ]] && return
491
492 local root=${1:-${ED}}
493
494 if [[ -d "${ED}"/tmp/multilib-include ]]; then
495 multibuild_merge_root \
496 "${ED}"/tmp/multilib-include "${root}"/usr/include
497 # it can fail if something else uses /tmp
498 rmdir "${ED}"/tmp &>/dev/null
499 fi
500}
501
502# @FUNCTION: multilib_is_native_abi
503# @DESCRIPTION:
504# Determine whether the currently built ABI is the profile native.
505# Return true status (0) if that is true, otherwise false (1).
506#
507# This function is not intended to be used directly. Please use
508# multilib_build_binaries instead.
509multilib_is_native_abi() {
510 debug-print-function ${FUNCNAME} "${@}"
511
512 [[ ${#} -eq 0 ]] || die "${FUNCNAME}: too many arguments"
513
514 [[ ${COMPLETE_MULTILIB} == yes || ${ABI} == ${DEFAULT_ABI} ]]
515}
516
517# @FUNCTION: multilib_build_binaries
518# @DESCRIPTION:
519# Determine whether to build binaries for the currently built ABI.
520# Returns true status (0) if the currently built ABI is the profile
521# native or COMPLETE_MULTILIB variable is set to 'yes', otherwise
522# false (1).
523#
524# This is often useful for configure calls when some of the options are
525# supposed to be disabled for multilib ABIs (like those used for
526# executables only).
527multilib_build_binaries() {
528 debug-print-function ${FUNCNAME} "${@}"
529
530 eqawarn "QA warning: multilib_build_binaries is deprecated. Please use the equivalent"
531 eqawarn "multilib_is_native_abi function instead."
532
533 multilib_is_native_abi "${@}"
534}
535
536# @FUNCTION: multilib_native_use_with
537# @USAGE: <flag> [<opt-name> [<opt-value>]]
538# @DESCRIPTION:
539# Output --with configure option alike use_with if USE <flag> is enabled
540# and executables are being built (multilib_is_native_abi is true).
541# Otherwise, outputs --without configure option. Arguments are the same
542# as for use_with in the EAPI.
543multilib_native_use_with() {
544 if multilib_is_native_abi; then
545 use_with "${@}"
546 else
547 echo "--without-${2:-${1}}"
548 fi
549}
550
551# @FUNCTION: multilib_native_use_enable
552# @USAGE: <flag> [<opt-name> [<opt-value>]]
553# @DESCRIPTION:
554# Output --enable configure option alike use_with if USE <flag>
555# is enabled and executables are being built (multilib_is_native_abi
556# is true). Otherwise, outputs --disable configure option. Arguments are
557# the same as for use_enable in the EAPI.
558multilib_native_use_enable() {
559 if multilib_is_native_abi; then
560 use_enable "${@}"
561 else
562 echo "--disable-${2:-${1}}"
563 fi
564}
565
566# @FUNCTION: multilib_native_usex
567# @USAGE: <flag> [<true1> [<false1> [<true2> [<false2>]]]]
568# @DESCRIPTION:
569# Output the concatenation of <true1> (or 'yes' if unspecified)
570# and <true2> if USE <flag> is enabled and executables are being built
571# (multilib_is_native_abi is true). Otherwise, output the concatenation
572# of <false1> (or 'no' if unspecified) and <false2>. Arguments
573# are the same as for usex in the EAPI.
574#
575# Note: in EAPI 4 you need to inherit eutils to use this function.
576multilib_native_usex() {
577 if multilib_is_native_abi; then
578 usex "${@}"
579 else
580 echo "${3-no}${5}"
581 fi
582}
583
180_MULTILIB_BUILD=1 584_MULTILIB_BUILD=1
181fi 585fi

Legend:
Removed from v.1.6  
changed lines
  Added in v.1.47

  ViewVC Help
Powered by ViewVC 1.1.20