]>
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 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with GNU Zebra; see the file COPYING. If not, write to the Free | |
18 | * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA | |
19 | * 02111-1307, USA. | |
20 | */ | |
21 | ||
22 | #ifndef _ZEBRA_THREAD_H | |
23 | #define _ZEBRA_THREAD_H | |
24 | ||
5734509c | 25 | #include <zebra.h> |
cf672a86 | 26 | #include "monotime.h" |
1189d95f | 27 | #include <pthread.h> |
5734509c | 28 | |
8b70d0b0 | 29 | struct rusage_t |
30 | { | |
8b70d0b0 | 31 | struct rusage cpu; |
8b70d0b0 | 32 | struct timeval real; |
33 | }; | |
34 | #define RUSAGE_T struct rusage_t | |
35 | ||
db9c0df9 | 36 | #define GETRUSAGE(X) thread_getrusage(X) |
718e3744 | 37 | |
38 | /* Linked list of thread. */ | |
39 | struct thread_list | |
40 | { | |
41 | struct thread *head; | |
42 | struct thread *tail; | |
43 | int count; | |
44 | }; | |
45 | ||
4becea72 CF |
46 | struct pqueue; |
47 | ||
209a72a6 DS |
48 | /* |
49 | * Abstract it so we can use different methodologies to | |
50 | * select on data. | |
51 | */ | |
52 | typedef fd_set thread_fd_set; | |
53 | ||
704ef00b | 54 | #if defined(HAVE_POLL_CALL) |
0a95a0d0 DS |
55 | #include <poll.h> |
56 | struct fd_handler | |
57 | { | |
58 | /* number of pfd stored in pfds */ | |
59 | nfds_t pfdcount; | |
60 | /* number of pfd stored in pfds + number of snmp pfd */ | |
61 | nfds_t pfdcountsnmp; | |
62 | /* number of pfd that fit in the allocated space of pfds */ | |
63 | nfds_t pfdsize; | |
64 | struct pollfd *pfds; | |
65 | }; | |
66 | #else | |
67 | struct fd_handler | |
68 | { | |
69 | fd_set readfd; | |
70 | fd_set writefd; | |
71 | fd_set exceptfd; | |
72 | }; | |
73 | #endif | |
74 | ||
718e3744 | 75 | /* Master of the theads. */ |
76 | struct thread_master | |
77 | { | |
308d14ae DV |
78 | struct thread **read; |
79 | struct thread **write; | |
4becea72 | 80 | struct pqueue *timer; |
718e3744 | 81 | struct thread_list event; |
82 | struct thread_list ready; | |
83 | struct thread_list unuse; | |
4becea72 | 84 | struct pqueue *background; |
308d14ae | 85 | int fd_limit; |
0a95a0d0 | 86 | struct fd_handler handler; |
718e3744 | 87 | unsigned long alloc; |
705f2179 QY |
88 | long selectpoll_timeout; |
89 | bool spin; | |
90 | bool handle_signals; | |
1189d95f | 91 | pthread_mutex_t mtx; |
718e3744 | 92 | }; |
93 | ||
41b2373c PJ |
94 | typedef unsigned char thread_type; |
95 | ||
718e3744 | 96 | /* Thread itself. */ |
97 | struct thread | |
98 | { | |
41b2373c PJ |
99 | thread_type type; /* thread type */ |
100 | thread_type add_type; /* thread type */ | |
a48b4e6d | 101 | struct thread *next; /* next pointer of the thread */ |
718e3744 | 102 | struct thread *prev; /* previous pointer of the thread */ |
103 | struct thread_master *master; /* pointer to the struct thread_master. */ | |
104 | int (*func) (struct thread *); /* event function */ | |
105 | void *arg; /* event argument */ | |
106 | union { | |
107 | int val; /* second argument of the event. */ | |
108 | int fd; /* file descriptor in case of read/write. */ | |
109 | struct timeval sands; /* rest of time sands value. */ | |
110 | } u; | |
4becea72 | 111 | int index; /* used for timers to store position in queue */ |
41af338e | 112 | struct timeval real; |
cc8b13a0 | 113 | struct cpu_thread_history *hist; /* cache pointer to cpu_history */ |
50596be0 | 114 | unsigned long yield; /* yield time in us */ |
9c7753e4 DL |
115 | const char *funcname; |
116 | const char *schedfrom; | |
117 | int schedfrom_line; | |
1189d95f | 118 | pthread_mutex_t mtx; |
e04ab74d | 119 | }; |
120 | ||
8b70d0b0 | 121 | struct cpu_thread_history |
122 | { | |
e04ab74d | 123 | int (*func)(struct thread *); |
e04ab74d | 124 | unsigned int total_calls; |
f7c62e11 | 125 | unsigned int total_active; |
8b70d0b0 | 126 | struct time_stats |
127 | { | |
128 | unsigned long total, max; | |
129 | } real; | |
8b70d0b0 | 130 | struct time_stats cpu; |
41b2373c | 131 | thread_type types; |
9c7753e4 | 132 | const char *funcname; |
718e3744 | 133 | }; |
134 | ||
ca1f4309 DS |
135 | /* Struct timeval's tv_usec one second value. */ |
136 | #define TIMER_SECOND_MICRO 1000000L | |
137 | ||
718e3744 | 138 | /* Thread types. */ |
139 | #define THREAD_READ 0 | |
140 | #define THREAD_WRITE 1 | |
141 | #define THREAD_TIMER 2 | |
142 | #define THREAD_EVENT 3 | |
143 | #define THREAD_READY 4 | |
a48b4e6d | 144 | #define THREAD_BACKGROUND 5 |
145 | #define THREAD_UNUSED 6 | |
146 | #define THREAD_EXECUTE 7 | |
718e3744 | 147 | |
148 | /* Thread yield time. */ | |
17fc128d | 149 | #define THREAD_YIELD_TIME_SLOT 10 * 1000L /* 10ms */ |
718e3744 | 150 | |
151 | /* Macros. */ | |
152 | #define THREAD_ARG(X) ((X)->arg) | |
153 | #define THREAD_FD(X) ((X)->u.fd) | |
154 | #define THREAD_VAL(X) ((X)->u.val) | |
155 | ||
718e3744 | 156 | #define THREAD_OFF(thread) \ |
157 | do { \ | |
158 | if (thread) \ | |
159 | { \ | |
160 | thread_cancel (thread); \ | |
161 | thread = NULL; \ | |
162 | } \ | |
163 | } while (0) | |
164 | ||
165 | #define THREAD_READ_OFF(thread) THREAD_OFF(thread) | |
166 | #define THREAD_WRITE_OFF(thread) THREAD_OFF(thread) | |
167 | #define THREAD_TIMER_OFF(thread) THREAD_OFF(thread) | |
168 | ||
9c7753e4 DL |
169 | #define debugargdef const char *funcname, const char *schedfrom, int fromln |
170 | ||
ffa2c898 QY |
171 | #define thread_add_read(m,f,a,v,t) funcname_thread_add_read_write(THREAD_READ,m,f,a,v,t,#f,__FILE__,__LINE__) |
172 | #define thread_add_write(m,f,a,v,t) funcname_thread_add_read_write(THREAD_WRITE,m,f,a,v,t,#f,__FILE__,__LINE__) | |
173 | #define thread_add_timer(m,f,a,v,t) funcname_thread_add_timer(m,f,a,v,t,#f,__FILE__,__LINE__) | |
174 | #define thread_add_timer_msec(m,f,a,v,t) funcname_thread_add_timer_msec(m,f,a,v,t,#f,__FILE__,__LINE__) | |
175 | #define thread_add_timer_tv(m,f,a,v,t) funcname_thread_add_timer_tv(m,f,a,v,t,#f,__FILE__,__LINE__) | |
176 | #define thread_add_event(m,f,a,v,t) funcname_thread_add_event(m,f,a,v,t,#f,__FILE__,__LINE__) | |
9c7753e4 | 177 | #define thread_execute(m,f,a,v) funcname_thread_execute(m,f,a,v,#f,__FILE__,__LINE__) |
fb9e46bb | 178 | |
179 | /* The 4th arg to thread_add_background is the # of milliseconds to delay. */ | |
ffa2c898 | 180 | #define thread_add_background(m,f,a,v,t) funcname_thread_add_background(m,f,a,v,t,#f,__FILE__,__LINE__) |
e04ab74d | 181 | |
718e3744 | 182 | /* Prototypes. */ |
8cc4198f | 183 | extern struct thread_master *thread_master_create (void); |
184 | extern void thread_master_free (struct thread_master *); | |
495f0b13 | 185 | extern void thread_master_free_unused(struct thread_master *); |
8cc4198f | 186 | |
8dadcae7 | 187 | extern struct thread *funcname_thread_add_read_write (int dir, struct thread_master *, |
ffa2c898 QY |
188 | int (*)(struct thread *), void *, int, struct thread **, debugargdef); |
189 | ||
8cc4198f | 190 | extern struct thread *funcname_thread_add_timer (struct thread_master *, |
ffa2c898 QY |
191 | int (*)(struct thread *), void *, long, struct thread **, debugargdef); |
192 | ||
8cc4198f | 193 | extern struct thread *funcname_thread_add_timer_msec (struct thread_master *, |
ffa2c898 QY |
194 | int (*)(struct thread *), void *, long, struct thread **, debugargdef); |
195 | ||
d03c4cbd | 196 | extern struct thread *funcname_thread_add_timer_tv (struct thread_master *, |
ffa2c898 QY |
197 | int (*)(struct thread *), void *, struct timeval *, struct thread **, debugargdef); |
198 | ||
8cc4198f | 199 | extern struct thread *funcname_thread_add_event (struct thread_master *, |
ffa2c898 QY |
200 | int (*)(struct thread *), void *, int, struct thread **, debugargdef); |
201 | ||
8cc4198f | 202 | extern struct thread *funcname_thread_add_background (struct thread_master *, |
ffa2c898 QY |
203 | int (*func)(struct thread *), void *arg, long milliseconds_to_delay, |
204 | struct thread **, debugargdef); | |
205 | ||
8cc4198f | 206 | extern struct thread *funcname_thread_execute (struct thread_master *, |
ffa2c898 | 207 | int (*)(struct thread *), void *, int, debugargdef); |
9c7753e4 DL |
208 | #undef debugargdef |
209 | ||
8cc4198f | 210 | extern void thread_cancel (struct thread *); |
dc81807a | 211 | extern unsigned int thread_cancel_event (struct thread_master *, void *); |
8cc4198f | 212 | extern struct thread *thread_fetch (struct thread_master *, struct thread *); |
213 | extern void thread_call (struct thread *); | |
214 | extern unsigned long thread_timer_remain_second (struct thread *); | |
6ac44687 | 215 | extern struct timeval thread_timer_remain(struct thread*); |
8cc4198f | 216 | extern int thread_should_yield (struct thread *); |
50596be0 DS |
217 | /* set yield time for thread */ |
218 | extern void thread_set_yield_time (struct thread *, unsigned long); | |
718e3744 | 219 | |
55c72803 | 220 | /* Internal libfrr exports */ |
db9c0df9 | 221 | extern void thread_getrusage (RUSAGE_T *); |
0b84f294 | 222 | extern void thread_cmd_init (void); |
e04ab74d | 223 | |
8b70d0b0 | 224 | /* Returns elapsed real (wall clock) time. */ |
225 | extern unsigned long thread_consumed_time(RUSAGE_T *after, RUSAGE_T *before, | |
226 | unsigned long *cpu_time_elapsed); | |
227 | ||
d1265948 DL |
228 | /* only for use in logging functions! */ |
229 | extern struct thread *thread_current; | |
230 | ||
718e3744 | 231 | #endif /* _ZEBRA_THREAD_H */ |