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.
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify it under
8the terms of the GNU General Public License as published by the Free
9Software Foundation; either version 2, or (at your option) any later
10version.
11
12GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13WARRANTY; without even the implied warranty of MERCHANTABILITY or
14FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING.  If not, write to the Free
19Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
2002110-1301, USA.  */
21
22#ifndef GCC_TOPLEV_H
23#define GCC_TOPLEV_H
24
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))
29
30extern int toplev_main (unsigned int, const char **);
31extern int read_integral_parameter (const char *, const char *, const int);
32extern void strip_off_ending (char *, int);
33extern const char *trim_filename (const char *);
34extern void _fatal_insn_not_found (rtx, const char *, int, const char *)
35     ATTRIBUTE_NORETURN;
36extern void _fatal_insn (const char *, rtx, const char *, int, const char *)
37     ATTRIBUTE_NORETURN;
38
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__)
43
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
57extern void internal_error (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2)
58     ATTRIBUTE_NORETURN;
59extern void warning0 (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
60/* Pass one of the OPT_W* from options.h as the first parameter.  */
61extern void warning (int, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
62extern void error (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
63extern void fatal_error (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2)
64     ATTRIBUTE_NORETURN;
65extern void pedwarn (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
66extern void sorry (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
67extern void inform (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
68extern void verbatim (const char *, ...) ATTRIBUTE_GCC_DIAG(1,2);
69
70extern void rest_of_decl_compilation (tree, int, int);
71extern void rest_of_type_compilation (tree, int);
72extern void tree_rest_of_compilation (tree);
73extern void init_optimization_passes (void);
74extern void finish_optimization_passes (void);
75extern bool enable_rtl_dump_file (int);
76
77extern void announce_function (tree);
78
79extern void error_for_asm (rtx, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
80extern void warning_for_asm (rtx, const char *, ...) ATTRIBUTE_GCC_DIAG(2,3);
81extern void warn_deprecated_use (tree);
82/* APPLE LOCAL "unavailable" attribute (radar 2809697) */
83extern void error_unavailable_use (tree);
84
85#ifdef BUFSIZ
86extern void output_quoted_string	(FILE *, const char *);
87extern void output_file_directive	(FILE *, const char *);
88#endif
89
90#ifdef BUFSIZ
91  /* N.B. Unlike all the others, fnotice is just gettext+fprintf, and
92     therefore it can have ATTRIBUTE_PRINTF.  */
93extern void fnotice			(FILE *, const char *, ...)
94     ATTRIBUTE_PRINTF_2;
95#endif
96
97extern void wrapup_global_declaration_1 (tree);
98extern bool wrapup_global_declaration_2 (tree);
99extern bool wrapup_global_declarations (tree *, int);
100extern void check_global_declaration_1 (tree);
101extern void check_global_declarations (tree *, int);
102extern void emit_debug_global_declarations (tree *, int);
103extern void write_global_declarations (void);
104
105/* A unique local time stamp, might be zero if none is available.  */
106extern unsigned local_tick;
107
108extern const char *progname;
109extern const char *dump_base_name;
110extern const char *aux_base_name;
111extern const char *aux_info_file_name;
112extern const char *asm_file_name;
113extern bool exit_after_options;
114
115extern int target_flags_explicit;
116
117/* True if the user has tagged the function with the 'section'
118   attribute.  */
119
120extern bool user_defined_section_attribute;
121
122/* See toplev.c.  */
123extern int flag_crossjumping;
124extern int flag_if_conversion;
125extern int flag_if_conversion2;
126extern int flag_keep_static_consts;
127extern int flag_peel_loops;
128extern int flag_rerun_cse_after_loop;
129extern int flag_thread_jumps;
130extern int flag_tracer;
131extern int flag_unroll_loops;
132extern int flag_unroll_all_loops;
133extern int flag_unswitch_loops;
134extern int flag_cprop_registers;
135extern int time_report;
136
137/* Things to do with target switches.  */
138extern void print_version (FILE *, const char *);
139extern void * default_get_pch_validity (size_t *);
140extern const char * default_pch_valid_p (const void *, size_t);
141
142/* The hashtable, so that the C front ends can pass it to cpplib.  */
143extern struct ht *ident_hash;
144
145/* This function can be used by targets to set the flags originally
146    implied by -ffast-math and -fno-fast-math.  */
147
148extern void set_fast_math_flags         (int);
149
150/* Handle -d switch.  */
151extern void decode_d_option		(const char *);
152
153/* Return true iff flags are set as if -ffast-math.  */
154extern bool fast_math_flags_set_p	(void);
155
156/* Return log2, or -1 if not exact.  */
157extern int exact_log2                  (unsigned HOST_WIDE_INT);
158
159/* Return floor of log2, with -1 for zero.  */
160extern int floor_log2                  (unsigned HOST_WIDE_INT);
161
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
174
175extern inline int
176floor_log2 (unsigned HOST_WIDE_INT x)
177{
178  return x ? HOST_BITS_PER_WIDE_INT - 1 - (int) CLZ_HWI (x) : -1;
179}
180
181extern inline int
182exact_log2 (unsigned HOST_WIDE_INT x)
183{
184  return x == (x & -x) && x ? (int) CTZ_HWI (x) : -1;
185}
186#endif /* GCC_VERSION >= 3004 */
187
188/* Functions used to get and set GCC's notion of in what directory
189   compilation was started.  */
190
191extern const char *get_src_pwd	       (void);
192extern bool set_src_pwd		       (const char *);
193
194#endif /* ! GCC_TOPLEV_H */
195