[mirror_frr.git] / lib / thread.h

/* Thread management routine header.
 * Copyright (C) 1998 Kunihiro Ishiguro
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra 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, or (at your option) any
 * later version.
 *
 * GNU Zebra 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.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef _ZEBRA_THREAD_H
#define _ZEBRA_THREAD_H

#include <zebra.h>
#include <pthread.h>
#include <poll.h>
#include "monotime.h"
#include "frratomic.h"
#include "typesafe.h"
#include "xref.h"

#ifdef __cplusplus
extern "C" {
#endif

extern bool cputime_enabled;
extern unsigned long cputime_threshold;
/* capturing wallclock time is always enabled since it is fast (reading
 * hardware TSC w/o syscalls)
 */
extern unsigned long walltime_threshold;

struct rusage_t {
#ifdef HAVE_CLOCK_THREAD_CPUTIME_ID
	struct timespec cpu;
#else
	struct rusage cpu;
#endif
	struct timeval real;
};
#define RUSAGE_T        struct rusage_t

#define GETRUSAGE(X) thread_getrusage(X)

PREDECL_LIST(thread_list);
PREDECL_HEAP(thread_timer_list);

struct fd_handler {
	/* number of pfd that fit in the allocated space of pfds. This is a
	 * constant and is the same for both pfds and copy.
	 */
	nfds_t pfdsize;

	/* file descriptors to monitor for i/o */
	struct pollfd *pfds;
	/* number of pollfds stored in pfds */
	nfds_t pfdcount;

	/* chunk used for temp copy of pollfds */
	struct pollfd *copy;
	/* number of pollfds stored in copy */
	nfds_t copycount;
};

struct xref_threadsched {
	struct xref xref;

	const char *funcname;
	const char *dest;
	uint32_t thread_type;
};

/* Master of the theads. */
struct thread_master {
	char *name;

	struct thread **read;
	struct thread **write;
	struct thread_timer_list_head timer;
	struct thread_list_head event, ready, unuse;
	struct list *cancel_req;
	bool canceled;
	pthread_cond_t cancel_cond;
	struct hash *cpu_record;
	int io_pipe[2];
	int fd_limit;
	struct fd_handler handler;
	unsigned long alloc;
	long selectpoll_timeout;
	bool spin;
	bool handle_signals;
	pthread_mutex_t mtx;
	pthread_t owner;

	bool ready_run_loop;
	RUSAGE_T last_getrusage;
};

/* Thread itself. */
struct thread {
	uint8_t type;		  /* thread type */
	uint8_t add_type;	  /* thread type */
	struct thread_list_item threaditem;
	struct thread_timer_list_item timeritem;
	struct thread **ref;	  /* external reference (if given) */
	struct thread_master *master; /* pointer to the struct thread_master */
	int (*func)(struct thread *); /* event function */
	void *arg;		      /* event argument */
	union {
		int val;	      /* second argument of the event. */
		int fd;		      /* file descriptor in case of r/w */
		struct timeval sands; /* rest of time sands value. */
	} u;
	struct timeval real;
	struct cpu_thread_history *hist; /* cache pointer to cpu_history */
	unsigned long yield;		 /* yield time in microseconds */
	const struct xref_threadsched *xref;   /* origin location */
	pthread_mutex_t mtx;   /* mutex for thread.c functions */
};

struct cpu_thread_history {
	int (*func)(struct thread *);
	atomic_size_t total_cpu_warn;
	atomic_size_t total_wall_warn;
	atomic_size_t total_calls;
	atomic_size_t total_active;
	struct time_stats {
		atomic_size_t total, max;
	} real;
	struct time_stats cpu;
	atomic_uint_fast32_t types;
	const char *funcname;
};

/* Struct timeval's tv_usec one second value.  */
#define TIMER_SECOND_MICRO 1000000L

/* Thread types. */
#define THREAD_READ           0
#define THREAD_WRITE          1
#define THREAD_TIMER          2
#define THREAD_EVENT          3
#define THREAD_READY          4
#define THREAD_UNUSED         5
#define THREAD_EXECUTE        6

