Willy Tarreau | 4151c75 | 2019-08-08 18:21:26 +0200 | [diff] [blame] | 1 | /* |
| 2 | * include/proto/trace.h |
| 3 | * This file provides functions for runtime tracing |
| 4 | * |
| 5 | * Copyright (C) 2000-2019 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 _PROTO_TRACE_H |
| 23 | #define _PROTO_TRACE_H |
| 24 | |
| 25 | #include <common/buffer.h> |
| 26 | #include <common/compat.h> |
| 27 | #include <common/config.h> |
| 28 | #include <common/ist.h> |
| 29 | #include <common/mini-clist.h> |
| 30 | #include <types/log.h> |
| 31 | #include <types/sink.h> |
| 32 | #include <types/trace.h> |
| 33 | |
Willy Tarreau | 4ab2421 | 2019-08-12 17:27:09 +0200 | [diff] [blame] | 34 | /* Make a string from the location of the trace producer as "file:line" */ |
| 35 | #define TRC_LOC _TRC_LOC(__FILE__, __LINE__) |
| 36 | #define _TRC_LOC(f,l) __TRC_LOC(f, ":", l) |
| 37 | #define __TRC_LOC(f,c,l) f c #l |
| 38 | |
Willy Tarreau | c326ecc | 2019-08-28 10:35:16 +0200 | [diff] [blame^] | 39 | /* truncate a macro arg list to exactly 5 args and replace missing ones with NULL */ |
| 40 | #define TRC_5ARGS(a1,a2,a3,a4,a5,...) DEFNULL(a1),DEFNULL(a2),DEFNULL(a3),DEFNULL(a4),DEFNULL(a5) |
| 41 | |
Willy Tarreau | 4ab2421 | 2019-08-12 17:27:09 +0200 | [diff] [blame] | 42 | /* For convenience, TRACE() alone uses the file's default TRACE_LEVEL, most |
Willy Tarreau | c326ecc | 2019-08-28 10:35:16 +0200 | [diff] [blame^] | 43 | * likely TRACE_LEVEL_DEVELOPER, though the other explicit variants specify |
| 44 | * the desired level and will work when TRACE_LEVEL is not set. The 5 optional |
| 45 | * arguments are the 4 source-specific arguments that are passed to the cb() |
| 46 | * callback dedicated to decoding, and which may be used for special tracking. |
| 47 | * These 4 arguments as well as the cb() function pointer may all be NULL, or |
| 48 | * simply omitted (in which case they will be replaced by a NULL). This |
| 49 | * ordering allows many TRACE() calls to be placed using copy-paste and just |
| 50 | * change the message at the beginning. |
Willy Tarreau | 4ab2421 | 2019-08-12 17:27:09 +0200 | [diff] [blame] | 51 | */ |
Willy Tarreau | c326ecc | 2019-08-28 10:35:16 +0200 | [diff] [blame^] | 52 | #define TRACE(msg, mask, ...) \ |
| 53 | trace(TRACE_LEVEL, (mask), TRACE_SOURCE, ist(TRC_LOC), TRC_5ARGS(__VA_ARGS__,,,,,), ist(msg)) |
| 54 | |
| 55 | #define TRACE_USER(msg, mask, ...) \ |
| 56 | trace(TRACE_LEVEL_USER, (mask), TRACE_SOURCE, ist(TRC_LOC), TRC_5ARGS(__VA_ARGS__,,,,,), ist(msg)) |
Willy Tarreau | 4ab2421 | 2019-08-12 17:27:09 +0200 | [diff] [blame] | 57 | |
Willy Tarreau | c326ecc | 2019-08-28 10:35:16 +0200 | [diff] [blame^] | 58 | #define TRACE_PAYLOAD(msg, mask, ...) \ |
| 59 | trace(TRACE_LEVEL_PAYLOAD, (mask), TRACE_SOURCE, ist(TRC_LOC), TRC_5ARGS(__VA_ARGS__,,,,,), ist(msg)) |
| 60 | |
| 61 | #define TRACE_PROTO(msg, mask, ...) \ |
| 62 | trace(TRACE_LEVEL_PROTO, (mask), TRACE_SOURCE, ist(TRC_LOC), TRC_5ARGS(__VA_ARGS__,,,,,), ist(msg)) |
| 63 | |
| 64 | #define TRACE_STATE(msg, mask, ...) \ |
| 65 | trace(TRACE_LEVEL_STATE, (mask), TRACE_SOURCE, ist(TRC_LOC), TRC_5ARGS(__VA_ARGS__,,,,,), ist(msg)) |
Willy Tarreau | 4ab2421 | 2019-08-12 17:27:09 +0200 | [diff] [blame] | 66 | |
Willy Tarreau | c326ecc | 2019-08-28 10:35:16 +0200 | [diff] [blame^] | 67 | #define TRACE_DEVEL(msg, mask, ...) \ |
| 68 | trace(TRACE_LEVEL_DEVELOPER, (mask), TRACE_SOURCE, ist(TRC_LOC), TRC_5ARGS(__VA_ARGS__,,,,,), ist(msg)) |
Willy Tarreau | 4ab2421 | 2019-08-12 17:27:09 +0200 | [diff] [blame] | 69 | |
Willy Tarreau | 4151c75 | 2019-08-08 18:21:26 +0200 | [diff] [blame] | 70 | extern struct list trace_sources; |
Willy Tarreau | 88ebd40 | 2019-08-19 15:55:34 +0200 | [diff] [blame] | 71 | extern THREAD_LOCAL struct buffer trace_buf; |
Willy Tarreau | 4151c75 | 2019-08-08 18:21:26 +0200 | [diff] [blame] | 72 | |
Willy Tarreau | bfd14fc | 2019-08-19 16:28:07 +0200 | [diff] [blame] | 73 | void __trace(enum trace_level level, uint64_t mask, struct trace_source *src, const struct ist where, |
| 74 | const void *a1, const void *a2, const void *a3, const void *a4, |
| 75 | void (*cb)(enum trace_level level, uint64_t mask, const struct trace_source *src, const struct ist where, |
| 76 | const void *a1, const void *a2, const void *a3, const void *a4), |
| 77 | const struct ist msg); |
Willy Tarreau | 4c2ae48 | 2019-08-12 15:51:58 +0200 | [diff] [blame] | 78 | |
Willy Tarreau | 864e880 | 2019-08-08 18:48:12 +0200 | [diff] [blame] | 79 | /* return a single char to describe a trace state */ |
| 80 | static inline char trace_state_char(enum trace_state st) |
| 81 | { |
| 82 | return (st == TRACE_STATE_RUNNING) ? 'R' : |
| 83 | (st == TRACE_STATE_WAITING) ? 'w' : |
| 84 | '.'; |
| 85 | } |
| 86 | |
| 87 | /* return a single char to describe an event state */ |
| 88 | static inline char trace_event_char(uint64_t conf, uint64_t ev) |
| 89 | { |
| 90 | return (conf & ev) ? '+' : '-'; |
| 91 | } |
| 92 | |
Willy Tarreau | 4151c75 | 2019-08-08 18:21:26 +0200 | [diff] [blame] | 93 | /* registers trace source <source>. Modifies the list element! |
| 94 | * The {start,pause,stop,report} events are not changed so the source may |
| 95 | * preset them. |
| 96 | */ |
| 97 | static inline void trace_register_source(struct trace_source *source) |
| 98 | { |
| 99 | source->lockon = TRACE_LOCKON_NOTHING; |
| 100 | source->level = TRACE_LEVEL_USER; |
| 101 | source->detail_level = LOG_NOTICE; |
| 102 | source->sink = NULL; |
| 103 | source->state = TRACE_STATE_STOPPED; |
| 104 | source->lockon_ptr = NULL; |
| 105 | LIST_ADDQ(&trace_sources, &source->source_link); |
| 106 | } |
| 107 | |
Willy Tarreau | 4c2ae48 | 2019-08-12 15:51:58 +0200 | [diff] [blame] | 108 | /* sends a trace for the given source */ |
Willy Tarreau | bfd14fc | 2019-08-19 16:28:07 +0200 | [diff] [blame] | 109 | static inline void trace(enum trace_level level, uint64_t mask, struct trace_source *src, const struct ist where, |
| 110 | const void *a1, const void *a2, const void *a3, const void *a4, |
| 111 | void (*cb)(enum trace_level level, uint64_t mask, const struct trace_source *src, const struct ist where, |
| 112 | const void *a1, const void *a2, const void *a3, const void *a4), |
| 113 | const struct ist msg) |
Willy Tarreau | 4c2ae48 | 2019-08-12 15:51:58 +0200 | [diff] [blame] | 114 | { |
| 115 | if (unlikely(src->state != TRACE_STATE_STOPPED)) |
Willy Tarreau | bfd14fc | 2019-08-19 16:28:07 +0200 | [diff] [blame] | 116 | __trace(level, mask, src, where, a1, a2, a3, a4, cb, msg); |
Willy Tarreau | 4c2ae48 | 2019-08-12 15:51:58 +0200 | [diff] [blame] | 117 | } |
| 118 | |
Willy Tarreau | 4151c75 | 2019-08-08 18:21:26 +0200 | [diff] [blame] | 119 | #endif /* _PROTO_TRACE_H */ |
| 120 | |
| 121 | /* |
| 122 | * Local variables: |
| 123 | * c-indent-level: 8 |
| 124 | * c-basic-offset: 8 |
| 125 | * End: |
| 126 | */ |