OpenCL Language Server Refactoring

.gitignore

@@ -20,6 +20,7 @@ xcuserdata/
 *.xccheckout
 *.xcscmblueprint
 .DS_Store
+Testing
 
 ## Conan
 .conan*
@@ -31,9 +32,9 @@ test_package/*
 .build*
 
 ## VS Code
+.vs
 .vscode
 CMakePresets.json
 
-
 ## Python
 .pyenv

CMakeLists.txt

@@ -47,6 +47,7 @@ find_package(OpenCLHeadersCpp REQUIRED)
 find_package(spdlog REQUIRED)
 find_package(nlohmann_json REQUIRED)
 find_package(CLI11 REQUIRED)
+find_package(uriparser REQUIRED)
 
 if(ENABLE_TESTING)
     find_package(GTest REQUIRED)
@@ -57,15 +58,18 @@ endif()
 
 set(headers
     clinfo.hpp
+    device.hpp
     diagnostics.hpp
     jsonrpc.hpp
+    log.hpp
     lsp.hpp
     utils.hpp
 )
 set(sources
     clinfo.cpp
     diagnostics.cpp
     jsonrpc.cpp
+    log.cpp
     lsp.cpp
     main.cpp
     utils.cpp
@@ -75,7 +79,7 @@ list(TRANSFORM sources PREPEND "${CMAKE_CURRENT_SOURCE_DIR}/src/")
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/include/version.hpp.in version.hpp)
 source_group("include" FILES ${headers})
 source_group("src" FILES ${sources})
-set(libs nlohmann_json::nlohmann_json spdlog::spdlog OpenCL::HeadersCpp CLI11::CLI11)
+set(libs nlohmann_json::nlohmann_json spdlog::spdlog OpenCL::HeadersCpp CLI11::CLI11 uriparser::uriparser)
 if(LINUX)
     set(libs ${libs} stdc++fs OpenCL::OpenCL)
 elseif(APPLE)

README.md

@@ -22,7 +22,7 @@ You can configure diagnostics with `json-rpc` request during the intitialization
             "configuration": {
                 "buildOptions": [],
                 "deviceID": 0,
-                "maxNumberOfProblems": 100
+                "maxNumberOfProblems": 127
             }
         }
     }
@@ -33,10 +33,10 @@ You can configure diagnostics with `json-rpc` request during the intitialization
 
 |||
 | --- | --- |
-| `buildOptions` | Build options to be used for building the program. The list of [supported](https://registry.khronos.org/OpenCL/sdk/2.1/docs/man/xhtml/clBuildProgram.html) build options. |
+| `buildOptions` | Options to be utilized when building the program. The list of [supported](https://registry.khronos.org/OpenCL/sdk/2.1/docs/man/xhtml/clBuildProgram.html) build options. |
 | `deviceID` | Device ID or 0 (automatic selection) of the OpenCL device to be used for diagnostics. |
 | |  *Run `./opencl-language-server --clinfo` to get information about available OpenCL devices including identifiers.* |
-| `maxNumberOfProblems` | Controls the maximum number of problems produced by the language server. |
+| `maxNumberOfProblems` | Controls the maximum number of errors parsed by the language server. |
 
 ## Development
 

builder/.gitignore

@@ -0,0 +1 @@
+__pycache__

conanfile.py

@@ -24,6 +24,7 @@ class OpenCLLanguageServerConanfile(ConanFile):
         "nlohmann_json/[^3.11.2]",
         "opencl-clhpp-headers/2022.09.30",
         "spdlog/[^1.11.0]",
+        "uriparser/[^0.9.7]"
     )
     exports_sources = (
         "include/**",

include/clinfo.hpp

@@ -2,12 +2,12 @@
 //  clinfo.hpp
 //  opencl-language-server
 //
-//  Created by is on 5.2.2023.
+//  Created by Ilia Shoshin on 5.2.2023.
 //
 
 #pragma once
 
-#include <CL/opencl.hpp>
+#include "device.hpp"
 
 #include <memory>
 #include <nlohmann/json.hpp>
@@ -21,9 +21,7 @@ struct ICLInfo
 
     virtual nlohmann::json json() = 0;
 
-    virtual uint32_t GetDeviceID(const cl::Device& device) = 0;
-
-    virtual std::string GetDeviceDescription(const cl::Device& device) = 0;
+    virtual std::vector<Device> GetDevices() = 0;
 };
 
 std::shared_ptr<ICLInfo> CreateCLInfo();

include/device.hpp

@@ -0,0 +1,65 @@
+//
+//  device.hpp
+//  opencl-language-server
+//
+//  Created by Ilia Shoshin on 24.8.2023.
+//
+
+#pragma once
+
+#include <CL/opencl.hpp>
+
+namespace ocls {
+
+class Device
+{
+public:
+
+    Device(const Device&) = default;
+    Device& operator=(const Device&) = default;
+    Device(Device&&) noexcept = default;
+    Device& operator=(Device&&) noexcept = default;
+
+#ifdef ENABLE_TESTING
+    Device(uint32_t identifier, std::string description, size_t powerIndex)
+        : m_identifier {identifier}
+        , m_description {std::move(description)}
+        , m_powerIndex {powerIndex}
+    {}
+#endif
+
+    Device(cl::Device device, uint32_t identifier, std::string description, size_t powerIndex)
+        : m_device {std::move(device)}
+        , m_identifier {identifier}
+        , m_description {std::move(description)}
+        , m_powerIndex {powerIndex}
+    {}
+
+    const cl::Device& getUnderlyingDevice() const noexcept
+    {
+        return m_device;
+    }
+
+    uint32_t GetID() const noexcept
+    {
+        return m_identifier;
+    }
+
+    std::string GetDescription() const noexcept
+    {
+        return m_description;
+    }
+
+    size_t GetPowerIndex() const noexcept
+    {
+        return m_powerIndex;
+    }
+
+private:
+    cl::Device m_device;
+    uint32_t m_identifier;
+    std::string m_description;
+    size_t m_powerIndex;
+};
+
+} // namespace ocls

include/diagnostics.hpp

@@ -2,7 +2,7 @@
 //  diagnostics.hpp
 //  opencl-language-server
 //
-//  Created by Ilya Shoshin (Galarius) on 7/16/21.
+//  Created by Ilia Shoshin on 7/16/21.
 //
 
 #pragma once
@@ -12,23 +12,49 @@
 #include <memory>
 #include <nlohmann/json.hpp>
 #include <string>
+#include <regex>
+#include <tuple>
+#include <optional>
 
 namespace ocls {
 
 struct Source
 {
     std::string filePath;
     std::string text;
+
+    bool operator==(const Source& other) const
+    {
+        return filePath == other.filePath && text == other.text;
+    }
+};
+
+struct IDiagnosticsParser
+{
+    virtual ~IDiagnosticsParser() = default;
+
+    virtual std::tuple<std::string, long, long, long, std::string> ParseMatch(const std::smatch& matches) = 0;
+    virtual nlohmann::json ParseDiagnostics(
+        const std::string& buildLog, const std::string& name, uint64_t problemsLimit) = 0;
 };
 
 struct IDiagnostics
 {
+    virtual ~IDiagnostics() = default;
+
     virtual void SetBuildOptions(const nlohmann::json& options) = 0;
-    virtual void SetMaxProblemsCount(int maxNumberOfProblems) = 0;
+    virtual void SetBuildOptions(const std::string& options) = 0;
+    virtual void SetMaxProblemsCount(uint64_t maxNumberOfProblems) = 0;
     virtual void SetOpenCLDevice(uint32_t identifier) = 0;
-    virtual nlohmann::json Get(const Source& source) = 0;
+
+    virtual std::optional<ocls::Device> GetDevice() const = 0;
+    virtual std::string GetBuildLog(const Source& source) = 0;
+    virtual nlohmann::json GetDiagnostics(const Source& source) = 0;
 };
 
+std::shared_ptr<IDiagnosticsParser> CreateDiagnosticsParser();
 std::shared_ptr<IDiagnostics> CreateDiagnostics(std::shared_ptr<ICLInfo> clInfo);
+std::shared_ptr<IDiagnostics> CreateDiagnostics(
+    std::shared_ptr<ICLInfo> clInfo, std::shared_ptr<IDiagnosticsParser> parser);
 
 } // namespace ocls

include/jsonrpc.hpp

@@ -2,94 +2,66 @@
 //  jsonrpc.hpp
 //  opencl-language-server
 //
-//  Created by Ilya Shoshin (Galarius) on 7/16/21.
+//  Created by Ilia Shoshin on 7/16/21.
 //
 
 #pragma once
 
 #include <functional>
-#include <iostream>
+#include <memory>
 #include <nlohmann/json.hpp>
-#include <optional>
-#include <regex>
-#include <unordered_map>
 
 namespace ocls {
 
-class JsonRPC
-{
-    using InputCallbackFunc = std::function<void(const nlohmann::json&)>;
-    using OutputCallbackFunc = std::function<void(const std::string&)>;
+using InputCallbackFunc = std::function<void(const nlohmann::json&)>;
+using OutputCallbackFunc = std::function<void(const std::string&)>;
 
-public:
-    enum class ErrorCode : int
-    {
-        ///@{
-        ParseError = -32700,     ///< Parse error    Invalid JSON was received by the server. An error occurred on the
-                                 ///< server while parsing the JSON text.
-        InvalidRequest = -32600, ///< Invalid Request    The JSON sent is not a valid Request object.
-        MethodNotFound = -32601, ///< Method not found    The method does not exist / is not available.
-        InvalidParams = -32602,  ///< Invalid params    Invalid method parameter(s).
-        InternalError =
-            -32603, ///< Internal error    Internal JSON-RPC error.
-                    // -32000 to -32099    Server error    Reserved for implementation-defined server-errors.
-        NotInitialized = -32002 ///< The first client's message is not equal to "initialize"
-                                ///@}
-    };
+// clang-format off
+enum class JRPCErrorCode : int
+{
+    ///@{
+    ParseError = -32700,     ///< Parse error    Invalid JSON was received by the server. An error occurred on the
+                             ///< server while parsing the JSON text.
+    InvalidRequest = -32600, ///< Invalid Request    The JSON sent is not a valid Request object.
+    MethodNotFound = -32601, ///< Method not found    The method does not exist / is not available.
+    InvalidParams = -32602,  ///< Invalid params    Invalid method parameter(s).
+    InternalError = -32603,  ///< Internal error    Internal JSON-RPC error.
+    // -32000 to -32099    Server error    Reserved for implementation-defined server-errors.
+    NotInitialized = -32002 ///< The first client's message is not equal to "initialize"
+    ///@}
+};
+// clang-format on
 
-    friend std::ostream& operator<<(std::ostream& out, ErrorCode const& code)
-    {
-        out << static_cast<int64_t>(code);
-        return out;
-    }
+struct IJsonRPC
+{
+    virtual ~IJsonRPC() = default;
 
     /**
      Register callback to be notified on the specific method notification.
      All unregistered notifications will be responded with MethodNotFound automatically.
-     */
-    void RegisterMethodCallback(const std::string& method, InputCallbackFunc&& func);
+    */
+    virtual void RegisterMethodCallback(const std::string& method, InputCallbackFunc&& func) = 0;
     /**
      Register callback to be notified on client responds to server (our) requests.
      */
