[PTX/GCN] Replace tabs into spaces such that @code_for and @code_diff match

Author: Keluaa

src/cleanup/cleanup.jl

@@ -21,6 +21,31 @@ cleanup_code(type, code) = cleanup_code(type, code, true, (;))
 cleanup_code(type, code, dbinfo) = cleanup_code(type, code, dbinfo, (;))
 cleanup_code(_, c, _, _) = c  # default is no cleanup
 
+
+function replace_tabs(tab_width)
+    # Matches any line with at least one tab in it
+    line_with_tabs = r"^.*?\t.*$"m
+
+    function replace_all_tabs_within_line(line)
+        buf = IOBuffer(; sizehint=ncodeunits(line))
+        column = 0
+        for char in line
+            if char == '\t'
+                required_spaces = tab_width - (column % tab_width)
+                foreach(_ -> print(buf, ' '), 1:required_spaces)
+                column += required_spaces
+            else
+                print(buf, char)
+                column += 1
+            end
+        end
+        return String(take!(buf))
+    end
+
+    return line_with_tabs => replace_all_tabs_within_line
+end
+
+
 include("julia_names.jl")
 include("typed_ir.jl")
 include("llvm_ir.jl")

src/cleanup/gcn.jl

@@ -68,6 +68,9 @@ function cleanup_code(::Val{:gcn}, c, dbinfo, cleanup_opts)
         r"\s*; -- Begin function.+$"m => "",
         extra_patterns...,
     )
+
+    # GCN doesn't have any instruction guards, so 4 spaces is enough.
+    c = replace(c, replace_tabs(4))
     return rstrip(c)  # remove trailing newlines
 end
 
@@ -81,7 +84,7 @@ function align_instruction_operand(column)
         m = match(operand_regex, c)
         isnothing(m) && return c
 
-        mnemonic_end     = m.offsets[1]
+        mnemonic_end = m.offsets[1]
 
         if all(isspace, m[2])
             # In case the operands are just trailing spaces, return only the mnemonic

src/cleanup/ptx.jl

@@ -45,7 +45,7 @@ function cleanup_code(::Val{:ptx}, c, dbinfo, cleanup_opts)
         push!(extra_patterns, align_instruction_predicates(align_preds))
     end
 
-    return replace(c,
+    c = replace(c,
         # Parameter names are always local to a function, so this should never create ambiguous code.
         trim_parameter_names(),
         # Generic match to cleanup external functions as well
@@ -66,6 +66,10 @@ function cleanup_code(::Val{:ptx}, c, dbinfo, cleanup_opts)
         r"\R{2,}" => "\n",
         extra_patterns...
     )
+
+    # Replace tabs by 8 spaces, as it gives enough space for instruction guards.
+    # Some patterns may depend on tabs, so we must replace them last.
+    return replace(c, replace_tabs(8))
 end
 
 

src/cleanup/sass.jl

@@ -31,5 +31,8 @@ function cleanup_code(::Val{:sass}, c, dbinfo, cleanup_opts)
         push!(extra_patterns, r"; Location .+\R" => "")  # Remove location comments
     end
 
-    return replace(c, extra_patterns...)
+    c = replace(c, extra_patterns...)
+
+    # SASS output uses 8 spaces as indent, but there is still some tabs in some places.
+    return replace(c, replace_tabs(8))    
 end

test/cleanup.jl

@@ -217,6 +217,7 @@ end
         # Others
         @test !has_trailing_spaces(cleaned_ptx)
         @test count(r"\R{2,}", cleaned_ptx) == 0  # no empty lines
+        @test count('\t', cleaned_ptx) == 0  # no tabs
 
         # Make sure we didn't remove any instruction by mistake
         @test count(';', ptx_sample) == count(';', cleaned_ptx)
@@ -239,6 +240,7 @@ end
         @test !has_trailing_spaces(cleaned_ptx)
         @test count(r"\R{2,}", cleaned_ptx) == 0  # no empty lines
         @test !endswith(cleaned_ptx, r"\R")  # no trailing newlines
+        @test count('\t', cleaned_ptx) == 0  # no tabs
 
         # Make sure we didn't remove any instruction by mistake
         @test count(';', ptx_sample) == count(';', cleaned_ptx)
@@ -260,6 +262,7 @@ end
         @test !has_trailing_spaces(cleaned_ptx)
         @test count(r"\R{2,}", cleaned_ptx) == 0  # no empty lines
         @test !endswith(cleaned_ptx, r"\R")  # no trailing newlines
+        @test count('\t', cleaned_ptx) == 0  # no tabs
 
         # Make sure we didn't remove any instruction by mistake
         @test count(';', ptx_sample) == count(';', cleaned_ptx)
@@ -284,6 +287,7 @@ end
         # Others
         @test !has_trailing_spaces(cleaned_sass)
         @test !endswith(cleaned_sass, r"\R")  # no trailing newlines
+        @test count('\t', cleaned_sass) == 0  # no tabs
 
         # Location comments should be removed with `dbinfo=false`
         cleaned_sass_no_loc = CDC.cleanup_code(Val(:sass), sass_sample, false)
@@ -321,6 +325,7 @@ end
         @test !has_trailing_spaces(cleaned_gcn)
         @test count(r"\R{2,}", cleaned_gcn) == 0  # no empty lines
         @test !endswith(cleaned_gcn, r"\R")  # no trailing newlines
+        @test count('\t', cleaned_gcn) == 0  # no tabs
     end
 end
 
@@ -345,6 +350,7 @@ end
         @test !has_trailing_spaces(cleaned_spirv)
         @test count(r"\R{2,}", cleaned_spirv) == 0  # no empty lines
         @test !endswith(cleaned_spirv, r"\R")  # no trailing newlines
+        @test count('\t', cleaned_spirv) == 0  # no tabs
     end
 end