[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

struct rusage_t {
	struct rusage cpu;
	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;
};

/* 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_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,      TIMER, 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 *);
extern void thread_cancel_event(struct thread_master *, void *);
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);

/* 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
d62a17ae	36	struct rusage_t {
	37	struct rusage cpu;
	38	struct timeval real;
8b70d0b0	39	};
	40	#define RUSAGE_T struct rusage_t
	41
db9c0df9	42	#define GETRUSAGE(X) thread_getrusage(X)
718e3744	43
c284542b	44	PREDECL_LIST(thread_list)
27d29ced	45	PREDECL_HEAP(thread_timer_list)
4becea72	46
d62a17ae	47	struct fd_handler {
	48	/* number of pfd that fit in the allocated space of pfds. This is a
	49	* constant
	50	* and is the same for both pfds and copy. */
	51	nfds_t pfdsize;
	52
	53	/* file descriptors to monitor for i/o */
	54	struct pollfd *pfds;
	55	/* number of pollfds stored in pfds */
	56	nfds_t pfdcount;
	57
	58	/* chunk used for temp copy of pollfds */
	59	struct pollfd *copy;
	60	/* number of pollfds stored in copy */
	61	nfds_t copycount;
0a95a0d0	62	};
0a95a0d0	63
60a3efec DL	64	struct xref_threadsched {
	65	struct xref xref;
	66
	67	const char *funcname;
	68	const char *dest;
	69	uint32_t thread_type;
	70	};
	71
718e3744	72	/* Master of the theads. */
d62a17ae	73	struct thread_master {
	74	char *name;
	75
	76	struct thread **read;
	77	struct thread **write;
27d29ced	78	struct thread_timer_list_head timer;
c284542b	79	struct thread_list_head event, ready, unuse;
d62a17ae	80	struct list *cancel_req;
	81	bool canceled;
	82	pthread_cond_t cancel_cond;
	83	struct hash *cpu_record;
	84	int io_pipe[2];
	85	int fd_limit;
	86	struct fd_handler handler;
	87	unsigned long alloc;
	88	long selectpoll_timeout;
	89	bool spin;
	90	bool handle_signals;
	91	pthread_mutex_t mtx;
	92	pthread_t owner;
718e3744	93	};
	94
	95	/* Thread itself. */
d62a17ae	96	struct thread {
fbcac826 QY	97	uint8_t type; /* thread type */
fbcac826 QY	98	uint8_t add_type; /* thread type */
c284542b	99	struct thread_list_item threaditem;
27d29ced	100	struct thread_timer_list_item timeritem;
d62a17ae	101	struct thread *ref; / external reference (if given) */
	102	struct thread_master master; / pointer to the struct thread_master */
	103	int (func)(struct thread ); /* event function */
	104	void arg; / event argument */
	105	union {
	106	int val; /* second argument of the event. */
	107	int fd; /* file descriptor in case of r/w */
	108	struct timeval sands; /* rest of time sands value. */
	109	} u;
d62a17ae	110	struct timeval real;
	111	struct cpu_thread_history hist; / cache pointer to cpu_history */
	112	unsigned long yield; /* yield time in microseconds */
60a3efec	113	const struct xref_threadsched xref; / origin location */
d62a17ae	114	pthread_mutex_t mtx; /* mutex for thread.c functions */
e04ab74d	115	};
e04ab74d	116
d62a17ae	117	struct cpu_thread_history {
d62a17ae	118	int (func)(struct thread );
72327cf3 MS	119	atomic_size_t total_calls;
72327cf3 MS	120	atomic_size_t total_active;
d62a17ae	121	struct time_stats {
c8a65463	122	atomic_size_t total, max;
d62a17ae	123	} real;
d62a17ae	124	struct time_stats cpu;
c8a65463	125	atomic_uint_fast32_t types;
d62a17ae	126	const char *funcname;
718e3744	127	};
718e3744	128
ca1f4309 DS	129	/* Struct timeval's tv_usec one second value. */
	130	#define TIMER_SECOND_MICRO 1000000L
	131
718e3744	132	/* Thread types. */
	133	#define THREAD_READ 0
	134	#define THREAD_WRITE 1
	135	#define THREAD_TIMER 2
	136	#define THREAD_EVENT 3
	137	#define THREAD_READY 4
a587d00b QY	138	#define THREAD_UNUSED 5
a587d00b QY	139	#define THREAD_EXECUTE 6
718e3744	140
718e3744	141	/* Thread yield time. */
17fc128d	142	#define THREAD_YIELD_TIME_SLOT 10 * 1000L /* 10ms */
718e3744	143
0447957e AK	144	#define THREAD_TIMER_STRLEN 12
0447957e AK	145
718e3744	146	/* Macros. */
	147	#define THREAD_ARG(X) ((X)->arg)
	148	#define THREAD_FD(X) ((X)->u.fd)
	149	#define THREAD_VAL(X) ((X)->u.val)
	150
50478845 MS	151	/*
	152	* Please consider this macro deprecated, and do not use it in new code.
	153	*/
	154	#define THREAD_OFF(thread) \
	155	do { \
	156	if ((thread)) \
	157	thread_cancel(&(thread)); \
	158	} while (0)
