1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Graph coloring tools
18 import rapid_type_analysis
# for type coloration
20 abstract class AbstractColoring[E
: Object]
22 private var sorter
: AbstractSorter[E
]
23 private var reverse_sorter
: AbstractSorter[E
]
25 private var core
: OrderedSet[E
] = new OrderedSet[E
]
26 private var crown
: OrderedSet[E
] = new OrderedSet[E
]
27 private var border
: OrderedSet[E
] = new OrderedSet[E
]
29 private var coloration_result
: Map[E
, Int] = new HashMap[E
, Int]
30 private var conflicts_graph_cache
: nullable HashMap[E
, Set[E
]]
32 init(sorter
: AbstractSorter[E
], reverse_sorter
: AbstractSorter[E
]) do
34 self.reverse_sorter
= reverse_sorter
37 fun colorize
(elements
: Collection[E
]): Map[E
, Int] do
38 # tag each element as part of group core, crown or border
43 #print "core: {core.join(", ")}"
44 #print "border: {border.join(", ")}"
45 #print "crown: {crown.join(", ")}"
47 # sort by reverse linearization order
48 reverse_sorter
.sort
(core
)
49 reverse_sorter
.sort
(border
)
50 reverse_sorter
.sort
(crown
)
53 #for k, v in conflicts_graph do
55 # print "{k}: {v.join(", ")}"
60 colorize_elements
(core
)
61 colorize_elements
(border
)
62 colorize_elements
(crown
)
64 return coloration_result
67 # Colorize a collection of elements
68 private fun colorize_elements
(elements
: Collection[E
]) do
71 for element
in elements
do
73 while not self.is_color_free
(element
, color
) do
76 coloration_result
[element
] = color
81 # Check if a related element to the element already use the color
82 private fun is_color_free
(element
: E
, color
: Int): Bool do
83 if conflicts_graph
.has_key
(element
) then
84 for st
in conflicts_graph
[element
] do
85 if coloration_result
.has_key
(st
) and coloration_result
[st
] == color
then return false
88 for st
in self.super_elements
(element
) do
89 if coloration_result
.has_key
(st
) and coloration_result
[st
] == color
then return false
94 # Tag element as core, crown or border
95 private fun tag_element
(element
: E
) do
96 # Check if sub elements are all in single inheritance
97 var all_subelements_si
= true
98 for subelem
in self.sub_elements
(element
) do
99 if self.is_element_mi
(subelem
) then
100 all_subelements_si
= false
105 # Tag as core, crown or border
106 if self.is_element_mi
(element
) then
107 core
.add_all
(self.super_elements
(element
))
109 if all_subelements_si
then
112 else if not all_subelements_si
then
113 core
.add_all
(self.super_elements
(element
))
120 # Conflicts graph of elements hierarchy (two types are in conflict if they have common subelements)
121 private fun conflicts_graph
: Map[E
, Set[E
]] do
122 if self.conflicts_graph_cache
== null then
123 self.conflicts_graph_cache
= new HashMap[E
, HashSet[E
]]
124 for t
in self.core
do
125 for i
in self.linear_extension
(t
) do
126 if t
== i
then continue
128 var lin_i
= self.linear_extension
(i
)
130 for j
in self.linear_extension
(t
) do
131 if i
== j
or j
== t
then continue
132 var lin_j
= self.linear_extension
(j
)
134 var d_ij
= lin_i
- lin_j
135 var d_ji
= lin_j
- lin_i
138 if not conflicts_graph_cache
.has_key
(ed1
) then conflicts_graph_cache
[ed1
] = new HashSet[E
]
139 # add ed1 x ed2 to conflicts graph
140 for ed2
in d_ji
do conflicts_graph_cache
[ed1
].add
(ed2
)
143 if not conflicts_graph_cache
.has_key
(ed1
) then conflicts_graph_cache
[ed1
] = new HashSet[E
]
144 # add ed1 x ed2 to conflicts graph
145 for ed2
in d_ji
do conflicts_graph_cache
[ed1
].add
(ed2
)
151 return conflicts_graph_cache
.as(not null)
154 # cache for linear_extensions
155 private var linear_extensions_cache
: Map[E
, OrderedSet[E
]] = new HashMap[E
, OrderedSet[E
]]
157 # Return a linear_extension of super_elements of the element
158 private fun linear_extension
(element
: E
): OrderedSet[E
] do
159 if not self.linear_extensions_cache
.has_key
(element
) then
160 var lin
= new OrderedSet[E
]
162 lin
.add_all
(self.super_elements
(element
))
163 self.sorter
.sort
(lin
)
164 self.linear_extensions_cache
[element
] = lin
166 return self.linear_extensions_cache
[element
]
169 # Return all super elements (directs and indirects) of an element
170 private fun super_elements
(element
: E
): Collection[E
] is abstract
172 # Return all sub elements (directs and indirects) of an element
173 private fun sub_elements
(element
: E
): Collection[E
] is abstract
175 # Is the element in multiple inheritance ?
176 private fun is_element_mi
(element
: E
): Bool is abstract
179 # MClassType coloring
181 super AbstractColoring[MClassType]
185 private var mmodule
: MModule
186 private var mtypes
: Set[MClassType] = new HashSet[MClassType]
189 private var super_elements_cache
: Map[T
, Set[T
]] = new HashMap[T
, Set[T
]]
190 private var sub_elements_cache
: Map[T
, Set[T
]] = new HashMap[T
, Set[T
]]
192 init(mainmodule
: MModule, runtime_type_analysis
: RapidTypeAnalysis) do
193 super(new TypeSorter(mainmodule
), new ReverseTypeSorter(mainmodule
))
194 self.mmodule
= mainmodule
195 self.mtypes
.add_all
(runtime_type_analysis
.live_types
)
196 self.mtypes
.add_all
(runtime_type_analysis
.live_cast_types
)
200 private fun build_type_tables
(mtypes
: Set[T
], colors
: Map[T
, Int]): Map[T
, Array[nullable T
]] do
201 var tables
= new HashMap[T
, Array[nullable T
]]
203 for mtype
in mtypes
do
204 var table
= new Array[nullable T
]
205 var supers
= new HashSet[T
]
206 supers
.add_all
(self.super_elements
(mtype
))
209 var color
= colors
[sup
]
210 if table
.length
<= color
then
211 for i
in [table
.length
.. color
[ do
217 tables
[mtype
] = table
222 redef fun super_elements
(element
) do
223 if not self.super_elements_cache
.has_key
(element
) then
224 var supers
= new HashSet[T
]
225 for mtype
in self.mtypes
do
226 if element
== mtype
then continue
227 if element
.is_subtype
(self.mmodule
, null, mtype
) then
231 self.super_elements_cache
[element
] = supers
233 return self.super_elements_cache
[element
]
236 # Return all direct super elements of an element
237 redef fun is_element_mi
(element
) do
238 return self.mmodule
.flatten_mclass_hierarchy
[element
.mclass
].direct_greaters
.length
> 1
241 # Return all sub elements (directs and indirects) of an element
242 redef fun sub_elements
(element
) do
243 if not self.sub_elements_cache
.has_key
(element
) then
244 var subs
= new HashSet[T
]
245 for mtype
in self.mtypes
do
246 if element
== mtype
then continue
247 if mtype
.is_subtype
(self.mmodule
, null, element
) then
251 self.sub_elements_cache
[element
] = subs
253 return self.sub_elements_cache
[element
]
257 # A sorter for linearize list of types
258 private class TypeSorter
259 super AbstractSorter[MClassType]
261 private var mmodule
: MModule
263 init(mmodule
: MModule) do self.mmodule
= mmodule
265 redef fun compare
(a
, b
) do
268 else if a
.is_subtype
(self.mmodule
, null, b
) then
275 # A sorter for reverse linearization
276 private class ReverseTypeSorter
279 redef fun compare
(a
, b
) do
282 else if a
.is_subtype
(self.mmodule
, null, b
) then
291 super AbstractColoring[MClass]
295 private var mmodule
: MModule
298 private var super_elements_cache
: Map[T
, Set[T
]] = new HashMap[T
, Set[T
]]
299 private var parent_elements_cache
: Map[T
, Set[T
]] = new HashMap[T
, Set[T
]]
300 private var sub_elements_cache
: Map[T
, Set[T
]] = new HashMap[T
, Set[T
]]
302 init(mainmodule
: MModule) do
303 super(new ClassSorter(mainmodule
), new ReverseClassSorter(mainmodule
))
304 self.mmodule
= mainmodule
307 redef fun super_elements
(element
) do
308 if not self.super_elements_cache
.has_key
(element
) then
309 var supers
= new HashSet[T
]
310 if self.mmodule
.flatten_mclass_hierarchy
.has
(element
) then
311 for sup
in self.mmodule
.flatten_mclass_hierarchy
[element
].greaters
do
312 if element
== sup
then continue
316 self.super_elements_cache
[element
] = supers
318 return self.super_elements_cache
[element
]
321 private fun parent_elements
(element
: T
): Set[T
] do
322 if not self.parent_elements_cache
.has_key
(element
) then
323 var parents
= new HashSet[T
]
324 if self.mmodule
.flatten_mclass_hierarchy
.has
(element
) then
325 for parent
in self.mmodule
.flatten_mclass_hierarchy
[element
].direct_greaters
do
326 if element
== parent
then continue
330 self.parent_elements_cache
[element
] = parents
332 return self.parent_elements_cache
[element
]
335 # Return all sub elements (directs and indirects) of an element
336 redef fun sub_elements
(element
) do
337 if not self.sub_elements_cache
.has_key
(element
) then
338 var subs
= new HashSet[T
]
339 if self.mmodule
.flatten_mclass_hierarchy
.has
(element
) then
340 for sub
in self.mmodule
.flatten_mclass_hierarchy
[element
].smallers
do
344 self.sub_elements_cache
[element
] = subs
346 return self.sub_elements_cache
[element
]
349 # Return all direct super elements of an element
350 redef fun is_element_mi
(element
) do
351 if not self.mmodule
.flatten_mclass_hierarchy
.has
(element
) then return false
352 return self.mmodule
.flatten_mclass_hierarchy
[element
].direct_greaters
.length
> 1
356 # A sorter for linearize list of classes
357 private class ClassSorter
358 super AbstractSorter[MClass]
362 redef fun compare
(a
, b
) do
365 else if self.mmodule
.flatten_mclass_hierarchy
.has
(a
) and self.mmodule
.flatten_mclass_hierarchy
[a
].greaters
.has
(b
) then
372 # A sorter for reverse linearization
373 private class ReverseClassSorter
374 super AbstractSorter[MClass]
378 redef fun compare
(a
, b
) do
381 else if self.mmodule
.flatten_mclass_hierarchy
.has
(a
) and self.mmodule
.flatten_mclass_hierarchy
[a
].greaters
.has
(b
) then
389 class PropertyColoring
391 type MPROP: MProperty
392 type MPROPDEF: MPropDef
394 private var class_coloring
: ClassColoring
395 private var coloration_result
: Map[MPROP, Int] = new HashMap[MPROP, Int]
397 init(class_coloring
: ClassColoring) do
398 self.class_coloring
= class_coloring
401 private fun colorize
: Map[MPROP, Int] do
402 colorize_core_properties
403 colorize_crown_properties
404 return self.coloration_result
407 private fun build_property_tables
: Map[MClass, Array[nullable MPROPDEF]] do
408 var tables
= new HashMap[MClass, Array[nullable MPROPDEF]]
410 for mclass
in self.class_coloring
.coloration_result
.keys
do
411 var table
= new Array[nullable MPROPDEF]
412 # first, fill table from parents by reverse linearization order
413 var parents
= new OrderedSet[MClass]
414 parents
.add_all
(self.class_coloring
.super_elements
(mclass
))
415 self.class_coloring
.reverse_sorter
.sort
(parents
)
416 for parent
in parents
do
417 for mproperty
in self.properties
(parent
) do
418 var color
= self.coloration_result
[mproperty
]
419 if table
.length
<= color
then
420 for i
in [table
.length
.. color
[ do
424 for mpropdef
in mproperty
.mpropdefs
do
425 if mpropdef
.mclassdef
.mclass
== parent
then
426 table
[color
] = mpropdef
432 # then override with local properties
433 for mproperty
in self.properties
(mclass
) do
434 var color
= self.coloration_result
[mproperty
]
435 if table
.length
<= color
then
436 for i
in [table
.length
.. color
[ do
440 for mpropdef
in mproperty
.mpropdefs
do
441 if mpropdef
.mclassdef
.mclass
== mclass
then
442 table
[color
] = mpropdef
446 tables
[mclass
] = table
451 # Colorize properties of the core hierarchy
452 private fun colorize_core_properties
do
453 var mclasses
= self.class_coloring
.core
456 for mclass
in mclasses
do
457 var color
= min_color
459 # if the class is root, get the minimal color
460 if self.class_coloring
.parent_elements
(mclass
).length
== 0 then
461 colorize_elements
(self.properties
(mclass
), color
)
463 # check last color used by parents
464 color
= max_color
(color
, self.class_coloring
.parent_elements
(mclass
))
465 # check max color used in conflicts
466 if self.class_coloring
.conflicts_graph
.has_key
(mclass
) then
467 color
= max_color
(color
, self.class_coloring
.conflicts_graph
[mclass
])
471 colorize_elements
(self.properties
(mclass
), color
)
476 # Colorize properties of the crown hierarchy
477 private fun colorize_crown_properties
do
478 for mclass
in self.class_coloring
.crown
do
479 colorize_elements
(self.properties
(mclass
), max_color
(0, self.class_coloring
.parent_elements
(mclass
)))
483 # Colorize a collection of properties given a starting color
484 private fun colorize_elements
(elements
: Collection[MPROP], start_color
: Int) do
485 for element
in elements
do
486 if self.coloration_result
.has_key
(element
) then continue
487 self.coloration_result
[element
] = start_color
492 private fun max_color
(min_color
: Int, mclasses
: Collection[MClass]): Int do
493 var max_color
= min_color
495 for mclass
in mclasses
do
496 for mproperty
in self.properties
(mclass
) do
497 var color
= min_color
498 if self.coloration_result
.has_key
(mproperty
) then
499 color
= self.coloration_result
[mproperty
]
500 if color
>= max_color
then max_color
= color
+ 1
508 private var properties_cache
: Map[MClass, Set[MPROP]] = new HashMap[MClass, Set[MPROP]]
510 # All 'mproperties' associated to all 'mclassdefs' of the class
511 private fun properties
(mclass
: MClass): Set[MPROP] do
512 if not self.properties_cache
.has_key
(mclass
) then
513 var properties
= new HashSet[MPROP]
514 var parents
= self.class_coloring
.super_elements
(mclass
)
515 for parent
in parents
do
516 properties
.add_all
(self.properties
(parent
))
519 for mclassdef
in mclass
.mclassdefs
do
520 for mpropdef
in mclassdef
.mpropdefs
do
521 var mproperty
= mpropdef
.mproperty
522 if mproperty
isa MPROP then
523 properties
.add
(mproperty
)
527 self.properties_cache
[mclass
] = properties
529 return properties_cache
[mclass
]
535 super PropertyColoring
537 redef type MPROP: MMethod
538 redef type MPROPDEF: MMethodDef
541 # MAttribute coloring
542 class AttributeColoring
543 super PropertyColoring
545 redef type MPROP: MAttribute
546 redef type MPROPDEF: MAttributeDef
549 # MParameterType coloring
551 private var class_coloring
: ClassColoring
552 private var coloration_result
: Map[MParameterType, Int] = new HashMap[MParameterType, Int]
554 init(class_coloring
: ClassColoring) do
555 self.class_coloring
= class_coloring
558 private fun colorize
: Map[MParameterType, Int] do
559 colorize_core_properties
560 colorize_crown_properties
561 return self.coloration_result
564 # Colorize properties of the core hierarchy
565 private fun colorize_core_properties
do
566 var mclasses
= self.class_coloring
.core
569 for mclass
in mclasses
do
570 var color
= min_color
572 # if the class is root, get the minimal color
573 if self.class_coloring
.parent_elements
(mclass
).length
== 0 then
574 colorize_elements
(self.fts
(mclass
), color
)
576 # check last color used by parents
577 color
= max_color
(color
, self.class_coloring
.parent_elements
(mclass
))
578 # check max color used in conflicts
579 if self.class_coloring
.conflicts_graph
.has_key
(mclass
) then
580 color
= max_color
(color
, self.class_coloring
.conflicts_graph
[mclass
])
583 colorize_elements
(self.fts
(mclass
), color
)
588 # Colorize properties of the crown hierarchy
589 private fun colorize_crown_properties
do
590 for mclass
in self.class_coloring
.crown
do
591 colorize_elements
(self.fts
(mclass
), max_color
(0, self.class_coloring
.parent_elements
(mclass
)))
595 # Colorize a collection of properties given a starting color
596 private fun colorize_elements
(elements
: Collection[MParameterType], start_color
: Int) do
597 for element
in elements
do
598 if self.coloration_result
.has_key
(element
) then continue
599 self.coloration_result
[element
] = start_color
604 private fun max_color
(min_color
: Int, mclasses
: Collection[MClass]): Int do
605 var max_color
= min_color
607 for mclass
in mclasses
do
608 for ft
in self.fts
(mclass
) do
609 var color
= min_color
610 if self.coloration_result
.has_key
(ft
) then
611 color
= self.coloration_result
[ft
]
612 if color
>= max_color
then max_color
= color
+ 1
620 private var fts_cache
: Map[MClass, Set[MParameterType]] = new HashMap[MClass, Set[MParameterType]]
622 private fun fts
(mclass
: MClass): Set[MParameterType] do
623 if not self.fts_cache
.has_key
(mclass
) then
624 var fts
= new HashSet[MParameterType]
625 var mclass_type
= mclass
.mclass_type
626 if mclass_type
isa MGenericType then
627 for ft
in mclass_type
.arguments
do
628 fts
.add
(ft
.as(MParameterType))
631 self.fts_cache
[mclass
] = fts
633 return fts_cache
[mclass
]
636 private fun build_ft_tables
: Map[MClass, Array[nullable MParameterType]] do
637 var tables
= new HashMap[MClass, Array[nullable MParameterType]]
639 for mclass
in self.class_coloring
.coloration_result
.keys
do
640 var table
= new Array[nullable MParameterType]
642 # first, fill table from parents
643 for parent
in self.class_coloring
.super_elements
(mclass
) do
644 for ft
in self.fts
(parent
) do
645 var color
= self.coloration_result
[ft
]
646 if table
.length
<= color
then
647 for i
in [table
.length
.. color
[ do
655 # then override with local properties
656 for ft
in self.fts
(mclass
) do
657 var color
= self.coloration_result
[ft
]
658 if table
.length
<= color
then
659 for i
in [table
.length
.. color
[ do
665 tables
[mclass
] = table
674 private class OrderedSet[E
]
678 if not self.has
(e
) then
683 # Return a new OrderedSet with the elements only contened in 'self' and not in 'o'
684 fun -(o
: OrderedSet[E
]): OrderedSet[E
] do
685 var res
= new OrderedSet[E
]
686 for e
in self do if not o
.has
(e
) then res
.add
(e
)