2 #define I3__FILE__ "sighandler.c"
4 * vim:ts=4:sw=4:expandtab
6 * i3 - an improved dynamic tiling window manager
7 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
8 * © 2009 Jan-Erik Rediger
10 * sighandler.c: Interactive crash dialog upon SIGSEGV/SIGABRT/SIGFPE (offers
11 * to restart inplace).
21 #include <xcb/xcb_event.h>
23 #include <X11/keysym.h>
25 static void open_popups(void);
27 static xcb_gcontext_t pixmap_gc;
28 static xcb_pixmap_t pixmap;
29 static int raised_signal;
31 static char *crash_text[] = {
33 "To debug this problem, either attach gdb now",
35 "- 'b' to save a backtrace (needs GDB),",
36 "- 'r' to restart i3 in-place or",
37 "- 'f' to forget the current layout and restart"};
38 static int crash_text_longest = 5;
39 static int backtrace_string_index = 3;
40 static int backtrace_done = 0;
43 * Attach gdb to pid_parent and dump a backtrace to i3-backtrace.$pid in the
46 static int backtrace(void) {
47 char *tmpdir = getenv("TMPDIR");
51 pid_t pid_parent = getpid();
53 char *filename = NULL;
56 /* Find a unique filename for the backtrace (since the PID of i3 stays the
57 * same), so that we don’t overwrite earlier backtraces. */
60 sasprintf(&filename, "%s/i3-backtrace.%d.%d.txt", tmpdir, pid_parent, suffix);
62 } while (stat(filename, &bt) == 0);
64 pid_t pid_gdb = fork();
66 DLOG("Failed to fork for GDB\n");
68 } else if (pid_gdb == 0) {
73 if (pipe(stdin_pipe) == -1) {
74 ELOG("Failed to init stdin_pipe\n");
77 if (pipe(stdout_pipe) == -1) {
78 ELOG("Failed to init stdout_pipe\n");
82 /* close standard streams in case i3 is started from a terminal; gdb
83 * needs to run without controlling terminal for it to work properly in
89 /* We provide pipe file descriptors for stdin/stdout because gdb < 7.5
90 * crashes otherwise, see
91 * http://sourceware.org/bugzilla/show_bug.cgi?id=14114 */
92 dup2(stdin_pipe[0], STDIN_FILENO);
93 dup2(stdout_pipe[1], STDOUT_FILENO);
95 char *pid_s, *gdb_log_cmd;
96 sasprintf(&pid_s, "%d", pid_parent);
97 sasprintf(&gdb_log_cmd, "set logging file %s", filename);
107 "-ex", "set logging on",
111 execvp(args[0], args);
112 DLOG("Failed to exec GDB\n");
117 waitpid(pid_gdb, &status, 0);
119 /* see if the backtrace was succesful or not */
120 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
121 DLOG("GDB did not run properly\n");
123 } else if (stat(filename, &bt) == -1) {
124 DLOG("GDB executed successfully, but no backtrace was generated\n");
131 * Draw the window containing the info text
134 static int sig_draw_window(xcb_window_t win, int width, int height, int font_height, i3String **crash_text_i3strings) {
135 /* re-draw the background */
136 xcb_rectangle_t border = {0, 0, width, height},
137 inner = {2, 2, width - 4, height - 4};
138 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){get_colorpixel("#FF0000")});
139 xcb_poly_fill_rectangle(conn, pixmap, pixmap_gc, 1, &border);
140 xcb_change_gc(conn, pixmap_gc, XCB_GC_FOREGROUND, (uint32_t[]){get_colorpixel("#000000")});
141 xcb_poly_fill_rectangle(conn, pixmap, pixmap_gc, 1, &inner);
143 /* restore font color */
144 set_font_colors(pixmap_gc, get_colorpixel("#FFFFFF"), get_colorpixel("#000000"));
146 char *bt_colour = "#FFFFFF";
147 if (backtrace_done < 0)
148 bt_colour = "#AA0000";
149 else if (backtrace_done > 0)
150 bt_colour = "#00AA00";
152 for (int i = 0; crash_text_i3strings[i] != NULL; ++i) {
153 /* fix the colour for the backtrace line when it finished */
154 if (i == backtrace_string_index)
155 set_font_colors(pixmap_gc, get_colorpixel(bt_colour), get_colorpixel("#000000"));
157 draw_text(crash_text_i3strings[i], pixmap, pixmap_gc,
158 8, 5 + i * font_height, width - 16);
160 /* and reset the colour again for other lines */
161 if (i == backtrace_string_index)
162 set_font_colors(pixmap_gc, get_colorpixel("#FFFFFF"), get_colorpixel("#000000"));
165 /* Copy the contents of the pixmap to the real window */
166 xcb_copy_area(conn, pixmap, win, pixmap_gc, 0, 0, 0, 0, width, height);
173 * Handles keypresses of 'b', 'r' and 'f' to get a backtrace or restart i3
176 static int sig_handle_key_press(void *ignored, xcb_connection_t *conn, xcb_key_press_event_t *event) {
177 uint16_t state = event->state;
179 /* Apparantly, after activating numlock once, the numlock modifier
180 * stays turned on (use xev(1) to verify). So, to resolve useful
181 * keysyms, we remove the numlock flag from the event state */
182 state &= ~xcb_numlock_mask;
184 xcb_keysym_t sym = xcb_key_press_lookup_keysym(keysyms, event, state);
187 DLOG("User issued core-dump command.\n");
189 /* fork and exec/attach GDB to the parent to get a backtrace in the
191 backtrace_done = backtrace();
193 /* re-open the windows to indicate that it's finished */
207 * Opens the window we use for input/output and maps it
210 static xcb_window_t open_input_window(xcb_connection_t *conn, Rect screen_rect, uint32_t width, uint32_t height) {
211 xcb_window_t win = xcb_generate_id(conn);
216 mask |= XCB_CW_BACK_PIXEL;
219 mask |= XCB_CW_OVERRIDE_REDIRECT;
222 /* center each popup on the specified screen */
223 uint32_t x = screen_rect.x + ((screen_rect.width / 2) - (width / 2)),
224 y = screen_rect.y + ((screen_rect.height / 2) - (height / 2));
226 xcb_create_window(conn,
227 XCB_COPY_FROM_PARENT,
228 win, /* the window id */
229 root, /* parent == root */
230 x, y, width, height, /* dimensions */
231 0, /* border = 0, we draw our own */
232 XCB_WINDOW_CLASS_INPUT_OUTPUT,
233 XCB_WINDOW_CLASS_COPY_FROM_PARENT, /* copy visual from parent */
237 /* Map the window (= make it visible) */
238 xcb_map_window(conn, win);
243 static void open_popups() {
244 /* width and height of the popup window, so that the text fits in */
245 int crash_text_num = sizeof(crash_text) / sizeof(char *);
246 int height = 13 + (crash_text_num * config.font.height);
248 int crash_text_length = sizeof(crash_text) / sizeof(char *);
249 i3String **crash_text_i3strings = smalloc(sizeof(i3String *) * (crash_text_length + 1));
250 /* Pre-compute i3Strings for our text */
251 for (int i = 0; i < crash_text_length; ++i) {
252 crash_text_i3strings[i] = i3string_from_utf8(crash_text[i]);
254 crash_text_i3strings[crash_text_length] = NULL;
255 /* calculate width for longest text */
256 int font_width = predict_text_width(crash_text_i3strings[crash_text_longest]);
257 int width = font_width + 20;
259 /* Open a popup window on each virtual screen */
262 TAILQ_FOREACH(screen, &outputs, outputs) {
265 win = open_input_window(conn, screen->rect, width, height);
268 pixmap = xcb_generate_id(conn);
269 pixmap_gc = xcb_generate_id(conn);
270 xcb_create_pixmap(conn, root_depth, pixmap, win, width, height);
271 xcb_create_gc(conn, pixmap_gc, pixmap, 0, 0);
273 /* Grab the keyboard to get all input */
274 xcb_grab_keyboard(conn, false, win, XCB_CURRENT_TIME, XCB_GRAB_MODE_ASYNC, XCB_GRAB_MODE_ASYNC);
276 /* Grab the cursor inside the popup */
277 xcb_grab_pointer(conn, false, win, XCB_NONE, XCB_GRAB_MODE_ASYNC,
278 XCB_GRAB_MODE_ASYNC, win, XCB_NONE, XCB_CURRENT_TIME);
280 sig_draw_window(win, width, height, config.font.height, crash_text_i3strings);
287 * It creates a window asking the user to restart in-place
288 * or exit to generate a core dump
291 void handle_signal(int sig, siginfo_t *info, void *data) {
292 DLOG("i3 crashed. SIG: %d\n", sig);
294 struct sigaction action;
295 action.sa_handler = SIG_DFL;
296 sigaction(sig, &action, NULL);
301 xcb_generic_event_t *event;
302 /* Yay, more own eventhandlers… */
303 while ((event = xcb_wait_for_event(conn))) {
304 /* Strip off the highest bit (set if the event is generated) */
305 int type = (event->response_type & 0x7F);
306 if (type == XCB_KEY_PRESS) {
307 sig_handle_key_press(NULL, conn, (xcb_key_press_event_t *)event);
314 * Setup signal handlers to safely handle SIGSEGV and SIGFPE
317 void setup_signal_handler(void) {
318 struct sigaction action;
320 action.sa_sigaction = handle_signal;
321 action.sa_flags = SA_NODEFER | SA_RESETHAND | SA_SIGINFO;
322 sigemptyset(&action.sa_mask);
324 /* Catch all signals with default action "Core", see signal(7) */
325 if (sigaction(SIGQUIT, &action, NULL) == -1 ||
326 sigaction(SIGILL, &action, NULL) == -1 ||
327 sigaction(SIGABRT, &action, NULL) == -1 ||
328 sigaction(SIGFPE, &action, NULL) == -1 ||
329 sigaction(SIGSEGV, &action, NULL) == -1)
330 ELOG("Could not setup signal handler");