[Code] Add device caps query support

Author: EgorOrachyov

README.md

@@ -37,10 +37,11 @@ prototyping algorithms on a local computer for later running on a powerful serve
 - [X] CSR matrix reduce
 - [X] CSR slicing
 - [X] Sequential fallback backend for CPU
+- [X] Device capabilities query
 - [ ] IO matrix loading from mtx file
 - [ ] IO matrix saving into mtx file
 - [ ] IO matrix saving into gviz format
-- [ ] IO user-defined file logging
+- [X] IO user-defined file logging
 - [X] Wrapper for Python API
 - [ ] Wrapper syntax sugar
 - [ ] Tests for Python wrapper

cubool/CMakeLists.txt

@@ -27,9 +27,10 @@ set(CUBOOL_SOURCES
 
 set(CUBOOL_C_API_SOURCES
     include/cubool/cubool.h
-    sources/cuBool_Version_Get.cpp
-    sources/cuBool_About_Get.cpp
-    sources/cuBool_LicenseInfo_Get.cpp
+    sources/cuBool_GetAbout.cpp
+    sources/cuBool_GetVersion.cpp
+    sources/cuBool_GetLicenseInfo.cpp
+    sources/cuBool_GetDeviceCaps.cpp
     sources/cuBool_Initialize.cpp
     sources/cuBool_Finalize.cpp
     sources/cuBool_SetupLogger.cpp

cubool/include/cubool/cubool.h

@@ -102,24 +102,24 @@ typedef uint32_t cuBool_Index;
 typedef struct cuBool_Matrix_t* cuBool_Matrix;
 
 /** Cuda device capabilities */
-typedef struct CuBool_DeviceCaps {
+typedef struct cuBool_DeviceCaps {
     char name[256];
+    bool cudaSupported;
     int major;
     int minor;
     int warp;
-    bool cudaSupported;
-    cuBool_Index globalMemoryKiBs;
-    cuBool_Index sharedMemoryPerMultiProcKiBs;
-    cuBool_Index sharedMemoryPerBlockKiBs;
-} CuBool_DeviceCaps;
+    int globalMemoryKiBs;
+    int sharedMemoryPerMultiProcKiBs;
+    int sharedMemoryPerBlockKiBs;
+} cuBool_DeviceCaps;
 
 /**
  * Query human-readable text info about the project implementation
  * @note It is safe to call this function before the library is initialized.
  *
  * @return Read-only library about info
  */
-CUBOOL_EXPORT CUBOOL_API const char* cuBool_About_Get(
+CUBOOL_EXPORT CUBOOL_API const char* cuBool_GetAbout(
 );
 
 /**
@@ -128,7 +128,7 @@ CUBOOL_EXPORT CUBOOL_API const char* cuBool_About_Get(
 
  * @return Read-only library license info
  */
-CUBOOL_EXPORT CUBOOL_API const char* cuBool_LicenseInfo_Get(
+CUBOOL_EXPORT CUBOOL_API const char* cuBool_GetLicenseInfo(
 );
 
 /**
@@ -141,7 +141,7 @@ CUBOOL_EXPORT CUBOOL_API const char* cuBool_LicenseInfo_Get(
  *
  * @return Error if failed to query version info
  */
-CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Version_Get(
+CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_GetVersion(
     int* major,
     int* minor,
     int* sub
@@ -202,8 +202,8 @@ CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_Finalize(
  *
  * @return Error if cuda device not present or if failed to query capabilities
  */
-CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_DeviceCaps_Get(
-    CuBool_DeviceCaps* deviceCaps
+CUBOOL_EXPORT CUBOOL_API cuBool_Status cuBool_GetDeviceCaps(
+    cuBool_DeviceCaps* deviceCaps
 );
 
 /**

cubool/sources/backend/backend_base.hpp

@@ -38,6 +38,7 @@ namespace cubool {
         virtual bool isInitialized() const = 0;
         virtual MatrixBase* createMatrix(size_t nrows, size_t ncols) = 0;
         virtual void releaseMatrix(MatrixBase* matrixBase) = 0;
+        virtual void queryCapabilities(cuBool_DeviceCaps& caps) = 0;
     };
 
 }

cubool/sources/core/library.cpp

@@ -87,6 +87,28 @@ namespace cubool {
 
         CHECK_RAISE_ERROR(mBackend != nullptr, BackendError, "Failed to select backend");
         mRelaxedRelease = initHints & CUBOOL_HINT_RELAXED_FINALIZE;
+
+        // Log device caps
+        cuBool_DeviceCaps caps;
+        queryCapabilities(caps);
+
+        std::stringstream ss;
+
+        if (caps.cudaSupported) {
+            ss << "Cuda device capabilities" << std::endl
+               << " name: " << caps.name << std::endl
+               << " major: " << caps.major << std::endl
+               << " minor: " << caps.minor << std::endl
+               << " warp size: " << caps.warp << std::endl
+               << " globalMemoryKiBs: " << caps.globalMemoryKiBs << std::endl
+               << " sharedMemoryPerMultiProcKiBs: " << caps.sharedMemoryPerMultiProcKiBs << std::endl
+               << " sharedMemoryPerBlockKiBs: " << caps.sharedMemoryPerBlockKiBs << std::endl;
+        }
+        else {
+            ss << "Cuda device is not presented";
+        }
+
+        mLogger->logInfo(ss.str());
     }
 
     void Library::finalize() {
@@ -187,6 +209,19 @@ namespace cubool {
         mLogger->log(Logger::Level::Error, error.what());
     }
 
+    void Library::queryCapabilities(cuBool_DeviceCaps &caps) {
+        caps.name[0] = '\0';
+        caps.cudaSupported = false;
+        caps.major = 0;
+        caps.minor = 0;
+        caps.warp = 0;
+        caps.globalMemoryKiBs = 0;
+        caps.sharedMemoryPerBlockKiBs = 0;
+        caps.sharedMemoryPerMultiProcKiBs = 0;
+
+        mBackend->queryCapabilities(caps);
+    }
+
     class Logger * Library::getLogger() {
         return mLogger.get();
     }

cubool/sources/core/library.hpp

@@ -27,8 +27,8 @@
 
 #include <core/config.hpp>
 #include <core/error.hpp>
-#include <memory>
 #include <unordered_set>
+#include <memory>
 
 namespace cubool {
 
@@ -41,6 +41,7 @@ namespace cubool {
         static class MatrixBase *createMatrix(size_t nrows, size_t ncols);
         static void releaseMatrix(class MatrixBase *matrixBase);
         static void handleError(const std::exception& error);
+        static void queryCapabilities(cuBool_DeviceCaps& caps);
         static class Logger* getLogger();
 
     private:

cubool/sources/cuBool_About_Get.cpp renamed to cubool/sources/cuBool_GetAbout.cpp

@@ -24,7 +24,7 @@
 
 #include <cuBool_Common.hpp>
 
-const char* cuBool_About_Get() {
+const char* cuBool_GetAbout() {
     static const char about[] =
         "CuBool is a linear boolean algebra library primitives and operations for \n"
         "work with dense and sparse matrices written on the NVIDIA CUDA platform. The primary \n"

cubool/sources/cuBool_GetDeviceCaps.cpp

@@ -0,0 +1,35 @@
+/**********************************************************************************/
+/* MIT License                                                                    */
+/*                                                                                */
+/* Copyright (c) 2020, 2021 JetBrains-Research                                    */
+/*                                                                                */
+/* Permission is hereby granted, free of charge, to any person obtaining a copy   */
+/* of this software and associated documentation files (the "Software"), to deal  */
+/* in the Software without restriction, including without limitation the rights   */
+/* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell      */
+/* copies of the Software, and to permit persons to whom the Software is          */
+/* furnished to do so, subject to the following conditions:                       */
+/*                                                                                */
+/* The above copyright notice and this permission notice shall be included in all */
+/* copies or substantial portions of the Software.                                */
+/*                                                                                */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR     */
+/* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,       */
+/* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE    */
+/* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER         */
+/* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,  */
+/* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE  */
+/* SOFTWARE.                                                                      */
+/**********************************************************************************/
+
+#include <cuBool_Common.hpp>
+
+cuBool_Status cuBool_GetDeviceCaps(
+        cuBool_DeviceCaps* deviceCaps
+) {
+    CUBOOL_BEGIN_BODY
+        CUBOOL_VALIDATE_LIBRARY
+        CUBOOL_ARG_NOT_NULL(deviceCaps)
+        cubool::Library::queryCapabilities(*deviceCaps);
+    CUBOOL_END_BODY
+}

cubool/sources/cuBool_LicenseInfo_Get.cpp renamed to cubool/sources/cuBool_GetLicenseInfo.cpp

@@ -24,7 +24,7 @@
 
 #include <cuBool_Common.hpp>
 
-const char* cuBool_LicenseInfo_Get() {
+const char* cuBool_GetLicenseInfo() {
     static const char license[] =
         "MIT License\n"
         "\n"

cubool/sources/cuBool_Version_Get.cpp renamed to cubool/sources/cuBool_GetVersion.cpp

@@ -24,7 +24,7 @@
 
 #include <cuBool_Common.hpp>
 
-cuBool_Status cuBool_Version_Get(
+cuBool_Status cuBool_GetVersion(
         int *major,
         int *minor,
         int *sub