3 #include "baseproc-sys.h"
6 // This header defines base_proc_service (base process service) and several derivatives, as well as some
7 // utility functions and classes. See service.h for full details of services.
9 // Given a string and a list of pairs of (start,end) indices for each argument in that string,
10 // store a null terminator for the argument. Return a `char *` vector containing the beginning
11 // of each argument and a trailing nullptr. (The returned array is invalidated if the string is later modified).
12 std::vector<const char *> separate_args(std::string &s, std::list<std::pair<unsigned,unsigned>> &arg_indices);
14 class base_process_service;
16 // A timer for process restarting. Used to ensure a minimum delay between process restarts (and
17 // also for timing service stop before the SIGKILL hammer is used).
18 class process_restart_timer : public eventloop_t::timer_impl<process_restart_timer>
21 base_process_service * service;
23 process_restart_timer(base_process_service *service_p)
28 dasynq::rearm timer_expiry(eventloop_t &, int expiry_count);
31 // Base class for process-based services.
32 class base_process_service : public service_record
34 friend class service_child_watcher;
35 friend class exec_status_pipe_watcher;
36 friend class base_process_service_test;
40 void do_restart() noexcept;
43 string program_name; // storage for program/script and arguments
44 std::vector<const char *> exec_arg_parts; // pointer to each argument/part of the program_name, and nullptr
46 string stop_command; // storage for stop program/script and arguments
47 std::vector<const char *> stop_arg_parts; // pointer to each argument/part of the stop_command, and nullptr
49 string working_dir; // working directory (or empty)
51 service_child_watcher child_listener;
52 exec_status_pipe_watcher child_status_listener;
53 process_restart_timer restart_timer;
54 time_val last_start_time;
56 // Restart interval time and restart count are used to track the number of automatic restarts
57 // over an interval. Too many restarts over an interval will inhibit further restarts.
58 time_val restart_interval_time; // current restart interval
59 int restart_interval_count; // count of restarts within current interval
61 time_val restart_interval; // maximum restart interval
62 int max_restart_interval_count; // number of restarts allowed over maximum interval
63 time_val restart_delay; // delay between restarts
65 // Time allowed for service stop, after which SIGKILL is sent. 0 to disable.
66 time_val stop_timeout = {10, 0}; // default of 10 seconds
68 // Time allowed for service start, after which SIGINT is sent (and then SIGKILL after
69 // <stop_timeout>). 0 to disable.
70 time_val start_timeout = {60, 0}; // default of 1 minute
72 uid_t run_as_uid = -1;
73 gid_t run_as_gid = -1;
75 pid_t pid = -1; // PID of the process. If state is STARTING or STOPPING,
76 // this is PID of the service script; otherwise it is the
77 // PID of the process itself (process service).
78 bp_sys::exit_status exit_status; // Exit status, if the process has exited (pid == -1).
79 int socket_fd = -1; // For socket-activation services, this is the file
80 // descriptor for the socket.
82 bool waiting_restart_timer : 1;
83 bool stop_timer_armed : 1;
84 bool reserved_child_watch : 1;
85 bool tracking_child : 1; // whether we expect to see child process status
86 bool start_is_interruptible : 1; // whether we can interrupt start
88 // Launch the process with the given arguments, return true on success
89 bool start_ps_process(const std::vector<const char *> &args, bool on_console) noexcept;
91 // Restart the process (due to start failure or unexpected termination). Restarts will be
93 bool restart_ps_process() noexcept;
95 // Perform smooth recovery process
96 void do_smooth_recovery() noexcept;
98 // Start the process, return true on success
99 virtual bool bring_up() noexcept override;
101 // Called when the process exits. The exit_status is the status value yielded by
102 // the "wait" system call.
103 virtual void handle_exit_status(bp_sys::exit_status exit_status) noexcept = 0;
105 // Called if an exec fails.
106 virtual void exec_failed(int errcode) noexcept = 0;
108 // Called if exec succeeds.
109 virtual void exec_succeeded() noexcept { };
111 virtual bool can_interrupt_start() noexcept override
113 return waiting_restart_timer || start_is_interruptible || service_record::can_interrupt_start();
116 virtual bool can_proceed_to_start() noexcept override
118 return ! waiting_restart_timer;
121 virtual bool interrupt_start() noexcept override;
123 void becoming_inactive() noexcept override;
126 void kill_with_fire() noexcept;
128 // Signal the process group of the service process
129 void kill_pg(int signo) noexcept;
132 void emergency_stop() noexcept;
134 // Open the activation socket, return false on failure
135 bool open_socket() noexcept;
138 // Constructor for a base_process_service. Note that the various parameters not specified here must in
139 // general be set separately (using the appropriate set_xxx function for each).
140 base_process_service(service_set *sset, string name, service_type_t record_type_p, string &&command,
141 std::list<std::pair<unsigned,unsigned>> &command_offsets,
142 const std::list<prelim_dep> &deplist_p);
144 ~base_process_service() noexcept
146 if (reserved_child_watch) {
147 child_listener.unreserve(event_loop);
149 restart_timer.deregister(event_loop);
152 // Set the stop command and arguments (may throw std::bad_alloc)
153 void set_stop_command(std::string command, std::list<std::pair<unsigned,unsigned>> &stop_command_offsets)
155 stop_command = command;
156 stop_arg_parts = separate_args(stop_command, stop_command_offsets);
159 void set_restart_interval(timespec interval, int max_restarts) noexcept
161 restart_interval = interval;
162 max_restart_interval_count = max_restarts;
165 void set_restart_delay(timespec delay) noexcept
167 restart_delay = delay;
170 void set_stop_timeout(timespec timeout) noexcept
172 stop_timeout = timeout;
175 void set_start_timeout(timespec timeout) noexcept
177 start_timeout = timeout;
180 void set_start_interruptible(bool value) noexcept
182 start_is_interruptible = value;
185 // Set an additional signal (other than SIGTERM) to be used to terminate the process
186 void set_extra_termination_signal(int signo) noexcept
188 this->term_signal = signo;
191 // Set the uid/gid that the service process will be run as
192 void set_run_as_uid_gid(uid_t uid, gid_t gid) noexcept
198 // Set the working directory
199 void set_workding_dir(string working_dir_p)
201 working_dir = working_dir_p;
204 // The restart/stop timer expired.
205 void timer_expired() noexcept;
207 // Accessor for testing:
208 const std::vector<const char *> & get_exec_arg_parts() noexcept
210 return exec_arg_parts;
214 // Standard process service.
215 class process_service : public base_process_service
217 virtual void handle_exit_status(bp_sys::exit_status exit_status) noexcept override;
218 virtual void exec_failed(int errcode) noexcept override;
219 virtual void exec_succeeded() noexcept override;
220 virtual void bring_down() noexcept override;
223 process_service(service_set *sset, string name, string &&command,
224 std::list<std::pair<unsigned,unsigned>> &command_offsets,
225 std::list<prelim_dep> depends_p)
226 : base_process_service(sset, name, service_type_t::PROCESS, std::move(command), command_offsets,
231 ~process_service() noexcept
236 // Bgproc (self-"backgrounding", i.e. double-forking) process service
237 class bgproc_service : public base_process_service
239 virtual void handle_exit_status(bp_sys::exit_status exit_status) noexcept override;
240 virtual void exec_failed(int errcode) noexcept override;
241 virtual void bring_down() noexcept override;
243 enum class pid_result_t {
245 FAILED, // failed to read pid or read invalid pid
246 TERMINATED // read pid successfully, but the process already terminated
249 // Read the pid-file, return false on failure
250 pid_result_t read_pid_file(bp_sys::exit_status *exit_status) noexcept;
253 bgproc_service(service_set *sset, string name, string &&command,
254 std::list<std::pair<unsigned,unsigned>> &command_offsets,
255 std::list<prelim_dep> depends_p)
256 : base_process_service(sset, name, service_type_t::BGPROCESS, std::move(command), command_offsets,
261 ~bgproc_service() noexcept
266 // Service which is started and stopped via separate commands
267 class scripted_service : public base_process_service
269 virtual void handle_exit_status(bp_sys::exit_status exit_status) noexcept override;
270 virtual void exec_succeeded() noexcept override;
271 virtual void exec_failed(int errcode) noexcept override;
272 virtual void bring_down() noexcept override;
274 virtual bool interrupt_start() noexcept override
276 // if base::interrupt_start() returns false, then start hasn't been fully interrupted, but an
277 // interrupt has been issued:
278 interrupting_start = ! base_process_service::interrupt_start();
279 return ! interrupting_start;
282 bool interrupting_start : 1; // running start script (true) or stop script (false)
285 scripted_service(service_set *sset, string name, string &&command,
286 std::list<std::pair<unsigned,unsigned>> &command_offsets,
287 std::list<prelim_dep> depends_p)
288 : base_process_service(sset, name, service_type_t::SCRIPTED, std::move(command), command_offsets,
289 depends_p), interrupting_start(false)
293 ~scripted_service() noexcept