1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 Jean Privat <jean@pryen.org>
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
9 # http://www.apache.org/licenses/LICENSE-2.0
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.
18 module abstract_compiler
24 private import annotation
27 # Add compiling options
28 redef class ToolContext
30 var opt_output
= new OptionString("Output file", "-o", "--output")
32 var opt_dir
= new OptionString("Output directory", "--dir")
34 var opt_no_cc
= new OptionBool("Do not invoke C compiler", "--no-cc")
36 var opt_no_main
= new OptionBool("Do not generate main entry point", "--no-main")
38 var opt_make_flags
= new OptionString("Additional options to make", "--make-flags")
40 var opt_max_c_lines
= new OptionInt("Maximum number of lines in generated C files. Use 0 for unlimited", 10000, "--max-c-lines")
42 var opt_group_c_files
= new OptionBool("Group all generated code in the same series of files", "--group-c-files")
44 var opt_compile_dir
= new OptionString("Directory used to generate temporary files", "--compile-dir")
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")
52 var opt_no_check_assert
= new OptionBool("Disable the evaluation of explicit 'assert' and 'as' (dangerous)", "--no-check-assert")
54 var opt_no_check_autocast
= new OptionBool("Disable implicit casts on unsafe expression usage (dangerous)", "--no-check-autocast")
56 var opt_no_check_null
= new OptionBool("Disable tests of null receiver (dangerous)", "--no-check-null")
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")
66 var opt_stacktrace
= new OptionString("Control the generation of stack traces", "--stacktrace")
68 var opt_no_gcc_directive
= new OptionArray("Disable a advanced gcc directives for optimization", "--no-gcc-directive")
70 var opt_release
= new OptionBool("Compile in release mode and finalize application", "--release")
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
)
83 opt_no_main
.hidden
= true
86 redef fun process_options
(args
)
90 var st
= opt_stacktrace
.value
91 if st
== "none" or st
== "libunwind" or st
== "nitstack" then
93 else if st
== "auto" or st
== null then
95 opt_stacktrace
.value
= "nitstack"
97 print
"Error: unknown value `{st}` for --stacktrace. Use `none`, `libunwind`, `nitstack` or `auto`."
101 if opt_output
.value
!= null and opt_dir
.value
!= null then
102 print
"Error: cannot use both --dir and --output"
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
116 redef class ModelBuilder
117 # The compilation directory
118 var compile_dir
: String
120 # Simple indirection to `Toolchain::write_and_make`
121 protected fun write_and_make
(compiler
: AbstractCompiler)
123 var platform
= compiler
.mainmodule
.target_platform
125 if platform
== null then
126 toolchain
= new MakefileToolchain(toolcontext
)
128 toolchain
= platform
.toolchain
(toolcontext
)
130 compile_dir
= toolchain
.compile_dir
131 toolchain
.write_and_make compiler
136 fun toolchain
(toolcontext
: ToolContext): Toolchain is abstract
140 var toolcontext
: ToolContext
142 fun compile_dir
: String
144 var compile_dir
= toolcontext
.opt_compile_dir
.value
145 if compile_dir
== null then compile_dir
= ".nit_compile"
149 fun write_and_make
(compiler
: AbstractCompiler) is abstract
152 class MakefileToolchain
155 redef fun write_and_make
(compiler
)
157 var compile_dir
= compile_dir
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
163 self.toolcontext
.info
("*** WRITING C ***", 1)
167 var cfiles
= new Array[String]
168 write_files
(compiler
, compile_dir
, cfiles
)
170 # Generate the Makefile
172 write_makefile
(compiler
, compile_dir
, cfiles
)
175 self.toolcontext
.info
("*** END WRITING C: {time1-time0} ***", 2)
177 # Execute the Makefile
179 if self.toolcontext
.opt_no_cc
.value
then return
182 self.toolcontext
.info
("*** COMPILING C ***", 1)
184 compile_c_code
(compiler
, compile_dir
)
187 self.toolcontext
.info
("*** END COMPILING C: {time1-time0} ***", 2)
190 fun write_files
(compiler
: AbstractCompiler, compile_dir
: String, cfiles
: Array[String])
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
= ""
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"
206 for m
in compiler
.mainmodule
.in_importation
.greaters
do
207 compiler
.finalize_ffi_for_module
(m
)
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}"
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
224 for l
in compiler
.header
.lines
do
230 var max_c_lines
= toolcontext
.opt_max_c_lines
.value
231 for f
in compiler
.files
do
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
240 if file
== null or (count
> max_c_lines
and max_c_lines
> 0) then
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"
251 for l
in vis
.decl_lines
do
255 for l
in vis
.lines
do
260 if file
== null then continue
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
)
272 node
.debug
"No provided declaration for {key}"
274 print
"No provided declaration for {key}"
278 hfile
.write compiler
.provided_declarations
[key
]
284 self.toolcontext
.info
("Total C source files to compile: {cfiles.length}", 2)
287 fun makefile_name
(mainmodule
: MModule): String do return "{mainmodule.c_name}.mk"
289 fun default_outname
(mainmodule
: MModule): String
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
300 # Combine options and platform informations to get the final path of the outfile
301 fun outfile
(mainmodule
: MModule): String
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
)
311 fun write_makefile
(compiler
: AbstractCompiler, compile_dir
: String, cfiles
: Array[String])
313 var mainmodule
= compiler
.mainmodule
314 var platform
= compiler
.mainmodule
.target_platform
316 var outname
= outfile
(mainmodule
)
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
326 var makename
= makefile_name
(mainmodule
)
327 var makepath
= "{compile_dir}/{makename}"
328 var makefile
= new OFStream.open
(makepath
)
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
)
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")
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")
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
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")
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")
356 makefile
.write
("ifdef NEED_LIBUNWIND\n\tLDLIBS += -lunwind\nendif\n")
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("$","$$")}")
364 var ofiles
= new Array[String]
365 var dep_rules
= new Array[String]
366 # Compile each generated file
368 var o
= f
.strip_extension
(".c") + ".o"
369 makefile
.write
("{o}: {f}\n\t$(CC) $(CFLAGS) $(CINCL) -c -o {o} {f}\n\n")
374 var java_files
= new Array[ExternFile]
376 var pkgconfigs
= new Array[String]
377 for f
in compiler
.extern_bodies
do
378 pkgconfigs
.add_all f
.pkgconfigs
381 if not pkgconfigs
.is_empty
then
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")
388 for p
in pkgconfigs
do
390 # Check for library {{{p}}}
391 ifneq ($(shell pkg-config --exists '{{{p}}}'; echo $$?), 0)
392 $(error "pkg-config: package {{{p}}} is not found.")
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
)
406 if f
.compiles_to_o_file
then ofiles
.add
(o
)
407 if f
.add_to_jar
then java_files
.add
(f
)
410 if not java_files
.is_empty
then
411 var jar_file
= "{outpath}.jar"
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
(" ")
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
424 if not pkgconfigs
.is_empty
then
425 pkg
= "`pkg-config --libs {pkgconfigs.join(" ")}`"
427 makefile
.write
("{outpath}: {dep_rules.join(" ")}\n\t$(CC) $(LDFLAGS) -o {outpath.escape_to_sh} {ofiles.join(" ")} $(LDLIBS) {pkg}\n\n")
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")
434 self.toolcontext
.info
("Generated makefile: {makepath}", 2)
436 makepath
.file_copy_to
"{compile_dir}/Makefile"
439 fun compile_c_code
(compiler
: AbstractCompiler, compile_dir
: String)
441 var makename
= makefile_name
(compiler
.mainmodule
)
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)
448 if self.toolcontext
.verbose_level
>= 3 then
449 res
= sys
.system
("make -B -C {compile_dir} -f {makename} -j 4 {makeflags} 2>&1")
451 res
= sys
.system
("make -B -C {compile_dir} -f {makename} -j 4 {makeflags} 2>&1 >/dev/null")
454 toolcontext
.error
(null, "make failed! Error code: {res}.")
459 # Singleton that store the knowledge about the compilation process
460 abstract class AbstractCompiler
461 type VISITOR: AbstractCompilerVisitor
463 # Table corresponding c_names to nit names (methods)
464 var names
= new HashMap[String, String]
466 # The main module of the program currently compiled
467 # Is assigned during the separate compilation
468 var mainmodule
: MModule is writable
470 # The real main module of the program
471 var realmainmodule
: MModule is noinit
473 # The modelbuilder used to know the model and the AST
474 var modelbuilder
: ModelBuilder is protected writable
476 # Is hardening asked? (see --hardening)
477 fun hardening
: Bool do return self.modelbuilder
.toolcontext
.opt_hardening
.value
481 self.realmainmodule
= mainmodule
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
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
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
)
497 return self.files
.first
499 var f
= new CodeFile(name
)
504 # The list of all associated files
505 # Used to generate .c files
506 var files
= new List[CodeFile]
508 # Initialize a visitor specific for a compiler engine
509 fun new_visitor
: VISITOR is abstract
511 # Where global declaration are stored (the main .h)
512 var header
: CodeWriter is writable, noinit
514 # Provide a declaration that can be requested (before or latter) by a visitor
515 fun provide_declaration
(key
: String, s
: String)
517 if self.provided_declarations
.has_key
(key
) then
518 assert self.provided_declarations
[key
] == s
520 self.provided_declarations
[key
] = s
523 private var provided_declarations
= new HashMap[String, String]
525 private var requirers_of_declarations
= new HashMap[String, ANode]
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
531 var compile_dir
= modelbuilder
.compile_dir
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
545 stream.write(i.escape_to_c)
546 stream.write("\
",\"")
547 stream.write(names[i].escape_to_c)
548 stream.write("\
"\},\n")
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;")
558 stream
.write
("free(procname);")
559 stream
.write
("return NULL;")
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")
567 extern_bodies
.add
(new ExternCFile("{compile_dir}/c_functions_hash.c", ""))
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")
584 compile_header_structs
585 compile_nitni_structs
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);")
592 self.header
.add_decl
("void show_backtrace(int) __attribute__ ((noreturn));")
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)")
604 self.header
.add_decl
("#define likely(x) __builtin_expect((x),1)")
605 self.header
.add_decl
("#define unlikely(x) __builtin_expect((x),0)")
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;")
614 # Declaration of structures for live Nit types
615 protected fun compile_header_structs
is abstract
617 # Declaration of structures for nitni undelying the FFI
618 protected fun compile_nitni_structs
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. */
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 */
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;
634 extern struct nitni_global_ref_list_t *nitni_global_ref_list;
636 /* Initializer of global reference list */
637 extern void nitni_global_ref_list_init();
639 /* Intern function to add a global reference to the list */
640 extern void nitni_global_ref_add( struct nitni_ref *ref );
642 /* Intern function to remove a global reference from the list */
643 extern void nitni_global_ref_remove( struct nitni_ref *ref );
645 /* Increase count on an existing global reference */
646 extern void nitni_global_ref_incr( struct nitni_ref *ref );
648 /* Decrease count on an existing global reference */
649 extern void nitni_global_ref_decr( struct nitni_ref *ref );
653 fun compile_finalizer_function
655 var finalizable_type
= mainmodule
.finalizable_type
656 if finalizable_type
== null then return
658 var finalize_meth
= mainmodule
.try_get_primitive_method
("finalize", finalizable_type
.mclass
)
660 if finalize_meth
== null then
661 modelbuilder
.toolcontext
.error
(null, "The `Finalizable` class doesn't declare the `finalize` method.")
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
])
672 # Generate the main C function.
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
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
686 if platform
!= null and not platform
.supports_libunwind
then ost
= "none"
688 var no_main
= (platform
!= null and platform
.no_main
) or modelbuilder
.toolcontext
.opt_no_main
.value
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\
"")
697 v
.add_decl
("int glob_argc;")
698 v
.add_decl
("char **glob_argv;")
699 v
.add_decl
("val *glob_sys;")
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};")
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;")
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;")
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);")
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);")
756 v
.add_decl
(" PRINT_ERROR(\"` %s \\n\",procname);")
759 v.add_decl("PRINT_ERROR(\"-------------------------------------------------\\n\");")
760 v.add_decl("free(procname);")
763 v.add_decl("exit(signo);")
767 v.add_decl("int nit_main(int argc, char** argv) \{")
769 v.add_decl("int main(int argc, char** argv) \{")
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);")
780 v.add("glob_argc = argc; glob_argv = argv;")
781 v.add("initialize_gc_option();")
783 v.add "initialize_nitni_global_refs();"
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])
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])
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};")
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
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);")
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);")
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);")
845 # Copile all C functions related to the [incr|decr]_ref features of the FFI
846 fun compile_nitni_global_ref_functions
848 var v = self.new_visitor
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;
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;
862 nitni_global_ref_list->tail->next = ref;
863 ref->prev = nitni_global_ref_list->tail;
865 nitni_global_ref_list->tail = ref;
870 void nitni_global_ref_remove( struct nitni_ref *ref ) {
871 if ( ref->prev == NULL ) {
872 nitni_global_ref_list->head = ref->next;
874 ref->prev->next = ref->next;
877 if ( ref->next == NULL ) {
878 nitni_global_ref_list->tail = ref->prev;
880 ref->next->prev = ref->prev;
884 extern void nitni_global_ref_incr( struct nitni_ref *ref ) {
885 if ( ref->count == 0 ) /* not registered */
888 nitni_global_ref_add( ref );
894 extern void nitni_global_ref_decr( struct nitni_ref *ref ) {
895 if ( ref->count == 1 ) /* was last reference */
897 /* remove from list */
898 nitni_global_ref_remove( ref );
906 # List of additional files required to compile (FFI)
907 var extern_bodies = new Array[ExternFile]
909 # List of source files to copy over to the compile dir
910 var files_to_copy = new Array[String]
912 # This is used to avoid adding an extern file more than once
913 private var seen_extern = new ArraySet[String]
915 # Generate code that initialize the attributes on a new instance
916 fun generate_init_attr(v: VISITOR, recv: RuntimeVariable, mtype: MClassType)
918 var cds = mtype.collect_mclassdefs(self.mainmodule).to_a
919 self.mainmodule.linearize_mclassdefs(cds)
921 for npropdef in modelbuilder.collect_attr_propdef(cd) do
922 npropdef.init_expr(v, recv)
927 # Generate code that check if an attribute is correctly initialized
928 fun generate_check_attr(v: VISITOR, recv: RuntimeVariable, mtype: MClassType)
930 var cds = mtype.collect_mclassdefs(self.mainmodule).to_a
931 self.mainmodule.linearize_mclassdefs(cds)
933 for npropdef in modelbuilder.collect_attr_propdef(cd) do
934 npropdef.check_expr(v, recv)
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
946 protected fun init_count_type_test_tags: HashMap[String, Int]
948 var res = new HashMap[String, Int]
949 for tag in count_type_test_tags do
955 # Display stats about compilation process
959 # * type tests against resolved types (`x
isa Collection[Animal]`)
960 # * type tests against unresolved types (`x
isa Collection[E
]`)
961 # * type tests skipped
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]
980 var count_type_test = count_type_test_total["total"]
981 var tags = count_type_test_tags.to_a
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)}%)"
994 fun finalize_ffi_for_module(mmodule: MModule) do mmodule.finalize_ffi(self)
997 # Avoid division by zero by returning the string "n/a"
998 fun div(a,b:Int):String
1000 if b == 0 then return "n/a"
1001 return ((a*10000/b).to_f / 100.0).to_precision(2)
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
1009 var writers = new Array[CodeWriter]
1010 var required_declarations = new HashSet[String]
1013 # Where to store generated lines
1016 var lines: List[String] = new List[String]
1017 var decl_lines: List[String] = new List[String]
1019 # Add a line in the main part of the generated C
1020 fun add(s: String) do self.lines.add(s)
1023 # (used for local or global declaration)
1024 fun add_decl(s: String) do self.decl_lines.add(s)
1028 file.writers.add(self)
1032 # A visitor on the AST of property definition that generate the C code.
1033 abstract class AbstractCompilerVisitor
1035 type COMPILER: AbstractCompiler
1037 # The associated compiler
1038 var compiler: COMPILER
1040 # The current visited AST node
1041 var current_node: nullable ANode = null is writable
1043 # The current `Frame`
1044 var frame: nullable Frame = null is writable
1046 # Alias for self.compiler.mainmodule.object_type
1047 fun object_type: MClassType do return self.compiler.mainmodule.object_type
1049 # Alias for self.compiler.mainmodule.bool_type
1050 fun bool_type: MClassType do return self.compiler.mainmodule.bool_type
1052 var writer: CodeWriter is noinit
1056 self.writer = new CodeWriter(compiler.files.last)
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)
1062 # Force to get the primitive property named `name
` in the instance `recv
` or abort
1063 fun get_property(name: String, recv: MType): MMethod
1065 assert recv isa MClassType
1066 return self.compiler.modelbuilder.force_get_primitive_method(self.current_node, name, recv.mclass, self.compiler.mainmodule)
1069 fun compile_callsite(callsite: CallSite, arguments: Array[RuntimeVariable]): nullable RuntimeVariable
1071 var initializers = callsite.mpropdef.initializers
1072 if not initializers.is_empty then
1073 var recv = arguments.first
1076 for p in initializers do
1077 if p isa MMethod then
1079 for x in p.intro.msignature.mparameters do
1080 args.add arguments[i]
1084 else if p isa MAttribute then
1085 self.write_attribute(p, recv, arguments[i])
1089 assert i == arguments.length
1091 return self.send(callsite.mproperty, [recv])
1094 return self.send(callsite.mproperty, arguments)
1097 fun native_array_instance(elttype: MType, length: RuntimeVariable): RuntimeVariable is abstract
1099 fun calloc_array(ret_type: MType, arguments: Array[RuntimeVariable]) is abstract
1101 fun native_array_def(pname: String, ret_type: nullable MType, arguments: Array[RuntimeVariable]) is abstract
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]
1108 var msignature = mpropdef.new_msignature or else mpropdef.msignature.as(not null)
1109 var res = new Array[RuntimeVariable]
1112 if args.is_empty then return res
1114 var vararg_rank = msignature.vararg_rank
1115 var vararg_len = args.length - msignature.arity
1116 if vararg_len < 0 then vararg_len = 0
1118 for i in [0..msignature.arity[ do
1119 if i == vararg_rank then
1121 if ne isa AVarargExpr then
1122 var e = self.expr(ne.n_expr, null)
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)
1131 var elttype = msignature.mparameters[vararg_rank].mtype
1132 var arg = self.vararg_instance(mpropdef, recv, vararg, elttype)
1136 if i > vararg_rank then j += vararg_len
1137 var e = self.expr(args[j], null)
1146 # Anchor a type to the main module and the current receiver
1147 fun anchor(mtype: MType): MType
1149 if not mtype.need_anchor then return mtype
1150 return mtype.anchor_to(self.compiler.mainmodule, self.frame.receiver)
1153 fun resolve_for(mtype: MType, recv: RuntimeVariable): MType
1155 if not mtype.need_anchor then return mtype
1156 return mtype.resolve_for(recv.mcasttype, self.frame.receiver, self.compiler.mainmodule, true)
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
1165 mtype = self.anchor(mtype)
1166 var valmtype = value.mcasttype
1167 if valmtype.is_subtype(self.compiler.mainmodule, null, mtype) then
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)
1175 var res = new RuntimeVariable(value.name, valmtype, mtype)
1180 # Generate a super call from a method definition
1181 fun supercall(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1183 # Adapt the arguments of a method according to targetted `MMethodDef`
1184 fun adapt_signature(m: MMethodDef, args: Array[RuntimeVariable]) is abstract
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
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
1193 # Box extern classes to be used in the generated code
1194 fun box_extern(value: RuntimeVariable, mtype: MType): RuntimeVariable is abstract
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
1199 # Generate a polymorphic subtype test
1200 fun type_test(value: RuntimeVariable, mtype: MType, tag: String): RuntimeVariable is abstract
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
1205 # Generate a Nit "is" for two runtime_variables
1206 fun equal_test(value1, value2: RuntimeVariable): RuntimeVariable is abstract
1210 # Generate a static call on a method definition
1211 fun call(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
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
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
1219 assert t isa MClassType
1220 var propdef = m.lookup_first_definition(self.compiler.mainmodule, t)
1221 return self.call(propdef, t, args)
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
1227 assert t isa MClassType
1228 m = m.lookup_next_definition(self.compiler.mainmodule, t)
1229 return self.call(m, t, args)
1232 # Attributes handling
1234 # Generate a polymorphic attribute is_set test
1235 fun isset_attribute(a: MAttribute, recv: RuntimeVariable): RuntimeVariable is abstract
1237 # Generate a polymorphic attribute read
1238 fun read_attribute(a: MAttribute, recv: RuntimeVariable): RuntimeVariable is abstract
1240 # Generate a polymorphic attribute write
1241 fun write_attribute(a: MAttribute, recv: RuntimeVariable, value: RuntimeVariable) is abstract
1245 # Add a check and an abort for a null receiver if needed
1246 fun check_recv_notnull(recv: RuntimeVariable)
1248 if self.compiler.modelbuilder.toolcontext.opt_no_check_null.value then return
1250 var maybenull = recv.mcasttype isa MNullableType or recv.mcasttype isa MNullType
1252 self.add("if (unlikely({recv} == NULL)) \{")
1253 self.add_abort("Receiver is null")
1260 private var names = new HashSet[String]
1261 private var last: Int = 0
1263 # Return a new name based on `s
` and unique in the visitor
1264 fun get_name(s: String): String
1266 if not self.names.has(s) then
1270 var i = self.last + 1
1273 if not self.names.has(s2) then
1282 # Return an unique and stable identifier associated with an escapemark
1283 fun escapemark_name(e: nullable EscapeMark): String
1286 if frame.escapemark_names.has_key(e) then return frame.escapemark_names[e]
1288 if name == null then name = "label"
1289 name = get_name(name)
1290 frame.escapemark_names[e] = name
1294 # Insert a C label for associated with an escapemark
1295 fun add_escape_label(e: nullable EscapeMark)
1297 if e == null then return
1298 if e.escapes.is_empty then return
1299 add("BREAK_{escapemark_name(e)}: (void)0;")
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
1306 # Variables handling
1308 protected var variables = new HashMap[Variable, RuntimeVariable]
1310 # Return the local runtime_variable associated to a Nit local variable
1311 fun variable(variable: Variable): RuntimeVariable
1313 if self.variables.has_key(variable) then
1314 return self.variables[variable]
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
1326 # Return a new uninitialized local runtime_variable
1327 fun new_var(mtype: MType): RuntimeVariable
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} */;")
1336 # The difference with `new_var
` is the C static type of the local variable
1337 fun new_var_extern(mtype: MType): RuntimeVariable
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 */;")
1346 # Return a new uninitialized named runtime_variable
1347 fun new_named_var(mtype: MType, name: String): RuntimeVariable
1349 mtype = self.anchor(mtype)
1350 var res = new RuntimeVariable(name, mtype, mtype)
1351 self.add_decl("{mtype.ctype} {name} /* : {mtype} */;")
1355 # Correctly assign a left and a right value
1356 # Boxing and unboxing is performed if required
1357 fun assign(left, right: RuntimeVariable)
1359 right = self.autobox(right, left.mtype)
1360 self.add("{left} = {right};")
1363 # Generate instances
1365 # Generate a alloc-instance + init-attributes
1366 fun init_instance(mtype: MClassType): RuntimeVariable is abstract
1368 # Set a GC finalizer on `recv
`, only if `recv
` isa Finalizable
1369 fun set_finalizer(recv: RuntimeVariable)
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});"
1379 # Generate an integer value
1380 fun int_instance(value: Int): RuntimeVariable
1382 var res = self.new_var(self.get_class("Int").mclass_type)
1383 self.add("{res} = {value};")
1387 # Generate an integer value
1388 fun bool_instance(value: Bool): RuntimeVariable
1390 var res = self.new_var(self.get_class("Bool").mclass_type)
1392 self.add("{res} = 1;")
1394 self.add("{res} = 0;")
1399 # Generate a string value
1400 fun string_instance(string: String): RuntimeVariable
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};")
1419 fun value_instance(object: Object): RuntimeVariable
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)
1432 # Generate an array value
1433 fun array_instance(array: Array[RuntimeVariable], elttype: MType): RuntimeVariable is abstract
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
1440 # Add a line in the main part of the generated C
1441 fun add(s: String) do self.writer.lines.add(s)
1444 # (used for local or global declaration)
1445 fun add_decl(s: String) do self.writer.decl_lines.add(s)
1447 # Request the presence of a global declaration
1448 fun require_declaration(key: String)
1450 var reqs = self.writer.file.required_declarations
1451 if reqs.has(key) then return
1453 var node = current_node
1454 if node != null then compiler.requirers_of_declarations[key] = node
1457 # Add a declaration in the local-header
1458 # The declaration is ensured to be present once
1459 fun declare_once(s: String)
1461 self.compiler.provide_declaration(s, s)
1462 self.require_declaration(s)
1465 # look for a needed .h and .c file for a given .nit source-file
1466 # FIXME: bad API, parameter should be a `MModule`, not its source-file
1467 fun add_extern(file: String)
1469 file = file.strip_extension(".nit")
1470 var tryfile = file + ".nit.h"
1471 if tryfile.file_exists then
1472 self.declare_once("#include \"{tryfile.basename("")}\"")
1473 self.compiler.files_to_copy.add(tryfile)
1475 tryfile = file + "_nit.h"
1476 if tryfile.file_exists then
1477 self.declare_once("#include \"{tryfile.basename("")}\"")
1478 self.compiler.files_to_copy.add(tryfile)
1481 if self.compiler.seen_extern.has(file) then return
1482 self.compiler.seen_extern.add(file)
1483 tryfile = file + ".nit.c"
1484 if not tryfile.file_exists then
1485 tryfile = file + "_nit.c"
1486 if not tryfile.file_exists then return
1488 var f = new ExternCFile(tryfile.basename(""), "")
1489 self.compiler.extern_bodies.add(f)
1490 self.compiler.files_to_copy.add(tryfile)
1493 # Return a new local runtime_variable initialized with the C expression `cexpr
`.
1494 fun new_expr(cexpr: String, mtype: MType): RuntimeVariable
1496 var res = new_var(mtype)
1497 self.add("{res} = {cexpr};")
1501 # Generate generic abort
1502 # used by aborts, asserts, casts, etc.
1503 fun add_abort(message: String)
1505 self.add("PRINT_ERROR(\"Runtime error: %s\", \"{message.escape_to_c}\");")
1511 if self.current_node != null and self.current_node.location.file != null then
1512 self.add("PRINT_ERROR(\" (%s:%d)\\n\", \"{self.current_node.location.file.filename.escape_to_c}\", {current_node.location.line_start});")
1514 self.add("PRINT_ERROR(\"\\n\");")
1516 self.add("show_backtrace(1);")
1519 # Add a dynamic cast
1520 fun add_cast(value: RuntimeVariable, mtype: MType, tag: String)
1522 var res = self.type_test(value, mtype, tag)
1523 self.add("if (unlikely(!{res})) \{")
1524 var cn = self.class_name_string(value)
1525 self.add("PRINT_ERROR(\"Runtime error: Cast failed. Expected `%s
`, got `%s
`\", \"{mtype.to_s.escape_to_c}\", {cn});")
1530 # Generate a return with the value `s
`
1531 fun ret(s: RuntimeVariable)
1533 self.assign(self.frame.returnvar.as(not null), s)
1534 self.add("goto {self.frame.returnlabel.as(not null)};")
1537 # Compile a statement (if any)
1538 fun stmt(nexpr: nullable AExpr)
1540 if nexpr == null then return
1542 var narray = nexpr.comprehension
1543 if narray != null then
1544 var recv = frame.comprehension.as(not null)
1545 var val = expr(nexpr, narray.element_mtype)
1546 compile_callsite(narray.push_callsite.as(not null), [recv, val])
1550 var old = self.current_node
1551 self.current_node = nexpr
1553 self.current_node = old
1556 # Compile an expression an return its result
1557 # `mtype
` is the expected return type, pass null if no specific type is expected.
1558 fun expr(nexpr: AExpr, mtype: nullable MType): RuntimeVariable
1560 var old = self.current_node
1561 self.current_node = nexpr
1562 var res = nexpr.expr(self).as(not null)
1563 if mtype != null then
1564 mtype = self.anchor(mtype)
1565 res = self.autobox(res, mtype)
1567 res = autoadapt(res, nexpr.mtype.as(not null))
1568 var implicit_cast_to = nexpr.implicit_cast_to
1569 if implicit_cast_to != null and not self.compiler.modelbuilder.toolcontext.opt_no_check_autocast.value then
1570 add_cast(res, implicit_cast_to, "auto")
1571 res = autoadapt(res, implicit_cast_to)
1573 self.current_node = old
1577 # Alias for `self.expr
(nexpr
, self.bool_type
)`
1578 fun expr_bool(nexpr: AExpr): RuntimeVariable do return expr(nexpr, bool_type)
1580 # Safely show a debug message on the current node and repeat the message in the C code as a comment
1581 fun debug(message: String)
1583 var node = self.current_node
1584 if node == null then
1585 print "?: {message}"
1589 self.add("/* DEBUG: {message} */")
1593 # A C function associated to a Nit method
1594 # Because of customization, a given Nit method can be compiler more that once
1595 abstract class AbstractRuntimeFunction
1597 type COMPILER: AbstractCompiler
1598 type VISITOR: AbstractCompilerVisitor
1600 # The associated Nit method
1601 var mmethoddef: MMethodDef
1603 # The mangled c name of the runtime_function
1604 # Subclasses should redefine `build_c_name
` instead
1607 var res = self.c_name_cache
1608 if res != null then return res
1609 res = self.build_c_name
1610 self.c_name_cache = res
1614 # Non cached version of `c_name
`
1615 protected fun build_c_name: String is abstract
1617 protected var c_name_cache: nullable String = null is writable
1619 # Implements a call of the runtime_function
1620 # May inline the body or generate a C function call
1621 fun call(v: VISITOR, arguments: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1623 # Generate the code for the `AbstractRuntimeFunction`
1624 # Warning: compile more than once compilation makes CC unhappy
1625 fun compile_to_c(compiler: COMPILER) is abstract
1628 # A runtime variable hold a runtime value in C.
1629 # Runtime variables are associated to Nit local variables and intermediate results in Nit expressions.
1631 # 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.
1632 class RuntimeVariable
1633 # The name of the variable in the C code
1636 # The static type of the variable (as declard in C)
1639 # The current casted type of the variable (as known in Nit)
1640 var mcasttype: MType is writable
1642 # If the variable exaclty a mcasttype?
1643 # false (usual value) means that the variable is a mcasttype or a subtype.
1644 var is_exact: Bool = false is writable
1648 assert not mtype.need_anchor
1649 assert not mcasttype.need_anchor
1652 redef fun to_s do return name
1657 if self.is_exact then
1658 exact_str = " exact"
1663 if self.mtype == self.mcasttype then
1664 type_str = "{mtype}{exact_str}"
1666 type_str = "{mtype}({mcasttype}{exact_str})"
1668 return "<{name}:{type_str}>"
1672 # A frame correspond to a visited property in a `GlobalCompilerVisitor`
1675 type VISITOR: AbstractCompilerVisitor
1677 # The associated visitor
1678 var visitor: VISITOR
1680 # The executed property.
1681 # A Method in case of a call, an attribute in case of a default initialization.
1682 var mpropdef: MPropDef
1684 # The static type of the receiver
1685 var receiver: MClassType
1687 # Arguments of the method (the first is the receiver)
1688 var arguments: Array[RuntimeVariable]
1690 # The runtime_variable associated to the return (in a function)
1691 var returnvar: nullable RuntimeVariable = null is writable
1693 # The label at the end of the property
1694 var returnlabel: nullable String = null is writable
1696 # Labels associated to a each escapemarks.
1697 # Because of inlinings, escape-marks must be associated to their context (the frame)
1698 private var escapemark_names = new HashMap[EscapeMark, String]
1700 # The array comprehension currently filled, if any
1701 private var comprehension: nullable RuntimeVariable = null
1705 # Return the C type associated to a given Nit static type
1706 fun ctype: String do return "val*"
1708 # C type outside of the compiler code and in boxes
1709 fun ctype_extern: String do return "val*"
1711 # Short name of the `ctype
` to use in unions
1712 fun ctypename: String do return "val"
1715 redef class MClassType
1717 redef fun ctype: String
1719 if mclass.name == "Int" then
1721 else if mclass.name == "Bool" then
1723 else if mclass.name == "Char" then
1725 else if mclass.name == "Float" then
1727 else if mclass.name == "NativeString" then
1729 else if mclass.name == "NativeArray" then
1736 redef fun ctype_extern: String
1738 if mclass.kind == extern_kind then
1745 redef fun ctypename: String
1747 if mclass.name == "Int" then
1749 else if mclass.name == "Bool" then
1751 else if mclass.name == "Char" then
1753 else if mclass.name == "Float" then
1755 else if mclass.name == "NativeString" then
1757 else if mclass.name == "NativeArray" then
1758 #return "{self.arguments.first.ctype}*"
1766 redef class MPropDef
1767 type VISITOR: AbstractCompilerVisitor
1770 redef class MMethodDef
1771 # Can the body be inlined?
1772 fun can_inline(v: VISITOR): Bool
1774 if is_abstract then return true
1775 var modelbuilder = v.compiler.modelbuilder
1776 var node = modelbuilder.mpropdef2node(self)
1777 if node isa APropdef then
1778 return node.can_inline
1779 else if node isa AClassdef then
1780 # Automatic free init is always inlined since it is empty or contains only attribtes assigments
1787 # Inline the body in another visitor
1788 fun compile_inside_to_c(v: VISITOR, arguments: Array[RuntimeVariable]): nullable RuntimeVariable
1790 var modelbuilder = v.compiler.modelbuilder
1791 var val = constant_value
1792 var node = modelbuilder.mpropdef2node(self)
1793 if node isa APropdef then
1794 var oldnode = v.current_node
1795 v.current_node = node
1796 self.compile_parameter_check(v, arguments)
1797 node.compile_to_c(v, self, arguments)
1798 v.current_node = oldnode
1799 else if node isa AClassdef then
1800 var oldnode = v.current_node
1801 v.current_node = node
1802 self.compile_parameter_check(v, arguments)
1803 node.compile_to_c(v, self, arguments)
1804 v.current_node = oldnode
1805 else if val != null then
1806 v.ret(v.value_instance(val))
1813 # Generate type checks in the C code to check covariant parameters
1814 fun compile_parameter_check(v: VISITOR, arguments: Array[RuntimeVariable])
1816 if v.compiler.modelbuilder.toolcontext.opt_no_check_covariance.value then return
1818 for i in [0..msignature.arity[ do
1819 # skip test for vararg since the array is instantiated with the correct polymorphic type
1820 if msignature.vararg_rank == i then continue
1822 # skip if the cast is not required
1823 var origmtype = self.mproperty.intro.msignature.mparameters[i].mtype
1824 if not origmtype.need_anchor then continue
1826 # get the parameter type
1827 var mtype = self.msignature.mparameters[i].mtype
1830 # note that v decides if and how to implements the cast
1831 v.add("/* Covariant cast for argument {i} ({self.msignature.mparameters[i].name}) {arguments[i+1].inspect} isa {mtype} */")
1832 v.add_cast(arguments[i+1], mtype, "covariance")
1839 redef class APropdef
1840 fun compile_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
1842 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name} {mpropdef} at {location.to_s}\\n\");")
1843 debug("Not yet implemented")
1846 fun can_inline: Bool do return true
1849 redef class AMethPropdef
1850 redef fun compile_to_c(v, mpropdef, arguments)
1852 if mpropdef.is_abstract then
1853 var cn = v.class_name_string(arguments.first)
1854 v.add("PRINT_ERROR(\"Runtime error: Abstract method `%s
` called on `%s
`\", \"{mpropdef.mproperty.name.escape_to_c}\", {cn});")
1859 # Call the implicit super-init
1860 var auto_super_inits = self.auto_super_inits
1861 if auto_super_inits != null then
1862 var args = [arguments.first]
1863 for auto_super_init in auto_super_inits do
1864 assert auto_super_init.mproperty != mpropdef.mproperty
1866 for i in [0..auto_super_init.msignature.arity+1[ do
1867 args.add(arguments[i])
1869 assert auto_super_init.mproperty != mpropdef.mproperty
1870 v.compile_callsite(auto_super_init, args)
1873 if auto_super_call then
1874 v.supercall(mpropdef, arguments.first.mtype.as(MClassType), arguments)
1877 # Try special compilation
1878 if mpropdef.is_intern then
1879 if compile_intern_to_c(v, mpropdef, arguments) then return
1880 else if mpropdef.is_extern then
1881 if mpropdef.mproperty.is_init then
1882 if compile_externinit_to_c(v, mpropdef, arguments) then return
1884 if compile_externmeth_to_c(v, mpropdef, arguments) then return
1888 # Compile block if any
1889 var n_block = n_block
1890 if n_block != null then
1891 for i in [0..mpropdef.msignature.arity[ do
1892 var variable = self.n_signature.n_params[i].variable.as(not null)
1893 v.assign(v.variable(variable), arguments[i+1])
1900 var cn = v.class_name_string(arguments.first)
1901 v.add("PRINT_ERROR(\"Runtime error: uncompiled method `%s
` called on `%s
`. NOT YET IMPLEMENTED\", \"{mpropdef.mproperty.name.escape_to_c}\", {cn});")
1905 redef fun can_inline
1907 if self.auto_super_inits != null then return false
1908 var nblock = self.n_block
1909 if nblock == null then return true
1910 if (mpropdef.mproperty.name == "==" or mpropdef.mproperty.name == "!=") and mpropdef.mclassdef.mclass.name == "Object" then return true
1911 if nblock isa ABlockExpr and nblock.n_expr.length == 0 then return true
1915 fun compile_intern_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable]): Bool
1917 var pname = mpropdef.mproperty.name
1918 var cname = mpropdef.mclassdef.mclass.name
1919 var ret = mpropdef.msignature.return_mtype
1921 ret = v.resolve_for(ret, arguments.first)
1923 if pname != "==" and pname != "!=" then
1924 v.adapt_signature(mpropdef, arguments)
1925 v.unbox_signature_extern(mpropdef, arguments)
1927 if cname == "Int" then
1928 if pname == "output" then
1929 v.add("printf(\"%ld\\n\", {arguments.first});")
1931 else if pname == "object_id" then
1932 v.ret(arguments.first)
1934 else if pname == "+" then
1935 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
1937 else if pname == "-" then
1938 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
1940 else if pname == "unary -" then
1941 v.ret(v.new_expr("-{arguments[0]}", ret.as(not null)))
1943 else if pname == "*" then
1944 v.ret(v.new_expr("{arguments[0]} * {arguments[1]}", ret.as(not null)))
1946 else if pname == "/" then
1947 v.ret(v.new_expr("{arguments[0]} / {arguments[1]}", ret.as(not null)))
1949 else if pname == "%" then
1950 v.ret(v.new_expr("{arguments[0]} % {arguments[1]}", ret.as(not null)))
1952 else if pname == "lshift" then
1953 v.ret(v.new_expr("{arguments[0]} << {arguments[1]}", ret.as(not null)))
1955 else if pname == "rshift" then
1956 v.ret(v.new_expr("{arguments[0]} >> {arguments[1]}", ret.as(not null)))
1958 else if pname == "==" then
1959 v.ret(v.equal_test(arguments[0], arguments[1]))
1961 else if pname == "!=" then
1962 var res = v.equal_test(arguments[0], arguments[1])
1963 v.ret(v.new_expr("!{res}", ret.as(not null)))
1965 else if pname == "<" then
1966 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
1968 else if pname == ">" then
1969 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
1971 else if pname == "<=" then
1972 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
1974 else if pname == ">=" then
1975 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
1977 else if pname == "to_f" then
1978 v.ret(v.new_expr("(double){arguments[0]}", ret.as(not null)))
1980 else if pname == "ascii" then
1981 v.ret(v.new_expr("{arguments[0]}", ret.as(not null)))
1984 else if cname == "Char" then
1985 if pname == "output" then
1986 v.add("printf(\"%c\", {arguments.first});")
1988 else if pname == "object_id" then
1989 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
1991 else if pname == "successor" then
1992 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
1994 else if pname == "predecessor" then
1995 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
1997 else if pname == "==" then
1998 v.ret(v.equal_test(arguments[0], arguments[1]))
2000 else if pname == "!=" then
2001 var res = v.equal_test(arguments[0], arguments[1])
2002 v.ret(v.new_expr("!{res}", ret.as(not null)))
2004 else if pname == "<" then
2005 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
2007 else if pname == ">" then
2008 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
2010 else if pname == "<=" then
2011 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
2013 else if pname == ">=" then
2014 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
2016 else if pname == "to_i" then
2017 v.ret(v.new_expr("{arguments[0]}-'0'", ret.as(not null)))
2019 else if pname == "ascii" then
2020 v.ret(v.new_expr("(unsigned char){arguments[0]}", ret.as(not null)))
2023 else if cname == "Bool" then
2024 if pname == "output" then
2025 v.add("printf({arguments.first}?\"true\\n\":\"false\\n\");")
2027 else if pname == "object_id" then
2028 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
2030 else if pname == "==" then
2031 v.ret(v.equal_test(arguments[0], arguments[1]))
2033 else if pname == "!=" then
2034 var res = v.equal_test(arguments[0], arguments[1])
2035 v.ret(v.new_expr("!{res}", ret.as(not null)))
2038 else if cname == "Float" then
2039 if pname == "output" then
2040 v.add("printf(\"%f\\n\", {arguments.first});")
2042 else if pname == "object_id" then
2043 v.ret(v.new_expr("(double){arguments.first}", ret.as(not null)))
2045 else if pname == "+" then
2046 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
2048 else if pname == "-" then
2049 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
2051 else if pname == "unary -" then
2052 v.ret(v.new_expr("-{arguments[0]}", ret.as(not null)))
2054 else if pname == "succ" then
2055 v.ret(v.new_expr("{arguments[0]}+1", ret.as(not null)))
2057 else if pname == "prec" then
2058 v.ret(v.new_expr("{arguments[0]}-1", ret.as(not null)))
2060 else if pname == "*" then
2061 v.ret(v.new_expr("{arguments[0]} * {arguments[1]}", ret.as(not null)))
2063 else if pname == "/" then
2064 v.ret(v.new_expr("{arguments[0]} / {arguments[1]}", ret.as(not null)))
2066 else if pname == "==" then
2067 v.ret(v.equal_test(arguments[0], arguments[1]))
2069 else if pname == "!=" then
2070 var res = v.equal_test(arguments[0], arguments[1])
2071 v.ret(v.new_expr("!{res}", ret.as(not null)))
2073 else if pname == "<" then
2074 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
2076 else if pname == ">" then
2077 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
2079 else if pname == "<=" then
2080 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
2082 else if pname == ">=" then
2083 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
2085 else if pname == "to_i" then
2086 v.ret(v.new_expr("(long){arguments[0]}", ret.as(not null)))
2089 else if cname == "NativeString" then
2090 if pname == "[]" then
2091 v.ret(v.new_expr("{arguments[0]}[{arguments[1]}]", ret.as(not null)))
2093 else if pname == "[]=" then
2094 v.add("{arguments[0]}[{arguments[1]}]={arguments[2]};")
2096 else if pname == "copy_to" then
2097 v.add("memmove({arguments[1]}+{arguments[4]},{arguments[0]}+{arguments[3]},{arguments[2]});")
2099 else if pname == "atoi" then
2100 v.ret(v.new_expr("atoi({arguments[0]});", ret.as(not null)))
2102 else if pname == "new" then
2103 v.ret(v.new_expr("(char*)nit_alloc({arguments[1]})", ret.as(not null)))
2106 else if cname == "NativeArray" then
2107 v.native_array_def(pname, ret, arguments)
2110 if pname == "exit" then
2111 v.add("exit({arguments[1]});")
2113 else if pname == "sys" then
2114 v.ret(v.new_expr("glob_sys", ret.as(not null)))
2116 else if pname == "calloc_string" then
2117 v.ret(v.new_expr("(char*)nit_alloc({arguments[1]})", ret.as(not null)))
2119 else if pname == "calloc_array" then
2120 v.calloc_array(ret.as(not null), arguments)
2122 else if pname == "object_id" then
2123 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
2125 else if pname == "is_same_type" then
2126 v.ret(v.is_same_type_test(arguments[0], arguments[1]))
2128 else if pname == "is_same_instance" then
2129 v.ret(v.equal_test(arguments[0], arguments[1]))
2131 else if pname == "output_class_name" then
2132 var nat = v.class_name_string(arguments.first)
2133 v.add("printf(\"%s\\n\", {nat});")
2135 else if pname == "native_class_name" then
2136 var nat = v.class_name_string(arguments.first)
2137 v.ret(v.new_expr("(char*){nat}", ret.as(not null)))
2139 else if pname == "force_garbage_collection" then
2140 v.add("nit_gcollect();")
2142 else if pname == "native_argc" then
2143 v.ret(v.new_expr("glob_argc", ret.as(not null)))
2145 else if pname == "native_argv" then
2146 v.ret(v.new_expr("glob_argv[{arguments[1]}]", ret.as(not null)))
2152 # Compile an extern method
2153 # Return `true` if the compilation was successful, `false` if a fall-back is needed
2154 fun compile_externmeth_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable]): Bool
2157 var at = self.get_single_annotation("extern", v.compiler.modelbuilder)
2158 if at != null and at.n_args.length == 1 then
2159 externname = at.arg_as_string(v.compiler.modelbuilder)
2160 if externname == null then return false
2164 if location.file != null then
2165 var file = location.file.filename
2168 var res: nullable RuntimeVariable = null
2169 var ret = mpropdef.msignature.return_mtype
2171 ret = v.resolve_for(ret, arguments.first)
2172 res = v.new_var_extern(ret)
2174 v.adapt_signature(mpropdef, arguments)
2175 v.unbox_signature_extern(mpropdef, arguments)
2178 v.add("{externname}({arguments.join(", ")});")
2180 v.add("{res} = {externname}({arguments.join(", ")});")
2181 res = v.box_extern(res, ret.as(not null))
2187 # Compile an extern factory
2188 # Return `true` if the compilation was successful, `false` if a fall-back is needed
2189 fun compile_externinit_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable]): Bool
2192 var at = self.get_single_annotation("extern", v.compiler.modelbuilder)
2194 externname = at.arg_as_string(v.compiler.modelbuilder)
2195 if externname == null then return false
2199 if location.file != null then
2200 var file = location.file.filename
2203 v.adapt_signature(mpropdef, arguments)
2204 v.unbox_signature_extern(mpropdef, arguments)
2205 var ret = arguments.first.mtype
2206 var res = v.new_var_extern(ret)
2210 v.add("{res} = {externname}({arguments.join(", ")});")
2211 res = v.box_extern(res, ret)
2217 redef class AAttrPropdef
2218 redef fun can_inline: Bool do return not is_lazy
2220 redef fun compile_to_c(v, mpropdef, arguments)
2222 if mpropdef == mreadpropdef then
2223 assert arguments.length == 1
2224 var recv = arguments.first
2228 var ret = self.mpropdef.static_mtype
2229 var useiset = ret.ctype == "val*" and not ret isa MNullableType
2230 var guard = self.mlazypropdef.mproperty
2232 set = v.isset_attribute(self.mpropdef.mproperty, recv)
2234 set = v.read_attribute(guard, recv)
2236 v.add("if(likely({set})) \{")
2237 res = v.read_attribute(self.mpropdef.mproperty, recv)
2240 var value = evaluate_expr(v, recv)
2242 v.assign(res, value)
2244 var true_v = v.new_expr("1", v.bool_type)
2245 v.write_attribute(guard, arguments.first, true_v)
2249 res = v.read_attribute(self.mpropdef.mproperty, arguments.first)
2251 v.assign(v.frame.returnvar.as(not null), res)
2252 else if mpropdef == mwritepropdef then
2253 assert arguments.length == 2
2254 v.write_attribute(self.mpropdef.mproperty, arguments.first, arguments[1])
2256 var ret = self.mpropdef.static_mtype
2257 var useiset = ret.ctype == "val*" and not ret isa MNullableType
2259 v.write_attribute(self.mlazypropdef.mproperty, arguments.first, v.new_expr("1", v.bool_type))
2267 fun init_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable)
2269 if has_value and not is_lazy then evaluate_expr(v, recv)
2272 # Evaluate, store and return the default value of the attribute
2273 private fun evaluate_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable): RuntimeVariable
2275 var oldnode = v.current_node
2276 v.current_node = self
2277 var old_frame = v.frame
2278 var frame = new Frame(v, self.mpropdef.as(not null), recv.mcasttype.as_notnullable.as(MClassType), [recv])
2282 var mtype = self.mpropdef.static_mtype
2283 assert mtype != null
2285 var nexpr = self.n_expr
2286 var nblock = self.n_block
2287 if nexpr != null then
2288 value = v.expr(nexpr, mtype)
2289 else if nblock != null then
2290 value = v.new_var(mtype)
2291 frame.returnvar = value
2292 frame.returnlabel = v.get_name("RET_LABEL")
2295 v.add("{frame.returnlabel.as(not null)}:(void)0;")
2301 v.write_attribute(self.mpropdef.mproperty, recv, value)
2304 v.current_node = oldnode
2309 fun check_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable)
2311 var nexpr = self.n_expr
2312 if nexpr != null then return
2314 var oldnode = v.current_node
2315 v.current_node = self
2316 var old_frame = v.frame
2317 var frame = new Frame(v, self.mpropdef.as(not null), recv.mtype.as(MClassType), [recv])
2319 # Force read to check the initialization
2320 v.read_attribute(self.mpropdef.mproperty, recv)
2322 v.current_node = oldnode
2326 redef class AClassdef
2327 private fun compile_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
2329 if mpropdef == self.mfree_init then
2330 assert mpropdef.mproperty.is_root_init
2331 assert arguments.length == 1
2332 if not mpropdef.is_intro then
2333 v.supercall(mpropdef, arguments.first.mtype.as(MClassType), arguments)
2343 # Try to compile self as an expression
2344 # Do not call this method directly, use `v
.expr
` instead
2345 private fun expr(v: AbstractCompilerVisitor): nullable RuntimeVariable
2347 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name}:{location.to_s}\\n\");")
2348 var mtype = self.mtype
2349 if mtype == null then
2352 var res = v.new_var(mtype)
2353 v.add("/* {res} = NOT YET {class_name} */")
2358 # Try to compile self as a statement
2359 # Do not call this method directly, use `v
.stmt
` instead
2360 private fun stmt(v: AbstractCompilerVisitor)
2366 redef class ABlockExpr
2369 for e in self.n_expr do v.stmt(e)
2373 var last = self.n_expr.last
2374 for e in self.n_expr do
2375 if e == last then break
2378 return v.expr(last, null)
2382 redef class AVardeclExpr
2385 var variable = self.variable.as(not null)
2386 var ne = self.n_expr
2388 var i = v.expr(ne, variable.declared_type)
2389 v.assign(v.variable(variable), i)
2394 redef class AVarExpr
2397 var res = v.variable(self.variable.as(not null))
2398 var mtype = self.mtype.as(not null)
2399 return v.autoadapt(res, mtype)
2403 redef class AVarAssignExpr
2406 var variable = self.variable.as(not null)
2407 var i = v.expr(self.n_value, variable.declared_type)
2408 v.assign(v.variable(variable), i)
2413 redef class AVarReassignExpr
2416 var variable = self.variable.as(not null)
2417 var vari = v.variable(variable)
2418 var value = v.expr(self.n_value, variable.declared_type)
2419 var res = v.compile_callsite(self.reassign_callsite.as(not null), [vari, value])
2421 v.assign(v.variable(variable), res)
2425 redef class ASelfExpr
2426 redef fun expr(v) do return v.frame.arguments.first
2429 redef class AEscapeExpr
2430 redef fun stmt(v) do v.add("goto BREAK_{v.escapemark_name(self.escapemark)};")
2433 redef class AReturnExpr
2436 var nexpr = self.n_expr
2437 if nexpr != null then
2438 var returnvar = v.frame.returnvar.as(not null)
2439 var i = v.expr(nexpr, returnvar.mtype)
2440 v.assign(returnvar, i)
2442 v.add("goto {v.frame.returnlabel.as(not null)};")
2446 redef class AAbortExpr
2447 redef fun stmt(v) do v.add_abort("Aborted")
2453 var cond = v.expr_bool(self.n_expr)
2454 v.add("if ({cond})\{")
2463 var res = v.new_var(self.mtype.as(not null))
2464 var cond = v.expr_bool(self.n_expr)
2465 v.add("if ({cond})\{")
2466 v.assign(res, v.expr(self.n_then.as(not null), null))
2468 v.assign(res, v.expr(self.n_else.as(not null), null))
2474 redef class AIfexprExpr
2477 var res = v.new_var(self.mtype.as(not null))
2478 var cond = v.expr_bool(self.n_expr)
2479 v.add("if ({cond})\{")
2480 v.assign(res, v.expr(self.n_then, null))
2482 v.assign(res, v.expr(self.n_else, null))
2491 v.stmt(self.n_block)
2492 v.add_escape_label(break_mark)
2496 redef class AWhileExpr
2500 var cond = v.expr_bool(self.n_expr)
2501 v.add("if (!{cond}) break;")
2502 v.stmt(self.n_block)
2503 v.add_escape_label(continue_mark)
2505 v.add_escape_label(break_mark)
2509 redef class ALoopExpr
2513 v.stmt(self.n_block)
2514 v.add_escape_label(continue_mark)
2516 v.add_escape_label(break_mark)
2520 redef class AForExpr
2523 var cl = v.expr(self.n_expr, null)
2524 var it_meth = self.method_iterator
2525 assert it_meth != null
2526 var it = v.compile_callsite(it_meth, [cl])
2529 var isok_meth = self.method_is_ok
2530 assert isok_meth != null
2531 var ok = v.compile_callsite(isok_meth, [it])
2533 v.add("if(!{ok}) break;")
2534 if self.variables.length == 1 then
2535 var item_meth = self.method_item
2536 assert item_meth != null
2537 var i = v.compile_callsite(item_meth, [it])
2539 v.assign(v.variable(variables.first), i)
2540 else if self.variables.length == 2 then
2541 var key_meth = self.method_key
2542 assert key_meth != null
2543 var i = v.compile_callsite(key_meth, [it])
2545 v.assign(v.variable(variables[0]), i)
2546 var item_meth = self.method_item
2547 assert item_meth != null
2548 i = v.compile_callsite(item_meth, [it])
2550 v.assign(v.variable(variables[1]), i)
2554 v.stmt(self.n_block)
2555 v.add_escape_label(continue_mark)
2556 var next_meth = self.method_next
2557 assert next_meth != null
2558 v.compile_callsite(next_meth, [it])
2560 v.add_escape_label(break_mark)
2562 var method_finish = self.method_finish
2563 if method_finish != null then
2564 # TODO: Find a way to call this also in long escape (e.g. return)
2565 v.compile_callsite(method_finish, [it])
2570 redef class AAssertExpr
2573 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return
2575 var cond = v.expr_bool(self.n_expr)
2576 v.add("if (unlikely(!{cond})) \{")
2580 v.add_abort("Assert '{nid.text}' failed")
2582 v.add_abort("Assert failed")
2591 var res = v.new_var(self.mtype.as(not null))
2592 var i1 = v.expr_bool(self.n_expr)
2593 v.add("if ({i1}) \{")
2596 var i2 = v.expr_bool(self.n_expr2)
2597 v.add("{res} = {i2};")
2603 redef class AImpliesExpr
2606 var res = v.new_var(self.mtype.as(not null))
2607 var i1 = v.expr_bool(self.n_expr)
2608 v.add("if (!{i1}) \{")
2611 var i2 = v.expr_bool(self.n_expr2)
2612 v.add("{res} = {i2};")
2618 redef class AAndExpr
2621 var res = v.new_var(self.mtype.as(not null))
2622 var i1 = v.expr_bool(self.n_expr)
2623 v.add("if (!{i1}) \{")
2626 var i2 = v.expr_bool(self.n_expr2)
2627 v.add("{res} = {i2};")
2633 redef class ANotExpr
2636 var cond = v.expr_bool(self.n_expr)
2637 return v.new_expr("!{cond}", self.mtype.as(not null))
2641 redef class AOrElseExpr
2644 var res = v.new_var(self.mtype.as(not null))
2645 var i1 = v.expr(self.n_expr, null)
2646 v.add("if ({i1}!=NULL) \{")
2649 var i2 = v.expr(self.n_expr2, null)
2656 redef class AIntExpr
2657 redef fun expr(v) do return v.new_expr("{self.value.to_s}", self.mtype.as(not null))
2660 redef class AFloatExpr
2661 redef fun expr(v) do return v.new_expr("{self.n_float.text}", self.mtype.as(not null)) # FIXME use value, not n_float
2664 redef class ACharExpr
2665 redef fun expr(v) do return v.new_expr("'{self.value.to_s.escape_to_c}'", self.mtype.as(not null))
2668 redef class AArrayExpr
2671 var mtype = self.element_mtype.as(not null)
2672 var array = new Array[RuntimeVariable]
2673 var res = v.array_instance(array, mtype)
2675 var old_comprehension = v.frame.comprehension
2676 v.frame.comprehension = res
2677 for nexpr in self.n_exprs do
2680 v.frame.comprehension = old_comprehension
2686 redef class AStringFormExpr
2687 redef fun expr(v) do return v.string_instance(self.value.as(not null))
2690 redef class ASuperstringExpr
2693 var array = new Array[RuntimeVariable]
2694 for ne in self.n_exprs do
2695 if ne isa AStringFormExpr and ne.value == "" then continue # skip empty sub-strings
2696 var i = v.expr(ne, null)
2699 var a = v.array_instance(array, v.object_type)
2700 var res = v.send(v.get_property("to_s", a.mtype), [a])
2705 redef class ACrangeExpr
2708 var i1 = v.expr(self.n_expr, null)
2709 var i2 = v.expr(self.n_expr2, null)
2710 var mtype = self.mtype.as(MClassType)
2711 var res = v.init_instance(mtype)
2712 v.compile_callsite(init_callsite.as(not null), [res, i1, i2])
2717 redef class AOrangeExpr
2720 var i1 = v.expr(self.n_expr, null)
2721 var i2 = v.expr(self.n_expr2, null)
2722 var mtype = self.mtype.as(MClassType)
2723 var res = v.init_instance(mtype)
2724 v.compile_callsite(init_callsite.as(not null), [res, i1, i2])
2729 redef class ATrueExpr
2730 redef fun expr(v) do return v.new_expr("1", self.mtype.as(not null))
2733 redef class AFalseExpr
2734 redef fun expr(v) do return v.new_expr("0", self.mtype.as(not null))
2737 redef class ANullExpr
2738 redef fun expr(v) do return v.new_expr("NULL", self.mtype.as(not null))
2741 redef class AIsaExpr
2744 var i = v.expr(self.n_expr, null)
2745 return v.type_test(i, self.cast_type.as(not null), "isa")
2749 redef class AAsCastExpr
2752 var i = v.expr(self.n_expr, null)
2753 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return i
2755 v.add_cast(i, self.mtype.as(not null), "as")
2760 redef class AAsNotnullExpr
2763 var i = v.expr(self.n_expr, null)
2764 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return i
2766 if i.mtype.ctype != "val*" then return i
2768 v.add("if (unlikely({i} == NULL)) \{")
2769 v.add_abort("Cast failed")
2775 redef class AParExpr
2776 redef fun expr(v) do return v.expr(self.n_expr, null)
2779 redef class AOnceExpr
2782 var mtype = self.mtype.as(not null)
2783 var name = v.get_name("varonce")
2784 var guard = v.get_name(name + "_guard")
2785 v.add_decl("static {mtype.ctype} {name};")
2786 v.add_decl("static int {guard};")
2787 var res = v.new_var(mtype)
2788 v.add("if ({guard}) \{")
2789 v.add("{res} = {name};")
2791 var i = v.expr(self.n_expr, mtype)
2792 v.add("{res} = {i};")
2793 v.add("{name} = {res};")
2794 v.add("{guard} = 1;")
2800 redef class ASendExpr
2803 var recv = v.expr(self.n_expr, null)
2804 var callsite = self.callsite.as(not null)
2805 var args = v.varargize(callsite.mpropdef, recv, self.raw_arguments)
2806 return v.compile_callsite(callsite, args)
2810 redef class ASendReassignFormExpr
2813 var recv = v.expr(self.n_expr, null)
2814 var callsite = self.callsite.as(not null)
2815 var args = v.varargize(callsite.mpropdef, recv, self.raw_arguments)
2817 var value = v.expr(self.n_value, null)
2819 var left = v.compile_callsite(callsite, args)
2822 var res = v.compile_callsite(self.reassign_callsite.as(not null), [left, value])
2826 v.compile_callsite(self.write_callsite.as(not null), args)
2830 redef class ASuperExpr
2833 var recv = v.frame.arguments.first
2835 var callsite = self.callsite
2836 if callsite != null then
2837 var args = v.varargize(callsite.mpropdef, recv, self.n_args.n_exprs)
2839 # Add additional arguments for the super init call
2840 if args.length == 1 then
2841 for i in [0..callsite.msignature.arity[ do
2842 args.add(v.frame.arguments[i+1])
2846 var res = v.compile_callsite(callsite, args)
2850 var mpropdef = self.mpropdef.as(not null)
2851 var args = v.varargize(mpropdef, recv, self.n_args.n_exprs)
2852 if args.length == 1 then
2853 args = v.frame.arguments
2856 # stantard call-next-method
2857 return v.supercall(mpropdef, recv.mtype.as(MClassType), args)
2861 redef class ANewExpr
2864 var mtype = self.recvtype
2865 assert mtype != null
2867 var ctype = mtype.ctype
2868 if mtype.mclass.name == "NativeArray" then
2869 assert self.n_args.n_exprs.length == 1
2870 var l = v.expr(self.n_args.n_exprs.first, null)
2871 assert mtype isa MGenericType
2872 var elttype = mtype.arguments.first
2873 return v.native_array_instance(elttype, l)
2874 else if ctype == "val*" then
2875 recv = v.init_instance(mtype)
2876 else if ctype == "char*" then
2877 recv = v.new_expr("NULL/*special!*/", mtype)
2879 recv = v.new_expr("({ctype})0/*special!*/", mtype)
2882 var callsite = self.callsite.as(not null)
2883 var args = v.varargize(callsite.mpropdef, recv, self.n_args.n_exprs)
2884 var res2 = v.compile_callsite(callsite, args)
2885 if res2 != null then
2886 #self.debug("got {res2} from {mproperty}. drop {recv}")
2893 redef class AAttrExpr
2896 var recv = v.expr(self.n_expr, null)
2897 var mproperty = self.mproperty.as(not null)
2898 return v.read_attribute(mproperty, recv)
2902 redef class AAttrAssignExpr
2905 var recv = v.expr(self.n_expr, null)
2906 var i = v.expr(self.n_value, null)
2907 var mproperty = self.mproperty.as(not null)
2908 v.write_attribute(mproperty, recv, i)
2913 redef class AAttrReassignExpr
2916 var recv = v.expr(self.n_expr, null)
2917 var value = v.expr(self.n_value, null)
2918 var mproperty = self.mproperty.as(not null)
2919 var attr = v.read_attribute(mproperty, recv)
2920 var res = v.compile_callsite(self.reassign_callsite.as(not null), [attr, value])
2922 v.write_attribute(mproperty, recv, res)
2926 redef class AIssetAttrExpr
2929 var recv = v.expr(self.n_expr, null)
2930 var mproperty = self.mproperty.as(not null)
2931 return v.isset_attribute(mproperty, recv)
2935 redef class ADebugTypeExpr
2944 redef class Array[E]
2945 # Return a new `Array` with the elements only contened in self and not in `o
`
2946 fun -(o: Array[E]): Array[E] do
2947 var res = new Array[E]
2948 for e in self do if not o.has(e) then res.add(e)
2954 # All `MProperty` associated to all `MClassDef` of `mclass
`
2955 fun properties(mclass: MClass): Set[MProperty] do
2956 if not self.properties_cache.has_key(mclass) then
2957 var properties = new HashSet[MProperty]
2958 var parents = new Array[MClass]
2959 if self.flatten_mclass_hierarchy.has(mclass) then
2960 parents.add_all(mclass.in_hierarchy(self).direct_greaters)
2962 for parent in parents do
2963 properties.add_all(self.properties(parent))
2965 for mclassdef in mclass.mclassdefs do
2966 if not self.in_importation <= mclassdef.mmodule then continue
2967 for mprop in mclassdef.intro_mproperties do
2968 properties.add(mprop)
2971 self.properties_cache[mclass] = properties
2973 return properties_cache[mclass]
2975 private var properties_cache: Map[MClass, Set[MProperty]] = new HashMap[MClass, Set[MProperty]]
2977 # Write FFI and nitni results to file
2978 fun finalize_ffi(c: AbstractCompiler) do end
2980 # Give requided addinional system libraries (as given to LD_LIBS)
2981 # Note: can return null instead of an empty set
2982 fun collect_linker_libs: nullable Set[String] do return null
2985 # Create a tool context to handle options and paths
2986 var toolcontext = new ToolContext
2988 toolcontext.tooldescription = "Usage: nitc [OPTION]... file.nit...\nCompiles Nit programs."
2990 # We do not add other options, so process them now!
2991 toolcontext.process_options(args)
2993 # We need a model to collect stufs
2994 var model = new Model
2995 # An a model builder to parse files
2996 var modelbuilder = new ModelBuilder(model, toolcontext)
2998 var arguments = toolcontext.option_context.rest
2999 if arguments.length > 1 and toolcontext.opt_output.value != null then
3000 print "Error: --output needs a single source file. Do you prefer --dir?"
3004 # Here we load an process all modules passed on the command line
3005 var mmodules = modelbuilder.parse(arguments)
3007 if mmodules.is_empty then return
3008 modelbuilder.run_phases
3010 for mmodule in mmodules do
3011 toolcontext.info("*** PROCESS {mmodule} ***", 1)
3013 toolcontext.run_global_phases(ms)