/* Thread yield time.  */
#define THREAD_YIELD_TIME_SLOT     10 * 1000L /* 10ms */

#define THREAD_TIMER_STRLEN 12

/* Macros. */
#define THREAD_ARG(X) ((X)->arg)
#define THREAD_FD(X)  ((X)->u.fd)
#define THREAD_VAL(X) ((X)->u.val)

/*
 * Please consider this macro deprecated, and do not use it in new code.
 */
#define THREAD_OFF(thread)                                             \
	do {                                                           \
		if ((thread))                                          \
			thread_cancel(&(thread));                      \
	} while (0)

/*
 * Macro wrappers to generate xrefs for all thread add calls.  Includes
 * file/line/function info for debugging/tracing.
 */
#include "lib/xref.h"

#define _xref_t_a(addfn, type, m, f, a, v, t)                                  \
	({                                                                     \
		static const struct xref_threadsched _xref                     \
				__attribute__((used)) = {                      \
			.xref = XREF_INIT(XREFT_THREADSCHED, NULL, __func__),  \
			.funcname = #f,                                        \
			.dest = #t,                                            \
			.thread_type = THREAD_ ## type,                        \
		};                                                             \
		XREF_LINK(_xref.xref);                                         \
		_thread_add_ ## addfn(&_xref, m, f, a, v, t);                  \
	})                                                                     \
	/* end */

#define thread_add_read(m,f,a,v,t)       _xref_t_a(read_write, READ,  m,f,a,v,t)
#define thread_add_write(m,f,a,v,t)      _xref_t_a(read_write, WRITE, m,f,a,v,t)
#define thread_add_timer(m,f,a,v,t)      _xref_t_a(timer,      TIMER, m,f,a,v,t)
#define thread_add_timer_msec(m,f,a,v,t) _xref_t_a(timer_msec, TIMER, m,f,a,v,t)
#define thread_add_timer_tv(m,f,a,v,t)   _xref_t_a(timer_tv,   TIMER, m,f,a,v,t)
#define thread_add_event(m,f,a,v,t)      _xref_t_a(event,      EVENT, m,f,a,v,t)

#define thread_execute(m,f,a,v)                                                \
	({                                                                     \
		static const struct xref_threadsched _xref                     \
				__attribute__((used)) = {                      \
			.xref = XREF_INIT(XREFT_THREADSCHED, NULL, __func__),  \
			.funcname = #f,                                        \
			.dest = NULL,                                          \
			.thread_type = THREAD_EXECUTE,                         \
		};                                                             \
		XREF_LINK(_xref.xref);                                         \
		_thread_execute(&_xref, m, f, a, v);                           \
	}) /* end */

/* Prototypes. */
extern struct thread_master *thread_master_create(const char *);
void thread_master_set_name(struct thread_master *master, const char *name);
extern void thread_master_free(struct thread_master *);
extern void thread_master_free_unused(struct thread_master *);

extern struct thread *_thread_add_read_write(
	const struct xref_threadsched *xref, struct thread_master *master,
	int (*fn)(struct thread *), void *arg, int fd, struct thread **tref);

extern struct thread *_thread_add_timer(
	const struct xref_threadsched *xref, struct thread_master *master,
	int (*fn)(struct thread *), void *arg, long t, struct thread **tref);

extern struct thread *_thread_add_timer_msec(
	const struct xref_threadsched *xref, struct thread_master *master,
	int (*fn)(struct thread *), void *arg, long t, struct thread **tref);

extern struct thread *_thread_add_timer_tv(
	const struct xref_threadsched *xref, struct thread_master *master,
	int (*fn)(struct thread *), void *arg, struct timeval *tv,
	struct thread **tref);

extern struct thread *_thread_add_event(
	const struct xref_threadsched *xref, struct thread_master *master,
	int (*fn)(struct thread *), void *arg, int val, struct thread **tref);

extern void _thread_execute(const struct xref_threadsched *xref,
			    struct thread_master *master,
			    int (*fn)(struct thread *), void *arg, int val);

