rf_psstatus.h revision 1.7 1 /* $NetBSD: rf_psstatus.h,v 1.7 2004/03/03 00:58:03 oster Exp $ */
2 /*
3 * Copyright (c) 1995 Carnegie-Mellon University.
4 * All rights reserved.
5 *
6 * Author: Mark Holland
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 /*****************************************************************************
30 *
31 * psstatus.h
32 *
33 * The reconstruction code maintains a bunch of status related to the parity
34 * stripes that are currently under reconstruction. This header file defines
35 * the status structures.
36 *
37 *****************************************************************************/
38
39 #ifndef _RF__RF_PSSTATUS_H_
40 #define _RF__RF_PSSTATUS_H_
41
42 #include <dev/raidframe/raidframevar.h>
43
44 #include "rf_threadstuff.h"
45 #include "rf_callback.h"
46
47 #define RF_PS_MAX_BUFS 10 /* max number of bufs we'll accumulate before
48 * we do an XOR */
49
50 #define RF_PSS_DEFAULT_TABLESIZE 200
51
52 /*
53 * Macros to acquire/release the mutex lock on a parity stripe status
54 * descriptor. Note that we use just one lock for the whole hash chain.
55 */
56 #define RF_HASH_PSID(_raid_,_psid_) ( (_psid_) % ((_raid_)->pssTableSize) ) /* simple hash function */
57 #define RF_LOCK_PSS_MUTEX(_raidPtr, _psid) \
58 RF_LOCK_MUTEX((_raidPtr)->reconControl->pssTable[ RF_HASH_PSID(_raidPtr,_psid) ].mutex)
59 #define RF_UNLOCK_PSS_MUTEX(_raidPtr, _psid) \
60 RF_UNLOCK_MUTEX((_raidPtr)->reconControl->pssTable[ RF_HASH_PSID(_raidPtr,_psid) ].mutex)
61
62 struct RF_ReconParityStripeStatus_s {
63 RF_StripeNum_t parityStripeID; /* the parity stripe ID */
64 RF_ReconUnitNum_t which_ru; /* which reconstruction unit with the
65 * indicated parity stripe */
66 RF_PSSFlags_t flags; /* flags indicating various conditions */
67 void *rbuf; /* this is the accumulating xor sum */
68 void *writeRbuf; /* DEBUG ONLY: a pointer to the rbuf after it
69 * has filled & been sent to disk */
70 void *rbufsForXor[RF_PS_MAX_BUFS]; /* these are buffers still to
71 * be xored into the
72 * accumulating sum */
73 int xorBufCount; /* num buffers waiting to be xored */
74 int blockCount; /* count of # proc that have blocked recon on
75 * this parity stripe */
76 char *issued; /* issued[i]==1 <=> column i has already
77 * issued a read request for the indicated RU */
78 RF_CallbackDesc_t *procWaitList; /* list of user procs waiting
79 * for recon to be done */
80 RF_CallbackDesc_t *blockWaitList; /* list of disks blocked
81 * waiting for user write to
82 * complete */
83 RF_CallbackDesc_t *bufWaitList; /* list of disks blocked waiting to
84 * acquire a buffer for this RU */
85 RF_ReconParityStripeStatus_t *next;
86 };
87
88 struct RF_PSStatusHeader_s {
89 RF_DECLARE_MUTEX(mutex) /* mutex for this hash chain */
90 RF_ReconParityStripeStatus_t *chain; /* the hash chain */
91 };
92 /* masks for the "flags" field above */
93 #define RF_PSS_NONE 0x00000000 /* no flags */
94 #define RF_PSS_UNDER_RECON 0x00000001 /* this parity stripe is
95 * currently under
96 * reconstruction */
97 #define RF_PSS_FORCED_ON_WRITE 0x00000002 /* indicates a recon was
98 * forced due to a user-write
99 * operation */
100 #define RF_PSS_FORCED_ON_READ 0x00000004 /* ditto for read, but not
101 * currently implemented */
102 #define RF_PSS_RECON_BLOCKED 0x00000008 /* reconstruction is currently
103 * blocked due to a pending
104 * user I/O */
105 #define RF_PSS_CREATE 0x00000010 /* tells LookupRUStatus to
106 * create the entry */
107 #define RF_PSS_BUFFERWAIT 0x00000020 /* someone is waiting for a
108 * buffer for this RU */
109
110 int rf_ConfigurePSStatus(RF_ShutdownList_t **, RF_Raid_t *, RF_Config_t *);
111 RF_PSStatusHeader_t *rf_MakeParityStripeStatusTable(RF_Raid_t *);
112 void rf_FreeParityStripeStatusTable(RF_Raid_t *, RF_PSStatusHeader_t *);
113 RF_ReconParityStripeStatus_t *rf_LookupRUStatus(RF_Raid_t *, RF_PSStatusHeader_t *,
114 RF_StripeNum_t, RF_ReconUnitNum_t,
115 RF_PSSFlags_t,
116 RF_ReconParityStripeStatus_t *);
117 void rf_PSStatusDelete(RF_Raid_t *, RF_PSStatusHeader_t *,
118 RF_ReconParityStripeStatus_t *);
119 void rf_RemoveFromActiveReconTable(RF_Raid_t *, RF_StripeNum_t, RF_ReconUnitNum_t);
120 RF_ReconParityStripeStatus_t *rf_AllocPSStatus(RF_Raid_t *);
121 void rf_FreePSStatus(RF_Raid_t *, RF_ReconParityStripeStatus_t *);
122 void rf_PrintPSStatusTable(RF_Raid_t *);
123
124 #endif /* !_RF__RF_PSSTATUS_H_ */
125