include/crm/common/mainloop.h

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

INCLUDED FROM