extern void thread_cancel(struct thread **event);
extern void thread_cancel_async(struct thread_master *, struct thread **,
				void *);
/* Cancel ready tasks with an arg matching 'arg' */
extern void thread_cancel_event_ready(struct thread_master *m, void *arg);
/* Cancel all tasks with an arg matching 'arg', including timers and io */
extern void thread_cancel_event(struct thread_master *m, void *arg);
extern struct thread *thread_fetch(struct thread_master *, struct thread *);
extern void thread_call(struct thread *);
extern unsigned long thread_timer_remain_second(struct thread *);
extern struct timeval thread_timer_remain(struct thread *);
extern unsigned long thread_timer_remain_msec(struct thread *);
extern int thread_should_yield(struct thread *);
/* set yield time for thread */
extern void thread_set_yield_time(struct thread *, unsigned long);

/* Internal libfrr exports */
extern void thread_getrusage(RUSAGE_T *);
extern void thread_cmd_init(void);

/* Returns elapsed real (wall clock) time. */
extern unsigned long thread_consumed_time(RUSAGE_T *after, RUSAGE_T *before,
					  unsigned long *cpu_time_elapsed);

/* only for use in logging functions! */
extern pthread_key_t thread_current;
extern char *thread_timer_to_hhmmss(char *buf, int buf_size,
		struct thread *t_timer);

extern bool thread_is_scheduled(struct thread *thread);
/* Debug signal mask */
void debug_signals(const sigset_t *sigs);

#ifdef __cplusplus
}
#endif

#endif /* _ZEBRA_THREAD_H */
Commit	Line	Data
718e3744	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	*
896014f4 DL	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
718e3744	19	*/
	20
	21	#ifndef _ZEBRA_THREAD_H
	22	#define _ZEBRA_THREAD_H
	23
