/[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.170 - (show annotations) (download)
Sat May 26 02:55:02 2012 UTC (2 years, 1 month ago) by vapier
Branch: MAIN
Changes since 1.169: +5 -1 lines
warn when people add preprocessor/linker flags with `append-flags`

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

  ViewVC Help
Powered by ViewVC 1.1.20