[wip] Implementing debugger in xeus-cpp(Prototype) by kr-2003 · Pull Request #354 · compiler-research/xeus-cpp

kr-2003 · 2025-06-19T15:33:02Z

Description

Please include a summary of changes, motivation and context for this PR.

Fixes # (issue)

Type of change

Please tick all options which are relevant.

Bug fix
New feature
Added/removed dependencies
Required documentation updates

github-actions

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 10 out of 122. Check the log or trigger a new build to see more.

github-actions

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 10 out of 103. Check the log or trigger a new build to see more.

codecov-commenter · 2025-06-19T16:56:04Z

Codecov Report

Attention: Patch coverage is 22.33010% with 80 lines in your changes missing coverage. Please review.

Project coverage is 77.15%. Comparing base (951e670) to head (3c6be4e).

Files with missing lines	Patch %	Lines
src/xinterpreter.cpp	24.44%	68 Missing ⚠️
src/main.cpp	7.69%	12 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #354      +/-   ##
==========================================
- Coverage   81.78%   77.15%   -4.64%     
==========================================
  Files          20       20              
  Lines         950     1011      +61     
  Branches       87       94       +7     
==========================================
+ Hits          777      780       +3     
- Misses        173      231      +58

Files with missing lines	Coverage Δ
src/main.cpp	`47.05% <7.69%> (+6.38%)`	⬆️
src/xinterpreter.cpp	`66.53% <24.44%> (-23.58%)`	⬇️

Files with missing lines	Coverage Δ
src/main.cpp	`47.05% <7.69%> (+6.38%)`	⬆️
src/xinterpreter.cpp	`66.53% <24.44%> (-23.58%)`	⬇️

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 10 out of 93. Check the log or trigger a new build to see more.

Vipul-Cariappa

I have put some comments. We can discuss this in detail during the meeting today.

Vipul-Cariappa · 2025-06-20T06:56:32Z

+if(XEUS_CPP_USE_DEBUGGER)
+    add_definitions(
+        -DXEUS_CPP_USE_DEBUGGER
+    )
+endif()


Not sure if this is a good idea. I need to know the purpose.

Vipul-Cariappa · 2025-06-20T07:01:11Z

+        std::string m_lldb_port;
+        std::string m_lldbdap_port;


What is the difference between m_lldb_port & m_lldbdap_port?

Looks like m_lldbdap_port is unused?

Vipul-Cariappa · 2025-06-20T07:09:33Z

+#ifdef XEUS_CPP_USE_DEBUGGER
+    nl::json debugger_config;
+    debugger_config["lldb"]["initCommands"] = {
+        "settings set plugin.jit-loader.gdb.enable on"
+    };
+#endif


This does not look correct. The use of ifdef. Let's discuss it in the meeting.
We need to do this based on the metadata of the kernel.json.

Vipul-Cariappa · 2025-06-20T07:18:44Z

+            int fd = open(log_file.c_str(), O_WRONLY | O_CREAT | O_TRUNC, 0644);
+            if (fd != -1)
+            {
+                dup2(fd, STDOUT_FILENO);
+                dup2(fd, STDERR_FILENO);
+                close(fd);
+            }


Need some explanation here.

This code is used to run lldb-dap and redirect its output to a file. might be useful for debugging

Vipul-Cariappa · 2025-06-20T07:27:23Z

+                  << std::endl;
+        nl::json reply = {
+            {"type", "response"},
+            {"request_seq", message["seq"]},


What is request_seq and message["seq"]?

Vipul-Cariappa · 2025-06-20T07:28:10Z

+             {{"variables",
+               {{{"name", "a"}, {"value", "100"}, {"type", "int"}, {"evaluateName", "a"}, {"variablesReference", 0}},
+                {{"name", "b"},
+                 {"value", "1000"},
+                 {"type", "int"},
+                 {"evaluateName", "b"},
+                 {"variablesReference", 0}}}}}}
+        };


I see that this is not yet implemented.

yes, its the major feature to discuss and work upon

Vipul-Cariappa · 2025-06-20T07:30:00Z

+    std::string debugger::get_cell_temporary_file(const std::string& code) const
+    {
+        // Placeholder: Return a dummy temporary file path
+        std::string tmp_file = get_tmp_prefix() + "/cell_tmp.cpp";
+        std::ofstream out(tmp_file);
+        out << code;
+        out.close();
+        return tmp_file;
+    }


Hopefully, we don't need this.

Vipul-Cariappa · 2025-06-20T07:34:06Z

+    std::string highlight(const std::string& code)
+    {
+        // Placeholder: No syntax highlighting implemented
+        // In a real implementation, use a C++ library (e.g., libclang or a custom highlighter)
+        return code;
+    }


How and where do you plan to use this?

highlighting lines when breakpoint hit, step ins and outs

Vipul-Cariappa · 2025-06-20T07:40:31Z

        restore_output();
    }

+    nl::json interpreter::internal_request_impl(const nl::json& content)


Why do we have this?

yeah, i forgot to remove it. i was using previously. no need of this now.

github-actions

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 10 out of 99. Check the log or trigger a new build to see more.

github-actions · 2025-06-23T07:15:29Z

+#include "nlohmann/json.hpp"
+#include "xeus-zmq/xdebugger_base.hpp"
+#include "xeus_cpp_config.hpp"
+#include "xeus-cpp/xinterpreter.hpp"


