1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
/* shutting down pluto, for libreswan
*
* Copyright (C) 2020 Andrew Cagney
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <https://www.gnu.org/licenses/gpl2.txt>.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
*/
#ifndef PLUTO_SHUTDOWN_H
#define PLUTO_SHUTDOWN_H
#include <stdbool.h>
struct logger;
/*
* The global EXITING_PLUTO is there as a hint to long running threads
* that they should also shutdown (it should be tested in the thread's
* main and some inner loops). Just note that, on its own, it isn't
* sufficient. Any long running threads will also need a gentle nudge
* (so that they loop around and detect the need to quit) and then a
* join to confirm that they have exited.
*/
extern volatile bool exiting_pluto;
/*
* "idle" then exit the event-loop, and then exit pluto.
*
* Recommended for shutting down while the event-loop is running.
*
* Using the event-loop: shutdown the helper threads; clean up any
* child processes; delete any states / connections; and close any
* open sockets.
*
* Then, once the event-loop exits (which should happen once there's
* nothing to do), clean up any remaining memory and exit pluto.
*
* The important thing here is that for much of the shutdown the event
* loop is still running. This way helper threads and states can
* continue to rely on the event-loop as they transition to the
* shutdown state (rather than special abort paths).
*/
void whack_shutdown(struct logger *logger, bool leave_state);
#endif
|
