Merge: Less fixme and todo
[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 # Do the full code generation of the program `mainmodule`
485 # It is the main method usually called after the instantiation
486 fun do_compilation is abstract
487
488 # Force the creation of a new file
489 # The point is to avoid contamination between must-be-compiled-separately files
490 fun new_file(name: String): CodeFile
491 do
492 if modelbuilder.toolcontext.opt_group_c_files.value then
493 if self.files.is_empty then
494 var f = new CodeFile(mainmodule.c_name)
495 self.files.add(f)
496 end
497 return self.files.first
498 end
499 var f = new CodeFile(name)
500 self.files.add(f)
501 return f
502 end
503
504 # The list of all associated files
505 # Used to generate .c files
506 var files = new List[CodeFile]
507
508 # Initialize a visitor specific for a compiler engine
509 fun new_visitor: VISITOR is abstract
510
511 # Where global declaration are stored (the main .h)
512 var header: CodeWriter is writable, noinit
513
514 # Provide a declaration that can be requested (before or latter) by a visitor
515 fun provide_declaration(key: String, s: String)
516 do
517 if self.provided_declarations.has_key(key) then
518 assert self.provided_declarations[key] == s
519 end
520 self.provided_declarations[key] = s
521 end
522
523 private var provided_declarations = new HashMap[String, String]
524
525 private var requirers_of_declarations = new HashMap[String, ANode]
526
527 # Builds the .c and .h files to be used when generating a Stack Trace
528 # Binds the generated C function names to Nit function names
529 fun build_c_to_nit_bindings
530 do
531 var compile_dir = modelbuilder.compile_dir
532
533 var stream = new OFStream.open("{compile_dir}/c_functions_hash.c")
534 stream.write("#include <string.h>\n")
535 stream.write("#include <stdlib.h>\n")
536 stream.write("#include \"c_functions_hash.h\"\n")
537 stream.write("typedef struct C_Nit_Names\{char* name; char* nit_name;\}C_Nit_Names;\n")
538 stream.write("const char* get_nit_name(register const char* procproc, register unsigned int len)\{\n")
539 stream.write("char* procname = malloc(len+1);")
540 stream.write("memcpy(procname, procproc, len);")
541 stream.write("procname[len] = '\\0';")
542 stream.write("static const C_Nit_Names map[{names.length}] = \{\n")
543 for i in names.keys do
544 stream.write("\{\"")
545 stream.write(i.escape_to_c)
546 stream.write("\",\"")
547 stream.write(names[i].escape_to_c)
548 stream.write("\"\},\n")
549 end
550 stream.write("\};\n")
551 stream.write("int i;")
552 stream.write("for(i = 0; i < {names.length}; i++)\{")
553 stream.write("if(strcmp(procname,map[i].name) == 0)\{")
554 stream.write("free(procname);")
555 stream.write("return map[i].nit_name;")
556 stream.write("\}")
557 stream.write("\}")
558 stream.write("free(procname);")
559 stream.write("return NULL;")
560 stream.write("\}\n")
561 stream.close
562
563 stream = new OFStream.open("{compile_dir}/c_functions_hash.h")
564 stream.write("const char* get_nit_name(register const char* procname, register unsigned int len);\n")
565 stream.close
566
567 extern_bodies.add(new ExternCFile("{compile_dir}/c_functions_hash.c", ""))
568 end
569
570 # Compile C headers
571 # This method call compile_header_strucs method that has to be refined
572 fun compile_header do
573 self.header.add_decl("#include <stdlib.h>")
574 self.header.add_decl("#include <stdio.h>")
575 self.header.add_decl("#include <string.h>")
576 self.header.add_decl("#include \"gc_chooser.h\"")
577 self.header.add_decl("#ifdef ANDROID")
578 self.header.add_decl(" #include <android/log.h>")
579 self.header.add_decl(" #define PRINT_ERROR(...) (void)__android_log_print(ANDROID_LOG_WARN, \"Nit\", __VA_ARGS__)")
580 self.header.add_decl("#else")
581 self.header.add_decl(" #define PRINT_ERROR(...) fprintf(stderr, __VA_ARGS__)")
582 self.header.add_decl("#endif")
583
584 compile_header_structs
585 compile_nitni_structs
586
587 var gccd_disable = modelbuilder.toolcontext.opt_no_gcc_directive.value
588 if gccd_disable.has("noreturn") or gccd_disable.has("all") then
589 # Signal handler function prototype
590 self.header.add_decl("void show_backtrace(int);")
591 else
592 self.header.add_decl("void show_backtrace(int) __attribute__ ((noreturn));")
593 end
594
595 if gccd_disable.has("likely") or gccd_disable.has("all") then
596 self.header.add_decl("#define likely(x) (x)")
597 self.header.add_decl("#define unlikely(x) (x)")
598 else if gccd_disable.has("correct-likely") then
599 # invert the `likely` definition
600 # Used by masochists to bench the worst case
601 self.header.add_decl("#define likely(x) __builtin_expect((x),0)")
602 self.header.add_decl("#define unlikely(x) __builtin_expect((x),1)")
603 else
604 self.header.add_decl("#define likely(x) __builtin_expect((x),1)")
605 self.header.add_decl("#define unlikely(x) __builtin_expect((x),0)")
606 end
607
608 # Global variable used by intern methods
609 self.header.add_decl("extern int glob_argc;")
610 self.header.add_decl("extern char **glob_argv;")
611 self.header.add_decl("extern val *glob_sys;")
612 end
613
614 # Declaration of structures for live Nit types
615 protected fun compile_header_structs is abstract
616
617 # Declaration of structures for nitni undelying the FFI
618 protected fun compile_nitni_structs
619 do
620 self.header.add_decl """
621 /* Native reference to Nit objects */
622 /* This structure is used to represent every Nit type in extern methods and custom C code. */
623 struct nitni_ref {
624 struct nitni_ref *next,
625 *prev; /* adjacent global references in global list */
626 int count; /* number of time this global reference has been marked */
627 };
628
629 /* List of global references from C code to Nit objects */
630 /* Instanciated empty at init of Nit system and filled explicitly by user in C code */
631 struct nitni_global_ref_list_t {
632 struct nitni_ref *head, *tail;
633 };
634 extern struct nitni_global_ref_list_t *nitni_global_ref_list;
635
636 /* Initializer of global reference list */
637 extern void nitni_global_ref_list_init();
638
639 /* Intern function to add a global reference to the list */
640 extern void nitni_global_ref_add( struct nitni_ref *ref );
641
642 /* Intern function to remove a global reference from the list */
643 extern void nitni_global_ref_remove( struct nitni_ref *ref );
644
645 /* Increase count on an existing global reference */
646 extern void nitni_global_ref_incr( struct nitni_ref *ref );
647
648 /* Decrease count on an existing global reference */
649 extern void nitni_global_ref_decr( struct nitni_ref *ref );
650 """
651 end
652
653 fun compile_finalizer_function
654 do
655 var finalizable_type = mainmodule.finalizable_type
656 if finalizable_type == null then return
657
658 var finalize_meth = mainmodule.try_get_primitive_method("finalize", finalizable_type.mclass)
659
660 if finalize_meth == null then
661 modelbuilder.toolcontext.error(null, "The `Finalizable` class doesn't declare the `finalize` method.")
662 return
663 end
664
665 var v = self.new_visitor
666 v.add_decl "void gc_finalize (void *obj, void *client_data) \{"
667 var recv = v.new_expr("obj", finalizable_type)
668 v.send(finalize_meth, [recv])
669 v.add "\}"
670 end
671
672 # Generate the main C function.
673 #
674 # This function:
675 #
676 # * allocate the Sys object if it exists
677 # * call init if is exists
678 # * call main if it exists
679 fun compile_main_function
680 do
681 var v = self.new_visitor
682 v.add_decl("#include <signal.h>")
683 var ost = modelbuilder.toolcontext.opt_stacktrace.value
684 var platform = mainmodule.target_platform
685
686 if platform != null and not platform.supports_libunwind then ost = "none"
687
688 var no_main = (platform != null and platform.no_main) or modelbuilder.toolcontext.opt_no_main.value
689
690 if ost == "nitstack" or ost == "libunwind" then
691 v.add_decl("#define UNW_LOCAL_ONLY")
692 v.add_decl("#include <libunwind.h>")
693 if ost == "nitstack" then
694 v.add_decl("#include \"c_functions_hash.h\"")
695 end
696 end
697 v.add_decl("int glob_argc;")
698 v.add_decl("char **glob_argv;")
699 v.add_decl("val *glob_sys;")
700
701 if self.modelbuilder.toolcontext.opt_typing_test_metrics.value then
702 for tag in count_type_test_tags do
703 v.add_decl("long count_type_test_resolved_{tag};")
704 v.add_decl("long count_type_test_unresolved_{tag};")
705 v.add_decl("long count_type_test_skipped_{tag};")
706 v.compiler.header.add_decl("extern long count_type_test_resolved_{tag};")
707 v.compiler.header.add_decl("extern long count_type_test_unresolved_{tag};")
708 v.compiler.header.add_decl("extern long count_type_test_skipped_{tag};")
709 end
710 end
711
712 if self.modelbuilder.toolcontext.opt_invocation_metrics.value then
713 v.add_decl("long count_invoke_by_tables;")
714 v.add_decl("long count_invoke_by_direct;")
715 v.add_decl("long count_invoke_by_inline;")
716 v.compiler.header.add_decl("extern long count_invoke_by_tables;")
717 v.compiler.header.add_decl("extern long count_invoke_by_direct;")
718 v.compiler.header.add_decl("extern long count_invoke_by_inline;")
719 end
720
721 if self.modelbuilder.toolcontext.opt_isset_checks_metrics.value then
722 v.add_decl("long count_attr_reads = 0;")
723 v.add_decl("long count_isset_checks = 0;")
724 v.compiler.header.add_decl("extern long count_attr_reads;")
725 v.compiler.header.add_decl("extern long count_isset_checks;")
726 end
727
728 v.add_decl("void sig_handler(int signo)\{")
729 v.add_decl("PRINT_ERROR(\"Caught signal : %s\\n\", strsignal(signo));")
730 v.add_decl("show_backtrace(signo);")
731 v.add_decl("\}")
732
733 v.add_decl("void show_backtrace (int signo) \{")
734 if ost == "nitstack" or ost == "libunwind" then
735 v.add_decl("char* opt = getenv(\"NIT_NO_STACK\");")
736 v.add_decl("unw_cursor_t cursor;")
737 v.add_decl("if(opt==NULL)\{")
738 v.add_decl("unw_context_t uc;")
739 v.add_decl("unw_word_t ip;")
740 v.add_decl("char* procname = malloc(sizeof(char) * 100);")
741 v.add_decl("unw_getcontext(&uc);")
742 v.add_decl("unw_init_local(&cursor, &uc);")
743 v.add_decl("PRINT_ERROR(\"-------------------------------------------------\\n\");")
744 v.add_decl("PRINT_ERROR(\"-- Stack Trace ------------------------------\\n\");")
745 v.add_decl("PRINT_ERROR(\"-------------------------------------------------\\n\");")
746 v.add_decl("while (unw_step(&cursor) > 0) \{")
747 v.add_decl(" unw_get_proc_name(&cursor, procname, 100, &ip);")
748 if ost == "nitstack" then
749 v.add_decl(" const char* recv = get_nit_name(procname, strlen(procname));")
750 v.add_decl(" if (recv != NULL)\{")
751 v.add_decl(" PRINT_ERROR(\"` %s\\n\", recv);")
752 v.add_decl(" \}else\{")
753 v.add_decl(" PRINT_ERROR(\"` %s\\n\", procname);")
754 v.add_decl(" \}")
755 else
756 v.add_decl(" PRINT_ERROR(\"` %s \\n\",procname);")
757 end
758 v.add_decl("\}")
759 v.add_decl("PRINT_ERROR(\"-------------------------------------------------\\n\");")
760 v.add_decl("free(procname);")
761 v.add_decl("\}")
762 end
763 v.add_decl("exit(signo);")
764 v.add_decl("\}")
765
766 if no_main then
767 v.add_decl("int nit_main(int argc, char** argv) \{")
768 else
769 v.add_decl("int main(int argc, char** argv) \{")
770 end
771
772 v.add("signal(SIGABRT, sig_handler);")
773 v.add("signal(SIGFPE, sig_handler);")
774 v.add("signal(SIGILL, sig_handler);")
775 v.add("signal(SIGINT, sig_handler);")
776 v.add("signal(SIGTERM, sig_handler);")
777 v.add("signal(SIGSEGV, sig_handler);")
778 v.add("signal(SIGPIPE, sig_handler);")
779
780 v.add("glob_argc = argc; glob_argv = argv;")
781 v.add("initialize_gc_option();")
782
783 v.add "initialize_nitni_global_refs();"
784
785 var main_type = mainmodule.sys_type
786 if main_type != null then
787 var mainmodule = v.compiler.mainmodule
788 var glob_sys = v.init_instance(main_type)
789 v.add("glob_sys = {glob_sys};")
790 var main_init = mainmodule.try_get_primitive_method("init", main_type.mclass)
791 if main_init != null then
792 v.send(main_init, [glob_sys])
793 end
794 var main_method = mainmodule.try_get_primitive_method("run", main_type.mclass) or else
795 mainmodule.try_get_primitive_method("main", main_type.mclass)
796 if main_method != null then
797 v.send(main_method, [glob_sys])
798 end
799 end
800
801 if self.modelbuilder.toolcontext.opt_typing_test_metrics.value then
802 v.add_decl("long count_type_test_resolved_total = 0;")
803 v.add_decl("long count_type_test_unresolved_total = 0;")
804 v.add_decl("long count_type_test_skipped_total = 0;")
805 v.add_decl("long count_type_test_total_total = 0;")
806 for tag in count_type_test_tags do
807 v.add_decl("long count_type_test_total_{tag};")
808 v.add("count_type_test_total_{tag} = count_type_test_resolved_{tag} + count_type_test_unresolved_{tag} + count_type_test_skipped_{tag};")
809 v.add("count_type_test_resolved_total += count_type_test_resolved_{tag};")
810 v.add("count_type_test_unresolved_total += count_type_test_unresolved_{tag};")
811 v.add("count_type_test_skipped_total += count_type_test_skipped_{tag};")
812 v.add("count_type_test_total_total += count_type_test_total_{tag};")
813 end
814 v.add("printf(\"# dynamic count_type_test: total %l\\n\");")
815 v.add("printf(\"\\tresolved\\tunresolved\\tskipped\\ttotal\\n\");")
816 var tags = count_type_test_tags.to_a
817 tags.add("total")
818 for tag in tags do
819 v.add("printf(\"{tag}\");")
820 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_resolved_{tag}, 100.0*count_type_test_resolved_{tag}/count_type_test_total_total);")
821 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_unresolved_{tag}, 100.0*count_type_test_unresolved_{tag}/count_type_test_total_total);")
822 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_skipped_{tag}, 100.0*count_type_test_skipped_{tag}/count_type_test_total_total);")
823 v.add("printf(\"\\t%ld (%.2f%%)\\n\", count_type_test_total_{tag}, 100.0*count_type_test_total_{tag}/count_type_test_total_total);")
824 end
825 end
826
827 if self.modelbuilder.toolcontext.opt_invocation_metrics.value then
828 v.add_decl("long count_invoke_total;")
829 v.add("count_invoke_total = count_invoke_by_tables + count_invoke_by_direct + count_invoke_by_inline;")
830 v.add("printf(\"# dynamic count_invocation: total %ld\\n\", count_invoke_total);")
831 v.add("printf(\"by table: %ld (%.2f%%)\\n\", count_invoke_by_tables, 100.0*count_invoke_by_tables/count_invoke_total);")
832 v.add("printf(\"direct: %ld (%.2f%%)\\n\", count_invoke_by_direct, 100.0*count_invoke_by_direct/count_invoke_total);")
833 v.add("printf(\"inlined: %ld (%.2f%%)\\n\", count_invoke_by_inline, 100.0*count_invoke_by_inline/count_invoke_total);")
834 end
835
836 if self.modelbuilder.toolcontext.opt_isset_checks_metrics.value then
837 v.add("printf(\"# dynamic attribute reads: %ld\\n\", count_attr_reads);")
838 v.add("printf(\"# dynamic isset checks: %ld\\n\", count_isset_checks);")
839 end
840
841 v.add("return 0;")
842 v.add("\}")
843 end
844
845 # Copile all C functions related to the [incr|decr]_ref features of the FFI
846 fun compile_nitni_global_ref_functions
847 do
848 var v = self.new_visitor
849 v.add """
850 struct nitni_global_ref_list_t *nitni_global_ref_list;
851 void initialize_nitni_global_refs() {
852 nitni_global_ref_list = (struct nitni_global_ref_list_t*)nit_alloc(sizeof(struct nitni_global_ref_list_t));
853 nitni_global_ref_list->head = NULL;
854 nitni_global_ref_list->tail = NULL;
855 }
856
857 void nitni_global_ref_add( struct nitni_ref *ref ) {
858 if ( nitni_global_ref_list->head == NULL ) {
859 nitni_global_ref_list->head = ref;
860 ref->prev = NULL;
861 } else {
862 nitni_global_ref_list->tail->next = ref;
863 ref->prev = nitni_global_ref_list->tail;
864 }
865 nitni_global_ref_list->tail = ref;
866
867 ref->next = NULL;
868 }
869
870 void nitni_global_ref_remove( struct nitni_ref *ref ) {
871 if ( ref->prev == NULL ) {
872 nitni_global_ref_list->head = ref->next;
873 } else {
874 ref->prev->next = ref->next;
875 }
876
877 if ( ref->next == NULL ) {
878 nitni_global_ref_list->tail = ref->prev;
879 } else {
880 ref->next->prev = ref->prev;
881 }
882 }
883
884 extern void nitni_global_ref_incr( struct nitni_ref *ref ) {
885 if ( ref->count == 0 ) /* not registered */
886 {
887 /* add to list */
888 nitni_global_ref_add( ref );
889 }
890
891 ref->count ++;
892 }
893
894 extern void nitni_global_ref_decr( struct nitni_ref *ref ) {
895 if ( ref->count == 1 ) /* was last reference */
896 {
897 /* remove from list */
898 nitni_global_ref_remove( ref );
899 }
900
901 ref->count --;
902 }
903 """
904 end
905
906 # List of additional files required to compile (FFI)
907 var extern_bodies = new Array[ExternFile]
908
909 # List of source files to copy over to the compile dir
910 var files_to_copy = new Array[String]
911
912 # This is used to avoid adding an extern file more than once
913 private var seen_extern = new ArraySet[String]
914
915 # Generate code that initialize the attributes on a new instance
916 fun generate_init_attr(v: VISITOR, recv: RuntimeVariable, mtype: MClassType)
917 do
918 var cds = mtype.collect_mclassdefs(self.mainmodule).to_a
919 self.mainmodule.linearize_mclassdefs(cds)
920 for cd in cds do
921 for npropdef in modelbuilder.collect_attr_propdef(cd) do
922 npropdef.init_expr(v, recv)
923 end
924 end
925 end
926
927 # Generate code that check if an attribute is correctly initialized
928 fun generate_check_attr(v: VISITOR, recv: RuntimeVariable, mtype: MClassType)
929 do
930 var cds = mtype.collect_mclassdefs(self.mainmodule).to_a
931 self.mainmodule.linearize_mclassdefs(cds)
932 for cd in cds do
933 for npropdef in modelbuilder.collect_attr_propdef(cd) do
934 npropdef.check_expr(v, recv)
935 end
936 end
937 end
938
939 # stats
940
941 var count_type_test_tags: Array[String] = ["isa", "as", "auto", "covariance", "erasure"]
942 var count_type_test_resolved: HashMap[String, Int] = init_count_type_test_tags
943 var count_type_test_unresolved: HashMap[String, Int] = init_count_type_test_tags
944 var count_type_test_skipped: HashMap[String, Int] = init_count_type_test_tags
945
946 protected fun init_count_type_test_tags: HashMap[String, Int]
947 do
948 var res = new HashMap[String, Int]
949 for tag in count_type_test_tags do
950 res[tag] = 0
951 end
952 return res
953 end
954
955 # Display stats about compilation process
956 #
957 # Metrics used:
958 #
959 # * type tests against resolved types (`x isa Collection[Animal]`)
960 # * type tests against unresolved types (`x isa Collection[E]`)
961 # * type tests skipped
962 # * type tests total
963 fun display_stats
964 do
965 if self.modelbuilder.toolcontext.opt_typing_test_metrics.value then
966 print "# static count_type_test"
967 print "\tresolved:\tunresolved\tskipped\ttotal"
968 var count_type_test_total = init_count_type_test_tags
969 count_type_test_resolved["total"] = 0
970 count_type_test_unresolved["total"] = 0
971 count_type_test_skipped["total"] = 0
972 count_type_test_total["total"] = 0
973 for tag in count_type_test_tags do
974 count_type_test_total[tag] = count_type_test_resolved[tag] + count_type_test_unresolved[tag] + count_type_test_skipped[tag]
975 count_type_test_resolved["total"] += count_type_test_resolved[tag]
976 count_type_test_unresolved["total"] += count_type_test_unresolved[tag]
977 count_type_test_skipped["total"] += count_type_test_skipped[tag]
978 count_type_test_total["total"] += count_type_test_total[tag]
979 end
980 var count_type_test = count_type_test_total["total"]
981 var tags = count_type_test_tags.to_a
982 tags.add("total")
983 for tag in tags do
984 printn tag
985 printn "\t{count_type_test_resolved[tag]} ({div(count_type_test_resolved[tag],count_type_test)}%)"
986 printn "\t{count_type_test_unresolved[tag]} ({div(count_type_test_unresolved[tag],count_type_test)}%)"
987 printn "\t{count_type_test_skipped[tag]} ({div(count_type_test_skipped[tag],count_type_test)}%)"
988 printn "\t{count_type_test_total[tag]} ({div(count_type_test_total[tag],count_type_test)}%)"
989 print ""
990 end
991 end
992 end
993
994 fun finalize_ffi_for_module(mmodule: MModule) do mmodule.finalize_ffi(self)
995
996 # Division facility
997 # Avoid division by zero by returning the string "n/a"
998 fun div(a,b:Int):String
999 do
1000 if b == 0 then return "n/a"
1001 return ((a*10000/b).to_f / 100.0).to_precision(2)
1002 end
1003 end
1004
1005 # A file unit (may be more than one file if
1006 # A file unit aim to be autonomous and is made or one or more `CodeWriter`s
1007 class CodeFile
1008 var name: String
1009 var writers = new Array[CodeWriter]
1010 var required_declarations = new HashSet[String]
1011 end
1012
1013 # Where to store generated lines
1014 class CodeWriter
1015 var file: CodeFile
1016 var lines: List[String] = new List[String]
1017 var decl_lines: List[String] = new List[String]
1018
1019 # Add a line in the main part of the generated C
1020 fun add(s: String) do self.lines.add(s)
1021
1022 # Add a line in the
1023 # (used for local or global declaration)
1024 fun add_decl(s: String) do self.decl_lines.add(s)
1025
1026 init
1027 do
1028 file.writers.add(self)
1029 end
1030 end
1031
1032 # A visitor on the AST of property definition that generate the C code.
1033 abstract class AbstractCompilerVisitor
1034
1035 type COMPILER: AbstractCompiler
1036
1037 # The associated compiler
1038 var compiler: COMPILER
1039
1040 # The current visited AST node
1041 var current_node: nullable ANode = null is writable
1042
1043 # The current `Frame`
1044 var frame: nullable Frame = null is writable
1045
1046 # Alias for self.compiler.mainmodule.object_type
1047 fun object_type: MClassType do return self.compiler.mainmodule.object_type
1048
1049 # Alias for self.compiler.mainmodule.bool_type
1050 fun bool_type: MClassType do return self.compiler.mainmodule.bool_type
1051
1052 var writer: CodeWriter is noinit
1053
1054 init
1055 do
1056 self.writer = new CodeWriter(compiler.files.last)
1057 end
1058
1059 # Force to get the primitive class named `name` or abort
1060 fun get_class(name: String): MClass do return self.compiler.mainmodule.get_primitive_class(name)
1061
1062 # Force to get the primitive property named `name` in the instance `recv` or abort
1063 fun get_property(name: String, recv: MType): MMethod
1064 do
1065 assert recv isa MClassType
1066 return self.compiler.modelbuilder.force_get_primitive_method(self.current_node, name, recv.mclass, self.compiler.mainmodule)
1067 end
1068
1069 fun compile_callsite(callsite: CallSite, arguments: Array[RuntimeVariable]): nullable RuntimeVariable
1070 do
1071 var initializers = callsite.mpropdef.initializers
1072 if not initializers.is_empty then
1073 var recv = arguments.first
1074
1075 var i = 1
1076 for p in initializers do
1077 if p isa MMethod then
1078 var args = [recv]
1079 for x in p.intro.msignature.mparameters do
1080 args.add arguments[i]
1081 i += 1
1082 end
1083 self.send(p, args)
1084 else if p isa MAttribute then
1085 self.write_attribute(p, recv, arguments[i])
1086 i += 1
1087 else abort
1088 end
1089 assert i == arguments.length
1090
1091 return self.send(callsite.mproperty, [recv])
1092 end
1093
1094 return self.send(callsite.mproperty, arguments)
1095 end
1096
1097 fun native_array_instance(elttype: MType, length: RuntimeVariable): RuntimeVariable is abstract
1098
1099 fun calloc_array(ret_type: MType, arguments: Array[RuntimeVariable]) is abstract
1100
1101 fun native_array_def(pname: String, ret_type: nullable MType, arguments: Array[RuntimeVariable]) is abstract
1102
1103 # Evaluate `args` as expressions in the call of `mpropdef` on `recv`.
1104 # This method is used to manage varargs in signatures and returns the real array
1105 # of runtime variables to use in the call.
1106 fun varargize(mpropdef: MMethodDef, recv: RuntimeVariable, args: SequenceRead[AExpr]): Array[RuntimeVariable]
1107 do
1108 var msignature = mpropdef.new_msignature or else mpropdef.msignature.as(not null)
1109 var res = new Array[RuntimeVariable]
1110 res.add(recv)
1111
1112 if args.is_empty then return res
1113
1114 var vararg_rank = msignature.vararg_rank
1115 var vararg_len = args.length - msignature.arity
1116 if vararg_len < 0 then vararg_len = 0
1117
1118 for i in [0..msignature.arity[ do
1119 if i == vararg_rank then
1120 var ne = args[i]
1121 if ne isa AVarargExpr then
1122 var e = self.expr(ne.n_expr, null)
1123 res.add(e)
1124 continue
1125 end
1126 var vararg = new Array[RuntimeVariable]
1127 for j in [vararg_rank..vararg_rank+vararg_len] do
1128 var e = self.expr(args[j], null)
1129 vararg.add(e)
1130 end
1131 var elttype = msignature.mparameters[vararg_rank].mtype
1132 var arg = self.vararg_instance(mpropdef, recv, vararg, elttype)
1133 res.add(arg)
1134 else
1135 var j = i
1136 if i > vararg_rank then j += vararg_len
1137 var e = self.expr(args[j], null)
1138 res.add(e)
1139 end
1140 end
1141 return res
1142 end
1143
1144 # Type handling
1145
1146 # Anchor a type to the main module and the current receiver
1147 fun anchor(mtype: MType): MType
1148 do
1149 if not mtype.need_anchor then return mtype
1150 return mtype.anchor_to(self.compiler.mainmodule, self.frame.receiver)
1151 end
1152
1153 fun resolve_for(mtype: MType, recv: RuntimeVariable): MType
1154 do
1155 if not mtype.need_anchor then return mtype
1156 return mtype.resolve_for(recv.mcasttype, self.frame.receiver, self.compiler.mainmodule, true)
1157 end
1158
1159 # Unsafely cast a value to a new type
1160 # ie the result share the same C variable but my have a different mcasttype
1161 # NOTE: if the adaptation is useless then `value` is returned as it.
1162 # ENSURE: `result.name == value.name`
1163 fun autoadapt(value: RuntimeVariable, mtype: MType): RuntimeVariable
1164 do
1165 mtype = self.anchor(mtype)
1166 var valmtype = value.mcasttype
1167 if valmtype.is_subtype(self.compiler.mainmodule, null, mtype) then
1168 return value
1169 end
1170
1171 if valmtype isa MNullableType and valmtype.mtype.is_subtype(self.compiler.mainmodule, null, mtype) then
1172 var res = new RuntimeVariable(value.name, valmtype, valmtype.mtype)
1173 return res
1174 else
1175 var res = new RuntimeVariable(value.name, valmtype, mtype)
1176 return res
1177 end
1178 end
1179
1180 # Generate a super call from a method definition
1181 fun supercall(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1182
1183 # Adapt the arguments of a method according to targetted `MMethodDef`
1184 fun adapt_signature(m: MMethodDef, args: Array[RuntimeVariable]) is abstract
1185
1186 # Unbox all the arguments of a method when implemented `extern` or `intern`
1187 fun unbox_signature_extern(m: MMethodDef, args: Array[RuntimeVariable]) is abstract
1188
1189 # Box or unbox a value to another type iff a C type conversion is needed
1190 # ENSURE: `result.mtype.ctype == mtype.ctype`
1191 fun autobox(value: RuntimeVariable, mtype: MType): RuntimeVariable is abstract
1192
1193 # Box extern classes to be used in the generated code
1194 fun box_extern(value: RuntimeVariable, mtype: MType): RuntimeVariable is abstract
1195
1196 # Unbox extern classes to be used in extern code (legacy NI and FFI)
1197 fun unbox_extern(value: RuntimeVariable, mtype: MType): RuntimeVariable is abstract
1198
1199 # Generate a polymorphic subtype test
1200 fun type_test(value: RuntimeVariable, mtype: MType, tag: String): RuntimeVariable is abstract
1201
1202 # Generate the code required to dynamically check if 2 objects share the same runtime type
1203 fun is_same_type_test(value1, value2: RuntimeVariable): RuntimeVariable is abstract
1204
1205 # Generate a Nit "is" for two runtime_variables
1206 fun equal_test(value1, value2: RuntimeVariable): RuntimeVariable is abstract
1207
1208 # Sends
1209
1210 # Generate a static call on a method definition
1211 fun call(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1212
1213 # Generate a polymorphic send for the method `m` and the arguments `args`
1214 fun send(m: MMethod, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1215
1216 # Generate a monomorphic send for the method `m`, the type `t` and the arguments `args`
1217 fun monomorphic_send(m: MMethod, t: MType, args: Array[RuntimeVariable]): nullable RuntimeVariable
1218 do
1219 assert t isa MClassType
1220 var propdef = m.lookup_first_definition(self.compiler.mainmodule, t)
1221 return self.call(propdef, t, args)
1222 end
1223
1224 # Generate a monomorphic super send from the method `m`, the type `t` and the arguments `args`
1225 fun monomorphic_super_send(m: MMethodDef, t: MType, args: Array[RuntimeVariable]): nullable RuntimeVariable
1226 do
1227 assert t isa MClassType
1228 m = m.lookup_next_definition(self.compiler.mainmodule, t)
1229 return self.call(m, t, args)
1230 end
1231
1232 # Attributes handling
1233
1234 # Generate a polymorphic attribute is_set test
1235 fun isset_attribute(a: MAttribute, recv: RuntimeVariable): RuntimeVariable is abstract
1236
1237 # Generate a polymorphic attribute read
1238 fun read_attribute(a: MAttribute, recv: RuntimeVariable): RuntimeVariable is abstract
1239
1240 # Generate a polymorphic attribute write
1241 fun write_attribute(a: MAttribute, recv: RuntimeVariable, value: RuntimeVariable) is abstract
1242
1243 # Checks
1244
1245 # Add a check and an abort for a null receiver if needed
1246 fun check_recv_notnull(recv: RuntimeVariable)
1247 do
1248 if self.compiler.modelbuilder.toolcontext.opt_no_check_null.value then return
1249
1250 var maybenull = recv.mcasttype isa MNullableType or recv.mcasttype isa MNullType
1251 if maybenull then
1252 self.add("if (unlikely({recv} == NULL)) \{")
1253 self.add_abort("Receiver is null")
1254 self.add("\}")
1255 end
1256 end
1257
1258 # Names handling
1259
1260 private var names = new HashSet[String]
1261 private var last: Int = 0
1262
1263 # Return a new name based on `s` and unique in the visitor
1264 fun get_name(s: String): String
1265 do
1266 if not self.names.has(s) then
1267 self.names.add(s)
1268 return s
1269 end
1270 var i = self.last + 1
1271 loop
1272 var s2 = s + i.to_s
1273 if not self.names.has(s2) then
1274 self.last = i
1275 self.names.add(s2)
1276 return s2
1277 end
1278 i = i + 1
1279 end
1280 end
1281
1282 # Return an unique and stable identifier associated with an escapemark
1283 fun escapemark_name(e: nullable EscapeMark): String
1284 do
1285 assert e != null
1286 if frame.escapemark_names.has_key(e) then return frame.escapemark_names[e]
1287 var name = e.name
1288 if name == null then name = "label"
1289 name = get_name(name)
1290 frame.escapemark_names[e] = name
1291 return name
1292 end
1293
1294 # Insert a C label for associated with an escapemark
1295 fun add_escape_label(e: nullable EscapeMark)
1296 do
1297 if e == null then return
1298 if e.escapes.is_empty then return
1299 add("BREAK_{escapemark_name(e)}: (void)0;")
1300 end
1301
1302 # Return a "const char*" variable associated to the classname of the dynamic type of an object
1303 # NOTE: we do not return a `RuntimeVariable` "NativeString" as the class may not exist in the module/program
1304 fun class_name_string(value: RuntimeVariable): String is abstract
1305
1306 # Variables handling
1307
1308 protected var variables = new HashMap[Variable, RuntimeVariable]
1309
1310 # Return the local runtime_variable associated to a Nit local variable
1311 fun variable(variable: Variable): RuntimeVariable
1312 do
1313 if self.variables.has_key(variable) then
1314 return self.variables[variable]
1315 else
1316 var name = self.get_name("var_{variable.name}")
1317 var mtype = variable.declared_type.as(not null)
1318 mtype = self.anchor(mtype)
1319 var res = new RuntimeVariable(name, mtype, mtype)
1320 self.add_decl("{mtype.ctype} {name} /* var {variable}: {mtype} */;")
1321 self.variables[variable] = res
1322 return res
1323 end
1324 end
1325
1326 # Return a new uninitialized local runtime_variable
1327 fun new_var(mtype: MType): RuntimeVariable
1328 do
1329 mtype = self.anchor(mtype)
1330 var name = self.get_name("var")
1331 var res = new RuntimeVariable(name, mtype, mtype)
1332 self.add_decl("{mtype.ctype} {name} /* : {mtype} */;")
1333 return res
1334 end
1335
1336 # The difference with `new_var` is the C static type of the local variable
1337 fun new_var_extern(mtype: MType): RuntimeVariable
1338 do
1339 mtype = self.anchor(mtype)
1340 var name = self.get_name("var")
1341 var res = new RuntimeVariable(name, mtype, mtype)
1342 self.add_decl("{mtype.ctype_extern} {name} /* : {mtype} for extern */;")
1343 return res
1344 end
1345
1346 # Return a new uninitialized named runtime_variable
1347 fun new_named_var(mtype: MType, name: String): RuntimeVariable
1348 do
1349 mtype = self.anchor(mtype)
1350 var res = new RuntimeVariable(name, mtype, mtype)
1351 self.add_decl("{mtype.ctype} {name} /* : {mtype} */;")
1352 return res
1353 end
1354
1355 # Correctly assign a left and a right value
1356 # Boxing and unboxing is performed if required
1357 fun assign(left, right: RuntimeVariable)
1358 do
1359 right = self.autobox(right, left.mtype)
1360 self.add("{left} = {right};")
1361 end
1362
1363 # Generate instances
1364
1365 # Generate a alloc-instance + init-attributes
1366 fun init_instance(mtype: MClassType): RuntimeVariable is abstract
1367
1368 # Set a GC finalizer on `recv`, only if `recv` isa Finalizable
1369 fun set_finalizer(recv: RuntimeVariable)
1370 do
1371 var mtype = recv.mtype
1372 var finalizable_type = compiler.mainmodule.finalizable_type
1373 if finalizable_type != null and not mtype.need_anchor and
1374 mtype.is_subtype(compiler.mainmodule, null, finalizable_type) then
1375 add "gc_register_finalizer({recv});"
1376 end
1377 end
1378
1379 # Generate an integer value
1380 fun int_instance(value: Int): RuntimeVariable
1381 do
1382 var res = self.new_var(self.get_class("Int").mclass_type)
1383 self.add("{res} = {value};")
1384 return res
1385 end
1386
1387 # Generate an integer value
1388 fun bool_instance(value: Bool): RuntimeVariable
1389 do
1390 var res = self.new_var(self.get_class("Bool").mclass_type)
1391 if value then
1392 self.add("{res} = 1;")
1393 else
1394 self.add("{res} = 0;")
1395 end
1396 return res
1397 end
1398
1399 # Generate a string value
1400 fun string_instance(string: String): RuntimeVariable
1401 do
1402 var mtype = self.get_class("String").mclass_type
1403 var name = self.get_name("varonce")
1404 self.add_decl("static {mtype.ctype} {name};")
1405 var res = self.new_var(mtype)
1406 self.add("if ({name}) \{")
1407 self.add("{res} = {name};")
1408 self.add("\} else \{")
1409 var native_mtype = self.get_class("NativeString").mclass_type
1410 var nat = self.new_var(native_mtype)
1411 self.add("{nat} = \"{string.escape_to_c}\";")
1412 var length = self.int_instance(string.length)
1413 self.add("{res} = {self.send(self.get_property("to_s_with_length", native_mtype), [nat, length]).as(not null)};")
1414 self.add("{name} = {res};")
1415 self.add("\}")
1416 return res
1417 end
1418
1419 fun value_instance(object: Object): RuntimeVariable
1420 do
1421 if object isa Int then
1422 return int_instance(object)
1423 else if object isa Bool then
1424 return bool_instance(object)
1425 else if object isa String then
1426 return string_instance(object)
1427 else
1428 abort
1429 end
1430 end
1431
1432 # Generate an array value
1433 fun array_instance(array: Array[RuntimeVariable], elttype: MType): RuntimeVariable is abstract
1434
1435 # Get an instance of a array for a vararg
1436 fun vararg_instance(mpropdef: MPropDef, recv: RuntimeVariable, varargs: Array[RuntimeVariable], elttype: MType): RuntimeVariable is abstract
1437
1438 # Code generation
1439
1440 # Add a line in the main part of the generated C
1441 fun add(s: String) do self.writer.lines.add(s)
1442
1443 # Add a line in the
1444 # (used for local or global declaration)
1445 fun add_decl(s: String) do self.writer.decl_lines.add(s)
1446
1447 # Request the presence of a global declaration
1448 fun require_declaration(key: String)
1449 do
1450 var reqs = self.writer.file.required_declarations
1451 if reqs.has(key) then return
1452 reqs.add(key)
1453 var node = current_node
1454 if node != null then compiler.requirers_of_declarations[key] = node
1455 end
1456
1457 # Add a declaration in the local-header
1458 # The declaration is ensured to be present once
1459 fun declare_once(s: String)
1460 do
1461 self.compiler.provide_declaration(s, s)
1462 self.require_declaration(s)
1463 end
1464
1465 # Look for a needed .h and .c file for a given module
1466 # This is used for the legacy FFI
1467 fun add_extern(mmodule: MModule)
1468 do
1469 var file = mmodule.location.file.filename
1470 file = file.strip_extension(".nit")
1471 var 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 tryfile = file + "_nit.h"
1477 if tryfile.file_exists then
1478 self.declare_once("#include \"{tryfile.basename("")}\"")
1479 self.compiler.files_to_copy.add(tryfile)
1480 end
1481
1482 if self.compiler.seen_extern.has(file) then return
1483 self.compiler.seen_extern.add(file)
1484 tryfile = file + ".nit.c"
1485 if not tryfile.file_exists then
1486 tryfile = file + "_nit.c"
1487 if not tryfile.file_exists then return
1488 end
1489 var f = new ExternCFile(tryfile.basename(""), "")
1490 self.compiler.extern_bodies.add(f)
1491 self.compiler.files_to_copy.add(tryfile)
1492 end
1493
1494 # Return a new local runtime_variable initialized with the C expression `cexpr`.
1495 fun new_expr(cexpr: String, mtype: MType): RuntimeVariable
1496 do
1497 var res = new_var(mtype)
1498 self.add("{res} = {cexpr};")
1499 return res
1500 end
1501
1502 # Generate generic abort
1503 # used by aborts, asserts, casts, etc.
1504 fun add_abort(message: String)
1505 do
1506 self.add("PRINT_ERROR(\"Runtime error: %s\", \"{message.escape_to_c}\");")
1507 add_raw_abort
1508 end
1509
1510 fun add_raw_abort
1511 do
1512 if self.current_node != null and self.current_node.location.file != null then
1513 self.add("PRINT_ERROR(\" (%s:%d)\\n\", \"{self.current_node.location.file.filename.escape_to_c}\", {current_node.location.line_start});")
1514 else
1515 self.add("PRINT_ERROR(\"\\n\");")
1516 end
1517 self.add("show_backtrace(1);")
1518 end
1519
1520 # Add a dynamic cast
1521 fun add_cast(value: RuntimeVariable, mtype: MType, tag: String)
1522 do
1523 var res = self.type_test(value, mtype, tag)
1524 self.add("if (unlikely(!{res})) \{")
1525 var cn = self.class_name_string(value)
1526 self.add("PRINT_ERROR(\"Runtime error: Cast failed. Expected `%s`, got `%s`\", \"{mtype.to_s.escape_to_c}\", {cn});")
1527 self.add_raw_abort
1528 self.add("\}")
1529 end
1530
1531 # Generate a return with the value `s`
1532 fun ret(s: RuntimeVariable)
1533 do
1534 self.assign(self.frame.returnvar.as(not null), s)
1535 self.add("goto {self.frame.returnlabel.as(not null)};")
1536 end
1537
1538 # Compile a statement (if any)
1539 fun stmt(nexpr: nullable AExpr)
1540 do
1541 if nexpr == null then return
1542
1543 var narray = nexpr.comprehension
1544 if narray != null then
1545 var recv = frame.comprehension.as(not null)
1546 var val = expr(nexpr, narray.element_mtype)
1547 compile_callsite(narray.push_callsite.as(not null), [recv, val])
1548 return
1549 end
1550
1551 var old = self.current_node
1552 self.current_node = nexpr
1553 nexpr.stmt(self)
1554 self.current_node = old
1555 end
1556
1557 # Compile an expression an return its result
1558 # `mtype` is the expected return type, pass null if no specific type is expected.
1559 fun expr(nexpr: AExpr, mtype: nullable MType): RuntimeVariable
1560 do
1561 var old = self.current_node
1562 self.current_node = nexpr
1563 var res = nexpr.expr(self).as(not null)
1564 if mtype != null then
1565 mtype = self.anchor(mtype)
1566 res = self.autobox(res, mtype)
1567 end
1568 res = autoadapt(res, nexpr.mtype.as(not null))
1569 var implicit_cast_to = nexpr.implicit_cast_to
1570 if implicit_cast_to != null and not self.compiler.modelbuilder.toolcontext.opt_no_check_autocast.value then
1571 add_cast(res, implicit_cast_to, "auto")
1572 res = autoadapt(res, implicit_cast_to)
1573 end
1574 self.current_node = old
1575 return res
1576 end
1577
1578 # Alias for `self.expr(nexpr, self.bool_type)`
1579 fun expr_bool(nexpr: AExpr): RuntimeVariable do return expr(nexpr, bool_type)
1580
1581 # Safely show a debug message on the current node and repeat the message in the C code as a comment
1582 fun debug(message: String)
1583 do
1584 var node = self.current_node
1585 if node == null then
1586 print "?: {message}"
1587 else
1588 node.debug(message)
1589 end
1590 self.add("/* DEBUG: {message} */")
1591 end
1592 end
1593
1594 # A C function associated to a Nit method
1595 # Because of customization, a given Nit method can be compiler more that once
1596 abstract class AbstractRuntimeFunction
1597
1598 type COMPILER: AbstractCompiler
1599 type VISITOR: AbstractCompilerVisitor
1600
1601 # The associated Nit method
1602 var mmethoddef: MMethodDef
1603
1604 # The mangled c name of the runtime_function
1605 # Subclasses should redefine `build_c_name` instead
1606 fun c_name: String
1607 do
1608 var res = self.c_name_cache
1609 if res != null then return res
1610 res = self.build_c_name
1611 self.c_name_cache = res
1612 return res
1613 end
1614
1615 # Non cached version of `c_name`
1616 protected fun build_c_name: String is abstract
1617
1618 protected var c_name_cache: nullable String = null is writable
1619
1620 # Implements a call of the runtime_function
1621 # May inline the body or generate a C function call
1622 fun call(v: VISITOR, arguments: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1623
1624 # Generate the code for the `AbstractRuntimeFunction`
1625 # Warning: compile more than once compilation makes CC unhappy
1626 fun compile_to_c(compiler: COMPILER) is abstract
1627 end
1628
1629 # A runtime variable hold a runtime value in C.
1630 # Runtime variables are associated to Nit local variables and intermediate results in Nit expressions.
1631 #
1632 # 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.
1633 class RuntimeVariable
1634 # The name of the variable in the C code
1635 var name: String
1636
1637 # The static type of the variable (as declard in C)
1638 var mtype: MType
1639
1640 # The current casted type of the variable (as known in Nit)
1641 var mcasttype: MType is writable
1642
1643 # If the variable exaclty a mcasttype?
1644 # false (usual value) means that the variable is a mcasttype or a subtype.
1645 var is_exact: Bool = false is writable
1646
1647 init
1648 do
1649 assert not mtype.need_anchor
1650 assert not mcasttype.need_anchor
1651 end
1652
1653 redef fun to_s do return name
1654
1655 redef fun inspect
1656 do
1657 var exact_str
1658 if self.is_exact then
1659 exact_str = " exact"
1660 else
1661 exact_str = ""
1662 end
1663 var type_str
1664 if self.mtype == self.mcasttype then
1665 type_str = "{mtype}{exact_str}"
1666 else
1667 type_str = "{mtype}({mcasttype}{exact_str})"
1668 end
1669 return "<{name}:{type_str}>"
1670 end
1671 end
1672
1673 # A frame correspond to a visited property in a `GlobalCompilerVisitor`
1674 class Frame
1675
1676 type VISITOR: AbstractCompilerVisitor
1677
1678 # The associated visitor
1679 var visitor: VISITOR
1680
1681 # The executed property.
1682 # A Method in case of a call, an attribute in case of a default initialization.
1683 var mpropdef: MPropDef
1684
1685 # The static type of the receiver
1686 var receiver: MClassType
1687
1688 # Arguments of the method (the first is the receiver)
1689 var arguments: Array[RuntimeVariable]
1690
1691 # The runtime_variable associated to the return (in a function)
1692 var returnvar: nullable RuntimeVariable = null is writable
1693
1694 # The label at the end of the property
1695 var returnlabel: nullable String = null is writable
1696
1697 # Labels associated to a each escapemarks.
1698 # Because of inlinings, escape-marks must be associated to their context (the frame)
1699 private var escapemark_names = new HashMap[EscapeMark, String]
1700
1701 # The array comprehension currently filled, if any
1702 private var comprehension: nullable RuntimeVariable = null
1703 end
1704
1705 redef class MType
1706 # Return the C type associated to a given Nit static type
1707 fun ctype: String do return "val*"
1708
1709 # C type outside of the compiler code and in boxes
1710 fun ctype_extern: String do return "val*"
1711
1712 # Short name of the `ctype` to use in unions
1713 fun ctypename: String do return "val"
1714 end
1715
1716 redef class MClassType
1717
1718 redef fun ctype: String
1719 do
1720 if mclass.name == "Int" then
1721 return "long"
1722 else if mclass.name == "Bool" then
1723 return "short int"
1724 else if mclass.name == "Char" then
1725 return "char"
1726 else if mclass.name == "Float" then
1727 return "double"
1728 else if mclass.name == "NativeString" then
1729 return "char*"
1730 else if mclass.name == "NativeArray" then
1731 return "val*"
1732 else
1733 return "val*"
1734 end
1735 end
1736
1737 redef fun ctype_extern: String
1738 do
1739 if mclass.kind == extern_kind then
1740 return "void*"
1741 else
1742 return ctype
1743 end
1744 end
1745
1746 redef fun ctypename: String
1747 do
1748 if mclass.name == "Int" then
1749 return "l"
1750 else if mclass.name == "Bool" then
1751 return "s"
1752 else if mclass.name == "Char" then
1753 return "c"
1754 else if mclass.name == "Float" then
1755 return "d"
1756 else if mclass.name == "NativeString" then
1757 return "str"
1758 else if mclass.name == "NativeArray" then
1759 #return "{self.arguments.first.ctype}*"
1760 return "val"
1761 else
1762 return "val"
1763 end
1764 end
1765 end
1766
1767 redef class MPropDef
1768 type VISITOR: AbstractCompilerVisitor
1769 end
1770
1771 redef class MMethodDef
1772 # Can the body be inlined?
1773 fun can_inline(v: VISITOR): Bool
1774 do
1775 if is_abstract then return true
1776 var modelbuilder = v.compiler.modelbuilder
1777 var node = modelbuilder.mpropdef2node(self)
1778 if node isa APropdef then
1779 return node.can_inline
1780 else if node isa AClassdef then
1781 # Automatic free init is always inlined since it is empty or contains only attribtes assigments
1782 return true
1783 else
1784 abort
1785 end
1786 end
1787
1788 # Inline the body in another visitor
1789 fun compile_inside_to_c(v: VISITOR, arguments: Array[RuntimeVariable]): nullable RuntimeVariable
1790 do
1791 var modelbuilder = v.compiler.modelbuilder
1792 var val = constant_value
1793 var node = modelbuilder.mpropdef2node(self)
1794 if node isa APropdef then
1795 var oldnode = v.current_node
1796 v.current_node = node
1797 self.compile_parameter_check(v, arguments)
1798 node.compile_to_c(v, self, arguments)
1799 v.current_node = oldnode
1800 else if node isa AClassdef then
1801 var oldnode = v.current_node
1802 v.current_node = node
1803 self.compile_parameter_check(v, arguments)
1804 node.compile_to_c(v, self, arguments)
1805 v.current_node = oldnode
1806 else if val != null then
1807 v.ret(v.value_instance(val))
1808 else
1809 abort
1810 end
1811 return null
1812 end
1813
1814 # Generate type checks in the C code to check covariant parameters
1815 fun compile_parameter_check(v: VISITOR, arguments: Array[RuntimeVariable])
1816 do
1817 if v.compiler.modelbuilder.toolcontext.opt_no_check_covariance.value then return
1818
1819 for i in [0..msignature.arity[ do
1820 # skip test for vararg since the array is instantiated with the correct polymorphic type
1821 if msignature.vararg_rank == i then continue
1822
1823 # skip if the cast is not required
1824 var origmtype = self.mproperty.intro.msignature.mparameters[i].mtype
1825 if not origmtype.need_anchor then continue
1826
1827 # get the parameter type
1828 var mtype = self.msignature.mparameters[i].mtype
1829
1830 # generate the cast
1831 # note that v decides if and how to implements the cast
1832 v.add("/* Covariant cast for argument {i} ({self.msignature.mparameters[i].name}) {arguments[i+1].inspect} isa {mtype} */")
1833 v.add_cast(arguments[i+1], mtype, "covariance")
1834 end
1835 end
1836 end
1837
1838 # Node visit
1839
1840 redef class APropdef
1841 fun compile_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
1842 do
1843 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name} {mpropdef} at {location.to_s}\\n\");")
1844 debug("Not yet implemented")
1845 end
1846
1847 fun can_inline: Bool do return true
1848 end
1849
1850 redef class AMethPropdef
1851 redef fun compile_to_c(v, mpropdef, arguments)
1852 do
1853 if mpropdef.is_abstract then
1854 var cn = v.class_name_string(arguments.first)
1855 v.add("PRINT_ERROR(\"Runtime error: Abstract method `%s` called on `%s`\", \"{mpropdef.mproperty.name.escape_to_c}\", {cn});")
1856 v.add_raw_abort
1857 return
1858 end
1859
1860 # Call the implicit super-init
1861 var auto_super_inits = self.auto_super_inits
1862 if auto_super_inits != null then
1863 var args = [arguments.first]
1864 for auto_super_init in auto_super_inits do
1865 assert auto_super_init.mproperty != mpropdef.mproperty
1866 args.clear
1867 for i in [0..auto_super_init.msignature.arity+1[ do
1868 args.add(arguments[i])
1869 end
1870 assert auto_super_init.mproperty != mpropdef.mproperty
1871 v.compile_callsite(auto_super_init, args)
1872 end
1873 end
1874 if auto_super_call then
1875 v.supercall(mpropdef, arguments.first.mtype.as(MClassType), arguments)
1876 end
1877
1878 # Try special compilation
1879 if mpropdef.is_intern then
1880 if compile_intern_to_c(v, mpropdef, arguments) then return
1881 else if mpropdef.is_extern then
1882 if mpropdef.mproperty.is_init then
1883 if compile_externinit_to_c(v, mpropdef, arguments) then return
1884 else
1885 if compile_externmeth_to_c(v, mpropdef, arguments) then return
1886 end
1887 end
1888
1889 # Compile block if any
1890 var n_block = n_block
1891 if n_block != null then
1892 for i in [0..mpropdef.msignature.arity[ do
1893 var variable = self.n_signature.n_params[i].variable.as(not null)
1894 v.assign(v.variable(variable), arguments[i+1])
1895 end
1896 v.stmt(n_block)
1897 return
1898 end
1899
1900 # We have a problem
1901 var cn = v.class_name_string(arguments.first)
1902 v.add("PRINT_ERROR(\"Runtime error: uncompiled method `%s` called on `%s`. NOT YET IMPLEMENTED\", \"{mpropdef.mproperty.name.escape_to_c}\", {cn});")
1903 v.add_raw_abort
1904 end
1905
1906 redef fun can_inline
1907 do
1908 if self.auto_super_inits != null then return false
1909 var nblock = self.n_block
1910 if nblock == null then return true
1911 if (mpropdef.mproperty.name == "==" or mpropdef.mproperty.name == "!=") and mpropdef.mclassdef.mclass.name == "Object" then return true
1912 if nblock isa ABlockExpr and nblock.n_expr.length == 0 then return true
1913 return false
1914 end
1915
1916 fun compile_intern_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable]): Bool
1917 do
1918 var pname = mpropdef.mproperty.name
1919 var cname = mpropdef.mclassdef.mclass.name
1920 var ret = mpropdef.msignature.return_mtype
1921 if ret != null then
1922 ret = v.resolve_for(ret, arguments.first)
1923 end
1924 if pname != "==" and pname != "!=" then
1925 v.adapt_signature(mpropdef, arguments)
1926 v.unbox_signature_extern(mpropdef, arguments)
1927 end
1928 if cname == "Int" then
1929 if pname == "output" then
1930 v.add("printf(\"%ld\\n\", {arguments.first});")
1931 return true
1932 else if pname == "object_id" then
1933 v.ret(arguments.first)
1934 return true
1935 else if pname == "+" then
1936 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
1937 return true
1938 else if pname == "-" then
1939 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
1940 return true
1941 else if pname == "unary -" then
1942 v.ret(v.new_expr("-{arguments[0]}", ret.as(not null)))
1943 return true
1944 else if pname == "*" then
1945 v.ret(v.new_expr("{arguments[0]} * {arguments[1]}", ret.as(not null)))
1946 return true
1947 else if pname == "/" then
1948 v.ret(v.new_expr("{arguments[0]} / {arguments[1]}", ret.as(not null)))
1949 return true
1950 else if pname == "%" then
1951 v.ret(v.new_expr("{arguments[0]} % {arguments[1]}", ret.as(not null)))
1952 return true
1953 else if pname == "lshift" then
1954 v.ret(v.new_expr("{arguments[0]} << {arguments[1]}", ret.as(not null)))
1955 return true
1956 else if pname == "rshift" then
1957 v.ret(v.new_expr("{arguments[0]} >> {arguments[1]}", ret.as(not null)))
1958 return true
1959 else if pname == "==" then
1960 v.ret(v.equal_test(arguments[0], arguments[1]))
1961 return true
1962 else if pname == "!=" then
1963 var res = v.equal_test(arguments[0], arguments[1])
1964 v.ret(v.new_expr("!{res}", ret.as(not null)))
1965 return true
1966 else if pname == "<" then
1967 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
1968 return true
1969 else if pname == ">" then
1970 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
1971 return true
1972 else if pname == "<=" then
1973 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
1974 return true
1975 else if pname == ">=" then
1976 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
1977 return true
1978 else if pname == "to_f" then
1979 v.ret(v.new_expr("(double){arguments[0]}", ret.as(not null)))
1980 return true
1981 else if pname == "ascii" then
1982 v.ret(v.new_expr("{arguments[0]}", ret.as(not null)))
1983 return true
1984 end
1985 else if cname == "Char" then
1986 if pname == "output" then
1987 v.add("printf(\"%c\", {arguments.first});")
1988 return true
1989 else if pname == "object_id" then
1990 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
1991 return true
1992 else if pname == "successor" then
1993 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
1994 return true
1995 else if pname == "predecessor" then
1996 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
1997 return true
1998 else if pname == "==" then
1999 v.ret(v.equal_test(arguments[0], arguments[1]))
2000 return true
2001 else if pname == "!=" then
2002 var res = v.equal_test(arguments[0], arguments[1])
2003 v.ret(v.new_expr("!{res}", ret.as(not null)))
2004 return true
2005 else if pname == "<" then
2006 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
2007 return true
2008 else if pname == ">" then
2009 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
2010 return true
2011 else if pname == "<=" then
2012 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
2013 return true
2014 else if pname == ">=" then
2015 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
2016 return true
2017 else if pname == "to_i" then
2018 v.ret(v.new_expr("{arguments[0]}-'0'", ret.as(not null)))
2019 return true
2020 else if pname == "ascii" then
2021 v.ret(v.new_expr("(unsigned char){arguments[0]}", ret.as(not null)))
2022 return true
2023 end
2024 else if cname == "Bool" then
2025 if pname == "output" then
2026 v.add("printf({arguments.first}?\"true\\n\":\"false\\n\");")
2027 return true
2028 else if pname == "object_id" then
2029 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
2030 return true
2031 else if pname == "==" then
2032 v.ret(v.equal_test(arguments[0], arguments[1]))
2033 return true
2034 else if pname == "!=" then
2035 var res = v.equal_test(arguments[0], arguments[1])
2036 v.ret(v.new_expr("!{res}", ret.as(not null)))
2037 return true
2038 end
2039 else if cname == "Float" then
2040 if pname == "output" then
2041 v.add("printf(\"%f\\n\", {arguments.first});")
2042 return true
2043 else if pname == "object_id" then
2044 v.ret(v.new_expr("(double){arguments.first}", 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 == "unary -" then
2053 v.ret(v.new_expr("-{arguments[0]}", ret.as(not null)))
2054 return true
2055 else if pname == "succ" then
2056 v.ret(v.new_expr("{arguments[0]}+1", ret.as(not null)))
2057 return true
2058 else if pname == "prec" then
2059 v.ret(v.new_expr("{arguments[0]}-1", ret.as(not null)))
2060 return true
2061 else if pname == "*" then
2062 v.ret(v.new_expr("{arguments[0]} * {arguments[1]}", ret.as(not null)))
2063 return true
2064 else if pname == "/" then
2065 v.ret(v.new_expr("{arguments[0]} / {arguments[1]}", ret.as(not null)))
2066 return true
2067 else if pname == "==" then
2068 v.ret(v.equal_test(arguments[0], arguments[1]))
2069 return true
2070 else if pname == "!=" then
2071 var res = v.equal_test(arguments[0], arguments[1])
2072 v.ret(v.new_expr("!{res}", ret.as(not null)))
2073 return true
2074 else if pname == "<" then
2075 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
2076 return true
2077 else if pname == ">" then
2078 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
2079 return true
2080 else if pname == "<=" then
2081 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
2082 return true
2083 else if pname == ">=" then
2084 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
2085 return true
2086 else if pname == "to_i" then
2087 v.ret(v.new_expr("(long){arguments[0]}", ret.as(not null)))
2088 return true
2089 end
2090 else if cname == "NativeString" then
2091 if pname == "[]" then
2092 v.ret(v.new_expr("{arguments[0]}[{arguments[1]}]", ret.as(not null)))
2093 return true
2094 else if pname == "[]=" then
2095 v.add("{arguments[0]}[{arguments[1]}]={arguments[2]};")
2096 return true
2097 else if pname == "copy_to" then
2098 v.add("memmove({arguments[1]}+{arguments[4]},{arguments[0]}+{arguments[3]},{arguments[2]});")
2099 return true
2100 else if pname == "atoi" then
2101 v.ret(v.new_expr("atoi({arguments[0]});", ret.as(not null)))
2102 return true
2103 else if pname == "new" then
2104 v.ret(v.new_expr("(char*)nit_alloc({arguments[1]})", ret.as(not null)))
2105 return true
2106 end
2107 else if cname == "NativeArray" then
2108 v.native_array_def(pname, ret, arguments)
2109 return true
2110 end
2111 if pname == "exit" then
2112 v.add("exit({arguments[1]});")
2113 return true
2114 else if pname == "sys" then
2115 v.ret(v.new_expr("glob_sys", ret.as(not null)))
2116 return true
2117 else if pname == "calloc_string" then
2118 v.ret(v.new_expr("(char*)nit_alloc({arguments[1]})", ret.as(not null)))
2119 return true
2120 else if pname == "calloc_array" then
2121 v.calloc_array(ret.as(not null), arguments)
2122 return true
2123 else if pname == "object_id" then
2124 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
2125 return true
2126 else if pname == "is_same_type" then
2127 v.ret(v.is_same_type_test(arguments[0], arguments[1]))
2128 return true
2129 else if pname == "is_same_instance" then
2130 v.ret(v.equal_test(arguments[0], arguments[1]))
2131 return true
2132 else if pname == "output_class_name" then
2133 var nat = v.class_name_string(arguments.first)
2134 v.add("printf(\"%s\\n\", {nat});")
2135 return true
2136 else if pname == "native_class_name" then
2137 var nat = v.class_name_string(arguments.first)
2138 v.ret(v.new_expr("(char*){nat}", ret.as(not null)))
2139 return true
2140 else if pname == "force_garbage_collection" then
2141 v.add("nit_gcollect();")
2142 return true
2143 else if pname == "native_argc" then
2144 v.ret(v.new_expr("glob_argc", ret.as(not null)))
2145 return true
2146 else if pname == "native_argv" then
2147 v.ret(v.new_expr("glob_argv[{arguments[1]}]", ret.as(not null)))
2148 return true
2149 end
2150 return false
2151 end
2152
2153 # Compile an extern method
2154 # Return `true` if the compilation was successful, `false` if a fall-back is needed
2155 fun compile_externmeth_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable]): Bool
2156 do
2157 var externname
2158 var at = self.get_single_annotation("extern", v.compiler.modelbuilder)
2159 if at != null and at.n_args.length == 1 then
2160 externname = at.arg_as_string(v.compiler.modelbuilder)
2161 if externname == null then return false
2162 else
2163 return false
2164 end
2165 v.add_extern(mpropdef.mclassdef.mmodule)
2166 var res: nullable RuntimeVariable = null
2167 var ret = mpropdef.msignature.return_mtype
2168 if ret != null then
2169 ret = v.resolve_for(ret, arguments.first)
2170 res = v.new_var_extern(ret)
2171 end
2172 v.adapt_signature(mpropdef, arguments)
2173 v.unbox_signature_extern(mpropdef, arguments)
2174
2175 if res == null then
2176 v.add("{externname}({arguments.join(", ")});")
2177 else
2178 v.add("{res} = {externname}({arguments.join(", ")});")
2179 res = v.box_extern(res, ret.as(not null))
2180 v.ret(res)
2181 end
2182 return true
2183 end
2184
2185 # Compile an extern factory
2186 # Return `true` if the compilation was successful, `false` if a fall-back is needed
2187 fun compile_externinit_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable]): Bool
2188 do
2189 var externname
2190 var at = self.get_single_annotation("extern", v.compiler.modelbuilder)
2191 if at != null then
2192 externname = at.arg_as_string(v.compiler.modelbuilder)
2193 if externname == null then return false
2194 else
2195 return false
2196 end
2197 v.add_extern(mpropdef.mclassdef.mmodule)
2198 v.adapt_signature(mpropdef, arguments)
2199 v.unbox_signature_extern(mpropdef, arguments)
2200 var ret = arguments.first.mtype
2201 var res = v.new_var_extern(ret)
2202
2203 arguments.shift
2204
2205 v.add("{res} = {externname}({arguments.join(", ")});")
2206 res = v.box_extern(res, ret)
2207 v.ret(res)
2208 return true
2209 end
2210 end
2211
2212 redef class AAttrPropdef
2213 redef fun can_inline: Bool do return not is_lazy
2214
2215 redef fun compile_to_c(v, mpropdef, arguments)
2216 do
2217 if mpropdef == mreadpropdef then
2218 assert arguments.length == 1
2219 var recv = arguments.first
2220 var res
2221 if is_lazy then
2222 var set
2223 var ret = self.mpropdef.static_mtype
2224 var useiset = ret.ctype == "val*" and not ret isa MNullableType
2225 var guard = self.mlazypropdef.mproperty
2226 if useiset then
2227 set = v.isset_attribute(self.mpropdef.mproperty, recv)
2228 else
2229 set = v.read_attribute(guard, recv)
2230 end
2231 v.add("if(likely({set})) \{")
2232 res = v.read_attribute(self.mpropdef.mproperty, recv)
2233 v.add("\} else \{")
2234
2235 var value = evaluate_expr(v, recv)
2236
2237 v.assign(res, value)
2238 if not useiset then
2239 var true_v = v.new_expr("1", v.bool_type)
2240 v.write_attribute(guard, arguments.first, true_v)
2241 end
2242 v.add("\}")
2243 else
2244 res = v.read_attribute(self.mpropdef.mproperty, arguments.first)
2245 end
2246 v.assign(v.frame.returnvar.as(not null), res)
2247 else if mpropdef == mwritepropdef then
2248 assert arguments.length == 2
2249 v.write_attribute(self.mpropdef.mproperty, arguments.first, arguments[1])
2250 if is_lazy then
2251 var ret = self.mpropdef.static_mtype
2252 var useiset = ret.ctype == "val*" and not ret isa MNullableType
2253 if not useiset then
2254 v.write_attribute(self.mlazypropdef.mproperty, arguments.first, v.new_expr("1", v.bool_type))
2255 end
2256 end
2257 else
2258 abort
2259 end
2260 end
2261
2262 fun init_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable)
2263 do
2264 if has_value and not is_lazy then evaluate_expr(v, recv)
2265 end
2266
2267 # Evaluate, store and return the default value of the attribute
2268 private fun evaluate_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable): RuntimeVariable
2269 do
2270 var oldnode = v.current_node
2271 v.current_node = self
2272 var old_frame = v.frame
2273 var frame = new Frame(v, self.mpropdef.as(not null), recv.mcasttype.as_notnullable.as(MClassType), [recv])
2274 v.frame = frame
2275
2276 var value
2277 var mtype = self.mpropdef.static_mtype
2278 assert mtype != null
2279
2280 var nexpr = self.n_expr
2281 var nblock = self.n_block
2282 if nexpr != null then
2283 value = v.expr(nexpr, mtype)
2284 else if nblock != null then
2285 value = v.new_var(mtype)
2286 frame.returnvar = value
2287 frame.returnlabel = v.get_name("RET_LABEL")
2288 v.add("\{")
2289 v.stmt(nblock)
2290 v.add("{frame.returnlabel.as(not null)}:(void)0;")
2291 v.add("\}")
2292 else
2293 abort
2294 end
2295
2296 v.write_attribute(self.mpropdef.mproperty, recv, value)
2297
2298 v.frame = old_frame
2299 v.current_node = oldnode
2300
2301 return value
2302 end
2303
2304 fun check_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable)
2305 do
2306 var nexpr = self.n_expr
2307 if nexpr != null then return
2308
2309 var oldnode = v.current_node
2310 v.current_node = self
2311 var old_frame = v.frame
2312 var frame = new Frame(v, self.mpropdef.as(not null), recv.mtype.as(MClassType), [recv])
2313 v.frame = frame
2314 # Force read to check the initialization
2315 v.read_attribute(self.mpropdef.mproperty, recv)
2316 v.frame = old_frame
2317 v.current_node = oldnode
2318 end
2319 end
2320
2321 redef class AClassdef
2322 private fun compile_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
2323 do
2324 if mpropdef == self.mfree_init then
2325 assert mpropdef.mproperty.is_root_init
2326 assert arguments.length == 1
2327 if not mpropdef.is_intro then
2328 v.supercall(mpropdef, arguments.first.mtype.as(MClassType), arguments)
2329 end
2330 return
2331 else
2332 abort
2333 end
2334 end
2335 end
2336
2337 redef class AExpr
2338 # Try to compile self as an expression
2339 # Do not call this method directly, use `v.expr` instead
2340 private fun expr(v: AbstractCompilerVisitor): nullable RuntimeVariable
2341 do
2342 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name}:{location.to_s}\\n\");")
2343 var mtype = self.mtype
2344 if mtype == null then
2345 return null
2346 else
2347 var res = v.new_var(mtype)
2348 v.add("/* {res} = NOT YET {class_name} */")
2349 return res
2350 end
2351 end
2352
2353 # Try to compile self as a statement
2354 # Do not call this method directly, use `v.stmt` instead
2355 private fun stmt(v: AbstractCompilerVisitor)
2356 do
2357 expr(v)
2358 end
2359 end
2360
2361 redef class ABlockExpr
2362 redef fun stmt(v)
2363 do
2364 for e in self.n_expr do v.stmt(e)
2365 end
2366 redef fun expr(v)
2367 do
2368 var last = self.n_expr.last
2369 for e in self.n_expr do
2370 if e == last then break
2371 v.stmt(e)
2372 end
2373 return v.expr(last, null)
2374 end
2375 end
2376
2377 redef class AVardeclExpr
2378 redef fun stmt(v)
2379 do
2380 var variable = self.variable.as(not null)
2381 var ne = self.n_expr
2382 if ne != null then
2383 var i = v.expr(ne, variable.declared_type)
2384 v.assign(v.variable(variable), i)
2385 end
2386 end
2387 end
2388
2389 redef class AVarExpr
2390 redef fun expr(v)
2391 do
2392 var res = v.variable(self.variable.as(not null))
2393 var mtype = self.mtype.as(not null)
2394 return v.autoadapt(res, mtype)
2395 end
2396 end
2397
2398 redef class AVarAssignExpr
2399 redef fun expr(v)
2400 do
2401 var variable = self.variable.as(not null)
2402 var i = v.expr(self.n_value, variable.declared_type)
2403 v.assign(v.variable(variable), i)
2404 return i
2405 end
2406 end
2407
2408 redef class AVarReassignExpr
2409 redef fun stmt(v)
2410 do
2411 var variable = self.variable.as(not null)
2412 var vari = v.variable(variable)
2413 var value = v.expr(self.n_value, variable.declared_type)
2414 var res = v.compile_callsite(self.reassign_callsite.as(not null), [vari, value])
2415 assert res != null
2416 v.assign(v.variable(variable), res)
2417 end
2418 end
2419
2420 redef class ASelfExpr
2421 redef fun expr(v) do return v.frame.arguments.first
2422 end
2423
2424 redef class AEscapeExpr
2425 redef fun stmt(v) do v.add("goto BREAK_{v.escapemark_name(self.escapemark)};")
2426 end
2427
2428 redef class AReturnExpr
2429 redef fun stmt(v)
2430 do
2431 var nexpr = self.n_expr
2432 if nexpr != null then
2433 var returnvar = v.frame.returnvar.as(not null)
2434 var i = v.expr(nexpr, returnvar.mtype)
2435 v.assign(returnvar, i)
2436 end
2437 v.add("goto {v.frame.returnlabel.as(not null)};")
2438 end
2439 end
2440
2441 redef class AAbortExpr
2442 redef fun stmt(v) do v.add_abort("Aborted")
2443 end
2444
2445 redef class AIfExpr
2446 redef fun stmt(v)
2447 do
2448 var cond = v.expr_bool(self.n_expr)
2449 v.add("if ({cond})\{")
2450 v.stmt(self.n_then)
2451 v.add("\} else \{")
2452 v.stmt(self.n_else)
2453 v.add("\}")
2454 end
2455
2456 redef fun expr(v)
2457 do
2458 var res = v.new_var(self.mtype.as(not null))
2459 var cond = v.expr_bool(self.n_expr)
2460 v.add("if ({cond})\{")
2461 v.assign(res, v.expr(self.n_then.as(not null), null))
2462 v.add("\} else \{")
2463 v.assign(res, v.expr(self.n_else.as(not null), null))
2464 v.add("\}")
2465 return res
2466 end
2467 end
2468
2469 redef class AIfexprExpr
2470 redef fun expr(v)
2471 do
2472 var res = v.new_var(self.mtype.as(not null))
2473 var cond = v.expr_bool(self.n_expr)
2474 v.add("if ({cond})\{")
2475 v.assign(res, v.expr(self.n_then, null))
2476 v.add("\} else \{")
2477 v.assign(res, v.expr(self.n_else, null))
2478 v.add("\}")
2479 return res
2480 end
2481 end
2482
2483 redef class ADoExpr
2484 redef fun stmt(v)
2485 do
2486 v.stmt(self.n_block)
2487 v.add_escape_label(break_mark)
2488 end
2489 end
2490
2491 redef class AWhileExpr
2492 redef fun stmt(v)
2493 do
2494 v.add("for(;;) \{")
2495 var cond = v.expr_bool(self.n_expr)
2496 v.add("if (!{cond}) break;")
2497 v.stmt(self.n_block)
2498 v.add_escape_label(continue_mark)
2499 v.add("\}")
2500 v.add_escape_label(break_mark)
2501 end
2502 end
2503
2504 redef class ALoopExpr
2505 redef fun stmt(v)
2506 do
2507 v.add("for(;;) \{")
2508 v.stmt(self.n_block)
2509 v.add_escape_label(continue_mark)
2510 v.add("\}")
2511 v.add_escape_label(break_mark)
2512 end
2513 end
2514
2515 redef class AForExpr
2516 redef fun stmt(v)
2517 do
2518 var cl = v.expr(self.n_expr, null)
2519 var it_meth = self.method_iterator
2520 assert it_meth != null
2521 var it = v.compile_callsite(it_meth, [cl])
2522 assert it != null
2523 v.add("for(;;) \{")
2524 var isok_meth = self.method_is_ok
2525 assert isok_meth != null
2526 var ok = v.compile_callsite(isok_meth, [it])
2527 assert ok != null
2528 v.add("if(!{ok}) break;")
2529 if self.variables.length == 1 then
2530 var item_meth = self.method_item
2531 assert item_meth != null
2532 var i = v.compile_callsite(item_meth, [it])
2533 assert i != null
2534 v.assign(v.variable(variables.first), i)
2535 else if self.variables.length == 2 then
2536 var key_meth = self.method_key
2537 assert key_meth != null
2538 var i = v.compile_callsite(key_meth, [it])
2539 assert i != null
2540 v.assign(v.variable(variables[0]), i)
2541 var item_meth = self.method_item
2542 assert item_meth != null
2543 i = v.compile_callsite(item_meth, [it])
2544 assert i != null
2545 v.assign(v.variable(variables[1]), i)
2546 else
2547 abort
2548 end
2549 v.stmt(self.n_block)
2550 v.add_escape_label(continue_mark)
2551 var next_meth = self.method_next
2552 assert next_meth != null
2553 v.compile_callsite(next_meth, [it])
2554 v.add("\}")
2555 v.add_escape_label(break_mark)
2556
2557 var method_finish = self.method_finish
2558 if method_finish != null then
2559 # TODO: Find a way to call this also in long escape (e.g. return)
2560 v.compile_callsite(method_finish, [it])
2561 end
2562 end
2563 end
2564
2565 redef class AAssertExpr
2566 redef fun stmt(v)
2567 do
2568 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return
2569
2570 var cond = v.expr_bool(self.n_expr)
2571 v.add("if (unlikely(!{cond})) \{")
2572 v.stmt(self.n_else)
2573 var nid = self.n_id
2574 if nid != null then
2575 v.add_abort("Assert '{nid.text}' failed")
2576 else
2577 v.add_abort("Assert failed")
2578 end
2579 v.add("\}")
2580 end
2581 end
2582
2583 redef class AOrExpr
2584 redef fun expr(v)
2585 do
2586 var res = v.new_var(self.mtype.as(not null))
2587 var i1 = v.expr_bool(self.n_expr)
2588 v.add("if ({i1}) \{")
2589 v.add("{res} = 1;")
2590 v.add("\} else \{")
2591 var i2 = v.expr_bool(self.n_expr2)
2592 v.add("{res} = {i2};")
2593 v.add("\}")
2594 return res
2595 end
2596 end
2597
2598 redef class AImpliesExpr
2599 redef fun expr(v)
2600 do
2601 var res = v.new_var(self.mtype.as(not null))
2602 var i1 = v.expr_bool(self.n_expr)
2603 v.add("if (!{i1}) \{")
2604 v.add("{res} = 1;")
2605 v.add("\} else \{")
2606 var i2 = v.expr_bool(self.n_expr2)
2607 v.add("{res} = {i2};")
2608 v.add("\}")
2609 return res
2610 end
2611 end
2612
2613 redef class AAndExpr
2614 redef fun expr(v)
2615 do
2616 var res = v.new_var(self.mtype.as(not null))
2617 var i1 = v.expr_bool(self.n_expr)
2618 v.add("if (!{i1}) \{")
2619 v.add("{res} = 0;")
2620 v.add("\} else \{")
2621 var i2 = v.expr_bool(self.n_expr2)
2622 v.add("{res} = {i2};")
2623 v.add("\}")
2624 return res
2625 end
2626 end
2627
2628 redef class ANotExpr
2629 redef fun expr(v)
2630 do
2631 var cond = v.expr_bool(self.n_expr)
2632 return v.new_expr("!{cond}", self.mtype.as(not null))
2633 end
2634 end
2635
2636 redef class AOrElseExpr
2637 redef fun expr(v)
2638 do
2639 var res = v.new_var(self.mtype.as(not null))
2640 var i1 = v.expr(self.n_expr, null)
2641 v.add("if ({i1}!=NULL) \{")
2642 v.assign(res, i1)
2643 v.add("\} else \{")
2644 var i2 = v.expr(self.n_expr2, null)
2645 v.assign(res, i2)
2646 v.add("\}")
2647 return res
2648 end
2649 end
2650
2651 redef class AIntExpr
2652 redef fun expr(v) do return v.new_expr("{self.value.to_s}", self.mtype.as(not null))
2653 end
2654
2655 redef class AFloatExpr
2656 redef fun expr(v) do return v.new_expr("{self.n_float.text}", self.mtype.as(not null)) # FIXME use value, not n_float
2657 end
2658
2659 redef class ACharExpr
2660 redef fun expr(v) do return v.new_expr("'{self.value.to_s.escape_to_c}'", self.mtype.as(not null))
2661 end
2662
2663 redef class AArrayExpr
2664 redef fun expr(v)
2665 do
2666 var mtype = self.element_mtype.as(not null)
2667 var array = new Array[RuntimeVariable]
2668 var res = v.array_instance(array, mtype)
2669
2670 var old_comprehension = v.frame.comprehension
2671 v.frame.comprehension = res
2672 for nexpr in self.n_exprs do
2673 v.stmt(nexpr)
2674 end
2675 v.frame.comprehension = old_comprehension
2676
2677 return res
2678 end
2679 end
2680
2681 redef class AStringFormExpr
2682 redef fun expr(v) do return v.string_instance(self.value.as(not null))
2683 end
2684
2685 redef class ASuperstringExpr
2686 redef fun expr(v)
2687 do
2688 var array = new Array[RuntimeVariable]
2689 for ne in self.n_exprs do
2690 if ne isa AStringFormExpr and ne.value == "" then continue # skip empty sub-strings
2691 var i = v.expr(ne, null)
2692 array.add(i)
2693 end
2694 var a = v.array_instance(array, v.object_type)
2695 var res = v.send(v.get_property("to_s", a.mtype), [a])
2696 return res
2697 end
2698 end
2699
2700 redef class ACrangeExpr
2701 redef fun expr(v)
2702 do
2703 var i1 = v.expr(self.n_expr, null)
2704 var i2 = v.expr(self.n_expr2, null)
2705 var mtype = self.mtype.as(MClassType)
2706 var res = v.init_instance(mtype)
2707 v.compile_callsite(init_callsite.as(not null), [res, i1, i2])
2708 return res
2709 end
2710 end
2711
2712 redef class AOrangeExpr
2713 redef fun expr(v)
2714 do
2715 var i1 = v.expr(self.n_expr, null)
2716 var i2 = v.expr(self.n_expr2, null)
2717 var mtype = self.mtype.as(MClassType)
2718 var res = v.init_instance(mtype)
2719 v.compile_callsite(init_callsite.as(not null), [res, i1, i2])
2720 return res
2721 end
2722 end
2723
2724 redef class ATrueExpr
2725 redef fun expr(v) do return v.new_expr("1", self.mtype.as(not null))
2726 end
2727
2728 redef class AFalseExpr
2729 redef fun expr(v) do return v.new_expr("0", self.mtype.as(not null))
2730 end
2731
2732 redef class ANullExpr
2733 redef fun expr(v) do return v.new_expr("NULL", self.mtype.as(not null))
2734 end
2735
2736 redef class AIsaExpr
2737 redef fun expr(v)
2738 do
2739 var i = v.expr(self.n_expr, null)
2740 return v.type_test(i, self.cast_type.as(not null), "isa")
2741 end
2742 end
2743
2744 redef class AAsCastExpr
2745 redef fun expr(v)
2746 do
2747 var i = v.expr(self.n_expr, null)
2748 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return i
2749
2750 v.add_cast(i, self.mtype.as(not null), "as")
2751 return i
2752 end
2753 end
2754
2755 redef class AAsNotnullExpr
2756 redef fun expr(v)
2757 do
2758 var i = v.expr(self.n_expr, null)
2759 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return i
2760
2761 if i.mtype.ctype != "val*" then return i
2762
2763 v.add("if (unlikely({i} == NULL)) \{")
2764 v.add_abort("Cast failed")
2765 v.add("\}")
2766 return i
2767 end
2768 end
2769
2770 redef class AParExpr
2771 redef fun expr(v) do return v.expr(self.n_expr, null)
2772 end
2773
2774 redef class AOnceExpr
2775 redef fun expr(v)
2776 do
2777 var mtype = self.mtype.as(not null)
2778 var name = v.get_name("varonce")
2779 var guard = v.get_name(name + "_guard")
2780 v.add_decl("static {mtype.ctype} {name};")
2781 v.add_decl("static int {guard};")
2782 var res = v.new_var(mtype)
2783 v.add("if ({guard}) \{")
2784 v.add("{res} = {name};")
2785 v.add("\} else \{")
2786 var i = v.expr(self.n_expr, mtype)
2787 v.add("{res} = {i};")
2788 v.add("{name} = {res};")
2789 v.add("{guard} = 1;")
2790 v.add("\}")
2791 return res
2792 end
2793 end
2794
2795 redef class ASendExpr
2796 redef fun expr(v)
2797 do
2798 var recv = v.expr(self.n_expr, null)
2799 var callsite = self.callsite.as(not null)
2800 var args = v.varargize(callsite.mpropdef, recv, self.raw_arguments)
2801 return v.compile_callsite(callsite, args)
2802 end
2803 end
2804
2805 redef class ASendReassignFormExpr
2806 redef fun stmt(v)
2807 do
2808 var recv = v.expr(self.n_expr, null)
2809 var callsite = self.callsite.as(not null)
2810 var args = v.varargize(callsite.mpropdef, recv, self.raw_arguments)
2811
2812 var value = v.expr(self.n_value, null)
2813
2814 var left = v.compile_callsite(callsite, args)
2815 assert left != null
2816
2817 var res = v.compile_callsite(self.reassign_callsite.as(not null), [left, value])
2818 assert res != null
2819
2820 args.add(res)
2821 v.compile_callsite(self.write_callsite.as(not null), args)
2822 end
2823 end
2824
2825 redef class ASuperExpr
2826 redef fun expr(v)
2827 do
2828 var recv = v.frame.arguments.first
2829
2830 var callsite = self.callsite
2831 if callsite != null then
2832 var args = v.varargize(callsite.mpropdef, recv, self.n_args.n_exprs)
2833
2834 # Add additional arguments for the super init call
2835 if args.length == 1 then
2836 for i in [0..callsite.msignature.arity[ do
2837 args.add(v.frame.arguments[i+1])
2838 end
2839 end
2840 # Super init call
2841 var res = v.compile_callsite(callsite, args)
2842 return res
2843 end
2844
2845 var mpropdef = self.mpropdef.as(not null)
2846 var args = v.varargize(mpropdef, recv, self.n_args.n_exprs)
2847 if args.length == 1 then
2848 args = v.frame.arguments
2849 end
2850
2851 # stantard call-next-method
2852 return v.supercall(mpropdef, recv.mtype.as(MClassType), args)
2853 end
2854 end
2855
2856 redef class ANewExpr
2857 redef fun expr(v)
2858 do
2859 var mtype = self.recvtype
2860 assert mtype != null
2861 var recv
2862 var ctype = mtype.ctype
2863 if mtype.mclass.name == "NativeArray" then
2864 assert self.n_args.n_exprs.length == 1
2865 var l = v.expr(self.n_args.n_exprs.first, null)
2866 assert mtype isa MGenericType
2867 var elttype = mtype.arguments.first
2868 return v.native_array_instance(elttype, l)
2869 else if ctype == "val*" then
2870 recv = v.init_instance(mtype)
2871 else if ctype == "char*" then
2872 recv = v.new_expr("NULL/*special!*/", mtype)
2873 else
2874 recv = v.new_expr("({ctype})0/*special!*/", mtype)
2875 end
2876
2877 var callsite = self.callsite.as(not null)
2878 var args = v.varargize(callsite.mpropdef, recv, self.n_args.n_exprs)
2879 var res2 = v.compile_callsite(callsite, args)
2880 if res2 != null then
2881 #self.debug("got {res2} from {mproperty}. drop {recv}")
2882 return res2
2883 end
2884 return recv
2885 end
2886 end
2887
2888 redef class AAttrExpr
2889 redef fun expr(v)
2890 do
2891 var recv = v.expr(self.n_expr, null)
2892 var mproperty = self.mproperty.as(not null)
2893 return v.read_attribute(mproperty, recv)
2894 end
2895 end
2896
2897 redef class AAttrAssignExpr
2898 redef fun expr(v)
2899 do
2900 var recv = v.expr(self.n_expr, null)
2901 var i = v.expr(self.n_value, null)
2902 var mproperty = self.mproperty.as(not null)
2903 v.write_attribute(mproperty, recv, i)
2904 return i
2905 end
2906 end
2907
2908 redef class AAttrReassignExpr
2909 redef fun stmt(v)
2910 do
2911 var recv = v.expr(self.n_expr, null)
2912 var value = v.expr(self.n_value, null)
2913 var mproperty = self.mproperty.as(not null)
2914 var attr = v.read_attribute(mproperty, recv)
2915 var res = v.compile_callsite(self.reassign_callsite.as(not null), [attr, value])
2916 assert res != null
2917 v.write_attribute(mproperty, recv, res)
2918 end
2919 end
2920
2921 redef class AIssetAttrExpr
2922 redef fun expr(v)
2923 do
2924 var recv = v.expr(self.n_expr, null)
2925 var mproperty = self.mproperty.as(not null)
2926 return v.isset_attribute(mproperty, recv)
2927 end
2928 end
2929
2930 redef class ADebugTypeExpr
2931 redef fun stmt(v)
2932 do
2933 # do nothing
2934 end
2935 end
2936
2937 # Utils
2938
2939 redef class Array[E]
2940 # Return a new `Array` with the elements only contened in self and not in `o`
2941 fun -(o: Array[E]): Array[E] do
2942 var res = new Array[E]
2943 for e in self do if not o.has(e) then res.add(e)
2944 return res
2945 end
2946 end
2947
2948 redef class MModule
2949 # All `MProperty` associated to all `MClassDef` of `mclass`
2950 fun properties(mclass: MClass): Set[MProperty] do
2951 if not self.properties_cache.has_key(mclass) then
2952 var properties = new HashSet[MProperty]
2953 var parents = new Array[MClass]
2954 if self.flatten_mclass_hierarchy.has(mclass) then
2955 parents.add_all(mclass.in_hierarchy(self).direct_greaters)
2956 end
2957 for parent in parents do
2958 properties.add_all(self.properties(parent))
2959 end
2960 for mclassdef in mclass.mclassdefs do
2961 if not self.in_importation <= mclassdef.mmodule then continue
2962 for mprop in mclassdef.intro_mproperties do
2963 properties.add(mprop)
2964 end
2965 end
2966 self.properties_cache[mclass] = properties
2967 end
2968 return properties_cache[mclass]
2969 end
2970 private var properties_cache: Map[MClass, Set[MProperty]] = new HashMap[MClass, Set[MProperty]]
2971
2972 # Write FFI and nitni results to file
2973 fun finalize_ffi(c: AbstractCompiler) do end
2974
2975 # Give requided addinional system libraries (as given to LD_LIBS)
2976 # Note: can return null instead of an empty set
2977 fun collect_linker_libs: nullable Set[String] do return null
2978 end
2979
2980 # Create a tool context to handle options and paths
2981 var toolcontext = new ToolContext
2982
2983 toolcontext.tooldescription = "Usage: nitc [OPTION]... file.nit...\nCompiles Nit programs."
2984
2985 # We do not add other options, so process them now!
2986 toolcontext.process_options(args)
2987
2988 # We need a model to collect stufs
2989 var model = new Model
2990 # An a model builder to parse files
2991 var modelbuilder = new ModelBuilder(model, toolcontext)
2992
2993 var arguments = toolcontext.option_context.rest
2994 if arguments.length > 1 and toolcontext.opt_output.value != null then
2995 print "Error: --output needs a single source file. Do you prefer --dir?"
2996 exit 1
2997 end
2998
2999 # Here we load an process all modules passed on the command line
3000 var mmodules = modelbuilder.parse(arguments)
3001
3002 if mmodules.is_empty then return
3003 modelbuilder.run_phases
3004
3005 for mmodule in mmodules do
3006 toolcontext.info("*** PROCESS {mmodule} ***", 1)
3007 var ms = [mmodule]
3008 toolcontext.run_global_phases(ms)
3009 end