i3
startup.c
Go to the documentation of this file.
1/*
2 * vim:ts=4:sw=4:expandtab
3 *
4 * i3 - an improved dynamic tiling window manager
5 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
6 *
7 * startup.c: Startup notification code. Ensures a startup notification context
8 * is setup when launching applications. We store the current
9 * workspace to open windows in that startup notification context on
10 * the appropriate workspace.
11 *
12 */
13#include "all.h"
14#include "sd-daemon.h"
15
16#include <paths.h>
17#include <sys/types.h>
18#include <sys/wait.h>
19#include <unistd.h>
20
21#define SN_API_NOT_YET_FROZEN 1
22#include <libsn/sn-launcher.h>
23
24static TAILQ_HEAD(startup_sequence_head, Startup_Sequence) startup_sequences =
25 TAILQ_HEAD_INITIALIZER(startup_sequences);
26
27/*
28 * After 60 seconds, a timeout will be triggered for each startup sequence.
29 *
30 * The timeout will just trigger completion of the sequence, so the normal
31 * completion process takes place (startup_monitor_event will free it).
32 *
33 */
34static void startup_timeout(EV_P_ ev_timer *w, int revents) {
35 const char *id = sn_launcher_context_get_startup_id(w->data);
36 DLOG("Timeout for startup sequence %s\n", id);
37
38 struct Startup_Sequence *current, *sequence = NULL;
39 TAILQ_FOREACH (current, &startup_sequences, sequences) {
40 if (strcmp(current->id, id) != 0)
41 continue;
42
43 sequence = current;
44 break;
45 }
46
47 /* Unref the context (for the timeout itself, see start_application) */
48 sn_launcher_context_unref(w->data);
49
50 if (!sequence) {
51 DLOG("Sequence already deleted, nevermind.\n");
52 free(w);
53 return;
54 }
55
56 /* Complete the startup sequence, will trigger its deletion. */
57 sn_launcher_context_complete(w->data);
58 free(w);
59}
60
61/*
62 * Some applications (such as Firefox) mark a startup sequence as completed
63 * *before* they even map a window. Therefore, we cannot entirely delete the
64 * startup sequence once it’s marked as complete. Instead, we’ll mark it for
65 * deletion in 30 seconds and use that chance to delete old sequences.
66 *
67 * This function returns the number of active (!) startup notifications, that
68 * is, those which are not marked for deletion yet. This is used for changing
69 * the root window cursor.
70 *
71 */
72static int _prune_startup_sequences(void) {
73 time_t current_time = time(NULL);
74 int active_sequences = 0;
75
76 /* Traverse the list and delete everything which was marked for deletion 30
77 * seconds ago or earlier. */
78 struct Startup_Sequence *current, *next;
79 for (next = TAILQ_FIRST(&startup_sequences);
80 next != TAILQ_END(&startup_sequences);) {
81 current = next;
82 next = TAILQ_NEXT(next, sequences);
83
84 if (current->delete_at == 0) {
85 active_sequences++;
86 continue;
87 }
88
89 if (current_time <= current->delete_at)
90 continue;
91
93 }
94
95 return active_sequences;
96}
97
98/*
99 * Deletes a startup sequence, ignoring whether its timeout has elapsed.
100 * Useful when e.g. a window is moved between workspaces and its children
101 * shouldn't spawn on the original workspace.
102 *
103 */
105 assert(sequence != NULL);
106 DLOG("Deleting startup sequence %s, delete_at = %lld, current_time = %lld\n",
107 sequence->id, (long long)sequence->delete_at, (long long)time(NULL));
108
109 /* Unref the context, will be free()d */
110 sn_launcher_context_unref(sequence->context);
111
112 /* Delete our internal sequence */
113 TAILQ_REMOVE(&startup_sequences, sequence, sequences);
114
115 free(sequence->id);
116 free(sequence->workspace);
117 FREE(sequence);
118}
119
120/*
121 * Starts the given application by passing it through a shell. Zombie processes
122 * will be collected by ev in the default loop, we don't have to manually
123 * deal with it.
124 *
125 * The shell used to start applications is the system's bourne shell (i.e.,
126 * /bin/sh).
127 *
128 * The no_startup_id flag determines whether a startup notification context
129 * (and ID) should be created, which is the default and encouraged behavior.
130 *
131 */
132void start_application(const char *command, bool no_startup_id) {
133 SnLauncherContext *context = NULL;
134
135 if (!no_startup_id) {
136 /* Create a startup notification context to monitor the progress of this
137 * startup. */
138 context = sn_launcher_context_new(sndisplay, conn_screen);
139 sn_launcher_context_set_name(context, "i3");
140 sn_launcher_context_set_description(context, "exec command in i3");
141 /* Chop off everything starting from the first space (if there are any
142 * spaces in the command), since we don’t want the parameters. */
143 char *first_word = sstrdup(command);
144 char *space = strchr(first_word, ' ');
145 if (space)
146 *space = '\0';
147 sn_launcher_context_initiate(context, "i3", first_word, last_timestamp);
148 free(first_word);
149
150 /* Trigger a timeout after 60 seconds */
151 struct ev_timer *timeout = scalloc(1, sizeof(struct ev_timer));
152 ev_timer_init(timeout, startup_timeout, 60.0, 0.);
153 timeout->data = context;
154 ev_timer_start(main_loop, timeout);
155
156 LOG("startup id = %s\n", sn_launcher_context_get_startup_id(context));
157
158 /* Save the ID and current workspace in our internal list of startup
159 * sequences */
161 struct Startup_Sequence *sequence = scalloc(1, sizeof(struct Startup_Sequence));
162 sequence->id = sstrdup(sn_launcher_context_get_startup_id(context));
163 sequence->workspace = sstrdup(ws->name);
164 sequence->context = context;
165 TAILQ_INSERT_TAIL(&startup_sequences, sequence, sequences);
166
167 /* Increase the refcount once (it starts with 1, so it will be 2 now) for
168 * the timeout. Even if the sequence gets completed, the timeout still
169 * needs the context (but will unref it then) */
170 sn_launcher_context_ref(context);
171 }
172
173 LOG("executing: %s\n", command);
174 if (fork() == 0) {
175 /* Child process.
176 * It will be reaped by ev, even though there is no corresponding ev_child */
177 setsid();
178 setrlimit(RLIMIT_CORE, &original_rlimit_core);
179 /* Close all socket activation file descriptors explicitly, we disabled
180 * FD_CLOEXEC to keep them open when restarting i3. */
181 for (int fd = SD_LISTEN_FDS_START;
183 fd++) {
184 close(fd);
185 }
186 unsetenv("LISTEN_PID");
187 unsetenv("LISTEN_FDS");
188 signal(SIGPIPE, SIG_DFL);
189 /* Setup the environment variable(s) */
190 if (!no_startup_id)
191 sn_launcher_context_setup_child_process(context);
192 setenv("I3SOCK", current_socketpath, 1);
193
194 execl(_PATH_BSHELL, _PATH_BSHELL, "-c", command, NULL);
195 /* not reached */
196 }
197
198 if (!no_startup_id) {
199 /* Change the pointer of the root window to indicate progress */
201 }
202}
203
204/*
205 * Called by libstartup-notification when something happens
206 *
207 */
208void startup_monitor_event(SnMonitorEvent *event, void *userdata) {
209 SnStartupSequence *snsequence;
210
211 snsequence = sn_monitor_event_get_startup_sequence(event);
212
213 /* Get the corresponding internal startup sequence */
214 const char *id = sn_startup_sequence_get_id(snsequence);
215 struct Startup_Sequence *current, *sequence = NULL;
216 TAILQ_FOREACH (current, &startup_sequences, sequences) {
217 if (strcmp(current->id, id) != 0)
218 continue;
219
220 sequence = current;
221 break;
222 }
223
224 if (!sequence) {
225 DLOG("Got event for startup sequence that we did not initiate (ID = %s). Ignoring.\n", id);
226 return;
227 }
228
229 switch (sn_monitor_event_get_type(event)) {
230 case SN_MONITOR_EVENT_COMPLETED:
231 DLOG("startup sequence %s completed\n", sn_startup_sequence_get_id(snsequence));
232
233 /* Mark the given sequence for deletion in 30 seconds. */
234 time_t current_time = time(NULL);
235 sequence->delete_at = current_time + 30;
236 DLOG("Will delete startup sequence %s at timestamp %lld\n",
237 sequence->id, (long long)sequence->delete_at);
238
239 if (_prune_startup_sequences() == 0) {
240 DLOG("No more startup sequences running, changing root window cursor to default pointer.\n");
241 /* Change the pointer of the root window to indicate progress */
243 }
244 break;
245 default:
246 /* ignore */
247 break;
248 }
249}
250
251/*
252 * Renames workspaces that are mentioned in the startup sequences.
253 *
254 */
255void startup_sequence_rename_workspace(const char *old_name, const char *new_name) {
256 struct Startup_Sequence *current;
257 TAILQ_FOREACH (current, &startup_sequences, sequences) {
258 if (strcmp(current->workspace, old_name) != 0)
259 continue;
260 DLOG("Renaming workspace \"%s\" to \"%s\" in startup sequence %s.\n",
261 old_name, new_name, current->id);
262 free(current->workspace);
263 current->workspace = sstrdup(new_name);
264 }
265}
266
267/*
268 * Gets the stored startup sequence for the _NET_STARTUP_ID of a given window.
269 *
270 */
272 xcb_get_property_reply_t *startup_id_reply, bool ignore_mapped_leader) {
273 /* The _NET_STARTUP_ID is only needed during this function, so we get it
274 * here and don’t save it in the 'cwindow'. */
275 if (startup_id_reply == NULL || xcb_get_property_value_length(startup_id_reply) == 0) {
276 FREE(startup_id_reply);
277 DLOG("No _NET_STARTUP_ID set on window 0x%08x\n", cwindow->id);
278 if (cwindow->leader == XCB_NONE)
279 return NULL;
280
281 /* This is a special case that causes the leader's startup sequence
282 * to only be returned if it has never been mapped, useful primarily
283 * when trying to delete a sequence.
284 *
285 * It's generally inappropriate to delete a leader's sequence when
286 * moving a child window, but if the leader has no container, it's
287 * likely permanently unmapped and the child is the "real" window. */
288 if (ignore_mapped_leader && con_by_window_id(cwindow->leader) != NULL) {
289 DLOG("Ignoring leader window 0x%08x\n", cwindow->leader);
290 return NULL;
291 }
292
293 DLOG("Checking leader window 0x%08x\n", cwindow->leader);
294
295 xcb_get_property_cookie_t cookie;
296
297 cookie = xcb_get_property(conn, false, cwindow->leader,
298 A__NET_STARTUP_ID, XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
299 startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
300
301 if (startup_id_reply == NULL ||
302 xcb_get_property_value_length(startup_id_reply) == 0) {
303 FREE(startup_id_reply);
304 DLOG("No _NET_STARTUP_ID set on the leader either\n");
305 return NULL;
306 }
307 }
308
309 char *startup_id;
310 sasprintf(&startup_id, "%.*s", xcb_get_property_value_length(startup_id_reply),
311 (char *)xcb_get_property_value(startup_id_reply));
312 struct Startup_Sequence *current, *sequence = NULL;
313 TAILQ_FOREACH (current, &startup_sequences, sequences) {
314 if (strcmp(current->id, startup_id) != 0)
315 continue;
316
317 sequence = current;
318 break;
319 }
320
321 if (!sequence) {
322 DLOG("WARNING: This sequence (ID %s) was not found\n", startup_id);
323 free(startup_id);
324 free(startup_id_reply);
325 return NULL;
326 }
327
328 free(startup_id);
329 free(startup_id_reply);
330
331 return sequence;
332}
333
334/*
335 * Checks if the given window belongs to a startup notification by checking if
336 * the _NET_STARTUP_ID property is set on the window (or on its leader, if it’s
337 * unset).
338 *
339 * If so, returns the workspace on which the startup was initiated.
340 * Returns NULL otherwise.
341 *
342 */
343char *startup_workspace_for_window(i3Window *cwindow, xcb_get_property_reply_t *startup_id_reply) {
344 struct Startup_Sequence *sequence = startup_sequence_get(cwindow, startup_id_reply, false);
345 if (sequence == NULL)
346 return NULL;
347
348 /* If the startup sequence's time span has elapsed, delete it. */
349 time_t current_time = time(NULL);
350 if (sequence->delete_at > 0 && current_time > sequence->delete_at) {
351 DLOG("Deleting expired startup sequence %s\n", sequence->id);
352 startup_sequence_delete(sequence);
353 return NULL;
354 }
355
356 return sequence->workspace;
357}
358
359/*
360 * Deletes the startup sequence for a window if it exists.
361 *
362 */
364 struct Startup_Sequence *sequence;
365 xcb_get_property_cookie_t cookie;
366 xcb_get_property_reply_t *startup_id_reply;
367
368 cookie = xcb_get_property(conn, false, win->id, A__NET_STARTUP_ID,
369 XCB_GET_PROPERTY_TYPE_ANY, 0, 512);
370 startup_id_reply = xcb_get_property_reply(conn, cookie, NULL);
371
372 sequence = startup_sequence_get(win, startup_id_reply, true);
373 if (sequence != NULL) {
374 startup_sequence_delete(sequence);
375 }
376}
xcb_timestamp_t last_timestamp
The last timestamp we got from X11 (timestamps are included in some events and are used for some thin...
Definition main.c:64
int conn_screen
Definition main.c:56
xcb_connection_t * conn
XCB connection and root screen.
Definition main.c:54
int listen_fds
The number of file descriptors passed via socket activation.
Definition main.c:46
SnDisplay * sndisplay
Definition main.c:59
struct rlimit original_rlimit_core
The original value of RLIMIT_CORE when i3 was started.
Definition main.c:43
struct ev_loop * main_loop
Definition main.c:79
char * current_socketpath
Definition ipc.c:26
void xcursor_set_root_cursor(int cursor_id)
Sets the cursor of the root window to the 'pointer' cursor.
Definition xcursor.c:49
struct Con * focused
Definition tree.c:13
void startup_sequence_delete_by_window(i3Window *win)
Deletes the startup sequence for a window if it exists.
Definition startup.c:363
char * startup_workspace_for_window(i3Window *cwindow, xcb_get_property_reply_t *startup_id_reply)
Checks if the given window belongs to a startup notification by checking if the _NET_STARTUP_ID prope...
Definition startup.c:343
static int _prune_startup_sequences(void)
Definition startup.c:72
void start_application(const char *command, bool no_startup_id)
Starts the given application by passing it through a shell.
Definition startup.c:132
void startup_sequence_delete(struct Startup_Sequence *sequence)
Deletes a startup sequence, ignoring whether its timeout has elapsed.
Definition startup.c:104
struct Startup_Sequence * startup_sequence_get(i3Window *cwindow, xcb_get_property_reply_t *startup_id_reply, bool ignore_mapped_leader)
Gets the stored startup sequence for the _NET_STARTUP_ID of a given window.
Definition startup.c:271
void startup_sequence_rename_workspace(const char *old_name, const char *new_name)
Renames workspaces that are mentioned in the startup sequences.
Definition startup.c:255
void startup_monitor_event(SnMonitorEvent *event, void *userdata)
Called by libstartup-notification when something happens.
Definition startup.c:208
Con * con_get_workspace(Con *con)
Gets the workspace container this node is on.
Definition con.c:477
Con * con_by_window_id(xcb_window_t window)
Returns the container with the given client window ID or NULL if no such container exists.
Definition con.c:671
@ XCURSOR_CURSOR_WATCH
Definition xcursor.h:24
@ XCURSOR_CURSOR_POINTER
Definition xcursor.h:17
#define FREE(pointer)
Definition util.h:47
#define SD_LISTEN_FDS_START
Definition sd-daemon.h:102
#define TAILQ_FOREACH(var, head, field)
Definition queue.h:347
#define TAILQ_END(head)
Definition queue.h:337
#define TAILQ_HEAD(name, type)
Definition queue.h:318
#define TAILQ_INSERT_TAIL(head, elm, field)
Definition queue.h:376
#define TAILQ_FIRST(head)
Definition queue.h:336
#define TAILQ_REMOVE(head, elm, field)
Definition queue.h:402
#define TAILQ_NEXT(elm, field)
Definition queue.h:338
#define TAILQ_HEAD_INITIALIZER(head)
Definition queue.h:324
#define DLOG(fmt,...)
Definition libi3.h:105
#define LOG(fmt,...)
Definition libi3.h:95
char * sstrdup(const char *str)
Safe-wrapper around strdup which exits if malloc returns NULL (meaning that there is no more memory a...
void * scalloc(size_t num, size_t size)
Safe-wrapper around calloc which exits if malloc returns NULL (meaning that there is no more memory a...
int sasprintf(char **strp, const char *fmt,...)
Safe-wrapper around asprintf which exits if it returns -1 (meaning that there is no more memory avail...
Used during the config file lexing/parsing to keep the state of the lexer in order to provide useful ...
Stores internal information about a startup sequence, like the workspace it was initiated on.
Definition data.h:261
char * id
startup ID for this sequence, generated by libstartup-notification
Definition data.h:263
time_t delete_at
time at which this sequence should be deleted (after it was marked as completed)
Definition data.h:270
char * workspace
workspace on which this startup was initiated
Definition data.h:265
SnLauncherContext * context
libstartup-notification context for this launch
Definition data.h:267
A 'Window' is a type which contains an xcb_window_t and all the related information (hints like _NET_...
Definition data.h:428
xcb_window_t id
Definition data.h:429
xcb_window_t leader
Holds the xcb_window_t (just an ID) for the leader window (logical parent for toolwindows and similar...
Definition data.h:433
A 'Con' represents everything from the X11 root window down to a single X11 window.
Definition data.h:647
char * name
Definition data.h:696