global: create a new module global to gather (and nest) global analysis
[nit.git] / src / nitc.nit
1 # This file is part of NIT ( http://www.nitlanguage.org ).
2 #
3 # Copyright 2008 Jean Privat <jean@pryen.org>
4 #
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16
17 # Nit compiler main module
18 package nitc
19
20 import abstracttool
21 import analysis
22 import global
23 import program
24 import compiling
25 import syntax
26 import native_interface
27 import separate_options
28
29 # The main class of the nitcompiler program
30 class NitCompiler
31 super AbstractCompiler
32 readable var _opt_output: OptionString = new OptionString("Output file", "-o", "--output")
33 readable var _opt_boost: OptionBool = new OptionBool("Optimize compilation", "-O", "--boost")
34 readable var _opt_no_cc: OptionBool = new OptionBool("Do not invoke C compiler", "--no-cc")
35 readable var _opt_cc_no_link: OptionBool = new OptionBool("Do not invoke C linker", "--cc-no-link")
36 readable var _opt_global: OptionBool = new OptionBool("Use global compilation", "--global")
37 readable var _opt_global_no_STF_opt: OptionBool = new OptionBool("Do not use SFT optimization", "--no-global-SFT-optimization")
38 readable var _opt_global_no_DMR_opt: OptionBool = new OptionBool("Do not use dead method removal optimization", "--no-global-DMR-optimization")
39 readable var _opt_global_no_inline_get_set: OptionBool = new OptionBool("Do not automatically inline getters/setters", "--no-global-get-set-inlining")
40 readable var _opt_global_no_out_of_init_get_test_opt: OptionBool = new OptionBool("Do not remove get tests outside object initialization", "--no-global-OOIT-optimization")
41 readable var _opt_global_no_RFIMA: OptionBool = new OptionBool("Do not use a specialized algorithm to find reachable methods from initializers", "--no-global-RFIM-analysis")
42 readable var _opt_global_callgraph: OptionEnum = new OptionEnum(["none", "cha", "rta"], "The algorithm to use to build the callgraph", 2, "--global-callgraph")
43 readable var _opt_clibdir: OptionString = new OptionString("NIT C library directory", "--clibdir")
44 readable var _opt_bindir: OptionString = new OptionString("NIT tools directory", "--bindir")
45 readable var _opt_compdir: OptionString = new OptionString("Intermediate compilation directory", "--compdir")
46 readable var _opt_extension_prefix: OptionString = new OptionString("Append prefix to file extension", "-p", "--extension-prefix")
47 readable var _opt_output_format: OptionEnum = new OptionEnum(["none", "C", "icode"], "The type of code we want to be generated", 1, "--output-format")
48
49 init
50 do
51 super("nitc")
52 option_context.add_option(opt_output, opt_boost, opt_no_cc, opt_cc_no_link, opt_cc_libs, opt_cc_lib_paths, opt_cc_include_paths, opt_global, opt_clibdir, opt_bindir, opt_compdir, opt_extension_prefix, opt_global_no_STF_opt, opt_global_no_DMR_opt, opt_global_callgraph, opt_global_no_inline_get_set, opt_global_no_RFIMA, opt_global_no_out_of_init_get_test_opt, opt_output_format)
53 end
54
55 redef fun process_options
56 do
57 super
58 output_file = opt_output.value
59 boost = opt_boost.value
60 no_cc = opt_no_cc.value
61 cc_link = not opt_cc_no_link.value
62 cc_lib_paths = opt_cc_lib_paths.value
63 cc_libs = opt_cc_libs.value
64 cc_include_paths = opt_cc_include_paths.value
65 var ext = opt_extension_prefix.value
66 if ext != null then ext_prefix = ext else ext_prefix = ""
67 global = opt_global.value
68 use_SFT_optimization = not opt_global_no_STF_opt.value
69 no_dead_method_removal = opt_global_no_DMR_opt.value
70 no_inline_get_set = opt_global_no_inline_get_set.value
71 no_callgraph_from_init = opt_global_no_RFIMA.value
72 no_out_of_init_get_test_removal = opt_global_no_out_of_init_get_test_opt.value
73 global_callgraph = opt_global_callgraph.value_name
74 compdir = opt_compdir.value
75 if compdir == null then
76 var dir = once ("NIT_COMPDIR".to_symbol).environ
77 if not dir.is_empty then
78 compdir = dir
79 end
80 if compdir == null then
81 compdir = ".nit_compile"
82 end
83 end
84 compdir += ext_prefix
85 compdir = compdir.simplify_path
86
87 clibdir = opt_clibdir.value
88 if clibdir == null then
89 var dir = once ("NIT_DIR".to_symbol).environ
90 if dir.is_empty then
91 dir = "{sys.program_name.dirname}/../clib"
92 if dir.file_exists then clibdir = dir
93 else
94 dir = "{dir}/clib"
95 if dir.file_exists then clibdir = dir
96 end
97 if clibdir == null then
98 fatal_error(null, "Error: Cannot locate NIT C library directory. Uses --clibdir or envvar NIT_DIR.")
99 end
100 end
101 clibdir = clibdir.simplify_path
102
103 bindir = opt_bindir.value
104 if bindir == null then
105 var dir = once ("NIT_DIR".to_symbol).environ
106 if dir.is_empty then
107 dir = "{sys.program_name.dirname}/../bin"
108 if dir.file_exists then bindir = dir
109 else
110 dir = "{dir}/bin"
111 if dir.file_exists then bindir = dir
112 end
113 if bindir == null then
114 fatal_error(null, "Error: Cannot locate NIT tools directory. Uses --bindir or envvar NIT_DIR.")
115 end
116 end
117 bindir = bindir.simplify_path
118 end
119
120 redef fun perform_work(mods)
121 do
122 for mod in mods do
123 var p = new Program(mod, self)
124 p.output_format = opt_output_format.value_name
125 p.compute_main_method
126 p.generate_allocation_iroutines
127 if global then
128 p.do_global_pre_analysis_optimizations
129 p.do_global_analysis
130 p.do_global_post_analysis_optimizations
131 if opt_log.value then
132 p.dump_global_optimizations_information(log_directory)
133 p.dump_global_analysis_information(log_directory)
134 end
135 end
136 p.do_table_computation
137 p.compile_prog
138 end
139 end
140 end
141
142 var c = new NitCompiler
143 c.exec_cmd_line