/[gentoo-x86]/eclass/flag-o-matic.eclass
Gentoo

Contents of /eclass/flag-o-matic.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.167 - (show annotations) (download)
Sat Jan 14 09:10:54 2012 UTC (2 years, 3 months ago) by vapier
Branch: MAIN
Changes since 1.166: +51 -87 lines
unify duplicated lists of variable names and duplicated code blocks, and try to clean up code a bit

1 # Copyright 1999-2011 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/flag-o-matic.eclass,v 1.166 2012/01/14 08:22:13 vapier Exp $
4
5 # @ECLASS: flag-o-matic.eclass
6 # @MAINTAINER:
7 # toolchain@gentoo.org
8 # @BLURB: common functions to manipulate and query toolchain flags
9 # @DESCRIPTION:
10 # This eclass contains a suite of functions to help developers sanely
11 # and safely manage toolchain flags in their builds.
12
13 if [[ ${___ECLASS_ONCE_FLAG_O_MATIC} != "recur -_+^+_- spank" ]] ; then
14 ___ECLASS_ONCE_FLAG_O_MATIC="recur -_+^+_- spank"
15
16 inherit eutils toolchain-funcs multilib
17
18 # Return all the flag variables that our high level funcs operate on.
19 all-flag-vars() {
20 echo {C,CPP,CXX,F,FC,LD}FLAGS
21 }
22
23 # {C,CXX,F,FC}FLAGS that we allow in strip-flags
24 # Note: shell globs and character lists are allowed
25 setup-allowed-flags() {
26 ALLOWED_FLAGS="-pipe"
27 ALLOWED_FLAGS+=" -O -O1 -O2 -Os -mcpu -march -mtune"
28 ALLOWED_FLAGS+=" -fstack-protector -fstack-protector-all"
29 ALLOWED_FLAGS+=" -fbounds-checking -fno-strict-overflow"
30 ALLOWED_FLAGS+=" -fno-PIE -fno-pie -fno-unit-at-a-time"
31 ALLOWED_FLAGS+=" -g -g[0-9] -ggdb -ggdb[0-9] -gstabs -gstabs+"
32 ALLOWED_FLAGS+=" -fno-ident -fpermissive"
33 ALLOWED_FLAGS+=" -W* -w"
34
35 # allow a bunch of flags that negate features / control ABI
36 ALLOWED_FLAGS+=" -fno-stack-protector -fno-stack-protector-all \
37 -fno-strict-aliasing -fno-bounds-checking -fstrict-overflow \
38 -fno-omit-frame-pointer"
39 ALLOWED_FLAGS+=" -mregparm -mno-app-regs -mapp-regs -mno-mmx -mno-sse \
40 -mno-sse2 -mno-sse3 -mno-ssse3 -mno-sse4 -mno-sse4.1 -mno-sse4.2 \
41 -mno-avx -mno-aes -mno-pclmul -mno-sse4a -mno-3dnow -mno-popcnt \
42 -mno-abm -mips1 -mips2 -mips3 -mips4 -mips32 -mips64 -mips16 -mplt \
43 -msoft-float -mno-soft-float -mhard-float -mno-hard-float -mfpu \
44 -mieee -mieee-with-inexact -mschedule -mfloat-gprs -mspe -mno-spe \
45 -mtls-direct-seg-refs -mno-tls-direct-seg-refs -mflat -mno-flat \
46 -mno-faster-structs -mfaster-structs -m32 -m64 -mx32 -mabi \
47 -mlittle-endian -mbig-endian -EL -EB -fPIC -mlive-g0 -mcmodel \
48 -mstack-bias -mno-stack-bias -msecure-plt -m*-toc -D* -U*"
49
50 # 4.5
51 ALLOWED_FLAGS+=" -mno-fma4 -mno-movbe -mno-xop -mno-lwp"
52 # 4.6
53 ALLOWED_FLAGS+=" -mno-fsgsbase -mno-rdrnd -mno-f16c -mno-bmi -mno-tbm"
54
55 export ALLOWED_FLAGS
56 return 0
57 }
58
59 # inverted filters for hardened compiler. This is trying to unpick
60 # the hardened compiler defaults.
61 _filter-hardened() {
62 local f
63 for f in "$@" ; do
64 case "${f}" in
65 # Ideally we should only concern ourselves with PIE flags,
66 # not -fPIC or -fpic, but too many places filter -fPIC without
67 # thinking about -fPIE.
68 -fPIC|-fpic|-fPIE|-fpie|-Wl,pie|-pie)
69 gcc-specs-pie || continue
70 is-flagq -nopie || append-flags -nopie;;
71 -fstack-protector)
72 gcc-specs-ssp || continue
73 is-flagq -fno-stack-protector || append-flags $(test-flags -fno-stack-protector);;
74 -fstack-protector-all)
75 gcc-specs-ssp-to-all || continue
76 is-flagq -fno-stack-protector-all || append-flags $(test-flags -fno-stack-protector-all);;
77 -fno-strict-overflow)
78 gcc-specs-nostrict || continue
79 is-flagq -fstrict-overflow || append-flags $(test-flags -fstrict-overflow);;
80 esac
81 done
82 }
83
84 # Remove occurrences of strings from variable given in $1
85 # Strings removed are matched as globs, so for example
86 # '-O*' would remove -O1, -O2 etc.
87 _filter-var() {
88 local f x var=$1 new=()
89 shift
90
91 for f in ${!var} ; do
92 for x in "$@" ; do
93 # Note this should work with globs like -O*
94 [[ ${f} == ${x} ]] && continue 2
95 done
96 new+=( "${f}" )
97 done
98 eval export ${var}=\""${new[*]}"\"
99 }
100
101 # @FUNCTION: filter-flags
102 # @USAGE: <flags>
103 # @DESCRIPTION:
104 # Remove particular <flags> from {C,CPP,CXX,F,FC,LD}FLAGS. Accepts shell globs.
105 filter-flags() {
106 _filter-hardened "$@"
107 local v
108 for v in $(all-flag-vars) ; do
109 _filter-var ${v} "$@"
110 done
111 return 0
112 }
113
114 # @FUNCTION: filter-lfs-flags
115 # @DESCRIPTION:
116 # Remove flags that enable Large File Support.
117 filter-lfs-flags() {
118 [[ $# -ne 0 ]] && die "filter-lfs-flags takes no arguments"
119 # http://www.gnu.org/s/libc/manual/html_node/Feature-Test-Macros.html
120 # _LARGEFILE_SOURCE: enable support for new LFS funcs (ftello/etc...)
121 # _LARGEFILE64_SOURCE: enable support for 64bit variants (off64_t/fseeko64/etc...)
122 # _FILE_OFFSET_BITS: default to 64bit variants (off_t is defined as off64_t)
123 filter-flags -D_FILE_OFFSET_BITS=64 -D_LARGEFILE_SOURCE -D_LARGEFILE64_SOURCE
124 }
125
126 # @FUNCTION: append-cppflags
127 # @USAGE: <flags>
128 # @DESCRIPTION:
129 # Add extra <flags> to the current CPPFLAGS.
130 append-cppflags() {
131 [[ $# -eq 0 ]] && return 0
132 export CPPFLAGS="${CPPFLAGS} $*"
133 return 0
134 }
135
136 # @FUNCTION: append-cflags
137 # @USAGE: <flags>
138 # @DESCRIPTION:
139 # Add extra <flags> to the current CFLAGS.
140 append-cflags() {
141 [[ $# -eq 0 ]] && return 0
142 export CFLAGS=$(test-flags-CC ${CFLAGS} "$@")
143 return 0
144 }
145
146 # @FUNCTION: append-cxxflags
147 # @USAGE: <flags>
148 # @DESCRIPTION:
149 # Add extra <flags> to the current CXXFLAGS.
150 append-cxxflags() {
151 [[ $# -eq 0 ]] && return 0
152 export CXXFLAGS=$(test-flags-CXX ${CXXFLAGS} "$@")
153 return 0
154 }
155
156 # @FUNCTION: append-fflags
157 # @USAGE: <flags>
158 # @DESCRIPTION:
159 # Add extra <flags> to the current {F,FC}FLAGS.
160 append-fflags() {
161 [[ $# -eq 0 ]] && return 0
162 export FFLAGS=$(test-flags-F77 ${FFLAGS} "$@")
163 export FCFLAGS=$(test-flags-FC ${FCFLAGS} "$@")
164 return 0
165 }
166
167 # @FUNCTION: append-lfs-flags
168 # @DESCRIPTION:
169 # Add flags that enable Large File Support.
170 append-lfs-flags() {
171 [[ $# -ne 0 ]] && die "append-lfs-flags takes no arguments"
172 # see comments in filter-lfs-flags func for meaning of these
173 append-cppflags -D_FILE_OFFSET_BITS=64 -D_LARGEFILE_SOURCE -D_LARGEFILE64_SOURCE
174 }
175
176 # @FUNCTION: append-flags
177 # @USAGE: <flags>
178 # @DESCRIPTION:
179 # Add extra <flags> to your current {C,CXX,F,FC}FLAGS.
180 append-flags() {
181 [[ $# -eq 0 ]] && return 0
182 append-cflags "$@"
183 append-cxxflags "$@"
184 append-fflags "$@"
185 return 0
186 }
187
188 # @FUNCTION: replace-flags
189 # @USAGE: <old> <new>
190 # @DESCRIPTION:
191 # Replace the <old> flag with <new>. Accepts shell globs for <old>.
192 replace-flags() {
193 [[ $# != 2 ]] && die "Usage: replace-flags <old flag> <new flag>"
194
195 local f var new
196 for var in $(all-flag-vars) ; do
197 # Looping over the flags instead of using a global
198 # substitution ensures that we're working with flag atoms.
199 # Otherwise globs like -O* have the potential to wipe out the
200 # list of flags.
201 new=()
202 for f in ${!var} ; do
203 # Note this should work with globs like -O*
204 [[ ${f} == ${1} ]] && f=${2}
205 new+=( "${f}" )
206 done
207 eval export ${var}=\""${new[*]}"\"
208 done
209
210 return 0
211 }
212
213 # @FUNCTION: replace-cpu-flags
214 # @USAGE: <old> <new>
215 # @DESCRIPTION:
216 # Replace cpu flags (like -march/-mcpu/-mtune) that select the <old> cpu
217 # with flags that select the <new> cpu. Accepts shell globs for <old>.
218 replace-cpu-flags() {
219 local newcpu="$#" ; newcpu="${!newcpu}"
220 while [ $# -gt 1 ] ; do
221 # quote to make sure that no globbing is done (particularly on
222 # ${oldcpu}) prior to calling replace-flags
223 replace-flags "-march=${1}" "-march=${newcpu}"
224 replace-flags "-mcpu=${1}" "-mcpu=${newcpu}"
225 replace-flags "-mtune=${1}" "-mtune=${newcpu}"
226 shift
227 done
228 return 0
229 }
230
231 _is_flagq() {
232 local x
233 for x in ${!1} ; do
234 [[ ${x} == $2 ]] && return 0
235 done
236 return 1
237 }
238
239 # @FUNCTION: is-flagq
240 # @USAGE: <flag>
241 # @DESCRIPTION:
242 # Returns shell true if <flag> is in {C,CXX,F,FC}FLAGS, else returns shell false. Accepts shell globs.
243 is-flagq() {
244 [[ -n $2 ]] && die "Usage: is-flag <flag>"
245
246 local var
247 for var in $(all-flag-vars) ; do
248 _is_flagq ${var} "$1" && return 0
249 done
250 return 1
251 }
252
253 # @FUNCTION: is-flag
254 # @USAGE: <flag>
255 # @DESCRIPTION:
256 # Echo's "true" if flag is set in {C,CXX,F,FC}FLAGS. Accepts shell globs.
257 is-flag() {
258 is-flagq "$@" && echo true
259 }
260
261 # @FUNCTION: is-ldflagq
262 # @USAGE: <flag>
263 # @DESCRIPTION:
264 # Returns shell true if <flag> is in LDFLAGS, else returns shell false. Accepts shell globs.
265 is-ldflagq() {
266 [[ -n $2 ]] && die "Usage: is-ldflag <flag>"
267 _is_flagq LDFLAGS $1
268 }
269
270 # @FUNCTION: is-ldflag
271 # @USAGE: <flag>
272 # @DESCRIPTION:
273 # Echo's "true" if flag is set in LDFLAGS. Accepts shell globs.
274 is-ldflag() {
275 is-ldflagq "$@" && echo true
276 }
277
278 # @FUNCTION: filter-mfpmath
279 # @USAGE: <math types>
280 # @DESCRIPTION:
281 # Remove specified math types from the fpmath flag. For example, if the user
282 # has -mfpmath=sse,386, running `filter-mfpmath sse` will leave the user with
283 # -mfpmath=386.
284 filter-mfpmath() {
285 local orig_mfpmath new_math prune_math
286
287 # save the original -mfpmath flag
288 orig_mfpmath=$(get-flag -mfpmath)
289 # get the value of the current -mfpmath flag
290 new_math=$(get-flag mfpmath)
291 new_math=" ${new_math//,/ } "
292 # figure out which math values are to be removed
293 prune_math=""
294 for prune_math in "$@" ; do
295 new_math=${new_math/ ${prune_math} / }
296 done
297 new_math=$(echo ${new_math})
298 new_math=${new_math// /,}
299
300 if [[ -z ${new_math} ]] ; then
301 # if we're removing all user specified math values are
302 # slated for removal, then we just filter the flag
303 filter-flags ${orig_mfpmath}
304 else
305 # if we only want to filter some of the user specified
306 # math values, then we replace the current flag
307 replace-flags ${orig_mfpmath} -mfpmath=${new_math}
308 fi
309 return 0
310 }
311
312 # @FUNCTION: strip-flags
313 # @DESCRIPTION:
314 # Strip C[XX]FLAGS of everything except known good/safe flags.
315 strip-flags() {
316 local x y var
317
318 setup-allowed-flags
319
320 set -f # disable pathname expansion
321
322 for var in $(all-flag-vars) ; do
323 local new=()
324
325 for x in ${!var} ; do
326 local flag=${x%%=*}
327 for y in ${ALLOWED_FLAGS} ; do
328 if [[ -z ${flag%%${y}} ]] ; then
329 new+=( "${x}" )
330 break
331 fi
332 done
333 done
334
335 # In case we filtered out all optimization flags fallback to -O2
336 if _is_flagq ${var} "-O*" && ! _is_flagq new "-O*" ; then
337 new+=( -O2 )
338 fi
339
340 eval export ${var}=\""${new[*]}"\"
341 done
342
343 set +f # re-enable pathname expansion
344
345 return 0
346 }
347
348 test-flag-PROG() {
349 local comp=$1
350 local flags="$2"
351
352 [[ -z ${comp} || -z ${flags} ]] && return 1
353
354 # use -c so we can test the assembler as well
355 local PROG=$(tc-get${comp})
356 ${PROG} ${flags} -c -o /dev/null -xc /dev/null \
357 > /dev/null 2>&1
358 }
359
360 # @FUNCTION: test-flag-CC
361 # @USAGE: <flag>
362 # @DESCRIPTION:
363 # Returns shell true if <flag> is supported by the C compiler, else returns shell false.
364 test-flag-CC() { test-flag-PROG "CC" "$1"; }
365
366 # @FUNCTION: test-flag-CXX
367 # @USAGE: <flag>
368 # @DESCRIPTION:
369 # Returns shell true if <flag> is supported by the C++ compiler, else returns shell false.
370 test-flag-CXX() { test-flag-PROG "CXX" "$1"; }
371
372 # @FUNCTION: test-flag-F77
373 # @USAGE: <flag>
374 # @DESCRIPTION:
375 # Returns shell true if <flag> is supported by the Fortran 77 compiler, else returns shell false.
376 test-flag-F77() { test-flag-PROG "F77" "$1"; }
377
378 # @FUNCTION: test-flag-FC
379 # @USAGE: <flag>
380 # @DESCRIPTION:
381 # Returns shell true if <flag> is supported by the Fortran 90 compiler, else returns shell false.
382 test-flag-FC() { test-flag-PROG "FC" "$1"; }
383
384 test-flags-PROG() {
385 local comp=$1
386 local flags
387 local x
388
389 shift
390
391 [[ -z ${comp} ]] && return 1
392
393 for x in "$@" ; do
394 test-flag-${comp} "${x}" && flags="${flags}${flags:+ }${x}"
395 done
396
397 echo "${flags}"
398
399 # Just bail if we dont have any flags
400 [[ -n ${flags} ]]
401 }
402
403 # @FUNCTION: test-flags-CC
404 # @USAGE: <flags>
405 # @DESCRIPTION:
406 # Returns shell true if <flags> are supported by the C compiler, else returns shell false.
407 test-flags-CC() { test-flags-PROG "CC" "$@"; }
408
409 # @FUNCTION: test-flags-CXX
410 # @USAGE: <flags>
411 # @DESCRIPTION:
412 # Returns shell true if <flags> are supported by the C++ compiler, else returns shell false.
413 test-flags-CXX() { test-flags-PROG "CXX" "$@"; }
414
415 # @FUNCTION: test-flags-F77
416 # @USAGE: <flags>
417 # @DESCRIPTION:
418 # Returns shell true if <flags> are supported by the Fortran 77 compiler, else returns shell false.
419 test-flags-F77() { test-flags-PROG "F77" "$@"; }
420
421 # @FUNCTION: test-flags-FC
422 # @USAGE: <flags>
423 # @DESCRIPTION:
424 # Returns shell true if <flags> are supported by the Fortran 90 compiler, else returns shell false.
425 test-flags-FC() { test-flags-PROG "FC" "$@"; }
426
427 # @FUNCTION: test-flags
428 # @USAGE: <flags>
429 # @DESCRIPTION:
430 # Short-hand that should hopefully work for both C and C++ compiler, but
431 # its really only present due to the append-flags() abomination.
432 test-flags() { test-flags-CC "$@"; }
433
434 # @FUNCTION: test_version_info
435 # @USAGE: <version>
436 # @DESCRIPTION:
437 # Returns shell true if the current C compiler version matches <version>, else returns shell false.
438 # Accepts shell globs.
439 test_version_info() {
440 if [[ $($(tc-getCC) --version 2>&1) == *$1* ]]; then
441 return 0
442 else
443 return 1
444 fi
445 }
446
447 # @FUNCTION: strip-unsupported-flags
448 # @DESCRIPTION:
449 # Strip {C,CXX,F,FC}FLAGS of any flags not supported by the active toolchain.
450 strip-unsupported-flags() {
451 export CFLAGS=$(test-flags-CC ${CFLAGS})
452 export CXXFLAGS=$(test-flags-CXX ${CXXFLAGS})
453 export FFLAGS=$(test-flags-F77 ${FFLAGS})
454 export FCFLAGS=$(test-flags-FC ${FCFLAGS})
455 }
456
457 # @FUNCTION: get-flag
458 # @USAGE: <flag>
459 # @DESCRIPTION:
460 # Find and echo the value for a particular flag. Accepts shell globs.
461 get-flag() {
462 local f var findflag="$1"
463
464 # this code looks a little flaky but seems to work for
465 # everything we want ...
466 # for example, if CFLAGS="-march=i686":
467 # `get-flag -march` == "-march=i686"
468 # `get-flag march` == "i686"
469 for var in $(all-flag-vars) ; do
470 for f in ${!var} ; do
471 if [ "${f/${findflag}}" != "${f}" ] ; then
472 printf "%s\n" "${f/-${findflag}=}"
473 return 0
474 fi
475 done
476 done
477 return 1
478 }
479
480 # @FUNCTION: has_m64
481 # @DESCRIPTION:
482 # This doesn't test if the flag is accepted, it tests if the flag actually
483 # WORKS. Non-multilib gcc will take both -m32 and -m64. If the flag works
484 # return code is 0, else the return code is 1.
485 has_m64() {
486 eqawarn "${FUNCNAME}: don't use this anymore"
487
488 # this doesnt test if the flag is accepted, it tests if the flag
489 # actually -WORKS-. non-multilib gcc will take both -m32 and -m64!
490 # please dont replace this function with test_flag in some future
491 # clean-up!
492
493 local temp="$(emktemp)"
494 echo "int main() { return(0); }" > "${temp}".c
495 MY_CC=$(tc-getCC)
496 ${MY_CC/ .*/} -m64 -o "$(emktemp)" "${temp}".c > /dev/null 2>&1
497 local ret=$?
498 rm -f "${temp}".c
499 [[ ${ret} != 1 ]] && return 0
500 return 1
501 }
502
503 has_m32() {
504 die "${FUNCNAME}: don't use this anymore"
505 }
506
507 # @FUNCTION: replace-sparc64-flags
508 # @DESCRIPTION:
509 # Sets mcpu to v8 and uses the original value as mtune if none specified.
510 replace-sparc64-flags() {
511 local SPARC64_CPUS="ultrasparc3 ultrasparc v9"
512
513 if [ "${CFLAGS/mtune}" != "${CFLAGS}" ]; then
514 for x in ${SPARC64_CPUS}; do
515 CFLAGS="${CFLAGS/-mcpu=${x}/-mcpu=v8}"
516 done
517 else
518 for x in ${SPARC64_CPUS}; do
519 CFLAGS="${CFLAGS/-mcpu=${x}/-mcpu=v8 -mtune=${x}}"
520 done
521 fi
522
523 if [ "${CXXFLAGS/mtune}" != "${CXXFLAGS}" ]; then
524 for x in ${SPARC64_CPUS}; do
525 CXXFLAGS="${CXXFLAGS/-mcpu=${x}/-mcpu=v8}"
526 done
527 else
528 for x in ${SPARC64_CPUS}; do
529 CXXFLAGS="${CXXFLAGS/-mcpu=${x}/-mcpu=v8 -mtune=${x}}"
530 done
531 fi
532
533 export CFLAGS CXXFLAGS
534 }
535
536 # @FUNCTION: append-libs
537 # @USAGE: <libs>
538 # @DESCRIPTION:
539 # Add extra <libs> to the current LIBS.
540 append-libs() {
541 [[ $# -eq 0 ]] && return 0
542 local flag
543 for flag in "$@"; do
544 [[ ${flag} == -l* ]] && flag=${flag#-l}
545 export LIBS="${LIBS} -l${flag}"
546 done
547
548 return 0
549 }
550
551 # @FUNCTION: append-ldflags
552 # @USAGE: <flags>
553 # @DESCRIPTION:
554 # Add extra <flags> to the current LDFLAGS.
555 append-ldflags() {
556 [[ $# -eq 0 ]] && return 0
557 local flag
558 for flag in "$@"; do
559 [[ ${flag} == -l* ]] && \
560 ewarn "Appending a library link instruction (${flag}); libraries to link to should not be passed through LDFLAGS"
561 done
562
563 export LDFLAGS="${LDFLAGS} $*"
564 return 0
565 }
566
567 # @FUNCTION: filter-ldflags
568 # @USAGE: <flags>
569 # @DESCRIPTION:
570 # Remove particular <flags> from LDFLAGS. Accepts shell globs.
571 filter-ldflags() {
572 _filter-var LDFLAGS "$@"
573 return 0
574 }
575
576 # @FUNCTION: raw-ldflags
577 # @USAGE: [flags]
578 # @DESCRIPTION:
579 # Turn C style ldflags (-Wl,-foo) into straight ldflags - the results
580 # are suitable for passing directly to 'ld'; note LDFLAGS is usually passed
581 # to gcc where it needs the '-Wl,'.
582 #
583 # If no flags are specified, then default to ${LDFLAGS}.
584 raw-ldflags() {
585 local x input="$@"
586 [[ -z ${input} ]] && input=${LDFLAGS}
587 set --
588 for x in ${input} ; do
589 x=${x#-Wl,}
590 set -- "$@" ${x//,/ }
591 done
592 echo "$@"
593 }
594
595 # @FUNCTION: no-as-needed
596 # @RETURN: Flag to disable asneeded behavior for use with append-ldflags.
597 no-as-needed() {
598 case $($(tc-getLD) -v 2>&1 </dev/null) in
599 *GNU*) # GNU ld
600 echo "-Wl,--no-as-needed" ;;
601 esac
602 }
603
604 fi

  ViewVC Help
Powered by ViewVC 1.1.20