root/include/crm/common/mainloop.h

/* */

INCLUDED FROM

   1 /*
   2  * Copyright 2009-2024 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 
  21 /**
  22  * \file
  23  * \brief Wrappers for and extensions to glib mainloop
  24  * \ingroup core
  25  */
  26 
  27 enum mainloop_child_flags {
  28     /* don't kill pid group on timeout, only kill the pid */
  29     mainloop_leave_pid_group = 0x01,
  30 };
  31 
  32 // NOTE: sbd (as of at least 1.5.2) uses this
  33 typedef struct trigger_s crm_trigger_t;
  34 
  35 typedef struct mainloop_io_s mainloop_io_t;
  36 typedef struct mainloop_child_s mainloop_child_t;
  37 
  38 // NOTE: sbd (as of at least 1.5.2) uses this
  39 typedef struct mainloop_timer_s mainloop_timer_t;
  40 
  41 void mainloop_cleanup(void);
  42 
  43 // NOTE: sbd (as of at least 1.5.2) uses this
  44 crm_trigger_t *mainloop_add_trigger(int priority, int (*dispatch) (gpointer user_data),
  45                                     gpointer userdata);
  46 
  47 // NOTE: sbd (as of at least 1.5.2) uses this
  48 void mainloop_set_trigger(crm_trigger_t * source);
  49 
  50 void mainloop_trigger_complete(crm_trigger_t * trig);
  51 
  52 gboolean mainloop_destroy_trigger(crm_trigger_t * source);
  53 
  54 #ifndef HAVE_SIGHANDLER_T
  55 typedef void (*sighandler_t)(int);
  56 #endif
  57 
  58 sighandler_t crm_signal_handler(int sig, sighandler_t dispatch);
  59 
  60 // NOTE: sbd (as of at least 1.5.2) uses this
  61 gboolean mainloop_add_signal(int sig, void (*dispatch) (int sig));
  62 
  63 gboolean mainloop_destroy_signal(int sig);
  64 
  65 bool mainloop_timer_running(mainloop_timer_t *t);
  66 
  67 // NOTE: sbd (as of at least 1.5.2) uses this
  68 void mainloop_timer_start(mainloop_timer_t *t);
  69 
  70 // NOTE: sbd (as of at least 1.5.2) uses this
  71 void mainloop_timer_stop(mainloop_timer_t *t);
  72 
  73 guint mainloop_timer_set_period(mainloop_timer_t *t, guint period_ms);
  74 
  75 // NOTE: sbd (as of at least 1.5.2) uses this
  76 mainloop_timer_t *mainloop_timer_add(const char *name, guint period_ms, bool repeat, GSourceFunc cb, void *userdata);
  77 
  78 void mainloop_timer_del(mainloop_timer_t *t);
  79 
  80 
  81 #include <crm/common/ipc.h>
  82 #include <qb/qbipcs.h>
  83 
  84 struct ipc_client_callbacks {
  85     /*!
  86      * \brief Dispatch function for an IPC connection used as mainloop source
  87      *
  88      * \param[in] buffer    Message read from IPC connection
  89      * \param[in] length    Number of bytes in \p buffer
  90      * \param[in] userdata  User data passed when creating mainloop source
  91      *
  92      * \return Negative value to remove source, anything else to keep it
  93      */
  94     int (*dispatch) (const char *buffer, ssize_t length, gpointer userdata);
  95 
  96     /*!
  97      * \brief Destroy function for mainloop IPC connection client data
  98      *
  99      * \param[in,out] userdata  User data passed when creating mainloop source
 100      */
 101     void (*destroy) (gpointer userdata);
 102 };
 103 
 104 qb_ipcs_service_t *mainloop_add_ipc_server(const char *name, enum qb_ipc_type type,
 105                                            struct qb_ipcs_service_handlers *callbacks);
 106 
 107 /*!
 108  * \brief Start server-side API end-point, hooked into the internal event loop
 109  *
 110  * \param[in] name    name of the IPC end-point ("address" for the client)
 111  * \param[in] type    selects libqb's IPC back-end (or use #QB_IPC_NATIVE)
 112  * \param[in] callbacks  defines libqb's IPC service-level handlers
 113  * \param[in] priority  priority relative to other events handled in the
 114  *                      abstract handling loop, use #QB_LOOP_MED when unsure
 115  *
 116  * \return libqb's opaque handle to the created service abstraction
 117  *
 118  * \note For portability concerns, do not use this function if you keep
 119  *       \p priority as #QB_LOOP_MED, stick with #mainloop_add_ipc_server
 120  *       (with exactly such semantics) instead (once you link with this new
 121  *       symbol employed, you can't downgrade the library freely anymore).
 122  *
 123  * \note The intended effect will only get fully reflected when run-time
 124  *       linked to patched libqb: https://github.com/ClusterLabs/libqb/pull/352
 125  */
 126 qb_ipcs_service_t *mainloop_add_ipc_server_with_prio(const char *name,
 127                                                     enum qb_ipc_type type,
 128                                                     struct qb_ipcs_service_handlers *callbacks,
 129                                                     enum qb_loop_priority prio);
 130 
 131 void mainloop_del_ipc_server(qb_ipcs_service_t * server);
 132 
 133 mainloop_io_t *mainloop_add_ipc_client(const char *name, int priority, size_t max_size,
 134                                        void *userdata, struct ipc_client_callbacks *callbacks);
 135 
 136 void mainloop_del_ipc_client(mainloop_io_t * client);
 137 
 138 crm_ipc_t *mainloop_get_ipc_client(mainloop_io_t * client);
 139 
 140 struct mainloop_fd_callbacks {
 141     /*!
 142      * \brief Dispatch function for mainloop file descriptor with data ready
 143      *
 144      * \param[in,out] userdata  User data passed when creating mainloop source
 145      *
 146      * \return Negative value to remove source, anything else to keep it
 147      */
 148     int (*dispatch) (gpointer userdata);
 149 
 150     /*!
 151      * \brief Destroy function for mainloop file descriptor client data
 152      *
 153      * \param[in,out] userdata  User data passed when creating mainloop source
 154      */
 155     void (*destroy) (gpointer userdata);
 156 };
 157 
 158 mainloop_io_t *mainloop_add_fd(const char *name, int priority, int fd, void *userdata,
 159                                struct mainloop_fd_callbacks *callbacks);
 160 
 161 void mainloop_del_fd(mainloop_io_t * client);
 162 
 163 /*
 164  * Create a new tracked process
 165  * To track a process group, use -pid
 166  */
 167 void mainloop_child_add(pid_t pid,
 168                         int timeout,
 169                         const char *desc,
 170                         void *userdata,
 171                         void (*callback) (mainloop_child_t * p, pid_t pid, int core, int signo, int exitcode));
 172 
 173 void mainloop_child_add_with_flags(pid_t pid,
 174                         int timeout,
 175                         const char *desc,
 176                         void *userdata,
 177                         enum mainloop_child_flags,
 178                         void (*callback) (mainloop_child_t * p, pid_t pid, int core, int signo, int exitcode));
 179 
 180 void *mainloop_child_userdata(mainloop_child_t * child);
 181 int mainloop_child_timeout(mainloop_child_t * child);
 182 const char *mainloop_child_name(mainloop_child_t * child);
 183 
 184 pid_t mainloop_child_pid(mainloop_child_t * child);
 185 void mainloop_clear_child_userdata(mainloop_child_t * child);
 186 gboolean mainloop_child_kill(pid_t pid);
 187 
 188 void pcmk_quit_main_loop(GMainLoop *mloop, unsigned int n);
 189 void pcmk_drain_main_loop(GMainLoop *mloop, guint timer_ms,
 190                           bool (*check)(guint));
 191 
 192 #define G_PRIORITY_MEDIUM (G_PRIORITY_HIGH/2)
 193 
 194 #if !defined(PCMK_ALLOW_DEPRECATED) || (PCMK_ALLOW_DEPRECATED == 1)
 195 #include <crm/common/mainloop_compat.h>
 196 #endif
 197 
 198 #ifdef __cplusplus
 199 }
 200 #endif
 201 
 202 #endif

/* */