/[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.40
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.40 2014/04/28 17:38:21 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)
37 48
38# @ECLASS-VARIABLE: MULTILIB_USEDEP 49# @ECLASS-VARIABLE: MULTILIB_USEDEP
39# @DESCRIPTION: 50# @DESCRIPTION:
40# The USE-dependency to be used on dependencies (libraries) needing 51# The USE-dependency to be used on dependencies (libraries) needing
68 local abis=( $(get_all_abis) ) 79 local abis=( $(get_all_abis) )
69 80
70 local abi i found 81 local abi i found
71 for abi in "${abis[@]}"; do 82 for abi in "${abis[@]}"; do
72 for i in "${_MULTILIB_FLAGS[@]}"; do 83 for i in "${_MULTILIB_FLAGS[@]}"; do
73 local m_abi=${i#*:} 84 local m_abis=${i#*:} m_abi
74 local m_flag=${i%:*} 85 local m_flag=${i%:*}
75 86
87 # split on ,; we can't switch IFS for function scope because
88 # paludis is broken (bug #486592), and switching it locally
89 # for the split is more complex than cheating like this
90 for m_abi in ${m_abis//,/ }; do
76 if [[ ${m_abi} == ${abi} ]] && use "${m_flag}"; then 91 if [[ ${m_abi} == ${abi} ]] && use "${m_flag}"; then
77 echo "${abi}" 92 echo "${abi}"
78 found=1 93 found=1
94 break 2
79 fi 95 fi
96 done
80 done 97 done
81 done 98 done
82 99
83 if [[ ! ${found} ]]; then 100 if [[ ! ${found} ]]; then
101 # ${ABI} can be used to override the fallback (multilib-portage),
102 # ${DEFAULT_ABI} is the safe fallback.
103 local abi=${ABI:-${DEFAULT_ABI}}
104
84 debug-print "${FUNCNAME}: no ABIs enabled, fallback to ${DEFAULT_ABI}" 105 debug-print "${FUNCNAME}: no ABIs enabled, fallback to ${abi}"
85 echo ${DEFAULT_ABI} 106 debug-print "${FUNCNAME}: ABI=${ABI}, DEFAULT_ABI=${DEFAULT_ABI}"
107 echo ${abi}
86 fi 108 fi
109}
110
111# @FUNCTION: _multilib_multibuild_wrapper
112# @USAGE: <argv>...
113# @INTERNAL
114# @DESCRIPTION:
115# Initialize the environment for ABI selected for multibuild.
116_multilib_multibuild_wrapper() {
117 debug-print-function ${FUNCNAME} "${@}"
118
119 local ABI=${MULTIBUILD_VARIANT}
120 multilib_toolchain_setup "${ABI}"
121 "${@}"
87} 122}
88 123
89# @FUNCTION: multilib_foreach_abi 124# @FUNCTION: multilib_foreach_abi
90# @USAGE: <argv>... 125# @USAGE: <argv>...
91# @DESCRIPTION: 126# @DESCRIPTION:
94# and runs the given commands with them. 129# and runs the given commands with them.
95# 130#
96# If multilib support is disabled, it just runs the commands. No setup 131# If multilib support is disabled, it just runs the commands. No setup
97# is done. 132# is done.
98multilib_foreach_abi() { 133multilib_foreach_abi() {
99 local initial_dir=${BUILD_DIR:-${S}} 134 debug-print-function ${FUNCNAME} "${@}"
100 135
101 local ABI 136 local MULTIBUILD_VARIANTS=( $(multilib_get_enabled_abis) )
102 for ABI in $(multilib_get_enabled_abis); do 137 multibuild_foreach_variant _multilib_multibuild_wrapper "${@}"
103 multilib_toolchain_setup "${ABI}"
104 BUILD_DIR=${initial_dir%%/}-${ABI} "${@}"
105 done
106} 138}
107 139
108# @FUNCTION: multilib_parallel_foreach_abi 140# @FUNCTION: multilib_parallel_foreach_abi
109# @USAGE: <argv>... 141# @USAGE: <argv>...
110# @DESCRIPTION: 142# @DESCRIPTION:
116# If multilib support is disabled, it just runs the commands. No setup 148# If multilib support is disabled, it just runs the commands. No setup
117# is done. 149# is done.
118# 150#
119# Useful for running configure scripts. 151# Useful for running configure scripts.
120multilib_parallel_foreach_abi() { 152multilib_parallel_foreach_abi() {
121 local initial_dir=${BUILD_DIR:-${S}} 153 debug-print-function ${FUNCNAME} "${@}"
122 154
123 multijob_init 155 local MULTIBUILD_VARIANTS=( $(multilib_get_enabled_abis) )
156 multibuild_parallel_foreach_variant _multilib_multibuild_wrapper "${@}"
157}
124 158
125 local ABI 159# @FUNCTION: multilib_for_best_abi
126 for ABI in $(multilib_get_enabled_abis); do 160# @USAGE: <argv>...
127 ( 161# @DESCRIPTION:
128 multijob_child_init 162# Runs the given command with setup for the 'best' (usually native) ABI.
163multilib_for_best_abi() {
164 debug-print-function ${FUNCNAME} "${@}"
129 165
130 multilib_toolchain_setup "${ABI}" 166 local MULTIBUILD_VARIANTS=( $(multilib_get_enabled_abis) )
131 BUILD_DIR=${initial_dir%%/}-${ABI}
132 "${@}"
133 ) &
134 167
135 multijob_post_fork 168 multibuild_for_best_variant _multilib_multibuild_wrapper "${@}"
136 done
137
138 multijob_finish
139} 169}
140 170
141# @FUNCTION: multilib_check_headers 171# @FUNCTION: multilib_check_headers
142# @DESCRIPTION: 172# @DESCRIPTION:
143# Check whether the header files are consistent between ABIs. 173# Check whether the header files are consistent between ABIs.
175 else 205 else
176 echo "${cksum}" > "${cksum_file}" 206 echo "${cksum}" > "${cksum_file}"
177 fi 207 fi
178} 208}
179 209
210# @FUNCTION: multilib_copy_sources
211# @DESCRIPTION:
212# Create a single copy of the package sources for each enabled ABI.
213#
214# The sources are always copied from initial BUILD_DIR (or S if unset)
215# to ABI-specific build directory matching BUILD_DIR used by
216# multilib_foreach_abi().
217multilib_copy_sources() {
218 debug-print-function ${FUNCNAME} "${@}"
219
220 local MULTIBUILD_VARIANTS=( $(multilib_get_enabled_abis) )
221 multibuild_copy_sources
222}
223
224# @ECLASS-VARIABLE: MULTILIB_WRAPPED_HEADERS
225# @DESCRIPTION:
226# A list of headers to wrap for multilib support. The listed headers
227# will be moved to a non-standard location and replaced with a file
228# including them conditionally to current ABI.
229#
230# This variable has to be a bash array. Paths shall be relative to
231# installation root (${ED}), and name regular files. Recursive wrapping
232# is not supported.
233#
234# Please note that header wrapping is *discouraged*. It is preferred to
235# install all headers in a subdirectory of libdir and use pkg-config to
236# locate the headers. Some C preprocessors will not work with wrapped
237# headers.
238#
239# Example:
240# @CODE
241# MULTILIB_WRAPPED_HEADERS=(
242# /usr/include/foobar/config.h
243# )
244# @CODE
245
246# @ECLASS-VARIABLE: MULTILIB_CHOST_TOOLS
247# @DESCRIPTION:
248# A list of tool executables to preserve for each multilib ABI.
249# The listed executables will be renamed to ${CHOST}-${basename},
250# and the native variant will be symlinked to the generic name.
251#
252# This variable has to be a bash array. Paths shall be relative to
253# installation root (${ED}), and name regular files or symbolic
254# links to regular files. Recursive wrapping is not supported.
255#
256# If symbolic link is passed, both symlink path and symlink target
257# will be changed. As a result, the symlink target is expected
258# to be wrapped as well (either by listing in MULTILIB_CHOST_TOOLS
259# or externally).
260#
261# Please note that tool wrapping is *discouraged*. It is preferred to
262# install pkg-config files for each ABI, and require reverse
263# dependencies to use that.
264#
265# Packages that search for tools properly (e.g. using AC_PATH_TOOL
266# macro) will find the wrapper executables automatically. Other packages
267# will need explicit override of tool paths.
268#
269# Example:
270# @CODE
271# MULTILIB_CHOST_TOOLS=(
272# /usr/bin/foo-config
273# )
274
275# @CODE
276# @FUNCTION: multilib_prepare_wrappers
277# @USAGE: [<install-root>]
278# @DESCRIPTION:
279# Perform the preparation of all kinds of wrappers for the current ABI.
280# This function shall be called once per each ABI, after installing
281# the files to be wrapped.
282#
283# Takes an optional custom <install-root> from which files will be
284# used. If no root is specified, uses ${ED}.
285#
286# The files to be wrapped are specified using separate variables,
287# e.g. MULTILIB_WRAPPED_HEADERS. Those variables shall not be changed
288# between the successive calls to multilib_prepare_wrappers
289# and multilib_install_wrappers.
290#
291# After all wrappers are prepared, multilib_install_wrappers shall
292# be called to commit them to the installation tree.
293multilib_prepare_wrappers() {
294 debug-print-function ${FUNCNAME} "${@}"
295
296 [[ ${#} -le 1 ]] || die "${FUNCNAME}: too many arguments"
297
298 local root=${1:-${ED}}
299 local f
300
301 for f in "${MULTILIB_WRAPPED_HEADERS[@]}"; do
302 # drop leading slash if it's there
303 f=${f#/}
304
305 if [[ ${f} != usr/include/* ]]; then
306 die "Wrapping headers outside of /usr/include is not supported at the moment."
307 fi
308 # and then usr/include
309 f=${f#usr/include}
310
311 local dir=${f%/*}
312
313 if [[ ! -f ${ED}/tmp/multilib-include${f} ]]; then
314 dodir "/tmp/multilib-include${dir}"
315 # a generic template
316 cat > "${ED}/tmp/multilib-include${f}" <<_EOF_
317/* This file is auto-generated by multilib-build.eclass
318 * as a multilib-friendly wrapper. For the original content,
319 * please see the files that are #included below.
320 */
321
322#if defined(__x86_64__) /* amd64 */
323# if defined(__ILP32__) /* x32 ABI */
324# error "abi_x86_x32 not supported by the package."
325# else /* 64-bit ABI */
326# error "abi_x86_64 not supported by the package."
327# endif
328#elif defined(__i386__) /* plain x86 */
329# error "abi_x86_32 not supported by the package."
330#elif defined(__mips__)
331# if(_MIPS_SIM == _ABIN32) /* n32 */
332# error "abi_mips_n32 not supported by the package."
333# elif(_MIPS_SIM == _ABI64) /* n64 */
334# error "abi_mips_n64 not supported by the package."
335# elif(_MIPS_SIM == _ABIO32) /* o32 */
336# error "abi_mips_o32 not supported by the package."
337# endif
338#else
339# error "No ABI matched, please report a bug to bugs.gentoo.org"
340#endif
341_EOF_
342 fi
343
344 # Some ABIs may have install less files than others.
345 if [[ -f ${root}/usr/include${f} ]]; then
346 # $CHOST shall be set by multilib_toolchain_setup
347 dodir "/tmp/multilib-include/${CHOST}${dir}"
348 mv "${root}/usr/include${f}" "${ED}/tmp/multilib-include/${CHOST}${dir}/" || die
349
350 # XXX: get abi_* directly
351 local abi_flag
352 case "${ABI}" in
353 amd64|amd64_fbsd)
354 abi_flag=abi_x86_64;;
355 x86|x86_fbsd)
356 abi_flag=abi_x86_32;;
357 x32)
358 abi_flag=abi_x86_x32;;
359 n32)
360 abi_flag=abi_mips_n32;;
361 n64)
362 abi_flag=abi_mips_n64;;
363 o32)
364 abi_flag=abi_mips_o32;;
365 *)
366 die "Header wrapping for ${ABI} not supported yet";;
367 esac
368
369 # Note: match a space afterwards to avoid collision potential.
370 sed -e "/${abi_flag} /s&error.*&include <${CHOST}${f}>&" \
371 -i "${ED}/tmp/multilib-include${f}" || die
372 fi
373 done
374
375 for f in "${MULTILIB_CHOST_TOOLS[@]}"; do
376 # drop leading slash if it's there
377 f=${f#/}
378
379 local dir=${f%/*}
380 local fn=${f##*/}
381
382 if [[ -L ${root}/${f} ]]; then
383 # rewrite the symlink target
384 local target=$(readlink "${root}/${f}")
385 local target_dir
386 local target_fn=${target##*/}
387
388 [[ ${target} == */* ]] && target_dir=${target%/*}
389
390 ln -f -s "${target_dir+${target_dir}/}${CHOST}-${target_fn}" \
391 "${root}/${f}" || die
392 fi
393
394 mv "${root}/${f}" "${root}/${dir}/${CHOST}-${fn}" || die
395
396 # symlink the native one back
397 if multilib_is_native_abi; then
398 ln -s "${CHOST}-${fn}" "${root}/${f}" || die
399 fi
400 done
401}
402
403# @FUNCTION: multilib_install_wrappers
404# @USAGE: [<install-root>]
405# @DESCRIPTION:
406# Install the previously-prepared wrappers. This function shall
407# be called once, after all wrappers were prepared.
408#
409# Takes an optional custom <install-root> to which the wrappers will be
410# installed. If no root is specified, uses ${ED}. There is no need to
411# use the same root as when preparing the wrappers.
412#
413# The files to be wrapped are specified using separate variables,
414# e.g. MULTILIB_WRAPPED_HEADERS. Those variables shall not be changed
415# between the calls to multilib_prepare_wrappers
416# and multilib_install_wrappers.
417multilib_install_wrappers() {
418 debug-print-function ${FUNCNAME} "${@}"
419
420 [[ ${#} -le 1 ]] || die "${FUNCNAME}: too many arguments"
421
422 local root=${1:-${ED}}
423
424 if [[ -d "${ED}"/tmp/multilib-include ]]; then
425 multibuild_merge_root \
426 "${ED}"/tmp/multilib-include "${root}"/usr/include
427 # it can fail if something else uses /tmp
428 rmdir "${ED}"/tmp &>/dev/null
429 fi
430}
431
432# @FUNCTION: multilib_is_native_abi
433# @DESCRIPTION:
434# Determine whether the currently built ABI is the profile native.
435# Return true status (0) if that is true, otherwise false (1).
436#
437# This function is not intended to be used directly. Please use
438# multilib_build_binaries instead.
439multilib_is_native_abi() {
440 debug-print-function ${FUNCNAME} "${@}"
441
442 [[ ${#} -eq 0 ]] || die "${FUNCNAME}: too many arguments"
443
444 [[ ${COMPLETE_MULTILIB} == yes || ${ABI} == ${DEFAULT_ABI} ]]
445}
446
447# @FUNCTION: multilib_build_binaries
448# @DESCRIPTION:
449# Determine whether to build binaries for the currently built ABI.
450# Returns true status (0) if the currently built ABI is the profile
451# native or COMPLETE_MULTILIB variable is set to 'yes', otherwise
452# false (1).
453#
454# This is often useful for configure calls when some of the options are
455# supposed to be disabled for multilib ABIs (like those used for
456# executables only).
457multilib_build_binaries() {
458 debug-print-function ${FUNCNAME} "${@}"
459
460 eqawarn "QA warning: multilib_build_binaries is deprecated. Please use the equivalent"
461 eqawarn "multilib_is_native_abi function instead."
462
463 multilib_is_native_abi "${@}"
464}
465
466# @FUNCTION: multilib_native_use_with
467# @USAGE: <flag> [<opt-name> [<opt-value>]]
468# @DESCRIPTION:
469# Output --with configure option alike use_with if USE <flag> is enabled
470# and executables are being built (multilib_is_native_abi is true).
471# Otherwise, outputs --without configure option. Arguments are the same
472# as for use_with in the EAPI.
473multilib_native_use_with() {
474 if multilib_is_native_abi; then
475 use_with "${@}"
476 else
477 echo "--without-${2:-${1}}"
478 fi
479}
480
481# @FUNCTION: multilib_native_use_enable
482# @USAGE: <flag> [<opt-name> [<opt-value>]]
483# @DESCRIPTION:
484# Output --enable configure option alike use_with if USE <flag>
485# is enabled and executables are being built (multilib_is_native_abi
486# is true). Otherwise, outputs --disable configure option. Arguments are
487# the same as for use_enable in the EAPI.
488multilib_native_use_enable() {
489 if multilib_is_native_abi; then
490 use_enable "${@}"
491 else
492 echo "--disable-${2:-${1}}"
493 fi
494}
495
496# @FUNCTION: multilib_native_usex
497# @USAGE: <flag> [<true1> [<false1> [<true2> [<false2>]]]]
498# @DESCRIPTION:
499# Output the concatenation of <true1> (or 'yes' if unspecified)
500# and <true2> if USE <flag> is enabled and executables are being built
501# (multilib_is_native_abi is true). Otherwise, output the concatenation
502# of <false1> (or 'no' if unspecified) and <false2>. Arguments
503# are the same as for usex in the EAPI.
504#
505# Note: in EAPI 4 you need to inherit eutils to use this function.
506multilib_native_usex() {
507 if multilib_is_native_abi; then
508 usex "${@}"
509 else
510 echo "${3-no}${5}"
511 fi
512}
513
180_MULTILIB_BUILD=1 514_MULTILIB_BUILD=1
181fi 515fi

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

  ViewVC Help
Powered by ViewVC 1.1.20