[MLIR] Add simple runner utilities for timing

[bondhugula]

Summary

Add utilities print_flops, rtclock for timing / benchmarking. Add
mlir_runner_utils_dir test conf variable.

Signed-off-by: Uday Bondhugula <[e-mail]>

[bondhugula]

Fix casing for timeval

[ftynse]

mlir/lib/ExecutionEngine/RunnerUtils.cpp

17

We need some conditional compilation mechanism here, MLIR needs to be buildable on other systems than Linux.

[bondhugula]

Address review comment - conditional compile excluding WIN32

[bondhugula]

Thanks for noticing. PTAL.

[ftynse]

mlir/test/mlir-cpu-runner/sgemm_naive_codegen.mlir

16

This test will fail on Windows because the linker in JIT won't resolve this function. Consider returning 0.0 from the function and printing a message instead?

[bondhugula]

mlir/test/mlir-cpu-runner/sgemm_naive_codegen.mlir

16

Thanks, done.

[bondhugula]

Emit error message for the timer util on Win32

[bondhugula]

Ping reviewers @herhut @ftynse - thanks.

[ftynse]

mlir/lib/ExecutionEngine/RunnerUtils.cpp

113

Ultra-nit: the code below uses C-style I/O, let's be consistent here.

mlir/test/mlir-cpu-runner/sgemm_naive_codegen.mlir

2

Do we actually need the entire sgemm with non-trivial pipeline to test the flops printing utility?

[bondhugula]

Thanks for the review.

mlir/lib/ExecutionEngine/RunnerUtils.cpp

113

Thanks - changed to C style.

mlir/test/mlir-cpu-runner/sgemm_naive_codegen.mlir

2

This is for both - flops printing and timing. We don't need sgemm in particular; could have used say sdot as something minimal where the FLOPS would still be meaningful. But I reduced the problem size to something really small - so it shouldn't matter (exec time is 0.002s), and this could be an additional integration test for mlir-cpu-runner.

mlir/lib/ExecutionEngine/RunnerUtils.cpp

 //===- RunnerUtils.cpp - Utils for MLIR exec on targets with a C++ runtime ===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 //
 // This file implements basic functions to debug structured MLIR types at
 // runtime. Entities in this file may not be compatible with targets without a
 // C++ runtime. These may be progressively migrated to CRunnerUtils.cpp over
 // time.
 //
 //===----------------------------------------------------------------------===//
 
 #include "mlir/ExecutionEngine/RunnerUtils.h"
 
+#ifndef _WIN32
+#include <sys/time.h>
+#endif // _WIN32
+
 extern "C" void _mlir_ciface_print_memref_vector_4x4xf32(
     StridedMemRefType<Vector2D<4, 4, float>, 2> *M) {
   impl::printMemRef(*M);
 }
 
 #define MEMREF_CASE(TYPE, RANK)                                                \
   case RANK:                                                                   \
     impl::printMemRef(*(static_cast<StridedMemRefType<TYPE, RANK> *>(ptr)));   \

 extern "C" void
 _mlir_ciface_print_memref_3d_f32(StridedMemRefType<float, 3> *M) {
   impl::printMemRef(*M);
 }
 extern "C" void
 _mlir_ciface_print_memref_4d_f32(StridedMemRefType<float, 4> *M) {
   impl::printMemRef(*M);
 }
+
+/// Prints GFLOPS rating.
+extern "C" void print_flops(double flops) {
+  fprintf(stderr, "%lf GFLOPS\n", flops / 1.0E9);
+}
+
+/// Returns the number of seconds since Epoch 1970-01-01 00:00:00 +0000 (UTC).
+extern "C" double rtclock() {
+#ifndef _WIN32
+  struct timeval tp;
+  int stat = gettimeofday(&tp, NULL);
+  if (stat != 0)
+    fprintf(stderr, "Error returning time from gettimeofday: %d\n", stat);
+  return (tp.tv_sec + tp.tv_usec * 1.0e-6);
+#else
+  fprintf(stderr, "Timing utility not implemented on Windows\n");
+  return 0.0;
+#endif // _WIN32
+}

