gdb: Extend the comments in c-exp.y
[external/binutils.git] / opcodes / cgen.sh
1 #! /bin/sh
2 # CGEN generic assembler support code.
3 #
4 #   Copyright (C) 2000-2018 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 header="/* DO NOT EDIT!  -*- buffer-read-only: t -*- vi:set ro:  */"
86
87 case $action in
88 opcodes)
89         # Remove residual working files.
90         rm -f ${tmp}-desc.h ${tmp}-desc.h1
91         rm -f ${tmp}-desc.c ${tmp}-desc.c1
92         rm -f ${tmp}-opc.h ${tmp}-opc.h1
93         rm -f ${tmp}-opc.c ${tmp}-opc.c1
94         rm -f ${tmp}-opinst.c ${tmp}-opinst.c1
95         rm -f ${tmp}-ibld.h ${tmp}-ibld.h1
96         rm -f ${tmp}-ibld.c ${tmp}-ibld.in1
97         rm -f ${tmp}-asm.c ${tmp}-asm.in1
98         rm -f ${tmp}-dis.c ${tmp}-dis.in1
99
100         # Run CGEN.
101         ${cgen} ${cgendir}/cgen-opc.scm \
102                 -s ${cgendir} \
103                 ${cgenflags} \
104                 -f "${options}" \
105                 -m all \
106                 -a ${archfile} \
107                 -OPC ${opcfile} \
108                 -H ${tmp}-desc.h1 \
109                 -C ${tmp}-desc.c1 \
110                 -O ${tmp}-opc.h1 \
111                 -P ${tmp}-opc.c1 \
112                 -L ${tmp}-ibld.in1 \
113                 -A ${tmp}-asm.in1 \
114                 -D ${tmp}-dis.in1 \
115                 ${extrafile_args}
116
117         # Customise generated files for the particular architecture.
118         sed -e "1i$header" \
119             -e "s/@ARCH@/${ARCH}/g" -e "s/@arch@/${arch}/g" \
120             -e 's/[     ][      ]*$//' < ${tmp}-desc.h1 > ${tmp}-desc.h
121         ${rootdir}/move-if-change ${tmp}-desc.h ${srcdir}/${prefix}-desc.h
122
123         sed -e "1i$header" \
124             -e "s/@ARCH@/${ARCH}/g" -e "s/@arch@/${arch}/g" \
125             -e "s/@prefix@/${prefix}/" -e 's/[  ][      ]*$//' \
126             < ${tmp}-desc.c1 > ${tmp}-desc.c
127         ${rootdir}/move-if-change ${tmp}-desc.c ${srcdir}/${prefix}-desc.c
128
129         sed -e "1i$header" \
130             -e "s/@ARCH@/${ARCH}/g" -e "s/@arch@/${arch}/g" \
131             -e 's/[     ][      ]*$//' < ${tmp}-opc.h1 > ${tmp}-opc.h
132         ${rootdir}/move-if-change ${tmp}-opc.h ${srcdir}/${prefix}-opc.h
133
134         sed -e "1i$header" \
135             -e "s/@ARCH@/${ARCH}/g" -e "s/@arch@/${arch}/g" \
136             -e "s/@prefix@/${prefix}/" -e 's/[  ][      ]*$//' \
137             < ${tmp}-opc.c1 > ${tmp}-opc.c
138         ${rootdir}/move-if-change ${tmp}-opc.c ${srcdir}/${prefix}-opc.c
139
140         case $extrafiles in
141         *opinst*)
142           sed -e "1i$header" \
143               -e "s/@ARCH@/${ARCH}/g" -e "s/@arch@/${arch}/g" \
144               -e "s/@prefix@/${prefix}/" -e 's/[        ][      ]*$//' \
145               < ${tmp}-opinst.c1 >${tmp}-opinst.c
146           ${rootdir}/move-if-change ${tmp}-opinst.c ${srcdir}/${prefix}-opinst.c
147           ;;
148         esac
149
150         cat ${srcdir}/cgen-ibld.in ${tmp}-ibld.in1 | \
151           sed -e "1i$header" \
152             -e "s/@ARCH@/${ARCH}/g" -e "s/@arch@/${arch}/g" \
153             -e "s/@prefix@/${prefix}/" -e 's/[  ][      ]*$//' > ${tmp}-ibld.c
154         ${rootdir}/move-if-change ${tmp}-ibld.c ${srcdir}/${prefix}-ibld.c
155
156         sed -e "/ -- assembler routines/ r ${tmp}-asm.in1" ${srcdir}/cgen-asm.in \
157           | sed -e "1i$header" \
158                 -e "s/@ARCH@/${ARCH}/g" -e "s/@arch@/${arch}/g" \
159                 -e "s/@prefix@/${prefix}/" -e 's/[      ][      ]*$//' \
160           > ${tmp}-asm.c
161         ${rootdir}/move-if-change ${tmp}-asm.c ${srcdir}/${prefix}-asm.c
162
163         sed -e "/ -- disassembler routines/ r ${tmp}-dis.in1" ${srcdir}/cgen-dis.in \
164           | sed -e "1i$header" \
165                 -e "s/@ARCH@/${ARCH}/g" -e "s/@arch@/${arch}/g" \
166                 -e "s/@prefix@/${prefix}/" -e 's/[      ][      ]*$//' \
167           > ${tmp}-dis.c
168         ${rootdir}/move-if-change ${tmp}-dis.c ${srcdir}/${prefix}-dis.c
169
170         # Remove temporary files.
171         rm -f ${tmp}-desc.h1 ${tmp}-desc.c1
172         rm -f ${tmp}-opc.h1 ${tmp}-opc.c1
173         rm -f ${tmp}-opinst.c1
174         rm -f ${tmp}-ibld.h1 ${tmp}-ibld.in1
175         rm -f ${tmp}-asm.in1 ${tmp}-dis.in1
176         ;;
177
178 *)
179         echo "$0: bad action: ${action}" >&2
180         exit 1
181         ;;
182
183 esac
184
185 exit 0