summaryrefslogtreecommitdiff
path: root/sys/dev/raidframe/rf_threadstuff.h
blob: 93f9706b3a797f0f8351b3ba98e473c26174e122 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/*	$OpenBSD: rf_threadstuff.h,v 1.8 2002/12/16 07:01:05 tdeval Exp $	*/
/*	$NetBSD: rf_threadstuff.h,v 1.8 2000/06/11 03:35:38 oster Exp $	*/

/*
 * Copyright (c) 1995 Carnegie-Mellon University.
 * All rights reserved.
 *
 * Author: Mark Holland, Daniel Stodolsky, Jim Zelenka
 *
 * Permission to use, copy, modify and distribute this software and
 * its documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 *
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 *
 * Carnegie Mellon requests users of this software to return to
 *
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 *
 * any improvements or extensions that they make and grant Carnegie the
 * rights to redistribute these changes.
 */

/*
 * threadstuff.h -- Definitions for threads, locks, and synchronization.
 *
 * The purpose of this file is provide some illusion of portability.
 * If the functions below can be implemented with the same semantics on
 * some new system, then at least the synchronization and thread control
 * part of the code should not require modification to port to a new machine.
 * The only other place where the pthread package is explicitly used is
 * threadid.h
 *
 * This file should be included above stdio.h to get some necessary defines.
 *
 */

#ifndef	_RF__RF_THREADSTUFF_H_
#define	_RF__RF_THREADSTUFF_H_

#include "rf_types.h"
#include <sys/types.h>
#include <sys/param.h>
#ifdef	_KERNEL
#include <sys/systm.h>
#include <sys/proc.h>
#include <sys/kthread.h>
#endif

#define	rf_create_managed_mutex(a,b)					\
	_rf_create_managed_mutex(a,b,__FILE__,__LINE__)
#define	rf_create_managed_cond(a,b)					\
	_rf_create_managed_cond(a,b,__FILE__,__LINE__)
#define	rf_init_managed_threadgroup(a,b)				\
	_rf_init_managed_threadgroup(a,b,__FILE__,__LINE__)
#define	rf_init_threadgroup(a)						\
	_rf_init_threadgroup(a,__FILE__,__LINE__)
#define	rf_destroy_threadgroup(a)					\
	_rf_destroy_threadgroup(a,__FILE__,__LINE__)

int _rf_init_threadgroup(RF_ThreadGroup_t *, char *, int);
int _rf_destroy_threadgroup(RF_ThreadGroup_t *, char *, int);
int _rf_init_managed_threadgroup(RF_ShutdownList_t **, RF_ThreadGroup_t *,
    char *, int);

#include <sys/lock.h>
#define	decl_simple_lock_data(a,b)	a struct simplelock b
#define	simple_lock_addr(a)		((struct simplelock *)&(a))

typedef struct proc	*RF_Thread_t;
typedef void		*RF_ThreadArg_t;

#define	RF_DECLARE_MUTEX(_m_)		decl_simple_lock_data(,(_m_))
#define	RF_DECLARE_STATIC_MUTEX(_m_)	decl_simple_lock_data(static,(_m_))
#define	RF_DECLARE_EXTERN_MUTEX(_m_)	decl_simple_lock_data(extern,(_m_))

#define	RF_DECLARE_COND(_c_)		int _c_
#define	RF_DECLARE_STATIC_COND(_c_)	static int _c_
#define	RF_DECLARE_EXTERN_COND(_c_)	extern int _c_

#define	RF_LOCK_MUTEX(_m_)		simple_lock(&(_m_))
#define	RF_UNLOCK_MUTEX(_m_)		simple_unlock(&(_m_))

/*
 * In Net- and OpenBSD, kernel threads are simply processes that share several
 * substructures and never run in userspace.
 */