mlir/test/CMakeLists.txt

 add_subdirectory(EDSC)
 add_subdirectory(mlir-cpu-runner)
 add_subdirectory(SDBM)
 add_subdirectory(lib)
 
 llvm_canonicalize_cmake_booleans(
   LLVM_BUILD_EXAMPLES
   )
 
 # Passed to lit.site.cfg.py.in to set up the path where to find the libraries
 # for linalg integration tests.
 set(MLIR_DIALECT_LINALG_INTEGRATION_TEST_LIB_DIR ${CMAKE_LIBRARY_OUTPUT_DIRECTORY})
+set(MLIR_RUNNER_UTILS_DIR ${CMAKE_LIBRARY_OUTPUT_DIRECTORY})
 
 # Passed to lit.site.cfg.py.in to set up the path where to find the libraries
 # for the mlir cuda runner tests.
 set(MLIR_CUDA_WRAPPER_LIBRARY_DIR ${CMAKE_LIBRARY_OUTPUT_DIRECTORY})
 set(MLIR_VULKAN_WRAPPER_LIBRARY_DIR ${CMAKE_LIBRARY_OUTPUT_DIRECTORY})
 
 configure_lit_site_cfg(
   ${CMAKE_CURRENT_SOURCE_DIR}/lit.site.cfg.py.in

mlir/test/lit.cfg.py

 
 # The following tools are optional
 tools.extend([
     ToolSubst('toy-ch1', unresolved='ignore'),
     ToolSubst('toy-ch2', unresolved='ignore'),
     ToolSubst('toy-ch3', unresolved='ignore'),
     ToolSubst('toy-ch4', unresolved='ignore'),
     ToolSubst('toy-ch5', unresolved='ignore'),
-    ToolSubst('%linalg_test_lib_dir', config.linalg_test_lib_dir, unresolved='ignore'),
     ToolSubst('%cuda_wrapper_library_dir', config.cuda_wrapper_library_dir, unresolved='ignore'),
+    ToolSubst('%linalg_test_lib_dir', config.linalg_test_lib_dir, unresolved='ignore'),
+    ToolSubst('%mlir_runner_utils_dir', config.mlir_runner_utils_dir, unresolved='ignore'),
     ToolSubst('%vulkan_wrapper_library_dir', config.vulkan_wrapper_library_dir, unresolved='ignore')
 ])
 
 llvm_config.add_tool_substitutions(tools, tool_dirs)

mlir/test/lit.site.cfg.py.in

 config.host_cxx = "@HOST_CXX@"
 # Note: ldflags can contain double-quoted paths, so must use single quotes here.
 config.host_ldflags = '@HOST_LDFLAGS@'
 config.llvm_use_sanitizer = "@LLVM_USE_SANITIZER@"
 config.llvm_host_triple = '@LLVM_HOST_TRIPLE@'
 config.host_arch = "@HOST_ARCH@"
 config.mlir_src_root = "@MLIR_SOURCE_DIR@"
 config.mlir_obj_root = "@MLIR_BINARY_DIR@"
+config.mlir_runner_utils_dir = "@MLIR_RUNNER_UTILS_DIR@"
 config.mlir_tools_dir = "@MLIR_TOOLS_DIR@"
 config.linalg_test_lib_dir = "@MLIR_DIALECT_LINALG_INTEGRATION_TEST_LIB_DIR@"
 config.build_examples = @LLVM_BUILD_EXAMPLES@
 config.run_cuda_tests = @MLIR_CUDA_CONVERSIONS_ENABLED@
 config.cuda_wrapper_library_dir = "@MLIR_CUDA_WRAPPER_LIBRARY_DIR@"
 config.enable_cuda_runner = @MLIR_CUDA_RUNNER_ENABLED@
 config.vulkan_wrapper_library_dir = "@MLIR_VULKAN_WRAPPER_LIBRARY_DIR@"
 config.enable_vulkan_runner = @MLIR_VULKAN_RUNNER_ENABLED@

mlir/test/mlir-cpu-runner/sgemm_naive_codegen.mlir

+// RUN: mlir-opt -convert-linalg-to-loops -lower-affine -convert-loop-to-std -convert-std-to-llvm %s | mlir-cpu-runner -O3 -e main -entry-point-result=void -shared-libs=%mlir_runner_utils_dir/libmlir_runner_utils%shlibext | FileCheck %s
+
+func @main() {
+  %A = alloc() : memref<64x64xf32>
+  %B = alloc() : memref<64x64xf32>
+  %C = alloc() : memref<64x64xf32>
+
+  %cf1 = constant 1.00000e+00 : f32
+
+  linalg.fill(%A, %cf1) : memref<64x64xf32>, f32
+  linalg.fill(%B, %cf1) : memref<64x64xf32>, f32
+
+  %reps = constant 1 : index
+
+  %t_start = call @rtclock() : () -> f64
+  affine.for %arg0 = 0 to 5 {
+    linalg.fill(%C, %cf1) : memref<64x64xf32>, f32
+    call @sgemm_naive(%A, %B, %C) : (memref<64x64xf32>, memref<64x64xf32>, memref<64x64xf32>) -> ()
+  }
+  %t_end = call @rtclock() : () -> f64
+  %t = subf %t_end, %t_start : f64
+
+  %pC = memref_cast %C : memref<64x64xf32> to memref<*xf32>
+  call @print_memref_f32(%pC) : (memref<*xf32>) -> ()
+
+  %M = dim %C, 0 : memref<64x64xf32>
+  %N = dim %C, 1 : memref<64x64xf32>
+  %K = dim %A, 1 : memref<64x64xf32>
+
+  %f1 = muli %M, %N : index
+  %f2 = muli %f1, %K : index
+
+  // 2*M*N*K.
+  %c2 = constant 2 : index
+  %f3 = muli %c2, %f2 : index
+  %num_flops = muli %reps, %f3 : index
+  %num_flops_i = index_cast %num_flops : index to i64
+  %num_flops_f = sitofp %num_flops_i : i64 to f64
+  %flops = divf %num_flops_f, %t : f64
+  call @print_flops(%flops) : (f64) -> ()
+
+  return
+}
+// CHECK: 65,   65,   65,
+
+func @sgemm_naive(%arg0: memref<64x64xf32>, %arg1: memref<64x64xf32>, %arg2: memref<64x64xf32>) {
+  %c0 = constant 0 : index
+  affine.for %arg3 = 0 to 64 {
+    affine.for %arg4 = 0 to 64 {
+      %m = alloc() : memref<1xf32>
+      %v = affine.load %arg2[%arg3, %arg4] : memref<64x64xf32>
+      affine.store %v, %m[%c0] : memref<1xf32>
+      affine.for %arg5 = 0 to 64 {
+        %3 = affine.load %arg0[%arg3, %arg5] : memref<64x64xf32>
+        %4 = affine.load %arg1[%arg5, %arg4] : memref<64x64xf32>
+        %5 = affine.load %m[0] : memref<1xf32>
+        %6 = mulf %3, %4 : f32
+        %7 = addf %6, %5 : f32
+        affine.store %7, %m[0] : memref<1xf32>
+      }
+      %s = affine.load %m[%c0] : memref<1xf32>
+      affine.store %s, %arg2[%arg3, %arg4] : memref<64x64xf32>
+      dealloc %m : memref<1xf32>
+    }
+  }
+  return
+}
+
+func @print_flops(f64)
+func @rtclock() -> f64
+func @print_memref_f32(memref<*xf32>)