[mlir][sparse] simplification of sparse runtime support lib

Incorporated two header files directly into other since
other parts were used (and it makes it hard to find the
definitions). Removed TODOs that are less likely to be done.

Reviewed By: Peiming

Differential Revision: https://reviews.llvm.org/D159330

Author: aartbik

mlir/include/mlir/ExecutionEngine/SparseTensor/ArithmeticUtils.h

@@ -6,23 +6,13 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// This header is not part of the public API.  It is placed in the
-// includes directory only because that's required by the implementations
-// of template-classes.
-//
-// This file is part of the lightweight runtime support library for sparse
-// tensor manipulations.  The functionality of the support library is meant
-// to simplify benchmarking, testing, and debugging MLIR code operating on
-// sparse tensors.  However, the provided functionality is **not** part of
-// core MLIR itself.
+// A collection of "safe" arithmetic helper methods.
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef MLIR_EXECUTIONENGINE_SPARSETENSOR_ARITHMETICUTILS_H
 #define MLIR_EXECUTIONENGINE_SPARSETENSOR_ARITHMETICUTILS_H
 
-#include "mlir/ExecutionEngine/SparseTensor/Attributes.h"
-
 #include <cassert>
 #include <cinttypes>
 #include <limits>
@@ -108,12 +98,6 @@ constexpr bool safelyGE(T t, U u) noexcept {
 //
 //===----------------------------------------------------------------------===//
 
-// TODO: we would like to be able to pass in custom error messages, to
-// improve the user experience.  We should be able to use something like
-// `assert(((void)(msg ? msg : defaultMsg), cond))`; but I'm not entirely
-// sure that'll work as intended when done within a function-definition
-// rather than within a macro-definition.
-
 /// A version of `static_cast<To>` which checks for overflow/underflow.
 /// The implementation avoids performing runtime assertions whenever
 /// the types alone are sufficient to statically prove that overflow
@@ -140,7 +124,8 @@ inline uint64_t checkedMul(uint64_t lhs, uint64_t rhs) {
   // If assertions are enabled and we have the intrinsic, then use it to
   // avoid the expensive division.  If assertions are disabled, then don't
   // bother with intrinsics (to avoid any possible slowdown vs `operator*`).
-#if !defined(NDEBUG) && MLIR_SPARSETENSOR_HAS_BUILTIN(__builtin_mul_overflow)
+#if !defined(NDEBUG) && defined(__has_builtin) &&                              \
+    __has_builtin(__builtin_mul_overflow)
   uint64_t result;
   bool overflowed = __builtin_mul_overflow(lhs, rhs, &result);
   assert(!overflowed && "Integer overflow");

mlir/include/mlir/ExecutionEngine/SparseTensor/Attributes.h

@@ -6,20 +6,10 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// This header is not part of the public API.  It is placed in the
-// includes directory only because that's required by the implementations
-// of template-classes.
-//
 // This file defines an extremely lightweight API for fatal errors (not
 // arising from assertions).  The API does not attempt to be sophisticated
 // in any way, it's just the usual "I give up" style of error reporting.
 //
-// This file is part of the lightweight runtime support library for sparse
-// tensor manipulations.  The functionality of the support library is meant
-// to simplify benchmarking, testing, and debugging MLIR code operating on
-// sparse tensors.  However, the provided functionality is **not** part of
-// core MLIR itself.
-//
 //===----------------------------------------------------------------------===//
 
 #ifndef MLIR_EXECUTIONENGINE_SPARSETENSOR_ERRORHANDLING_H

mlir/include/mlir/ExecutionEngine/SparseTensor/ErrorHandling.h

@@ -15,18 +15,11 @@
 // (2) Formidable Repository of Open Sparse Tensors and Tools (FROSTT): *.tns
 //     http://frostt.io/tensors/file-formats.html
 //
-// This file is part of the lightweight runtime support library for sparse
-// tensor manipulations.  The functionality of the support library is meant
-// to simplify benchmarking, testing, and debugging MLIR code operating on
-// sparse tensors.  However, the provided functionality is **not** part of
-// core MLIR itself.
-//
 //===----------------------------------------------------------------------===//
 
 #ifndef MLIR_EXECUTIONENGINE_SPARSETENSOR_FILE_H
 #define MLIR_EXECUTIONENGINE_SPARSETENSOR_FILE_H
 
-#include "mlir/ExecutionEngine/SparseTensor/PermutationRef.h"
 #include "mlir/ExecutionEngine/SparseTensor/Storage.h"
 
 #include <fstream>
@@ -84,13 +77,6 @@ inline V readValue(char **linePtr, bool isPattern) {
 
 //===----------------------------------------------------------------------===//
 
-// TODO: benchmark whether to keep various methods inline vs moving them
-// off to the cpp file.
-
-// TODO: consider distinguishing separate classes for before vs
-// after reading the header; so as to statically avoid the need
-// to `assert(isValid())`.
-
 /// This class abstracts over the information stored in file headers,
 /// as well as providing the buffers and methods for parsing those headers.
 class SparseTensorReader final {