sys/bus/cam/cam_sim.c

   1 /*
   2  * Common functions for SCSI Interface Modules (SIMs).
   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: src/sys/cam/cam_sim.c,v 1.3 1999/08/28 00:40:42 peter Exp $
  29  * $DragonFly: src/sys/bus/cam/cam_sim.c,v 1.12 2008/06/29 19:15:34 dillon Exp $
  30  */
  31
  32 #include <sys/param.h>
  33 #include <sys/systm.h>
  34 #include <sys/malloc.h>
  35 #include <sys/kernel.h>
  36 #include <sys/lock.h>
  37 #include <sys/spinlock.h>
  38 #include <sys/thread2.h>
  39 #include <sys/spinlock2.h>
  40
  41 #include "cam.h"
  42 #include "cam_ccb.h"
  43 #include "cam_sim.h"
  44 #include "cam_queue.h"
  45 #include "cam_xpt_sim.h"
  46
  47 #define CAM_PATH_ANY (u_int32_t)-1
  48
  49 MALLOC_DEFINE(M_CAMSIM, "CAM SIM", "CAM SIM buffers");
  50
  51 /* Drivers will use sim_mplock if they need the BGL */
  52 sim_lock        sim_mplock;
  53
  54 void
  55 cam_sim_lock(sim_lock *lock)
  56 {
  57         if (lock == &sim_mplock)
  58                 get_mplock();
  59         else
  60                 lockmgr(lock, LK_EXCLUSIVE);
  61 }
  62
  63 void
  64 cam_sim_unlock(sim_lock *lock)
  65 {
  66         if (lock == &sim_mplock)
  67                 rel_mplock();
  68         else
  69                 lockmgr(lock, LK_RELEASE);
  70 }
  71
  72 void
  73 sim_lock_assert_owned(sim_lock *lock)
  74 {
  75         if (lock == &sim_mplock)
  76                 ASSERT_MP_LOCK_HELD(curthread);
  77         else
  78                 KKASSERT(lockstatus(lock, curthread) != 0);
  79 }
  80
  81 int
  82 sim_lock_sleep(void *ident, int flags, const char *wmesg, int timo,
  83                sim_lock *lock)
  84 {
  85         int retval;
  86
  87         if (lock != &sim_mplock) {
  88                 /* lock should be held already */
  89                 KKASSERT(lockstatus(lock, curthread) != 0);
  90                 crit_enter();
  91                 tsleep_interlock(ident);
  92                 lockmgr(lock, LK_RELEASE);
  93         }
  94
  95         retval = tsleep(ident, flags, wmesg, timo);
  96
  97         if (lock != &sim_mplock) {
  98                 lockmgr(lock, LK_EXCLUSIVE);
  99                 crit_exit();
 100         }
 101
 102         return (retval);
 103 }
 104
 105 struct cam_devq *
 106 cam_simq_alloc(u_int32_t max_sim_transactions)
 107 {
 108         return (cam_devq_alloc(/*size*/0, max_sim_transactions));
 109 }
 110
 111 void
 112 cam_simq_release(struct cam_devq *devq)
 113 {
 114         cam_devq_release(devq);
 115 }
 116
 117 /*
 118  * cam_sim_alloc() may potentially be called from an interrupt (?) but
 119  * unexpected things happen to the system if malloc() returns NULL so we
 120  * use M_INTWAIT anyway.
 121  */
 122 struct cam_sim *
 123 cam_sim_alloc(sim_action_func sim_action, sim_poll_func sim_poll,
 124               const char *sim_name, void *softc, u_int32_t unit,
 125               sim_lock *lock, int max_dev_transactions,
 126               int max_tagged_dev_transactions, struct cam_devq *queue)
 127 {
 128         struct cam_sim *sim;
 129
 130         /*
 131          * XXX ahd was limited to 256 instead of 512 for unknown reasons,
 132          * move that to a global limit here.  We may be able to remove this
 133          * code, needs testing.
 134          */
 135         if (max_dev_transactions > 256)
 136                 max_dev_transactions = 256;
 137         if (max_tagged_dev_transactions > 256)
 138                 max_tagged_dev_transactions = 256;
 139
 140         /*
 141          * Allocate a simq or use the supplied (possibly shared) simq.
 142          */
 143         if (queue == NULL)
 144                 queue = cam_simq_alloc(max_tagged_dev_transactions);
 145         else
 146                 cam_devq_reference(queue);
 147
 148         if (lock == NULL)
 149                 return (NULL);
 150
 151         sim = kmalloc(sizeof(struct cam_sim), M_CAMSIM, M_INTWAIT | M_ZERO);
 152         sim->sim_action = sim_action;
 153         sim->sim_poll = sim_poll;
 154         sim->sim_name = sim_name;
 155         sim->softc = softc;
 156         sim->path_id = CAM_PATH_ANY;
 157         sim->unit_number = unit;
 158         sim->bus_id = 0;        /* set in xpt_bus_register */
 159         sim->max_tagged_dev_openings = max_tagged_dev_transactions;
 160         sim->max_dev_openings = max_dev_transactions;
 161         sim->flags = 0;
 162         sim->refcount = 1;
 163         sim->devq = queue;
 164         sim->lock = lock;
 165         if (lock == &sim_mplock) {
 166                 sim->flags |= 0;
 167                 callout_init(&sim->callout);
 168         } else {
 169                 sim->flags |= CAM_SIM_MPSAFE;
 170                 callout_init_mp(&sim->callout);
 171         }
 172
 173         SLIST_INIT(&sim->ccb_freeq);
 174         TAILQ_INIT(&sim->sim_doneq);
 175         spin_init(&sim->sim_spin);
 176
 177         return (sim);
 178 }
 179
 180 static void deadsim_poll(struct cam_sim *sim);
 181 static void deadsim_action(struct cam_sim *sim, union ccb *ccb);
 182
 183 void
 184 cam_sim_free(struct cam_sim *sim)
 185 {
 186         sim->sim_action = deadsim_action;
 187         sim->sim_poll = deadsim_poll;
 188         cam_sim_release(sim, CAM_SIM_SOFTC);
 189 }
 190
 191 /*
 192  * Note: the devq is still used by individual peripherals even if the
 193  * backend sim disappears, so do not destroy it until the sim itself
 194  * is no longer needed.
 195  */
 196 void
 197 cam_sim_release(struct cam_sim *sim, int flags)
 198 {
 199         if (flags & CAM_SIM_SOFTC)
 200                 sim->softc = NULL;
 201         if (sim->refcount == 1) {
 202                 if (sim->devq) {
 203                         cam_simq_release(sim->devq);
 204                         sim->devq = NULL;
 205                 }
 206                 sim->refcount = 0;
 207                 kfree(sim, M_CAMSIM);
 208         } else {
 209                 --sim->refcount;
 210         }
 211 }
 212
 213 void
 214 cam_sim_set_path(struct cam_sim *sim, u_int32_t path_id)
 215 {
 216         sim->path_id = path_id;
 217 }
 218
 219 /*
 220  * Dead sim poll and action functions.  The backend to the sim has gone
 221  * away, aka usb, scsi device, etc... deal with it.
 222  */
 223 static void
 224 deadsim_poll(struct cam_sim *sim)
 225 {
 226         /* empty */
 227 }
 228
 229 static void
 230 deadsim_action(struct cam_sim *sim, union ccb *ccb)
 231 {
 232         ccb->ccb_h.status = CAM_TID_INVALID;
 233         xpt_done(ccb);
 234 }
 235