warning: #includes are not sorted properly [llvm-include-order]

Suggested change

#include "xeus-cpp/xinterpreter.hpp"

#include "xeus-cpp/xinterpreter.hpp"

#include "xeus-zmq/xdebugger_base.hpp"

#include "xeus_cpp_config.hpp"

github-actions · 2025-06-23T07:15:29Z

+        bool start() override;
+        void stop() override;
+        xeus::xdebugger_info get_debugger_info() const override;
+        virtual std::string get_cell_temporary_file(const std::string& code) const override;


warning: 'virtual' is redundant since the function is already declared 'override' [cppcoreguidelines-explicit-virtual-functions]

Suggested change

virtual std::string get_cell_temporary_file(const std::string& code) const override;

std::string get_cell_temporary_file(const std::string& code) const override;

github-actions · 2025-06-23T07:15:30Z

+        bool m_tcp_connected;
+        pid_t jit_process_pid;
+
+        using breakpoint_list_t = std::map<std::string, std::vector<nl::json>>;


warning: no header providing "std::vector" is directly included [misc-include-cleaner]

include/xeus-cpp/xdebugger.hpp:12:

- #ifdef __GNUC__ + #include <vector> + #ifdef __GNUC__

github-actions · 2025-06-23T07:15:30Z

+
+        xcpp::interpreter* m_interpreter;
+
+        std::unordered_map<std::string, std::vector<std::string>> m_hash_to_sequential;


warning: no header providing "std::unordered_map" is directly included [misc-include-cleaner]

include/xeus-cpp/xdebugger.hpp:12:

- #ifdef __GNUC__ + #include <unordered_map> + #ifdef __GNUC__

github-actions · 2025-06-23T07:15:30Z

+                                                       const std::string& user_name,
+                                                       const std::string& session_id,
+                                                       const nl::json& debugger_config);
+}


warning: namespace 'xcpp' not terminated with a closing comment [llvm-namespace-comment]

Suggested change

}

} // namespace xcpp

Additional context

include/xeus-cpp/xdebugger.hpp:27: namespace 'xcpp' starts here

namespace xcpp ^

github-actions · 2025-06-23T07:15:30Z


+        static pid_t get_current_pid();
+
+        std::vector<int> get_execution_count(const std::string& code) const


warning: function 'get_execution_count' should be marked [[nodiscard]] [modernize-use-nodiscard]

Suggested change

std::vector<int> get_execution_count(const std::string& code) const

[[nodiscard]] std::vector<int> get_execution_count(const std::string& code) const

github-actions · 2025-06-23T07:15:30Z

        xoutput_buffer m_cout_buffer;
        xoutput_buffer m_cerr_buffer;
+
+        std::map<std::string, std::vector<int>> m_code_to_execution_count_map;


warning: no header providing "std::map" is directly included [misc-include-cleaner]

include/xeus-cpp/xinterpreter.hpp:13:

- #include <memory> + #include <map> + #include <memory>

github-actions · 2025-06-23T07:15:30Z

 #include "xeus-cpp/xeus_cpp_config.hpp"
 #include "xeus-cpp/xinterpreter.hpp"
 #include "xeus-cpp/xutils.hpp"
+#include "xeus-cpp/xdebugger.hpp"


warning: #includes are not sorted properly [llvm-include-order]

Suggested change

#include "xeus-cpp/xdebugger.hpp"

#include "xeus-cpp/xdebugger.hpp"

#include "xeus-cpp/xeus_cpp_config.hpp"

#include "xeus-cpp/xinterpreter.hpp"

#include "xeus-cpp/xutils.hpp"

#include "xeus-zmq/xzmq_context.hpp"

#include <xeus-zmq/xserver_zmq.hpp>

#include <xeus/xhelper.hpp>

#include <xeus/xkernel.hpp>

#include <xeus/xkernel_configuration.hpp>

github-actions · 2025-06-23T07:15:30Z

    auto interpreter = std::make_unique<xcpp::interpreter>(argc, argv);
    std::unique_ptr<xeus::xcontext> context = xeus::make_zmq_context();

+    nl::json debugger_config;


warning: no header providing "nlohmann::json" is directly included [misc-include-cleaner]

src/main.cpp:9:

- #include <string> + #include <nlohmann/json_fwd.hpp> + #include <string>

github-actions · 2025-06-23T07:15:31Z

+    debugger_config["lldb"]["initCommands"] = {
+        "settings set plugin.jit-loader.gdb.enable on"
+    };
+    debugger_config["interpreter_ptr"] = reinterpret_cast<std::uintptr_t>(interpreter.get());


warning: do not use reinterpret_cast [cppcoreguidelines-pro-type-reinterpret-cast]

debugger_config["interpreter_ptr"] = reinterpret_cast<std::uintptr_t>(interpreter.get()); ^

github-actions

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 10 out of 103. Check the log or trigger a new build to see more.

github-actions · 2025-06-24T11:37:29Z

+    debugger_config["lldb"]["initCommands"] = {
+        "settings set plugin.jit-loader.gdb.enable on"
+    };
+    debugger_config["interpreter_ptr"] = reinterpret_cast<std::uintptr_t>(interpreter.get());


warning: no header providing "std::uintptr_t" is directly included [misc-include-cleaner]

src/main.cpp:8:

- #include <memory> + #include <cstdint> + #include <memory>

