Copilot commented on code in PR #13733: URL: https://github.com/apache/trafficserver/pull/13733#discussion_r4363835312
########## src/tscore/unit_tests/test_Demangle.cc: ########## @@ -0,0 +1,80 @@ +/** @file + + Tests for the exception description helpers. + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + */ + +#include "tscore/Demangle.h" + +#include <catch2/catch_test_macros.hpp> + +#include <stdexcept> +#include <string> + +namespace +{ +struct NotAnException { +}; + +std::string +describe_thrown(auto const &thrown) Review Comment: This test file uses C++20-only features (abbreviated function template parameter `auto` and `std::string::ends_with`). If the project/toolchain is still building unit tests under C++17 (or earlier), this will be a compile error. Either ensure the repo’s CMake explicitly enables C++20 for these tests, or rewrite the test to be C++17-compatible (e.g., a normal function template + `substr`/`compare` instead of `ends_with`). ########## src/tscore/unit_tests/test_Demangle.cc: ########## @@ -0,0 +1,80 @@ +/** @file + + Tests for the exception description helpers. + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + */ + +#include "tscore/Demangle.h" + +#include <catch2/catch_test_macros.hpp> + +#include <stdexcept> +#include <string> + +namespace +{ +struct NotAnException { +}; + +std::string +describe_thrown(auto const &thrown) +{ + try { + throw thrown; + } catch (...) { + return ts::describe_current_exception(); + } +} +} // namespace + +TEST_CASE("demangle", "[libts][Demangle]") +{ + CHECK(ts::demangle(typeid(int)) == "int"); + CHECK(ts::demangle(typeid(std::runtime_error)).find("runtime_error") != std::string::npos); + CHECK(ts::demangle(typeid(NotAnException)).find("NotAnException") != std::string::npos); +} + +TEST_CASE("describe_current_exception", "[libts][Demangle]") +{ + SECTION("a std::exception reports its type and message") + { + auto const text = describe_thrown(std::runtime_error{"boom"}); + + CHECK(text.find("runtime_error") != std::string::npos); + CHECK(text.ends_with(": boom")); Review Comment: This test file uses C++20-only features (abbreviated function template parameter `auto` and `std::string::ends_with`). If the project/toolchain is still building unit tests under C++17 (or earlier), this will be a compile error. Either ensure the repo’s CMake explicitly enables C++20 for these tests, or rewrite the test to be C++17-compatible (e.g., a normal function template + `substr`/`compare` instead of `ends_with`). ########## src/traffic_server/traffic_server.cc: ########## @@ -1971,6 +1973,24 @@ configure_io_uring() } #endif +// Runs when an exception escapes on any thread. The terminate handler runs +// before the stack unwinds, so aborting from here keeps the throwing frame in +// the core. The one exception is a throw that leaves a noexcept function: the +// runtime unwinds to that function's frame before it calls terminate, so the +// core loses the frames between the throw and it. Catching in main() instead +// would unwind those frames first and would miss other threads entirely. main() +// installs this before init_system() registers the crash handler, and before +// crash_logger_init() starts the crash logger. A throw in that window still +// aborts and dumps a core, but writes no crash log. +[[noreturn]] void +abort_on_uncaught_exception() +{ + if (std::current_exception()) { + ink_abort("traffic_server: terminating on an unhandled %s", ts::describe_current_exception().c_str()); + } + ink_abort("traffic_server: terminate called without an active exception"); Review Comment: `abort_on_uncaught_exception()` will always proceed to the second `ink_abort()` when `std::current_exception()` is non-null unless `ink_abort()` is formally `[[noreturn]]` to the compiler. To avoid a guaranteed fallthrough path (and potential double-reporting if `ink_abort`’s contract changes or isn’t annotated), make the second call an `else` branch or add an explicit `return` after the first `ink_abort()`. ########## src/tscore/Demangle.cc: ########## @@ -0,0 +1,79 @@ +/** @file + + Readable C++ type names. + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + */ + +#include "tscore/Demangle.h" + +#include <cstdlib> +#include <cxxabi.h> +#include <exception> +#include <memory> + +namespace +{ +struct FreeDeleter { + void + operator()(char *p) const noexcept + { + std::free(p); + } +}; +} // namespace + +namespace ts +{ +std::string +demangle(std::type_info const &type) noexcept +{ + try { + int status = 0; + std::unique_ptr<char, FreeDeleter> name{abi::__cxa_demangle(type.name(), nullptr, nullptr, &status)}; Review Comment: `abi::__cxa_demangle` and `abi::__cxa_current_exception_type()` are non-standard Itanium C++ ABI APIs; builds on platforms/standard libraries that don’t provide `<cxxabi.h>` (or don’t implement these symbols) will fail. Consider adding compile-time feature detection/guards (e.g., `__has_include(<cxxabi.h>)` and/or platform macros) and providing a fallback implementation that uses `type.name()` and returns a generic `"exception"` for non-`std::exception` throws when the ABI hooks are unavailable. ########## src/tscore/Demangle.cc: ########## @@ -0,0 +1,79 @@ +/** @file + + Readable C++ type names. + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + */ + +#include "tscore/Demangle.h" + +#include <cstdlib> +#include <cxxabi.h> Review Comment: `abi::__cxa_demangle` and `abi::__cxa_current_exception_type()` are non-standard Itanium C++ ABI APIs; builds on platforms/standard libraries that don’t provide `<cxxabi.h>` (or don’t implement these symbols) will fail. Consider adding compile-time feature detection/guards (e.g., `__has_include(<cxxabi.h>)` and/or platform macros) and providing a fallback implementation that uses `type.name()` and returns a generic `"exception"` for non-`std::exception` throws when the ABI hooks are unavailable. ########## src/tscore/Demangle.cc: ########## @@ -0,0 +1,79 @@ +/** @file + + Readable C++ type names. + + @section license License + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + */ + +#include "tscore/Demangle.h" + +#include <cstdlib> +#include <cxxabi.h> +#include <exception> +#include <memory> + +namespace +{ +struct FreeDeleter { + void + operator()(char *p) const noexcept + { + std::free(p); + } +}; +} // namespace + +namespace ts +{ +std::string +demangle(std::type_info const &type) noexcept +{ + try { + int status = 0; + std::unique_ptr<char, FreeDeleter> name{abi::__cxa_demangle(type.name(), nullptr, nullptr, &status)}; + + return status == 0 && name != nullptr ? name.get() : type.name(); + } catch (...) { + return "<unknown>"; + } +} + +std::string +describe_current_exception() noexcept +{ + std::exception_ptr const ep = std::current_exception(); + + try { + if (!ep) { + return "no active exception"; + } + try { + std::rethrow_exception(ep); + } catch (std::exception const &ex) { + return demangle(typeid(ex)) + ": " + ex.what(); + } catch (...) { + if (std::type_info const *type = abi::__cxa_current_exception_type(); type != nullptr) { + return "exception of type " + demangle(*type); + } Review Comment: `abi::__cxa_demangle` and `abi::__cxa_current_exception_type()` are non-standard Itanium C++ ABI APIs; builds on platforms/standard libraries that don’t provide `<cxxabi.h>` (or don’t implement these symbols) will fail. Consider adding compile-time feature detection/guards (e.g., `__has_include(<cxxabi.h>)` and/or platform macros) and providing a fallback implementation that uses `type.name()` and returns a generic `"exception"` for non-`std::exception` throws when the ABI hooks are unavailable. ########## tests/uranium_tests/command_argument/test_traffic_cache_tool_bad_aos.py: ########## @@ -0,0 +1,44 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import re + +from tools.uranium.services import ATS, ATSFactory + + +def configure_ats(ats_factory: ATSFactory) -> ATS: + """Create the runroot whose environment locates traffic_cache_tool. + + :param ats_factory: Factory for isolated Traffic Server instances. + """ + + return ats_factory.create("ts") + + +def test_traffic_cache_tool_bad_aos(ats_factory: ATSFactory) -> None: + """A non-numeric --aos is reported by traffic_cache_tool, which exits with 1 instead of aborting. + + std::stoi throws std::invalid_argument on the value. main() must report the exception and + return 1 rather than let it reach std::terminate, which would abort with SIGABRT. + + :param ats_factory: Factory for isolated Traffic Server instances. + """ + _ats = configure_ats(ats_factory) + + _ats.start() + result = _ats.run("traffic_cache_tool", "--aos", "abc", "list") + assert result.returncode == 1, result.output + assert re.search(r"traffic_cache_tool: terminating on an unhandled std::\S*invalid_argument: \S", result.stderr), result.output Review Comment: The regex for the `std::invalid_argument` message is overly strict about the `what()` payload (`: \S` only matches a single non-space character). In practice, `std::stoi`’s `what()` varies across standard libraries and may include spaces or longer text (e.g., `"stoi: no conversion"`). Loosen the pattern (e.g., allow `.*` after the colon, or match just the prefix up through the exception type) to reduce false negatives across libstdc++/libc++ variations. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
