forked from wpilibsuite/allwpilib
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[upstream_utils] Add std::is_debugger_present() shim
Fixes wpilibsuite#7420.
- Loading branch information
Showing
12 changed files
with
343 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| #!/usr/bin/env python3 | ||
|
|
||
| import os | ||
| import shutil | ||
|
|
||
| from upstream_utils import Lib, walk_cwd_and_copy_if | ||
|
|
||
|
|
||
| def copy_upstream_src(wpilib_root): | ||
| wpiutil = os.path.join(wpilib_root, "wpiutil") | ||
|
|
||
| # Delete old install | ||
| for d in [ | ||
| "src/main/native/thirdparty/debugging/src", | ||
| "src/main/native/thirdparty/debugging/include", | ||
| ]: | ||
| shutil.rmtree(os.path.join(wpiutil, d), ignore_errors=True) | ||
|
|
||
| # Copy debugging files into allwpilib | ||
| filenames = walk_cwd_and_copy_if( | ||
| lambda dp, f: dp.startswith(os.path.join(".", "src")) | ||
| or dp.startswith(os.path.join(".", "include")), | ||
| os.path.join(wpiutil, "src/main/native/thirdparty/debugging"), | ||
| ) | ||
|
|
||
| for filename in filenames: | ||
| with open(filename) as f: | ||
| content = f.read() | ||
|
|
||
| # Rename namespace from stdx to wpi | ||
| content = content.replace("namespace stdx", "namespace wpi") | ||
|
|
||
| with open(filename, "w") as f: | ||
| f.write(content) | ||
|
|
||
|
|
||
| def main(): | ||
| name = "debugging" | ||
| url = "https://github.com/grafikrobot/debugging" | ||
| # master on 2024-11-21 | ||
| tag = "c510133c44894b93afbb5be55275bfb88163a2cb" | ||
|
|
||
| expected = Lib(name, url, tag, copy_upstream_src) | ||
| expected.main() | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| main() |
49 changes: 49 additions & 0 deletions
49
upstream_utils/debugging_patches/0001-Fix-Windows-compilation.patch
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 | ||
| From: Tyler Veness <[email protected]> | ||
| Date: Thu, 21 Nov 2024 17:23:48 -0800 | ||
| Subject: [PATCH] Fix Windows compilation | ||
|
|
||
| --- | ||
| include/debugging.hpp | 10 ++++++++-- | ||
| src/windows.cxx | 2 +- | ||
| 2 files changed, 9 insertions(+), 3 deletions(-) | ||
|
|
||
| diff --git a/include/debugging.hpp b/include/debugging.hpp | ||
| index 70ba724a2b6522a774931af7d7be2cee9408567a..25014a9fc65d06052089058feea7566462c01d60 100644 | ||
| --- a/include/debugging.hpp | ||
| +++ b/include/debugging.hpp | ||
| @@ -7,13 +7,19 @@ namespace stdx { | ||
|
|
||
| bool is_debugger_present() noexcept; | ||
|
|
||
| -[[gnu::flatten]] inline void breakpoint() noexcept | ||
| +#if defined(__GNUC__) && !defined(__clang__) | ||
| +[[gnu::flatten]] | ||
| +#endif | ||
| +inline void breakpoint() noexcept | ||
| { | ||
| psnip_trap(); | ||
| } | ||
|
|
||
|
|
||
| -[[gnu::flatten]] inline void breakpoint_if_debugging() noexcept | ||
| +#if defined(__GNUC__) && !defined(__clang__) | ||
| +[[gnu::flatten]] | ||
| +#endif | ||
| +inline void breakpoint_if_debugging() noexcept | ||
| { | ||
| if (is_debugger_present()) breakpoint(); | ||
| } | ||
| diff --git a/src/windows.cxx b/src/windows.cxx | ||
| index eec576f415d52f63d2658012546ead2e691d7415..45d98eb27c5182de7ad11291925275fb4fdb54fb 100644 | ||
| --- a/src/windows.cxx | ||
| +++ b/src/windows.cxx | ||
| @@ -9,7 +9,7 @@ | ||
|
|
||
| namespace stdx { | ||
|
|
||
| -bool is_debugger_present(debugger_query q) noexcept | ||
| +bool is_debugger_present() noexcept | ||
| { | ||
| return ::IsDebuggerPresent(); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
wpiutil/src/main/native/thirdparty/debugging/include/debugging.hpp
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| #ifndef IXM_BREAKPOINT_HPP | ||
| #define IXM_BREAKPOINT_HPP | ||
|
|
||
| #include <debugging/detail/psnip_debug_trap.h> | ||
|
|
||
| namespace wpi { | ||
|
|
||
| bool is_debugger_present() noexcept; | ||
|
|
||
| #if defined(__GNUC__) && !defined(__clang__) | ||
| [[gnu::flatten]] | ||
| #endif | ||
| inline void breakpoint() noexcept | ||
| { | ||
| psnip_trap(); | ||
| } | ||
|
|
||
|
|
||
| #if defined(__GNUC__) && !defined(__clang__) | ||
| [[gnu::flatten]] | ||
| #endif | ||
| inline void breakpoint_if_debugging() noexcept | ||
| { | ||
| if (is_debugger_present()) breakpoint(); | ||
| } | ||
|
|
||
| } // namespace wpi | ||
|
|
||
| #endif |
83 changes: 83 additions & 0 deletions
83
wpiutil/src/main/native/thirdparty/debugging/include/debugging/detail/psnip_debug_trap.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| /* Debugging assertions and traps | ||
| * Portable Snippets - https://github.com/nemequ/portable-snippets | ||
| * Created by Evan Nemerson <[email protected]> | ||
| * | ||
| * To the extent possible under law, the authors have waived all | ||
| * copyright and related or neighboring rights to this code. For | ||
| * details, see the Creative Commons Zero 1.0 Universal license at | ||
| * https://creativecommons.org/publicdomain/zero/1.0/ | ||
| */ | ||
|
|
||
| #if !defined(PSNIP_DEBUG_TRAP_H) | ||
| #define PSNIP_DEBUG_TRAP_H | ||
|
|
||
| #if !defined(PSNIP_NDEBUG) && defined(NDEBUG) && !defined(PSNIP_DEBUG) | ||
| # define PSNIP_NDEBUG 1 | ||
| #endif | ||
|
|
||
| #if defined(__has_builtin) && !defined(__ibmxl__) | ||
| # if __has_builtin(__builtin_debugtrap) | ||
| # define psnip_trap() __builtin_debugtrap() | ||
| # elif __has_builtin(__debugbreak) | ||
| # define psnip_trap() __debugbreak() | ||
| # endif | ||
| #endif | ||
| #if !defined(psnip_trap) | ||
| # if defined(_MSC_VER) || defined(__INTEL_COMPILER) | ||
| # define psnip_trap() __debugbreak() | ||
| # elif defined(__ARMCC_VERSION) | ||
| # define psnip_trap() __breakpoint(42) | ||
| # elif defined(__ibmxl__) || defined(__xlC__) | ||
| # include <builtins.h> | ||
| # define psnip_trap() __trap(42) | ||
| # elif defined(__DMC__) && defined(_M_IX86) | ||
| static inline void psnip_trap(void) { __asm int 3h; } | ||
| # elif defined(__i386__) || defined(__x86_64__) | ||
| static inline void psnip_trap(void) { __asm__ __volatile__("int3"); } | ||
| # elif defined(__thumb__) | ||
| static inline void psnip_trap(void) { __asm__ __volatile__(".inst 0xde01"); } | ||
| # elif defined(__aarch64__) | ||
| static inline void psnip_trap(void) { __asm__ __volatile__(".inst 0xd4200000"); } | ||
| # elif defined(__arm__) | ||
| static inline void psnip_trap(void) { __asm__ __volatile__(".inst 0xe7f001f0"); } | ||
| # elif defined (__alpha__) && !defined(__osf__) | ||
| static inline void psnip_trap(void) { __asm__ __volatile__("bpt"); } | ||
| # elif defined(_54_) | ||
| static inline void psnip_trap(void) { __asm__ __volatile__("ESTOP"); } | ||
| # elif defined(_55_) | ||
| static inline void psnip_trap(void) { __asm__ __volatile__(";\n .if (.MNEMONIC)\n ESTOP_1\n .else\n ESTOP_1()\n .endif\n NOP"); } | ||
| # elif defined(_64P_) | ||
| static inline void psnip_trap(void) { __asm__ __volatile__("SWBP 0"); } | ||
| # elif defined(_6x_) | ||
| static inline void psnip_trap(void) { __asm__ __volatile__("NOP\n .word 0x10000000"); } | ||
| # elif defined(__STDC_HOSTED__) && (__STDC_HOSTED__ == 0) && defined(__GNUC__) | ||
| # define psnip_trap() __builtin_trap() | ||
| # else | ||
| # include <signal.h> | ||
| # if defined(SIGTRAP) | ||
| # define psnip_trap() raise(SIGTRAP) | ||
| # else | ||
| # define psnip_trap() raise(SIGABRT) | ||
| # endif | ||
| # endif | ||
| #endif | ||
|
|
||
| #if defined(HEDLEY_LIKELY) | ||
| # define PSNIP_DBG_LIKELY(expr) HEDLEY_LIKELY(expr) | ||
| #elif defined(__GNUC__) && (__GNUC__ >= 3) | ||
| # define PSNIP_DBG_LIKELY(expr) __builtin_expect(!!(expr), 1) | ||
| #else | ||
| # define PSNIP_DBG_LIKELY(expr) (!!(expr)) | ||
| #endif | ||
|
|
||
| #if !defined(PSNIP_NDEBUG) || (PSNIP_NDEBUG == 0) | ||
| # define psnip_dbg_assert(expr) do { \ | ||
| if (!PSNIP_DBG_LIKELY(expr)) { \ | ||
| psnip_trap(); \ | ||
| } \ | ||
| } while (0) | ||
| #else | ||
| # define psnip_dbg_assert(expr) | ||
| #endif | ||
|
|
||
| #endif /* !defined(PSNIP_DEBUG_TRAP_H) */ |
25 changes: 25 additions & 0 deletions
25
wpiutil/src/main/native/thirdparty/debugging/src/linux.cpp
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| #if defined(linux) || defined(__linux) || defined(__linux__) \ | ||
| || defined(__gnu_linux__) | ||
|
|
||
| # include <debugging.hpp> | ||
|
|
||
| # include <atomic> | ||
| # include <fstream> | ||
| # include <string> | ||
|
|
||
| namespace wpi { | ||
|
|
||
| bool is_debugger_present() noexcept | ||
| { | ||
| std::ifstream proc_self_status_f("/proc/self/status"); | ||
| if (!proc_self_status_f) return false; | ||
| std::string buffer(256, '\0'); | ||
| proc_self_status_f.read(&buffer[0], 256); | ||
| auto index = buffer.find("TracerPid:\t"); | ||
| if (index == buffer.npos) return false; | ||
| return buffer[index + 11] != '0'; | ||
| } | ||
|
|
||
| } // namespace wpi | ||
|
|
||
| #endif |
36 changes: 36 additions & 0 deletions
36
wpiutil/src/main/native/thirdparty/debugging/src/macos.cpp
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| #if defined(__APPLE__) && defined(__MACH__) | ||
|
|
||
| # include <debugging.hpp> | ||
|
|
||
| # include <algorithm> | ||
| # include <array> | ||
|
|
||
| # include <mach/mach_init.h> | ||
| # include <mach/task.h> | ||
|
|
||
| template <class T> | ||
| auto exc = std::array<T, EXC_TYPES_COUNT> { {} }; | ||
|
|
||
| namespace wpi { | ||
|
|
||
| bool is_debugger_present(debugger_query q) noexcept | ||
| { | ||
| mach_msg_type_number_t count {}; | ||
| auto masks = exc<exception_mask_t>; | ||
| auto ports = exc<mach_port_t>; | ||
| auto behaviors = exc<exception_behavior_t>; | ||
| auto flavors = exc<thread_state_flavor_t>; | ||
| exception_mast_t mask | ||
| = EXC_MASK_ALL & ~(EXC_MASK_RESOURCE | EXC_MASK_GUARD); | ||
| kern_return_t result = task_get_exception_ports(mach_task_self(), mask, | ||
| masks.data(), &count, ports.data(), behaviors.data(), flavors.data()); | ||
| if (result != KERN_SUCCESS) return false; | ||
| auto valid = [](auto port) { return MACH_PORT_VALID(port); }; | ||
| auto begin = std::begin(ports); | ||
| auto end = begin + count; | ||
| return end != std::find_if(begin, end, valid); | ||
| } | ||
|
|
||
| } // namespace wpi | ||
|
|
||
| #endif |
Oops, something went wrong.