mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-21 14:16:26 +00:00
52e4accb76
This makes pw_assert_basic trigger C's standard abort() function by
default, unless PW_ASSERT_BASIC_ABORT is defined as 0.
Below is an example session in pw watch with the abort functionality:
▒█████▄ █▓ ▄███▒ ▒█ ▒█ ░▓████▒ ░▓████▒ ▒▓████▄
▒█░ █░ ░█▒ ██▒ ▀█▒ ▒█░ █ ▒█ ▒█ ▀ ▒█ ▀ ▒█ ▀█▌
▒█▄▄▄█░ ░█▒ █▓░ ▄▄░ ▒█░ █ ▒█ ▒███ ▒███ ░█ █▌
▒█▀ ░█░ ▓█ █▓ ░█░ █ ▒█ ▒█ ▄ ▒█ ▄ ░█ ▄█▌
▒█ ░█░ ░▓███▀ ▒█▓▀▓█░ ░▓████▒ ░▓████▒ ▒▓████▀
Watching for changes. Ctrl-C to exit; enter to rebuild
20200415 21:17:32 INF Change detected: None
20200415 21:17:32 INF Starting build with 1 directories
20200415 21:17:32 INF [1/1] Starting build: out/host
ninja: Entering directory `out/host'
[1/5] ACTION //pw_assert:assert_backend_compile_test_run(//pw_toolchain:host_clang_og)
FAILED: gen/pw_assert/assert_backend_compile_test_run.pw_pystamp
python ../../pw_build/py/python_runner.py --gn-root ../../ --out-dir //out/host --touch //out/host/gen/pw_assert/assert_backend_compile_test_run.pw_pystamp --capture-output -- //pw_unit_test/py/pw_unit_test/test_runner.py --runner //targets/host/run_test --test //out/host/obj/pw_assert:assert_backend_compile_test
INF Test 1/1: [ RUN] assert_backend_compile_test
ERR /Users/keir/wrk/pigweed/targets/host/run_test exited with status 134
OUT [15726]
INF [==========] Running all tests.
INF [ RUN ] Crash.WithAndWithoutMessageArguments
INF [ OK ] Crash.WithAndWithoutMessageArguments
INF [ RUN ] Check.NoMessage
INF [ OK ] Check.NoMessage
INF [ RUN ] Check.WithMessageAndArgs
INF [ OK ] Check.WithMessageAndArgs
INF [ RUN ] Check.IntComparison
▄████▄ ██▀███ ▄▄▄ ██████ ██░ ██
▒██▀ ▀█ ▓██ ▒ ██▒ ▒████▄ ▒██ ▒ ▓██░ ██▒
▒▓█ 💥 ▄ ▓██ ░▄█ ▒ ▒██ ▀█▄ ░ ▓██▄ ▒██▀▀██░
▒▓▓▄ ▄██▒ ▒██▀▀█▄ ░██▄▄▄▄██ ▒ ██▒ ░▓█ ░██
▒ ▓███▀ ░ ░██▓ ▒██▒ ▓█ ▓██▒ ▒██████▒▒ ░▓█▒░██▓
░ ░▒ ▒ ░ ░ ▒▓ ░▒▓░ ▒▒ ▓▒█░ ▒ ▒▓▒ ▒ ░ ▒ ░░▒░▒
░ ▒ ░▒ ░ ▒░ ▒ ▒▒ ░ ░ ░▒ ░ ░ ▒ ░▒░ ░
░ ░░ ░ ░ ▒ ░ ░ ░ ░ ░░ ░
░ ░ ░ ░ ░ ░ ░ ░ ░
░
Welp, that didn't go as planned. It seems we crashed. Terribly sorry!
CRASH MESSAGE
Check failed: x_int (=50) >= y_int (=66). Oh dear. In state: TEST
CRASH FILE & LINE
../../pw_assert/assert_backend_compile_test.cc:92
CRASH FUNCTION
PigweedTestBody
/Users/keir/wrk/pigweed/targets/host/run_test: line 18: 15727 Abort trap: 6 "$@"
INF Test 1/1: [FAIL] assert_backend_compile_test
ninja: build stopped: subcommand failed.
20200415 21:17:32 ERR [1/1] Finished build: out/host (FAIL)
20200415 21:17:32 INF Finished; some builds failed
.------------------------------------
|
| FAIL out/host
|
'------------------------------------
▄██████▒░▄▄▄ ██▓ ░██▓
▓█▓ ░▒████▄ ▓██▒ ░▓██▒
▒████▒ ░▒█▀ ▀█▄ ▒██▒ ▒██░
░▓█▒ ░░██▄▄▄▄██ ░██░ ▒██░
░▒█░ ▓█ ▓██▒░██░░ ████████▒
▒█░ ▒▒ ▓▒█░░▓ ░ ▒░▓ ░
░▒ ▒ ▒▒ ░ ▒ ░░ ░ ▒ ░
░ ░ ░ ▒ ▒ ░ ░ ░
░ ░ ░ ░ ░
Change-Id: Iaf69455c5f108b2d4d9ae1b8dc4cd6bb5902fbed
158 lines
5.2 KiB
C++
158 lines
5.2 KiB
C++
// Copyright 2020 The Pigweed Authors
|
|
//
|
|
// Licensed 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
|
|
//
|
|
// https://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.
|
|
|
|
// This is a very basic direct output log implementation with no buffering.
|
|
|
|
//#define PW_LOG_MODULE_NAME "ASRT"
|
|
//#include "pw_log/log.h"
|
|
|
|
#include "pw_assert_basic/assert_basic.h"
|
|
|
|
#include <cstring>
|
|
|
|
#include "pw_preprocessor/util.h"
|
|
#include "pw_string/string_builder.h"
|
|
#include "pw_sys_io/sys_io.h"
|
|
|
|
// If 1, call C's standard abort() function on assert failure.
|
|
#ifndef PW_ASSERT_BASIC_ABORT
|
|
#define PW_ASSERT_BASIC_ABORT 1
|
|
#endif // PW_ASSERT_BASIC_ABORT
|
|
|
|
// TODO(pwbug/17): Expose these through the config system.
|
|
#define PW_ASSERT_BASIC_SHOW_BANNER 1
|
|
#define PW_ASSERT_BASIC_USE_COLORS 1
|
|
|
|
// ANSI color constants to control the terminal. Not Windows compatible.
|
|
// clang-format off
|
|
#if PW_ASSERT_BASIC_USE_COLORS
|
|
#define MAGENTA "\033[35m"
|
|
#define YELLOW "\033[33m"
|
|
#define RED "\033[31m"
|
|
#define GREEN "\033[32m"
|
|
#define BLUE "\033[96m"
|
|
#define BLACK "\033[30m"
|
|
#define YELLOW_BG "\033[43m"
|
|
#define WHITE_BG "\033[47m"
|
|
#define RED_BG "\033[41m"
|
|
#define BOLD "\033[1m"
|
|
#define RESET "\033[0m"
|
|
#else
|
|
#define MAGENTA ""
|
|
#define YELLOW ""
|
|
#define RED ""
|
|
#define GREEN ""
|
|
#define BLUE ""
|
|
#define BLACK ""
|
|
#define YELLOW_BG ""
|
|
#define WHITE_BG ""
|
|
#define RED_BG ""
|
|
#define BOLD ""
|
|
#define RESET ""
|
|
#endif // PW_ASSERT_BASIC_USE_COLORS
|
|
// clang-format on
|
|
|
|
static const char* kCrashBanner[] = {
|
|
" ",
|
|
" ▄████▄ ██▀███ ▄▄▄ ██████ ██░ ██ ",
|
|
" ▒██▀ ▀█ ▓██ ▒ ██▒ ▒████▄ ▒██ ▒ ▓██░ ██▒ ",
|
|
" ▒▓█ 💥 ▄ ▓██ ░▄█ ▒ ▒██ ▀█▄ ░ ▓██▄ ▒██▀▀██░ ",
|
|
" ▒▓▓▄ ▄██▒ ▒██▀▀█▄ ░██▄▄▄▄██ ▒ ██▒ ░▓█ ░██ ",
|
|
" ▒ ▓███▀ ░ ░██▓ ▒██▒ ▓█ ▓██▒ ▒██████▒▒ ░▓█▒░██▓ ",
|
|
" ░ ░▒ ▒ ░ ░ ▒▓ ░▒▓░ ▒▒ ▓▒█░ ▒ ▒▓▒ ▒ ░ ▒ ░░▒░▒ ",
|
|
" ░ ▒ ░▒ ░ ▒░ ▒ ▒▒ ░ ░ ░▒ ░ ░ ▒ ░▒░ ░ ",
|
|
" ░ ░░ ░ ░ ▒ ░ ░ ░ ░ ░░ ░ ",
|
|
" ░ ░ ░ ░ ░ ░ ░ ░ ░ ",
|
|
" ░",
|
|
" ",
|
|
};
|
|
|
|
using pw::sys_io::WriteLine;
|
|
|
|
typedef pw::StringBuffer<150> Buffer;
|
|
|
|
extern "C" void pw_Crash(const char* file_name,
|
|
int line_number,
|
|
const char* function_name,
|
|
const char* message,
|
|
...) {
|
|
// As a matter of usability, crashes should be visible; make it so.
|
|
#if PW_ASSERT_BASIC_SHOW_BANNER
|
|
WriteLine(RED);
|
|
for (const char* line : kCrashBanner) {
|
|
WriteLine(line);
|
|
}
|
|
WriteLine(RESET);
|
|
#endif // PW_ASSERT_BASIC_SHOW_BANNER
|
|
|
|
WriteLine(
|
|
" Welp, that didn't go as planned. "
|
|
"It seems we crashed. Terribly sorry!");
|
|
WriteLine("");
|
|
WriteLine(YELLOW " CRASH MESSAGE" RESET);
|
|
WriteLine("");
|
|
{
|
|
Buffer buffer;
|
|
buffer << " ";
|
|
va_list args;
|
|
va_start(args, message);
|
|
buffer.FormatVaList(message, args);
|
|
va_end(args);
|
|
WriteLine(buffer.view());
|
|
}
|
|
|
|
WriteLine("");
|
|
WriteLine(YELLOW " CRASH FILE & LINE" RESET);
|
|
WriteLine("");
|
|
{
|
|
Buffer buffer;
|
|
buffer.Format(" %s:%d", file_name, line_number);
|
|
WriteLine(buffer.view());
|
|
}
|
|
WriteLine("");
|
|
WriteLine(YELLOW " CRASH FUNCTION" RESET);
|
|
WriteLine("");
|
|
{
|
|
Buffer buffer;
|
|
buffer.Format(" %s", function_name);
|
|
WriteLine(buffer.view());
|
|
}
|
|
WriteLine("");
|
|
|
|
// TODO(pwbug/95): Perhaps surprisingly, this doesn't actually crash the
|
|
// device. At some point we'll have a reboot BSP function or similar, but for
|
|
// now this is acceptable since no one is using this basic backend.
|
|
if (!PW_ASSERT_BASIC_DISABLE_NORETURN) {
|
|
if (PW_ASSERT_BASIC_ABORT) {
|
|
abort();
|
|
} else {
|
|
WriteLine(MAGENTA " HANG TIME" RESET);
|
|
WriteLine("");
|
|
WriteLine(
|
|
" ... until a debugger joins. System is waiting in a while(1)");
|
|
while (1) {
|
|
}
|
|
}
|
|
PW_UNREACHABLE;
|
|
} else {
|
|
WriteLine(MAGENTA " NOTE: YOU ARE IN ASSERT BASIC TEST MODE" RESET);
|
|
WriteLine("");
|
|
WriteLine(" This build returns from the crash handler for testing.");
|
|
WriteLine(" If you see this message in production, your build is ");
|
|
WriteLine(" incorrectly configured. Search for");
|
|
WriteLine(" PW_ASSERT_BASIC_DISABLE_NORETURN to fix it.");
|
|
WriteLine("");
|
|
}
|
|
}
|