1 /* Thread management routine header.
2 * Copyright (C) 1998 Kunihiro Ishiguro
4 * This file is part of GNU Zebra.
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
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.
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
21 #ifndef _ZEBRA_THREAD_H
22 #define _ZEBRA_THREAD_H
28 #include "frratomic.h"
34 #define RUSAGE_T struct rusage_t
36 #define GETRUSAGE(X) thread_getrusage(X)
38 /* Linked list of thread. */
48 /* number of pfd that fit in the allocated space of pfds. This is a
50 * and is the same for both pfds and copy. */
53 /* file descriptors to monitor for i/o */
55 /* number of pollfds stored in pfds */
58 /* chunk used for temp copy of pollfds */
60 /* number of pollfds stored in copy */
65 struct thread
*thread
;
67 struct thread
**threadref
;
70 /* Master of the theads. */
71 struct thread_master
{
75 struct thread
**write
;
77 struct thread_list event
;
78 struct thread_list ready
;
79 struct thread_list unuse
;
80 struct list
*cancel_req
;
82 pthread_cond_t cancel_cond
;
83 struct hash
*cpu_record
;
86 struct fd_handler handler
;
88 long selectpoll_timeout
;
97 uint8_t type
; /* thread type */
98 uint8_t add_type
; /* thread type */
99 struct thread
*next
; /* next pointer of the thread */
100 struct thread
*prev
; /* previous pointer of the thread */
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 */
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. */
110 int index
; /* queue position for timers */
112 struct cpu_thread_history
*hist
; /* cache pointer to cpu_history */
113 unsigned long yield
; /* yield time in microseconds */
114 const char *funcname
; /* name of thread function */
115 const char *schedfrom
; /* source file thread was scheduled from */
116 int schedfrom_line
; /* line number of source file */
117 pthread_mutex_t mtx
; /* mutex for thread.c functions */
120 struct cpu_thread_history
{
121 int (*func
)(struct thread
*);
122 _Atomic
unsigned int total_calls
;
123 _Atomic
unsigned int total_active
;
125 _Atomic
unsigned long total
, max
;
127 struct time_stats cpu
;
128 _Atomic
uint8_t types
;
129 const char *funcname
;
132 /* Struct timeval's tv_usec one second value. */
133 #define TIMER_SECOND_MICRO 1000000L
136 #define THREAD_READ 0
137 #define THREAD_WRITE 1
138 #define THREAD_TIMER 2
139 #define THREAD_EVENT 3
140 #define THREAD_READY 4
141 #define THREAD_UNUSED 5
142 #define THREAD_EXECUTE 6
144 /* Thread yield time. */
145 #define THREAD_YIELD_TIME_SLOT 10 * 1000L /* 10ms */
148 #define THREAD_ARG(X) ((X)->arg)
149 #define THREAD_FD(X) ((X)->u.fd)
150 #define THREAD_VAL(X) ((X)->u.val)
152 #define THREAD_OFF(thread) \
155 thread_cancel(thread); \
160 #define THREAD_READ_OFF(thread) THREAD_OFF(thread)
161 #define THREAD_WRITE_OFF(thread) THREAD_OFF(thread)
162 #define THREAD_TIMER_OFF(thread) THREAD_OFF(thread)
164 #define debugargdef const char *funcname, const char *schedfrom, int fromln
166 #define thread_add_read(m,f,a,v,t) funcname_thread_add_read_write(THREAD_READ,m,f,a,v,t,#f,__FILE__,__LINE__)
167 #define thread_add_write(m,f,a,v,t) funcname_thread_add_read_write(THREAD_WRITE,m,f,a,v,t,#f,__FILE__,__LINE__)
168 #define thread_add_timer(m,f,a,v,t) funcname_thread_add_timer(m,f,a,v,t,#f,__FILE__,__LINE__)
169 #define thread_add_timer_msec(m,f,a,v,t) funcname_thread_add_timer_msec(m,f,a,v,t,#f,__FILE__,__LINE__)
170 #define thread_add_timer_tv(m,f,a,v,t) funcname_thread_add_timer_tv(m,f,a,v,t,#f,__FILE__,__LINE__)
171 #define thread_add_event(m,f,a,v,t) funcname_thread_add_event(m,f,a,v,t,#f,__FILE__,__LINE__)
172 #define thread_execute(m,f,a,v) funcname_thread_execute(m,f,a,v,#f,__FILE__,__LINE__)
175 extern struct thread_master
*thread_master_create(const char *);
176 void thread_master_set_name(struct thread_master
*master
, const char *name
);
177 extern void thread_master_free(struct thread_master
*);
178 extern void thread_master_free_unused(struct thread_master
*);
180 extern struct thread
*
181 funcname_thread_add_read_write(int dir
, struct thread_master
*,
182 int (*)(struct thread
*), void *, int,
183 struct thread
**, debugargdef
);
185 extern struct thread
*funcname_thread_add_timer(struct thread_master
*,
186 int (*)(struct thread
*),
187 void *, long, struct thread
**,
190 extern struct thread
*
191 funcname_thread_add_timer_msec(struct thread_master
*, int (*)(struct thread
*),
192 void *, long, struct thread
**, debugargdef
);
194 extern struct thread
*funcname_thread_add_timer_tv(struct thread_master
*,
195 int (*)(struct thread
*),
196 void *, struct timeval
*,
200 extern struct thread
*funcname_thread_add_event(struct thread_master
*,
201 int (*)(struct thread
*),
202 void *, int, struct thread
**,
205 extern void funcname_thread_execute(struct thread_master
*,
206 int (*)(struct thread
*), void *, int,
210 extern void thread_cancel(struct thread
*);
211 extern void thread_cancel_async(struct thread_master
*, struct thread
**,
213 extern void thread_cancel_event(struct thread_master
*, void *);
214 extern struct thread
*thread_fetch(struct thread_master
*, struct thread
*);
215 extern void thread_call(struct thread
*);
216 extern unsigned long thread_timer_remain_second(struct thread
*);
217 extern struct timeval
thread_timer_remain(struct thread
*);
218 extern int thread_should_yield(struct thread
*);
219 /* set yield time for thread */
220 extern void thread_set_yield_time(struct thread
*, unsigned long);
222 /* Internal libfrr exports */
223 extern void thread_getrusage(RUSAGE_T
*);
224 extern void thread_cmd_init(void);
226 /* Returns elapsed real (wall clock) time. */
227 extern unsigned long thread_consumed_time(RUSAGE_T
*after
, RUSAGE_T
*before
,
228 unsigned long *cpu_time_elapsed
);
230 /* only for use in logging functions! */
231 extern pthread_key_t thread_current
;
233 #endif /* _ZEBRA_THREAD_H */