Debugger for xeus-cpp with testing framework #401

kr-2003 · 2025-10-30T18:28:05Z

Description

Debugger support for xeus-cpp.
Pytest for testing the kernel using jupyter_client.

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 124. Check the log or trigger a new build to see more.

github-actions · 2025-10-30T18:36:10Z

include/xeus-cpp/xdebugger.hpp

+#include <string>
+
+#include "nlohmann/json.hpp"
+#include "xeus-cpp/xinterpreter.hpp"


warning: included header json.hpp is not used directly [misc-include-cleaner]

Suggested change

#include "xeus-cpp/xinterpreter.hpp"

#include "xeus-cpp/xinterpreter.hpp"

github-actions · 2025-10-30T18:36:11Z

include/xeus-cpp/xdebugger.hpp

+{
+    class xdebuglldb_client;
+
+    class XEUS_CPP_API debugger : public xeus::xdebugger_base


warning: class 'debugger' defines a destructor but does not define a copy constructor, a copy assignment operator, a move constructor or a move assignment operator [cppcoreguidelines-special-member-functions]

class XEUS_CPP_API debugger : public xeus::xdebugger_base ^

github-actions · 2025-10-30T18:36:11Z

include/xeus-cpp/xdebugger.hpp

+        using base_type = xeus::xdebugger_base;
+
+        debugger(
+            xeus::xcontext& context,


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

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

- #ifdef __GNUC__ + #include <xeus/xeus_context.hpp> + #ifdef __GNUC__

github-actions · 2025-10-30T18:36:11Z

include/xeus-cpp/xdebugger.hpp

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


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

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

- #ifdef __GNUC__ + #include <xeus/xkernel_configuration.hpp> + #ifdef __GNUC__

github-actions · 2025-10-30T18:36:11Z

include/xeus-cpp/xdebugger.hpp

+            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]

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

- #ifdef __GNUC__ + #include <nlohmann/json_fwd.hpp> + #ifdef __GNUC__

github-actions · 2025-10-30T18:36:11Z

include/xeus-cpp/xdebugger.hpp

+            const nl::json& debugger_config
+        );
+
+        virtual ~debugger();


warning: prefer using 'override' or (rarely) 'final' instead of 'virtual' [cppcoreguidelines-explicit-virtual-functions]

Suggested change

virtual ~debugger();

~debugger() override;

github-actions · 2025-10-30T18:36:11Z

include/xeus-cpp/xdebugger.hpp

+        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-10-30T18:36:11Z

include/xeus-cpp/xdebugger.hpp

+        std::string send_dap_message(const nl::json& message);
+        std::string receive_dap_response();
+
+        xdebuglldb_client* p_debuglldb_client;


warning: invalid case style for private member 'p_debuglldb_client' [readability-identifier-naming]

Suggested change

xdebuglldb_client* p_debuglldb_client;

xdebuglldb_client* m_p_debuglldb_client;

github-actions · 2025-10-30T18:36:12Z

include/xeus-cpp/xdebugger.hpp

+        bool m_is_running;
+        int m_tcp_socket;
+        bool m_tcp_connected;
+        pid_t jit_process_pid;


warning: invalid case style for private member 'jit_process_pid' [readability-identifier-naming]

Suggested change

pid_t jit_process_pid;

pid_t m_jit_process_pid;

github-actions · 2025-10-30T18:36:12Z

include/xeus-cpp/xdebugger.hpp

+        bool m_is_running;
+        int m_tcp_socket;
+        bool m_tcp_connected;
+        pid_t jit_process_pid;


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

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

- #ifdef __GNUC__ + #include <sys/types.h> + #ifdef __GNUC__

anutosh491 · 2025-10-31T06:15:31Z

share/jupyter/kernels/xcpp17-debugger/wasm_kernel.json.in

+      "libclangCppInterOp.so": "lib/libclangCppInterOp.so"
+    }
+  }
+}


Get rid of the wasm kernel, unless Jupyterlite supports it !

mcbarton · 2025-11-03T21:43:16Z

CMakeLists.txt

+if(NOT EMSCRIPTEN AND NOT WIN32)
+    configure_kernel("/share/jupyter/kernels/xcpp17-debugger/")
+endif()
+


These kernels require the --use-oop-jit flag, so shouldn't be added for Linux arm for osx x86.

Also we should have debugger kernels for c++20, c++23 and the the c kernels too.

I am wondering if we should switch to out of process in general all kernels. I suspect there are still several missing features but we should start enumerating them at least…

mcbarton · 2025-11-03T21:45:35Z

test/test_debugger.py

@@ -0,0 +1,512 @@
+"""Test xeus-cpp debugger functionality using LLDB"""


We shoud also be running the normal jupyter kenel tests for the c++ debugger kernels. We have a mechanism already in place to run the tests for multiple kernels. You just need to add them to the list of kernels in the python file.

mcbarton · 2025-11-03T21:47:03Z

