[TOOL][TEST] A simple string replacing tool for testing purposes

[zinovy.nis]

Summary

The strreplace tool helps to eliminate test code duplication. For example the sample below checks 2 operations - add & sub - in the same test code, so you don't need to create 2 separate test files:

; RUN: strreplace '<OPER>' "add" < %s | strreplace "<OPER_ASM>" "addl" > %t.1
; RUN: llc -O0 < %t.1 -mtriple=i686-apple-darwin | FileCheck %t.1

; RUN: strreplace '<OPER>'  "sub" < %s | strreplace "<OPER_ASM>" "subl" > %t.2
; RUN: llc < %t.2 -mtriple=i686-apple-darwin | FileCheck %t.2

; CHECK-LABEL: @foo_<OPER>
; CHECK: <OPER_ASM>

define i32 @foo_<OPER>(i32 %v).
{
  %res = <OPER> i32 1234, %v
  ret i32 %res
}

[zinovy.nis]

Gentle ping.

[majnemer]

Please keep the developer policy in mind when you ping a patch.

[hfinkel]

I don't think this is the right approach because it encourages multiple invocations of the executables, but this adds a lot of overhead to the test-suite run time. We generally encourage placing as many related tests together in the same file as possible to reduce this overhead. Also, it moves logic (like ADD -> some_add_instruction) into the command line and away from the relevant part of the test.

If you're looking for a simple way to capture this, I recommend that we provide a way to repeat a part of the file multiple times, and each time, have the ability to provide alternates. I'm thinking of something like this (obviously the syntax could use some improvement, but I think you'll get the idea):

RUN: repeater %s > %t.all
RUN: llc < %t.all | FileCheck %t.all

; FOREACH ADD SUB
; DEFINE OPER <ADD: add, SUB: sub>
; CHECK-LABEL: @foo_<OPER>
; CHECK: <ADD: addl, SUB: subl>

define i32 @foo_<OPER>(i32 %v).
{
  %res = <OPER> i32 1234, %v
  ret i32 %res
}
; ENDFOREACH

[zinovy.nis]

OK, thanks for the review.

CMakeLists.txt

 
 add_subdirectory(lib)
 
 if( LLVM_INCLUDE_UTILS )
   add_subdirectory(utils/FileCheck)
   add_subdirectory(utils/PerfectShuffle)
   add_subdirectory(utils/count)
   add_subdirectory(utils/not)
+  add_subdirectory(utils/strreplace)
   add_subdirectory(utils/llvm-lit)
   add_subdirectory(utils/yaml-bench)
 else()
   if ( LLVM_INCLUDE_TESTS )
     message(FATAL_ERROR "Including tests when not building utils will not work.
     Either set LLVM_INCLUDE_UTILS to On, or set LLVM_INCLDE_TESTS to Off.")
   endif()
 endif()

test/CMakeLists.txt

set(LLVM_TEST_DEPENDS
           llvm-symbolizer
           llvm-tblgen
           llvm-vtabledump
           macho-dump
           opt
           FileCheck
           count
           not
+          strreplace
           yaml2obj
           obj2yaml
           verify-uselistorder
         )
 
 # If Intel JIT events are supported, depend on a tool that tests the listener.
 if( LLVM_USE_INTEL_JITEVENTS )
   set(LLVM_TEST_DEPENDS ${LLVM_TEST_DEPENDS} llvm-jitlistener)

test/lit.cfg

for pattern in [r"\bbugpoint\b(?!-)",
                 r"\bllvm-vtabledump\b",
                 r"\bllvm-c-test\b",
                 r"\bmacho-dump\b",
                 NOJUNK + r"\bopt\b",
                 r"\bFileCheck\b",
                 r"\bobj2yaml\b",
                 r"\byaml2obj\b",
                 r"\bverify-uselistorder\b",
+                r"\bstrreplace\b",
                 # Handle these specially as they are strings searched
                 # for during testing.
                 r"\| \bcount\b",
                 r"\| \bnot\b"]:
     # Extract the tool name from the pattern.  This relies on the tool
     # name being surrounded by \b word match operators.  If the
     # pattern starts with "| ", include it in the string to be
     # substituted.

utils/Makefile

 ##===- utils/Makefile --------------------------------------*- Makefile -*-===##
 # 
 #                     The LLVM Compiler Infrastructure
 #
 # This file is distributed under the University of Illinois Open Source
 # License. See LICENSE.TXT for details.
 # 
 ##===----------------------------------------------------------------------===##
 
 LEVEL = ..
-PARALLEL_DIRS := FileCheck TableGen PerfectShuffle count fpcmp llvm-lit not \
+PARALLEL_DIRS := FileCheck TableGen PerfectShuffle count fpcmp llvm-lit not strreplace \
                  unittest
 
 EXTRA_DIST := check-each-file codegen-diff countloc.sh \
               DSAclean.py DSAextract.py emacs findsym.pl GenLibDeps.pl \
         getsrcs.sh llvmdo llvmgrep llvm-native-gcc \
         llvm-native-gxx makellvm profile.pl vim
 
 include $(LEVEL)/Makefile.common

utils/strreplace/CMakeLists.txt

+add_llvm_utility(strreplace
+  strreplace.cpp
+  )
+
+target_link_libraries(strreplace)

utils/strreplace/Makefile

+##===- utils/strreplace/Makefile ----------------------------------*- Makefile -*-===##
+#
+#                     The LLVM Compiler Infrastructure
+#
+# This file is distributed under the University of Illinois Open Source
+# License. See LICENSE.TXT for details.
+#
+##===----------------------------------------------------------------------===##
+
+LEVEL = ../..
+TOOLNAME = strreplace
+USEDLIBS = LLVMSupport.a
+
+# This tool has no plugins, optimize startup time.
+TOOL_NO_EXPORTS = 1
+
+# FIXME: Don't install this utility
+#NO_INSTALL = 1
+
+include $(LEVEL)/Makefile.common
+

utils/strreplace/strreplace.cpp

+//===-            strreplace.cpp: string replacement tool                -===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include <string>
+#include <iostream>
+
+using namespace std;
+
+std::string replace_all(string s, const string &from, const string &to) {
+  const size_t fromLen = from.length();
+  const size_t toLen = to.length();
+  size_t i = 0;
+  while (true) {
+    i = s.find(from, i);
+    if (i == string::npos)
+      break;
+    s.erase(i, fromLen);
+    s.insert(i, to);
+    i += toLen;
+  }
+  return s;
+}
+
+int main(int argc, const char **argv) {
+  if (argc < 3) {
+    cout << "Usage: " << argv[0] << " <from> <to>\n"
+         << "Reads stdin, replaces all occurrences of <from> with <to> and "
+            "prints the result into stdout.\n";
+    return 1;
+  }
+  const string from = argv[1];
+  const string to = argv[2];
+  string line;
+  while (getline(cin, line))
+    cout << replace_all(line, from, to) << '\n';
+  return 0;
+}