1 /* $NetBSD: rf_threadstuff.h,v 1.11 2001/10/04 15:58:56 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 <sys/types.h> 47 #include <sys/param.h> 48 #include <sys/systm.h> 49 #include <sys/proc.h> 50 #include <sys/kthread.h> 51 52 #include <dev/raidframe/raidframevar.h> 53 54 #define rf_create_managed_mutex(a,b) _rf_create_managed_mutex(a,b,__FILE__,__LINE__) 55 #define rf_create_managed_cond(a,b) _rf_create_managed_cond(a,b,__FILE__,__LINE__) 56 #define rf_init_managed_threadgroup(a,b) _rf_init_managed_threadgroup(a,b,__FILE__,__LINE__) 57 #define rf_init_threadgroup(a) _rf_init_threadgroup(a,__FILE__,__LINE__) 58 #define rf_destroy_threadgroup(a) _rf_destroy_threadgroup(a,__FILE__,__LINE__) 59 60 int _rf_init_threadgroup(RF_ThreadGroup_t * g, char *file, int line); 61 int _rf_destroy_threadgroup(RF_ThreadGroup_t * g, char *file, int line); 62 int 63 _rf_init_managed_threadgroup(RF_ShutdownList_t ** listp, 64 RF_ThreadGroup_t * g, char *file, int line); 65 66 #include <sys/lock.h> 67 #define decl_simple_lock_data(a,b) a struct simplelock b; 68 #define simple_lock_addr(a) ((struct simplelock *)&(a)) 69 70 typedef struct proc *RF_Thread_t; 71 typedef void *RF_ThreadArg_t; 72 73 #define RF_DECLARE_MUTEX(_m_) decl_simple_lock_data(,(_m_)) 74 #define RF_DECLARE_STATIC_MUTEX(_m_) decl_simple_lock_data(static,(_m_)) 75 #define RF_DECLARE_EXTERN_MUTEX(_m_) decl_simple_lock_data(extern,(_m_)) 76 77 #define RF_DECLARE_COND(_c_) int _c_; 78 #define RF_DECLARE_STATIC_COND(_c_) static int _c_; 79 #define RF_DECLARE_EXTERN_COND(_c_) extern int _c_; 80 81 #define RF_LOCK_MUTEX(_m_) simple_lock(&(_m_)) 82 #define RF_UNLOCK_MUTEX(_m_) simple_unlock(&(_m_)) 83 84 /* 85 * In NetBSD, kernel threads are simply processes which share several 86 * substructures and never run in userspace. 87 */ 88 #define RF_WAIT_COND(_c_,_m_) \ 89 ltsleep(&(_c_), PRIBIO, "rfwcond", 0, &(_m_)) 90 #define RF_SIGNAL_COND(_c_) wakeup_one(&(_c_)) 91 #define RF_BROADCAST_COND(_c_) wakeup(&(_c_)) 92 #define RF_CREATE_THREAD(_handle_, _func_, _arg_, _name_) \ 93 kthread_create1((void (*)(void *))(_func_), (void *)(_arg_), \ 94 (struct proc **)&(_handle_), _name_) 95 96 struct RF_ThreadGroup_s { 97 int created; 98 int running; 99 int shutdown; 100 RF_DECLARE_MUTEX(mutex) 101 RF_DECLARE_COND(cond) 102 }; 103 /* 104 * Someone has started a thread in the group 105 */ 106 #define RF_THREADGROUP_STARTED(_g_) { \ 107 RF_LOCK_MUTEX((_g_)->mutex); \ 108 (_g_)->created++; \ 109 RF_UNLOCK_MUTEX((_g_)->mutex); \ 110 } 111 112 /* 113 * Thread announcing that it is now running 114 */ 115 #define RF_THREADGROUP_RUNNING(_g_) { \ 116 RF_LOCK_MUTEX((_g_)->mutex); \ 117 (_g_)->running++; \ 118 RF_UNLOCK_MUTEX((_g_)->mutex); \ 119 RF_SIGNAL_COND((_g_)->cond); \ 120 } 121 122 /* 123 * Thread announcing that it is now done 124 */ 125 #define RF_THREADGROUP_DONE(_g_) { \ 126 RF_LOCK_MUTEX((_g_)->mutex); \ 127 (_g_)->shutdown++; \ 128 RF_UNLOCK_MUTEX((_g_)->mutex); \ 129 RF_SIGNAL_COND((_g_)->cond); \ 130 } 131 132 /* 133 * Wait for all threads to start running 134 */ 135 #define RF_THREADGROUP_WAIT_START(_g_) { \ 136 RF_LOCK_MUTEX((_g_)->mutex); \ 137 while((_g_)->running < (_g_)->created) { \ 138 RF_WAIT_COND((_g_)->cond, (_g_)->mutex); \ 139 } \ 140 RF_UNLOCK_MUTEX((_g_)->mutex); \ 141 } 142 143 /* 144 * Wait for all threads to stop running 145 */ 146 #ifndef __NetBSD__ 147 #define RF_THREADGROUP_WAIT_STOP(_g_) { \ 148 RF_LOCK_MUTEX((_g_)->mutex); \ 149 RF_ASSERT((_g_)->running == (_g_)->created); \ 150 while((_g_)->shutdown < (_g_)->running) { \ 151 RF_WAIT_COND((_g_)->cond, (_g_)->mutex); \ 152 } \ 153 RF_UNLOCK_MUTEX((_g_)->mutex); \ 154 } 155 #else 156 /* XXX Note that we've removed the assert. That should get put back in once 157 * we actually get something like a kernel thread running */ 158 #define RF_THREADGROUP_WAIT_STOP(_g_) { \ 159 RF_LOCK_MUTEX((_g_)->mutex); \ 160 while((_g_)->shutdown < (_g_)->running) { \ 161 RF_WAIT_COND((_g_)->cond, (_g_)->mutex); \ 162 } \ 163 RF_UNLOCK_MUTEX((_g_)->mutex); \ 164 } 165 #endif 166 167 168 int rf_mutex_init(struct simplelock *); 169 int rf_mutex_destroy(struct simplelock *); 170 int 171 _rf_create_managed_mutex(RF_ShutdownList_t **, struct simplelock *, 172 char *, int); 173 int 174 _rf_create_managed_cond(RF_ShutdownList_t ** listp, int *, 175 char *file, int line); 176 177 int rf_cond_init(int *c); 178 int rf_cond_destroy(int *c); 179 #endif /* !_RF__RF_THREADSTUFF_H_ */ 180