lib/thread.h

   1 /* Thread management routine header.
   2  * Copyright (C) 1998 Kunihiro Ishiguro
   3  *
   4  * This file is part of GNU Zebra.
   5  *
   6  * GNU Zebra is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2, or (at your option) any
   9  * later version.
  10  *
  11  * GNU Zebra is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef _ZEBRA_THREAD_H
  22 #define _ZEBRA_THREAD_H
  23
  24 #include <zebra.h>
  25 #include <pthread.h>
  26 #include <poll.h>
  27 #include "monotime.h"
  28 #include "frratomic.h"
  29 #include "typesafe.h"
  30 #include "xref.h"
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 extern bool cputime_enabled;
  37 extern unsigned long cputime_threshold;
  38 /* capturing wallclock time is always enabled since it is fast (reading
  39  * hardware TSC w/o syscalls)
  40  */
  41 extern unsigned long walltime_threshold;
  42
  43 struct rusage_t {
  44 #ifdef HAVE_CLOCK_THREAD_CPUTIME_ID
  45         struct timespec cpu;
  46 #else
  47         struct rusage cpu;
  48 #endif
  49         struct timeval real;
  50 };
  51 #define RUSAGE_T        struct rusage_t
  52
  53 #define GETRUSAGE(X) thread_getrusage(X)
  54
  55 PREDECL_LIST(thread_list);
  56 PREDECL_HEAP(thread_timer_list);
  57
  58 struct fd_handler {
  59         /* number of pfd that fit in the allocated space of pfds. This is a
  60          * constant and is the same for both pfds and copy.
  61          */
  62         nfds_t pfdsize;
  63
  64         /* file descriptors to monitor for i/o */
  65         struct pollfd *pfds;
  66         /* number of pollfds stored in pfds */
  67         nfds_t pfdcount;
  68
  69         /* chunk used for temp copy of pollfds */
  70         struct pollfd *copy;
  71         /* number of pollfds stored in copy */
  72         nfds_t copycount;
  73 };
  74
  75 struct xref_threadsched {
  76         struct xref xref;
  77
  78         const char *funcname;
  79         const char *dest;
  80         uint32_t thread_type;
  81 };
  82
  83 /* Master of the theads. */
  84 struct thread_master {
  85         char *name;
  86
  87         struct thread **read;
  88         struct thread **write;
  89         struct thread_timer_list_head timer;
  90         struct thread_list_head event, ready, unuse;
  91         struct list *cancel_req;
  92         bool canceled;
  93         pthread_cond_t cancel_cond;
  94         struct hash *cpu_record;
  95         int io_pipe[2];
  96         int fd_limit;
  97         struct fd_handler handler;
  98         unsigned long alloc;
  99         long selectpoll_timeout;
 100         bool spin;
 101         bool handle_signals;
 102         pthread_mutex_t mtx;
 103         pthread_t owner;
 104
 105         bool ready_run_loop;
 106         RUSAGE_T last_getrusage;
 107 };
 108
 109 /* Thread itself. */
 110 struct thread {
 111         uint8_t type;             /* thread type */
 112         uint8_t add_type;         /* thread type */
 113         struct thread_list_item threaditem;
 114         struct thread_timer_list_item timeritem;
 115         struct thread **ref;      /* external reference (if given) */
 116         struct thread_master *master; /* pointer to the struct thread_master */
 117         int (*func)(struct thread *); /* event function */
 118         void *arg;                    /* event argument */
 119         union {
 120                 int val;              /* second argument of the event. */
 121                 int fd;               /* file descriptor in case of r/w */
 122                 struct timeval sands; /* rest of time sands value. */
 123         } u;
 124         struct timeval real;
 125         struct cpu_thread_history *hist; /* cache pointer to cpu_history */
 126         unsigned long yield;             /* yield time in microseconds */
 127         const struct xref_threadsched *xref;   /* origin location */
 128         pthread_mutex_t mtx;   /* mutex for thread.c functions */
 129 };
 130
 131 struct cpu_thread_history {
 132         int (*func)(struct thread *);
 133         atomic_size_t total_cpu_warn;
 134         atomic_size_t total_wall_warn;
 135         atomic_size_t total_calls;
 136         atomic_size_t total_active;
 137         struct time_stats {
 138                 atomic_size_t total, max;
 139         } real;
 140         struct time_stats cpu;
 141         atomic_uint_fast32_t types;
 142         const char *funcname;
 143 };
 144
 145 /* Struct timeval's tv_usec one second value.  */
 146 #define TIMER_SECOND_MICRO 1000000L
 147
 148 /* Thread types. */
 149 #define THREAD_READ           0
 150 #define THREAD_WRITE          1
 151 #define THREAD_TIMER          2
 152 #define THREAD_EVENT          3
 153 #define THREAD_READY          4
 154 #define THREAD_UNUSED         5
 155 #define THREAD_EXECUTE        6
 156
 157 /* Thread yield time.  */
 158 #define THREAD_YIELD_TIME_SLOT     10 * 1000L /* 10ms */
 159
 160 #define THREAD_TIMER_STRLEN 12
 161
 162 /* Macros. */
 163 #define THREAD_ARG(X) ((X)->arg)
 164 #define THREAD_FD(X)  ((X)->u.fd)
 165 #define THREAD_VAL(X) ((X)->u.val)
 166
 167 /*
 168  * Please consider this macro deprecated, and do not use it in new code.
 169  */
 170 #define THREAD_OFF(thread)                                             \
 171         do {                                                           \
 172                 if ((thread))                                          \
 173                         thread_cancel(&(thread));                      \
 174         } while (0)
 175
 176 /*
 177  * Macro wrappers to generate xrefs for all thread add calls.  Includes
 178  * file/line/function info for debugging/tracing.
 179  */
 180 #include "lib/xref.h"
 181
 182 #define _xref_t_a(addfn, type, m, f, a, v, t)                                  \
 183         ({                                                                     \
 184                 static const struct xref_threadsched _xref                     \
 185                                 __attribute__((used)) = {                      \
 186                         .xref = XREF_INIT(XREFT_THREADSCHED, NULL, __func__),  \
 187                         .funcname = #f,                                        \
 188                         .dest = #t,                                            \
 189                         .thread_type = THREAD_ ## type,                        \
 190                 };                                                             \
 191                 XREF_LINK(_xref.xref);                                         \
 192                 _thread_add_ ## addfn(&_xref, m, f, a, v, t);                  \
 193         })                                                                     \
 194         /* end */
 195
 196 #define thread_add_read(m,f,a,v,t)       _xref_t_a(read_write, READ,  m,f,a,v,t)
 197 #define thread_add_write(m,f,a,v,t)      _xref_t_a(read_write, WRITE, m,f,a,v,t)
 198 #define thread_add_timer(m,f,a,v,t)      _xref_t_a(timer,      TIMER, m,f,a,v,t)
 199 #define thread_add_timer_msec(m,f,a,v,t) _xref_t_a(timer_msec, TIMER, m,f,a,v,t)
 200 #define thread_add_timer_tv(m,f,a,v,t)   _xref_t_a(timer_tv,   TIMER, m,f,a,v,t)
 201 #define thread_add_event(m,f,a,v,t)      _xref_t_a(event,      EVENT, m,f,a,v,t)
 202
 203 #define thread_execute(m,f,a,v)                                                \
 204         ({                                                                     \
 205                 static const struct xref_threadsched _xref                     \
 206                                 __attribute__((used)) = {                      \
 207                         .xref = XREF_INIT(XREFT_THREADSCHED, NULL, __func__),  \
 208                         .funcname = #f,                                        \
 209                         .dest = NULL,                                          \
 210                         .thread_type = THREAD_EXECUTE,                         \
 211                 };                                                             \
 212                 XREF_LINK(_xref.xref);                                         \
 213                 _thread_execute(&_xref, m, f, a, v);                           \
 214         }) /* end */
 215
 216 /* Prototypes. */
 217 extern struct thread_master *thread_master_create(const char *);
 218 void thread_master_set_name(struct thread_master *master, const char *name);
 219 extern void thread_master_free(struct thread_master *);
 220 extern void thread_master_free_unused(struct thread_master *);
 221
 222 extern struct thread *_thread_add_read_write(
 223         const struct xref_threadsched *xref, struct thread_master *master,
 224         int (*fn)(struct thread *), void *arg, int fd, struct thread **tref);
 225
 226 extern struct thread *_thread_add_timer(
 227         const struct xref_threadsched *xref, struct thread_master *master,
 228         int (*fn)(struct thread *), void *arg, long t, struct thread **tref);
 229
 230 extern struct thread *_thread_add_timer_msec(
 231         const struct xref_threadsched *xref, struct thread_master *master,
 232         int (*fn)(struct thread *), void *arg, long t, struct thread **tref);
 233
 234 extern struct thread *_thread_add_timer_tv(
 235         const struct xref_threadsched *xref, struct thread_master *master,
 236         int (*fn)(struct thread *), void *arg, struct timeval *tv,
 237         struct thread **tref);
 238
 239 extern struct thread *_thread_add_event(
 240         const struct xref_threadsched *xref, struct thread_master *master,
 241         int (*fn)(struct thread *), void *arg, int val, struct thread **tref);
 242
 243 extern void _thread_execute(const struct xref_threadsched *xref,
 244                             struct thread_master *master,
 245                             int (*fn)(struct thread *), void *arg, int val);
 246
 247 extern void thread_cancel(struct thread **event);
 248 extern void thread_cancel_async(struct thread_master *, struct thread **,
 249                                 void *);
 250 /* Cancel ready tasks with an arg matching 'arg' */
 251 extern void thread_cancel_event_ready(struct thread_master *m, void *arg);
 252 /* Cancel all tasks with an arg matching 'arg', including timers and io */
 253 extern void thread_cancel_event(struct thread_master *m, void *arg);
 254 extern struct thread *thread_fetch(struct thread_master *, struct thread *);
 255 extern void thread_call(struct thread *);
 256 extern unsigned long thread_timer_remain_second(struct thread *);
 257 extern struct timeval thread_timer_remain(struct thread *);
 258 extern unsigned long thread_timer_remain_msec(struct thread *);
 259 extern int thread_should_yield(struct thread *);
 260 /* set yield time for thread */
 261 extern void thread_set_yield_time(struct thread *, unsigned long);
 262
 263 /* Internal libfrr exports */
 264 extern void thread_getrusage(RUSAGE_T *);
 265 extern void thread_cmd_init(void);
 266
 267 /* Returns elapsed real (wall clock) time. */
 268 extern unsigned long thread_consumed_time(RUSAGE_T *after, RUSAGE_T *before,
 269                                           unsigned long *cpu_time_elapsed);
 270
 271 /* only for use in logging functions! */
 272 extern pthread_key_t thread_current;
 273 extern char *thread_timer_to_hhmmss(char *buf, int buf_size,
 274                 struct thread *t_timer);
 275
 276 extern bool thread_is_scheduled(struct thread *thread);
 277 /* Debug signal mask */
 278 void debug_signals(const sigset_t *sigs);
 279
 280 #ifdef __cplusplus
 281 }
 282 #endif
 283
 284 #endif /* _ZEBRA_THREAD_H */