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
22 private import primitive_info
25 # Something that store color of table elements
26 abstract class ColorContext
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
))
115 else if p
isa MMTypeProperty then
116 clt
.add
(new TableEltVTClassId(p
))
117 clt
.add
(new TableEltVTClassColor(p
))
120 if p
isa MMMethod and p
.need_super
then
121 clt
.add
(new TableEltSuper(p
))
125 if not ilt
.is_empty
then
126 var teg
= new ModuleTableEltGroup
127 teg
.elements
.append
(ilt
)
128 module_table
.add
(teg
)
131 if not clt
.is_empty
then
132 var teg
= new ModuleTableEltGroup
133 teg
.elements
.append
(clt
)
134 module_table
.add
(teg
)
140 # Information about the class tables
141 readable var _table_information
: TableInformation = new TableInformation
143 # Associate global classes to compiled classes
144 readable var _compiled_classes
: HashMap[MMGlobalClass, CompiledClass] = new HashMap[MMGlobalClass, CompiledClass]
146 fun do_table_computation
148 tc
.info
("Building tables",1)
149 for m
in main_module
.mhe
.greaters_and_self
do
150 tc
.info
("Building tables for module: {m.name}",2)
154 tc
.info
("Merging all tables",2)
155 do_global_table_analysis
158 # Do the complete global analysis
159 private fun do_global_table_analysis
161 var smallest_classes
= new Array[MMLocalClass]
162 var global_properties
= new HashSet[MMGlobalProperty]
163 var ctab
= new Array[TableElt]
164 var itab
= new Array[TableElt]
166 ctab
.add
(new TableEltClassSelfId)
167 ctab
.add
(new TableEltClassObjectSize)
168 ctab
.add
(new TableEltClassSelfName)
169 itab
.add
(new TableEltVftPointer)
170 itab
.add
(new TableEltObjectId)
175 # We have to work on ALL the classes of the module
176 var classes
= new Array[MMLocalClass]
177 for c
in main_module
.local_classes
do classes
.add
(c
)
178 classes
.sort
!cmp
(x
,y
) = x
.total_order_compare
(y
)
181 # Associate a CompiledClass to the class
182 var cc
= new CompiledClass(c
)
183 compiled_classes
[c
.global
] = cc
185 # Assign a unique class identifier
186 # (negative are for primitive classes)
189 if c
.primitive_info
!= null then
191 pclassid
= pclassid
- 4
194 classid
= classid
+ 4
197 # Register is the class is a leaf
198 if c
.cshe
.direct_smallers
.is_empty
then
199 smallest_classes
.add
(c
)
202 # Store the colortableelt in the class table pool
203 var bc
= c
.global
.intro
204 assert bc
isa MMConcreteClass
205 ctab
.add
(bc
.class_color_pos
)
208 # Compute core and crown classes for colorization
209 var crown_classes
= new HashSet[MMLocalClass]
210 var core_classes
= new HashSet[MMLocalClass]
211 for c
in smallest_classes
do
212 while c
.cshe
.direct_greaters
.length
== 1 do
213 c
= c
.cshe
.direct_greaters
.first
216 core_classes
.add_all
(c
.cshe
.greaters_and_self
)
218 #print("nbclasses: {classes.length} leaves: {smallest_classes.length} crown: {crown_classes.length} core: {core_classes.length}")
220 # Colorize core color for typechecks
221 colorize
(ctab
, crown_classes
, 0)
223 # Compute tables for typechecks
226 var cc
= compiled_classes
[c
.global
]
227 if core_classes
.has
(c
) then
228 # For core classes, just build the table
229 build_tables_in
(cc
.class_table
, c
, ctab
)
230 if maxcolor
< cc
.class_table
.length
then maxcolor
= cc
.class_table
.length
232 # For other classes, it's easier: just append to the parent tables
233 var sc
= c
.cshe
.direct_greaters
.first
234 var scc
= compiled_classes
[sc
.global
]
235 assert cc
.class_table
.is_empty
236 cc
.class_table
.add_all
(scc
.class_table
)
237 var bc
= c
.global
.intro
238 assert bc
isa MMConcreteClass
239 var colpos
= bc
.class_color_pos
240 var colposcolor
= cc
.class_table
.length
241 table_information
.color
(colpos
) = colposcolor
242 cc
.class_table
.add
(colpos
)
243 if maxcolor
< colposcolor
then maxcolor
= colposcolor
246 table_information
.max_class_table_length
= maxcolor
+ 1
248 # Fill class table and instance tables pools
250 var cc
= compiled_classes
[c
.global
]
251 var cte
= cc
.class_layout
252 var ite
= cc
.instance_layout
253 for sc
in c
.crhe
.greaters_and_self
do
254 if sc
isa MMConcreteClass then
255 cte
.add
(sc
, sc
.class_layout
)
256 ite
.add
(sc
, sc
.instance_layout
)
260 if core_classes
.has
(c
) then
261 if cte
.length
> 0 then
264 if ite
.length
> 0 then
270 # Colorize all elements in pools tables
271 colorize
(ctab
, crown_classes
, maxcolor
+1)
272 colorize
(itab
, crown_classes
, 0)
274 # Build class and instance tables now things are colored
275 table_information
.max_class_table_length
= 0
277 var cc
= compiled_classes
[c
.global
]
278 if core_classes
.has
(c
) then
279 # For core classes, just build the table
280 build_tables_in
(cc
.class_table
, c
, ctab
)
281 build_tables_in
(cc
.instance_table
, c
, itab
)
283 # For other classes, it's easier: just append to the parent tables
284 var sc
= c
.cshe
.direct_greaters
.first
285 var scc
= compiled_classes
[sc
.global
]
287 cc
.class_table
.add_all
(scc
.class_table
)
288 var bc
= c
.global
.intro
289 assert bc
isa MMConcreteClass
290 var colpos
= bc
.class_color_pos
291 cc
.class_table
[table_information
.color
(colpos
)] = colpos
292 while cc
.class_table
.length
<= maxcolor
do
293 cc
.class_table
.add
(null)
295 append_to_table
(cc
.class_table
, cc
.class_layout
)
296 assert cc
.instance_table
.is_empty
297 cc
.instance_table
.add_all
(scc
.instance_table
)
298 append_to_table
(cc
.instance_table
, cc
.instance_layout
)
304 fun colorize
(elts
: Array[TableElt], classes
: Collection[MMLocalClass], startcolor
: Int)
306 var colors
= new HashMap[Int, Array[TableElt]]
307 var rel_classes
= new Array[MMLocalClass]
311 if table_information
.has_color
(e
) then
312 color
= table_information
.color
(e
)
316 if e
.is_related_to
(c
) then
320 var trycolor
= startcolor
321 while trycolor
!= color
do
323 for c
in rel_classes
do
326 if colors
.has_key
(trycolor
+ idx
) and not free_color
(colors
[trycolor
+ idx
], c
) then
327 trycolor
= trycolor
+ idx
+ 1
335 table_information
.color
(e
) = color
337 for idx
in [0..len
[ do
338 if colors
.has_key
(color
+ idx
) then
339 colors
[color
+ idx
].add
(e
)
341 colors
[color
+ idx
] = [e
]
347 private fun free_color
(es
: Array[TableElt], c
: MMLocalClass): Bool
350 if e2
.is_related_to
(c
) then
357 private fun append_to_table
(table
: Array[nullable TableElt], cmp
: TableEltComposite)
359 for j
in [0..cmp
.length
[ do
361 table_information
.color
(e
) = table
.length
366 private fun build_tables_in
(table
: Array[nullable TableElt], c
: MMLocalClass, elts
: Array[TableElt])
368 var tab
= new HashMap[Int, TableElt]
371 if e
.is_related_to
(c
) then
372 var col
= table_information
.color
(e
)
373 var l
= col
+ e
.length
382 if tab
.has_key
(i
) then
384 for j
in [0..e
.length
[ do
397 # The local table of the module (refers things introduced in the module)
398 readable var _local_table
: Array[ModuleTableElt] = new Array[ModuleTableElt]
400 # Builds the local tables and local classes layouts
401 private fun local_analysis
403 for c
in local_classes
do
404 if c
isa MMConcreteClass then
405 c
.build_layout_in
(_local_table
)
411 ###############################################################################
413 # An element of a class, an instance or a module table
414 interface AbsTableElt
417 # An element of a class or an instance table
418 # Such an elements represent method function pointers, attribute values, etc.
421 # Is the element conflict to class `c' (used for coloring)
422 fun is_related_to
(c
: MMLocalClass): Bool is abstract
424 # Number of sub-elements. 1 if none
425 fun length
: Int do return 1
427 # Access the ith subelement.
428 fun item
(i
: Int): TableElt do return self
431 # An element of a module table
432 # Such an elements represent colors or identifiers
433 interface ModuleTableElt
437 # An element of a module table that represents a group of TableElt defined in the same local class
438 class ModuleTableEltGroup
440 readable var _elements
: Array[TableElt] = new Array[TableElt]
443 # An element that represents a class property
444 abstract class TableEltProp
446 readable var _property
: MMLocalProperty
448 init(p
: MMLocalProperty)
454 # An element that represents a function pointer to a global method
459 # An element that represents a class color value for a virtual type
460 class TableEltVTClassColor
464 # An element that represents a class id value for a virtual type
465 class TableEltVTClassId
469 # An element that represents a function pointer to the super method of a local method
474 # An element that represents the value stored for a global attribute
479 # An element representing a class information
480 abstract class AbsTableEltClass
482 # The local class where the information comes from
483 readable var _local_class
: MMLocalClass
485 init(c
: MMLocalClass)
491 # An element of a class table representing a class information
492 abstract class TableEltClass
494 super AbsTableEltClass
495 redef fun is_related_to
(c
)
497 var bc
= c
.mmmodule
[_local_class
.global
]
502 # An element representing the id of a class in a module table
503 class TableEltClassId
505 super AbsTableEltClass
508 # An element representing the constructor marker position in a class table
509 class TableEltClassInitTable
513 # An element used for a cast
514 # Note: this element is both a TableElt and a ModuleTableElt.
515 # At the TableElt offset, there is the id of the super-class
516 # At the ModuleTableElt offset, there is the TableElt offset (ie. the color of the super-class).
517 class TableEltClassColor
522 # A Group of elements introduced in the same global-class that are colored together
523 class TableEltComposite
525 var _table
: Array[TableElt]
526 var _cc
: CompiledClass
527 var _offsets
: HashMap[MMLocalClass, Int]
528 redef fun length
do return _table
.length
529 redef fun is_related_to
(c
) do return c
.cshe
<= _cc
.local_class
531 fun add
(c
: MMLocalClass, tab
: Array[TableElt])
533 _offsets
[c
] = _table
.length
537 redef fun item
(i
) do return _table
[i
]
539 init(cc
: CompiledClass)
542 _table
= new Array[TableElt]
543 _offsets
= new HashMap[MMLocalClass, Int]
547 # The element that represent the class id
548 class TableEltClassSelfId
550 redef fun is_related_to
(c
) do return true
553 # The element that represent the class name
554 class TableEltClassSelfName
556 redef fun is_related_to
(c
) do return true
559 # The element that represent the Object Size
560 class TableEltClassObjectSize
562 redef fun is_related_to
(c
) do return true
565 # The element that represent the object id
566 class TableEltObjectId
568 redef fun is_related_to
(c
) do return true
572 class TableEltVftPointer
574 redef fun is_related_to
(c
) do return true