1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2008 Jean Privat <jean@pryen.org>
4 # Copyright 2009 Jean-Sebastien Gelinas <calestar@gmail.com>
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
18 # Compute tables for classes and modules.
19 package table_computation
25 # Something that store color of table elements
27 var _colors
: HashMap[TableElt, Int] = new HashMap[TableElt, Int]
29 # The color of a table element.
30 fun color
(e
: TableElt): Int
35 # Is a table element already colored?
36 fun has_color
(e
: TableElt): Bool
38 return _colors
.has_key
(e
)
41 # Assign a color to a table element.
42 fun color
=(e
: TableElt, c
: Int)
46 for i
in [0..e
.length
[ do
47 _colors
[e
.item
(i
)] = idx
53 # All information and results of the global analysis.
54 class TableInformation
56 # FIXME: do something better.
57 readable writable var _max_class_table_length
: Int = 0
60 # A compiled class is a class in a program
63 # The corresponding local class in the main module of the prgram
64 readable var _local_class
: MMLocalClass
66 # The identifier of the class
67 readable writable var _id
: Int = 0
69 # The full class table of the class
70 readable var _class_table
: Array[nullable TableElt] = new Array[nullable TableElt]
72 # The full instance table of the class
73 readable var _instance_table
: Array[nullable TableElt] = new Array[nullable TableElt]
75 # The proper class table part (no superclasses but all refinements)
76 readable writable var _class_layout
: TableEltComposite = new TableEltComposite(self)
78 # The proper instance table part (no superclasses but all refinements)
79 readable writable var _instance_layout
: TableEltComposite = new TableEltComposite(self)
81 init(c
: MMLocalClass) do _local_class
= c
84 redef class MMConcreteClass
85 # The table element of the subtype check
86 fun class_color_pos
: TableEltClassColor do return _class_color_pos
.as(not null)
87 var _class_color_pos
: nullable TableEltClassColor
89 # The proper local class table part (nor superclasses nor refinments)
90 readable var _class_layout
: Array[TableElt] = new Array[TableElt]
92 # The proper local instance table part (nor superclasses nor refinments)
93 readable var _instance_layout
: Array[TableElt] = new Array[TableElt]
95 # Build the local layout of the class and feed the module table
96 private fun build_layout_in
(module_table
: Array[ModuleTableElt])
98 var clt
= _class_layout
99 var ilt
= _instance_layout
101 if global
.intro
== self then
102 module_table
.add
(new TableEltClassId(self))
103 var cpp
= new TableEltClassColor(self)
104 _class_color_pos
= cpp
105 module_table
.add
(cpp
)
106 clt
.add
(new TableEltClassInitTable(self))
108 for p
in local_local_properties
do
110 if pg
.intro
== p
then
111 if p
isa MMAttribute then
112 ilt
.add
(new TableEltAttr(p
))
113 else if p
isa MMMethod then
114 clt
.add
(new TableEltMeth(p
))
117 if p
isa MMMethod and p
.need_super
then
118 clt
.add
(new TableEltSuper(p
))
122 if not ilt
.is_empty
then
123 var teg
= new ModuleTableEltGroup
124 teg
.elements
.append
(ilt
)
125 module_table
.add
(teg
)
128 if not clt
.is_empty
then
129 var teg
= new ModuleTableEltGroup
130 teg
.elements
.append
(clt
)
131 module_table
.add
(teg
)
137 # Information about the class tables
138 readable var _table_information
: TableInformation = new TableInformation
140 # Associate global classes to compiled classes
141 readable var _compiled_classes
: HashMap[MMGlobalClass, CompiledClass] = new HashMap[MMGlobalClass, CompiledClass]
143 fun do_table_computation
145 tc
.info
("Building tables",1)
146 for m
in main_module
.mhe
.greaters_and_self
do
147 tc
.info
("Building tables for module: {m.name}",2)
151 tc
.info
("Merging all tables",2)
152 do_global_table_analysis
155 # Do the complete global analysis
156 private fun do_global_table_analysis
158 var smallest_classes
= new Array[MMLocalClass]
159 var global_properties
= new HashSet[MMGlobalProperty]
160 var ctab
= new Array[TableElt]
161 var itab
= new Array[TableElt]
163 ctab
.add
(new TableEltClassSelfId)
164 ctab
.add
(new TableEltClassObjectSize)
165 itab
.add
(new TableEltVftPointer)
166 itab
.add
(new TableEltObjectId)
171 # We have to work on ALL the classes of the module
172 var classes
= new Array[MMLocalClass]
173 for c
in main_module
.local_classes
do classes
.add
(c
)
174 classes
.sort
!cmp
(x
,y
) = x
.total_order_compare
(y
)
177 # Associate a CompiledClass to the class
178 var cc
= new CompiledClass(c
)
179 compiled_classes
[c
.global
] = cc
181 # Assign a unique class identifier
182 # (negative are for primitive classes)
185 if c
.primitive_info
!= null then
187 pclassid
= pclassid
- 4
190 classid
= classid
+ 4
193 # Register is the class is a leaf
194 if c
.cshe
.direct_smallers
.is_empty
then
195 smallest_classes
.add
(c
)
198 # Store the colortableelt in the class table pool
199 var bc
= c
.global
.intro
200 assert bc
isa MMConcreteClass
201 ctab
.add
(bc
.class_color_pos
)
204 # Compute core and crown classes for colorization
205 var crown_classes
= new HashSet[MMLocalClass]
206 var core_classes
= new HashSet[MMLocalClass]
207 for c
in smallest_classes
do
208 while c
.cshe
.direct_greaters
.length
== 1 do
209 c
= c
.cshe
.direct_greaters
.first
212 core_classes
.add_all
(c
.cshe
.greaters_and_self
)
214 #print("nbclasses: {classes.length} leaves: {smallest_classes.length} crown: {crown_classes.length} core: {core_classes.length}")
216 # Colorize core color for typechecks
217 colorize
(ctab
, crown_classes
, 0)
219 # Compute tables for typechecks
222 var cc
= compiled_classes
[c
.global
]
223 if core_classes
.has
(c
) then
224 # For core classes, just build the table
225 build_tables_in
(cc
.class_table
, c
, ctab
)
226 if maxcolor
< cc
.class_table
.length
then maxcolor
= cc
.class_table
.length
228 # For other classes, it's easier: just append to the parent tables
229 var sc
= c
.cshe
.direct_greaters
.first
230 var scc
= compiled_classes
[sc
.global
]
231 assert cc
.class_table
.is_empty
232 cc
.class_table
.add_all
(scc
.class_table
)
233 var bc
= c
.global
.intro
234 assert bc
isa MMConcreteClass
235 var colpos
= bc
.class_color_pos
236 var colposcolor
= cc
.class_table
.length
237 table_information
.color
(colpos
) = colposcolor
238 cc
.class_table
.add
(colpos
)
239 if maxcolor
< colposcolor
then maxcolor
= colposcolor
242 table_information
.max_class_table_length
= maxcolor
+ 1
244 # Fill class table and instance tables pools
246 var cc
= compiled_classes
[c
.global
]
247 var cte
= cc
.class_layout
248 var ite
= cc
.instance_layout
249 for sc
in c
.crhe
.greaters_and_self
do
250 if sc
isa MMConcreteClass then
251 cte
.add
(sc
, sc
.class_layout
)
252 ite
.add
(sc
, sc
.instance_layout
)
256 if core_classes
.has
(c
) then
257 if cte
.length
> 0 then
260 if ite
.length
> 0 then
266 # Colorize all elements in pools tables
267 colorize
(ctab
, crown_classes
, maxcolor
+1)
268 colorize
(itab
, crown_classes
, 0)
270 # Build class and instance tables now things are colored
271 table_information
.max_class_table_length
= 0
273 var cc
= compiled_classes
[c
.global
]
274 if core_classes
.has
(c
) then
275 # For core classes, just build the table
276 build_tables_in
(cc
.class_table
, c
, ctab
)
277 build_tables_in
(cc
.instance_table
, c
, itab
)
279 # For other classes, it's easier: just append to the parent tables
280 var sc
= c
.cshe
.direct_greaters
.first
281 var scc
= compiled_classes
[sc
.global
]
283 cc
.class_table
.add_all
(scc
.class_table
)
284 var bc
= c
.global
.intro
285 assert bc
isa MMConcreteClass
286 var colpos
= bc
.class_color_pos
287 cc
.class_table
[table_information
.color
(colpos
)] = colpos
288 while cc
.class_table
.length
<= maxcolor
do
289 cc
.class_table
.add
(null)
291 append_to_table
(cc
.class_table
, cc
.class_layout
)
292 assert cc
.instance_table
.is_empty
293 cc
.instance_table
.add_all
(scc
.instance_table
)
294 append_to_table
(cc
.instance_table
, cc
.instance_layout
)
300 fun colorize
(elts
: Array[TableElt], classes
: Collection[MMLocalClass], startcolor
: Int)
302 var colors
= new HashMap[Int, Array[TableElt]]
303 var rel_classes
= new Array[MMLocalClass]
307 if table_information
.has_color
(e
) then
308 color
= table_information
.color
(e
)
312 if e
.is_related_to
(c
) then
316 var trycolor
= startcolor
317 while trycolor
!= color
do
319 for c
in rel_classes
do
322 if colors
.has_key
(trycolor
+ idx
) and not free_color
(colors
[trycolor
+ idx
], c
) then
323 trycolor
= trycolor
+ idx
+ 1
331 table_information
.color
(e
) = color
333 for idx
in [0..len
[ do
334 if colors
.has_key
(color
+ idx
) then
335 colors
[color
+ idx
].add
(e
)
337 colors
[color
+ idx
] = [e
]
343 private fun free_color
(es
: Array[TableElt], c
: MMLocalClass): Bool
346 if e2
.is_related_to
(c
) then
353 private fun append_to_table
(table
: Array[nullable TableElt], cmp
: TableEltComposite)
355 for j
in [0..cmp
.length
[ do
357 table_information
.color
(e
) = table
.length
362 private fun build_tables_in
(table
: Array[nullable TableElt], c
: MMLocalClass, elts
: Array[TableElt])
364 var tab
= new HashMap[Int, TableElt]
367 if e
.is_related_to
(c
) then
368 var col
= table_information
.color
(e
)
369 var l
= col
+ e
.length
378 if tab
.has_key
(i
) then
380 for j
in [0..e
.length
[ do
393 # The local table of the module (refers things introduced in the module)
394 readable var _local_table
: Array[ModuleTableElt] = new Array[ModuleTableElt]
396 # Builds the local tables and local classes layouts
397 private fun local_analysis
399 for c
in local_classes
do
400 if c
isa MMConcreteClass then
401 c
.build_layout_in
(_local_table
)
407 ###############################################################################
409 # An element of a class, an instance or a module table
410 abstract class AbsTableElt
413 # An element of a class or an instance table
414 # Such an elements represent method function pointers, attribute values, etc.
415 abstract class TableElt
417 # Is the element conflict to class `c' (used for coloring)
418 fun is_related_to
(c
: MMLocalClass): Bool is abstract
420 # Number of sub-elements. 1 if none
421 fun length
: Int do return 1
423 # Access the ith subelement.
424 fun item
(i
: Int): TableElt do return self
427 # An element of a module table
428 # Such an elements represent colors or identifiers
429 abstract class ModuleTableElt
433 # An element of a module table that represents a group of TableElt defined in the same local class
434 class ModuleTableEltGroup
436 readable var _elements
: Array[TableElt] = new Array[TableElt]
439 # An element that represents a class property
440 abstract class TableEltProp
442 readable var _property
: MMLocalProperty
444 init(p
: MMLocalProperty)
450 # An element that represents a function pointer to a global method
455 # An element that represents a function pointer to the super method of a local method
460 # An element that represents the value stored for a global attribute
465 # An element representing a class information
466 class AbsTableEltClass
468 # The local class where the information comes from
469 readable var _local_class
: MMLocalClass
471 init(c
: MMLocalClass)
477 # An element of a class table representing a class information
480 super AbsTableEltClass
481 redef fun is_related_to
(c
)
483 var bc
= c
.mmmodule
[_local_class
.global
]
488 # An element representing the id of a class in a module table
489 class TableEltClassId
491 super AbsTableEltClass
494 # An element representing the constructor marker position in a class table
495 class TableEltClassInitTable
499 # An element used for a cast
500 # Note: this element is both a TableElt and a ModuleTableElt.
501 # At the TableElt offset, there is the id of the super-class
502 # At the ModuleTableElt offset, there is the TableElt offset (ie. the color of the super-class).
503 class TableEltClassColor
508 # A Group of elements introduced in the same global-class that are colored together
509 class TableEltComposite
511 var _table
: Array[TableElt]
512 var _cc
: CompiledClass
513 var _offsets
: HashMap[MMLocalClass, Int]
514 redef fun length
do return _table
.length
515 redef fun is_related_to
(c
) do return c
.cshe
<= _cc
.local_class
517 fun add
(c
: MMLocalClass, tab
: Array[TableElt])
519 _offsets
[c
] = _table
.length
523 redef fun item
(i
) do return _table
[i
]
525 init(cc
: CompiledClass)
528 _table
= new Array[TableElt]
529 _offsets
= new HashMap[MMLocalClass, Int]
533 # The element that represent the class id
534 class TableEltClassSelfId
536 redef fun is_related_to
(c
) do return true
539 # The element that represent the Object Size
540 class TableEltClassObjectSize
542 redef fun is_related_to
(c
) do return true
545 # The element that represent the object id
546 class TableEltObjectId
548 redef fun is_related_to
(c
) do return true
552 class TableEltVftPointer
554 redef fun is_related_to
(c
) do return true