RepoMirrors
/
haproxy
mirror of http://git.haproxy.org/git/haproxy.git/
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
haproxy/include/common/debug.h

71 lines
2.1 KiB
C
Raw Normal View History

[MINOR] added include/common/debug.h This file will provide debugging macros such as DPRINTF.
2006-12-16 18:54:02 +00:00
/*
include/common/debug.h
This files contains some macros to help debugging.
Copyright (C) 2000-2006 Willy Tarreau - w@1wt.eu
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation, version 2.1
exclusively.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef _COMMON_DEBUG_H
#define _COMMON_DEBUG_H
#include <common/config.h>
DEBUG: add p_malloc() to return a poisonned memory area This one is useful to detect improperly initialized memory areas when some suspicious malloc() are involved in random behaviours.
2015-09-25 23:27:43 +00:00
#include <common/memory.h>
[MINOR] added include/common/debug.h This file will provide debugging macros such as DPRINTF.
2006-12-16 18:54:02 +00:00
#ifdef DEBUG_FULL
[BUILD] debug.h had a typo. Also add FSM_PRINTF to debug FSM only.
2006-12-16 22:22:58 +00:00
#define DPRINTF(x...) fprintf(x)
[MINOR] added include/common/debug.h This file will provide debugging macros such as DPRINTF.
2006-12-16 18:54:02 +00:00
#else
#define DPRINTF(x...)
#endif
[BUILD] debug.h had a typo. Also add FSM_PRINTF to debug FSM only.
2006-12-16 22:22:58 +00:00
#ifdef DEBUG_FSM
#define FSM_PRINTF(x...) fprintf(x)
#else
#define FSM_PRINTF(x...)
#endif
[MINOR] term_trace: add better instrumentations to trace the code A new member has been added to the struct session. It keeps a trace of what block of code performs a close or a shutdown on a socket, and in what sequence. This is extremely convenient for post-mortem analysis where flag combinations and states seem impossible. A new ABORT_NOW() macro has also been added to make the code immediately segfault where called.
2008-08-16 12:55:08 +00:00
/* This abort is more efficient than abort() because it does not mangle the
* stack and stops at the exact location we need.
*/
MINOR: debug: make the ABORT_NOW macro use a volatile int Similar to previous commit, let's make the macro use a volatile when dereferencing NULL so that clang doesn't optimize it away.
2018-12-16 07:17:23 +00:00
#define ABORT_NOW() (*(volatile int*)0=0)
[MINOR] term_trace: add better instrumentations to trace the code A new member has been added to the struct session. It keeps a trace of what block of code performs a close or a shutdown on a socket, and in what sequence. This is extremely convenient for post-mortem analysis where flag combinations and states seem impossible. A new ABORT_NOW() macro has also been added to make the code immediately segfault where called.
2008-08-16 12:55:08 +00:00
[DEBUG] add a TRACE macro to facilitate runtime data extraction The new TRACE macro is used almost like fprintf, except that a session has to be passed instead of the file descriptor. It displays infos about where it is called, session ptr and id, etc...
2008-06-13 20:36:31 +00:00
/* this one is provided for easy code tracing.
REORG/MAJOR: session: rename the "session" entity to "stream" With HTTP/2, we'll have to support multiplexed streams. A stream is in fact the largest part of what we currently call a session, it has buffers, logs, etc. In order to catch any error, this commit removes any reference to the struct session and tries to rename most "session" occurrences in function names to "stream" and "sess" to "strm" when that's related to a session. The files stream.{c,h} were added and session.{c,h} removed. The session will be reintroduced later and a few parts of the stream will progressively be moved overthere. It will more or less contain only what we need in an embryonic session. Sample fetch functions and converters will have to change a bit so that they'll use an L5 (session) instead of what's currently called "L4" which is in fact L6 for now. Once all changes are completed, we should see approximately this : L7 - http_txn L6 - stream L5 - session L4 - connection | applet There will be at most one http_txn per stream, and a same session will possibly be referenced by multiple streams. A connection will point to a session and to a stream. The session will hold all the information we need to keep even when we don't yet have a stream. Some more cleanup is needed because some code was already far from being clean. The server queue management still refers to sessions at many places while comments talk about connections. This will have to be cleaned up once we have a server-side connection pool manager. Stream flags "SN_*" still need to be renamed, it doesn't seem like any of them will need to move to the session.
2015-04-02 22:22:06 +00:00
* Usage: TRACE(strm||0, fmt, args...);
* TRACE(strm, "");
[DEBUG] add a TRACE macro to facilitate runtime data extraction The new TRACE macro is used almost like fprintf, except that a session has to be passed instead of the file descriptor. It displays infos about where it is called, session ptr and id, etc...
2008-06-13 20:36:31 +00:00
*/
REORG/MAJOR: session: rename the "session" entity to "stream" With HTTP/2, we'll have to support multiplexed streams. A stream is in fact the largest part of what we currently call a session, it has buffers, logs, etc. In order to catch any error, this commit removes any reference to the struct session and tries to rename most "session" occurrences in function names to "stream" and "sess" to "strm" when that's related to a session. The files stream.{c,h} were added and session.{c,h} removed. The session will be reintroduced later and a few parts of the stream will progressively be moved overthere. It will more or less contain only what we need in an embryonic session. Sample fetch functions and converters will have to change a bit so that they'll use an L5 (session) instead of what's currently called "L4" which is in fact L6 for now. Once all changes are completed, we should see approximately this : L7 - http_txn L6 - stream L5 - session L4 - connection | applet There will be at most one http_txn per stream, and a same session will possibly be referenced by multiple streams. A connection will point to a session and to a stream. The session will hold all the information we need to keep even when we don't yet have a stream. Some more cleanup is needed because some code was already far from being clean. The server queue management still refers to sessions at many places while comments talk about connections. This will have to be cleaned up once we have a server-side connection pool manager. Stream flags "SN_*" still need to be renamed, it doesn't seem like any of them will need to move to the session.
2015-04-02 22:22:06 +00:00
#define TRACE(strm, fmt, args...) do { \
[DEBUG] add a TRACE macro to facilitate runtime data extraction The new TRACE macro is used almost like fprintf, except that a session has to be passed instead of the file descriptor. It displays infos about where it is called, session ptr and id, etc...
2008-06-13 20:36:31 +00:00
fprintf(stderr, \
REORG/MAJOR: session: rename the "session" entity to "stream" With HTTP/2, we'll have to support multiplexed streams. A stream is in fact the largest part of what we currently call a session, it has buffers, logs, etc. In order to catch any error, this commit removes any reference to the struct session and tries to rename most "session" occurrences in function names to "stream" and "sess" to "strm" when that's related to a session. The files stream.{c,h} were added and session.{c,h} removed. The session will be reintroduced later and a few parts of the stream will progressively be moved overthere. It will more or less contain only what we need in an embryonic session. Sample fetch functions and converters will have to change a bit so that they'll use an L5 (session) instead of what's currently called "L4" which is in fact L6 for now. Once all changes are completed, we should see approximately this : L7 - http_txn L6 - stream L5 - session L4 - connection | applet There will be at most one http_txn per stream, and a same session will possibly be referenced by multiple streams. A connection will point to a session and to a stream. The session will hold all the information we need to keep even when we don't yet have a stream. Some more cleanup is needed because some code was already far from being clean. The server queue management still refers to sessions at many places while comments talk about connections. This will have to be cleaned up once we have a server-side connection pool manager. Stream flags "SN_*" still need to be renamed, it doesn't seem like any of them will need to move to the session.
2015-04-02 22:22:06 +00:00
"%d.%06d [%s:%d %s] [strm %p(%x)] " fmt "\n", \
[DEBUG] add a TRACE macro to facilitate runtime data extraction The new TRACE macro is used almost like fprintf, except that a session has to be passed instead of the file descriptor. It displays infos about where it is called, session ptr and id, etc...
2008-06-13 20:36:31 +00:00
(int)now.tv_sec, (int)now.tv_usec, \
__FILE__, __LINE__, __FUNCTION__, \
REORG/MAJOR: session: rename the "session" entity to "stream" With HTTP/2, we'll have to support multiplexed streams. A stream is in fact the largest part of what we currently call a session, it has buffers, logs, etc. In order to catch any error, this commit removes any reference to the struct session and tries to rename most "session" occurrences in function names to "stream" and "sess" to "strm" when that's related to a session. The files stream.{c,h} were added and session.{c,h} removed. The session will be reintroduced later and a few parts of the stream will progressively be moved overthere. It will more or less contain only what we need in an embryonic session. Sample fetch functions and converters will have to change a bit so that they'll use an L5 (session) instead of what's currently called "L4" which is in fact L6 for now. Once all changes are completed, we should see approximately this : L7 - http_txn L6 - stream L5 - session L4 - connection | applet There will be at most one http_txn per stream, and a same session will possibly be referenced by multiple streams. A connection will point to a session and to a stream. The session will hold all the information we need to keep even when we don't yet have a stream. Some more cleanup is needed because some code was already far from being clean. The server queue management still refers to sessions at many places while comments talk about connections. This will have to be cleaned up once we have a server-side connection pool manager. Stream flags "SN_*" still need to be renamed, it doesn't seem like any of them will need to move to the session.
2015-04-02 22:22:06 +00:00
strm, strm?((struct stream *)strm)->uniq_id:~0U, \
[DEBUG] add a TRACE macro to facilitate runtime data extraction The new TRACE macro is used almost like fprintf, except that a session has to be passed instead of the file descriptor. It displays infos about where it is called, session ptr and id, etc...
2008-06-13 20:36:31 +00:00
##args); \
} while (0)
DEBUG: add p_malloc() to return a poisonned memory area This one is useful to detect improperly initialized memory areas when some suspicious malloc() are involved in random behaviours.
2015-09-25 23:27:43 +00:00
/* This one is useful to automatically apply poisonning on an area returned
* by malloc(). Only "p_" is required to make it work, and to define a poison
* byte using -dM.
*/
static inline void *p_malloc(size_t size)
{
void *ret = malloc(size);
MINOR: debug: enable memory poisonning to use byte 0 When debugging an issue, sometimes it can be useful to be able to use byte 0 to poison memory areas, resulting in the same effect as a calloc(). This patch changes the default mem_poison_byte to -1 to disable it so that all positive values are usable.
2015-10-08 12:12:13 +00:00
if (mem_poison_byte >= 0 && ret)
DEBUG: add p_malloc() to return a poisonned memory area This one is useful to detect improperly initialized memory areas when some suspicious malloc() are involved in random behaviours.
2015-09-25 23:27:43 +00:00
memset(ret, mem_poison_byte, size);
return ret;
}
[DEBUG] add a TRACE macro to facilitate runtime data extraction The new TRACE macro is used almost like fprintf, except that a session has to be passed instead of the file descriptor. It displays infos about where it is called, session ptr and id, etc...
2008-06-13 20:36:31 +00:00
[MINOR] added include/common/debug.h This file will provide debugging macros such as DPRINTF.
2006-12-16 18:54:02 +00:00
#endif /* _COMMON_DEBUG_H */