From 59df109d56a0f5346562de9b3124666a4443adf0 Mon Sep 17 00:00:00 2001 From: Gabe Black Date: Sat, 23 Nov 2013 00:38:49 -0800 Subject: [PATCH] libpayload: Add a new "die" function to fatally signal programming errors. If a programming error is detected, die can be used to print a message and stop execution similar to failing an assert. There's also a "die_if" function which is conditional. die functions, like asserts, should be used to trap programming errors and not when the hardware does something wrong. If all code was written perfectly, no die function would ever be called. In other words, it would be appropriate to use die if a function was called with a value that was out of bounds or if malloc failed. It wouldn't be appropriate if an external device doesn't respond. In the future, the die family of functions might print a stack trace or show other debugging info. BUG=None TEST=Used the die_if function in other code and verified that it stops execution, prints messages like printf, shows file, line, and function information, and is correctly gated by its condition. BRANCH=None Change-Id: I653fc8cb0b4e459522f1b86f7fac280836d57916 Signed-off-by: Gabe Black Reviewed-on: https://chromium-review.googlesource.com/178000 Reviewed-by: Gabe Black Commit-Queue: Gabe Black Tested-by: Gabe Black --- payloads/libpayload/include/die.h | 45 ++++++++++++++++++++++++ payloads/libpayload/include/libpayload.h | 1 + payloads/libpayload/libc/Makefile.inc | 1 + payloads/libpayload/libc/die.c | 35 ++++++++++++++++++ 4 files changed, 82 insertions(+) create mode 100644 payloads/libpayload/include/die.h create mode 100644 payloads/libpayload/libc/die.c diff --git a/payloads/libpayload/include/die.h b/payloads/libpayload/include/die.h new file mode 100644 index 0000000000..6dff6a89b4 --- /dev/null +++ b/payloads/libpayload/include/die.h @@ -0,0 +1,45 @@ +/* + * This file is part of the libpayload project. + * + * Copyright (C) 2013 coresystems GmbH + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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. + */ + +#ifndef __DIE_H__ +#define __DIE_H__ + +void die_work(const char *file, const char *func, const int line, + const char *fmt, ...) + __attribute__((format (printf, 4, 5))) + __attribute__((noreturn)); + +#define die(fmt, args...) \ + do { die_work(__FILE__, __FUNCTION__, __LINE__, fmt, ##args); } \ + while (0) + +#define die_if(condition, fmt, args...) \ + do { if (condition) die(fmt, ##args); } while (0) + +#endif /* __DIE_H__ */ diff --git a/payloads/libpayload/include/libpayload.h b/payloads/libpayload/include/libpayload.h index 1bb3e30d02..8f1173371c 100644 --- a/payloads/libpayload/include/libpayload.h +++ b/payloads/libpayload/include/libpayload.h @@ -45,6 +45,7 @@ #include #include +#include #include #include #include diff --git a/payloads/libpayload/libc/Makefile.inc b/payloads/libpayload/libc/Makefile.inc index 53f3c9b1bb..e2eee15c7c 100644 --- a/payloads/libpayload/libc/Makefile.inc +++ b/payloads/libpayload/libc/Makefile.inc @@ -36,6 +36,7 @@ libc-$(CONFIG_LP_LIBC) += args.c strings.c libc-$(CONFIG_LP_LIBC) += strlcpy.c libc-$(CONFIG_LP_LIBC) += qsort.c libc-$(CONFIG_LP_LIBC) += hexdump.c +libc-$(CONFIG_LP_LIBC) += die.c # should be moved to coreboot directory libc-$(CONFIG_LP_LAR) += lar.c diff --git a/payloads/libpayload/libc/die.c b/payloads/libpayload/libc/die.c new file mode 100644 index 0000000000..62fa881e79 --- /dev/null +++ b/payloads/libpayload/libc/die.c @@ -0,0 +1,35 @@ +/* + * Copyright 2013 Google Inc. + * + * See file CREDITS for list of people who contributed to this + * project. + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License as + * published by the Free Software Foundation; either version 2 of + * the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but without any warranty; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + */ + +#include + +void die_work(const char *file, const char *func, const int line, + const char *fmt, ...) +{ + va_list args; + + printf("%s:%d %s(): ", file, line, func); + va_start(args, fmt); + vprintf(fmt, args); + va_end(args); + abort(); +}