Branch data Line data Source code
1 : : // Copyright (C) 2020-2025 Free Software Foundation, Inc.
2 : :
3 : : // This file is part of GCC.
4 : :
5 : : // GCC is free software; you can redistribute it and/or modify it under
6 : : // the terms of the GNU General Public License as published by the Free
7 : : // Software Foundation; either version 3, or (at your option) any later
8 : : // version.
9 : :
10 : : // GCC is distributed in the hope that it will be useful, but WITHOUT ANY
11 : : // WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 : : // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 : : // for more details.
14 : :
15 : : // You should have received a copy of the GNU General Public License
16 : : // along with GCC; see the file COPYING3. If not see
17 : : // <http://www.gnu.org/licenses/>.
18 : :
19 : : #include "rust-system.h"
20 : : #include "rust-diagnostics.h"
21 : : #include "coretypes.h"
22 : : #include "target.h"
23 : : #include "tree.h"
24 : : #include "gimple-expr.h"
25 : : #include "diagnostic.h"
26 : : #include "opts.h"
27 : : #include "fold-const.h"
28 : : #include "gimplify.h"
29 : : #include "stor-layout.h"
30 : : #include "debug.h"
31 : : #include "convert.h"
32 : : #include "langhooks.h"
33 : : #include "langhooks-def.h"
34 : : #include "selftest.h"
35 : : #include "rust-cfg-parser.h"
36 : : #include "rust-privacy-ctx.h"
37 : : #include "rust-ast-resolve-item.h"
38 : : #include "rust-lex.h"
39 : : #include "optional.h"
40 : : #include "rust-unicode.h"
41 : : #include "rust-punycode.h"
42 : :
43 : : #include <mpfr.h>
44 : : // note: header files must be in this order or else forward declarations don't
45 : : // work properly. Kinda dumb system, but have to live with it. clang-format
46 : : // seems to mess it up
47 : : /* Order: config, system, coretypes, target, tree, gimple-expr, diagnostic,
48 : : * opts, fold-const, gimplify, stor-layout, debug, convert, langhooks,
49 : : * langhooks-def */
50 : :
51 : : // FIXME: test saving intellisense
52 : : #include "options.h"
53 : :
54 : : // version check to stop compiling if c++ isn't c++11 or higher
55 : : #if __cplusplus < 201103
56 : : #error \
57 : : "GCC Rust frontend requires C++11 or higher. You can compile the g++ frontend first and then compile the Rust frontend using that."
58 : : #endif
59 : : // TODO: is this best way to do it? Is it allowed? (should be)
60 : :
61 : : /* General TODOs:
62 : : * - convert all copies of expensive-to-copy (deep copy) AST objects into
63 : : * moves, if possible. Don't remove clone functionality - it may be required for
64 : : * e.g. HIR conversion.
65 : : */
66 : :
67 : : #include "rust-session-manager.h"
68 : : #include "rust-tree.h"
69 : :
70 : : // The resulting tree type.
71 : : union GTY ((
72 : : desc ("TREE_CODE (&%h.generic) == IDENTIFIER_NODE"),
73 : : chain_next (
74 : : "CODE_CONTAINS_STRUCT (TREE_CODE (&%h.generic), "
75 : : "TS_COMMON) ? ((union lang_tree_node *) TREE_CHAIN (&%h.generic)) : NULL")))
76 : : lang_tree_node
77 : : {
78 : : union tree_node GTY ((tag ("0"), desc ("tree_node_structure (&%h)"))) generic;
79 : : struct lang_identifier GTY ((tag ("1"))) identifier;
80 : : };
81 : :
82 : : // has to be in same compilation unit as session, so here for now
83 : : void
84 : 46080 : rust_add_target_info (const char *key, const char *value)
85 : : {
86 : 92160 : Rust::Session::get_instance ().options.target_data.insert_key_value_pair (
87 : 92160 : key, value);
88 : 46080 : }
89 : :
90 : : /* Language hooks. */
91 : :
92 : : /* Initial lang hook called (possibly), used for initialisation.
93 : : * Must call build_common_tree_nodes, set_sizetype, build_common_tree_nodes_2,
94 : : * and build_common_builtin_nodes, as well as set global variable
95 : : * void_list_node. Apparently called after option handling? */
96 : : static bool
97 : 5120 : grs_langhook_init (void)
98 : : {
99 : : /* Something to do with this:
100 : : This allows the code in d-builtins.cc to not have to worry about
101 : : converting (C signed char *) to (D char *) for string arguments of
102 : : built-in functions. The parameter (signed_char = false) specifies
103 : : whether char is signed. */
104 : 5120 : build_common_tree_nodes (false);
105 : :
106 : : // Builds built-ins for middle-end after all front-end built-ins are already
107 : : // instantiated
108 : 5120 : build_common_builtin_nodes ();
109 : :
110 : 5120 : mpfr_set_default_prec (128);
111 : :
112 : 5120 : using_eh_for_cleanups ();
113 : :
114 : : // initialise compiler session
115 : 5120 : Rust::Session::get_instance ().init ();
116 : :
117 : 5120 : return true;
118 : : }
119 : :
120 : : /* The option mask (something to do with options for specific frontends or
121 : : * something). */
122 : : static unsigned int
123 : 14755 : grs_langhook_option_lang_mask (void)
124 : : {
125 : 14755 : return CL_Rust;
126 : : }
127 : :
128 : : /* Initialize the options structure. */
129 : : static void
130 : 5122 : grs_langhook_init_options_struct (struct gcc_options *opts)
131 : : {
132 : : /* Operations are always wrapping in Rust, even on signed integer. This is
133 : : * useful for the low level wrapping_{add, sub, mul} intrinsics, not for
134 : : * regular arithmetic operations which are checked for overflow anyway using
135 : : * builtins */
136 : 5122 : opts->x_flag_wrapv = 1;
137 : :
138 : : /* We need to warn on unused variables by default */
139 : 5122 : opts->x_warn_unused_variable = 1;
140 : : /* For const variables too */
141 : 5122 : opts->x_warn_unused_const_variable = 1;
142 : : /* And finally unused result for #[must_use] */
143 : 5122 : opts->x_warn_unused_result = 1;
144 : : /* lets warn for infinite recursion*/
145 : 5122 : opts->x_warn_infinite_recursion = 1;
146 : : /* Enable exception handling (aka `panic!` in Rust) */
147 : 5122 : opts->x_flag_exceptions = 1;
148 : :
149 : : // nothing yet - used by frontends to change specific options for the language
150 : 5122 : Rust::Session::get_instance ().init_options ();
151 : 5122 : }
152 : :
153 : : /* Main entry point for front-end, apparently. Finds input file names in global
154 : : * vars in_fnames and num_in_fnames. From this, frontend can take over and do
155 : : * actual parsing and initial compilation. This function must create a complete
156 : : * parse tree in a global var, and then return.
157 : : *
158 : : * Some consider this the "start of compilation". */
159 : : static void
160 : 5120 : grs_langhook_parse_file (void)
161 : : {
162 : 5120 : rust_debug ("Preparing to parse files. ");
163 : :
164 : 5120 : Rust::Session::get_instance ().handle_input_files (num_in_fnames, in_fnames);
165 : 5113 : }
166 : :
167 : : /* Seems to get the exact type for a specific type - e.g. for scalar float with
168 : : * 32-bit bitsize, it returns float, and for 64-bit bitsize, it returns double.
169 : : * Used to map RTL nodes to machine modes or something like that. */
170 : : static tree
171 : 39584 : grs_langhook_type_for_mode (machine_mode mode, int unsignedp)
172 : : {
173 : : // TODO: change all this later to match rustc types
174 : 39584 : if (mode == QImode)
175 : 0 : return unsignedp ? unsigned_intQI_type_node : intQI_type_node;
176 : :
177 : 39584 : if (mode == HImode)
178 : 0 : return unsignedp ? unsigned_intHI_type_node : intHI_type_node;
179 : :
180 : 39584 : if (mode == SImode)
181 : 21 : return unsignedp ? unsigned_intSI_type_node : intSI_type_node;
182 : :
183 : 39563 : if (mode == DImode)
184 : 8824 : return unsignedp ? unsigned_intDI_type_node : intDI_type_node;
185 : :
186 : 30739 : if (mode == TYPE_MODE (intTI_type_node))
187 : 19 : return unsignedp ? unsigned_intTI_type_node : intTI_type_node;
188 : :
189 : 30720 : if (mode == TYPE_MODE (float_type_node))
190 : 0 : return float_type_node;
191 : :
192 : 30720 : if (mode == TYPE_MODE (double_type_node))
193 : 0 : return double_type_node;
194 : :
195 : 30720 : if (mode == TYPE_MODE (long_double_type_node))
196 : 0 : return long_double_type_node;
197 : :
198 : 30720 : if (COMPLEX_MODE_P (mode))
199 : : {
200 : 30720 : if (mode == TYPE_MODE (complex_float_type_node))
201 : 5120 : return complex_float_type_node;
202 : 25600 : if (mode == TYPE_MODE (complex_double_type_node))
203 : 5120 : return complex_double_type_node;
204 : 20480 : if (mode == TYPE_MODE (complex_long_double_type_node))
205 : 5120 : return complex_long_double_type_node;
206 : 15360 : if (mode == TYPE_MODE (complex_integer_type_node) && !unsignedp)
207 : 0 : return complex_integer_type_node;
208 : : }
209 : :
210 : : /* See (a) <https://github.com/Rust-GCC/gccrs/issues/1713>
211 : : "Test failure on msp430-elfbare target", and
212 : : (b) <https://gcc.gnu.org/PR46805>
213 : : "ICE: SIGSEGV in optab_for_tree_code (optabs.c:407) with -O
214 : : -fno-tree-scev-cprop -ftree-vectorize"
215 : : -- we have to support "random" modes/types here.
216 : : TODO Clean all this up (either locally, or preferably per PR46805:
217 : : "Ideally we'd never use lang_hooks.types.type_for_mode (or _for_size) in
218 : : the middle-end but had a pure middle-end based implementation". */
219 : 30720 : for (size_t i = 0; i < NUM_INT_N_ENTS; i++)
220 : 15360 : if (int_n_enabled_p[i] && mode == int_n_data[i].m)
221 : 0 : return (unsignedp ? int_n_trees[i].unsigned_type
222 : 0 : : int_n_trees[i].signed_type);
223 : :
224 : : /* rust_unreachable */
225 : : return NULL;
226 : : }
227 : :
228 : : // Record a builtin function. We just ignore builtin functions.
229 : : static tree
230 : 1943104 : grs_langhook_builtin_function (tree decl ATTRIBUTE_UNUSED)
231 : : {
232 : 1943104 : return decl;
233 : : }
234 : :
235 : : /* Return true if we are in the global binding level (which is never,
236 : : * apparently). */
237 : : static bool
238 : 540 : grs_langhook_global_bindings_p (void)
239 : : {
240 : : // return current_function_decl == NULL_TREE;
241 : : // rust_unreachable();
242 : : // return true;
243 : 540 : return false;
244 : : }
245 : :
246 : : /* Push a declaration into the current binding level. We can't
247 : : usefully implement this since we don't want to convert from tree
248 : : back to one of our internal data structures. I think the only way
249 : : this is used is to record a decl which is to be returned by
250 : : getdecls, and we could implement it for that purpose if
251 : : necessary. */
252 : : static tree
253 : 0 : grs_langhook_pushdecl (tree decl ATTRIBUTE_UNUSED)
254 : : {
255 : 0 : rust_unreachable ();
256 : : return NULL;
257 : : }
258 : :
259 : : /* This hook is used to get the current list of declarations as trees.
260 : : We don't support that; instead we use the write_globals hook. This
261 : : can't simply crash because it is called by -gstabs. */
262 : : static tree
263 : 0 : grs_langhook_getdecls (void)
264 : : {
265 : : // rust_unreachable();
266 : 0 : return NULL;
267 : : }
268 : :
269 : : // Handle Rust-specific options. Return false if nothing happened.
270 : : static bool
271 : 47421 : grs_langhook_handle_option (
272 : : size_t scode, const char *arg, HOST_WIDE_INT value, int kind ATTRIBUTE_UNUSED,
273 : : location_t loc ATTRIBUTE_UNUSED,
274 : : const struct cl_option_handlers *handlers ATTRIBUTE_UNUSED)
275 : : {
276 : : // Convert integer code to lang.opt enum codes with names.
277 : 47421 : enum opt_code code = (enum opt_code) scode;
278 : :
279 : : // Delegate to session manager
280 : 47421 : return Rust::Session::get_instance ().handle_option (code, arg, value, kind,
281 : 47421 : loc, handlers);
282 : : }
283 : :
284 : : /* Run after parsing options. */
285 : : static bool
286 : 5122 : grs_langhook_post_options (const char **pfilename ATTRIBUTE_UNUSED)
287 : : {
288 : : // can be used to override other options if required
289 : :
290 : : // satisfies an assert in init_excess_precision in toplev.cc
291 : 5122 : if (flag_excess_precision /*_cmdline*/ == EXCESS_PRECISION_DEFAULT)
292 : 5122 : flag_excess_precision /*_cmdline*/ = EXCESS_PRECISION_STANDARD;
293 : :
294 : : /* Returning false means that the backend should be used. */
295 : 5122 : return false;
296 : : }
297 : :
298 : : /* Rust-specific gimplification. May need to gimplify e.g.
299 : : * CALL_EXPR_STATIC_CHAIN */
300 : : static int
301 : 463906 : grs_langhook_gimplify_expr (tree *expr_p ATTRIBUTE_UNUSED,
302 : : gimple_seq *pre_p ATTRIBUTE_UNUSED,
303 : : gimple_seq *post_p ATTRIBUTE_UNUSED)
304 : : {
305 : 463906 : if (TREE_CODE (*expr_p) == CALL_EXPR
306 : 463906 : && CALL_EXPR_STATIC_CHAIN (*expr_p) != NULL_TREE)
307 : 0 : gimplify_expr (&CALL_EXPR_STATIC_CHAIN (*expr_p), pre_p, post_p,
308 : : is_gimple_val, fb_rvalue);
309 : 463906 : return GS_UNHANDLED;
310 : : }
311 : :
312 : : static tree
313 : 4 : grs_langhook_eh_personality (void)
314 : : {
315 : 4 : static tree personality_decl;
316 : 4 : if (personality_decl == NULL_TREE)
317 : : {
318 : 4 : personality_decl = build_personality_function ("gccrs");
319 : 4 : rust_preserve_from_gc (personality_decl);
320 : : }
321 : 4 : return personality_decl;
322 : : }
323 : :
324 : : tree
325 : 222 : convert (tree type, tree expr)
326 : : {
327 : 222 : if (type == error_mark_node || expr == error_mark_node
328 : 444 : || TREE_TYPE (expr) == error_mark_node)
329 : : return error_mark_node;
330 : :
331 : 222 : if (type == TREE_TYPE (expr))
332 : : return expr;
333 : :
334 : 222 : if (TYPE_MAIN_VARIANT (type) == TYPE_MAIN_VARIANT (TREE_TYPE (expr)))
335 : 0 : return fold_convert (type, expr);
336 : :
337 : 222 : switch (TREE_CODE (type))
338 : : {
339 : 0 : case VOID_TYPE:
340 : 0 : case BOOLEAN_TYPE:
341 : 0 : return fold_convert (type, expr);
342 : 111 : case INTEGER_TYPE:
343 : 111 : return convert_to_integer (type, expr);
344 : 111 : case POINTER_TYPE:
345 : 111 : return convert_to_pointer (type, expr);
346 : 0 : case REAL_TYPE:
347 : 0 : return convert_to_real (type, expr);
348 : 0 : case COMPLEX_TYPE:
349 : 0 : return convert_to_complex (type, expr);
350 : 0 : default:
351 : 0 : break;
352 : : }
353 : :
354 : 0 : rust_unreachable ();
355 : : }
356 : :
357 : : /* FIXME: This is a hack to preserve trees that we create from the
358 : : garbage collector. */
359 : :
360 : : static GTY (()) tree rust_gc_root;
361 : :
362 : : void
363 : 147461 : rust_preserve_from_gc (tree t)
364 : : {
365 : 147461 : rust_gc_root = tree_cons (NULL_TREE, t, rust_gc_root);
366 : 147461 : }
367 : :
368 : : /* Convert an identifier for use in an error message. */
369 : :
370 : : const char *
371 : 0 : rust_localize_identifier (const char *ident)
372 : : {
373 : 0 : return identifier_to_locale (ident);
374 : : }
375 : :
376 : : extern const attribute_spec grs_langhook_common_attribute_table[];
377 : :
378 : : /* The language hooks data structure. This is the main interface between the GCC
379 : : * front-end and the GCC middle-end/back-end. A list of language hooks could be
380 : : * found in <gcc>/langhooks.h
381 : : */
382 : : #undef LANG_HOOKS_NAME
383 : : #undef LANG_HOOKS_INIT
384 : : #undef LANG_HOOKS_OPTION_LANG_MASK
385 : : #undef LANG_HOOKS_INIT_OPTIONS_STRUCT
386 : : #undef LANG_HOOKS_HANDLE_OPTION
387 : : #undef LANG_HOOKS_POST_OPTIONS
388 : : #undef LANG_HOOKS_PARSE_FILE
389 : : #undef LANG_HOOKS_TYPE_FOR_MODE
390 : : #undef LANG_HOOKS_BUILTIN_FUNCTION
391 : : #undef LANG_HOOKS_GLOBAL_BINDINGS_P
392 : : #undef LANG_HOOKS_PUSHDECL
393 : : #undef LANG_HOOKS_GETDECLS
394 : : #undef LANG_HOOKS_WRITE_GLOBALS
395 : : #undef LANG_HOOKS_GIMPLIFY_EXPR
396 : : #undef LANG_HOOKS_EH_PERSONALITY
397 : :
398 : : #undef LANG_HOOKS_COMMON_ATTRIBUTE_TABLE
399 : :
400 : : #define LANG_HOOKS_NAME "GNU Rust"
401 : : #define LANG_HOOKS_INIT grs_langhook_init
402 : : #define LANG_HOOKS_OPTION_LANG_MASK grs_langhook_option_lang_mask
403 : : #define LANG_HOOKS_INIT_OPTIONS_STRUCT grs_langhook_init_options_struct
404 : : #define LANG_HOOKS_HANDLE_OPTION grs_langhook_handle_option
405 : : #define LANG_HOOKS_POST_OPTIONS grs_langhook_post_options
406 : : /* Main lang-hook, apparently. Finds input file names in global vars in_fnames
407 : : * and num_in_fnames From this, frontend can take over and do actual parsing and
408 : : * initial compilation.
409 : : * This hook must create a complete parse tree in a global var, and then return.
410 : : */
411 : : #define LANG_HOOKS_PARSE_FILE grs_langhook_parse_file
412 : : #define LANG_HOOKS_TYPE_FOR_MODE grs_langhook_type_for_mode
413 : : #define LANG_HOOKS_BUILTIN_FUNCTION grs_langhook_builtin_function
414 : : #define LANG_HOOKS_GLOBAL_BINDINGS_P grs_langhook_global_bindings_p
415 : : #define LANG_HOOKS_PUSHDECL grs_langhook_pushdecl
416 : : #define LANG_HOOKS_GETDECLS grs_langhook_getdecls
417 : : #define LANG_HOOKS_GIMPLIFY_EXPR grs_langhook_gimplify_expr
418 : : #define LANG_HOOKS_EH_PERSONALITY grs_langhook_eh_personality
419 : :
420 : : #define LANG_HOOKS_COMMON_ATTRIBUTE_TABLE grs_langhook_common_attribute_table
421 : :
422 : : #if CHECKING_P
423 : :
424 : : #undef LANG_HOOKS_RUN_LANG_SELFTESTS
425 : : #define LANG_HOOKS_RUN_LANG_SELFTESTS selftest::run_rust_tests
426 : :
427 : : namespace selftest {
428 : :
429 : : void
430 : 1 : run_rust_tests ()
431 : : {
432 : : // Call tests for the rust frontend here
433 : 1 : rust_input_source_test ();
434 : 1 : rust_nfc_qc_test ();
435 : 1 : rust_utf8_normalize_test ();
436 : 1 : rust_punycode_encode_test ();
437 : 1 : rust_cfg_parser_test ();
438 : 1 : rust_privacy_ctx_test ();
439 : 1 : rust_crate_name_validation_test ();
440 : 1 : rust_simple_path_resolve_test ();
441 : 1 : }
442 : : } // namespace selftest
443 : :
444 : : #endif /* !CHECKING_P */
445 : :
446 : : // Expands all LANG_HOOKS_x of GCC
447 : : struct lang_hooks lang_hooks = LANG_HOOKS_INITIALIZER;
448 : :
449 : : // These are for GCC's garbage collector to work properly or something
450 : : #include "gt-rust-rust-lang.h"
451 : : #include "gtype-rust.h"
|
