source/utils/CarlaProcessUtils.hpp

   1 /*
   2  * Carla process utils
   3  * Copyright (C) 2019-2022 Filipe Coelho <falktx@falktx.com>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of
   8  * the License, or any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * For a full copy of the GNU General Public License see the doc/GPL.txt file.
  16  */
  17
  18 #ifndef CARLA_PROCESS_UTILS_HPP_INCLUDED
  19 #define CARLA_PROCESS_UTILS_HPP_INCLUDED
  20
  21 #include "CarlaUtils.hpp"
  22
  23 #ifdef CARLA_OS_LINUX
  24 # include <sys/prctl.h>
  25 #endif
  26
  27 #ifdef CARLA_OS_MAC
  28 # include <dispatch/dispatch.h>
  29 #endif
  30
  31 #ifdef CARLA_OS_HAIKU
  32 typedef __sighandler_t sig_t;
  33 #endif
  34
  35 #ifndef CARLA_OS_WIN
  36 # include <csignal>
  37 # include <csetjmp>
  38 #endif
  39
  40 // --------------------------------------------------------------------------------------------------------------------
  41 // process functions
  42
  43 /*
  44  * Set current process name.
  45  */
  46 static inline
  47 void carla_setProcessName(const char* const name) noexcept
  48 {
  49     CARLA_SAFE_ASSERT_RETURN(name != nullptr && name[0] != '\0',);
  50
  51 #ifdef CARLA_OS_LINUX
  52     ::prctl(PR_SET_NAME, name, 0, 0, 0);
  53 #endif
  54 }
  55
  56 #ifdef CARLA_OS_MAC
  57 static inline
  58 void carla_macOS_proc_exit_handler_kill(void*)
  59 {
  60     carla_stdout("Carla bridge parent has died, killing ourselves now");
  61     ::kill(::getpid(), SIGKILL);
  62 }
  63 static inline
  64 void carla_macOS_proc_exit_handler_term(void*)
  65 {
  66     carla_stdout("Carla bridge parent has died, terminating ourselves now");
  67     ::kill(::getpid(), SIGTERM);
  68 }
  69 #endif
  70
  71 /*
  72  * Set flag to automatically terminate ourselves if parent process dies.
  73  */
  74 static inline
  75 void carla_terminateProcessOnParentExit(const bool kill) noexcept
  76 {
  77 #if defined(CARLA_OS_LINUX)
  78     ::prctl(PR_SET_PDEATHSIG, kill ? SIGKILL : SIGTERM);
  79 #elif defined(CARLA_OS_MAC)
  80     const dispatch_source_t source = dispatch_source_create(DISPATCH_SOURCE_TYPE_PROC,
  81                                                             ::getppid(),
  82                                                             DISPATCH_PROC_EXIT,
  83                                                             nullptr);
  84
  85     dispatch_source_set_event_handler_f(source, kill ? carla_macOS_proc_exit_handler_kill
  86                                                      : carla_macOS_proc_exit_handler_term);
  87
  88     dispatch_resume(source);
  89 #endif
  90
  91     // maybe unused
  92     return; (void)kill;
  93 }
  94
  95 // --------------------------------------------------------------------------------------------------------------------
  96 // process utility classes
  97
  98 #if !(defined(CARLA_OS_WASM) || defined(CARLA_OS_WIN))
  99 /*
 100  * Catches SIGABRT for a function scope.
 101  */
 102 class ScopedAbortCatcher {
 103 public:
 104     ScopedAbortCatcher();
 105     ~ScopedAbortCatcher();
 106
 107     inline bool wasTriggered() const
 108     {
 109         return s_triggered;
 110     }
 111
 112 private:
 113     static bool s_triggered;
 114     static jmp_buf s_env;
 115     static sig_t s_oldsig;
 116     static void sig_handler(const int signum);
 117
 118     CARLA_DECLARE_NON_COPYABLE(ScopedAbortCatcher)
 119     CARLA_PREVENT_HEAP_ALLOCATION
 120 };
 121 #endif
 122
 123 /*
 124  * Store and restore all signal handlers for a function scope.
 125  */
 126 class CarlaSignalRestorer {
 127 public:
 128   CarlaSignalRestorer();
 129   ~CarlaSignalRestorer();
 130
 131 private:
 132 #if !(defined(CARLA_OS_WASM) || defined(CARLA_OS_WIN))
 133     struct ::sigaction sigs[16];
 134 #endif
 135
 136     CARLA_DECLARE_NON_COPYABLE(CarlaSignalRestorer)
 137     CARLA_PREVENT_HEAP_ALLOCATION
 138 };
 139
 140 // --------------------------------------------------------------------------------------------------------------------
 141
 142 #endif // CARLA_PROCESS_UTILS_HPP_INCLUDED