1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2014 Julien Pagès <julien.pages@lirmm.fr>
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.
17 # Implementation of the Nit virtual machine
20 import interpreter
::naive_interpreter
22 import perfect_hashing
24 redef class ModelBuilder
25 redef fun run_naive_interpreter
(mainmodule
: MModule, arguments
: Array[String])
28 self.toolcontext
.info
("*** NITVM STARTING ***", 1)
30 var interpreter
= new VirtualMachine(self, mainmodule
, arguments
)
31 interpreter
.start
(mainmodule
)
34 self.toolcontext
.info
("*** NITVM STOPPING : {time1-time0} ***", 2)
38 # A virtual machine based on the naive_interpreter
39 class VirtualMachine super NaiveInterpreter
41 # Perfect hashing and perfect numbering
42 var ph
: Perfecthashing = new Perfecthashing
44 # Handles memory and garbage collection
45 var memory_manager
: MemoryManager = new MemoryManager
47 # The unique instance of the `MInit` value
48 var initialization_value
: Instance
50 init(modelbuilder
: ModelBuilder, mainmodule
: MModule, arguments
: Array[String])
52 var init_type
= new MInitType(mainmodule
.model
)
53 initialization_value
= new MutableInstance(init_type
)
57 # Subtyping test for the virtual machine
58 redef fun is_subtype
(sub
, sup
: MType): Bool
60 var anchor
= self.frame
.arguments
.first
.mtype
.as(MClassType)
61 var sup_accept_null
= false
62 if sup
isa MNullableType then
63 sup_accept_null
= true
65 else if sup
isa MNullType then
66 sup_accept_null
= true
69 # Can `sub` provides null or not?
70 # Thus we can match with `sup_accept_null`
71 # Also discard the nullable marker if it exists
72 if sub
isa MNullableType then
73 if not sup_accept_null
then return false
75 else if sub
isa MNullType then
76 return sup_accept_null
78 # Now the case of direct null and nullable is over
80 # An unfixed formal type can only accept itself
81 if sup
isa MParameterType or sup
isa MVirtualType then
85 if sub
isa MParameterType or sub
isa MVirtualType then
86 sub
= sub
.anchor_to
(mainmodule
, anchor
)
87 # Manage the second layer of null/nullable
88 if sub
isa MNullableType then
89 if not sup_accept_null
then return false
91 else if sub
isa MNullType then
92 return sup_accept_null
96 assert sub
isa MClassType
98 # `sup` accepts only null
99 if sup
isa MNullType then return false
101 assert sup
isa MClassType
103 # Create the sup vtable if not create
104 if not sup
.mclass
.loaded
then create_class
(sup
.mclass
)
106 # Sub can be discovered inside a Generic type during the subtyping test
107 if not sub
.mclass
.loaded
then create_class
(sub
.mclass
)
109 if sup
isa MGenericType then
110 var sub2
= sub
.supertype_to
(mainmodule
, anchor
, sup
.mclass
)
111 assert sub2
.mclass
== sup
.mclass
113 for i
in [0..sup
.mclass
.arity
[ do
114 var sub_arg
= sub2
.arguments
[i
]
115 var sup_arg
= sup
.arguments
[i
]
116 var res
= is_subtype
(sub_arg
, sup_arg
)
118 if res
== false then return false
123 var super_id
= sup
.mclass
.vtable
.id
124 var mask
= sub
.mclass
.vtable
.mask
126 return inter_is_subtype
(super_id
, mask
, sub
.mclass
.vtable
.internal_vtable
)
129 # Subtyping test with perfect hashing
130 private fun inter_is_subtype
(id
: Int, mask
:Int, vtable
: Pointer): Bool `{
131 // hv is the position in hashtable
134 // Follow the pointer to somewhere in the vtable
135 long unsigned int *offset = (long unsigned int*)(((long int *)vtable)[-hv]);
137 // If the pointed value is corresponding to the identifier, the test is true, otherwise false
138 return *offset == id;
141 # Redef init_instance to simulate the loading of a class
142 redef fun init_instance
(recv
: Instance)
144 if not recv
.mtype
.as(MClassType).mclass
.loaded
then create_class
(recv
.mtype
.as(MClassType).mclass
)
146 recv
.vtable
= recv
.mtype
.as(MClassType).mclass
.vtable
148 assert recv
isa MutableInstance
150 recv
.internal_attributes
= init_internal_attributes
(initialization_value
, recv
.mtype
.as(MClassType).mclass
.all_mattributes
(mainmodule
, none_visibility
).length
)
154 # Associate a `PrimitiveInstance` to its `VTable`
155 redef fun init_instance_primitive
(recv
: Instance)
157 if not recv
.mtype
.as(MClassType).mclass
.loaded
then create_class
(recv
.mtype
.as(MClassType).mclass
)
159 recv
.vtable
= recv
.mtype
.as(MClassType).mclass
.vtable
162 # Create a virtual table for this `MClass` if not already done
163 redef fun get_primitive_class
(name
: String): MClass
167 if not mclass
.loaded
then create_class
(mclass
)
172 # Initialize the internal representation of an object (its attribute values)
173 # `init_instance` is the initial value of attributes
174 private fun init_internal_attributes
(init_instance
: Instance, size
: Int): Pointer
175 import Array[Instance].length
, Array[Instance].[] `{
177 Instance* attributes = malloc(sizeof(Instance) * size);
180 for(i=0; i<size; i++)
181 attributes[i] = init_instance;
183 Instance_incr_ref(init_instance);
187 # Creates the runtime structures for this class
188 fun create_class
(mclass
: MClass) do mclass
.make_vt
(self)
190 # Execute `mproperty` for a `args` (where `args[0]` is the receiver).
191 redef fun send
(mproperty
: MMethod, args
: Array[Instance]): nullable Instance
193 var recv
= args
.first
194 var mtype
= recv
.mtype
195 var ret
= send_commons
(mproperty
, args
, mtype
)
196 if ret
!= null then return ret
198 var propdef
= method_dispatch
(mproperty
, recv
.vtable
.as(not null))
200 return self.call
(propdef
, args
)
203 # Method dispatch, for a given global method `mproperty`
204 # returns the most specific local method in the class corresponding to `vtable`
205 private fun method_dispatch
(mproperty
: MMethod, vtable
: VTable): MMethodDef
207 return method_dispatch_ph
(vtable
.internal_vtable
, vtable
.mask
,
208 mproperty
.intro_mclassdef
.mclass
.vtable
.id
, mproperty
.offset
)
211 # Execute a method dispatch with perfect hashing
212 private fun method_dispatch_ph
(vtable
: Pointer, mask
: Int, id
: Int, offset
: Int): MMethodDef `{
213 // Perfect hashing position
215 long unsigned int *pointer = (long unsigned int*)(((long int *)vtable)[-hv]);
217 // pointer+2 is the position where methods are
218 // Add the offset of property and get the method implementation
219 MMethodDef propdef = (MMethodDef)*(pointer + 2 + offset);
224 # Return the value of the attribute `mproperty` for the object `recv`
225 redef fun read_attribute
(mproperty
: MAttribute, recv
: Instance): Instance
227 assert recv
isa MutableInstance
229 # Read the attribute value with perfect hashing
230 var id
= mproperty
.intro_mclassdef
.mclass
.vtable
.id
232 var i
= read_attribute_ph
(recv
.internal_attributes
, recv
.vtable
.internal_vtable
,
233 recv
.vtable
.mask
, id
, mproperty
.offset
)
235 # If we get a `MInit` value, throw an error
236 if i
== initialization_value
then
237 fatal
("Uninitialized attribute {mproperty.name}")
244 # Return the attribute value in `instance` with a sequence of perfect_hashing
245 # `instance` is the attributes array of the receiver
246 # `vtable` is the pointer to the virtual table of the class (of the receiver)
247 # `mask` is the perfect hashing mask of the class
248 # `id` is the identifier of the class
249 # `offset` is the relative offset of this attribute
250 private fun read_attribute_ph
(instance
: Pointer, vtable
: Pointer, mask
: Int, id
: Int, offset
: Int): Instance `{
251 // Perfect hashing position
253 long unsigned int *pointer = (long unsigned int*)(((long int *)vtable)[-hv]);
255 // pointer+1 is the position where the delta of the class is
256 int absolute_offset = *(pointer + 1);
258 Instance res = ((Instance *)instance)[absolute_offset + offset];
263 # Replace in `recv` the value of the attribute `mproperty` by `value`
264 redef fun write_attribute
(mproperty
: MAttribute, recv
: Instance, value
: Instance)
266 assert recv
isa MutableInstance
268 var id
= mproperty
.intro_mclassdef
.mclass
.vtable
.id
270 # Replace the old value of mproperty in recv
271 write_attribute_ph
(recv
.internal_attributes
, recv
.vtable
.internal_vtable
,
272 recv
.vtable
.mask
, id
, mproperty
.offset
, value
)
275 # Replace the value of an attribute in an instance
276 # `instance` is the attributes array of the receiver
277 # `vtable` is the pointer to the virtual table of the class (of the receiver)
278 # `mask` is the perfect hashing mask of the class
279 # `id` is the identifier of the class
280 # `offset` is the relative offset of this attribute
281 # `value` is the new value for this attribute
282 private fun write_attribute_ph
(instance
: Pointer, vtable
: Pointer, mask
: Int, id
: Int, offset
: Int, value
: Instance) `{
283 // Perfect hashing position
285 long unsigned int *pointer = (long unsigned int*)(((long int *)vtable)[-hv]);
287 // pointer+1 is the position where the delta of the class is
288 int absolute_offset = *(pointer + 1);
290 ((Instance *)instance)[absolute_offset + offset] = value;
291 Instance_incr_ref(value);
294 # Is the attribute `mproperty` initialized in the instance `recv`?
295 redef fun isset_attribute
(mproperty
: MAttribute, recv
: Instance): Bool
297 assert recv
isa MutableInstance
299 # Read the attribute value with internal perfect hashing read
300 # because we do not want to throw an error if the value is `initialization_value`
301 var id
= mproperty
.intro_mclassdef
.mclass
.vtable
.id
303 var i
= read_attribute_ph
(recv
.internal_attributes
, recv
.vtable
.internal_vtable
,
304 recv
.vtable
.mask
, id
, mproperty
.offset
)
306 return i
!= initialization_value
311 # A reference to the virtual table of this class
312 var vtable
: nullable VTable
314 # True when the class is effectively loaded by the vm, false otherwise
315 var loaded
: Bool = false
317 # For each loaded subclass, keep the position of the group of attributes
318 # introduced by self class in the object
319 var positions_attributes
: HashMap[MClass, Int] = new HashMap[MClass, Int]
321 # For each loaded subclass, keep the position of the group of methods
322 # introduced by self class in the vtable
323 var positions_methods
: HashMap[MClass, Int] = new HashMap[MClass, Int]
325 # Allocates a VTable for this class and gives it an id
326 private fun make_vt
(v
: VirtualMachine)
328 if loaded
then return
330 # `superclasses` contains the order of superclasses for virtual tables
331 var superclasses
= superclasses_ordering
(v
)
332 superclasses
.remove
(self)
334 # Make_vt for super-classes
335 var ids
= new Array[Int]
336 var nb_methods
= new Array[Int]
337 var nb_attributes
= new Array[Int]
339 # Absolute offset of the beginning of the attributes table
340 var offset_attributes
= 0
341 # Absolute offset of the beginning of the methods table
342 var offset_methods
= 0
344 for parent
in superclasses
do
345 if not parent
.loaded
then parent
.make_vt
(v
)
347 # Get the number of introduced methods and attributes for this class
351 for p
in parent
.intro_mproperties
(none_visibility
) do
352 if p
isa MMethod then methods
+= 1
353 if p
isa MAttribute then
358 ids
.push
(parent
.vtable
.id
)
359 nb_methods
.push
(methods
)
360 nb_attributes
.push
(attributes
)
362 # Update `positions_attributes` and `positions_methods` in `parent`
363 update_positions
(offset_attributes
, offset_methods
, parent
)
365 offset_attributes
+= attributes
366 offset_methods
+= methods
369 # When all super-classes have their identifiers and vtables, allocate current one
370 allocate_vtable
(v
, ids
, nb_methods
, nb_attributes
, offset_attributes
, offset_methods
)
373 # The virtual table now needs to be filled with pointer to methods
374 superclasses
.add
(self)
375 for cl
in superclasses
do
376 fill_vtable
(v
, vtable
.as(not null), cl
)
380 # Allocate a single vtable
381 # `ids : Array of superclasses identifiers
382 # `nb_methods : Array which contain the number of introduced methods for each class in ids
383 # `nb_attributes : Array which contain the number of introduced attributes for each class in ids
384 # `offset_attributes : Offset from the beginning of the table of the group of attributes
385 # `offset_methods : Offset from the beginning of the table of the group of methods
386 private fun allocate_vtable
(v
: VirtualMachine, ids
: Array[Int], nb_methods
: Array[Int], nb_attributes
: Array[Int],
387 offset_attributes
: Int, offset_methods
: Int)
390 var idc
= new Array[Int]
392 vtable
.mask
= v
.ph
.pnand
(ids
, 1, idc
) - 1
394 vtable
.classname
= name
396 # Add current id to Array of super-ids
397 var ids_total
= new Array[Int]
398 ids_total
.add_all
(ids
)
399 ids_total
.push
(vtable
.id
)
401 var nb_methods_total
= new Array[Int]
402 var nb_attributes_total
= new Array[Int]
405 var nb_introduced_attributes
= 0
407 # Fixing offsets for self attributes and methods
408 var relative_offset_attr
= 0
409 var relative_offset_meth
= 0
410 for p
in intro_mproperties
(none_visibility
) do
411 if p
isa MMethod then
413 p
.offset
= relative_offset_meth
414 relative_offset_meth
+= 1
416 if p
isa MAttribute then
417 nb_introduced_attributes
+= 1
418 p
.offset
= relative_offset_attr
419 relative_offset_attr
+= 1
423 nb_methods_total
.add_all
(nb_methods
)
424 nb_methods_total
.push
(self_methods
)
426 nb_attributes_total
.add_all
(nb_attributes
)
427 nb_attributes_total
.push
(nb_introduced_attributes
)
429 # Save the offsets of self class
430 offset_attributes
+= nb_introduced_attributes
431 offset_methods
+= self_methods
432 update_positions
(offset_attributes
, offset_methods
, self)
434 # Since we have the number of attributes for each class, calculate the delta
435 var d
= calculate_delta
(nb_attributes_total
)
436 vtable
.internal_vtable
= v
.memory_manager
.init_vtable
(ids_total
, nb_methods_total
, d
, vtable
.mask
)
439 # Fill the vtable with methods of `self` class
440 # `v` : Current instance of the VirtualMachine
441 # `table` : the table of self class, will be filled with its methods
442 private fun fill_vtable
(v
:VirtualMachine, table
: VTable, cl
: MClass)
444 var methods
= new Array[MMethodDef]
445 for m
in cl
.intro_mproperties
(none_visibility
) do
446 if m
isa MMethod then
447 # `propdef` is the most specific implementation for this MMethod
448 var propdef
= m
.lookup_first_definition
(v
.mainmodule
, self.intro
.bound_mtype
)
449 methods
.push
(propdef
)
453 # Call a method in C to put propdefs of self methods in the vtables
454 v
.memory_manager
.put_methods
(vtable
.internal_vtable
, vtable
.mask
, cl
.vtable
.id
, methods
)
457 # Computes delta for each class
458 # A delta represents the offset for this group of attributes in the object
459 # `nb_attributes` : number of attributes for each class (classes are linearized from Object to current)
460 # return deltas for each class
461 private fun calculate_delta
(nb_attributes
: Array[Int]): Array[Int]
463 var deltas
= new Array[Int]
466 for nb
in nb_attributes
do
474 # Order superclasses of self
475 # Return the order of superclasses in runtime structures of this class
476 private fun superclasses_ordering
(v
: VirtualMachine): Array[MClass]
478 var superclasses
= new Array[MClass]
479 superclasses
.add_all
(ancestors
)
481 var res
= new Array[MClass]
482 if superclasses
.length
> 1 then
484 var ordering
= self.dfs
(v
, res
)
488 # There is no super-class, self is Object
493 # A kind of Depth-First-Search for superclasses ordering
494 # `v` : the current executed instance of VirtualMachine
495 # `res` : Result Array, ie current superclasses ordering
496 private fun dfs
(v
: VirtualMachine, res
: Array[MClass]): Array[MClass]
498 # Add this class at the beginning
501 var direct_parents
= self.in_hierarchy
(v
.mainmodule
).direct_greaters
.to_a
503 if direct_parents
.length
> 1 then
504 # Prefix represents the class which has the most properties
505 # we try to choose it in first to reduce the number of potential recompilations
508 for cl
in direct_parents
do
509 # If we never have visited this class
510 if not res
.has
(cl
) then
511 var properties_length
= cl
.all_mproperties
(v
.mainmodule
, none_visibility
).length
512 if properties_length
> max
then
513 max
= properties_length
519 if prefix
!= null then
520 # Add the prefix class ordering at the beginning of our sequence
521 var prefix_res
= new Array[MClass]
522 prefix_res
= prefix
.dfs
(v
, prefix_res
)
524 # Then we recurse on other classes
525 for cl
in direct_parents
do
527 res
= new Array[MClass]
531 if not prefix_res
.has
(cl_res
) then prefix_res
.push
(cl_res
)
540 if direct_parents
.length
> 0 then
541 res
= direct_parents
.first
.dfs
(v
, res
)
545 if not res
.has
(self) then res
.push
(self)
550 # Update positions of self class in `parent`
551 # `attributes_offset`: absolute offset of introduced attributes
552 # `methods_offset`: absolute offset of introduced methods
553 private fun update_positions
(attributes_offsets
: Int, methods_offset
:Int, parent
: MClass)
555 parent
.positions_attributes
[self] = attributes_offsets
556 parent
.positions_methods
[self] = methods_offset
560 redef class MAttribute
561 # Represents the relative offset of this attribute in the runtime instance
566 # Represents the relative offset of this attribute in the runtime instance
570 # Redef MutableInstance to improve implementation of attributes in objects
571 redef class MutableInstance
573 # C-array to store pointers to attributes of this Object
574 var internal_attributes
: Pointer
577 # Redef to associate an `Instance` to its `VTable`
579 var vtable
: nullable VTable
582 # Is the type of the initial value inside attributes
586 redef var model
: Model
587 protected init(model
: Model)
592 redef fun to_s
do return "InitType"
593 redef fun as_nullable
do return self
594 redef fun need_anchor
do return false
595 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
596 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
598 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
600 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
602 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
605 # A VTable contains the virtual method table for the dispatch
606 # and informations to perform subtyping tests
608 # The mask to perform perfect hashing
609 var mask
: Int is noinit
611 # Unique identifier given by perfect hashing
612 var id
: Int is noinit
614 # Pointer to the c-allocated area, represents the virtual table
615 var internal_vtable
: Pointer is noinit
617 # The short classname of this class
618 var classname
: String is noinit
621 # Handle memory, used for allocate virtual table and associated structures
624 # Allocate and fill a virtual table
625 fun init_vtable
(ids
: Array[Int], nb_methods
: Array[Int], nb_attributes
: Array[Int], mask
: Int): Pointer
627 # Allocate in C current virtual table
628 var res
= intern_init_vtable
(ids
, nb_methods
, nb_attributes
, mask
)
633 # Construct virtual tables with a bi-dimensional layout
634 private fun intern_init_vtable
(ids
: Array[Int], nb_methods
: Array[Int], deltas
: Array[Int], mask
: Int): Pointer
635 import Array[Int].length
, Array[Int].[] `{
637 // Allocate and fill current virtual table
639 int total_size = 0; // total size of this virtual table
640 int nb_classes = Array_of_Int_length(nb_methods);
641 for(i = 0; i<nb_classes; i++) {
642 /* - One for each method of this class
643 * - One for the delta (offset of this group of attributes in objects)
646 total_size += Array_of_Int__index(nb_methods, i);
650 // Add the size of the perfect hashtable (mask +1)
651 // Add one because we start to fill the vtable at position 1 (0 is the init position)
652 total_size += mask+2;
653 long unsigned int* vtable = malloc(sizeof(long unsigned int)*total_size);
655 // Initialisation to the first position of the virtual table (ie : Object)
656 long unsigned int *init = vtable + mask + 2;
657 for(i=0; i<total_size; i++)
658 vtable[i] = (long unsigned int)init;
660 // Set the virtual table to its position 0
661 // ie: after the hashtable
662 vtable = vtable + mask + 1;
664 int current_size = 1;
665 for(i = 0; i < nb_classes; i++) {
667 vtable[hv] contains a pointer to the group of introduced methods
668 For each superclasse we have in virtual table :
669 (id | delta | introduced methods)
671 int hv = mask & Array_of_Int__index(ids, i);
673 vtable[current_size] = Array_of_Int__index(ids, i);
674 vtable[current_size + 1] = Array_of_Int__index(deltas, i);
675 vtable[-hv] = (long unsigned int)&(vtable[current_size]);
678 current_size += Array_of_Int__index(nb_methods, i);
684 # Put implementation of methods of a class in `vtable`
685 # `vtable` : Pointer to the C-virtual table
686 # `mask` : perfect-hashing mask of the class corresponding to the vtable
687 # `id` : id of the target class
688 # `methods` : array of MMethodDef of the target class
689 fun put_methods
(vtable
: Pointer, mask
: Int, id
: Int, methods
: Array[MMethodDef])
690 import Array[MMethodDef].length
, Array[MMethodDef].[] `{
692 // Get the area to fill with methods by a sequence of perfect hashing
694 long unsigned int *pointer = (long unsigned int*)(((long unsigned int *)vtable)[-hv]);
696 // pointer+2 is the beginning of the area for methods implementation
697 int length = Array_of_MMethodDef_length(methods);
698 long unsigned int *area = (pointer + 2);
701 for(i=0; i<length; i++)
703 MMethodDef method = Array_of_MMethodDef__index(methods, i);
704 area[i] = (long unsigned int)method;
705 MMethodDef_incr_ref(method);