2 * Copyright (C) 2013 Canonical Ltd.
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
18 #include <glib/gstdio.h>
21 #include "unity-system-compositor.h"
22 #include "configuration.h"
27 struct UnitySystemCompositorPrivate
29 /* Compositor process */
32 /* Command to run the compositor */
35 /* Socket to communicate on */
42 /* TRUE if should show hardware cursor */
43 gboolean enable_hardware_cursor;
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 /* Buffer reading from channel */
55 gsize read_buffer_length;
56 gsize read_buffer_n_used;
58 /* Timeout when waiting for compositor to start */
62 /* TRUE when received ready signal */
66 G_DEFINE_TYPE (UnitySystemCompositor, unity_system_compositor, DISPLAY_SERVER_TYPE);
72 USC_MESSAGE_READY = 2,
73 USC_MESSAGE_SESSION_CONNECTED = 3,
74 USC_MESSAGE_SET_ACTIVE_SESSION = 4,
75 USC_MESSAGE_SET_NEXT_SESSION = 5,
78 UnitySystemCompositor *
79 unity_system_compositor_new (void)
81 return g_object_new (UNITY_SYSTEM_COMPOSITOR_TYPE, NULL);
85 unity_system_compositor_set_command (UnitySystemCompositor *compositor, const gchar *command)
87 g_return_if_fail (compositor != NULL);
88 g_free (compositor->priv->command);
89 compositor->priv->command = g_strdup (command);
93 unity_system_compositor_set_socket (UnitySystemCompositor *compositor, const gchar *socket)
95 g_return_if_fail (compositor != NULL);
96 g_free (compositor->priv->socket);
97 compositor->priv->socket = g_strdup (socket);
101 unity_system_compositor_get_socket (UnitySystemCompositor *compositor)
103 g_return_val_if_fail (compositor != NULL, NULL);
104 return compositor->priv->socket;
108 unity_system_compositor_set_vt (UnitySystemCompositor *compositor, gint vt)
110 g_return_if_fail (compositor != NULL);
112 if (compositor->priv->have_vt_ref)
113 vt_unref (compositor->priv->vt);
114 compositor->priv->have_vt_ref = FALSE;
115 compositor->priv->vt = vt;
119 compositor->priv->have_vt_ref = TRUE;
124 unity_system_compositor_set_enable_hardware_cursor (UnitySystemCompositor *compositor, gboolean enable_cursor)
126 g_return_if_fail (compositor != NULL);
127 compositor->priv->enable_hardware_cursor = enable_cursor;
131 unity_system_compositor_set_timeout (UnitySystemCompositor *compositor, gint timeout)
133 g_return_if_fail (compositor != NULL);
134 compositor->priv->timeout = timeout;
138 write_message (UnitySystemCompositor *compositor, guint16 id, const guint8 *payload, guint16 payload_length)
141 gsize data_length = 4 + payload_length;
143 data = g_malloc (data_length);
146 data[2] = payload_length >> 8;
147 data[3] = payload_length & 0xFF;
148 memcpy (data + 4, payload, payload_length);
151 if (write (compositor->priv->to_compositor_pipe[1], data, data_length) != data_length)
152 l_warning (compositor, "Failed to write to compositor: %s", strerror (errno));
158 unity_system_compositor_set_active_session (UnitySystemCompositor *compositor, const gchar *id)
160 g_return_if_fail (compositor != NULL);
161 write_message (compositor, USC_MESSAGE_SET_ACTIVE_SESSION, (const guint8 *) id, strlen (id));
165 unity_system_compositor_set_next_session (UnitySystemCompositor *compositor, const gchar *id)
167 g_return_if_fail (compositor != NULL);
168 write_message (compositor, USC_MESSAGE_SET_NEXT_SESSION, (const guint8 *) id, strlen (id));
172 unity_system_compositor_get_vt (DisplayServer *server)
174 g_return_val_if_fail (server != NULL, 0);
175 return UNITY_SYSTEM_COMPOSITOR (server)->priv->vt;
179 unity_system_compositor_connect_session (DisplayServer *display_server, Session *session)
181 UnitySystemCompositor *compositor = UNITY_SYSTEM_COMPOSITOR (display_server);
184 session_set_env (session, "XDG_SESSION_TYPE", "mir");
186 if (compositor->priv->socket)
187 session_set_env (session, "MIR_SOCKET", compositor->priv->socket);
188 if (IS_GREETER (session))
192 session_set_env (session, "MIR_SERVER_NAME", name);
194 if (compositor->priv->vt >= 0)
196 gchar *value = g_strdup_printf ("%d", compositor->priv->vt);
197 session_set_env (session, "XDG_VTNR", value);
203 unity_system_compositor_disconnect_session (DisplayServer *display_server, Session *session)
205 session_unset_env (session, "XDG_SESSION_TYPE");
206 session_unset_env (session, "MIR_SOCKET");
207 session_unset_env (session, "MIR_SERVER_NAME");
208 session_unset_env (session, "XDG_VTNR");
212 get_absolute_command (const gchar *command)
215 gchar *absolute_binary, *absolute_command = NULL;
217 tokens = g_strsplit (command, " ", 2);
219 absolute_binary = g_find_program_in_path (tokens[0]);
223 absolute_command = g_strjoin (" ", absolute_binary, tokens[1], NULL);
225 absolute_command = g_strdup (absolute_binary);
227 g_free (absolute_binary);
231 return absolute_command;
235 read_cb (GIOChannel *source, GIOCondition condition, gpointer data)
237 UnitySystemCompositor *compositor = data;
239 guint16 id, payload_length;
242 if (condition == G_IO_HUP)
244 l_debug (compositor, "Compositor closed communication channel");
245 compositor->priv->from_compositor_watch = 0;
249 /* Work out how much required for a message */
250 if (compositor->priv->read_buffer_n_used < 4)
251 n_to_read = 4 - compositor->priv->read_buffer_n_used;
254 payload_length = compositor->priv->read_buffer[2] << 8 | compositor->priv->read_buffer[3];
255 n_to_read = 4 + payload_length - compositor->priv->read_buffer_n_used;
258 /* Read from compositor */
261 gsize n_total, n_read = 0;
263 GError *error = NULL;
265 n_total = compositor->priv->read_buffer_n_used + n_to_read;
266 if (compositor->priv->read_buffer_length < n_total)
267 compositor->priv->read_buffer = g_realloc (compositor->priv->read_buffer, n_total);
269 status = g_io_channel_read_chars (source,
270 (gchar *)compositor->priv->read_buffer + compositor->priv->read_buffer_n_used,
275 l_warning (compositor, "Failed to read from compositor: %s", error->message);
276 if (status != G_IO_STATUS_NORMAL)
278 g_clear_error (&error);
279 compositor->priv->read_buffer_n_used += n_read;
283 if (compositor->priv->read_buffer_n_used < 4)
285 id = compositor->priv->read_buffer[0] << 8 | compositor->priv->read_buffer[1];
286 payload_length = compositor->priv->read_buffer[2] << 8 | compositor->priv->read_buffer[3];
289 if (compositor->priv->read_buffer_n_used < 4 + payload_length)
291 /*payload = compositor->priv->read_buffer + 4;*/
295 case USC_MESSAGE_PING:
296 l_debug (compositor, "PING!");
297 write_message (compositor, USC_MESSAGE_PONG, NULL, 0);
299 case USC_MESSAGE_PONG:
300 l_debug (compositor, "PONG!");
302 case USC_MESSAGE_READY:
303 l_debug (compositor, "READY");
304 if (!compositor->priv->is_ready)
306 compositor->priv->is_ready = TRUE;
307 l_debug (compositor, "Compositor ready");
308 g_source_remove (compositor->priv->timeout_source);
309 compositor->priv->timeout_source = 0;
310 DISPLAY_SERVER_CLASS (unity_system_compositor_parent_class)->start (DISPLAY_SERVER (compositor));
313 case USC_MESSAGE_SESSION_CONNECTED:
314 l_debug (compositor, "SESSION CONNECTED");
317 l_warning (compositor, "Ignoring unknown message %d with %d octets from system compositor", id, payload_length);
322 compositor->priv->read_buffer_n_used = 0;
328 run_cb (Process *process, gpointer user_data)
332 /* Make input non-blocking */
333 fd = open ("/dev/null", O_RDONLY);
334 dup2 (fd, STDIN_FILENO);
339 timeout_cb (gpointer data)
341 UnitySystemCompositor *compositor = data;
343 /* Stop the compositor - it is not working */
344 display_server_stop (DISPLAY_SERVER (compositor));
346 compositor->priv->timeout_source = 0;
352 stopped_cb (Process *process, UnitySystemCompositor *compositor)
354 l_debug (compositor, "Unity system compositor stopped");
356 if (compositor->priv->timeout_source != 0)
357 g_source_remove (compositor->priv->timeout_source);
358 compositor->priv->timeout_source = 0;
360 /* Release VT and display number for re-use */
361 if (compositor->priv->have_vt_ref)
363 vt_unref (compositor->priv->vt);
364 compositor->priv->have_vt_ref = FALSE;
367 DISPLAY_SERVER_CLASS (unity_system_compositor_parent_class)->stop (DISPLAY_SERVER (compositor));
371 unity_system_compositor_start (DisplayServer *server)
373 UnitySystemCompositor *compositor = UNITY_SYSTEM_COMPOSITOR (server);
376 gchar *dir, *log_file, *absolute_command, *value;
378 g_return_val_if_fail (compositor->priv->process == NULL, FALSE);
380 compositor->priv->is_ready = FALSE;
382 g_return_val_if_fail (compositor->priv->command != NULL, FALSE);
384 /* Create pipes to talk to compositor */
385 if (pipe (compositor->priv->to_compositor_pipe) < 0 || pipe (compositor->priv->from_compositor_pipe) < 0)
387 l_debug (compositor, "Failed to create compositor pipes: %s", g_strerror (errno));
391 /* Don't allow the daemon end of the pipes to be accessed in the compositor */
392 fcntl (compositor->priv->to_compositor_pipe[1], F_SETFD, FD_CLOEXEC);
393 fcntl (compositor->priv->from_compositor_pipe[0], F_SETFD, FD_CLOEXEC);
395 /* Listen for messages from the compositor */
396 compositor->priv->from_compositor_channel = g_io_channel_unix_new (compositor->priv->from_compositor_pipe[0]);
397 compositor->priv->from_compositor_watch = g_io_add_watch (compositor->priv->from_compositor_channel, G_IO_IN | G_IO_HUP, read_cb, compositor);
400 dir = config_get_string (config_get_instance (), "LightDM", "log-directory");
401 log_file = g_build_filename (dir, "unity-system-compositor.log", NULL);
402 l_debug (compositor, "Logging to %s", log_file);
405 /* Setup environment */
406 compositor->priv->process = process_new (run_cb, compositor);
407 process_set_log_file (compositor->priv->process, log_file, TRUE);
409 process_set_clear_environment (compositor->priv->process, TRUE);
410 process_set_env (compositor->priv->process, "XDG_SEAT", "seat0");
411 value = g_strdup_printf ("%d", compositor->priv->vt);
412 process_set_env (compositor->priv->process, "XDG_VTNR", value);
414 /* Variable required for regression tests */
415 if (g_getenv ("LIGHTDM_TEST_ROOT"))
417 process_set_env (compositor->priv->process, "LIGHTDM_TEST_ROOT", g_getenv ("LIGHTDM_TEST_ROOT"));
418 process_set_env (compositor->priv->process, "LD_PRELOAD", g_getenv ("LD_PRELOAD"));
419 process_set_env (compositor->priv->process, "LD_LIBRARY_PATH", g_getenv ("LD_LIBRARY_PATH"));
422 /* Generate command line to run */
423 absolute_command = get_absolute_command (compositor->priv->command);
424 if (!absolute_command)
426 l_debug (compositor, "Can't launch compositor %s, not found in path", compositor->priv->command);
429 command = g_string_new (absolute_command);
430 g_free (absolute_command);
431 g_string_append_printf (command, " --file '%s'", compositor->priv->socket);
432 g_string_append_printf (command, " --from-dm-fd %d --to-dm-fd %d", compositor->priv->to_compositor_pipe[0], compositor->priv->from_compositor_pipe[1]);
433 if (compositor->priv->vt > 0)
434 g_string_append_printf (command, " --vt %d", compositor->priv->vt);
435 if (compositor->priv->enable_hardware_cursor)
436 g_string_append (command, " --enable-hardware-cursor=true");
437 process_set_command (compositor->priv->process, command->str);
438 g_string_free (command, TRUE);
440 /* Start the compositor */
441 g_signal_connect (compositor->priv->process, "stopped", G_CALLBACK (stopped_cb), compositor);
442 result = process_start (compositor->priv->process, FALSE);
444 /* Close compostor ends of the pipes */
445 close (compositor->priv->to_compositor_pipe[0]);
446 compositor->priv->to_compositor_pipe[0] = 0;
447 close (compositor->priv->from_compositor_pipe[1]);
448 compositor->priv->from_compositor_pipe[1] = 0;
453 /* Connect to the compositor */
454 if (compositor->priv->timeout > 0)
456 l_debug (compositor, "Waiting for system compositor for %ds", compositor->priv->timeout);
457 compositor->priv->timeout_source = g_timeout_add (compositor->priv->timeout * 1000, timeout_cb, compositor);
464 unity_system_compositor_stop (DisplayServer *server)
466 process_stop (UNITY_SYSTEM_COMPOSITOR (server)->priv->process);
470 unity_system_compositor_init (UnitySystemCompositor *compositor)
472 compositor->priv = G_TYPE_INSTANCE_GET_PRIVATE (compositor, UNITY_SYSTEM_COMPOSITOR_TYPE, UnitySystemCompositorPrivate);
473 compositor->priv->vt = -1;
474 compositor->priv->command = g_strdup ("unity-system-compositor");
475 compositor->priv->socket = g_strdup ("/run/mir_socket");
476 compositor->priv->timeout = -1;
480 unity_system_compositor_finalize (GObject *object)
482 UnitySystemCompositor *self;
484 self = UNITY_SYSTEM_COMPOSITOR (object);
486 if (self->priv->process)
488 g_signal_handlers_disconnect_matched (self->priv->process, G_SIGNAL_MATCH_DATA, 0, 0, NULL, NULL, self);
489 g_object_unref (self->priv->process);
491 g_free (self->priv->command);
492 g_free (self->priv->socket);
493 if (self->priv->have_vt_ref)
494 vt_unref (self->priv->vt);
495 close (self->priv->to_compositor_pipe[0]);
496 close (self->priv->to_compositor_pipe[1]);
497 close (self->priv->from_compositor_pipe[0]);
498 close (self->priv->from_compositor_pipe[1]);
499 g_io_channel_unref (self->priv->from_compositor_channel);
500 if (self->priv->from_compositor_watch)
501 g_source_remove (self->priv->from_compositor_watch);
502 g_free (self->priv->read_buffer);
503 if (self->priv->timeout_source)
504 g_source_remove (self->priv->timeout_source);
506 G_OBJECT_CLASS (unity_system_compositor_parent_class)->finalize (object);
510 unity_system_compositor_class_init (UnitySystemCompositorClass *klass)
512 GObjectClass *object_class = G_OBJECT_CLASS (klass);
513 DisplayServerClass *display_server_class = DISPLAY_SERVER_CLASS (klass);
515 display_server_class->get_vt = unity_system_compositor_get_vt;
516 display_server_class->connect_session = unity_system_compositor_connect_session;
517 display_server_class->disconnect_session = unity_system_compositor_disconnect_session;
518 display_server_class->start = unity_system_compositor_start;
519 display_server_class->stop = unity_system_compositor_stop;
520 object_class->finalize = unity_system_compositor_finalize;
522 g_type_class_add_private (klass, sizeof (UnitySystemCompositorPrivate));