1# Copyright (C) 2007-2024 Free Software Foundation, Inc.
2
3# This file is part of GDB.
4
5# This program is free software; you can redistribute it and/or modify
6# it under the terms of the GNU General Public License as published by
7# the Free Software Foundation; either version 3 of the License, or
8# (at your option) any later version.
9#
10# This program is distributed in the hope that it will be useful,
11# but WITHOUT ANY WARRANTY; without even the implied warranty of
12# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13# GNU General Public License for more details.
14#
15# You should have received a copy of the GNU General Public License
16# along with this program.  If not, see <http://www.gnu.org/licenses/>.
17
18
19# This file requires GNU make!
20
21# This Makefile updates files in ../regformats from their XML master
22# copies.  Because this relies on xsltproc, it is not normally run
23# during the build process; it should be run by hand when one of the
24# affected XML files is changed, and the results should be kept in the
25# GDB repository.
26
27# It can also update the C files in the features directory from their
28# XML master copies.  This relies on a GDB linked with expat and that
29# is configured to include support for the architecture, so the files
30# are kept in the GDB repository.
31#
32# By default we'll generate all C files, and you must point make at a
33# GDB that has been configured with --enable-targets=all:
34#
35#   make GDB=/path/to/gdb cfiles
36#
37# To regenerate all C files from scratch:
38#
39#   make GDB=/path/to/gdb clean-cfiles cfiles
40#
41# To generate specific C files, you can override the XMLTOC and
42# FEATURE_XMLFILES make variables:
43#
44#   make GDB=/path/to/gdb XMLTOC="xml files" FEATURE_XMLFILES="xml files" cfiles
45
46# List of .dat files to create in ../regformats/
47WHICH = mips-linux mips-dsp-linux \
48          mips64-linux mips64-dsp-linux \
49          nios2-linux \
50          or1k-linux \
51          rs6000/powerpc-32 \
52          rs6000/powerpc-32l rs6000/powerpc-altivec32l rs6000/powerpc-e500l \
53          rs6000/powerpc-64l rs6000/powerpc-altivec64l rs6000/powerpc-vsx32l \
54          rs6000/powerpc-vsx64l \
55          rs6000/powerpc-isa205-32l rs6000/powerpc-isa205-64l \
56          rs6000/powerpc-isa205-altivec32l rs6000/powerpc-isa205-altivec64l \
57          rs6000/powerpc-isa205-vsx32l rs6000/powerpc-isa205-vsx64l \
58          rs6000/powerpc-isa205-ppr-dscr-vsx32l \
59          rs6000/powerpc-isa205-ppr-dscr-vsx64l \
60          rs6000/powerpc-isa207-vsx32l rs6000/powerpc-isa207-vsx64l \
61          rs6000/powerpc-isa207-htm-vsx32l \
62          rs6000/powerpc-isa207-htm-vsx64l \
63          s390-linux32 s390-linux64 s390x-linux64 \
64          s390-linux32v1 s390-linux64v1 s390x-linux64v1 \
65          s390-linux32v2 s390-linux64v2 s390x-linux64v2 \
66          s390-te-linux64 s390x-te-linux64 s390-vx-linux64 s390x-vx-linux64 \
67          s390-tevx-linux64 s390x-tevx-linux64 \
68          s390-gs-linux64 s390x-gs-linux64 \
69          tic6x-c64xp-linux tic6x-c64x-linux tic6x-c62x-linux
70
71# Record which registers should be sent to GDB by default after stop.
72mips-expedite = r29,pc
73mips-dsp-expedite = r29,pc
74mips64-expedite = r29,pc
75mips64-dsp-expedite = r29,pc
76nios2-linux-expedite = sp,pc
77or1k-expedite = r1,npc
78powerpc-expedite = r1,pc
79s390-linux32-expedite = r14,r15,pswa
80s390-linux32v1-expedite = r14,r15,pswa
81s390-linux32v2-expedite = r14,r15,pswa
82s390-linux64-expedite = r14l,r15l,pswa
83s390-linux64v1-expedite = r14l,r15l,pswa
84s390-linux64v2-expedite = r14l,r15l,pswa
85s390-te-linux64-expedite = r14l,r15l,pswa
86s390-vx-linux64-expedite = r14l,r15l,pswa
87s390-tevx-linux64-expedite = r14l,r15l,pswa
88s390-gs-linux64-expedite = r14,r15,pswa
89s390x-expedite = r14,r15,pswa
90tic6x-expedite = A15,PC
91
92
93XSLTPROC = xsltproc
94outdir = ../regformats
95OUTPUTS = $(patsubst %,$(outdir)/%.dat,$(WHICH))
96
97# For targets without feature based target descriptions,
98# the set of xml files we'll generate .c files for GDB from.  By
99# default we'll build all .c files, which requires an
100# --enable-targets=all GDB.  You can override this by passing XMLTOC
101# to make on the command line.
102XMLTOC = \
103          microblaze-with-stack-protect.xml \
104          microblaze.xml \
105          mips-dsp-linux.xml \
106          mips-linux.xml \
107          mips64-dsp-linux.xml \
108          mips64-linux.xml \
109          nds32.xml \
110          nios2.xml \
111          or1k.xml \
112          or1k-linux.xml \
113          rs6000/powerpc-32.xml \
114          rs6000/powerpc-32l.xml \
115          rs6000/powerpc-403.xml \
116          rs6000/powerpc-403gc.xml \
117          rs6000/powerpc-405.xml \
118          rs6000/powerpc-505.xml \
119          rs6000/powerpc-601.xml \
120          rs6000/powerpc-602.xml \
121          rs6000/powerpc-603.xml \
122          rs6000/powerpc-604.xml \
123          rs6000/powerpc-64.xml \
124          rs6000/powerpc-64l.xml \
125          rs6000/powerpc-7400.xml \
126          rs6000/powerpc-750.xml \
127          rs6000/powerpc-860.xml \
128          rs6000/powerpc-altivec32.xml \
129          rs6000/powerpc-altivec32l.xml \
130          rs6000/powerpc-altivec64.xml \
131          rs6000/powerpc-altivec64l.xml \
132          rs6000/powerpc-e500.xml \
133          rs6000/powerpc-e500l.xml \
134          rs6000/powerpc-isa205-32l.xml \
135          rs6000/powerpc-isa205-64l.xml \
136          rs6000/powerpc-isa205-altivec32l.xml \
137          rs6000/powerpc-isa205-altivec64l.xml \
138          rs6000/powerpc-isa205-vsx32l.xml \
139          rs6000/powerpc-isa205-vsx64l.xml \
140          rs6000/powerpc-isa205-ppr-dscr-vsx32l.xml \
141          rs6000/powerpc-isa205-ppr-dscr-vsx64l.xml \
142          rs6000/powerpc-isa207-vsx32l.xml \
143          rs6000/powerpc-isa207-vsx64l.xml \
144          rs6000/powerpc-isa207-htm-vsx32l.xml \
145          rs6000/powerpc-isa207-htm-vsx64l.xml \
146          rs6000/powerpc-vsx32.xml \
147          rs6000/powerpc-vsx32l.xml \
148          rs6000/powerpc-vsx64.xml \
149          rs6000/powerpc-vsx64l.xml \
150          rs6000/rs6000.xml \
151          rx.xml \
152          s390-linux32.xml \
153          s390-linux32v1.xml \
154          s390-linux32v2.xml \
155          s390-linux64.xml \
156          s390-linux64v1.xml \
157          s390-linux64v2.xml \
158          s390-te-linux64.xml \
159          s390x-linux64.xml \
160          s390x-linux64v1.xml \
161          s390x-linux64v2.xml \
162          s390x-te-linux64.xml \
163          s390-tevx-linux64.xml \
164          s390-vx-linux64.xml \
165          s390x-tevx-linux64.xml \
166          s390x-vx-linux64.xml \
167          s390-gs-linux64.xml \
168          s390x-gs-linux64.xml \
169          sparc/sparc32-solaris.xml \
170          sparc/sparc64-solaris.xml \
171          z80.xml
172
173TDESC_CFILES = $(patsubst %.xml,%.c,$(XMLTOC))
174GDB = false
175
176#Targets which use feature based target descriptions.
177aarch64-feature = 1
178arm-feature = 1
179i386-feature = 1
180loongarch-feature = 1
181riscv-feature = 1
182tic6x-feature = 1
183
184all: $(OUTPUTS)
185
186$(outdir)/%.dat: %.xml number-regs.xsl sort-regs.xsl gdbserver-regs.xsl
187          echo "# THIS FILE IS GENERATED.  -*- buffer-read-only: t -*- vi :set ro:" > $(outdir)/$*.tmp
188          echo "# Generated from: $<" >> $(outdir)/$*.tmp
189          echo "name:`echo $(notdir $*) | sed 's/-/_/g'`" >> $(outdir)/$*.tmp
190          $(if $($(firstword $(subst /, ,$(subst -, ,$*)))-feature), echo "feature:1") >> $(outdir)/$*.tmp
191          echo "xmltarget:$(<F)" >> $(outdir)/$*.tmp
192          echo "expedite:$(if $($*-expedite),$($*-expedite),$($(firstword $(subst -, ,$(notdir $*)))-expedite))" \
193            >> $(outdir)/$*.tmp
194          $(XSLTPROC) --path "$(PWD)" --xinclude number-regs.xsl $< | \
195            $(XSLTPROC) sort-regs.xsl - | \
196            $(XSLTPROC) gdbserver-regs.xsl - >> $(outdir)/$*.tmp
197          sh ../../move-if-change $(outdir)/$*.tmp $(outdir)/$*.dat
198
199# For targets with feature based target descriptions,
200# the set of xml files we'll generate .c files for GDB from.
201FEATURE_XMLFILES = aarch64-core.xml \
202          aarch64-fpu.xml \
203          aarch64-pauth.xml \
204          aarch64-mte.xml \
205          arc/v1-core.xml \
206          arc/v1-aux.xml \
207          arc/v2-core.xml \
208          arc/v2-aux.xml \
209          arm/arm-core.xml \
210          arm/arm-fpa.xml \
211          arm/arm-m-profile.xml \
212          arm/arm-m-profile-mve.xml \
213          arm/arm-m-system.xml \
214          arm/arm-m-profile-with-fpa.xml \
215          arm/arm-secext.xml \
216          arm/arm-tls.xml \
217          arm/arm-vfpv2.xml \
218          arm/arm-vfpv3.xml \
219          arm/xscale-iwmmxt.xml \
220          cskyv2-linux.xml \
221          i386/32bit-core.xml \
222          i386/32bit-sse.xml \
223          i386/32bit-linux.xml \
224          i386/32bit-avx.xml \
225          i386/32bit-mpx.xml \
226          i386/32bit-avx512.xml \
227          i386/32bit-segments.xml \
228          i386/64bit-avx512.xml \
229          i386/64bit-core.xml \
230          i386/64bit-mpx.xml \
231          i386/64bit-segments.xml \
232          i386/64bit-avx.xml \
233          i386/64bit-linux.xml \
234          i386/64bit-sse.xml \
235          i386/pkeys.xml \
236          i386/x32-core.xml \
237          loongarch/base32.xml \
238          loongarch/base64.xml \
239          loongarch/fpu.xml \
240          loongarch/lsx.xml \
241          loongarch/lasx.xml \
242          loongarch/lbt.xml \
243          riscv/rv32e-xregs.xml \
244          riscv/32bit-cpu.xml \
245          riscv/32bit-fpu.xml \
246          riscv/64bit-cpu.xml \
247          riscv/64bit-fpu.xml \
248          tic6x-c6xp.xml \
249          tic6x-core.xml \
250          tic6x-gp.xml
251
252FEATURE_CFILES = $(patsubst %.xml,%.c,$(FEATURE_XMLFILES))
253
254cfiles: $(TDESC_CFILES) $(FEATURE_CFILES)
255
256$(TDESC_CFILES): %.c: %.xml
257          $(GDB) -nx -q -batch -ex 'maint print c-tdesc $<' > $@.tmp
258          sh ../../move-if-change $@.tmp $@
259
260$(FEATURE_CFILES): %.c: %.xml.tmp
261          $(GDB) -nx -q -batch \
262            -ex 'maint print c-tdesc -single-feature $<' > $@.tmp
263          sh ../../move-if-change $@.tmp $@
264          rm $<
265
266# %.xml is the XML file for each target description feature, and
267# %.xml.tmp is the XML file target description which only includes
268# one target description feature.
269
270%.xml.tmp: %.xml
271          echo "<?xml version=\"1.0\"?>" > $@.tmp
272          echo "<!DOCTYPE target SYSTEM \"gdb-target.dtd\">" >> $@.tmp
273          echo "<target>" >> $@.tmp
274          echo "  <xi:include href=\"$(notdir $<)\"/>" >> $@.tmp
275          echo "</target>" >> $@.tmp
276          sh ../../move-if-change $@.tmp $@
277
278# 'all' doesn't build the C files, so don't delete them in 'clean'
279# either.
280clean-cfiles:
281          rm -f $(TDESC_CFILES) $(FEATURE_CFILES)
282
283clean:
284          rm -f $(OUTPUTS)
285