blob: 9a5c2946bc09f648543c8082804dbd9d3c994156 [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 Tarreaua37cb182019-07-31 19:20:39 +020050/* mask of threads still having to dump, used to respect ordering. Only used
51 * when USE_THREAD_DUMP is set.
52 */
53volatile unsigned long threads_to_dump = 0;
Willy Tarreau9b013702019-10-24 18:18:02 +020054unsigned int debug_commands_issued = 0;
Willy Tarreaua37cb182019-07-31 19:20:39 +020055
Willy Tarreau123fc972021-01-22 13:52:41 +010056/* dumps a backtrace of the current thread that is appended to buffer <buf>.
57 * Lines are prefixed with the string <prefix> which may be empty (used for
58 * indenting). It is recommended to use this at a function's tail so that
Willy Tarreau2bfce7e2021-01-22 14:48:34 +010059 * the function does not appear in the call stack. The <dump> argument
60 * indicates what dump state to start from, and should usually be zero. It
61 * may be among the following values:
62 * - 0: search usual callers before step 1, or directly jump to 2
63 * - 1: skip usual callers before step 2
64 * - 2: dump until polling loop, scheduler, or main() (excluded)
65 * - 3: end
66 * - 4-7: like 0 but stops *after* main.
Willy Tarreau123fc972021-01-22 13:52:41 +010067 */
Willy Tarreau2bfce7e2021-01-22 14:48:34 +010068void ha_dump_backtrace(struct buffer *buf, const char *prefix, int dump)
Willy Tarreau123fc972021-01-22 13:52:41 +010069{
70 struct buffer bak;
71 char pfx2[100];
72 void *callers[100];
73 int j, nptrs;
74 const void *addr;
Willy Tarreau123fc972021-01-22 13:52:41 +010075
76 nptrs = my_backtrace(callers, sizeof(callers)/sizeof(*callers));
77 if (!nptrs)
78 return;
79
80 if (snprintf(pfx2, sizeof(pfx2), "%s| ", prefix) > sizeof(pfx2))
81 pfx2[0] = 0;
82
83 /* The call backtrace_symbols_fd(callers, nptrs, STDOUT_FILENO would
84 * produce similar output to the following:
85 */
86 chunk_appendf(buf, "%scall trace(%d):\n", prefix, nptrs);
Willy Tarreau2bfce7e2021-01-22 14:48:34 +010087 for (j = 0; (j < nptrs || (dump & 3) < 2); j++) {
88 if (j == nptrs && !(dump & 3)) {
Willy Tarreau123fc972021-01-22 13:52:41 +010089 /* we failed to spot the starting point of the
90 * dump, let's start over dumping everything we
91 * have.
92 */
Willy Tarreau2bfce7e2021-01-22 14:48:34 +010093 dump += 2;
Willy Tarreau123fc972021-01-22 13:52:41 +010094 j = 0;
95 }
96 bak = *buf;
97 dump_addr_and_bytes(buf, pfx2, callers[j], 8);
98 addr = resolve_sym_name(buf, ": ", callers[j]);
Willy Tarreau2bfce7e2021-01-22 14:48:34 +010099 if ((dump & 3) == 0) {
Willy Tarreau123fc972021-01-22 13:52:41 +0100100 /* dump not started, will start *after*
Willy Tarreaua8459b22021-01-22 14:12:27 +0100101 * ha_thread_dump_all_to_trash, ha_panic and ha_backtrace_to_stderr
Willy Tarreau123fc972021-01-22 13:52:41 +0100102 */
Willy Tarreaua8459b22021-01-22 14:12:27 +0100103 if (addr == ha_thread_dump_all_to_trash || addr == ha_panic ||
104 addr == ha_backtrace_to_stderr)
Willy Tarreau2bfce7e2021-01-22 14:48:34 +0100105 dump++;
Willy Tarreau123fc972021-01-22 13:52:41 +0100106 *buf = bak;
107 continue;
108 }
109
Willy Tarreau2bfce7e2021-01-22 14:48:34 +0100110 if ((dump & 3) == 1) {
Willy Tarreau123fc972021-01-22 13:52:41 +0100111 /* starting */
Willy Tarreaua8459b22021-01-22 14:12:27 +0100112 if (addr == ha_thread_dump_all_to_trash || addr == ha_panic ||
113 addr == ha_backtrace_to_stderr) {
Willy Tarreau123fc972021-01-22 13:52:41 +0100114 *buf = bak;
115 continue;
116 }
Willy Tarreau2bfce7e2021-01-22 14:48:34 +0100117 dump++;
Willy Tarreau123fc972021-01-22 13:52:41 +0100118 }
119
Willy Tarreau2bfce7e2021-01-22 14:48:34 +0100120 if ((dump & 3) == 2) {
121 /* still dumping */
122 if (dump == 6) {
123 /* we only stop *after* main and we must send the LF */
124 if (addr == main) {
125 j = nptrs;
126 dump++;
127 }
128 }
129 else if (addr == run_poll_loop || addr == main || addr == run_tasks_from_lists) {
130 dump++;
Willy Tarreau123fc972021-01-22 13:52:41 +0100131 *buf = bak;
132 break;
133 }
134 }
135 /* OK, line dumped */
136 chunk_appendf(buf, "\n");
137 }
138}
139
Willy Tarreaua8459b22021-01-22 14:12:27 +0100140/* dump a backtrace of current thread's stack to stderr. */
Willy Tarreau7831e022022-05-06 15:16:19 +0200141void ha_backtrace_to_stderr(void)
Willy Tarreaua8459b22021-01-22 14:12:27 +0100142{
143 char area[2048];
144 struct buffer b = b_make(area, sizeof(area), 0, 0);
145
Willy Tarreau2bfce7e2021-01-22 14:48:34 +0100146 ha_dump_backtrace(&b, " ", 4);
Willy Tarreaua8459b22021-01-22 14:12:27 +0100147 if (b.data)
Willy Tarreau2cbe2e72021-01-22 15:58:26 +0100148 DISGUISE(write(2, b.area, b.data));
Willy Tarreaua8459b22021-01-22 14:12:27 +0100149}
150
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200151/* Dumps to the buffer some known information for the desired thread, and
152 * optionally extra info for the current thread. The dump will be appended to
153 * the buffer, so the caller is responsible for preliminary initializing it.
154 * The calling thread ID needs to be passed in <calling_tid> to display a star
Willy Tarreaue6a02fa2019-05-22 07:06:44 +0200155 * in front of the calling thread's line (usually it's tid). Any stuck thread
156 * is also prefixed with a '>'.
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200157 */
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200158void ha_thread_dump(struct buffer *buf, int thr, int calling_tid)
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200159{
160 unsigned long thr_bit = 1UL << thr;
Willy Tarreau45c38e22021-09-30 18:28:49 +0200161 unsigned long long p = ha_thread_ctx[thr].prev_cpu_time;
Willy Tarreau21694982021-10-08 15:09:17 +0200162 unsigned long long n = now_cpu_time_thread(thr);
Willy Tarreaua0b99532021-09-30 18:48:37 +0200163 int stuck = !!(ha_thread_ctx[thr].flags & TH_FL_STUCK);
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200164
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200165 chunk_appendf(buf,
Willy Tarreauf0e5da22020-05-01 12:26:03 +0200166 "%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 +0200167 " %2u/%-2u stuck=%d prof=%d",
Willy Tarreaue6a02fa2019-05-22 07:06:44 +0200168 (thr == calling_tid) ? '*' : ' ', stuck ? '>' : ' ', thr + 1,
Willy Tarreauff64d3b2020-05-01 11:28:49 +0200169 ha_get_pthread_id(thr),
Olivier Houchardcfbb3e62019-05-29 19:22:43 +0200170 thread_has_tasks(),
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200171 !!(global_tasks_mask & thr_bit),
Willy Tarreau1a9c9222021-10-01 11:30:33 +0200172 !eb_is_empty(&ha_thread_ctx[thr].timers),
173 !eb_is_empty(&ha_thread_ctx[thr].rqueue),
174 !(LIST_ISEMPTY(&ha_thread_ctx[thr].tasklets[TL_URGENT]) &&
175 LIST_ISEMPTY(&ha_thread_ctx[thr].tasklets[TL_NORMAL]) &&
176 LIST_ISEMPTY(&ha_thread_ctx[thr].tasklets[TL_BULK]) &&
177 MT_LIST_ISEMPTY(&ha_thread_ctx[thr].shared_tasklet_list)),
178 ha_thread_ctx[thr].tasks_in_list,
179 ha_thread_ctx[thr].rq_total,
Willy Tarreaua3870b72021-09-13 19:24:47 +0200180 ha_thread_info[thr].tg->tgid, ha_thread_info[thr].ltid + 1,
Willy Tarreaue6a02fa2019-05-22 07:06:44 +0200181 stuck,
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200182 !!(task_profiling_mask & thr_bit));
183
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200184 chunk_appendf(buf,
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200185 " harmless=%d wantrdv=%d",
186 !!(threads_harmless_mask & thr_bit),
187 !!(threads_want_rdv_mask & thr_bit));
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200188
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200189 chunk_appendf(buf, "\n");
Willy Tarreau9c8800a2019-05-20 20:52:20 +0200190 chunk_appendf(buf, " cpu_ns: poll=%llu now=%llu diff=%llu\n", p, n, n-p);
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200191
Willy Tarreaua3870b72021-09-13 19:24:47 +0200192 /* this is the end of what we can dump from outside the current thread */
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200193
194 if (thr != tid)
195 return;
196
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200197 chunk_appendf(buf, " curr_task=");
Willy Tarreau1a9c9222021-10-01 11:30:33 +0200198 ha_task_dump(buf, th_ctx->current, " ");
Willy Tarreauf5b4e062020-03-03 15:40:23 +0100199
Willy Tarreauf5b4e062020-03-03 15:40:23 +0100200 if (stuck) {
201 /* We only emit the backtrace for stuck threads in order not to
202 * waste precious output buffer space with non-interesting data.
Willy Tarreau123fc972021-01-22 13:52:41 +0100203 * Please leave this as the last instruction in this function
204 * so that the compiler uses tail merging and the current
205 * function does not appear in the stack.
Willy Tarreauf5b4e062020-03-03 15:40:23 +0100206 */
Willy Tarreau2bfce7e2021-01-22 14:48:34 +0100207 ha_dump_backtrace(buf, " ", 0);
Willy Tarreauf5b4e062020-03-03 15:40:23 +0100208 }
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200209}
210
211
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200212/* dumps into the buffer some information related to task <task> (which may
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200213 * either be a task or a tasklet, and prepend each line except the first one
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200214 * with <pfx>. The buffer is only appended and the first output starts by the
215 * pointer itself. The caller is responsible for making sure the task is not
216 * going to vanish during the dump.
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200217 */
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200218void ha_task_dump(struct buffer *buf, const struct task *task, const char *pfx)
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200219{
Willy Tarreau578ea8b2019-05-22 09:43:09 +0200220 const struct stream *s = NULL;
Willy Tarreaua512b022019-08-21 14:12:19 +0200221 const struct appctx __maybe_unused *appctx = NULL;
Willy Tarreau78a7cb62019-08-21 14:16:02 +0200222 struct hlua __maybe_unused *hlua = NULL;
Willy Tarreau578ea8b2019-05-22 09:43:09 +0200223
Willy Tarreau14a1ab72019-05-17 10:34:25 +0200224 if (!task) {
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200225 chunk_appendf(buf, "0\n");
Willy Tarreau231ec392019-05-17 10:39:47 +0200226 return;
227 }
228
Willy Tarreau20db9112019-05-17 14:14:35 +0200229 if (TASK_IS_TASKLET(task))
230 chunk_appendf(buf,
231 "%p (tasklet) calls=%u\n",
232 task,
233 task->calls);
234 else
235 chunk_appendf(buf,
236 "%p (task) calls=%u last=%llu%s\n",
237 task,
238 task->calls,
239 task->call_date ? (unsigned long long)(now_mono_time() - task->call_date) : 0,
240 task->call_date ? " ns ago" : "");
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200241
Willy Tarreau2e89b092020-03-03 17:13:02 +0100242 chunk_appendf(buf, "%s fct=%p(", pfx, task->process);
243 resolve_sym_name(buf, NULL, task->process);
244 chunk_appendf(buf,") ctx=%p", task->context);
Willy Tarreau578ea8b2019-05-22 09:43:09 +0200245
Willy Tarreaua512b022019-08-21 14:12:19 +0200246 if (task->process == task_run_applet && (appctx = task->context))
247 chunk_appendf(buf, "(%s)\n", appctx->applet->name);
248 else
249 chunk_appendf(buf, "\n");
250
Willy Tarreau578ea8b2019-05-22 09:43:09 +0200251 if (task->process == process_stream && task->context)
252 s = (struct stream *)task->context;
253 else if (task->process == task_run_applet && task->context)
Willy Tarreauc12b3212022-05-27 11:08:15 +0200254 s = sc_strm(appctx_sc((struct appctx *)task->context));
Willy Tarreau462b9892022-05-18 18:06:53 +0200255 else if (task->process == sc_conn_io_cb && task->context)
Willy Tarreauea27f482022-05-18 16:10:52 +0200256 s = sc_strm(((struct stconn *)task->context));
Willy Tarreau578ea8b2019-05-22 09:43:09 +0200257
258 if (s)
259 stream_dump(buf, s, pfx, '\n');
Willy Tarreau78a7cb62019-08-21 14:16:02 +0200260
261#ifdef USE_LUA
262 hlua = NULL;
263 if (s && (hlua = s->hlua)) {
264 chunk_appendf(buf, "%sCurrent executing Lua from a stream analyser -- ", pfx);
265 }
266 else if (task->process == hlua_process_task && (hlua = task->context)) {
267 chunk_appendf(buf, "%sCurrent executing a Lua task -- ", pfx);
268 }
269 else if (task->process == task_run_applet && (appctx = task->context) &&
Willy Tarreaue23f33b2022-05-06 14:07:13 +0200270 (appctx->applet->fct == hlua_applet_tcp_fct)) {
Willy Tarreau78a7cb62019-08-21 14:16:02 +0200271 chunk_appendf(buf, "%sCurrent executing a Lua TCP service -- ", pfx);
272 }
273 else if (task->process == task_run_applet && (appctx = task->context) &&
Willy Tarreauaa229cc2022-05-06 14:26:10 +0200274 (appctx->applet->fct == hlua_applet_http_fct)) {
Willy Tarreau78a7cb62019-08-21 14:16:02 +0200275 chunk_appendf(buf, "%sCurrent executing a Lua HTTP service -- ", pfx);
276 }
277
Christopher Faulet471425f2020-07-24 19:08:05 +0200278 if (hlua && hlua->T) {
Christopher Fauletcc2c4f82021-03-24 14:52:24 +0100279 chunk_appendf(buf, "stack traceback:\n ");
280 append_prefixed_str(buf, hlua_traceback(hlua->T, "\n "), pfx, '\n', 0);
281 b_putchr(buf, '\n');
Willy Tarreau78a7cb62019-08-21 14:16:02 +0200282 }
Christopher Faulet471425f2020-07-24 19:08:05 +0200283 else
284 b_putchr(buf, '\n');
Willy Tarreau78a7cb62019-08-21 14:16:02 +0200285#endif
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200286}
287
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200288/* This function dumps all profiling settings. It returns 0 if the output
289 * buffer is full and it needs to be called again, otherwise non-zero.
290 */
291static int cli_io_handler_show_threads(struct appctx *appctx)
292{
Willy Tarreauc12b3212022-05-27 11:08:15 +0200293 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200294 int thr;
295
Willy Tarreau475e4632022-05-27 10:26:46 +0200296 if (unlikely(sc_ic(sc)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200297 return 1;
298
299 if (appctx->st0)
300 thr = appctx->st1;
301 else
302 thr = 0;
303
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200304 chunk_reset(&trash);
Willy Tarreauc7091d82019-05-17 10:08:49 +0200305 ha_thread_dump_all_to_trash();
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200306
Willy Tarreaud0a06d52022-05-18 15:07:19 +0200307 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200308 /* failed, try again */
Willy Tarreau5cf64dd2019-05-17 10:36:08 +0200309 appctx->st1 = thr;
310 return 0;
311 }
Willy Tarreau4e2b6462019-05-16 17:44:30 +0200312 return 1;
313}
314
Willy Tarreau6ab7b212021-12-28 09:57:10 +0100315#if defined(HA_HAVE_DUMP_LIBS)
316/* parse a "show libs" command. It returns 1 if it emits anything otherwise zero. */
317static int debug_parse_cli_show_libs(char **args, char *payload, struct appctx *appctx, void *private)
318{
319 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
320 return 1;
321
322 chunk_reset(&trash);
323 if (dump_libs(&trash, 1))
324 return cli_msg(appctx, LOG_INFO, trash.area);
325 else
326 return 0;
327}
328#endif
329
Willy Tarreau56131ca2019-05-20 13:48:29 +0200330/* dumps a state of all threads into the trash and on fd #2, then aborts. */
331void ha_panic()
332{
333 chunk_reset(&trash);
Willy Tarreaua9f9fc92019-05-20 17:45:35 +0200334 chunk_appendf(&trash, "Thread %u is about to kill the process.\n", tid + 1);
Willy Tarreau56131ca2019-05-20 13:48:29 +0200335 ha_thread_dump_all_to_trash();
Willy Tarreau2e8ab6b2020-03-14 11:03:20 +0100336 DISGUISE(write(2, trash.area, trash.data));
Willy Tarreau56131ca2019-05-20 13:48:29 +0200337 for (;;)
338 abort();
339}
340
Willy Tarreau06e66c82022-03-02 15:52:03 +0100341/* Complain with message <msg> on stderr. If <counter> is not NULL, it is
342 * atomically incremented, and the message is only printed when the counter
343 * was zero, so that the message is only printed once. <taint> is only checked
344 * on bit 1, and will taint the process either for a bug (2) or warn (0).
345 */
346void complain(int *counter, const char *msg, int taint)
347{
348 if (counter && _HA_ATOMIC_FETCH_ADD(counter, 1))
349 return;
350 DISGUISE(write(2, msg, strlen(msg)));
351 if (taint & 2)
352 mark_tainted(TAINTED_BUG);
353 else
354 mark_tainted(TAINTED_WARN);
355}
356
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200357/* parse a "debug dev exit" command. It always returns 1, though it should never return. */
358static int debug_parse_cli_exit(char **args, char *payload, struct appctx *appctx, void *private)
359{
360 int code = atoi(args[3]);
361
362 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
363 return 1;
364
Willy Tarreau4781b152021-04-06 13:53:36 +0200365 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200366 exit(code);
367 return 1;
368}
369
Willy Tarreau5baf4fe2021-01-22 14:15:46 +0100370/* parse a "debug dev bug" command. It always returns 1, though it should never return.
371 * Note: we make sure not to make the function static so that it appears in the trace.
372 */
373int debug_parse_cli_bug(char **args, char *payload, struct appctx *appctx, void *private)
374{
375 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
376 return 1;
377
Willy Tarreau4781b152021-04-06 13:53:36 +0200378 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau5baf4fe2021-01-22 14:15:46 +0100379 BUG_ON(one > zero);
380 return 1;
381}
382
Willy Tarreau305cfbd2022-02-25 08:52:39 +0100383/* parse a "debug dev warn" command. It always returns 1.
384 * Note: we make sure not to make the function static so that it appears in the trace.
385 */
386int debug_parse_cli_warn(char **args, char *payload, struct appctx *appctx, void *private)
387{
388 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
389 return 1;
390
391 _HA_ATOMIC_INC(&debug_commands_issued);
392 WARN_ON(one > zero);
393 return 1;
394}
395
Willy Tarreau6d3f1e32022-02-28 11:51:23 +0100396/* parse a "debug dev check" command. It always returns 1.
Willy Tarreau4e0a8b12022-02-25 08:55:11 +0100397 * Note: we make sure not to make the function static so that it appears in the trace.
398 */
Willy Tarreau6d3f1e32022-02-28 11:51:23 +0100399int debug_parse_cli_check(char **args, char *payload, struct appctx *appctx, void *private)
Willy Tarreau4e0a8b12022-02-25 08:55:11 +0100400{
401 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
402 return 1;
403
404 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6d3f1e32022-02-28 11:51:23 +0100405 CHECK_IF(one > zero);
Willy Tarreau4e0a8b12022-02-25 08:55:11 +0100406 return 1;
407}
408
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200409/* parse a "debug dev close" command. It always returns 1. */
410static int debug_parse_cli_close(char **args, char *payload, struct appctx *appctx, void *private)
411{
412 int fd;
413
414 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
415 return 1;
416
Willy Tarreau9d008692019-08-09 11:21:01 +0200417 if (!*args[3])
418 return cli_err(appctx, "Missing file descriptor number.\n");
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200419
420 fd = atoi(args[3]);
Willy Tarreau9d008692019-08-09 11:21:01 +0200421 if (fd < 0 || fd >= global.maxsock)
422 return cli_err(appctx, "File descriptor out of range.\n");
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200423
Willy Tarreau9d008692019-08-09 11:21:01 +0200424 if (!fdtab[fd].owner)
425 return cli_msg(appctx, LOG_INFO, "File descriptor was already closed.\n");
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200426
Willy Tarreau4781b152021-04-06 13:53:36 +0200427 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200428 fd_delete(fd);
429 return 1;
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200430}
431
432/* parse a "debug dev delay" command. It always returns 1. */
433static int debug_parse_cli_delay(char **args, char *payload, struct appctx *appctx, void *private)
434{
435 int delay = atoi(args[3]);
436
437 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
438 return 1;
439
Willy Tarreau4781b152021-04-06 13:53:36 +0200440 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200441 usleep((long)delay * 1000);
442 return 1;
443}
444
445/* parse a "debug dev log" command. It always returns 1. */
446static int debug_parse_cli_log(char **args, char *payload, struct appctx *appctx, void *private)
447{
448 int arg;
449
450 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
451 return 1;
452
Willy Tarreau4781b152021-04-06 13:53:36 +0200453 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200454 chunk_reset(&trash);
455 for (arg = 3; *args[arg]; arg++) {
456 if (arg > 3)
457 chunk_strcat(&trash, " ");
458 chunk_strcat(&trash, args[arg]);
459 }
460
461 send_log(NULL, LOG_INFO, "%s\n", trash.area);
462 return 1;
463}
464
465/* parse a "debug dev loop" command. It always returns 1. */
466static int debug_parse_cli_loop(char **args, char *payload, struct appctx *appctx, void *private)
467{
468 struct timeval deadline, curr;
469 int loop = atoi(args[3]);
470
471 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
472 return 1;
473
Willy Tarreau4781b152021-04-06 13:53:36 +0200474 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200475 gettimeofday(&curr, NULL);
476 tv_ms_add(&deadline, &curr, loop);
477
478 while (tv_ms_cmp(&curr, &deadline) < 0)
479 gettimeofday(&curr, NULL);
480
481 return 1;
482}
483
484/* parse a "debug dev panic" command. It always returns 1, though it should never return. */
485static int debug_parse_cli_panic(char **args, char *payload, struct appctx *appctx, void *private)
486{
487 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
488 return 1;
489
Willy Tarreau4781b152021-04-06 13:53:36 +0200490 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200491 ha_panic();
492 return 1;
493}
494
495/* parse a "debug dev exec" command. It always returns 1. */
Willy Tarreaub24ab222019-10-24 18:03:39 +0200496#if defined(DEBUG_DEV)
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200497static int debug_parse_cli_exec(char **args, char *payload, struct appctx *appctx, void *private)
498{
Willy Tarreau368bff42019-12-06 17:18:28 +0100499 int pipefd[2];
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200500 int arg;
Willy Tarreau368bff42019-12-06 17:18:28 +0100501 int pid;
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200502
503 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
504 return 1;
505
Willy Tarreau4781b152021-04-06 13:53:36 +0200506 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200507 chunk_reset(&trash);
508 for (arg = 3; *args[arg]; arg++) {
509 if (arg > 3)
510 chunk_strcat(&trash, " ");
511 chunk_strcat(&trash, args[arg]);
512 }
513
Willy Tarreau368bff42019-12-06 17:18:28 +0100514 thread_isolate();
515 if (pipe(pipefd) < 0)
516 goto fail_pipe;
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200517
Willy Tarreau38247432022-04-26 10:24:14 +0200518 if (fd_set_cloexec(pipefd[0]) == -1)
Willy Tarreau368bff42019-12-06 17:18:28 +0100519 goto fail_fcntl;
520
Willy Tarreau38247432022-04-26 10:24:14 +0200521 if (fd_set_cloexec(pipefd[1]) == -1)
Willy Tarreau368bff42019-12-06 17:18:28 +0100522 goto fail_fcntl;
523
524 pid = fork();
525
526 if (pid < 0)
527 goto fail_fork;
528 else if (pid == 0) {
529 /* child */
530 char *cmd[4] = { "/bin/sh", "-c", 0, 0 };
531
532 close(0);
533 dup2(pipefd[1], 1);
534 dup2(pipefd[1], 2);
535
536 cmd[2] = trash.area;
537 execvp(cmd[0], cmd);
538 printf("execvp() failed\n");
539 exit(1);
540 }
541
542 /* parent */
543 thread_release();
544 close(pipefd[1]);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200545 chunk_reset(&trash);
546 while (1) {
Willy Tarreau368bff42019-12-06 17:18:28 +0100547 size_t ret = read(pipefd[0], trash.area + trash.data, trash.size - 20 - trash.data);
548 if (ret <= 0)
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200549 break;
550 trash.data += ret;
551 if (trash.data + 20 == trash.size) {
552 chunk_strcat(&trash, "\n[[[TRUNCATED]]]\n");
553 break;
554 }
555 }
Willy Tarreau368bff42019-12-06 17:18:28 +0100556 close(pipefd[0]);
557 waitpid(pid, NULL, WNOHANG);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200558 trash.area[trash.data] = 0;
Willy Tarreau9d008692019-08-09 11:21:01 +0200559 return cli_msg(appctx, LOG_INFO, trash.area);
Willy Tarreau368bff42019-12-06 17:18:28 +0100560
561 fail_fork:
562 fail_fcntl:
563 close(pipefd[0]);
564 close(pipefd[1]);
565 fail_pipe:
566 thread_release();
567 return cli_err(appctx, "Failed to execute command.\n");
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200568}
Willy Tarreaub24ab222019-10-24 18:03:39 +0200569#endif
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200570
571/* parse a "debug dev hex" command. It always returns 1. */
572static int debug_parse_cli_hex(char **args, char *payload, struct appctx *appctx, void *private)
573{
574 unsigned long start, len;
575
576 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
577 return 1;
578
Willy Tarreau9d008692019-08-09 11:21:01 +0200579 if (!*args[3])
580 return cli_err(appctx, "Missing memory address to dump from.\n");
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200581
582 start = strtoul(args[3], NULL, 0);
Willy Tarreau9d008692019-08-09 11:21:01 +0200583 if (!start)
584 return cli_err(appctx, "Will not dump from NULL address.\n");
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200585
Willy Tarreau4781b152021-04-06 13:53:36 +0200586 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau9b013702019-10-24 18:18:02 +0200587
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200588 /* by default, dump ~128 till next block of 16 */
589 len = strtoul(args[4], NULL, 0);
590 if (!len)
591 len = ((start + 128) & -16) - start;
592
593 chunk_reset(&trash);
Willy Tarreau37101052019-05-20 16:48:20 +0200594 dump_hex(&trash, " ", (const void *)start, len, 1);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200595 trash.area[trash.data] = 0;
Willy Tarreau9d008692019-08-09 11:21:01 +0200596 return cli_msg(appctx, LOG_INFO, trash.area);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200597}
598
Willy Tarreau48129be2021-05-04 18:40:50 +0200599/* parse a "debug dev sym <addr>" command. It always returns 1. */
600static int debug_parse_cli_sym(char **args, char *payload, struct appctx *appctx, void *private)
601{
602 unsigned long addr;
603
604 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
605 return 1;
606
607 if (!*args[3])
608 return cli_err(appctx, "Missing memory address to be resolved.\n");
609
610 _HA_ATOMIC_INC(&debug_commands_issued);
611
612 addr = strtoul(args[3], NULL, 0);
613 chunk_printf(&trash, "%#lx resolves to ", addr);
614 resolve_sym_name(&trash, NULL, (const void *)addr);
615 chunk_appendf(&trash, "\n");
616
617 return cli_msg(appctx, LOG_INFO, trash.area);
618}
619
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200620/* parse a "debug dev tkill" command. It always returns 1. */
621static int debug_parse_cli_tkill(char **args, char *payload, struct appctx *appctx, void *private)
622{
623 int thr = 0;
624 int sig = SIGABRT;
625
626 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
627 return 1;
628
629 if (*args[3])
630 thr = atoi(args[3]);
631
Willy Tarreau9d008692019-08-09 11:21:01 +0200632 if (thr < 0 || thr > global.nbthread)
633 return cli_err(appctx, "Thread number out of range (use 0 for current).\n");
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200634
635 if (*args[4])
636 sig = atoi(args[4]);
637
Willy Tarreau4781b152021-04-06 13:53:36 +0200638 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200639 if (thr)
Willy Tarreaufade80d2019-05-22 08:46:59 +0200640 ha_tkill(thr - 1, sig);
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200641 else
Willy Tarreau6bdf3e92019-05-20 14:25:05 +0200642 raise(sig);
643 return 1;
644}
645
Willy Tarreau6cbe62b2020-03-05 17:16:24 +0100646/* parse a "debug dev write" command. It always returns 1. */
647static int debug_parse_cli_write(char **args, char *payload, struct appctx *appctx, void *private)
648{
649 unsigned long len;
650
651 if (!*args[3])
652 return cli_err(appctx, "Missing output size.\n");
653
654 len = strtoul(args[3], NULL, 0);
655 if (len >= trash.size)
656 return cli_err(appctx, "Output too large, must be <tune.bufsize.\n");
657
Willy Tarreau4781b152021-04-06 13:53:36 +0200658 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau6cbe62b2020-03-05 17:16:24 +0100659
660 chunk_reset(&trash);
661 trash.data = len;
662 memset(trash.area, '.', trash.data);
663 trash.area[trash.data] = 0;
664 for (len = 64; len < trash.data; len += 64)
665 trash.area[len] = '\n';
666 return cli_msg(appctx, LOG_INFO, trash.area);
667}
668
Willy Tarreau68680bb2019-10-23 17:23:25 +0200669/* parse a "debug dev stream" command */
670/*
671 * debug dev stream [strm=<ptr>] [strm.f[{+-=}<flags>]] [txn.f[{+-=}<flags>]] \
672 * [req.f[{+-=}<flags>]] [res.f[{+-=}<flags>]] \
673 * [sif.f[{+-=<flags>]] [sib.f[{+-=<flags>]] \
674 * [sif.s[=<state>]] [sib.s[=<state>]]
675 */
676static int debug_parse_cli_stream(char **args, char *payload, struct appctx *appctx, void *private)
677{
Willy Tarreau0698c802022-05-11 14:09:57 +0200678 struct stream *s = appctx_strm(appctx);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200679 int arg;
680 void *ptr;
681 int size;
682 const char *word, *end;
683 struct ist name;
684 char *msg = NULL;
685 char *endarg;
686 unsigned long long old, new;
687
688 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
689 return 1;
690
691 ptr = NULL; size = 0;
692
693 if (!*args[3]) {
694 return cli_err(appctx,
695 "Usage: debug dev stream { <obj> <op> <value> | wake }*\n"
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +0200696 " <obj> = {strm | strm.f | strm.x | scf.s | scb.s |\n"
Willy Tarreau68680bb2019-10-23 17:23:25 +0200697 " txn.f | req.f | req.r | req.w | res.f | res.r | res.w}\n"
698 " <op> = {'' (show) | '=' (assign) | '^' (xor) | '+' (or) | '-' (andnot)}\n"
699 " <value> = 'now' | 64-bit dec/hex integer (0x prefix supported)\n"
700 " 'wake' wakes the stream asssigned to 'strm' (default: current)\n"
701 );
702 }
703
Willy Tarreau4781b152021-04-06 13:53:36 +0200704 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200705 for (arg = 3; *args[arg]; arg++) {
706 old = 0;
707 end = word = args[arg];
708 while (*end && *end != '=' && *end != '^' && *end != '+' && *end != '-')
709 end++;
710 name = ist2(word, end - word);
711 if (isteq(name, ist("strm"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200712 ptr = (!s || !may_access(s)) ? NULL : &s; size = sizeof(s);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200713 } else if (isteq(name, ist("strm.f"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200714 ptr = (!s || !may_access(s)) ? NULL : &s->flags; size = sizeof(s->flags);
Christopher Fauletae024ce2022-03-29 19:02:31 +0200715 } else if (isteq(name, ist("strm.x"))) {
716 ptr = (!s || !may_access(s)) ? NULL : &s->conn_exp; size = sizeof(s->conn_exp);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200717 } else if (isteq(name, ist("txn.f"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200718 ptr = (!s || !may_access(s)) ? NULL : &s->txn->flags; size = sizeof(s->txn->flags);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200719 } else if (isteq(name, ist("req.f"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200720 ptr = (!s || !may_access(s)) ? NULL : &s->req.flags; size = sizeof(s->req.flags);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200721 } else if (isteq(name, ist("res.f"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200722 ptr = (!s || !may_access(s)) ? NULL : &s->res.flags; size = sizeof(s->res.flags);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200723 } else if (isteq(name, ist("req.r"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200724 ptr = (!s || !may_access(s)) ? NULL : &s->req.rex; size = sizeof(s->req.rex);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200725 } else if (isteq(name, ist("res.r"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200726 ptr = (!s || !may_access(s)) ? NULL : &s->res.rex; size = sizeof(s->res.rex);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200727 } else if (isteq(name, ist("req.w"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200728 ptr = (!s || !may_access(s)) ? NULL : &s->req.wex; size = sizeof(s->req.wex);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200729 } else if (isteq(name, ist("res.w"))) {
Willy Tarreaub2fee042019-10-25 10:06:55 +0200730 ptr = (!s || !may_access(s)) ? NULL : &s->res.wex; size = sizeof(s->res.wex);
Willy Tarreau7cb9e6c2022-05-17 19:40:40 +0200731 } else if (isteq(name, ist("scf.s"))) {
732 ptr = (!s || !may_access(s)) ? NULL : &s->scf->state; size = sizeof(s->scf->state);
733 } else if (isteq(name, ist("scb.s"))) {
734 ptr = (!s || !may_access(s)) ? NULL : &s->scf->state; size = sizeof(s->scb->state);
Willy Tarreau68680bb2019-10-23 17:23:25 +0200735 } else if (isteq(name, ist("wake"))) {
Willy Tarreau2b5520d2019-10-24 18:28:23 +0200736 if (s && may_access(s) && may_access((void *)s + sizeof(*s) - 1))
Willy Tarreau68680bb2019-10-23 17:23:25 +0200737 task_wakeup(s->task, TASK_WOKEN_TIMER|TASK_WOKEN_IO|TASK_WOKEN_MSG);
738 continue;
739 } else
740 return cli_dynerr(appctx, memprintf(&msg, "Unsupported field name: '%s'.\n", word));
741
742 /* read previous value */
Willy Tarreau2b5520d2019-10-24 18:28:23 +0200743 if ((s || ptr == &s) && ptr && may_access(ptr) && may_access(ptr + size - 1)) {
Willy Tarreau68680bb2019-10-23 17:23:25 +0200744 if (size == 8)
745 old = read_u64(ptr);
746 else if (size == 4)
747 old = read_u32(ptr);
748 else if (size == 2)
749 old = read_u16(ptr);
750 else
751 old = *(const uint8_t *)ptr;
Willy Tarreau2b5520d2019-10-24 18:28:23 +0200752 } else {
753 memprintf(&msg,
754 "%sSkipping inaccessible pointer %p for field '%.*s'.\n",
755 msg ? msg : "", ptr, (int)(end - word), word);
756 continue;
Willy Tarreau68680bb2019-10-23 17:23:25 +0200757 }
758
759 /* parse the new value . */
760 new = strtoll(end + 1, &endarg, 0);
761 if (end[1] && *endarg) {
762 if (strcmp(end + 1, "now") == 0)
763 new = now_ms;
764 else {
765 memprintf(&msg,
766 "%sIgnoring unparsable value '%s' for field '%.*s'.\n",
767 msg ? msg : "", end + 1, (int)(end - word), word);
768 continue;
769 }
770 }
771
772 switch (*end) {
773 case '\0': /* show */
774 memprintf(&msg, "%s%.*s=%#llx ", msg ? msg : "", (int)(end - word), word, old);
775 new = old; // do not change the value
776 break;
777
778 case '=': /* set */
779 break;
780
781 case '^': /* XOR */
782 new = old ^ new;
783 break;
784
785 case '+': /* OR */
786 new = old | new;
787 break;
788
789 case '-': /* AND NOT */
790 new = old & ~new;
791 break;
792
793 default:
794 break;
795 }
796
797 /* write the new value */
Willy Tarreau2b5520d2019-10-24 18:28:23 +0200798 if (new != old) {
Willy Tarreau68680bb2019-10-23 17:23:25 +0200799 if (size == 8)
800 write_u64(ptr, new);
801 else if (size == 4)
802 write_u32(ptr, new);
803 else if (size == 2)
804 write_u16(ptr, new);
805 else
806 *(uint8_t *)ptr = new;
807 }
808 }
809
810 if (msg && *msg)
811 return cli_dynmsg(appctx, LOG_INFO, msg);
812 return 1;
813}
814
Willy Tarreau144f84a2021-03-02 16:09:26 +0100815static struct task *debug_task_handler(struct task *t, void *ctx, unsigned int state)
Willy Tarreaua5a44792020-11-29 17:12:15 +0100816{
817 unsigned long *tctx = ctx; // [0] = #tasks, [1] = inter, [2+] = { tl | (tsk+1) }
818 unsigned long inter = tctx[1];
819 unsigned long rnd;
820
821 t->expire = tick_add(now_ms, inter);
822
823 /* half of the calls will wake up another entry */
Willy Tarreau06e69b52021-03-02 14:01:35 +0100824 rnd = statistical_prng();
Willy Tarreaua5a44792020-11-29 17:12:15 +0100825 if (rnd & 1) {
826 rnd >>= 1;
827 rnd %= tctx[0];
828 rnd = tctx[rnd + 2];
829
830 if (rnd & 1)
831 task_wakeup((struct task *)(rnd - 1), TASK_WOKEN_MSG);
832 else
833 tasklet_wakeup((struct tasklet *)rnd);
834 }
835 return t;
836}
837
Willy Tarreau144f84a2021-03-02 16:09:26 +0100838static struct task *debug_tasklet_handler(struct task *t, void *ctx, unsigned int state)
Willy Tarreaua5a44792020-11-29 17:12:15 +0100839{
840 unsigned long *tctx = ctx; // [0] = #tasks, [1] = inter, [2+] = { tl | (tsk+1) }
841 unsigned long rnd;
842 int i;
843
844 /* wake up two random entries */
845 for (i = 0; i < 2; i++) {
Willy Tarreau06e69b52021-03-02 14:01:35 +0100846 rnd = statistical_prng() % tctx[0];
Willy Tarreaua5a44792020-11-29 17:12:15 +0100847 rnd = tctx[rnd + 2];
848
849 if (rnd & 1)
850 task_wakeup((struct task *)(rnd - 1), TASK_WOKEN_MSG);
851 else
852 tasklet_wakeup((struct tasklet *)rnd);
853 }
854 return t;
855}
856
857/* parse a "debug dev sched" command
858 * debug dev sched {task|tasklet} [count=<count>] [mask=<mask>] [single=<single>] [inter=<inter>]
859 */
860static int debug_parse_cli_sched(char **args, char *payload, struct appctx *appctx, void *private)
861{
862 int arg;
863 void *ptr;
864 int size;
865 const char *word, *end;
866 struct ist name;
867 char *msg = NULL;
868 char *endarg;
869 unsigned long long new;
870 unsigned long count = 0;
871 unsigned long thrid = 0;
872 unsigned int inter = 0;
873 unsigned long mask, tmask;
874 unsigned long i;
875 int mode = 0; // 0 = tasklet; 1 = task
876 int single = 0;
877 unsigned long *tctx; // [0] = #tasks, [1] = inter, [2+] = { tl | (tsk+1) }
878
879 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
880 return 1;
881
882 ptr = NULL; size = 0;
883 mask = all_threads_mask;
884
885 if (strcmp(args[3], "task") != 0 && strcmp(args[3], "tasklet") != 0) {
886 return cli_err(appctx,
887 "Usage: debug dev sched {task|tasklet} { <obj> = <value> }*\n"
888 " <obj> = {count | mask | inter | single }\n"
889 " <value> = 64-bit dec/hex integer (0x prefix supported)\n"
890 );
891 }
892
893 mode = strcmp(args[3], "task") == 0;
894
Willy Tarreau4781b152021-04-06 13:53:36 +0200895 _HA_ATOMIC_INC(&debug_commands_issued);
Willy Tarreaua5a44792020-11-29 17:12:15 +0100896 for (arg = 4; *args[arg]; arg++) {
897 end = word = args[arg];
898 while (*end && *end != '=' && *end != '^' && *end != '+' && *end != '-')
899 end++;
900 name = ist2(word, end - word);
901 if (isteq(name, ist("count"))) {
902 ptr = &count; size = sizeof(count);
903 } else if (isteq(name, ist("mask"))) {
904 ptr = &mask; size = sizeof(mask);
905 } else if (isteq(name, ist("tid"))) {
906 ptr = &thrid; size = sizeof(thrid);
907 } else if (isteq(name, ist("inter"))) {
908 ptr = &inter; size = sizeof(inter);
909 } else if (isteq(name, ist("single"))) {
910 ptr = &single; size = sizeof(single);
911 } else
912 return cli_dynerr(appctx, memprintf(&msg, "Unsupported setting: '%s'.\n", word));
913
914 /* parse the new value . */
915 new = strtoll(end + 1, &endarg, 0);
916 if (end[1] && *endarg) {
917 memprintf(&msg,
918 "%sIgnoring unparsable value '%s' for field '%.*s'.\n",
919 msg ? msg : "", end + 1, (int)(end - word), word);
920 continue;
921 }
922
923 /* write the new value */
924 if (size == 8)
925 write_u64(ptr, new);
926 else if (size == 4)
927 write_u32(ptr, new);
928 else if (size == 2)
929 write_u16(ptr, new);
930 else
931 *(uint8_t *)ptr = new;
932 }
933
934 tctx = calloc(sizeof(*tctx), count + 2);
935 if (!tctx)
936 goto fail;
937
938 tctx[0] = (unsigned long)count;
939 tctx[1] = (unsigned long)inter;
940
941 mask &= all_threads_mask;
942 if (!mask)
943 mask = tid_bit;
944
945 tmask = 0;
946 for (i = 0; i < count; i++) {
947 if (single || mode == 0) {
948 /* look for next bit matching a bit in mask or loop back to zero */
949 for (tmask <<= 1; !(mask & tmask); ) {
950 if (!(mask & -tmask))
951 tmask = 1;
952 else
953 tmask <<= 1;
954 }
955 } else {
956 /* multi-threaded task */
957 tmask = mask;
958 }
959
960 /* now, if poly or mask was set, tmask corresponds to the
961 * valid thread mask to use, otherwise it remains zero.
962 */
963 //printf("%lu: mode=%d mask=%#lx\n", i, mode, tmask);
964 if (mode == 0) {
965 struct tasklet *tl = tasklet_new();
966
967 if (!tl)
968 goto fail;
969
970 if (tmask)
971 tl->tid = my_ffsl(tmask) - 1;
972 tl->process = debug_tasklet_handler;
973 tl->context = tctx;
974 tctx[i + 2] = (unsigned long)tl;
975 } else {
976 struct task *task = task_new(tmask ? tmask : tid_bit);
977
978 if (!task)
979 goto fail;
980
981 task->process = debug_task_handler;
982 task->context = tctx;
983 tctx[i + 2] = (unsigned long)task + 1;
984 }
985 }
986
987 /* start the tasks and tasklets */
988 for (i = 0; i < count; i++) {
989 unsigned long ctx = tctx[i + 2];
990
991 if (ctx & 1)
992 task_wakeup((struct task *)(ctx - 1), TASK_WOKEN_INIT);
993 else
994 tasklet_wakeup((struct tasklet *)ctx);
995 }
996
997 if (msg && *msg)
998 return cli_dynmsg(appctx, LOG_INFO, msg);
999 return 1;
1000
1001 fail:
1002 /* free partially allocated entries */
1003 for (i = 0; tctx && i < count; i++) {
1004 unsigned long ctx = tctx[i + 2];
1005
1006 if (!ctx)
1007 break;
1008
1009 if (ctx & 1)
1010 task_destroy((struct task *)(ctx - 1));
1011 else
1012 tasklet_free((struct tasklet *)ctx);
1013 }
1014
1015 free(tctx);
1016 return cli_err(appctx, "Not enough memory");
1017}
1018
Willy Tarreaue06bbf32022-05-05 14:26:28 +02001019/* CLI state for "debug dev fd" */
1020struct dev_fd_ctx {
1021 int start_fd;
1022};
1023
Willy Tarreau5be7c192022-01-24 20:26:09 +01001024/* CLI parser for the "debug dev fd" command. The current FD to restart from is
Willy Tarreaue06bbf32022-05-05 14:26:28 +02001025 * stored in a struct dev_fd_ctx pointed to by svcctx.
Willy Tarreau5be7c192022-01-24 20:26:09 +01001026 */
1027static int debug_parse_cli_fd(char **args, char *payload, struct appctx *appctx, void *private)
1028{
Willy Tarreaue06bbf32022-05-05 14:26:28 +02001029 struct dev_fd_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1030
Willy Tarreau5be7c192022-01-24 20:26:09 +01001031 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1032 return 1;
1033
1034 /* start at fd #0 */
Willy Tarreaue06bbf32022-05-05 14:26:28 +02001035 ctx->start_fd = 0;
Willy Tarreau5be7c192022-01-24 20:26:09 +01001036 return 0;
1037}
1038
1039/* CLI I/O handler for the "debug dev fd" command. Dumps all FDs that are
1040 * accessible from the process but not known from fdtab. The FD number to
Willy Tarreaue06bbf32022-05-05 14:26:28 +02001041 * restart from is stored in a struct dev_fd_ctx pointed to by svcctx.
Willy Tarreau5be7c192022-01-24 20:26:09 +01001042 */
1043static int debug_iohandler_fd(struct appctx *appctx)
1044{
Willy Tarreaue06bbf32022-05-05 14:26:28 +02001045 struct dev_fd_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001046 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau5be7c192022-01-24 20:26:09 +01001047 struct sockaddr_storage sa;
1048 struct stat statbuf;
1049 socklen_t salen, vlen;
1050 int ret1, ret2, port;
1051 char *addrstr;
1052 int ret = 1;
1053 int i, fd;
1054
Willy Tarreau475e4632022-05-27 10:26:46 +02001055 if (unlikely(sc_ic(sc)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreau5be7c192022-01-24 20:26:09 +01001056 goto end;
1057
1058 chunk_reset(&trash);
1059
1060 thread_isolate();
1061
1062 /* we have two inner loops here, one for the proxy, the other one for
1063 * the buffer.
1064 */
Willy Tarreaue06bbf32022-05-05 14:26:28 +02001065 for (fd = ctx->start_fd; fd < global.maxsock; fd++) {
Willy Tarreau5be7c192022-01-24 20:26:09 +01001066 /* check for FD's existence */
1067 ret1 = fcntl(fd, F_GETFD, 0);
1068 if (ret1 == -1)
1069 continue; // not known to the process
1070 if (fdtab[fd].owner)
1071 continue; // well-known
1072
1073 /* OK we're seeing an orphan let's try to retrieve as much
1074 * information as possible about it.
1075 */
1076 chunk_printf(&trash, "%5d", fd);
1077
1078 if (fstat(fd, &statbuf) != -1) {
1079 chunk_appendf(&trash, " type=%s mod=%04o dev=%#llx siz=%#llx uid=%lld gid=%lld fs=%#llx ino=%#llx",
1080 isatty(fd) ? "tty.":
1081 S_ISREG(statbuf.st_mode) ? "file":
1082 S_ISDIR(statbuf.st_mode) ? "dir.":
1083 S_ISCHR(statbuf.st_mode) ? "chr.":
1084 S_ISBLK(statbuf.st_mode) ? "blk.":
1085 S_ISFIFO(statbuf.st_mode) ? "pipe":
1086 S_ISLNK(statbuf.st_mode) ? "link":
1087 S_ISSOCK(statbuf.st_mode) ? "sock":
1088#ifdef USE_EPOLL
1089 epoll_wait(fd, NULL, 0, 0) != -1 || errno != EBADF ? "epol":
1090#endif
1091 "????",
1092 (uint)statbuf.st_mode & 07777,
1093
1094 (ullong)statbuf.st_rdev,
1095 (ullong)statbuf.st_size,
1096 (ullong)statbuf.st_uid,
1097 (ullong)statbuf.st_gid,
1098
1099 (ullong)statbuf.st_dev,
1100 (ullong)statbuf.st_ino);
1101 }
1102
1103 chunk_appendf(&trash, " getfd=%s+%#x",
1104 (ret1 & FD_CLOEXEC) ? "cloex" : "",
1105 ret1 &~ FD_CLOEXEC);
1106
1107 /* FD options */
1108 ret2 = fcntl(fd, F_GETFL, 0);
1109 if (ret2) {
1110 chunk_appendf(&trash, " getfl=%s",
1111 (ret1 & 3) >= 2 ? "O_RDWR" :
1112 (ret1 & 1) ? "O_WRONLY" : "O_RDONLY");
1113
1114 for (i = 2; i < 32; i++) {
1115 if (!(ret2 & (1UL << i)))
1116 continue;
1117 switch (1UL << i) {
1118 case O_CREAT: chunk_appendf(&trash, ",O_CREAT"); break;
1119 case O_EXCL: chunk_appendf(&trash, ",O_EXCL"); break;
1120 case O_NOCTTY: chunk_appendf(&trash, ",O_NOCTTY"); break;
1121 case O_TRUNC: chunk_appendf(&trash, ",O_TRUNC"); break;
1122 case O_APPEND: chunk_appendf(&trash, ",O_APPEND"); break;
Willy Tarreau410942b2022-01-25 14:51:53 +01001123#ifdef O_ASYNC
Willy Tarreau5be7c192022-01-24 20:26:09 +01001124 case O_ASYNC: chunk_appendf(&trash, ",O_ASYNC"); break;
Willy Tarreau410942b2022-01-25 14:51:53 +01001125#endif
Willy Tarreau5be7c192022-01-24 20:26:09 +01001126#ifdef O_DIRECT
1127 case O_DIRECT: chunk_appendf(&trash, ",O_DIRECT"); break;
1128#endif
1129#ifdef O_NOATIME
1130 case O_NOATIME: chunk_appendf(&trash, ",O_NOATIME"); break;
1131#endif
1132 }
1133 }
1134 }
1135
1136 vlen = sizeof(ret2);
1137 ret1 = getsockopt(fd, SOL_SOCKET, SO_TYPE, &ret2, &vlen);
1138 if (ret1 != -1)
1139 chunk_appendf(&trash, " so_type=%d", ret2);
1140
1141 vlen = sizeof(ret2);
1142 ret1 = getsockopt(fd, SOL_SOCKET, SO_ACCEPTCONN, &ret2, &vlen);
1143 if (ret1 != -1)
1144 chunk_appendf(&trash, " so_accept=%d", ret2);
1145
1146 vlen = sizeof(ret2);
1147 ret1 = getsockopt(fd, SOL_SOCKET, SO_ERROR, &ret2, &vlen);
1148 if (ret1 != -1)
1149 chunk_appendf(&trash, " so_error=%d", ret2);
1150
1151 salen = sizeof(sa);
1152 if (getsockname(fd, (struct sockaddr *)&sa, &salen) != -1) {
1153 if (sa.ss_family == AF_INET)
1154 port = ntohs(((const struct sockaddr_in *)&sa)->sin_port);
1155 else if (sa.ss_family == AF_INET6)
1156 port = ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port);
1157 else
1158 port = 0;
1159 addrstr = sa2str(&sa, port, 0);
1160 chunk_appendf(&trash, " laddr=%s", addrstr);
1161 free(addrstr);
1162 }
1163
1164 salen = sizeof(sa);
1165 if (getpeername(fd, (struct sockaddr *)&sa, &salen) != -1) {
1166 if (sa.ss_family == AF_INET)
1167 port = ntohs(((const struct sockaddr_in *)&sa)->sin_port);
1168 else if (sa.ss_family == AF_INET6)
1169 port = ntohs(((const struct sockaddr_in6 *)&sa)->sin6_port);
1170 else
1171 port = 0;
1172 addrstr = sa2str(&sa, port, 0);
1173 chunk_appendf(&trash, " raddr=%s", addrstr);
1174 free(addrstr);
1175 }
1176
1177 chunk_appendf(&trash, "\n");
1178
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001179 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreaue06bbf32022-05-05 14:26:28 +02001180 ctx->start_fd = fd;
Willy Tarreau5be7c192022-01-24 20:26:09 +01001181 ret = 0;
1182 break;
1183 }
1184 }
1185
1186 thread_release();
1187 end:
1188 return ret;
1189}
1190
Willy Tarreaua6026a02020-07-02 09:14:48 +02001191#if defined(DEBUG_MEM_STATS)
Willy Tarreau40e952f2022-05-05 14:39:51 +02001192
1193/* CLI state for "debug dev memstats" */
1194struct dev_mem_ctx {
1195 struct mem_stats *start, *stop; /* begin/end of dump */
1196 int show_all; /* show all entries if non-null */
1197};
1198
1199/* CLI parser for the "debug dev memstats" command. Sets a dev_mem_ctx shown above. */
Willy Tarreaua6026a02020-07-02 09:14:48 +02001200static int debug_parse_cli_memstats(char **args, char *payload, struct appctx *appctx, void *private)
1201{
Willy Tarreau40e952f2022-05-05 14:39:51 +02001202 struct dev_mem_ctx *ctx = applet_reserve_svcctx(appctx, sizeof(*ctx));
1203
Willy Tarreaua6026a02020-07-02 09:14:48 +02001204 extern __attribute__((__weak__)) struct mem_stats __start_mem_stats;
1205 extern __attribute__((__weak__)) struct mem_stats __stop_mem_stats;
1206
1207 if (!cli_has_level(appctx, ACCESS_LVL_OPER))
1208 return 1;
1209
1210 if (strcmp(args[3], "reset") == 0) {
1211 struct mem_stats *ptr;
1212
1213 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1214 return 1;
1215
1216 for (ptr = &__start_mem_stats; ptr < &__stop_mem_stats; ptr++) {
1217 _HA_ATOMIC_STORE(&ptr->calls, 0);
1218 _HA_ATOMIC_STORE(&ptr->size, 0);
1219 }
1220 return 1;
1221 }
1222
1223 if (strcmp(args[3], "all") == 0)
Willy Tarreau40e952f2022-05-05 14:39:51 +02001224 ctx->show_all = 1;
Willy Tarreaua6026a02020-07-02 09:14:48 +02001225
1226 /* otherwise proceed with the dump from p0 to p1 */
Willy Tarreau40e952f2022-05-05 14:39:51 +02001227 ctx->start = &__start_mem_stats;
1228 ctx->stop = &__stop_mem_stats;
Willy Tarreaua6026a02020-07-02 09:14:48 +02001229 return 0;
1230}
1231
Willy Tarreau40e952f2022-05-05 14:39:51 +02001232/* CLI I/O handler for the "debug dev memstats" command using a dev_mem_ctx
1233 * found in appctx->svcctx. Dumps all mem_stats structs referenced by pointers
1234 * located between ->start and ->stop. Dumps all entries if ->show_all != 0,
1235 * otherwise only non-zero calls.
Willy Tarreaua6026a02020-07-02 09:14:48 +02001236 */
1237static int debug_iohandler_memstats(struct appctx *appctx)
1238{
Willy Tarreau40e952f2022-05-05 14:39:51 +02001239 struct dev_mem_ctx *ctx = appctx->svcctx;
Willy Tarreauc12b3212022-05-27 11:08:15 +02001240 struct stconn *sc = appctx_sc(appctx);
Willy Tarreau40e952f2022-05-05 14:39:51 +02001241 struct mem_stats *ptr = ctx->start;
Willy Tarreaua6026a02020-07-02 09:14:48 +02001242 int ret = 1;
1243
Willy Tarreau475e4632022-05-27 10:26:46 +02001244 if (unlikely(sc_ic(sc)->flags & (CF_WRITE_ERROR|CF_SHUTW)))
Willy Tarreaua6026a02020-07-02 09:14:48 +02001245 goto end;
1246
1247 chunk_reset(&trash);
1248
1249 /* we have two inner loops here, one for the proxy, the other one for
1250 * the buffer.
1251 */
Willy Tarreau40e952f2022-05-05 14:39:51 +02001252 for (; ptr != ctx->stop; ptr++) {
Willy Tarreaua6026a02020-07-02 09:14:48 +02001253 const char *type;
1254 const char *name;
1255 const char *p;
1256
Willy Tarreau40e952f2022-05-05 14:39:51 +02001257 if (!ptr->size && !ptr->calls && !ctx->show_all)
Willy Tarreaua6026a02020-07-02 09:14:48 +02001258 continue;
1259
1260 /* basename only */
1261 for (p = name = ptr->file; *p; p++) {
1262 if (*p == '/')
1263 name = p + 1;
1264 }
1265
1266 switch (ptr->type) {
1267 case MEM_STATS_TYPE_CALLOC: type = "CALLOC"; break;
1268 case MEM_STATS_TYPE_FREE: type = "FREE"; break;
1269 case MEM_STATS_TYPE_MALLOC: type = "MALLOC"; break;
1270 case MEM_STATS_TYPE_REALLOC: type = "REALLOC"; break;
1271 case MEM_STATS_TYPE_STRDUP: type = "STRDUP"; break;
1272 default: type = "UNSET"; break;
1273 }
1274
1275 //chunk_printf(&trash,
1276 // "%20s:%-5d %7s size: %12lu calls: %9lu size/call: %6lu\n",
1277 // name, ptr->line, type,
1278 // (unsigned long)ptr->size, (unsigned long)ptr->calls,
1279 // (unsigned long)(ptr->calls ? (ptr->size / ptr->calls) : 0));
1280
1281 chunk_printf(&trash, "%s:%d", name, ptr->line);
1282 while (trash.data < 25)
1283 trash.area[trash.data++] = ' ';
1284 chunk_appendf(&trash, "%7s size: %12lu calls: %9lu size/call: %6lu\n",
1285 type,
1286 (unsigned long)ptr->size, (unsigned long)ptr->calls,
1287 (unsigned long)(ptr->calls ? (ptr->size / ptr->calls) : 0));
1288
Willy Tarreaud0a06d52022-05-18 15:07:19 +02001289 if (applet_putchk(appctx, &trash) == -1) {
Willy Tarreau40e952f2022-05-05 14:39:51 +02001290 ctx->start = ptr;
Willy Tarreaua6026a02020-07-02 09:14:48 +02001291 ret = 0;
1292 break;
1293 }
1294 }
1295
1296 end:
1297 return ret;
1298}
1299
1300#endif
1301
Willy Tarreauc7091d82019-05-17 10:08:49 +02001302#ifndef USE_THREAD_DUMP
1303
1304/* This function dumps all threads' state to the trash. This version is the
1305 * most basic one, which doesn't inspect other threads.
1306 */
1307void ha_thread_dump_all_to_trash()
1308{
1309 unsigned int thr;
1310
1311 for (thr = 0; thr < global.nbthread; thr++)
1312 ha_thread_dump(&trash, thr, tid);
1313}
1314
1315#else /* below USE_THREAD_DUMP is set */
1316
Willy Tarreauc7091d82019-05-17 10:08:49 +02001317/* ID of the thread requesting the dump */
1318static unsigned int thread_dump_tid;
1319
1320/* points to the buffer where the dump functions should write. It must
1321 * have already been initialized by the requester. Nothing is done if
1322 * it's NULL.
1323 */
1324struct buffer *thread_dump_buffer = NULL;
1325
1326void ha_thread_dump_all_to_trash()
1327{
Willy Tarreauc7091d82019-05-17 10:08:49 +02001328 unsigned long old;
1329
1330 while (1) {
1331 old = 0;
1332 if (HA_ATOMIC_CAS(&threads_to_dump, &old, all_threads_mask))
1333 break;
1334 ha_thread_relax();
1335 }
1336
1337 thread_dump_buffer = &trash;
1338 thread_dump_tid = tid;
Willy Tarreaufade80d2019-05-22 08:46:59 +02001339 ha_tkillall(DEBUGSIG);
Willy Tarreauc7091d82019-05-17 10:08:49 +02001340}
1341
1342/* handles DEBUGSIG to dump the state of the thread it's working on */
1343void debug_handler(int sig, siginfo_t *si, void *arg)
1344{
Willy Tarreau82aafc42020-03-03 08:31:34 +01001345 /* first, let's check it's really for us and that we didn't just get
1346 * a spurious DEBUGSIG.
1347 */
1348 if (!(threads_to_dump & tid_bit))
1349 return;
1350
Willy Tarreauc7091d82019-05-17 10:08:49 +02001351 /* There are 4 phases in the dump process:
1352 * 1- wait for our turn, i.e. when all lower bits are gone.
1353 * 2- perform the action if our bit is set
1354 * 3- remove our bit to let the next one go, unless we're
Willy Tarreauc0773622019-07-31 19:15:45 +02001355 * the last one and have to put them all as a signal
1356 * 4- wait out bit to re-appear, then clear it and quit.
Willy Tarreauc7091d82019-05-17 10:08:49 +02001357 */
1358
1359 /* wait for all previous threads to finish first */
1360 while (threads_to_dump & (tid_bit - 1))
1361 ha_thread_relax();
1362
1363 /* dump if needed */
1364 if (threads_to_dump & tid_bit) {
1365 if (thread_dump_buffer)
1366 ha_thread_dump(thread_dump_buffer, tid, thread_dump_tid);
1367 if ((threads_to_dump & all_threads_mask) == tid_bit) {
1368 /* last one */
Willy Tarreauc0773622019-07-31 19:15:45 +02001369 HA_ATOMIC_STORE(&threads_to_dump, all_threads_mask);
Willy Tarreauc7091d82019-05-17 10:08:49 +02001370 thread_dump_buffer = NULL;
1371 }
1372 else
1373 HA_ATOMIC_AND(&threads_to_dump, ~tid_bit);
1374 }
1375
1376 /* now wait for all others to finish dumping. The last one will set all
Willy Tarreauc0773622019-07-31 19:15:45 +02001377 * bits again to broadcast the leaving condition so we'll see ourselves
1378 * present again. This way the threads_to_dump variable never passes to
1379 * zero until all visitors have stopped waiting.
Willy Tarreauc7091d82019-05-17 10:08:49 +02001380 */
Willy Tarreauc0773622019-07-31 19:15:45 +02001381 while (!(threads_to_dump & tid_bit))
1382 ha_thread_relax();
1383 HA_ATOMIC_AND(&threads_to_dump, ~tid_bit);
Willy Tarreaue6a02fa2019-05-22 07:06:44 +02001384
1385 /* mark the current thread as stuck to detect it upon next invocation
1386 * if it didn't move.
1387 */
1388 if (!((threads_harmless_mask|sleeping_thread_mask) & tid_bit))
Willy Tarreaua0b99532021-09-30 18:48:37 +02001389 th_ctx->flags |= TH_FL_STUCK;
Willy Tarreauc7091d82019-05-17 10:08:49 +02001390}
1391
1392static int init_debug_per_thread()
1393{
1394 sigset_t set;
1395
1396 /* unblock the DEBUGSIG signal we intend to use */
1397 sigemptyset(&set);
1398 sigaddset(&set, DEBUGSIG);
1399 ha_sigmask(SIG_UNBLOCK, &set, NULL);
1400 return 1;
1401}
1402
1403static int init_debug()
1404{
1405 struct sigaction sa;
Willy Tarreau2f1227e2021-01-22 12:12:29 +01001406 void *callers[1];
Willy Tarreauc7091d82019-05-17 10:08:49 +02001407
Willy Tarreau0214b452020-03-04 06:01:40 +01001408 /* calling backtrace() will access libgcc at runtime. We don't want to
1409 * do it after the chroot, so let's perform a first call to have it
1410 * ready in memory for later use.
1411 */
Willy Tarreau13faf162020-03-04 07:44:06 +01001412 my_backtrace(callers, sizeof(callers)/sizeof(*callers));
Willy Tarreauc7091d82019-05-17 10:08:49 +02001413 sa.sa_handler = NULL;
1414 sa.sa_sigaction = debug_handler;
1415 sigemptyset(&sa.sa_mask);
1416 sa.sa_flags = SA_SIGINFO;
1417 sigaction(DEBUGSIG, &sa, NULL);
Christopher Fauletfc633b62020-11-06 15:24:23 +01001418 return ERR_NONE;
Willy Tarreauc7091d82019-05-17 10:08:49 +02001419}
1420
1421REGISTER_POST_CHECK(init_debug);
1422REGISTER_PER_THREAD_INIT(init_debug_per_thread);
1423
1424#endif /* USE_THREAD_DUMP */
1425
Willy Tarreau4e2b6462019-05-16 17:44:30 +02001426/* register cli keywords */
1427static struct cli_kw_list cli_kws = {{ },{
Willy Tarreaub205bfd2021-05-07 11:38:37 +02001428 {{ "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 +01001429 {{ "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 +02001430 {{ "debug", "dev", "close", NULL }, "debug dev close <fd> : close this file descriptor", debug_parse_cli_close, NULL, NULL, NULL, ACCESS_EXPERT },
1431 {{ "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 +02001432#if defined(DEBUG_DEV)
Willy Tarreaub205bfd2021-05-07 11:38:37 +02001433 {{ "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 +02001434#endif
Willy Tarreau5be7c192022-01-24 20:26:09 +01001435 {{ "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 +02001436 {{ "debug", "dev", "exit", NULL }, "debug dev exit [code] : immediately exit the process", debug_parse_cli_exit, NULL, NULL, NULL, ACCESS_EXPERT },
1437 {{ "debug", "dev", "hex", NULL }, "debug dev hex <addr> [len] : dump a memory area", debug_parse_cli_hex, NULL, NULL, NULL, ACCESS_EXPERT },
1438 {{ "debug", "dev", "log", NULL }, "debug dev log [msg] ... : send this msg to global logs", debug_parse_cli_log, NULL, NULL, NULL, ACCESS_EXPERT },
1439 {{ "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 +02001440#if defined(DEBUG_MEM_STATS)
Willy Tarreaub205bfd2021-05-07 11:38:37 +02001441 {{ "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 +02001442#endif
Willy Tarreaub205bfd2021-05-07 11:38:37 +02001443 {{ "debug", "dev", "panic", NULL }, "debug dev panic : immediately trigger a panic", debug_parse_cli_panic, NULL, NULL, NULL, ACCESS_EXPERT },
1444 {{ "debug", "dev", "sched", NULL }, "debug dev sched {task|tasklet} [k=v]* : stress the scheduler", debug_parse_cli_sched, NULL, NULL, NULL, ACCESS_EXPERT },
1445 {{ "debug", "dev", "stream",NULL }, "debug dev stream [k=v]* : show/manipulate stream flags", debug_parse_cli_stream,NULL, NULL, NULL, ACCESS_EXPERT },
1446 {{ "debug", "dev", "sym", NULL }, "debug dev sym <addr> : resolve symbol address", debug_parse_cli_sym, NULL, NULL, NULL, ACCESS_EXPERT },
1447 {{ "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 +01001448 {{ "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 +02001449 {{ "debug", "dev", "write", NULL }, "debug dev write [size] : write that many bytes in return", debug_parse_cli_write, NULL, NULL, NULL, ACCESS_EXPERT },
Willy Tarreau6ab7b212021-12-28 09:57:10 +01001450#if defined(HA_HAVE_DUMP_LIBS)
1451 {{ "show", "libs", NULL, NULL }, "show libs : show loaded object files and libraries", debug_parse_cli_show_libs, NULL, NULL },
1452#endif
Willy Tarreaub205bfd2021-05-07 11:38:37 +02001453 {{ "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 +02001454 {{},}
1455}};
1456
1457INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);