tree-ssa.texi: Remove documentation for V_MUST_DEF.
[official-gcc.git] / gcc / toplev.h
bloba23d52c8983746db5179da19bc3c675c6ac5438b
1 /* toplev.h - Various declarations for functions found in toplev.c
2 Copyright (C) 1998, 1999, 2000, 2001, 2003, 2004, 2005
3 Free Software Foundation, Inc.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING. If not, write to the Free
19 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
20 02110-1301, USA. */
22 #ifndef GCC_TOPLEV_H
23 #define GCC_TOPLEV_H
25 /* If non-NULL, return one past-the-end of the matching SUBPART of
26 the WHOLE string. */
27 #define skip_leading_substring(whole, part) \
28 (strncmp (whole, part, strlen (part)) ? NULL : whole + strlen (part))
30 extern int toplev_main (unsigned int, const char **);
31 extern int read_integral_parameter (const char *, const char *, const int);
32 extern void strip_off_ending (char *, int);
33 extern const char *trim_filename (const char *);
34 extern void _fatal_insn_not_found (rtx, const char *, int, const char *)
35 ATTRIBUTE_NORETURN;
36 extern void _fatal_insn (const char *, rtx, const char *, int, const char *)
37 ATTRIBUTE_NORETURN;
39 #define fatal_insn(msgid, insn) \
40 _fatal_insn (msgid, insn, __FILE__, __LINE__, __FUNCTION__)
41 #define fatal_insn_not_found(insn) \
42 _fatal_insn_not_found (insn, __FILE__, __LINE__, __FUNCTION__)
44 /* If we haven't already defined a frontend specific diagnostics
45 style, use the generic one. */
46 #ifndef GCC_DIAG_STYLE
47 #define GCC_DIAG_STYLE __gcc_tdiag__
48 #endif
49 /* None of these functions are suitable for ATTRIBUTE_PRINTF, because
50 each language front end can extend them with its own set of format
51 specifiers. We must use custom format checks. */
52 #if GCC_VERSION >= 4001
53 #define ATTRIBUTE_GCC_DIAG(m, n) __attribute__ ((__format__ (GCC_DIAG_STYLE, m, n))) ATTRIBUTE_NONNULL(m)
54 #else
55 #define ATTRIBUTE_GCC_DIAG(m, n) ATTRIBUTE_NONNULL(m)
56 #endif
57 extern void internal_error (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2)
58 ATTRIBUTE_NORETURN;
59 extern void warning0 (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
60 /* Pass one of the OPT_W* from options.h as the first parameter. */
61 extern void warning (int, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
62 extern void error (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
63 extern void fatal_error (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2)
64 ATTRIBUTE_NORETURN;
65 extern void pedwarn (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
66 extern void sorry (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
67 extern void inform (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
68 extern void verbatim (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
70 extern void rest_of_decl_compilation (tree, int, int);
71 extern void rest_of_type_compilation (tree, int);
72 extern void tree_rest_of_compilation (tree);
73 extern void init_optimization_passes (void);
74 extern void finish_optimization_passes (void);
75 extern bool enable_rtl_dump_file (int);
77 extern void announce_function (tree);
79 extern void error_for_asm (rtx, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
80 extern void warning_for_asm (rtx, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
81 extern void warn_deprecated_use (tree);
83 #ifdef BUFSIZ
84 extern void output_quoted_string (FILE *, const char *);
85 extern void output_file_directive (FILE *, const char *);
86 #endif
88 #ifdef BUFSIZ
89 /* N.B. Unlike all the others, fnotice is just gettext+fprintf, and
90 therefore it can have ATTRIBUTE_PRINTF. */
91 extern void fnotice (FILE *, const char *, ...)
92 ATTRIBUTE_PRINTF_2;
93 #endif
95 extern void wrapup_global_declaration_1 (tree);
96 extern bool wrapup_global_declaration_2 (tree);
97 extern bool wrapup_global_declarations (tree *, int);
98 extern void check_global_declaration_1 (tree);
99 extern void check_global_declarations (tree *, int);
100 extern void emit_debug_global_declarations (tree *, int);
101 extern void write_global_declarations (void);
103 extern void dump_memory_report (bool);
105 /* A unique local time stamp, might be zero if none is available. */
106 extern unsigned local_tick;
108 extern const char *progname;
109 extern const char *dump_base_name;
110 extern const char *aux_base_name;
111 extern const char *aux_info_file_name;
112 extern const char *asm_file_name;
113 extern bool exit_after_options;
115 extern int target_flags_explicit;
117 /* True if the user has tagged the function with the 'section'
118 attribute. */
120 extern bool user_defined_section_attribute;
122 /* See toplev.c. */
123 extern int flag_crossjumping;
124 extern int flag_if_conversion;
125 extern int flag_if_conversion2;
126 extern int flag_keep_static_consts;
127 extern int flag_peel_loops;
128 extern int flag_rerun_cse_after_loop;
129 extern int flag_thread_jumps;
130 extern int flag_tracer;
131 extern int flag_unroll_loops;
132 extern int flag_unroll_all_loops;
133 extern int flag_unswitch_loops;
134 extern int flag_cprop_registers;
135 extern int time_report;
137 /* Things to do with target switches. */
138 extern void print_version (FILE *, const char *);
139 extern void * default_get_pch_validity (size_t *);
140 extern const char * default_pch_valid_p (const void *, size_t);
142 /* The hashtable, so that the C front ends can pass it to cpplib. */
143 extern struct ht *ident_hash;
145 /* This function can be used by targets to set the flags originally
146 implied by -ffast-math and -fno-fast-math. */
148 extern void set_fast_math_flags (int);
150 /* Handle -d switch. */
151 extern void decode_d_option (const char *);
153 /* Return true iff flags are set as if -ffast-math. */
154 extern bool fast_math_flags_set_p (void);
156 /* Return log2, or -1 if not exact. */
157 extern int exact_log2 (unsigned HOST_WIDE_INT);
159 /* Return floor of log2, with -1 for zero. */
160 extern int floor_log2 (unsigned HOST_WIDE_INT);
162 /* Inline versions of the above for speed. */
163 #if GCC_VERSION >= 3004
164 # if HOST_BITS_PER_WIDE_INT == HOST_BITS_PER_LONG
165 # define CLZ_HWI __builtin_clzl
166 # define CTZ_HWI __builtin_ctzl
167 # elif HOST_BITS_PER_WIDE_INT == HOST_BITS_PER_LONGLONG
168 # define CLZ_HWI __builtin_clzll
169 # define CTZ_HWI __builtin_ctzll
170 # else
171 # define CLZ_HWI __builtin_clz
172 # define CTZ_HWI __builtin_ctz
173 # endif
175 extern inline int
176 floor_log2 (unsigned HOST_WIDE_INT x)
178 return x ? HOST_BITS_PER_WIDE_INT - 1 - (int) CLZ_HWI (x) : -1;
181 extern inline int
182 exact_log2 (unsigned HOST_WIDE_INT x)
184 return x == (x & -x) && x ? (int) CTZ_HWI (x) : -1;
186 #endif /* GCC_VERSION >= 3004 */
188 /* Functions used to get and set GCC's notion of in what directory
189 compilation was started. */
191 extern const char *get_src_pwd (void);
192 extern bool set_src_pwd (const char *);
194 #endif /* ! GCC_TOPLEV_H */