blob: 1c9f43b8684e5ef3bdf288a07220bfdfc484a0ea [file] [log] [blame]
Willy Tarreau4e2b6462019-05-16 17:44:30 +02001/*
2 * Process debugging functions.
3 *
4 * Copyright 2000-2019 Willy Tarreau <willy@haproxy.org>.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 *
11 */
12
Willy Tarreauf5b4e062020-03-03 15:40:23 +010013
Willy Tarreau5be7c192022-01-24 20:26:09 +010014#include <errno.h>
Willy Tarreau368bff42019-12-06 17:18:28 +010015#include <fcntl.h>
Willy Tarreau4e2b6462019-05-16 17:44:30 +020016#include <signal.h>
17#include <time.h>
18#include <stdio.h>
Willy Tarreau6bdf3e92019-05-20 14:25:05 +020019#include <stdlib.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020020#include <syslog.h>
Willy Tarreau5be7c192022-01-24 20:26:09 +010021#include <sys/stat.h>
Willy Tarreau368bff42019-12-06 17:18:28 +010022#include <sys/types.h>
23#include <sys/wait.h>
Willy Tarreau5be7c192022-01-24 20:26:09 +010024#include <unistd.h>
25#ifdef USE_EPOLL
26#include <sys/epoll.h>
27#endif
Willy Tarreau4e2b6462019-05-16 17:44:30 +020028
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020029#include <haproxy/api.h>
Christopher Faulet6b0a0fb2022-04-04 11:29:28 +020030#include <haproxy/applet.h>
Willy Tarreau8dabda72020-05-27 17:22:10 +020031#include <haproxy/buf.h>
Willy Tarreau83487a82020-06-04 20:19:54 +020032#include <haproxy/cli.h>
Willy Tarreau55542642021-10-08 09:33:24 +020033#include <haproxy/clock.h>
Willy Tarreau2a83d602020-05-27 16:58:08 +020034#include <haproxy/debug.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020035#include <haproxy/fd.h>
36#include <haproxy/global.h>
Willy Tarreau86416052020-06-04 09:20:54 +020037#include <haproxy/hlua.h>
Willy Tarreaub7fc4c42021-10-06 18:56:42 +020038#include <haproxy/http_ana.h>
Willy Tarreauaeed4a82020-06-04 22:01:04 +020039#include <haproxy/log.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020040#include <haproxy/net_helper.h>
Willy Tarreau5edca2f2022-05-27 09:25:10 +020041#include <haproxy/sc_strm.h>
Willy Tarreaucb086c62022-05-27 09:47:12 +020042#include <haproxy/stconn.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020043#include <haproxy/task.h>
Willy Tarreau3f567e42020-05-28 15:29:19 +020044#include <haproxy/thread.h>
Willy Tarreau55542642021-10-08 09:33:24 +020045#include <haproxy/time.h>
Willy Tarreau48fbcae2020-06-03 18:09:46 +020046#include <haproxy/tools.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020047#include <import/ist.h>
Willy Tarreau4e2b6462019-05-16 17:44:30 +020048
Willy Tarreau4e2b6462019-05-16 17:44:30 +020049
Willy Tarreauf0c86dd2022-07-15 13:14:03 +020050/* The dump state is made of:
51 * - num_thread on the lowest 15 bits
52 * - a SYNC flag on bit 15 (waiting for sync start)
53 * - number of participating threads on bits 16-30
54 * Initiating a dump consists in setting it to SYNC and incrementing the
55 * num_thread part when entering the function. The first thread periodically
56 * recounts active threads and compares it to the ready ones, and clears SYNC
57 * and sets the number of participants to the value found, which serves as a
58 * start signal. A thread finished dumping looks up the TID of the next active
59 * thread after it and writes it in the lowest part. If there's none, it sets
60 * the thread counter to the number of participants and resets that part,
61 * which serves as an end-of-dump signal. All threads decrement the num_thread
62 * part. Then all threads wait for the value to reach zero. Only used when
63 * USE_THREAD_DUMP is set.
Willy Tarreaua37cb182019-07-31 19:20:39 +020064 */
Willy Tarreauf0c86dd2022-07-15 13:14:03 +020065#define THREAD_DUMP_TMASK 0x00007FFFU
66#define THREAD_DUMP_FSYNC 0x00008000U
67#define THREAD_DUMP_PMASK 0x7FFF0000U
68
Willy Tarreau89ed89e2022-07-01 21:18:03 +020069volatile unsigned int thread_dump_state = 0;
Willy Tarreau55433f92022-07-15 12:48:58 +020070unsigned int panic_started = 0;
Willy Tarreau9b013702019-10-24 18:18:02 +020071unsigned int debug_commands_issued = 0;
Willy Tarreaua37cb182019-07-31 19:20:39 +020072
Willy Tarreau123fc972021-01-22 13:52:41 +010073/* dumps a backtrace of the current thread that is appended to buffer <buf>.
74 * Lines are prefixed with the string <prefix> which may be empty (used for
75 * indenting). It is recommended to use this at a function's tail so that
Willy Tarreau2bfce7e2021-01-22 14:48:34 +010076 * the function does not appear in the call stack. The <dump> argument
77 * indicates what dump state to start from, and should usually be zero. It
78 * may be among the following values:
79 * - 0: search usual callers before step 1, or directly jump to 2
80 * - 1: skip usual callers before step 2
81 * - 2: dump until polling loop, scheduler, or main() (excluded)
82 * - 3: end
83 * - 4-7: like 0 but stops *after* main.
Willy Tarreau123fc972021-01-22 13:52:41 +010084 */
Willy Tarreau2bfce7e2021-01-22 14:48:34 +010085void ha_dump_backtrace(struct buffer *buf, const char *prefix, int dump)
Willy Tarreau123fc972021-01-22 13:52:41 +010086{
87 struct buffer bak;
88 char pfx2[100];
89 void *callers[100];
90 int j, nptrs;
91 const void *addr;
Willy Tarreau123fc972021-01-22 13:52:41 +010092
93 nptrs = my_backtrace(callers, sizeof(callers)/sizeof(*callers));
94 if (!nptrs)
95 return;
96
97 if (snprintf(pfx2, sizeof(pfx2), "%s| ", prefix) > sizeof(pfx2))
98 pfx2[0] = 0;
99
100 /* The call backtrace_symbols_fd(callers, nptrs, STDOUT_FILENO would
101 * produce similar output to the following:
102 */
103 chunk_appendf(buf, "%scall trace(%d):\n", prefix, nptrs);
Willy Tarreau2bfce7e2021-01-22 14:48:34 +0100104 for (j = 0; (j < nptrs || (dump & 3) < 2); j++) {
105 if (j == nptrs && !(dump & 3)) {
Willy Tarreau123fc972021-01-22 13:52:41 +0100106 /* we failed to spot the starting point of the
107 * dump, let's start over dumping everything we
108 * have.
109 */
Willy Tarreau2bfce7e2021-01-22 14:48:34 +0100110 dump += 2;
Willy Tarreau123fc972021-01-22 13:52:41 +0100111 j = 0;
112 }
113 bak = *buf;
114 dump_addr_and_bytes(buf, pfx2, callers[j], 8);
115 addr = resolve_sym_name(buf, ": ", callers[j]);
Willy Tarreau2bfce7e2021-01-22 14:48:34 +0100116 if ((dump & 3) == 0) {
Willy Tarreau123fc972021-01-22 13:52:41 +0100117 /* dump not started, will start *after*
Willy Tarreaua8459b22021-01-22 14:12:27 +0100118 * ha_thread_dump_all_to_trash, ha_panic and ha_backtrace_to_stderr
Willy Tarreau123fc972021-01-22 13:52:41 +0100119 */
Willy Tarreaua8459b22021-01-22 14:12:27 +0100120 if (addr == ha_thread_dump_all_to_trash || addr == ha_panic ||
121 addr == ha_backtrace_to_stderr)
Willy Tarreau2bfce7e2021-01-22 14:48:34 +0100122 dump++;
Willy Tarreau123fc972021-01-22 13:52:41 +0100123 *buf = bak;
124 continue;
125 }
126
Willy Tarreau2bfce7e2021-01-22 14:48:34 +0100127 if ((dump & 3) == 1) {
Willy Tarreau123fc972021-01-22 13:52:41 +0100128 /* starting */
Willy Tarreaua8459b22021-01-22 14:12:27 +0100129 if (addr == ha_thread_dump_all_to_trash || addr == ha_panic ||
130 addr == ha_backtrace_to_stderr) {
Willy Tarreau123fc972021-01-22 13:52:41 +0100131 *buf = bak;
132 continue;
133 }
Willy Tarreau2bfce7e2021-01-22 14:48:34 +0100134 dump++;
Willy Tarreau123fc972021-01-22 13:52:41 +0100135 }
136
Willy Tarreau2bfce7e2021-01-22 14:48:34 +0100137 if ((dump & 3) == 2) {
138 /* still dumping */
139 if (dump == 6) {
140 /* we only stop *after* main and we must send the LF */
141 if (addr == main) {
142 j = nptrs;
143 dump++;
144 }
145 }
146 else if (addr == run_poll_loop || addr == main || addr == run_tasks_from_lists) {
147 dump++;
Willy Tarreau123fc972021-01-22 13:52:41 +0100148 *buf = bak;
149 break;
150 }
151 }
152 /* OK, line dumped */
153 chunk_appendf(buf, "\n");
154 }
155}
156
Willy Tarreaua8459b22021-01-22 14:12:27 +0100157/* dump a backtrace of current thread's stack to stderr. */
Willy Tarreau7831e022022-05-06 15:16:19 +0200158void ha_backtrace_to_stderr(void)
Willy Tarreaua8459b22021-01-22 14:12:27 +0100159{
160 char area[2048];
161 struct buffer b = b_make(area, sizeof(area), 0, 0);
162
Willy Tarreau2bfce7e2021-01-22 14:48:34 +0100163 ha_dump_backtrace(&b, " ", 4);
Willy Tarreaua8459b22021-01-22 14:12:27 +0100164 if (b.data)
Willy Tarreau2cbe2e72021-01-22 15:58:26 +0100165 DISGUISE(write(2, b.area, b.data));
Willy Tarreaua8459b22021-01-22 14:12:27 +0100166}
167
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200168/* Dumps to the buffer some known information for the desired thread, and
169 * optionally extra info for the current thread. The dump will be appended to
170 * the buffer, so the caller is responsible for preliminary initializing it.
171 * The calling thread ID needs to be passed in <calling_tid> to display a star
Willy Tarreaue6a02fa2019-05-22 07:06:44 +0200172 * in front of the calling thread's line (usually it's tid). Any stuck thread
173 * is also prefixed with a '>'.
Willy Tarreaubdcd3252022-06-22 09:19:46 +0200174 * It must be called under thread isolation.
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200175 */
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200176void ha_thread_dump(struct buffer *buf, int thr, int calling_tid)
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200177{
Willy Tarreau38d07122022-06-27 16:13:50 +0200178 unsigned long thr_bit = ha_thread_info[thr].ltid_bit;
Willy Tarreau45c38e22021-09-30 18:28:49 +0200179 unsigned long long p = ha_thread_ctx[thr].prev_cpu_time;
Willy Tarreau21694982021-10-08 15:09:17 +0200180 unsigned long long n = now_cpu_time_thread(thr);
Willy Tarreaua0b99532021-09-30 18:48:37 +0200181 int stuck = !!(ha_thread_ctx[thr].flags & TH_FL_STUCK);
Willy Tarreau03f9b352022-06-27 16:02:24 +0200182 int tgrp = ha_thread_info[thr].tgid;
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200183
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200184 chunk_appendf(buf,
Willy Tarreauf0e5da22020-05-01 12:26:03 +0200185 "%c%cThread %-2u: id=0x%llx act=%d glob=%d wq=%d rq=%d tl=%d tlsz=%d rqsz=%d\n"
Willy Tarreaua3870b72021-09-13 19:24:47 +0200186 " %2u/%-2u stuck=%d prof=%d",
Willy Tarreaue6a02fa2019-05-22 07:06:44 +0200187 (thr == calling_tid) ? '*' : ' ', stuck ? '>' : ' ', thr + 1,
Willy Tarreauff64d3b2020-05-01 11:28:49 +0200188 ha_get_pthread_id(thr),
Olivier Houchardcfbb3e62019-05-29 19:22:43 +0200189 thread_has_tasks(),
Willy Tarreauc958c702022-06-16 15:59:36 +0200190 !eb_is_empty(&ha_thread_ctx[thr].rqueue_shared),
Willy Tarreau1a9c9222021-10-01 11:30:33 +0200191 !eb_is_empty(&ha_thread_ctx[thr].timers),
192 !eb_is_empty(&ha_thread_ctx[thr].rqueue),
193 !(LIST_ISEMPTY(&ha_thread_ctx[thr].tasklets[TL_URGENT]) &&
194 LIST_ISEMPTY(&ha_thread_ctx[thr].tasklets[TL_NORMAL]) &&
195 LIST_ISEMPTY(&ha_thread_ctx[thr].tasklets[TL_BULK]) &&
196 MT_LIST_ISEMPTY(&ha_thread_ctx[thr].shared_tasklet_list)),
197 ha_thread_ctx[thr].tasks_in_list,
198 ha_thread_ctx[thr].rq_total,
Willy Tarreau66ad98a2022-06-28 10:49:57 +0200199 ha_thread_info[thr].tgid, ha_thread_info[thr].ltid + 1,
Willy Tarreaue6a02fa2019-05-22 07:06:44 +0200200 stuck,
Willy Tarreau680ed5f2022-06-13 15:59:39 +0200201 !!(th_ctx->flags & TH_FL_TASK_PROFILING));
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200202
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200203 chunk_appendf(buf,
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200204 " harmless=%d wantrdv=%d",
Willy Tarreau03f9b352022-06-27 16:02:24 +0200205 !!(_HA_ATOMIC_LOAD(&ha_tgroup_ctx[tgrp-1].threads_harmless) & thr_bit),
Willy Tarreau680ed5f2022-06-13 15:59:39 +0200206 !!(th_ctx->flags & TH_FL_TASK_PROFILING));
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200207
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200208 chunk_appendf(buf, "\n");
Willy Tarreau9c8800a2019-05-20 20:52:20 +0200209 chunk_appendf(buf, " cpu_ns: poll=%llu now=%llu diff=%llu\n", p, n, n-p);
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200210
Willy Tarreaua3870b72021-09-13 19:24:47 +0200211 /* this is the end of what we can dump from outside the current thread */
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200212
213 if (thr != tid)
214 return;
215
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200216 chunk_appendf(buf, " curr_task=");
Willy Tarreau1a9c9222021-10-01 11:30:33 +0200217 ha_task_dump(buf, th_ctx->current, " ");
Willy Tarreauf5b4e062020-03-03 15:40:23 +0100218
Willy Tarreauf5b4e062020-03-03 15:40:23 +0100219 if (stuck) {
220 /* We only emit the backtrace for stuck threads in order not to
221 * waste precious output buffer space with non-interesting data.
Willy Tarreau123fc972021-01-22 13:52:41 +0100222 * Please leave this as the last instruction in this function
223 * so that the compiler uses tail merging and the current
224 * function does not appear in the stack.
Willy Tarreauf5b4e062020-03-03 15:40:23 +0100225 */
Willy Tarreau2bfce7e2021-01-22 14:48:34 +0100226 ha_dump_backtrace(buf, " ", 0);
Willy Tarreauf5b4e062020-03-03 15:40:23 +0100227 }
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200228}
229
230
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200231/* dumps into the buffer some information related to task <task> (which may
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200232 * either be a task or a tasklet, and prepend each line except the first one
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200233 * with <pfx>. The buffer is only appended and the first output starts by the
234 * pointer itself. The caller is responsible for making sure the task is not
235 * going to vanish during the dump.
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200236 */
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200237void ha_task_dump(struct buffer *buf, const struct task *task, const char *pfx)
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200238{
Willy Tarreau578ea8b2019-05-22 09:43:09 +0200239 const struct stream *s = NULL;
Willy Tarreaua512b022019-08-21 14:12:19 +0200240 const struct appctx __maybe_unused *appctx = NULL;
Willy Tarreau78a7cb62019-08-21 14:16:02 +0200241 struct hlua __maybe_unused *hlua = NULL;
Willy Tarreau52f238d2022-07-15 12:08:40 +0200242 const struct stconn *sc;
Willy Tarreau578ea8b2019-05-22 09:43:09 +0200243
Willy Tarreau14a1ab72019-05-17 10:34:25 +0200244 if (!task) {
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200245 chunk_appendf(buf, "0\n");
Willy Tarreau231ec392019-05-17 10:39:47 +0200246 return;
247 }
248
Willy Tarreau20db9112019-05-17 14:14:35 +0200249 if (TASK_IS_TASKLET(task))
250 chunk_appendf(buf,
251 "%p (tasklet) calls=%u\n",
252 task,
253 task->calls);
254 else
255 chunk_appendf(buf,
256 "%p (task) calls=%u last=%llu%s\n",
257 task,
258 task->calls,
Willy Tarreau04e50b32022-09-07 14:49:50 +0200259 task->wake_date ? (unsigned long long)(now_mono_time() - task->wake_date) : 0,
260 task->wake_date ? " ns ago" : "");
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200261
Willy Tarreau2e89b092020-03-03 17:13:02 +0100262 chunk_appendf(buf, "%s fct=%p(", pfx, task->process);
263 resolve_sym_name(buf, NULL, task->process);
264 chunk_appendf(buf,") ctx=%p", task->context);
Willy Tarreau578ea8b2019-05-22 09:43:09 +0200265
Willy Tarreaua512b022019-08-21 14:12:19 +0200266 if (task->process == task_run_applet && (appctx = task->context))
267 chunk_appendf(buf, "(%s)\n", appctx->applet->name);
268 else
269 chunk_appendf(buf, "\n");
270
Willy Tarreau578ea8b2019-05-22 09:43:09 +0200271 if (task->process == process_stream && task->context)
272 s = (struct stream *)task->context;
Willy Tarreau52f238d2022-07-15 12:08:40 +0200273 else if (task->process == task_run_applet && task->context && (sc = appctx_sc((struct appctx *)task->context)))
274 s = sc_strm(sc);
Willy Tarreau462b9892022-05-18 18:06:53 +0200275 else if (task->process == sc_conn_io_cb && task->context)
Willy Tarreauea27f482022-05-18 16:10:52 +0200276 s = sc_strm(((struct stconn *)task->context));
Willy Tarreau578ea8b2019-05-22 09:43:09 +0200277
278 if (s)
279 stream_dump(buf, s, pfx, '\n');
Willy Tarreau78a7cb62019-08-21 14:16:02 +0200280
281#ifdef USE_LUA
282 hlua = NULL;
283 if (s && (hlua = s->hlua)) {
284 chunk_appendf(buf, "%sCurrent executing Lua from a stream analyser -- ", pfx);
285 }
286 else if (task->process == hlua_process_task && (hlua = task->context)) {
287 chunk_appendf(buf, "%sCurrent executing a Lua task -- ", pfx);
288 }
289 else if (task->process == task_run_applet && (appctx = task->context) &&
Willy Tarreaue23f33b2022-05-06 14:07:13 +0200290 (appctx->applet->fct == hlua_applet_tcp_fct)) {
Willy Tarreau78a7cb62019-08-21 14:16:02 +0200291 chunk_appendf(buf, "%sCurrent executing a Lua TCP service -- ", pfx);
292 }
293 else if (task->process == task_run_applet && (appctx = task->context) &&
Willy Tarreauaa229cc2022-05-06 14:26:10 +0200294 (appctx->applet->fct == hlua_applet_http_fct)) {
Willy Tarreau78a7cb62019-08-21 14:16:02 +0200295 chunk_appendf(buf, "%sCurrent executing a Lua HTTP service -- ", pfx);
296 }
297
Christopher Faulet471425f2020-07-24 19:08:05 +0200298 if (hlua && hlua->T) {
Christopher Fauletcc2c4f82021-03-24 14:52:24 +0100299 chunk_appendf(buf, "stack traceback:\n ");
300 append_prefixed_str(buf, hlua_traceback(hlua->T, "\n "), pfx, '\n', 0);
301 b_putchr(buf, '\n');
Willy Tarreau78a7cb62019-08-21 14:16:02 +0200302 }
Christopher Faulet471425f2020-07-24 19:08:05 +0200303 else
304 b_putchr(buf, '\n');
Willy Tarreau78a7cb62019-08-21 14:16:02 +0200305#endif
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200306}
307
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200308/* This function dumps all profiling settings. It returns 0 if the output
309 * buffer is full and it needs to be called again, otherwise non-zero.
310 */
311static int cli_io_handler_show_threads(struct appctx *appctx)
312{
Willy Tarreauc12b3212022-05-27 11:08:15 +0200313 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200314 int thr;
315
Willy Tarreau475e4632022-05-27 10:26:46 +0200316 if (unlikely(sc_ic(sc)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200317 return 1;
318
319 if (appctx->st0)
320 thr = appctx->st1;
321 else
322 thr = 0;
323
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200324 chunk_reset(&trash);
Willy Tarreauc7091d82019-05-17 10:08:49 +0200325 ha_thread_dump_all_to_trash();
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200326
Willy Tarreaud0a06d52022-05-18 15:07:19 +0200327 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200328 /* failed, try again */
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200329 appctx->st1 = thr;
330 return 0;
331 }
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200332 return 1;
333}
334
Willy Tarreau6ab7b212021-12-28 09:57:10 +0100335#if defined(HA_HAVE_DUMP_LIBS)
336/* parse a "show libs" command. It returns 1 if it emits anything otherwise zero. */
337static int debug_parse_cli_show_libs(char **args, char *payload, struct appctx *appctx, void *private)
338{
339 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
340 return 1;
341
342 chunk_reset(&trash);
343 if (dump_libs(&trash, 1))
344 return cli_msg(appctx, LOG_INFO, trash.area);
345 else
346 return 0;
347}
348#endif
349
Willy Tarreau56131ca2019-05-20 13:48:29 +0200350/* dumps a state of all threads into the trash and on fd #2, then aborts. */
351void ha_panic()
352{
Willy Tarreau55433f92022-07-15 12:48:58 +0200353 if (HA_ATOMIC_FETCH_ADD(&panic_started, 1) != 0) {
354 /* a panic dump is already in progress, let's not disturb it,
355 * we'll be called via signal DEBUGSIG. By returning we may be
356 * able to leave a current signal handler (e.g. WDT) so that
357 * this will ensure more reliable signal delivery.
358 */
359 return;
360 }
Willy Tarreau56131ca2019-05-20 13:48:29 +0200361 chunk_reset(&trash);
Willy Tarreaua9f9fc92019-05-20 17:45:35 +0200362 chunk_appendf(&trash, "Thread %u is about to kill the process.\n", tid + 1);
Willy Tarreau56131ca2019-05-20 13:48:29 +0200363 ha_thread_dump_all_to_trash();
Willy Tarreau2e8ab6b2020-03-14 11:03:20 +0100364 DISGUISE(write(2, trash.area, trash.data));
Willy Tarreau56131ca2019-05-20 13:48:29 +0200365 for (;;)
366 abort();
367}
368
Willy Tarreau06e66c82022-03-02 15:52:03 +0100369/* Complain with message <msg> on stderr. If <counter> is not NULL, it is
370 * atomically incremented, and the message is only printed when the counter
371 * was zero, so that the message is only printed once. <taint> is only checked
372 * on bit 1, and will taint the process either for a bug (2) or warn (0).
373 */
374void complain(int *counter, const char *msg, int taint)
375{
376 if (counter && _HA_ATOMIC_FETCH_ADD(counter, 1))
377 return;
378 DISGUISE(write(2, msg, strlen(msg)));
379 if (taint & 2)
380 mark_tainted(TAINTED_BUG);
381 else
382 mark_tainted(TAINTED_WARN);
383}
384
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200385/* parse a "debug dev exit" command. It always returns 1, though it should never return. */
386static int debug_parse_cli_exit(char **args, char *payload, struct appctx *appctx, void *private)
387{
388 int code = atoi(args[3]);
389
390 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
391 return 1;
392
Willy Tarreau4781b152021-04-06 13:53:36 +0200393 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200394 exit(code);
395 return 1;
396}
397
Willy Tarreau5baf4fe2021-01-22 14:15:46 +0100398/* parse a "debug dev bug" command. It always returns 1, though it should never return.
399 * Note: we make sure not to make the function static so that it appears in the trace.
400 */
401int debug_parse_cli_bug(char **args, char *payload, struct appctx *appctx, void *private)
402{
403 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
404 return 1;
405
Willy Tarreau4781b152021-04-06 13:53:36 +0200406 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau5baf4fe2021-01-22 14:15:46 +0100407 BUG_ON(one > zero);
408 return 1;
409}
410
Willy Tarreau305cfbd2022-02-25 08:52:39 +0100411/* parse a "debug dev warn" command. It always returns 1.
412 * Note: we make sure not to make the function static so that it appears in the trace.
413 */
414int debug_parse_cli_warn(char **args, char *payload, struct appctx *appctx, void *private)
415{
416 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
417 return 1;
418
419 _HA_ATOMIC_INC(&debug_commands_issued);
420 WARN_ON(one > zero);
421 return 1;
422}
423
Willy Tarreau6d3f1e32022-02-28 11:51:23 +0100424/* parse a "debug dev check" command. It always returns 1.
Willy Tarreau4e0a8b12022-02-25 08:55:11 +0100425 * Note: we make sure not to make the function static so that it appears in the trace.
426 */
Willy Tarreau6d3f1e32022-02-28 11:51:23 +0100427int debug_parse_cli_check(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau4e0a8b12022-02-25 08:55:11 +0100428{
429 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
430 return 1;
431
432 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6d3f1e32022-02-28 11:51:23 +0100433 CHECK_IF(one > zero);
Willy Tarreau4e0a8b12022-02-25 08:55:11 +0100434 return 1;
435}
436
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200437/* parse a "debug dev close" command. It always returns 1. */
438static int debug_parse_cli_close(char **args, char *payload, struct appctx *appctx, void *private)
439{
440 int fd;
441
442 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
443 return 1;
444
Willy Tarreau9d008692019-08-09 11:21:01 +0200445 if (!*args[3])
446 return cli_err(appctx, "Missing file descriptor number.\n");
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200447
448 fd = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +0200449 if (fd < 0 || fd >= global.maxsock)
450 return cli_err(appctx, "File descriptor out of range.\n");
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200451
Willy Tarreau9d008692019-08-09 11:21:01 +0200452 if (!fdtab[fd].owner)
453 return cli_msg(appctx, LOG_INFO, "File descriptor was already closed.\n");
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200454
Willy Tarreau4781b152021-04-06 13:53:36 +0200455 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200456 fd_delete(fd);
457 return 1;
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200458}
459
Willy Tarreaudadf00e2022-07-15 08:25:03 +0200460/* this is meant to cause a deadlock when more than one task is running it or when run twice */
461static struct task *debug_run_cli_deadlock(struct task *task, void *ctx, unsigned int state)
462{
463 static HA_SPINLOCK_T lock __maybe_unused;
464
465 HA_SPIN_LOCK(OTHER_LOCK, &lock);
466 return NULL;
467}
468
469/* parse a "debug dev deadlock" command. It always returns 1. */
470static int debug_parse_cli_deadlock(char **args, char *payload, struct appctx *appctx, void *private)
471{
472 int tasks;
473
474 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
475 return 1;
476
477 _HA_ATOMIC_INC(&debug_commands_issued);
478 for (tasks = atoi(args[3]); tasks > 0; tasks--) {
479 struct task *t = task_new_on(tasks % global.nbthread);
480 if (!t)
481 continue;
482 t->process = debug_run_cli_deadlock;
483 t->context = NULL;
484 task_wakeup(t, TASK_WOKEN_INIT);
485 }
486
487 return 1;
488}
489
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200490/* parse a "debug dev delay" command. It always returns 1. */
491static int debug_parse_cli_delay(char **args, char *payload, struct appctx *appctx, void *private)
492{
493 int delay = atoi(args[3]);
494
495 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
496 return 1;
497
Willy Tarreau4781b152021-04-06 13:53:36 +0200498 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200499 usleep((long)delay * 1000);
500 return 1;
501}
502
503/* parse a "debug dev log" command. It always returns 1. */
504static int debug_parse_cli_log(char **args, char *payload, struct appctx *appctx, void *private)
505{
506 int arg;
507
508 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
509 return 1;
510
Willy Tarreau4781b152021-04-06 13:53:36 +0200511 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200512 chunk_reset(&trash);
513 for (arg = 3; *args[arg]; arg++) {
514 if (arg > 3)
515 chunk_strcat(&trash, " ");
516 chunk_strcat(&trash, args[arg]);
517 }
518
519 send_log(NULL, LOG_INFO, "%s\n", trash.area);
520 return 1;
521}
522
523/* parse a "debug dev loop" command. It always returns 1. */
524static int debug_parse_cli_loop(char **args, char *payload, struct appctx *appctx, void *private)
525{
526 struct timeval deadline, curr;
527 int loop = atoi(args[3]);
528
529 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
530 return 1;
531
Willy Tarreau4781b152021-04-06 13:53:36 +0200532 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200533 gettimeofday(&curr, NULL);
534 tv_ms_add(&deadline, &curr, loop);
535
536 while (tv_ms_cmp(&curr, &deadline) < 0)
537 gettimeofday(&curr, NULL);
538
539 return 1;
540}
541
542/* parse a "debug dev panic" command. It always returns 1, though it should never return. */
543static int debug_parse_cli_panic(char **args, char *payload, struct appctx *appctx, void *private)
544{
545 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
546 return 1;
547
Willy Tarreau4781b152021-04-06 13:53:36 +0200548 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200549 ha_panic();
550 return 1;
551}
552
553/* parse a "debug dev exec" command. It always returns 1. */
Willy Tarreaub24ab222019-10-24 18:03:39 +0200554#if defined(DEBUG_DEV)
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200555static int debug_parse_cli_exec(char **args, char *payload, struct appctx *appctx, void *private)
556{
Willy Tarreau368bff42019-12-06 17:18:28 +0100557 int pipefd[2];
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200558 int arg;
Willy Tarreau368bff42019-12-06 17:18:28 +0100559 int pid;
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200560
561 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
562 return 1;
563
Willy Tarreau4781b152021-04-06 13:53:36 +0200564 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200565 chunk_reset(&trash);
566 for (arg = 3; *args[arg]; arg++) {
567 if (arg > 3)
568 chunk_strcat(&trash, " ");
569 chunk_strcat(&trash, args[arg]);
570 }
571
Willy Tarreau368bff42019-12-06 17:18:28 +0100572 thread_isolate();
573 if (pipe(pipefd) < 0)
574 goto fail_pipe;
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200575
Willy Tarreau38247432022-04-26 10:24:14 +0200576 if (fd_set_cloexec(pipefd[0]) == -1)
Willy Tarreau368bff42019-12-06 17:18:28 +0100577 goto fail_fcntl;
578
Willy Tarreau38247432022-04-26 10:24:14 +0200579 if (fd_set_cloexec(pipefd[1]) == -1)
Willy Tarreau368bff42019-12-06 17:18:28 +0100580 goto fail_fcntl;
581
582 pid = fork();
583
584 if (pid < 0)
585 goto fail_fork;
586 else if (pid == 0) {
587 /* child */
588 char *cmd[4] = { "/bin/sh", "-c", 0, 0 };
589
590 close(0);
591 dup2(pipefd[1], 1);
592 dup2(pipefd[1], 2);
593
594 cmd[2] = trash.area;
595 execvp(cmd[0], cmd);
596 printf("execvp() failed\n");
597 exit(1);
598 }
599
600 /* parent */
601 thread_release();
602 close(pipefd[1]);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200603 chunk_reset(&trash);
604 while (1) {
Willy Tarreau368bff42019-12-06 17:18:28 +0100605 size_t ret = read(pipefd[0], trash.area + trash.data, trash.size - 20 - trash.data);
606 if (ret <= 0)
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200607 break;
608 trash.data += ret;
609 if (trash.data + 20 == trash.size) {
610 chunk_strcat(&trash, "\n[[[TRUNCATED]]]\n");
611 break;
612 }
613 }
Willy Tarreau368bff42019-12-06 17:18:28 +0100614 close(pipefd[0]);
615 waitpid(pid, NULL, WNOHANG);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200616 trash.area[trash.data] = 0;
Willy Tarreau9d008692019-08-09 11:21:01 +0200617 return cli_msg(appctx, LOG_INFO, trash.area);
Willy Tarreau368bff42019-12-06 17:18:28 +0100618
619 fail_fork:
620 fail_fcntl:
621 close(pipefd[0]);
622 close(pipefd[1]);
623 fail_pipe:
624 thread_release();
625 return cli_err(appctx, "Failed to execute command.\n");
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200626}
Willy Tarreaub24ab222019-10-24 18:03:39 +0200627#endif
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200628
629/* parse a "debug dev hex" command. It always returns 1. */
630static int debug_parse_cli_hex(char **args, char *payload, struct appctx *appctx, void *private)
631{
632 unsigned long start, len;
633
634 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
635 return 1;
636
Willy Tarreau9d008692019-08-09 11:21:01 +0200637 if (!*args[3])
638 return cli_err(appctx, "Missing memory address to dump from.\n");
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200639
640 start = strtoul(args[3], NULL, 0);
Willy Tarreau9d008692019-08-09 11:21:01 +0200641 if (!start)
642 return cli_err(appctx, "Will not dump from NULL address.\n");
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200643
Willy Tarreau4781b152021-04-06 13:53:36 +0200644 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau9b013702019-10-24 18:18:02 +0200645
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200646 /* by default, dump ~128 till next block of 16 */
647 len = strtoul(args[4], NULL, 0);
648 if (!len)
649 len = ((start + 128) & -16) - start;
650
651 chunk_reset(&trash);
Willy Tarreau37101052019-05-20 16:48:20 +0200652 dump_hex(&trash, " ", (const void *)start, len, 1);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200653 trash.area[trash.data] = 0;
Willy Tarreau9d008692019-08-09 11:21:01 +0200654 return cli_msg(appctx, LOG_INFO, trash.area);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200655}
656
Willy Tarreau48129be2021-05-04 18:40:50 +0200657/* parse a "debug dev sym <addr>" command. It always returns 1. */
658static int debug_parse_cli_sym(char **args, char *payload, struct appctx *appctx, void *private)
659{
660 unsigned long addr;
661
662 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
663 return 1;
664
665 if (!*args[3])
666 return cli_err(appctx, "Missing memory address to be resolved.\n");
667
668 _HA_ATOMIC_INC(&debug_commands_issued);
669
670 addr = strtoul(args[3], NULL, 0);
671 chunk_printf(&trash, "%#lx resolves to ", addr);
672 resolve_sym_name(&trash, NULL, (const void *)addr);
673 chunk_appendf(&trash, "\n");
674
675 return cli_msg(appctx, LOG_INFO, trash.area);
676}
677
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200678/* parse a "debug dev tkill" command. It always returns 1. */
679static int debug_parse_cli_tkill(char **args, char *payload, struct appctx *appctx, void *private)
680{
681 int thr = 0;
682 int sig = SIGABRT;
683
684 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
685 return 1;
686
687 if (*args[3])
688 thr = atoi(args[3]);
689
Willy Tarreau9d008692019-08-09 11:21:01 +0200690 if (thr < 0 || thr > global.nbthread)
691 return cli_err(appctx, "Thread number out of range (use 0 for current).\n");
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200692
693 if (*args[4])
694 sig = atoi(args[4]);
695
Willy Tarreau4781b152021-04-06 13:53:36 +0200696 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200697 if (thr)
Willy Tarreaufade80d2019-05-22 08:46:59 +0200698 ha_tkill(thr - 1, sig);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200699 else
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200700 raise(sig);
701 return 1;
702}
703
Erwan Le Goas54966df2022-09-14 17:24:22 +0200704/* hashes 'word' in "debug dev hash 'word' ". */
705static int debug_parse_cli_hash(char **args, char *payload, struct appctx *appctx, void *private)
706{
707 char *msg = NULL;
708
709 cli_dynmsg(appctx, LOG_INFO, memprintf(&msg, "%s\n", HA_ANON_CLI(args[3])));
710 return 1;
711}
712
Willy Tarreau6cbe62b2020-03-05 17:16:24 +0100713/* parse a "debug dev write" command. It always returns 1. */
714static int debug_parse_cli_write(char **args, char *payload, struct appctx *appctx, void *private)
715{
716 unsigned long len;
717
718 if (!*args[3])
719 return cli_err(appctx, "Missing output size.\n");
720
721 len = strtoul(args[3], NULL, 0);
722 if (len >= trash.size)
723 return cli_err(appctx, "Output too large, must be <tune.bufsize.\n");
724
Willy Tarreau4781b152021-04-06 13:53:36 +0200725 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6cbe62b2020-03-05 17:16:24 +0100726
727 chunk_reset(&trash);
728 trash.data = len;
729 memset(trash.area, '.', trash.data);
730 trash.area[trash.data] = 0;
731 for (len = 64; len < trash.data; len += 64)
732 trash.area[len] = '\n';
733 return cli_msg(appctx, LOG_INFO, trash.area);
734}
735
Willy Tarreau68680bb2019-10-23 17:23:25 +0200736/* parse a "debug dev stream" command */
737/*
738 * debug dev stream [strm=<ptr>] [strm.f[{+-=}<flags>]] [txn.f[{+-=}<flags>]] \
739 * [req.f[{+-=}<flags>]] [res.f[{+-=}<flags>]] \
740 * [sif.f[{+-=<flags>]] [sib.f[{+-=<flags>]] \
741 * [sif.s[=<state>]] [sib.s[=<state>]]
742 */
743static int debug_parse_cli_stream(char **args, char *payload, struct appctx *appctx, void *private)
744{
Willy Tarreau0698c802022-05-11 14:09:57 +0200745 struct stream *s = appctx_strm(appctx);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200746 int arg;
747 void *ptr;
748 int size;
749 const char *word, *end;
750 struct ist name;
751 char *msg = NULL;
752 char *endarg;
753 unsigned long long old, new;
754
755 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
756 return 1;
757
758 ptr = NULL; size = 0;
759
760 if (!*args[3]) {
761 return cli_err(appctx,
762 "Usage: debug dev stream { <obj> <op> <value> | wake }*\n"
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +0200763 " <obj> = {strm | strm.f | strm.x | scf.s | scb.s |\n"
Willy Tarreau68680bb2019-10-23 17:23:25 +0200764 " txn.f | req.f | req.r | req.w | res.f | res.r | res.w}\n"
765 " <op> = {'' (show) | '=' (assign) | '^' (xor) | '+' (or) | '-' (andnot)}\n"
766 " <value> = 'now' | 64-bit dec/hex integer (0x prefix supported)\n"
767 " 'wake' wakes the stream asssigned to 'strm' (default: current)\n"
768 );
769 }
770
Willy Tarreau4781b152021-04-06 13:53:36 +0200771 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200772 for (arg = 3; *args[arg]; arg++) {
773 old = 0;
774 end = word = args[arg];
775 while (*end && *end != '=' && *end != '^' && *end != '+' && *end != '-')
776 end++;
777 name = ist2(word, end - word);
778 if (isteq(name, ist("strm"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200779 ptr = (!s || !may_access(s)) ? NULL : &s; size = sizeof(s);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200780 } else if (isteq(name, ist("strm.f"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200781 ptr = (!s || !may_access(s)) ? NULL : &s->flags; size = sizeof(s->flags);
Christopher Fauletae024ce2022-03-29 19:02:31 +0200782 } else if (isteq(name, ist("strm.x"))) {
783 ptr = (!s || !may_access(s)) ? NULL : &s->conn_exp; size = sizeof(s->conn_exp);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200784 } else if (isteq(name, ist("txn.f"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200785 ptr = (!s || !may_access(s)) ? NULL : &s->txn->flags; size = sizeof(s->txn->flags);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200786 } else if (isteq(name, ist("req.f"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200787 ptr = (!s || !may_access(s)) ? NULL : &s->req.flags; size = sizeof(s->req.flags);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200788 } else if (isteq(name, ist("res.f"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200789 ptr = (!s || !may_access(s)) ? NULL : &s->res.flags; size = sizeof(s->res.flags);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200790 } else if (isteq(name, ist("req.r"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200791 ptr = (!s || !may_access(s)) ? NULL : &s->req.rex; size = sizeof(s->req.rex);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200792 } else if (isteq(name, ist("res.r"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200793 ptr = (!s || !may_access(s)) ? NULL : &s->res.rex; size = sizeof(s->res.rex);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200794 } else if (isteq(name, ist("req.w"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200795 ptr = (!s || !may_access(s)) ? NULL : &s->req.wex; size = sizeof(s->req.wex);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200796 } else if (isteq(name, ist("res.w"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200797 ptr = (!s || !may_access(s)) ? NULL : &s->res.wex; size = sizeof(s->res.wex);
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +0200798 } else if (isteq(name, ist("scf.s"))) {
799 ptr = (!s || !may_access(s)) ? NULL : &s->scf->state; size = sizeof(s->scf->state);
800 } else if (isteq(name, ist("scb.s"))) {
801 ptr = (!s || !may_access(s)) ? NULL : &s->scf->state; size = sizeof(s->scb->state);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200802 } else if (isteq(name, ist("wake"))) {
Willy Tarreau2b5520d2019-10-24 18:28:23 +0200803 if (s && may_access(s) && may_access((void *)s + sizeof(*s) - 1))
Willy Tarreau68680bb2019-10-23 17:23:25 +0200804 task_wakeup(s->task, TASK_WOKEN_TIMER|TASK_WOKEN_IO|TASK_WOKEN_MSG);
805 continue;
806 } else
807 return cli_dynerr(appctx, memprintf(&msg, "Unsupported field name: '%s'.\n", word));
808
809 /* read previous value */
Willy Tarreau2b5520d2019-10-24 18:28:23 +0200810 if ((s || ptr == &s) && ptr && may_access(ptr) && may_access(ptr + size - 1)) {
Willy Tarreau68680bb2019-10-23 17:23:25 +0200811 if (size == 8)
812 old = read_u64(ptr);
813 else if (size == 4)
814 old = read_u32(ptr);
815 else if (size == 2)
816 old = read_u16(ptr);
817 else
818 old = *(const uint8_t *)ptr;
Willy Tarreau2b5520d2019-10-24 18:28:23 +0200819 } else {
820 memprintf(&msg,
821 "%sSkipping inaccessible pointer %p for field '%.*s'.\n",
822 msg ? msg : "", ptr, (int)(end - word), word);
823 continue;
Willy Tarreau68680bb2019-10-23 17:23:25 +0200824 }
825
826 /* parse the new value . */
827 new = strtoll(end + 1, &endarg, 0);
828 if (end[1] && *endarg) {
829 if (strcmp(end + 1, "now") == 0)
830 new = now_ms;
831 else {
832 memprintf(&msg,
833 "%sIgnoring unparsable value '%s' for field '%.*s'.\n",
834 msg ? msg : "", end + 1, (int)(end - word), word);
835 continue;
836 }
837 }
838
839 switch (*end) {
840 case '\0': /* show */
841 memprintf(&msg, "%s%.*s=%#llx ", msg ? msg : "", (int)(end - word), word, old);
842 new = old; // do not change the value
843 break;
844
845 case '=': /* set */
846 break;
847
848 case '^': /* XOR */
849 new = old ^ new;
850 break;
851
852 case '+': /* OR */
853 new = old | new;
854 break;
855
856 case '-': /* AND NOT */
857 new = old & ~new;
858 break;
859
860 default:
861 break;
862 }
863
864 /* write the new value */
Willy Tarreau2b5520d2019-10-24 18:28:23 +0200865 if (new != old) {
Willy Tarreau68680bb2019-10-23 17:23:25 +0200866 if (size == 8)
867 write_u64(ptr, new);
868 else if (size == 4)
869 write_u32(ptr, new);
870 else if (size == 2)
871 write_u16(ptr, new);
872 else
873 *(uint8_t *)ptr = new;
874 }
875 }
876
877 if (msg && *msg)
878 return cli_dynmsg(appctx, LOG_INFO, msg);
879 return 1;
880}
881
Willy Tarreau144f84a2021-03-02 16:09:26 +0100882static struct task *debug_task_handler(struct task *t, void *ctx, unsigned int state)
Willy Tarreaua5a44792020-11-29 17:12:15 +0100883{
884 unsigned long *tctx = ctx; // [0] = #tasks, [1] = inter, [2+] = { tl | (tsk+1) }
885 unsigned long inter = tctx[1];
886 unsigned long rnd;
887
888 t->expire = tick_add(now_ms, inter);
889
890 /* half of the calls will wake up another entry */
Willy Tarreau06e69b52021-03-02 14:01:35 +0100891 rnd = statistical_prng();
Willy Tarreaua5a44792020-11-29 17:12:15 +0100892 if (rnd & 1) {
893 rnd >>= 1;
894 rnd %= tctx[0];
895 rnd = tctx[rnd + 2];
896
897 if (rnd & 1)
898 task_wakeup((struct task *)(rnd - 1), TASK_WOKEN_MSG);
899 else
900 tasklet_wakeup((struct tasklet *)rnd);
901 }
902 return t;
903}
904
Willy Tarreau144f84a2021-03-02 16:09:26 +0100905static struct task *debug_tasklet_handler(struct task *t, void *ctx, unsigned int state)
Willy Tarreaua5a44792020-11-29 17:12:15 +0100906{
907 unsigned long *tctx = ctx; // [0] = #tasks, [1] = inter, [2+] = { tl | (tsk+1) }
908 unsigned long rnd;
909 int i;
910
911 /* wake up two random entries */
912 for (i = 0; i < 2; i++) {
Willy Tarreau06e69b52021-03-02 14:01:35 +0100913 rnd = statistical_prng() % tctx[0];
Willy Tarreaua5a44792020-11-29 17:12:15 +0100914 rnd = tctx[rnd + 2];
915
916 if (rnd & 1)
917 task_wakeup((struct task *)(rnd - 1), TASK_WOKEN_MSG);
918 else
919 tasklet_wakeup((struct tasklet *)rnd);
920 }
921 return t;
922}
923
924/* parse a "debug dev sched" command
925 * debug dev sched {task|tasklet} [count=<count>] [mask=<mask>] [single=<single>] [inter=<inter>]
926 */
927static int debug_parse_cli_sched(char **args, char *payload, struct appctx *appctx, void *private)
928{
929 int arg;
930 void *ptr;
931 int size;
932 const char *word, *end;
933 struct ist name;
934 char *msg = NULL;
935 char *endarg;
936 unsigned long long new;
937 unsigned long count = 0;
Willy Tarreau8e5c53a2022-06-15 16:32:41 +0200938 unsigned long thrid = tid;
Willy Tarreaua5a44792020-11-29 17:12:15 +0100939 unsigned int inter = 0;
Willy Tarreaua5a44792020-11-29 17:12:15 +0100940 unsigned long i;
941 int mode = 0; // 0 = tasklet; 1 = task
Willy Tarreaua5a44792020-11-29 17:12:15 +0100942 unsigned long *tctx; // [0] = #tasks, [1] = inter, [2+] = { tl | (tsk+1) }
943
944 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
945 return 1;
946
947 ptr = NULL; size = 0;
Willy Tarreaua5a44792020-11-29 17:12:15 +0100948
949 if (strcmp(args[3], "task") != 0 && strcmp(args[3], "tasklet") != 0) {
950 return cli_err(appctx,
951 "Usage: debug dev sched {task|tasklet} { <obj> = <value> }*\n"
Willy Tarreau8e5c53a2022-06-15 16:32:41 +0200952 " <obj> = {count | tid | inter }\n"
Willy Tarreaua5a44792020-11-29 17:12:15 +0100953 " <value> = 64-bit dec/hex integer (0x prefix supported)\n"
954 );
955 }
956
957 mode = strcmp(args[3], "task") == 0;
958
Willy Tarreau4781b152021-04-06 13:53:36 +0200959 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreaua5a44792020-11-29 17:12:15 +0100960 for (arg = 4; *args[arg]; arg++) {
961 end = word = args[arg];
962 while (*end && *end != '=' && *end != '^' && *end != '+' && *end != '-')
963 end++;
964 name = ist2(word, end - word);
965 if (isteq(name, ist("count"))) {
966 ptr = &count; size = sizeof(count);
Willy Tarreaua5a44792020-11-29 17:12:15 +0100967 } else if (isteq(name, ist("tid"))) {
968 ptr = &thrid; size = sizeof(thrid);
969 } else if (isteq(name, ist("inter"))) {
970 ptr = &inter; size = sizeof(inter);
Willy Tarreaua5a44792020-11-29 17:12:15 +0100971 } else
972 return cli_dynerr(appctx, memprintf(&msg, "Unsupported setting: '%s'.\n", word));
973
974 /* parse the new value . */
975 new = strtoll(end + 1, &endarg, 0);
976 if (end[1] && *endarg) {
977 memprintf(&msg,
978 "%sIgnoring unparsable value '%s' for field '%.*s'.\n",
979 msg ? msg : "", end + 1, (int)(end - word), word);
980 continue;
981 }
982
983 /* write the new value */
984 if (size == 8)
985 write_u64(ptr, new);
986 else if (size == 4)
987 write_u32(ptr, new);
988 else if (size == 2)
989 write_u16(ptr, new);
990 else
991 *(uint8_t *)ptr = new;
992 }
993
994 tctx = calloc(sizeof(*tctx), count + 2);
995 if (!tctx)
996 goto fail;
997
998 tctx[0] = (unsigned long)count;
999 tctx[1] = (unsigned long)inter;
1000
Willy Tarreau8e5c53a2022-06-15 16:32:41 +02001001 if (thrid >= global.nbthread)
1002 thrid = tid;
Willy Tarreaua5a44792020-11-29 17:12:15 +01001003
Willy Tarreaua5a44792020-11-29 17:12:15 +01001004 for (i = 0; i < count; i++) {
Willy Tarreaua5a44792020-11-29 17:12:15 +01001005 /* now, if poly or mask was set, tmask corresponds to the
1006 * valid thread mask to use, otherwise it remains zero.
1007 */
1008 //printf("%lu: mode=%d mask=%#lx\n", i, mode, tmask);
1009 if (mode == 0) {
1010 struct tasklet *tl = tasklet_new();
1011
1012 if (!tl)
1013 goto fail;
1014
Willy Tarreau8e5c53a2022-06-15 16:32:41 +02001015 tl->tid = thrid;
Willy Tarreaua5a44792020-11-29 17:12:15 +01001016 tl->process = debug_tasklet_handler;
1017 tl->context = tctx;
1018 tctx[i + 2] = (unsigned long)tl;
1019 } else {
Willy Tarreau8e5c53a2022-06-15 16:32:41 +02001020 struct task *task = task_new_on(thrid);
Willy Tarreaua5a44792020-11-29 17:12:15 +01001021
1022 if (!task)
1023 goto fail;
1024
1025 task->process = debug_task_handler;
1026 task->context = tctx;
1027 tctx[i + 2] = (unsigned long)task + 1;
1028 }
1029 }
1030
1031 /* start the tasks and tasklets */
1032 for (i = 0; i < count; i++) {
1033 unsigned long ctx = tctx[i + 2];
1034
1035 if (ctx & 1)
1036 task_wakeup((struct task *)(ctx - 1), TASK_WOKEN_INIT);
1037 else
1038 tasklet_wakeup((struct tasklet *)ctx);
1039 }
1040
1041 if (msg && *msg)
1042 return cli_dynmsg(appctx, LOG_INFO, msg);
1043 return 1;
1044
1045 fail:
1046 /* free partially allocated entries */
1047 for (i = 0; tctx && i < count; i++) {
1048 unsigned long ctx = tctx[i + 2];
1049
1050 if (!ctx)
1051 break;
1052
1053 if (ctx & 1)
1054 task_destroy((struct task *)(ctx - 1));
1055 else
1056 tasklet_free((struct tasklet *)ctx);
1057 }
1058
1059 free(tctx);
1060 return cli_err(appctx, "Not enough memory");
1061}
1062
Willy Tarreaue06bbf32022-05-05 14:26:28 +02001063/* CLI state for "debug dev fd" */
1064struct dev_fd_ctx {
1065 int start_fd;
1066};
1067
Willy Tarreau5be7c192022-01-24 20:26:09 +01001068/* CLI parser for the "debug dev fd" command. The current FD to restart from is
Willy Tarreaue06bbf32022-05-05 14:26:28 +02001069 * stored in a struct dev_fd_ctx pointed to by svcctx.
Willy Tarreau5be7c192022-01-24 20:26:09 +01001070 */
1071static int debug_parse_cli_fd(char **args, char *payload, struct appctx *appctx, void *private)
1072{
Willy Tarreaue06bbf32022-05-05 14:26:28 +02001073 struct dev_fd_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1074
Willy Tarreau5be7c192022-01-24 20:26:09 +01001075 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1076 return 1;
1077
1078 /* start at fd #0 */
Willy Tarreaue06bbf32022-05-05 14:26:28 +02001079 ctx->start_fd = 0;
Willy Tarreau5be7c192022-01-24 20:26:09 +01001080 return 0;
1081}
1082
1083/* CLI I/O handler for the "debug dev fd" command. Dumps all FDs that are
1084 * accessible from the process but not known from fdtab. The FD number to
Willy Tarreaue06bbf32022-05-05 14:26:28 +02001085 * restart from is stored in a struct dev_fd_ctx pointed to by svcctx.
Willy Tarreau5be7c192022-01-24 20:26:09 +01001086 */
1087static int debug_iohandler_fd(struct appctx *appctx)
1088{
Willy Tarreaue06bbf32022-05-05 14:26:28 +02001089 struct dev_fd_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001090 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau5be7c192022-01-24 20:26:09 +01001091 struct sockaddr_storage sa;
1092 struct stat statbuf;
1093 socklen_t salen, vlen;
1094 int ret1, ret2, port;
1095 char *addrstr;
1096 int ret = 1;
1097 int i, fd;
1098
Willy Tarreau475e4632022-05-27 10:26:46 +02001099 if (unlikely(sc_ic(sc)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreau5be7c192022-01-24 20:26:09 +01001100 goto end;
1101
1102 chunk_reset(&trash);
1103
1104 thread_isolate();
1105
1106 /* we have two inner loops here, one for the proxy, the other one for
1107 * the buffer.
1108 */
Willy Tarreaue06bbf32022-05-05 14:26:28 +02001109 for (fd = ctx->start_fd; fd < global.maxsock; fd++) {
Willy Tarreau5be7c192022-01-24 20:26:09 +01001110 /* check for FD's existence */
1111 ret1 = fcntl(fd, F_GETFD, 0);
1112 if (ret1 == -1)
1113 continue; // not known to the process
1114 if (fdtab[fd].owner)
1115 continue; // well-known
1116
1117 /* OK we're seeing an orphan let's try to retrieve as much
1118 * information as possible about it.
1119 */
1120 chunk_printf(&trash, "%5d", fd);
1121
1122 if (fstat(fd, &statbuf) != -1) {
1123 chunk_appendf(&trash, " type=%s mod=%04o dev=%#llx siz=%#llx uid=%lld gid=%lld fs=%#llx ino=%#llx",
1124 isatty(fd) ? "tty.":
1125 S_ISREG(statbuf.st_mode) ? "file":
1126 S_ISDIR(statbuf.st_mode) ? "dir.":
1127 S_ISCHR(statbuf.st_mode) ? "chr.":
1128 S_ISBLK(statbuf.st_mode) ? "blk.":
1129 S_ISFIFO(statbuf.st_mode) ? "pipe":
1130 S_ISLNK(statbuf.st_mode) ? "link":
1131 S_ISSOCK(statbuf.st_mode) ? "sock":
1132#ifdef USE_EPOLL
1133 epoll_wait(fd, NULL, 0, 0) != -1 || errno != EBADF ? "epol":
1134#endif
1135 "????",
1136 (uint)statbuf.st_mode & 07777,
1137
1138 (ullong)statbuf.st_rdev,
1139 (ullong)statbuf.st_size,
1140 (ullong)statbuf.st_uid,
1141 (ullong)statbuf.st_gid,
1142
1143 (ullong)statbuf.st_dev,
1144 (ullong)statbuf.st_ino);
1145 }
1146
1147 chunk_appendf(&trash, " getfd=%s+%#x",
1148 (ret1 & FD_CLOEXEC) ? "cloex" : "",
1149 ret1 &~ FD_CLOEXEC);
1150
1151 /* FD options */
1152 ret2 = fcntl(fd, F_GETFL, 0);
1153 if (ret2) {
1154 chunk_appendf(&trash, " getfl=%s",
1155 (ret1 & 3) >= 2 ? "O_RDWR" :
1156 (ret1 & 1) ? "O_WRONLY" : "O_RDONLY");
1157
1158 for (i = 2; i < 32; i++) {
1159 if (!(ret2 & (1UL << i)))
1160 continue;
1161 switch (1UL << i) {
1162 case O_CREAT: chunk_appendf(&trash, ",O_CREAT"); break;
1163 case O_EXCL: chunk_appendf(&trash, ",O_EXCL"); break;
1164 case O_NOCTTY: chunk_appendf(&trash, ",O_NOCTTY"); break;
1165 case O_TRUNC: chunk_appendf(&trash, ",O_TRUNC"); break;
1166 case O_APPEND: chunk_appendf(&trash, ",O_APPEND"); break;
Willy Tarreau410942b2022-01-25 14:51:53 +01001167#ifdef O_ASYNC
Willy Tarreau5be7c192022-01-24 20:26:09 +01001168 case O_ASYNC: chunk_appendf(&trash, ",O_ASYNC"); break;
Willy Tarreau410942b2022-01-25 14:51:53 +01001169#endif
Willy Tarreau5be7c192022-01-24 20:26:09 +01001170#ifdef O_DIRECT
1171 case O_DIRECT: chunk_appendf(&trash, ",O_DIRECT"); break;
1172#endif
1173#ifdef O_NOATIME
1174 case O_NOATIME: chunk_appendf(&trash, ",O_NOATIME"); break;
1175#endif
1176 }
1177 }
1178 }
1179
1180 vlen = sizeof(ret2);
1181 ret1 = getsockopt(fd, SOL_SOCKET, SO_TYPE, &ret2, &vlen);
1182 if (ret1 != -1)
1183 chunk_appendf(&trash, " so_type=%d", ret2);
1184
1185 vlen = sizeof(ret2);
1186 ret1 = getsockopt(fd, SOL_SOCKET, SO_ACCEPTCONN, &ret2, &vlen);
1187 if (ret1 != -1)
1188 chunk_appendf(&trash, " so_accept=%d", ret2);
1189
1190 vlen = sizeof(ret2);
1191 ret1 = getsockopt(fd, SOL_SOCKET, SO_ERROR, &ret2, &vlen);
1192 if (ret1 != -1)
1193 chunk_appendf(&trash, " so_error=%d", ret2);
1194
1195 salen = sizeof(sa);
1196 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1197 if (sa.ss_family == AF_INET)
1198 port = ntohs(((const struct sockaddr_in *)&sa)->sin_port);
1199 else if (sa.ss_family == AF_INET6)
1200 port = ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port);
1201 else
1202 port = 0;
1203 addrstr = sa2str(&sa, port, 0);
1204 chunk_appendf(&trash, " laddr=%s", addrstr);
1205 free(addrstr);
1206 }
1207
1208 salen = sizeof(sa);
1209 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1210 if (sa.ss_family == AF_INET)
1211 port = ntohs(((const struct sockaddr_in *)&sa)->sin_port);
1212 else if (sa.ss_family == AF_INET6)
1213 port = ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port);
1214 else
1215 port = 0;
1216 addrstr = sa2str(&sa, port, 0);
1217 chunk_appendf(&trash, " raddr=%s", addrstr);
1218 free(addrstr);
1219 }
1220
1221 chunk_appendf(&trash, "\n");
1222
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001223 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreaue06bbf32022-05-05 14:26:28 +02001224 ctx->start_fd = fd;
Willy Tarreau5be7c192022-01-24 20:26:09 +01001225 ret = 0;
1226 break;
1227 }
1228 }
1229
1230 thread_release();
1231 end:
1232 return ret;
1233}
1234
Willy Tarreaua6026a02020-07-02 09:14:48 +02001235#if defined(DEBUG_MEM_STATS)
Willy Tarreau40e952f2022-05-05 14:39:51 +02001236
1237/* CLI state for "debug dev memstats" */
1238struct dev_mem_ctx {
1239 struct mem_stats *start, *stop; /* begin/end of dump */
1240 int show_all; /* show all entries if non-null */
Willy Tarreau4a426e22022-08-09 08:51:08 +02001241 int width;
Willy Tarreau40e952f2022-05-05 14:39:51 +02001242};
1243
1244/* CLI parser for the "debug dev memstats" command. Sets a dev_mem_ctx shown above. */
Willy Tarreaua6026a02020-07-02 09:14:48 +02001245static int debug_parse_cli_memstats(char **args, char *payload, struct appctx *appctx, void *private)
1246{
Willy Tarreau40e952f2022-05-05 14:39:51 +02001247 struct dev_mem_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1248
Willy Tarreaua6026a02020-07-02 09:14:48 +02001249 extern __attribute__((__weak__)) struct mem_stats __start_mem_stats;
1250 extern __attribute__((__weak__)) struct mem_stats __stop_mem_stats;
1251
1252 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1253 return 1;
1254
1255 if (strcmp(args[3], "reset") == 0) {
1256 struct mem_stats *ptr;
1257
1258 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1259 return 1;
1260
1261 for (ptr = &__start_mem_stats; ptr < &__stop_mem_stats; ptr++) {
1262 _HA_ATOMIC_STORE(&ptr->calls, 0);
1263 _HA_ATOMIC_STORE(&ptr->size, 0);
1264 }
1265 return 1;
1266 }
1267
1268 if (strcmp(args[3], "all") == 0)
Willy Tarreau40e952f2022-05-05 14:39:51 +02001269 ctx->show_all = 1;
Willy Tarreaua6026a02020-07-02 09:14:48 +02001270
1271 /* otherwise proceed with the dump from p0 to p1 */
Willy Tarreau40e952f2022-05-05 14:39:51 +02001272 ctx->start = &__start_mem_stats;
1273 ctx->stop = &__stop_mem_stats;
Willy Tarreau4a426e22022-08-09 08:51:08 +02001274 ctx->width = 0;
Willy Tarreaua6026a02020-07-02 09:14:48 +02001275 return 0;
1276}
1277
Willy Tarreau40e952f2022-05-05 14:39:51 +02001278/* CLI I/O handler for the "debug dev memstats" command using a dev_mem_ctx
1279 * found in appctx->svcctx. Dumps all mem_stats structs referenced by pointers
1280 * located between ->start and ->stop. Dumps all entries if ->show_all != 0,
1281 * otherwise only non-zero calls.
Willy Tarreaua6026a02020-07-02 09:14:48 +02001282 */
1283static int debug_iohandler_memstats(struct appctx *appctx)
1284{
Willy Tarreau40e952f2022-05-05 14:39:51 +02001285 struct dev_mem_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001286 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau4a426e22022-08-09 08:51:08 +02001287 struct mem_stats *ptr;
Willy Tarreaua6026a02020-07-02 09:14:48 +02001288 int ret = 1;
1289
Willy Tarreau475e4632022-05-27 10:26:46 +02001290 if (unlikely(sc_ic(sc)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreaua6026a02020-07-02 09:14:48 +02001291 goto end;
1292
Willy Tarreau4a426e22022-08-09 08:51:08 +02001293 if (!ctx->width) {
1294 /* we don't know the first column's width, let's compute it
1295 * now based on a first pass on printable entries and their
1296 * expected width (approximated).
1297 */
1298 for (ptr = ctx->start; ptr != ctx->stop; ptr++) {
1299 const char *p, *name;
1300 int w = 0;
1301 char tmp;
1302
1303 if (!ptr->size && !ptr->calls && !ctx->show_all)
1304 continue;
1305
Willy Tarreaud96d2142022-09-06 08:05:59 +02001306 for (p = name = ptr->caller.file; *p; p++) {
Willy Tarreau4a426e22022-08-09 08:51:08 +02001307 if (*p == '/')
1308 name = p + 1;
1309 }
1310
1311 if (ctx->show_all)
Willy Tarreaud96d2142022-09-06 08:05:59 +02001312 w = snprintf(&tmp, 0, "%s(%s:%d) ", ptr->caller.func, name, ptr->caller.line);
Willy Tarreau4a426e22022-08-09 08:51:08 +02001313 else
Willy Tarreaud96d2142022-09-06 08:05:59 +02001314 w = snprintf(&tmp, 0, "%s:%d ", name, ptr->caller.line);
Willy Tarreau4a426e22022-08-09 08:51:08 +02001315
1316 if (w > ctx->width)
1317 ctx->width = w;
1318 }
1319 }
1320
Willy Tarreaua6026a02020-07-02 09:14:48 +02001321 /* we have two inner loops here, one for the proxy, the other one for
1322 * the buffer.
1323 */
Willy Tarreau4a426e22022-08-09 08:51:08 +02001324 for (ptr = ctx->start; ptr != ctx->stop; ptr++) {
Willy Tarreaua6026a02020-07-02 09:14:48 +02001325 const char *type;
1326 const char *name;
1327 const char *p;
Willy Tarreau55c950b2022-08-09 08:15:27 +02001328 const char *info = NULL;
Willy Tarreau17200dd2022-08-09 08:40:08 +02001329 const char *func = NULL;
Willy Tarreaua6026a02020-07-02 09:14:48 +02001330
Willy Tarreau40e952f2022-05-05 14:39:51 +02001331 if (!ptr->size && !ptr->calls && !ctx->show_all)
Willy Tarreaua6026a02020-07-02 09:14:48 +02001332 continue;
1333
1334 /* basename only */
Willy Tarreaud96d2142022-09-06 08:05:59 +02001335 for (p = name = ptr->caller.file; *p; p++) {
Willy Tarreaua6026a02020-07-02 09:14:48 +02001336 if (*p == '/')
1337 name = p + 1;
1338 }
1339
Willy Tarreaud96d2142022-09-06 08:05:59 +02001340 func = ptr->caller.func;
Willy Tarreau17200dd2022-08-09 08:40:08 +02001341
Willy Tarreaud96d2142022-09-06 08:05:59 +02001342 switch (ptr->caller.what) {
Willy Tarreaua6026a02020-07-02 09:14:48 +02001343 case MEM_STATS_TYPE_CALLOC: type = "CALLOC"; break;
1344 case MEM_STATS_TYPE_FREE: type = "FREE"; break;
1345 case MEM_STATS_TYPE_MALLOC: type = "MALLOC"; break;
1346 case MEM_STATS_TYPE_REALLOC: type = "REALLOC"; break;
1347 case MEM_STATS_TYPE_STRDUP: type = "STRDUP"; break;
Willy Tarreau55c950b2022-08-09 08:15:27 +02001348 case MEM_STATS_TYPE_P_ALLOC: type = "P_ALLOC"; if (ptr->extra) info = ((const struct pool_head *)ptr->extra)->name; break;
1349 case MEM_STATS_TYPE_P_FREE: type = "P_FREE"; if (ptr->extra) info = ((const struct pool_head *)ptr->extra)->name; break;
Willy Tarreaua6026a02020-07-02 09:14:48 +02001350 default: type = "UNSET"; break;
1351 }
1352
1353 //chunk_printf(&trash,
1354 // "%20s:%-5d %7s size: %12lu calls: %9lu size/call: %6lu\n",
1355 // name, ptr->line, type,
1356 // (unsigned long)ptr->size, (unsigned long)ptr->calls,
1357 // (unsigned long)(ptr->calls ? (ptr->size / ptr->calls) : 0));
1358
Willy Tarreau17200dd2022-08-09 08:40:08 +02001359 chunk_reset(&trash);
1360 if (ctx->show_all)
1361 chunk_appendf(&trash, "%s(", func);
1362
Willy Tarreaud96d2142022-09-06 08:05:59 +02001363 chunk_appendf(&trash, "%s:%d", name, ptr->caller.line);
Willy Tarreau17200dd2022-08-09 08:40:08 +02001364
1365 if (ctx->show_all)
1366 chunk_appendf(&trash, ")");
1367
Willy Tarreau4a426e22022-08-09 08:51:08 +02001368 while (trash.data < ctx->width)
Willy Tarreaua6026a02020-07-02 09:14:48 +02001369 trash.area[trash.data++] = ' ';
Willy Tarreau17200dd2022-08-09 08:40:08 +02001370
Willy Tarreau55c950b2022-08-09 08:15:27 +02001371 chunk_appendf(&trash, "%7s size: %12lu calls: %9lu size/call: %6lu %s\n",
Willy Tarreaua6026a02020-07-02 09:14:48 +02001372 type,
1373 (unsigned long)ptr->size, (unsigned long)ptr->calls,
Willy Tarreau55c950b2022-08-09 08:15:27 +02001374 (unsigned long)(ptr->calls ? (ptr->size / ptr->calls) : 0),
1375 info ? info : "");
Willy Tarreaua6026a02020-07-02 09:14:48 +02001376
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001377 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreau40e952f2022-05-05 14:39:51 +02001378 ctx->start = ptr;
Willy Tarreaua6026a02020-07-02 09:14:48 +02001379 ret = 0;
1380 break;
1381 }
1382 }
1383
1384 end:
1385 return ret;
1386}
1387
1388#endif
1389
Willy Tarreauc7091d82019-05-17 10:08:49 +02001390#ifndef USE_THREAD_DUMP
1391
1392/* This function dumps all threads' state to the trash. This version is the
1393 * most basic one, which doesn't inspect other threads.
1394 */
1395void ha_thread_dump_all_to_trash()
1396{
1397 unsigned int thr;
1398
1399 for (thr = 0; thr < global.nbthread; thr++)
1400 ha_thread_dump(&trash, thr, tid);
1401}
1402
1403#else /* below USE_THREAD_DUMP is set */
1404
Willy Tarreauc7091d82019-05-17 10:08:49 +02001405/* ID of the thread requesting the dump */
1406static unsigned int thread_dump_tid;
1407
1408/* points to the buffer where the dump functions should write. It must
1409 * have already been initialized by the requester. Nothing is done if
1410 * it's NULL.
1411 */
1412struct buffer *thread_dump_buffer = NULL;
1413
Willy Tarreau00c27b52022-07-01 19:08:56 +02001414/* initiates a thread dump */
Willy Tarreauc7091d82019-05-17 10:08:49 +02001415void ha_thread_dump_all_to_trash()
1416{
Willy Tarreau039972b2022-07-01 19:37:42 +02001417 unsigned int old;
Willy Tarreauc7091d82019-05-17 10:08:49 +02001418
Willy Tarreauf0c86dd2022-07-15 13:14:03 +02001419 /* initiate a dump starting from first thread. Use a CAS so that we do
1420 * not wait if we're not the first one, but we wait for a previous dump
1421 * to finish.
Willy Tarreau67297262022-07-13 08:59:39 +02001422 */
Willy Tarreauf0c86dd2022-07-15 13:14:03 +02001423 while (1) {
1424 old = 0;
1425 if (HA_ATOMIC_CAS(&thread_dump_state, &old, THREAD_DUMP_FSYNC))
1426 break;
1427 ha_thread_relax();
1428 }
Willy Tarreauc7091d82019-05-17 10:08:49 +02001429 thread_dump_buffer = &trash;
1430 thread_dump_tid = tid;
Willy Tarreaufade80d2019-05-22 08:46:59 +02001431 ha_tkillall(DEBUGSIG);
Willy Tarreauf0c86dd2022-07-15 13:14:03 +02001432
1433 /* the call above contains a raise() so we're certain to return after
1434 * returning from the sighandler, hence when the dump is complete.
1435 */
Willy Tarreauc7091d82019-05-17 10:08:49 +02001436}
1437
Willy Tarreauf0c86dd2022-07-15 13:14:03 +02001438/* handles DEBUGSIG to dump the state of the thread it's working on. This is
1439 * appended at the end of thread_dump_buffer which must be protected against
1440 * reentrance from different threads (a thread-local buffer works fine).
1441 */
Willy Tarreauc7091d82019-05-17 10:08:49 +02001442void debug_handler(int sig, siginfo_t *si, void *arg)
1443{
Willy Tarreaua2b8ed42022-07-01 17:11:03 +02001444 int harmless = is_thread_harmless();
Willy Tarreauf0c86dd2022-07-15 13:14:03 +02001445 int running = 0;
1446 uint prev;
Willy Tarreau00c27b52022-07-01 19:08:56 +02001447 uint next;
Willy Tarreaua2b8ed42022-07-01 17:11:03 +02001448
Willy Tarreau82aafc42020-03-03 08:31:34 +01001449 /* first, let's check it's really for us and that we didn't just get
1450 * a spurious DEBUGSIG.
1451 */
Willy Tarreau00c27b52022-07-01 19:08:56 +02001452 if (!_HA_ATOMIC_LOAD(&thread_dump_state))
Willy Tarreau82aafc42020-03-03 08:31:34 +01001453 return;
1454
Willy Tarreauf0c86dd2022-07-15 13:14:03 +02001455 /* There are 5 phases in the dump process:
1456 * 1- wait for all threads to sync or the first one to start
1457 * 2- wait for our turn, i.e. when tid appears in lower bits.
1458 * 3- perform the action if our tid is there
1459 * 4- pass tid to the number of the next thread to dump or
1460 * reset running counter if we're last one.
1461 * 5- wait for running to be zero and decrement the count
Willy Tarreauc7091d82019-05-17 10:08:49 +02001462 */
1463
1464 /* wait for all previous threads to finish first */
Willy Tarreauf7afdd92022-07-01 17:19:14 +02001465 if (!harmless)
1466 thread_harmless_now();
1467
Willy Tarreauf0c86dd2022-07-15 13:14:03 +02001468 if (HA_ATOMIC_FETCH_ADD(&thread_dump_state, 1) == THREAD_DUMP_FSYNC) {
1469 /* the first one which lands here is responsible for constantly
1470 * recounting the number of active theads and switching from
1471 * SYNC to DUMP.
1472 */
1473 while (1) {
1474 int first = -1; // first tid to dump
1475 int thr;
1476
1477 running = 0;
1478 for (thr = 0; thr < global.nbthread; thr++) {
1479 if (ha_thread_info[thr].tg->threads_enabled & ha_thread_info[thr].ltid_bit) {
1480 running++;
1481 if (first < 0)
1482 first = thr;
1483 }
1484 }
1485
1486 if ((HA_ATOMIC_LOAD(&thread_dump_state) & THREAD_DUMP_TMASK) == running) {
1487 /* all threads are there, let's try to start */
1488 prev = THREAD_DUMP_FSYNC | running;
1489 next = (running << 16) | first;
1490 if (HA_ATOMIC_CAS(&thread_dump_state, &prev, next))
1491 break;
1492 /* it failed! maybe a thread appeared late (e.g. during boot), let's
1493 * recount.
1494 */
1495 }
1496 ha_thread_relax();
1497 }
1498 }
1499
1500 /* all threads: let's wait for the SYNC flag to disappear; tid is reset at
1501 * the same time to the first valid tid to dump and pmask will reflect the
1502 * number of participants.
1503 */
1504 while (HA_ATOMIC_LOAD(&thread_dump_state) & THREAD_DUMP_FSYNC)
1505 ha_thread_relax();
1506
1507 /* wait for our turn */
1508 while ((HA_ATOMIC_LOAD(&thread_dump_state) & THREAD_DUMP_TMASK) != tid)
Willy Tarreauc7091d82019-05-17 10:08:49 +02001509 ha_thread_relax();
1510
Willy Tarreauf0c86dd2022-07-15 13:14:03 +02001511 /* make sure we don't count all that wait time against us */
1512 HA_ATOMIC_AND(&th_ctx->flags, ~TH_FL_STUCK);
1513
Willy Tarreauf7afdd92022-07-01 17:19:14 +02001514 if (!harmless)
1515 thread_harmless_end();
1516
Willy Tarreauc7091d82019-05-17 10:08:49 +02001517 /* dump if needed */
Willy Tarreau00c27b52022-07-01 19:08:56 +02001518 if (thread_dump_buffer)
1519 ha_thread_dump(thread_dump_buffer, tid, thread_dump_tid);
1520
Willy Tarreauf0c86dd2022-07-15 13:14:03 +02001521 /* figure which is the next thread ID to dump among enabled ones. Note
1522 * that this relies on the fact that we're not creating new threads in
1523 * the middle of a dump, which is normally granted by the harmless bits
1524 * anyway.
1525 */
Willy Tarreau00c27b52022-07-01 19:08:56 +02001526 for (next = tid + 1; next < global.nbthread; next++) {
1527 if (unlikely(next >= MAX_THREADS)) {
1528 /* just to please gcc 6.5 who guesses the ranges wrong. */
1529 continue;
Willy Tarreauc7091d82019-05-17 10:08:49 +02001530 }
Willy Tarreau00c27b52022-07-01 19:08:56 +02001531
1532 if (ha_thread_info[next].tg &&
1533 ha_thread_info[next].tg->threads_enabled & ha_thread_info[next].ltid_bit)
1534 break;
Willy Tarreauc7091d82019-05-17 10:08:49 +02001535 }
1536
Willy Tarreauf0c86dd2022-07-15 13:14:03 +02001537 /* if there are threads left to dump, we atomically set the next one,
1538 * otherwise we'll clear dump and set the thread part to the number of
1539 * threads that need to disappear.
1540 */
1541 if (next < global.nbthread) {
1542 next = (HA_ATOMIC_LOAD(&thread_dump_state) & THREAD_DUMP_PMASK) | next;
1543 HA_ATOMIC_STORE(&thread_dump_state, next);
1544 } else {
Willy Tarreau00c27b52022-07-01 19:08:56 +02001545 thread_dump_buffer = NULL; // was the last one
Willy Tarreauf0c86dd2022-07-15 13:14:03 +02001546 running = (HA_ATOMIC_LOAD(&thread_dump_state) & THREAD_DUMP_PMASK) >> 16;
1547 HA_ATOMIC_STORE(&thread_dump_state, running);
1548 }
Willy Tarreau00c27b52022-07-01 19:08:56 +02001549
1550 /* now wait for all others to finish dumping: the lowest part will turn
1551 * to zero. Then all others decrement the done part.
Willy Tarreauc7091d82019-05-17 10:08:49 +02001552 */
Willy Tarreauf7afdd92022-07-01 17:19:14 +02001553 if (!harmless)
1554 thread_harmless_now();
1555
Willy Tarreauf0c86dd2022-07-15 13:14:03 +02001556 /* wait for everyone to finish*/
1557 while (HA_ATOMIC_LOAD(&thread_dump_state) & THREAD_DUMP_PMASK)
Willy Tarreauc0773622019-07-31 19:15:45 +02001558 ha_thread_relax();
Willy Tarreauf7afdd92022-07-01 17:19:14 +02001559
Willy Tarreauf0c86dd2022-07-15 13:14:03 +02001560 /* make sure we don't count all that wait time against us */
1561 HA_ATOMIC_AND(&th_ctx->flags, ~TH_FL_STUCK);
1562
Willy Tarreauf7afdd92022-07-01 17:19:14 +02001563 if (!harmless)
1564 thread_harmless_end();
1565
Willy Tarreauf0c86dd2022-07-15 13:14:03 +02001566 /* we're gone. Past this point anything can happen including another
1567 * thread trying to re-trigger a dump, so thread_dump_buffer and
1568 * thread_dump_tid may become invalid immediately after this call.
1569 */
1570 HA_ATOMIC_SUB(&thread_dump_state, 1);
Willy Tarreaue6a02fa2019-05-22 07:06:44 +02001571
1572 /* mark the current thread as stuck to detect it upon next invocation
1573 * if it didn't move.
1574 */
Willy Tarreaua2b8ed42022-07-01 17:11:03 +02001575 if (!harmless &&
Willy Tarreaue7475c82022-06-20 09:23:24 +02001576 !(_HA_ATOMIC_LOAD(&th_ctx->flags) & TH_FL_SLEEPING))
Willy Tarreaubdcd3252022-06-22 09:19:46 +02001577 _HA_ATOMIC_OR(&th_ctx->flags, TH_FL_STUCK);
Willy Tarreauc7091d82019-05-17 10:08:49 +02001578}
1579
1580static int init_debug_per_thread()
1581{
1582 sigset_t set;
1583
1584 /* unblock the DEBUGSIG signal we intend to use */
1585 sigemptyset(&set);
1586 sigaddset(&set, DEBUGSIG);
1587 ha_sigmask(SIG_UNBLOCK, &set, NULL);
1588 return 1;
1589}
1590
1591static int init_debug()
1592{
1593 struct sigaction sa;
Willy Tarreau2f1227e2021-01-22 12:12:29 +01001594 void *callers[1];
Willy Tarreauc7091d82019-05-17 10:08:49 +02001595
Willy Tarreau0214b452020-03-04 06:01:40 +01001596 /* calling backtrace() will access libgcc at runtime. We don't want to
1597 * do it after the chroot, so let's perform a first call to have it
1598 * ready in memory for later use.
1599 */
Willy Tarreau13faf162020-03-04 07:44:06 +01001600 my_backtrace(callers, sizeof(callers)/sizeof(*callers));
Willy Tarreauc7091d82019-05-17 10:08:49 +02001601 sa.sa_handler = NULL;
1602 sa.sa_sigaction = debug_handler;
1603 sigemptyset(&sa.sa_mask);
1604 sa.sa_flags = SA_SIGINFO;
1605 sigaction(DEBUGSIG, &sa, NULL);
Christopher Fauletfc633b62020-11-06 15:24:23 +01001606 return ERR_NONE;
Willy Tarreauc7091d82019-05-17 10:08:49 +02001607}
1608
1609REGISTER_POST_CHECK(init_debug);
1610REGISTER_PER_THREAD_INIT(init_debug_per_thread);
1611
1612#endif /* USE_THREAD_DUMP */
1613
Willy Tarreau4e2b6462019-05-16 17:44:30 +02001614/* register cli keywords */
1615static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02001616 {{ "debug", "dev", "bug", NULL }, "debug dev bug : call BUG_ON() and crash", debug_parse_cli_bug, NULL, NULL, NULL, ACCESS_EXPERT },
Willy Tarreau6d3f1e32022-02-28 11:51:23 +01001617 {{ "debug", "dev", "check", NULL }, "debug dev check : call CHECK_IF() and possibly crash", debug_parse_cli_check, NULL, NULL, NULL, ACCESS_EXPERT },
Willy Tarreaub205bfd2021-05-07 11:38:37 +02001618 {{ "debug", "dev", "close", NULL }, "debug dev close <fd> : close this file descriptor", debug_parse_cli_close, NULL, NULL, NULL, ACCESS_EXPERT },
Willy Tarreaudadf00e2022-07-15 08:25:03 +02001619 {{ "debug", "dev", "deadlock", NULL }, "debug dev deadlock [nbtask] : deadlock between this number of tasks", debug_parse_cli_deadlock, NULL, NULL, NULL, ACCESS_EXPERT },
Willy Tarreaub205bfd2021-05-07 11:38:37 +02001620 {{ "debug", "dev", "delay", NULL }, "debug dev delay [ms] : sleep this long", debug_parse_cli_delay, NULL, NULL, NULL, ACCESS_EXPERT },
Willy Tarreau6bdf3e92019-05-20 14:25:05 +02001621#if defined(DEBUG_DEV)
Willy Tarreaub205bfd2021-05-07 11:38:37 +02001622 {{ "debug", "dev", "exec", NULL }, "debug dev exec [cmd] ... : show this command's output", debug_parse_cli_exec, NULL, NULL, NULL, ACCESS_EXPERT },
Willy Tarreau6bdf3e92019-05-20 14:25:05 +02001623#endif
Willy Tarreau5be7c192022-01-24 20:26:09 +01001624 {{ "debug", "dev", "fd", NULL }, "debug dev fd : scan for rogue/unhandled FDs", debug_parse_cli_fd, debug_iohandler_fd, NULL, NULL, ACCESS_EXPERT },
Willy Tarreaub205bfd2021-05-07 11:38:37 +02001625 {{ "debug", "dev", "exit", NULL }, "debug dev exit [code] : immediately exit the process", debug_parse_cli_exit, NULL, NULL, NULL, ACCESS_EXPERT },
1626 {{ "debug", "dev", "hex", NULL }, "debug dev hex <addr> [len] : dump a memory area", debug_parse_cli_hex, NULL, NULL, NULL, ACCESS_EXPERT },
1627 {{ "debug", "dev", "log", NULL }, "debug dev log [msg] ... : send this msg to global logs", debug_parse_cli_log, NULL, NULL, NULL, ACCESS_EXPERT },
1628 {{ "debug", "dev", "loop", NULL }, "debug dev loop [ms] : loop this long", debug_parse_cli_loop, NULL, NULL, NULL, ACCESS_EXPERT },
Willy Tarreaua6026a02020-07-02 09:14:48 +02001629#if defined(DEBUG_MEM_STATS)
Willy Tarreaub205bfd2021-05-07 11:38:37 +02001630 {{ "debug", "dev", "memstats", NULL }, "debug dev memstats [reset|all] : dump/reset memory statistics", debug_parse_cli_memstats, debug_iohandler_memstats, NULL, NULL, ACCESS_EXPERT },
Willy Tarreaua6026a02020-07-02 09:14:48 +02001631#endif
Willy Tarreaub205bfd2021-05-07 11:38:37 +02001632 {{ "debug", "dev", "panic", NULL }, "debug dev panic : immediately trigger a panic", debug_parse_cli_panic, NULL, NULL, NULL, ACCESS_EXPERT },
1633 {{ "debug", "dev", "sched", NULL }, "debug dev sched {task|tasklet} [k=v]* : stress the scheduler", debug_parse_cli_sched, NULL, NULL, NULL, ACCESS_EXPERT },
1634 {{ "debug", "dev", "stream",NULL }, "debug dev stream [k=v]* : show/manipulate stream flags", debug_parse_cli_stream,NULL, NULL, NULL, ACCESS_EXPERT },
1635 {{ "debug", "dev", "sym", NULL }, "debug dev sym <addr> : resolve symbol address", debug_parse_cli_sym, NULL, NULL, NULL, ACCESS_EXPERT },
1636 {{ "debug", "dev", "tkill", NULL }, "debug dev tkill [thr] [sig] : send signal to thread", debug_parse_cli_tkill, NULL, NULL, NULL, ACCESS_EXPERT },
Willy Tarreau305cfbd2022-02-25 08:52:39 +01001637 {{ "debug", "dev", "warn", NULL }, "debug dev warn : call WARN_ON() and possibly crash", debug_parse_cli_warn, NULL, NULL, NULL, ACCESS_EXPERT },
Willy Tarreaub205bfd2021-05-07 11:38:37 +02001638 {{ "debug", "dev", "write", NULL }, "debug dev write [size] : write that many bytes in return", debug_parse_cli_write, NULL, NULL, NULL, ACCESS_EXPERT },
Erwan Le Goas54966df2022-09-14 17:24:22 +02001639 {{ "debug", "dev", "hash", NULL }, "debug dev hash [msg] : return msg hashed", debug_parse_cli_hash, NULL, NULL, NULL, ACCESS_EXPERT },
1640
Willy Tarreau6ab7b212021-12-28 09:57:10 +01001641#if defined(HA_HAVE_DUMP_LIBS)
1642 {{ "show", "libs", NULL, NULL }, "show libs : show loaded object files and libraries", debug_parse_cli_show_libs, NULL, NULL },
1643#endif
Willy Tarreaub205bfd2021-05-07 11:38:37 +02001644 {{ "show", "threads", NULL, NULL }, "show threads : show some threads debugging information", NULL, cli_io_handler_show_threads, NULL },
Willy Tarreau4e2b6462019-05-16 17:44:30 +02001645 {{},}
1646}};
1647
1648INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);