/[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.173 - (show annotations) (download)
Thu May 31 00:29:06 2012 UTC (2 years, 2 months ago) by vapier
Branch: MAIN
Changes since 1.172: +2 -2 lines
fix moronic syntax error in previous commit

1 # Copyright 1999-2012 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.172 2012/05/31 00:24:47 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,CCAS,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,CCAS,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: filter-ldflags
127 # @USAGE: <flags>
128 # @DESCRIPTION:
129 # Remove particular <flags> from LDFLAGS. Accepts shell globs.
130 filter-ldflags() {
131 _filter-var LDFLAGS "$@"
132 return 0
133 }
134
135 # @FUNCTION: append-cppflags
136 # @USAGE: <flags>
137 # @DESCRIPTION:
138 # Add extra <flags> to the current CPPFLAGS.
139 append-cppflags() {
140 [[ $# -eq 0 ]] && return 0
141 export CPPFLAGS="${CPPFLAGS} $*"
142 return 0
143 }
144
145 # @FUNCTION: append-cflags
146 # @USAGE: <flags>
147 # @DESCRIPTION:
148 # Add extra <flags> to the current CFLAGS.
149 append-cflags() {
150 [[ $# -eq 0 ]] && return 0
151 export CFLAGS=$(test-flags-CC ${CFLAGS} "$@")
152 return 0
153 }
154
155 # @FUNCTION: append-cxxflags
156 # @USAGE: <flags>
157 # @DESCRIPTION:
158 # Add extra <flags> to the current CXXFLAGS.
159 append-cxxflags() {
160 [[ $# -eq 0 ]] && return 0
161 export CXXFLAGS=$(test-flags-CXX ${CXXFLAGS} "$@")
162 return 0
163 }
164
165 # @FUNCTION: append-fflags
166 # @USAGE: <flags>
167 # @DESCRIPTION:
168 # Add extra <flags> to the current {F,FC}FLAGS.
169 append-fflags() {
170 [[ $# -eq 0 ]] && return 0
171 export FFLAGS=$(test-flags-F77 ${FFLAGS} "$@")
172 export FCFLAGS=$(test-flags-FC ${FCFLAGS} "$@")
173 return 0
174 }
175
176 # @FUNCTION: append-lfs-flags
177 # @DESCRIPTION:
178 # Add flags that enable Large File Support.
179 append-lfs-flags() {
180 [[ $# -ne 0 ]] && die "append-lfs-flags takes no arguments"
181 # see comments in filter-lfs-flags func for meaning of these
182 append-cppflags -D_FILE_OFFSET_BITS=64 -D_LARGEFILE_SOURCE -D_LARGEFILE64_SOURCE
183 }
184
185 # @FUNCTION: append-ldflags
186 # @USAGE: <flags>
187 # @DESCRIPTION:
188 # Add extra <flags> to the current LDFLAGS.
189 append-ldflags() {
190 [[ $# -eq 0 ]] && return 0
191 local flag
192 for flag in "$@"; do
193 [[ ${flag} == -l* ]] && \
194 ewarn "Appending a library link instruction (${flag}); libraries to link to should not be passed through LDFLAGS"
195 done
196
197 export LDFLAGS="${LDFLAGS} $*"
198 return 0
199 }
200
201 # @FUNCTION: append-flags
202 # @USAGE: <flags>
203 # @DESCRIPTION:
204 # Add extra <flags> to your current {C,CXX,F,FC}FLAGS.
205 append-flags() {
206 [[ $# -eq 0 ]] && return 0
207 case " $* " in
208 *' '-[DIU]*) eqawarn 'please use append-cppflags for preprocessor flags' ;;
209 *' '-L*|\
210 *' '-Wl,*) eqawarn 'please use append-ldflags for linker flags' ;;
211 esac
212 append-cflags "$@"
213 append-cxxflags "$@"
214 append-fflags "$@"
215 return 0
216 }
217
218 # @FUNCTION: replace-flags
219 # @USAGE: <old> <new>
220 # @DESCRIPTION:
221 # Replace the <old> flag with <new>. Accepts shell globs for <old>.
222 replace-flags() {
223 [[ $# != 2 ]] && die "Usage: replace-flags <old flag> <new flag>"
224
225 local f var new
226 for var in $(all-flag-vars) ; do
227 # Looping over the flags instead of using a global
228 # substitution ensures that we're working with flag atoms.
229 # Otherwise globs like -O* have the potential to wipe out the
230 # list of flags.
231 new=()
232 for f in ${!var} ; do
233 # Note this should work with globs like -O*
234 [[ ${f} == ${1} ]] && f=${2}
235 new+=( "${f}" )
236 done
237 eval export ${var}=\""${new[*]}"\"
238 done
239
240 return 0
241 }
242
243 # @FUNCTION: replace-cpu-flags
244 # @USAGE: <old> <new>
245 # @DESCRIPTION:
246 # Replace cpu flags (like -march/-mcpu/-mtune) that select the <old> cpu
247 # with flags that select the <new> cpu. Accepts shell globs for <old>.
248 replace-cpu-flags() {
249 local newcpu="$#" ; newcpu="${!newcpu}"
250 while [ $# -gt 1 ] ; do
251 # quote to make sure that no globbing is done (particularly on
252 # ${oldcpu}) prior to calling replace-flags
253 replace-flags "-march=${1}" "-march=${newcpu}"
254 replace-flags "-mcpu=${1}" "-mcpu=${newcpu}"
255 replace-flags "-mtune=${1}" "-mtune=${newcpu}"
256 shift
257 done
258 return 0
259 }
260
261 _is_flagq() {
262 local x
263 for x in ${!1} ; do
264 [[ ${x} == $2 ]] && return 0
265 done
266 return 1
267 }
268
269 # @FUNCTION: is-flagq
270 # @USAGE: <flag>
271 # @DESCRIPTION:
272 # Returns shell true if <flag> is in {C,CXX,F,FC}FLAGS, else returns shell false. Accepts shell globs.
273 is-flagq() {
274 [[ -n $2 ]] && die "Usage: is-flag <flag>"
275
276 local var
277 for var in $(all-flag-vars) ; do
278 _is_flagq ${var} "$1" && return 0
279 done
280 return 1
281 }
282
283 # @FUNCTION: is-flag
284 # @USAGE: <flag>
285 # @DESCRIPTION:
286 # Echo's "true" if flag is set in {C,CXX,F,FC}FLAGS. Accepts shell globs.
287 is-flag() {
288 is-flagq "$@" && echo true
289 }
290
291 # @FUNCTION: is-ldflagq
292 # @USAGE: <flag>
293 # @DESCRIPTION:
294 # Returns shell true if <flag> is in LDFLAGS, else returns shell false. Accepts shell globs.
295 is-ldflagq() {
296 [[ -n $2 ]] && die "Usage: is-ldflag <flag>"
297 _is_flagq LDFLAGS $1
298 }
299
300 # @FUNCTION: is-ldflag
301 # @USAGE: <flag>
302 # @DESCRIPTION:
303 # Echo's "true" if flag is set in LDFLAGS. Accepts shell globs.
304 is-ldflag() {
305 is-ldflagq "$@" && echo true
306 }
307
308 # @FUNCTION: filter-mfpmath
309 # @USAGE: <math types>
310 # @DESCRIPTION:
311 # Remove specified math types from the fpmath flag. For example, if the user
312 # has -mfpmath=sse,386, running `filter-mfpmath sse` will leave the user with
313 # -mfpmath=386.
314 filter-mfpmath() {
315 local orig_mfpmath new_math prune_math
316
317 # save the original -mfpmath flag
318 orig_mfpmath=$(get-flag -mfpmath)
319 # get the value of the current -mfpmath flag
320 new_math=$(get-flag mfpmath)
321 new_math=" ${new_math//,/ } "
322 # figure out which math values are to be removed
323 prune_math=""
324 for prune_math in "$@" ; do
325 new_math=${new_math/ ${prune_math} / }
326 done
327 new_math=$(echo ${new_math})
328 new_math=${new_math// /,}
329
330 if [[ -z ${new_math} ]] ; then
331 # if we're removing all user specified math values are
332 # slated for removal, then we just filter the flag
333 filter-flags ${orig_mfpmath}
334 else
335 # if we only want to filter some of the user specified
336 # math values, then we replace the current flag
337 replace-flags ${orig_mfpmath} -mfpmath=${new_math}
338 fi
339 return 0
340 }
341
342 # @FUNCTION: strip-flags
343 # @DESCRIPTION:
344 # Strip C[XX]FLAGS of everything except known good/safe flags.
345 strip-flags() {
346 local x y var
347
348 setup-allowed-flags
349
350 set -f # disable pathname expansion
351
352 for var in $(all-flag-vars) ; do
353 local new=()
354
355 for x in ${!var} ; do
356 local flag=${x%%=*}
357 for y in ${ALLOWED_FLAGS} ; do
358 if [[ -z ${flag%%${y}} ]] ; then
359 new+=( "${x}" )
360 break
361 fi
362 done
363 done
364
365 # In case we filtered out all optimization flags fallback to -O2
366 if _is_flagq ${var} "-O*" && ! _is_flagq new "-O*" ; then
367 new+=( -O2 )
368 fi
369
370 eval export ${var}=\""${new[*]}"\"
371 done
372
373 set +f # re-enable pathname expansion
374
375 return 0
376 }
377
378 test-flag-PROG() {
379 local comp=$1
380 local flag=$2
381
382 [[ -z ${comp} || -z ${flag} ]] && return 1
383
384 # use -c so we can test the assembler as well
385 local PROG=$(tc-get${comp})
386 ${PROG} "${flag}" -c -o /dev/null -xc /dev/null \
387 > /dev/null 2>&1
388 }
389
390 # @FUNCTION: test-flag-CC
391 # @USAGE: <flag>
392 # @DESCRIPTION:
393 # Returns shell true if <flag> is supported by the C compiler, else returns shell false.
394 test-flag-CC() { test-flag-PROG "CC" "$1"; }
395
396 # @FUNCTION: test-flag-CXX
397 # @USAGE: <flag>
398 # @DESCRIPTION:
399 # Returns shell true if <flag> is supported by the C++ compiler, else returns shell false.
400 test-flag-CXX() { test-flag-PROG "CXX" "$1"; }
401
402 # @FUNCTION: test-flag-F77
403 # @USAGE: <flag>
404 # @DESCRIPTION:
405 # Returns shell true if <flag> is supported by the Fortran 77 compiler, else returns shell false.
406 test-flag-F77() { test-flag-PROG "F77" "$1"; }
407
408 # @FUNCTION: test-flag-FC
409 # @USAGE: <flag>
410 # @DESCRIPTION:
411 # Returns shell true if <flag> is supported by the Fortran 90 compiler, else returns shell false.
412 test-flag-FC() { test-flag-PROG "FC" "$1"; }
413
414 test-flags-PROG() {
415 local comp=$1
416 local flags
417 local x
418
419 shift
420
421 [[ -z ${comp} ]] && return 1
422
423 for x in "$@" ; do
424 test-flag-${comp} "${x}" && flags="${flags}${flags:+ }${x}"
425 done
426
427 echo "${flags}"
428
429 # Just bail if we dont have any flags
430 [[ -n ${flags} ]]
431 }
432
433 # @FUNCTION: test-flags-CC
434 # @USAGE: <flags>
435 # @DESCRIPTION:
436 # Returns shell true if <flags> are supported by the C compiler, else returns shell false.
437 test-flags-CC() { test-flags-PROG "CC" "$@"; }
438
439 # @FUNCTION: test-flags-CXX
440 # @USAGE: <flags>
441 # @DESCRIPTION:
442 # Returns shell true if <flags> are supported by the C++ compiler, else returns shell false.
443 test-flags-CXX() { test-flags-PROG "CXX" "$@"; }
444
445 # @FUNCTION: test-flags-F77
446 # @USAGE: <flags>
447 # @DESCRIPTION:
448 # Returns shell true if <flags> are supported by the Fortran 77 compiler, else returns shell false.
449 test-flags-F77() { test-flags-PROG "F77" "$@"; }
450
451 # @FUNCTION: test-flags-FC
452 # @USAGE: <flags>
453 # @DESCRIPTION:
454 # Returns shell true if <flags> are supported by the Fortran 90 compiler, else returns shell false.
455 test-flags-FC() { test-flags-PROG "FC" "$@"; }
456
457 # @FUNCTION: test-flags
458 # @USAGE: <flags>
459 # @DESCRIPTION:
460 # Short-hand that should hopefully work for both C and C++ compiler, but
461 # its really only present due to the append-flags() abomination.
462 test-flags() { test-flags-CC "$@"; }
463
464 # @FUNCTION: test_version_info
465 # @USAGE: <version>
466 # @DESCRIPTION:
467 # Returns shell true if the current C compiler version matches <version>, else returns shell false.
468 # Accepts shell globs.
469 test_version_info() {
470 if [[ $($(tc-getCC) --version 2>&1) == *$1* ]]; then
471 return 0
472 else
473 return 1
474 fi
475 }
476
477 # @FUNCTION: strip-unsupported-flags
478 # @DESCRIPTION:
479 # Strip {C,CXX,F,FC}FLAGS of any flags not supported by the active toolchain.
480 strip-unsupported-flags() {
481 export CFLAGS=$(test-flags-CC ${CFLAGS})
482 export CXXFLAGS=$(test-flags-CXX ${CXXFLAGS})
483 export FFLAGS=$(test-flags-F77 ${FFLAGS})
484 export FCFLAGS=$(test-flags-FC ${FCFLAGS})
485 }
486
487 # @FUNCTION: get-flag
488 # @USAGE: <flag>
489 # @DESCRIPTION:
490 # Find and echo the value for a particular flag. Accepts shell globs.
491 get-flag() {
492 local f var findflag="$1"
493
494 # this code looks a little flaky but seems to work for
495 # everything we want ...
496 # for example, if CFLAGS="-march=i686":
497 # `get-flag -march` == "-march=i686"
498 # `get-flag march` == "i686"
499 for var in $(all-flag-vars) ; do
500 for f in ${!var} ; do
501 if [ "${f/${findflag}}" != "${f}" ] ; then
502 printf "%s\n" "${f/-${findflag}=}"
503 return 0
504 fi
505 done
506 done
507 return 1
508 }
509
510 # @FUNCTION: has_m64
511 # @DESCRIPTION:
512 # This doesn't test if the flag is accepted, it tests if the flag actually
513 # WORKS. Non-multilib gcc will take both -m32 and -m64. If the flag works
514 # return code is 0, else the return code is 1.
515 has_m64() {
516 eqawarn "${FUNCNAME}: don't use this anymore"
517
518 # this doesnt test if the flag is accepted, it tests if the flag
519 # actually -WORKS-. non-multilib gcc will take both -m32 and -m64!
520 # please dont replace this function with test_flag in some future
521 # clean-up!
522
523 local temp="$(emktemp)"
524 echo "int main() { return(0); }" > "${temp}".c
525 MY_CC=$(tc-getCC)
526 ${MY_CC/ .*/} -m64 -o "$(emktemp)" "${temp}".c > /dev/null 2>&1
527 local ret=$?
528 rm -f "${temp}".c
529 [[ ${ret} != 1 ]] && return 0
530 return 1
531 }
532
533 has_m32() {
534 die "${FUNCNAME}: don't use this anymore"
535 }
536
537 # @FUNCTION: replace-sparc64-flags
538 # @DESCRIPTION:
539 # Sets mcpu to v8 and uses the original value as mtune if none specified.
540 replace-sparc64-flags() {
541 local SPARC64_CPUS="ultrasparc3 ultrasparc v9"
542
543 if [ "${CFLAGS/mtune}" != "${CFLAGS}" ]; then
544 for x in ${SPARC64_CPUS}; do
545 CFLAGS="${CFLAGS/-mcpu=${x}/-mcpu=v8}"
546 done
547 else
548 for x in ${SPARC64_CPUS}; do
549 CFLAGS="${CFLAGS/-mcpu=${x}/-mcpu=v8 -mtune=${x}}"
550 done
551 fi
552
553 if [ "${CXXFLAGS/mtune}" != "${CXXFLAGS}" ]; then
554 for x in ${SPARC64_CPUS}; do
555 CXXFLAGS="${CXXFLAGS/-mcpu=${x}/-mcpu=v8}"
556 done
557 else
558 for x in ${SPARC64_CPUS}; do
559 CXXFLAGS="${CXXFLAGS/-mcpu=${x}/-mcpu=v8 -mtune=${x}}"
560 done
561 fi
562
563 export CFLAGS CXXFLAGS
564 }
565
566 # @FUNCTION: append-libs
567 # @USAGE: <libs>
568 # @DESCRIPTION:
569 # Add extra <libs> to the current LIBS.
570 append-libs() {
571 [[ $# -eq 0 ]] && return 0
572 local flag
573 for flag in "$@"; do
574 [[ ${flag} == -l* ]] && flag=${flag#-l}
575 export LIBS="${LIBS} -l${flag}"
576 done
577
578 return 0
579 }
580
581 # @FUNCTION: raw-ldflags
582 # @USAGE: [flags]
583 # @DESCRIPTION:
584 # Turn C style ldflags (-Wl,-foo) into straight ldflags - the results
585 # are suitable for passing directly to 'ld'; note LDFLAGS is usually passed
586 # to gcc where it needs the '-Wl,'.
587 #
588 # If no flags are specified, then default to ${LDFLAGS}.
589 raw-ldflags() {
590 local x input="$@"
591 [[ -z ${input} ]] && input=${LDFLAGS}
592 set --
593 for x in ${input} ; do
594 x=${x#-Wl,}
595 set -- "$@" ${x//,/ }
596 done
597 echo "$@"
598 }
599
600 # @FUNCTION: no-as-needed
601 # @RETURN: Flag to disable asneeded behavior for use with append-ldflags.
602 no-as-needed() {
603 case $($(tc-getLD) -v 2>&1 </dev/null) in
604 *GNU*) # GNU ld
605 echo "-Wl,--no-as-needed" ;;
606 esac
607 }
608
609 fi

  ViewVC Help
Powered by ViewVC 1.1.20