1/* Declarations for rtx-reader support for gen* routines.
2 Copyright (C) 2000-2023 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
8Software Foundation; either version 3, or (at your option) any later
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14for more details.
15
16You should have received a copy of the GNU General Public License
17along with GCC; see the file COPYING3. If not see
18<http://www.gnu.org/licenses/>. */
19
20#ifndef GCC_GENSUPPORT_H
21#define GCC_GENSUPPORT_H
22
23#include "hash-set.h"
24#include "read-md.h"
25
26struct obstack;
27extern struct obstack *rtl_obstack;
28
29/* Information about an .md define_* rtx. */
30class md_rtx_info {
31public:
32 /* The rtx itself. */
33 rtx def;
34
35 /* The location of the first line of the rtx. */
36 file_location loc;
37
38 /* The unique number attached to the rtx. Currently all define_insns,
39 define_expands, define_splits, define_peepholes and define_peephole2s
40 share the same insn_code index space. */
41 int index;
42};
43
44#define OPTAB_CL(name, pat, c, b, l) name,
45#define OPTAB_CX(name, pat)
46#define OPTAB_CD(name, pat) name,
47#define OPTAB_NL(name, pat, c, b, s, l) name,
48#define OPTAB_NC(name, pat, c) name,
49#define OPTAB_NX(name, pat)
50#define OPTAB_VL(name, pat, c, b, s, l) name,
51#define OPTAB_VC(name, pat, c) name,
52#define OPTAB_VX(name, pat)
53#define OPTAB_DC(name, pat, c) name,
54#define OPTAB_D(name, pat) name,
55
56/* Enumerates all optabs. */
57typedef enum optab_tag {
58 unknown_optab,
59#include "optabs.def"
60 NUM_OPTABS
61} optab;
62
63#undef OPTAB_CL
64#undef OPTAB_CX
65#undef OPTAB_CD
66#undef OPTAB_NL
67#undef OPTAB_NC
68#undef OPTAB_NX
69#undef OPTAB_VL
70#undef OPTAB_VC
71#undef OPTAB_VX
72#undef OPTAB_DC
73#undef OPTAB_D
74
75/* Describes one entry in optabs.def. */
76struct optab_def
77{
78 /* The name of the optab (e.g. "add_optab"). */
79 const char *name;
80
81 /* The pattern that matching define_expands and define_insns have.
82 See the comment at the head of optabs.def for details. */
83 const char *pattern;
84
85 /* The initializers (in the form of C code) for the libcall_basename,
86 libcall_suffix and libcall_gen fields of (convert_)optab_libcall_d. */
87 const char *base;
88 const char *suffix;
89 const char *libcall;
90
91 /* The optab's enum value. */
92 unsigned int op;
93
94 /* The value returned by optab_to_code (OP). */
95 enum rtx_code fcode;
96
97 /* CODE if code_to_optab (CODE) should return OP, otherwise UNKNOWN. */
98 enum rtx_code rcode;
99
100 /* 1: conversion optabs with libcall data,
101 2: conversion optabs without libcall data,
102 3: non-conversion optabs with libcall data ("normal" and "overflow"
103 optabs in the optabs.def comment)
104 4: non-conversion optabs without libcall data ("direct" optabs). */
105 unsigned int kind;
106};
107
108extern optab_def optabs[];
109extern unsigned int num_optabs;
110
111/* Information about an instruction name that matches an optab pattern. */
112struct optab_pattern
113{
114 /* The name of the instruction. */
115 const char *name;
116
117 /* The matching optab. */
118 unsigned int op;
119
120 /* The optab modes. M2 is only significant for conversion optabs;
121 it is zero otherwise. */
122 unsigned int m1, m2;
123
124 /* An index that provides a lexicographical sort of (OP, M2, M1).
125 Used by genopinit.cc. */
126 unsigned int sort_num;
127};
128
129extern rtx add_implicit_parallel (rtvec);
130extern rtx_reader *init_rtx_reader_args_cb (int, const char **,
131 bool (*)(const char *));
132extern rtx_reader *init_rtx_reader_args (int, const char **);
133extern int count_patterns ();
134extern bool read_md_rtx (md_rtx_info *);
135extern unsigned int get_num_insn_codes ();
136
137/* Set this to 0 to disable automatic elision of insn patterns which
138 can never be used in this configuration. See genconditions.cc.
139 Must be set before calling init_md_reader. */
140extern int insn_elision;
141
142/* Return the C test that says whether a definition rtx can be used,
143 or "" if it can be used unconditionally. */
144extern const char *get_c_test (rtx);
145
146/* If the C test passed as the argument can be evaluated at compile
147 time, return its truth value; else return -1. The test must have
148 appeared somewhere in the machine description when genconditions
149 was run. */
150extern int maybe_eval_c_test (const char *);
151
152/* Add an entry to the table of conditions. Used by genconditions and
153 by read-rtl.cc. */
154extern void add_c_test (const char *, int);
155
156/* This structure is used internally by gensupport.cc and genconditions.cc. */
157struct c_test
158{
159 const char *expr;
160 int value;
161};
162
163#ifdef __HASHTAB_H__
164extern hashval_t hash_c_test (const void *);
165extern int cmp_c_test (const void *, const void *);
166extern void traverse_c_tests (htab_trav, void *);
167#endif
168
169/* Predicate handling: helper functions and data structures. */
170
171struct pred_data
172{
173 struct pred_data *next; /* for iterating over the set of all preds */
174 const char *name; /* predicate name */
175 bool special; /* special handling of modes? */
176
177 /* data used primarily by genpreds.cc */
178 const char *c_block; /* C test block */
179 rtx exp; /* RTL test expression */
180
181 /* data used primarily by genrecog.cc */
182 enum rtx_code singleton; /* if pred takes only one code, that code */
183 int num_codes; /* number of codes accepted */
184 bool allows_non_lvalue; /* if pred allows non-lvalue expressions */
185 bool allows_non_const; /* if pred allows non-const expressions */
186 bool codes[NUM_RTX_CODE]; /* set of codes accepted */
187};
188
189extern struct pred_data *first_predicate;
190extern struct pred_data *lookup_predicate (const char *);
191extern void add_predicate_code (struct pred_data *, enum rtx_code);
192extern void add_predicate (struct pred_data *);
193
194#define FOR_ALL_PREDICATES(p) for (p = first_predicate; p; p = p->next)
195
196struct pattern_stats
197{
198 /* The largest match_operand, match_operator or match_parallel
199 number found. */
200 int max_opno;
201
202 /* The largest match_dup, match_op_dup or match_par_dup number found. */
203 int max_dup_opno;
204
205 /* The smallest and largest match_scratch number found. */
206 int min_scratch_opno;
207 int max_scratch_opno;
208
209 /* The number of times match_dup, match_op_dup or match_par_dup appears
210 in the pattern. */
211 int num_dups;
212
213 /* The number of rtx arguments to the generator function. */
214 int num_generator_args;
215
216 /* The number of rtx operands in an insn. */
217 int num_insn_operands;
218
219 /* The number of operand variables that are needed. */
220 int num_operand_vars;
221};
222
223extern hash_set<rtx> compact_syntax;
224
225extern void get_pattern_stats (struct pattern_stats *ranges, rtvec vec);
226extern void compute_test_codes (rtx, file_location, char *);
227extern file_location get_file_location (rtx);
228extern const char *get_emit_function (rtx);
229extern bool needs_barrier_p (rtx);
230extern bool find_optab (optab_pattern *, const char *);
231
232#endif /* GCC_GENSUPPORT_H */
233

source code of gcc/gensupport.h