1 /* $NetBSD: rf_threadstuff.h,v 1.10 2001/01/27 20:42:21 oster Exp $ */ 2 /* 3 * Copyright (c) 1995 Carnegie-Mellon University. 4 * All rights reserved. 5 * 6 * Author: Mark Holland, Daniel Stodolsky, Jim Zelenka 7 * 8 * Permission to use, copy, modify and distribute this software and 9 * its documentation is hereby granted, provided that both the copyright 10 * notice and this permission notice appear in all copies of the 11 * software, derivative works or modified versions, and any portions 12 * thereof, and that both notices appear in supporting documentation. 13 * 14 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 15 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 16 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 17 * 18 * Carnegie Mellon requests users of this software to return to 19 * 20 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 21 * School of Computer Science 22 * Carnegie Mellon University 23 * Pittsburgh PA 15213-3890 24 * 25 * any improvements or extensions that they make and grant Carnegie the 26 * rights to redistribute these changes. 27 */ 28 29 /* 30 * threadstuff.h -- definitions for threads, locks, and synchronization 31 * 32 * The purpose of this file is provide some illusion of portability. 33 * If the functions below can be implemented with the same semantics on 34 * some new system, then at least the synchronization and thread control 35 * part of the code should not require modification to port to a new machine. 36 * the only other place where the pthread package is explicitly used is 37 * threadid.h 38 * 39 * this file should be included above stdio.h to get some necessary defines. 40 * 41 */ 42 43 #ifndef _RF__RF_THREADSTUFF_H_ 44 #define _RF__RF_THREADSTUFF_H_ 45 46 #include "rf_types.h" 47 #include <sys/types.h> 48 #include <sys/param.h> 49 #ifdef _KERNEL 50 #include <sys/systm.h> 51 #include <sys/proc.h> 52 #include <sys/kthread.h> 53 #endif 54 55 #define rf_create_managed_mutex(a,b) _rf_create_managed_mutex(a,b,__FILE__,__LINE__) 56 #define rf_create_managed_cond(a,b) _rf_create_managed_cond(a,b,__FILE__,__LINE__) 57 #define rf_init_managed_threadgroup(a,b) _rf_init_managed_threadgroup(a,b,__FILE__,__LINE__) 58 #define rf_init_threadgroup(a) _rf_init_threadgroup(a,__FILE__,__LINE__) 59 #define rf_destroy_threadgroup(a) _rf_destroy_threadgroup(a,__FILE__,__LINE__) 60 61 int _rf_init_threadgroup(RF_ThreadGroup_t * g, char *file, int line); 62 int _rf_destroy_threadgroup(RF_ThreadGroup_t * g, char *file, int line); 63 int 64 _rf_init_managed_threadgroup(RF_ShutdownList_t ** listp, 65 RF_ThreadGroup_t * g, char *file, int line); 66 67 #include <sys/lock.h> 68 #define decl_simple_lock_data(a,b) a struct simplelock b; 69 #define simple_lock_addr(a) ((struct simplelock *)&(a)) 70 71 typedef struct proc *RF_Thread_t; 72 typedef void *RF_ThreadArg_t; 73 74 #define RF_DECLARE_MUTEX(_m_) decl_simple_lock_data(,(_m_)) 75 #define RF_DECLARE_STATIC_MUTEX(_m_) decl_simple_lock_data(static,(_m_)) 76 #define RF_DECLARE_EXTERN_MUTEX(_m_) decl_simple_lock_data(extern,(_m_)) 77 78 #define RF_DECLARE_COND(_c_) int _c_; 79 #define RF_DECLARE_STATIC_COND(_c_) static int _c_; 80 #define RF_DECLARE_EXTERN_COND(_c_) extern int _c_; 81 82 #define RF_LOCK_MUTEX(_m_) simple_lock(&(_m_)) 83 #define RF_UNLOCK_MUTEX(_m_) simple_unlock(&(_m_)) 84 85 /* 86 * In NetBSD, kernel threads are simply processes which share several 87 * substructures and never run in userspace. 88 */ 89 #define RF_WAIT_COND(_c_,_m_) \ 90 ltsleep(&(_c_), PRIBIO, "rfwcond", 0, &(_m_)) 91 #define RF_SIGNAL_COND(_c_) wakeup_one(&(_c_)) 92 #define RF_BROADCAST_COND(_c_) wakeup(&(_c_)) 93 #define RF_CREATE_THREAD(_handle_, _func_, _arg_, _name_) \ 94 kthread_create1((void (*)(void *))(_func_), (void *)(_arg_), \ 95 (struct proc **)&(_handle_), _name_) 96 97 struct RF_ThreadGroup_s { 98 int created; 99 int running; 100 int shutdown; 101 RF_DECLARE_MUTEX(mutex) 102 RF_DECLARE_COND(cond) 103 }; 104 /* 105 * Someone has started a thread in the group 106 */ 107 #define RF_THREADGROUP_STARTED(_g_) { \ 108 RF_LOCK_MUTEX((_g_)->mutex); \ 109 (_g_)->created++; \ 110 RF_UNLOCK_MUTEX((_g_)->mutex); \ 111 } 112 113 /* 114 * Thread announcing that it is now running 115 */ 116 #define RF_THREADGROUP_RUNNING(_g_) { \ 117 RF_LOCK_MUTEX((_g_)->mutex); \ 118 (_g_)->running++; \ 119 RF_UNLOCK_MUTEX((_g_)->mutex); \ 120 RF_SIGNAL_COND((_g_)->cond); \ 121 } 122 123 /* 124 * Thread announcing that it is now done 125 */ 126 #define RF_THREADGROUP_DONE(_g_) { \ 127 RF_LOCK_MUTEX((_g_)->mutex); \ 128 (_g_)->shutdown++; \ 129 RF_UNLOCK_MUTEX((_g_)->mutex); \ 130 RF_SIGNAL_COND((_g_)->cond); \ 131 } 132 133 /* 134 * Wait for all threads to start running 135 */ 136 #define RF_THREADGROUP_WAIT_START(_g_) { \ 137 RF_LOCK_MUTEX((_g_)->mutex); \ 138 while((_g_)->running < (_g_)->created) { \ 139 RF_WAIT_COND((_g_)->cond, (_g_)->mutex); \ 140 } \ 141 RF_UNLOCK_MUTEX((_g_)->mutex); \ 142 } 143 144 /* 145 * Wait for all threads to stop running 146 */ 147 #ifndef __NetBSD__ 148 #define RF_THREADGROUP_WAIT_STOP(_g_) { \ 149 RF_LOCK_MUTEX((_g_)->mutex); \ 150 RF_ASSERT((_g_)->running == (_g_)->created); \ 151 while((_g_)->shutdown < (_g_)->running) { \ 152 RF_WAIT_COND((_g_)->cond, (_g_)->mutex); \ 153 } \ 154 RF_UNLOCK_MUTEX((_g_)->mutex); \ 155 } 156 #else 157 /* XXX Note that we've removed the assert. That should get put back in once 158 * we actually get something like a kernel thread running */ 159 #define RF_THREADGROUP_WAIT_STOP(_g_) { \ 160 RF_LOCK_MUTEX((_g_)->mutex); \ 161 while((_g_)->shutdown < (_g_)->running) { \ 162 RF_WAIT_COND((_g_)->cond, (_g_)->mutex); \ 163 } \ 164 RF_UNLOCK_MUTEX((_g_)->mutex); \ 165 } 166 #endif 167 168 169 int rf_mutex_init(struct simplelock *); 170 int rf_mutex_destroy(struct simplelock *); 171 int 172 _rf_create_managed_mutex(RF_ShutdownList_t **, struct simplelock *, 173 char *, int); 174 int 175 _rf_create_managed_cond(RF_ShutdownList_t ** listp, int *, 176 char *file, int line); 177 178 int rf_cond_init(int *c); 179 int rf_cond_destroy(int *c); 180 #endif /* !_RF__RF_THREADSTUFF_H_ */ 181