Initial commit of preview version

1 files changed, 132 insertions, 0 deletions

diff --git a/include/internal/routine.h b/include/internal/routine.h
new file mode 100644
index 00000000..42357d8d
--- /dev/null
+++ b/include/internal/routine.h
@@ -0,0 +1,132 @@
+
+// =================================================================================================
+// This file is part of the CLBlast project. The project is licensed under Apache Version 2.0. This
+// project loosely follows the Google C++ styleguide and uses a tab-size of two spaces and a max-
+// width of 100 characters per line.
+//
+// Author(s):
+//   Cedric Nugteren <www.cedricnugteren.nl>
+//
+// This file implements all the basic functionality for the BLAS routines. This class serves as a
+// base class for the actual routines (e.g. Xaxpy, Xgemm). It contains common functionality such as
+// compiling the OpenCL kernel, connecting to the database, etc.
+//
+// =================================================================================================
+
+#ifndef CLBLAST_ROUTINE_H_
+#define CLBLAST_ROUTINE_H_
+
+#include <string>
+#include <vector>
+
+#include "internal/utilities.h"
+#include "internal/database.h"
+
+namespace clblast {
+// =================================================================================================
+
+// See comment at top of file for a description of the class
+class Routine {
+ public:
+
+  // Khronos OpenCL extensions
+  const std::string kKhronosHalfPrecision = "cl_khr_fp16";
+  const std::string kKhronosDoublePrecision = "cl_khr_fp64";
+
+  // New data-type:tThe cache of compiled OpenCL programs, along with some meta-data
+  struct ProgramCache {
+    Program program;
+    std::string device_name;
+    Precision precision;
+    std::vector<std::string> routines;
+
+    // Finds out whether the properties match
+    bool MatchInCache(const std::string &ref_name, const Precision &ref_precision,
+                      const std::vector<std::string> &ref_routines) {
+      auto ref_size = ref_routines.size();
+      if (device_name == ref_name && precision == ref_precision && routines.size() == ref_size) {
+        auto found_match = true;
+        for (auto i=size_t{0}; i<ref_size; ++i) {
+          if (routines[i] != ref_routines[i]) { found_match = false; }
+        }
+        return found_match;
+      }
+      return false;
+    }
+  };
+
+  // The actual cache, implemented as a vector of the above data-type
+  static std::vector<ProgramCache> program_cache_;
+
+  // Helper functions which check for errors in the status code
+  static constexpr bool ErrorIn(const StatusCode s) { return (s != StatusCode::kSuccess); }
+
+  // Base class constructor
+  explicit Routine(CommandQueue &queue, Event &event,
+                   const std::vector<std::string> &routines, const Precision precision);
+
+  // Set-up phase of the kernel
+  StatusCode SetUp(const std::string &routine_source);
+
+ protected:
+  
+  // Runs a kernel given the global and local thread sizes
+  StatusCode RunKernel(const Kernel &kernel, std::vector<size_t> &global,
+                       const std::vector<size_t> &local);
+
+  // Tests for valid inputs of matrices A, B, and C
+  StatusCode TestMatrixA(const size_t one, const size_t two, const Buffer &buffer,
+                         const size_t offset, const size_t ld, const size_t data_size);
+  StatusCode TestMatrixB(const size_t one, const size_t two, const Buffer &buffer,
+                         const size_t offset, const size_t ld, const size_t data_size);
+  StatusCode TestMatrixC(const size_t one, const size_t two, const Buffer &buffer,
+                         const size_t offset, const size_t ld, const size_t data_size);
+
+  // Tests for valid inputs of vectors X and Y
+  StatusCode TestVectorX(const size_t n, const Buffer &buffer, const size_t offset,
+                         const size_t inc, const size_t data_size);
+  StatusCode TestVectorY(const size_t n, const Buffer &buffer, const size_t offset,
+                         const size_t inc, const size_t data_size);
+
+  // Copies/transposes a matrix and padds/unpads it
+  StatusCode PadCopyTransposeMatrix(const size_t src_one, const size_t src_two,
+                                    const size_t src_ld, const size_t src_offset,
+                                    const Buffer &src,
+                                    const size_t dest_one, const size_t dest_two,
+                                    const size_t dest_ld, const size_t dest_offset,
+                                    const Buffer &dest,
+                                    const bool do_transpose, const bool pad,
+                                    const Program &program);
+  
+  // Queries the cache and retrieve either a matching program or a boolean whether a match exists.
+  // The first assumes that the program is available in the cache and will throw an exception
+  // otherwise.
+  Program GetProgramFromCache() const;
+  bool ProgramIsInCache() const;
+
+  // Non-static variable for the precision. Note that the same variable (but static) might exist in
+  // a derived class.
+  const Precision precision_;
+
+  // The OpenCL objects, accessible only from derived classes
+  CommandQueue queue_;
+  Event event_;
+  const Context context_;
+  const Device device_;
+
+  // OpenCL device properties
+  const std::string device_name_;
+  const cl_uint max_work_item_dimensions_;
+  const std::vector<size_t> max_work_item_sizes_;
+  const size_t max_work_group_size_;
+
+  // Connection to the database for all the device-specific parameters
+  const Database db_;
+  const std::vector<std::string> routines_;
+};
+
+// =================================================================================================
+} // namespace clblast
+
+// CLBLAST_ROUTINE_H_
+#endif