compiler: intern methods on NativeArray can fallback instead of no-op
[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 v.add("{res} = nit_alloc(sizeof(struct {mtype.c_name}) + length*sizeof(val*));")
250 v.add("((struct {mtype.c_name}*){res})->length = length;")
251 else
252 v.add("{res} = nit_alloc(sizeof(struct {mtype.c_name}));")
253 end
254 v.add("{res}->classid = {self.classid(mtype)};")
255
256 self.generate_init_attr(v, res, mtype)
257 v.set_finalizer res
258 v.add("return {res};")
259 v.add("\}")
260 end
261
262 fun generate_box_instance(mtype: MClassType)
263 do
264 assert self.runtime_type_analysis.live_types.has(mtype)
265 var v = self.new_visitor
266
267 self.header.add_decl("val* BOX_{mtype.c_name}({mtype.ctype});")
268 v.add_decl("/* allocate {mtype} */")
269 v.add_decl("val* BOX_{mtype.c_name}({mtype.ctype} value) \{")
270 v.add("struct {mtype.c_name}*res = nit_alloc(sizeof(struct {mtype.c_name}));")
271 v.add("res->classid = {self.classid(mtype)};")
272 v.add("res->value = value;")
273 v.add("return (val*)res;")
274 v.add("\}")
275 end
276
277 redef fun new_visitor do return new GlobalCompilerVisitor(self)
278
279 private var collect_types_cache: HashMap[MType, Array[MClassType]] = new HashMap[MType, Array[MClassType]]
280
281 redef fun compile_nitni_structs
282 do
283 self.header.add_decl """
284 struct nitni_instance \{
285 struct nitni_instance *next,
286 *prev; /* adjacent global references in global list */
287 int count; /* number of time this global reference has been marked */
288 val *value;
289 \};"""
290 super
291 end
292 end
293
294 # A visitor on the AST of property definition that generate the C code.
295 # Because of inlining, a visitor can visit more than one property.
296 class GlobalCompilerVisitor
297 super AbstractCompilerVisitor
298
299 redef type COMPILER: GlobalCompiler
300
301 redef fun autobox(value, mtype)
302 do
303 if value.mtype == mtype then
304 return value
305 else if not value.mtype.is_c_primitive and not mtype.is_c_primitive then
306 return value
307 else if not value.mtype.is_c_primitive then
308 return self.new_expr("((struct {mtype.c_name}*){value})->value; /* autounbox from {value.mtype} to {mtype} */", mtype)
309 else if not mtype.is_c_primitive then
310 var valtype = value.mtype.as(MClassType)
311 var res = self.new_var(mtype)
312 if not compiler.runtime_type_analysis.live_types.has(valtype) then
313 self.add("/*no autobox from {value.mtype} to {mtype}: {value.mtype} is not live! */")
314 self.add("PRINT_ERROR(\"Dead code executed!\\n\"); fatal_exit(1);")
315 return res
316 end
317 self.add("{res} = BOX_{valtype.c_name}({value}); /* autobox from {value.mtype} to {mtype} */")
318 return res
319 else if value.mtype.ctype == "void*" and mtype.ctype == "void*" then
320 return value
321 else
322 # Bad things will appen!
323 var res = self.new_var(mtype)
324 self.add("/* {res} left unintialized (cannot convert {value.mtype} to {mtype}) */")
325 self.add("PRINT_ERROR(\"Cast error: Cannot cast %s to %s.\\n\", \"{value.mtype}\", \"{mtype}\"); fatal_exit(1);")
326 return res
327 end
328 end
329
330 redef fun unbox_extern(value, mtype)
331 do
332 if mtype isa MClassType and mtype.mclass.kind == extern_kind and
333 mtype.mclass.name != "NativeString" then
334 var res = self.new_var_extern(mtype)
335 self.add "{res} = ((struct {mtype.c_name}*){value})->value; /* unboxing {value.mtype} */"
336 return res
337 else
338 return value
339 end
340 end
341
342 redef fun box_extern(value, mtype)
343 do
344 if not mtype isa MClassType or mtype.mclass.kind != extern_kind or
345 mtype.mclass.name == "NativeString" then return value
346
347 var valtype = value.mtype.as(MClassType)
348 var res = self.new_var(mtype)
349 if not compiler.runtime_type_analysis.live_types.has(value.mtype.as(MClassType)) then
350 self.add("/*no boxing of {value.mtype}: {value.mtype} is not live! */")
351 self.add("PRINT_ERROR(\"Dead code executed!\\n\"); fatal_exit(1);")
352 return res
353 end
354 self.add("{res} = BOX_{valtype.c_name}({value}); /* boxing {value.mtype} */")
355 return res
356 end
357
358 # The runtime types that are acceptable for a given receiver.
359 fun collect_types(recv: RuntimeVariable): Array[MClassType]
360 do
361 var mtype = recv.mcasttype
362 if recv.is_exact then
363 assert mtype isa MClassType
364 assert self.compiler.runtime_type_analysis.live_types.has(mtype)
365 var types = [mtype]
366 return types
367 end
368 var cache = self.compiler.collect_types_cache
369 if cache.has_key(mtype) then
370 return cache[mtype]
371 end
372 var types = new Array[MClassType]
373 var mainmodule = self.compiler.mainmodule
374 for t in self.compiler.runtime_type_analysis.live_types do
375 if not t.is_subtype(mainmodule, null, mtype) then continue
376 types.add(t)
377 end
378 cache[mtype] = types
379 return types
380 end
381
382 redef fun native_array_def(pname, ret_type, arguments)
383 do
384 var elttype = arguments.first.mtype
385 var recv = "((struct {arguments[0].mcasttype.c_name}*){arguments[0]})->values"
386 if pname == "[]" then
387 self.ret(self.new_expr("{recv}[{arguments[1]}]", ret_type.as(not null)))
388 return true
389 else if pname == "[]=" then
390 self.add("{recv}[{arguments[1]}]={arguments[2]};")
391 return true
392 else if pname == "length" then
393 self.ret(self.new_expr("((struct {arguments[0].mcasttype.c_name}*){arguments[0]})->length", ret_type.as(not null)))
394 return true
395 else if pname == "copy_to" then
396 var recv1 = "((struct {arguments[1].mcasttype.c_name}*){arguments[1]})->values"
397 self.add("memmove({recv1},{recv},{arguments[2]}*sizeof({elttype.ctype}));")
398 return true
399 end
400 return false
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 length = autobox(length, compiler.mainmodule.int_type)
408 return self.new_expr("NEW_{ret_type.c_name}({length})", ret_type)
409 end
410
411 redef fun native_array_get(nat, i)
412 do
413 var recv = "((struct {nat.mcasttype.c_name}*){nat})->values"
414 var ret_type = nat.mcasttype.as(MClassType).arguments.first
415 return self.new_expr("{recv}[{i}]", ret_type)
416 end
417
418 redef fun native_array_set(nat, i, val)
419 do
420 var recv = "((struct {nat.mcasttype.c_name}*){nat})->values"
421 self.add("{recv}[{i}]={val};")
422 end
423
424 redef fun calloc_array(ret_type, arguments)
425 do
426 self.ret(self.new_expr("NEW_{ret_type.c_name}({arguments[1]})", ret_type))
427 end
428
429 redef fun send(m, args)
430 do
431 var types = self.collect_types(args.first)
432
433 var res: nullable RuntimeVariable
434 var ret = m.intro.msignature.return_mtype
435 if ret == null then
436 res = null
437 else
438 ret = self.resolve_for(ret, args.first)
439 res = self.new_var(ret)
440 end
441
442 self.add("/* send {m} on {args.first.inspect} */")
443 if args.first.mtype.is_c_primitive then
444 var mclasstype = args.first.mtype.as(MClassType)
445 if not self.compiler.runtime_type_analysis.live_types.has(mclasstype) then
446 self.add("/* skip, no method {m} */")
447 return res
448 end
449 var propdef = m.lookup_first_definition(self.compiler.mainmodule, mclasstype)
450 var res2 = self.call(propdef, mclasstype, args)
451 if res != null then self.assign(res, res2.as(not null))
452 return res
453 end
454 var consider_null = not self.compiler.modelbuilder.toolcontext.opt_no_check_null.value or m.name == "==" or m.name == "!="
455 if args.first.mcasttype isa MNullableType or args.first.mcasttype isa MNullType and consider_null then
456 # The reciever is potentially null, so we have to 3 cases: ==, != or NullPointerException
457 self.add("if ({args.first} == NULL) \{ /* Special null case */")
458 if m.name == "==" or m.name == "is_same_instance" then
459 assert res != null
460 if args[1].mcasttype isa MNullableType then
461 self.add("{res} = ({args[1]} == NULL);")
462 else if args[1].mcasttype isa MNullType then
463 self.add("{res} = 1; /* is null */")
464 else
465 self.add("{res} = 0; /* {args[1].inspect} cannot be null */")
466 end
467 else if m.name == "!=" then
468 assert res != null
469 if args[1].mcasttype isa MNullableType then
470 self.add("{res} = ({args[1]} != NULL);")
471 else if args[1].mcasttype isa MNullType then
472 self.add("{res} = 0; /* is null */")
473 else
474 self.add("{res} = 1; /* {args[1].inspect} cannot be null */")
475 end
476 else
477 self.add_abort("Receiver is null")
478 end
479 self.add "\} else"
480 end
481 if types.is_empty then
482 self.add("\{")
483 self.add("/*BUG: no live types for {args.first.inspect} . {m}*/")
484 self.bugtype(args.first)
485 self.add("\}")
486 return res
487 end
488
489 self.add("switch({args.first}->classid) \{")
490 var last = types.last
491 var defaultpropdef: nullable MMethodDef = null
492 for t in types do
493 var propdef = m.lookup_first_definition(self.compiler.mainmodule, t)
494 if propdef.mclassdef.mclass.name == "Object" and not t.is_c_primitive then
495 defaultpropdef = propdef
496 continue
497 end
498 if not self.compiler.hardening and t == last and defaultpropdef == null then
499 self.add("default: /* test {t} */")
500 else
501 self.add("case {self.compiler.classid(t)}: /* test {t} */")
502 end
503 var res2 = self.call(propdef, t, args)
504 if res != null then self.assign(res, res2.as(not null))
505 self.add "break;"
506 end
507 if defaultpropdef != null then
508 self.add("default: /* default is Object */")
509 var res2 = self.call(defaultpropdef, defaultpropdef.mclassdef.bound_mtype, args)
510 if res != null then self.assign(res, res2.as(not null))
511 else if self.compiler.hardening then
512 self.add("default: /* bug */")
513 self.bugtype(args.first)
514 end
515 self.add("\}")
516 return res
517 end
518
519 fun check_valid_reciever(recvtype: MClassType)
520 do
521 if self.compiler.runtime_type_analysis.live_types.has(recvtype) or recvtype.mclass.name == "Object" then return
522 print "{recvtype} is not a live type"
523 abort
524 end
525
526 # Subpart of old call function
527 #
528 # Checks if the type of the receiver is valid and corrects it if necessary
529 private fun get_recvtype(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): MClassType
530 do
531 check_valid_reciever(recvtype)
532 return recvtype
533 end
534
535 redef fun call(m, recvtype, args)
536 do
537 var recv_type = get_recvtype(m, recvtype, args)
538 var recv = self.autoadapt(self.autobox(args.first, recvtype), recvtype)
539 if m.is_extern then recv = unbox_extern(recv, recv_type)
540
541 args = args.to_a
542 args.first = recv
543
544 assert args.length == m.msignature.arity + 1 else debug("Invalid arity for {m}. {args.length} arguments given.")
545
546 var rm = new CustomizedRuntimeFunction(m, recvtype)
547 return rm.call(self, args)
548 end
549
550 redef fun supercall(m: MMethodDef, recvtype: MClassType, args: Array[RuntimeVariable]): nullable RuntimeVariable
551 do
552 var types = self.collect_types(args.first)
553
554 var res: nullable RuntimeVariable
555 var ret = m.mproperty.intro.msignature.return_mtype
556 if ret == null then
557 res = null
558 else
559 ret = self.resolve_for(ret, args.first)
560 res = self.new_var(ret)
561 end
562
563 self.add("/* super {m} on {args.first.inspect} */")
564 if args.first.mtype.is_c_primitive then
565 var mclasstype = args.first.mtype.as(MClassType)
566 if not self.compiler.runtime_type_analysis.live_types.has(mclasstype) then
567 self.add("/* skip, no method {m} */")
568 return res
569 end
570 var propdef = m.lookup_next_definition(self.compiler.mainmodule, mclasstype)
571 var res2 = self.call(propdef, mclasstype, args)
572 if res != null then self.assign(res, res2.as(not null))
573 return res
574 end
575
576 if types.is_empty then
577 self.add("\{")
578 self.add("/*BUG: no live types for {args.first.inspect} . {m}*/")
579 self.bugtype(args.first)
580 self.add("\}")
581 return res
582 end
583
584 self.add("switch({args.first}->classid) \{")
585 var last = types.last
586 for t in types do
587 var propdef = m.lookup_next_definition(self.compiler.mainmodule, t)
588 if not self.compiler.hardening and t == last then
589 self.add("default: /* test {t} */")
590 else
591 self.add("case {self.compiler.classid(t)}: /* test {t} */")
592 end
593 var res2 = self.call(propdef, t, args)
594 if res != null then self.assign(res, res2.as(not null))
595 self.add "break;"
596 end
597 if self.compiler.hardening then
598 self.add("default: /* bug */")
599 self.bugtype(args.first)
600 end
601 self.add("\}")
602 return res
603 end
604
605 redef fun adapt_signature(m, args)
606 do
607 var recv = args.first
608 for i in [0..m.msignature.arity[ do
609 var mp = m.msignature.mparameters[i]
610 var t = mp.mtype
611 if mp.is_vararg then
612 t = args[i+1].mtype
613 end
614 t = self.resolve_for(t, recv)
615 args[i+1] = self.autobox(args[i+1], t)
616 end
617 end
618
619 redef fun unbox_signature_extern(m, args)
620 do
621 var recv = args.first
622 for i in [0..m.msignature.arity[ do
623 var mp = m.msignature.mparameters[i]
624 var t = mp.mtype
625 if mp.is_vararg then
626 t = args[i+1].mtype
627 end
628 t = self.resolve_for(t, recv)
629 if m.is_extern then args[i+1] = self.unbox_extern(args[i+1], t)
630 end
631 end
632
633 # FIXME: this is currently buggy since recv is not exact
634 redef fun vararg_instance(mpropdef, recv, varargs, elttype)
635 do
636 elttype = self.resolve_for(elttype, recv)
637 return self.array_instance(varargs, elttype)
638 end
639
640 fun bugtype(recv: RuntimeVariable)
641 do
642 if recv.mtype.is_c_primitive then return
643 self.add("PRINT_ERROR(\"BTD BUG: Dynamic type is %s, static type is %s\\n\", class_names[{recv}->classid], \"{recv.mcasttype}\");")
644 self.add("fatal_exit(1);")
645 end
646
647 redef fun isset_attribute(a, recv)
648 do
649 check_recv_notnull(recv)
650
651 var types = self.collect_types(recv)
652 var res = self.new_var(bool_type)
653
654 if types.is_empty then
655 self.add("/*BUG: no live types for {recv.inspect} . {a}*/")
656 self.bugtype(recv)
657 return res
658 end
659 self.add("/* isset {a} on {recv.inspect} */")
660 self.add("switch({recv}->classid) \{")
661 var last = types.last
662 for t in types do
663 if not self.compiler.hardening and t == last then
664 self.add("default: /*{self.compiler.classid(t)}*/")
665 else
666 self.add("case {self.compiler.classid(t)}:")
667 end
668 var recv2 = self.autoadapt(recv, t)
669 var ta = a.intro.static_mtype.as(not null)
670 ta = self.resolve_for(ta, recv2)
671 var attr = self.new_expr("((struct {t.c_name}*){recv})->{a.intro.c_name}", ta)
672 if not ta isa MNullableType then
673 if not ta.is_c_primitive then
674 self.add("{res} = ({attr} != NULL);")
675 else
676 self.add("{res} = 1; /*NOTYET isset on primitive attributes*/")
677 end
678 end
679 self.add("break;")
680 end
681 if self.compiler.hardening then
682 self.add("default: /* Bug */")
683 self.bugtype(recv)
684 end
685 self.add("\}")
686
687 return res
688 end
689
690 redef fun read_attribute(a, recv)
691 do
692 check_recv_notnull(recv)
693
694 var types = self.collect_types(recv)
695
696 var ret = a.intro.static_mtype.as(not null)
697 ret = self.resolve_for(ret, recv)
698 var res = self.new_var(ret)
699
700 if types.is_empty then
701 self.add("/*BUG: no live types for {recv.inspect} . {a}*/")
702 self.bugtype(recv)
703 return res
704 end
705 self.add("/* read {a} on {recv.inspect} */")
706 self.add("switch({recv}->classid) \{")
707 var last = types.last
708 for t in types do
709 if not self.compiler.hardening and t == last then
710 self.add("default: /*{self.compiler.classid(t)}*/")
711 else
712 self.add("case {self.compiler.classid(t)}:")
713 end
714 var recv2 = self.autoadapt(recv, t)
715 var ta = a.intro.static_mtype.as(not null)
716 ta = self.resolve_for(ta, recv2)
717 var res2 = self.new_expr("((struct {t.c_name}*){recv})->{a.intro.c_name}", ta)
718 if not ta isa MNullableType and not self.compiler.modelbuilder.toolcontext.opt_no_check_attr_isset.value then
719 if not ta.is_c_primitive then
720 self.add("if ({res2} == NULL) \{")
721 self.add_abort("Uninitialized attribute {a.name}")
722 self.add("\}")
723 else
724 self.add("/*NOTYET isset on primitive attributes*/")
725 end
726 end
727 self.assign(res, res2)
728 self.add("break;")
729 end
730 if self.compiler.hardening then
731 self.add("default: /* Bug */")
732 self.bugtype(recv)
733 end
734 self.add("\}")
735
736 return res
737 end
738
739 redef fun write_attribute(a, recv, value)
740 do
741 check_recv_notnull(recv)
742
743 var types = self.collect_types(recv)
744
745 if types.is_empty then
746 self.add("/*BUG: no live types for {recv.inspect} . {a}*/")
747 self.bugtype(recv)
748 return
749 end
750 self.add("/* write {a} on {recv.inspect} */")
751 self.add("switch({recv}->classid) \{")
752 var last = types.last
753 for t in types do
754 if not self.compiler.hardening and t == last then
755 self.add("default: /*{self.compiler.classid(t)}*/")
756 else
757 self.add("case {self.compiler.classid(t)}:")
758 end
759 var recv2 = self.autoadapt(recv, t)
760 var ta = a.intro.static_mtype.as(not null)
761 ta = self.resolve_for(ta, recv2)
762 self.add("((struct {t.c_name}*){recv})->{a.intro.c_name} = {self.autobox(value, ta)};")
763 self.add("break;")
764 end
765 if self.compiler.hardening then
766 self.add("default: /* Bug*/")
767 self.bugtype(recv)
768 end
769 self.add("\}")
770 end
771
772 redef fun init_instance(mtype)
773 do
774 mtype = self.anchor(mtype).as(MClassType)
775 if not self.compiler.runtime_type_analysis.live_types.has(mtype) then
776 debug "problem: {mtype} was detected dead"
777 end
778 var res = self.new_expr("NEW_{mtype.c_name}()", mtype)
779 res.is_exact = true
780 return res
781 end
782
783 redef fun type_test(value, mtype, tag)
784 do
785 mtype = self.anchor(mtype)
786 if not self.compiler.runtime_type_analysis.live_cast_types.has(mtype) then
787 debug "problem: {mtype} was detected cast-dead"
788 abort
789 end
790
791 var types = self.collect_types(value)
792 var res = self.new_var(bool_type)
793
794 self.add("/* isa {mtype} on {value.inspect} */")
795 if value.mtype.is_c_primitive then
796 if value.mtype.is_subtype(self.compiler.mainmodule, null, mtype) then
797 self.add("{res} = 1;")
798 else
799 self.add("{res} = 0;")
800 end
801 return res
802 end
803 if value.mcasttype isa MNullableType or value.mcasttype isa MNullType then
804 self.add("if ({value} == NULL) \{")
805 if mtype isa MNullableType then
806 self.add("{res} = 1; /* isa {mtype} */")
807 else
808 self.add("{res} = 0; /* not isa {mtype} */")
809 end
810 self.add("\} else ")
811 end
812 self.add("switch({value}->classid) \{")
813 for t in types do
814 if t.is_subtype(self.compiler.mainmodule, null, mtype) then
815 self.add("case {self.compiler.classid(t)}: /* {t} */")
816 end
817 end
818 self.add("{res} = 1;")
819 self.add("break;")
820 self.add("default:")
821 self.add("{res} = 0;")
822 self.add("\}")
823
824 return res
825 end
826
827 redef fun is_same_type_test(value1, value2)
828 do
829 var res = self.new_var(bool_type)
830 if not value2.mtype.is_c_primitive then
831 if not value1.mtype.is_c_primitive then
832 self.add "{res} = {value1}->classid == {value2}->classid;"
833 else
834 self.add "{res} = {self.compiler.classid(value1.mtype.as(MClassType))} == {value2}->classid;"
835 end
836 else
837 if not value1.mtype.is_c_primitive then
838 self.add "{res} = {value1}->classid == {self.compiler.classid(value2.mtype.as(MClassType))};"
839 else if value1.mcasttype == value2.mcasttype then
840 self.add "{res} = 1;"
841 else
842 self.add "{res} = 0;"
843 end
844 end
845 return res
846 end
847
848 redef fun class_name_string(value)
849 do
850 var res = self.get_name("var_class_name")
851 self.add_decl("const char* {res};")
852 if not value.mtype.is_c_primitive then
853 self.add "{res} = class_names[{value}->classid];"
854 else
855 self.add "{res} = class_names[{self.compiler.classid(value.mtype.as(MClassType))}];"
856 end
857 return res
858 end
859
860 redef fun equal_test(value1, value2)
861 do
862 var res = self.new_var(bool_type)
863 if value2.mtype.is_c_primitive and not value1.mtype.is_c_primitive then
864 var tmp = value1
865 value1 = value2
866 value2 = tmp
867 end
868 if value1.mtype.is_c_primitive then
869 if value2.mtype == value1.mtype then
870 self.add("{res} = {value1} == {value2};")
871 else if value2.mtype.is_c_primitive then
872 self.add("{res} = 0; /* incompatible types {value1.mtype} vs. {value2.mtype}*/")
873 else
874 var mtype1 = value1.mtype.as(MClassType)
875 self.add("{res} = ({value2} != NULL) && ({value2}->classid == {self.compiler.classid(mtype1)});")
876 self.add("if ({res}) \{")
877 self.add("{res} = ({self.autobox(value2, value1.mtype)} == {value1});")
878 self.add("\}")
879 end
880 else
881 var s = new Array[String]
882 for t in self.compiler.live_primitive_types do
883 if not t.is_subtype(self.compiler.mainmodule, null, value1.mcasttype) then continue
884 if not t.is_subtype(self.compiler.mainmodule, null, value2.mcasttype) then continue
885 s.add "({value1}->classid == {self.compiler.classid(t)} && ((struct {t.c_name}*){value1})->value == ((struct {t.c_name}*){value2})->value)"
886 end
887
888 if self.compiler.mainmodule.model.get_mclasses_by_name("Pointer") != null then
889 var pointer_type = self.compiler.mainmodule.pointer_type
890 if value1.mcasttype.is_subtype(self.compiler.mainmodule, null, pointer_type) or
891 value2.mcasttype.is_subtype(self.compiler.mainmodule, null, pointer_type) then
892 s.add "(((struct {pointer_type.c_name}*){value1})->value == ((struct {pointer_type.c_name}*){value2})->value)"
893 end
894 end
895
896 if s.is_empty then
897 self.add("{res} = {value1} == {value2};")
898 else
899 self.add("{res} = {value1} == {value2} || ({value1} != NULL && {value2} != NULL && {value1}->classid == {value2}->classid && ({s.join(" || ")}));")
900 end
901 end
902 return res
903 end
904
905 redef fun array_instance(array, elttype)
906 do
907 elttype = self.anchor(elttype)
908 var arraytype = mmodule.array_type(elttype)
909 var res = self.init_instance(arraytype)
910 self.add("\{ /* {res} = array_instance Array[{elttype}] */")
911 var nat = self.new_var(mmodule.native_array_type(elttype))
912 nat.is_exact = true
913 self.add("{nat} = NEW_{nat.mtype.c_name}({array.length});")
914 for i in [0..array.length[ do
915 var r = self.autobox(array[i], elttype)
916 self.add("((struct {nat.mtype.c_name}*) {nat})->values[{i}] = {r};")
917 end
918 var length = self.int_instance(array.length)
919 self.send(self.get_property("with_native", arraytype), [res, nat, length])
920 self.add("\}")
921 return res
922 end
923 end
924
925 # A runtime function customized on a specific monomrph receiver type
926 private class CustomizedRuntimeFunction
927 super AbstractRuntimeFunction
928
929 redef type COMPILER: GlobalCompiler
930 redef type VISITOR: GlobalCompilerVisitor
931
932 # The considered reciever
933 # (usually is a live type but no strong guarantee)
934 var recv: MClassType
935
936 redef fun build_c_name
937 do
938 var res = self.c_name_cache
939 if res != null then return res
940 if self.mmethoddef.mclassdef.bound_mtype == self.recv then
941 res = self.mmethoddef.c_name
942 else
943 res = "{mmethoddef.c_name}__{recv.c_name}"
944 end
945 self.c_name_cache = res
946 return res
947 end
948
949 # used in the compiler worklist
950 redef fun ==(o)
951 do
952 if not o isa CustomizedRuntimeFunction then return false
953 if self.mmethoddef != o.mmethoddef then return false
954 if self.recv != o.recv then return false
955 return true
956 end
957
958 # used in the compiler work-list
959 redef fun hash do return self.mmethoddef.hash + self.recv.hash
960
961 redef fun to_s
962 do
963 if self.mmethoddef.mclassdef.bound_mtype == self.recv then
964 return self.mmethoddef.to_s
965 else
966 return "{self.mmethoddef}@{self.recv}"
967 end
968 end
969
970 # compile the code customized for the reciever
971 redef fun compile_to_c(compiler)
972 do
973 var recv = self.recv
974 var mmethoddef = self.mmethoddef
975 if not recv.is_subtype(compiler.mainmodule, null, mmethoddef.mclassdef.bound_mtype) then
976 print("problem: why do we compile {self} for {recv}?")
977 abort
978 end
979
980 var v = compiler.new_visitor
981 var selfvar = new RuntimeVariable("self", recv, recv)
982 if compiler.runtime_type_analysis.live_types.has(recv) then
983 selfvar.is_exact = true
984 end
985 var arguments = new Array[RuntimeVariable]
986 var frame = new StaticFrame(v, mmethoddef, recv, arguments)
987 v.frame = frame
988
989 var sig = new FlatBuffer
990 var comment = new FlatBuffer
991 var ret = mmethoddef.msignature.return_mtype
992 if ret != null then
993 ret = v.resolve_for(ret, selfvar)
994 sig.append("{ret.ctype} ")
995 else
996 sig.append("void ")
997 end
998 sig.append(self.c_name)
999 sig.append("({recv.ctype} {selfvar}")
1000 comment.append("(self: {recv}")
1001 arguments.add(selfvar)
1002 for i in [0..mmethoddef.msignature.arity[ do
1003 var mp = mmethoddef.msignature.mparameters[i]
1004 var mtype = mp.mtype
1005 if mp.is_vararg then
1006 mtype = v.mmodule.array_type(mtype)
1007 end
1008 mtype = v.resolve_for(mtype, selfvar)
1009 comment.append(", {mtype}")
1010 sig.append(", {mtype.ctype} p{i}")
1011 var argvar = new RuntimeVariable("p{i}", mtype, mtype)
1012 arguments.add(argvar)
1013 end
1014 sig.append(")")
1015 comment.append(")")
1016 if ret != null then
1017 comment.append(": {ret}")
1018 end
1019 compiler.header.add_decl("{sig};")
1020
1021 v.add_decl("/* method {self} for {comment} */")
1022 v.add_decl("{sig} \{")
1023 #v.add("printf(\"method {self} for {comment}\\n\");")
1024 if ret != null then
1025 frame.returnvar = v.new_var(ret)
1026 end
1027 frame.returnlabel = v.get_name("RET_LABEL")
1028
1029 mmethoddef.compile_inside_to_c(v, arguments)
1030
1031 v.add("{frame.returnlabel.as(not null)}:;")
1032 if ret != null then
1033 v.add("return {frame.returnvar.as(not null)};")
1034 end
1035 v.add("\}")
1036 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})"
1037 end
1038
1039 redef fun call(v: VISITOR, arguments: Array[RuntimeVariable]): nullable RuntimeVariable
1040 do
1041 var ret = self.mmethoddef.msignature.return_mtype
1042 if ret != null then
1043 ret = v.resolve_for(ret, arguments.first)
1044 end
1045 if self.mmethoddef.can_inline(v) then
1046 var frame = new StaticFrame(v, self.mmethoddef, self.recv, arguments)
1047 frame.returnlabel = v.get_name("RET_LABEL")
1048 if ret != null then
1049 frame.returnvar = v.new_var(ret)
1050 end
1051 var old_frame = v.frame
1052 v.frame = frame
1053 v.add("\{ /* Inline {self} ({arguments.join(",")}) */")
1054 self.mmethoddef.compile_inside_to_c(v, arguments)
1055 v.add("{frame.returnlabel.as(not null)}:(void)0;")
1056 v.add("\}")
1057 v.frame = old_frame
1058 return frame.returnvar
1059 end
1060 v.adapt_signature(self.mmethoddef, arguments)
1061 v.compiler.todo(self)
1062 if ret == null then
1063 v.add("{self.c_name}({arguments.join(",")});")
1064 return null
1065 else
1066 var res = v.new_var(ret)
1067 v.add("{res} = {self.c_name}({arguments.join(",")});")
1068 return res
1069 end
1070 end
1071 end