Add support for Windows in the Jupyter kernel for Cling

yjoer · web-flow · commit eecf269b4036 · 2025-10-20T23:56:22.000+02:00
* Use console scripts for cross-platform compatibility

* Set the pipe to non-blocking with a cross-platform API

* Load the default C library on Windows explicitly

* Get pointers to standard devices in a Windows-specific way

* Export all symbols

* Peek at the pipes at every flush interval

* Export symbols and use the standard exception handling model for MSVC

* Align the exported symbols with the driver

* Rename from cling_exports to jupyter_exports

* Support std::cin
diff --git a/interpreter/cling/tools/Jupyter/CMakeLists.txt b/interpreter/cling/tools/Jupyter/CMakeLists.txt
@@ -12,7 +12,11 @@ set(LLVM_NO_DEAD_STRIP 1)
 set(SOURCES
     Kernel.cpp
     )
-set_source_files_properties(Kernel.cpp COMPILE_FLAGS "-fexceptions -frtti")
+if(MSVC)
+    set_source_files_properties(Kernel.cpp COMPILE_FLAGS "/EHsc /GR")
+else()
+    set_source_files_properties(Kernel.cpp COMPILE_FLAGS "-fexceptions -frtti")
+endif()
 #Solve unresolved symbols bug in unix
 #See https://github.com/vgvassilev/cling/issues/114
 if(WIN32)
