typing: remove most top-level things
[nit.git] / src / compiler / global_compiler.nit
1 # This file is part of NIT ( http://www.nitlanguage.org ).
2 #
3 # Copyright 2012 Jean Privat <jean@pryen.org>
4 #
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16
17 # Global compilation of a Nit program
18 #
19 # Techniques used are:
20 # * heterogeneous generics
21 # * customization
22 # * switch dispatch
23 # * inlining
24 module global_compiler
25
26 import abstract_compiler
27 import rapid_type_analysis
28
29 redef class ToolContext
30 # option --global
31 var opt_global = new OptionBool("Use global compilation", "--global")
32
33 var global_compiler_phase = new GlobalCompilerPhase(self, null)
34
35 redef init do
36 super
37 option_context.add_option(opt_global)
38 end
39 end
40
41 class GlobalCompilerPhase
42 super Phase
43 redef fun process_mainmodule(mainmodule, given_mmodules) do
44 if not toolcontext.opt_global.value then return
45
46 var modelbuilder = toolcontext.modelbuilder
47 var analysis = modelbuilder.do_rapid_type_analysis(mainmodule)
48 modelbuilder.run_global_compiler(mainmodule, analysis)
49 end
50 end
51
52 redef class ModelBuilder
53 # Entry point to performs a global compilation on the AST of a complete program.
54 # `mainmodule` is the main module of the program
55 # `runtime_type_analysis` is a already computer type analysis.
56 fun run_global_compiler(mainmodule: MModule, runtime_type_analysis: RapidTypeAnalysis)
57 do
58 var time0 = get_time
59 self.toolcontext.info("*** GENERATING C ***", 1)
60
61 var compiler = new GlobalCompiler(mainmodule, self, runtime_type_analysis)
62 compiler.do_compilation
63 compiler.display_stats
64
65 var time1 = get_time
66 self.toolcontext.info("*** END GENERATING C: {time1-time0} ***", 2)
67 write_and_make(compiler)
68 end
69 end
70
71 # Compiler that use global compilation and perform hard optimisations like:
72 # * customization
73 # * switch dispatch
74 # * inlining
75 class GlobalCompiler
76 super AbstractCompiler
77
78 redef type VISITOR: GlobalCompilerVisitor
79
80 # The result of the RTA (used to know live types and methods)
81 var runtime_type_analysis: RapidTypeAnalysis
82
83 init
84 do
85 var file = new_file("{mainmodule.c_name}.nitgg")
86 self.header = new CodeWriter(file)
87 self.live_primitive_types = new Array[MClassType]
88 for t in runtime_type_analysis.live_types do
89 if t.is_c_primitive or t.mclass.name == "Pointer" then
90 self.live_primitive_types.add(t)
91 end
92 end
93 end
94
95 redef fun do_compilation
96 do
97 var compiler = self
98
99 compiler.compile_header
100
101 if mainmodule.model.get_mclasses_by_name("Pointer") != null then
102 runtime_type_analysis.live_types.add(mainmodule.pointer_type)
103 end
104 for t in runtime_type_analysis.live_types do
105 compiler.declare_runtimeclass(t)
106 end
107
108 compiler.compile_class_names
109
110 # Init instance code (allocate and init-arguments)
111 for t in runtime_type_analysis.live_types do
112 if not t.is_c_primitive then
113 compiler.generate_init_instance(t)
114 if t.mclass.kind == extern_kind then
115 compiler.generate_box_instance(t)
116 end
117 else
118 compiler.generate_box_instance(t)
119 end
120 end
121
122 # The main function of the C
123 compiler.compile_nitni_global_ref_functions
124 compiler.compile_main_function
125
126 # Compile until all runtime_functions are visited
127 while not compiler.todos.is_empty do
128 var m = compiler.todos.shift
129 modelbuilder.toolcontext.info("Compile {m} ({compiler.seen.length-compiler.todos.length}/{compiler.seen.length})", 3)
130 m.compile_to_c(compiler)
131 end
132 modelbuilder.toolcontext.info("Total methods to compile to C: {compiler.seen.length}", 2)
133
134 end
135
136 # Compile class names (for the class_name and output_class_name methods)
137 protected fun compile_class_names do
138 var v = new_visitor
139 self.header.add_decl("extern const char *class_names[];")
140 v.add("const char *class_names[] = \{")
141 for t in self.runtime_type_analysis.live_types do
142 v.add("\"{t}\", /* {self.classid(t)} */")
143 end
144 v.add("\};")
145 end
146
147 # Return the C symbol associated to a live type runtime
148 # REQUIRE: self.runtime_type_analysis.live_types.has(mtype)
149 fun classid(mtype: MClassType): String
150 do
151 if self.classids.has_key(mtype) then
152 return self.classids[mtype]
153 end
154 print "No classid for {mtype}"
155 abort
156 end
157
158 # Cache for classid
159 protected var classids: HashMap[MClassType, String] = new HashMap[MClassType, String]
160
161 # Declaration of structures the live Nit types
162 # Each live type is generated as an independent C `struct` type.
163 # They only share a common first field `classid` used to implement the polymorphism.
164 # Usualy, all C variables that refers to a Nit object are typed on the abstract struct `val` that contains only the `classid` field.
165 redef fun compile_header_structs do
166 self.header.add_decl("typedef struct \{int classid;\} val; /* general C type representing a Nit instance. */")
167 end
168
169 # Subset of runtime_type_analysis.live_types that contains only primitive types
170 # Used to implement the equal test
171 var live_primitive_types: Array[MClassType] is noinit
172
173 # Add a new todo task
174 fun todo(m: AbstractRuntimeFunction)
175 do
176 if seen.has(m) then return
177 todos.add(m)
178 seen.add(m)
179 end
180
181 # runtime_functions that need to be compiled
182 private var todos: List[AbstractRuntimeFunction] = new List[AbstractRuntimeFunction]
183
184 # runtime_functions already seen (todo or done)
185 private var seen: HashSet[AbstractRuntimeFunction] = new HashSet[AbstractRuntimeFunction]
186
187 # Declare C structures and identifiers for a runtime class
188 fun declare_runtimeclass(mtype: MClassType)
189 do
190 var v = self.header
191 assert self.runtime_type_analysis.live_types.has(mtype)
192 v.add_decl("/* runtime class {mtype} */")
193 var idnum = classids.length
194 var idname = "ID_" + mtype.c_name
195 self.classids[mtype] = idname
196 v.add_decl("#define {idname} {idnum} /* {mtype} */")
197
198 v.add_decl("struct {mtype.c_name} \{")
199 v.add_decl("int classid; /* must be {idname} */")
200
201 if mtype.mclass.name == "NativeArray" then
202 # NativeArrays are just a instance header followed by an array of values
203 v.add_decl("int length;")
204 v.add_decl("{mtype.arguments.first.ctype} values[1];")
205 end
206
207 if mtype.ctype_extern != "val*" then
208 # Is the Nit type is native then the struct is a box with two fields:
209 # * the `classid` to be polymorph
210 # * the `value` that contains the native value.
211 v.add_decl("{mtype.ctype_extern} value;")
212 end
213
214 # Collect all attributes and associate them a field in the structure.
215 # Note: we do not try to optimize the order and helps CC to optimize the client code.
216 for cd in mtype.collect_mclassdefs(self.mainmodule) do
217 for p in cd.intro_mproperties do
218 if not p isa MAttribute then continue
219 var t = p.intro.static_mtype.as(not null)
220 t = t.anchor_to(self.mainmodule, mtype)
221 v.add_decl("{t.ctype} {p.intro.c_name}; /* {p}: {t} */")
222 end
223 end
224 v.add_decl("\};")
225 end
226
227 # Generate the init-instance of a live type (allocate + init-instance)
228 fun generate_init_instance(mtype: MClassType)
229 do
230 assert self.runtime_type_analysis.live_types.has(mtype)
231 assert not mtype.is_c_primitive
232 var v = self.new_visitor
233
234 var is_native_array = mtype.mclass.name == "NativeArray"
235
236 var sig
237 if is_native_array then
238 sig = "int length"
239 else
240 sig = "void"
241 end
242
243 self.header.add_decl("{mtype.ctype} NEW_{mtype.c_name}({sig});")
244 v.add_decl("/* allocate {mtype} */")
245 v.add_decl("{mtype.ctype} NEW_{mtype.c_name}({sig}) \{")
246 var res = v.new_var(mtype)
247 res.is_exact = true
248 if is_native_array then
249 var mtype_elt = mtype.arguments.first
250 v.add("{res} = nit_alloc(sizeof(struct {mtype.c_name}) + length*sizeof({mtype_elt.ctype}));")
251 v.add("((struct {mtype.c_name}*){res})->length = length;")
252 else
253 v.add("{res} = nit_alloc(sizeof(struct {mtype.c_name}));")
254 end
255 v.add("{res}->classid = {self.classid(mtype)};")
256
257 self.generate_init_attr(v, res, mtype)
258 v.set_finalizer res
259 v.add("return {res};")
260 v.add("\}")
261 end
262
263 fun generate_box_instance(mtype: MClassType)
264 do
265 assert self.runtime_type_analysis.live_types.has(mtype)
266 var v = self.new_visitor
267
268 self.header.add_decl("val* BOX_{mtype.c_name}({mtype.ctype});")
269 v.add_decl("/* allocate {mtype} */")
270 v.add_decl("val* BOX_{mtype.c_name}({mtype.ctype} value) \{")
271 v.add("struct {mtype.c_name}*res = nit_alloc(sizeof(struct {mtype.c_name}));")
272 v.add("res->classid = {self.classid(mtype)};")
273 v.add("res->value = value;")
274 v.add("return (val*)res;")
275 v.add("\}")
276 end
277
278 redef fun new_visitor do return new GlobalCompilerVisitor(self)
279
280 private var collect_types_cache: HashMap[MType, Array[MClassType]] = new HashMap[MType, Array[MClassType]]
281
282 redef fun compile_nitni_structs
283 do
284 self.header.add_decl """
285 struct nitni_instance \{
286 struct nitni_instance *next,
287 *prev; /* adjacent global references in global list */
288 int count; /* number of time this global reference has been marked */
289 val *value;
290 \};"""
291 super
292 end
293 end
294
295 # A visitor on the AST of property definition that generate the C code.
296 # Because of inlining, a visitor can visit more than one property.
297 class GlobalCompilerVisitor
298 super AbstractCompilerVisitor
299
300 redef type COMPILER: GlobalCompiler
301
302 redef fun autobox(value, mtype)
303 do
304 if value.mtype == mtype then
305 return value
306 else if not value.mtype.is_c_primitive and not mtype.is_c_primitive then
307 return value
308 else if not value.mtype.is_c_primitive then
309 return self.new_expr("((struct {mtype.c_name}*){value})->value; /* autounbox from {value.mtype} to {mtype} */", mtype)
310 else if not mtype.is_c_primitive then
311 var valtype = value.mtype.as(MClassType)
312 var res = self.new_var(mtype)
313 if not compiler.runtime_type_analysis.live_types.has(valtype) then
314 self.add("/*no autobox from {value.mtype} to {mtype}: {value.mtype} is not live! */")
315 self.add("PRINT_ERROR(\"Dead code executed!\\n\"); fatal_exit(1);")
316 return res
317 end
318 self.add("{res} = BOX_{valtype.c_name}({value}); /* autobox from {value.mtype} to {mtype} */")
319 return res
320 else if value.mtype.ctype == "void*" and mtype.ctype == "void*" then
321 return value
322 else
323 # Bad things will appen!
324 var res = self.new_var(mtype)
325 self.add("/* {res} left unintialized (cannot convert {value.mtype} to {mtype}) */")
326 self.add("PRINT_ERROR(\"Cast error: Cannot cast %s to %s.\\n\", \"{value.mtype}\", \"{mtype}\"); fatal_exit(1);")
327 return res
328 end
329 end
330
331 redef fun unbox_extern(value, mtype)
332 do
333 if mtype isa MClassType and mtype.mclass.kind == extern_kind and
334 mtype.mclass.name != "NativeString" then
335 var res = self.new_var_extern(mtype)
336 self.add "{res} = ((struct {mtype.c_name}*){value})->value; /* unboxing {value.mtype} */"
337 return res
338 else
339 return value
340 end
341 end
342
343 redef fun box_extern(value, mtype)
344 do
345 if not mtype isa MClassType or mtype.mclass.kind != extern_kind or
346 mtype.mclass.name == "NativeString" then return value
347
348 var valtype = value.mtype.as(MClassType)
349 var res = self.new_var(mtype)
350 if not compiler.runtime_type_analysis.live_types.has(value.mtype.as(MClassType)) then
351 self.add("/*no boxing of {value.mtype}: {value.mtype} is not live! */")
352 self.add("PRINT_ERROR(\"Dead code executed!\\n\"); fatal_exit(1);")
353 return res
354 end
355 self.add("{res} = BOX_{valtype.c_name}({value}); /* boxing {value.mtype} */")
356 return res
357 end
358
359 # The runtime types that are acceptable for a given receiver.
360 fun collect_types(recv: RuntimeVariable): Array[MClassType]
361 do
362 var mtype = recv.mcasttype
363 if recv.is_exact then
364 assert mtype isa MClassType
365 assert self.compiler.runtime_type_analysis.live_types.has(mtype)
366 var types = [mtype]
367 return types
368 end
369 var cache = self.compiler.collect_types_cache
370 if cache.has_key(mtype) then
371 return cache[mtype]
372 end
373 var types = new Array[MClassType]
374 var mainmodule = self.compiler.mainmodule
375 for t in self.compiler.runtime_type_analysis.live_types do
376 if not t.is_subtype(mainmodule, null, mtype) then continue
377 types.add(t)
378 end
379 cache[mtype] = types
380 return types
381 end
382
383 redef fun native_array_def(pname, ret_type, arguments)
384 do
385 var elttype = arguments.first.mtype
386 var recv = "((struct {arguments[0].mcasttype.c_name}*){arguments[0]})->values"
387 if pname == "[]" then
388 self.ret(self.new_expr("{recv}[{arguments[1]}]", ret_type.as(not null)))
389 return
390 else if pname == "[]=" then
391 self.add("{recv}[{arguments[1]}]={arguments[2]};")
392 return
393 else if pname == "length" then
394 self.ret(self.new_expr("((struct {arguments[0].mcasttype.c_name}*){arguments[0]})->length", ret_type.as(not null)))
395 return
396 else if pname == "copy_to" then
397 var recv1 = "((struct {arguments[1].mcasttype.c_name}*){arguments[1]})->values"
398 self.add("memmove({recv1},{recv},{arguments[2]}*sizeof({elttype.ctype}));")
399 return
400 end
401 end
402
403 redef fun native_array_instance(elttype: MType, length: RuntimeVariable): RuntimeVariable
404 do
405 var ret_type = mmodule.native_array_type(elttype)
406 ret_type = anchor(ret_type).as(MClassType)
407 return self.new_expr("NEW_{ret_type.c_name}({length})", ret_type)
408 end
409
410 redef fun native_array_get(nat, i)
411 do
412 var recv = "((struct {nat.mcasttype.c_name}*){nat})->values"
413 var ret_type = nat.mcasttype.as(MClassType).arguments.first
414 return self.new_expr("{recv}[{i}]", ret_type)
415 end
416
417 redef fun native_array_set(nat, i, val)
418 do
419 var recv = "((struct {nat.mcasttype.c_name}*){nat})->values"
420 self.add("{recv}[{i}]={val};")
421 end
422
423 redef fun calloc_array(ret_type, arguments)
424 do
425 self.ret(self.new_expr("NEW_{ret_type.c_name}({arguments[1]})", ret_type))
426 end
427
428 redef fun send(m, args)
429 do
430 var types = self.collect_types(args.first)
431
432 var res: nullable RuntimeVariable
433 var ret = m.intro.msignature.return_mtype
434 if ret == null then
435 res = null
436 else
437 ret = self.resolve_for(ret, args.first)
438 res = self.new_var(ret)
439 end
440
441 self.add("/* send {m} on {args.first.inspect} */")
442 if args.first.mtype.is_c_primitive then
443 var mclasstype = args.first.mtype.as(MClassType)
444 if not self.compiler.runtime_type_analysis.live_types.has(mclasstype) then
445 self.add("/* skip, no method {m} */")
446 return res
447 end
448 var propdef = m.lookup_first_definition(self.compiler.mainmodule, mclasstype)
449 var res2 = self.call(propdef, mclasstype, args)
450 if res != null then self.assign(res, res2.as(not null))
451 return res
452 end
453 var consider_null = not self.compiler.modelbuilder.toolcontext.opt_no_check_null.value or m.name == "==" or m.name == "!="
454 if args.first.mcasttype isa MNullableType or args.first.mcasttype isa MNullType and consider_null then
455 # The reciever is potentially null, so we have to 3 cases: ==, != or NullPointerException
456 self.add("if ({args.first} == NULL) \{ /* Special null case */")
457 if m.name == "==" or m.name == "is_same_instance" then
458 assert res != null
459 if args[1].mcasttype isa MNullableType then
460 self.add("{res} = ({args[1]} == NULL);")
461 else if args[1].mcasttype isa MNullType then
462 self.add("{res} = 1; /* is null */")
463 else
464 self.add("{res} = 0; /* {args[1].inspect} cannot be null */")
465 end
466 else if m.name == "!=" then
467 assert res != null
468 if args[1].mcasttype isa MNullableType then
469 self.add("{res} = ({args[1]} != NULL);")
470 else if args[1].mcasttype isa MNullType then
471 self.add("{res} = 0; /* is null */")
472 else
473 self.add("{res} = 1; /* {args[1].inspect} cannot be null */")
474 end
475 else
476 self.add_abort("Receiver is null")
477 end
478 self.add "\} else"
479 end
480 if types.is_empty then
481 self.add("\{")
482 self.add("/*BUG: no live types for {args.first.inspect} . {m}*/")
483 self.bugtype(args.first)
484 self.add("\}")
485 return res
486 end
487
488 self.add("switch({args.first}->classid) \{")
489 var last = types.last
490 var defaultpropdef: nullable MMethodDef = null
491 for t in types do
492 var propdef = m.lookup_first_definition(self.compiler.mainmodule, t)
493 if propdef.mclassdef.mclass.name == "Object" and not t.is_c_primitive then
494 defaultpropdef = propdef
495 continue
496 end
497 if not self.compiler.hardening and t == last and defaultpropdef == null then
498 self.add("default: /* test {t} */")
499 else
500 self.add("case {self.compiler.classid(t)}: /* test {t} */")
501 end
502 var res2 = self.call(propdef, t, args)
503 if res != null then self.assign(res, res2.as(not null))
504 self.add "break;"
505 end
506 if defaultpropdef != null then
507 self.add("default: /* default is Object */")
508 var res2 = self.call(defaultpropdef, defaultpropdef.mclassdef.bound_mtype, args)
509 if res != null then self.assign(res, res2.as(not null))
510 else if self.compiler.hardening then
511 self.add("default: /* bug */")
512 self.bugtype(args.first)
513 end
514 self.add("\}")
515 return res
516 end
517
518 fun check_valid_reciever(recvtype: MClassType)
519 do
520 if self.compiler.runtime_type_analysis.live_types.has(recvtype) or recvtype.mclass.name == "Object" then return
521 print "{recvtype} is not a live type"
522 abort
523 end
524
525 # Subpart of old call function
526 #
527 # Checks if the type of the receiver is valid and corrects it if necessary
528 private fun get_recvtype(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): MClassType
529 do
530 check_valid_reciever(recvtype)
531 return recvtype
532 end
533
534 redef fun call(m, recvtype, args)
535 do
536 var recv_type = get_recvtype(m, recvtype, args)
537 var recv = self.autoadapt(self.autobox(args.first, recvtype), recvtype)
538 if m.is_extern then recv = unbox_extern(recv, recv_type)
539
540 args = args.to_a
541 args.first = recv
542
543 assert args.length == m.msignature.arity + 1 else debug("Invalid arity for {m}. {args.length} arguments given.")
544
545 var rm = new CustomizedRuntimeFunction(m, recvtype)
546 return rm.call(self, args)
547 end
548
549 redef fun supercall(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): nullable RuntimeVariable
550 do
551 var types = self.collect_types(args.first)
552
553 var res: nullable RuntimeVariable
554 var ret = m.mproperty.intro.msignature.return_mtype
555 if ret == null then
556 res = null
557 else
558 ret = self.resolve_for(ret, args.first)
559 res = self.new_var(ret)
560 end
561
562 self.add("/* super {m} on {args.first.inspect} */")
563 if args.first.mtype.is_c_primitive then
564 var mclasstype = args.first.mtype.as(MClassType)
565 if not self.compiler.runtime_type_analysis.live_types.has(mclasstype) then
566 self.add("/* skip, no method {m} */")
567 return res
568 end
569 var propdef = m.lookup_next_definition(self.compiler.mainmodule, mclasstype)
570 var res2 = self.call(propdef, mclasstype, args)
571 if res != null then self.assign(res, res2.as(not null))
572 return res
573 end
574
575 if types.is_empty then
576 self.add("\{")
577 self.add("/*BUG: no live types for {args.first.inspect} . {m}*/")
578 self.bugtype(args.first)
579 self.add("\}")
580 return res
581 end
582
583 self.add("switch({args.first}->classid) \{")
584 var last = types.last
585 for t in types do
586 var propdef = m.lookup_next_definition(self.compiler.mainmodule, t)
587 if not self.compiler.hardening and t == last then
588 self.add("default: /* test {t} */")
589 else
590 self.add("case {self.compiler.classid(t)}: /* test {t} */")
591 end
592 var res2 = self.call(propdef, t, args)
593 if res != null then self.assign(res, res2.as(not null))
594 self.add "break;"
595 end
596 if self.compiler.hardening then
597 self.add("default: /* bug */")
598 self.bugtype(args.first)
599 end
600 self.add("\}")
601 return res
602 end
603
604 redef fun adapt_signature(m, args)
605 do
606 var recv = args.first
607 for i in [0..m.msignature.arity[ do
608 var t = m.msignature.mparameters[i].mtype
609 if i == m.msignature.vararg_rank then
610 t = args[i+1].mtype
611 end
612 t = self.resolve_for(t, recv)
613 args[i+1] = self.autobox(args[i+1], t)
614 end
615 end
616
617 redef fun unbox_signature_extern(m, args)
618 do
619 var recv = args.first
620 for i in [0..m.msignature.arity[ do
621 var t = m.msignature.mparameters[i].mtype
622 if i == m.msignature.vararg_rank then
623 t = args[i+1].mtype
624 end
625 t = self.resolve_for(t, recv)
626 if m.is_extern then args[i+1] = self.unbox_extern(args[i+1], t)
627 end
628 end
629
630 # FIXME: this is currently buggy since recv is not exact
631 redef fun vararg_instance(mpropdef, recv, varargs, elttype)
632 do
633 elttype = self.resolve_for(elttype, recv)
634 return self.array_instance(varargs, elttype)
635 end
636
637 fun bugtype(recv: RuntimeVariable)
638 do
639 if recv.mtype.is_c_primitive then return
640 self.add("PRINT_ERROR(\"BTD BUG: Dynamic type is %s, static type is %s\\n\", class_names[{recv}->classid], \"{recv.mcasttype}\");")
641 self.add("fatal_exit(1);")
642 end
643
644 redef fun isset_attribute(a, recv)
645 do
646 check_recv_notnull(recv)
647
648 var types = self.collect_types(recv)
649 var res = self.new_var(bool_type)
650
651 if types.is_empty then
652 self.add("/*BUG: no live types for {recv.inspect} . {a}*/")
653 self.bugtype(recv)
654 return res
655 end
656 self.add("/* isset {a} on {recv.inspect} */")
657 self.add("switch({recv}->classid) \{")
658 var last = types.last
659 for t in types do
660 if not self.compiler.hardening and t == last then
661 self.add("default: /*{self.compiler.classid(t)}*/")
662 else
663 self.add("case {self.compiler.classid(t)}:")
664 end
665 var recv2 = self.autoadapt(recv, t)
666 var ta = a.intro.static_mtype.as(not null)
667 ta = self.resolve_for(ta, recv2)
668 var attr = self.new_expr("((struct {t.c_name}*){recv})->{a.intro.c_name}", ta)
669 if not ta isa MNullableType then
670 if not ta.is_c_primitive then
671 self.add("{res} = ({attr} != NULL);")
672 else
673 self.add("{res} = 1; /*NOTYET isset on primitive attributes*/")
674 end
675 end
676 self.add("break;")
677 end
678 if self.compiler.hardening then
679 self.add("default: /* Bug */")
680 self.bugtype(recv)
681 end
682 self.add("\}")
683
684 return res
685 end
686
687 redef fun read_attribute(a, recv)
688 do
689 check_recv_notnull(recv)
690
691 var types = self.collect_types(recv)
692
693 var ret = a.intro.static_mtype.as(not null)
694 ret = self.resolve_for(ret, recv)
695 var res = self.new_var(ret)
696
697 if types.is_empty then
698 self.add("/*BUG: no live types for {recv.inspect} . {a}*/")
699 self.bugtype(recv)
700 return res
701 end
702 self.add("/* read {a} on {recv.inspect} */")
703 self.add("switch({recv}->classid) \{")
704 var last = types.last
705 for t in types do
706 if not self.compiler.hardening and t == last then
707 self.add("default: /*{self.compiler.classid(t)}*/")
708 else
709 self.add("case {self.compiler.classid(t)}:")
710 end
711 var recv2 = self.autoadapt(recv, t)
712 var ta = a.intro.static_mtype.as(not null)
713 ta = self.resolve_for(ta, recv2)
714 var res2 = self.new_expr("((struct {t.c_name}*){recv})->{a.intro.c_name}", ta)
715 if not ta isa MNullableType and not self.compiler.modelbuilder.toolcontext.opt_no_check_attr_isset.value then
716 if not ta.is_c_primitive then
717 self.add("if ({res2} == NULL) \{")
718 self.add_abort("Uninitialized attribute {a.name}")
719 self.add("\}")
720 else
721 self.add("/*NOTYET isset on primitive attributes*/")
722 end
723 end
724 self.assign(res, res2)
725 self.add("break;")
726 end
727 if self.compiler.hardening then
728 self.add("default: /* Bug */")
729 self.bugtype(recv)
730 end
731 self.add("\}")
732
733 return res
734 end
735
736 redef fun write_attribute(a, recv, value)
737 do
738 check_recv_notnull(recv)
739
740 var types = self.collect_types(recv)
741
742 if types.is_empty then
743 self.add("/*BUG: no live types for {recv.inspect} . {a}*/")
744 self.bugtype(recv)
745 return
746 end
747 self.add("/* write {a} on {recv.inspect} */")
748 self.add("switch({recv}->classid) \{")
749 var last = types.last
750 for t in types do
751 if not self.compiler.hardening and t == last then
752 self.add("default: /*{self.compiler.classid(t)}*/")
753 else
754 self.add("case {self.compiler.classid(t)}:")
755 end
756 var recv2 = self.autoadapt(recv, t)
757 var ta = a.intro.static_mtype.as(not null)
758 ta = self.resolve_for(ta, recv2)
759 self.add("((struct {t.c_name}*){recv})->{a.intro.c_name} = {self.autobox(value, ta)};")
760 self.add("break;")
761 end
762 if self.compiler.hardening then
763 self.add("default: /* Bug*/")
764 self.bugtype(recv)
765 end
766 self.add("\}")
767 end
768
769 redef fun init_instance(mtype)
770 do
771 mtype = self.anchor(mtype).as(MClassType)
772 if not self.compiler.runtime_type_analysis.live_types.has(mtype) then
773 debug "problem: {mtype} was detected dead"
774 end
775 var res = self.new_expr("NEW_{mtype.c_name}()", mtype)
776 res.is_exact = true
777 return res
778 end
779
780 redef fun type_test(value, mtype, tag)
781 do
782 mtype = self.anchor(mtype)
783 if not self.compiler.runtime_type_analysis.live_cast_types.has(mtype) then
784 debug "problem: {mtype} was detected cast-dead"
785 abort
786 end
787
788 var types = self.collect_types(value)
789 var res = self.new_var(bool_type)
790
791 self.add("/* isa {mtype} on {value.inspect} */")
792 if value.mtype.is_c_primitive then
793 if value.mtype.is_subtype(self.compiler.mainmodule, null, mtype) then
794 self.add("{res} = 1;")
795 else
796 self.add("{res} = 0;")
797 end
798 return res
799 end
800 if value.mcasttype isa MNullableType or value.mcasttype isa MNullType then
801 self.add("if ({value} == NULL) \{")
802 if mtype isa MNullableType then
803 self.add("{res} = 1; /* isa {mtype} */")
804 else
805 self.add("{res} = 0; /* not isa {mtype} */")
806 end
807 self.add("\} else ")
808 end
809 self.add("switch({value}->classid) \{")
810 for t in types do
811 if t.is_subtype(self.compiler.mainmodule, null, mtype) then
812 self.add("case {self.compiler.classid(t)}: /* {t} */")
813 end
814 end
815 self.add("{res} = 1;")
816 self.add("break;")
817 self.add("default:")
818 self.add("{res} = 0;")
819 self.add("\}")
820
821 return res
822 end
823
824 redef fun is_same_type_test(value1, value2)
825 do
826 var res = self.new_var(bool_type)
827 if not value2.mtype.is_c_primitive then
828 if not value1.mtype.is_c_primitive then
829 self.add "{res} = {value1}->classid == {value2}->classid;"
830 else
831 self.add "{res} = {self.compiler.classid(value1.mtype.as(MClassType))} == {value2}->classid;"
832 end
833 else
834 if not value1.mtype.is_c_primitive then
835 self.add "{res} = {value1}->classid == {self.compiler.classid(value2.mtype.as(MClassType))};"
836 else if value1.mcasttype == value2.mcasttype then
837 self.add "{res} = 1;"
838 else
839 self.add "{res} = 0;"
840 end
841 end
842 return res
843 end
844
845 redef fun class_name_string(value)
846 do
847 var res = self.get_name("var_class_name")
848 self.add_decl("const char* {res};")
849 if not value.mtype.is_c_primitive then
850 self.add "{res} = class_names[{value}->classid];"
851 else
852 self.add "{res} = class_names[{self.compiler.classid(value.mtype.as(MClassType))}];"
853 end
854 return res
855 end
856
857 redef fun equal_test(value1, value2)
858 do
859 var res = self.new_var(bool_type)
860 if value2.mtype.is_c_primitive and not value1.mtype.is_c_primitive then
861 var tmp = value1
862 value1 = value2
863 value2 = tmp
864 end
865 if value1.mtype.is_c_primitive then
866 if value2.mtype == value1.mtype then
867 self.add("{res} = {value1} == {value2};")
868 else if value2.mtype.is_c_primitive then
869 self.add("{res} = 0; /* incompatible types {value1.mtype} vs. {value2.mtype}*/")
870 else
871 var mtype1 = value1.mtype.as(MClassType)
872 self.add("{res} = ({value2} != NULL) && ({value2}->classid == {self.compiler.classid(mtype1)});")
873 self.add("if ({res}) \{")
874 self.add("{res} = ({self.autobox(value2, value1.mtype)} == {value1});")
875 self.add("\}")
876 end
877 else
878 var s = new Array[String]
879 for t in self.compiler.live_primitive_types do
880 if not t.is_subtype(self.compiler.mainmodule, null, value1.mcasttype) then continue
881 if not t.is_subtype(self.compiler.mainmodule, null, value2.mcasttype) then continue
882 s.add "({value1}->classid == {self.compiler.classid(t)} && ((struct {t.c_name}*){value1})->value == ((struct {t.c_name}*){value2})->value)"
883 end
884
885 if self.compiler.mainmodule.model.get_mclasses_by_name("Pointer") != null then
886 var pointer_type = self.compiler.mainmodule.pointer_type
887 if value1.mcasttype.is_subtype(self.compiler.mainmodule, null, pointer_type) or
888 value2.mcasttype.is_subtype(self.compiler.mainmodule, null, pointer_type) then
889 s.add "(((struct {pointer_type.c_name}*){value1})->value == ((struct {pointer_type.c_name}*){value2})->value)"
890 end
891 end
892
893 if s.is_empty then
894 self.add("{res} = {value1} == {value2};")
895 else
896 self.add("{res} = {value1} == {value2} || ({value1} != NULL && {value2} != NULL && {value1}->classid == {value2}->classid && ({s.join(" || ")}));")
897 end
898 end
899 return res
900 end
901
902 redef fun array_instance(array, elttype)
903 do
904 elttype = self.anchor(elttype)
905 var arraytype = mmodule.array_type(elttype)
906 var res = self.init_instance(arraytype)
907 self.add("\{ /* {res} = array_instance Array[{elttype}] */")
908 var nat = self.new_var(mmodule.native_array_type(elttype))
909 nat.is_exact = true
910 self.add("{nat} = NEW_{nat.mtype.c_name}({array.length});")
911 for i in [0..array.length[ do
912 var r = self.autobox(array[i], elttype)
913 self.add("((struct {nat.mtype.c_name}*) {nat})->values[{i}] = {r};")
914 end
915 var length = self.int_instance(array.length)
916 self.send(self.get_property("with_native", arraytype), [res, nat, length])
917 self.add("\}")
918 return res
919 end
920 end
921
922 # A runtime function customized on a specific monomrph receiver type
923 private class CustomizedRuntimeFunction
924 super AbstractRuntimeFunction
925
926 redef type COMPILER: GlobalCompiler
927 redef type VISITOR: GlobalCompilerVisitor
928
929 # The considered reciever
930 # (usually is a live type but no strong guarantee)
931 var recv: MClassType
932
933 redef fun build_c_name
934 do
935 var res = self.c_name_cache
936 if res != null then return res
937 if self.mmethoddef.mclassdef.bound_mtype == self.recv then
938 res = self.mmethoddef.c_name
939 else
940 res = "{mmethoddef.c_name}__{recv.c_name}"
941 end
942 self.c_name_cache = res
943 return res
944 end
945
946 # used in the compiler worklist
947 redef fun ==(o)
948 do
949 if not o isa CustomizedRuntimeFunction then return false
950 if self.mmethoddef != o.mmethoddef then return false
951 if self.recv != o.recv then return false
952 return true
953 end
954
955 # used in the compiler work-list
956 redef fun hash do return self.mmethoddef.hash + self.recv.hash
957
958 redef fun to_s
959 do
960 if self.mmethoddef.mclassdef.bound_mtype == self.recv then
961 return self.mmethoddef.to_s
962 else
963 return "{self.mmethoddef}@{self.recv}"
964 end
965 end
966
967 # compile the code customized for the reciever
968 redef fun compile_to_c(compiler)
969 do
970 var recv = self.recv
971 var mmethoddef = self.mmethoddef
972 if not recv.is_subtype(compiler.mainmodule, null, mmethoddef.mclassdef.bound_mtype) then
973 print("problem: why do we compile {self} for {recv}?")
974 abort
975 end
976
977 var v = compiler.new_visitor
978 var selfvar = new RuntimeVariable("self", recv, recv)
979 if compiler.runtime_type_analysis.live_types.has(recv) then
980 selfvar.is_exact = true
981 end
982 var arguments = new Array[RuntimeVariable]
983 var frame = new StaticFrame(v, mmethoddef, recv, arguments)
984 v.frame = frame
985
986 var sig = new FlatBuffer
987 var comment = new FlatBuffer
988 var ret = mmethoddef.msignature.return_mtype
989 if ret != null then
990 ret = v.resolve_for(ret, selfvar)
991 sig.append("{ret.ctype} ")
992 else
993 sig.append("void ")
994 end
995 sig.append(self.c_name)
996 sig.append("({recv.ctype} {selfvar}")
997 comment.append("(self: {recv}")
998 arguments.add(selfvar)
999 for i in [0..mmethoddef.msignature.arity[ do
1000 var mtype = mmethoddef.msignature.mparameters[i].mtype
1001 if i == mmethoddef.msignature.vararg_rank then
1002 mtype = v.mmodule.array_type(mtype)
1003 end
1004 mtype = v.resolve_for(mtype, selfvar)
1005 comment.append(", {mtype}")
1006 sig.append(", {mtype.ctype} p{i}")
1007 var argvar = new RuntimeVariable("p{i}", mtype, mtype)
1008 arguments.add(argvar)
1009 end
1010 sig.append(")")
1011 comment.append(")")
1012 if ret != null then
1013 comment.append(": {ret}")
1014 end
1015 compiler.header.add_decl("{sig};")
1016
1017 v.add_decl("/* method {self} for {comment} */")
1018 v.add_decl("{sig} \{")
1019 #v.add("printf(\"method {self} for {comment}\\n\");")
1020 if ret != null then
1021 frame.returnvar = v.new_var(ret)
1022 end
1023 frame.returnlabel = v.get_name("RET_LABEL")
1024
1025 mmethoddef.compile_inside_to_c(v, arguments)
1026
1027 v.add("{frame.returnlabel.as(not null)}:;")
1028 if ret != null then
1029 v.add("return {frame.returnvar.as(not null)};")
1030 end
1031 v.add("\}")
1032 if not self.c_name.has_substring("VIRTUAL", 0) then compiler.names[self.c_name] = "{mmethoddef.mclassdef.mmodule.name}::{mmethoddef.mclassdef.mclass.name}::{mmethoddef.mproperty.name} ({mmethoddef.location.file.filename}:{mmethoddef.location.line_start})"
1033 end
1034
1035 redef fun call(v: VISITOR, arguments: Array[RuntimeVariable]): nullable RuntimeVariable
1036 do
1037 var ret = self.mmethoddef.msignature.return_mtype
1038 if ret != null then
1039 ret = v.resolve_for(ret, arguments.first)
1040 end
1041 if self.mmethoddef.can_inline(v) then
1042 var frame = new StaticFrame(v, self.mmethoddef, self.recv, arguments)
1043 frame.returnlabel = v.get_name("RET_LABEL")
1044 if ret != null then
1045 frame.returnvar = v.new_var(ret)
1046 end
1047 var old_frame = v.frame
1048 v.frame = frame
1049 v.add("\{ /* Inline {self} ({arguments.join(",")}) */")
1050 self.mmethoddef.compile_inside_to_c(v, arguments)
1051 v.add("{frame.returnlabel.as(not null)}:(void)0;")
1052 v.add("\}")
1053 v.frame = old_frame
1054 return frame.returnvar
1055 end
1056 v.adapt_signature(self.mmethoddef, arguments)
1057 v.compiler.todo(self)
1058 if ret == null then
1059 v.add("{self.c_name}({arguments.join(",")});")
1060 return null
1061 else
1062 var res = v.new_var(ret)
1063 v.add("{res} = {self.c_name}({arguments.join(",")});")
1064 return res
1065 end
1066 end
1067 end