1#!/bin/sh
2# Generates multilib.h.
3#   Copyright (C) 1994-2018 Free Software Foundation, Inc.
4
5#This file is part of GCC.
6
7#GCC is free software; you can redistribute it and/or modify it under
8#the terms of the GNU General Public License as published by the Free
9#Software Foundation; either version 3, or (at your option) any later
10#version.
11
12#GCC is distributed in the hope that it will be useful, but WITHOUT
13#ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14#FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15#for more details.
16
17#You should have received a copy of the GNU General Public License
18#along with GCC; see the file COPYING3.  If not see
19#<http://www.gnu.org/licenses/>.
20
21# This shell script produces a header file which the gcc driver
22# program uses to pick which library to use based on the machine
23# specific options that it is given.
24
25# The first argument is a list of sets of options.  The elements in
26# the list are separated by spaces.  Within an element, the options
27# are separated by slashes or pipes.  No leading dash is used on the
28# options.
29# Each option in a set separated by slashes is mutually incompatible
30# with all other options
31# in the set.
32# Each option in a set separated by pipes will be used for the library
33# compilation and any of the options in the set will be sufficient
34# for it to be triggered.
35
36# The optional second argument is a list of subdirectory names.  If
37# the second argument is non-empty, there must be as many elements in
38# the second argument as there are options in the first argument.  The
39# elements in the second list are separated by spaces.  If the second
40# argument is empty, the option names will be used as the directory
41# names.
42
43# The optional third argument is a list of options which are
44# identical.  The elements in the list are separated by spaces.  Each
45# element must be of the form OPTION=OPTION.  The first OPTION should
46# appear in the first argument, and the second should be a synonym for
47# it.  Question marks are replaced with equal signs in both options.
48
49# The optional fourth argument is a list of multilib directory
50# combinations that should not be built.
51
52# The optional fifth argument is a list of options that should be
53# used whenever building multilib libraries.
54
55# The optional sixth argument is a list of exclusions used internally by
56# the compiler similar to exceptions. The difference being that exclusions
57# allow matching default options that genmultilib does not know about and
58# is done at runtime as opposed to being sorted out at compile time.
59# Each element in the list is a separate exclusion rule. Each rule is
60# a list of options (sans preceding '-') separated by a '/'. The options
61# on the rule are grouped as an AND operation, and all options much match
62# for the rule to exclude a set. Options can be preceded with a '!' to
63# match a logical NOT.
64
65# The optional seventh argument is a list of OS subdirectory names.
66# The format is either the same as of the second argument, or a set of
67# mappings. When it is the same as the second argument, it describes
68# the multilib directories using OS conventions, rather than GCC
69# conventions.  When it is a set of mappings of the form gccdir=osdir,
70# the left side gives the GCC convention and the right gives the
71# equivalent OS defined location.  If the osdir part begins with a !,
72# the os directory names are used exclusively.  Use the mapping when
73# there is no one-to-one equivalence between GCC levels and the OS.
74
75# The optional eighth argument which intends to reduce the effort to write
76# so many MULTILIB_EXCEPTIONS rules. This option defines a series of option
77# combinations that we actually required.
78# For some cases, the generated option combinations are far more than what
79# we need, we have to write a lot of rules to screen out combinations we
80# don't need. If we missed some rules, the unexpected libraries will be built.
81# Now with this argument, one can simply give what combinations are needed.
82# It is pretty straigtforward.
83# This argument can be used together with MULTILIB_EXCEPTIONS and will take
84# effect after the MULTILIB_EXCEPTIONS.
85
86# The optional ninth argument is the multiarch name.
87
88# The optional tenth argument specifies how to reuse multilib for different
89# option sets.
90
91# The last option should be "yes" if multilibs are enabled.  If it is not
92# "yes", all GCC multilib dir names will be ".".
93
94# The output looks like
95#   #define MULTILIB_MATCHES "\
96#   SUBDIRECTORY OPTIONS;\
97#   ...
98#   "
99# The SUBDIRECTORY is the subdirectory to use.  The OPTIONS are
100# multiple options separated by spaces.  Each option may start with an
101# exclamation point.  gcc will consider each line in turn.  If none of
102# the options beginning with an exclamation point are present, and all
103# of the other options are present, that subdirectory will be used.
104# The order of the subdirectories is such that they can be created in
105# order; that is, a subdirectory is preceded by all its parents.
106
107# Here is an example (this is from the actual sparc64 case):
108#   genmultilib 'm64/m32 mno-app-regs|mcmodel=medany' '64 32 alt'
109#		'mcmodel?medany=mcmodel?medmid' 'm32/mno-app-regs* m32/mcmodel=*'
110#		'' 'm32/!m64/mno-app-regs m32/!m64/mcmodel=medany'
111#		'../lib64 ../lib32 alt' '' '' '' yes
112# This produces:
113#   ". !m64 !m32 !mno-app-regs !mcmodel=medany;",
114#   "64:../lib64 m64 !m32 !mno-app-regs !mcmodel=medany;",
115#   "32:../lib32 !m64 m32 !mno-app-regs !mcmodel=medany;",
116#   "alt !m64 !m32 mno-app-regs mcmodel=medany;",
117#   "alt !m64 !m32 mno-app-regs !mcmodel=medany;",
118#   "alt !m64 !m32 !mno-app-regs mcmodel=medany;",
119#   "64/alt:../lib64/alt m64 !m32 mno-app-regs mcmodel=medany;",
120#   "64/alt:../lib64/alt m64 !m32 mno-app-regs !mcmodel=medany;",
121#   "64/alt:../lib64/alt m64 !m32 !mno-app-regs mcmodel=medany;",
122#
123# The effect is that `gcc -mno-app-regs' (for example) will append "alt"
124# to the directory name when searching for libraries or startup files and
125# `gcc -m32 -mcmodel=medany' (for example) will append "32/alt". Also note
126# that exclusion above is moot, unless the compiler had a default of -m32,
127# which would mean that all of the "alt" directories (not the 64/alt ones)
128# would be ignored (not generated, nor used) since the exclusion also
129# matches the multilib_default args.
130
131# Copy the positional parameters into variables.
132options=$1
133dirnames=$2
134matches=$3
135exceptions=$4
136extra=$5
137exclusions=$6
138osdirnames=$7
139multilib_required=$8
140multiarch=$9
141multilib_reuse=${10}
142enable_multilib=${11}
143
144echo "static const char *const multilib_raw[] = {"
145
146mkdir tmpmultilib.$$ || exit 1
147# Use cd ./foo to avoid CDPATH output.
148cd ./tmpmultilib.$$ || exit 1
149
150# What we want to do is select all combinations of the sets in
151# options.  Each combination which includes a set of mutually
152# exclusive options must then be output multiple times, once for each
153# item in the set.  Selecting combinations is a recursive process.
154# Since not all versions of sh support functions, we achieve recursion
155# by creating a temporary shell script which invokes itself.
156rm -f tmpmultilib
157cat >tmpmultilib <<\EOF
158#!/bin/sh
159# This recursive script basically outputs all combinations of its
160# input arguments, handling mutually exclusive sets of options by
161# repetition.  When the script is called, ${initial} is the list of
162# options which should appear before all combinations this will
163# output.  The output looks like a list of subdirectory names with
164# leading and trailing slashes.
165if [ "$#" != "0" ]; then
166  first=$1
167  shift
168  case "$first" in
169  *\|*)
170    all=${initial}`echo $first | sed -e 's_|_/_'g`
171    first=`echo $first | sed -e 's_|_ _'g`
172    echo ${all}/
173    initial="${initial}${all}/" ./tmpmultilib $@
174    ./tmpmultilib $first $@ | grep -v "^${all}"
175    ;;
176  *)
177    for opt in `echo $first | sed -e 's|/| |'g`; do
178      echo ${initial}${opt}/
179    done
180    ./tmpmultilib $@
181    for opt in `echo $first | sed -e 's|/| |'g`; do
182      initial="${initial}${opt}/" ./tmpmultilib $@
183    done
184  esac
185fi
186EOF
187chmod +x tmpmultilib
188
189combinations=`initial=/ ./tmpmultilib ${options}`
190
191# If there exceptions, weed them out now
192if [ -n "${exceptions}" ]; then
193  cat >tmpmultilib2 <<\EOF
194#!/bin/sh
195# This recursive script weeds out any combination of multilib
196# switches that should not be generated.  The output looks like
197# a list of subdirectory names with leading and trailing slashes.
198
199  for opt in $@; do
200    case "$opt" in
201EOF
202
203  for except in ${exceptions}; do
204    echo "      /${except}/) : ;;" >> tmpmultilib2
205  done
206
207cat >>tmpmultilib2 <<\EOF
208      *) echo ${opt};;
209    esac
210  done
211EOF
212  chmod +x tmpmultilib2
213  combinations=`./tmpmultilib2 ${combinations}`
214fi
215
216# If the MULTILIB_REQUIRED list are provided,
217# filter out combinations not in this list.
218if [ -n "${multilib_required}" ]; then
219  cat >tmpmultilib2 <<\EOF
220#!/bin/sh
221# This recursive script weeds out any combination of multilib
222# switches that not in the expected list.
223
224  for opt in $@; do
225    case "$opt" in
226EOF
227
228  for expect in ${multilib_required}; do
229    echo "      /${expect}/) echo \${opt};;" >> tmpmultilib2
230  done
231
232cat >>tmpmultilib2 <<\EOF
233      *) ;;
234    esac
235  done
236EOF
237
238   chmod +x tmpmultilib2
239   combinations=`./tmpmultilib2 ${combinations}`
240
241fi
242
243# Construct a sed pattern which will convert option names to directory
244# names.
245todirnames=
246if [ -n "${dirnames}" ]; then
247  set x ${dirnames}
248  shift
249  for set in ${options}; do
250    for opts in `echo ${set} | sed -e 's|/| |'g`; do
251      patt="/"
252      for opt in `echo ${opts} | sed -e 's_|_ _'g`; do
253        if [ "$1" != "${opt}" ]; then
254          todirnames="${todirnames} -e s|/${opt}/|/${1}/|g"
255	  patt="${patt}${1}/"
256	  if [ "${patt}" != "/${1}/" ]; then
257	    todirnames="${todirnames} -e s|${patt}|/${1}/|g"
258          fi
259        fi
260      done
261      shift
262    done
263  done
264fi
265
266# Construct a sed pattern which will convert option names to OS directory
267# names.
268toosdirnames=
269defaultosdirname=
270defaultosdirname2=
271if [ -n "${multiarch}" ]; then
272  defaultosdirname=::${multiarch}
273fi
274if [ -n "${osdirnames}" ]; then
275  set x ${osdirnames}
276  shift
277  while [ $# != 0 ] ; do
278    case "$1" in
279      .=*)
280        defaultosdirname=`echo $1 | sed 's|^.=|:|'`
281	if [ -n "${multiarch}" ]; then
282	  defaultosdirname=${defaultosdirname}:${multiarch}
283	fi
284	case "$defaultosdirname" in
285	  ::*) ;;
286	  *)
287	    defaultosdirname2=${defaultosdirname}
288	    defaultosdirname=
289	    ;;
290	esac
291	shift
292	;;
293      *=*)
294	patt=`echo $1 | sed -e 's|=|/$=/|'`
295        toosdirnames="${toosdirnames} -e s=^/${patt}/="
296	shift
297        ;;
298      *)
299        break
300	;;
301    esac
302  done
303
304  if [ $# != 0 ]; then
305    for set in ${options}; do
306      for opts in `echo ${set} | sed -e 's|/| |'g`; do
307        patt="/"
308        for opt in `echo ${opts} | sed -e 's_|_ _'g`; do
309          if [ "$1" != "${opt}" ]; then
310            toosdirnames="${toosdirnames} -e s|/${opt}/|/${1}/|g"
311	    patt="${patt}${1}/"
312	    if [ "${patt}" != "/${1}/" ]; then
313	      toosdirnames="${toosdirnames} -e s|${patt}|/${1}/|g"
314            fi
315          fi
316        done
317        shift
318      done
319    done
320  fi
321fi
322
323# We need another recursive shell script to correctly handle positive
324# matches.  If we are invoked as
325#   genmultilib "opt1 opt2" "" "opt1=nopt1 opt2=nopt2"
326# we must output
327#   opt1/opt2 opt1 opt2
328#   opt1/opt2 nopt1 opt2
329#   opt1/opt2 opt1 nopt2
330#   opt1/opt2 nopt1 nopt2
331# In other words, we must output all combinations of matches.
332rm -f tmpmultilib2
333cat >tmpmultilib2 <<\EOF
334#!/bin/sh
335# The positional parameters are a list of matches to consider.
336# ${dirout} is the directory name and ${optout} is the current list of
337# options.
338if [ "$#" = "0" ]; then
339  echo "\"${dirout} ${optout};\","
340else
341  first=$1
342  shift
343  dirout="${dirout}" optout="${optout}" ./tmpmultilib2 $@
344  l=`echo ${first} | sed -e 's/=.*$//' -e 's/?/=/g'`
345  r=`echo ${first} | sed -e 's/^.*=//' -e 's/?/=/g'`
346  if expr " ${optout} " : ".* ${l} .*" > /dev/null; then
347    newopt=`echo " ${optout} " | sed -e "s/ ${l} / ${r} /" -e 's/^ //' -e 's/ $//'`
348    dirout="${dirout}" optout="${newopt}" ./tmpmultilib2 $@
349  fi
350fi
351EOF
352chmod +x tmpmultilib2
353
354# Start with the current directory, which includes only negations.
355optout=
356for set in ${options}; do
357  for opt in `echo ${set} | sed -e 's_[/|]_ _g'`; do
358    optout="${optout} !${opt}"
359  done
360done
361optout=`echo ${optout} | sed -e 's/^ //'`
362echo "\".${defaultosdirname} ${optout};\","
363[ -n "${defaultosdirname2}" ] && echo "\".${defaultosdirname2} ${optout};\","
364
365# This part of code convert an option combination to
366# its corresponding directory names.
367# The directory names will be deduced from MULTILIB_DIRNAMES,
368# MULTILIB_OSDIRNAMES or the option combination itself.
369rm -rf tmpmultilib3
370cat >tmpmultilib3 <<\EOF
371#!/bin/sh
372
373dirout=
374combo=$1
375todirnames=$2
376toosdirnames=$3
377enable_multilib=$4
378
379if [ -n "${todirnames}" ]; then
380  dirout=`echo ${combo} | sed ${todirnames}`
381else
382  dirout=`echo ${combo} | sed -e 's/=/-/g'`
383fi
384# Remove the leading and trailing slashes.
385dirout=`echo ${dirout} | sed -e 's|^/||' -e 's|/*:/*|:|' -e 's|/$||g'`
386
387# Use the OS directory names rather than the option names.
388if [ -n "${toosdirnames}" ]; then
389  osdirout=`echo ${combo} | sed ${toosdirnames}`
390  # Remove the leading and trailing slashes.
391  osdirout=`echo ${osdirout} | sed -e 's|^/||' -e 's|/*:/*|:|' -e 's|/$||g'`
392  if [ "x${enable_multilib}" != xyes ]; then
393    dirout=".:${osdirout}"
394    disable_multilib=yes
395  else
396    case "${osdirout}" in
397      !*)
398	dirout=`echo ${osdirout} | sed 's/^!//'`
399	;;
400       *)
401	dirout="${dirout}:${osdirout}"
402	;;
403    esac
404  fi
405else
406  if [ "x${enable_multilib}" != xyes ]; then
407    # genmultilib with --disable-multilib should be
408    # called with '' '' '' '' '' '' '' no
409    # if MULTILIB_OSDIRNAMES is empty.
410    exit 1
411  fi
412fi
413echo "${dirout}"
414EOF
415chmod +x tmpmultilib3
416
417# Script to look through the options and output each option that is present,
418# and negate each option that is not present.
419rm -rf tmpmultilib4
420cat > tmpmultilib4 <<\EOF
421#!/bin/sh
422
423optout=
424combo=$1
425options=$2
426
427for set in ${options}; do
428  setopts=`echo ${set} | sed -e 's_[/|]_ _g'`
429  for opt in ${setopts}; do
430    if expr "${combo} " : ".*/${opt}/.*" > /dev/null; then
431      optout="${optout} ${opt}"
432    else
433      optout="${optout} !${opt}"
434    fi
435  done
436done
437optout=`echo ${optout} | sed -e 's/^ //'`
438echo "${optout}"
439EOF
440chmod +x tmpmultilib4
441
442# Work over the list of combinations.  We have to translate each one
443# to use the directory names rather than the option names, we have to
444# include the information in matches, and we have to generate the
445# correct list of options and negations.
446for combo in ${combinations}; do
447  # Use the directory names rather than the option names.
448  dirout=`./tmpmultilib3 "${combo}" "${todirnames}" "${toosdirnames}" "${enable_multilib}"`
449
450  # Look through the options.  We must output each option that is
451  # present, and negate each option that is not present.
452  optout=`./tmpmultilib4 "${combo}" "${options}"`
453
454  # Output the line with all appropriate matches.
455  dirout="${dirout}" optout="${optout}" ./tmpmultilib2
456done
457
458# Terminate the list of string.
459echo "NULL"
460echo "};"
461
462# Generate a regular expression to validate option combinations.
463options_re=
464for set in ${options}; do
465  for opt in `echo ${set} | sed -e 's_[/|]_ _g' -e 's/+/./g' `; do
466    options_re="${options_re}${options_re:+|}${opt}"
467  done
468done
469options_re="^/((${options_re})/)*\$"
470
471# Output rules used for multilib reuse.
472echo ""
473echo "static const char *const multilib_reuse_raw[] = {"
474for rrule in ${multilib_reuse}; do
475  # The left part of the rule are the options we used to build multilib.
476  # The right part of the rule are the options that can reuse this multilib.
477  combo=`echo ${rrule} | sed -e 's/=.*$//' -e 's/\([^\\]\)\./\1=/g' -e 's/\\\././g'`
478  copts=`echo ${rrule} | sed -e 's/^.*=//' -e 's/\([^\\]\)\./\1=/g' -e 's/\\\././g'`
479  # The variable ${combinations} are the option combinations we will build
480  # multilib from.  If the combination in the left part of reuse rule isn't
481  # in this variable, it means no multilib will be built for current reuse
482  # rule.  Thus the reuse purpose specified by current rule is meaningless.
483  if expr "${combinations} " : ".*/${combo}/.*" > /dev/null; then
484    if echo "/${copts}/" | grep -E "${options_re}" > /dev/null; then
485      combo="/${combo}/"
486      dirout=`./tmpmultilib3 "${combo}" "${todirnames}" "${toosdirnames}" "${enable_multilib}"`
487      copts="/${copts}/"
488      optout=`./tmpmultilib4 "${copts}" "${options}"`
489      # Output the line with all appropriate matches.
490      dirout="${dirout}" optout="${optout}" ./tmpmultilib2
491    else
492      echo "The rule ${rrule} contains an option absent from MULTILIB_OPTIONS." >&2
493      exit 1
494    fi
495  else
496    echo "The rule ${rrule} is trying to reuse nonexistent multilib." >&2
497    exit 1
498  fi
499done
500
501# Terminate the list of string.
502echo "NULL"
503echo "};"
504
505# Output all of the matches now as option and that is the same as that, with
506# a semicolon trailer.  Include all of the normal options as well.
507# Note, the format of the matches is reversed compared
508# to what we want, so switch them around.
509echo ""
510echo "static const char *const multilib_matches_raw[] = {"
511for match in ${matches}; do
512  l=`echo ${match} | sed -e 's/=.*$//' -e 's/?/=/g'`
513  r=`echo ${match} | sed -e 's/^.*=//' -e 's/?/=/g'`
514  echo "\"${r} ${l};\","
515done
516for set in ${options}; do
517  for opt in `echo ${set} | sed -e 's_[/|]_ _'g`; do
518    echo "\"${opt} ${opt};\","
519  done
520done
521echo "NULL"
522echo "};"
523
524# Output the default options now
525echo ""
526echo "static const char *multilib_extra = \"${extra}\";"
527
528# Output the exclusion rules now
529echo ""
530echo "static const char *const multilib_exclusions_raw[] = {"
531for rule in ${exclusions}; do
532  s=`echo ${rule} | sed -e 's,/, ,g'`
533  echo "\"${s};\","
534done
535echo "NULL"
536echo "};"
537
538# Output the options now
539moptions=`echo ${options} | sed -e 's,[ 	][ 	]*, ,g'`
540echo ""
541echo "static const char *multilib_options = \"${moptions}\";"
542
543# Finally output the disable flag if specified
544if [ "x${disable_multilib}" = xyes ]; then
545  echo ""
546  echo "#define DISABLE_MULTILIB  1"
547fi
548
549cd ..
550rm -r tmpmultilib.$$
551
552exit 0
553