github-actions · 2025-06-24T11:37:30Z

+using namespace std::placeholders;
+
+// ***** ONLY FOR DEBUGGING PURPOSES. NOT TO BE COMMITTED *****
+static std::ofstream log_stream("/Users/abhinavkumar/Desktop/Coding/CERN_HSF_COMPILER_RESEARCH/xeus-cpp/build/xeus-cpp-logs.log", std::ios::app);


warning: initializing non-local variable with non-const expression depending on uninitialized non-local variable 'app' [cppcoreguidelines-interfaces-global-init]

static std::ofstream log_stream("/Users/abhinavkumar/Desktop/Coding/CERN_HSF_COMPILER_RESEARCH/xeus-cpp/build/xeus-cpp-logs.log", std::ios::app); ^

github-actions · 2025-06-24T11:37:30Z

+using namespace std::placeholders;
+
+// ***** ONLY FOR DEBUGGING PURPOSES. NOT TO BE COMMITTED *****
+static std::ofstream log_stream("/Users/abhinavkumar/Desktop/Coding/CERN_HSF_COMPILER_RESEARCH/xeus-cpp/build/xeus-cpp-logs.log", std::ios::app);


warning: variable 'log_stream' is non-const and globally accessible, consider making it const [cppcoreguidelines-avoid-non-const-global-variables]

static std::ofstream log_stream("/Users/abhinavkumar/Desktop/Coding/CERN_HSF_COMPILER_RESEARCH/xeus-cpp/build/xeus-cpp-logs.log", std::ios::app); ^

github-actions · 2025-06-24T11:37:30Z

