[NPM] Fix bug in llvm/utils/reduce_pipeline.py

[markus]

Summary

Last minute changes in https://reviews.llvm.org/D110908 unfortunately introduced a bug wrt automatic pipeline expansion. This patch fixes it as well as gets rid of redundant variables (string representation of of the pipeline) to avoid that this issue occurs again.

[aeubanks]

ah yes I had run into this but forgot to report it. thanks!

llvm/utils/reduce_pipeline.py

parser.add_argument(
     help='Do not remove empty pass-managers from the pipeline during reduction.'
 )
 [args, extra_opt_args] = parser.parse_known_args()
 
 print('The following extra args will be passed to opt: {}'.format(
     extra_opt_args))
 
 lst = pipeline.fromStr(args.passes)
-passes = '-passes={}'.format(pipeline.toStr(lst))
 ll_input = args.input
 
 # Step #-1
 # Launch 'opt' once with '-print-pipeline-passes' to expand pipeline before
 # starting reduction. Allows specifying a default pipelines (e.g.
 # '-passes=default<O3>').
 if not args.dont_expand_passes:
     run_args = [
         args.opt_binary, '-disable-symbolication', '-disable-output',
-        '-print-pipeline-passes', passes, ll_input
+        '-print-pipeline-passes', '-passes={}'.format(pipeline.toStr(lst)),
+        ll_input
     ]
     run_args.extend(extra_opt_args)
     opt = subprocess.run(run_args,
                          stdout=subprocess.PIPE,
                          stderr=subprocess.PIPE)
     if opt.returncode != 0:
         print('Failed to expand passes. Aborting.')
         print(run_args)
         print('exitcode: {}'.format(opt.returncode))
         print(opt.stderr.decode())
         exit(1)
     stdout = opt.stdout.decode()
     stdout = stdout[:stdout.rfind('\n')]
-    print('Expanded pass sequence: {}'.format(stdout))
-    passes = '-passes={}'.format(stdout)
+    lst = pipeline.fromStr(stdout)
+    print('Expanded pass sequence: {}'.format(pipeline.toStr(lst)))
 
 # Step #0
 # Confirm that the given input, passes and options result in failure.
 print('---Starting step #0---')
 run_args = [
-    args.opt_binary, '-disable-symbolication', '-disable-output', passes,
-    ll_input
+    args.opt_binary, '-disable-symbolication', '-disable-output',
+    '-passes={}'.format(pipeline.toStr(lst)), ll_input
 ]
 run_args.extend(extra_opt_args)
 opt = subprocess.run(run_args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 if opt.returncode >= 0:
     print('Input does not result in failure as expected. Aborting.')
     print(run_args)
     print('exitcode: {}'.format(opt.returncode))
     print(opt.stderr.decode())

 prevIntermediate = None
 tmpd = tempfile.TemporaryDirectory()
 
 for idx in range(pipeline.count(lst)):
     [lstA, lstB] = pipeline.split(lst, idx)
     if not args.dont_remove_empty_pm:
         lstA = pipeline.prune(lstA)
         lstB = pipeline.prune(lstB)
-    passesA = '-passes=' + pipeline.toStr(lstA)
-    passesB = '-passes=' + pipeline.toStr(lstB)
 
     intermediate = 'intermediate-0.ll' if idx % 2 else 'intermediate-1.ll'
     intermediate = tmpd.name + '/' + intermediate
     run_args = [
         args.opt_binary, '-disable-symbolication', '-S', '-o', intermediate,
-        passesA, ll_input
+        '-passes={}'.format(pipeline.toStr(lstA)), ll_input
     ]
     run_args.extend(extra_opt_args)
     optA = subprocess.run(run_args,
                           stdout=subprocess.PIPE,
                           stderr=subprocess.PIPE)
     run_args = [
-        args.opt_binary, '-disable-symbolication', '-disable-output', passesB,
-        intermediate
+        args.opt_binary, '-disable-symbolication', '-disable-output',
+        '-passes={}'.format(pipeline.toStr(lstB)), intermediate
     ]
     run_args.extend(extra_opt_args)
     optB = subprocess.run(run_args,
                           stdout=subprocess.PIPE,
                           stderr=subprocess.PIPE)
     if not (optA.returncode == 0
             and optB.returncode == expected_error_returncode):
         break
     prevLstB = lstB
     prevIntermediate = intermediate
 if prevLstB:
     lst = prevLstB
     ll_input = prevIntermediate
 print('-passes="{}"'.format(pipeline.toStr(lst)))
 
 # Step #2
 # Try removing passes from the end of the remaining pipeline while still
 # reproducing the error.
 print('---Starting step #2---')
 prevLstA = None
 for idx in reversed(range(pipeline.count(lst))):
     [lstA, lstB] = pipeline.split(lst, idx)
     if not args.dont_remove_empty_pm:
         lstA = pipeline.prune(lstA)
-    passesA = '-passes=' + pipeline.toStr(lstA)
     run_args = [
-        args.opt_binary, '-disable-symbolication', '-disable-output', passesA,
-        ll_input
+        args.opt_binary, '-disable-symbolication', '-disable-output',
+        '-passes={}'.format(pipeline.toStr(lstA)), ll_input
     ]
     run_args.extend(extra_opt_args)
     optA = subprocess.run(run_args,
                           stdout=subprocess.PIPE,
                           stderr=subprocess.PIPE)
     if optA.returncode != expected_error_returncode:
         break
     prevLstA = lstA
 if prevLstA:
     lst = prevLstA
 print('-passes="{}"'.format(pipeline.toStr(lst)))
 
 # Step #3
 # Now that we have a pipeline that is reduced both front and back we do
 # exhaustive sweeps over the remainder trying to remove one pass at a time.
 # Repeat as long as reduction is possible.
 print('---Starting step #3---')
 while True:
     keepGoing = False
     for idx in range(pipeline.count(lst)):
         candLst = pipeline.remove(lst, idx)
         if not args.dont_remove_empty_pm:
             candLst = pipeline.prune(candLst)
-        passes = '-passes=' + pipeline.toStr(candLst)
         run_args = [
             args.opt_binary, '-disable-symbolication', '-disable-output',
-            passes, ll_input
+            '-passes={}'.format(pipeline.toStr(candLst)), ll_input
         ]
         run_args.extend(extra_opt_args)
         opt = subprocess.run(run_args,
                              stdout=subprocess.PIPE,
                              stderr=subprocess.PIPE)
         if opt.returncode == expected_error_returncode:
             lst = candLst
             keepGoing = True

llvm/utils/reduce_pipeline_test/fake_opt.py

 parser.add_argument('-crash-seq',
                     action='store',
                     dest='crash_seq',
                     required=True)
 parser.add_argument('-o', action='store', dest='output')
 parser.add_argument('input')
 [args, unknown_args] = parser.parse_known_args()
 
-# Echo pipeline if '-print-pipeline-passes'.
+# Expand pipeline if '-print-pipeline-passes'.
 if args.print_pipeline_passes:
+    if args.passes == 'EXPAND_a_to_f':
+        print('a,b,c,d,e,f')
+    else:
         print(args.passes)
     exit(0)
 
 # Parse '-crash-seq'.
 crash_seq = []
 tok = ''
 for c in args.crash_seq:
     if c == ',':
         if tok != '':

llvm/utils/reduce_pipeline_test/test.py

def test_1(self):
             '-crash-seq=a,i'
         ]
         run = subprocess.run(run_args,
                              stdout=subprocess.PIPE,
                              stderr=subprocess.PIPE)
         self.assertEqual(run.returncode, 0)
         self.assertEqual(getFinalPasses(run), '-passes="a,i"')
 
