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
.target_platform
124 var toolchain
= platform
.toolchain
(toolcontext
)
125 compile_dir
= toolchain
.compile_dir
126 toolchain
.write_and_make compiler
131 # The specific tool-chain associated to the platform
132 fun toolchain
(toolcontext
: ToolContext): Toolchain do return new MakefileToolchain(toolcontext
)
136 var toolcontext
: ToolContext
138 fun compile_dir
: String
140 var compile_dir
= toolcontext
.opt_compile_dir
.value
141 if compile_dir
== null then compile_dir
= ".nit_compile"
145 fun write_and_make
(compiler
: AbstractCompiler) is abstract
148 class MakefileToolchain
151 redef fun write_and_make
(compiler
)
153 var compile_dir
= compile_dir
155 # Generate the .h and .c files
156 # A single C file regroups many compiled rumtime functions
157 # 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
159 self.toolcontext
.info
("*** WRITING C ***", 1)
163 var cfiles
= new Array[String]
164 write_files
(compiler
, compile_dir
, cfiles
)
166 # Generate the Makefile
168 write_makefile
(compiler
, compile_dir
, cfiles
)
171 self.toolcontext
.info
("*** END WRITING C: {time1-time0} ***", 2)
173 # Execute the Makefile
175 if self.toolcontext
.opt_no_cc
.value
then return
178 self.toolcontext
.info
("*** COMPILING C ***", 1)
180 compile_c_code
(compiler
, compile_dir
)
183 self.toolcontext
.info
("*** END COMPILING C: {time1-time0} ***", 2)
186 fun write_files
(compiler
: AbstractCompiler, compile_dir
: String, cfiles
: Array[String])
188 var platform
= compiler
.target_platform
189 if self.toolcontext
.opt_stacktrace
.value
== "nitstack" and platform
.supports_libunwind
then compiler
.build_c_to_nit_bindings
190 var cc_opt_with_libgc
= "-DWITH_LIBGC"
191 if not platform
.supports_libgc
then cc_opt_with_libgc
= ""
193 # Add gc_choser.h to aditionnal bodies
194 var gc_chooser
= new ExternCFile("gc_chooser.c", cc_opt_with_libgc
)
195 if cc_opt_with_libgc
!= "" then gc_chooser
.pkgconfigs
.add
"bdw-gc"
196 compiler
.extern_bodies
.add
(gc_chooser
)
197 var clib
= toolcontext
.nit_dir
/ "clib"
198 compiler
.files_to_copy
.add
"{clib}/gc_chooser.c"
199 compiler
.files_to_copy
.add
"{clib}/gc_chooser.h"
202 for m
in compiler
.mainmodule
.in_importation
.greaters
do
203 compiler
.finalize_ffi_for_module
(m
)
206 # Copy original .[ch] files to compile_dir
207 for src
in compiler
.files_to_copy
do
208 var basename
= src
.basename
("")
209 var dst
= "{compile_dir}/{basename}"
213 var hfilename
= compiler
.header
.file
.name
+ ".h"
214 var hfilepath
= "{compile_dir}/{hfilename}"
215 var h
= new OFStream.open
(hfilepath
)
216 for l
in compiler
.header
.decl_lines
do
220 for l
in compiler
.header
.lines
do
226 var max_c_lines
= toolcontext
.opt_max_c_lines
.value
227 for f
in compiler
.files
do
230 var file
: nullable OFStream = null
231 for vis
in f
.writers
do
232 if vis
== compiler
.header
then continue
233 var total_lines
= vis
.lines
.length
+ vis
.decl_lines
.length
234 if total_lines
== 0 then continue
236 if file
== null or (count
> max_c_lines
and max_c_lines
> 0) then
238 if file
!= null then file
.close
239 var cfilename
= "{f.name}.{i}.c"
240 var cfilepath
= "{compile_dir}/{cfilename}"
241 self.toolcontext
.info
("new C source files to compile: {cfilepath}", 3)
242 cfiles
.add
(cfilename
)
243 file
= new OFStream.open
(cfilepath
)
244 file
.write
"#include \"{f.name}.0.h\
"\n"
247 for l
in vis
.decl_lines
do
251 for l
in vis
.lines
do
256 if file
== null then continue
259 var cfilename
= "{f.name}.0.h"
260 var cfilepath
= "{compile_dir}/{cfilename}"
261 var hfile
: nullable OFStream = null
262 hfile
= new OFStream.open
(cfilepath
)
263 hfile
.write
"#include \"{hfilename}\
"\n"
264 for key
in f
.required_declarations
do
265 if not compiler
.provided_declarations
.has_key
(key
) then
266 var node
= compiler
.requirers_of_declarations
.get_or_null
(key
)
268 node
.debug
"No provided declaration for {key}"
270 print
"No provided declaration for {key}"
274 hfile
.write compiler
.provided_declarations
[key
]
280 self.toolcontext
.info
("Total C source files to compile: {cfiles.length}", 2)
283 fun makefile_name
(mainmodule
: MModule): String do return "{mainmodule.c_name}.mk"
285 fun default_outname
(mainmodule
: MModule): String
287 # Search a non fictive module
288 var res
= mainmodule
.name
289 while mainmodule
.is_fictive
do
290 mainmodule
= mainmodule
.in_importation
.direct_greaters
.first
291 res
= mainmodule
.name
296 # Combine options and platform informations to get the final path of the outfile
297 fun outfile
(mainmodule
: MModule): String
299 var res
= self.toolcontext
.opt_output
.value
300 if res
!= null then return res
301 res
= default_outname
(mainmodule
)
302 var dir
= self.toolcontext
.opt_dir
.value
303 if dir
!= null then return dir
.join_path
(res
)
307 fun write_makefile
(compiler
: AbstractCompiler, compile_dir
: String, cfiles
: Array[String])
309 var mainmodule
= compiler
.mainmodule
310 var platform
= compiler
.target_platform
312 var outname
= outfile
(mainmodule
)
314 var real_outpath
= compile_dir
.relpath
(outname
)
315 var outpath
= real_outpath
.escape_to_mk
316 if outpath
!= real_outpath
then
317 # If the name is crazy and need escaping, we will do an indirection
318 # 1. generate the binary in the .nit_compile dir under an escaped name
319 # 2. copy the binary at the right place in the `all` goal.
320 outpath
= mainmodule
.c_name
322 var makename
= makefile_name
(mainmodule
)
323 var makepath
= "{compile_dir}/{makename}"
324 var makefile
= new OFStream.open
(makepath
)
326 var linker_options
= new HashSet[String]
327 for m
in mainmodule
.in_importation
.greaters
do
328 var libs
= m
.collect_linker_libs
329 if libs
!= null then linker_options
.add_all
(libs
)
332 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")
334 var ost
= toolcontext
.opt_stacktrace
.value
335 if (ost
== "libunwind" or ost
== "nitstack") and platform
.supports_libunwind
then makefile
.write
("NEED_LIBUNWIND := YesPlease\n")
337 # Dynamic adaptations
338 # While `platform` enable complex toolchains, they are statically applied
339 # For a dynamic adaptsation of the compilation, the generated Makefile should check and adapt things itself
341 # Check and adapt the targeted system
342 makefile
.write
("uname_S := $(shell sh -c 'uname -s 2>/dev/null || echo not')\n")
343 makefile
.write
("ifeq ($(uname_S),Darwin)\n")
344 # remove -lunwind since it is already included on macosx
345 makefile
.write
("\tNEED_LIBUNWIND :=\n")
346 makefile
.write
("endif\n\n")
348 # Check and adapt for the compiler used
349 # clang need an additionnal `-Qunused-arguments`
350 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")
352 makefile
.write
("ifdef NEED_LIBUNWIND\n\tLDLIBS += -lunwind\nendif\n")
354 makefile
.write
("all: {outpath}\n")
355 if outpath
!= real_outpath
then
356 makefile
.write
("\tcp -- {outpath.escape_to_sh} {real_outpath.escape_to_sh.replace("$","$$")}")
360 var ofiles
= new Array[String]
361 var dep_rules
= new Array[String]
362 # Compile each generated file
364 var o
= f
.strip_extension
(".c") + ".o"
365 makefile
.write
("{o}: {f}\n\t$(CC) $(CFLAGS) $(CINCL) -c -o {o} {f}\n\n")
370 # Generate linker script, if any
371 if not compiler
.linker_script
.is_empty
then
372 var linker_script_path
= "{compile_dir}/linker_script"
373 ofiles
.add
"linker_script"
374 var f
= new OFStream.open
(linker_script_path
)
375 for l
in compiler
.linker_script
do
382 var java_files
= new Array[ExternFile]
384 var pkgconfigs
= new Array[String]
385 for f
in compiler
.extern_bodies
do
386 pkgconfigs
.add_all f
.pkgconfigs
389 if not pkgconfigs
.is_empty
then
391 # does pkg-config exists?
392 ifneq ($(shell which pkg-config >/dev/null; echo $$?), 0)
393 $(error "Command `pkg-config` not found. Please install it")
396 for p
in pkgconfigs
do
398 # Check for library {{{p}}}
399 ifneq ($(shell pkg-config --exists '{{{p}}}'; echo $$?), 0)
400 $(error "pkg-config: package {{{p}}} is not found.")
406 # Compile each required extern body into a specific .o
407 for f
in compiler
.extern_bodies
do
408 var o
= f
.makefile_rule_name
409 var ff
= f
.filename
.basename
("")
410 makefile
.write
("{o}: {ff}\n")
411 makefile
.write
("\t{f.makefile_rule_content}\n\n")
412 dep_rules
.add
(f
.makefile_rule_name
)
414 if f
.compiles_to_o_file
then ofiles
.add
(o
)
415 if f
.add_to_jar
then java_files
.add
(f
)
418 if not java_files
.is_empty
then
419 var jar_file
= "{outpath}.jar"
421 var class_files_array
= new Array[String]
422 for f
in java_files
do class_files_array
.add
(f
.makefile_rule_name
)
423 var class_files
= class_files_array
.join
(" ")
425 makefile
.write
("{jar_file}: {class_files}\n")
426 makefile
.write
("\tjar cf {jar_file} {class_files}\n\n")
427 dep_rules
.add jar_file
432 if not pkgconfigs
.is_empty
then
433 pkg
= "`pkg-config --libs {pkgconfigs.join(" ")}`"
435 makefile
.write
("{outpath}: {dep_rules.join(" ")}\n\t$(CC) $(LDFLAGS) -o {outpath.escape_to_sh} {ofiles.join(" ")} $(LDLIBS) {pkg}\n\n")
437 makefile
.write
("clean:\n\trm {ofiles.join(" ")} 2>/dev/null\n")
438 if outpath
!= real_outpath
then
439 makefile
.write
("\trm -- {outpath.escape_to_sh} 2>/dev/null\n")
442 self.toolcontext
.info
("Generated makefile: {makepath}", 2)
444 makepath
.file_copy_to
"{compile_dir}/Makefile"
447 fun compile_c_code
(compiler
: AbstractCompiler, compile_dir
: String)
449 var makename
= makefile_name
(compiler
.mainmodule
)
451 var makeflags
= self.toolcontext
.opt_make_flags
.value
452 if makeflags
== null then makeflags
= ""
453 self.toolcontext
.info
("make -B -C {compile_dir} -f {makename} -j 4 {makeflags}", 2)
456 if self.toolcontext
.verbose_level
>= 3 then
457 res
= sys
.system
("make -B -C {compile_dir} -f {makename} -j 4 {makeflags} 2>&1")
459 res
= sys
.system
("make -B -C {compile_dir} -f {makename} -j 4 {makeflags} 2>&1 >/dev/null")
462 toolcontext
.error
(null, "make failed! Error code: {res}.")
467 # Singleton that store the knowledge about the compilation process
468 abstract class AbstractCompiler
469 type VISITOR: AbstractCompilerVisitor
471 # Table corresponding c_names to nit names (methods)
472 var names
= new HashMap[String, String]
474 # The main module of the program currently compiled
475 # Is assigned during the separate compilation
476 var mainmodule
: MModule is writable
478 # The real main module of the program
479 var realmainmodule
: MModule is noinit
481 # The modelbuilder used to know the model and the AST
482 var modelbuilder
: ModelBuilder is protected writable
484 # Is hardening asked? (see --hardening)
485 fun hardening
: Bool do return self.modelbuilder
.toolcontext
.opt_hardening
.value
487 # The targeted specific platform
488 var target_platform
: Platform is noinit
492 self.realmainmodule
= mainmodule
493 target_platform
= mainmodule
.target_platform
or else new Platform
496 # Do the full code generation of the program `mainmodule`
497 # It is the main method usually called after the instantiation
498 fun do_compilation
is abstract
500 # Force the creation of a new file
501 # The point is to avoid contamination between must-be-compiled-separately files
502 fun new_file
(name
: String): CodeFile
504 if modelbuilder
.toolcontext
.opt_group_c_files
.value
then
505 if self.files
.is_empty
then
506 var f
= new CodeFile(mainmodule
.c_name
)
509 return self.files
.first
511 var f
= new CodeFile(name
)
516 # The list of all associated files
517 # Used to generate .c files
518 var files
= new List[CodeFile]
520 # Initialize a visitor specific for a compiler engine
521 fun new_visitor
: VISITOR is abstract
523 # Where global declaration are stored (the main .h)
524 var header
: CodeWriter is writable, noinit
526 # Additionnal linker script for `ld`.
527 # Mainly used to do specific link-time symbol resolution
528 var linker_script
= new Array[String]
530 # Provide a declaration that can be requested (before or latter) by a visitor
531 fun provide_declaration
(key
: String, s
: String)
533 if self.provided_declarations
.has_key
(key
) then
534 assert self.provided_declarations
[key
] == s
536 self.provided_declarations
[key
] = s
539 private var provided_declarations
= new HashMap[String, String]
541 private var requirers_of_declarations
= new HashMap[String, ANode]
543 # Builds the .c and .h files to be used when generating a Stack Trace
544 # Binds the generated C function names to Nit function names
545 fun build_c_to_nit_bindings
547 var compile_dir
= modelbuilder
.compile_dir
549 var stream
= new OFStream.open
("{compile_dir}/c_functions_hash.c")
550 stream
.write
("#include <string.h>\n")
551 stream
.write
("#include <stdlib.h>\n")
552 stream
.write
("#include \"c_functions_hash
.h\
"\n")
553 stream
.write
("typedef struct C_Nit_Names\{char* name; char* nit_name;\}C_Nit_Names;\n")
554 stream
.write
("const char* get_nit_name(register const char* procproc, register unsigned int len)\{\n")
555 stream
.write
("char* procname = malloc(len+1);")
556 stream
.write
("memcpy(procname, procproc, len);")
557 stream
.write
("procname[len] = '\\0';")
558 stream
.write
("static const C_Nit_Names map[{names.length}] = \{\n")
559 for i
in names
.keys
do
561 stream.write(i.escape_to_c)
562 stream.write("\
",\"")
563 stream.write(names[i].escape_to_c)
564 stream.write("\
"\},\n")
566 stream
.write
("\};\n")
567 stream
.write
("int i;")
568 stream
.write
("for(i = 0; i < {names.length}; i++)\{")
569 stream
.write
("if(strcmp(procname,map[i].name) == 0)\{")
570 stream
.write
("free(procname);")
571 stream
.write
("return map[i].nit_name;")
574 stream
.write
("free(procname);")
575 stream
.write
("return NULL;")
579 stream
= new OFStream.open
("{compile_dir}/c_functions_hash.h")
580 stream
.write
("const char* get_nit_name(register const char* procname, register unsigned int len);\n")
583 extern_bodies
.add
(new ExternCFile("{compile_dir}/c_functions_hash.c", ""))
587 # This method call compile_header_strucs method that has to be refined
588 fun compile_header
do
589 self.header
.add_decl
("#include <stdlib.h>")
590 self.header
.add_decl
("#include <stdio.h>")
591 self.header
.add_decl
("#include <string.h>")
592 self.header
.add_decl
("#include \"gc_chooser
.h\
"")
593 self.header
.add_decl
("#ifdef ANDROID")
594 self.header
.add_decl
(" #include <android/log.h>")
595 self.header
.add_decl
(" #define PRINT_ERROR(...) (void)__android_log_print(ANDROID_LOG_WARN, \"Nit\
", __VA_ARGS__)")
596 self.header
.add_decl
("#else")
597 self.header
.add_decl
(" #define PRINT_ERROR(...) fprintf(stderr, __VA_ARGS__)")
598 self.header
.add_decl
("#endif")
600 compile_header_structs
601 compile_nitni_structs
603 var gccd_disable
= modelbuilder
.toolcontext
.opt_no_gcc_directive
.value
604 if gccd_disable
.has
("noreturn") or gccd_disable
.has
("all") then
605 # Signal handler function prototype
606 self.header
.add_decl
("void show_backtrace(int);")
608 self.header
.add_decl
("void show_backtrace(int) __attribute__ ((noreturn));")
611 if gccd_disable
.has
("likely") or gccd_disable
.has
("all") then
612 self.header
.add_decl
("#define likely(x) (x)")
613 self.header
.add_decl
("#define unlikely(x) (x)")
614 else if gccd_disable
.has
("correct-likely") then
615 # invert the `likely` definition
616 # Used by masochists to bench the worst case
617 self.header
.add_decl
("#define likely(x) __builtin_expect((x),0)")
618 self.header
.add_decl
("#define unlikely(x) __builtin_expect((x),1)")
620 self.header
.add_decl
("#define likely(x) __builtin_expect((x),1)")
621 self.header
.add_decl
("#define unlikely(x) __builtin_expect((x),0)")
624 # Global variable used by intern methods
625 self.header
.add_decl
("extern int glob_argc;")
626 self.header
.add_decl
("extern char **glob_argv;")
627 self.header
.add_decl
("extern val *glob_sys;")
630 # Declaration of structures for live Nit types
631 protected fun compile_header_structs
is abstract
633 # Declaration of structures for nitni undelying the FFI
634 protected fun compile_nitni_structs
636 self.header
.add_decl
"""
637 /* Native reference to Nit objects */
638 /* This structure is used to represent every Nit type in extern methods and custom C code. */
640 struct nitni_ref *next,
641 *prev; /* adjacent global references in global list */
642 int count; /* number of time this global reference has been marked */
645 /* List of global references from C code to Nit objects */
646 /* Instanciated empty at init of Nit system and filled explicitly by user in C code */
647 struct nitni_global_ref_list_t {
648 struct nitni_ref *head, *tail;
650 extern struct nitni_global_ref_list_t *nitni_global_ref_list;
652 /* Initializer of global reference list */
653 extern void nitni_global_ref_list_init();
655 /* Intern function to add a global reference to the list */
656 extern void nitni_global_ref_add( struct nitni_ref *ref );
658 /* Intern function to remove a global reference from the list */
659 extern void nitni_global_ref_remove( struct nitni_ref *ref );
661 /* Increase count on an existing global reference */
662 extern void nitni_global_ref_incr( struct nitni_ref *ref );
664 /* Decrease count on an existing global reference */
665 extern void nitni_global_ref_decr( struct nitni_ref *ref );
669 fun compile_finalizer_function
671 var finalizable_type
= mainmodule
.finalizable_type
672 if finalizable_type
== null then return
674 var finalize_meth
= mainmodule
.try_get_primitive_method
("finalize", finalizable_type
.mclass
)
676 if finalize_meth
== null then
677 modelbuilder
.toolcontext
.error
(null, "The `Finalizable` class doesn't declare the `finalize` method.")
681 var v
= self.new_visitor
682 v
.add_decl
"void gc_finalize (void *obj, void *client_data) \{"
683 var recv
= v
.new_expr
("obj", finalizable_type
)
684 v
.send
(finalize_meth
, [recv
])
688 # Generate the main C function.
692 # * allocate the Sys object if it exists
693 # * call init if is exists
694 # * call main if it exists
695 fun compile_main_function
697 var v
= self.new_visitor
698 v
.add_decl
("#include <signal.h>")
699 var ost
= modelbuilder
.toolcontext
.opt_stacktrace
.value
700 var platform
= target_platform
702 if not platform
.supports_libunwind
then ost
= "none"
704 var no_main
= platform
.no_main
or modelbuilder
.toolcontext
.opt_no_main
.value
706 if ost
== "nitstack" or ost
== "libunwind" then
707 v
.add_decl
("#define UNW_LOCAL_ONLY")
708 v
.add_decl
("#include <libunwind.h>")
709 if ost
== "nitstack" then
710 v
.add_decl
("#include \"c_functions_hash
.h\
"")
713 v
.add_decl
("int glob_argc;")
714 v
.add_decl
("char **glob_argv;")
715 v
.add_decl
("val *glob_sys;")
717 if self.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
718 for tag
in count_type_test_tags
do
719 v
.add_decl
("long count_type_test_resolved_{tag};")
720 v
.add_decl
("long count_type_test_unresolved_{tag};")
721 v
.add_decl
("long count_type_test_skipped_{tag};")
722 v
.compiler
.header
.add_decl
("extern long count_type_test_resolved_{tag};")
723 v
.compiler
.header
.add_decl
("extern long count_type_test_unresolved_{tag};")
724 v
.compiler
.header
.add_decl
("extern long count_type_test_skipped_{tag};")
728 if self.modelbuilder
.toolcontext
.opt_invocation_metrics
.value
then
729 v
.add_decl
("long count_invoke_by_tables;")
730 v
.add_decl
("long count_invoke_by_direct;")
731 v
.add_decl
("long count_invoke_by_inline;")
732 v
.compiler
.header
.add_decl
("extern long count_invoke_by_tables;")
733 v
.compiler
.header
.add_decl
("extern long count_invoke_by_direct;")
734 v
.compiler
.header
.add_decl
("extern long count_invoke_by_inline;")
737 if self.modelbuilder
.toolcontext
.opt_isset_checks_metrics
.value
then
738 v
.add_decl
("long count_attr_reads = 0;")
739 v
.add_decl
("long count_isset_checks = 0;")
740 v
.compiler
.header
.add_decl
("extern long count_attr_reads;")
741 v
.compiler
.header
.add_decl
("extern long count_isset_checks;")
744 v
.add_decl
("void sig_handler(int signo)\{")
745 v
.add_decl
("PRINT_ERROR(\"Caught signal
: %s\\n\
", strsignal(signo));")
746 v
.add_decl
("show_backtrace(signo);")
749 v
.add_decl
("void show_backtrace (int signo) \{")
750 if ost
== "nitstack" or ost
== "libunwind" then
751 v
.add_decl
("char* opt = getenv(\"NIT_NO_STACK\
");")
752 v
.add_decl
("unw_cursor_t cursor;")
753 v
.add_decl
("if(opt==NULL)\{")
754 v
.add_decl
("unw_context_t uc;")
755 v
.add_decl
("unw_word_t ip;")
756 v
.add_decl
("char* procname = malloc(sizeof(char) * 100);")
757 v
.add_decl
("unw_getcontext(&uc);")
758 v
.add_decl
("unw_init_local(&cursor, &uc);")
759 v
.add_decl
("PRINT_ERROR(\"-------------------------------------------------\\n\
");")
760 v
.add_decl
("PRINT_ERROR(\"-- Stack Trace ------------------------------\\n\
");")
761 v
.add_decl
("PRINT_ERROR(\"-------------------------------------------------\\n\
");")
762 v
.add_decl
("while (unw_step(&cursor) > 0) \{")
763 v
.add_decl
(" unw_get_proc_name(&cursor, procname, 100, &ip);")
764 if ost
== "nitstack" then
765 v
.add_decl
(" const char* recv = get_nit_name(procname, strlen(procname));")
766 v
.add_decl
(" if (recv != NULL)\{")
767 v
.add_decl
(" PRINT_ERROR(\"` %s\\n\", recv);")
768 v.add_decl(" \}else\{")
769 v.add_decl(" PRINT_ERROR(\"` %s\\n\
", procname);")
772 v
.add_decl
(" PRINT_ERROR(\"` %s \\n\",procname);")
775 v.add_decl("PRINT_ERROR(\"-------------------------------------------------\\n\");")
776 v.add_decl("free(procname);")
779 v.add_decl("exit(signo);")
783 v.add_decl("int nit_main(int argc, char** argv) \{")
785 v.add_decl("int main(int argc, char** argv) \{")
788 v.add("signal(SIGABRT, sig_handler);")
789 v.add("signal(SIGFPE, sig_handler);")
790 v.add("signal(SIGILL, sig_handler);")
791 v.add("signal(SIGINT, sig_handler);")
792 v.add("signal(SIGTERM, sig_handler);")
793 v.add("signal(SIGSEGV, sig_handler);")
794 v.add("signal(SIGPIPE, sig_handler);")
796 v.add("glob_argc = argc; glob_argv = argv;")
797 v.add("initialize_gc_option();")
799 v.add "initialize_nitni_global_refs();"
801 var main_type = mainmodule.sys_type
802 if main_type != null then
803 var mainmodule = v.compiler.mainmodule
804 var glob_sys = v.init_instance(main_type)
805 v.add("glob_sys = {glob_sys};")
806 var main_init = mainmodule.try_get_primitive_method("init", main_type.mclass)
807 if main_init != null then
808 v.send(main_init, [glob_sys])
810 var main_method = mainmodule.try_get_primitive_method("run", main_type.mclass) or else
811 mainmodule.try_get_primitive_method("main", main_type.mclass)
812 if main_method != null then
813 v.send(main_method, [glob_sys])
817 if self.modelbuilder.toolcontext.opt_typing_test_metrics.value then
818 v.add_decl("long count_type_test_resolved_total = 0;")
819 v.add_decl("long count_type_test_unresolved_total = 0;")
820 v.add_decl("long count_type_test_skipped_total = 0;")
821 v.add_decl("long count_type_test_total_total = 0;")
822 for tag in count_type_test_tags do
823 v.add_decl("long count_type_test_total_{tag};")
824 v.add("count_type_test_total_{tag} = count_type_test_resolved_{tag} + count_type_test_unresolved_{tag} + count_type_test_skipped_{tag};")
825 v.add("count_type_test_resolved_total += count_type_test_resolved_{tag};")
826 v.add("count_type_test_unresolved_total += count_type_test_unresolved_{tag};")
827 v.add("count_type_test_skipped_total += count_type_test_skipped_{tag};")
828 v.add("count_type_test_total_total += count_type_test_total_{tag};")
830 v.add("printf(\"# dynamic count_type_test: total %l\\n\");")
831 v.add("printf(\"\\tresolved\\tunresolved\\tskipped\\ttotal\\n\");")
832 var tags = count_type_test_tags.to_a
835 v.add("printf(\"{tag}\");")
836 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_resolved_{tag}, 100.0*count_type_test_resolved_{tag}/count_type_test_total_total);")
837 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_unresolved_{tag}, 100.0*count_type_test_unresolved_{tag}/count_type_test_total_total);")
838 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_skipped_{tag}, 100.0*count_type_test_skipped_{tag}/count_type_test_total_total);")
839 v.add("printf(\"\\t%ld (%.2f%%)\\n\", count_type_test_total_{tag}, 100.0*count_type_test_total_{tag}/count_type_test_total_total);")
843 if self.modelbuilder.toolcontext.opt_invocation_metrics.value then
844 v.add_decl("long count_invoke_total;")
845 v.add("count_invoke_total = count_invoke_by_tables + count_invoke_by_direct + count_invoke_by_inline;")
846 v.add("printf(\"# dynamic count_invocation: total %ld\\n\", count_invoke_total);")
847 v.add("printf(\"by table: %ld (%.2f%%)\\n\", count_invoke_by_tables, 100.0*count_invoke_by_tables/count_invoke_total);")
848 v.add("printf(\"direct: %ld (%.2f%%)\\n\", count_invoke_by_direct, 100.0*count_invoke_by_direct/count_invoke_total);")
849 v.add("printf(\"inlined: %ld (%.2f%%)\\n\", count_invoke_by_inline, 100.0*count_invoke_by_inline/count_invoke_total);")
852 if self.modelbuilder.toolcontext.opt_isset_checks_metrics.value then
853 v.add("printf(\"# dynamic attribute reads: %ld\\n\", count_attr_reads);")
854 v.add("printf(\"# dynamic isset checks: %ld\\n\", count_isset_checks);")
861 # Copile all C functions related to the [incr|decr]_ref features of the FFI
862 fun compile_nitni_global_ref_functions
864 var v = self.new_visitor
866 struct nitni_global_ref_list_t *nitni_global_ref_list;
867 void initialize_nitni_global_refs() {
868 nitni_global_ref_list = (struct nitni_global_ref_list_t*)nit_alloc(sizeof(struct nitni_global_ref_list_t));
869 nitni_global_ref_list->head = NULL;
870 nitni_global_ref_list->tail = NULL;
873 void nitni_global_ref_add( struct nitni_ref *ref ) {
874 if ( nitni_global_ref_list->head == NULL ) {
875 nitni_global_ref_list->head = ref;
878 nitni_global_ref_list->tail->next = ref;
879 ref->prev = nitni_global_ref_list->tail;
881 nitni_global_ref_list->tail = ref;
886 void nitni_global_ref_remove( struct nitni_ref *ref ) {
887 if ( ref->prev == NULL ) {
888 nitni_global_ref_list->head = ref->next;
890 ref->prev->next = ref->next;
893 if ( ref->next == NULL ) {
894 nitni_global_ref_list->tail = ref->prev;
896 ref->next->prev = ref->prev;
900 extern void nitni_global_ref_incr( struct nitni_ref *ref ) {
901 if ( ref->count == 0 ) /* not registered */
904 nitni_global_ref_add( ref );
910 extern void nitni_global_ref_decr( struct nitni_ref *ref ) {
911 if ( ref->count == 1 ) /* was last reference */
913 /* remove from list */
914 nitni_global_ref_remove( ref );
922 # List of additional files required to compile (FFI)
923 var extern_bodies = new Array[ExternFile]
925 # List of source files to copy over to the compile dir
926 var files_to_copy = new Array[String]
928 # This is used to avoid adding an extern file more than once
929 private var seen_extern = new ArraySet[String]
931 # Generate code that initialize the attributes on a new instance
932 fun generate_init_attr(v: VISITOR, recv: RuntimeVariable, mtype: MClassType)
934 var cds = mtype.collect_mclassdefs(self.mainmodule).to_a
935 self.mainmodule.linearize_mclassdefs(cds)
937 for npropdef in modelbuilder.collect_attr_propdef(cd) do
938 npropdef.init_expr(v, recv)
943 # Generate code that check if an attribute is correctly initialized
944 fun generate_check_attr(v: VISITOR, recv: RuntimeVariable, mtype: MClassType)
946 var cds = mtype.collect_mclassdefs(self.mainmodule).to_a
947 self.mainmodule.linearize_mclassdefs(cds)
949 for npropdef in modelbuilder.collect_attr_propdef(cd) do
950 npropdef.check_expr(v, recv)
957 var count_type_test_tags: Array[String] = ["isa", "as", "auto", "covariance", "erasure"]
958 var count_type_test_resolved: HashMap[String, Int] = init_count_type_test_tags
959 var count_type_test_unresolved: HashMap[String, Int] = init_count_type_test_tags
960 var count_type_test_skipped: HashMap[String, Int] = init_count_type_test_tags
962 protected fun init_count_type_test_tags: HashMap[String, Int]
964 var res = new HashMap[String, Int]
965 for tag in count_type_test_tags do
971 # Display stats about compilation process
975 # * type tests against resolved types (`x
isa Collection[Animal]`)
976 # * type tests against unresolved types (`x
isa Collection[E
]`)
977 # * type tests skipped
981 if self.modelbuilder.toolcontext.opt_typing_test_metrics.value then
982 print "# static count_type_test"
983 print "\tresolved:\tunresolved\tskipped\ttotal"
984 var count_type_test_total = init_count_type_test_tags
985 count_type_test_resolved["total"] = 0
986 count_type_test_unresolved["total"] = 0
987 count_type_test_skipped["total"] = 0
988 count_type_test_total["total"] = 0
989 for tag in count_type_test_tags do
990 count_type_test_total[tag] = count_type_test_resolved[tag] + count_type_test_unresolved[tag] + count_type_test_skipped[tag]
991 count_type_test_resolved["total"] += count_type_test_resolved[tag]
992 count_type_test_unresolved["total"] += count_type_test_unresolved[tag]
993 count_type_test_skipped["total"] += count_type_test_skipped[tag]
994 count_type_test_total["total"] += count_type_test_total[tag]
996 var count_type_test = count_type_test_total["total"]
997 var tags = count_type_test_tags.to_a
1001 printn "\t{count_type_test_resolved[tag]} ({div(count_type_test_resolved[tag],count_type_test)}%)"
1002 printn "\t{count_type_test_unresolved[tag]} ({div(count_type_test_unresolved[tag],count_type_test)}%)"
1003 printn "\t{count_type_test_skipped[tag]} ({div(count_type_test_skipped[tag],count_type_test)}%)"
1004 printn "\t{count_type_test_total[tag]} ({div(count_type_test_total[tag],count_type_test)}%)"
1010 fun finalize_ffi_for_module(mmodule: MModule) do mmodule.finalize_ffi(self)
1013 # Avoid division by zero by returning the string "n/a"
1014 fun div(a,b:Int):String
1016 if b == 0 then return "n/a"
1017 return ((a*10000/b).to_f / 100.0).to_precision(2)
1021 # A file unit (may be more than one file if
1022 # A file unit aim to be autonomous and is made or one or more `CodeWriter`s
1025 var writers = new Array[CodeWriter]
1026 var required_declarations = new HashSet[String]
1029 # Where to store generated lines
1032 var lines: List[String] = new List[String]
1033 var decl_lines: List[String] = new List[String]
1035 # Add a line in the main part of the generated C
1036 fun add(s: String) do self.lines.add(s)
1039 # (used for local or global declaration)
1040 fun add_decl(s: String) do self.decl_lines.add(s)
1044 file.writers.add(self)
1048 # A visitor on the AST of property definition that generate the C code.
1049 abstract class AbstractCompilerVisitor
1051 type COMPILER: AbstractCompiler
1053 # The associated compiler
1054 var compiler: COMPILER
1056 # The current visited AST node
1057 var current_node: nullable ANode = null is writable
1059 # The current `StaticFrame`
1060 var frame: nullable StaticFrame = null is writable
1062 # Alias for self.compiler.mainmodule.object_type
1063 fun object_type: MClassType do return self.compiler.mainmodule.object_type
1065 # Alias for self.compiler.mainmodule.bool_type
1066 fun bool_type: MClassType do return self.compiler.mainmodule.bool_type
1068 var writer: CodeWriter is noinit
1072 self.writer = new CodeWriter(compiler.files.last)
1075 # Force to get the primitive class named `name
` or abort
1076 fun get_class(name: String): MClass do return self.compiler.mainmodule.get_primitive_class(name)
1078 # Force to get the primitive property named `name
` in the instance `recv
` or abort
1079 fun get_property(name: String, recv: MType): MMethod
1081 assert recv isa MClassType
1082 return self.compiler.modelbuilder.force_get_primitive_method(self.current_node, name, recv.mclass, self.compiler.mainmodule)
1085 fun compile_callsite(callsite: CallSite, arguments: Array[RuntimeVariable]): nullable RuntimeVariable
1087 var initializers = callsite.mpropdef.initializers
1088 if not initializers.is_empty then
1089 var recv = arguments.first
1092 for p in initializers do
1093 if p isa MMethod then
1095 for x in p.intro.msignature.mparameters do
1096 args.add arguments[i]
1100 else if p isa MAttribute then
1101 self.write_attribute(p, recv, arguments[i])
1105 assert i == arguments.length
1107 return self.send(callsite.mproperty, [recv])
1110 return self.send(callsite.mproperty, arguments)
1113 fun native_array_instance(elttype: MType, length: RuntimeVariable): RuntimeVariable is abstract
1115 fun calloc_array(ret_type: MType, arguments: Array[RuntimeVariable]) is abstract
1117 fun native_array_def(pname: String, ret_type: nullable MType, arguments: Array[RuntimeVariable]) is abstract
1119 # Evaluate `args
` as expressions in the call of `mpropdef
` on `recv
`.
1120 # This method is used to manage varargs in signatures and returns the real array
1121 # of runtime variables to use in the call.
1122 fun varargize(mpropdef: MMethodDef, recv: RuntimeVariable, args: SequenceRead[AExpr]): Array[RuntimeVariable]
1124 var msignature = mpropdef.new_msignature or else mpropdef.msignature.as(not null)
1125 var res = new Array[RuntimeVariable]
1128 if args.is_empty then return res
1130 var vararg_rank = msignature.vararg_rank
1131 var vararg_len = args.length - msignature.arity
1132 if vararg_len < 0 then vararg_len = 0
1134 for i in [0..msignature.arity[ do
1135 if i == vararg_rank then
1137 if ne isa AVarargExpr then
1138 var e = self.expr(ne.n_expr, null)
1142 var vararg = new Array[RuntimeVariable]
1143 for j in [vararg_rank..vararg_rank+vararg_len] do
1144 var e = self.expr(args[j], null)
1147 var elttype = msignature.mparameters[vararg_rank].mtype
1148 var arg = self.vararg_instance(mpropdef, recv, vararg, elttype)
1152 if i > vararg_rank then j += vararg_len
1153 var e = self.expr(args[j], null)
1162 # Anchor a type to the main module and the current receiver
1163 fun anchor(mtype: MType): MType
1165 if not mtype.need_anchor then return mtype
1166 return mtype.anchor_to(self.compiler.mainmodule, self.frame.receiver)
1169 fun resolve_for(mtype: MType, recv: RuntimeVariable): MType
1171 if not mtype.need_anchor then return mtype
1172 return mtype.resolve_for(recv.mcasttype, self.frame.receiver, self.compiler.mainmodule, true)
1175 # Unsafely cast a value to a new type
1176 # ie the result share the same C variable but my have a different mcasttype
1177 # NOTE: if the adaptation is useless then `value
` is returned as it.
1178 # ENSURE: `result
.name
== value
.name
`
1179 fun autoadapt(value: RuntimeVariable, mtype: MType): RuntimeVariable
1181 mtype = self.anchor(mtype)
1182 var valmtype = value.mcasttype
1183 if valmtype.is_subtype(self.compiler.mainmodule, null, mtype) then
1187 if valmtype isa MNullableType and valmtype.mtype.is_subtype(self.compiler.mainmodule, null, mtype) then
1188 var res = new RuntimeVariable(value.name, valmtype, valmtype.mtype)
1191 var res = new RuntimeVariable(value.name, valmtype, mtype)
1196 # Generate a super call from a method definition
1197 fun supercall(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1199 # Adapt the arguments of a method according to targetted `MMethodDef`
1200 fun adapt_signature(m: MMethodDef, args: Array[RuntimeVariable]) is abstract
1202 # Unbox all the arguments of a method when implemented `extern` or `intern`
1203 fun unbox_signature_extern(m: MMethodDef, args: Array[RuntimeVariable]) is abstract
1205 # Box or unbox a value to another type iff a C type conversion is needed
1206 # ENSURE: `result
.mtype
.ctype
== mtype
.ctype
`
1207 fun autobox(value: RuntimeVariable, mtype: MType): RuntimeVariable is abstract
1209 # Box extern classes to be used in the generated code
1210 fun box_extern(value: RuntimeVariable, mtype: MType): RuntimeVariable is abstract
1212 # Unbox extern classes to be used in extern code (legacy NI and FFI)
1213 fun unbox_extern(value: RuntimeVariable, mtype: MType): RuntimeVariable is abstract
1215 # Generate a polymorphic subtype test
1216 fun type_test(value: RuntimeVariable, mtype: MType, tag: String): RuntimeVariable is abstract
1218 # Generate the code required to dynamically check if 2 objects share the same runtime type
1219 fun is_same_type_test(value1, value2: RuntimeVariable): RuntimeVariable is abstract
1221 # Generate a Nit "is" for two runtime_variables
1222 fun equal_test(value1, value2: RuntimeVariable): RuntimeVariable is abstract
1226 # Generate a static call on a method definition
1227 fun call(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1229 # Generate a polymorphic send for the method `m
` and the arguments `args
`
1230 fun send(m: MMethod, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1232 # Generate a monomorphic send for the method `m
`, the type `t
` and the arguments `args
`
1233 fun monomorphic_send(m: MMethod, t: MType, args: Array[RuntimeVariable]): nullable RuntimeVariable
1235 assert t isa MClassType
1236 var propdef = m.lookup_first_definition(self.compiler.mainmodule, t)
1237 return self.call(propdef, t, args)
1240 # Generate a monomorphic super send from the method `m
`, the type `t
` and the arguments `args
`
1241 fun monomorphic_super_send(m: MMethodDef, t: MType, args: Array[RuntimeVariable]): nullable RuntimeVariable
1243 assert t isa MClassType
1244 m = m.lookup_next_definition(self.compiler.mainmodule, t)
1245 return self.call(m, t, args)
1248 # Attributes handling
1250 # Generate a polymorphic attribute is_set test
1251 fun isset_attribute(a: MAttribute, recv: RuntimeVariable): RuntimeVariable is abstract
1253 # Generate a polymorphic attribute read
1254 fun read_attribute(a: MAttribute, recv: RuntimeVariable): RuntimeVariable is abstract
1256 # Generate a polymorphic attribute write
1257 fun write_attribute(a: MAttribute, recv: RuntimeVariable, value: RuntimeVariable) is abstract
1261 # Add a check and an abort for a null receiver if needed
1262 fun check_recv_notnull(recv: RuntimeVariable)
1264 if self.compiler.modelbuilder.toolcontext.opt_no_check_null.value then return
1266 var maybenull = recv.mcasttype isa MNullableType or recv.mcasttype isa MNullType
1268 self.add("if (unlikely({recv} == NULL)) \{")
1269 self.add_abort("Receiver is null")
1276 private var names = new HashSet[String]
1277 private var last: Int = 0
1279 # Return a new name based on `s
` and unique in the visitor
1280 fun get_name(s: String): String
1282 if not self.names.has(s) then
1286 var i = self.last + 1
1289 if not self.names.has(s2) then
1298 # Return an unique and stable identifier associated with an escapemark
1299 fun escapemark_name(e: nullable EscapeMark): String
1302 if frame.escapemark_names.has_key(e) then return frame.escapemark_names[e]
1304 if name == null then name = "label"
1305 name = get_name(name)
1306 frame.escapemark_names[e] = name
1310 # Insert a C label for associated with an escapemark
1311 fun add_escape_label(e: nullable EscapeMark)
1313 if e == null then return
1314 if e.escapes.is_empty then return
1315 add("BREAK_{escapemark_name(e)}: (void)0;")
1318 # Return a "const char*" variable associated to the classname of the dynamic type of an object
1319 # NOTE: we do not return a `RuntimeVariable` "NativeString" as the class may not exist in the module/program
1320 fun class_name_string(value: RuntimeVariable): String is abstract
1322 # Variables handling
1324 protected var variables = new HashMap[Variable, RuntimeVariable]
1326 # Return the local runtime_variable associated to a Nit local variable
1327 fun variable(variable: Variable): RuntimeVariable
1329 if self.variables.has_key(variable) then
1330 return self.variables[variable]
1332 var name = self.get_name("var_{variable.name}")
1333 var mtype = variable.declared_type.as(not null)
1334 mtype = self.anchor(mtype)
1335 var res = new RuntimeVariable(name, mtype, mtype)
1336 self.add_decl("{mtype.ctype} {name} /* var {variable}: {mtype} */;")
1337 self.variables[variable] = res
1342 # Return a new uninitialized local runtime_variable
1343 fun new_var(mtype: MType): RuntimeVariable
1345 mtype = self.anchor(mtype)
1346 var name = self.get_name("var")
1347 var res = new RuntimeVariable(name, mtype, mtype)
1348 self.add_decl("{mtype.ctype} {name} /* : {mtype} */;")
1352 # The difference with `new_var
` is the C static type of the local variable
1353 fun new_var_extern(mtype: MType): RuntimeVariable
1355 mtype = self.anchor(mtype)
1356 var name = self.get_name("var")
1357 var res = new RuntimeVariable(name, mtype, mtype)
1358 self.add_decl("{mtype.ctype_extern} {name} /* : {mtype} for extern */;")
1362 # Return a new uninitialized named runtime_variable
1363 fun new_named_var(mtype: MType, name: String): RuntimeVariable
1365 mtype = self.anchor(mtype)
1366 var res = new RuntimeVariable(name, mtype, mtype)
1367 self.add_decl("{mtype.ctype} {name} /* : {mtype} */;")
1371 # Correctly assign a left and a right value
1372 # Boxing and unboxing is performed if required
1373 fun assign(left, right: RuntimeVariable)
1375 right = self.autobox(right, left.mtype)
1376 self.add("{left} = {right};")
1379 # Generate instances
1381 # Generate a alloc-instance + init-attributes
1382 fun init_instance(mtype: MClassType): RuntimeVariable is abstract
1384 # Set a GC finalizer on `recv
`, only if `recv
` isa Finalizable
1385 fun set_finalizer(recv: RuntimeVariable)
1387 var mtype = recv.mtype
1388 var finalizable_type = compiler.mainmodule.finalizable_type
1389 if finalizable_type != null and not mtype.need_anchor and
1390 mtype.is_subtype(compiler.mainmodule, null, finalizable_type) then
1391 add "gc_register_finalizer({recv});"
1395 # Generate an integer value
1396 fun int_instance(value: Int): RuntimeVariable
1398 var res = self.new_var(self.get_class("Int").mclass_type)
1399 self.add("{res} = {value};")
1403 # Generate an integer value
1404 fun bool_instance(value: Bool): RuntimeVariable
1406 var res = self.new_var(self.get_class("Bool").mclass_type)
1408 self.add("{res} = 1;")
1410 self.add("{res} = 0;")
1415 # Generate a string value
1416 fun string_instance(string: String): RuntimeVariable
1418 var mtype = self.get_class("String").mclass_type
1419 var name = self.get_name("varonce")
1420 self.add_decl("static {mtype.ctype} {name};")
1421 var res = self.new_var(mtype)
1422 self.add("if ({name}) \{")
1423 self.add("{res} = {name};")
1424 self.add("\} else \{")
1425 var native_mtype = self.get_class("NativeString").mclass_type
1426 var nat = self.new_var(native_mtype)
1427 self.add("{nat} = \"{string.escape_to_c}\";")
1428 var length = self.int_instance(string.length)
1429 self.add("{res} = {self.send(self.get_property("to_s_with_length", native_mtype), [nat, length]).as(not null)};")
1430 self.add("{name} = {res};")
1435 fun value_instance(object: Object): RuntimeVariable
1437 if object isa Int then
1438 return int_instance(object)
1439 else if object isa Bool then
1440 return bool_instance(object)
1441 else if object isa String then
1442 return string_instance(object)
1448 # Generate an array value
1449 fun array_instance(array: Array[RuntimeVariable], elttype: MType): RuntimeVariable is abstract
1451 # Get an instance of a array for a vararg
1452 fun vararg_instance(mpropdef: MPropDef, recv: RuntimeVariable, varargs: Array[RuntimeVariable], elttype: MType): RuntimeVariable is abstract
1456 # Add a line in the main part of the generated C
1457 fun add(s: String) do self.writer.lines.add(s)
1460 # (used for local or global declaration)
1461 fun add_decl(s: String) do self.writer.decl_lines.add(s)
1463 # Request the presence of a global declaration
1464 fun require_declaration(key: String)
1466 var reqs = self.writer.file.required_declarations
1467 if reqs.has(key) then return
1469 var node = current_node
1470 if node != null then compiler.requirers_of_declarations[key] = node
1473 # Add a declaration in the local-header
1474 # The declaration is ensured to be present once
1475 fun declare_once(s: String)
1477 self.compiler.provide_declaration(s, s)
1478 self.require_declaration(s)
1481 # Look for a needed .h and .c file for a given module
1482 # This is used for the legacy FFI
1483 fun add_extern(mmodule: MModule)
1485 var file = mmodule.location.file.filename
1486 file = file.strip_extension(".nit")
1487 var tryfile = file + ".nit.h"
1488 if tryfile.file_exists then
1489 self.declare_once("#include \"{tryfile.basename("")}\"")
1490 self.compiler.files_to_copy.add(tryfile)
1492 tryfile = file + "_nit.h"
1493 if tryfile.file_exists then
1494 self.declare_once("#include \"{tryfile.basename("")}\"")
1495 self.compiler.files_to_copy.add(tryfile)
1498 if self.compiler.seen_extern.has(file) then return
1499 self.compiler.seen_extern.add(file)
1500 tryfile = file + ".nit.c"
1501 if not tryfile.file_exists then
1502 tryfile = file + "_nit.c"
1503 if not tryfile.file_exists then return
1505 var f = new ExternCFile(tryfile.basename(""), "")
1506 self.compiler.extern_bodies.add(f)
1507 self.compiler.files_to_copy.add(tryfile)
1510 # Return a new local runtime_variable initialized with the C expression `cexpr
`.
1511 fun new_expr(cexpr: String, mtype: MType): RuntimeVariable
1513 var res = new_var(mtype)
1514 self.add("{res} = {cexpr};")
1518 # Generate generic abort
1519 # used by aborts, asserts, casts, etc.
1520 fun add_abort(message: String)
1522 self.add("PRINT_ERROR(\"Runtime error: %s\", \"{message.escape_to_c}\");")
1528 if self.current_node != null and self.current_node.location.file != null then
1529 self.add("PRINT_ERROR(\" (%s:%d)\\n\", \"{self.current_node.location.file.filename.escape_to_c}\", {current_node.location.line_start});")
1531 self.add("PRINT_ERROR(\"\\n\");")
1533 self.add("show_backtrace(1);")
1536 # Add a dynamic cast
1537 fun add_cast(value: RuntimeVariable, mtype: MType, tag: String)
1539 var res = self.type_test(value, mtype, tag)
1540 self.add("if (unlikely(!{res})) \{")
1541 var cn = self.class_name_string(value)
1542 self.add("PRINT_ERROR(\"Runtime error: Cast failed. Expected `%s
`, got `%s
`\", \"{mtype.to_s.escape_to_c}\", {cn});")
1547 # Generate a return with the value `s
`
1548 fun ret(s: RuntimeVariable)
1550 self.assign(self.frame.returnvar.as(not null), s)
1551 self.add("goto {self.frame.returnlabel.as(not null)};")
1554 # Compile a statement (if any)
1555 fun stmt(nexpr: nullable AExpr)
1557 if nexpr == null then return
1559 var narray = nexpr.comprehension
1560 if narray != null then
1561 var recv = frame.comprehension.as(not null)
1562 var val = expr(nexpr, narray.element_mtype)
1563 compile_callsite(narray.push_callsite.as(not null), [recv, val])
1567 var old = self.current_node
1568 self.current_node = nexpr
1570 self.current_node = old
1573 # Compile an expression an return its result
1574 # `mtype
` is the expected return type, pass null if no specific type is expected.
1575 fun expr(nexpr: AExpr, mtype: nullable MType): RuntimeVariable
1577 var old = self.current_node
1578 self.current_node = nexpr
1579 var res = nexpr.expr(self).as(not null)
1580 if mtype != null then
1581 mtype = self.anchor(mtype)
1582 res = self.autobox(res, mtype)
1584 res = autoadapt(res, nexpr.mtype.as(not null))
1585 var implicit_cast_to = nexpr.implicit_cast_to
1586 if implicit_cast_to != null and not self.compiler.modelbuilder.toolcontext.opt_no_check_autocast.value then
1587 add_cast(res, implicit_cast_to, "auto")
1588 res = autoadapt(res, implicit_cast_to)
1590 self.current_node = old
1594 # Alias for `self.expr
(nexpr
, self.bool_type
)`
1595 fun expr_bool(nexpr: AExpr): RuntimeVariable do return expr(nexpr, bool_type)
1597 # Safely show a debug message on the current node and repeat the message in the C code as a comment
1598 fun debug(message: String)
1600 var node = self.current_node
1601 if node == null then
1602 print "?: {message}"
1606 self.add("/* DEBUG: {message} */")
1610 # A C function associated to a Nit method
1611 # Because of customization, a given Nit method can be compiler more that once
1612 abstract class AbstractRuntimeFunction
1614 type COMPILER: AbstractCompiler
1615 type VISITOR: AbstractCompilerVisitor
1617 # The associated Nit method
1618 var mmethoddef: MMethodDef
1620 # The mangled c name of the runtime_function
1621 # Subclasses should redefine `build_c_name
` instead
1624 var res = self.c_name_cache
1625 if res != null then return res
1626 res = self.build_c_name
1627 self.c_name_cache = res
1631 # Non cached version of `c_name
`
1632 protected fun build_c_name: String is abstract
1634 protected var c_name_cache: nullable String = null is writable
1636 # Implements a call of the runtime_function
1637 # May inline the body or generate a C function call
1638 fun call(v: VISITOR, arguments: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1640 # Generate the code for the `AbstractRuntimeFunction`
1641 # Warning: compile more than once compilation makes CC unhappy
1642 fun compile_to_c(compiler: COMPILER) is abstract
1645 # A runtime variable hold a runtime value in C.
1646 # Runtime variables are associated to Nit local variables and intermediate results in Nit expressions.
1648 # 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.
1649 class RuntimeVariable
1650 # The name of the variable in the C code
1653 # The static type of the variable (as declard in C)
1656 # The current casted type of the variable (as known in Nit)
1657 var mcasttype: MType is writable
1659 # If the variable exaclty a mcasttype?
1660 # false (usual value) means that the variable is a mcasttype or a subtype.
1661 var is_exact: Bool = false is writable
1665 assert not mtype.need_anchor
1666 assert not mcasttype.need_anchor
1669 redef fun to_s do return name
1674 if self.is_exact then
1675 exact_str = " exact"
1680 if self.mtype == self.mcasttype then
1681 type_str = "{mtype}{exact_str}"
1683 type_str = "{mtype}({mcasttype}{exact_str})"
1685 return "<{name}:{type_str}>"
1689 # The static context of a visited property in a `AbstractCompilerVisitor`
1692 type VISITOR: AbstractCompilerVisitor
1694 # The associated visitor
1695 var visitor: VISITOR
1697 # The executed property.
1698 # A Method in case of a call, an attribute in case of a default initialization.
1699 var mpropdef: MPropDef
1701 # The static type of the receiver
1702 var receiver: MClassType
1704 # Arguments of the method (the first is the receiver)
1705 var arguments: Array[RuntimeVariable]
1707 # The runtime_variable associated to the return (in a function)
1708 var returnvar: nullable RuntimeVariable = null is writable
1710 # The label at the end of the property
1711 var returnlabel: nullable String = null is writable
1713 # Labels associated to a each escapemarks.
1714 # Because of inlinings, escape-marks must be associated to their context (the frame)
1715 private var escapemark_names = new HashMap[EscapeMark, String]
1717 # The array comprehension currently filled, if any
1718 private var comprehension: nullable RuntimeVariable = null
1722 # Return the C type associated to a given Nit static type
1723 fun ctype: String do return "val*"
1725 # C type outside of the compiler code and in boxes
1726 fun ctype_extern: String do return "val*"
1728 # Short name of the `ctype
` to use in unions
1729 fun ctypename: String do return "val"
1732 redef class MClassType
1734 redef fun ctype: String
1736 if mclass.name == "Int" then
1738 else if mclass.name == "Bool" then
1740 else if mclass.name == "Char" then
1742 else if mclass.name == "Float" then
1744 else if mclass.name == "NativeString" then
1746 else if mclass.name == "NativeArray" then
1753 redef fun ctype_extern: String
1755 if mclass.kind == extern_kind then
1762 redef fun ctypename: String
1764 if mclass.name == "Int" then
1766 else if mclass.name == "Bool" then
1768 else if mclass.name == "Char" then
1770 else if mclass.name == "Float" then
1772 else if mclass.name == "NativeString" then
1774 else if mclass.name == "NativeArray" then
1775 #return "{self.arguments.first.ctype}*"
1783 redef class MPropDef
1784 type VISITOR: AbstractCompilerVisitor
1787 redef class MMethodDef
1788 # Can the body be inlined?
1789 fun can_inline(v: VISITOR): Bool
1791 if is_abstract then return true
1792 var modelbuilder = v.compiler.modelbuilder
1793 var node = modelbuilder.mpropdef2node(self)
1794 if node isa APropdef then
1795 return node.can_inline
1796 else if node isa AClassdef then
1797 # Automatic free init is always inlined since it is empty or contains only attribtes assigments
1804 # Inline the body in another visitor
1805 fun compile_inside_to_c(v: VISITOR, arguments: Array[RuntimeVariable]): nullable RuntimeVariable
1807 var modelbuilder = v.compiler.modelbuilder
1808 var val = constant_value
1809 var node = modelbuilder.mpropdef2node(self)
1810 if node isa APropdef then
1811 var oldnode = v.current_node
1812 v.current_node = node
1813 self.compile_parameter_check(v, arguments)
1814 node.compile_to_c(v, self, arguments)
1815 v.current_node = oldnode
1816 else if node isa AClassdef then
1817 var oldnode = v.current_node
1818 v.current_node = node
1819 self.compile_parameter_check(v, arguments)
1820 node.compile_to_c(v, self, arguments)
1821 v.current_node = oldnode
1822 else if val != null then
1823 v.ret(v.value_instance(val))
1830 # Generate type checks in the C code to check covariant parameters
1831 fun compile_parameter_check(v: VISITOR, arguments: Array[RuntimeVariable])
1833 if v.compiler.modelbuilder.toolcontext.opt_no_check_covariance.value then return
1835 for i in [0..msignature.arity[ do
1836 # skip test for vararg since the array is instantiated with the correct polymorphic type
1837 if msignature.vararg_rank == i then continue
1839 # skip if the cast is not required
1840 var origmtype = self.mproperty.intro.msignature.mparameters[i].mtype
1841 if not origmtype.need_anchor then continue
1843 # get the parameter type
1844 var mtype = self.msignature.mparameters[i].mtype
1847 # note that v decides if and how to implements the cast
1848 v.add("/* Covariant cast for argument {i} ({self.msignature.mparameters[i].name}) {arguments[i+1].inspect} isa {mtype} */")
1849 v.add_cast(arguments[i+1], mtype, "covariance")
1856 redef class APropdef
1857 fun compile_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
1859 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name} {mpropdef} at {location.to_s}\\n\");")
1860 debug("Not yet implemented")
1863 fun can_inline: Bool do return true
1866 redef class AMethPropdef
1867 redef fun compile_to_c(v, mpropdef, arguments)
1869 if mpropdef.is_abstract then
1870 var cn = v.class_name_string(arguments.first)
1871 v.add("PRINT_ERROR(\"Runtime error: Abstract method `%s
` called on `%s
`\", \"{mpropdef.mproperty.name.escape_to_c}\", {cn});")
1876 # Call the implicit super-init
1877 var auto_super_inits = self.auto_super_inits
1878 if auto_super_inits != null then
1879 var args = [arguments.first]
1880 for auto_super_init in auto_super_inits do
1881 assert auto_super_init.mproperty != mpropdef.mproperty
1883 for i in [0..auto_super_init.msignature.arity+1[ do
1884 args.add(arguments[i])
1886 assert auto_super_init.mproperty != mpropdef.mproperty
1887 v.compile_callsite(auto_super_init, args)
1890 if auto_super_call then
1891 v.supercall(mpropdef, arguments.first.mtype.as(MClassType), arguments)
1894 # Try special compilation
1895 if mpropdef.is_intern then
1896 if compile_intern_to_c(v, mpropdef, arguments) then return
1897 else if mpropdef.is_extern then
1898 if mpropdef.mproperty.is_init then
1899 if compile_externinit_to_c(v, mpropdef, arguments) then return
1901 if compile_externmeth_to_c(v, mpropdef, arguments) then return
1905 # Compile block if any
1906 var n_block = n_block
1907 if n_block != null then
1908 for i in [0..mpropdef.msignature.arity[ do
1909 var variable = self.n_signature.n_params[i].variable.as(not null)
1910 v.assign(v.variable(variable), arguments[i+1])
1917 var cn = v.class_name_string(arguments.first)
1918 v.add("PRINT_ERROR(\"Runtime error: uncompiled method `%s
` called on `%s
`. NOT YET IMPLEMENTED\", \"{mpropdef.mproperty.name.escape_to_c}\", {cn});")
1922 redef fun can_inline
1924 if self.auto_super_inits != null then return false
1925 var nblock = self.n_block
1926 if nblock == null then return true
1927 if (mpropdef.mproperty.name == "==" or mpropdef.mproperty.name == "!=") and mpropdef.mclassdef.mclass.name == "Object" then return true
1928 if nblock isa ABlockExpr and nblock.n_expr.length == 0 then return true
1932 fun compile_intern_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable]): Bool
1934 var pname = mpropdef.mproperty.name
1935 var cname = mpropdef.mclassdef.mclass.name
1936 var ret = mpropdef.msignature.return_mtype
1938 ret = v.resolve_for(ret, arguments.first)
1940 if pname != "==" and pname != "!=" then
1941 v.adapt_signature(mpropdef, arguments)
1942 v.unbox_signature_extern(mpropdef, arguments)
1944 if cname == "Int" then
1945 if pname == "output" then
1946 v.add("printf(\"%ld\\n\", {arguments.first});")
1948 else if pname == "object_id" then
1949 v.ret(arguments.first)
1951 else if pname == "+" then
1952 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
1954 else if pname == "-" then
1955 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
1957 else if pname == "unary -" then
1958 v.ret(v.new_expr("-{arguments[0]}", ret.as(not null)))
1960 else if pname == "*" then
1961 v.ret(v.new_expr("{arguments[0]} * {arguments[1]}", ret.as(not null)))
1963 else if pname == "/" then
1964 v.ret(v.new_expr("{arguments[0]} / {arguments[1]}", ret.as(not null)))
1966 else if pname == "%" then
1967 v.ret(v.new_expr("{arguments[0]} % {arguments[1]}", ret.as(not null)))
1969 else if pname == "lshift" then
1970 v.ret(v.new_expr("{arguments[0]} << {arguments[1]}", ret.as(not null)))
1972 else if pname == "rshift" then
1973 v.ret(v.new_expr("{arguments[0]} >> {arguments[1]}", ret.as(not null)))
1975 else if pname == "==" then
1976 v.ret(v.equal_test(arguments[0], arguments[1]))
1978 else if pname == "!=" then
1979 var res = v.equal_test(arguments[0], arguments[1])
1980 v.ret(v.new_expr("!{res}", ret.as(not null)))
1982 else if pname == "<" then
1983 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
1985 else if pname == ">" then
1986 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
1988 else if pname == "<=" then
1989 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
1991 else if pname == ">=" then
1992 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
1994 else if pname == "to_f" then
1995 v.ret(v.new_expr("(double){arguments[0]}", ret.as(not null)))
1997 else if pname == "ascii" then
1998 v.ret(v.new_expr("{arguments[0]}", ret.as(not null)))
2001 else if cname == "Char" then
2002 if pname == "output" then
2003 v.add("printf(\"%c\", {arguments.first});")
2005 else if pname == "object_id" then
2006 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
2008 else if pname == "successor" then
2009 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
2011 else if pname == "predecessor" then
2012 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
2014 else if pname == "==" then
2015 v.ret(v.equal_test(arguments[0], arguments[1]))
2017 else if pname == "!=" then
2018 var res = v.equal_test(arguments[0], arguments[1])
2019 v.ret(v.new_expr("!{res}", ret.as(not null)))
2021 else if pname == "<" then
2022 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
2024 else if pname == ">" then
2025 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
2027 else if pname == "<=" then
2028 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
2030 else if pname == ">=" then
2031 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
2033 else if pname == "to_i" then
2034 v.ret(v.new_expr("{arguments[0]}-'0'", ret.as(not null)))
2036 else if pname == "ascii" then
2037 v.ret(v.new_expr("(unsigned char){arguments[0]}", ret.as(not null)))
2040 else if cname == "Bool" then
2041 if pname == "output" then
2042 v.add("printf({arguments.first}?\"true\\n\":\"false\\n\");")
2044 else if pname == "object_id" then
2045 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
2047 else if pname == "==" then
2048 v.ret(v.equal_test(arguments[0], arguments[1]))
2050 else if pname == "!=" then
2051 var res = v.equal_test(arguments[0], arguments[1])
2052 v.ret(v.new_expr("!{res}", ret.as(not null)))
2055 else if cname == "Float" then
2056 if pname == "output" then
2057 v.add("printf(\"%f\\n\", {arguments.first});")
2059 else if pname == "object_id" then
2060 v.ret(v.new_expr("(double){arguments.first}", ret.as(not null)))
2062 else if pname == "+" then
2063 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
2065 else if pname == "-" then
2066 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
2068 else if pname == "unary -" then
2069 v.ret(v.new_expr("-{arguments[0]}", ret.as(not null)))
2071 else if pname == "succ" then
2072 v.ret(v.new_expr("{arguments[0]}+1", ret.as(not null)))
2074 else if pname == "prec" then
2075 v.ret(v.new_expr("{arguments[0]}-1", ret.as(not null)))
2077 else if pname == "*" then
2078 v.ret(v.new_expr("{arguments[0]} * {arguments[1]}", ret.as(not null)))
2080 else if pname == "/" then
2081 v.ret(v.new_expr("{arguments[0]} / {arguments[1]}", ret.as(not null)))
2083 else if pname == "==" then
2084 v.ret(v.equal_test(arguments[0], arguments[1]))
2086 else if pname == "!=" then
2087 var res = v.equal_test(arguments[0], arguments[1])
2088 v.ret(v.new_expr("!{res}", ret.as(not null)))
2090 else if pname == "<" then
2091 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
2093 else if pname == ">" then
2094 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
2096 else if pname == "<=" then
2097 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
2099 else if pname == ">=" then
2100 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
2102 else if pname == "to_i" then
2103 v.ret(v.new_expr("(long){arguments[0]}", ret.as(not null)))
2106 else if cname == "NativeString" then
2107 if pname == "[]" then
2108 v.ret(v.new_expr("{arguments[0]}[{arguments[1]}]", ret.as(not null)))
2110 else if pname == "[]=" then
2111 v.add("{arguments[0]}[{arguments[1]}]={arguments[2]};")
2113 else if pname == "copy_to" then
2114 v.add("memmove({arguments[1]}+{arguments[4]},{arguments[0]}+{arguments[3]},{arguments[2]});")
2116 else if pname == "atoi" then
2117 v.ret(v.new_expr("atoi({arguments[0]});", ret.as(not null)))
2119 else if pname == "new" then
2120 v.ret(v.new_expr("(char*)nit_alloc({arguments[1]})", ret.as(not null)))
2123 else if cname == "NativeArray" then
2124 v.native_array_def(pname, ret, arguments)
2127 if pname == "exit" then
2128 v.add("exit({arguments[1]});")
2130 else if pname == "sys" then
2131 v.ret(v.new_expr("glob_sys", ret.as(not null)))
2133 else if pname == "calloc_string" then
2134 v.ret(v.new_expr("(char*)nit_alloc({arguments[1]})", ret.as(not null)))
2136 else if pname == "calloc_array" then
2137 v.calloc_array(ret.as(not null), arguments)
2139 else if pname == "object_id" then
2140 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
2142 else if pname == "is_same_type" then
2143 v.ret(v.is_same_type_test(arguments[0], arguments[1]))
2145 else if pname == "is_same_instance" then
2146 v.ret(v.equal_test(arguments[0], arguments[1]))
2148 else if pname == "output_class_name" then
2149 var nat = v.class_name_string(arguments.first)
2150 v.add("printf(\"%s\\n\", {nat});")
2152 else if pname == "native_class_name" then
2153 var nat = v.class_name_string(arguments.first)
2154 v.ret(v.new_expr("(char*){nat}", ret.as(not null)))
2156 else if pname == "force_garbage_collection" then
2157 v.add("nit_gcollect();")
2159 else if pname == "native_argc" then
2160 v.ret(v.new_expr("glob_argc", ret.as(not null)))
2162 else if pname == "native_argv" then
2163 v.ret(v.new_expr("glob_argv[{arguments[1]}]", ret.as(not null)))
2169 # Compile an extern method
2170 # Return `true` if the compilation was successful, `false` if a fall-back is needed
2171 fun compile_externmeth_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable]): Bool
2174 var at = self.get_single_annotation("extern", v.compiler.modelbuilder)
2175 if at != null and at.n_args.length == 1 then
2176 externname = at.arg_as_string(v.compiler.modelbuilder)
2177 if externname == null then return false
2181 v.add_extern(mpropdef.mclassdef.mmodule)
2182 var res: nullable RuntimeVariable = null
2183 var ret = mpropdef.msignature.return_mtype
2185 ret = v.resolve_for(ret, arguments.first)
2186 res = v.new_var_extern(ret)
2188 v.adapt_signature(mpropdef, arguments)
2189 v.unbox_signature_extern(mpropdef, arguments)
2192 v.add("{externname}({arguments.join(", ")});")
2194 v.add("{res} = {externname}({arguments.join(", ")});")
2195 res = v.box_extern(res, ret.as(not null))
2201 # Compile an extern factory
2202 # Return `true` if the compilation was successful, `false` if a fall-back is needed
2203 fun compile_externinit_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable]): Bool
2206 var at = self.get_single_annotation("extern", v.compiler.modelbuilder)
2208 externname = at.arg_as_string(v.compiler.modelbuilder)
2209 if externname == null then return false
2213 v.add_extern(mpropdef.mclassdef.mmodule)
2214 v.adapt_signature(mpropdef, arguments)
2215 v.unbox_signature_extern(mpropdef, arguments)
2216 var ret = arguments.first.mtype
2217 var res = v.new_var_extern(ret)
2221 v.add("{res} = {externname}({arguments.join(", ")});")
2222 res = v.box_extern(res, ret)
2228 redef class AAttrPropdef
2229 redef fun can_inline: Bool do return not is_lazy
2231 redef fun compile_to_c(v, mpropdef, arguments)
2233 if mpropdef == mreadpropdef then
2234 assert arguments.length == 1
2235 var recv = arguments.first
2239 var ret = self.mpropdef.static_mtype
2240 var useiset = ret.ctype == "val*" and not ret isa MNullableType
2241 var guard = self.mlazypropdef.mproperty
2243 set = v.isset_attribute(self.mpropdef.mproperty, recv)
2245 set = v.read_attribute(guard, recv)
2247 v.add("if(likely({set})) \{")
2248 res = v.read_attribute(self.mpropdef.mproperty, recv)
2251 var value = evaluate_expr(v, recv)
2253 v.assign(res, value)
2255 var true_v = v.new_expr("1", v.bool_type)
2256 v.write_attribute(guard, arguments.first, true_v)
2260 res = v.read_attribute(self.mpropdef.mproperty, arguments.first)
2262 v.assign(v.frame.returnvar.as(not null), res)
2263 else if mpropdef == mwritepropdef then
2264 assert arguments.length == 2
2265 v.write_attribute(self.mpropdef.mproperty, arguments.first, arguments[1])
2267 var ret = self.mpropdef.static_mtype
2268 var useiset = ret.ctype == "val*" and not ret isa MNullableType
2270 v.write_attribute(self.mlazypropdef.mproperty, arguments.first, v.new_expr("1", v.bool_type))
2278 fun init_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable)
2280 if has_value and not is_lazy then evaluate_expr(v, recv)
2283 # Evaluate, store and return the default value of the attribute
2284 private fun evaluate_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable): RuntimeVariable
2286 var oldnode = v.current_node
2287 v.current_node = self
2288 var old_frame = v.frame
2289 var frame = new StaticFrame(v, self.mpropdef.as(not null), recv.mcasttype.as_notnullable.as(MClassType), [recv])
2293 var mtype = self.mpropdef.static_mtype
2294 assert mtype != null
2296 var nexpr = self.n_expr
2297 var nblock = self.n_block
2298 if nexpr != null then
2299 value = v.expr(nexpr, mtype)
2300 else if nblock != null then
2301 value = v.new_var(mtype)
2302 frame.returnvar = value
2303 frame.returnlabel = v.get_name("RET_LABEL")
2306 v.add("{frame.returnlabel.as(not null)}:(void)0;")
2312 v.write_attribute(self.mpropdef.mproperty, recv, value)
2315 v.current_node = oldnode
2320 fun check_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable)
2322 var nexpr = self.n_expr
2323 if nexpr != null then return
2325 var oldnode = v.current_node
2326 v.current_node = self
2327 var old_frame = v.frame
2328 var frame = new StaticFrame(v, self.mpropdef.as(not null), recv.mtype.as(MClassType), [recv])
2330 # Force read to check the initialization
2331 v.read_attribute(self.mpropdef.mproperty, recv)
2333 v.current_node = oldnode
2337 redef class AClassdef
2338 private fun compile_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
2340 if mpropdef == self.mfree_init then
2341 assert mpropdef.mproperty.is_root_init
2342 assert arguments.length == 1
2343 if not mpropdef.is_intro then
2344 v.supercall(mpropdef, arguments.first.mtype.as(MClassType), arguments)
2354 # Try to compile self as an expression
2355 # Do not call this method directly, use `v
.expr
` instead
2356 private fun expr(v: AbstractCompilerVisitor): nullable RuntimeVariable
2358 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name}:{location.to_s}\\n\");")
2359 var mtype = self.mtype
2360 if mtype == null then
2363 var res = v.new_var(mtype)
2364 v.add("/* {res} = NOT YET {class_name} */")
2369 # Try to compile self as a statement
2370 # Do not call this method directly, use `v
.stmt
` instead
2371 private fun stmt(v: AbstractCompilerVisitor)
2377 redef class ABlockExpr
2380 for e in self.n_expr do v.stmt(e)
2384 var last = self.n_expr.last
2385 for e in self.n_expr do
2386 if e == last then break
2389 return v.expr(last, null)
2393 redef class AVardeclExpr
2396 var variable = self.variable.as(not null)
2397 var ne = self.n_expr
2399 var i = v.expr(ne, variable.declared_type)
2400 v.assign(v.variable(variable), i)
2405 redef class AVarExpr
2408 var res = v.variable(self.variable.as(not null))
2409 var mtype = self.mtype.as(not null)
2410 return v.autoadapt(res, mtype)
2414 redef class AVarAssignExpr
2417 var variable = self.variable.as(not null)
2418 var i = v.expr(self.n_value, variable.declared_type)
2419 v.assign(v.variable(variable), i)
2424 redef class AVarReassignExpr
2427 var variable = self.variable.as(not null)
2428 var vari = v.variable(variable)
2429 var value = v.expr(self.n_value, variable.declared_type)
2430 var res = v.compile_callsite(self.reassign_callsite.as(not null), [vari, value])
2432 v.assign(v.variable(variable), res)
2436 redef class ASelfExpr
2437 redef fun expr(v) do return v.frame.arguments.first
2440 redef class AEscapeExpr
2441 redef fun stmt(v) do v.add("goto BREAK_{v.escapemark_name(self.escapemark)};")
2444 redef class AReturnExpr
2447 var nexpr = self.n_expr
2448 if nexpr != null then
2449 var returnvar = v.frame.returnvar.as(not null)
2450 var i = v.expr(nexpr, returnvar.mtype)
2451 v.assign(returnvar, i)
2453 v.add("goto {v.frame.returnlabel.as(not null)};")
2457 redef class AAbortExpr
2458 redef fun stmt(v) do v.add_abort("Aborted")
2464 var cond = v.expr_bool(self.n_expr)
2465 v.add("if ({cond})\{")
2474 var res = v.new_var(self.mtype.as(not null))
2475 var cond = v.expr_bool(self.n_expr)
2476 v.add("if ({cond})\{")
2477 v.assign(res, v.expr(self.n_then.as(not null), null))
2479 v.assign(res, v.expr(self.n_else.as(not null), null))
2485 redef class AIfexprExpr
2488 var res = v.new_var(self.mtype.as(not null))
2489 var cond = v.expr_bool(self.n_expr)
2490 v.add("if ({cond})\{")
2491 v.assign(res, v.expr(self.n_then, null))
2493 v.assign(res, v.expr(self.n_else, null))
2502 v.stmt(self.n_block)
2503 v.add_escape_label(break_mark)
2507 redef class AWhileExpr
2511 var cond = v.expr_bool(self.n_expr)
2512 v.add("if (!{cond}) break;")
2513 v.stmt(self.n_block)
2514 v.add_escape_label(continue_mark)
2516 v.add_escape_label(break_mark)
2520 redef class ALoopExpr
2524 v.stmt(self.n_block)
2525 v.add_escape_label(continue_mark)
2527 v.add_escape_label(break_mark)
2531 redef class AForExpr
2534 var cl = v.expr(self.n_expr, null)
2535 var it_meth = self.method_iterator
2536 assert it_meth != null
2537 var it = v.compile_callsite(it_meth, [cl])
2540 var isok_meth = self.method_is_ok
2541 assert isok_meth != null
2542 var ok = v.compile_callsite(isok_meth, [it])
2544 v.add("if(!{ok}) break;")
2545 if self.variables.length == 1 then
2546 var item_meth = self.method_item
2547 assert item_meth != null
2548 var i = v.compile_callsite(item_meth, [it])
2550 v.assign(v.variable(variables.first), i)
2551 else if self.variables.length == 2 then
2552 var key_meth = self.method_key
2553 assert key_meth != null
2554 var i = v.compile_callsite(key_meth, [it])
2556 v.assign(v.variable(variables[0]), i)
2557 var item_meth = self.method_item
2558 assert item_meth != null
2559 i = v.compile_callsite(item_meth, [it])
2561 v.assign(v.variable(variables[1]), i)
2565 v.stmt(self.n_block)
2566 v.add_escape_label(continue_mark)
2567 var next_meth = self.method_next
2568 assert next_meth != null
2569 v.compile_callsite(next_meth, [it])
2571 v.add_escape_label(break_mark)
2573 var method_finish = self.method_finish
2574 if method_finish != null then
2575 # TODO: Find a way to call this also in long escape (e.g. return)
2576 v.compile_callsite(method_finish, [it])
2581 redef class AAssertExpr
2584 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return
2586 var cond = v.expr_bool(self.n_expr)
2587 v.add("if (unlikely(!{cond})) \{")
2591 v.add_abort("Assert '{nid.text}' failed")
2593 v.add_abort("Assert failed")
2602 var res = v.new_var(self.mtype.as(not null))
2603 var i1 = v.expr_bool(self.n_expr)
2604 v.add("if ({i1}) \{")
2607 var i2 = v.expr_bool(self.n_expr2)
2608 v.add("{res} = {i2};")
2614 redef class AImpliesExpr
2617 var res = v.new_var(self.mtype.as(not null))
2618 var i1 = v.expr_bool(self.n_expr)
2619 v.add("if (!{i1}) \{")
2622 var i2 = v.expr_bool(self.n_expr2)
2623 v.add("{res} = {i2};")
2629 redef class AAndExpr
2632 var res = v.new_var(self.mtype.as(not null))
2633 var i1 = v.expr_bool(self.n_expr)
2634 v.add("if (!{i1}) \{")
2637 var i2 = v.expr_bool(self.n_expr2)
2638 v.add("{res} = {i2};")
2644 redef class ANotExpr
2647 var cond = v.expr_bool(self.n_expr)
2648 return v.new_expr("!{cond}", self.mtype.as(not null))
2652 redef class AOrElseExpr
2655 var res = v.new_var(self.mtype.as(not null))
2656 var i1 = v.expr(self.n_expr, null)
2657 v.add("if ({i1}!=NULL) \{")
2660 var i2 = v.expr(self.n_expr2, null)
2667 redef class AIntExpr
2668 redef fun expr(v) do return v.new_expr("{self.value.to_s}", self.mtype.as(not null))
2671 redef class AFloatExpr
2672 redef fun expr(v) do return v.new_expr("{self.n_float.text}", self.mtype.as(not null)) # FIXME use value, not n_float
2675 redef class ACharExpr
2676 redef fun expr(v) do return v.new_expr("'{self.value.to_s.escape_to_c}'", self.mtype.as(not null))
2679 redef class AArrayExpr
2682 var mtype = self.element_mtype.as(not null)
2683 var array = new Array[RuntimeVariable]
2684 var res = v.array_instance(array, mtype)
2686 var old_comprehension = v.frame.comprehension
2687 v.frame.comprehension = res
2688 for nexpr in self.n_exprs do
2691 v.frame.comprehension = old_comprehension
2697 redef class AStringFormExpr
2698 redef fun expr(v) do return v.string_instance(self.value.as(not null))
2701 redef class ASuperstringExpr
2704 var array = new Array[RuntimeVariable]
2705 for ne in self.n_exprs do
2706 if ne isa AStringFormExpr and ne.value == "" then continue # skip empty sub-strings
2707 var i = v.expr(ne, null)
2710 var a = v.array_instance(array, v.object_type)
2711 var res = v.send(v.get_property("to_s", a.mtype), [a])
2716 redef class ACrangeExpr
2719 var i1 = v.expr(self.n_expr, null)
2720 var i2 = v.expr(self.n_expr2, null)
2721 var mtype = self.mtype.as(MClassType)
2722 var res = v.init_instance(mtype)
2723 v.compile_callsite(init_callsite.as(not null), [res, i1, i2])
2728 redef class AOrangeExpr
2731 var i1 = v.expr(self.n_expr, null)
2732 var i2 = v.expr(self.n_expr2, null)
2733 var mtype = self.mtype.as(MClassType)
2734 var res = v.init_instance(mtype)
2735 v.compile_callsite(init_callsite.as(not null), [res, i1, i2])
2740 redef class ATrueExpr
2741 redef fun expr(v) do return v.new_expr("1", self.mtype.as(not null))
2744 redef class AFalseExpr
2745 redef fun expr(v) do return v.new_expr("0", self.mtype.as(not null))
2748 redef class ANullExpr
2749 redef fun expr(v) do return v.new_expr("NULL", self.mtype.as(not null))
2752 redef class AIsaExpr
2755 var i = v.expr(self.n_expr, null)
2756 return v.type_test(i, self.cast_type.as(not null), "isa")
2760 redef class AAsCastExpr
2763 var i = v.expr(self.n_expr, null)
2764 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return i
2766 v.add_cast(i, self.mtype.as(not null), "as")
2771 redef class AAsNotnullExpr
2774 var i = v.expr(self.n_expr, null)
2775 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return i
2777 if i.mtype.ctype != "val*" then return i
2779 v.add("if (unlikely({i} == NULL)) \{")
2780 v.add_abort("Cast failed")
2786 redef class AParExpr
2787 redef fun expr(v) do return v.expr(self.n_expr, null)
2790 redef class AOnceExpr
2793 var mtype = self.mtype.as(not null)
2794 var name = v.get_name("varonce")
2795 var guard = v.get_name(name + "_guard")
2796 v.add_decl("static {mtype.ctype} {name};")
2797 v.add_decl("static int {guard};")
2798 var res = v.new_var(mtype)
2799 v.add("if ({guard}) \{")
2800 v.add("{res} = {name};")
2802 var i = v.expr(self.n_expr, mtype)
2803 v.add("{res} = {i};")
2804 v.add("{name} = {res};")
2805 v.add("{guard} = 1;")
2811 redef class ASendExpr
2814 var recv = v.expr(self.n_expr, null)
2815 var callsite = self.callsite.as(not null)
2816 var args = v.varargize(callsite.mpropdef, recv, self.raw_arguments)
2817 return v.compile_callsite(callsite, args)
2821 redef class ASendReassignFormExpr
2824 var recv = v.expr(self.n_expr, null)
2825 var callsite = self.callsite.as(not null)
2826 var args = v.varargize(callsite.mpropdef, recv, self.raw_arguments)
2828 var value = v.expr(self.n_value, null)
2830 var left = v.compile_callsite(callsite, args)
2833 var res = v.compile_callsite(self.reassign_callsite.as(not null), [left, value])
2837 v.compile_callsite(self.write_callsite.as(not null), args)
2841 redef class ASuperExpr
2844 var recv = v.frame.arguments.first
2846 var callsite = self.callsite
2847 if callsite != null then
2848 var args = v.varargize(callsite.mpropdef, recv, self.n_args.n_exprs)
2850 # Add additional arguments for the super init call
2851 if args.length == 1 then
2852 for i in [0..callsite.msignature.arity[ do
2853 args.add(v.frame.arguments[i+1])
2857 var res = v.compile_callsite(callsite, args)
2861 var mpropdef = self.mpropdef.as(not null)
2862 var args = v.varargize(mpropdef, recv, self.n_args.n_exprs)
2863 if args.length == 1 then
2864 args = v.frame.arguments
2867 # stantard call-next-method
2868 return v.supercall(mpropdef, recv.mtype.as(MClassType), args)
2872 redef class ANewExpr
2875 var mtype = self.recvtype
2876 assert mtype != null
2878 var ctype = mtype.ctype
2879 if mtype.mclass.name == "NativeArray" then
2880 assert self.n_args.n_exprs.length == 1
2881 var l = v.expr(self.n_args.n_exprs.first, null)
2882 assert mtype isa MGenericType
2883 var elttype = mtype.arguments.first
2884 return v.native_array_instance(elttype, l)
2885 else if ctype == "val*" then
2886 recv = v.init_instance(mtype)
2887 else if ctype == "char*" then
2888 recv = v.new_expr("NULL/*special!*/", mtype)
2890 recv = v.new_expr("({ctype})0/*special!*/", mtype)
2893 var callsite = self.callsite.as(not null)
2894 var args = v.varargize(callsite.mpropdef, recv, self.n_args.n_exprs)
2895 var res2 = v.compile_callsite(callsite, args)
2896 if res2 != null then
2897 #self.debug("got {res2} from {mproperty}. drop {recv}")
2904 redef class AAttrExpr
2907 var recv = v.expr(self.n_expr, null)
2908 var mproperty = self.mproperty.as(not null)
2909 return v.read_attribute(mproperty, recv)
2913 redef class AAttrAssignExpr
2916 var recv = v.expr(self.n_expr, null)
2917 var i = v.expr(self.n_value, null)
2918 var mproperty = self.mproperty.as(not null)
2919 v.write_attribute(mproperty, recv, i)
2924 redef class AAttrReassignExpr
2927 var recv = v.expr(self.n_expr, null)
2928 var value = v.expr(self.n_value, null)
2929 var mproperty = self.mproperty.as(not null)
2930 var attr = v.read_attribute(mproperty, recv)
2931 var res = v.compile_callsite(self.reassign_callsite.as(not null), [attr, value])
2933 v.write_attribute(mproperty, recv, res)
2937 redef class AIssetAttrExpr
2940 var recv = v.expr(self.n_expr, null)
2941 var mproperty = self.mproperty.as(not null)
2942 return v.isset_attribute(mproperty, recv)
2946 redef class ADebugTypeExpr
2955 redef class Array[E]
2956 # Return a new `Array` with the elements only contened in self and not in `o
`
2957 fun -(o: Array[E]): Array[E] do
2958 var res = new Array[E]
2959 for e in self do if not o.has(e) then res.add(e)
2965 # All `MProperty` associated to all `MClassDef` of `mclass
`
2966 fun properties(mclass: MClass): Set[MProperty] do
2967 if not self.properties_cache.has_key(mclass) then
2968 var properties = new HashSet[MProperty]
2969 var parents = new Array[MClass]
2970 if self.flatten_mclass_hierarchy.has(mclass) then
2971 parents.add_all(mclass.in_hierarchy(self).direct_greaters)
2973 for parent in parents do
2974 properties.add_all(self.properties(parent))
2976 for mclassdef in mclass.mclassdefs do
2977 if not self.in_importation <= mclassdef.mmodule then continue
2978 for mprop in mclassdef.intro_mproperties do
2979 properties.add(mprop)
2982 self.properties_cache[mclass] = properties
2984 return properties_cache[mclass]
2986 private var properties_cache: Map[MClass, Set[MProperty]] = new HashMap[MClass, Set[MProperty]]
2988 # Write FFI and nitni results to file
2989 fun finalize_ffi(c: AbstractCompiler) do end
2991 # Give requided addinional system libraries (as given to LD_LIBS)
2992 # Note: can return null instead of an empty set
2993 fun collect_linker_libs: nullable Array[String] do return null
2996 # Create a tool context to handle options and paths
2997 var toolcontext = new ToolContext
2999 toolcontext.tooldescription = "Usage: nitc [OPTION]... file.nit...\nCompiles Nit programs."
3001 # We do not add other options, so process them now!
3002 toolcontext.process_options(args)
3004 # We need a model to collect stufs
3005 var model = new Model
3006 # An a model builder to parse files
3007 var modelbuilder = new ModelBuilder(model, toolcontext)
3009 var arguments = toolcontext.option_context.rest
3010 if arguments.length > 1 and toolcontext.opt_output.value != null then
3011 print "Error: --output needs a single source file. Do you prefer --dir?"
3015 # Here we load an process all modules passed on the command line
3016 var mmodules = modelbuilder.parse(arguments)
3018 if mmodules.is_empty then return
3019 modelbuilder.run_phases
3021 for mmodule in mmodules do
3022 toolcontext.info("*** PROCESS {mmodule} ***", 1)
3024 toolcontext.run_global_phases(ms)