b5e5bb8c4e48b6adb04187d8979a01663a9d4135
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 intrude 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 init_naive_interpreter
(interpreter
, 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 # Subtyping test for the virtual machine
48 redef fun is_subtype
(sub
, sup
: MType): Bool
50 var anchor
= self.frame
.arguments
.first
.mtype
.as(MClassType)
51 var sup_accept_null
= false
52 if sup
isa MNullableType then
53 sup_accept_null
= true
55 else if sup
isa MNullType then
56 sup_accept_null
= true
59 # Can `sub` provides null or not?
60 # Thus we can match with `sup_accept_null`
61 # Also discard the nullable marker if it exists
62 if sub
isa MNullableType then
63 if not sup_accept_null
then return false
65 else if sub
isa MNullType then
66 return sup_accept_null
68 # Now the case of direct null and nullable is over
70 # An unfixed formal type can only accept itself
71 if sup
isa MParameterType or sup
isa MVirtualType then
75 if sub
isa MParameterType or sub
isa MVirtualType then
76 sub
= sub
.anchor_to
(mainmodule
, anchor
)
77 # Manage the second layer of null/nullable
78 if sub
isa MNullableType then
79 if not sup_accept_null
then return false
81 else if sub
isa MNullType then
82 return sup_accept_null
86 assert sub
isa MClassType
88 # `sup` accepts only null
89 if sup
isa MNullType then return false
91 assert sup
isa MClassType
93 # Create the sup vtable if not create
94 if not sup
.mclass
.loaded
then create_class
(sup
.mclass
)
96 # Sub can be discovered inside a Generic type during the subtyping test
97 if not sub
.mclass
.loaded
then create_class
(sub
.mclass
)
99 if anchor
== null then anchor
= sub
100 if sup
isa MGenericType then
101 var sub2
= sub
.supertype_to
(mainmodule
, anchor
, sup
.mclass
)
102 assert sub2
.mclass
== sup
.mclass
104 for i
in [0..sup
.mclass
.arity
[ do
105 var sub_arg
= sub2
.arguments
[i
]
106 var sup_arg
= sup
.arguments
[i
]
107 var res
= is_subtype
(sub_arg
, sup_arg
)
109 if res
== false then return false
114 var super_id
= sup
.mclass
.vtable
.id
115 var mask
= sub
.mclass
.vtable
.mask
117 return inter_is_subtype
(super_id
, mask
, sub
.mclass
.vtable
.internal_vtable
)
120 # Subtyping test with perfect hashing
121 private fun inter_is_subtype
(id
: Int, mask
:Int, vtable
: Pointer): Bool `{
122 // hv is the position in hashtable
125 // Follow the pointer to somewhere in the vtable
126 long unsigned int *offset = (long unsigned int*)(((long int *)vtable)[-hv]);
128 // If the pointed value is corresponding to the identifier, the test is true, otherwise false
129 return *offset == id;
132 # Redef init_instance to simulate the loading of a class
133 redef fun init_instance
(recv
: Instance)
135 if not recv
.mtype
.as(MClassType).mclass
.loaded
then create_class
(recv
.mtype
.as(MClassType).mclass
)
137 recv
.vtable
= recv
.mtype
.as(MClassType).mclass
.vtable
139 assert(recv
isa MutableInstance)
141 recv
.internal_attributes
= init_internal_attributes
(null_instance
, recv
.mtype
.as(MClassType).mclass
.all_mattributes
(mainmodule
, none_visibility
).length
)
145 # Initialize the internal representation of an object (its attribute values)
146 private fun init_internal_attributes
(null_instance
: Instance, size
: Int): Pointer
147 import Array[Instance].length
, Array[Instance].[] `{
149 Instance* attributes = malloc(sizeof(Instance) * size);
152 for(i=0; i<size; i++)
153 attributes[i] = null_instance;
155 Instance_incr_ref(null_instance);
159 # Creates the runtime structures for this class
160 fun create_class
(mclass
: MClass) do mclass
.make_vt
(self)
162 # Return the value of the attribute `mproperty` for the object `recv`
163 redef fun read_attribute
(mproperty
: MAttribute, recv
: Instance): Instance
165 assert recv
isa MutableInstance
167 # Read the attribute value with perfect hashing
168 var id
= mproperty
.intro_mclassdef
.mclass
.vtable
.id
170 var i
= read_attribute_ph
(recv
.internal_attributes
, recv
.vtable
.internal_vtable
,
171 recv
.vtable
.mask
, id
, mproperty
.offset
)
176 # Return the attribute value in `instance` with a sequence of perfect_hashing
177 # `instance` is the attributes array of the receiver
178 # `vtable` is the pointer to the virtual table of the class (of the receiver)
179 # `mask` is the perfect hashing mask of the class
180 # `id` is the identifier of the class
181 # `offset` is the relative offset of this attribute
182 private fun read_attribute_ph
(instance
: Pointer, vtable
: Pointer, mask
: Int, id
: Int, offset
: Int): Instance `{
183 // Perfect hashing position
185 long unsigned int *pointer = (long unsigned int*)(((long int *)vtable)[-hv]);
187 // pointer+1 is the position where the delta of the class is
188 int absolute_offset = *(pointer + 1);
190 Instance res = ((Instance *)instance)[absolute_offset + offset];
195 # Replace in `recv` the value of the attribute `mproperty` by `value`
196 redef fun write_attribute
(mproperty
: MAttribute, recv
: Instance, value
: Instance)
198 assert recv
isa MutableInstance
200 var id
= mproperty
.intro_mclassdef
.mclass
.vtable
.id
202 # Replace the old value of mproperty in recv
203 write_attribute_ph
(recv
.internal_attributes
, recv
.vtable
.internal_vtable
,
204 recv
.vtable
.mask
, id
, mproperty
.offset
, value
)
207 # Replace the value of an attribute in an instance
208 # `instance` is the attributes array of the receiver
209 # `vtable` is the pointer to the virtual table of the class (of the receiver)
210 # `mask` is the perfect hashing mask of the class
211 # `id` is the identifier of the class
212 # `offset` is the relative offset of this attribute
213 # `value` is the new value for this attribute
214 private fun write_attribute_ph
(instance
: Pointer, vtable
: Pointer, mask
: Int, id
: Int, offset
: Int, value
: Instance) `{
215 // Perfect hashing position
217 long unsigned int *pointer = (long unsigned int*)(((long int *)vtable)[-hv]);
219 // pointer+1 is the position where the delta of the class is
220 int absolute_offset = *(pointer + 1);
222 ((Instance *)instance)[absolute_offset + offset] = value;
223 Instance_incr_ref(value);
228 # A reference to the virtual table of this class
229 var vtable
: nullable VTable
231 # True when the class is effectively loaded by the vm, false otherwise
232 var loaded
: Bool = false
234 # For each loaded subclass, keep the position of the group of attributes
235 # introduced by self class in the object
236 var positions_attributes
: HashMap[MClass, Int] = new HashMap[MClass, Int]
238 # For each loaded subclass, keep the position of the group of methods
239 # introduced by self class in the vtable
240 var positions_methods
: HashMap[MClass, Int] = new HashMap[MClass, Int]
242 # Allocates a VTable for this class and gives it an id
243 private fun make_vt
(v
: VirtualMachine)
245 if loaded
then return
247 # `superclasses` contains the order of superclasses for virtual tables
248 var superclasses
= superclasses_ordering
(v
)
249 superclasses
.remove
(self)
251 # Make_vt for super-classes
252 var ids
= new Array[Int]
253 var nb_methods
= new Array[Int]
254 var nb_attributes
= new Array[Int]
256 # Absolute offset of the beginning of the attributes table
257 var offset_attributes
= 0
258 # Absolute offset of the beginning of the methods table
259 var offset_methods
= 0
261 for parent
in superclasses
do
262 if not parent
.loaded
then parent
.make_vt
(v
)
264 # Get the number of introduced methods and attributes for this class
268 for p
in parent
.intro_mproperties
(none_visibility
) do
269 if p
isa MMethod then methods
+= 1
270 if p
isa MAttribute then
275 ids
.push
(parent
.vtable
.id
)
276 nb_methods
.push
(methods
)
277 nb_attributes
.push
(attributes
)
279 # Update `positions_attributes` and `positions_methods` in `parent`
280 update_positions
(offset_attributes
, offset_methods
, parent
)
282 offset_attributes
+= attributes
283 offset_methods
+= methods
286 # When all super-classes have their identifiers and vtables, allocate current one
287 allocate_vtable
(v
, ids
, nb_methods
, nb_attributes
, offset_attributes
, offset_methods
)
289 # The virtual table now needs to be filled with pointer to methods
292 # Allocate a single vtable
293 # `ids : Array of superclasses identifiers
294 # `nb_methods : Array which contain the number of introduced methods for each class in ids
295 # `nb_attributes : Array which contain the number of introduced attributes for each class in ids
296 # `offset_attributes : Offset from the beginning of the table of the group of attributes
297 # `offset_methods : Offset from the beginning of the table of the group of methods
298 private fun allocate_vtable
(v
: VirtualMachine, ids
: Array[Int], nb_methods
: Array[Int], nb_attributes
: Array[Int],
299 offset_attributes
: Int, offset_methods
: Int)
302 var idc
= new Array[Int]
304 vtable
.mask
= v
.ph
.pnand
(ids
, 1, idc
) - 1
306 vtable
.classname
= name
308 # Add current id to Array of super-ids
309 var ids_total
= new Array[Int]
310 ids_total
.add_all
(ids
)
311 ids_total
.push
(vtable
.id
)
313 var nb_methods_total
= new Array[Int]
314 var nb_attributes_total
= new Array[Int]
317 var nb_introduced_attributes
= 0
319 # For self attributes, fixing offsets
320 var relative_offset
= 0
321 for p
in intro_mproperties
(none_visibility
) do
322 if p
isa MMethod then self_methods
+= 1
323 if p
isa MAttribute then
324 nb_introduced_attributes
+= 1
325 p
.offset
= relative_offset
330 nb_methods_total
.add_all
(nb_methods
)
331 nb_methods_total
.push
(self_methods
)
333 nb_attributes_total
.add_all
(nb_attributes
)
334 nb_attributes_total
.push
(nb_introduced_attributes
)
336 # Save the offsets of self class
337 offset_attributes
+= nb_introduced_attributes
338 offset_methods
+= self_methods
339 update_positions
(offset_attributes
, offset_methods
, self)
341 # Since we have the number of attributes for each class, calculate the delta
342 var d
= calculate_delta
(nb_attributes_total
)
343 vtable
.internal_vtable
= v
.memory_manager
.init_vtable
(ids_total
, nb_methods_total
, d
, vtable
.mask
)
346 # Computes delta for each class
347 # A delta represents the offset for this group of attributes in the object
348 # `nb_attributes` : number of attributes for each class (classes are linearized from Object to current)
349 # return deltas for each class
350 private fun calculate_delta
(nb_attributes
: Array[Int]): Array[Int]
352 var deltas
= new Array[Int]
355 for nb
in nb_attributes
do
363 # Order superclasses of self
364 # Return the order of superclasses in runtime structures of this class
365 private fun superclasses_ordering
(v
: VirtualMachine): Array[MClass]
367 var superclasses
= new Array[MClass]
368 superclasses
.add_all
(ancestors
)
370 var res
= new Array[MClass]
371 if superclasses
.length
> 1 then
373 var ordering
= self.dfs
(v
, res
)
377 # There is no super-class, self is Object
382 # A kind of Depth-First-Search for superclasses ordering
383 # `v` : the current executed instance of VirtualMachine
384 # `res` : Result Array, ie current superclasses ordering
385 private fun dfs
(v
: VirtualMachine, res
: Array[MClass]): Array[MClass]
387 # Add this class at the beginning
390 var direct_parents
= self.in_hierarchy
(v
.mainmodule
).direct_greaters
.to_a
392 if direct_parents
.length
> 1 then
393 # Prefix represents the class which has the most properties
394 # we try to choose it in first to reduce the number of potential recompilations
397 for cl
in direct_parents
do
398 # If we never have visited this class
399 if not res
.has
(cl
) then
400 var properties_length
= cl
.all_mproperties
(v
.mainmodule
, none_visibility
).length
401 if properties_length
> max
then
402 max
= properties_length
408 if prefix
!= null then
409 # Add the prefix class ordering at the beginning of our sequence
410 var prefix_res
= new Array[MClass]
411 prefix_res
= prefix
.dfs
(v
, prefix_res
)
413 # Then we recurse on other classes
414 for cl
in direct_parents
do
416 res
= new Array[MClass]
420 if not prefix_res
.has
(cl_res
) then prefix_res
.push
(cl_res
)
429 if direct_parents
.length
> 0 then
430 res
= direct_parents
.first
.dfs
(v
, res
)
434 if not res
.has
(self) then res
.push
(self)
439 # Update positions of self class in `parent`
440 # `attributes_offset`: absolute offset of introduced attributes
441 # `methods_offset`: absolute offset of introduced methods
442 private fun update_positions
(attributes_offsets
: Int, methods_offset
:Int, parent
: MClass)
444 parent
.positions_attributes
[self] = attributes_offsets
445 parent
.positions_methods
[self] = methods_offset
449 redef class MAttribute
450 # Represents the relative offset of this attribute in the runtime instance
454 # Redef MutableInstance to improve implementation of attributes in objects
455 redef class MutableInstance
457 # C-array to store pointers to attributes of this Object
458 var internal_attributes
: Pointer
461 # A VTable contains the virtual method table for the dispatch
462 # and informations to perform subtyping tests
464 # The mask to perform perfect hashing
465 var mask
: Int is noinit
467 # Unique identifier given by perfect hashing
468 var id
: Int is noinit
470 # Pointer to the c-allocated area, represents the virtual table
471 var internal_vtable
: Pointer is noinit
473 # The short classname of this class
474 var classname
: String is noinit
478 var vtable
: nullable VTable
481 # Handle memory, used for allocate virtual table and associated structures
484 # Allocate and fill a virtual table
485 fun init_vtable
(ids
: Array[Int], nb_methods
: Array[Int], nb_attributes
: Array[Int], mask
: Int): Pointer
487 # Allocate in C current virtual table
488 var res
= intern_init_vtable
(ids
, nb_methods
, nb_attributes
, mask
)
493 # Construct virtual tables with a bi-dimensional layout
494 private fun intern_init_vtable
(ids
: Array[Int], nb_methods
: Array[Int], deltas
: Array[Int], mask
: Int): Pointer
495 import Array[Int].length
, Array[Int].[] `{
497 // Allocate and fill current virtual table
499 int total_size = 0; // total size of this virtual table
500 int nb_classes = Array_of_Int_length(nb_methods);
501 for(i = 0; i<nb_classes; i++) {
502 /* - One for each method of this class
503 * - One for the delta (offset of this group of attributes in objects)
506 total_size += Array_of_Int__index(nb_methods, i);
510 // Add the size of the perfect hashtable (mask +1)
511 // Add one because we start to fill the vtable at position 1 (0 is the init position)
512 total_size += mask+2;
513 long unsigned int* vtable = malloc(sizeof(long unsigned int)*total_size);
515 // Initialisation to the first position of the virtual table (ie : Object)
516 long unsigned int *init = vtable + mask + 2;
517 for(i=0; i<total_size; i++)
518 vtable[i] = (long unsigned int)init;
520 // Set the virtual table to its position 0
521 // ie: after the hashtable
522 vtable = vtable + mask + 1;
524 int current_size = 1;
525 for(i = 0; i < nb_classes; i++) {
527 vtable[hv] contains a pointer to the group of introduced methods
528 For each superclasse we have in virtual table :
529 (id | delta | introduced methods)
531 int hv = mask & Array_of_Int__index(ids, i);
533 vtable[current_size] = Array_of_Int__index(ids, i);
534 vtable[current_size + 1] = Array_of_Int__index(deltas, i);
535 vtable[-hv] = (long unsigned int)&(vtable[current_size]);
538 current_size += Array_of_Int__index(nb_methods, i);