shared/process-util.h

   1 /*
   2  * Copyright 2022 Collabora, Ltd.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining
   5  * a copy of this software and associated documentation files (the
   6  * "Software"), to deal in the Software without restriction, including
   7  * without limitation the rights to use, copy, modify, merge, publish,
   8  * distribute, sublicense, and/or sell copies of the Software, and to
   9  * permit persons to whom the Software is furnished to do so, subject to
  10  * the following conditions:
  11  *
  12  * The above copyright notice and this permission notice (including the
  13  * next paragraph) shall be included in all copies or substantial
  14  * portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  20  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  21  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <unistd.h>
  30
  31 #include <wayland-util.h>
  32
  33 #include "os-compatibility.h"
  34 #include "string-helpers.h"
  35
  36 /**
  37  * A container for file descriptors and their string representations, designed
  38  * to be used when forking child processes.
  39  *
  40  * fds[0] is generally used as the file descriptor held within the parent
  41  * process to communicate with the child, and fds[1] as the child's counterpart.
  42  *
  43  * str1[] is used as a string representation of fds[1].
  44  */
  45 struct fdstr {
  46         char str1[12];
  47         int fds[2];
  48 };
  49
  50 void
  51 fdstr_update_str1(struct fdstr *s);
  52
  53 void
  54 fdstr_set_fd1(struct fdstr *s, int fd);
  55
  56 bool
  57 fdstr_clear_cloexec_fd1(struct fdstr *s);
  58
  59 void
  60 fdstr_close_all(struct fdstr *s);
  61
  62
  63 /**
  64  * A container for environment variables and/or process arguments, designed to
  65  * be used when forking child processes, as setenv() and anything which
  66  * allocates memory cannot be used between fork() and exec().
  67  */
  68 struct custom_env {
  69         struct wl_array envp;
  70         bool env_finalized;
  71         struct wl_array argp;
  72         bool arg_finalized;
  73 };
  74
  75 void
  76 custom_env_init_from_environ(struct custom_env *env);
  77
  78 void
  79 custom_env_fini(struct custom_env *env);
  80
  81 void
  82 custom_env_set_env_var(struct custom_env *env, const char *name, const char *value);
  83
  84 void
  85 custom_env_add_arg(struct custom_env *env, const char *arg);
  86
  87 void
  88 custom_env_add_from_exec_string(struct custom_env *env, const char *exec_str);
  89
  90 char *const *
  91 custom_env_get_envp(struct custom_env *env);
  92
  93 char *const *
  94 custom_env_get_argp(struct custom_env *env);