]>
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 | ||
25 | #ifdef HAVE_RUSAGE | |
26 | #define RUSAGE_T struct rusage | |
27 | #define GETRUSAGE(X) getrusage (RUSAGE_SELF, X); | |
28 | #else | |
29 | #define RUSAGE_T struct timeval | |
30 | #define GETRUSAGE(X) gettimeofday (X, NULL); | |
31 | #endif /* HAVE_RUSAGE */ | |
32 | ||
33 | /* Linked list of thread. */ | |
34 | struct thread_list | |
35 | { | |
36 | struct thread *head; | |
37 | struct thread *tail; | |
38 | int count; | |
39 | }; | |
40 | ||
41 | /* Master of the theads. */ | |
42 | struct thread_master | |
43 | { | |
44 | struct thread_list read; | |
45 | struct thread_list write; | |
46 | struct thread_list timer; | |
47 | struct thread_list event; | |
48 | struct thread_list ready; | |
49 | struct thread_list unuse; | |
a48b4e6d | 50 | struct thread_list background; |
718e3744 | 51 | fd_set readfd; |
52 | fd_set writefd; | |
53 | fd_set exceptfd; | |
54 | unsigned long alloc; | |
55 | }; | |
56 | ||
57 | /* Thread itself. */ | |
58 | struct thread | |
59 | { | |
60 | unsigned char type; /* thread type */ | |
fb9e46bb | 61 | unsigned char add_type; /* thread type */ |
a48b4e6d | 62 | struct thread *next; /* next pointer of the thread */ |
718e3744 | 63 | struct thread *prev; /* previous pointer of the thread */ |
64 | struct thread_master *master; /* pointer to the struct thread_master. */ | |
65 | int (*func) (struct thread *); /* event function */ | |
66 | void *arg; /* event argument */ | |
67 | union { | |
68 | int val; /* second argument of the event. */ | |
69 | int fd; /* file descriptor in case of read/write. */ | |
70 | struct timeval sands; /* rest of time sands value. */ | |
71 | } u; | |
72 | RUSAGE_T ru; /* Indepth usage info. */ | |
e04ab74d | 73 | char* funcname; |
74 | }; | |
75 | ||
a48b4e6d | 76 | struct cpu_thread_history { |
e04ab74d | 77 | int (*func)(struct thread *); |
8c328f11 | 78 | const char *funcname; |
e04ab74d | 79 | unsigned int total_calls; |
80 | unsigned long total, max; | |
81 | unsigned char types; | |
718e3744 | 82 | }; |
83 | ||
84 | /* Thread types. */ | |
85 | #define THREAD_READ 0 | |
86 | #define THREAD_WRITE 1 | |
87 | #define THREAD_TIMER 2 | |
88 | #define THREAD_EVENT 3 | |
89 | #define THREAD_READY 4 | |
a48b4e6d | 90 | #define THREAD_BACKGROUND 5 |
91 | #define THREAD_UNUSED 6 | |
92 | #define THREAD_EXECUTE 7 | |
718e3744 | 93 | |
94 | /* Thread yield time. */ | |
17fc128d | 95 | #define THREAD_YIELD_TIME_SLOT 10 * 1000L /* 10ms */ |
718e3744 | 96 | |
97 | /* Macros. */ | |
98 | #define THREAD_ARG(X) ((X)->arg) | |
99 | #define THREAD_FD(X) ((X)->u.fd) | |
100 | #define THREAD_VAL(X) ((X)->u.val) | |
101 | ||
102 | #define THREAD_READ_ON(master,thread,func,arg,sock) \ | |
103 | do { \ | |
104 | if (! thread) \ | |
105 | thread = thread_add_read (master, func, arg, sock); \ | |
106 | } while (0) | |
107 | ||
108 | #define THREAD_WRITE_ON(master,thread,func,arg,sock) \ | |
109 | do { \ | |
110 | if (! thread) \ | |
111 | thread = thread_add_write (master, func, arg, sock); \ | |
112 | } while (0) | |
113 | ||
114 | #define THREAD_TIMER_ON(master,thread,func,arg,time) \ | |
115 | do { \ | |
116 | if (! thread) \ | |
117 | thread = thread_add_timer (master, func, arg, time); \ | |
118 | } while (0) | |
119 | ||
120 | #define THREAD_OFF(thread) \ | |
121 | do { \ | |
122 | if (thread) \ | |
123 | { \ | |
124 | thread_cancel (thread); \ | |
125 | thread = NULL; \ | |
126 | } \ | |
127 | } while (0) | |
128 | ||
129 | #define THREAD_READ_OFF(thread) THREAD_OFF(thread) | |
130 | #define THREAD_WRITE_OFF(thread) THREAD_OFF(thread) | |
131 | #define THREAD_TIMER_OFF(thread) THREAD_OFF(thread) | |
132 | ||
e04ab74d | 133 | #define thread_add_read(m,f,a,v) funcname_thread_add_read(m,f,a,v,#f) |
134 | #define thread_add_write(m,f,a,v) funcname_thread_add_write(m,f,a,v,#f) | |
135 | #define thread_add_timer(m,f,a,v) funcname_thread_add_timer(m,f,a,v,#f) | |
9e867fe6 | 136 | #define thread_add_timer_msec(m,f,a,v) funcname_thread_add_timer_msec(m,f,a,v,#f) |
e04ab74d | 137 | #define thread_add_event(m,f,a,v) funcname_thread_add_event(m,f,a,v,#f) |
138 | #define thread_execute(m,f,a,v) funcname_thread_execute(m,f,a,v,#f) | |
fb9e46bb | 139 | |
140 | /* The 4th arg to thread_add_background is the # of milliseconds to delay. */ | |
a48b4e6d | 141 | #define thread_add_background(m,f,a,v) funcname_thread_add_background(m,f,a,v,#f) |
e04ab74d | 142 | |
718e3744 | 143 | /* Prototypes. */ |
144 | struct thread_master *thread_master_create (); | |
e04ab74d | 145 | struct thread *funcname_thread_add_read (struct thread_master *, |
8c328f11 | 146 | int (*)(struct thread *), void *, int, const char*); |
e04ab74d | 147 | struct thread *funcname_thread_add_write (struct thread_master *, |
8c328f11 | 148 | int (*)(struct thread *), void *, int, const char*); |
e04ab74d | 149 | struct thread *funcname_thread_add_timer (struct thread_master *, |
8c328f11 | 150 | int (*)(struct thread *), void *, long, const char*); |
9e867fe6 | 151 | struct thread *funcname_thread_add_timer_msec (struct thread_master *, |
8c328f11 | 152 | int (*)(struct thread *), void *, long, const char*); |
e04ab74d | 153 | struct thread *funcname_thread_add_event (struct thread_master *, |
8c328f11 | 154 | int (*)(struct thread *), void *, int, const char*); |
a48b4e6d | 155 | struct thread *funcname_thread_add_background (struct thread_master *, |
fb9e46bb | 156 | int (*func)(struct thread *), |
157 | void *arg, | |
158 | long milliseconds_to_delay, | |
159 | const char *funcname); | |
a48b4e6d | 160 | |
718e3744 | 161 | void thread_cancel (struct thread *); |
162 | void thread_cancel_event (struct thread_master *, void *); | |
163 | ||
164 | struct thread *thread_fetch (struct thread_master *, struct thread *); | |
e04ab74d | 165 | struct thread *funcname_thread_execute (struct thread_master *, |
8c328f11 | 166 | int (*)(struct thread *), void *, int, const char *); |
718e3744 | 167 | void thread_call (struct thread *); |
168 | unsigned long thread_timer_remain_second (struct thread *); | |
a48b4e6d | 169 | int thread_should_yield (struct thread *); |
718e3744 | 170 | |
e04ab74d | 171 | extern struct cmd_element show_thread_cpu_cmd; |
172 | ||
924b9229 | 173 | extern unsigned long thread_consumed_time(RUSAGE_T *after, RUSAGE_T *before); |
174 | ||
718e3744 | 175 | #endif /* _ZEBRA_THREAD_H */ |