5734509c	24	#include <zebra.h>
1189d95f	25	#include <pthread.h>
75bcb355 QY	26	#include <poll.h>
75bcb355 QY	27	#include "monotime.h"
fbcac826	28	#include "frratomic.h"
c284542b	29	#include "typesafe.h"
60a3efec	30	#include "xref.h"
5734509c	31
5e244469 RW	32	#ifdef __cplusplus
	33	extern "C" {
	34	#endif
	35
45f01188 DL	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
d62a17ae	43	struct rusage_t {
6418e2d3 DL	44	#ifdef HAVE_CLOCK_THREAD_CPUTIME_ID
	45	struct timespec cpu;
	46	#else
d62a17ae	47	struct rusage cpu;
6418e2d3	48	#endif
d62a17ae	49	struct timeval real;
8b70d0b0	50	};
	51	#define RUSAGE_T struct rusage_t
	52
db9c0df9	53	#define GETRUSAGE(X) thread_getrusage(X)
718e3744	54
960b9a53 DL	55	PREDECL_LIST(thread_list);
960b9a53 DL	56	PREDECL_HEAP(thread_timer_list);
4becea72	57
d62a17ae	58	struct fd_handler {
d62a17ae	59	/* number of pfd that fit in the allocated space of pfds. This is a
a9318a32 MS	60	* constant and is the same for both pfds and copy.
a9318a32 MS	61	*/
d62a17ae	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;
0a95a0d0	73	};
0a95a0d0	74
60a3efec DL	75	struct xref_threadsched {
	76	struct xref xref;
	77
	78	const char *funcname;
	79	const char *dest;
	80	uint32_t thread_type;
	81	};
	82
718e3744	83	/* Master of the theads. */
d62a17ae	84	struct thread_master {
	85	char *name;
	86
	87	struct thread **read;
	88	struct thread **write;
27d29ced	89	struct thread_timer_list_head timer;
c284542b	90	struct thread_list_head event, ready, unuse;
d62a17ae	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;
5e822957 DS	104
	105	bool ready_run_loop;
	106	RUSAGE_T last_getrusage;
718e3744	107	};
	108
	109	/* Thread itself. */
d62a17ae	110	struct thread {
fbcac826 QY	111	uint8_t type; /* thread type */
fbcac826 QY	112	uint8_t add_type; /* thread type */
c284542b	113	struct thread_list_item threaditem;
27d29ced	114	struct thread_timer_list_item timeritem;
d62a17ae	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;
d62a17ae	124	struct timeval real;
	125	struct cpu_thread_history hist; / cache pointer to cpu_history */
	126	unsigned long yield; /* yield time in microseconds */
60a3efec	127	const struct xref_threadsched xref; / origin location */
d62a17ae	128	pthread_mutex_t mtx; /* mutex for thread.c functions */
e04ab74d	129	};
e04ab74d	130
d62a17ae	131	struct cpu_thread_history {
d62a17ae	132	int (func)(struct thread );
9b8e01ca DS	133	atomic_size_t total_cpu_warn;
9b8e01ca DS	134	atomic_size_t total_wall_warn;
72327cf3 MS	135	atomic_size_t total_calls;
72327cf3 MS	136	atomic_size_t total_active;
d62a17ae	137	struct time_stats {
c8a65463	138	atomic_size_t total, max;
d62a17ae	139	} real;
d62a17ae	140	struct time_stats cpu;
c8a65463	141	atomic_uint_fast32_t types;
d62a17ae	142	const char *funcname;
718e3744	143	};
718e3744	144
ca1f4309 DS	145	/* Struct timeval's tv_usec one second value. */
	146	#define TIMER_SECOND_MICRO 1000000L
	147
718e3744	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
a587d00b QY	154	#define THREAD_UNUSED 5
a587d00b QY	155	#define THREAD_EXECUTE 6
718e3744	156
718e3744	157	/* Thread yield time. */
17fc128d	158	#define THREAD_YIELD_TIME_SLOT 10 * 1000L /* 10ms */
718e3744	159
0447957e AK	160	#define THREAD_TIMER_STRLEN 12
0447957e AK	161
718e3744	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
50478845 MS	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)
718e3744	175
60a3efec DL	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)
44a5e507	201	#define thread_add_event(m,f,a,v,t) _xref_t_a(event, EVENT, m,f,a,v,t)
60a3efec DL	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 */
fb9e46bb	215
718e3744	216	/* Prototypes. */
d62a17ae	217	extern struct thread_master thread_master_create(const char );
d8a8a8de	218	void thread_master_set_name(struct thread_master master, const char name);
d62a17ae	219	extern void thread_master_free(struct thread_master *);
495f0b13	220	extern void thread_master_free_unused(struct thread_master *);
8cc4198f	221
60a3efec DL	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);
9c7753e4	246
b3d6bc6e	247	extern void thread_cancel(struct thread **event);
d62a17ae	248	extern void thread_cancel_async(struct thread_master , struct thread *,
d62a17ae	249	void *);
a9318a32 MS	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);
d62a17ae	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 *);
78ca0342	258	extern unsigned long thread_timer_remain_msec(struct thread *);
d62a17ae	259	extern int thread_should_yield(struct thread *);
50596be0	260	/* set yield time for thread */
d62a17ae	261	extern void thread_set_yield_time(struct thread *, unsigned long);
718e3744	262
55c72803	263	/* Internal libfrr exports */
d62a17ae	264	extern void thread_getrusage(RUSAGE_T *);
d62a17ae	265	extern void thread_cmd_init(void);
e04ab74d	266
8b70d0b0	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
d1265948	271	/* only for use in logging functions! */
e0bebc7c	272	extern pthread_key_t thread_current;
0447957e AK	273	extern char thread_timer_to_hhmmss(char buf, int buf_size,
0447957e AK	274	struct thread *t_timer);
d1265948	275
a505383d	276	extern bool thread_is_scheduled(struct thread *thread);
1543c387 MS	277	/* Debug signal mask */
	278	void debug_signals(const sigset_t *sigs);
	279
5e244469 RW	280	#ifdef __cplusplus
	281	}
	282	#endif
	283
718e3744	284	#endif /* _ZEBRA_THREAD_H */