src/xinterpreter.cpp

                             "\n"
                             "  xeus-cpp: a C++ Jupyter kernel - based on Clang-repl\n";
        result["banner"] = banner;
+        result["debugger"] = true;


Isn't this only true for the debugger kernels. Don't we need dependent on which kernel we are using

mcbarton · 2025-11-03T21:47:43Z

src/xinterpreter.cpp

        //NOLINTNEXTLINE (cppcoreguidelines-pro-bounds-pointer-arithmetic)
        createInterpreter(Args(argv ? argv + 1 : argv, argv + argc));
-        m_version = get_stdopt();
+        // m_version = get_stdopt();


I don't understand why this has been commented out.

anutosh491 · 2025-11-04T05:02:29Z

Hi @mcbarton ,

I would really appreciate if you refrain from reviewing the work here unless we request a review from your end. By "We", I mean one of the 4 Google Summer of Code mentors (me, Vipul, Vassil, Johan).

We have been having a weekly call over video with @kr-2003 since the past 6 months and there is an incremental systematic approach planned to move things in. I would not like this to be a copy of the cppinterop PR compiler-research/CppInterOp#717 where we tried to address everything in PR and that ended up being a 73 commit long 2000 line diff nightmare to review.

We simply cannot address everything through a single PR. For eg. this is experimental enough and we need to start with a 1 single kernel and propagate the idea to others then.

If you would like to contribute to this project, please join the weekly call on Friday and raise your points there. Untill then I would appreciate if you take down your requested changes and we can ask you to join in when we need your expertise.

vgvassilev · 2025-11-04T05:29:59Z

test/test_debugger.py

@@ -0,0 +1,512 @@
+"""Test xeus-cpp debugger functionality using LLDB"""


Is lldb required now? Or we put it as part of CppInterOp?

vgvassilev · 2025-11-04T05:31:31Z

include/xeus-cpp/xdebugger.hpp

+#define XEUS_CPP_XDEBUGGER_HPP
+
+#ifdef __GNUC__
+#pragma GCC diagnostic push


Why these are needed? Ideally we should write code that does not produce warnings.

vgvassilev · 2025-11-04T05:32:07Z

include/xeus-cpp/xdebugger.hpp

@@ -0,0 +1,118 @@
+/************************************************************************************
+ * Copyright (c) 2023, xeus-cpp contributors                                        *


Suggested change

* Copyright (c) 2023, xeus-cpp contributors *

* Copyright (c) 2025, xeus-cpp contributors *

vgvassilev · 2025-11-04T05:33:11Z

CMakeLists.txt

+if(NOT EMSCRIPTEN AND NOT WIN32)
+    configure_kernel("/share/jupyter/kernels/xcpp17-debugger/")
+endif()
+


I am wondering if we should switch to out of process in general all kernels. I suspect there are still several missing features but we should start enumerating them at least…

anutosh491 · 2025-11-04T05:40:53Z

I am wondering if we should switch to out of process in general all kernels

Exactly what we (Johan, Vipul and I) started discussing last week. The benchmarks here for matrix multiplication/sorting algorithms (https://compiler-research.org/blogs/gsoc24_sahil_wrapup_blog/) are awesome.

I also made @kr-2003 run the whole C++ test suite through an out of process kernel and we look like we're in decent-to-good shape.

We plan to discuss more on this now that the cppinterop pR has gone in.

kr-2003 added 2 commits October 21, 2025 11:39

xeus-cpp debugger with tests

9656949

xeus-cpp debugger with testing

05da59f

kr-2003 marked this pull request as draft October 30, 2025 18:28

github-actions bot reviewed Oct 30, 2025

View reviewed changes

anutosh491 reviewed Oct 31, 2025

View reviewed changes

mcbarton requested changes Nov 3, 2025

View reviewed changes

vgvassilev reviewed Nov 4, 2025

View reviewed changes

	#include "xeus-cpp/xinterpreter.hpp"
	#include "xeus-cpp/xinterpreter.hpp"

	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;

	xdebuglldb_client* p_debuglldb_client;
	xdebuglldb_client* m_p_debuglldb_client;

		@@ -0,0 +1,512 @@
		"""Test xeus-cpp debugger functionality using LLDB"""

		@@ -0,0 +1,118 @@
		/************************************************************************************
		* Copyright (c) 2023, xeus-cpp contributors *

	* Copyright (c) 2023, xeus-cpp contributors *
	* Copyright (c) 2025, xeus-cpp contributors *

Debugger for xeus-cpp with testing framework #401

Are you sure you want to change the base?

Debugger for xeus-cpp with testing framework #401

Uh oh!

Conversation

kr-2003 commented Oct 30, 2025

Description

Type of change

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 30, 2025

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!

anutosh491 commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

anutosh491 commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

anutosh491 commented Nov 4, 2025 •

edited

Loading

anutosh491 commented Nov 4, 2025 •

edited

Loading