docs: Fix 2 typos
[official-gcc.git] / gcc / opth-gen.awk
blob6a68958064d4d0c3cead16b64cf7f012d6fc42d7
1 # Copyright (C) 2003-2024 Free Software Foundation, Inc.
2 # Contributed by Kelley Cook, June 2004.
3 # Original code from Neil Booth, May 2003.
5 # This program is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by the
7 # Free Software Foundation; either version 3, or (at your option) any
8 # 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.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; see the file COPYING3. If not see
17 # <http://www.gnu.org/licenses/>.
19 # This Awk script reads in the option records generated from
20 # opt-gather.awk, combines the flags of duplicate options and generates a
21 # C header file.
23 # This program uses functions from opt-functions.awk and code from
24 # opt-read.awk.
25 # Usage: awk -f opt-functions.awk -f opt-read.awk -f opth-gen.awk \
26 # < inputfile > options.h
28 # Dump out an enumeration into a .h file.
29 # Combine the flags of duplicate options.
30 END {
31 print "/* This file is auto-generated by opth-gen.awk. */"
32 print ""
33 print "#ifndef OPTIONS_H"
34 print "#define OPTIONS_H"
35 print ""
36 print "#include \"flag-types.h\""
37 print ""
39 if (n_extra_h_includes > 0) {
40 for (i = 0; i < n_extra_h_includes; i++) {
41 print "#include " quote extra_h_includes[i] quote
43 print ""
46 print "#if !defined(IN_LIBGCC2) && !defined(IN_TARGET_LIBS) && !defined(IN_RTS)"
47 print "#ifndef GENERATOR_FILE"
48 print "#if !defined(IN_LIBGCC2) && !defined(IN_TARGET_LIBS)"
49 print "struct GTY(()) gcc_options"
50 print "#else"
51 print "struct gcc_options"
52 print "#endif"
53 print "{"
54 print "#endif"
56 for (i = 0; i < n_extra_vars; i++) {
57 var = extra_vars[i]
58 sub(" *=.*", "", var)
59 orig_var = var
60 name = var
61 type = var
62 type_after = var
63 sub("^.*[ *]", "", name)
64 sub("\\[.*\\]$", "", name)
65 sub("\\[.*\\]$", "", type)
66 sub(" *" name "$", "", type)
67 sub("^.*" name, "", type_after)
68 var_seen[name] = 1
69 print "#ifdef GENERATOR_FILE"
70 print "extern " orig_var ";"
71 print "#else"
72 print " " type " x_" name type_after ";"
73 print "#define " name " global_options.x_" name
74 print "#endif"
77 for (i = 0; i < n_opts; i++) {
78 if (flag_set_p("Save", flags[i]))
79 have_save = 1;
81 name = var_name(flags[i]);
82 if (name == "")
83 continue;
85 if (name in var_seen)
86 continue;
88 var_seen[name] = 1;
89 print "#ifdef GENERATOR_FILE"
90 print "extern " var_type(flags[i]) name ";"
91 print "#else"
92 print " " var_type(flags[i]) "x_" name ";"
93 print "#define " name " global_options.x_" name
94 print "#endif"
96 for (i = 0; i < n_opts; i++) {
97 name = static_var(opts[i], flags[i]);
98 if (name != "") {
99 print "#ifndef GENERATOR_FILE"
100 print " " var_type(flags[i]) "x_" name ";"
101 print "#define x_" name " do_not_use"
102 print "#endif"
105 for (i = 0; i < n_opts; i++) {
106 if (flag_set_p("SetByCombined", flags[i])) {
107 print "#ifndef GENERATOR_FILE"
108 print " bool frontend_set_" var_name(flags[i]) ";"
109 print "#endif"
112 print "#ifndef GENERATOR_FILE"
113 print "};"
114 print "extern struct gcc_options global_options;"
115 print "extern const struct gcc_options global_options_init;"
116 print "extern struct gcc_options global_options_set;"
117 print "#define target_flags_explicit global_options_set.x_target_flags"
118 print "#endif"
119 print "#endif"
120 print ""
122 # All of the optimization switches gathered together so they can be saved and restored.
123 # This will allow attribute((cold)) to turn on space optimization.
125 # Change the type of normal switches from int to unsigned char to save space.
126 # Also, order the structure so that pointer fields occur first, then int
127 # fields, and then char fields to provide the best packing.
129 print "#if !defined(IN_LIBGCC2) && !defined(IN_TARGET_LIBS) && !defined(IN_RTS)"
130 print ""
131 print "/* Structure to save/restore optimization and target specific options. */";
132 print "struct GTY(()) cl_optimization";
133 print "{";
135 n_opt_char = 4;
136 n_opt_short = 0;
137 n_opt_int = 0;
138 n_opt_enum = 0;
139 n_opt_other = 0;
140 n_opt_explicit = 4;
141 var_opt_char[0] = "unsigned char x_optimize";
142 var_opt_char[1] = "unsigned char x_optimize_size";
143 var_opt_char[2] = "unsigned char x_optimize_debug";
144 var_opt_char[3] = "unsigned char x_optimize_fast";
146 for (i = 0; i < n_opts; i++) {
147 if (flag_set_p("(Optimization|PerFunction)", flags[i])) {
148 name = var_name(flags[i])
149 if(name == "")
150 continue;
152 if(name in var_opt_seen)
153 continue;
155 var_opt_seen[name]++;
156 n_opt_explicit++;
157 otype = var_type_struct(flags[i]);
158 if (otype ~ "^((un)?signed +)?int *$")
159 var_opt_int[n_opt_int++] = otype "x_" name;
161 else if (otype ~ "^((un)?signed +)?short *$")
162 var_opt_short[n_opt_short++] = otype "x_" name;
164 else if (otype ~ "^((un)?signed +)?char *$")
165 var_opt_char[n_opt_char++] = otype "x_" name;
167 else if (otype ~ ("^enum +[_" alnum "]+ *$"))
168 var_opt_enum[n_opt_enum++] = otype "x_" name;
170 else
171 var_opt_other[n_opt_other++] = otype "x_" name;
175 for (i = 0; i < n_opt_other; i++) {
176 print " " var_opt_other[i] ";";
179 for (i = 0; i < n_opt_int; i++) {
180 print " " var_opt_int[i] ";";
183 for (i = 0; i < n_opt_enum; i++) {
184 print " " var_opt_enum[i] ";";
187 for (i = 0; i < n_opt_short; i++) {
188 print " " var_opt_short[i] ";";
191 for (i = 0; i < n_opt_char; i++) {
192 print " " var_opt_char[i] ";";
195 print " /* " n_opt_explicit " members */";
196 print " unsigned HOST_WIDE_INT explicit_mask[" int ((n_opt_explicit + 63) / 64) "];";
198 print "};";
199 print "";
201 # Target and optimization save/restore/print functions.
202 print "/* Structure to save/restore selected target specific options. */";
203 print "struct GTY(()) cl_target_option";
204 print "{";
206 n_target_char = 0;
207 n_target_short = 0;
208 n_target_int = 0;
209 n_target_enum = 0;
210 n_target_other = 0;
211 n_target_explicit = n_extra_target_vars;
212 n_target_explicit_mask = 0;
214 for (i = 0; i < n_target_save; i++) {
215 if (target_save_decl[i] ~ "^((un)?signed +)?int +[_" alnum "]+$")
216 var_target_int[n_target_int++] = target_save_decl[i];
218 else if (target_save_decl[i] ~ "^((un)?signed +)?short +[_" alnum "]+$")
219 var_target_short[n_target_short++] = target_save_decl[i];
221 else if (target_save_decl[i] ~ "^((un)?signed +)?char +[_ " alnum "]+$")
222 var_target_char[n_target_char++] = target_save_decl[i];
224 else if (target_save_decl[i] ~ ("^enum +[_" alnum "]+ +[_" alnum "]+$")) {
225 var_target_enum[n_target_enum++] = target_save_decl[i];
227 else
228 var_target_other[n_target_other++] = target_save_decl[i];
231 if (have_save) {
232 for (i = 0; i < n_opts; i++) {
233 if (flag_set_p("Save", flags[i])) {
234 name = var_name(flags[i])
235 if(name == "")
236 name = "target_flags";
238 if(name in var_save_seen)
239 continue;
241 var_save_seen[name]++;
242 n_target_explicit++;
243 otype = var_type_struct(flags[i])
245 if (opt_args("Mask", flags[i]) != "" \
246 || opt_args("InverseMask", flags[i]))
247 var_target_explicit_mask[n_target_explicit_mask++] \
248 = otype "explicit_mask_" name;
250 if (otype ~ "^((un)?signed +)?int *$")
251 var_target_int[n_target_int++] = otype "x_" name;
253 else if (otype ~ "^((un)?signed +)?short *$")
254 var_target_short[n_target_short++] = otype "x_" name;
256 else if (otype ~ "^((un)?signed +)?char *$")
257 var_target_char[n_target_char++] = otype "x_" name;
259 else if (otype ~ ("^enum +[_" alnum "]+ +[_" alnum "]+"))
260 var_target_enum[n_target_enum++] = otype "x_" name;
262 else
263 var_target_other[n_target_other++] = otype "x_" name;
266 } else {
267 var_target_int[n_target_int++] = "int x_target_flags";
268 n_target_explicit++;
269 var_target_explicit_mask[n_target_explicit_mask++] \
270 = "int explicit_mask_target_flags";
273 for (i = 0; i < n_target_other; i++) {
274 print " " var_target_other[i] ";";
277 for (i = 0; i < n_target_enum; i++) {
278 print " " var_target_enum[i] ";";
281 for (i = 0; i < n_target_int; i++) {
282 print " " var_target_int[i] ";";
285 for (i = 0; i < n_target_short; i++) {
286 print " " var_target_short[i] ";";
289 for (i = 0; i < n_target_char; i++) {
290 print " " var_target_char[i] ";";
293 print " /* " n_target_explicit - n_target_explicit_mask " members */";
294 if (n_target_explicit > n_target_explicit_mask) {
295 print " unsigned HOST_WIDE_INT explicit_mask[" \
296 int ((n_target_explicit - n_target_explicit_mask + 63) / 64) "];";
299 for (i = 0; i < n_target_explicit_mask; i++) {
300 print " " var_target_explicit_mask[i] ";";
303 print "};";
304 print "";
305 print "";
306 print "/* Save optimization variables into a structure. */"
307 print "extern void cl_optimization_save (struct cl_optimization *, struct gcc_options *, struct gcc_options *);";
308 print "";
309 print "/* Restore optimization variables from a structure. */";
310 print "extern void cl_optimization_restore (struct gcc_options *, struct gcc_options *, struct cl_optimization *);";
311 print "";
312 print "/* Print optimization variables from a structure. */";
313 print "extern void cl_optimization_print (FILE *, int, struct cl_optimization *);";
314 print "";
315 print "/* Print different optimization variables from structures provided as arguments. */";
316 print "extern void cl_optimization_print_diff (FILE *, int, cl_optimization *ptr1, cl_optimization *ptr2);";
317 print "";
318 print "/* Save selected option variables into a structure. */"
319 print "extern void cl_target_option_save (struct cl_target_option *, struct gcc_options *, struct gcc_options *);";
320 print "";
321 print "/* Restore selected option variables from a structure. */"
322 print "extern void cl_target_option_restore (struct gcc_options *, struct gcc_options *, struct cl_target_option *);";
323 print "";
324 print "/* Print target option variables from a structure. */";
325 print "extern void cl_target_option_print (FILE *, int, struct cl_target_option *);";
326 print "";
327 print "/* Print different target option variables from structures provided as arguments. */";
328 print "extern void cl_target_option_print_diff (FILE *, int, cl_target_option *ptr1, cl_target_option *ptr2);";
329 print "";
330 print "/* Compare two target option variables from a structure. */";
331 print "extern bool cl_target_option_eq (const struct cl_target_option *, const struct cl_target_option *);";
332 print "";
333 print "/* Free heap memory used by target option variables. */";
334 print "extern void cl_target_option_free (struct cl_target_option *);";
335 print "";
336 print "/* Hash option variables from a structure. */";
337 print "extern hashval_t cl_target_option_hash (const struct cl_target_option *);";
338 print "";
339 print "/* Hash optimization from a structure. */";
340 print "extern hashval_t cl_optimization_hash (const struct cl_optimization *);";
341 print "";
342 print "/* Compare two optimization options. */";
343 print "extern bool cl_optimization_option_eq (cl_optimization const *ptr1, cl_optimization const *ptr2);"
344 print "";
345 print "/* Free heap memory used by optimization options. */";
346 print "extern void cl_optimization_option_free (cl_optimization *ptr1);"
347 print "";
348 print "/* Compare and report difference for a part of cl_optimization options. */";
349 print "extern void cl_optimization_compare (gcc_options *ptr1, gcc_options *ptr2);";
350 print "";
351 print "/* Generator files may not have access to location_t, and don't need these. */"
352 print "#if defined(UNKNOWN_LOCATION)"
353 print "bool "
354 print "common_handle_option_auto (struct gcc_options *opts, "
355 print " struct gcc_options *opts_set, "
356 print " const struct cl_decoded_option *decoded, "
357 print " unsigned int lang_mask, int kind, "
358 print " location_t loc, "
359 print " const struct cl_option_handlers *handlers, "
360 print " diagnostic_context *dc); "
361 for (i = 0; i < n_langs; i++) {
362 lang_name = lang_sanitized_name(langs[i]);
363 print "bool"
364 print lang_name "_handle_option_auto (struct gcc_options *opts,"
365 print " struct gcc_options *opts_set,"
366 print " size_t scode, const char *arg,"
367 print " HOST_WIDE_INT value,"
368 print " unsigned int lang_mask, int kind,"
369 print " location_t loc,"
370 print " const struct cl_option_handlers *handlers,"
371 print " diagnostic_context *dc);"
373 print "void cpp_handle_option_auto (const struct gcc_options * opts, size_t scode,"
374 print " struct cpp_options * cpp_opts);"
375 print "void init_global_opts_from_cpp(struct gcc_options * opts, "
376 print " const struct cpp_options * cpp_opts);"
377 print "#endif";
378 print "#endif";
379 print "";
381 for (i = 0; i < n_opts; i++) {
382 name = opt_args("Mask", flags[i])
383 if (name == "") {
384 opt = opt_args("InverseMask", flags[i])
385 if (opt ~ ",")
386 name = nth_arg(0, opt)
387 else
388 name = opt
390 if (name != "" && mask_bits[name] == 0) {
391 mask_bits[name] = 1
392 vname = var_name(flags[i])
393 mask = "MASK_"
394 mask_1 = "1U"
395 if (vname != "") {
396 mask = "OPTION_MASK_"
397 if (host_wide_int[vname] == "yes")
398 mask_1 = "HOST_WIDE_INT_1U"
399 } else
400 extra_mask_bits[name] = 1
401 print "#define " mask name " (" mask_1 " << " masknum[vname]++ ")"
404 for (i = 0; i < n_extra_masks; i++) {
405 if (extra_mask_bits[extra_masks[i]] == 0)
406 print "#define MASK_" extra_masks[i] " (1U << " masknum[""]++ ")"
409 for (i = 0; i < n_target_vars; i++)
411 if (find_index(target_vars[i], extra_target_vars, n_extra_target_vars) == n_extra_target_vars)
412 continue
413 for (j = 0; j < n_other_mask[i]; j++)
415 print "#define MASK_" other_masks[i "," j] " (1U << " other_masknum[i]++ ")"
417 if (other_masknum[i] > 32)
418 print "#error too many target masks for" extra_target_vars[i]
421 for (var in masknum) {
422 if (var != "" && host_wide_int[var] == "yes") {
423 print "#if defined(HOST_BITS_PER_WIDE_INT) && " masknum[var] " > HOST_BITS_PER_WIDE_INT"
424 print "#error too many masks for " var
425 print "#endif"
427 else if (masknum[var] > 32) {
428 if (var == "")
429 print "#error too many target masks"
430 else
431 print "#error too many masks for " var
434 for (i = 0; i < n_target_vars; i++)
436 if (find_index(target_vars[i], extra_target_vars, n_extra_target_vars) == n_extra_target_vars)
437 continue
438 for (j = 0; j < n_other_mask[i]; j++)
440 print "#define TARGET_" other_masks[i "," j] \
441 " ((" target_vars[i] " & MASK_" other_masks[i "," j] ") != 0)"
442 print "#define TARGET_" other_masks[i "," j] "_P(" target_vars[i] ")" \
443 " (((" target_vars[i] ") & MASK_" other_masks[i "," j] ") != 0)"
444 print "#define TARGET_" other_masks[i "," j] "_OPTS_P(opts)" \
445 " (((opts->x_" target_vars[i] ") & MASK_" other_masks[i "," j] ") != 0)"
448 print ""
450 for (i = 0; i < n_opts; i++) {
451 name = opt_args("Mask", flags[i])
452 if (name == "") {
453 opt = opt_args("InverseMask", flags[i])
454 if (opt ~ ",")
455 name = nth_arg(0, opt)
456 else
457 name = opt
459 if (name != "" && mask_macros[name] == 0) {
460 mask_macros[name] = 1
461 vname = var_name(flags[i])
462 mask = "OPTION_MASK_"
463 if (vname == "") {
464 vname = "target_flags"
465 mask = "MASK_"
466 extra_mask_macros[name] = 1
468 original_name = name
469 gsub("ISA_", "", name)
470 gsub("ISA2_", "", name)
471 print "/* " original_name " mask */"
472 print "#define TARGET_" name \
473 " ((" vname " & " mask original_name ") != 0)"
474 print "#define TARGET_" name "_P(" vname ")" \
475 " (((" vname ") & " mask original_name ") != 0)"
476 print "#define TARGET_" name "_OPTS_P(opts)" \
477 " (((opts->x_" vname ") & " mask original_name ") != 0)"
478 print "#define TARGET_EXPLICIT_" name "_P(opts)" \
479 " ((opts->x_" vname "_explicit & " mask original_name ") != 0)"
480 print "#define SET_TARGET_" name "(opts) opts->x_" vname " |= " mask original_name
483 for (i = 0; i < n_extra_masks; i++) {
484 if (extra_mask_macros[extra_masks[i]] == 0) {
485 print "#define TARGET_" extra_masks[i] \
486 " ((target_flags & MASK_" extra_masks[i] ") != 0)"
487 print "#define TARGET_" extra_masks[i] "_P(target_flags)" \
488 " (((target_flags) & " extra_masks[i] ") != 0)"
489 print "#define TARGET_" extra_masks[i] "_OPTS_P(opts)" \
490 " (((opts->x_target_flags) & MASK_" extra_masks[i] ") != 0)"
493 print ""
495 for (i = 0; i < n_opts; i++) {
496 opt = opt_args("InverseMask", flags[i])
497 if (opt ~ ",") {
498 vname = var_name(flags[i])
499 mask = "OPTION_MASK_"
500 if (vname == "") {
501 vname = "target_flags"
502 mask = "MASK_"
504 print "#define TARGET_" nth_arg(1, opt) \
505 " ((" vname " & " mask nth_arg(0, opt) ") == 0)"
508 print ""
510 for (i = 0; i < n_langs; i++) {
511 macros[i] = "CL_" lang_sanitized_name(langs[i])
512 s = substr(" ", length (macros[i]))
513 print "#define " macros[i] s " (1U << " i ")"
515 print "#define CL_LANG_ALL ((1U << " n_langs ") - 1)"
517 print ""
518 print "enum opt_code"
519 print "{"
521 for (i = 0; i < n_opts; i++)
522 back_chain[i] = "N_OPTS";
524 enum_value = 0
525 for (i = 0; i < n_opts; i++) {
526 # Combine the flags of identical switches. Switches
527 # appear many times if they are handled by many front
528 # ends, for example.
529 while( i + 1 != n_opts && opts[i] == opts[i + 1] ) {
530 flags[i + 1] = flags[i] " " flags[i + 1];
531 i++;
534 len = length (opts[i]);
535 enum = opt_enum(opts[i])
536 enum_string = enum " = " enum_value ","
538 # Aliases do not get enumeration names.
539 if ((flag_set_p("Alias.*", flags[i]) \
540 && !flag_set_p("SeparateAlias", flags[i])) \
541 || flag_set_p("Ignore", flags[i])) {
542 enum_string = "/* " enum_string " */"
545 # If this switch takes joined arguments, back-chain all
546 # subsequent switches to it for which it is a prefix. If
547 # a later switch S is a longer prefix of a switch T, T
548 # will be back-chained to S in a later iteration of this
549 # for() loop, which is what we want.
550 if (flag_set_p("Joined.*", flags[i])) {
551 for (j = i + 1; j < n_opts; j++) {
552 if (substr (opts[j], 1, len) != opts[i])
553 break;
554 back_chain[j] = enum;
558 s = substr(" ",
559 length (enum_string))
561 if (help[i] == "")
562 hlp = "0"
563 else
564 hlp = "N_(\"" help[i] "\")";
566 print " " enum_string s "/* -" opts[i] " */"
567 enum_value++
570 print " N_OPTS,"
571 print " OPT_SPECIAL_unknown,"
572 print " OPT_SPECIAL_ignore,"
573 print " OPT_SPECIAL_warn_removed,"
574 print " OPT_SPECIAL_program_name,"
575 print " OPT_SPECIAL_input_file"
576 print "};"
577 print ""
578 print "#ifdef GCC_C_COMMON_C"
579 print "/* Mapping from cpp message reasons to the options that enable them. */"
580 print "#include <cpplib.h>"
581 print "struct cpp_reason_option_codes_t"
582 print "{"
583 print " /* cpplib message reason. */"
584 print " const enum cpp_warning_reason reason;"
585 print " /* gcc option that controls this message. */"
586 print " const int option_code;"
587 print "};"
588 print ""
589 print "static const struct cpp_reason_option_codes_t cpp_reason_option_codes[] = {"
590 for (i = 0; i < n_opts; i++) {
591 # With identical flags, pick only the last one. The
592 # earlier loop ensured that it has all flags merged,
593 # and a nonempty help text if one of the texts was nonempty.
594 while( i + 1 != n_opts && opts[i] == opts[i + 1] ) {
595 i++;
597 cpp_reason = nth_arg(0, opt_args("CppReason", flags[i]));
598 if (cpp_reason != "") {
599 cpp_reason = cpp_reason ",";
600 printf(" {%-40s %s},\n", cpp_reason, opt_enum(opts[i]))
603 printf(" {%-40s 0},\n", "CPP_W_NONE,")
604 print "};"
605 print "#endif"
606 print ""
607 print "#endif /* OPTIONS_H */"