S/390: Improve error checking for optional operands
[external/binutils.git] / opcodes / cgen.sh
1 #! /bin/sh
2 # CGEN generic assembler support code.
3 #
4 #   Copyright (C) 2000-2017 Free Software Foundation, Inc.
5 #
6 #   This file is part of the GNU opcodes library.
7 #
8 #   This library is free software; you can redistribute it and/or modify
9 #   it under the terms of the GNU General Public License as published by
10 #   the Free Software Foundation; either version 3, or (at your option)
11 #   any later version.
12 #
13 #   It is distributed in the hope that it will be useful, but WITHOUT
14 #   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 #   or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
16 #   License for more details.
17 #
18 #   You should have received a copy of the GNU General Public License along
19 #   with this program; if not, write to the Free Software Foundation, Inc.,
20 #   51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.  */
21 #
22 # Generate CGEN opcode files: arch-desc.[ch], arch-opc.[ch],
23 # arch-asm.c, arch-dis.c, arch-opinst.c, arch-ibld.[ch].
24 #
25 # Usage:
26 # cgen.sh action srcdir cgen cgendir cgenflags arch prefix \
27 #         arch-file opc-file options [extrafiles]
28 #
29 # ACTION is currently always "opcodes". It exists to be consistent with the
30 # simulator.
31 # ARCH is the name of the architecture.
32 # It is substituted into @arch@ and @ARCH@ in the generated files.
33 # PREFIX is both the generated file prefix and is substituted into
34 # @prefix@ in the generated files.
35 # ARCH-FILE is the name of the .cpu file (including path).
36 # OPC-FILE is the name of the .opc file (including path).
37 # OPTIONS is comma separated list of options (???).
38 # EXTRAFILES is a space separated list (1 arg still) of extra files to build:
39 #       - opinst - arch-opinst.c is being made, causes semantic analysis
40 #
41 # We store the generated files in the source directory until we decide to
42 # ship a Scheme interpreter (or other implementation) with gdb/binutils.
43 # Maybe we never will.
44
45 # We want to behave like make, any error forces us to stop.
46 set -e
47
48 action=$1
49 srcdir=$2
50 cgen="$3"
51 cgendir=$4
52 cgenflags=$5
53 arch=$6
54 prefix=$7
55 archfile=$8
56 opcfile=$9
57 shift ; options=$9
58
59 # List of extra files to build.
60 # Values: opinst (only 1 extra file at present)
61 shift ; extrafiles=$9
62
63 rootdir=${srcdir}/..
64
65 # $arch is $6, as passed on the command line.
66 # $ARCH is the same argument but in all uppercase.
67 # Both forms are used in this script.
68
69 lowercase='abcdefghijklmnopqrstuvwxyz'
70 uppercase='ABCDEFGHIJKLMNOPQRSTUVWXYZ'
71 ARCH=`echo ${arch} | tr "${lowercase}" "${uppercase}"`
72
73 # Allow parallel makes to run multiple cgen's without colliding.
74 tmp=tmp-$$
75
76 extrafile_args=""
77 for ef in .. $extrafiles
78 do
79     case $ef in
80     ..) ;;
81     opinst) extrafile_args="-Q ${tmp}-opinst.c1 $extrafile_args" ;;
82     esac
83 done
84
85 case $action in
86 opcodes)
87         # Remove residual working files.
88         rm -f ${tmp}-desc.h ${tmp}-desc.h1
89         rm -f ${tmp}-desc.c ${tmp}-desc.c1
90         rm -f ${tmp}-opc.h ${tmp}-opc.h1
91         rm -f ${tmp}-opc.c ${tmp}-opc.c1
92         rm -f ${tmp}-opinst.c ${tmp}-opinst.c1
93         rm -f ${tmp}-ibld.h ${tmp}-ibld.h1
94         rm -f ${tmp}-ibld.c ${tmp}-ibld.in1
95         rm -f ${tmp}-asm.c ${tmp}-asm.in1
96         rm -f ${tmp}-dis.c ${tmp}-dis.in1
97
98         # Run CGEN.
99         ${cgen} ${cgendir}/cgen-opc.scm \
100                 -s ${cgendir} \
101                 ${cgenflags} \
102                 -f "${options}" \
103                 -m all \
104                 -a ${archfile} \
105                 -OPC ${opcfile} \
106                 -H ${tmp}-desc.h1 \
107                 -C ${tmp}-desc.c1 \
108                 -O ${tmp}-opc.h1 \
109                 -P ${tmp}-opc.c1 \
110                 -L ${tmp}-ibld.in1 \
111                 -A ${tmp}-asm.in1 \
112                 -D ${tmp}-dis.in1 \
113                 ${extrafile_args}
114
115         # Customise generated files for the particular architecture.
116         sed -e "s/@ARCH@/${ARCH}/g" -e "s/@arch@/${arch}/g" \
117             -e 's/[     ][      ]*$//' < ${tmp}-desc.h1 > ${tmp}-desc.h
118         ${rootdir}/move-if-change ${tmp}-desc.h ${srcdir}/${prefix}-desc.h
119
120         sed -e "s/@ARCH@/${ARCH}/g" -e "s/@arch@/${arch}/g" \
121             -e "s/@prefix@/${prefix}/" -e 's/[  ][      ]*$//' \
122             < ${tmp}-desc.c1 > ${tmp}-desc.c
123         ${rootdir}/move-if-change ${tmp}-desc.c ${srcdir}/${prefix}-desc.c
124
125         sed -e "s/@ARCH@/${ARCH}/g" -e "s/@arch@/${arch}/g" \
126             -e 's/[     ][      ]*$//' < ${tmp}-opc.h1 > ${tmp}-opc.h
127         ${rootdir}/move-if-change ${tmp}-opc.h ${srcdir}/${prefix}-opc.h
128
129         sed -e "s/@ARCH@/${ARCH}/g" -e "s/@arch@/${arch}/g" \
130             -e "s/@prefix@/${prefix}/" -e 's/[  ][      ]*$//' \
131             < ${tmp}-opc.c1 > ${tmp}-opc.c
132         ${rootdir}/move-if-change ${tmp}-opc.c ${srcdir}/${prefix}-opc.c
133
134         case $extrafiles in
135         *opinst*)
136           sed -e "s/@ARCH@/${ARCH}/g" -e "s/@arch@/${arch}/g" \
137               -e "s/@prefix@/${prefix}/" -e 's/[        ][      ]*$//' \
138               < ${tmp}-opinst.c1 >${tmp}-opinst.c
139           ${rootdir}/move-if-change ${tmp}-opinst.c ${srcdir}/${prefix}-opinst.c
140           ;;
141         esac
142
143         cat ${srcdir}/cgen-ibld.in ${tmp}-ibld.in1 | \
144           sed -e "s/@ARCH@/${ARCH}/g" -e "s/@arch@/${arch}/g" \
145             -e "s/@prefix@/${prefix}/" -e 's/[  ][      ]*$//' > ${tmp}-ibld.c
146         ${rootdir}/move-if-change ${tmp}-ibld.c ${srcdir}/${prefix}-ibld.c
147
148         sed -e "/ -- assembler routines/ r ${tmp}-asm.in1" ${srcdir}/cgen-asm.in \
149           | sed -e "s/@ARCH@/${ARCH}/g" -e "s/@arch@/${arch}/g" \
150                 -e "s/@prefix@/${prefix}/" -e 's/[      ][      ]*$//' \
151           > ${tmp}-asm.c
152         ${rootdir}/move-if-change ${tmp}-asm.c ${srcdir}/${prefix}-asm.c
153
154         sed -e "/ -- disassembler routines/ r ${tmp}-dis.in1" ${srcdir}/cgen-dis.in \
155           | sed -e "s/@ARCH@/${ARCH}/g" -e "s/@arch@/${arch}/g" \
156                 -e "s/@prefix@/${prefix}/" -e 's/[      ][      ]*$//' \
157           > ${tmp}-dis.c
158         ${rootdir}/move-if-change ${tmp}-dis.c ${srcdir}/${prefix}-dis.c
159
160         # Remove temporary files.
161         rm -f ${tmp}-desc.h1 ${tmp}-desc.c1
162         rm -f ${tmp}-opc.h1 ${tmp}-opc.c1
163         rm -f ${tmp}-opinst.c1
164         rm -f ${tmp}-ibld.h1 ${tmp}-ibld.in1
165         rm -f ${tmp}-asm.in1 ${tmp}-dis.in1
166         ;;
167
168 *)
169         echo "$0: bad action: ${action}" >&2
170         exit 1
171         ;;
172
173 esac
174
175 exit 0