Skip to content

Commit

Permalink
[upstream_utils] Add std::is_debugger_present() shim (#7423)
Browse files Browse the repository at this point in the history
  • Loading branch information
calcmogul authored Nov 22, 2024
1 parent 1d58c50 commit b7eb9fb
Show file tree
Hide file tree
Showing 16 changed files with 425 additions and 3 deletions.
27 changes: 27 additions & 0 deletions ThirdPartyNotices.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Portable File Dialogs wpigui/src/main/native/include/portable-file-dialogs.h
V8 export-template wpiutil/src/main/native/include/wpi/SymbolExports.h
GCEM wpimath/src/main/native/thirdparty/gcem/include/
Sleipnir wpimath/src/main/native/thirdparty/sleipnir
Debugging wpiutil/src/main/native/thirdparty/debugging

==============================================================================
Google Test License
Expand Down Expand Up @@ -1224,3 +1225,29 @@ Redistribution and use in source and binary forms, with or without modification,
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=================
Debugging License
=================
MIT License

Copyright (c) 2021-2022 René Ferdinand Rivera Morell
Copyright (c) 2018 Isabella Muerte

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
48 changes: 48 additions & 0 deletions upstream_utils/debugging.py
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()
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Tyler Veness <[email protected]>
Date: Thu, 21 Nov 2024 17:51:15 -0800
Subject: [PATCH 1/4] Guard [[gnu::flatten]] attribute

---
include/debugging.hpp | 10 ++++++++--
1 file changed, 8 insertions(+), 2 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();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
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 2/4] Remove debugger_query argument from Windows and macOS

---
src/macos.cxx | 2 +-
src/windows.cxx | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/macos.cxx b/src/macos.cxx
index bbcf6f2eec9ea479a2bea0ff06b454dc81b5d356..85dbb5f45d89680e39b4847a9aa2d5472c824f2a 100644
--- a/src/macos.cxx
+++ b/src/macos.cxx
@@ -13,7 +13,7 @@ auto exc = std::array<T, EXC_TYPES_COUNT> { {} };

