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
22 import auto_super_init
26 # Add compiling options
27 redef class ToolContext
29 var opt_output
: OptionString = new OptionString("Output file", "-o", "--output")
31 var opt_dir
: OptionString = new OptionString("Output directory", "--dir")
33 var opt_no_cc
: OptionBool = new OptionBool("Do not invoke C compiler", "--no-cc")
35 var opt_no_main
: OptionBool = new OptionBool("Do not generate main entry point", "--no-main")
37 var opt_cc_path
: OptionArray = new OptionArray("Set include path for C header files (may be used more than once)", "--cc-path")
39 var opt_make_flags
: OptionString = new OptionString("Additional options to make", "--make-flags")
41 var opt_compile_dir
: OptionString = new OptionString("Directory used to generate temporary files", "--compile-dir")
43 var opt_hardening
: OptionBool = new OptionBool("Generate contracts in the C code against bugs in the compiler", "--hardening")
45 var opt_no_shortcut_range
: OptionBool = new OptionBool("Always insantiate a range and its iterator on 'for' loops", "--no-shortcut-range")
46 # --no-check-covariance
47 var opt_no_check_covariance
: OptionBool = new OptionBool("Disable type tests of covariant parameters (dangerous)", "--no-check-covariance")
48 # --no-check-attr-isset
49 var opt_no_check_attr_isset
: OptionBool = new OptionBool("Disable isset tests before each attribute access (dangerous)", "--no-check-attr-isset")
51 var opt_no_check_assert
: OptionBool = new OptionBool("Disable the evaluation of explicit 'assert' and 'as' (dangerous)", "--no-check-assert")
53 var opt_no_check_autocast
: OptionBool = new OptionBool("Disable implicit casts on unsafe expression usage (dangerous)", "--no-check-autocast")
55 var opt_no_check_other
: OptionBool = new OptionBool("Disable implicit tests: unset attribute, null receiver (dangerous)", "--no-check-other")
56 # --typing-test-metrics
57 var opt_typing_test_metrics
: OptionBool = new OptionBool("Enable static and dynamic count of all type tests", "--typing-test-metrics")
58 # --invocation-metrics
59 var opt_invocation_metrics
: OptionBool = new OptionBool("Enable static and dynamic count of all method invocations", "--invocation-metrics")
60 # --isset-checks-metrics
61 var opt_isset_checks_metrics
: OptionBool = new OptionBool("Enable static and dynamic count of isset checks before attributes access", "--isset-checks-metrics")
63 var opt_stacktrace
: OptionString = new OptionString("Control the generation of stack traces", "--stacktrace")
65 var opt_no_gcc_directive
= new OptionArray("Disable a advanced gcc directives for optimization", "--no-gcc-directive")
67 var opt_release
= new OptionBool("Compile in release mode and finalize application", "--release")
72 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
, self.opt_no_shortcut_range
)
73 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_other
)
74 self.option_context
.add_option
(self.opt_typing_test_metrics
, self.opt_invocation_metrics
, self.opt_isset_checks_metrics
)
75 self.option_context
.add_option
(self.opt_stacktrace
)
76 self.option_context
.add_option
(self.opt_no_gcc_directive
)
77 self.option_context
.add_option
(self.opt_release
)
80 redef fun process_options
(args
)
84 var st
= opt_stacktrace
.value
85 if st
== "none" or st
== "libunwind" or st
== "nitstack" then
87 else if st
== "auto" or st
== null then
89 opt_stacktrace
.value
= "nitstack"
91 print
"Error: unknown value `{st}` for --stacktrace. Use `none`, `libunwind`, `nitstack` or `auto`."
95 if opt_output
.value
!= null and opt_dir
.value
!= null then
96 print
"Error: cannot use both --dir and --output"
102 redef class ModelBuilder
103 # The compilation directory
104 var compile_dir
: String
106 # Simple indirection to `Toolchain::write_and_make`
107 protected fun write_and_make
(compiler
: AbstractCompiler)
109 var platform
= compiler
.mainmodule
.target_platform
111 if platform
== null then
112 toolchain
= new MakefileToolchain(toolcontext
)
114 toolchain
= platform
.toolchain
(toolcontext
)
116 compile_dir
= toolchain
.compile_dir
117 toolchain
.write_and_make compiler
122 fun toolchain
(toolcontext
: ToolContext): Toolchain is abstract
126 var toolcontext
: ToolContext
128 fun compile_dir
: String
130 var compile_dir
= toolcontext
.opt_compile_dir
.value
131 if compile_dir
== null then compile_dir
= ".nit_compile"
135 fun write_and_make
(compiler
: AbstractCompiler) is abstract
138 class MakefileToolchain
140 # The list of directories to search for included C headers (-I for C compilers)
141 # The list is initially set with :
142 # * the toolcontext --cc-path option
143 # * the NIT_CC_PATH environment variable
144 # * `toolcontext.nit_dir`
145 # Path can be added (or removed) by the client
146 var cc_paths
= new Array[String]
148 protected fun gather_cc_paths
150 # Look for the the Nit clib path
151 var path_env
= toolcontext
.nit_dir
152 if path_env
!= null then
153 var libname
= "{path_env}/clib"
154 if libname
.file_exists
then cc_paths
.add
(libname
)
157 if cc_paths
.is_empty
then
158 toolcontext
.error
(null, "Cannot determine the nit clib path. define envvar NIT_DIR.")
161 # Add user defined cc_paths
162 cc_paths
.append
(toolcontext
.opt_cc_path
.value
)
164 path_env
= "NIT_CC_PATH".environ
165 if not path_env
.is_empty
then
166 cc_paths
.append
(path_env
.split_with
(':'))
170 redef fun write_and_make
(compiler
)
174 var mainmodule
= compiler
.mainmodule
175 var compile_dir
= compile_dir
177 # Generate the .h and .c files
178 # A single C file regroups many compiled rumtime functions
179 # 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
181 self.toolcontext
.info
("*** WRITING C ***", 1)
185 var cfiles
= new Array[String]
186 write_files
(compiler
, compile_dir
, cfiles
)
188 # Generate the Makefile
190 write_makefile
(compiler
, compile_dir
, cfiles
)
193 self.toolcontext
.info
("*** END WRITING C: {time1-time0} ***", 2)
195 # Execute the Makefile
197 if self.toolcontext
.opt_no_cc
.value
then return
200 self.toolcontext
.info
("*** COMPILING C ***", 1)
202 compile_c_code
(compiler
, compile_dir
)
205 self.toolcontext
.info
("*** END COMPILING C: {time1-time0} ***", 2)
208 fun write_files
(compiler
: AbstractCompiler, compile_dir
: String, cfiles
: Array[String])
210 var platform
= compiler
.mainmodule
.target_platform
211 if self.toolcontext
.opt_stacktrace
.value
== "nitstack" and (platform
== null or platform
.supports_libunwind
) then compiler
.build_c_to_nit_bindings
212 var cc_opt_with_libgc
= "-DWITH_LIBGC"
213 if platform
!= null and not platform
.supports_libgc
then cc_opt_with_libgc
= ""
215 # Add gc_choser.h to aditionnal bodies
216 var gc_chooser
= new ExternCFile("gc_chooser.c", cc_opt_with_libgc
)
217 compiler
.extern_bodies
.add
(gc_chooser
)
218 compiler
.files_to_copy
.add
"{cc_paths.first}/gc_chooser.c"
219 compiler
.files_to_copy
.add
"{cc_paths.first}/gc_chooser.h"
222 var m2m
= toolcontext
.modelbuilder
.mmodule2nmodule
223 for m
in compiler
.mainmodule
.in_importation
.greaters
do
224 compiler
.finalize_ffi_for_module
(m
)
227 # Copy original .[ch] files to compile_dir
228 for src
in compiler
.files_to_copy
do
229 var basename
= src
.basename
("")
230 var dst
= "{compile_dir}/{basename}"
234 var hfilename
= compiler
.header
.file
.name
+ ".h"
235 var hfilepath
= "{compile_dir}/{hfilename}"
236 var h
= new OFStream.open
(hfilepath
)
237 for l
in compiler
.header
.decl_lines
do
241 for l
in compiler
.header
.lines
do
247 for f
in compiler
.files
do
249 var hfile
: nullable OFStream = null
251 var cfilename
= "{f.name}.0.h"
252 var cfilepath
= "{compile_dir}/{cfilename}"
253 hfile
= new OFStream.open
(cfilepath
)
254 hfile
.write
"#include \"{hfilename}\
"\n"
255 for key
in f
.required_declarations
do
256 if not compiler
.provided_declarations
.has_key
(key
) then
257 var node
= compiler
.requirers_of_declarations
.get_or_null
(key
)
259 node
.debug
"No provided declaration for {key}"
261 print
"No provided declaration for {key}"
265 hfile
.write compiler
.provided_declarations
[key
]
269 var file
: nullable OFStream = null
270 for vis
in f
.writers
do
271 if vis
== compiler
.header
then continue
272 var total_lines
= vis
.lines
.length
+ vis
.decl_lines
.length
273 if total_lines
== 0 then continue
275 if file
== null or count
> 10000 then
277 if file
!= null then file
.close
278 cfilename
= "{f.name}.{i}.c"
279 cfilepath
= "{compile_dir}/{cfilename}"
280 self.toolcontext
.info
("new C source files to compile: {cfilepath}", 3)
281 cfiles
.add
(cfilename
)
282 file
= new OFStream.open
(cfilepath
)
283 file
.write
"#include \"{f.name}.0.h\
"\n"
286 for l
in vis
.decl_lines
do
290 for l
in vis
.lines
do
295 if file
!= null then file
.close
298 self.toolcontext
.info
("Total C source files to compile: {cfiles.length}", 2)
301 fun makefile_name
(mainmodule
: MModule): String do return "{mainmodule.name}.mk"
303 fun default_outname
(mainmodule
: MModule): String do return mainmodule
.name
305 # Combine options and platform informations to get the final path of the outfile
306 fun outfile
(mainmodule
: MModule): String
308 var res
= self.toolcontext
.opt_output
.value
309 if res
!= null then return res
310 res
= default_outname
(mainmodule
)
311 var dir
= self.toolcontext
.opt_dir
.value
312 if dir
!= null then return dir
.join_path
(res
)
316 fun write_makefile
(compiler
: AbstractCompiler, compile_dir
: String, cfiles
: Array[String])
318 var mainmodule
= compiler
.mainmodule
319 var platform
= compiler
.mainmodule
.target_platform
321 var outname
= outfile
(mainmodule
)
323 var orig_dir
=".." # FIXME only works if `compile_dir` is a subdirectory of cwd
324 var outpath
= orig_dir
.join_path
(outname
).simplify_path
325 var makename
= makefile_name
(mainmodule
)
326 var makepath
= "{compile_dir}/{makename}"
327 var makefile
= new OFStream.open
(makepath
)
331 cc_includes
+= " -I \"" + p + "\
""
334 var linker_options
= new HashSet[String]
335 var m2m
= toolcontext
.modelbuilder
.mmodule2nmodule
336 for m
in mainmodule
.in_importation
.greaters
do
337 var libs
= m
.collect_linker_libs
338 if libs
!= null then linker_options
.add_all
(libs
)
341 makefile
.write
("CC = ccache cc\nCXX = ccache c++\nCFLAGS = -g -O2 -Wno-unused-value -Wno-switch\nCINCL = {cc_includes}\nLDFLAGS ?= \nLDLIBS ?= -lm -lgc {linker_options.join(" ")}\n\n")
343 var ost
= toolcontext
.opt_stacktrace
.value
344 if (ost
== "libunwind" or ost
== "nitstack") and (platform
== null or platform
.supports_libunwind
) then makefile
.write
("NEED_LIBUNWIND := YesPlease\n")
346 # Dynamic adaptations
347 # While `platform` enable complex toolchains, they are statically applied
348 # For a dynamic adaptsation of the compilation, the generated Makefile should check and adapt things itself
350 # Check and adapt the targeted system
351 makefile
.write
("uname_S := $(shell sh -c 'uname -s 2>/dev/null || echo not')\n")
352 makefile
.write
("ifeq ($(uname_S),Darwin)\n")
353 # remove -lunwind since it is already included on macosx
354 makefile
.write
("\tNEED_LIBUNWIND :=\n")
355 makefile
.write
("endif\n\n")
357 # Check and adapt for the compiler used
358 # clang need an additionnal `-Qunused-arguments`
359 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")
361 makefile
.write
("ifdef NEED_LIBUNWIND\n\tLDLIBS += -lunwind\nendif\n")
363 makefile
.write
("all: {outpath}\n\n")
365 var ofiles
= new Array[String]
366 var dep_rules
= new Array[String]
367 # Compile each generated file
369 var o
= f
.strip_extension
(".c") + ".o"
370 makefile
.write
("{o}: {f}\n\t$(CC) $(CFLAGS) $(CINCL) -c -o {o} {f}\n\n")
375 var java_files
= new Array[ExternFile]
377 # Compile each required extern body into a specific .o
378 for f
in compiler
.extern_bodies
do
379 var o
= f
.makefile_rule_name
380 var ff
= f
.filename
.basename
("")
381 makefile
.write
("{o}: {ff}\n")
382 makefile
.write
("\t{f.makefile_rule_content}\n\n")
383 dep_rules
.add
(f
.makefile_rule_name
)
385 if f
.compiles_to_o_file
then ofiles
.add
(o
)
386 if f
.add_to_jar
then java_files
.add
(f
)
389 if not java_files
.is_empty
then
390 var jar_file
= "{outpath}.jar"
392 var class_files_array
= new Array[String]
393 for f
in java_files
do class_files_array
.add
(f
.makefile_rule_name
)
394 var class_files
= class_files_array
.join
(" ")
396 makefile
.write
("{jar_file}: {class_files}\n")
397 makefile
.write
("\tjar cf {jar_file} {class_files}\n\n")
398 dep_rules
.add jar_file
402 makefile
.write
("{outpath}: {dep_rules.join(" ")}\n\t$(CC) $(LDFLAGS) -o {outpath} {ofiles.join(" ")} $(LDLIBS)\n\n")
404 makefile
.write
("clean:\n\trm {ofiles.join(" ")} 2>/dev/null\n\n")
406 self.toolcontext
.info
("Generated makefile: {makepath}", 2)
409 fun compile_c_code
(compiler
: AbstractCompiler, compile_dir
: String)
411 var makename
= makefile_name
(compiler
.mainmodule
)
413 var makeflags
= self.toolcontext
.opt_make_flags
.value
414 if makeflags
== null then makeflags
= ""
415 self.toolcontext
.info
("make -B -C {compile_dir} -f {makename} -j 4 {makeflags}", 2)
418 if self.toolcontext
.verbose_level
>= 3 then
419 res
= sys
.system
("make -B -C {compile_dir} -f {makename} -j 4 {makeflags} 2>&1")
421 res
= sys
.system
("make -B -C {compile_dir} -f {makename} -j 4 {makeflags} 2>&1 >/dev/null")
424 toolcontext
.error
(null, "make failed! Error code: {res}.")
429 # Singleton that store the knowledge about the compilation process
430 abstract class AbstractCompiler
431 type VISITOR: AbstractCompilerVisitor
433 # Table corresponding c_names to nit names (methods)
434 var names
= new HashMap[String, String]
436 # The main module of the program currently compiled
437 # Is assigned during the separate compilation
438 var mainmodule
: MModule writable
440 # The real main module of the program
441 var realmainmodule
: MModule
443 # The modeulbuilder used to know the model and the AST
444 var modelbuilder
: ModelBuilder protected writable
446 # Is hardening asked? (see --hardening)
447 fun hardening
: Bool do return self.modelbuilder
.toolcontext
.opt_hardening
.value
449 init(mainmodule
: MModule, modelbuilder
: ModelBuilder)
451 self.mainmodule
= mainmodule
452 self.realmainmodule
= mainmodule
453 self.modelbuilder
= modelbuilder
456 # Force the creation of a new file
457 # The point is to avoid contamination between must-be-compiled-separately files
458 fun new_file
(name
: String): CodeFile
460 var f
= new CodeFile(name
)
465 # The list of all associated files
466 # Used to generate .c files
467 var files
: List[CodeFile] = new List[CodeFile]
469 # Initialize a visitor specific for a compiler engine
470 fun new_visitor
: VISITOR is abstract
472 # Where global declaration are stored (the main .h)
473 var header
: CodeWriter writable
475 # Provide a declaration that can be requested (before or latter) by a visitor
476 fun provide_declaration
(key
: String, s
: String)
478 if self.provided_declarations
.has_key
(key
) then
479 assert self.provided_declarations
[key
] == s
481 self.provided_declarations
[key
] = s
484 private var provided_declarations
= new HashMap[String, String]
486 private var requirers_of_declarations
= new HashMap[String, ANode]
488 # Builds the .c and .h files to be used when generating a Stack Trace
489 # Binds the generated C function names to Nit function names
490 fun build_c_to_nit_bindings
492 var compile_dir
= modelbuilder
.compile_dir
494 var stream
= new OFStream.open
("{compile_dir}/c_functions_hash.c")
495 stream
.write
("#include <string.h>\n")
496 stream
.write
("#include <stdlib.h>\n")
497 stream
.write
("#include \"c_functions_hash
.h\
"\n")
498 stream
.write
("typedef struct C_Nit_Names\{char* name; char* nit_name;\}C_Nit_Names;\n")
499 stream
.write
("const char* get_nit_name(register const char* procproc, register unsigned int len)\{\n")
500 stream
.write
("char* procname = malloc(len+1);")
501 stream
.write
("memcpy(procname, procproc, len);")
502 stream
.write
("procname[len] = '\\0';")
503 stream
.write
("static const C_Nit_Names map[{names.length}] = \{\n")
504 for i
in names
.keys
do
507 stream.write("\
",\"")
508 stream.write(names[i])
509 stream.write("\
"\},\n")
511 stream
.write
("\};\n")
512 stream
.write
("int i;")
513 stream
.write
("for(i = 0; i < {names.length}; i++)\{")
514 stream
.write
("if(strcmp(procname,map[i].name) == 0)\{")
515 stream
.write
("free(procname);")
516 stream
.write
("return map[i].nit_name;")
519 stream
.write
("free(procname);")
520 stream
.write
("return NULL;")
524 stream
= new OFStream.open
("{compile_dir}/c_functions_hash.h")
525 stream
.write
("const char* get_nit_name(register const char* procname, register unsigned int len);\n")
528 extern_bodies
.add
(new ExternCFile("{compile_dir}/c_functions_hash.c", ""))
532 # This method call compile_header_strucs method that has to be refined
533 fun compile_header
do
535 var toolctx
= modelbuilder
.toolcontext
536 self.header
.add_decl
("#include <stdlib.h>")
537 self.header
.add_decl
("#include <stdio.h>")
538 self.header
.add_decl
("#include <string.h>")
539 self.header
.add_decl
("#include \"gc_chooser
.h\
"")
540 self.header
.add_decl
("#ifdef ANDROID")
541 self.header
.add_decl
(" #include <android/log.h>")
542 self.header
.add_decl
(" #define PRINT_ERROR(...) (void)__android_log_print(ANDROID_LOG_WARN, \"Nit\
", __VA_ARGS__)")
543 self.header
.add_decl
("#else")
544 self.header
.add_decl
(" #define PRINT_ERROR(...) fprintf(stderr, __VA_ARGS__)")
545 self.header
.add_decl
("#endif")
547 compile_header_structs
548 compile_nitni_structs
550 var gccd_disable
= modelbuilder
.toolcontext
.opt_no_gcc_directive
.value
551 if gccd_disable
.has
("noreturn") or gccd_disable
.has
("all") then
552 # Signal handler function prototype
553 self.header
.add_decl
("void show_backtrace(int);")
555 self.header
.add_decl
("void show_backtrace(int) __attribute__ ((noreturn));")
558 if gccd_disable
.has
("likely") or gccd_disable
.has
("all") then
559 self.header
.add_decl
("#define likely(x) (x)")
560 self.header
.add_decl
("#define unlikely(x) (x)")
561 else if gccd_disable
.has
("correct-likely") then
562 # invert the `likely` definition
563 # Used by masochists to bench the worst case
564 self.header
.add_decl
("#define likely(x) __builtin_expect((x),0)")
565 self.header
.add_decl
("#define unlikely(x) __builtin_expect((x),1)")
567 self.header
.add_decl
("#define likely(x) __builtin_expect((x),1)")
568 self.header
.add_decl
("#define unlikely(x) __builtin_expect((x),0)")
571 # Global variable used by intern methods
572 self.header
.add_decl
("extern int glob_argc;")
573 self.header
.add_decl
("extern char **glob_argv;")
574 self.header
.add_decl
("extern val *glob_sys;")
577 # Declaration of structures for live Nit types
578 protected fun compile_header_structs
is abstract
580 # Declaration of structures for nitni undelying the FFI
581 protected fun compile_nitni_structs
583 self.header
.add_decl
"""
584 /* Native reference to Nit objects */
585 /* This structure is used to represent every Nit type in extern methods and custom C code. */
587 struct nitni_ref *next,
588 *prev; /* adjacent global references in global list */
589 int count; /* number of time this global reference has been marked */
592 /* List of global references from C code to Nit objects */
593 /* Instanciated empty at init of Nit system and filled explicitly by user in C code */
594 struct nitni_global_ref_list_t {
595 struct nitni_ref *head, *tail;
597 extern struct nitni_global_ref_list_t *nitni_global_ref_list;
599 /* Initializer of global reference list */
600 extern void nitni_global_ref_list_init();
602 /* Intern function to add a global reference to the list */
603 extern void nitni_global_ref_add( struct nitni_ref *ref );
605 /* Intern function to remove a global reference from the list */
606 extern void nitni_global_ref_remove( struct nitni_ref *ref );
608 /* Increase count on an existing global reference */
609 extern void nitni_global_ref_incr( struct nitni_ref *ref );
611 /* Decrease count on an existing global reference */
612 extern void nitni_global_ref_decr( struct nitni_ref *ref );
616 # Generate the main C function.
618 # * allocate the Sys object if it exists
619 # * call init if is exists
620 # * call main if it exists
621 fun compile_main_function
623 var v
= self.new_visitor
624 v
.add_decl
("#include <signal.h>")
625 var ost
= modelbuilder
.toolcontext
.opt_stacktrace
.value
626 var platform
= mainmodule
.target_platform
628 if platform
!= null and not platform
.supports_libunwind
then ost
= "none"
630 var no_main
= (platform
!= null and platform
.no_main
) or modelbuilder
.toolcontext
.opt_no_main
.value
632 if ost
== "nitstack" or ost
== "libunwind" then
633 v
.add_decl
("#define UNW_LOCAL_ONLY")
634 v
.add_decl
("#include <libunwind.h>")
635 if ost
== "nitstack" then
636 v
.add_decl
("#include \"c_functions_hash
.h\
"")
639 v
.add_decl
("int glob_argc;")
640 v
.add_decl
("char **glob_argv;")
641 v
.add_decl
("val *glob_sys;")
643 if self.modelbuilder
.toolcontext
.opt_typing_test_metrics
.value
then
644 for tag
in count_type_test_tags
do
645 v
.add_decl
("long count_type_test_resolved_{tag};")
646 v
.add_decl
("long count_type_test_unresolved_{tag};")
647 v
.add_decl
("long count_type_test_skipped_{tag};")
648 v
.compiler
.header
.add_decl
("extern long count_type_test_resolved_{tag};")
649 v
.compiler
.header
.add_decl
("extern long count_type_test_unresolved_{tag};")
650 v
.compiler
.header
.add_decl
("extern long count_type_test_skipped_{tag};")
654 if self.modelbuilder
.toolcontext
.opt_invocation_metrics
.value
then
655 v
.add_decl
("long count_invoke_by_tables;")
656 v
.add_decl
("long count_invoke_by_direct;")
657 v
.add_decl
("long count_invoke_by_inline;")
658 v
.compiler
.header
.add_decl
("extern long count_invoke_by_tables;")
659 v
.compiler
.header
.add_decl
("extern long count_invoke_by_direct;")
660 v
.compiler
.header
.add_decl
("extern long count_invoke_by_inline;")
663 if self.modelbuilder
.toolcontext
.opt_isset_checks_metrics
.value
then
664 v
.add_decl
("long count_attr_reads = 0;")
665 v
.add_decl
("long count_isset_checks = 0;")
666 v
.compiler
.header
.add_decl
("extern long count_attr_reads;")
667 v
.compiler
.header
.add_decl
("extern long count_isset_checks;")
670 v
.add_decl
("void sig_handler(int signo)\{")
671 v
.add_decl
("PRINT_ERROR(\"Caught signal
: %s\\n\
", strsignal(signo));")
672 v
.add_decl
("show_backtrace(signo);")
675 v
.add_decl
("void show_backtrace (int signo) \{")
676 if ost
== "nitstack" or ost
== "libunwind" then
677 v
.add_decl
("char* opt = getenv(\"NIT_NO_STACK\
");")
678 v
.add_decl
("unw_cursor_t cursor;")
679 v
.add_decl
("if(opt==NULL)\{")
680 v
.add_decl
("unw_context_t uc;")
681 v
.add_decl
("unw_word_t ip;")
682 v
.add_decl
("char* procname = malloc(sizeof(char) * 100);")
683 v
.add_decl
("unw_getcontext(&uc);")
684 v
.add_decl
("unw_init_local(&cursor, &uc);")
685 v
.add_decl
("PRINT_ERROR(\"-------------------------------------------------\\n\
");")
686 v
.add_decl
("PRINT_ERROR(\"-- Stack Trace ------------------------------\\n\
");")
687 v
.add_decl
("PRINT_ERROR(\"-------------------------------------------------\\n\
");")
688 v
.add_decl
("while (unw_step(&cursor) > 0) \{")
689 v
.add_decl
(" unw_get_proc_name(&cursor, procname, 100, &ip);")
690 if ost
== "nitstack" then
691 v
.add_decl
(" const char* recv = get_nit_name(procname, strlen(procname));")
692 v
.add_decl
(" if (recv != NULL)\{")
693 v
.add_decl
(" PRINT_ERROR(\"` %s\\n\", recv);")
694 v.add_decl(" \}else\{")
695 v.add_decl(" PRINT_ERROR(\"` %s\\n\
", procname);")
698 v
.add_decl
(" PRINT_ERROR(\"` %s \\n\",procname);")
701 v.add_decl("PRINT_ERROR(\"-------------------------------------------------\\n\");")
702 v.add_decl("free(procname);")
705 v.add_decl("exit(signo);")
709 v.add_decl("int nit_main(int argc, char** argv) \{")
711 v.add_decl("int main(int argc, char** argv) \{")
714 v.add("signal(SIGABRT, sig_handler);")
715 v.add("signal(SIGFPE, sig_handler);")
716 v.add("signal(SIGILL, sig_handler);")
717 v.add("signal(SIGINT, sig_handler);")
718 v.add("signal(SIGTERM, sig_handler);")
719 v.add("signal(SIGSEGV, sig_handler);")
720 v.add("signal(SIGPIPE, sig_handler);")
722 v.add("glob_argc = argc; glob_argv = argv;")
723 v.add("initialize_gc_option();")
725 v.add "initialize_nitni_global_refs();"
727 var main_type = mainmodule.sys_type
728 if main_type != null then
729 var mainmodule = v.compiler.mainmodule
730 var glob_sys = v.init_instance(main_type)
731 v.add("glob_sys = {glob_sys};")
732 var main_init = mainmodule.try_get_primitive_method("init", main_type.mclass)
733 if main_init != null then
734 v.send(main_init, [glob_sys])
736 var main_method = mainmodule.try_get_primitive_method("main", main_type.mclass)
737 if main_method != null then
738 v.send(main_method, [glob_sys])
742 if self.modelbuilder.toolcontext.opt_typing_test_metrics.value then
743 v.add_decl("long count_type_test_resolved_total = 0;")
744 v.add_decl("long count_type_test_unresolved_total = 0;")
745 v.add_decl("long count_type_test_skipped_total = 0;")
746 v.add_decl("long count_type_test_total_total = 0;")
747 for tag in count_type_test_tags do
748 v.add_decl("long count_type_test_total_{tag};")
749 v.add("count_type_test_total_{tag} = count_type_test_resolved_{tag} + count_type_test_unresolved_{tag} + count_type_test_skipped_{tag};")
750 v.add("count_type_test_resolved_total += count_type_test_resolved_{tag};")
751 v.add("count_type_test_unresolved_total += count_type_test_unresolved_{tag};")
752 v.add("count_type_test_skipped_total += count_type_test_skipped_{tag};")
753 v.add("count_type_test_total_total += count_type_test_total_{tag};")
755 v.add("printf(\"# dynamic count_type_test: total %l\\n\");")
756 v.add("printf(\"\\tresolved\\tunresolved\\tskipped\\ttotal\\n\");")
757 var tags = count_type_test_tags.to_a
760 v.add("printf(\"{tag}\");")
761 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_resolved_{tag}, 100.0*count_type_test_resolved_{tag}/count_type_test_total_total);")
762 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_unresolved_{tag}, 100.0*count_type_test_unresolved_{tag}/count_type_test_total_total);")
763 v.add("printf(\"\\t%ld (%.2f%%)\", count_type_test_skipped_{tag}, 100.0*count_type_test_skipped_{tag}/count_type_test_total_total);")
764 v.add("printf(\"\\t%ld (%.2f%%)\\n\", count_type_test_total_{tag}, 100.0*count_type_test_total_{tag}/count_type_test_total_total);")
768 if self.modelbuilder.toolcontext.opt_invocation_metrics.value then
769 v.add_decl("long count_invoke_total;")
770 v.add("count_invoke_total = count_invoke_by_tables + count_invoke_by_direct + count_invoke_by_inline;")
771 v.add("printf(\"# dynamic count_invocation: total %ld\\n\", count_invoke_total);")
772 v.add("printf(\"by table: %ld (%.2f%%)\\n\", count_invoke_by_tables, 100.0*count_invoke_by_tables/count_invoke_total);")
773 v.add("printf(\"direct: %ld (%.2f%%)\\n\", count_invoke_by_direct, 100.0*count_invoke_by_direct/count_invoke_total);")
774 v.add("printf(\"inlined: %ld (%.2f%%)\\n\", count_invoke_by_inline, 100.0*count_invoke_by_inline/count_invoke_total);")
777 if self.modelbuilder.toolcontext.opt_isset_checks_metrics.value then
778 v.add("printf(\"# dynamic attribute reads: %ld\\n\", count_attr_reads);")
779 v.add("printf(\"# dynamic isset checks: %ld\\n\", count_isset_checks);")
786 # Copile all C functions related to the [incr|decr]_ref features of the FFI
787 fun compile_nitni_global_ref_functions
789 var v = self.new_visitor
791 struct nitni_global_ref_list_t *nitni_global_ref_list;
792 void initialize_nitni_global_refs() {
793 nitni_global_ref_list = (struct nitni_global_ref_list_t*)nit_alloc(sizeof(struct nitni_global_ref_list_t));
794 nitni_global_ref_list->head = NULL;
795 nitni_global_ref_list->tail = NULL;
798 void nitni_global_ref_add( struct nitni_ref *ref ) {
799 if ( nitni_global_ref_list->head == NULL ) {
800 nitni_global_ref_list->head = ref;
803 nitni_global_ref_list->tail->next = ref;
804 ref->prev = nitni_global_ref_list->tail;
806 nitni_global_ref_list->tail = ref;
811 void nitni_global_ref_remove( struct nitni_ref *ref ) {
812 if ( ref->prev == NULL ) {
813 nitni_global_ref_list->head = ref->next;
815 ref->prev->next = ref->next;
818 if ( ref->next == NULL ) {
819 nitni_global_ref_list->tail = ref->prev;
821 ref->next->prev = ref->prev;
825 extern void nitni_global_ref_incr( struct nitni_ref *ref ) {
826 if ( ref->count == 0 ) /* not registered */
829 nitni_global_ref_add( ref );
835 extern void nitni_global_ref_decr( struct nitni_ref *ref ) {
836 if ( ref->count == 1 ) /* was last reference */
838 /* remove from list */
839 nitni_global_ref_remove( ref );
847 # List of additional files required to compile (FFI)
848 var extern_bodies = new Array[ExternFile]
850 # List of source files to copy over to the compile dir
851 var files_to_copy = new Array[String]
853 # This is used to avoid adding an extern file more than once
854 private var seen_extern = new ArraySet[String]
856 # Generate code that initialize the attributes on a new instance
857 fun generate_init_attr(v: VISITOR, recv: RuntimeVariable, mtype: MClassType)
859 var cds = mtype.collect_mclassdefs(self.mainmodule).to_a
860 self.mainmodule.linearize_mclassdefs(cds)
862 var n = self.modelbuilder.mclassdef2nclassdef[cd]
863 for npropdef in n.n_propdefs do
864 if npropdef isa AAttrPropdef then
865 npropdef.init_expr(v, recv)
871 # Generate code that check if an attribute is correctly initialized
872 fun generate_check_attr(v: VISITOR, recv: RuntimeVariable, mtype: MClassType)
874 var cds = mtype.collect_mclassdefs(self.mainmodule).to_a
875 self.mainmodule.linearize_mclassdefs(cds)
877 var n = self.modelbuilder.mclassdef2nclassdef[cd]
878 for npropdef in n.n_propdefs do
879 if npropdef isa AAttrPropdef then
880 npropdef.check_expr(v, recv)
888 var count_type_test_tags: Array[String] = ["isa", "as", "auto", "covariance", "erasure"]
889 var count_type_test_resolved: HashMap[String, Int] = init_count_type_test_tags
890 var count_type_test_unresolved: HashMap[String, Int] = init_count_type_test_tags
891 var count_type_test_skipped: HashMap[String, Int] = init_count_type_test_tags
893 protected fun init_count_type_test_tags: HashMap[String, Int]
895 var res = new HashMap[String, Int]
896 for tag in count_type_test_tags do
902 # Display stats about compilation process
904 # * type tests against resolved types (`x
isa Collection[Animal]`)
905 # * type tests against unresolved types (`x
isa Collection[E
]`)
906 # * type tests skipped
911 if self.modelbuilder.toolcontext.opt_typing_test_metrics.value then
912 print "# static count_type_test"
913 print "\tresolved:\tunresolved\tskipped\ttotal"
914 var count_type_test_total = init_count_type_test_tags
915 count_type_test_resolved["total"] = 0
916 count_type_test_unresolved["total"] = 0
917 count_type_test_skipped["total"] = 0
918 count_type_test_total["total"] = 0
919 for tag in count_type_test_tags do
920 count_type_test_total[tag] = count_type_test_resolved[tag] + count_type_test_unresolved[tag] + count_type_test_skipped[tag]
921 count_type_test_resolved["total"] += count_type_test_resolved[tag]
922 count_type_test_unresolved["total"] += count_type_test_unresolved[tag]
923 count_type_test_skipped["total"] += count_type_test_skipped[tag]
924 count_type_test_total["total"] += count_type_test_total[tag]
926 var count_type_test = count_type_test_total["total"]
927 var tags = count_type_test_tags.to_a
931 printn "\t{count_type_test_resolved[tag]} ({div(count_type_test_resolved[tag],count_type_test)}%)"
932 printn "\t{count_type_test_unresolved[tag]} ({div(count_type_test_unresolved[tag],count_type_test)}%)"
933 printn "\t{count_type_test_skipped[tag]} ({div(count_type_test_skipped[tag],count_type_test)}%)"
934 printn "\t{count_type_test_total[tag]} ({div(count_type_test_total[tag],count_type_test)}%)"
940 fun finalize_ffi_for_module(mmodule: MModule) do mmodule.finalize_ffi(self)
943 # Avoid division by zero by returning the string "n/a"
944 fun div(a,b:Int):String
946 if b == 0 then return "n/a"
947 return ((a*10000/b).to_f / 100.0).to_precision(2)
951 # A file unit (may be more than one file if
952 # A file unit aim to be autonomous and is made or one or more `CodeWriter`s
955 var writers = new Array[CodeWriter]
956 var required_declarations = new HashSet[String]
959 # Where to store generated lines
962 var lines: List[String] = new List[String]
963 var decl_lines: List[String] = new List[String]
965 # Add a line in the main part of the generated C
966 fun add(s: String) do self.lines.add(s)
969 # (used for local or global declaration)
970 fun add_decl(s: String) do self.decl_lines.add(s)
975 file.writers.add(self)
979 # A visitor on the AST of property definition that generate the C code.
980 abstract class AbstractCompilerVisitor
982 type COMPILER: AbstractCompiler
984 # The associated compiler
985 var compiler: COMPILER
987 # The current visited AST node
988 var current_node: nullable ANode writable = null
990 # The current `Frame`
991 var frame: nullable Frame writable
993 # Alias for self.compiler.mainmodule.object_type
994 fun object_type: MClassType do return self.compiler.mainmodule.object_type
996 # Alias for self.compiler.mainmodule.bool_type
997 fun bool_type: MClassType do return self.compiler.mainmodule.bool_type
999 var writer: CodeWriter
1001 init(compiler: COMPILER)
1003 self.compiler = compiler
1004 self.writer = new CodeWriter(compiler.files.last)
1007 # Force to get the primitive class named `name
` or abort
1008 fun get_class(name: String): MClass do return self.compiler.mainmodule.get_primitive_class(name)
1010 # Force to get the primitive property named `name
` in the instance `recv
` or abort
1011 fun get_property(name: String, recv: MType): MMethod
1013 assert recv isa MClassType
1014 return self.compiler.modelbuilder.force_get_primitive_method(self.current_node.as(not null), name, recv.mclass, self.compiler.mainmodule)
1017 fun compile_callsite(callsite: CallSite, args: Array[RuntimeVariable]): nullable RuntimeVariable
1019 return self.send(callsite.mproperty, args)
1022 fun native_array_instance(elttype: MType, length: RuntimeVariable): RuntimeVariable is abstract
1024 fun calloc_array(ret_type: MType, arguments: Array[RuntimeVariable]) is abstract
1026 fun native_array_def(pname: String, ret_type: nullable MType, arguments: Array[RuntimeVariable]) is abstract
1028 # Transform varargs, in raw arguments, into a single argument of type `Array`
1029 # Note: this method modify the given `args
`
1030 # If there is no vararg, then `args
` is not modified.
1031 fun varargize(mpropdef: MPropDef, msignature: MSignature, args: Array[RuntimeVariable])
1033 var recv = args.first
1034 var vararg_rank = msignature.vararg_rank
1035 if vararg_rank >= 0 then
1036 assert args.length >= msignature.arity + 1 # because of self
1038 args = new Array[RuntimeVariable]
1040 args.add(rawargs.first) # recv
1042 for i in [0..vararg_rank[ do
1043 args.add(rawargs[i+1])
1046 var vararg_lastrank = vararg_rank + rawargs.length-1-msignature.arity
1047 var vararg = new Array[RuntimeVariable]
1048 for i in [vararg_rank..vararg_lastrank] do
1049 vararg.add(rawargs[i+1])
1052 var elttype = msignature.mparameters[vararg_rank].mtype
1053 args.add(self.vararg_instance(mpropdef, recv, vararg, elttype))
1055 for i in [vararg_lastrank+1..rawargs.length-1[ do
1056 args.add(rawargs[i+1])
1059 rawargs.add_all(args)
1065 # Anchor a type to the main module and the current receiver
1066 fun anchor(mtype: MType): MType
1068 if not mtype.need_anchor then return mtype
1069 return mtype.anchor_to(self.compiler.mainmodule, self.frame.receiver)
1072 fun resolve_for(mtype: MType, recv: RuntimeVariable): MType
1074 if not mtype.need_anchor then return mtype
1075 return mtype.resolve_for(recv.mcasttype, self.frame.receiver, self.compiler.mainmodule, true)
1078 # Unsafely cast a value to a new type
1079 # ie the result share the same C variable but my have a different mcasttype
1080 # NOTE: if the adaptation is useless then `value
` is returned as it.
1081 # ENSURE: `result
.name
== value
.name
`
1082 fun autoadapt(value: RuntimeVariable, mtype: MType): RuntimeVariable
1084 mtype = self.anchor(mtype)
1085 var valmtype = value.mcasttype
1086 if valmtype.is_subtype(self.compiler.mainmodule, null, mtype) then
1090 if valmtype isa MNullableType and valmtype.mtype.is_subtype(self.compiler.mainmodule, null, mtype) then
1091 var res = new RuntimeVariable(value.name, valmtype, valmtype.mtype)
1094 var res = new RuntimeVariable(value.name, valmtype, mtype)
1099 # Generate a super call from a method definition
1100 fun supercall(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1102 fun adapt_signature(m: MMethodDef, args: Array[RuntimeVariable]) is abstract
1104 # Box or unbox a value to another type iff a C type conversion is needed
1105 # ENSURE: `result
.mtype
.ctype
== mtype
.ctype
`
1106 fun autobox(value: RuntimeVariable, mtype: MType): RuntimeVariable is abstract
1108 # Generate a polymorphic subtype test
1109 fun type_test(value: RuntimeVariable, mtype: MType, tag: String): RuntimeVariable is abstract
1111 # Generate the code required to dynamically check if 2 objects share the same runtime type
1112 fun is_same_type_test(value1, value2: RuntimeVariable): RuntimeVariable is abstract
1114 # Generate a Nit "is" for two runtime_variables
1115 fun equal_test(value1, value2: RuntimeVariable): RuntimeVariable is abstract
1119 # Generate a static call on a method definition
1120 fun call(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1122 # Generate a polymorphic send for the method `m
` and the arguments `args
`
1123 fun send(m: MMethod, args: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1125 # Generate a monomorphic send for the method `m
`, the type `t
` and the arguments `args
`
1126 fun monomorphic_send(m: MMethod, t: MType, args: Array[RuntimeVariable]): nullable RuntimeVariable
1128 assert t isa MClassType
1129 var propdef = m.lookup_first_definition(self.compiler.mainmodule, t)
1130 return self.call(propdef, t, args)
1133 # Generate a monomorphic super send from the method `m
`, the type `t
` and the arguments `args
`
1134 fun monomorphic_super_send(m: MMethodDef, t: MType, args: Array[RuntimeVariable]): nullable RuntimeVariable
1136 assert t isa MClassType
1137 m = m.lookup_next_definition(self.compiler.mainmodule, t)
1138 return self.call(m, t, args)
1141 # Attributes handling
1143 # Generate a polymorphic attribute is_set test
1144 fun isset_attribute(a: MAttribute, recv: RuntimeVariable): RuntimeVariable is abstract
1146 # Generate a polymorphic attribute read
1147 fun read_attribute(a: MAttribute, recv: RuntimeVariable): RuntimeVariable is abstract
1149 # Generate a polymorphic attribute write
1150 fun write_attribute(a: MAttribute, recv: RuntimeVariable, value: RuntimeVariable) is abstract
1154 # Add a check and an abort for a null reciever if needed
1155 fun check_recv_notnull(recv: RuntimeVariable)
1157 if self.compiler.modelbuilder.toolcontext.opt_no_check_other.value then return
1159 var maybenull = recv.mcasttype isa MNullableType or recv.mcasttype isa MNullType
1161 self.add("if (unlikely({recv} == NULL)) \{")
1162 self.add_abort("Receiver is null")
1169 private var names: HashSet[String] = new HashSet[String]
1170 private var last: Int = 0
1172 # Return a new name based on `s
` and unique in the visitor
1173 fun get_name(s: String): String
1175 if not self.names.has(s) then
1179 var i = self.last + 1
1182 if not self.names.has(s2) then
1191 # Return an unique and stable identifier associated with an escapemark
1192 fun escapemark_name(e: nullable EscapeMark): String
1195 if escapemark_names.has_key(e) then return escapemark_names[e]
1197 if name == null then name = "label"
1198 name = get_name(name)
1199 escapemark_names[e] = name
1203 private var escapemark_names = new HashMap[EscapeMark, String]
1205 # Return a "const char*" variable associated to the classname of the dynamic type of an object
1206 # NOTE: we do not return a `RuntimeVariable` "NativeString" as the class may not exist in the module/program
1207 fun class_name_string(value: RuntimeVariable): String is abstract
1209 # Variables handling
1211 protected var variables: HashMap[Variable, RuntimeVariable] = new HashMap[Variable, RuntimeVariable]
1213 # Return the local runtime_variable associated to a Nit local variable
1214 fun variable(variable: Variable): RuntimeVariable
1216 if self.variables.has_key(variable) then
1217 return self.variables[variable]
1219 var name = self.get_name("var_{variable.name}")
1220 var mtype = variable.declared_type.as(not null)
1221 mtype = self.anchor(mtype)
1222 var res = new RuntimeVariable(name, mtype, mtype)
1223 self.add_decl("{mtype.ctype} {name} /* var {variable}: {mtype} */;")
1224 self.variables[variable] = res
1229 # Return a new uninitialized local runtime_variable
1230 fun new_var(mtype: MType): RuntimeVariable
1232 mtype = self.anchor(mtype)
1233 var name = self.get_name("var")
1234 var res = new RuntimeVariable(name, mtype, mtype)
1235 self.add_decl("{mtype.ctype} {name} /* : {mtype} */;")
1239 # Return a new uninitialized named runtime_variable
1240 fun new_named_var(mtype: MType, name: String): RuntimeVariable
1242 mtype = self.anchor(mtype)
1243 var res = new RuntimeVariable(name, mtype, mtype)
1244 self.add_decl("{mtype.ctype} {name} /* : {mtype} */;")
1248 # Correctly assign a left and a right value
1249 # Boxing and unboxing is performed if required
1250 fun assign(left, right: RuntimeVariable)
1252 right = self.autobox(right, left.mtype)
1253 self.add("{left} = {right};")
1256 # Generate instances
1258 # Generate a alloc-instance + init-attributes
1259 fun init_instance(mtype: MClassType): RuntimeVariable is abstract
1261 # Generate an integer value
1262 fun int_instance(value: Int): RuntimeVariable
1264 var res = self.new_var(self.get_class("Int").mclass_type)
1265 self.add("{res} = {value};")
1269 # Generate a string value
1270 fun string_instance(string: String): RuntimeVariable
1272 var mtype = self.get_class("String").mclass_type
1273 var name = self.get_name("varonce")
1274 self.add_decl("static {mtype.ctype} {name};")
1275 var res = self.new_var(mtype)
1276 self.add("if ({name}) \{")
1277 self.add("{res} = {name};")
1278 self.add("\} else \{")
1279 var native_mtype = self.get_class("NativeString").mclass_type
1280 var nat = self.new_var(native_mtype)
1281 self.add("{nat} = \"{string.escape_to_c}\";")
1282 var length = self.int_instance(string.length)
1283 self.add("{res} = {self.send(self.get_property("to_s_with_length", native_mtype), [nat, length]).as(not null)};")
1284 self.add("{name} = {res};")
1289 # Generate an array value
1290 fun array_instance(array: Array[RuntimeVariable], elttype: MType): RuntimeVariable is abstract
1292 # Get an instance of a array for a vararg
1293 fun vararg_instance(mpropdef: MPropDef, recv: RuntimeVariable, varargs: Array[RuntimeVariable], elttype: MType): RuntimeVariable is abstract
1297 # Add a line in the main part of the generated C
1298 fun add(s: String) do self.writer.lines.add(s)
1301 # (used for local or global declaration)
1302 fun add_decl(s: String) do self.writer.decl_lines.add(s)
1304 # Request the presence of a global declaration
1305 fun require_declaration(key: String)
1307 var reqs = self.writer.file.required_declarations
1308 if reqs.has(key) then return
1310 var node = current_node
1311 if node != null then compiler.requirers_of_declarations[key] = node
1314 # Add a declaration in the local-header
1315 # The declaration is ensured to be present once
1316 fun declare_once(s: String)
1318 self.compiler.provide_declaration(s, s)
1319 self.require_declaration(s)
1322 # look for a needed .h and .c file for a given .nit source-file
1323 # FIXME: bad API, parameter should be a `MModule`, not its source-file
1324 fun add_extern(file: String)
1326 file = file.strip_extension(".nit")
1327 var tryfile = file + ".nit.h"
1328 if tryfile.file_exists then
1329 self.declare_once("#include \"{tryfile.basename("")}\"")
1330 self.compiler.files_to_copy.add(tryfile)
1332 tryfile = file + "_nit.h"
1333 if tryfile.file_exists then
1334 self.declare_once("#include \"{tryfile.basename("")}\"")
1335 self.compiler.files_to_copy.add(tryfile)
1338 if self.compiler.seen_extern.has(file) then return
1339 self.compiler.seen_extern.add(file)
1340 tryfile = file + ".nit.c"
1341 if not tryfile.file_exists then
1342 tryfile = file + "_nit.c"
1343 if not tryfile.file_exists then return
1345 var f = new ExternCFile(tryfile.basename(""), "")
1346 self.compiler.extern_bodies.add(f)
1347 self.compiler.files_to_copy.add(tryfile)
1350 # Return a new local runtime_variable initialized with the C expression `cexpr
`.
1351 fun new_expr(cexpr: String, mtype: MType): RuntimeVariable
1353 var res = new_var(mtype)
1354 self.add("{res} = {cexpr};")
1358 # Generate generic abort
1359 # used by aborts, asserts, casts, etc.
1360 fun add_abort(message: String)
1362 self.add("PRINT_ERROR(\"Runtime error: %s\", \"{message.escape_to_c}\");")
1368 if self.current_node != null and self.current_node.location.file != null then
1369 self.add("PRINT_ERROR(\" (%s:%d)\\n\", \"{self.current_node.location.file.filename.escape_to_c}\", {current_node.location.line_start});")
1371 self.add("PRINT_ERROR(\"\\n\");")
1373 self.add("show_backtrace(1);")
1376 # Add a dynamic cast
1377 fun add_cast(value: RuntimeVariable, mtype: MType, tag: String)
1379 var res = self.type_test(value, mtype, tag)
1380 self.add("if (unlikely(!{res})) \{")
1381 var cn = self.class_name_string(value)
1382 self.add("PRINT_ERROR(\"Runtime error: Cast failed. Expected `%s
`, got `%s
`\", \"{mtype.to_s.escape_to_c}\", {cn});")
1387 # Generate a return with the value `s
`
1388 fun ret(s: RuntimeVariable)
1390 self.assign(self.frame.returnvar.as(not null), s)
1391 self.add("goto {self.frame.returnlabel.as(not null)};")
1394 # Compile a statement (if any)
1395 fun stmt(nexpr: nullable AExpr)
1397 if nexpr == null then return
1398 var old = self.current_node
1399 self.current_node = nexpr
1401 self.current_node = old
1404 # Compile an expression an return its result
1405 # `mtype
` is the expected return type, pass null if no specific type is expected.
1406 fun expr(nexpr: AExpr, mtype: nullable MType): RuntimeVariable
1408 var old = self.current_node
1409 self.current_node = nexpr
1410 var res = nexpr.expr(self).as(not null)
1411 if mtype != null then
1412 mtype = self.anchor(mtype)
1413 res = self.autobox(res, mtype)
1415 res = autoadapt(res, nexpr.mtype.as(not null))
1416 var implicit_cast_to = nexpr.implicit_cast_to
1417 if implicit_cast_to != null and not self.compiler.modelbuilder.toolcontext.opt_no_check_autocast.value then
1418 add_cast(res, implicit_cast_to, "auto")
1419 res = autoadapt(res, implicit_cast_to)
1421 self.current_node = old
1425 # Alias for `self.expr
(nexpr
, self.bool_type
)`
1426 fun expr_bool(nexpr: AExpr): RuntimeVariable do return expr(nexpr, bool_type)
1428 # Safely show a debug message on the current node and repeat the message in the C code as a comment
1429 fun debug(message: String)
1431 var node = self.current_node
1432 if node == null then
1433 print "?: {message}"
1437 self.add("/* DEBUG: {message} */")
1441 # A C function associated to a Nit method
1442 # Because of customization, a given Nit method can be compiler more that once
1443 abstract class AbstractRuntimeFunction
1445 type COMPILER: AbstractCompiler
1446 type VISITOR: AbstractCompilerVisitor
1448 # The associated Nit method
1449 var mmethoddef: MMethodDef
1451 # The mangled c name of the runtime_function
1452 # Subclasses should redefine `build_c_name
` instead
1455 var res = self.c_name_cache
1456 if res != null then return res
1457 res = self.build_c_name
1458 self.c_name_cache = res
1462 # Non cached version of `c_name
`
1463 protected fun build_c_name: String is abstract
1465 protected var c_name_cache: nullable String writable = null
1467 # Implements a call of the runtime_function
1468 # May inline the body or generate a C function call
1469 fun call(v: VISITOR, arguments: Array[RuntimeVariable]): nullable RuntimeVariable is abstract
1471 # Generate the code for the `AbstractRuntimeFunction`
1472 # Warning: compile more than once compilation makes CC unhappy
1473 fun compile_to_c(compiler: COMPILER) is abstract
1476 # A runtime variable hold a runtime value in C.
1477 # Runtime variables are associated to Nit local variables and intermediate results in Nit expressions.
1479 # 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.
1480 class RuntimeVariable
1481 # The name of the variable in the C code
1484 # The static type of the variable (as declard in C)
1487 # The current casted type of the variable (as known in Nit)
1488 var mcasttype: MType writable
1490 # If the variable exaclty a mcasttype?
1491 # false (usual value) means that the variable is a mcasttype or a subtype.
1492 var is_exact: Bool writable = false
1494 init(name: String, mtype: MType, mcasttype: MType)
1498 self.mcasttype = mcasttype
1499 assert not mtype.need_anchor
1500 assert not mcasttype.need_anchor
1503 redef fun to_s do return name
1508 if self.is_exact then
1509 exact_str = " exact"
1514 if self.mtype == self.mcasttype then
1515 type_str = "{mtype}{exact_str}"
1517 type_str = "{mtype}({mcasttype}{exact_str})"
1519 return "<{name}:{type_str}>"
1523 # A frame correspond to a visited property in a `GlobalCompilerVisitor`
1526 type VISITOR: AbstractCompilerVisitor
1528 # The associated visitor
1529 var visitor: VISITOR
1531 # The executed property.
1532 # A Method in case of a call, an attribute in case of a default initialization.
1533 var mpropdef: MPropDef
1535 # The static type of the receiver
1536 var receiver: MClassType
1538 # Arguments of the method (the first is the receiver)
1539 var arguments: Array[RuntimeVariable]
1541 # The runtime_variable associated to the return (in a function)
1542 var returnvar: nullable RuntimeVariable writable = null
1544 # The label at the end of the property
1545 var returnlabel: nullable String writable = null
1549 # Return the C type associated to a given Nit static type
1550 fun ctype: String do return "val*"
1552 fun ctypename: String do return "val"
1554 # Return the name of the C structure associated to a Nit live type
1555 fun c_name: String is abstract
1556 protected var c_name_cache: nullable String protected writable
1559 redef class MClassType
1562 var res = self.c_name_cache
1563 if res != null then return res
1564 res = "{mclass.intro_mmodule.name.to_cmangle}__{mclass.name.to_cmangle}"
1565 self.c_name_cache = res
1569 redef fun ctype: String
1571 if mclass.name == "Int" then
1573 else if mclass.name == "Bool" then
1575 else if mclass.name == "Char" then
1577 else if mclass.name == "Float" then
1579 else if mclass.name == "NativeString" then
1581 else if mclass.name == "NativeArray" then
1583 else if mclass.kind == extern_kind then
1590 redef fun ctypename: String
1592 if mclass.name == "Int" then
1594 else if mclass.name == "Bool" then
1596 else if mclass.name == "Char" then
1598 else if mclass.name == "Float" then
1600 else if mclass.name == "NativeString" then
1602 else if mclass.name == "NativeArray" then
1603 #return "{self.arguments.first.ctype}*"
1605 else if mclass.kind == extern_kind then
1613 redef class MGenericType
1616 var res = self.c_name_cache
1617 if res != null then return res
1619 for t in self.arguments do
1620 res = res + t.c_name
1622 self.c_name_cache = res
1627 redef class MParameterType
1630 var res = self.c_name_cache
1631 if res != null then return res
1632 res = "{self.mclass.c_name}_FT{self.rank}"
1633 self.c_name_cache = res
1638 redef class MVirtualType
1641 var res = self.c_name_cache
1642 if res != null then return res
1643 res = "{self.mproperty.intro.mclassdef.mclass.c_name}_VT{self.mproperty.name}"
1644 self.c_name_cache = res
1649 redef class MNullableType
1652 var res = self.c_name_cache
1653 if res != null then return res
1654 res = "nullable_{self.mtype.c_name}"
1655 self.c_name_cache = res
1661 # Return the name of the C structure associated to a Nit class
1662 fun c_name: String do
1663 var res = self.c_name_cache
1664 if res != null then return res
1665 res = "{intro_mmodule.name.to_cmangle}__{name.to_cmangle}"
1666 self.c_name_cache = res
1669 private var c_name_cache: nullable String
1672 redef class MProperty
1673 fun c_name: String do
1674 var res = self.c_name_cache
1675 if res != null then return res
1676 res = "{self.intro.c_name}"
1677 self.c_name_cache = res
1680 private var c_name_cache: nullable String
1683 redef class MPropDef
1684 type VISITOR: AbstractCompilerVisitor
1686 private var c_name_cache: nullable String
1688 # The mangled name associated to the property
1691 var res = self.c_name_cache
1692 if res != null then return res
1693 res = "{self.mclassdef.mmodule.name.to_cmangle}__{self.mclassdef.mclass.name.to_cmangle}__{self.mproperty.name.to_cmangle}"
1694 self.c_name_cache = res
1699 redef class MMethodDef
1700 # Can the body be inlined?
1701 fun can_inline(v: VISITOR): Bool
1703 if is_abstract then return true
1704 var modelbuilder = v.compiler.modelbuilder
1705 if modelbuilder.mpropdef2npropdef.has_key(self) then
1706 var npropdef = modelbuilder.mpropdef2npropdef[self]
1707 return npropdef.can_inline
1708 else if self.mproperty.name == "init" then
1709 # Automatic free init is always inlined since it is empty or contains only attribtes assigments
1716 # Inline the body in another visitor
1717 fun compile_inside_to_c(v: VISITOR, arguments: Array[RuntimeVariable]): nullable RuntimeVariable
1719 var modelbuilder = v.compiler.modelbuilder
1720 if modelbuilder.mpropdef2npropdef.has_key(self) then
1721 var npropdef = modelbuilder.mpropdef2npropdef[self]
1722 var oldnode = v.current_node
1723 v.current_node = npropdef
1724 self.compile_parameter_check(v, arguments)
1725 npropdef.compile_to_c(v, self, arguments)
1726 v.current_node = oldnode
1727 else if self.mproperty.name == "init" then
1728 var nclassdef = modelbuilder.mclassdef2nclassdef[self.mclassdef]
1729 var oldnode = v.current_node
1730 v.current_node = nclassdef
1731 self.compile_parameter_check(v, arguments)
1732 nclassdef.compile_to_c(v, self, arguments)
1733 v.current_node = oldnode
1740 # Generate type checks in the C code to check covariant parameters
1741 fun compile_parameter_check(v: VISITOR, arguments: Array[RuntimeVariable])
1743 if v.compiler.modelbuilder.toolcontext.opt_no_check_covariance.value then return
1745 for i in [0..msignature.arity[ do
1746 # skip test for vararg since the array is instantiated with the correct polymorphic type
1747 if msignature.vararg_rank == i then continue
1749 # skip if the cast is not required
1750 var origmtype = self.mproperty.intro.msignature.mparameters[i].mtype
1751 if not origmtype.need_anchor then continue
1753 # get the parameter type
1754 var mtype = self.msignature.mparameters[i].mtype
1757 # note that v decides if and how to implements the cast
1758 v.add("/* Covariant cast for argument {i} ({self.msignature.mparameters[i].name}) {arguments[i+1].inspect} isa {mtype} */")
1759 v.add_cast(arguments[i+1], mtype, "covariance")
1766 redef class APropdef
1767 fun compile_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
1769 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name} {mpropdef} at {location.to_s}\\n\");")
1770 debug("Not yet implemented")
1773 fun can_inline: Bool do return true
1776 redef class AMethPropdef
1777 redef fun compile_to_c(v, mpropdef, arguments)
1779 if mpropdef.is_abstract then
1780 var cn = v.class_name_string(arguments.first)
1781 v.add("PRINT_ERROR(\"Runtime error: Abstract method `%s
` called on `%s
`\", \"{mpropdef.mproperty.name.escape_to_c}\", {cn});")
1786 # Call the implicit super-init
1787 var auto_super_inits = self.auto_super_inits
1788 if auto_super_inits != null then
1789 var args = [arguments.first]
1790 for auto_super_init in auto_super_inits do
1792 for i in [0..auto_super_init.msignature.arity+1[ do
1793 args.add(arguments[i])
1795 v.compile_callsite(auto_super_init, args)
1799 var n_block = n_block
1800 if n_block != null then
1801 for i in [0..mpropdef.msignature.arity[ do
1802 var variable = self.n_signature.n_params[i].variable.as(not null)
1803 v.assign(v.variable(variable), arguments[i+1])
1806 else if mpropdef.is_intern then
1807 compile_intern_to_c(v, mpropdef, arguments)
1808 else if mpropdef.is_extern then
1809 if mpropdef.mproperty.is_init then
1810 compile_externinit_to_c(v, mpropdef, arguments)
1812 compile_externmeth_to_c(v, mpropdef, arguments)
1817 redef fun can_inline
1819 if self.auto_super_inits != null then return false
1820 var nblock = self.n_block
1821 if nblock == null then return true
1822 if (mpropdef.mproperty.name == "==" or mpropdef.mproperty.name == "!=") and mpropdef.mclassdef.mclass.name == "Object" then return true
1823 if nblock isa ABlockExpr and nblock.n_expr.length == 0 then return true
1827 fun compile_intern_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
1829 var pname = mpropdef.mproperty.name
1830 var cname = mpropdef.mclassdef.mclass.name
1831 var ret = mpropdef.msignature.return_mtype
1833 ret = v.resolve_for(ret, arguments.first)
1834 else if mpropdef.mproperty.is_new then
1835 ret = arguments.first.mcasttype
1837 if pname != "==" and pname != "!=" then
1838 v.adapt_signature(mpropdef, arguments)
1840 if cname == "Int" then
1841 if pname == "output" then
1842 v.add("printf(\"%ld\\n\", {arguments.first});")
1844 else if pname == "object_id" then
1845 v.ret(arguments.first)
1847 else if pname == "+" then
1848 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
1850 else if pname == "-" then
1851 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
1853 else if pname == "unary -" then
1854 v.ret(v.new_expr("-{arguments[0]}", ret.as(not null)))
1856 else if pname == "*" then
1857 v.ret(v.new_expr("{arguments[0]} * {arguments[1]}", ret.as(not null)))
1859 else if pname == "/" then
1860 v.ret(v.new_expr("{arguments[0]} / {arguments[1]}", ret.as(not null)))
1862 else if pname == "%" then
1863 v.ret(v.new_expr("{arguments[0]} % {arguments[1]}", ret.as(not null)))
1865 else if pname == "lshift" then
1866 v.ret(v.new_expr("{arguments[0]} << {arguments[1]}", ret.as(not null)))
1868 else if pname == "rshift" then
1869 v.ret(v.new_expr("{arguments[0]} >> {arguments[1]}", ret.as(not null)))
1871 else if pname == "==" then
1872 v.ret(v.equal_test(arguments[0], arguments[1]))
1874 else if pname == "!=" then
1875 var res = v.equal_test(arguments[0], arguments[1])
1876 v.ret(v.new_expr("!{res}", ret.as(not null)))
1878 else if pname == "<" then
1879 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
1881 else if pname == ">" then
1882 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
1884 else if pname == "<=" then
1885 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
1887 else if pname == ">=" then
1888 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
1890 else if pname == "to_f" then
1891 v.ret(v.new_expr("(double){arguments[0]}", ret.as(not null)))
1893 else if pname == "ascii" then
1894 v.ret(v.new_expr("{arguments[0]}", ret.as(not null)))
1897 else if cname == "Char" then
1898 if pname == "output" then
1899 v.add("printf(\"%c\", {arguments.first});")
1901 else if pname == "object_id" then
1902 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
1904 else if pname == "successor" then
1905 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
1907 else if pname == "predecessor" then
1908 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
1910 else if pname == "==" then
1911 v.ret(v.equal_test(arguments[0], arguments[1]))
1913 else if pname == "!=" then
1914 var res = v.equal_test(arguments[0], arguments[1])
1915 v.ret(v.new_expr("!{res}", ret.as(not null)))
1917 else if pname == "<" then
1918 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
1920 else if pname == ">" then
1921 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
1923 else if pname == "<=" then
1924 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
1926 else if pname == ">=" then
1927 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
1929 else if pname == "to_i" then
1930 v.ret(v.new_expr("{arguments[0]}-'0'", ret.as(not null)))
1932 else if pname == "ascii" then
1933 v.ret(v.new_expr("(unsigned char){arguments[0]}", ret.as(not null)))
1936 else if cname == "Bool" then
1937 if pname == "output" then
1938 v.add("printf({arguments.first}?\"true\\n\":\"false\\n\");")
1940 else if pname == "object_id" then
1941 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
1943 else if pname == "==" then
1944 v.ret(v.equal_test(arguments[0], arguments[1]))
1946 else if pname == "!=" then
1947 var res = v.equal_test(arguments[0], arguments[1])
1948 v.ret(v.new_expr("!{res}", ret.as(not null)))
1951 else if cname == "Float" then
1952 if pname == "output" then
1953 v.add("printf(\"%f\\n\", {arguments.first});")
1955 else if pname == "object_id" then
1956 v.ret(v.new_expr("(double){arguments.first}", ret.as(not null)))
1958 else if pname == "+" then
1959 v.ret(v.new_expr("{arguments[0]} + {arguments[1]}", ret.as(not null)))
1961 else if pname == "-" then
1962 v.ret(v.new_expr("{arguments[0]} - {arguments[1]}", ret.as(not null)))
1964 else if pname == "unary -" then
1965 v.ret(v.new_expr("-{arguments[0]}", ret.as(not null)))
1967 else if pname == "succ" then
1968 v.ret(v.new_expr("{arguments[0]}+1", ret.as(not null)))
1970 else if pname == "prec" then
1971 v.ret(v.new_expr("{arguments[0]}-1", ret.as(not null)))
1973 else if pname == "*" then
1974 v.ret(v.new_expr("{arguments[0]} * {arguments[1]}", ret.as(not null)))
1976 else if pname == "/" then
1977 v.ret(v.new_expr("{arguments[0]} / {arguments[1]}", ret.as(not null)))
1979 else if pname == "==" then
1980 v.ret(v.equal_test(arguments[0], arguments[1]))
1982 else if pname == "!=" then
1983 var res = v.equal_test(arguments[0], arguments[1])
1984 v.ret(v.new_expr("!{res}", ret.as(not null)))
1986 else if pname == "<" then
1987 v.ret(v.new_expr("{arguments[0]} < {arguments[1]}", ret.as(not null)))
1989 else if pname == ">" then
1990 v.ret(v.new_expr("{arguments[0]} > {arguments[1]}", ret.as(not null)))
1992 else if pname == "<=" then
1993 v.ret(v.new_expr("{arguments[0]} <= {arguments[1]}", ret.as(not null)))
1995 else if pname == ">=" then
1996 v.ret(v.new_expr("{arguments[0]} >= {arguments[1]}", ret.as(not null)))
1998 else if pname == "to_i" then
1999 v.ret(v.new_expr("(long){arguments[0]}", ret.as(not null)))
2002 else if cname == "NativeString" then
2003 if pname == "[]" then
2004 v.ret(v.new_expr("{arguments[0]}[{arguments[1]}]", ret.as(not null)))
2006 else if pname == "[]=" then
2007 v.add("{arguments[0]}[{arguments[1]}]={arguments[2]};")
2009 else if pname == "copy_to" then
2010 v.add("memcpy({arguments[1]}+{arguments[4]},{arguments[0]}+{arguments[3]},{arguments[2]});")
2012 else if pname == "atoi" then
2013 v.ret(v.new_expr("atoi({arguments[0]});", ret.as(not null)))
2015 else if pname == "init" then
2016 v.ret(v.new_expr("(char*)nit_alloc({arguments[1]})", ret.as(not null)))
2019 else if cname == "NativeArray" then
2020 v.native_array_def(pname, ret, arguments)
2023 if pname == "exit" then
2024 v.add("exit({arguments[1]});")
2026 else if pname == "sys" then
2027 v.ret(v.new_expr("glob_sys", ret.as(not null)))
2029 else if pname == "calloc_string" then
2030 v.ret(v.new_expr("(char*)nit_alloc({arguments[1]})", ret.as(not null)))
2032 else if pname == "calloc_array" then
2033 v.calloc_array(ret.as(not null), arguments)
2035 else if pname == "object_id" then
2036 v.ret(v.new_expr("(long){arguments.first}", ret.as(not null)))
2038 else if pname == "is_same_type" then
2039 v.ret(v.is_same_type_test(arguments[0], arguments[1]))
2041 else if pname == "is_same_instance" then
2042 v.ret(v.equal_test(arguments[0], arguments[1]))
2044 else if pname == "output_class_name" then
2045 var nat = v.class_name_string(arguments.first)
2046 v.add("printf(\"%s\\n\", {nat});")
2048 else if pname == "native_class_name" then
2049 var nat = v.class_name_string(arguments.first)
2050 v.ret(v.new_expr("(char*){nat}", ret.as(not null)))
2052 else if pname == "force_garbage_collection" then
2053 v.add("nit_gcollect();")
2055 else if pname == "native_argc" then
2056 v.ret(v.new_expr("glob_argc", ret.as(not null)))
2058 else if pname == "native_argv" then
2059 v.ret(v.new_expr("glob_argv[{arguments[1]}]", ret.as(not null)))
2062 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name}:{mpropdef} at {location.to_s}\\n\");")
2063 debug("Not implemented {mpropdef}")
2066 fun compile_externmeth_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
2069 var nextern = self.n_extern
2070 if nextern == null then
2071 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED nitni for {mpropdef} at {location.to_s}\\n\");")
2072 v.add("show_backtrace(1);")
2075 externname = nextern.text.substring(1, nextern.text.length-2)
2076 if location.file != null then
2077 var file = location.file.filename
2080 var res: nullable RuntimeVariable = null
2081 var ret = mpropdef.msignature.return_mtype
2083 ret = v.resolve_for(ret, arguments.first)
2084 res = v.new_var(ret)
2086 v.adapt_signature(mpropdef, arguments)
2089 v.add("{externname}({arguments.join(", ")});")
2091 v.add("{res} = {externname}({arguments.join(", ")});")
2096 fun compile_externinit_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
2099 var nextern = self.n_extern
2100 if nextern == null then
2101 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED nitni for {mpropdef} at {location.to_s}\\n\");")
2102 v.add("show_backtrace(1);")
2105 externname = nextern.text.substring(1, nextern.text.length-2)
2106 if location.file != null then
2107 var file = location.file.filename
2110 v.adapt_signature(mpropdef, arguments)
2111 var ret = arguments.first.mtype
2112 var res = v.new_var(ret)
2116 v.add("{res} = {externname}({arguments.join(", ")});")
2121 redef class AAttrPropdef
2122 redef fun compile_to_c(v, mpropdef, arguments)
2124 if mpropdef == mreadpropdef then
2125 assert arguments.length == 1
2129 assert nexpr != null
2131 var ret = self.mpropdef.static_mtype
2132 var useiset = ret.ctype == "val*" and not ret isa MNullableType
2133 var guard = self.mlazypropdef.mproperty
2135 set = v.isset_attribute(self.mpropdef.mproperty, arguments.first)
2137 set = v.read_attribute(guard, arguments.first)
2139 v.add("if(likely({set})) \{")
2140 res = v.read_attribute(self.mpropdef.mproperty, arguments.first)
2142 var value = v.expr(nexpr, self.mpropdef.static_mtype)
2143 v.write_attribute(self.mpropdef.mproperty, arguments.first, value)
2144 v.assign(res, value)
2146 var true_v = v.new_expr("1", v.bool_type)
2147 v.write_attribute(guard, arguments.first, true_v)
2151 res = v.read_attribute(self.mpropdef.mproperty, arguments.first)
2153 v.assign(v.frame.returnvar.as(not null), res)
2154 else if mpropdef == mwritepropdef then
2155 assert arguments.length == 2
2156 v.write_attribute(self.mpropdef.mproperty, arguments.first, arguments[1])
2158 var ret = self.mpropdef.static_mtype
2159 var useiset = ret.ctype == "val*" and not ret isa MNullableType
2161 v.write_attribute(self.mlazypropdef.mproperty, arguments.first, v.new_expr("1", v.bool_type))
2169 fun init_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable)
2171 var nexpr = self.n_expr
2172 if nexpr != null and not is_lazy then
2173 var oldnode = v.current_node
2174 v.current_node = self
2175 var old_frame = v.frame
2176 var frame = new Frame(v, self.mpropdef.as(not null), recv.mtype.as(MClassType), [recv])
2178 var value = v.expr(nexpr, self.mpropdef.static_mtype)
2179 v.write_attribute(self.mpropdef.mproperty, recv, value)
2181 v.current_node = oldnode
2185 fun check_expr(v: AbstractCompilerVisitor, recv: RuntimeVariable)
2187 var nexpr = self.n_expr
2188 if nexpr != null then return
2190 var oldnode = v.current_node
2191 v.current_node = self
2192 var old_frame = v.frame
2193 var frame = new Frame(v, self.mpropdef.as(not null), recv.mtype.as(MClassType), [recv])
2195 # Force read to check the initialization
2196 v.read_attribute(self.mpropdef.mproperty, recv)
2198 v.current_node = oldnode
2202 redef class AClassdef
2203 private fun compile_to_c(v: AbstractCompilerVisitor, mpropdef: MMethodDef, arguments: Array[RuntimeVariable])
2205 if mpropdef == self.mfree_init then
2206 var super_inits = self.super_inits
2207 if super_inits != null then
2208 var args_of_super = arguments
2209 if arguments.length > 1 then args_of_super = [arguments.first]
2210 for su in super_inits do
2211 v.send(su, args_of_super)
2214 var recv = arguments.first
2216 # Collect undefined attributes
2217 for npropdef in self.n_propdefs do
2218 if npropdef isa AAttrPropdef and npropdef.n_expr == null and not npropdef.noinit then
2219 v.write_attribute(npropdef.mpropdef.mproperty, recv, arguments[i])
2230 # Try to compile self as an expression
2231 # Do not call this method directly, use `v
.expr
` instead
2232 private fun expr(v: AbstractCompilerVisitor): nullable RuntimeVariable
2234 v.add("PRINT_ERROR(\"NOT YET IMPLEMENTED {class_name}:{location.to_s}\\n\");")
2235 var mtype = self.mtype
2236 if mtype == null then
2239 var res = v.new_var(mtype)
2240 v.add("/* {res} = NOT YET {class_name} */")
2245 # Try to compile self as a statement
2246 # Do not call this method directly, use `v
.stmt
` instead
2247 private fun stmt(v: AbstractCompilerVisitor)
2250 if res != null then v.add("{res};")
2254 redef class ABlockExpr
2257 for e in self.n_expr do v.stmt(e)
2261 var last = self.n_expr.last
2262 for e in self.n_expr do
2263 if e == last then break
2266 return v.expr(last, null)
2270 redef class AVardeclExpr
2273 var variable = self.variable.as(not null)
2274 var ne = self.n_expr
2276 var i = v.expr(ne, variable.declared_type)
2277 v.assign(v.variable(variable), i)
2282 redef class AVarExpr
2285 var res = v.variable(self.variable.as(not null))
2286 var mtype = self.mtype.as(not null)
2287 return v.autoadapt(res, mtype)
2291 redef class AVarAssignExpr
2294 var variable = self.variable.as(not null)
2295 var i = v.expr(self.n_value, variable.declared_type)
2296 v.assign(v.variable(variable), i)
2300 var variable = self.variable.as(not null)
2301 var i = v.expr(self.n_value, variable.declared_type)
2302 v.assign(v.variable(variable), i)
2307 redef class AVarReassignExpr
2310 var variable = self.variable.as(not null)
2311 var vari = v.variable(variable)
2312 var value = v.expr(self.n_value, variable.declared_type)
2313 var res = v.compile_callsite(self.reassign_callsite.as(not null), [vari, value])
2315 v.assign(v.variable(variable), res)
2319 redef class ASelfExpr
2320 redef fun expr(v) do return v.frame.arguments.first
2323 redef class AContinueExpr
2324 redef fun stmt(v) do v.add("goto CONTINUE_{v.escapemark_name(self.escapemark)};")
2327 redef class ABreakExpr
2328 redef fun stmt(v) do v.add("goto BREAK_{v.escapemark_name(self.escapemark)};")
2331 redef class AReturnExpr
2334 var nexpr = self.n_expr
2335 if nexpr != null then
2336 var returnvar = v.frame.returnvar.as(not null)
2337 var i = v.expr(nexpr, returnvar.mtype)
2338 v.assign(returnvar, i)
2340 v.add("goto {v.frame.returnlabel.as(not null)};")
2344 redef class AAbortExpr
2345 redef fun stmt(v) do v.add_abort("Aborted")
2351 var cond = v.expr_bool(self.n_expr)
2352 v.add("if ({cond})\{")
2361 var res = v.new_var(self.mtype.as(not null))
2362 var cond = v.expr_bool(self.n_expr)
2363 v.add("if ({cond})\{")
2364 v.assign(res, v.expr(self.n_then.as(not null), null))
2366 v.assign(res, v.expr(self.n_else.as(not null), null))
2372 redef class AIfexprExpr
2375 var res = v.new_var(self.mtype.as(not null))
2376 var cond = v.expr_bool(self.n_expr)
2377 v.add("if ({cond})\{")
2378 v.assign(res, v.expr(self.n_then, null))
2380 v.assign(res, v.expr(self.n_else, null))
2389 v.stmt(self.n_block)
2390 var escapemark = self.escapemark
2391 if escapemark != null then
2392 v.add("BREAK_{v.escapemark_name(escapemark)}: (void)0;")
2397 redef class AWhileExpr
2401 var cond = v.expr_bool(self.n_expr)
2402 v.add("if (!{cond}) break;")
2403 v.stmt(self.n_block)
2404 v.add("CONTINUE_{v.escapemark_name(escapemark)}: (void)0;")
2406 v.add("BREAK_{v.escapemark_name(escapemark)}: (void)0;")
2410 redef class ALoopExpr
2414 v.stmt(self.n_block)
2415 v.add("CONTINUE_{v.escapemark_name(escapemark)}: (void)0;")
2417 v.add("BREAK_{v.escapemark_name(escapemark)}: (void)0;")
2421 redef class AForExpr
2424 # Shortcut on explicit range
2425 # Avoid the instantiation of the range and the iterator
2426 var nexpr = self.n_expr
2427 if self.variables.length == 1 and nexpr isa AOrangeExpr and not v.compiler.modelbuilder.toolcontext.opt_no_shortcut_range.value then
2428 var from = v.expr(nexpr.n_expr, null)
2429 var to = v.expr(nexpr.n_expr2, null)
2430 var variable = v.variable(variables.first)
2432 v.assign(variable, from)
2433 v.add("for(;;) \{ /* shortcut range */")
2435 var ok = v.send(v.get_property("<", variable.mtype), [variable, to])
2437 v.add("if(!{ok}) break;")
2439 v.stmt(self.n_block)
2441 v.add("CONTINUE_{v.escapemark_name(escapemark)}: (void)0;")
2442 var succ = v.send(v.get_property("succ", variable.mtype), [variable])
2444 v.assign(variable, succ)
2446 v.add("BREAK_{v.escapemark_name(escapemark)}: (void)0;")
2450 var cl = v.expr(self.n_expr, null)
2451 var it_meth = self.method_iterator
2452 assert it_meth != null
2453 var it = v.compile_callsite(it_meth, [cl])
2456 var isok_meth = self.method_is_ok
2457 assert isok_meth != null
2458 var ok = v.compile_callsite(isok_meth, [it])
2460 v.add("if(!{ok}) break;")
2461 if self.variables.length == 1 then
2462 var item_meth = self.method_item
2463 assert item_meth != null
2464 var i = v.compile_callsite(item_meth, [it])
2466 v.assign(v.variable(variables.first), i)
2467 else if self.variables.length == 2 then
2468 var key_meth = self.method_key
2469 assert key_meth != null
2470 var i = v.compile_callsite(key_meth, [it])
2472 v.assign(v.variable(variables[0]), i)
2473 var item_meth = self.method_item
2474 assert item_meth != null
2475 i = v.compile_callsite(item_meth, [it])
2477 v.assign(v.variable(variables[1]), i)
2481 v.stmt(self.n_block)
2482 v.add("CONTINUE_{v.escapemark_name(escapemark)}: (void)0;")
2483 var next_meth = self.method_next
2484 assert next_meth != null
2485 v.compile_callsite(next_meth, [it])
2487 v.add("BREAK_{v.escapemark_name(escapemark)}: (void)0;")
2491 redef class AAssertExpr
2494 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return
2496 var cond = v.expr_bool(self.n_expr)
2497 v.add("if (unlikely(!{cond})) \{")
2501 v.add_abort("Assert '{nid.text}' failed")
2503 v.add_abort("Assert failed")
2512 var res = v.new_var(self.mtype.as(not null))
2513 var i1 = v.expr_bool(self.n_expr)
2514 v.add("if ({i1}) \{")
2517 var i2 = v.expr_bool(self.n_expr2)
2518 v.add("{res} = {i2};")
2524 redef class AImpliesExpr
2527 var res = v.new_var(self.mtype.as(not null))
2528 var i1 = v.expr_bool(self.n_expr)
2529 v.add("if (!{i1}) \{")
2532 var i2 = v.expr_bool(self.n_expr2)
2533 v.add("{res} = {i2};")
2539 redef class AAndExpr
2542 var res = v.new_var(self.mtype.as(not null))
2543 var i1 = v.expr_bool(self.n_expr)
2544 v.add("if (!{i1}) \{")
2547 var i2 = v.expr_bool(self.n_expr2)
2548 v.add("{res} = {i2};")
2554 redef class ANotExpr
2557 var cond = v.expr_bool(self.n_expr)
2558 return v.new_expr("!{cond}", self.mtype.as(not null))
2562 redef class AOrElseExpr
2565 var res = v.new_var(self.mtype.as(not null))
2566 var i1 = v.expr(self.n_expr, null)
2567 v.add("if ({i1}!=NULL) \{")
2570 var i2 = v.expr(self.n_expr2, null)
2577 redef class AIntExpr
2578 redef fun expr(v) do return v.new_expr("{self.value.to_s}", self.mtype.as(not null))
2581 redef class AFloatExpr
2582 redef fun expr(v) do return v.new_expr("{self.n_float.text}", self.mtype.as(not null)) # FIXME use value, not n_float
2585 redef class ACharExpr
2586 redef fun expr(v) do return v.new_expr("'{self.value.to_s.escape_to_c}'", self.mtype.as(not null))
2589 redef class AArrayExpr
2592 var mtype = self.mtype.as(MClassType).arguments.first
2593 var array = new Array[RuntimeVariable]
2594 for nexpr in self.n_exprs.n_exprs do
2595 var i = v.expr(nexpr, mtype)
2598 return v.array_instance(array, mtype)
2602 redef class AStringFormExpr
2603 redef fun expr(v) do return v.string_instance(self.value.as(not null))
2606 redef class ASuperstringExpr
2609 var array = new Array[RuntimeVariable]
2610 for ne in self.n_exprs do
2611 if ne isa AStringFormExpr and ne.value == "" then continue # skip empty sub-strings
2612 var i = v.expr(ne, null)
2615 var a = v.array_instance(array, v.object_type)
2616 var res = v.send(v.get_property("to_s", a.mtype), [a])
2621 redef class ACrangeExpr
2624 var i1 = v.expr(self.n_expr, null)
2625 var i2 = v.expr(self.n_expr2, null)
2626 var mtype = self.mtype.as(MClassType)
2627 var res = v.init_instance(mtype)
2628 var it = v.compile_callsite(init_callsite.as(not null), [res, i1, i2])
2633 redef class AOrangeExpr
2636 var i1 = v.expr(self.n_expr, null)
2637 var i2 = v.expr(self.n_expr2, null)
2638 var mtype = self.mtype.as(MClassType)
2639 var res = v.init_instance(mtype)
2640 var it = v.compile_callsite(init_callsite.as(not null), [res, i1, i2])
2645 redef class ATrueExpr
2646 redef fun expr(v) do return v.new_expr("1", self.mtype.as(not null))
2649 redef class AFalseExpr
2650 redef fun expr(v) do return v.new_expr("0", self.mtype.as(not null))
2653 redef class ANullExpr
2654 redef fun expr(v) do return v.new_expr("NULL", self.mtype.as(not null))
2657 redef class AIsaExpr
2660 var i = v.expr(self.n_expr, null)
2661 return v.type_test(i, self.cast_type.as(not null), "isa")
2665 redef class AAsCastExpr
2668 var i = v.expr(self.n_expr, null)
2669 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return i
2671 v.add_cast(i, self.mtype.as(not null), "as")
2676 redef class AAsNotnullExpr
2679 var i = v.expr(self.n_expr, null)
2680 if v.compiler.modelbuilder.toolcontext.opt_no_check_assert.value then return i
2682 if i.mtype.ctype != "val*" then return i
2684 v.add("if (unlikely({i} == NULL)) \{")
2685 v.add_abort("Cast failed")
2691 redef class AParExpr
2692 redef fun expr(v) do return v.expr(self.n_expr, null)
2695 redef class AOnceExpr
2698 var mtype = self.mtype.as(not null)
2699 var name = v.get_name("varonce")
2700 var guard = v.get_name(name + "_guard")
2701 v.add_decl("static {mtype.ctype} {name};")
2702 v.add_decl("static int {guard};")
2703 var res = v.new_var(mtype)
2704 v.add("if ({guard}) \{")
2705 v.add("{res} = {name};")
2707 var i = v.expr(self.n_expr, mtype)
2708 v.add("{res} = {i};")
2709 v.add("{name} = {res};")
2710 v.add("{guard} = 1;")
2716 redef class ASendExpr
2719 var recv = v.expr(self.n_expr, null)
2721 for a in self.raw_arguments do
2722 args.add(v.expr(a, null))
2724 return v.compile_callsite(self.callsite.as(not null), args)
2728 redef class ASendReassignFormExpr
2731 var recv = v.expr(self.n_expr, null)
2733 for a in self.raw_arguments do
2734 args.add(v.expr(a, null))
2736 var value = v.expr(self.n_value, null)
2738 var left = v.compile_callsite(self.callsite.as(not null), args)
2741 var res = v.compile_callsite(self.reassign_callsite.as(not null), [left, value])
2745 v.compile_callsite(self.write_callsite.as(not null), args)
2749 redef class ASuperExpr
2752 var recv = v.frame.arguments.first
2754 for a in self.n_args.n_exprs do
2755 args.add(v.expr(a, null))
2758 var callsite = self.callsite
2759 if callsite != null then
2760 # Add additionnals arguments for the super init call
2761 if args.length == 1 then
2762 for i in [0..callsite.msignature.arity[ do
2763 args.add(v.frame.arguments[i+1])
2767 var res = v.compile_callsite(callsite, args)
2771 if args.length == 1 then
2772 args = v.frame.arguments
2775 # stantard call-next-method
2776 return v.supercall(mpropdef.as(not null), recv.mtype.as(MClassType), args)
2780 redef class ANewExpr
2783 var mtype = self.mtype.as(MClassType)
2785 var ctype = mtype.ctype
2786 if mtype.mclass.name == "NativeArray" then
2787 assert self.n_args.n_exprs.length == 1
2788 var l = v.expr(self.n_args.n_exprs.first, null)
2789 assert mtype isa MGenericType
2790 var elttype = mtype.arguments.first
2791 return v.native_array_instance(elttype, l)
2792 else if ctype == "val*" then
2793 recv = v.init_instance(mtype)
2794 else if ctype == "void*" then
2795 recv = v.new_expr("NULL/*special!*/", mtype)
2797 recv = v.new_expr("({ctype})0/*special!*/", mtype)
2800 for a in self.n_args.n_exprs do
2801 args.add(v.expr(a, null))
2803 var res2 = v.compile_callsite(self.callsite.as(not null), args)
2804 if res2 != null then
2805 #self.debug("got {res2} from {mproperty}. drop {recv}")
2812 redef class AAttrExpr
2815 var recv = v.expr(self.n_expr, null)
2816 var mproperty = self.mproperty.as(not null)
2817 return v.read_attribute(mproperty, recv)
2821 redef class AAttrAssignExpr
2824 var recv = v.expr(self.n_expr, null)
2825 var i = v.expr(self.n_value, null)
2826 var mproperty = self.mproperty.as(not null)
2827 v.write_attribute(mproperty, recv, i)
2831 redef class AAttrReassignExpr
2834 var recv = v.expr(self.n_expr, null)
2835 var value = v.expr(self.n_value, null)
2836 var mproperty = self.mproperty.as(not null)
2837 var attr = v.read_attribute(mproperty, recv)
2838 var res = v.compile_callsite(self.reassign_callsite.as(not null), [attr, value])
2840 v.write_attribute(mproperty, recv, res)
2844 redef class AIssetAttrExpr
2847 var recv = v.expr(self.n_expr, null)
2848 var mproperty = self.mproperty.as(not null)
2849 return v.isset_attribute(mproperty, recv)
2853 redef class ADebugTypeExpr
2862 redef class Array[E]
2863 # Return a new `Array` with the elements only contened in self and not in `o
`
2864 fun -(o: Array[E]): Array[E] do
2865 var res = new Array[E]
2866 for e in self do if not o.has(e) then res.add(e)
2872 # All `MProperty` associated to all `MClassDef` of `mclass
`
2873 fun properties(mclass: MClass): Set[MProperty] do
2874 if not self.properties_cache.has_key(mclass) then
2875 var properties = new HashSet[MProperty]
2876 var parents = new Array[MClass]
2877 if self.flatten_mclass_hierarchy.has(mclass) then
2878 parents.add_all(mclass.in_hierarchy(self).direct_greaters)
2880 for parent in parents do
2881 properties.add_all(self.properties(parent))
2883 for mclassdef in mclass.mclassdefs do
2884 if not self.in_importation <= mclassdef.mmodule then continue
2885 for mprop in mclassdef.intro_mproperties do
2886 properties.add(mprop)
2889 self.properties_cache[mclass] = properties
2891 return properties_cache[mclass]
2893 private var properties_cache: Map[MClass, Set[MProperty]] = new HashMap[MClass, Set[MProperty]]
2895 # Write FFI and nitni results to file
2896 fun finalize_ffi(c: AbstractCompiler) do end
2898 # Give requided addinional system libraries (as given to LD_LIBS)
2899 # Note: can return null instead of an empty set
2900 fun collect_linker_libs: nullable Set[String] do return null
2903 # Create a tool context to handle options and paths
2904 var toolcontext = new ToolContext
2906 var opt_mixins = new OptionArray("Additionals module to min-in", "-m")
2907 toolcontext.option_context.add_option(opt_mixins)
2909 toolcontext.tooldescription = "Usage: nitg [OPTION]... file.nit...\nCompiles Nit programs."
2911 # We do not add other options, so process them now!
2912 toolcontext.process_options(args)
2914 # We need a model to collect stufs
2915 var model = new Model
2916 # An a model builder to parse files
2917 var modelbuilder = new ModelBuilder(model, toolcontext)
2919 var arguments = toolcontext.option_context.rest
2920 if arguments.length > 1 and toolcontext.opt_output.value != null then
2921 print "Error: --output needs a single source file. Do you prefer --dir?"
2925 # Here we load an process all modules passed on the command line
2926 var mmodules = modelbuilder.parse(arguments)
2927 var mixins = modelbuilder.parse(opt_mixins.value)
2929 if mmodules.is_empty then return
2930 modelbuilder.run_phases
2932 for mmodule in mmodules do
2933 toolcontext.info("*** PROCESS {mmodule} ***", 1)
2935 if not mixins.is_empty then
2938 toolcontext.run_global_phases(ms)