compiler: associate escape_marks to to frame (because of inlining)
[nit.git] / src / compiler / abstract_compiler.nit
1 # This file is part of NIT ( http://www.nitlanguage.org ).
2 #
3 # Copyright 2012 Jean Privat <jean@pryen.org>
4 #
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16
17 # Abstract compiler
18 module abstract_compiler
19
20 import literal
21 import semantize
22 import platform
23 import c_tools
24 private import annotation
25 import mixin
26
27 # Add compiling options
28 redef class ToolContext
29 # --output
30 var opt_output = new OptionString("Output file", "-o", "--output")
31 # --dir
32 var opt_dir = new OptionString("Output directory", "--dir")
33 # --no-cc
34 var opt_no_cc = new OptionBool("Do not invoke C compiler", "--no-cc")
35 # --no-main
36 var opt_no_main = new OptionBool("Do not generate main entry point", "--no-main")
37 # --make-flags
38 var opt_make_flags = new OptionString("Additional options to make", "--make-flags")
39 # --max-c-lines
40 var opt_max_c_lines = new OptionInt("Maximum number of lines in generated C files. Use 0 for unlimited", 10000, "--max-c-lines")
41 # --group-c-files
42 var opt_group_c_files = new OptionBool("Group all generated code in the same series of files", "--group-c-files")
43 # --compile-dir
44 var opt_compile_dir = new OptionString("Directory used to generate temporary files", "--compile-dir")
45 # --hardening
46 var opt_hardening = new OptionBool("Generate contracts in the C code against bugs in the compiler", "--hardening")
47 # --no-check-covariance
48 var opt_no_check_covariance = new OptionBool("Disable type tests of covariant parameters (dangerous)", "--no-check-covariance")
49 # --no-check-attr-isset
50 var opt_no_check_attr_isset = new OptionBool("Disable isset tests before each attribute access (dangerous)", "--no-check-attr-isset")
51 # --no-check-assert
52 var opt_no_check_assert = new OptionBool("Disable the evaluation of explicit 'assert' and 'as' (dangerous)", "--no-check-assert")
53 # --no-check-autocast
54 var opt_no_check_autocast = new OptionBool("Disable implicit casts on unsafe expression usage (dangerous)", "--no-check-autocast")
55 # --no-check-null
56 var opt_no_check_null = new OptionBool("Disable tests of null receiver (dangerous)", "--no-check-null")
57 # --no-check-all
58 var opt_no_check_all = new OptionBool("Disable all tests (dangerous)", "--no-check-all")
59 # --typing-test-metrics
60 var opt_typing_test_metrics = new OptionBool("Enable static and dynamic count of all type tests", "--typing-test-metrics")
61 # --invocation-metrics
62 var opt_invocation_metrics = new OptionBool("Enable static and dynamic count of all method invocations", "--invocation-metrics")
63 # --isset-checks-metrics
64 var opt_isset_checks_metrics = new OptionBool("Enable static and dynamic count of isset checks before attributes access", "--isset-checks-metrics")
65 # --stacktrace
66 var opt_stacktrace = new OptionString("Control the generation of stack traces", "--stacktrace")
67 # --no-gcc-directives
68 var opt_no_gcc_directive = new OptionArray("Disable a advanced gcc directives for optimization", "--no-gcc-directive")
69 # --release
70 var opt_release = new OptionBool("Compile in release mode and finalize application", "--release")
71
72 redef init
73 do
74 super
75 self.option_context.add_option(self.opt_output, self.opt_dir, self.opt_no_cc, self.opt_no_main, self.opt_make_flags, self.opt_compile_dir, self.opt_hardening)
76 self.option_context.add_option(self.opt_no_check_covariance, self.opt_no_check_attr_isset, self.opt_no_check_assert, self.opt_no_check_autocast, self.opt_no_check_null, self.opt_no_check_all)
77 self.option_context.add_option(self.opt_typing_test_metrics, self.opt_invocation_metrics, self.opt_isset_checks_metrics)
78 self.option_context.add_option(self.opt_stacktrace)
79 self.option_context.add_option(self.opt_no_gcc_directive)
80 self.option_context.add_option(self.opt_release)
81 self.option_context.add_option(self.opt_max_c_lines, self.opt_group_c_files)
82
83 opt_no_main.hidden = true
84 end
85
86 redef fun process_options(args)
87 do
88 super
89
90 var st = opt_stacktrace.value
91 if st == "none" or st == "libunwind" or st == "nitstack" then
92 # Fine, do nothing
93 else if st == "auto" or st == null then
94 # Default is nitstack
95 opt_stacktrace.value = "nitstack"
96 else
97 print "Error: unknown value `{st}` for --stacktrace. Use `none`, `libunwind`, `nitstack` or `auto`."
98 exit(1)
99 end
100
101 if opt_output.value != null and opt_dir.value != null then
102 print "Error: cannot use both --dir and --output"
103 exit(1)
104 end
105
106 if opt_no_check_all.value then
107 opt_no_check_covariance.value = true
108 opt_no_check_attr_isset.value = true
109 opt_no_check_assert.value = true
110 opt_no_check_autocast.value = true
111 opt_no_check_null.value = true
112 end
113 end
114 end
115
116 redef class ModelBuilder
117 # The compilation directory
118 var compile_dir: String
119
120 # Simple indirection to `Toolchain::write_and_make`
121 protected fun write_and_make(compiler: AbstractCompiler)
122 do
123 var platform = compiler.mainmodule.target_platform
124 var toolchain
125 if platform == null then
126 toolchain = new MakefileToolchain(toolcontext)
127 else
128 toolchain = platform.toolchain(toolcontext)
129 end
130 compile_dir = toolchain.compile_dir
131 toolchain.write_and_make compiler
132 end
133 end
134
135 redef class Platform
136 fun toolchain(toolcontext: ToolContext): Toolchain is abstract
137 end
138
139 class Toolchain
140 var toolcontext: ToolContext
141
142 fun compile_dir: String
143 do
144 var compile_dir = toolcontext.opt_compile_dir.value
145 if compile_dir == null then compile_dir = ".nit_compile"
146 return compile_dir
147 end
148
149 fun write_and_make(compiler: AbstractCompiler) is abstract
150 end
151
152 class MakefileToolchain
153 super Toolchain
154
155 redef fun write_and_make(compiler)
156 do
157 var compile_dir = compile_dir
158
159 # Generate the .h and .c files
160 # A single C file regroups many compiled rumtime functions
161 # Note that we do not try to be clever an a small change in a Nit source file may change the content of all the generated .c files
162 var time0 = get_time
163 self.toolcontext.info("*** WRITING C ***", 1)
164
165 compile_dir.mkdir
166
167 var cfiles = new Array[String]
168 write_files(compiler, compile_dir, cfiles)
169
170 # Generate the Makefile
171
172 write_makefile(compiler, compile_dir, cfiles)
173
174 var time1 = get_time
175 self.toolcontext.info("*** END WRITING C: {time1-time0} ***", 2)
176
177 # Execute the Makefile
178
179 if self.toolcontext.opt_no_cc.value then return
180
181 time0 = time1
182 self.toolcontext.info("*** COMPILING C ***", 1)
183
184 compile_c_code(compiler, compile_dir)
185
186 time1 = get_time
187 self.toolcontext.info("*** END COMPILING C: {time1-time0} ***", 2)
188 end
189
190 fun write_files(compiler: AbstractCompiler, compile_dir: String, cfiles: Array[String])
191 do
192 var platform = compiler.mainmodule.target_platform
193 if self.toolcontext.opt_stacktrace.value == "nitstack" and (platform == null or platform.supports_libunwind) then compiler.build_c_to_nit_bindings
194 var cc_opt_with_libgc = "-DWITH_LIBGC"
195 if platform != null and not platform.supports_libgc then cc_opt_with_libgc = ""
196
197 # Add gc_choser.h to aditionnal bodies
198 var gc_chooser = new ExternCFile("gc_chooser.c", cc_opt_with_libgc)
199 if cc_opt_with_libgc != "" then gc_chooser.pkgconfigs.add "bdw-gc"
200 compiler.extern_bodies.add(gc_chooser)
201 var clib = toolcontext.nit_dir / "clib"
202 compiler.files_to_copy.add "{clib}/gc_chooser.c"
203 compiler.files_to_copy.add "{clib}/gc_chooser.h"
204
205 # FFI
206 for m in compiler.mainmodule.in_importation.greaters do
207 compiler.finalize_ffi_for_module(m)
208 end
209
210 # Copy original .[ch] files to compile_dir
211 for src in compiler.files_to_copy do
212 var basename = src.basename("")
213 var dst = "{compile_dir}/{basename}"
214 src.file_copy_to dst
215 end
216
217 var hfilename = compiler.header.file.name + ".h"
218 var hfilepath = "{compile_dir}/{hfilename}"
219 var h = new OFStream.open(hfilepath)
220 for l in compiler.header.decl_lines do
221 h.write l
222 h.write "\n"
223 end
224 for l in compiler.header.lines do
225 h.write l
226 h.write "\n"
227 end
228 h.close
229
230 var max_c_lines = toolcontext.opt_max_c_lines.value
231 for f in compiler.files do
232 var i = 0
233 var count = 0
234 var file: nullable OFStream = null
235 for vis in f.writers do
236 if vis == compiler.header then continue
237 var total_lines = vis.lines.length + vis.decl_lines.length
238 if total_lines == 0 then continue
239 count += total_lines
240 if file == null or (count > max_c_lines and max_c_lines > 0) then
241 i += 1
242 if file != null then file.close
243 var cfilename = "{f.name}.{i}.c"
244 var cfilepath = "{compile_dir}/{cfilename}"
245 self.toolcontext.info("new C source files to compile: {cfilepath}", 3)
246 cfiles.add(cfilename)
247 file = new OFStream.open(cfilepath)
248 file.write "#include \"{f.name}.0.h\"\n"
249 count = total_lines
250 end
251 for l in vis.decl_lines do
252 file.write l
253 file.write "\n"
254 end
255 for l in vis.lines do
256 file.write l
257 file.write "\n"
258 end
259 end
260 if file == null then continue
261 file.close
262
263 var cfilename = "{f.name}.0.h"
264 var cfilepath = "{compile_dir}/{cfilename}"
265 var hfile: nullable OFStream = null
266 hfile = new OFStream.open(cfilepath)
267 hfile.write "#include \"{hfilename}\"\n"
268 for key in f.required_declarations do
269 if not compiler.provided_declarations.has_key(key) then
270 var node = compiler.requirers_of_declarations.get_or_null(key)
271 if node != null then
272 node.debug "No provided declaration for {key}"
273 else
274 print "No provided declaration for {key}"
275 end
276 abort
277 end
278 hfile.write compiler.provided_declarations[key]
279 hfile.write "\n"
280 end
281 hfile.close
282 end
283
284 self.toolcontext.info("Total C source files to compile: {cfiles.length}", 2)
285 end
286
287 fun makefile_name(mainmodule: MModule): String do return "{mainmodule.c_name}.mk"
288
289 fun default_outname(mainmodule: MModule): String
290 do
291 # Search a non fictive module
292 var res = mainmodule.name
293 while mainmodule.is_fictive do
294 mainmodule = mainmodule.in_importation.direct_greaters.first
295 res = mainmodule.name
296 end
297 return res
298 end
299
300 # Combine options and platform informations to get the final path of the outfile
301 fun outfile(mainmodule: MModule): String
302 do
303 var res = self.toolcontext.opt_output.value
304 if res != null then return res
305 res = default_outname(mainmodule)
306 var dir = self.toolcontext.opt_dir.value
307 if dir != null then return dir.join_path(res)
308 return res
309 end
310
311 fun write_makefile(compiler: AbstractCompiler, compile_dir: String, cfiles: Array[String])
312 do
313 var mainmodule = compiler.mainmodule
314 var platform = compiler.mainmodule.target_platform
315
316 var outname = outfile(mainmodule)
317
318 var real_outpath = compile_dir.relpath(outname)
319 var outpath = real_outpath.escape_to_mk
320 if outpath != real_outpath then
321 # If the name is crazy and need escaping, we will do an indirection
322 # 1. generate the binary in the .nit_compile dir under an escaped name
323 # 2. copy the binary at the right place in the `all` goal.
324 outpath = mainmodule.c_name
325 end
326 var makename = makefile_name(mainmodule)
327 var makepath = "{compile_dir}/{makename}"
328 var makefile = new OFStream.open(makepath)
329
330 var linker_options = new HashSet[String]
331 for m in mainmodule.in_importation.greaters do
332 var libs = m.collect_linker_libs
333 if libs != null then linker_options.add_all(libs)
334 end
335
336 makefile.write("CC = ccache cc\nCXX = ccache c++\nCFLAGS = -g -O2 -Wno-unused-value -Wno-switch -Wno-attributes\nCINCL =\nLDFLAGS ?= \nLDLIBS ?= -lm {linker_options.join(" ")}\n\n")
337
338 var ost = toolcontext.opt_stacktrace.value
339 if (ost == "libunwind" or ost == "nitstack") and (platform == null or platform.supports_libunwind) then makefile.write("NEED_LIBUNWIND := YesPlease\n")
340
341 # Dynamic adaptations
342 # While `platform` enable complex toolchains, they are statically applied
343 # For a dynamic adaptsation of the compilation, the generated Makefile should check and adapt things itself
344
345 # Check and adapt the targeted system
346 makefile.write("uname_S := $(shell sh -c 'uname -s 2>/dev/null || echo not')\n")
347 makefile.write("ifeq ($(uname_S),Darwin)\n")
348 # remove -lunwind since it is already included on macosx
349 makefile.write("\tNEED_LIBUNWIND :=\n")
350 makefile.write("endif\n\n")
351
352 # Check and adapt for the compiler used
353 # clang need an additionnal `-Qunused-arguments`
354 makefile.write("clang_check := $(shell sh -c '$(CC) -v 2>&1 | grep -q clang; echo $$?')\nifeq ($(clang_check), 0)\n\tCFLAGS += -Qunused-arguments\nendif\n")
355
356 makefile.write("ifdef NEED_LIBUNWIND\n\tLDLIBS += -lunwind\nendif\n")
357
358 makefile.write("all: {outpath}\n")
359 if outpath != real_outpath then
360 makefile.write("\tcp -- {outpath.escape_to_sh} {real_outpath.escape_to_sh.replace("$","$$")}")
361 end
362 makefile.write("\n")
363
364 var ofiles = new Array[String]
365 var dep_rules = new Array[String]
366 # Compile each generated file
367 for f in cfiles do
368 var o = f.strip_extension(".c") + ".o"
369 makefile.write("{o}: {f}\n\t$(CC) $(CFLAGS) $(CINCL) -c -o {o} {f}\n\n")
370 ofiles.add(o)
371 dep_rules.add(o)
372 end
373
374 var java_files = new Array[ExternFile]
375
376 var pkgconfigs = new Array[String]
377 for f in compiler.extern_bodies do
378 pkgconfigs.add_all f.pkgconfigs
379 end
380 # Protect pkg-config
381 if not pkgconfigs.is_empty then
382 makefile.write """
383 # does pkg-config exists?
384 ifneq ($(shell which pkg-config >/dev/null; echo $$?), 0)
385 $(error "Command `pkg-config` not found. Please install it")
386 endif
387 """
388 for p in pkgconfigs do
389 makefile.write """
390 # Check for library {{{p}}}
391 ifneq ($(shell pkg-config --exists '{{{p}}}'; echo $$?), 0)
392 $(error "pkg-config: package {{{p}}} is not found.")
393 endif
394 """
395 end
396 end
397
398 # Compile each required extern body into a specific .o
399 for f in compiler.extern_bodies do
400 var o = f.makefile_rule_name
401 var ff = f.filename.basename("")
402 makefile.write("{o}: {ff}\n")
403 makefile.write("\t{f.makefile_rule_content}\n\n")
404 dep_rules.add(f.makefile_rule_name)
405
406 if f.compiles_to_o_file then ofiles.add(o)
407 if f.add_to_jar then java_files.add(f)
408 end
409
410 if not java_files.is_empty then
411 var jar_file = "{outpath}.jar"
412
413 var class_files_array = new Array[String]
414 for f in java_files do class_files_array.add(f.makefile_rule_name)
415 var class_files = class_files_array.join(" ")
416
417 makefile.write("{jar_file}: {class_files}\n")
418 makefile.write("\tjar cf {jar_file} {class_files}\n\n")
419 dep_rules.add jar_file
420 end
421
422 # Link edition
423 var pkg = ""
424 if not pkgconfigs.is_empty then
425 pkg = "`pkg-config --libs {pkgconfigs.join(" ")}`"
426 end
427 makefile.write("{outpath}: {dep_rules.join(" ")}\n\t$(CC) $(LDFLAGS) -o {outpath.escape_to_sh} {ofiles.join(" ")} $(LDLIBS) {pkg}\n\n")
428 # Clean
429 makefile.write("clean:\n\trm {ofiles.join(" ")} 2>/dev/null\n")
430 if outpath != real_outpath then
431 makefile.write("\trm -- {outpath.escape_to_sh} 2>/dev/null\n")
432 end
433 makefile.close
434 self.toolcontext.info("Generated makefile: {makepath}", 2)
435
436 makepath.file_copy_to "{compile_dir}/Makefile"
437 end
438
439 fun compile_c_code(compiler: AbstractCompiler, compile_dir: String)
440 do
441 var makename = makefile_name(compiler.mainmodule)
442
443 var makeflags = self.toolcontext.opt_make_flags.value
444 if makeflags == null then makeflags = ""
445 self.toolcontext.info("make -B -C {compile_dir} -f {makename} -j 4 {makeflags}", 2)
446
447 var res
448 if self.toolcontext.verbose_level >= 3 then
449 res = sys.system("make -B -C {compile_dir} -f {makename} -j 4 {makeflags} 2>&1")
450 else
451 res = sys.system("make -B -C {compile_dir} -f {makename} -j 4 {makeflags} 2>&1 >/dev/null")
452 end
453 if res != 0 then
454 toolcontext.error(null, "make failed! Error code: {res}.")
455 end
456 end
457 end
458
459 # Singleton that store the knowledge about the compilation process
460 abstract class AbstractCompiler
461 type VISITOR: AbstractCompilerVisitor
462
463 # Table corresponding c_names to nit names (methods)
464 var names = new HashMap[String, String]
465
466 # The main module of the program currently compiled
467 # Is assigned during the separate compilation
468 var mainmodule: MModule is writable
469
470 # The real main module of the program
471 var realmainmodule: MModule is noinit
472
473 # The modelbuilder used to know the model and the AST
474 var modelbuilder: ModelBuilder is protected writable
475
476 # Is hardening asked? (see --hardening)
477 fun hardening: Bool do return self.modelbuilder.toolcontext.opt_hardening.value
478
479 init
480 do
481 self.realmainmodule = mainmodule
482 end
483
484 # Force the creation of a new file
485 # The point is to avoid contamination between must-be-compiled-separately files
486 fun new_file(name: String): CodeFile
487 do
488 if modelbuilder.toolcontext.opt_group_c_files.value then
489 if self.files.is_empty then
490 var f = new CodeFile(mainmodule.c_name)
491 self.files.add(f)
492 end
493 return self.files.first
494 end
495 var f = new CodeFile(name)
496 self.files.add(f)
497 return f
498 end
499
500 # The list of all associated files
501 # Used to generate .c files
502 var files = new List[CodeFile]
503
504 # Initialize a visitor specific for a compiler engine
505 fun new_visitor: VISITOR is abstract
506
507 # Where global declaration are stored (the main .h)
508 var header: CodeWriter is writable, noinit
509
510 # Provide a declaration that can be requested (before or latter) by a visitor
511 fun provide_declaration(key: String, s: String)
512 do
513 if self.provided_declarations.has_key(key) then
514 assert self.provided_declarations[key] == s
515 end
516 self.provided_declarations[key] = s
517 end
518
519 private var provided_declarations = new HashMap[String, String]
520
521 private var requirers_of_declarations = new HashMap[String, ANode]
522
523 # Builds the .c and .h files to be used when generating a Stack Trace
524 # Binds the generated C function names to Nit function names
525 fun build_c_to_nit_bindings
526 do
527 var compile_dir = modelbuilder.compile_dir
528
529 var stream = new OFStream.open("{compile_dir}/c_functions_hash.c")
530 stream.write("#include <string.h>\n")
531 stream.write("#include <stdlib.h>\n")
532 stream.write("#include \"c_functions_hash.h\"\n")
533 stream.write("typedef struct C_Nit_Names\{char* name; char* nit_name;\}C_Nit_Names;\n")
534 stream.write("const char* get_nit_name(register const char* procproc, register unsigned int len)\{\n")
535 stream.write("char* procname = malloc(len+1);")
536 stream.write("memcpy(procname, procproc, len);")
537 stream.write("procname[len] = '\\0';")
538 stream.write("static const C_Nit_Names map[{names.length}] = \{\n")
539 for i in names.keys do
540 stream.write("\{\"")
541 stream.write(i.escape_to_c)
542 stream.write("\",\"")
543 stream.write(names[i].escape_to_c)
544 stream.write("\"\},\n")
545 end
546 stream.write("\};\n")
547 stream.write("int i;")
548 stream.write("for(i = 0; i < {names.length}; i++)\{")
549 stream.write("if(strcmp(procname,map[i].name) == 0)\{")
550 stream.write("free(procname);")
551 stream.write("return map[i].nit_name;")
552 stream.write("\}")
553 stream.write("\}")
554 stream.write("free(procname);")
555 stream.write("return NULL;")
556 stream.write("\}\n")
557 stream.close
558
559 stream = new OFStream.open("{compile_dir}/c_functions_hash.h")
560 stream.write("const char* get_nit_name(register const char* procname, register unsigned int len);\n")
561 stream.close
562
563 extern_bodies.add(new ExternCFile("{compile_dir}/c_functions_hash.c", ""))
564 end
565
566 # Compile C headers
567 # This method call compile_header_strucs method that has to be refined
568 fun compile_header do
569 self.header.add_decl("#include <stdlib.h>")
570 self.header.add_decl("#include <stdio.h>")
571 self.header.add_decl("#include <string.h>")
572 self.header.add_decl("#include \"gc_chooser.h\"")
573 self.header.add_decl("#ifdef ANDROID")
574 self.header.add_decl(" #include <android/log.h>")
575 self.header.add_decl(" #define PRINT_ERROR(...) (void)__android_log_print(ANDROID_LOG_WARN, \"Nit\", __VA_ARGS__)")
576 self.header.add_decl("#else")
577 self.header.add_decl(" #define PRINT_ERROR(...) fprintf(stderr, __VA_ARGS__)")
578 self.header.add_decl("#endif")
579
580 compile_header_structs
581 compile_nitni_structs
582
583 var gccd_disable = modelbuilder.toolcontext.opt_no_gcc_directive.value
584 if gccd_disable.has("noreturn") or gccd_disable.has("all") then
585 # Signal handler function prototype
586 self.header.add_decl("void show_backtrace(int);")
587 else
588 self.header.add_decl("void show_backtrace(int) __attribute__ ((noreturn));")
589 end
590
591 if gccd_disable.has("likely") or gccd_disable.has("all") then
592 self.header.add_decl("#define likely(x) (x)")
593 self.header.add_decl("#define unlikely(x) (x)")
594 else if gccd_disable.has("correct-likely") then
595 # invert the `likely` definition
596 # Used by masochists to bench the worst case
597 self.header.add_decl("#define likely(x) __builtin_expect((x),0)")
598 self.header.add_decl("#define unlikely(x) __builtin_expect((x),1)")
599 else
600 self.header.add_decl("#define likely(x) __builtin_expect((x),1)")
601 self.header.add_decl("#define unlikely(x) __builtin_expect((x),0)")
602 end
603
604 # Global variable used by intern methods
605 self.header.add_decl("extern int glob_argc;")
606 self.header.add_decl("extern char **glob_argv;")
607 self.header.add_decl("extern val *glob_sys;")
608 end
609
610 # Declaration of structures for live Nit types
611 protected fun compile_header_structs is abstract
612
613 # Declaration of structures for nitni undelying the FFI
614 protected fun compile_nitni_structs
615 do
616 self.header.add_decl """
617 /* Native reference to Nit objects */
618 /* This structure is used to represent every Nit type in extern methods and custom C code. */
619 struct nitni_ref {
620 struct nitni_ref *next,
621 *prev; /* adjacent global references in global list */
622 int count; /* number of time this global reference has been marked */
623 };
624
625 /* List of global references from C code to Nit objects */
626 /* Instanciated empty at init of Nit system and filled explicitly by user in C code */
627 struct nitni_global_ref_list_t {
628 struct nitni_ref *head, *tail;
629 };
630 extern struct nitni_global_ref_list_t *nitni_global_ref_list;
631
632 /* Initializer of global reference list */
633 extern void nitni_global_ref_list_init();
634
635 /* Intern function to add a global reference to the list */
636 extern void nitni_global_ref_add( struct nitni_ref *ref );
637
638 /* Intern function to remove a global reference from the list */
639 extern void nitni_global_ref_remove( struct nitni_ref *ref );
640
641 /* Increase count on an existing global reference */
642 extern void nitni_global_ref_incr( struct nitni_ref *ref );
643
644 /* Decrease count on an existing global reference */
645 extern void nitni_global_ref_decr( struct nitni_ref *ref );
646 """
647 end
648
649 fun compile_finalizer_function
650 do
651 var finalizable_type = mainmodule.finalizable_type
652 if finalizable_type == null then return
653
654 var finalize_meth = mainmodule.try_get_primitive_method("finalize", finalizable_type.mclass)
655
656 if finalize_meth == null then
657 modelbuilder.toolcontext.error(null, "The `Finalizable` class doesn't declare the `finalize` method.")
658 return
659 end
660
661 var v = self.new_visitor
662 v.add_decl "void gc_finalize (void *obj, void *client_data) \{"
663 var recv = v.new_expr("obj", finalizable_type)
664 v.send(finalize_meth, [recv])
665 v.add "\}"
666 end
667
668 # Generate the main C function.
669 #
670 # This function:
671 #
672 # * allocate the Sys object if it exists
673 # * call init if is exists
674 # * call main if it exists
675 fun compile_main_function
676 do
677 var v = self.new_visitor
678 v.add_decl("#include <signal.h>")
679 var ost = modelbuilder.toolcontext.opt_stacktrace.value
680 var platform = mainmodule.target_platform
681
682 if platform != null and not platform.supports_libunwind then ost = "none"
683
684 var no_main = (platform != null and platform.no_main) or modelbuilder.toolcontext.opt_no_main.value
685
686 if ost == "nitstack" or ost == "libunwind" then
687 v.add_decl("#define UNW_LOCAL_ONLY")
688 v.add_decl("#include <libunwind.h>")
689 if ost == "nitstack" then
690 v.add_decl("#include \"c_functions_hash.h\"")
691 end
692 end
693 v.add_decl("int glob_argc;")
694 v.add_decl("char **glob_argv;")
695 v.add_decl("val *glob_sys;")
696
697 if self.modelbuilder.toolcontext.opt_typing_test_metrics.value then
698 for tag in count_type_test_tags do
699 v.add_decl("long count_type_test_resolved_{tag};")
700 v.add_decl("long count_type_test_unresolved_{tag};")
701 v.add_decl("long count_type_test_skipped_{tag};")
702 v.compiler.header.add_decl("extern long count_type_test_resolved_{tag};")
703 v.compiler.header.add_decl("extern long count_type_test_unresolved_{tag};")
704 v.compiler.header.add_decl("extern long count_type_test_skipped_{tag};")
705 end
706 end
707
708 if self.modelbuilder.toolcontext.opt_invocation_metrics.value then
709 v.add_decl("long count_invoke_by_tables;")
710 v.add_decl("long count_invoke_by_direct;")
711 v.add_decl("long count_invoke_by_inline;")
712 v.compiler.header.add_decl("extern long count_invoke_by_tables;")
713 v.compiler.header.add_decl("extern long count_invoke_by_direct;")
714 v.compiler.header.add_decl("extern long count_invoke_by_inline;")
715 end
716
717 if self.modelbuilder.toolcontext.opt_isset_checks_metrics.value then
718 v.add_decl("long count_attr_reads = 0;")
719 v.add_decl("long count_isset_checks = 0;")
720 v.compiler.header.add_decl("extern long count_attr_reads;")
721 v.compiler.header.add_decl("extern long count_isset_checks;")
722 end
723
724 v.add_decl("void sig_handler(int signo)\{")
725 v.add_decl("PRINT_ERROR(\"Caught signal : %s\\n\", strsignal(signo));")
726 v.add_decl("show_backtrace(signo);")
727 v.add_decl("\}")
728
729 v.add_decl("void show_backtrace (int signo) \{")
730 if ost == "nitstack" or ost == "libunwind" then
731 v.add_decl("char* opt = getenv(\"NIT_NO_STACK\");")
732 v.add_decl("unw_cursor_t cursor;")
733 v.add_decl("if(opt==NULL)\{")
734 v.add_decl("unw_context_t uc;")
735 v.add_decl("unw_word_t ip;")
736 v.add_decl("char* procname = malloc(sizeof(char) * 100);")
737 v.add_decl("unw_getcontext(&uc);")
738 v.add_decl("unw_init_local(&cursor, &uc);")
739 v.add_decl("PRINT_ERROR(\"-------------------------------------------------\\n\");")
740 v.add_decl("PRINT_ERROR(\"-- Stack Trace ------------------------------\\n\");")
741 v.add_decl("PRINT_ERROR(\"-------------------------------------------------\\n\");")
742 v.add_decl("while (unw_step(&cursor) > 0) \{")
743 v.add_decl(" unw_get_proc_name(&cursor, procname, 100, &ip);")
744 if ost == "nitstack" then
745 v.add_decl(" const char* recv = get_nit_name(procname, strlen(procname));")
746 v.add_decl(" if (recv != NULL)\{")
747 v.add_decl(" PRINT_ERROR(\"` %s\\n\", recv);")
748 v.add_decl(" \}else\{")
749 v.add_decl(" PRINT_ERROR(\"` %s\\n\", procname);")
750 v.add_decl(" \}")
751 else
752 v.add_decl(" PRINT_ERROR(\"` %s \\n\",procname);")
753 end
754 v.add_decl("\}")
755 v.add_decl("PRINT_ERROR(\"-------------------------------------------------\\n\");")
756 v.add_decl("free(procname);")
757 v.add_decl("\}")
758 end
759 v.add_decl("exit(signo);")
760 v.add_decl("\}")
761
762 if no_main then
763 v.add_decl("int nit_main(int argc, char** argv) \{")
764 else
765 v.add_decl("int main(int argc, char** argv) \{")
766 end
767
768 v.add("signal(SIGABRT, sig_handler);")
769 v.add("signal(SIGFPE, sig_handler);")
770 v.add("signal(SIGILL, sig_handler);")
771 v.add("signal(SIGINT, sig_handler);")
772 v.add("signal(SIGTERM, sig_handler);")
773 v.add("signal(SIGSEGV, sig_handler);")
774 v.add("signal(SIGPIPE, sig_handler);")
775
776 v.add("glob_argc = argc; glob_argv = argv;")
777 v.add("initialize_gc_option();")
778
779 v.add "initialize_nitni_global_refs();"
780
781 var main_type = mainmodule.sys_type
782 if main_type != null then
783 var mainmodule = v.compiler.mainmodule
784 var glob_sys = v.init_instance(main_type)
785 v.add("glob_sys = {glob_sys};")
786 var main_init = mainmodule.try_get_primitive_method("init", main_type.mclass)
787 if main_init != null then
788 v.send(main_init, [glob_sys])
789 end
790 var main_method = mainmodule.try_get_primitive_method("run", main_type.mclass) or else
791 mainmodule.try_get_primitive_method("main", main_type.mclass)
792 if main_method != null then
793 v.send(main_method, [glob_sys])
794 end
795 end
796
797 if self.modelbuilder.toolcontext.opt_typing_test_metrics.value then
798 v.add_decl("long count_type_test_resolved_total = 0;")
799 v.add_decl("long count_type_test_unresolved_total = 0;")
800 v.add_decl("long count_type_test_skipped_total = 0;")
801 v.add_decl("long count_type_test_total_total = 0;")
802 for tag in count_type_test_tags do
803 v.add_decl("long count_type_test_total_{tag};")
804 v.add("count_type_test_total_{tag} = count_type_test_resolved_{tag} + count_type_test_unresolved_{tag} + count_type_test_skipped_{tag};")
805 v.add("count_type_test_resolved_total += count_type_test_resolved_{tag};")
806 v.add("count_type_test_unresolved_total += count_type_test_unresolved_{tag};")
807 v.add("count_type_test_skipped_total += count_type_test_skipped_{tag};")
808 v.add("count_type_test_total_total += count_type_test_total_{tag};")
809 end
810 v.add("printf(\"# dynamic count_type_test: total %l\\n\");")
811 v.add("printf(\"\\tresolved\\tunresolved\\tskipped\\ttotal\\n\");")
812 var tags = count_type_test_tags.to_a
813 tags.add("total")
814 for tag in tags do
815 v.add("printf(\"{tag}\");")
816 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_resolved_{tag}, 100.0*count_type_test_resolved_{tag}/count_type_test_total_total);")
817 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_unresolved_{tag}, 100.0*count_type_test_unresolved_{tag}/count_type_test_total_total);")
818 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_skipped_{tag}, 100.0*count_type_test_skipped_{tag}/count_type_test_total_total);")
819 v.add("printf(\"\\t%ld (%.2f%%)\\n\", count_type_test_total_{tag}, 100.0*count_type_test_total_{tag}/count_type_test_total_total);")
820 end
821 end
822
823 if self.modelbuilder.toolcontext.opt_invocation_metrics.value then
824 v.add_decl("long count_invoke_total;")
825 v.add("count_invoke_total = count_invoke_by_tables + count_invoke_by_direct + count_invoke_by_inline;")
826 v.add("printf(\"# dynamic count_invocation: total %ld\\n\", count_invoke_total);")
827 v.add("printf(\"by table: %ld (%.2f%%)\\n\", count_invoke_by_tables, 100.0*count_invoke_by_tables/count_invoke_total);")
828 v.add("printf(\"direct: %ld (%.2f%%)\\n\", count_invoke_by_direct, 100.0*count_invoke_by_direct/count_invoke_total);")
829 v.add("printf(\"inlined: %ld (%.2f%%)\\n\", count_invoke_by_inline, 100.0*count_invoke_by_inline/count_invoke_total);")
830 end
831
832 if self.modelbuilder.toolcontext.opt_isset_checks_metrics.value then
833 v.add("printf(\"# dynamic attribute reads: %ld\\n\", count_attr_reads);")
834 v.add("printf(\"# dynamic isset checks: %ld\\n\", count_isset_checks);")
835 end
836
837 v.add("return 0;")
838 v.add("\}")
839 end
840
841 # Copile all C functions related to the [incr|decr]_ref features of the FFI
842 fun compile_nitni_global_ref_functions
843 do
844 var v = self.new_visitor
845 v.add """
846 struct nitni_global_ref_list_t *nitni_global_ref_list;
847 void initialize_nitni_global_refs() {
848 nitni_global_ref_list = (struct nitni_global_ref_list_t*)nit_alloc(sizeof(struct nitni_global_ref_list_t));
849 nitni_global_ref_list->head = NULL;
850 nitni_global_ref_list->tail = NULL;
851 }
852
853 void nitni_global_ref_add( struct nitni_ref *ref ) {
854 if ( nitni_global_ref_list->head == NULL ) {
855 nitni_global_ref_list->head = ref;
856 ref->prev = NULL;
857 } else {
858 nitni_global_ref_list->tail->next = ref;
859 ref->prev = nitni_global_ref_list->tail;
860 }
861 nitni_global_ref_list->tail = ref;
862
863 ref->next = NULL;
864 }
865
866 void nitni_global_ref_remove( struct nitni_ref *ref ) {
867 if ( ref->prev == NULL ) {
868 nitni_global_ref_list->head = ref->next;
869 } else {
870 ref->prev->next = ref->next;
871 }
872
873 if ( ref->next == NULL ) {
874 nitni_global_ref_list->tail = ref->prev;
875 } else {
876 ref->next->prev = ref->prev;
877 }
878 }
879
880 extern void nitni_global_ref_incr( struct nitni_ref *ref ) {
881 if ( ref->count == 0 ) /* not registered */
882 {
883 /* add to list */
884 nitni_global_ref_add( ref );
885 }
886
887 ref->count ++;
888 }
889
890 extern void nitni_global_ref_decr( struct nitni_ref *ref ) {
891 if ( ref->count == 1 ) /* was last reference */
892 {
893 /* remove from list */
894 nitni_global_ref_remove( ref );
895 }
896
897 ref->count --;
898 }
899 """
900 end
901
902 # List of additional files required to compile (FFI)
903 var extern_bodies = new Array[ExternFile]
904
905 # List of source files to copy over to the compile dir
906 var files_to_copy = new Array[String]
907
908 # This is used to avoid adding an extern file more than once
909 private var seen_extern = new ArraySet[String]
910
911 # Generate code that initialize the attributes on a new instance
912 fun generate_init_attr(v: VISITOR, recv: RuntimeVariable, mtype: MClassType)
913 do
914 var cds = mtype.collect_mclassdefs(self.mainmodule).to_a
915 self.mainmodule.linearize_mclassdefs(cds)
916 for cd in cds do
917 for npropdef in modelbuilder.collect_attr_propdef(cd) do
918 npropdef.init_expr(v, recv)
919 end
920 end
921 end
922
923 # Generate code that check if an attribute is correctly initialized
924 fun generate_check_attr(v: VISITOR, recv: RuntimeVariable, mtype: MClassType)
925 do
926 var cds = mtype.collect_mclassdefs(self.mainmodule).to_a
927 self.mainmodule.linearize_mclassdefs(cds)
928 for cd in cds do
929 for npropdef in modelbuilder.collect_attr_propdef(cd) do
930 npropdef.check_expr(v, recv)
931 end
932 end
933 end
934
935 # stats
936
937 var count_type_test_tags: Array[String] = ["isa", "as", "auto", "covariance", "erasure"]
938 var count_type_test_resolved: HashMap[String, Int] = init_count_type_test_tags
939 var count_type_test_unresolved: HashMap[String, Int] = init_count_type_test_tags
940 var count_type_test_skipped: HashMap[String, Int] = init_count_type_test_tags
941
942 protected fun init_count_type_test_tags: HashMap[String, Int]
943 do
944 var res = new HashMap[String, Int]
945 for tag in count_type_test_tags do
946 res[tag] = 0
947 end
948 return res
949 end
950
951 # Display stats about compilation process
952 #
953 # Metrics used:
954 #
955 # * type tests against resolved types (`x isa Collection[Animal]`)
956 # * type tests against unresolved types (`x isa Collection[E]`)
957 # * type tests skipped
958 # * type tests total
959 fun display_stats
960 do
961 if self.modelbuilder.toolcontext.opt_typing_test_metrics.value then
962 print "# static count_type_test"
963 print "\tresolved:\tunresolved\tskipped\ttotal"
964 var count_type_test_total = init_count_type_test_tags
965 count_type_test_resolved["total"] = 0
966 count_type_test_unresolved["total"] = 0
967 count_type_test_skipped["total"] = 0
968 count_type_test_total["total"] = 0
969 for tag in count_type_test_tags do
970 count_type_test_total[tag] = count_type_test_resolved[tag] + count_type_test_unresolved[tag] + count_type_test_skipped[tag]
971 count_type_test_resolved["total"] += count_type_test_resolved[tag]
972 count_type_test_unresolved["total"] += count_type_test_unresolved[tag]
973 count_type_test_skipped["total"] += count_type_test_skipped[tag]
974 count_type_test_total["total"] += count_type_test_total[tag]
975 end
976 var count_type_test = count_type_test_total["total"]
977 var tags = count_type_test_tags.to_a
978 tags.add("total")
979 for tag in tags do
980 printn tag
981 printn "\t{count_type_test_resolved[tag]} ({div(count_type_test_resolved[tag],count_type_test)}%)"
982 printn "\t{count_type_test_unresolved[tag]} ({div(count_type_test_unresolved[tag],count_type_test)}%)"
983 printn "\t{count_type_test_skipped[tag]} ({div(count_type_test_skipped[tag],count_type_test)}%)"
984 printn "\t{count_type_test_total[tag]} ({div(count_type_test_total[tag],count_type_test)}%)"
985 print ""
986 end
987 end
988 end
989
990 fun finalize_ffi_for_module(mmodule: MModule) do mmodule.finalize_ffi(self)
991
992 # Division facility
993 # Avoid division by zero by returning the string "n/a"
994 fun div(a,b:Int):String
995 do
996 if b == 0 then return "n/a"
997 return ((a*10000/b).to_f / 100.0).to_precision(2)
998 end
999 end
1000
1001 # A file unit (may be more than one file if
1002 # A file unit aim to be autonomous and is made or one or more `CodeWriter`s
1003 class CodeFile
1004 var name: String
1005 var writers = new Array[CodeWriter]
1006 var required_declarations = new HashSet[String]
1007 end
1008
1009 # Where to store generated lines
1010 class CodeWriter
1011 var file: CodeFile
1012 var lines: List[String] = new List[String]
1013 var decl_lines: List[String] = new List[String]
1014
1015 # Add a line in the main part of the generated C
1016 fun add(s: String) do self.lines.add(s)
1017
1018 # Add a line in the
1019 # (used for local or global declaration)
1020 fun add_decl(s: String) do self.decl_lines.add(s)
1021
1022 init
1023 do
1024 file.writers.add(self)
1025 end
1026 end
1027
1028 # A visitor on the AST of property definition that generate the C code.
1029 abstract class AbstractCompilerVisitor
1030
1031 type COMPILER: AbstractCompiler
1032
1033 # The associated compiler
1034 var compiler: COMPILER
1035
1036 # The current visited AST node
1037 var current_node: nullable ANode = null is writable
1038
1039 # The current `Frame`
1040 var frame: nullable Frame = null is writable
1041
1042 # Alias for self.compiler.mainmodule.object_type
1043 fun object_type: MClassType do return self.compiler.mainmodule.object_type
1044
1045 # Alias for self.compiler.mainmodule.bool_type
1046 fun bool_type: MClassType do return self.compiler.mainmodule.bool_type
1047
1048 var writer: CodeWriter is noinit
1049
1050 init
1051 do
1052 self.writer = new CodeWriter(compiler.files.last)
1053 end
1054
1055 # Force to get the primitive class named `name` or abort
1056 fun get_class(name: String): MClass do return self.compiler.mainmodule.get_primitive_class(name)
1057
1058 # Force to get the primitive property named `name` in the instance `recv` or abort
1059 fun get_property(name: String, recv: MType): MMethod
1060 do
1061 assert recv isa MClassType
1062 return self.compiler.modelbuilder.force_get_primitive_method(self.current_node, name, recv.mclass, self.compiler.mainmodule)
1063 end
1064
1065 fun compile_callsite(callsite: CallSite, arguments: Array[RuntimeVariable]): nullable RuntimeVariable
1066 do
1067 var initializers = callsite.mpropdef.initializers
1068 if not initializers.is_empty then
1069 var recv = arguments.first
1070
1071 var i = 1
1072 for p in initializers do
1073 if p isa MMethod then
1074 var args = [recv]
1075 for x in p.intro.msignature.mparameters do
1076 args.add arguments[i]
1077 i += 1
1078 end
1079 self.send(p, args)
1080 else if p isa MAttribute then
1081 self.write_attribute(p, recv, arguments[i])
1082 i += 1
1083 else abort
1084 end
1085 assert i == arguments.length
1086
1087 return self.send(callsite.mproperty, [recv])
1088 end
1089
1090 return self.send(callsite.mproperty, arguments)
1091 end
1092
1093 fun native_array_instance(elttype: MType, length: RuntimeVariable): RuntimeVariable is abstract
1094
1095 fun calloc_array(ret_type: MType, arguments: Array[RuntimeVariable]) is abstract
1096
1097 fun native_array_def(pname: String, ret_type: nullable MType, arguments: Array[RuntimeVariable]) is abstract
1098
1099 # Evaluate `args` as expressions in the call of `mpropdef` on `recv`.
1100 # This method is used to manage varargs in signatures and returns the real array
1101 # of runtime variables to use in the call.
1102 fun varargize(mpropdef: MMethodDef, recv: RuntimeVariable, args: SequenceRead[AExpr]): Array[RuntimeVariable]
1103 do
1104 var msignature = mpropdef.new_msignature or else mpropdef.msignature.as(not null)
1105 var res = new Array[RuntimeVariable]
1106 res.add(recv)
1107
1108 if args.is_empty then return res
1109
1110 var vararg_rank = msignature.vararg_rank
1111 var vararg_len = args.length - msignature.arity
1112 if vararg_len < 0 then vararg_len = 0
1113
1114 for i in [0..msignature.arity[ do
1115 if i == vararg_rank then
1116 var ne = args[i]
1117 if ne isa AVarargExpr then
1118 var e = self.expr(ne.n_expr, null)
1119 res.add(e)
1120 continue
1121 end
1122 var vararg = new Array[RuntimeVariable]
1123 for j in [vararg_rank..vararg_rank+vararg_len] do
1124 var e = self.expr(args[j], null)
1125 vararg.add(e)
1126 end
1127 var elttype = msignature.mparameters[vararg_rank].mtype
1128 var arg = self.vararg_instance(mpropdef, recv, vararg, elttype)
1129 res.add(arg)
1130 else
1131 var j = i
1132 if i > vararg_rank then j += vararg_len
1133 var e = self.expr(args[j], null)
1134 res.add(e)
1135 end
1136 end
1137 return res
1138 end
1139
1140 # Type handling
1141
1142 # Anchor a type to the main module and the current receiver
1143 fun anchor(mtype: MType): MType
1144 do
1145 if not mtype.need_anchor then return mtype
1146 return mtype.anchor_to(self.compiler.mainmodule, self.frame.receiver)
1147 end
1148
1149 fun resolve_for(mtype: MType, recv: RuntimeVariable): MType
1150 do
1151 if not mtype.need_anchor then return mtype
1152 return mtype.resolve_for(recv.mcasttype, self.frame.receiver, self.compiler.mainmodule, true)
1153 end
1154
1155 # Unsafely cast a value to a new type
1156 # ie the result share the same C variable but my have a different mcasttype
1157 # NOTE: if the adaptation is useless then `value` is returned as it.
1158 # ENSURE: `result.name == value.name`
1159 fun autoadapt(value: RuntimeVariable, mtype: MType): RuntimeVariable
1160 do
1161 mtype = self.anchor(mtype)
1162 var valmtype = value.mcasttype
1163 if valmtype.is_subtype(self.compiler.mainmodule, null, mtype) then
1164 return value
1165 end
1166
1167 if valmtype isa MNullableType and valmtype.mtype.is_subtype(self.compiler.mainmodule, null, mtype) then
1168 var res = new RuntimeVariable(value.name, valmtype, valmtype.mtype)
1169 return res
1170 else
1171 var res = new RuntimeVariable(value.name, valmtype, mtype)
1172 return res
1173 end
1174 end
1175
1176 # Generate a super call from a method definition
1177 fun supercall(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1178
1179 # Adapt the arguments of a method according to targetted `MMethodDef`
1180 fun adapt_signature(m: MMethodDef, args: Array[RuntimeVariable]) is abstract
1181
1182 # Unbox all the arguments of a method when implemented `extern` or `intern`
1183 fun unbox_signature_extern(m: MMethodDef, args: Array[RuntimeVariable]) is abstract
1184
1185 # Box or unbox a value to another type iff a C type conversion is needed
1186 # ENSURE: `result.mtype.ctype == mtype.ctype`
1187 fun autobox(value: RuntimeVariable, mtype: MType): RuntimeVariable is abstract
1188
1189 # Box extern classes to be used in the generated code
1190 fun box_extern(value: RuntimeVariable, mtype: MType): RuntimeVariable is abstract
1191
1192 # Unbox extern classes to be used in extern code (legacy NI and FFI)
1193 fun unbox_extern(value: RuntimeVariable, mtype: MType): RuntimeVariable is abstract
1194
1195 # Generate a polymorphic subtype test
1196 fun type_test(value: RuntimeVariable, mtype: MType, tag: String): RuntimeVariable is abstract
1197
1198 # Generate the code required to dynamically check if 2 objects share the same runtime type
1199 fun is_same_type_test(value1, value2: RuntimeVariable): RuntimeVariable is abstract
1200
1201 # Generate a Nit "is" for two runtime_variables
1202 fun equal_test(value1, value2: RuntimeVariable): RuntimeVariable is abstract
1203
1204 # Sends
1205
1206 # Generate a static call on a method definition
1207 fun call(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1208
1209 # Generate a polymorphic send for the method `m` and the arguments `args`
1210 fun send(m: MMethod, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1211
1212 # Generate a monomorphic send for the method `m`, the type `t` and the arguments `args`
1213 fun monomorphic_send(m: MMethod, t: MType, args: Array[RuntimeVariable]): nullable RuntimeVariable
1214 do
1215 assert t isa MClassType
1216 var propdef = m.lookup_first_definition(self.compiler.mainmodule, t)
1217 return self.call(propdef, t, args)
1218 end
1219
1220 # Generate a monomorphic super send from the method `m`, the type `t` and the arguments `args`
1221 fun monomorphic_super_send(m: MMethodDef, t: MType, args: Array[RuntimeVariable]): nullable RuntimeVariable
1222 do
1223 assert t isa MClassType
1224 m = m.lookup_next_definition(self.compiler.mainmodule, t)
1225 return self.call(m, t, args)
1226 end
1227
1228 # Attributes handling
1229
1230 # Generate a polymorphic attribute is_set test
1231 fun isset_attribute(a: MAttribute, recv: RuntimeVariable): RuntimeVariable is abstract
1232
1233 # Generate a polymorphic attribute read
1234 fun read_attribute(a: MAttribute, recv: RuntimeVariable): RuntimeVariable is abstract
1235
1236 # Generate a polymorphic attribute write
1237 fun write_attribute(a: MAttribute, recv: RuntimeVariable, value: RuntimeVariable) is abstract
1238
1239 # Checks
1240
1241 # Add a check and an abort for a null receiver if needed
1242 fun check_recv_notnull(recv: RuntimeVariable)
1243 do
1244 if self.compiler.modelbuilder.toolcontext.opt_no_check_null.value then return
1245
1246 var maybenull = recv.mcasttype isa MNullableType or recv.mcasttype isa MNullType
1247 if maybenull then
1248 self.add("if (unlikely({recv} == NULL)) \{")
1249 self.add_abort("Receiver is null")
1250 self.add("\}")
1251 end
1252 end
1253
1254 # Names handling
1255
1256 private var names = new HashSet[String]
1257 private var last: Int = 0
1258
1259 # Return a new name based on `s` and unique in the visitor
1260 fun get_name(s: String): String
1261 do
1262 if not self.names.has(s) then
1263 self.names.add(s)
1264 return s
1265 end
1266 var i = self.last + 1
1267 loop
1268 var s2 = s + i.to_s
1269 if not self.names.has(s2) then
1270 self.last = i
1271 self.names.add(s2)
1272 return s2
1273 end
1274 i = i + 1
1275 end
1276 end
1277
1278 # Return an unique and stable identifier associated with an escapemark
1279 fun escapemark_name(e: nullable EscapeMark): String
1280 do
1281 assert e != null
1282 if frame.escapemark_names.has_key(e) then return frame.escapemark_names[e]
1283 var name = e.name
1284 if name == null then name = "label"
1285 name = get_name(name)
1286 frame.escapemark_names[e] = name
1287 return name
1288 end
1289
1290 # Insert a C label for associated with an escapemark
1291 fun add_escape_label(e: nullable EscapeMark)
1292 do
1293 if e == null then return
1294 if e.escapes.is_empty then return
1295 add("BREAK_{escapemark_name(e)}: (void)0;")
1296 end
1297
1298 # Return a "const char*" variable associated to the classname of the dynamic type of an object
1299 # NOTE: we do not return a `RuntimeVariable` "NativeString" as the class may not exist in the module/program
1300 fun class_name_string(value: RuntimeVariable): String is abstract
1301
1302 # Variables handling
1303
1304 protected var variables = new HashMap[Variable, RuntimeVariable]
1305
1306 # Return the local runtime_variable associated to a Nit local variable
1307 fun variable(variable: Variable): RuntimeVariable
1308 do
1309 if self.variables.has_key(variable) then
1310 return self.variables[variable]
1311 else
1312 var name = self.get_name("var_{variable.name}")
1313 var mtype = variable.declared_type.as(not null)
1314 mtype = self.anchor(mtype)
1315 var res = new RuntimeVariable(name, mtype, mtype)
1316 self.add_decl("{mtype.ctype} {name} /* var {variable}: {mtype} */;")
1317 self.variables[variable] = res
1318 return res
1319 end
1320 end
1321
1322 # Return a new uninitialized local runtime_variable
1323 fun new_var(mtype: MType): RuntimeVariable
1324 do
1325 mtype = self.anchor(mtype)
1326 var name = self.get_name("var")
1327 var res = new RuntimeVariable(name, mtype, mtype)
1328 self.add_decl("{mtype.ctype} {name} /* : {mtype} */;")
1329 return res
1330 end
1331
1332 # The difference with `new_var` is the C static type of the local variable
1333 fun new_var_extern(mtype: MType): RuntimeVariable
1334 do
1335 mtype = self.anchor(mtype)
1336 var name = self.get_name("var")
1337 var res = new RuntimeVariable(name, mtype, mtype)
1338 self.add_decl("{mtype.ctype_extern} {name} /* : {mtype} for extern */;")
1339 return res
1340 end
1341
1342 # Return a new uninitialized named runtime_variable
1343 fun new_named_var(mtype: MType, name: String): RuntimeVariable
1344 do
1345 mtype = self.anchor(mtype)
1346 var res = new RuntimeVariable(name, mtype, mtype)
1347 self.add_decl("{mtype.ctype} {name} /* : {mtype} */;")
1348 return res
1349 end
1350
1351 # Correctly assign a left and a right value
1352 # Boxing and unboxing is performed if required
1353 fun assign(left, right: RuntimeVariable)
1354 do
1355 right = self.autobox(right, left.mtype)
1356 self.add("{left} = {right};")
1357 end
1358
1359 # Generate instances
1360
1361 # Generate a alloc-instance + init-attributes
1362 fun init_instance(mtype: MClassType): RuntimeVariable is abstract
1363
1364 # Set a GC finalizer on `recv`, only if `recv` isa Finalizable
1365 fun set_finalizer(recv: RuntimeVariable)
1366 do
1367 var mtype = recv.mtype
1368 var finalizable_type = compiler.mainmodule.finalizable_type
1369 if finalizable_type != null and not mtype.need_anchor and
1370 mtype.is_subtype(compiler.mainmodule, null, finalizable_type) then
1371 add "gc_register_finalizer({recv});"
1372 end
1373 end
1374
1375 # Generate an integer value
1376 fun int_instance(value: Int): RuntimeVariable
1377 do
1378 var res = self.new_var(self.get_class("Int").mclass_type)
1379 self.add("{res} = {value};")
1380 return res
1381 end
1382
1383 # Generate an integer value
1384 fun bool_instance(value: Bool): RuntimeVariable
1385 do
1386 var res = self.new_var(self.get_class("Bool").mclass_type)
1387 if value then
1388 self.add("{res} = 1;")
1389 else
1390 self.add("{res} = 0;")
1391 end
1392 return res
1393 end
1394
1395 # Generate a string value
1396 fun string_instance(string: String): RuntimeVariable
1397 do
1398 var mtype = self.get_class("String").mclass_type
1399 var name = self.get_name("varonce")
1400 self.add_decl("static {mtype.ctype} {name};")
1401 var res = self.new_var(mtype)
1402 self.add("if ({name}) \{")
1403 self.add("{res} = {name};")
1404 self.add("\} else \{")
1405 var native_mtype = self.get_class("NativeString").mclass_type
1406 var nat = self.new_var(native_mtype)
1407 self.add("{nat} = \"{string.escape_to_c}\";")
1408 var length = self.int_instance(string.length)
1409 self.add("{res} = {self.send(self.get_property("to_s_with_length", native_mtype), [nat, length]).as(not null)};")
1410 self.add("{name} = {res};")
1411 self.add("\}")
1412 return res
1413 end
1414
1415 fun value_instance(object: Object): RuntimeVariable
1416 do
1417 if object isa Int then
1418 return int_instance(object)
1419 else if object isa Bool then
1420 return bool_instance(object)
1421 else if object isa String then
1422 return string_instance(object)
1423 else
1424 abort
1425 end
1426 end
1427
1428 # Generate an array value
1429 fun array_instance(array: Array[RuntimeVariable], elttype: MType): RuntimeVariable is abstract
1430
1431 # Get an instance of a array for a vararg
1432 fun vararg_instance(mpropdef: MPropDef, recv: RuntimeVariable, varargs: Array[RuntimeVariable], elttype: MType): RuntimeVariable is abstract
1433
1434 # Code generation
1435
1436 # Add a line in the main part of the generated C
1437 fun add(s: String) do self.writer.lines.add(s)
1438
1439 # Add a line in the
1440 # (used for local or global declaration)
1441 fun add_decl(s: String) do self.writer.decl_lines.add(s)
1442
1443 # Request the presence of a global declaration
1444 fun require_declaration(key: String)
1445 do
1446 var reqs = self.writer.file.required_declarations
1447 if reqs.has(key) then return
1448 reqs.add(key)
1449 var node = current_node
1450 if node != null then compiler.requirers_of_declarations[key] = node
1451 end
1452
1453 # Add a declaration in the local-header
1454 # The declaration is ensured to be present once
1455 fun declare_once(s: String)
1456 do
1457 self.compiler.provide_declaration(s, s)
1458 self.require_declaration(s)
1459 end
1460
1461 # look for a needed .h and .c file for a given .nit source-file
1462 # FIXME: bad API, parameter should be a `MModule`, not its source-file
1463 fun add_extern(file: String)
1464 do
1465 file = file.strip_extension(".nit")
1466 var tryfile = file + ".nit.h"
1467 if tryfile.file_exists then
1468 self.declare_once("#include \"{tryfile.basename("")}\"")
1469 self.compiler.files_to_copy.add(tryfile)
1470 end
1471 tryfile = file + "_nit.h"
1472 if tryfile.file_exists then
1473 self.declare_once("#include \"{tryfile.basename("")}\"")
1474 self.compiler.files_to_copy.add(tryfile)
1475 end
1476
1477 if self.compiler.seen_extern.has(file) then return
1478 self.compiler.seen_extern.add(file)
1479 tryfile = file + ".nit.c"
1480 if not tryfile.file_exists then
1481 tryfile = file + "_nit.c"
1482 if not tryfile.file_exists then return
1483 end
1484 var f = new ExternCFile(tryfile.basename(""), "")
1485 self.compiler.extern_bodies.add(f)
1486 self.compiler.files_to_copy.add(tryfile)
1487 end
1488
1489 # Return a new local runtime_variable initialized with the C expression `cexpr`.
1490 fun new_expr(cexpr: String, mtype: MType): RuntimeVariable
1491 do
1492 var res = new_var(mtype)
1493 self.add("{res} = {cexpr};")
1494 return res
1495 end
1496
1497 # Generate generic abort
1498 # used by aborts, asserts, casts, etc.
1499 fun add_abort(message: String)
1500 do
1501 self.add("PRINT_ERROR(\"Runtime error: %s\", \"{message.escape_to_c}\");")
1502 add_raw_abort
1503 end
1504
1505 fun add_raw_abort
1506 do
1507 if self.current_node != null and self.current_node.location.file != null then
1508 self.add("PRINT_ERROR(\" (%s:%d)\\n\", \"{self.current_node.location.file.filename.escape_to_c}\", {current_node.location.line_start});")
1509 else
1510 self.add("PRINT_ERROR(\"\\n\");")
1511 end
1512 self.add("show_backtrace(1);")
1513 end
1514
1515 # Add a dynamic cast
1516 fun add_cast(value: RuntimeVariable, mtype: MType, tag: String)
1517 do
1518 var res = self.type_test(value, mtype, tag)
1519 self.add("if (unlikely(!{res})) \{")
1520 var cn = self.class_name_string(value)
1521 self.add("PRINT_ERROR(\"Runtime error: Cast failed. Expected `%s`, got `%s`\", \"{mtype.to_s.escape_to_c}\", {cn});")
1522 self.add_raw_abort
1523 self.add("\}")
1524 end
1525
1526 # Generate a return with the value `s`
1527 fun ret(s: RuntimeVariable)
1528 do
1529 self.assign(self.frame.returnvar.as(not null), s)
1530 self.add("goto {self.frame.returnlabel.as(not null)};")
1531 end
1532
1533 # Compile a statement (if any)
1534 fun stmt(nexpr: nullable AExpr)
1535 do
1536 if nexpr == null then return
1537 var old = self.current_node
1538 self.current_node = nexpr
1539 nexpr.stmt(self)
1540 self.current_node = old
1541 end
1542
1543 # Compile an expression an return its result
1544 # `mtype` is the expected return type, pass null if no specific type is expected.
1545 fun expr(nexpr: AExpr, mtype: nullable MType): RuntimeVariable
1546 do
1547 var old = self.current_node
1548 self.current_node = nexpr
1549 var res = nexpr.expr(self).as(not null)
1550 if mtype != null then
1551 mtype = self.anchor(mtype)
1552 res = self.autobox(res, mtype)
1553 end
1554 res = autoadapt(res, nexpr.mtype.as(not null))
1555 var implicit_cast_to = nexpr.implicit_cast_to
1556 if implicit_cast_to != null and not self.compiler.modelbuilder.toolcontext.opt_no_check_autocast.value then
1557 add_cast(res, implicit_cast_to, "auto")
1558 res = autoadapt(res, implicit_cast_to)
1559 end
1560 self.current_node = old
1561 return res
1562 end
1563
1564 # Alias for `self.expr(nexpr, self.bool_type)`
1565 fun expr_bool(nexpr: AExpr): RuntimeVariable do return expr(nexpr, bool_type)
1566
1567 # Safely show a debug message on the current node and repeat the message in the C code as a comment
1568 fun debug(message: String)
1569 do
1570 var node = self.current_node
1571 if node == null then
1572 print "?: {message}"
1573 else
1574 node.debug(message)
1575 end
1576 self.add("/* DEBUG: {message} */")
1577 end
1578 end
1579
1580 # A C function associated to a Nit method
1581 # Because of customization, a given Nit method can be compiler more that once
1582 abstract class AbstractRuntimeFunction
1583
1584 type COMPILER: AbstractCompiler
1585 type VISITOR: AbstractCompilerVisitor
1586
1587 # The associated Nit method
1588 var mmethoddef: MMethodDef
1589
1590 # The mangled c name of the runtime_function
1591 # Subclasses should redefine `build_c_name` instead
1592 fun c_name: String
1593 do
1594 var res = self.c_name_cache
1595 if res != null then return res
1596 res = self.build_c_name
1597 self.c_name_cache = res
1598 return res
1599 end
1600
1601 # Non cached version of `c_name`
1602 protected fun build_c_name: String is abstract
1603
1604 protected var c_name_cache: nullable String = null is writable
1605
1606 # Implements a call of the runtime_function
1607 # May inline the body or generate a C function call
1608 fun call(v: VISITOR, arguments: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1609
1610 # Generate the code for the `AbstractRuntimeFunction`
1611 # Warning: compile more than once compilation makes CC unhappy
1612 fun compile_to_c(compiler: COMPILER) is abstract
1613 end
1614
1615 # A runtime variable hold a runtime value in C.
1616 # Runtime variables are associated to Nit local variables and intermediate results in Nit expressions.
1617 #
1618 # The tricky point is that a single C variable can be associated to more than one `RuntimeVariable` because the static knowledge of the type of an expression can vary in the C code.
1619 class RuntimeVariable
1620 # The name of the variable in the C code
1621 var name: String
1622
1623 # The static type of the variable (as declard in C)
1624 var mtype: MType
1625
1626 # The current casted type of the variable (as known in Nit)
1627 var mcasttype: MType is writable
1628
1629 # If the variable exaclty a mcasttype?
1630 # false (usual value) means that the variable is a mcasttype or a subtype.
1631 var is_exact: Bool = false is writable
1632
1633 init
1634 do
1635 assert not mtype.need_anchor
1636 assert not mcasttype.need_anchor
1637 end
1638
1639 redef fun to_s do return name
1640
1641 redef fun inspect
1642 do
1643 var exact_str
1644 if self.is_exact then
1645 exact_str = " exact"
1646 else
1647 exact_str = ""
1648 end
1649 var type_str
1650 if self.mtype == self.mcasttype then
1651 type_str = "{mtype}{exact_str}"
1652 else
1653 type_str = "{mtype}({mcasttype}{exact_str})"
1654 end
1655 return "<{name}:{type_str}>"
1656 end
1657 end
1658
1659 # A frame correspond to a visited property in a `GlobalCompilerVisitor`
1660 class Frame
1661
1662 type VISITOR: AbstractCompilerVisitor
1663
1664 # The associated visitor
1665 var visitor: VISITOR
1666
1667 # The executed property.
1668 # A Method in case of a call, an attribute in case of a default initialization.
1669 var mpropdef: MPropDef
1670
1671 # The static type of the receiver
1672 var receiver: MClassType
1673
1674 # Arguments of the method (the first is the receiver)
1675 var arguments: Array[RuntimeVariable]
1676
1677 # The runtime_variable associated to the return (in a function)
1678 var returnvar: nullable RuntimeVariable = null is writable
1679
1680 # The label at the end of the property
1681 var returnlabel: nullable String = null is writable
1682
1683 # Labels associated to a each escapemarks.
1684 # Because of inlinings, escape-marks must be associated to their context (the frame)
1685 private var escapemark_names = new HashMap[EscapeMark, String]
1686 end
1687
1688 redef class MType
1689 # Return the C type associated to a given Nit static type
1690 fun ctype: String do return "val*"
1691
1692 # C type outside of the compiler code and in boxes
1693 fun ctype_extern: String do return "val*"
1694
1695 # Short name of the `ctype` to use in unions
1696 fun ctypename: String do return "val"
1697
1698 # Return the name of the C structure associated to a Nit live type
1699 fun c_name: String is abstract
1700 protected var c_name_cache: nullable String is protected writable
1701 end
1702
1703 redef class MClassType
1704 redef fun c_name
1705 do
1706 var res = self.c_name_cache
1707 if res != null then return res
1708 res = "{mclass.intro_mmodule.c_name}__{mclass.name.to_cmangle}"
1709 self.c_name_cache = res
1710 return res
1711 end
1712
1713 redef fun ctype: String
1714 do
1715 if mclass.name == "Int" then
1716 return "long"
1717 else if mclass.name == "Bool" then
1718 return "short int"
1719 else if mclass.name == "Char" then
1720 return "char"
1721 else if mclass.name == "Float" then
1722 return "double"
1723 else if mclass.name == "NativeString" then
1724 return "char*"
1725 else if mclass.name == "NativeArray" then
1726 return "val*"
1727 else
1728 return "val*"
1729 end
1730 end
1731
1732 redef fun ctype_extern: String
1733 do
1734 if mclass.kind == extern_kind then
1735 return "void*"
1736 else
1737 return ctype
1738 end
1739 end
1740
1741 redef fun ctypename: String
1742 do
1743 if mclass.name == "Int" then
1744 return "l"
1745 else if mclass.name == "Bool" then
1746 return "s"
1747 else if mclass.name == "Char" then
1748 return "c"
1749 else if mclass.name == "Float" then
1750 return "d"
1751 else if mclass.name == "NativeString" then
1752 return "str"
1753 else if mclass.name == "NativeArray" then
1754 #return "{self.arguments.first.ctype}*"
1755 return "val"
1756 else
1757 return "val"
1758 end
1759 end
1760 end
1761
1762 redef class MGenericType
1763 redef fun c_name
1764 do
1765 var res = self.c_name_cache
1766 if res != null then return res
1767 res = super
1768 for t in self.arguments do
1769 res = res + t.c_name
1770 end
1771 self.c_name_cache = res
1772 return res
1773 end
1774 end
1775
1776 redef class MParameterType
1777 redef fun c_name
1778 do
1779 var res = self.c_name_cache
1780 if res != null then return res
1781 res = "{self.mclass.c_name}_FT{self.rank}"
1782 self.c_name_cache = res
1783 return res
1784 end
1785 end
1786
1787 redef class MVirtualType
1788 redef fun c_name
1789 do
1790 var res = self.c_name_cache
1791 if res != null then return res
1792 res = "{self.mproperty.intro.mclassdef.mclass.c_name}_VT{self.mproperty.name}"
1793 self.c_name_cache = res
1794 return res
1795 end
1796 end
1797
1798 redef class MNullableType
1799 redef fun c_name
1800 do
1801 var res = self.c_name_cache
1802 if res != null then return res
1803 res = "nullable_{self.mtype.c_name}"
1804 self.c_name_cache = res
1805 return res
1806 end
1807 end
1808
1809 redef class MClass
1810 # Return the name of the C structure associated to a Nit class
1811 fun c_name: String do
1812 var res = self.c_name_cache
1813 if res != null then return res
1814 res = "{intro_mmodule.c_name}__{name.to_cmangle}"
1815 self.c_name_cache = res
1816 return res
1817 end
1818 private var c_name_cache: nullable String
1819 end
1820
1821 redef class MProperty
1822 fun c_name: String do
1823 var res = self.c_name_cache
1824 if res != null then return res
1825 res = "{self.intro.c_name}"
1826 self.c_name_cache = res
1827 return res
1828 end
1829 private var c_name_cache: nullable String
1830 end
1831
1832 redef class MPropDef
1833 type VISITOR: AbstractCompilerVisitor
1834
1835 private var c_name_cache: nullable String
1836
1837 # The mangled name associated to the property
1838 fun c_name: String
1839 do
1840 var res = self.c_name_cache
1841 if res != null then return res
1842 res = "{self.mclassdef.mmodule.c_name}__{self.mclassdef.mclass.name.to_cmangle}__{self.mproperty.name.to_cmangle}"
1843 self.c_name_cache = res
1844 return res
1845 end
1846 end
1847
1848 redef class MMethodDef
1849 # Can the body be inlined?
1850 fun can_inline(v: VISITOR): Bool
1851 do
1852 if is_abstract then return true
1853 var modelbuilder = v.compiler.modelbuilder
1854 var node = modelbuilder.mpropdef2node(self)
1855 if node isa APropdef then
1856 return node.can_inline
1857 else if node isa AClassdef then
1858 # Automatic free init is always inlined since it is empty or contains only attribtes assigments
1859 return true
1860 else
1861 abort
1862 end
1863 end
1864
1865 # Inline the body in another visitor
1866 fun compile_inside_to_c(v: VISITOR, arguments: Array[RuntimeVariable]): nullable RuntimeVariable
1867 do
1868 var modelbuilder = v.compiler.modelbuilder
1869 var val = constant_value
1870 var node = modelbuilder.mpropdef2node(self)
1871 if node isa APropdef then
1872 var oldnode = v.current_node
1873 v.current_node = node
1874 self.compile_parameter_check(v, arguments)
1875 node.compile_to_c(v, self, arguments)
1876 v.current_node = oldnode
1877 else if node isa AClassdef then
1878 var oldnode = v.current_node
1879 v.current_node = node
1880 self.compile_parameter_check(v, arguments)
1881 node.compile_to_c(v, self, arguments)
1882 v.current_node = oldnode
1883 else if val != null then
1884 v.ret(v.value_instance(val))
1885 else
1886 abort
1887 end
1888 return null
1889 end
1890
1891 # Generate type checks in the C code to check covariant parameters
1892 fun compile_parameter_check(v: VISITOR, arguments: Array[RuntimeVariable])
1893 do
1894 if v.compiler.modelbuilder.toolcontext.opt_no_check_covariance.value then return
1895
1896 for i in [0..msignature.arity[ do
1897 # skip test for vararg since the array is instantiated with the correct polymorphic type
1898 if msignature.vararg_rank == i then continue
1899
1900 # skip if the cast is not required
1901 var origmtype = self.mproperty.intro.msignature.mparameters[i].mtype
1902 if not origmtype.need_anchor then continue
1903
1904 # get the parameter type
1905 var mtype = self.msignature.mparameters[i].mtype
1906
1907 # generate the cast
1908 # note that v decides if and how to implements the cast
1909 v.add("/* Covariant cast for argument {i} ({self.msignature.mparameters[i].name}) {arguments[i+1].inspect} isa {mtype} */")
1910 v.add_cast(arguments[i+1], mtype, "covariance")
1911 end
1912 end
1913 end
1914
1915 # Node visit
1916
1917 redef class APropdef
1918 fun compile_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
1919 do
1920 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name} {mpropdef} at {location.to_s}\\n\");")
1921 debug("Not yet implemented")
1922 end
1923
1924 fun can_inline: Bool do return true
1925 end
1926
1927 redef class AMethPropdef
1928 redef fun compile_to_c(v, mpropdef, arguments)
1929 do
1930 if mpropdef.is_abstract then
1931 var cn = v.class_name_string(arguments.first)
1932 v.add("PRINT_ERROR(\"Runtime error: Abstract method `%s` called on `%s`\", \"{mpropdef.mproperty.name.escape_to_c}\", {cn});")
1933 v.add_raw_abort
1934 return
1935 end
1936
1937 # Call the implicit super-init
1938 var auto_super_inits = self.auto_super_inits
1939 if auto_super_inits != null then
1940 var args = [arguments.first]
1941 for auto_super_init in auto_super_inits do
1942 assert auto_super_init.mproperty != mpropdef.mproperty
1943 args.clear
1944 for i in [0..auto_super_init.msignature.arity+1[ do
1945 args.add(arguments[i])
1946 end
1947 assert auto_super_init.mproperty != mpropdef.mproperty
1948 v.compile_callsite(auto_super_init, args)
1949 end
1950 end
1951 if auto_super_call then
1952 v.supercall(mpropdef, arguments.first.mtype.as(MClassType), arguments)
1953 end
1954
1955 # Try special compilation
1956 if mpropdef.is_intern then
1957 if compile_intern_to_c(v, mpropdef, arguments) then return
1958 else if mpropdef.is_extern then
1959 if mpropdef.mproperty.is_init then
1960 if compile_externinit_to_c(v, mpropdef, arguments) then return
1961 else
1962 if compile_externmeth_to_c(v, mpropdef, arguments) then return
1963 end
1964 end
1965
1966 # Compile block if any
1967 var n_block = n_block
1968 if n_block != null then
1969 for i in [0..mpropdef.msignature.arity[ do
1970 var variable = self.n_signature.n_params[i].variable.as(not null)
1971 v.assign(v.variable(variable), arguments[i+1])
1972 end
1973 v.stmt(n_block)
1974 return
1975 end
1976
1977 # We have a problem
1978 var cn = v.class_name_string(arguments.first)
1979 v.add("PRINT_ERROR(\"Runtime error: uncompiled method `%s` called on `%s`. NOT YET IMPLEMENTED\", \"{mpropdef.mproperty.name.escape_to_c}\", {cn});")
1980 v.add_raw_abort
1981 end
1982
1983 redef fun can_inline
1984 do
1985 if self.auto_super_inits != null then return false
1986 var nblock = self.n_block
1987 if nblock == null then return true
1988 if (mpropdef.mproperty.name == "==" or mpropdef.mproperty.name == "!=") and mpropdef.mclassdef.mclass.name == "Object" then return true
1989 if nblock isa ABlockExpr and nblock.n_expr.length == 0 then return true
1990 return false
1991 end
1992
1993 fun compile_intern_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable]): Bool
1994 do
1995 var pname = mpropdef.mproperty.name
1996 var cname = mpropdef.mclassdef.mclass.name
1997 var ret = mpropdef.msignature.return_mtype
1998 if ret != null then
1999 ret = v.resolve_for(ret, arguments.first)
2000 end
2001 if pname != "==" and pname != "!=" then
2002 v.adapt_signature(mpropdef, arguments)
2003 v.unbox_signature_extern(mpropdef, arguments)
2004 end
2005 if cname == "Int" then
2006 if pname == "output" then
2007 v.add("printf(\"%ld\\n\", {arguments.first});")
2008 return true
2009 else if pname == "object_id" then
2010 v.ret(arguments.first)
2011 return true
2012 else if pname == "+" then
2013 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
2014 return true
2015 else if pname == "-" then
2016 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
2017 return true
2018 else if pname == "unary -" then
2019 v.ret(v.new_expr("-{arguments[0]}", ret.as(not null)))
2020 return true
2021 else if pname == "*" then
2022 v.ret(v.new_expr("{arguments[0]} * {arguments[1]}", ret.as(not null)))
2023 return true
2024 else if pname == "/" then
2025 v.ret(v.new_expr("{arguments[0]} / {arguments[1]}", ret.as(not null)))
2026 return true
2027 else if pname == "%" then
2028 v.ret(v.new_expr("{arguments[0]} % {arguments[1]}", ret.as(not null)))
2029 return true
2030 else if pname == "lshift" then
2031 v.ret(v.new_expr("{arguments[0]} << {arguments[1]}", ret.as(not null)))
2032 return true
2033 else if pname == "rshift" then
2034 v.ret(v.new_expr("{arguments[0]} >> {arguments[1]}", ret.as(not null)))
2035 return true
2036 else if pname == "==" then
2037 v.ret(v.equal_test(arguments[0], arguments[1]))
2038 return true
2039 else if pname == "!=" then
2040 var res = v.equal_test(arguments[0], arguments[1])
2041 v.ret(v.new_expr("!{res}", ret.as(not null)))
2042 return true
2043 else if pname == "<" then
2044 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
2045 return true
2046 else if pname == ">" then
2047 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
2048 return true
2049 else if pname == "<=" then
2050 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
2051 return true
2052 else if pname == ">=" then
2053 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
2054 return true
2055 else if pname == "to_f" then
2056 v.ret(v.new_expr("(double){arguments[0]}", ret.as(not null)))
2057 return true
2058 else if pname == "ascii" then
2059 v.ret(v.new_expr("{arguments[0]}", ret.as(not null)))
2060 return true
2061 end
2062 else if cname == "Char" then
2063 if pname == "output" then
2064 v.add("printf(\"%c\", {arguments.first});")
2065 return true
2066 else if pname == "object_id" then
2067 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
2068 return true
2069 else if pname == "successor" then
2070 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
2071 return true
2072 else if pname == "predecessor" then
2073 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
2074 return true
2075 else if pname == "==" then
2076 v.ret(v.equal_test(arguments[0], arguments[1]))
2077 return true
2078 else if pname == "!=" then
2079 var res = v.equal_test(arguments[0], arguments[1])
2080 v.ret(v.new_expr("!{res}", ret.as(not null)))
2081 return true
2082 else if pname == "<" then
2083 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
2084 return true
2085 else if pname == ">" then
2086 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
2087 return true
2088 else if pname == "<=" then
2089 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
2090 return true
2091 else if pname == ">=" then
2092 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
2093 return true
2094 else if pname == "to_i" then
2095 v.ret(v.new_expr("{arguments[0]}-'0'", ret.as(not null)))
2096 return true
2097 else if pname == "ascii" then
2098 v.ret(v.new_expr("(unsigned char){arguments[0]}", ret.as(not null)))
2099 return true
2100 end
2101 else if cname == "Bool" then
2102 if pname == "output" then
2103 v.add("printf({arguments.first}?\"true\\n\":\"false\\n\");")
2104 return true
2105 else if pname == "object_id" then
2106 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
2107 return true
2108 else if pname == "==" then
2109 v.ret(v.equal_test(arguments[0], arguments[1]))
2110 return true
2111 else if pname == "!=" then
2112 var res = v.equal_test(arguments[0], arguments[1])
2113 v.ret(v.new_expr("!{res}", ret.as(not null)))
2114 return true
2115 end
2116 else if cname == "Float" then
2117 if pname == "output" then
2118 v.add("printf(\"%f\\n\", {arguments.first});")
2119 return true
2120 else if pname == "object_id" then
2121 v.ret(v.new_expr("(double){arguments.first}", ret.as(not null)))
2122 return true
2123 else if pname == "+" then
2124 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
2125 return true
2126 else if pname == "-" then
2127 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
2128 return true
2129 else if pname == "unary -" then
2130 v.ret(v.new_expr("-{arguments[0]}", ret.as(not null)))
2131 return true
2132 else if pname == "succ" then
2133 v.ret(v.new_expr("{arguments[0]}+1", ret.as(not null)))
2134 return true
2135 else if pname == "prec" then
2136 v.ret(v.new_expr("{arguments[0]}-1", ret.as(not null)))
2137 return true
2138 else if pname == "*" then
2139 v.ret(v.new_expr("{arguments[0]} * {arguments[1]}", ret.as(not null)))
2140 return true
2141 else if pname == "/" then
2142 v.ret(v.new_expr("{arguments[0]} / {arguments[1]}", ret.as(not null)))
2143 return true
2144 else if pname == "==" then
2145 v.ret(v.equal_test(arguments[0], arguments[1]))
2146 return true
2147 else if pname == "!=" then
2148 var res = v.equal_test(arguments[0], arguments[1])
2149 v.ret(v.new_expr("!{res}", ret.as(not null)))
2150 return true
2151 else if pname == "<" then
2152 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
2153 return true
2154 else if pname == ">" then
2155 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
2156 return true
2157 else if pname == "<=" then
2158 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
2159 return true
2160 else if pname == ">=" then
2161 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
2162 return true
2163 else if pname == "to_i" then
2164 v.ret(v.new_expr("(long){arguments[0]}", ret.as(not null)))
2165 return true
2166 end
2167 else if cname == "NativeString" then
2168 if pname == "[]" then
2169 v.ret(v.new_expr("{arguments[0]}[{arguments[1]}]", ret.as(not null)))
2170 return true
2171 else if pname == "[]=" then
2172 v.add("{arguments[0]}[{arguments[1]}]={arguments[2]};")
2173 return true
2174 else if pname == "copy_to" then
2175 v.add("memmove({arguments[1]}+{arguments[4]},{arguments[0]}+{arguments[3]},{arguments[2]});")
2176 return true
2177 else if pname == "atoi" then
2178 v.ret(v.new_expr("atoi({arguments[0]});", ret.as(not null)))
2179 return true
2180 else if pname == "new" then
2181 v.ret(v.new_expr("(char*)nit_alloc({arguments[1]})", ret.as(not null)))
2182 return true
2183 end
2184 else if cname == "NativeArray" then
2185 v.native_array_def(pname, ret, arguments)
2186 return true
2187 end
2188 if pname == "exit" then
2189 v.add("exit({arguments[1]});")
2190 return true
2191 else if pname == "sys" then
2192 v.ret(v.new_expr("glob_sys", ret.as(not null)))
2193 return true
2194 else if pname == "calloc_string" then
2195 v.ret(v.new_expr("(char*)nit_alloc({arguments[1]})", ret.as(not null)))
2196 return true
2197 else if pname == "calloc_array" then
2198 v.calloc_array(ret.as(not null), arguments)
2199 return true
2200 else if pname == "object_id" then
2201 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
2202 return true
2203 else if pname == "is_same_type" then
2204 v.ret(v.is_same_type_test(arguments[0], arguments[1]))
2205 return true
2206 else if pname == "is_same_instance" then
2207 v.ret(v.equal_test(arguments[0], arguments[1]))
2208 return true
2209 else if pname == "output_class_name" then
2210 var nat = v.class_name_string(arguments.first)
2211 v.add("printf(\"%s\\n\", {nat});")
2212 return true
2213 else if pname == "native_class_name" then
2214 var nat = v.class_name_string(arguments.first)
2215 v.ret(v.new_expr("(char*){nat}", ret.as(not null)))
2216 return true
2217 else if pname == "force_garbage_collection" then
2218 v.add("nit_gcollect();")
2219 return true
2220 else if pname == "native_argc" then
2221 v.ret(v.new_expr("glob_argc", ret.as(not null)))
2222 return true
2223 else if pname == "native_argv" then
2224 v.ret(v.new_expr("glob_argv[{arguments[1]}]", ret.as(not null)))
2225 return true
2226 end
2227 return false
2228 end
2229
2230 # Compile an extern method
2231 # Return `true` if the compilation was successful, `false` if a fall-back is needed
2232 fun compile_externmeth_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable]): Bool
2233 do
2234 var externname
2235 var at = self.get_single_annotation("extern", v.compiler.modelbuilder)
2236 if at != null then
2237 externname = at.arg_as_string(v.compiler.modelbuilder)
2238 if externname == null then return false
2239 else
2240 return false
2241 end
2242 if location.file != null then
2243 var file = location.file.filename
2244 v.add_extern(file)
2245 end
2246 var res: nullable RuntimeVariable = null
2247 var ret = mpropdef.msignature.return_mtype
2248 if ret != null then
2249 ret = v.resolve_for(ret, arguments.first)
2250 res = v.new_var_extern(ret)
2251 end
2252 v.adapt_signature(mpropdef, arguments)
2253 v.unbox_signature_extern(mpropdef, arguments)
2254
2255 if res == null then
2256 v.add("{externname}({arguments.join(", ")});")
2257 else
2258 v.add("{res} = {externname}({arguments.join(", ")});")
2259 res = v.box_extern(res, ret.as(not null))
2260 v.ret(res)
2261 end
2262 return true
2263 end
2264
2265 # Compile an extern factory
2266 # Return `true` if the compilation was successful, `false` if a fall-back is needed
2267 fun compile_externinit_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable]): Bool
2268 do
2269 var externname
2270 var at = self.get_single_annotation("extern", v.compiler.modelbuilder)
2271 if at != null then
2272 externname = at.arg_as_string(v.compiler.modelbuilder)
2273 if externname == null then return false
2274 else
2275 return false
2276 end
2277 if location.file != null then
2278 var file = location.file.filename
2279 v.add_extern(file)
2280 end
2281 v.adapt_signature(mpropdef, arguments)
2282 v.unbox_signature_extern(mpropdef, arguments)
2283 var ret = arguments.first.mtype
2284 var res = v.new_var_extern(ret)
2285
2286 arguments.shift
2287
2288 v.add("{res} = {externname}({arguments.join(", ")});")
2289 res = v.box_extern(res, ret)
2290 v.ret(res)
2291 return true
2292 end
2293 end
2294
2295 redef class AAttrPropdef
2296 redef fun compile_to_c(v, mpropdef, arguments)
2297 do
2298 if mpropdef == mreadpropdef then
2299 assert arguments.length == 1
2300 var recv = arguments.first
2301 var res
2302 if is_lazy then
2303 var set
2304 var ret = self.mpropdef.static_mtype
2305 var useiset = ret.ctype == "val*" and not ret isa MNullableType
2306 var guard = self.mlazypropdef.mproperty
2307 if useiset then
2308 set = v.isset_attribute(self.mpropdef.mproperty, recv)
2309 else
2310 set = v.read_attribute(guard, recv)
2311 end
2312 v.add("if(likely({set})) \{")
2313 res = v.read_attribute(self.mpropdef.mproperty, recv)
2314 v.add("\} else \{")
2315
2316 var value = evaluate_expr(v, recv)
2317
2318 v.assign(res, value)
2319 if not useiset then
2320 var true_v = v.new_expr("1", v.bool_type)
2321 v.write_attribute(guard, arguments.first, true_v)
2322 end
2323 v.add("\}")
2324 else
2325 res = v.read_attribute(self.mpropdef.mproperty, arguments.first)
2326 end
2327 v.assign(v.frame.returnvar.as(not null), res)
2328 else if mpropdef == mwritepropdef then
2329 assert arguments.length == 2
2330 v.write_attribute(self.mpropdef.mproperty, arguments.first, arguments[1])
2331 if is_lazy then
2332 var ret = self.mpropdef.static_mtype
2333 var useiset = ret.ctype == "val*" and not ret isa MNullableType
2334 if not useiset then
2335 v.write_attribute(self.mlazypropdef.mproperty, arguments.first, v.new_expr("1", v.bool_type))
2336 end
2337 end
2338 else
2339 abort
2340 end
2341 end
2342
2343 fun init_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable)
2344 do
2345 if has_value and not is_lazy then evaluate_expr(v, recv)
2346 end
2347
2348 # Evaluate, store and return the default value of the attribute
2349 private fun evaluate_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable): RuntimeVariable
2350 do
2351 var oldnode = v.current_node
2352 v.current_node = self
2353 var old_frame = v.frame
2354 var frame = new Frame(v, self.mpropdef.as(not null), recv.mcasttype.as(MClassType), [recv])
2355 v.frame = frame
2356
2357 var value
2358 var mtype = self.mpropdef.static_mtype
2359 assert mtype != null
2360
2361 var nexpr = self.n_expr
2362 var nblock = self.n_block
2363 if nexpr != null then
2364 value = v.expr(nexpr, mtype)
2365 else if nblock != null then
2366 value = v.new_var(mtype)
2367 frame.returnvar = value
2368 frame.returnlabel = v.get_name("RET_LABEL")
2369 v.add("\{")
2370 v.stmt(nblock)
2371 v.add("{frame.returnlabel.as(not null)}:(void)0;")
2372 v.add("\}")
2373 else
2374 abort
2375 end
2376
2377 v.write_attribute(self.mpropdef.mproperty, recv, value)
2378
2379 v.frame = old_frame
2380 v.current_node = oldnode
2381
2382 return value
2383 end
2384
2385 fun check_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable)
2386 do
2387 var nexpr = self.n_expr
2388 if nexpr != null then return
2389
2390 var oldnode = v.current_node
2391 v.current_node = self
2392 var old_frame = v.frame
2393 var frame = new Frame(v, self.mpropdef.as(not null), recv.mtype.as(MClassType), [recv])
2394 v.frame = frame
2395 # Force read to check the initialization
2396 v.read_attribute(self.mpropdef.mproperty, recv)
2397 v.frame = old_frame
2398 v.current_node = oldnode
2399 end
2400 end
2401
2402 redef class AClassdef
2403 private fun compile_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
2404 do
2405 if mpropdef == self.mfree_init then
2406 assert mpropdef.mproperty.is_root_init
2407 assert arguments.length == 1
2408 if not mpropdef.is_intro then
2409 v.supercall(mpropdef, arguments.first.mtype.as(MClassType), arguments)
2410 end
2411 return
2412 else
2413 abort
2414 end
2415 end
2416 end
2417
2418 redef class AExpr
2419 # Try to compile self as an expression
2420 # Do not call this method directly, use `v.expr` instead
2421 private fun expr(v: AbstractCompilerVisitor): nullable RuntimeVariable
2422 do
2423 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name}:{location.to_s}\\n\");")
2424 var mtype = self.mtype
2425 if mtype == null then
2426 return null
2427 else
2428 var res = v.new_var(mtype)
2429 v.add("/* {res} = NOT YET {class_name} */")
2430 return res
2431 end
2432 end
2433
2434 # Try to compile self as a statement
2435 # Do not call this method directly, use `v.stmt` instead
2436 private fun stmt(v: AbstractCompilerVisitor)
2437 do
2438 expr(v)
2439 end
2440 end
2441
2442 redef class ABlockExpr
2443 redef fun stmt(v)
2444 do
2445 for e in self.n_expr do v.stmt(e)
2446 end
2447 redef fun expr(v)
2448 do
2449 var last = self.n_expr.last
2450 for e in self.n_expr do
2451 if e == last then break
2452 v.stmt(e)
2453 end
2454 return v.expr(last, null)
2455 end
2456 end
2457
2458 redef class AVardeclExpr
2459 redef fun stmt(v)
2460 do
2461 var variable = self.variable.as(not null)
2462 var ne = self.n_expr
2463 if ne != null then
2464 var i = v.expr(ne, variable.declared_type)
2465 v.assign(v.variable(variable), i)
2466 end
2467 end
2468 end
2469
2470 redef class AVarExpr
2471 redef fun expr(v)
2472 do
2473 var res = v.variable(self.variable.as(not null))
2474 var mtype = self.mtype.as(not null)
2475 return v.autoadapt(res, mtype)
2476 end
2477 end
2478
2479 redef class AVarAssignExpr
2480 redef fun expr(v)
2481 do
2482 var variable = self.variable.as(not null)
2483 var i = v.expr(self.n_value, variable.declared_type)
2484 v.assign(v.variable(variable), i)
2485 return i
2486 end
2487 end
2488
2489 redef class AVarReassignExpr
2490 redef fun stmt(v)
2491 do
2492 var variable = self.variable.as(not null)
2493 var vari = v.variable(variable)
2494 var value = v.expr(self.n_value, variable.declared_type)
2495 var res = v.compile_callsite(self.reassign_callsite.as(not null), [vari, value])
2496 assert res != null
2497 v.assign(v.variable(variable), res)
2498 end
2499 end
2500
2501 redef class ASelfExpr
2502 redef fun expr(v) do return v.frame.arguments.first
2503 end
2504
2505 redef class AEscapeExpr
2506 redef fun stmt(v) do v.add("goto BREAK_{v.escapemark_name(self.escapemark)};")
2507 end
2508
2509 redef class AReturnExpr
2510 redef fun stmt(v)
2511 do
2512 var nexpr = self.n_expr
2513 if nexpr != null then
2514 var returnvar = v.frame.returnvar.as(not null)
2515 var i = v.expr(nexpr, returnvar.mtype)
2516 v.assign(returnvar, i)
2517 end
2518 v.add("goto {v.frame.returnlabel.as(not null)};")
2519 end
2520 end
2521
2522 redef class AAbortExpr
2523 redef fun stmt(v) do v.add_abort("Aborted")
2524 end
2525
2526 redef class AIfExpr
2527 redef fun stmt(v)
2528 do
2529 var cond = v.expr_bool(self.n_expr)
2530 v.add("if ({cond})\{")
2531 v.stmt(self.n_then)
2532 v.add("\} else \{")
2533 v.stmt(self.n_else)
2534 v.add("\}")
2535 end
2536
2537 redef fun expr(v)
2538 do
2539 var res = v.new_var(self.mtype.as(not null))
2540 var cond = v.expr_bool(self.n_expr)
2541 v.add("if ({cond})\{")
2542 v.assign(res, v.expr(self.n_then.as(not null), null))
2543 v.add("\} else \{")
2544 v.assign(res, v.expr(self.n_else.as(not null), null))
2545 v.add("\}")
2546 return res
2547 end
2548 end
2549
2550 redef class AIfexprExpr
2551 redef fun expr(v)
2552 do
2553 var res = v.new_var(self.mtype.as(not null))
2554 var cond = v.expr_bool(self.n_expr)
2555 v.add("if ({cond})\{")
2556 v.assign(res, v.expr(self.n_then, null))
2557 v.add("\} else \{")
2558 v.assign(res, v.expr(self.n_else, null))
2559 v.add("\}")
2560 return res
2561 end
2562 end
2563
2564 redef class ADoExpr
2565 redef fun stmt(v)
2566 do
2567 v.stmt(self.n_block)
2568 v.add_escape_label(break_mark)
2569 end
2570 end
2571
2572 redef class AWhileExpr
2573 redef fun stmt(v)
2574 do
2575 v.add("for(;;) \{")
2576 var cond = v.expr_bool(self.n_expr)
2577 v.add("if (!{cond}) break;")
2578 v.stmt(self.n_block)
2579 v.add_escape_label(continue_mark)
2580 v.add("\}")
2581 v.add_escape_label(break_mark)
2582 end
2583 end
2584
2585 redef class ALoopExpr
2586 redef fun stmt(v)
2587 do
2588 v.add("for(;;) \{")
2589 v.stmt(self.n_block)
2590 v.add_escape_label(continue_mark)
2591 v.add("\}")
2592 v.add_escape_label(break_mark)
2593 end
2594 end
2595
2596 redef class AForExpr
2597 redef fun stmt(v)
2598 do
2599 var cl = v.expr(self.n_expr, null)
2600 var it_meth = self.method_iterator
2601 assert it_meth != null
2602 var it = v.compile_callsite(it_meth, [cl])
2603 assert it != null
2604 v.add("for(;;) \{")
2605 var isok_meth = self.method_is_ok
2606 assert isok_meth != null
2607 var ok = v.compile_callsite(isok_meth, [it])
2608 assert ok != null
2609 v.add("if(!{ok}) break;")
2610 if self.variables.length == 1 then
2611 var item_meth = self.method_item
2612 assert item_meth != null
2613 var i = v.compile_callsite(item_meth, [it])
2614 assert i != null
2615 v.assign(v.variable(variables.first), i)
2616 else if self.variables.length == 2 then
2617 var key_meth = self.method_key
2618 assert key_meth != null
2619 var i = v.compile_callsite(key_meth, [it])
2620 assert i != null
2621 v.assign(v.variable(variables[0]), i)
2622 var item_meth = self.method_item
2623 assert item_meth != null
2624 i = v.compile_callsite(item_meth, [it])
2625 assert i != null
2626 v.assign(v.variable(variables[1]), i)
2627 else
2628 abort
2629 end
2630 v.stmt(self.n_block)
2631 v.add_escape_label(continue_mark)
2632 var next_meth = self.method_next
2633 assert next_meth != null
2634 v.compile_callsite(next_meth, [it])
2635 v.add("\}")
2636 v.add_escape_label(break_mark)
2637
2638 var method_finish = self.method_finish
2639 if method_finish != null then
2640 # TODO: Find a way to call this also in long escape (e.g. return)
2641 v.compile_callsite(method_finish, [it])
2642 end
2643 end
2644 end
2645
2646 redef class AAssertExpr
2647 redef fun stmt(v)
2648 do
2649 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return
2650
2651 var cond = v.expr_bool(self.n_expr)
2652 v.add("if (unlikely(!{cond})) \{")
2653 v.stmt(self.n_else)
2654 var nid = self.n_id
2655 if nid != null then
2656 v.add_abort("Assert '{nid.text}' failed")
2657 else
2658 v.add_abort("Assert failed")
2659 end
2660 v.add("\}")
2661 end
2662 end
2663
2664 redef class AOrExpr
2665 redef fun expr(v)
2666 do
2667 var res = v.new_var(self.mtype.as(not null))
2668 var i1 = v.expr_bool(self.n_expr)
2669 v.add("if ({i1}) \{")
2670 v.add("{res} = 1;")
2671 v.add("\} else \{")
2672 var i2 = v.expr_bool(self.n_expr2)
2673 v.add("{res} = {i2};")
2674 v.add("\}")
2675 return res
2676 end
2677 end
2678
2679 redef class AImpliesExpr
2680 redef fun expr(v)
2681 do
2682 var res = v.new_var(self.mtype.as(not null))
2683 var i1 = v.expr_bool(self.n_expr)
2684 v.add("if (!{i1}) \{")
2685 v.add("{res} = 1;")
2686 v.add("\} else \{")
2687 var i2 = v.expr_bool(self.n_expr2)
2688 v.add("{res} = {i2};")
2689 v.add("\}")
2690 return res
2691 end
2692 end
2693
2694 redef class AAndExpr
2695 redef fun expr(v)
2696 do
2697 var res = v.new_var(self.mtype.as(not null))
2698 var i1 = v.expr_bool(self.n_expr)
2699 v.add("if (!{i1}) \{")
2700 v.add("{res} = 0;")
2701 v.add("\} else \{")
2702 var i2 = v.expr_bool(self.n_expr2)
2703 v.add("{res} = {i2};")
2704 v.add("\}")
2705 return res
2706 end
2707 end
2708
2709 redef class ANotExpr
2710 redef fun expr(v)
2711 do
2712 var cond = v.expr_bool(self.n_expr)
2713 return v.new_expr("!{cond}", self.mtype.as(not null))
2714 end
2715 end
2716
2717 redef class AOrElseExpr
2718 redef fun expr(v)
2719 do
2720 var res = v.new_var(self.mtype.as(not null))
2721 var i1 = v.expr(self.n_expr, null)
2722 v.add("if ({i1}!=NULL) \{")
2723 v.assign(res, i1)
2724 v.add("\} else \{")
2725 var i2 = v.expr(self.n_expr2, null)
2726 v.assign(res, i2)
2727 v.add("\}")
2728 return res
2729 end
2730 end
2731
2732 redef class AIntExpr
2733 redef fun expr(v) do return v.new_expr("{self.value.to_s}", self.mtype.as(not null))
2734 end
2735
2736 redef class AFloatExpr
2737 redef fun expr(v) do return v.new_expr("{self.n_float.text}", self.mtype.as(not null)) # FIXME use value, not n_float
2738 end
2739
2740 redef class ACharExpr
2741 redef fun expr(v) do return v.new_expr("'{self.value.to_s.escape_to_c}'", self.mtype.as(not null))
2742 end
2743
2744 redef class AArrayExpr
2745 redef fun expr(v)
2746 do
2747 var mtype = self.mtype.as(MClassType).arguments.first
2748 var array = new Array[RuntimeVariable]
2749 for nexpr in self.n_exprs.n_exprs do
2750 var i = v.expr(nexpr, mtype)
2751 array.add(i)
2752 end
2753 return v.array_instance(array, mtype)
2754 end
2755 end
2756
2757 redef class AStringFormExpr
2758 redef fun expr(v) do return v.string_instance(self.value.as(not null))
2759 end
2760
2761 redef class ASuperstringExpr
2762 redef fun expr(v)
2763 do
2764 var array = new Array[RuntimeVariable]
2765 for ne in self.n_exprs do
2766 if ne isa AStringFormExpr and ne.value == "" then continue # skip empty sub-strings
2767 var i = v.expr(ne, null)
2768 array.add(i)
2769 end
2770 var a = v.array_instance(array, v.object_type)
2771 var res = v.send(v.get_property("to_s", a.mtype), [a])
2772 return res
2773 end
2774 end
2775
2776 redef class ACrangeExpr
2777 redef fun expr(v)
2778 do
2779 var i1 = v.expr(self.n_expr, null)
2780 var i2 = v.expr(self.n_expr2, null)
2781 var mtype = self.mtype.as(MClassType)
2782 var res = v.init_instance(mtype)
2783 v.compile_callsite(init_callsite.as(not null), [res, i1, i2])
2784 return res
2785 end
2786 end
2787
2788 redef class AOrangeExpr
2789 redef fun expr(v)
2790 do
2791 var i1 = v.expr(self.n_expr, null)
2792 var i2 = v.expr(self.n_expr2, null)
2793 var mtype = self.mtype.as(MClassType)
2794 var res = v.init_instance(mtype)
2795 v.compile_callsite(init_callsite.as(not null), [res, i1, i2])
2796 return res
2797 end
2798 end
2799
2800 redef class ATrueExpr
2801 redef fun expr(v) do return v.new_expr("1", self.mtype.as(not null))
2802 end
2803
2804 redef class AFalseExpr
2805 redef fun expr(v) do return v.new_expr("0", self.mtype.as(not null))
2806 end
2807
2808 redef class ANullExpr
2809 redef fun expr(v) do return v.new_expr("NULL", self.mtype.as(not null))
2810 end
2811
2812 redef class AIsaExpr
2813 redef fun expr(v)
2814 do
2815 var i = v.expr(self.n_expr, null)
2816 return v.type_test(i, self.cast_type.as(not null), "isa")
2817 end
2818 end
2819
2820 redef class AAsCastExpr
2821 redef fun expr(v)
2822 do
2823 var i = v.expr(self.n_expr, null)
2824 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return i
2825
2826 v.add_cast(i, self.mtype.as(not null), "as")
2827 return i
2828 end
2829 end
2830
2831 redef class AAsNotnullExpr
2832 redef fun expr(v)
2833 do
2834 var i = v.expr(self.n_expr, null)
2835 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return i
2836
2837 if i.mtype.ctype != "val*" then return i
2838
2839 v.add("if (unlikely({i} == NULL)) \{")
2840 v.add_abort("Cast failed")
2841 v.add("\}")
2842 return i
2843 end
2844 end
2845
2846 redef class AParExpr
2847 redef fun expr(v) do return v.expr(self.n_expr, null)
2848 end
2849
2850 redef class AOnceExpr
2851 redef fun expr(v)
2852 do
2853 var mtype = self.mtype.as(not null)
2854 var name = v.get_name("varonce")
2855 var guard = v.get_name(name + "_guard")
2856 v.add_decl("static {mtype.ctype} {name};")
2857 v.add_decl("static int {guard};")
2858 var res = v.new_var(mtype)
2859 v.add("if ({guard}) \{")
2860 v.add("{res} = {name};")
2861 v.add("\} else \{")
2862 var i = v.expr(self.n_expr, mtype)
2863 v.add("{res} = {i};")
2864 v.add("{name} = {res};")
2865 v.add("{guard} = 1;")
2866 v.add("\}")
2867 return res
2868 end
2869 end
2870
2871 redef class ASendExpr
2872 redef fun expr(v)
2873 do
2874 var recv = v.expr(self.n_expr, null)
2875 var callsite = self.callsite.as(not null)
2876 var args = v.varargize(callsite.mpropdef, recv, self.raw_arguments)
2877 return v.compile_callsite(callsite, args)
2878 end
2879 end
2880
2881 redef class ASendReassignFormExpr
2882 redef fun stmt(v)
2883 do
2884 var recv = v.expr(self.n_expr, null)
2885 var callsite = self.callsite.as(not null)
2886 var args = v.varargize(callsite.mpropdef, recv, self.raw_arguments)
2887
2888 var value = v.expr(self.n_value, null)
2889
2890 var left = v.compile_callsite(callsite, args)
2891 assert left != null
2892
2893 var res = v.compile_callsite(self.reassign_callsite.as(not null), [left, value])
2894 assert res != null
2895
2896 args.add(res)
2897 v.compile_callsite(self.write_callsite.as(not null), args)
2898 end
2899 end
2900
2901 redef class ASuperExpr
2902 redef fun expr(v)
2903 do
2904 var recv = v.frame.arguments.first
2905
2906 var callsite = self.callsite
2907 if callsite != null then
2908 var args = v.varargize(callsite.mpropdef, recv, self.n_args.n_exprs)
2909
2910 # Add additional arguments for the super init call
2911 if args.length == 1 then
2912 for i in [0..callsite.msignature.arity[ do
2913 args.add(v.frame.arguments[i+1])
2914 end
2915 end
2916 # Super init call
2917 var res = v.compile_callsite(callsite, args)
2918 return res
2919 end
2920
2921 var mpropdef = self.mpropdef.as(not null)
2922 var args = v.varargize(mpropdef, recv, self.n_args.n_exprs)
2923 if args.length == 1 then
2924 args = v.frame.arguments
2925 end
2926
2927 # stantard call-next-method
2928 return v.supercall(mpropdef, recv.mtype.as(MClassType), args)
2929 end
2930 end
2931
2932 redef class ANewExpr
2933 redef fun expr(v)
2934 do
2935 var mtype = self.recvtype
2936 assert mtype != null
2937 var recv
2938 var ctype = mtype.ctype
2939 if mtype.mclass.name == "NativeArray" then
2940 assert self.n_args.n_exprs.length == 1
2941 var l = v.expr(self.n_args.n_exprs.first, null)
2942 assert mtype isa MGenericType
2943 var elttype = mtype.arguments.first
2944 return v.native_array_instance(elttype, l)
2945 else if ctype == "val*" then
2946 recv = v.init_instance(mtype)
2947 else if ctype == "char*" then
2948 recv = v.new_expr("NULL/*special!*/", mtype)
2949 else
2950 recv = v.new_expr("({ctype})0/*special!*/", mtype)
2951 end
2952
2953 var callsite = self.callsite.as(not null)
2954 var args = v.varargize(callsite.mpropdef, recv, self.n_args.n_exprs)
2955 var res2 = v.compile_callsite(callsite, args)
2956 if res2 != null then
2957 #self.debug("got {res2} from {mproperty}. drop {recv}")
2958 return res2
2959 end
2960 return recv
2961 end
2962 end
2963
2964 redef class AAttrExpr
2965 redef fun expr(v)
2966 do
2967 var recv = v.expr(self.n_expr, null)
2968 var mproperty = self.mproperty.as(not null)
2969 return v.read_attribute(mproperty, recv)
2970 end
2971 end
2972
2973 redef class AAttrAssignExpr
2974 redef fun expr(v)
2975 do
2976 var recv = v.expr(self.n_expr, null)
2977 var i = v.expr(self.n_value, null)
2978 var mproperty = self.mproperty.as(not null)
2979 v.write_attribute(mproperty, recv, i)
2980 return i
2981 end
2982 end
2983
2984 redef class AAttrReassignExpr
2985 redef fun stmt(v)
2986 do
2987 var recv = v.expr(self.n_expr, null)
2988 var value = v.expr(self.n_value, null)
2989 var mproperty = self.mproperty.as(not null)
2990 var attr = v.read_attribute(mproperty, recv)
2991 var res = v.compile_callsite(self.reassign_callsite.as(not null), [attr, value])
2992 assert res != null
2993 v.write_attribute(mproperty, recv, res)
2994 end
2995 end
2996
2997 redef class AIssetAttrExpr
2998 redef fun expr(v)
2999 do
3000 var recv = v.expr(self.n_expr, null)
3001 var mproperty = self.mproperty.as(not null)
3002 return v.isset_attribute(mproperty, recv)
3003 end
3004 end
3005
3006 redef class ADebugTypeExpr
3007 redef fun stmt(v)
3008 do
3009 # do nothing
3010 end
3011 end
3012
3013 # Utils
3014
3015 redef class Array[E]
3016 # Return a new `Array` with the elements only contened in self and not in `o`
3017 fun -(o: Array[E]): Array[E] do
3018 var res = new Array[E]
3019 for e in self do if not o.has(e) then res.add(e)
3020 return res
3021 end
3022 end
3023
3024 redef class MModule
3025 # Return the name of the global C identifier associated to `self`.
3026 # This name is used to prefix files and other C identifiers associated with `self`.
3027 var c_name: String is lazy do
3028 var g = mgroup
3029 var res
3030 if g != null and g.mproject.name != name then
3031 res = g.mproject.name.to_cmangle + "__" + name.to_cmangle
3032 else
3033 res = name.to_cmangle
3034 end
3035 return res
3036 end
3037
3038 # All `MProperty` associated to all `MClassDef` of `mclass`
3039 fun properties(mclass: MClass): Set[MProperty] do
3040 if not self.properties_cache.has_key(mclass) then
3041 var properties = new HashSet[MProperty]
3042 var parents = new Array[MClass]
3043 if self.flatten_mclass_hierarchy.has(mclass) then
3044 parents.add_all(mclass.in_hierarchy(self).direct_greaters)
3045 end
3046 for parent in parents do
3047 properties.add_all(self.properties(parent))
3048 end
3049 for mclassdef in mclass.mclassdefs do
3050 if not self.in_importation <= mclassdef.mmodule then continue
3051 for mprop in mclassdef.intro_mproperties do
3052 properties.add(mprop)
3053 end
3054 end
3055 self.properties_cache[mclass] = properties
3056 end
3057 return properties_cache[mclass]
3058 end
3059 private var properties_cache: Map[MClass, Set[MProperty]] = new HashMap[MClass, Set[MProperty]]
3060
3061 # Write FFI and nitni results to file
3062 fun finalize_ffi(c: AbstractCompiler) do end
3063
3064 # Give requided addinional system libraries (as given to LD_LIBS)
3065 # Note: can return null instead of an empty set
3066 fun collect_linker_libs: nullable Set[String] do return null
3067 end
3068
3069 # Create a tool context to handle options and paths
3070 var toolcontext = new ToolContext
3071
3072 toolcontext.tooldescription = "Usage: nitc [OPTION]... file.nit...\nCompiles Nit programs."
3073
3074 # We do not add other options, so process them now!
3075 toolcontext.process_options(args)
3076
3077 # We need a model to collect stufs
3078 var model = new Model
3079 # An a model builder to parse files
3080 var modelbuilder = new ModelBuilder(model, toolcontext)
3081
3082 var arguments = toolcontext.option_context.rest
3083 if arguments.length > 1 and toolcontext.opt_output.value != null then
3084 print "Error: --output needs a single source file. Do you prefer --dir?"
3085 exit 1
3086 end
3087
3088 # Here we load an process all modules passed on the command line
3089 var mmodules = modelbuilder.parse(arguments)
3090
3091 if mmodules.is_empty then return
3092 modelbuilder.run_phases
3093
3094 for mmodule in mmodules do
3095 toolcontext.info("*** PROCESS {mmodule} ***", 1)
3096 var ms = [mmodule]
3097 toolcontext.run_global_phases(ms)
3098 end