pacemaker  2.1.4-dc6eb4362
Scalable High-Availability cluster resource manager
mainloop.h
Go to the documentation of this file.
1 /*
2  * Copyright 2009-2021 the Pacemaker project contributors
3  *
4  * The version control history for this file may have further details.
5  *
6  * This source code is licensed under the GNU Lesser General Public License
7  * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
8  */
9 
10 #ifndef PCMK__CRM_COMMON_MAINLOOP__H
11 # define PCMK__CRM_COMMON_MAINLOOP__H
12 
13 # include <signal.h> // sighandler_t
14 # include <glib.h>
15 # include <stdbool.h>
16 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20 
28  /* don't kill pid group on timeout, only kill the pid */
30 };
31 
32 typedef struct trigger_s crm_trigger_t;
33 typedef struct mainloop_io_s mainloop_io_t;
34 typedef struct mainloop_child_s mainloop_child_t;
35 typedef struct mainloop_timer_s mainloop_timer_t;
36 
37 void mainloop_cleanup(void);
38 
39 crm_trigger_t *mainloop_add_trigger(int priority, int (*dispatch) (gpointer user_data),
40  gpointer userdata);
41 
42 void mainloop_set_trigger(crm_trigger_t * source);
43 
45 
46 gboolean mainloop_destroy_trigger(crm_trigger_t * source);
47 
48 # ifndef HAVE_SIGHANDLER_T
49 typedef void (*sighandler_t)(int);
50 # endif
51 
53 
54 gboolean mainloop_add_signal(int sig, void (*dispatch) (int sig));
55 
56 gboolean mainloop_destroy_signal(int sig);
57 
59 
61 
63 
64 guint mainloop_timer_set_period(mainloop_timer_t *t, guint period_ms);
65 
66 mainloop_timer_t *mainloop_timer_add(const char *name, guint period_ms, bool repeat, GSourceFunc cb, void *userdata);
67 
69 
70 
71 # include <crm/common/ipc.h>
72 # include <qb/qbipcs.h>
73 
84  int (*dispatch) (const char *buffer, ssize_t length, gpointer userdata);
85 
91  void (*destroy) (gpointer userdata);
92 };
93 
94 qb_ipcs_service_t *mainloop_add_ipc_server(const char *name, enum qb_ipc_type type,
95  struct qb_ipcs_service_handlers *callbacks);
96 
116 qb_ipcs_service_t *mainloop_add_ipc_server_with_prio(const char *name,
117  enum qb_ipc_type type,
118  struct qb_ipcs_service_handlers *callbacks,
119  enum qb_loop_priority prio);
120 
121 void mainloop_del_ipc_server(qb_ipcs_service_t * server);
122 
123 mainloop_io_t *mainloop_add_ipc_client(const char *name, int priority, size_t max_size,
124  void *userdata, struct ipc_client_callbacks *callbacks);
125 
127 
129 
138  int (*dispatch) (gpointer userdata);
139 
145  void (*destroy) (gpointer userdata);
146 };
147 
148 mainloop_io_t *mainloop_add_fd(const char *name, int priority, int fd, void *userdata,
149  struct mainloop_fd_callbacks *callbacks);
150 
151 void mainloop_del_fd(mainloop_io_t * client);
152 
153 /*
154  * Create a new tracked process
155  * To track a process group, use -pid
156  */
157 void mainloop_child_add(pid_t pid,
158  int timeout,
159  const char *desc,
160  void *userdata,
161  void (*callback) (mainloop_child_t * p, pid_t pid, int core, int signo, int exitcode));
162 
164  int timeout,
165  const char *desc,
166  void *userdata,
168  void (*callback) (mainloop_child_t * p, pid_t pid, int core, int signo, int exitcode));
169 
172 const char *mainloop_child_name(mainloop_child_t * child);
173 
174 pid_t mainloop_child_pid(mainloop_child_t * child);
176 gboolean mainloop_child_kill(pid_t pid);
177 
178 void pcmk_quit_main_loop(GMainLoop *mloop, unsigned int n);
179 void pcmk_drain_main_loop(GMainLoop *mloop, guint timer_ms,
180  bool (*check)(guint));
181 
182 # define G_PRIORITY_MEDIUM (G_PRIORITY_HIGH/2)
183 
184 #if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
186 #endif
187 
188 #ifdef __cplusplus
189 }
190 #endif
191 
192 #endif
gboolean mainloop_add_signal(int sig, void(*dispatch)(int sig))
Definition: mainloop.c:355
mainloop_io_t * mainloop_add_fd(const char *name, int priority, int fd, void *userdata, struct mainloop_fd_callbacks *callbacks)
Definition: mainloop.c:976
void mainloop_timer_start(mainloop_timer_t *t)
Definition: mainloop.c:1350
guint mainloop_timer_set_period(mainloop_timer_t *t, guint period_ms)
Definition: mainloop.c:1370
mainloop_child_flags
Definition: mainloop.h:27
void mainloop_timer_del(mainloop_timer_t *t)
Definition: mainloop.c:1407
const char * name
Definition: cib.c:24
gboolean mainloop_child_kill(pid_t pid)
Definition: mainloop.c:1216
void(* destroy)(gpointer userdata)
Destroy function for mainloop file descriptor client data.
Definition: mainloop.h:145
Deprecated Pacemaker mainloop API.
qb_ipcs_service_t * mainloop_add_ipc_server_with_prio(const char *name, enum qb_ipc_type type, struct qb_ipcs_service_handlers *callbacks, enum qb_loop_priority prio)
Start server-side API end-point, hooked into the internal event loop.
Definition: mainloop.c:677
void pcmk_drain_main_loop(GMainLoop *mloop, guint timer_ms, bool(*check)(guint))
Process main loop events while a certain condition is met.
Definition: mainloop.c:1465
struct mainloop_timer_s mainloop_timer_t
Definition: mainloop.h:35
struct mainloop_io_s mainloop_io_t
Definition: mainloop.h:33
void mainloop_child_add_with_flags(pid_t pid, int timeout, const char *desc, void *userdata, enum mainloop_child_flags, void(*callback)(mainloop_child_t *p, pid_t pid, int core, int signo, int exitcode))
Definition: mainloop.c:1272
struct mainloop_child_s mainloop_child_t
Definition: mainloop.h:34
void mainloop_set_trigger(crm_trigger_t *source)
Definition: mainloop.c:198
void mainloop_cleanup(void)
Definition: mainloop.c:429
pid_t mainloop_child_pid(mainloop_child_t *child)
Definition: mainloop.c:1036
enum crm_ais_msg_types type
Definition: cpg.c:48
gboolean mainloop_destroy_trigger(crm_trigger_t *source)
Definition: mainloop.c:206
void mainloop_timer_stop(mainloop_timer_t *t)
Definition: mainloop.c:1360
struct trigger_s crm_trigger_t
Definition: mainloop.h:32
int(* dispatch)(gpointer userdata)
Dispatch function for mainloop file descriptor with data ready.
Definition: mainloop.h:138
uint32_t pid
Definition: cpg.c:46
void * mainloop_child_userdata(mainloop_child_t *child)
Definition: mainloop.c:1054
struct crm_ipc_s crm_ipc_t
Definition: ipc.h:163
void(* destroy)(gpointer userdata)
Destroy function for mainloop IPC connection client data.
Definition: mainloop.h:91
sighandler_t crm_signal_handler(int sig, sighandler_t dispatch)
Definition: mainloop.c:307
crm_trigger_t * mainloop_add_trigger(int priority, int(*dispatch)(gpointer user_data), gpointer userdata)
Create a trigger to be used as a mainloop source.
Definition: mainloop.c:186
void mainloop_del_ipc_client(mainloop_io_t *client)
Definition: mainloop.c:961
bool mainloop_timer_running(mainloop_timer_t *t)
Definition: mainloop.c:1341
void(* sighandler_t)(int)
Definition: mainloop.h:49
void mainloop_child_add(pid_t pid, int timeout, const char *desc, void *userdata, void(*callback)(mainloop_child_t *p, pid_t pid, int core, int signo, int exitcode))
Definition: mainloop.c:1303
void mainloop_trigger_complete(crm_trigger_t *trig)
Definition: mainloop.c:168
crm_ipc_t * mainloop_get_ipc_client(mainloop_io_t *client)
Definition: mainloop.c:967
void mainloop_clear_child_userdata(mainloop_child_t *child)
Definition: mainloop.c:1060
void pcmk_quit_main_loop(GMainLoop *mloop, unsigned int n)
Drain some remaining main loop events then quit it.
Definition: mainloop.c:1437
IPC interface to Pacemaker daemons.
void mainloop_del_fd(mainloop_io_t *client)
Definition: mainloop.c:1020
void mainloop_del_ipc_server(qb_ipcs_service_t *server)
Definition: mainloop.c:714
mainloop_timer_t * mainloop_timer_add(const char *name, guint period_ms, bool repeat, GSourceFunc cb, void *userdata)
Definition: mainloop.c:1386
gboolean mainloop_destroy_signal(int sig)
Definition: mainloop.c:409
mainloop_io_t * mainloop_add_ipc_client(const char *name, int priority, size_t max_size, void *userdata, struct ipc_client_callbacks *callbacks)
Definition: mainloop.c:936
qb_ipcs_service_t * mainloop_add_ipc_server(const char *name, enum qb_ipc_type type, struct qb_ipcs_service_handlers *callbacks)
Definition: mainloop.c:670
const char * mainloop_child_name(mainloop_child_t *child)
Definition: mainloop.c:1042
unsigned int timeout
Definition: pcmk_fence.c:31
int(* dispatch)(const char *buffer, ssize_t length, gpointer userdata)
Dispatch function for an IPC connection used as mainloop source.
Definition: mainloop.h:84
int mainloop_child_timeout(mainloop_child_t *child)
Definition: mainloop.c:1048