SASS cleanup tests

Author: Keluaa

src/cleanup/cleanup.jl

@@ -26,6 +26,7 @@ include("typed_ir.jl")
 include("llvm_ir.jl")
 include("native.jl")
 include("ptx.jl")
+include("sass.jl")
 include("gcn.jl")
 include("agx.jl")
 include("spirv.jl")

src/cleanup/ptx.jl

@@ -2,9 +2,6 @@
 # The PTX output of LLVM's NVPTX backend has a comment with the mangled function name
 const PTX_FUNC_NAME_COMMENT_REGEX = r"// -- Begin function "m * MANGLED_NAME_REGEX * r"$"m
 
-# Same with SASS but the name is surrounded by a lot of dashes
-const SASS_FUNC_NAME_COMMENT_REGEX = r"//-{5,} .text."m * MANGLED_NAME_REGEX * r" -{5,}$"m
-
 
 function cleanup_code(::Val{:ptx}, c, dbinfo, cleanup_opts)
     c = clean_function_name(PTX_FUNC_NAME_COMMENT_REGEX, c)
@@ -60,28 +57,6 @@ function cleanup_code(::Val{:ptx}, c, dbinfo, cleanup_opts)
 end
 
 
-function cleanup_code(::Val{:sass}, c, dbinfo, cleanup_opts)
-    # SASS problems:
-    # Registers seem to be assigned randomly, changing from one call to another with the
-    # same input, as well as some immediate values (maybe related to the functions order in PTX?).
-    # Some instructions (only `MOV` from what I saw) might be ordered differently, or even
-    # in different numbers (max of what I could see is 1, but still surprising).
-    c = replace_llvm_module_name(c)
-    c = clean_function_name(SASS_FUNC_NAME_COMMENT_REGEX, c)
-
-    extra_patterns = []
-    if get(cleanup_opts, :demangle, true)
-        # Demangle only names which aren't the function's name
-        push!(extra_patterns, demangle_all())
-    end
-    if !dbinfo
-        push!(extra_patterns, r"; Location .+\R" => "")  # Remove location comments
-    end
-
-    return replace(c, extra_patterns...)
-end
-
-
 function find_main_ptx_function(c)
     # Matches any declaration of the form ".a1 .a2 some_name ( ..." and extracts ".a1 .a2" in group
     # "attrs" and "some_name" in group "name".

src/cleanup/sass.jl

@@ -0,0 +1,25 @@
+
+# SASS is the same as PTX, but the name is surrounded by a lot of dashes
+const SASS_FUNC_NAME_COMMENT_REGEX = r"//-{5,} \.text\."m * MANGLED_NAME_REGEX * r" -{5,}$"m
+
+
+function cleanup_code(::Val{:sass}, c, dbinfo, cleanup_opts)
+    # TODO: SASS problems:
+    # Registers seem to be assigned randomly, changing from one call to another with the
+    # same input, as well as some immediate values (maybe related to the functions order in PTX?).
+    # Some instructions (only `MOV` from what I saw) might be ordered differently, or even
+    # in different numbers (max of what I could see is 1, but still surprising).
+    c = replace_llvm_module_name(c)
+    c = clean_function_name(SASS_FUNC_NAME_COMMENT_REGEX, c)
+
+    extra_patterns = []
+    if get(cleanup_opts, :demangle, true)
+        # Demangle only names which aren't the function's name
+        push!(extra_patterns, demangle_all())
+    end
+    if !dbinfo
+        push!(extra_patterns, r"; Location .+\R" => "")  # Remove location comments
+    end
+
+    return replace(c, extra_patterns...)
+end

test/cleanup.jl

@@ -256,7 +256,28 @@ end
 
 
 @testset "SASS" begin
-    # TODO
+    @testset "Sample 1" begin
+        sass_sample = readchomp("./samples/extern_func_with_no_params.sass")
+        cleaned_sass = CDC.cleanup_code(Val(:sass), sass_sample)
+
+        println(TEST_IO, "\nCleaned SASS sample 1:")
+        println(TEST_IO, cleaned_sass)
+
+        # No mangled names
+        @test is_removed(CDC.MANGLED_NAME_REGEX, sass_sample, cleaned_sass)
+
+        # Make sure we didn't remove any instruction by mistake
+        @test count(r";$"m, sass_sample) == count(r";$"m, cleaned_sass)
+
+        # Others
+        @test !has_trailing_spaces(cleaned_sass)
+        @test !endswith(cleaned_sass, r"\R")  # no trailing newlines
+
+        # Location comments should be removed with `dbinfo=false`
+        cleaned_sass_no_loc = CDC.cleanup_code(Val(:sass), sass_sample, false)
+        @test is_removed("; Location", cleaned_sass, cleaned_sass_no_loc)
+        @test count(r"\R{2,}", cleaned_sass) == count(r"\R{2,}", cleaned_sass_no_loc)  # no empty lines were added
+    end
 end