gcc/read-md.h

   1 /* MD reader definitions.
   2    Copyright (C) 1987-2017 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   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
   9 version.
  10
  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
  14 for more details.
  15
  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/>.  */
  19
  20 #ifndef GCC_READ_MD_H
  21 #define GCC_READ_MD_H
  22
  23 #include "obstack.h"
  24
  25 /* Records a position in the file.  */
  26 struct file_location {
  27   file_location () {}
  28   file_location (const char *, int, int);
  29
  30   const char *filename;
  31   int lineno;
  32   int colno;
  33 };
  34
  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) {}
  37
  38 /* Holds one symbol or number in the .md file.  */
  39 struct md_name {
  40   /* The name as it appeared in the .md file.  Names are syntactically
  41      limited to the length of this buffer.  */
  42   char buffer[256];
  43
  44   /* The name that should actually be used by the generator programs.
  45      This is an expansion of NAME, after things like constant substitution.  */
  46   char *string;
  47 };
  48
  49 /* This structure represents a constant defined by define_constant,
  50    define_enum, or such-like.  */
  51 struct md_constant {
  52   /* The name of the constant.  */
  53   char *name;
  54
  55   /* The string to which the constants expands.  */
  56   char *value;
  57
  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;
  61 };
  62
  63 /* This structure represents one value in an enum_type.  */
  64 struct enum_value {
  65   /* The next value in the enum, or null if this is the last.  */
  66   struct enum_value *next;
  67
  68   /* The name of the value as it appears in the .md file.  */
  69   char *name;
  70
  71   /* The definition of the related C value.  */
  72   struct md_constant *def;
  73 };
  74
  75 /* This structure represents an enum defined by define_enum or the like.  */
  76 struct enum_type {
  77   /* The C name of the enumeration.  */
  78   char *name;
  79
  80   /* True if this is an md-style enum (DEFINE_ENUM) rather than
  81      a C-style enum (DEFINE_C_ENUM).  */
  82   bool md_p;
  83
  84   /* The values of the enumeration.  There is always at least one.  */
  85   struct enum_value *values;
  86
  87   /* A pointer to the null terminator in VALUES.  */
  88   struct enum_value **tail_ptr;
  89
  90   /* The number of enumeration values.  */
  91   unsigned int num_values;
  92 };
  93
  94 /* A class for reading .md files and RTL dump files.
  95
  96    Implemented in read-md.c.
  97
  98    This class has responsibility for reading chars from input files, and
  99    for certain common top-level directives including the "include"
 100    directive.
 101
 102    It does not handle parsing the hierarchically-nested expressions of
 103    rtl.def; for that see the rtx_reader subclass below (implemented in
 104    read-rtl.c).  */
 105
 106 class md_reader
 107 {
 108  public:
 109   md_reader (bool compact);
 110   virtual ~md_reader ();
 111
 112   bool read_md_files (int, const char **, bool (*) (const char *));
 113   bool read_file (const char *filename);
 114   bool read_file_fragment (const char *filename,
 115                            int first_line,
 116                            int last_line);
 117
 118   /* A hook that handles a single .md-file directive, up to but not
 119      including the closing ')'.  It takes two arguments: the file position
 120      at which the directive started, and the name of the directive.  The next
 121      unread character is the optional space after the directive name.  */
 122   virtual void handle_unknown_directive (file_location, const char *) = 0;
 123
 124   file_location get_current_location () const;
 125
 126   bool is_compact () const { return m_compact; }
 127
 128   /* Defined in read-md.c.  */
 129   int read_char (void);
 130   void unread_char (int ch);
 131   file_location read_name (struct md_name *name);
 132   file_location read_name_or_nil (struct md_name *);
 133   void read_escape ();
 134   char *read_quoted_string ();
 135   char *read_braced_string ();
 136   char *read_string (int star_if_braced);
 137   void read_skip_construct (int depth, file_location loc);
 138   void require_char (char expected);
 139   void require_char_ws (char expected);
 140   void require_word_ws (const char *expected);
 141   int peek_char (void);
 142
 143   void set_md_ptr_loc (const void *ptr, const char *filename, int lineno);
 144   const struct ptr_loc *get_md_ptr_loc (const void *ptr);
 145   void copy_md_ptr_loc (const void *new_ptr, const void *old_ptr);
 146   void fprint_md_ptr_loc (FILE *outf, const void *ptr);
 147   void print_md_ptr_loc (const void *ptr);
 148
 149   struct enum_type *lookup_enum_type (const char *name);
 150   void traverse_enum_types (htab_trav callback, void *info);
 151
 152   void handle_constants ();
 153   void traverse_md_constants (htab_trav callback, void *info);
 154   void handle_enum (file_location loc, bool md_p);
 155
 156   const char *join_c_conditions (const char *cond1, const char *cond2);
 157   void fprint_c_condition (FILE *outf, const char *cond);
 158   void print_c_condition (const char *cond);
 159
 160   /* Defined in read-rtl.c.  */
 161   const char *apply_iterator_to_string (const char *string);
 162   rtx copy_rtx_for_iterators (rtx original);
 163   void read_conditions ();
 164   void record_potential_iterator_use (struct iterator_group *group,
 165                                       void *ptr, const char *name);
 166   struct mapping *read_mapping (struct iterator_group *group, htab_t table);
 167
 168   const char *get_top_level_filename () const { return m_toplevel_fname; }
 169   const char *get_filename () const { return m_read_md_filename; }
 170   int get_lineno () const { return m_read_md_lineno; }
 171   int get_colno () const { return m_read_md_colno; }
 172
 173   struct obstack *get_string_obstack () { return &m_string_obstack; }
 174   htab_t get_md_constants () { return m_md_constants; }
 175
 176  private:
 177   /* A singly-linked list of filenames.  */
 178   struct file_name_list {
 179     struct file_name_list *next;
 180     const char *fname;
 181   };
 182
 183  private:
 184   void handle_file ();
 185   void handle_toplevel_file ();
 186   void handle_include (file_location loc);
 187   void add_include_path (const char *arg);
 188
 189   bool read_name_1 (struct md_name *name, file_location *out_loc);
 190
 191  private:
 192   /* Are we reading a compact dump?  */
 193   bool m_compact;
 194
 195   /* The name of the toplevel file that indirectly included
 196      m_read_md_file.  */
 197   const char *m_toplevel_fname;
 198
 199   /* The directory part of m_toplevel_fname
 200      NULL if m_toplevel_fname is a bare filename.  */
 201   char *m_base_dir;
 202
 203   /* The file we are reading.  */
 204   FILE *m_read_md_file;
 205
 206   /* The filename of m_read_md_file.  */
 207   const char *m_read_md_filename;
 208
 209   /* The current line number in m_read_md_file.  */
 210   int m_read_md_lineno;
 211
 212   /* The current column number in m_read_md_file.  */
 213   int m_read_md_colno;
 214
 215   /* The column number before the last newline, so that
 216      we can handle unread_char ('\n') at least once whilst
 217      retaining column information.  */
 218   int m_last_line_colno;
 219
 220   /* The first directory to search.  */
 221   file_name_list *m_first_dir_md_include;
 222
 223   /* A pointer to the null terminator of the md include chain.  */
 224   file_name_list **m_last_dir_md_include_ptr;
 225
 226   /* Obstack used for allocating MD strings.  */
 227   struct obstack m_string_obstack;
 228
 229   /* A table of ptr_locs, hashed on the PTR field.  */
 230   htab_t m_ptr_locs;
 231
 232   /* An obstack for the above.  Plain xmalloc is a bit heavyweight for a
 233      small structure like ptr_loc.  */
 234   struct obstack m_ptr_loc_obstack;
 235
 236   /* A hash table of triples (A, B, C), where each of A, B and C is a condition
 237      and A is equivalent to "B && C".  This is used to keep track of the source
 238      of conditions that are made up of separate MD strings (such as the split
 239      condition of a define_insn_and_split).  */
 240   htab_t m_joined_conditions;
 241
 242   /* An obstack for allocating joined_conditions entries.  */
 243   struct obstack m_joined_conditions_obstack;
 244
 245   /* A table of md_constant structures, hashed by name.  Null if no
 246      constant expansion should occur.  */
 247   htab_t m_md_constants;
 248
 249   /* A table of enum_type structures, hashed by name.  */
 250   htab_t m_enum_types;
 251
 252   /* If non-zero, filter the input to just this subset of lines.  */
 253   int m_first_line;
 254   int m_last_line;
 255 };
 256
 257 /* Global singleton; constrast with rtx_reader_ptr below.  */
 258 extern md_reader *md_reader_ptr;
 259
 260 /* An md_reader subclass which skips unknown directives, for
 261    the gen* tools that purely use read-md.o.  */
 262
 263 class noop_reader : public md_reader
 264 {
 265  public:
 266   noop_reader () : md_reader (false) {}
 267
 268   /* A dummy implementation which skips unknown directives.  */
 269   void handle_unknown_directive (file_location, const char *);
 270 };
 271
 272 /* An md_reader subclass that actually handles full hierarchical
 273    rtx expressions.
 274
 275    Implemented in read-rtl.c.  */
 276
 277 class rtx_reader : public md_reader
 278 {
 279  public:
 280   rtx_reader (bool compact);
 281   ~rtx_reader ();
 282
 283   bool read_rtx (const char *rtx_name, vec<rtx> *rtxen);
 284   rtx read_rtx_code (const char *code_name);
 285   virtual rtx read_rtx_operand (rtx return_rtx, int idx);
 286   rtx read_nested_rtx ();
 287   rtx read_rtx_variadic (rtx form);
 288   char *read_until (const char *terminator_chars, bool consume_terminator);
 289
 290   virtual void handle_any_trailing_information (rtx) {}
 291   virtual rtx postprocess (rtx x) { return x; }
 292
 293   /* Hook to allow function_reader subclass to put STRINGBUF into gc-managed
 294      memory, rather than within an obstack.
 295      This base class implementation is a no-op.  */
 296   virtual const char *finalize_string (char *stringbuf) { return stringbuf; }
 297
 298  protected:
 299   /* Analogous to rtx_writer's m_in_call_function_usage.  */
 300   bool m_in_call_function_usage;
 301
 302   /* Support for "reuse_rtx" directives.  */
 303   auto_vec<rtx> m_reuse_rtx_by_id;
 304 };
 305
 306 /* Global singleton; constrast with md_reader_ptr above.  */
 307 extern rtx_reader *rtx_reader_ptr;
 308
 309 extern void (*include_callback) (const char *);
 310
 311 /* Read the next character from the MD file.  */
 312
 313 static inline int
 314 read_char (void)
 315 {
 316   return md_reader_ptr->read_char ();
 317 }
 318
 319 /* Put back CH, which was the last character read from the MD file.  */
 320
 321 static inline void
 322 unread_char (int ch)
 323 {
 324   md_reader_ptr->unread_char (ch);
 325 }
 326
 327 extern hashval_t leading_string_hash (const void *);
 328 extern int leading_string_eq_p (const void *, const void *);
 329 extern const char *join_c_conditions (const char *, const char *);
 330 extern void message_at (file_location, const char *, ...) ATTRIBUTE_PRINTF_2;
 331 extern void error_at (file_location, const char *, ...) ATTRIBUTE_PRINTF_2;
 332 extern void fatal_at (file_location, const char *, ...) ATTRIBUTE_PRINTF_2;
 333 extern void fatal_with_file_and_line (const char *, ...)
 334   ATTRIBUTE_PRINTF_1 ATTRIBUTE_NORETURN;
 335 extern void fatal_expected_char (int, int) ATTRIBUTE_NORETURN;
 336 extern int read_skip_spaces (void);
 337 extern int n_comma_elts (const char *);
 338 extern const char *scan_comma_elt (const char **);
 339 extern void upcase_string (char *);
 340 extern void traverse_enum_types (htab_trav, void *);
 341 extern struct enum_type *lookup_enum_type (const char *);
 342
 343 #endif /* GCC_READ_MD_H */