1 /* MD reader definitions.
2 Copyright (C) 1987-2016 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
25 /* Records a position in the file. */
26 struct file_location
{
28 file_location (const char *, int, int);
35 inline file_location::file_location (const char *filename_in
, int lineno_in
, int colno_in
)
36 : filename (filename_in
), lineno (lineno_in
), colno (colno_in
) {}
38 /* Holds one symbol or number in the .md file. */
40 /* The name as it appeared in the .md file. Names are syntactically
41 limited to the length of this buffer. */
44 /* The name that should actually be used by the generator programs.
45 This is an expansion of NAME, after things like constant substitution. */
49 /* This structure represents a constant defined by define_constant,
50 define_enum, or such-like. */
52 /* The name of the constant. */
55 /* The string to which the constants expands. */
58 /* If the constant is associated with a enumeration, this field
59 points to that enumeration, otherwise it is null. */
60 struct enum_type
*parent_enum
;
63 /* This structure represents one value in an enum_type. */
65 /* The next value in the enum, or null if this is the last. */
66 struct enum_value
*next
;
68 /* The name of the value as it appears in the .md file. */
71 /* The definition of the related C value. */
72 struct md_constant
*def
;
75 /* This structure represents an enum defined by define_enum or the like. */
77 /* The C name of the enumeration. */
80 /* True if this is an md-style enum (DEFINE_ENUM) rather than
81 a C-style enum (DEFINE_C_ENUM). */
84 /* The values of the enumeration. There is always at least one. */
85 struct enum_value
*values
;
87 /* A pointer to the null terminator in VALUES. */
88 struct enum_value
**tail_ptr
;
90 /* The number of enumeration values. */
91 unsigned int num_values
;
94 /* A class for reading .md files and RTL dump files.
96 Implemented in read-md.c.
98 This class has responsibility for reading chars from input files, and
99 for certain common top-level directives including the "include"
102 It does not handle parsing the hierarchically-nested expressions of
103 rtl.def; for that see the rtx_reader subclass below (implemented in
110 virtual ~md_reader ();
112 bool read_md_files (int, const char **, bool (*) (const char *));
114 /* A hook that handles a single .md-file directive, up to but not
115 including the closing ')'. It takes two arguments: the file position
116 at which the directive started, and the name of the directive. The next
117 unread character is the optional space after the directive name. */
118 virtual void handle_unknown_directive (file_location
, const char *) = 0;
120 file_location
get_current_location () const;
122 /* Defined in read-md.c. */
123 int read_char (void);
124 void unread_char (int ch
);
125 void read_name (struct md_name
*name
);
127 char *read_quoted_string ();
128 char *read_braced_string ();
129 char *read_string (int star_if_braced
);
130 void read_skip_construct (int depth
, file_location loc
);
131 void require_char (char expected
);
132 void require_char_ws (char expected
);
133 void require_word_ws (const char *expected
);
134 int peek_char (void);
136 void set_md_ptr_loc (const void *ptr
, const char *filename
, int lineno
);
137 const struct ptr_loc
*get_md_ptr_loc (const void *ptr
);
138 void copy_md_ptr_loc (const void *new_ptr
, const void *old_ptr
);
139 void fprint_md_ptr_loc (FILE *outf
, const void *ptr
);
140 void print_md_ptr_loc (const void *ptr
);
142 struct enum_type
*lookup_enum_type (const char *name
);
143 void traverse_enum_types (htab_trav callback
, void *info
);
145 void handle_constants ();
146 void traverse_md_constants (htab_trav callback
, void *info
);
147 void handle_enum (file_location loc
, bool md_p
);
149 const char *join_c_conditions (const char *cond1
, const char *cond2
);
150 void fprint_c_condition (FILE *outf
, const char *cond
);
151 void print_c_condition (const char *cond
);
153 /* Defined in read-rtl.c. */
154 const char *apply_iterator_to_string (const char *string
);
155 rtx
copy_rtx_for_iterators (rtx original
);
156 void read_conditions ();
157 void record_potential_iterator_use (struct iterator_group
*group
,
158 void *ptr
, const char *name
);
159 struct mapping
*read_mapping (struct iterator_group
*group
, htab_t table
);
161 const char *get_top_level_filename () const { return m_toplevel_fname
; }
162 const char *get_filename () const { return m_read_md_filename
; }
163 int get_lineno () const { return m_read_md_lineno
; }
164 int get_colno () const { return m_read_md_colno
; }
166 struct obstack
*get_string_obstack () { return &m_string_obstack
; }
167 htab_t
get_md_constants () { return m_md_constants
; }
170 /* A singly-linked list of filenames. */
171 struct file_name_list
{
172 struct file_name_list
*next
;
178 void handle_toplevel_file ();
179 void handle_include (file_location loc
);
180 void add_include_path (const char *arg
);
183 /* The name of the toplevel file that indirectly included
185 const char *m_toplevel_fname
;
187 /* The directory part of m_toplevel_fname
188 NULL if m_toplevel_fname is a bare filename. */
191 /* The file we are reading. */
192 FILE *m_read_md_file
;
194 /* The filename of m_read_md_file. */
195 const char *m_read_md_filename
;
197 /* The current line number in m_read_md_file. */
198 int m_read_md_lineno
;
200 /* The current column number in m_read_md_file. */
203 /* The column number before the last newline, so that
204 we can handle unread_char ('\n') at least once whilst
205 retaining column information. */
206 int m_last_line_colno
;
208 /* The first directory to search. */
209 file_name_list
*m_first_dir_md_include
;
211 /* A pointer to the null terminator of the md include chain. */
212 file_name_list
**m_last_dir_md_include_ptr
;
214 /* Obstack used for allocating MD strings. */
215 struct obstack m_string_obstack
;
217 /* A table of ptr_locs, hashed on the PTR field. */
220 /* An obstack for the above. Plain xmalloc is a bit heavyweight for a
221 small structure like ptr_loc. */
222 struct obstack m_ptr_loc_obstack
;
224 /* A hash table of triples (A, B, C), where each of A, B and C is a condition
225 and A is equivalent to "B && C". This is used to keep track of the source
226 of conditions that are made up of separate MD strings (such as the split
227 condition of a define_insn_and_split). */
228 htab_t m_joined_conditions
;
230 /* An obstack for allocating joined_conditions entries. */
231 struct obstack m_joined_conditions_obstack
;
233 /* A table of md_constant structures, hashed by name. Null if no
234 constant expansion should occur. */
235 htab_t m_md_constants
;
237 /* A table of enum_type structures, hashed by name. */
241 /* Global singleton; constrast with rtx_reader_ptr below. */
242 extern md_reader
*md_reader_ptr
;
244 /* An md_reader subclass which skips unknown directives, for
245 the gen* tools that purely use read-md.o. */
247 class noop_reader
: public md_reader
250 noop_reader () : md_reader () {}
252 /* A dummy implementation which skips unknown directives. */
253 void handle_unknown_directive (file_location
, const char *);
256 /* An md_reader subclass that actually handles full hierarchical
259 Implemented in read-rtl.c. */
261 class rtx_reader
: public md_reader
267 bool read_rtx (const char *rtx_name
, vec
<rtx
> *rtxen
);
268 rtx
read_rtx_code (const char *code_name
);
269 void read_rtx_operand (rtx return_rtx
, int idx
);
270 rtx
read_nested_rtx ();
271 rtx
read_rtx_variadic (rtx form
);
274 /* Global singleton; constrast with md_reader_ptr above. */
275 extern rtx_reader
*rtx_reader_ptr
;
277 extern void (*include_callback
) (const char *);
279 /* Read the next character from the MD file. */
284 return md_reader_ptr
->read_char ();
287 /* Put back CH, which was the last character read from the MD file. */
292 md_reader_ptr
->unread_char (ch
);
295 extern hashval_t
leading_string_hash (const void *);
296 extern int leading_string_eq_p (const void *, const void *);
297 extern const char *join_c_conditions (const char *, const char *);
298 extern void message_at (file_location
, const char *, ...) ATTRIBUTE_PRINTF_2
;
299 extern void error_at (file_location
, const char *, ...) ATTRIBUTE_PRINTF_2
;
300 extern void fatal_at (file_location
, const char *, ...) ATTRIBUTE_PRINTF_2
;
301 extern void fatal_with_file_and_line (const char *, ...)
302 ATTRIBUTE_PRINTF_1 ATTRIBUTE_NORETURN
;
303 extern void fatal_expected_char (int, int) ATTRIBUTE_NORETURN
;
304 extern int read_skip_spaces (void);
305 extern int n_comma_elts (const char *);
306 extern const char *scan_comma_elt (const char **);
307 extern void upcase_string (char *);
308 extern void traverse_enum_types (htab_trav
, void *);
309 extern struct enum_type
*lookup_enum_type (const char *);
311 #endif /* GCC_READ_MD_H */