]>
git.proxmox.com Git - mirror_frr.git/blob - lib/thread.h
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
34 #define RUSAGE_T struct rusage_t
36 #define GETRUSAGE(X) thread_getrusage(X)
38 /* Linked list of thread. */
50 /* number of pfd stored in pfds */
52 /* number of pfd stored in pfds + number of snmp pfd */
54 /* number of pfd that fit in the allocated space of pfds */
56 /* file descriptors to monitor for i/o */
58 /* chunk used for temp copy of pollfds */
62 /* Master of the theads. */
66 struct thread
**write
;
68 struct thread_list event
;
69 struct thread_list ready
;
70 struct thread_list unuse
;
73 struct fd_handler handler
;
75 long selectpoll_timeout
;
82 typedef unsigned char thread_type
;
87 thread_type type
; /* thread type */
88 thread_type add_type
; /* thread type */
89 struct thread
*next
; /* next pointer of the thread */
90 struct thread
*prev
; /* previous pointer of the thread */
91 struct thread
**ref
; /* external reference (if given) */
92 struct thread_master
*master
; /* pointer to the struct thread_master */
93 int (*func
) (struct thread
*); /* event function */
94 void *arg
; /* event argument */
96 int val
; /* second argument of the event. */
97 int fd
; /* file descriptor in case of r/w */
98 struct timeval sands
; /* rest of time sands value. */
100 int index
; /* queue position for timers */
102 struct cpu_thread_history
*hist
; /* cache pointer to cpu_history */
103 unsigned long yield
; /* yield time in microseconds */
104 const char *funcname
; /* name of thread function */
105 const char *schedfrom
; /* source file thread was scheduled from */
106 int schedfrom_line
; /* line number of source file */
107 pthread_mutex_t mtx
; /* mutex for thread.c functions */
110 struct cpu_thread_history
112 int (*func
)(struct thread
*);
113 unsigned int total_calls
;
114 unsigned int total_active
;
117 unsigned long total
, max
;
119 struct time_stats cpu
;
121 const char *funcname
;
124 /* Struct timeval's tv_usec one second value. */
125 #define TIMER_SECOND_MICRO 1000000L
128 #define THREAD_READ 0
129 #define THREAD_WRITE 1
130 #define THREAD_TIMER 2
131 #define THREAD_EVENT 3
132 #define THREAD_READY 4
133 #define THREAD_UNUSED 5
134 #define THREAD_EXECUTE 6
136 /* Thread yield time. */
137 #define THREAD_YIELD_TIME_SLOT 10 * 1000L /* 10ms */
140 #define THREAD_ARG(X) ((X)->arg)
141 #define THREAD_FD(X) ((X)->u.fd)
142 #define THREAD_VAL(X) ((X)->u.val)
144 #define THREAD_OFF(thread) \
148 thread_cancel (thread); \
153 #define THREAD_READ_OFF(thread) THREAD_OFF(thread)
154 #define THREAD_WRITE_OFF(thread) THREAD_OFF(thread)
155 #define THREAD_TIMER_OFF(thread) THREAD_OFF(thread)
157 #define debugargdef const char *funcname, const char *schedfrom, int fromln
159 #define thread_add_read(m,f,a,v,t) funcname_thread_add_read_write(THREAD_READ,m,f,a,v,t,#f,__FILE__,__LINE__)
160 #define thread_add_write(m,f,a,v,t) funcname_thread_add_read_write(THREAD_WRITE,m,f,a,v,t,#f,__FILE__,__LINE__)
161 #define thread_add_timer(m,f,a,v,t) funcname_thread_add_timer(m,f,a,v,t,#f,__FILE__,__LINE__)
162 #define thread_add_timer_msec(m,f,a,v,t) funcname_thread_add_timer_msec(m,f,a,v,t,#f,__FILE__,__LINE__)
163 #define thread_add_timer_tv(m,f,a,v,t) funcname_thread_add_timer_tv(m,f,a,v,t,#f,__FILE__,__LINE__)
164 #define thread_add_event(m,f,a,v,t) funcname_thread_add_event(m,f,a,v,t,#f,__FILE__,__LINE__)
165 #define thread_execute(m,f,a,v) funcname_thread_execute(m,f,a,v,#f,__FILE__,__LINE__)
168 extern struct thread_master
*thread_master_create (void);
169 extern void thread_master_free (struct thread_master
*);
170 extern void thread_master_free_unused(struct thread_master
*);
172 extern struct thread
* funcname_thread_add_read_write (int dir
, struct thread_master
*,
173 int (*)(struct thread
*), void *, int, struct thread
**, debugargdef
);
175 extern struct thread
* funcname_thread_add_timer (struct thread_master
*,
176 int (*)(struct thread
*), void *, long, struct thread
**, debugargdef
);
178 extern struct thread
* funcname_thread_add_timer_msec (struct thread_master
*,
179 int (*)(struct thread
*), void *, long, struct thread
**, debugargdef
);
181 extern struct thread
* funcname_thread_add_timer_tv (struct thread_master
*,
182 int (*)(struct thread
*), void *, struct timeval
*, struct thread
**, debugargdef
);
184 extern struct thread
* funcname_thread_add_event (struct thread_master
*,
185 int (*)(struct thread
*), void *, int, struct thread
**, debugargdef
);
187 extern void funcname_thread_execute (struct thread_master
*,
188 int (*)(struct thread
*), void *, int, debugargdef
);
191 extern void thread_cancel (struct thread
*);
192 extern unsigned int thread_cancel_event (struct thread_master
*, void *);
193 extern struct thread
*thread_fetch (struct thread_master
*, struct thread
*);
194 extern void thread_call (struct thread
*);
195 extern unsigned long thread_timer_remain_second (struct thread
*);
196 extern struct timeval
thread_timer_remain(struct thread
*);
197 extern int thread_should_yield (struct thread
*);
198 /* set yield time for thread */
199 extern void thread_set_yield_time (struct thread
*, unsigned long);
201 /* Internal libfrr exports */
202 extern void thread_getrusage (RUSAGE_T
*);
203 extern void thread_cmd_init (void);
205 /* Returns elapsed real (wall clock) time. */
206 extern unsigned long thread_consumed_time(RUSAGE_T
*after
, RUSAGE_T
*before
,
207 unsigned long *cpu_time_elapsed
);
209 /* only for use in logging functions! */
210 extern struct thread
*thread_current
;
212 #endif /* _ZEBRA_THREAD_H */