718e3744	159
60a3efec DL	160	/*
	161	* Macro wrappers to generate xrefs for all thread add calls. Includes
	162	* file/line/function info for debugging/tracing.
	163	*/
	164	#include "lib/xref.h"
	165
	166	#define _xref_t_a(addfn, type, m, f, a, v, t) \
	167	({ \
	168	static const struct xref_threadsched _xref \
	169	__attribute__((used)) = { \
	170	.xref = XREF_INIT(XREFT_THREADSCHED, NULL, __func__), \
	171	.funcname = #f, \
	172	.dest = #t, \
	173	.thread_type = THREAD_ ## type, \
	174	}; \
	175	XREF_LINK(_xref.xref); \
	176	_thread_add_ ## addfn(&_xref, m, f, a, v, t); \
	177	}) \
	178	/* end */
	179
	180	#define thread_add_read(m,f,a,v,t) _xref_t_a(read_write, READ, m,f,a,v,t)
	181	#define thread_add_write(m,f,a,v,t) _xref_t_a(read_write, WRITE, m,f,a,v,t)
	182	#define thread_add_timer(m,f,a,v,t) _xref_t_a(timer, TIMER, m,f,a,v,t)
	183	#define thread_add_timer_msec(m,f,a,v,t) _xref_t_a(timer_msec, TIMER, m,f,a,v,t)
	184	#define thread_add_timer_tv(m,f,a,v,t) _xref_t_a(timer_tv, TIMER, m,f,a,v,t)
	185	#define thread_add_event(m,f,a,v,t) _xref_t_a(event, TIMER, m,f,a,v,t)
	186
	187	#define thread_execute(m,f,a,v) \
	188	({ \
	189	static const struct xref_threadsched _xref \
	190	__attribute__((used)) = { \
	191	.xref = XREF_INIT(XREFT_THREADSCHED, NULL, __func__), \
	192	.funcname = #f, \
	193	.dest = NULL, \
	194	.thread_type = THREAD_EXECUTE, \
	195	}; \
	196	XREF_LINK(_xref.xref); \
	197	_thread_execute(&_xref, m, f, a, v); \
	198	}) /* end */
fb9e46bb	199
718e3744	200	/* Prototypes. */
d62a17ae	201	extern struct thread_master thread_master_create(const char );
d8a8a8de	202	void thread_master_set_name(struct thread_master master, const char name);
d62a17ae	203	extern void thread_master_free(struct thread_master *);
495f0b13	204	extern void thread_master_free_unused(struct thread_master *);
8cc4198f	205
60a3efec DL	206	extern struct thread *_thread_add_read_write(
	207	const struct xref_threadsched xref, struct thread_master master,
	208	int (fn)(struct thread ), void arg, int fd, struct thread *tref);
	209
	210	extern struct thread *_thread_add_timer(
	211	const struct xref_threadsched xref, struct thread_master master,
	212	int (fn)(struct thread ), void arg, long t, struct thread *tref);
	213
	214	extern struct thread *_thread_add_timer_msec(
	215	const struct xref_threadsched xref, struct thread_master master,
	216	int (fn)(struct thread ), void arg, long t, struct thread *tref);
	217
	218	extern struct thread *_thread_add_timer_tv(
	219	const struct xref_threadsched xref, struct thread_master master,
	220	int (fn)(struct thread ), void arg, struct timeval tv,
	221	struct thread **tref);
	222
	223	extern struct thread *_thread_add_event(
	224	const struct xref_threadsched xref, struct thread_master master,
	225	int (fn)(struct thread ), void arg, int val, struct thread *tref);
	226
	227	extern void _thread_execute(const struct xref_threadsched *xref,
	228	struct thread_master *master,
	229	int (fn)(struct thread ), void *arg, int val);
9c7753e4	230
b3d6bc6e	231	extern void thread_cancel(struct thread **event);
d62a17ae	232	extern void thread_cancel_async(struct thread_master , struct thread *,
	233	void *);
	234	extern void thread_cancel_event(struct thread_master , void );
	235	extern struct thread thread_fetch(struct thread_master , struct thread *);
	236	extern void thread_call(struct thread *);
	237	extern unsigned long thread_timer_remain_second(struct thread *);
	238	extern struct timeval thread_timer_remain(struct thread *);
78ca0342	239	extern unsigned long thread_timer_remain_msec(struct thread *);
d62a17ae	240	extern int thread_should_yield(struct thread *);
50596be0	241	/* set yield time for thread */
d62a17ae	242	extern void thread_set_yield_time(struct thread *, unsigned long);
718e3744	243
55c72803	244	/* Internal libfrr exports */
d62a17ae	245	extern void thread_getrusage(RUSAGE_T *);
d62a17ae	246	extern void thread_cmd_init(void);
e04ab74d	247
8b70d0b0	248	/* Returns elapsed real (wall clock) time. */
	249	extern unsigned long thread_consumed_time(RUSAGE_T after, RUSAGE_T before,
	250	unsigned long *cpu_time_elapsed);
	251
d1265948	252	/* only for use in logging functions! */
e0bebc7c	253	extern pthread_key_t thread_current;
0447957e AK	254	extern char thread_timer_to_hhmmss(char buf, int buf_size,
0447957e AK	255	struct thread *t_timer);
d1265948	256
1543c387 MS	257	/* Debug signal mask */
	258	void debug_signals(const sigset_t *sigs);
	259
5e244469 RW	260	#ifdef __cplusplus
	261	}
	262	#endif
	263
718e3744	264	#endif /* _ZEBRA_THREAD_H */