sys/cam/cam_queue.h

   1 /*-
   2  * CAM request queue management definitions.
   3  *
   4  * Copyright (c) 1997 Justin T. Gibbs.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions, and the following disclaimer,
  12  *    without modification, immediately at the beginning of the file.
  13  * 2. The name of the author may not be used to endorse or promote products
  14  *    derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _CAM_CAM_QUEUE_H
  32 #define _CAM_CAM_QUEUE_H 1
  33
  34 #ifdef _KERNEL
  35
  36 #include <sys/queue.h>
  37 #include <cam/cam.h>
  38
  39 /*
  40  * This structure implements a heap based priority queue.  The queue
  41  * assumes that the objects stored in it begin with a cam_qentry
  42  * structure holding the priority information used to sort the objects.
  43  * This structure is opaque to clients (outside of the XPT layer) to allow
  44  * the implementation to change without affecting them.
  45  */
  46 struct camq {
  47         cam_pinfo **queue_array;
  48         int        array_size;
  49         int        entries;
  50         u_int32_t  generation;
  51         u_int32_t  qfrozen_cnt;
  52 };
  53
  54 TAILQ_HEAD(ccb_hdr_tailq, ccb_hdr);
  55 LIST_HEAD(ccb_hdr_list, ccb_hdr);
  56 SLIST_HEAD(ccb_hdr_slist, ccb_hdr);
  57
  58 struct cam_ccbq {
  59         struct  camq queue;
  60         int     devq_openings;
  61         int     devq_allocating;
  62         int     dev_openings;
  63         int     dev_active;
  64         int     held;
  65 };
  66
  67 struct cam_ed;
  68
  69 struct cam_devq {
  70         struct  camq send_queue;
  71         int     send_openings;
  72         int     send_active;
  73 };
  74
  75
  76 struct cam_devq *cam_devq_alloc(int devices, int openings);
  77
  78 int              cam_devq_init(struct cam_devq *devq, int devices,
  79                                int openings);
  80
  81 void             cam_devq_free(struct cam_devq *devq);
  82
  83 u_int32_t        cam_devq_resize(struct cam_devq *camq, int openings);
  84
  85 /*
  86  * Allocate a cam_ccb_queue structure and initialize it.
  87  */
  88 struct cam_ccbq *cam_ccbq_alloc(int openings);
  89
  90 u_int32_t       cam_ccbq_resize(struct cam_ccbq *ccbq, int devices);
  91
  92 int             cam_ccbq_init(struct cam_ccbq *ccbq, int openings);
  93
  94 void            cam_ccbq_free(struct cam_ccbq *ccbq);
  95
  96 void            cam_ccbq_fini(struct cam_ccbq *ccbq);
  97
  98 /*
  99  * Allocate and initialize a cam_queue structure.
 100  */
 101 struct camq     *camq_alloc(int size);
 102
 103 /*
 104  * Resize a cam queue
 105  */
 106 u_int32_t       camq_resize(struct camq *queue, int new_size);
 107
 108 /*
 109  * Initialize a camq structure.  Return 0 on success, 1 on failure.
 110  */
 111 int             camq_init(struct camq *camq, int size);
 112
 113 /*
 114  * Free a cam_queue structure.  This should only be called if a controller
 115  * driver failes somehow during its attach routine or is unloaded and has
 116  * obtained a cam_queue structure.
 117  */
 118 void            camq_free(struct camq *queue);
 119
 120 /*
 121  * Finialize any internal storage or state of a cam_queue.
 122  */
 123 void            camq_fini(struct camq *queue);
 124
 125 /*
 126  * cam_queue_insert: Given a CAM queue with at least one open spot,
 127  * insert the new entry maintaining order.
 128  */
 129 void            camq_insert(struct camq *queue, cam_pinfo *new_entry);
 130
 131 /*
 132  * camq_remove: Remove and arbitrary entry from the queue maintaining
 133  * queue order.
 134  */
 135 cam_pinfo       *camq_remove(struct camq *queue, int index);
 136 #define CAMQ_HEAD 1     /* Head of queue index */
 137
 138 /* Index the first element in the heap */
 139 #define CAMQ_GET_HEAD(camq) ((camq)->queue_array[CAMQ_HEAD])
 140
 141 /* Get the first element priority. */
 142 #define CAMQ_GET_PRIO(camq) (((camq)->entries > 0) ?                    \
 143                             ((camq)->queue_array[CAMQ_HEAD]->priority) : 0)
 144
 145 /*
 146  * camq_change_priority: Raise or lower the priority of an entry
 147  * maintaining queue order.
 148  */
 149 void            camq_change_priority(struct camq *queue, int index,
 150                                      u_int32_t new_priority);
 151
 152 static __inline int
 153 cam_ccbq_pending_ccb_count(struct cam_ccbq *ccbq);
 154
 155 static __inline void
 156 cam_ccbq_take_opening(struct cam_ccbq *ccbq);
 157
 158 static __inline void
 159 cam_ccbq_insert_ccb(struct cam_ccbq *ccbq, union ccb *new_ccb);
 160
 161 static __inline void
 162 cam_ccbq_remove_ccb(struct cam_ccbq *ccbq, union ccb *ccb);
 163
 164 static __inline union ccb *
 165 cam_ccbq_peek_ccb(struct cam_ccbq *ccbq, int index);
 166
 167 static __inline void
 168 cam_ccbq_send_ccb(struct cam_ccbq *queue, union ccb *send_ccb);
 169
 170 static __inline void
 171 cam_ccbq_ccb_done(struct cam_ccbq *ccbq, union ccb *done_ccb);
 172
 173 static __inline void
 174 cam_ccbq_release_opening(struct cam_ccbq *ccbq);
 175
 176
 177 static __inline int
 178 cam_ccbq_pending_ccb_count(struct cam_ccbq *ccbq)
 179 {
 180         return (ccbq->queue.entries);
 181 }
 182
 183 static __inline void
 184 cam_ccbq_take_opening(struct cam_ccbq *ccbq)
 185 {
 186         ccbq->devq_openings--;
 187         ccbq->held++;
 188 }
 189
 190 static __inline void
 191 cam_ccbq_insert_ccb(struct cam_ccbq *ccbq, union ccb *new_ccb)
 192 {
 193         ccbq->held--;
 194         camq_insert(&ccbq->queue, &new_ccb->ccb_h.pinfo);
 195 }
 196
 197 static __inline void
 198 cam_ccbq_remove_ccb(struct cam_ccbq *ccbq, union ccb *ccb)
 199 {
 200         camq_remove(&ccbq->queue, ccb->ccb_h.pinfo.index);
 201 }
 202
 203 static __inline union ccb *
 204 cam_ccbq_peek_ccb(struct cam_ccbq *ccbq, int index)
 205 {
 206         return((union ccb *)ccbq->queue.queue_array[index]);
 207 }
 208
 209 static __inline void
 210 cam_ccbq_send_ccb(struct cam_ccbq *ccbq, union ccb *send_ccb)
 211 {
 212
 213         send_ccb->ccb_h.pinfo.index = CAM_ACTIVE_INDEX;
 214         ccbq->dev_active++;
 215         ccbq->dev_openings--;
 216 }
 217
 218 static __inline void
 219 cam_ccbq_ccb_done(struct cam_ccbq *ccbq, union ccb *done_ccb)
 220 {
 221
 222         ccbq->dev_active--;
 223         ccbq->dev_openings++;
 224         ccbq->held++;
 225 }
 226
 227 static __inline void
 228 cam_ccbq_release_opening(struct cam_ccbq *ccbq)
 229 {
 230         ccbq->held--;
 231         ccbq->devq_openings++;
 232 }
 233
 234 #endif /* _KERNEL */
 235 #endif  /* _CAM_CAM_QUEUE_H */