1 /* $NetBSD: rf_diskqueue.h,v 1.6 2001/10/04 15:58:53 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@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 * rf_diskqueue.h -- header file for disk queues 32 * 33 * see comments in rf_diskqueue.c 34 * 35 ****************************************************************************************/ 36 37 38 #ifndef _RF__RF_DISKQUEUE_H_ 39 #define _RF__RF_DISKQUEUE_H_ 40 41 #include <dev/raidframe/raidframevar.h> 42 43 #include "rf_threadstuff.h" 44 #include "rf_acctrace.h" 45 #include "rf_alloclist.h" 46 #include "rf_etimer.h" 47 48 49 #include "rf_netbsd.h" 50 51 52 #define RF_IO_NORMAL_PRIORITY 1 53 #define RF_IO_LOW_PRIORITY 0 54 55 /* the data held by a disk queue entry */ 56 struct RF_DiskQueueData_s { 57 RF_SectorNum_t sectorOffset; /* sector offset into the disk */ 58 RF_SectorCount_t numSector; /* number of sectors to read/write */ 59 RF_IoType_t type; /* read/write/nop */ 60 caddr_t buf; /* buffer pointer */ 61 RF_StripeNum_t parityStripeID; /* the RAID parity stripe ID this 62 * access is for */ 63 RF_ReconUnitNum_t which_ru; /* which RU within this parity stripe */ 64 int priority; /* the priority of this request */ 65 int (*CompleteFunc) (void *, int); /* function to be called upon 66 * completion */ 67 int (*AuxFunc) (void *,...); /* function called upon 68 * completion of the first I/O 69 * of a Read_Op_Write pair */ 70 void *argument; /* argument to be passed to CompleteFunc */ 71 RF_Raid_t *raidPtr; /* needed for simulation */ 72 RF_AccTraceEntry_t *tracerec; /* perf mon only */ 73 RF_Etimer_t qtime; /* perf mon only - time request is in queue */ 74 long entryTime; 75 RF_DiskQueueData_t *next; 76 RF_DiskQueueData_t *prev; 77 caddr_t buf2; /* for read-op-write */ 78 dev_t dev; /* the device number for in-kernel version */ 79 RF_DiskQueue_t *queue; /* the disk queue to which this req is 80 * targeted */ 81 RF_DiskQueueDataFlags_t flags; /* flags controlling operation */ 82 83 struct proc *b_proc; /* the b_proc from the original bp passed into 84 * the driver for this I/O */ 85 struct buf *bp; /* a bp to use to get this I/O done */ 86 }; 87 #define RF_LOCK_DISK_QUEUE 0x01 88 #define RF_UNLOCK_DISK_QUEUE 0x02 89 90 /* note: "Create" returns type-specific queue header pointer cast to (void *) */ 91 struct RF_DiskQueueSW_s { 92 RF_DiskQueueType_t queueType; 93 void *(*Create) (RF_SectorCount_t, RF_AllocListElem_t *, RF_ShutdownList_t **); /* creation routine -- 94 * one call per queue in 95 * system */ 96 void (*Enqueue) (void *, RF_DiskQueueData_t *, int); /* enqueue routine */ 97 RF_DiskQueueData_t *(*Dequeue) (void *); /* dequeue routine */ 98 RF_DiskQueueData_t *(*Peek) (void *); /* peek at head of queue */ 99 100 /* the rest are optional: they improve performance, but the driver 101 * will deal with it if they don't exist */ 102 int (*Promote) (void *, RF_StripeNum_t, RF_ReconUnitNum_t); /* promotes priority of 103 * tagged accesses */ 104 }; 105 106 struct RF_DiskQueue_s { 107 RF_DiskQueueSW_t *qPtr; /* access point to queue functions */ 108 void *qHdr; /* queue header, of whatever type */ 109 RF_DECLARE_MUTEX(mutex) /* mutex locking data structures */ 110 RF_DECLARE_COND(cond) /* condition variable for 111 * synchronization */ 112 long numOutstanding; /* number of I/Os currently outstanding on 113 * disk */ 114 long maxOutstanding; /* max # of I/Os that can be outstanding on a 115 * disk (in-kernel only) */ 116 int curPriority; /* the priority of accs all that are currently 117 * outstanding */ 118 long queueLength; /* number of requests in queue */ 119 RF_DiskQueueData_t *nextLockingOp; /* a locking op that has 120 * arrived at the head of the 121 * queue & is waiting for 122 * drainage */ 123 RF_DiskQueueData_t *unlockingOp; /* used at user level to 124 * communicate unlocking op 125 * b/w user (or dag exec) & 126 * disk threads */ 127 int numWaiting; /* number of threads waiting on this variable. 128 * user-level only */ 129 RF_DiskQueueFlags_t flags; /* terminate, locked */ 130 RF_Raid_t *raidPtr; /* associated array */ 131 dev_t dev; /* device number for kernel version */ 132 RF_SectorNum_t last_deq_sector; /* last sector number dequeued or 133 * dispatched */ 134 int row, col; /* debug only */ 135 struct raidcinfo *rf_cinfo; /* disks component info.. */ 136 }; 137 #define RF_DQ_LOCKED 0x02 /* no new accs allowed until queue is 138 * explicitly unlocked */ 139 140 /* macros setting & returning information about queues and requests */ 141 #define RF_QUEUE_LOCKED(_q) ((_q)->flags & RF_DQ_LOCKED) 142 #define RF_QUEUE_EMPTY(_q) (((_q)->numOutstanding == 0) && ((_q)->nextLockingOp == NULL) && !RF_QUEUE_LOCKED(_q)) 143 #define RF_QUEUE_FULL(_q) ((_q)->numOutstanding == (_q)->maxOutstanding) 144 145 #define RF_LOCK_QUEUE(_q) (_q)->flags |= RF_DQ_LOCKED 146 #define RF_UNLOCK_QUEUE(_q) (_q)->flags &= ~RF_DQ_LOCKED 147 148 #define RF_LOCK_QUEUE_MUTEX(_q_,_wh_) RF_LOCK_MUTEX((_q_)->mutex) 149 #define RF_UNLOCK_QUEUE_MUTEX(_q_,_wh_) RF_UNLOCK_MUTEX((_q_)->mutex) 150 151 #define RF_LOCKING_REQ(_r) ((_r)->flags & RF_LOCK_DISK_QUEUE) 152 #define RF_UNLOCKING_REQ(_r) ((_r)->flags & RF_UNLOCK_DISK_QUEUE) 153 154 /* whether it is ok to dispatch a regular request */ 155 #define RF_OK_TO_DISPATCH(_q_,_r_) \ 156 (RF_QUEUE_EMPTY(_q_) || \ 157 (!RF_QUEUE_FULL(_q_) && ((_r_)->priority >= (_q_)->curPriority))) 158 159 int rf_ConfigureDiskQueueSystem(RF_ShutdownList_t ** listp); 160 161 void rf_TerminateDiskQueues(RF_Raid_t * raidPtr); 162 163 int 164 rf_ConfigureDiskQueues(RF_ShutdownList_t ** listp, RF_Raid_t * raidPtr, 165 RF_Config_t * cfgPtr); 166 167 void rf_DiskIOEnqueue(RF_DiskQueue_t * queue, RF_DiskQueueData_t * req, int pri); 168 169 170 void rf_DiskIOComplete(RF_DiskQueue_t * queue, RF_DiskQueueData_t * req, int status); 171 172 int 173 rf_DiskIOPromote(RF_DiskQueue_t * queue, RF_StripeNum_t parityStripeID, 174 RF_ReconUnitNum_t which_ru); 175 176 RF_DiskQueueData_t * 177 rf_CreateDiskQueueData(RF_IoType_t typ, RF_SectorNum_t ssect, 178 RF_SectorCount_t nsect, caddr_t buf, 179 RF_StripeNum_t parityStripeID, 180 RF_ReconUnitNum_t which_ru, 181 int (*wakeF) (void *, int), 182 void *arg, RF_DiskQueueData_t * next, 183 RF_AccTraceEntry_t * tracerec, 184 void *raidPtr, RF_DiskQueueDataFlags_t flags, 185 void *kb_proc); 186 187 RF_DiskQueueData_t * 188 rf_CreateDiskQueueDataFull(RF_IoType_t typ, RF_SectorNum_t ssect, 189 RF_SectorCount_t nsect, caddr_t buf, 190 RF_StripeNum_t parityStripeID, 191 RF_ReconUnitNum_t which_ru, 192 int (*wakeF) (void *, int), 193 void *arg, RF_DiskQueueData_t * next, 194 RF_AccTraceEntry_t * tracerec, 195 int priority, int (*AuxFunc) (void *,...), 196 caddr_t buf2, void *raidPtr, 197 RF_DiskQueueDataFlags_t flags, void *kb_proc); 198 199 void 200 rf_FreeDiskQueueData(RF_DiskQueueData_t * p); 201 202 int 203 rf_ConfigureDiskQueue(RF_Raid_t *, RF_DiskQueue_t *, RF_RowCol_t, 204 RF_RowCol_t, RF_DiskQueueSW_t *, 205 RF_SectorCount_t, dev_t, int, 206 RF_ShutdownList_t **, 207 RF_AllocListElem_t *); 208 209 #endif /* !_RF__RF_DISKQUEUE_H_ */ 210