summaryrefslogtreecommitdiff
path: root/sys/dev/raidframe/rf_paritylog.h
blob: f50bfa0b0d6d34ac6b804802ccae6f942c9e937f (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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
/*	$OpenBSD: rf_paritylog.h,v 1.3 2002/12/16 07:01:04 tdeval Exp $	*/
/*	$NetBSD: rf_paritylog.h,v 1.3 1999/02/05 00:06:14 oster Exp $	*/

/*
 * Copyright (c) 1995 Carnegie-Mellon University.
 * All rights reserved.
 *
 * Author: William V. Courtright II
 *
 * 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.
 */

/*
 * Header file for parity log.
 */

#ifndef	_RF__RF_PARITYLOG_H_
#define	_RF__RF_PARITYLOG_H_

#include "rf_types.h"

#define	RF_DEFAULT_NUM_SECTORS_PER_LOG		64

typedef int RF_RegionId_t;

typedef enum RF_ParityRecordType_e {
	RF_STOP,
	RF_UPDATE,
	RF_OVERWRITE
} RF_ParityRecordType_t;

struct RF_CommonLogData_s {
	RF_DECLARE_MUTEX(mutex);	/* Protects cnt. */
	int			  cnt;	/* When 0, time to call wakeFunc. */
	RF_Raid_t		 *raidPtr;
/*	int			(*wakeFunc) (struct buf *); */
	int			(*wakeFunc) (RF_DagNode_t *, int);
	void			 *wakeArg;
	RF_AccTraceEntry_t	 *tracerec;
	RF_Etimer_t		  startTime;
	caddr_t			  bufPtr;
	RF_ParityRecordType_t	  operation;
	RF_CommonLogData_t	 *next;
};

struct RF_ParityLogData_s {
	RF_RegionId_t		 regionID;	/*
						 * This struct guaranteed to
						 * span a single region.
						 */
	int			 bufOffset;	/*
						 * Offset from common->bufPtr.
						 */
	RF_PhysDiskAddr_t	 diskAddress;
	RF_CommonLogData_t	*common;	/*
						 * Info shared by one or more
						 * parityLogData structs.
						 */
	RF_ParityLogData_t	*next;
	RF_ParityLogData_t	*prev;
};

struct RF_ParityLogAppendQueue_s {
	RF_DECLARE_MUTEX(mutex);
};

struct RF_ParityLogRecord_s {
	RF_PhysDiskAddr_t	 parityAddr;
	RF_ParityRecordType_t	 operation;
};

struct RF_ParityLog_s {
	RF_RegionId_t		 regionID;
	int			 numRecords;
	int			 diskOffset;
	RF_ParityLogRecord_t	*records;
	caddr_t			 bufPtr;
	RF_ParityLog_t		*next;
};

struct RF_ParityLogQueue_s {
	RF_DECLARE_MUTEX(mutex);
	RF_ParityLog_t	*parityLogs;
};

struct RF_RegionBufferQueue_s {
	RF_DECLARE_MUTEX(mutex);
	RF_DECLARE_COND(cond);
	int	 bufferSize;
	int	 totalBuffers;		/* Size of array 'buffers'. */
	int	 availableBuffers;	/* Num available 'buffers'. */
	int	 emptyBuffersIndex;	/* Stick next freed buffer here. */
	int	 availBuffersIndex;	/* Grab next buffer from here. */
	caddr_t	*buffers;		/* Array buffers used to hold parity. */
};
#define	RF_PLOG_CREATED		(1<<0)	/* Thread is created. */
#define	RF_PLOG_RUNNING		(1<<1)	/* Thread is running. */
#define	RF_PLOG_TERMINATE	(1<<2)	/* Thread is terminated (should exit).*/
#define	RF_PLOG_SHUTDOWN	(1<<3)	/* Thread is aware and exiting/exited.*/

struct RF_ParityLogDiskQueue_s {
	RF_DECLARE_MUTEX(mutex);	/* Protects all vars in this struct. */
	RF_DECLARE_COND(cond);
	int			 threadState;	/*
						 * Is thread running, should it
						 * shutdown ?  (see above)
						 */
	RF_ParityLog_t		*flushQueue;	/*
						 * List of parity logs to be
						 * flushed to log disk.
						 */
	RF_ParityLog_t		*reintQueue;	/*
						 * List of parity logs waiting
						 * to be reintegrated.
						 */
	RF_ParityLogData_t	*bufHead;	/*
						 * Head of FIFO list of log
						 * data, waiting on a buffer.
						 */
	RF_ParityLogData_t	*bufTail;	/*
						 * Tail of FIFO list of log
						 * data, waiting on a buffer.
						 */
	RF_ParityLogData_t	*reintHead;	/*
						 * Head of FIFO list of
						 * log data, waiting on
						 * reintegration.
						 */
	RF_ParityLogData_t	*reintTail;	/*
						 * Tail of FIFO list of
						 * log data, waiting on
						 * reintegration.
						 */
	RF_ParityLogData_t	*logBlockHead;	/*
						 * Queue of work, blocked
						 * until a log is available.
						 */
	RF_ParityLogData_t	*logBlockTail;
	RF_ParityLogData_t	*reintBlockHead;/*
						 * Queue of work, blocked
						 * until reintegration is
						 * complete.
						 */
	RF_ParityLogData_t	*reintBlockTail;
	RF_CommonLogData_t	*freeCommonList;/*
						 * List of unused common
						 * data structs.
						 */
	RF_ParityLogData_t	*freeDataList;	/*
						 * List of unused log
						 * data structs.
						 */
};

struct RF_DiskMap_s {
	RF_PhysDiskAddr_t	parityAddr;
	RF_ParityRecordType_t	operation;
};

struct RF_RegionInfo_s {
	RF_DECLARE_MUTEX(mutex);		/*
						 * Protects: diskCount, diskMap,
						 * loggingEnabled, coreLog.
						 */
	RF_DECLARE_MUTEX(reintMutex);		/* Protects: reintInProgress. */
	int		 reintInProgress;	/*
						 * Flag used to suspend flushing
						 * operations.
						 */
	RF_SectorCount_t capacity;		/*
						 * Capacity of this region
						 * in sectors.
						*/
	RF_SectorNum_t	 regionStartAddr;	/*
						 * Starting disk address for
						 * this region.
						 */
	RF_SectorNum_t	 parityStartAddr;	/*
						 * Starting disk address for
						 * this region.
						 */
	RF_SectorCount_t numSectorsParity;	/*
						 * Number of parity sectors
						 * protected by this region.
						 */
	RF_SectorCount_t diskCount;		/*
						 * Num of sectors written to
						 * this region's disk log.
						 */
	RF_DiskMap_t	*diskMap;		/*
						 * In-core map of what's in
						 * this region's disk log.
						 */
	int		 loggingEnabled;	/*
						 * Logging enable for this
						 * region.
						 */
	RF_ParityLog_t	*coreLog;		/*
						 * In-core log for this region.
						 */
};

RF_ParityLogData_t *rf_CreateParityLogData(RF_ParityRecordType_t,
	RF_PhysDiskAddr_t *, caddr_t, RF_Raid_t *,
	int (*) (RF_DagNode_t *, int), void *,
	RF_AccTraceEntry_t *, RF_Etimer_t);
RF_ParityLogData_t *rf_SearchAndDequeueParityLogData(RF_Raid_t *, RF_RegionId_t,
	RF_ParityLogData_t **, RF_ParityLogData_t **, int);
void rf_ReleaseParityLogs(RF_Raid_t *, RF_ParityLog_t *);
int  rf_ParityLogAppend(RF_ParityLogData_t *, int, RF_ParityLog_t **, int);
void rf_EnableParityLogging(RF_Raid_t *);

#endif	/* !_RF__RF_PARITYLOG_H_ */