-    void RegisterInputCallback(InputCallbackFunc&& func);
+    virtual void RegisterInputCallback(InputCallbackFunc&& func) = 0;
     /**
      Register callback to be notified when server is going to send the final message to the client.
      Basically it should be redirected to the stdout.
      */
-    void RegisterOutputCallback(OutputCallbackFunc&& func);
+    virtual void RegisterOutputCallback(OutputCallbackFunc&& func) = 0;
 
-    void Consume(char c);
-    bool IsReady() const;
-    void Write(const nlohmann::json& data) const;
-    void Reset();
+    virtual void Consume(char c) = 0;
+    virtual bool IsReady() const = 0;
+    virtual void Write(const nlohmann::json& data) const = 0;
+    virtual void Reset() = 0;
     /**
      Send trace message to client.
      */
-    void LogTrace(const std::string& message, const std::string& verbose = "");
-    void WriteError(JsonRPC::ErrorCode errorCode, const std::string& message) const;
-
-private:
-    void OnInitialize();
-    void OnTracingChanged(const nlohmann::json& data);
-    bool ReadHeader();
-    void FireMethodCallback();
-    void FireRespondCallback();
-
-private:
-    std::string m_method;
-    std::string m_buffer;
-    nlohmann::json m_body;
-    std::unordered_map<std::string, std::string> m_headers;
-    std::unordered_map<std::string, InputCallbackFunc> m_callbacks;
-    OutputCallbackFunc m_outputCallback;
-    InputCallbackFunc m_respondCallback;
-    bool m_isProcessing = true;
-    bool m_initialized = false;
-    bool m_validHeader = false;
-    bool m_tracing = false;
-    bool m_verbosity = false;
-    unsigned long m_contentLength = 0;
-    std::regex m_headerRegex {"([\\w-]+): (.+)\\r\\n(?:([^:]+)\\r\\n)?"};
+    virtual void WriteTrace(const std::string& message, const std::string& verbose) = 0;
+    virtual void WriteError(JRPCErrorCode errorCode, const std::string& message) const = 0;
 };
 
+std::shared_ptr<IJsonRPC> CreateJsonRPC();
+
 } // namespace ocls

include/log.hpp

@@ -0,0 +1,25 @@
+//
+//  logs.hpp
+//  opencl-language-server
+//
+//  Created by Ilia Shoshin on 20/08/23.
+//
+
+#include <string>
+#include <spdlog/spdlog.h>
+
+namespace ocls {
+
+struct LogName
+{
+    static std::string main;
+    static std::string clinfo;
+    static std::string diagnostics;
+    static std::string jrpc;
+    static std::string lsp;
+};
+
+extern void ConfigureFileLogging(const std::string& filename, spdlog::level::level_enum level);
+extern void ConfigureNullLogging();
+
+} // namespace ocls