#define	RF_WAIT_COND(_c_,_m_)	do {					\
	RF_UNLOCK_MUTEX(_m_);						\
	tsleep(&_c_, PRIBIO, "rfwcond", 0);				\
	RF_LOCK_MUTEX(_m_);						\
} while (0)
#define	RF_SIGNAL_COND(_c_)	wakeup(&(_c_))
#define	RF_BROADCAST_COND(_c_)	wakeup(&(_c_))
#define	RF_CREATE_THREAD(_handle_, _func_, _arg_, _name_)		\
	kthread_create((void (*)(void *))(_func_), (void *)(_arg_),	\
	    (struct proc **)&(_handle_), _name_)

struct RF_ThreadGroup_s {
	int			 created;
	int			 running;
	int			 shutdown;
	RF_DECLARE_MUTEX	(mutex);
	RF_DECLARE_COND		(cond);
};

/*
 * Someone has started a thread in the group.
 */
#define	RF_THREADGROUP_STARTED(_g_)	do {				\
	RF_LOCK_MUTEX((_g_)->mutex);					\
	(_g_)->created++;						\
	RF_UNLOCK_MUTEX((_g_)->mutex);					\
} while (0)

/*
 * Thread announcing that it is now running.
 */
#define	RF_THREADGROUP_RUNNING(_g_)	do {				\
	RF_LOCK_MUTEX((_g_)->mutex);					\
	(_g_)->running++;						\
	RF_UNLOCK_MUTEX((_g_)->mutex);					\
	RF_SIGNAL_COND((_g_)->cond);					\
} while (0)

/*
 * Thread announcing that it is now done.
 */
#define	RF_THREADGROUP_DONE(_g_)	do {				\
	RF_LOCK_MUTEX((_g_)->mutex);					\
	(_g_)->shutdown++;						\
	RF_UNLOCK_MUTEX((_g_)->mutex);					\
	RF_SIGNAL_COND((_g_)->cond);					\
} while (0)

/*
 * Wait for all threads to start running.
 */
#define	RF_THREADGROUP_WAIT_START(_g_)	do {				\
	RF_LOCK_MUTEX((_g_)->mutex);					\
	while((_g_)->running < (_g_)->created) {			\
		RF_WAIT_COND((_g_)->cond, (_g_)->mutex);		\
	}								\
	RF_UNLOCK_MUTEX((_g_)->mutex);					\
} while (0)

/*
 * Wait for all threads to stop running.
 */
#if	!defined(__NetBSD__) && !defined(__OpenBSD__)
#define	RF_THREADGROUP_WAIT_STOP(_g_)	do {				\
	RF_LOCK_MUTEX((_g_)->mutex);					\
	RF_ASSERT((_g_)->running == (_g_)->created);			\
	while((_g_)->shutdown < (_g_)->running) {			\
		RF_WAIT_COND((_g_)->cond, (_g_)->mutex);		\
	}								\
	RF_UNLOCK_MUTEX((_g_)->mutex);					\
} while (0)
#else
 /*
  * XXX Note that we've removed the assert. That should be put back in once
  * we actually get something like a kernel thread running.
  */
#define	RF_THREADGROUP_WAIT_STOP(_g_)	do {				\
	RF_LOCK_MUTEX((_g_)->mutex);					\
	while((_g_)->shutdown < (_g_)->running) {			\
		RF_WAIT_COND((_g_)->cond, (_g_)->mutex);		\
	}								\
	RF_UNLOCK_MUTEX((_g_)->mutex);					\
} while (0)
#endif


int  rf_mutex_init(struct simplelock *);
int  rf_mutex_destroy(struct simplelock *);
int _rf_create_managed_mutex(RF_ShutdownList_t **, struct simplelock *,
	char *, int);
int _rf_create_managed_cond(RF_ShutdownList_t ** listp, int *, char *, int);

int  rf_cond_init(int *);
int  rf_cond_destroy(int *);

#endif	/* !_RF__RF_THREADSTUFF_H_ */