namespace stdx {

-bool is_debugger_present(debugger_query q) noexcept
+bool is_debugger_present() noexcept
{
mach_msg_type_number_t count {};
auto masks = exc<exception_mask_t>;
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();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Tyler Veness <[email protected]>
Date: Thu, 21 Nov 2024 18:09:37 -0800
Subject: [PATCH 3/4] Fix exception mask type typo on macOS

---
src/macos.cxx | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/macos.cxx b/src/macos.cxx
index 85dbb5f45d89680e39b4847a9aa2d5472c824f2a..2c68064742bc7883a08551b88cd5dbb9a1f38100 100644
--- a/src/macos.cxx
+++ b/src/macos.cxx
@@ -20,7 +20,7 @@ bool is_debugger_present() noexcept
auto ports = exc<mach_port_t>;
auto behaviors = exc<exception_behavior_t>;
auto flavors = exc<thread_state_flavor_t>;
- exception_mast_t mask
+ exception_mask_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());
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Tyler Veness <[email protected]>
Date: Thu, 21 Nov 2024 18:49:53 -0800
Subject: [PATCH 4/4] Remove NOMINMAX macro from Windows

---
src/windows.cxx | 1 -
1 file changed, 1 deletion(-)

diff --git a/src/windows.cxx b/src/windows.cxx
index 45d98eb27c5182de7ad11291925275fb4fdb54fb..d20ae438ef9b2de8830c6df099f0476aba395de5 100644
--- a/src/windows.cxx
+++ b/src/windows.cxx
@@ -4,7 +4,6 @@
# include <debugging.hpp>

# define WIN32_LEAN_AND_MEAN
-# define NOMINMAX
# include <Windows.h>

namespace stdx {
5 changes: 3 additions & 2 deletions upstream_utils/upstream_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,10 @@ def copy_to(files, root, rename_c_to_cpp=False):
for f in files:
dest_file = os.path.join(root, f)

# Rename .cc file to .cpp
if dest_file.endswith(".cc"):
# Rename .cc or .cxx file to .cpp
if dest_file.endswith(".cc") or dest_file.endswith(".cxx"):
dest_file = os.path.splitext(dest_file)[0] + ".cpp"

if rename_c_to_cpp and dest_file.endswith(".c"):
dest_file = os.path.splitext(dest_file)[0] + ".cpp"

Expand Down
18 changes: 18 additions & 0 deletions wpiutil/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,22 @@ cc_library(
visibility = ["//wpiutil:__subpackages__"],
)

cc_library(
name = "debugging-headers",
hdrs = glob([
"src/main/native/thirdparty/debugging/include/**/*",
]),
includes = ["src/main/native/thirdparty/debugging/include"],
strip_include_prefix = "src/main/native/thirdparty/debugging/include",
visibility = ["//wpiutil:__subpackages__"],
)

filegroup(
name = "debugging-srcs",
srcs = glob(["src/main/native/thirdparty/debugging/src/**"]),
visibility = ["//wpiutil:__subpackages__"],
)

cc_library(
name = "expected-headers",
hdrs = glob([
Expand Down Expand Up @@ -175,6 +191,7 @@ cc_library(
["src/main/native/cpp/**"],
exclude = ["src/main/native/cpp/jni/**"],
) + [
":debugging-srcs",
":fmtlib-srcs",
":generate-resources",
":llvm-srcs",
Expand All @@ -191,6 +208,7 @@ cc_library(
deps = [
":argparse-headers",
":concurrentqueue-headers",
":debugging-headers",
":expected-headers",
":fmtlib-headers",
":json-headers",
Expand Down
3 changes: 3 additions & 0 deletions wpiutil/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ generate_resources(src/main/native/resources generated/main/cpp WPI wpi wpiutil_
file(
GLOB_RECURSE wpiutil_native_src
src/main/native/cpp/*.cpp
src/main/native/thirdparty/debugging/src/*.cpp
src/main/native/thirdparty/json/cpp/*.cpp
src/main/native/thirdparty/llvm/cpp/*.cpp
src/main/native/thirdparty/mpack/src/*.cpp
Expand Down Expand Up @@ -198,6 +199,7 @@ install(
DIRECTORY
src/main/native/include/
src/main/native/thirdparty/argparse/include/
src/main/native/thirdparty/debugging/include/
src/main/native/thirdparty/expected/include/
src/main/native/thirdparty/json/include/
src/main/native/thirdparty/llvm/include/
Expand All @@ -212,6 +214,7 @@ target_include_directories(
PUBLIC
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src/main/native/include>
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src/main/native/thirdparty/argparse/include>
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src/main/native/thirdparty/debugging/include>
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src/main/native/thirdparty/expected/include>
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src/main/native/thirdparty/json/include>
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src/main/native/thirdparty/llvm/include>
Expand Down
12 changes: 11 additions & 1 deletion wpiutil/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,15 @@ ext {
dependsOn generateTask
}
it.sources {
debuggingCpp(CppSourceSet) {
source {
srcDirs 'src/main/native/thirdparty/debugging/src'
include '*.cpp'
}
exportedHeaders {
srcDirs 'src/main/native/thirdparty/debugging/include'
}
}
fmtlibCpp(CppSourceSet) {
source {
srcDirs 'src/main/native/thirdparty/fmtlib/src'
Expand Down Expand Up @@ -178,6 +187,7 @@ nativeUtils.exportsConfigs {
cppHeadersZip {
def thirdpartyIncDirs = [
'src/main/native/thirdparty/argparse/include',
'src/main/native/thirdparty/debugging/include',
'src/main/native/thirdparty/expected/include',
'src/main/native/thirdparty/fmtlib/include',
'src/main/native/thirdparty/json/include',
Expand Down Expand Up @@ -229,7 +239,7 @@ model {
all {
it.sources.each {
it.exportedHeaders {
srcDirs 'src/main/native/include', 'src/main/native/thirdparty/argparse/include/', 'src/main/native/thirdparty/expected/include', 'src/main/native/thirdparty/fmtlib/include', 'src/main/native/thirdparty/llvm/include', 'src/main/native/thirdparty/sigslot/include', 'src/main/native/thirdparty/json/include', 'src/main/native/thirdparty/memory/include', 'src/main/native/thirdparty/mpack/include', 'src/main/native/thirdparty/protobuf/include', 'src/main/native/thirdparty/nanopb/include'
srcDirs 'src/main/native/include', 'src/main/native/thirdparty/argparse/include/', 'src/main/native/thirdparty/debugging/include', 'src/main/native/thirdparty/expected/include', 'src/main/native/thirdparty/fmtlib/include', 'src/main/native/thirdparty/llvm/include', 'src/main/native/thirdparty/sigslot/include', 'src/main/native/thirdparty/json/include', 'src/main/native/thirdparty/memory/include', 'src/main/native/thirdparty/mpack/include', 'src/main/native/thirdparty/protobuf/include', 'src/main/native/thirdparty/nanopb/include'
}
}
}
Expand Down
29 changes: 29 additions & 0 deletions wpiutil/src/main/native/thirdparty/debugging/include/debugging.hpp
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
Loading

0 comments on commit b7eb9fb

Please sign in to comment.