Add more grpc - Asyncstuff
[src/agl-compositor.git] / src / shell.c
index f7ec6a2..d583fe5 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2019 Collabora, Ltd.
+ * Copyright © 2019, 2022 Collabora, Ltd.
  *
  * Permission is hereby granted, free of charge, to any person obtaining
  * a copy of this software and associated documentation files (the
 #include <string.h>
 #include <sys/socket.h>
 #include <sys/types.h>
+#include <sys/wait.h>
 #include <unistd.h>
 #include <libweston/libweston.h>
 #include <libweston/config-parser.h>
 
+#include <weston/weston.h>
 #include "shared/os-compatibility.h"
+#include "shared/helpers.h"
+#include "shared/process-util.h"
 
 #include "agl-shell-server-protocol.h"
 #include "agl-shell-desktop-server-protocol.h"
@@ -812,99 +816,211 @@ ivi_shell_advertise_xdg_surfaces(struct ivi_compositor *ivi, struct wl_resource
        }
 }
 
-static void
-client_exec(const char *command, int fd)
+static struct wl_client *
+client_launch(struct weston_compositor *compositor,
+                    struct weston_process *proc,
+                    const char *path,
+                    weston_process_cleanup_func_t cleanup)
 {
-       sigset_t sig;
-       char s[32];
+       struct wl_client *client = NULL;
+       struct custom_env child_env;
+       struct fdstr wayland_socket;
+       const char *fail_cloexec = "Couldn't unset CLOEXEC on client socket";
+       const char *fail_seteuid = "Couldn't call seteuid";
+       char *fail_exec;
+       char * const *argp;
+       char * const *envp;
+       sigset_t allsigs;
+       pid_t pid;
+       bool ret;
+       struct ivi_compositor *ivi;
+       size_t written __attribute__((unused));
 
-       /* Don't give the child our signal mask */
-       sigfillset(&sig);
-       sigprocmask(SIG_UNBLOCK, &sig, NULL);
+       weston_log("launching '%s'\n", path);
+       str_printf(&fail_exec, "Error: Couldn't launch client '%s'\n", path);
 
-       /* Launch clients as the user; don't give them the wrong euid */
-       if (seteuid(getuid()) == -1) {
-               weston_log("seteuid failed: %s\n", strerror(errno));
-               return;
+       custom_env_init_from_environ(&child_env);
+       custom_env_add_from_exec_string(&child_env, path);
+
+       if (os_socketpair_cloexec(AF_UNIX, SOCK_STREAM, 0,
+                                 wayland_socket.fds) < 0) {
+               weston_log("client_launch: "
+                          "socketpair failed while launching '%s': %s\n",
+                          path, strerror(errno));
+               custom_env_fini(&child_env);
+               return NULL;
        }
+       fdstr_update_str1(&wayland_socket);
+       custom_env_set_env_var(&child_env, "WAYLAND_SOCKET",
+                              wayland_socket.str1);
 
-       /* Duplicate fd to unset the CLOEXEC flag. We don't need to worry about
-        * clobbering fd, as we'll exit/exec either way.
-        */
-       fd = dup(fd);
-       if (fd == -1) {
-               weston_log("dup failed: %s\n", strerror(errno));
-               return;
+       argp = custom_env_get_argp(&child_env);
+       envp = custom_env_get_envp(&child_env);
+
+       pid = fork();
+       switch (pid) {
+       case 0:
+               /* Put the client in a new session so it won't catch signals
+                * intended for the parent. Sharing a session can be
+                * confusing when launching weston under gdb, as the ctrl-c
+                * intended for gdb will pass to the child, and weston
+                * will cleanly shut down when the child exits.
+                */
+               setsid();
+
+               /* do not give our signal mask to the new process */
+               sigfillset(&allsigs);
+               sigprocmask(SIG_UNBLOCK, &allsigs, NULL);
+
+               /* Launch clients as the user. Do not launch clients with wrong euid. */
+               if (seteuid(getuid()) == -1) {
+                       written = write(STDERR_FILENO, fail_seteuid, strlen(fail_seteuid));
+                       _exit(EXIT_FAILURE);
+               }
+
+               ret = fdstr_clear_cloexec_fd1(&wayland_socket);
+               if (!ret) {
+                       written = write(STDERR_FILENO, fail_cloexec, strlen(fail_cloexec));
+                       _exit(EXIT_FAILURE);
+               }
+
+               execve(argp[0], argp, envp);
+
+               if (fail_exec)
+                       written = write(STDERR_FILENO, fail_exec, strlen(fail_exec));
+               _exit(EXIT_FAILURE);
+
+       default:
+               close(wayland_socket.fds[1]);
+               ivi = weston_compositor_get_user_data(compositor);
+               client = wl_client_create(compositor->wl_display,
+                                         wayland_socket.fds[0]);
+               if (!client) {
+                       custom_env_fini(&child_env);
+                       close(wayland_socket.fds[0]);
+                       free(fail_exec);
+                       weston_log("client_launch: "
+                               "wl_client_create failed while launching '%s'.\n",
+                               path);
+                       return NULL;
+               }
+
+               proc->pid = pid;
+               proc->cleanup = cleanup;
+               wl_list_insert(&ivi->child_process_list, &proc->link);
+               break;
+
+       case -1:
+               fdstr_close_all(&wayland_socket);
+               weston_log("client_launch: "
+                          "fork failed while launching '%s': %s\n", path,
+                          strerror(errno));
+               break;
        }
 
-       snprintf(s, sizeof s, "%d", fd);
-       setenv("WAYLAND_SOCKET", s, 1);
+       custom_env_fini(&child_env);
+       free(fail_exec);
 
-       execl("/bin/sh", "/bin/sh", "-c", command, NULL);
-       weston_log("executing '%s' failed: %s", command, strerror(errno));
+       return client;
 }
 
-static struct wl_client *
-launch_shell_client(struct ivi_compositor *ivi, const char *command)
+struct process_info {
+       struct weston_process proc;
+       char *path;
+};
+
+int
+sigchld_handler(int signal_number, void *data)
 {
-       struct wl_client *client;
-       int sock[2];
+       struct weston_process *p;
+       struct ivi_compositor *ivi = data;
+       int status;
        pid_t pid;
 
-       weston_log("launching' %s'\n", command);
+       while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
+               wl_list_for_each(p, &ivi->child_process_list, link) {
+                       if (p->pid == pid)
+                               break;
+               }
 
-       if (os_socketpair_cloexec(AF_UNIX, SOCK_STREAM, 0, sock) < 0) {
-               weston_log("socketpair failed while launching '%s': %s\n",
-                          command, strerror(errno));
-               return NULL;
-       }
+               if (&p->link == &ivi->child_process_list) {
+                       weston_log("unknown child process exited\n");
+                       continue;
+               }
 
-       pid = fork();
-       if (pid == -1) {
-               close(sock[0]);
-               close(sock[1]);
-               weston_log("fork failed while launching '%s': %s\n",
-                          command, strerror(errno));
-               return NULL;
+               wl_list_remove(&p->link);
+               wl_list_init(&p->link);
+               p->cleanup(p, status);
        }
 
-       if (pid == 0) {
-               client_exec(command, sock[1]);
-               _Exit(EXIT_FAILURE);
-       }
-       close(sock[1]);
+       if (pid < 0 && errno != ECHILD)
+               weston_log("waitpid error %s\n", strerror(errno));
 
-       client = wl_client_create(ivi->compositor->wl_display, sock[0]);
-       if (!client) {
-               close(sock[0]);
-               weston_log("Failed to create wayland client for '%s'",
-                          command);
-               return NULL;
+       return 1;
+}
+
+
+static void
+process_handle_sigchld(struct weston_process *process, int status)
+{
+       struct process_info *pinfo =
+               container_of(process, struct process_info, proc);
+
+       /*
+        * There are no guarantees whether this runs before or after
+        * the wl_client destructor.
+        */
+
+       if (WIFEXITED(status)) {
+               weston_log("%s exited with status %d\n", pinfo->path,
+                          WEXITSTATUS(status));
+       } else if (WIFSIGNALED(status)) {
+               weston_log("%s died on signal %d\n", pinfo->path,
+                          WTERMSIG(status));
+       } else {
+               weston_log("%s disappeared\n", pinfo->path);
        }
 
-       return client;
+       free(pinfo->path);
+       free(pinfo);
 }
 
 int
-ivi_launch_shell_client(struct ivi_compositor *ivi)
+ivi_launch_shell_client(struct ivi_compositor *ivi, const char *cmd_section,
+                       struct wl_client **client)
 {
+       struct process_info *pinfo;
        struct weston_config_section *section;
        char *command = NULL;
 
-       section = weston_config_get_section(ivi->config, "shell-client",
-                                           NULL, NULL);
+       section = weston_config_get_section(ivi->config, cmd_section, NULL, NULL);
        if (section)
-               weston_config_section_get_string(section, "command",
-                                                &command, NULL);
+               weston_config_section_get_string(section, "command", &command, NULL);
 
        if (!command)
                return -1;
 
-       ivi->shell_client.client = launch_shell_client(ivi, command);
-       if (!ivi->shell_client.client)
+       pinfo = zalloc(sizeof *pinfo);
+       if (!pinfo)
                return -1;
 
+       pinfo->path = strdup(command);
+       if (!pinfo->path)
+               goto out_free;
+
+       *client = client_launch(ivi->compositor, &pinfo->proc, command, process_handle_sigchld);
+       if (!*client)
+               goto out_str;
+
        return 0;
+
+out_str:
+       free(pinfo->path);
+
+out_free:
+       free(pinfo);
+
+       return -1;
 }
 
 static void
@@ -1022,6 +1138,26 @@ insert_black_curtain(struct ivi_output *output)
        weston_log("Added black curtain to output %s\n", output->output->name);
 }
 
+void
+shell_send_app_state(struct ivi_compositor *ivi, const char *app_id,
+                    enum agl_shell_app_state state)
+{
+       if (app_id && wl_resource_get_version(ivi->shell_client.resource) >=
+           AGL_SHELL_APP_STATE_SINCE_VERSION) {
+
+               weston_log("%s() should sent app_state\n", __func__);
+               agl_shell_send_app_state(ivi->shell_client.resource,
+                                        app_id, state);
+
+               if (ivi->shell_client.resource_ext) {
+                       weston_log("%s() 2. should sent app_state %p\n", 
+                                       __func__, ivi->shell_client.resource_ext);
+                       agl_shell_send_app_state(ivi->shell_client.resource_ext,
+                                                app_id, state);
+               }
+       }
+}
+
 static void
 shell_ready(struct wl_client *client, struct wl_resource *shell_res)
 {
@@ -1060,11 +1196,7 @@ shell_ready(struct wl_client *client, struct wl_resource *shell_res)
                surface->checked_pending = true;
                app_id = weston_desktop_surface_get_app_id(surface->dsurface);
 
-               if (app_id &&
-                   wl_resource_get_version(ivi->shell_client.resource) >=
-                   AGL_SHELL_APP_STATE_SINCE_VERSION)
-                       agl_shell_send_app_state(ivi->shell_client.resource,
-                                                app_id, AGL_SHELL_APP_STATE_STARTED);
+               shell_send_app_state(ivi, app_id, AGL_SHELL_APP_STATE_STARTED);
        }
 }
 
@@ -1308,6 +1440,22 @@ shell_destroy(struct wl_client *client, struct wl_resource *res)
 {
 }
 
+static void
+shell_ext_destroy(struct wl_client *client, struct wl_resource *res)
+{
+       wl_resource_destroy(res);
+}
+
+static void
+shell_ext_doas(struct wl_client *client, struct wl_resource *res)
+{
+       struct  ivi_compositor *ivi = wl_resource_get_user_data(res);
+
+       ivi->shell_client_ext.doas_requested = true;
+       agl_shell_ext_send_doas_done(ivi->shell_client_ext.resource,
+                                    AGL_SHELL_EXT_DOAS_SHELL_CLIENT_STATUS_SUCCESS);
+}
+
 static const struct agl_shell_interface agl_shell_implementation = {
        .destroy = shell_destroy,
        .ready = shell_ready,
@@ -1316,6 +1464,11 @@ static const struct agl_shell_interface agl_shell_implementation = {
        .activate_app = shell_activate_app,
 };
 
+static const struct agl_shell_ext_interface agl_shell_ext_implementation = {
+       .destroy = shell_ext_destroy,
+       .doas_shell_client = shell_ext_doas,
+};
+
 static void
 shell_desktop_set_app_property(struct wl_client *client,
                               struct wl_resource *shell_res,
@@ -1441,6 +1594,14 @@ unbind_agl_shell(struct wl_resource *resource)
        ivi->shell_client.client = NULL;
 }
 
+static void
+unbind_agl_shell_ext(struct wl_resource *resource)
+{
+       struct ivi_compositor *ivi = wl_resource_get_user_data(resource);
+
+       ivi->shell_client_ext.resource = NULL;
+}
+
 static void
 bind_agl_shell(struct wl_client *client,
               void *data, uint32_t version, uint32_t id)
@@ -1472,8 +1633,25 @@ bind_agl_shell(struct wl_client *client,
                        return;
                }
 
-               agl_shell_send_bound_fail(resource);
-               ivi->shell_client.status = BOUND_FAILED;
+               if (ivi->shell_client_ext.resource && 
+                   ivi->shell_client_ext.doas_requested) {
+
+                       wl_resource_set_implementation(resource, &agl_shell_implementation,
+                                                      ivi, NULL);
+                       ivi->shell_client.resource_ext = resource;
+
+                       if (ivi->shell_client.status == BOUND_OK &&
+                           wl_resource_get_version(resource) >= AGL_SHELL_BOUND_OK_SINCE_VERSION) {
+                               ivi->shell_client_ext.status = BOUND_OK;
+                               agl_shell_send_bound_ok(ivi->shell_client.resource_ext);
+                               weston_log("Sent agl_shell_send_bound_ok to client ext %p\n", ivi->shell_client.resource_ext);
+                       }
+
+                       return;
+               } else {
+                       agl_shell_send_bound_fail(resource);
+                       ivi->shell_client.status = BOUND_FAILED;
+               }
        }
 
        wl_resource_set_implementation(resource, &agl_shell_implementation,
@@ -1485,6 +1663,30 @@ bind_agl_shell(struct wl_client *client,
                agl_shell_send_bound_ok(ivi->shell_client.resource);
 }
 
+static void
+bind_agl_shell_ext(struct wl_client *client,
+                  void *data, uint32_t version, uint32_t id)
+{
+       struct ivi_compositor *ivi = data;
+       struct wl_resource *resource;
+
+       resource = wl_resource_create(client, &agl_shell_ext_interface, version, id);
+       if (!resource) {
+               wl_client_post_no_memory(client);
+               return;
+       }
+
+       if (ivi->shell_client_ext.resource) {
+               wl_resource_post_error(resource, WL_DISPLAY_ERROR_INVALID_OBJECT,
+                                      "agl_shell_ext has already been bound");
+               return;
+       }
+
+       wl_resource_set_implementation(resource, &agl_shell_ext_implementation,
+                                      ivi, unbind_agl_shell_ext);
+       ivi->shell_client_ext.resource = resource;
+}
+
 static void
 unbind_agl_shell_desktop(struct wl_resource *resource)
 {
@@ -1548,6 +1750,14 @@ ivi_shell_create_global(struct ivi_compositor *ivi)
                return -1;
        }
 
+       ivi->agl_shell_ext = wl_global_create(ivi->compositor->wl_display,
+                                             &agl_shell_ext_interface, 1,
+                                             ivi, bind_agl_shell_ext);
+       if (!ivi->agl_shell_ext) {
+               weston_log("Failed to create agl_shell_ext global.\n");
+               return -1;
+       }
+
        ivi->agl_shell_desktop = wl_global_create(ivi->compositor->wl_display,
                                                  &agl_shell_desktop_interface, 2,
                                                  ivi, bind_agl_shell_desktop);