rf_paritylog.h revision 1.1 1 /* $NetBSD: rf_paritylog.h,v 1.1 1998/11/13 04:20:31 oster Exp $ */
2 /*
3 * Copyright (c) 1995 Carnegie-Mellon University.
4 * All rights reserved.
5 *
6 * Author: William V. Courtright II
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 (at) 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 /* header file for parity log
30 *
31 * :
32 * Log: rf_paritylog.h,v
33 * Revision 1.21 1996/07/17 21:00:58 jimz
34 * clean up timer interface, tracing
35 *
36 * Revision 1.20 1996/07/15 17:22:18 jimz
37 * nit-pick code cleanup
38 * resolve stdlib problems on DEC OSF
39 *
40 * Revision 1.19 1996/06/11 10:17:57 jimz
41 * definitions and run state for parity logging thread
42 *
43 * Revision 1.18 1996/06/07 21:33:04 jimz
44 * begin using consistent types for sector numbers,
45 * stripe numbers, row+col numbers, recon unit numbers
46 *
47 * Revision 1.17 1996/06/05 18:06:02 jimz
48 * Major code cleanup. The Great Renaming is now done.
49 * Better modularity. Better typing. Fixed a bunch of
50 * synchronization bugs. Made a lot of global stuff
51 * per-desc or per-array. Removed dead code.
52 *
53 * Revision 1.16 1996/06/02 17:31:48 jimz
54 * Moved a lot of global stuff into array structure, where it belongs.
55 * Fixed up paritylogging, pss modules in this manner. Some general
56 * code cleanup. Removed lots of dead code, some dead files.
57 *
58 * Revision 1.15 1996/05/31 22:26:54 jimz
59 * fix a lot of mapping problems, memory allocation problems
60 * found some weird lock issues, fixed 'em
61 * more code cleanup
62 *
63 * Revision 1.14 1996/05/30 11:29:41 jimz
64 * Numerous bug fixes. Stripe lock release code disagreed with the taking code
65 * about when stripes should be locked (I made it consistent: no parity, no lock)
66 * There was a lot of extra serialization of I/Os which I've removed- a lot of
67 * it was to calculate values for the cache code, which is no longer with us.
68 * More types, function, macro cleanup. Added code to properly quiesce the array
69 * on shutdown. Made a lot of stuff array-specific which was (bogusly) general
70 * before. Fixed memory allocation, freeing bugs.
71 *
72 * Revision 1.13 1996/05/23 00:33:23 jimz
73 * code cleanup: move all debug decls to rf_options.c, all extern
74 * debug decls to rf_options.h, all debug vars preceded by rf_
75 *
76 * Revision 1.12 1996/05/18 19:51:34 jimz
77 * major code cleanup- fix syntax, make some types consistent,
78 * add prototypes, clean out dead code, et cetera
79 *
80 * Revision 1.11 1995/12/06 20:54:58 wvcii
81 * added prototyping
82 *
83 * Revision 1.10 1995/11/30 16:05:50 wvcii
84 * added copyright info
85 *
86 * Revision 1.9 1995/10/07 05:09:27 wvcii
87 * removed #define BYTESPERSECTOR 512
88 *
89 * Revision 1.8 1995/09/06 19:27:52 wvcii
90 * added startTime to commonLogData
91 *
92 * Revision 1.7 1995/07/07 00:13:42 wvcii
93 * this version free from deadlock, fails parity verification
94 *
95 */
96
97 #ifndef _RF__RF_PARITYLOG_H_
98 #define _RF__RF_PARITYLOG_H_
99
100 #include "rf_types.h"
101
102 #define RF_DEFAULT_NUM_SECTORS_PER_LOG 64
103
104 typedef int RF_RegionId_t;
105
106 typedef enum RF_ParityRecordType_e {
107 RF_STOP,
108 RF_UPDATE,
109 RF_OVERWRITE
110 } RF_ParityRecordType_t;
111
112 struct RF_CommonLogData_s {
113 RF_DECLARE_MUTEX(mutex) /* protects cnt */
114 int cnt; /* when 0, time to call wakeFunc */
115 RF_Raid_t *raidPtr;
116 /* int (*wakeFunc)(struct buf *); */
117 int (*wakeFunc)(RF_DagNode_t *node, int status);
118 void *wakeArg;
119 RF_AccTraceEntry_t *tracerec;
120 RF_Etimer_t startTime;
121 caddr_t bufPtr;
122 RF_ParityRecordType_t operation;
123 RF_CommonLogData_t *next;
124 };
125
126 struct RF_ParityLogData_s {
127 RF_RegionId_t regionID; /* this struct guaranteed to span a single region */
128 int bufOffset; /* offset from common->bufPtr */
129 RF_PhysDiskAddr_t diskAddress;
130 RF_CommonLogData_t *common; /* info shared by one or more parityLogData structs */
131 RF_ParityLogData_t *next;
132 RF_ParityLogData_t *prev;
133 };
134
135 struct RF_ParityLogAppendQueue_s {
136 RF_DECLARE_MUTEX(mutex)
137 };
138
139 struct RF_ParityLogRecord_s {
140 RF_PhysDiskAddr_t parityAddr;
141 RF_ParityRecordType_t operation;
142 };
143
144 struct RF_ParityLog_s {
145 RF_RegionId_t regionID;
146 int numRecords;
147 int diskOffset;
148 RF_ParityLogRecord_t *records;
149 caddr_t bufPtr;
150 RF_ParityLog_t *next;
151 };
152
153 struct RF_ParityLogQueue_s {
154 RF_DECLARE_MUTEX(mutex)
155 RF_ParityLog_t *parityLogs;
156 };
157
158 struct RF_RegionBufferQueue_s {
159 RF_DECLARE_MUTEX(mutex)
160 RF_DECLARE_COND(cond)
161 int bufferSize;
162 int totalBuffers; /* size of array 'buffers' */
163 int availableBuffers; /* num available 'buffers' */
164 int emptyBuffersIndex; /* stick next freed buffer here */
165 int availBuffersIndex; /* grab next buffer from here */
166 caddr_t *buffers; /* array buffers used to hold parity */
167 };
168
169 #define RF_PLOG_CREATED (1<<0) /* thread is created */
170 #define RF_PLOG_RUNNING (1<<1) /* thread is running */
171 #define RF_PLOG_TERMINATE (1<<2) /* thread is terminated (should exit) */
172 #define RF_PLOG_SHUTDOWN (1<<3) /* thread is aware and exiting/exited */
173
174 struct RF_ParityLogDiskQueue_s {
175 RF_DECLARE_MUTEX(mutex) /* protects all vars in this struct */
176 RF_DECLARE_COND(cond)
177 int threadState; /* is thread running, should it shutdown (see above) */
178 RF_ParityLog_t *flushQueue; /* list of parity logs to be flushed to log disk */
179 RF_ParityLog_t *reintQueue; /* list of parity logs waiting to be reintegrated */
180 RF_ParityLogData_t *bufHead; /* head of FIFO list of log data, waiting on a buffer */
181 RF_ParityLogData_t *bufTail; /* tail of FIFO list of log data, waiting on a buffer */
182 RF_ParityLogData_t *reintHead; /* head of FIFO list of log data, waiting on reintegration */
183 RF_ParityLogData_t *reintTail; /* tail of FIFO list of log data, waiting on reintegration */
184 RF_ParityLogData_t *logBlockHead; /* queue of work, blocked until a log is available */
185 RF_ParityLogData_t *logBlockTail;
186 RF_ParityLogData_t *reintBlockHead; /* queue of work, blocked until reintegration is complete */
187 RF_ParityLogData_t *reintBlockTail;
188 RF_CommonLogData_t *freeCommonList; /* list of unused common data structs */
189 RF_ParityLogData_t *freeDataList; /* list of unused log data structs */
190 };
191
192 struct RF_DiskMap_s {
193 RF_PhysDiskAddr_t parityAddr;
194 RF_ParityRecordType_t operation;
195 };
196
197 struct RF_RegionInfo_s {
198 RF_DECLARE_MUTEX(mutex) /* protects: diskCount, diskMap, loggingEnabled, coreLog */
199 RF_DECLARE_MUTEX(reintMutex) /* protects: reintInProgress */
200 int reintInProgress; /* flag used to suspend flushing operations */
201 RF_SectorCount_t capacity; /* capacity of this region in sectors */
202 RF_SectorNum_t regionStartAddr; /* starting disk address for this region */
203 RF_SectorNum_t parityStartAddr; /* starting disk address for this region */
204 RF_SectorCount_t numSectorsParity; /* number of parity sectors protected by this region */
205 RF_SectorCount_t diskCount; /* num of sectors written to this region's disk log */
206 RF_DiskMap_t *diskMap; /* in-core map of what's in this region's disk log */
207 int loggingEnabled; /* logging enable for this region */
208 RF_ParityLog_t *coreLog; /* in-core log for this region */
209 };
210
211 RF_ParityLogData_t *rf_CreateParityLogData(RF_ParityRecordType_t operation,
212 RF_PhysDiskAddr_t *pda, caddr_t bufPtr, RF_Raid_t *raidPtr,
213 int (*wakeFunc)(RF_DagNode_t *node, int status),
214 void *wakeArg, RF_AccTraceEntry_t *tracerec,
215 RF_Etimer_t startTime);
216 RF_ParityLogData_t *rf_SearchAndDequeueParityLogData(RF_Raid_t *raidPtr,
217 RF_RegionId_t regionID, RF_ParityLogData_t **head,
218 RF_ParityLogData_t **tail, int ignoreLocks);
219 void rf_ReleaseParityLogs(RF_Raid_t *raidPtr, RF_ParityLog_t *firstLog);
220 int rf_ParityLogAppend(RF_ParityLogData_t *logData, int finish,
221 RF_ParityLog_t **incomingLog, int clearReintFlag);
222 void rf_EnableParityLogging(RF_Raid_t *raidPtr);
223
224 #endif /* !_RF__RF_PARITYLOG_H_ */
225