50a81748fd
This patch adds the ability to attach a GDB host through the UART to a running payload. Libpayload implements a small stub that can parse and respond to the GDB remote protocol and provide the required primitives (reading/writing registers/memory, etc.) to allow GDB to control execution. The goal of this implementation is to be as small and uninvasive as possible. It implements only the minimum amount of primitives required, and relies on GDB's impressive workaround capabilities (such as emulating breakpoints by temporarily replacing instructions) for the more complicated features. This way, a relatively tiny amount of code on the firmware side opens a vast range of capabilities to the user, not just in debugging but also in remote-controlling the firmware to change its behavior (e.g. through GDBs ability to modify variables and call functions). By default, a system with the REMOTEGDB Kconfig will only trap into GDB when executing halt() (including the calls from die_if(), assert(), and exception handlers). In addition, payloads can manually call gdb_enter() if desired. It will print a final "Ready for GDB connection." on the serial, detach the normal serial output driver and wait for the commands that GDB starts sending on attach. Based on original implementation by Gabe Black <gabeblack@chromium.org>. BUG=chrome-os-partner:18390 TEST=Boot a GDB enabled image in recovery mode (or get it to hit a halt()), close your terminal, execute '<toolchain>-gdb --symbols /build/<board>/firmware/depthcharge_gdb/depthcharge.elf --directory ~/trunk/src/third_party/coreboot/payloads/libpayload --directory ~/trunk/src/platform/depthcharge --directory ~/trunk/src/platform/vboot_reference --ex "target remote <cpu_uart_pty>"' and behold the magic. (You can also SIGSTOP your terminal's parent shell and the terminal itself, and SIGCONT them in reverse order after GDB exits. More convenient wrapper tools to do all this automatically coming soon.) Original-Change-Id: Ib440d1804126cdfdac4a8801f5015b4487e25269 Original-Signed-off-by: Julius Werner <jwerner@chromium.org> Original-Reviewed-on: https://chromium-review.googlesource.com/202563 Original-Reviewed-by: Stefan Reinauer <reinauer@chromium.org> (cherry picked from commit 9c4a642c7be2faf122fef39bdfaddd64aec68b77) Signed-off-by: Marc Jones <marc.jones@se-eng.com> Change-Id: I9238b4eb19d3ab2c98e4e1c5946cd7d252ca3c3b Reviewed-on: http://review.coreboot.org/8119 Tested-by: build bot (Jenkins) Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
214 lines
6.5 KiB
C
214 lines
6.5 KiB
C
/*
|
|
* This file is part of the libpayload project.
|
|
*
|
|
* Copyright (C) 2008 Advanced Micro Devices, Inc.
|
|
* Copyright 2013 Google Inc.
|
|
*
|
|
* 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 _STDLIB_H
|
|
#define _STDLIB_H
|
|
|
|
#include <die.h>
|
|
#include <stddef.h>
|
|
#include <string.h>
|
|
|
|
#define ALIGN(x,a) __ALIGN_MASK(x,(typeof(x))(a)-1UL)
|
|
#define __ALIGN_MASK(x,mask) (((x)+(mask))&~(mask))
|
|
#define ALIGN_UP(x,a) ALIGN((x),(a))
|
|
#define ALIGN_DOWN(x,a) ((x) & ~((typeof(x))(a)-1UL))
|
|
|
|
/**
|
|
* @defgroup malloc Memory allocation functions
|
|
* @{
|
|
*/
|
|
#if defined(CONFIG_LP_DEBUG_MALLOC) && !defined(IN_MALLOC_C)
|
|
#define free(p) \
|
|
({ \
|
|
extern void print_malloc_map(void); \
|
|
extern void free(void *); \
|
|
printf("free(%p) called from %s:%s:%d...\n", p, __FILE__, __func__, \
|
|
__LINE__);\
|
|
printf("PRE free()\n"); \
|
|
print_malloc_map(); \
|
|
free(p); \
|
|
printf("POST free()\n"); \
|
|
print_malloc_map(); \
|
|
})
|
|
#define malloc(s) \
|
|
({ \
|
|
extern void print_malloc_map(void); \
|
|
extern void *malloc(size_t); \
|
|
void *ptr; \
|
|
printf("malloc(%u) called from %s:%s:%d...\n", s, __FILE__, __func__, \
|
|
__LINE__);\
|
|
printf("PRE malloc\n"); \
|
|
print_malloc_map(); \
|
|
ptr = malloc(s); \
|
|
printf("POST malloc (ptr = %p)\n", ptr); \
|
|
print_malloc_map(); \
|
|
ptr; \
|
|
})
|
|
#define calloc(n,s) \
|
|
({ \
|
|
extern void print_malloc_map(void); \
|
|
extern void *calloc(size_t,size_t); \
|
|
void *ptr; \
|
|
printf("calloc(%u, %u) called from %s:%s:%d...\n", n, s, __FILE__, \
|
|
__func__, __LINE__);\
|
|
printf("PRE calloc\n"); \
|
|
print_malloc_map(); \
|
|
ptr = calloc(n,s); \
|
|
printf("POST calloc (ptr = %p)\n", ptr); \
|
|
print_malloc_map(); \
|
|
ptr; \
|
|
})
|
|
#define realloc(p,s) \
|
|
({ \
|
|
extern void print_malloc_map(void); \
|
|
extern void *realloc(void*,size_t); \
|
|
void *ptr; \
|
|
printf("realloc(%p, %u) called from %s:%s:%d...\n", p, s, __FILE__, \
|
|
__func__, __LINE__);\
|
|
printf("PRE realloc\n"); \
|
|
print_malloc_map(); \
|
|
ptr = realloc(p,s); \
|
|
printf("POST realloc (ptr = %p)\n", ptr); \
|
|
print_malloc_map(); \
|
|
ptr; \
|
|
})
|
|
#define memalign(a,s) \
|
|
({ \
|
|
extern void print_malloc_map(void); \
|
|
extern void *memalign(size_t, size_t); \
|
|
void *ptr; \
|
|
printf("memalign(%u, %u) called from %s:%s:%d...\n", a, s, __FILE__, \
|
|
__func__, __LINE__);\
|
|
printf("PRE memalign\n"); \
|
|
print_malloc_map(); \
|
|
ptr = memalign(a,s); \
|
|
printf("POST memalign (ptr = %p)\n", ptr); \
|
|
print_malloc_map(); \
|
|
ptr; \
|
|
})
|
|
#define dma_malloc(s) \
|
|
({ \
|
|
extern void print_malloc_map(void); \
|
|
extern void *dma_malloc(size_t); \
|
|
void *ptr; \
|
|
printf("dma_malloc(%u) called from %s:%s:%d...\n", s, __FILE__, \
|
|
__func__, __LINE__);\
|
|
printf("PRE dma_malloc\n"); \
|
|
print_malloc_map(); \
|
|
ptr = dma_malloc(s); \
|
|
printf("POST dma_malloc (ptr = %p)\n", ptr); \
|
|
print_malloc_map(); \
|
|
ptr; \
|
|
})
|
|
#define dma_memalign(a,s) \
|
|
({ \
|
|
extern void print_malloc_map(void); \
|
|
extern void *dma_memalign(size_t, size_t); \
|
|
void *ptr; \
|
|
printf("dma_memalign(%u, %u) called from %s:%s:%d...\n", a, s, \
|
|
__FILE__, __func__, __LINE__);\
|
|
printf("PRE dma_memalign\n"); \
|
|
print_malloc_map(); \
|
|
ptr = dma_memalign(a,s); \
|
|
printf("POST dma_memalign (ptr = %p)\n", ptr); \
|
|
print_malloc_map(); \
|
|
ptr; \
|
|
})
|
|
#else
|
|
void free(void *ptr);
|
|
void *malloc(size_t size);
|
|
void *calloc(size_t nmemb, size_t size);
|
|
void *realloc(void *ptr, size_t size);
|
|
void *memalign(size_t align, size_t size);
|
|
void *dma_malloc(size_t size);
|
|
void *dma_memalign(size_t align, size_t size);
|
|
#endif
|
|
void init_dma_memory(void *start, u32 size);
|
|
int dma_initialized(void);
|
|
int dma_coherent(void *ptr);
|
|
|
|
static inline void *xmalloc_work(size_t size, const char *file,
|
|
const char *func, int line)
|
|
{
|
|
void *ret = malloc(size);
|
|
if (!ret && size) {
|
|
die_work(file, func, line, "Failed to malloc %zu bytes.\n",
|
|
size);
|
|
}
|
|
return ret;
|
|
}
|
|
#define xmalloc(size) xmalloc_work((size), __FILE__, __FUNCTION__, __LINE__)
|
|
|
|
static inline void *xzalloc_work(size_t size, const char *file,
|
|
const char *func, int line)
|
|
{
|
|
void *ret = xmalloc_work(size, file, func, line);
|
|
memset(ret, 0, size);
|
|
return ret;
|
|
}
|
|
#define xzalloc(size) xzalloc_work((size), __FILE__, __FUNCTION__, __LINE__)
|
|
/** @} */
|
|
|
|
/**
|
|
* @defgroup stdlib String conversion functions
|
|
* @{
|
|
*/
|
|
long int strtol(const char *s, char **nptr, int base);
|
|
unsigned long int strtoul(const char *s, char **nptr, int base);
|
|
unsigned long long int strtoull(const char *s, char **nptr, int base);
|
|
long atol(const char *nptr);
|
|
|
|
/** @} */
|
|
|
|
/**
|
|
* @defgroup rand Random number generator functions
|
|
* @{
|
|
*/
|
|
int rand_r(unsigned int *seed);
|
|
int rand(void);
|
|
void srand(unsigned int seed);
|
|
/** @} */
|
|
|
|
/**
|
|
* Stop execution and halt the processor (this function does not return).
|
|
*/
|
|
void halt(void) __attribute__ ((noreturn));
|
|
void exit(int status) __attribute__ ((noreturn));
|
|
#define abort() halt() /**< Alias for the halt() function */
|
|
#ifdef CONFIG_LP_REMOTEGDB
|
|
/* Override abort()/halt() to trap into GDB if it is enabled. */
|
|
#define halt() do { gdb_enter(); halt(); } while (0)
|
|
#endif
|
|
|
|
/** @} */
|
|
|
|
void qsort(void *aa, size_t n, size_t es, int (*cmp)(const void *, const void *));
|
|
char *getenv(const char*);
|
|
#endif
|