+// ***** ONLY FOR DEBUGGING PURPOSES. NOT TO BE COMMITTED *****
+static std::ofstream log_stream("/Users/abhinavkumar/Desktop/Coding/CERN_HSF_COMPILER_RESEARCH/xeus-cpp/build/xeus-cpp-logs.log", std::ios::app);
+
+void log_debug(const std::string& msg) {


warning: function 'log_debug' can be made static or moved into an anonymous namespace to enforce internal linkage [misc-use-internal-linkage]

Suggested change

void log_debug(const std::string& msg) {

static void log_debug(const std::string& msg) {

github-actions · 2025-06-24T11:37:30Z

+// ***** ONLY FOR DEBUGGING PURPOSES. NOT TO BE COMMITTED *****
+static std::ofstream log_stream("/Users/abhinavkumar/Desktop/Coding/CERN_HSF_COMPILER_RESEARCH/xeus-cpp/build/xeus-cpp-logs.log", std::ios::app);
+
+void log_debug(const std::string& msg) {


warning: no header providing "std::string" is directly included [misc-include-cleaner]

src/xdebugger.cpp:9:

- #include <sys/socket.h> + #include <string> + #include <sys/socket.h>

github-actions · 2025-06-24T11:37:30Z

+static std::ofstream log_stream("/Users/abhinavkumar/Desktop/Coding/CERN_HSF_COMPILER_RESEARCH/xeus-cpp/build/xeus-cpp-logs.log", std::ios::app);
+
+void log_debug(const std::string& msg) {
+    log_stream << "[xeus-cpp] " << msg << std::endl;


warning: do not use 'std::endl' with streams; use '\n' instead [performance-avoid-endl]

Suggested change

log_stream << "[xeus-cpp] " << msg << std::endl;

log_stream << "[xeus-cpp] " << msg << '\n';

github-actions · 2025-06-24T11:37:30Z

+
+namespace xcpp
+{
+    debugger::debugger(


warning: constructor does not initialize these fields: m_is_running, m_tcp_socket, m_tcp_connected, jit_process_pid, m_copy_to_globals_available [cppcoreguidelines-pro-type-member-init]

include/xeus-cpp/xdebugger.hpp:72:

- bool m_is_running; - int m_tcp_socket; - bool m_tcp_connected; - pid_t jit_process_pid; + bool m_is_running{}; + int m_tcp_socket{}; + bool m_tcp_connected{}; + pid_t jit_process_pid{};

include/xeus-cpp/xdebugger.hpp:85:

- bool m_copy_to_globals_available; + bool m_copy_to_globals_available{};

github-actions · 2025-06-24T11:37:30Z

+namespace xcpp
+{
+    debugger::debugger(
+        xeus::xcontext& context,


warning: no header providing "xeus::xcontext" is directly included [misc-include-cleaner]

src/xdebugger.cpp:14:

+ #include <xeus/xeus_context.hpp>

github-actions · 2025-06-24T11:37:30Z

+{
+    debugger::debugger(
+        xeus::xcontext& context,
+        const xeus::xconfiguration& config,


warning: no header providing "xeus::xconfiguration" is directly included [misc-include-cleaner]

src/xdebugger.cpp:14:

+ #include <xeus/xkernel_configuration.hpp>

github-actions · 2025-06-24T11:37:30Z

+        const xeus::xconfiguration& config,
+        const std::string& user_name,
+        const std::string& session_id,
+        const nl::json& debugger_config


warning: no header providing "nlohmann::json" is directly included [misc-include-cleaner]

src/xdebugger.cpp:9:

- #include <sys/socket.h> + #include <nlohmann/json_fwd.hpp> + #include <sys/socket.h>

github-actions

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 10 out of 93. Check the log or trigger a new build to see more.

github-actions · 2025-06-25T09:33:22Z

+        const std::string& session_id,
+        const nl::json& debugger_config
+    )
+        : xdebugger_base(context)


warning: no header providing "xeus::xdebugger_base" is directly included [misc-include-cleaner]

src/xdebugger.cpp:14:

+ #include <xeus-zmq/xdebugger_base.hpp>

github-actions · 2025-06-25T09:33:23Z

+              context,
+              config,
+              xeus::get_socket_linger(),
+              xdap_tcp_configuration(xeus::dap_tcp_type::client, xeus::dap_init_type::parallel, user_name, session_id),


warning: no header providing "xeus::dap_init_type" is directly included [misc-include-cleaner]

xdap_tcp_configuration(xeus::dap_tcp_type::client, xeus::dap_init_type::parallel, user_name, session_id), ^

github-actions · 2025-06-25T09:33:23Z

+              context,
+              config,
+              xeus::get_socket_linger(),
+              xdap_tcp_configuration(xeus::dap_tcp_type::client, xeus::dap_init_type::parallel, user_name, session_id),


warning: no header providing "xeus::dap_tcp_type" is directly included [misc-include-cleaner]

src/xdebugger.cpp:14:

+ #include <xeus-zmq/xdap_tcp_client.hpp>

github-actions · 2025-06-25T09:33:23Z

+              get_event_callback()
+          ))
+        , m_lldb_host("127.0.0.1")
+        , m_lldb_port("")


warning: redundant string initialization [readability-redundant-string-init]

Suggested change

, m_lldb_port("")

,

github-actions · 2025-06-25T09:33:23Z

+        // Register request handlers
+        register_request_handler(
+            "inspectVariables",
+            std::bind(&debugger::inspect_variables_request, this, _1),


warning: no header providing "std::bind" is directly included [misc-include-cleaner]

src/xdebugger.cpp:7:

- #include <iostream> + #include <functional> + #include <iostream>

github-actions · 2025-06-25T09:33:23Z

+        // Register request handlers
+        register_request_handler(
+            "inspectVariables",
+            std::bind(&debugger::inspect_variables_request, this, _1),


warning: no header providing "std::placeholders::_1" is directly included [misc-include-cleaner]

std::bind(&debugger::inspect_variables_request, this, _1), ^

github-actions · 2025-06-25T09:33:24Z

+        // Register request handlers
+        register_request_handler(
+            "inspectVariables",
+            std::bind(&debugger::inspect_variables_request, this, _1),


warning: prefer a lambda to std::bind [modernize-avoid-bind]

Suggested change

std::bind(&debugger::inspect_variables_request, this, _1),

[this](auto && PH1) { return inspect_variables_request(std::forward<decltype(PH1)>(PH1)); },

github-actions · 2025-06-25T09:33:24Z

+            std::bind(&debugger::inspect_variables_request, this, _1),
+            false
+        );
+        register_request_handler("attach", std::bind(&debugger::attach_request, this, _1), true);


warning: prefer a lambda to std::bind [modernize-avoid-bind]

Suggested change

register_request_handler("attach", std::bind(&debugger::attach_request, this, _1), true);

register_request_handler("attach", [this](auto && PH1) { return attach_request(std::forward<decltype(PH1)>(PH1)); }, true);

github-actions · 2025-06-25T09:33:24Z

+        register_request_handler("attach", std::bind(&debugger::attach_request, this, _1), true);
+        register_request_handler(
+            "configurationDone",
+            std::bind(&debugger::configuration_done_request, this, _1),


warning: prefer a lambda to std::bind [modernize-avoid-bind]

Suggested change

std::bind(&debugger::configuration_done_request, this, _1),

[this](auto && PH1) { return configuration_done_request(std::forward<decltype(PH1)>(PH1)); },

github-actions · 2025-06-25T09:33:24Z

+            std::bind(&debugger::configuration_done_request, this, _1),
+            true
+        );
+        register_request_handler("richInspectVariables", std::bind(&debugger::rich_inspect_variables_request, this, _1), true);


warning: prefer a lambda to std::bind [modernize-avoid-bind]

Suggested change

register_request_handler("richInspectVariables", std::bind(&debugger::rich_inspect_variables_request, this, _1), true);

register_request_handler("richInspectVariables", [this](auto && PH1) { return rich_inspect_variables_request(std::forward<decltype(PH1)>(PH1)); }, true);

github-actions

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 10 out of 102. Check the log or trigger a new build to see more.

github-actions · 2025-06-30T14:24:25Z

 #include "xeus_cpp_config.hpp"
 #include "xmanager.hpp"
+#include <thread>
+


warning: included header thread is not used directly [misc-include-cleaner]

Suggested change

github-actions · 2025-06-30T14:24:25Z

+            return {};
+        }
+
+        std::string get_code_from_execution_count(int execution_count) const


warning: function 'get_code_from_execution_count' should be marked [[nodiscard]] [modernize-use-nodiscard]

Suggested change

std::string get_code_from_execution_count(int execution_count) const

[[nodiscard]] std::string get_code_from_execution_count(int execution_count) const

github-actions · 2025-06-30T14:24:25Z

 #include "xeus-cpp/xeus_cpp_config.hpp"
 #include "xeus-cpp/xinterpreter.hpp"
 #include "xeus-cpp/xutils.hpp"
+#include "xeus-cpp/xdebugger.hpp"


warning: #includes are not sorted properly [llvm-include-order]

Suggested change

#include "xeus-cpp/xdebugger.hpp"

#include "xeus-cpp/xdebugger.hpp"

#include "xeus-cpp/xeus_cpp_config.hpp"

#include "xeus-cpp/xinterpreter.hpp"

#include "xeus-cpp/xutils.hpp"

#include "xeus-zmq/xserver_zmq_split.hpp"

#include "xeus-zmq/xzmq_context.hpp"

#include <xeus-zmq/xserver_zmq.hpp>

#include <xeus/xhelper.hpp>

#include <xeus/xkernel.hpp>

#include <xeus/xkernel_configuration.hpp>

github-actions · 2025-06-30T14:24:26Z

+
+namespace xcpp
+{
+    debugger::debugger(


warning: constructor does not initialize these fields: m_is_running, m_tcp_socket, m_tcp_connected, jit_process_pid, m_copy_to_globals_available [cppcoreguidelines-pro-type-member-init]

include/xeus-cpp/xdebugger.hpp:76:

- bool m_is_running; - int m_tcp_socket; - bool m_tcp_connected; - pid_t jit_process_pid; + bool m_is_running{}; + int m_tcp_socket{}; + bool m_tcp_connected{}; + pid_t jit_process_pid{};

include/xeus-cpp/xdebugger.hpp:89:

- bool m_copy_to_globals_available; + bool m_copy_to_globals_available{};

github-actions · 2025-06-30T14:24:26Z

+            true
+        );
+        register_request_handler("richInspectVariables", std::bind(&debugger::rich_inspect_variables_request, this, _1), true);
+        register_request_handler("setBreakpoints", std::bind(&debugger::set_breakpoints_request, this, _1), true);


warning: prefer a lambda to std::bind [modernize-avoid-bind]

Suggested change

register_request_handler("setBreakpoints", std::bind(&debugger::set_breakpoints_request, this, _1), true);

register_request_handler("setBreakpoints", [this](auto && PH1) { return set_breakpoints_request(std::forward<decltype(PH1)>(PH1)); }, true);

github-actions · 2025-06-30T14:24:26Z

+        );
+        register_request_handler("richInspectVariables", std::bind(&debugger::rich_inspect_variables_request, this, _1), true);
+        register_request_handler("setBreakpoints", std::bind(&debugger::set_breakpoints_request, this, _1), true);
+        register_request_handler("dumpCell", std::bind(&debugger::dump_cell_request, this, _1), true);


warning: prefer a lambda to std::bind [modernize-avoid-bind]

Suggested change

register_request_handler("dumpCell", std::bind(&debugger::dump_cell_request, this, _1), true);

register_request_handler("dumpCell", [this](auto && PH1) { return dump_cell_request(std::forward<decltype(PH1)>(PH1)); }, true);

github-actions · 2025-06-30T14:24:26Z

+        register_request_handler("richInspectVariables", std::bind(&debugger::rich_inspect_variables_request, this, _1), true);
+        register_request_handler("setBreakpoints", std::bind(&debugger::set_breakpoints_request, this, _1), true);
+        register_request_handler("dumpCell", std::bind(&debugger::dump_cell_request, this, _1), true);
+        register_request_handler("copyToGlobals", std::bind(&debugger::copy_to_globals_request, this, _1), true);


warning: prefer a lambda to std::bind [modernize-avoid-bind]

Suggested change

register_request_handler("copyToGlobals", std::bind(&debugger::copy_to_globals_request, this, _1), true);

register_request_handler("copyToGlobals", [this](auto && PH1) { return copy_to_globals_request(std::forward<decltype(PH1)>(PH1)); }, true);

github-actions · 2025-06-30T14:24:26Z

+        register_request_handler("setBreakpoints", std::bind(&debugger::set_breakpoints_request, this, _1), true);
+        register_request_handler("dumpCell", std::bind(&debugger::dump_cell_request, this, _1), true);
+        register_request_handler("copyToGlobals", std::bind(&debugger::copy_to_globals_request, this, _1), true);
+        register_request_handler("stackTrace", std::bind(&debugger::stack_trace_request, this, _1), true);


warning: prefer a lambda to std::bind [modernize-avoid-bind]

Suggested change

register_request_handler("stackTrace", std::bind(&debugger::stack_trace_request, this, _1), true);

register_request_handler("stackTrace", [this](auto && PH1) { return stack_trace_request(std::forward<decltype(PH1)>(PH1)); }, true);

github-actions · 2025-06-30T14:24:26Z

+        register_request_handler("dumpCell", std::bind(&debugger::dump_cell_request, this, _1), true);
+        register_request_handler("copyToGlobals", std::bind(&debugger::copy_to_globals_request, this, _1), true);
+        register_request_handler("stackTrace", std::bind(&debugger::stack_trace_request, this, _1), true);
+        register_request_handler("source", std::bind(&debugger::source_request, this, _1), true);


warning: prefer a lambda to std::bind [modernize-avoid-bind]

Suggested change

register_request_handler("source", std::bind(&debugger::source_request, this, _1), true);

register_request_handler("source", [this](auto && PH1) { return source_request(std::forward<decltype(PH1)>(PH1)); }, true);

github-actions · 2025-06-30T14:24:26Z

+        register_request_handler("stackTrace", std::bind(&debugger::stack_trace_request, this, _1), true);
+        register_request_handler("source", std::bind(&debugger::source_request, this, _1), true);
+
+        m_interpreter = reinterpret_cast<xcpp::interpreter*>(


warning: do not use reinterpret_cast [cppcoreguidelines-pro-type-reinterpret-cast]

m_interpreter = reinterpret_cast<xcpp::interpreter*>( ^

github-actions

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 10 out of 118. Check the log or trigger a new build to see more.

github-actions · 2025-07-02T08:38:42Z

+        register_request_handler("stackTrace", std::bind(&debugger::stack_trace_request, this, _1), true);
+        register_request_handler("source", std::bind(&debugger::source_request, this, _1), true);
+
+        m_interpreter = reinterpret_cast<xcpp::interpreter*>(


warning: integer to pointer cast pessimizes optimization opportunities [performance-no-int-to-ptr]

m_interpreter = reinterpret_cast<xcpp::interpreter*>( ^

github-actions · 2025-07-02T08:38:42Z

+        register_request_handler("source", std::bind(&debugger::source_request, this, _1), true);
+
+        m_interpreter = reinterpret_cast<xcpp::interpreter*>(
+            debugger_config["interpreter_ptr"].get<std::uintptr_t>()


warning: no header providing "std::uintptr_t" is directly included [misc-include-cleaner]

src/xdebugger.cpp:4:

- #include <cstdlib> + #include <cstdint> + #include <cstdlib>

github-actions · 2025-07-02T08:38:42Z

+
+        m_interpreter = reinterpret_cast<xcpp::interpreter*>(
+            debugger_config["interpreter_ptr"].get<std::uintptr_t>()
+        );


warning: 'm_interpreter' should be initialized in a member initializer of the constructor [cppcoreguidelines-prefer-member-initializer]

src/xdebugger.cpp:52:

- , m_debugger_config(debugger_config) + , m_debugger_config(debugger_config), m_interpreter(reinterpret_cast<xcpp::interpreter*>( + debugger_config["interpreter_ptr"].get<std::uintptr_t>() + ))

Suggested change

);

github-actions · 2025-07-02T08:38:42Z

+        m_lldb_port = xeus::find_free_port(100, 9999, 10099);
+        if (m_lldb_port.empty())
+        {
+            std::cerr << "Failed to find a free port for LLDB-DAP" << std::endl;


warning: do not use 'std::endl' with streams; use '\n' instead [performance-avoid-endl]

Suggested change

std::cerr << "Failed to find a free port for LLDB-DAP" << std::endl;

std::cerr << "Failed to find a free port for LLDB-DAP" << '\n';

github-actions · 2025-07-02T08:38:42Z

+        }
+
+        // std::vector<std::string> lldb_args = {"/Users/abhinavkumar/Desktop/Coding/CERN_HSF_COMPILER_RESEARCH/llvm-project-lldb/build/bin/lldb-dap", "--connection", "listen://localhost:" + m_lldb_port};
+        std::vector<std::string> lldb_args = {


warning: no header providing "std::vector" is directly included [misc-include-cleaner]

src/xdebugger.cpp:14:

+ #include <vector>

github-actions · 2025-07-02T08:38:42Z

+        };
+
+        std::string log_dir = xeus::get_temp_directory_path() + "/xcpp_debug_logs_"
+                              + std::to_string(xeus::get_current_pid());


warning: no header providing "std::to_string" is directly included [misc-include-cleaner]

+ std::to_string(xeus::get_current_pid()); ^

github-actions · 2025-07-02T08:38:42Z

+
+        // std::cout << "Log file for LLDB-DAP: " << log_file << std::endl;
+
+        pid_t pid = fork();


warning: no header providing "pid_t" is directly included [misc-include-cleaner]

src/xdebugger.cpp:13:

- #include <unistd.h> + #include <time.h> + #include <unistd.h>

github-actions · 2025-07-02T08:38:43Z

+        if (pid == 0)
+        {
+            // ***** ONLY FOR DEBUGGING PURPOSES. NOT TO BE COMMITTED *****
+            int fd = open(log_file.c_str(), O_WRONLY | O_CREAT | O_TRUNC, 0644);


warning: do not call c-style vararg functions [cppcoreguidelines-pro-type-vararg]

int fd = open(log_file.c_str(), O_WRONLY | O_CREAT | O_TRUNC, 0644); ^

github-actions · 2025-07-02T08:38:43Z

+            }
+            // ******* (END) ONLY FOR DEBUGGING PURPOSES. NOT TO BE COMMITTED ******
+
+            int null_fd = open("/dev/null", O_RDONLY);


warning: do not call c-style vararg functions [cppcoreguidelines-pro-type-vararg]

int null_fd = open("/dev/null", O_RDONLY); ^

github-actions · 2025-07-02T08:38:43Z

+            std::vector<char*> argv;
+            for (auto& arg : lldb_args)
+            {
+                argv.push_back(const_cast<char*>(arg.c_str()));


warning: 'push_back' is called inside a loop; consider pre-allocating the container capacity before the loop [performance-inefficient-vector-operation]

src/xdebugger.cpp:137:

- for (auto& arg : lldb_args) + argv.reserve(lldb_args.size()); + for (auto& arg : lldb_args)

github-actions

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 10 out of 82. Check the log or trigger a new build to see more.

github-actions · 2025-07-08T16:57:48Z

+            std::vector<char*> argv;
+            for (auto& arg : lldb_args)
+            {
+                argv.push_back(const_cast<char*>(arg.c_str()));


warning: do not use const_cast to remove const qualifier [cppcoreguidelines-pro-type-const-cast]

argv.push_back(const_cast<char*>(arg.c_str())); ^

github-actions · 2025-07-08T16:57:48Z

+
+            execvp("lldb-dap", argv.data());
+
+            std::cerr << "Failed to execute lldb-dap" << std::endl;


warning: do not use 'std::endl' with streams; use '\n' instead [performance-avoid-endl]

Suggested change

std::cerr << "Failed to execute lldb-dap" << std::endl;

std::cerr << "Failed to execute lldb-dap" << '\n';

github-actions · 2025-07-08T16:57:48Z

+        }
+        else if (pid > 0)
+        {
+            int status;


warning: variable 'status' is not initialized [cppcoreguidelines-init-variables]

Suggested change

int status;

int status = 0;

github-actions · 2025-07-08T16:57:48Z

+        else if (pid > 0)
+        {
+            int status;
+            if (waitpid(pid, &status, WNOHANG) != 0)


warning: no header providing "WNOHANG" is directly included [misc-include-cleaner]

src/xdebugger.cpp:9:

- #include <sys/socket.h> + #include <stdlib.h> + #include <sys/socket.h>

github-actions · 2025-07-08T16:57:48Z

+            int status;
+            if (waitpid(pid, &status, WNOHANG) != 0)
+            {
+                std::cerr << "LLDB-DAP process exited prematurely." << std::endl;


warning: do not use 'std::endl' with streams; use '\n' instead [performance-avoid-endl]

Suggested change

std::cerr << "LLDB-DAP process exited prematurely." << std::endl;

std::cerr << "LLDB-DAP process exited prematurely." << '\n';

github-actions · 2025-07-08T16:57:48Z

+        }
+        else
+        {
+            std::cerr << "fork() failed" << std::endl;


warning: do not use 'std::endl' with streams; use '\n' instead [performance-avoid-endl]

Suggested change

std::cerr << "fork() failed" << std::endl;

std::cerr << "fork() failed" << '\n';

github-actions · 2025-07-08T16:57:49Z

+        bool lldb_started = start_lldb();
+        if (!lldb_started)
+        {
+            std::cerr << "Failed to start LLDB-DAP" << std::endl;


warning: do not use 'std::endl' with streams; use '\n' instead [performance-avoid-endl]

Suggested change

std::cerr << "Failed to start LLDB-DAP" << std::endl;

std::cerr << "Failed to start LLDB-DAP" << '\n';

github-actions · 2025-07-08T16:57:49Z

+        nl::json bp_json = message["arguments"]["breakpoints"];
+        std::vector<nl::json> bp_list(bp_json.begin(), bp_json.end());
+        std::string sequential_source = m_hash_to_sequential[source][0];
+        m_breakpoint_list.insert(std::make_pair(std::move(source), std::move(bp_list)));


warning: no header providing "std::make_pair" is directly included [misc-include-cleaner]

src/xdebugger.cpp:14:

+ #include <utility>

github-actions · 2025-07-08T16:57:49Z

+        nl::json bp_json = message["arguments"]["breakpoints"];
+        std::vector<nl::json> bp_list(bp_json.begin(), bp_json.end());
+        std::string sequential_source = m_hash_to_sequential[source][0];
+        m_breakpoint_list.insert(std::make_pair(std::move(source), std::move(bp_list)));


warning: no header providing "std::move" is directly included [misc-include-cleaner]

m_breakpoint_list.insert(std::make_pair(std::move(source), std::move(bp_list))); ^

github-actions · 2025-07-08T16:57:49Z

+        nl::json bp_json = message["arguments"]["breakpoints"];
+        std::vector<nl::json> bp_list(bp_json.begin(), bp_json.end());
+        std::string sequential_source = m_hash_to_sequential[source][0];
+        m_breakpoint_list.insert(std::make_pair(std::move(source), std::move(bp_list)));


warning: no header providing "std::move" is directly included [misc-include-cleaner]

m_breakpoint_list.insert(std::make_pair(std::move(source), std::move(bp_list))); ^

kr-2003 added 14 commits May 6, 2025 20:26

removed redundant files in lite case

889f32f

merge

2a047c3

initial lldb start

3d11208

sent init request while testing connection

874fb85

removed testing connection

9bdb79c

multiple requests

d7c0df2

attach_request

346cf9f

trying to attach

609a590

trying to attach

777fa06

trying to attach

10c8c06

Merge branch 'main' into jit-oop-exec

ae46678

out-of-process JIT execution

a6a02dc

out-of-process JIT execution

be37853

removed some redundant files

73fd7d5

kr-2003 marked this pull request as draft June 19, 2025 15:33

github-actions bot reviewed Jun 19, 2025

View reviewed changes

added XEUS_CPP_USE_DEBUGGER var

78e14aa

github-actions bot reviewed Jun 19, 2025

View reviewed changes

added XEUS_CPP_USE_DEBUGGER var

3c6be4e

github-actions bot reviewed Jun 19, 2025

View reviewed changes

Vipul-Cariappa reviewed Jun 20, 2025

View reviewed changes

added breakpoints

90df737

github-actions bot reviewed Jun 23, 2025

View reviewed changes

debugging breakpoint hits

0cba670

github-actions bot reviewed Jun 24, 2025

View reviewed changes

debugging breakpoint hits

eda00f8

github-actions bot reviewed Jun 25, 2025

View reviewed changes

added variable inspection

290becd

github-actions bot reviewed Jun 30, 2025

View reviewed changes

redirection handle

5ab3a13

github-actions bot reviewed Jul 2, 2025

View reviewed changes

fixed redirection

8c8bafd

kr-2003 changed the title ~~[wip] Implementing debugger in xeus-cpp~~ [wip] Implementing debugger in xeus-cpp(Prototype) Jul 8, 2025

kr-2003 mentioned this pull request Jul 8, 2025

[GSoC 2025] Tracking Issue: Implementing Debugger Support for xeus-cpp #364

Open

10 tasks

github-actions bot reviewed Jul 8, 2025

View reviewed changes

fixing changes

275a9f9

	virtual std::string get_cell_temporary_file(const std::string& code) const override;
	std::string get_cell_temporary_file(const std::string& code) const override;


		xcpp::interpreter* m_interpreter;

		std::unordered_map<std::string, std::vector<std::string>> m_hash_to_sequential;


		static pid_t get_current_pid();

		std::vector<int> get_execution_count(const std::string& code) const

	std::vector<int> get_execution_count(const std::string& code) const
	[[nodiscard]] std::vector<int> get_execution_count(const std::string& code) const

	void log_debug(const std::string& msg) {
	static void log_debug(const std::string& msg) {

	log_stream << "[xeus-cpp] " << msg << std::endl;
	log_stream << "[xeus-cpp] " << msg << '\n';

	std::bind(&debugger::inspect_variables_request, this, _1),
	[this](auto && PH1) { return inspect_variables_request(std::forward<decltype(PH1)>(PH1)); },

	register_request_handler("attach", std::bind(&debugger::attach_request, this, _1), true);
	register_request_handler("attach", [this](auto && PH1) { return attach_request(std::forward<decltype(PH1)>(PH1)); }, true);

	std::bind(&debugger::configuration_done_request, this, _1),
	[this](auto && PH1) { return configuration_done_request(std::forward<decltype(PH1)>(PH1)); },

	register_request_handler("richInspectVariables", std::bind(&debugger::rich_inspect_variables_request, this, _1), true);
	register_request_handler("richInspectVariables", [this](auto && PH1) { return rich_inspect_variables_request(std::forward<decltype(PH1)>(PH1)); }, true);

	std::string get_code_from_execution_count(int execution_count) const
	[[nodiscard]] std::string get_code_from_execution_count(int execution_count) const

-#include "xeus-cpp/xdebugger.hpp"
+#include "xeus-cpp/xdebugger.hpp"
+#include "xeus-cpp/xeus_cpp_config.hpp"
+#include "xeus-cpp/xinterpreter.hpp"
+#include "xeus-cpp/xutils.hpp"
+#include "xeus-zmq/xserver_zmq_split.hpp"
+#include "xeus-zmq/xzmq_context.hpp"
+#include <xeus-zmq/xserver_zmq.hpp>
+#include <xeus/xhelper.hpp>
+#include <xeus/xkernel.hpp>
+#include <xeus/xkernel_configuration.hpp>

	register_request_handler("setBreakpoints", std::bind(&debugger::set_breakpoints_request, this, _1), true);
	register_request_handler("setBreakpoints", [this](auto && PH1) { return set_breakpoints_request(std::forward<decltype(PH1)>(PH1)); }, true);

	register_request_handler("dumpCell", std::bind(&debugger::dump_cell_request, this, _1), true);
	register_request_handler("dumpCell", [this](auto && PH1) { return dump_cell_request(std::forward<decltype(PH1)>(PH1)); }, true);

	register_request_handler("copyToGlobals", std::bind(&debugger::copy_to_globals_request, this, _1), true);
	register_request_handler("copyToGlobals", [this](auto && PH1) { return copy_to_globals_request(std::forward<decltype(PH1)>(PH1)); }, true);

	register_request_handler("stackTrace", std::bind(&debugger::stack_trace_request, this, _1), true);
	register_request_handler("stackTrace", [this](auto && PH1) { return stack_trace_request(std::forward<decltype(PH1)>(PH1)); }, true);

	register_request_handler("source", std::bind(&debugger::source_request, this, _1), true);
	register_request_handler("source", [this](auto && PH1) { return source_request(std::forward<decltype(PH1)>(PH1)); }, true);

	std::cerr << "Failed to find a free port for LLDB-DAP" << std::endl;
	std::cerr << "Failed to find a free port for LLDB-DAP" << '\n';


		// std::cout << "Log file for LLDB-DAP: " << log_file << std::endl;

		pid_t pid = fork();


		execvp("lldb-dap", argv.data());

		std::cerr << "Failed to execute lldb-dap" << std::endl;

Conversation

kr-2003 commented Jun 19, 2025

Description

Type of change

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Jun 19, 2025

Codecov Report

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Vipul-Cariappa left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

	std::cerr << "LLDB-DAP process exited prematurely." << std::endl;
	std::cerr << "LLDB-DAP process exited prematurely." << '\n';

	std::cerr << "fork() failed" << std::endl;
	std::cerr << "fork() failed" << '\n';

	std::cerr << "Failed to start LLDB-DAP" << std::endl;
	std::cerr << "Failed to start LLDB-DAP" << '\n';