blob: c6c154cde78d7884f6c26fe1a52620438e8bf947 [file] [log] [blame]
Willy Tarreau1d488b62006-12-16 19:54:02 +01001/*
2 include/common/debug.h
3 This files contains some macros to help debugging.
4
5 Copyright (C) 2000-2006 Willy Tarreau - w@1wt.eu
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation, version 2.1
10 exclusively.
11
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20*/
21
22#ifndef _COMMON_DEBUG_H
23#define _COMMON_DEBUG_H
24
25#include <common/config.h>
Willy Tarreau18954282015-09-26 01:27:43 +020026#include <common/memory.h>
Willy Tarreau1d488b62006-12-16 19:54:02 +010027
28#ifdef DEBUG_FULL
Willy Tarreau8a68c242006-12-16 23:22:58 +010029#define DPRINTF(x...) fprintf(x)
Willy Tarreau1d488b62006-12-16 19:54:02 +010030#else
31#define DPRINTF(x...)
32#endif
33
Willy Tarreau8a68c242006-12-16 23:22:58 +010034#ifdef DEBUG_FSM
35#define FSM_PRINTF(x...) fprintf(x)
36#else
37#define FSM_PRINTF(x...)
38#endif
39
Willy Tarreauf8533202008-08-16 14:55:08 +020040/* This abort is more efficient than abort() because it does not mangle the
41 * stack and stops at the exact location we need.
42 */
Willy Tarreaua5e33a92019-05-14 17:22:28 +020043#define ABORT_NOW() (*(volatile int*)1=0)
Willy Tarreauf8533202008-08-16 14:55:08 +020044
Willy Tarreau469fa2c2019-05-14 17:27:52 +020045/* BUG_ON: complains if <cond> is true when DEBUG_STRICT or DEBUG_STRICT_NOCRASH
46 * are set, does nothing otherwise. With DEBUG_STRICT in addition it immediately
47 * crashes using ABORT_NOW() above.
48 */
49#if defined(DEBUG_STRICT) || defined(DEBUG_STRICT_NOCRASH)
50#if defined(DEBUG_STRICT)
51#define CRASH_NOW() ABORT_NOW()
52#else
53#define CRASH_NOW()
54#endif
55
56#define BUG_ON(cond) _BUG_ON(cond, __FILE__, __LINE__)
57#define _BUG_ON(cond, file, line) __BUG_ON(cond, file, line)
58#define __BUG_ON(cond, file, line) \
59 do { \
60 if (unlikely(cond)) { \
61 const char msg[] = "\nFATAL: bug condition \"" #cond "\" matched at " file ":" #line "\n"; \
Willy Tarreau15ed69f2020-03-14 10:58:35 +010062 DISGUISE(write(2, msg, strlen(msg))); \
Willy Tarreau469fa2c2019-05-14 17:27:52 +020063 CRASH_NOW(); \
64 } \
65 } while (0)
66#else
67#undef CRASH_NOW
68#define BUG_ON(cond)
69#endif
70
Willy Tarreau4e2b6462019-05-16 17:44:30 +020071struct task;
Willy Tarreau5cf64dd2019-05-17 10:36:08 +020072struct buffer;
Willy Tarreaua37cb182019-07-31 19:20:39 +020073extern volatile unsigned long threads_to_dump;
Willy Tarreau9b013702019-10-24 18:18:02 +020074extern unsigned int debug_commands_issued;
Willy Tarreau5cf64dd2019-05-17 10:36:08 +020075void ha_task_dump(struct buffer *buf, const struct task *task, const char *pfx);
76void ha_thread_dump(struct buffer *buf, int thr, int calling_tid);
Willy Tarreauc7091d82019-05-17 10:08:49 +020077void ha_thread_dump_all_to_trash();
Willy Tarreau56131ca2019-05-20 13:48:29 +020078void ha_panic();
Willy Tarreau4e2b6462019-05-16 17:44:30 +020079
Willy Tarreau18954282015-09-26 01:27:43 +020080/* This one is useful to automatically apply poisonning on an area returned
81 * by malloc(). Only "p_" is required to make it work, and to define a poison
82 * byte using -dM.
83 */
84static inline void *p_malloc(size_t size)
85{
86 void *ret = malloc(size);
Willy Tarreau067ac9f2015-10-08 14:12:13 +020087 if (mem_poison_byte >= 0 && ret)
Willy Tarreau18954282015-09-26 01:27:43 +020088 memset(ret, mem_poison_byte, size);
89 return ret;
90}
Willy Tarreau5c6f58f2008-06-13 22:36:31 +020091
Willy Tarreau1d488b62006-12-16 19:54:02 +010092#endif /* _COMMON_DEBUG_H */