isl_test_python.py

   1 # Copyright 2016-2017 Tobias Grosser
   2 #
   3 # Use of this software is governed by the MIT license
   4 #
   5 # Written by Tobias Grosser, Weststrasse 47, CH-8003, Zurich
   6
   7 import sys
   8 import isl
   9
  10 # Test that isl objects can be constructed.
  11 #
  12 # This tests:
  13 #  - construction from a string
  14 #  - construction from an integer
  15 #  - static constructor without a parameter
  16 #  - conversion construction
  17 #  - construction of empty union set
  18 #
  19 #  The tests to construct from integers and strings cover functionality that
  20 #  is also tested in the parameter type tests, but here the presence of
  21 #  multiple overloaded constructors and overload resolution is tested.
  22 #
  23 def test_constructors():
  24         zero1 = isl.val("0")
  25         assert(zero1.is_zero())
  26
  27         zero2 = isl.val(0)
  28         assert(zero2.is_zero())
  29
  30         zero3 = isl.val.zero()
  31         assert(zero3.is_zero())
  32
  33         bs = isl.basic_set("{ [1] }")
  34         result = isl.set("{ [1] }")
  35         s = isl.set(bs)
  36         assert(s.is_equal(result))
  37
  38         us = isl.union_set("{ A[1]; B[2, 3] }")
  39         empty = isl.union_set.empty()
  40         assert(us.is_equal(us.union(empty)))
  41
  42 # Test integer function parameters for a particular integer value.
  43 #
  44 def test_int(i):
  45         val_int = isl.val(i)
  46         val_str = isl.val(str(i))
  47         assert(val_int.eq(val_str))
  48
  49 # Test integer function parameters.
  50 #
  51 # Verify that extreme values and zero work.
  52 #
  53 def test_parameters_int():
  54         test_int(sys.maxsize)
  55         test_int(-sys.maxsize - 1)
  56         test_int(0)
  57
  58 # Test isl objects parameters.
  59 #
  60 # Verify that isl objects can be passed as lvalue and rvalue parameters.
  61 # Also verify that isl object parameters are automatically type converted if
  62 # there is an inheritance relation. Finally, test function calls without
  63 # any additional parameters, apart from the isl object on which
  64 # the method is called.
  65 #
  66 def test_parameters_obj():
  67         a = isl.set("{ [0] }")
  68         b = isl.set("{ [1] }")
  69         c = isl.set("{ [2] }")
  70         expected = isl.set("{ [i] : 0 <= i <= 2 }")
  71
  72         tmp = a.union(b)
  73         res_lvalue_param = tmp.union(c)
  74         assert(res_lvalue_param.is_equal(expected))
  75
  76         res_rvalue_param = a.union(b).union(c)
  77         assert(res_rvalue_param.is_equal(expected))
  78
  79         a2 = isl.basic_set("{ [0] }")
  80         assert(a.is_equal(a2))
  81
  82         two = isl.val(2)
  83         half = isl.val("1/2")
  84         res_only_this_param = two.inv()
  85         assert(res_only_this_param.eq(half))
  86
  87 # Test different kinds of parameters to be passed to functions.
  88 #
  89 # This includes integer and isl object parameters.
  90 #
  91 def test_parameters():
  92         test_parameters_int()
  93         test_parameters_obj()
  94
  95 # Test that isl objects are returned correctly.
  96 #
  97 # This only tests that after combining two objects, the result is successfully
  98 # returned.
  99 #
 100 def test_return_obj():
 101         one = isl.val("1")
 102         two = isl.val("2")
 103         three = isl.val("3")
 104
 105         res = one.add(two)
 106
 107         assert(res.eq(three))
 108
 109 # Test that integer values are returned correctly.
 110 #
 111 def test_return_int():
 112         one = isl.val("1")
 113         neg_one = isl.val("-1")
 114         zero = isl.val("0")
 115
 116         assert(one.sgn() > 0)
 117         assert(neg_one.sgn() < 0)
 118         assert(zero.sgn() == 0)
 119
 120 # Test that isl_bool values are returned correctly.
 121 #
 122 # In particular, check the conversion to bool in case of true and false.
 123 #
 124 def test_return_bool():
 125         empty = isl.set("{ : false }")
 126         univ = isl.set("{ : }")
 127
 128         b_true = empty.is_empty()
 129         b_false = univ.is_empty()
 130
 131         assert(b_true)
 132         assert(not b_false)
 133
 134 # Test that strings are returned correctly.
 135 # Do so by calling overloaded isl.ast_build.from_expr methods.
 136 #
 137 def test_return_string():
 138         context = isl.set("[n] -> { : }")
 139         build = isl.ast_build.from_context(context)
 140         pw_aff = isl.pw_aff("[n] -> { [n] }")
 141         set = isl.set("[n] -> { : n >= 0 }")
 142
 143         expr = build.expr_from(pw_aff)
 144         expected_string = "n"
 145         assert(expected_string == expr.to_C_str())
 146
 147         expr = build.expr_from(set)
 148         expected_string = "n >= 0"
 149         assert(expected_string == expr.to_C_str())
 150
 151 # Test that return values are handled correctly.
 152 #
 153 # Test that isl objects, integers, boolean values, and strings are
 154 # returned correctly.
 155 #
 156 def test_return():
 157         test_return_obj()
 158         test_return_int()
 159         test_return_bool()
 160         test_return_string()
 161
 162 # Test that foreach functions are modeled correctly.
 163 #
 164 # Verify that closures are correctly called as callback of a 'foreach'
 165 # function and that variables captured by the closure work correctly. Also
 166 # check that the foreach function handles exceptions thrown from
 167 # the closure and that it propagates the exception.
 168 #
 169 def test_foreach():
 170         s = isl.set("{ [0]; [1]; [2] }")
 171
 172         list = []
 173         def add(bs):
 174                 list.append(bs)
 175         s.foreach_basic_set(add)
 176
 177         assert(len(list) == 3)
 178         assert(list[0].is_subset(s))
 179         assert(list[1].is_subset(s))
 180         assert(list[2].is_subset(s))
 181         assert(not list[0].is_equal(list[1]))
 182         assert(not list[0].is_equal(list[2]))
 183         assert(not list[1].is_equal(list[2]))
 184
 185         def fail(bs):
 186                 raise Exception("fail")
 187
 188         caught = False
 189         try:
 190                 s.foreach_basic_set(fail)
 191         except:
 192                 caught = True
 193         assert(caught)
 194
 195 # Test the functionality of "foreach_scc" functions.
 196 #
 197 # In particular, test it on a list of elements that can be completely sorted
 198 # but where two of the elements ("a" and "b") are incomparable.
 199 #
 200 def test_foreach_scc():
 201         list = isl.id_list(3)
 202         sorted = [isl.id_list(3)]
 203         data = {
 204                 'a' : isl.map("{ [0] -> [1] }"),
 205                 'b' : isl.map("{ [1] -> [0] }"),
 206                 'c' : isl.map("{ [i = 0:1] -> [i] }"),
 207         }
 208         for k, v in data.items():
 209                 list = list.add(k)
 210         id = data['a'].space().domain().identity_multi_pw_aff_on_domain()
 211         def follows(a, b):
 212                 map = data[b.name()].apply_domain(data[a.name()])
 213                 return not map.lex_ge_at(id).is_empty()
 214
 215         def add_single(scc):
 216                 assert(scc.size() == 1)
 217                 sorted[0] = sorted[0].concat(scc)
 218
 219         list.foreach_scc(follows, add_single)
 220         assert(sorted[0].size() == 3)
 221         assert(sorted[0].at(0).name() == "b")
 222         assert(sorted[0].at(1).name() == "c")
 223         assert(sorted[0].at(2).name() == "a")
 224
 225 # Test the functionality of "every" functions.
 226 #
 227 # In particular, test the generic functionality and
 228 # test that exceptions are properly propagated.
 229 #
 230 def test_every():
 231         us = isl.union_set("{ A[i]; B[j] }")
 232
 233         def is_empty(s):
 234                 return s.is_empty()
 235         assert(not us.every_set(is_empty))
 236
 237         def is_non_empty(s):
 238                 return not s.is_empty()
 239         assert(us.every_set(is_non_empty))
 240
 241         def in_A(s):
 242                 return s.is_subset(isl.set("{ A[x] }"))
 243         assert(not us.every_set(in_A))
 244
 245         def not_in_A(s):
 246                 return not s.is_subset(isl.set("{ A[x] }"))
 247         assert(not us.every_set(not_in_A))
 248
 249         def fail(s):
 250                 raise Exception("fail")
 251
 252         caught = False
 253         try:
 254                 us.ever_set(fail)
 255         except:
 256                 caught = True
 257         assert(caught)
 258
 259 # Check basic construction of spaces.
 260 #
 261 def test_space():
 262         unit = isl.space.unit()
 263         set_space = unit.add_named_tuple("A", 3)
 264         map_space = set_space.add_named_tuple("B", 2)
 265
 266         set = isl.set.universe(set_space)
 267         map = isl.map.universe(map_space)
 268         assert(set.is_equal(isl.set("{ A[*,*,*] }")))
 269         assert(map.is_equal(isl.map("{ A[*,*,*] -> B[*,*] }")))
 270
 271 # Construct a simple schedule tree with an outer sequence node and
 272 # a single-dimensional band node in each branch, with one of them
 273 # marked coincident.
 274 #
 275 def construct_schedule_tree():
 276         A = isl.union_set("{ A[i] : 0 <= i < 10 }")
 277         B = isl.union_set("{ B[i] : 0 <= i < 20 }")
 278
 279         node = isl.schedule_node.from_domain(A.union(B))
 280         node = node.child(0)
 281
 282         filters = isl.union_set_list(A).add(B)
 283         node = node.insert_sequence(filters)
 284
 285         f_A = isl.multi_union_pw_aff("[ { A[i] -> [i] } ]")
 286         node = node.child(0)
 287         node = node.child(0)
 288         node = node.insert_partial_schedule(f_A)
 289         node = node.member_set_coincident(0, True)
 290         node = node.ancestor(2)
 291
 292         f_B = isl.multi_union_pw_aff("[ { B[i] -> [i] } ]")
 293         node = node.child(1)
 294         node = node.child(0)
 295         node = node.insert_partial_schedule(f_B)
 296         node = node.ancestor(2)
 297
 298         return node.schedule()
 299
 300 # Test basic schedule tree functionality.
 301 #
 302 # In particular, create a simple schedule tree and
 303 # - check that the root node is a domain node
 304 # - test map_descendant_bottom_up
 305 # - test foreach_descendant_top_down
 306 # - test every_descendant
 307 #
 308 def test_schedule_tree():
 309         schedule = construct_schedule_tree()
 310         root = schedule.root()
 311
 312         assert(type(root) == isl.schedule_node_domain)
 313
 314         count = [0]
 315         def inc_count(node):
 316                 count[0] += 1
 317                 return node
 318         root = root.map_descendant_bottom_up(inc_count)
 319         assert(count[0] == 8)
 320
 321         def fail_map(node):
 322                 raise Exception("fail")
 323                 return node
 324         caught = False
 325         try:
 326                 root.map_descendant_bottom_up(fail_map)
 327         except:
 328                 caught = True
 329         assert(caught)
 330
 331         count = [0]
 332         def inc_count(node):
 333                 count[0] += 1
 334                 return True
 335         root.foreach_descendant_top_down(inc_count)
 336         assert(count[0] == 8)
 337
 338         count = [0]
 339         def inc_count(node):
 340                 count[0] += 1
 341                 return False
 342         root.foreach_descendant_top_down(inc_count)
 343         assert(count[0] == 1)
 344
 345         def is_not_domain(node):
 346                 return type(node) != isl.schedule_node_domain
 347         assert(root.child(0).every_descendant(is_not_domain))
 348         assert(not root.every_descendant(is_not_domain))
 349
 350         def fail(node):
 351                 raise Exception("fail")
 352         caught = False
 353         try:
 354                 root.every_descendant(fail)
 355         except:
 356                 caught = True
 357         assert(caught)
 358
 359         domain = root.domain()
 360         filters = [isl.union_set("{}")]
 361         def collect_filters(node):
 362                 if type(node) == isl.schedule_node_filter:
 363                         filters[0] = filters[0].union(node.filter())
 364                 return True
 365         root.every_descendant(collect_filters)
 366         assert(domain.is_equal(filters[0]))
 367
 368 # Test marking band members for unrolling.
 369 # "schedule" is the schedule created by construct_schedule_tree.
 370 # It schedules two statements, with 10 and 20 instances, respectively.
 371 # Unrolling all band members therefore results in 30 at-domain calls
 372 # by the AST generator.
 373 #
 374 def test_ast_build_unroll(schedule):
 375         root = schedule.root()
 376         def mark_unroll(node):
 377                 if type(node) == isl.schedule_node_band:
 378                         node = node.member_set_ast_loop_unroll(0)
 379                 return node
 380         root = root.map_descendant_bottom_up(mark_unroll)
 381         schedule = root.schedule()
 382
 383         count_ast = [0]
 384         def inc_count_ast(node, build):
 385                 count_ast[0] += 1
 386                 return node
 387
 388         build = isl.ast_build()
 389         build = build.set_at_each_domain(inc_count_ast)
 390         ast = build.node_from(schedule)
 391         assert(count_ast[0] == 30)
 392
 393 # Test basic AST generation from a schedule tree.
 394 #
 395 # In particular, create a simple schedule tree and
 396 # - generate an AST from the schedule tree
 397 # - test at_each_domain
 398 # - test unrolling
 399 #
 400 def test_ast_build():
 401         schedule = construct_schedule_tree()
 402
 403         count_ast = [0]
 404         def inc_count_ast(node, build):
 405                 count_ast[0] += 1
 406                 return node
 407
 408         build = isl.ast_build()
 409         build_copy = build.set_at_each_domain(inc_count_ast)
 410         ast = build.node_from(schedule)
 411         assert(count_ast[0] == 0)
 412         count_ast[0] = 0
 413         ast = build_copy.node_from(schedule)
 414         assert(count_ast[0] == 2)
 415         build = build_copy
 416         count_ast[0] = 0
 417         ast = build.node_from(schedule)
 418         assert(count_ast[0] == 2)
 419
 420         do_fail = True
 421         count_ast_fail = [0]
 422         def fail_inc_count_ast(node, build):
 423                 count_ast_fail[0] += 1
 424                 if do_fail:
 425                         raise Exception("fail")
 426                 return node
 427         build = isl.ast_build()
 428         build = build.set_at_each_domain(fail_inc_count_ast)
 429         caught = False
 430         try:
 431                 ast = build.node_from(schedule)
 432         except:
 433                 caught = True
 434         assert(caught)
 435         assert(count_ast_fail[0] > 0)
 436         build_copy = build
 437         build_copy = build_copy.set_at_each_domain(inc_count_ast)
 438         count_ast[0] = 0
 439         ast = build_copy.node_from(schedule)
 440         assert(count_ast[0] == 2)
 441         count_ast_fail[0] = 0
 442         do_fail = False
 443         ast = build.node_from(schedule)
 444         assert(count_ast_fail[0] == 2)
 445
 446         test_ast_build_unroll(schedule)
 447
 448 # Test basic AST expression generation from an affine expression.
 449 #
 450 def test_ast_build_expr():
 451         pa = isl.pw_aff("[n] -> { [n + 1] }")
 452         build = isl.ast_build.from_context(pa.domain())
 453
 454         op = build.expr_from(pa)
 455         assert(type(op) == isl.ast_expr_op_add)
 456         assert(op.n_arg() == 2)
 457
 458 # Test the isl Python interface
 459 #
 460 # This includes:
 461 #  - Object construction
 462 #  - Different parameter types
 463 #  - Different return types
 464 #  - Foreach functions
 465 #  - Foreach SCC function
 466 #  - Every functions
 467 #  - Spaces
 468 #  - Schedule trees
 469 #  - AST generation
 470 #  - AST expression generation
 471 #
 472 test_constructors()
 473 test_parameters()
 474 test_return()
 475 test_foreach()
 476 test_foreach_scc()
 477 test_every()
 478 test_space()
 479 test_schedule_tree()
 480 test_ast_build()
 481 test_ast_build_expr()