2 * Copyright (C) 2012-2013 Robert Ancell.
3 * Author: Robert Ancell <robert.ancell@canonical.com>
5 * This program is free software: you can redistribute it and/or modify it under
6 * the terms of the GNU General Public License as published by the Free Software
7 * Foundation, either version 3 of the License, or (at your option) any later
8 * version. See http://www.gnu.org/copyleft/gpl.html the full text of the
15 #include <glib/gstdio.h>
17 #include "seat-unity.h"
18 #include "configuration.h"
19 #include "x-server-local.h"
20 #include "mir-server.h"
28 USC_MESSAGE_READY = 2,
29 USC_MESSAGE_SESSION_CONNECTED = 3,
30 USC_MESSAGE_SET_ACTIVE_SESSION = 4,
31 USC_MESSAGE_SET_NEXT_SESSION = 5,
34 struct SeatUnityPrivate
36 /* VT we are running on */
42 /* Filename of Mir socket */
43 gchar *mir_socket_filename;
45 /* Pipes to communicate with compositor */
46 int to_compositor_pipe[2];
47 int from_compositor_pipe[2];
49 /* IO channel listening on for messages from the compositor */
50 GIOChannel *from_compositor_channel;
51 guint from_compositor_watch;
53 /* TRUE when the compositor indicates it is ready */
54 gboolean compositor_ready;
56 /* Buffer reading from channel */
58 gsize read_buffer_length;
59 gsize read_buffer_n_used;
61 /* Compositor process */
62 Process *compositor_process;
64 /* Timeout when waiting for compositor to start */
65 guint compositor_timeout;
67 /* Next Mir ID to use for a Mir sessions, X server and greeters */
69 gint next_x_server_id;
72 /* The currently visible session */
73 Session *active_session;
74 DisplayServer *active_display_server;
77 G_DEFINE_TYPE (SeatUnity, seat_unity, SEAT_TYPE);
80 seat_unity_get_start_local_sessions (Seat *seat)
82 return !seat_get_string_property (seat, "xdmcp-manager");
86 seat_unity_setup (Seat *seat)
88 seat_set_can_switch (seat, TRUE);
89 SEAT_CLASS (seat_unity_parent_class)->setup (seat);
93 compositor_stopped_cb (Process *process, SeatUnity *seat)
95 if (seat->priv->compositor_timeout != 0)
96 g_source_remove (seat->priv->compositor_timeout);
97 seat->priv->compositor_timeout = 0;
99 /* Finished with the VT */
100 vt_unref (seat->priv->vt);
103 if (seat_get_is_stopping (SEAT (seat)))
105 SEAT_CLASS (seat_unity_parent_class)->stop (SEAT (seat));
109 l_debug (seat, "Stopping Unity seat, compositor terminated");
111 seat_stop (SEAT (seat));
115 compositor_run_cb (Process *process, SeatUnity *seat)
119 /* Make input non-blocking */
120 fd = open ("/dev/null", O_RDONLY);
121 dup2 (fd, STDIN_FILENO);
124 /* Redirect output to logfile */
125 if (seat->priv->log_file)
130 /* Move old file out of the way */
131 old_filename = g_strdup_printf ("%s.old", seat->priv->log_file);
132 rename (seat->priv->log_file, old_filename);
133 g_free (old_filename);
135 /* Create new file and log to it */
136 fd = g_open (seat->priv->log_file, O_WRONLY | O_CREAT | O_TRUNC, 0600);
138 l_warning (seat, "Failed to open log file %s: %s", seat->priv->log_file, g_strerror (errno));
141 dup2 (fd, STDOUT_FILENO);
142 dup2 (fd, STDERR_FILENO);
149 write_message (SeatUnity *seat, guint16 id, const guint8 *payload, guint16 payload_length)
152 gsize data_length = 4 + payload_length;
154 data = g_malloc (data_length);
157 data[2] = payload_length >> 8;
158 data[3] = payload_length & 0xFF;
159 memcpy (data + 4, payload, payload_length);
162 if (write (seat->priv->to_compositor_pipe[1], data, data_length) != data_length)
163 l_warning (seat, "Failed to write to compositor: %s", strerror (errno));
167 read_cb (GIOChannel *source, GIOCondition condition, gpointer data)
169 SeatUnity *seat = data;
171 guint16 id, payload_length;
174 if (condition == G_IO_HUP)
176 l_debug (seat, "Compositor closed communication channel");
180 /* Work out how much required for a message */
181 if (seat->priv->read_buffer_n_used < 4)
182 n_to_read = 4 - seat->priv->read_buffer_n_used;
185 payload_length = seat->priv->read_buffer[2] << 8 | seat->priv->read_buffer[3];
186 n_to_read = 4 + payload_length - seat->priv->read_buffer_n_used;
189 /* Read from compositor */
192 gsize n_total, n_read = 0;
194 GError *error = NULL;
196 n_total = seat->priv->read_buffer_n_used + n_to_read;
197 if (seat->priv->read_buffer_length < n_total)
198 seat->priv->read_buffer = g_realloc (seat->priv->read_buffer, n_total);
200 status = g_io_channel_read_chars (source,
201 (gchar *)seat->priv->read_buffer + seat->priv->read_buffer_n_used,
206 l_warning (seat, "Failed to read from compositor: %s", error->message);
207 if (status != G_IO_STATUS_NORMAL)
209 g_clear_error (&error);
210 seat->priv->read_buffer_n_used += n_read;
214 if (seat->priv->read_buffer_n_used < 4)
216 id = seat->priv->read_buffer[0] << 8 | seat->priv->read_buffer[1];
217 payload_length = seat->priv->read_buffer[2] << 8 | seat->priv->read_buffer[3];
220 if (seat->priv->read_buffer_n_used < 4 + payload_length)
222 /*payload = seat->priv->read_buffer + 4;*/
226 case USC_MESSAGE_PING:
227 l_debug (seat, "PING!");
228 write_message (seat, USC_MESSAGE_PONG, NULL, 0);
230 case USC_MESSAGE_PONG:
231 l_debug (seat, "PONG!");
233 case USC_MESSAGE_READY:
234 l_debug (seat, "READY");
235 if (!seat->priv->compositor_ready)
237 seat->priv->compositor_ready = TRUE;
238 l_debug (seat, "Compositor ready");
239 g_source_remove (seat->priv->compositor_timeout);
240 seat->priv->compositor_timeout = 0;
241 SEAT_CLASS (seat_unity_parent_class)->start (SEAT (seat));
244 case USC_MESSAGE_SESSION_CONNECTED:
245 l_debug (seat, "SESSION CONNECTED");
248 l_warning (seat, "Ignoring unknown message %d with %d octets from system compositor", id, payload_length);
253 seat->priv->read_buffer_n_used = 0;
259 get_absolute_command (const gchar *command)
262 gchar *absolute_binary, *absolute_command = NULL;
264 tokens = g_strsplit (command, " ", 2);
266 absolute_binary = g_find_program_in_path (tokens[0]);
270 absolute_command = g_strjoin (" ", absolute_binary, tokens[1], NULL);
272 absolute_command = g_strdup (absolute_binary);
273 g_free (absolute_binary);
276 absolute_command = g_strdup (command);
280 return absolute_command;
284 compositor_timeout_cb (gpointer data)
286 SeatUnity *seat = data;
288 /* Stop the compositor - it is not working */
289 process_stop (seat->priv->compositor_process);
295 seat_unity_start (Seat *seat)
297 const gchar *compositor_command;
298 gchar *command, *absolute_command, *dir, *value;
302 /* Replace Plymouth if it is running */
303 if (plymouth_get_is_active () && plymouth_has_active_vt ())
305 gint active_vt = vt_get_active ();
306 if (active_vt >= vt_get_min ())
308 SEAT_UNITY (seat)->priv->vt = active_vt;
309 plymouth_quit (TRUE);
312 l_debug (seat, "Plymouth is running on VT %d, but this is less than the configured minimum of %d so not replacing it", active_vt, vt_get_min ());
314 if (plymouth_get_is_active ())
315 plymouth_quit (FALSE);
316 if (SEAT_UNITY (seat)->priv->vt < 0)
317 SEAT_UNITY (seat)->priv->vt = vt_can_multi_seat () ? vt_get_unused () : 0;
318 if (SEAT_UNITY (seat)->priv->vt < 0)
320 l_debug (seat, "Failed to get a VT to run on");
323 vt_ref (SEAT_UNITY (seat)->priv->vt);
325 /* Create pipes to talk to compositor */
326 if (pipe (SEAT_UNITY (seat)->priv->to_compositor_pipe) < 0 || pipe (SEAT_UNITY (seat)->priv->from_compositor_pipe) < 0)
328 l_debug (seat, "Failed to create compositor pipes: %s", g_strerror (errno));
332 /* Don't allow the daemon end of the pipes to be accessed in the compositor */
333 fcntl (SEAT_UNITY (seat)->priv->to_compositor_pipe[1], F_SETFD, FD_CLOEXEC);
334 fcntl (SEAT_UNITY (seat)->priv->from_compositor_pipe[0], F_SETFD, FD_CLOEXEC);
336 /* Listen for messages from the compositor */
337 SEAT_UNITY (seat)->priv->from_compositor_channel = g_io_channel_unix_new (SEAT_UNITY (seat)->priv->from_compositor_pipe[0]);
338 SEAT_UNITY (seat)->priv->from_compositor_watch = g_io_add_watch (SEAT_UNITY (seat)->priv->from_compositor_channel, G_IO_IN | G_IO_HUP, read_cb, seat);
341 dir = config_get_string (config_get_instance (), "LightDM", "log-directory");
342 SEAT_UNITY (seat)->priv->log_file = g_build_filename (dir, "unity-system-compositor.log", NULL);
343 l_debug (seat, "Logging to %s", SEAT_UNITY (seat)->priv->log_file);
346 /* Setup environment */
347 process_set_clear_environment (SEAT_UNITY (seat)->priv->compositor_process, TRUE);
348 process_set_env (SEAT_UNITY (seat)->priv->compositor_process, "XDG_SEAT", "seat0");
349 value = g_strdup_printf ("%d", SEAT_UNITY (seat)->priv->vt);
350 process_set_env (SEAT_UNITY (seat)->priv->compositor_process, "XDG_VTNR", value);
352 /* Variable required for regression tests */
353 if (g_getenv ("LIGHTDM_TEST_ROOT"))
355 process_set_env (SEAT_UNITY (seat)->priv->compositor_process, "LIGHTDM_TEST_ROOT", g_getenv ("LIGHTDM_TEST_ROOT"));
356 process_set_env (SEAT_UNITY (seat)->priv->compositor_process, "LD_PRELOAD", g_getenv ("LD_PRELOAD"));
357 process_set_env (SEAT_UNITY (seat)->priv->compositor_process, "LD_LIBRARY_PATH", g_getenv ("LD_LIBRARY_PATH"));
360 SEAT_UNITY (seat)->priv->mir_socket_filename = g_strdup ("/tmp/mir_socket"); // FIXME: Use this socket by default as XMir is hardcoded to this
361 timeout = seat_get_integer_property (seat, "unity-compositor-timeout");
362 compositor_command = seat_get_string_property (seat, "unity-compositor-command");
363 command = g_strdup_printf ("%s --file '%s' --from-dm-fd %d --to-dm-fd %d --vt %d", compositor_command, SEAT_UNITY (seat)->priv->mir_socket_filename, SEAT_UNITY (seat)->priv->to_compositor_pipe[0], SEAT_UNITY (seat)->priv->from_compositor_pipe[1], SEAT_UNITY (seat)->priv->vt);
365 absolute_command = get_absolute_command (command);
368 /* Start the compositor */
369 process_set_command (SEAT_UNITY (seat)->priv->compositor_process, absolute_command);
370 g_free (absolute_command);
371 g_signal_connect (SEAT_UNITY (seat)->priv->compositor_process, "stopped", G_CALLBACK (compositor_stopped_cb), seat);
372 g_signal_connect (SEAT_UNITY (seat)->priv->compositor_process, "run", G_CALLBACK (compositor_run_cb), seat);
373 result = process_start (SEAT_UNITY (seat)->priv->compositor_process, FALSE);
375 /* Close compostor ends of the pipes */
376 close (SEAT_UNITY (seat)->priv->to_compositor_pipe[0]);
377 SEAT_UNITY (seat)->priv->to_compositor_pipe[0] = 0;
378 close (SEAT_UNITY (seat)->priv->from_compositor_pipe[1]);
379 SEAT_UNITY (seat)->priv->from_compositor_pipe[1] = 0;
384 /* Connect to the compositor */
385 timeout = seat_get_integer_property (seat, "unity-compositor-timeout");
388 l_debug (seat, "Waiting for system compositor for %ds", timeout);
389 SEAT_UNITY (seat)->priv->compositor_timeout = g_timeout_add (timeout * 1000, compositor_timeout_cb, seat);
394 static DisplayServer *
395 create_x_server (Seat *seat)
397 XServerLocal *x_server;
398 const gchar *command = NULL, *layout = NULL, *config_file = NULL, *xdmcp_manager = NULL, *key_name = NULL, *xdg_seat = NULL;
403 l_debug (seat, "Starting X server on Unity compositor");
405 x_server = x_server_local_new ();
407 command = seat_get_string_property (seat, "xserver-command");
409 x_server_local_set_command (x_server, command);
411 id = g_strdup_printf ("x-%d", SEAT_UNITY (seat)->priv->next_x_server_id);
412 SEAT_UNITY (seat)->priv->next_x_server_id++;
413 x_server_local_set_mir_id (x_server, id);
414 x_server_local_set_mir_socket (x_server, SEAT_UNITY (seat)->priv->mir_socket_filename);
417 layout = seat_get_string_property (seat, "xserver-layout");
419 x_server_local_set_layout (x_server, layout);
421 xdg_seat = seat_get_string_property (seat, "xdg-seat");
423 x_server_local_set_xdg_seat (x_server, xdg_seat);
425 config_file = seat_get_string_property (seat, "xserver-config");
427 x_server_local_set_config (x_server, config_file);
429 allow_tcp = seat_get_boolean_property (seat, "xserver-allow-tcp");
430 x_server_local_set_allow_tcp (x_server, allow_tcp);
432 xdmcp_manager = seat_get_string_property (seat, "xdmcp-manager");
434 x_server_local_set_xdmcp_server (x_server, xdmcp_manager);
436 port = seat_get_integer_property (seat, "xdmcp-port");
438 x_server_local_set_xdmcp_port (x_server, port);
440 key_name = seat_get_string_property (seat, "xdmcp-key");
446 GError *error = NULL;
448 dir = config_get_string (config_get_instance (), "LightDM", "config-directory");
449 path = g_build_filename (dir, "keys.conf", NULL);
452 keys = g_key_file_new ();
453 result = g_key_file_load_from_file (keys, path, G_KEY_FILE_NONE, &error);
455 l_debug (seat, "Error getting key %s", error->message);
456 g_clear_error (&error);
462 if (g_key_file_has_key (keys, "keyring", key_name, NULL))
463 key = g_key_file_get_string (keys, "keyring", key_name, NULL);
465 l_debug (seat, "Key %s not defined", key_name);
468 x_server_local_set_xdmcp_key (x_server, key);
473 g_key_file_free (keys);
476 return DISPLAY_SERVER (x_server);
479 static DisplayServer *
480 create_mir_server (Seat *seat)
482 MirServer *mir_server;
484 mir_server = mir_server_new ();
485 mir_server_set_parent_socket (mir_server, SEAT_UNITY (seat)->priv->mir_socket_filename);
487 return DISPLAY_SERVER (mir_server);
490 static DisplayServer *
491 seat_unity_create_display_server (Seat *seat, const gchar *session_type)
493 if (strcmp (session_type, "x") == 0)
494 return create_x_server (seat);
495 else if (strcmp (session_type, "mir") == 0)
496 return create_mir_server (seat);
499 l_warning (seat, "Can't create unsupported display server '%s'", session_type);
505 seat_unity_create_greeter_session (Seat *seat)
507 Greeter *greeter_session;
508 const gchar *xdg_seat;
512 greeter_session = SEAT_CLASS (seat_unity_parent_class)->create_greeter_session (seat);
513 xdg_seat = seat_get_string_property (seat, "xdg-seat");
516 l_debug (seat, "Setting XDG_SEAT=%s", xdg_seat);
517 session_set_env (SESSION (greeter_session), "XDG_SEAT", xdg_seat);
519 id = g_strdup_printf ("greeter-%d", SEAT_UNITY (seat)->priv->next_greeter_id);
520 SEAT_UNITY (seat)->priv->next_greeter_id++;
521 session_set_env (SESSION (greeter_session), "MIR_SERVER_NAME", id);
524 vt = SEAT_UNITY (seat)->priv->vt;
527 gchar *value = g_strdup_printf ("%d", vt);
528 l_debug (seat, "Setting XDG_VTNR=%s", value);
529 session_set_env (SESSION (greeter_session), "XDG_VTNR", value);
533 l_debug (seat, "Not setting XDG_VTNR");
535 return greeter_session;
539 seat_unity_create_session (Seat *seat)
542 const gchar *xdg_seat;
546 session = SEAT_CLASS (seat_unity_parent_class)->create_session (seat);
547 xdg_seat = seat_get_string_property (seat, "xdg-seat");
550 l_debug (seat, "Setting XDG_SEAT=%s", xdg_seat);
551 session_set_env (session, "XDG_SEAT", xdg_seat);
553 id = g_strdup_printf ("session-%d", SEAT_UNITY (seat)->priv->next_session_id);
554 SEAT_UNITY (seat)->priv->next_session_id++;
555 session_set_env (session, "MIR_SERVER_NAME", id);
558 vt = SEAT_UNITY (seat)->priv->vt;
561 gchar *value = g_strdup_printf ("%d", vt);
562 l_debug (seat, "Setting XDG_VTNR=%s", value);
563 session_set_env (SESSION (session), "XDG_VTNR", value);
567 l_debug (seat, "Not setting XDG_VTNR");
573 seat_unity_set_active_session (Seat *seat, Session *session)
575 DisplayServer *display_server;
577 if (session == SEAT_UNITY (seat)->priv->active_session)
579 SEAT_UNITY (seat)->priv->active_session = g_object_ref (session);
581 display_server = session_get_display_server (session);
582 if (SEAT_UNITY (seat)->priv->active_display_server != display_server)
584 const gchar *id = NULL;
586 SEAT_UNITY (seat)->priv->active_display_server = g_object_ref (display_server);
588 if (IS_X_SERVER_LOCAL (display_server))
589 id = x_server_local_get_mir_id (X_SERVER_LOCAL (display_server));
591 id = session_get_env (session, "MIR_SERVER_NAME");
595 l_debug (seat, "Switching to Mir session %s", id);
596 write_message (SEAT_UNITY (seat), USC_MESSAGE_SET_ACTIVE_SESSION, (const guint8 *) id, strlen (id));
599 l_warning (seat, "Failed to work out session ID");
602 SEAT_CLASS (seat_unity_parent_class)->set_active_session (seat, session);
606 seat_unity_get_active_session (Seat *seat)
608 return SEAT_UNITY (seat)->priv->active_session;
612 seat_unity_set_next_session (Seat *seat, Session *session)
614 DisplayServer *display_server;
615 const gchar *id = NULL;
620 display_server = session_get_display_server (session);
622 if (IS_X_SERVER_LOCAL (display_server))
623 id = x_server_local_get_mir_id (X_SERVER_LOCAL (display_server));
625 id = session_get_env (session, "MIR_SERVER_NAME");
629 l_debug (seat, "Marking Mir session %s as the next session", id);
630 write_message (SEAT_UNITY (seat), USC_MESSAGE_SET_NEXT_SESSION, (const guint8 *) id, strlen (id));
634 l_debug (seat, "Failed to work out session ID to mark");
637 SEAT_CLASS (seat_unity_parent_class)->set_next_session (seat, session);
641 seat_unity_run_script (Seat *seat, DisplayServer *display_server, Process *script)
644 XServerLocal *x_server;
646 x_server = X_SERVER_LOCAL (display_server);
647 path = x_server_local_get_authority_file_path (x_server);
648 process_set_env (script, "DISPLAY", x_server_get_address (X_SERVER (x_server)));
649 process_set_env (script, "XAUTHORITY", path);
651 SEAT_CLASS (seat_unity_parent_class)->run_script (seat, display_server, script);
655 seat_unity_stop (Seat *seat)
657 /* Stop the compositor first */
658 if (process_get_is_running (SEAT_UNITY (seat)->priv->compositor_process))
660 process_stop (SEAT_UNITY (seat)->priv->compositor_process);
664 SEAT_CLASS (seat_unity_parent_class)->stop (seat);
668 seat_unity_init (SeatUnity *seat)
670 seat->priv = G_TYPE_INSTANCE_GET_PRIVATE (seat, SEAT_UNITY_TYPE, SeatUnityPrivate);
672 seat->priv->compositor_process = process_new ();
676 seat_unity_finalize (GObject *object)
678 SeatUnity *seat = SEAT_UNITY (object);
680 if (seat->priv->vt >= 0)
681 vt_unref (seat->priv->vt);
682 g_free (seat->priv->log_file);
683 g_free (seat->priv->mir_socket_filename);
684 close (seat->priv->to_compositor_pipe[0]);
685 close (seat->priv->to_compositor_pipe[1]);
686 close (seat->priv->from_compositor_pipe[0]);
687 close (seat->priv->from_compositor_pipe[1]);
688 g_io_channel_unref (seat->priv->from_compositor_channel);
689 g_source_remove (seat->priv->from_compositor_watch);
690 g_free (seat->priv->read_buffer);
691 g_object_unref (seat->priv->compositor_process);
692 if (seat->priv->active_session)
693 g_object_unref (seat->priv->active_session);
694 if (seat->priv->active_display_server)
695 g_object_unref (seat->priv->active_display_server);
697 G_OBJECT_CLASS (seat_unity_parent_class)->finalize (object);
701 seat_unity_class_init (SeatUnityClass *klass)
703 GObjectClass *object_class = G_OBJECT_CLASS (klass);
704 SeatClass *seat_class = SEAT_CLASS (klass);
706 object_class->finalize = seat_unity_finalize;
707 seat_class->get_start_local_sessions = seat_unity_get_start_local_sessions;
708 seat_class->setup = seat_unity_setup;
709 seat_class->start = seat_unity_start;
710 seat_class->create_display_server = seat_unity_create_display_server;
711 seat_class->create_greeter_session = seat_unity_create_greeter_session;
712 seat_class->create_session = seat_unity_create_session;
713 seat_class->set_active_session = seat_unity_set_active_session;
714 seat_class->get_active_session = seat_unity_get_active_session;
715 seat_class->set_next_session = seat_unity_set_next_session;
716 seat_class->run_script = seat_unity_run_script;
717 seat_class->stop = seat_unity_stop;
719 g_type_class_add_private (klass, sizeof (SeatUnityPrivate));