flang/test/Evaluate/test_folding.py

   1 #!/usr/bin/env python3
   2
   3 """This script verifies expression folding.
   4 It compiles a source file with '-fdebug-dump-symbols'
   5 and looks for parameter declarations to check
   6 they have been folded as expected.
   7 To check folding of an expression EXPR,
   8 the fortran program passed to this script
   9 must contain the following:
  10
  11   logical, parameter :: test_x = <compare EXPR to expected value>
  12
  13 This script will test that all parameter
  14 with a name starting with "test_"
  15 have been folded to .true.
  16 For instance, acos folding can be tested with:
  17
  18   real(4), parameter :: res_acos = acos(0.5_4)
  19   real(4), parameter :: exp_acos = 1.047
  20   logical, parameter :: test_acos = abs(res_acos - exp_acos).LE.(0.001_4)
  21
  22 There are two kinds of failure:
  23   - test_x is folded to .false..
  24     This means the expression was folded
  25     but the value is not as expected.
  26   - test_x is not folded (it is neither .true. nor .false.).
  27     This means the compiler could not fold the expression.
  28
  29 Parameters:
  30     sys.argv[1]: a source file with contains the input and expected output
  31     sys.argv[2]: the Flang frontend driver
  32     sys.argv[3:]: Optional arguments to the Flang frontend driver"""
  33
  34 import os
  35 import sys
  36 import tempfile
  37 import re
  38 import subprocess
  39
  40 from difflib import unified_diff
  41 from pathlib import Path
  42
  43 def check_args(args):
  44     """Verifies that the number is arguments passed is correct."""
  45     if len(args) < 3:
  46         print(f"Usage: {args[0]} <fortran-source> <flang-command>")
  47         sys.exit(1)
  48
  49 def set_source(source):
  50     """Sets the path to the source files."""
  51     if not Path(source).is_file():
  52         print(f"File not found: {src}")
  53         sys.exit(1)
  54     return Path(source)
  55
  56 def set_executable(exe):
  57     """Sets the path to the Flang frontend driver."""
  58     if not Path(exe).is_file():
  59         print(f"Flang was not found: {exe}")
  60         sys.exit(1)
  61     return str(Path(exe))
  62
  63 check_args(sys.argv)
  64 cwd = os.getcwd()
  65 srcdir = set_source(sys.argv[1]).resolve()
  66 with open(srcdir, 'r', encoding="utf-8") as f:
  67     src = f.readlines()
  68 src1 = ""
  69 src2 = ""
  70 src3 = ""
  71 src4 = ""
  72 messages = ""
  73 actual_warnings = ""
  74 expected_warnings = ""
  75 warning_diffs = ""
  76
  77 flang_fc1 = set_executable(sys.argv[2])
  78 flang_fc1_args = sys.argv[3:]
  79 flang_fc1_options = ""
  80 LIBPGMATH = os.getenv('LIBPGMATH')
  81 if LIBPGMATH:
  82     flang_fc1_options = ["-fdebug-dump-symbols", "-DTEST_LIBPGMATH"]
  83     print("Assuming libpgmath support")
  84 else:
  85     flang_fc1_options = ["-fdebug-dump-symbols"]
  86     print("Not assuming libpgmath support")
  87
  88 cmd = [flang_fc1, *flang_fc1_args, *flang_fc1_options, str(srcdir)]
  89 with tempfile.TemporaryDirectory() as tmpdir:
  90     proc = subprocess.run(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE,
  91                           check=True, universal_newlines=True, cwd=tmpdir)
  92     src1 = proc.stdout
  93     messages = proc.stderr
  94
  95 for line in src1.split("\n"):
  96     m = re.search(r"(\w*)(?=, PARAMETER).*init:(.*)", line)
  97     if m:
  98         src2 += f"{m.group(1)} {m.group(2)}\n"
  99
 100 for line in src2.split("\n"):
 101     m = re.match(r"test_*", line)
 102     if m:
 103         src3 += f"{m.string}\n"
 104
 105 for passed_results, line in enumerate(src3.split("\n")):
 106     m = re.search(r"\.false\._.$", line)
 107     if m:
 108         src4 += f"{line}\n"
 109
 110 for line in messages.split("\n"):
 111     m = re.search(r"[^:]*:(\d*):\d*: (.*)", line)
 112     if m:
 113         actual_warnings += f"{m.group(1)}: {m.group(2)}\n"
 114
 115 passed_warnings = 0
 116 warnings = []
 117 for i, line in enumerate(src, 1):
 118     m = re.search(r"(?:!WARN:)(.*)", line)
 119     if m:
 120         warnings.append(m.group(1))
 121         continue
 122     if warnings:
 123         for x in warnings:
 124             passed_warnings += 1
 125             expected_warnings += f"{i}:{x}\n"
 126         warnings = []
 127
 128 for line in unified_diff(actual_warnings.split("\n"),
 129                          expected_warnings.split("\n"), n=0):
 130     line = re.sub(r"(^\-)(\d+:)", r"\nactual at \g<2>", line)
 131     line = re.sub(r"(^\+)(\d+:)", r"\nexpect at \g<2>", line)
 132     warning_diffs += line
 133
 134 if src4 or warning_diffs:
 135     print("Folding test failed:")
 136     # Prints failed tests, including parameters with the same
 137     # suffix so that more information can be obtained by declaring
 138     # expected_x and result_x
 139     if src4:
 140         for line in src4.split("\n"):
 141             m = re.match(r"test_(\w+)", line)
 142             if m:
 143                 for line in src2.split("\n"):
 144                     if m.group(1) in line:
 145                         print(line)
 146     if warning_diffs:
 147         print(warning_diffs)
 148     print()
 149     print("FAIL")
 150     sys.exit(1)
 151 else:
 152     print()
 153     print(f"All {passed_results+passed_warnings} tests passed")
 154     print("PASS")
 155