-    def test_2(self):
-        """Test the '--dont-expand-passes' option."""
+    def test_2_0(self):
+        """Test expansion of EXPAND_a_to_f (expands into 'a,b,c,d,e,f')."""
         run_args = [
             './utils/reduce_pipeline.py',
             '--opt-binary=./utils/reduce_pipeline_test/fake_opt.py',
-            '--input=/dev/null', '--passes=a,b,c,A(d,B(e,f),g),h,i',
-            '-crash-seq=b,d,f', '--dont-expand-passes'
+            '--input=/dev/null', '--passes=EXPAND_a_to_f', '-crash-seq=b,e'
         ]
         run = subprocess.run(run_args,
                              stdout=subprocess.PIPE,
                              stderr=subprocess.PIPE)
         self.assertEqual(run.returncode, 0)
-        self.assertEqual(getFinalPasses(run), '-passes="b,A(d,B(f))"')
+        self.assertEqual(getFinalPasses(run), '-passes="b,e"')
+
+    def test_2_1(self):
+        """Test EXPAND_a_to_f and the '--dont-expand-passes' option."""
+        run_args = [
+            './utils/reduce_pipeline.py',
+            '--opt-binary=./utils/reduce_pipeline_test/fake_opt.py',
+            '--input=/dev/null', '--passes=EXPAND_a_to_f',
+            '-crash-seq=EXPAND_a_to_f', '--dont-expand-passes'
+        ]
+        run = subprocess.run(run_args,
+                             stdout=subprocess.PIPE,
+                             stderr=subprocess.PIPE)
+        self.assertEqual(run.returncode, 0)
+        self.assertEqual(getFinalPasses(run), '-passes="EXPAND_a_to_f"')
 
     def test_3(self):
         """Test that empty pass-managers get removed by default."""
         run_args = [
             './utils/reduce_pipeline.py',
             '--opt-binary=./utils/reduce_pipeline_test/fake_opt.py',
             '--input=/dev/null', '--passes=a,b,c,A(d,B(e,f),g),h,i',
             '-crash-seq=b,d,h'