@@ -81,6 +85,71 @@ add_cling_library(libclingJupyter ${ENABLE_SHARED} ${ENABLE_STATIC}
 set_target_properties(libclingJupyter
         PROPERTIES ENABLE_EXPORTS 1)
 
+if(MSVC)
+    set_target_properties(libclingJupyter PROPERTIES WINDOWS_EXPORT_ALL_SYMBOLS 1)
+
+    # RTTI/C++ symbols
+    set(jupyter_exports ${jupyter_exports} ??_7type_info@@6B@
+        ?__type_info_root_node@@3U__type_info_node@@A
+        ?nothrow@std@@3Unothrow_t@1@B
+        __std_find_trivial_1
+        __std_reverse_trivially_swappable_1
+    )
+
+    # Compiler added symbols for static variables. NOT for VStudio < 2015
+    set(jupyter_exports ${jupyter_exports} _Init_thread_abort _Init_thread_epoch
+        _Init_thread_footer _Init_thread_header _tls_index
+    )
+
+    if(CMAKE_SIZEOF_VOID_P EQUAL 8)
+        # new/delete variants needed when linking to static msvc runtime (esp. Debug)
+        set(jupyter_exports ${jupyter_exports}
+        ??2@YAPEAX_K@Z
+        ??3@YAXPEAX@Z
+        ??_U@YAPEAX_K@Z
+        ??_V@YAXPEAX@Z
+        ??3@YAXPEAX_K@Z
+        ??2@YAPEAX_KAEBUnothrow_t@std@@@Z
+        ??_U@YAPEAX_KAEBUnothrow_t@std@@@Z
+        ??6?$basic_ostream@DU?$char_traits@D@std@@@std@@QEAAAEAV01@H@Z
+        ??6?$basic_ostream@DU?$char_traits@D@std@@@std@@QEAAAEAV01@M@Z
+        ??6?$basic_ostream@DU?$char_traits@D@std@@@std@@QEAAAEAV01@N@Z
+        ??6?$basic_ostream@DU?$char_traits@D@std@@@std@@QEAAAEAV01@PEBX@Z
+        ??6?$basic_ostream@DU?$char_traits@D@std@@@std@@QEAAAEAV01@P6AAEAV01@AEAV01@@Z@Z
+        ??$?6U?$char_traits@D@std@@@std@@YAAEAV?$basic_ostream@DU?$char_traits@D@std@@@0@AEAV10@D@Z
+        ??$?6U?$char_traits@D@std@@@std@@YAAEAV?$basic_ostream@DU?$char_traits@D@std@@@0@AEAV10@PEBD@Z
+        ?_Facet_Register@std@@YAXPEAV_Facet_base@1@@Z
+        )
+    else()
+        set(jupyter_exports ${jupyter_exports}
+        ??2@YAPAXI@Z
+        ??3@YAXPAX@Z
+        ??3@YAXPAXI@Z
+        ??_U@YAPAXI@Z
+        ??_V@YAXPAX@Z
+        ??_V@YAXPAXI@Z
+        ??2@YAPAXIABUnothrow_t@std@@@Z
+        ??_U@YAPAXIABUnothrow_t@std@@@Z
+        ??6?$basic_ostream@DU?$char_traits@D@std@@@std@@QAEAAV01@H@Z
+        ??6?$basic_ostream@DU?$char_traits@D@std@@@std@@QAEAAV01@M@Z
+        ??6?$basic_ostream@DU?$char_traits@D@std@@@std@@QAEAAV01@N@Z
+        ??6?$basic_ostream@DU?$char_traits@D@std@@@std@@QAEAAV01@PBX@Z
+        ??6?$basic_ostream@DU?$char_traits@D@std@@@std@@QAEAAV01@P6AAAV01@AAV01@@Z@Z
+        ??$?6U?$char_traits@D@std@@@std@@YAAAV?$basic_ostream@DU?$char_traits@D@std@@@0@AAV10@D@Z
+        ??$?6U?$char_traits@D@std@@@std@@YAAAV?$basic_ostream@DU?$char_traits@D@std@@@0@AAV10@PBD@Z
+        ?_Facet_Register@std@@YAXPAV_Facet_base@1@@Z
+        )
+    endif()
+
+    # List to '/EXPORT:sym0 /EXPORT:sym1 /EXPORT:sym2 ...'
+    foreach(sym ${jupyter_exports})
+        set(cling_link_str "${cling_link_str} /EXPORT:${sym}")
+    endforeach(sym ${jupyter_exports})
+
+    set_property(TARGET libclingJupyter APPEND_STRING PROPERTY LINK_FLAGS ${cling_link_str})
+
+endif(MSVC)
+
 if(ENABLE_SHARED)
     if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
         set(LIBCLINGJUPYTER_LINK_FLAGS " -Wl,-compatibility_version -Wl,1")
diff --git a/interpreter/cling/tools/Jupyter/kernel/clingkernel.py b/interpreter/cling/tools/Jupyter/kernel/clingkernel.py
@@ -18,14 +18,13 @@
 __version__ = '0.0.3'
 
 import ctypes
-from contextlib import contextmanager
-from fcntl import fcntl, F_GETFL, F_SETFL
 import os
 import shutil
 import select
 import struct
 import sys
 import threading
+import time
 
 from traitlets import Unicode, Float, Dict, List, CaselessStrEnum
 from ipykernel.kernelbase import Kernel
@@ -39,14 +38,44 @@
 class my_void_p(ctypes.c_void_p):
   pass
 
-libc = ctypes.CDLL(None)
-try:
-    c_stdout_p = ctypes.c_void_p.in_dll(libc, 'stdout')
-    c_stderr_p = ctypes.c_void_p.in_dll(libc, 'stderr')
-except ValueError:
-    # libc.stdout is has a funny name on OS X
-    c_stdout_p = ctypes.c_void_p.in_dll(libc, '__stdoutp')
-    c_stderr_p = ctypes.c_void_p.in_dll(libc, '__stderrp')
+if sys.platform == 'win32':
+    import msvcrt
+    libc = ctypes.cdll.msvcrt
+
+    class FILE(ctypes.Structure):
+        pass
+
+    FILE_p = ctypes.POINTER(FILE)
+
+    libc._fdopen.argtypes = [ctypes.c_int, ctypes.c_char_p]
+    libc._fdopen.restype = FILE_p
+
+    c_stdout_p = libc._fdopen(sys.stdout.fileno(), b"w")
+    c_stderr_p = libc._fdopen(sys.stderr.fileno(), b"w")
+
+    peek_named_pipe = ctypes.windll.kernel32.PeekNamedPipe
+    peek_named_pipe.argtypes = [
+        ctypes.wintypes.HANDLE,
+        ctypes.c_void_p,
+        ctypes.wintypes.DWORD,
+        ctypes.POINTER(ctypes.wintypes.DWORD),
+        ctypes.POINTER(ctypes.wintypes.DWORD),
+        ctypes.POINTER(ctypes.wintypes.DWORD),
+    ]
+    peek_named_pipe.restype = ctypes.c_bool
+
+    libc.fflush.argtypes = [FILE_p]
+    libc.fflush.restype = ctypes.c_int
+else:
+    libc = ctypes.CDLL(None)
+
+    try:
+        c_stdout_p = ctypes.c_void_p.in_dll(libc, 'stdout')
+        c_stderr_p = ctypes.c_void_p.in_dll(libc, 'stderr')
+    except ValueError:
+        # libc.stdout is has a funny name on OS X
+        c_stdout_p = ctypes.c_void_p.in_dll(libc, '__stdoutp')
+        c_stderr_p = ctypes.c_void_p.in_dll(libc, '__stderrp')
 
 
 class FdReplacer:
@@ -59,8 +88,9 @@ def __init__(self, name):
         os.dup2(pipe_in, self.real_fd)
         os.close(pipe_in)
         # make pipe_out non-blocking
-        flags = fcntl(self.pipe_out, F_GETFL)
-        fcntl(self.pipe_out, F_SETFL, flags|os.O_NONBLOCK)
+        # flags = fcntl(self.pipe_out, F_GETFL)
+        # fcntl(self.pipe_out, F_SETFL, flags|os.O_NONBLOCK)
+        os.set_blocking(self.pipe_out, False)
 
     def restore(self):
         os.close(self.real_fd)
@@ -120,7 +150,7 @@ def __init__(self, **kwargs):
         else:
             raise RuntimeError('cling at ' + clingInPath + ' is unusable. No cling, no fun.')
 
-        for libFolder in ["/lib/libclingJupyter.", "/libexec/lib/libclingJupyter."]:
+        for libFolder in ["/bin/libclingJupyter.", "/lib/libclingJupyter.", "/libexec/lib/libclingJupyter."]:
 
             for ext in ['so', 'dylib', 'dll']:
                 libFilename = clingInstDir + libFolder + ext
@@ -225,6 +255,44 @@ def forward_streams(self):
 
     def handle_input(self):
         """Capture stdout, stderr and sideband. Forward them as stream messages."""
+        if sys.platform == 'win32':
+            pipes = {"sideband": self.sideband_pipe}
+            for rs in self.replaced_streams:
+                if rs:
+                    pipes[rs.name] = rs.pipe_out
+
+            # wait for the flush interval before peeking at the pipe
+            time.sleep(self.flush_interval)
+
+            pipe_bytes = {}
+            total_bytes = 0
+            for name, pipe in pipes.items():
+                bytes_available = ctypes.wintypes.DWORD(0)
+                peek_named_pipe(
+                    ctypes.wintypes.HANDLE(msvcrt.get_osfhandle(pipe)),
+                    None,
+                    0,
+                    None,
+                    ctypes.byref(bytes_available),
+                    None,
+                )
+                pipe_bytes[name] = bytes_available.value
+                total_bytes += bytes_available.value
+
+            if total_bytes == 0:
+                libc.fflush(c_stdout_p)
+                libc.fflush(c_stderr_p)
+                return False
+
+            for name, n_bytes in pipe_bytes.items():
+                if n_bytes == 0:
+                    continue
+
+                if name == "sideband":
+                    self._process_sideband_data()
+                else:
+                    self._process_stdio_data(pipes[name], name)
+            return True
         # create pipe for stdout, stderr
         select_on = [self.sideband_pipe]
         for rs in self.replaced_streams:
@@ -287,7 +355,8 @@ def do_execute(self, code, silent, store_history=True,
         run_cell_thread.join()
 
         # Any leftovers?
-        while self.handle_input(): True
+        while self.handle_input():
+            pass
 
         self.close_forwards()
         status = 'ok'
diff --git a/interpreter/cling/tools/Jupyter/kernel/setup.py b/interpreter/cling/tools/Jupyter/kernel/setup.py
@@ -31,7 +31,6 @@
 #-----------------------------------------------------------------------------
 
 import os
-from glob import glob
 
 from distutils.core import setup
 
@@ -44,7 +43,11 @@
     name            = name,
     version         = '0.0.2',
     py_modules      = ['clingkernel'],
-    scripts         = glob(pjoin('scripts', '*')),
+    entry_points    = {
+        'console_scripts': [
+            'jupyter-cling-kernel=clingkernel:main'
+        ],
+    },
     description     = "C++ Kernel for Jupyter with Cling",
     author          = 'Min RK, Axel Naumann',
     author_email    = 'cling-dev@cern.ch',
diff --git a/interpreter/cling/tools/libcling/CMakeLists.txt b/interpreter/cling/tools/libcling/CMakeLists.txt
@@ -94,6 +94,10 @@ add_cling_library(libcling ${ENABLE_SHARED} ${ENABLE_STATIC}
 set_target_properties(libcling
         PROPERTIES ENABLE_EXPORTS 1)
 
+if(MSVC)
+    set_target_properties(libcling PROPERTIES WINDOWS_EXPORT_ALL_SYMBOLS 1)
+endif()
+
 if(ENABLE_SHARED)
   if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
     set(LIBCLING_LINK_FLAGS " -Wl,-compatibility_version -Wl,1")
