sys/cam/ctl/ctl_backend_ramdisk.c

   1 /*-
   2  * Copyright (c) 2003, 2008 Silicon Graphics International Corp.
   3  * Copyright (c) 2012 The FreeBSD Foundation
   4  * All rights reserved.
   5  *
   6  * Portions of this software were developed by Edward Tomasz Napierala
   7  * under sponsorship from the FreeBSD Foundation.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions, and the following disclaimer,
  14  *    without modification.
  15  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  16  *    substantially similar to the "NO WARRANTY" disclaimer below
  17  *    ("Disclaimer") and any redistribution must be conditioned upon
  18  *    including a substantially similar Disclaimer requirement for further
  19  *    binary redistribution.
  20  *
  21  * NO WARRANTY
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  25  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  30  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  31  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32  * POSSIBILITY OF SUCH DAMAGES.
  33  *
  34  * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_backend_ramdisk.c#3 $
  35  */
  36 /*
  37  * CAM Target Layer backend for a "fake" ramdisk.
  38  *
  39  * Author: Ken Merry <ken@FreeBSD.org>
  40  */
  41
  42 #include <sys/cdefs.h>
  43 __FBSDID("$FreeBSD$");
  44
  45 #include <sys/param.h>
  46 #include <sys/systm.h>
  47 #include <sys/kernel.h>
  48 #include <sys/condvar.h>
  49 #include <sys/types.h>
  50 #include <sys/lock.h>
  51 #include <sys/mutex.h>
  52 #include <sys/malloc.h>
  53 #include <sys/taskqueue.h>
  54 #include <sys/time.h>
  55 #include <sys/queue.h>
  56 #include <sys/conf.h>
  57 #include <sys/ioccom.h>
  58 #include <sys/module.h>
  59 #include <sys/sysctl.h>
  60
  61 #include <cam/scsi/scsi_all.h>
  62 #include <cam/scsi/scsi_da.h>
  63 #include <cam/ctl/ctl_io.h>
  64 #include <cam/ctl/ctl.h>
  65 #include <cam/ctl/ctl_util.h>
  66 #include <cam/ctl/ctl_backend.h>
  67 #include <cam/ctl/ctl_debug.h>
  68 #include <cam/ctl/ctl_ioctl.h>
  69 #include <cam/ctl/ctl_ha.h>
  70 #include <cam/ctl/ctl_private.h>
  71 #include <cam/ctl/ctl_error.h>
  72
  73 typedef enum {
  74         CTL_BE_RAMDISK_LUN_UNCONFIGURED = 0x01,
  75         CTL_BE_RAMDISK_LUN_CONFIG_ERR   = 0x02,
  76         CTL_BE_RAMDISK_LUN_WAITING      = 0x04
  77 } ctl_be_ramdisk_lun_flags;
  78
  79 struct ctl_be_ramdisk_lun {
  80         struct ctl_lun_create_params params;
  81         char lunname[32];
  82         uint64_t size_bytes;
  83         uint64_t size_blocks;
  84         struct ctl_be_ramdisk_softc *softc;
  85         ctl_be_ramdisk_lun_flags flags;
  86         STAILQ_ENTRY(ctl_be_ramdisk_lun) links;
  87         struct ctl_be_lun cbe_lun;
  88         struct taskqueue *io_taskqueue;
  89         struct task io_task;
  90         STAILQ_HEAD(, ctl_io_hdr) cont_queue;
  91         struct mtx_padalign queue_lock;
  92 };
  93
  94 struct ctl_be_ramdisk_softc {
  95         struct mtx lock;
  96         int rd_size;
  97 #ifdef CTL_RAMDISK_PAGES
  98         uint8_t **ramdisk_pages;
  99         int num_pages;
 100 #else
 101         uint8_t *ramdisk_buffer;
 102 #endif
 103         int num_luns;
 104         STAILQ_HEAD(, ctl_be_ramdisk_lun) lun_list;
 105 };
 106
 107 static struct ctl_be_ramdisk_softc rd_softc;
 108 extern struct ctl_softc *control_softc;
 109
 110 int ctl_backend_ramdisk_init(void);
 111 void ctl_backend_ramdisk_shutdown(void);
 112 static int ctl_backend_ramdisk_move_done(union ctl_io *io);
 113 static int ctl_backend_ramdisk_submit(union ctl_io *io);
 114 static void ctl_backend_ramdisk_continue(union ctl_io *io);
 115 static int ctl_backend_ramdisk_ioctl(struct cdev *dev, u_long cmd,
 116                                      caddr_t addr, int flag, struct thread *td);
 117 static int ctl_backend_ramdisk_rm(struct ctl_be_ramdisk_softc *softc,
 118                                   struct ctl_lun_req *req);
 119 static int ctl_backend_ramdisk_create(struct ctl_be_ramdisk_softc *softc,
 120                                       struct ctl_lun_req *req);
 121 static int ctl_backend_ramdisk_modify(struct ctl_be_ramdisk_softc *softc,
 122                                   struct ctl_lun_req *req);
 123 static void ctl_backend_ramdisk_worker(void *context, int pending);
 124 static void ctl_backend_ramdisk_lun_shutdown(void *be_lun);
 125 static void ctl_backend_ramdisk_lun_config_status(void *be_lun,
 126                                                   ctl_lun_config_status status);
 127 static int ctl_backend_ramdisk_config_write(union ctl_io *io);
 128 static int ctl_backend_ramdisk_config_read(union ctl_io *io);
 129
 130 static struct ctl_backend_driver ctl_be_ramdisk_driver =
 131 {
 132         .name = "ramdisk",
 133         .flags = CTL_BE_FLAG_HAS_CONFIG,
 134         .init = ctl_backend_ramdisk_init,
 135         .data_submit = ctl_backend_ramdisk_submit,
 136         .data_move_done = ctl_backend_ramdisk_move_done,
 137         .config_read = ctl_backend_ramdisk_config_read,
 138         .config_write = ctl_backend_ramdisk_config_write,
 139         .ioctl = ctl_backend_ramdisk_ioctl
 140 };
 141
 142 MALLOC_DEFINE(M_RAMDISK, "ramdisk", "Memory used for CTL RAMdisk");
 143 CTL_BACKEND_DECLARE(cbr, ctl_be_ramdisk_driver);
 144
 145 int
 146 ctl_backend_ramdisk_init(void)
 147 {
 148         struct ctl_be_ramdisk_softc *softc = &rd_softc;
 149 #ifdef CTL_RAMDISK_PAGES
 150         int i;
 151 #endif
 152
 153         memset(softc, 0, sizeof(*softc));
 154         mtx_init(&softc->lock, "ctlramdisk", NULL, MTX_DEF);
 155         STAILQ_INIT(&softc->lun_list);
 156         softc->rd_size = 1024 * 1024;
 157 #ifdef CTL_RAMDISK_PAGES
 158         softc->num_pages = softc->rd_size / PAGE_SIZE;
 159         softc->ramdisk_pages = (uint8_t **)malloc(sizeof(uint8_t *) *
 160                                                   softc->num_pages, M_RAMDISK,
 161                                                   M_WAITOK);
 162         for (i = 0; i < softc->num_pages; i++)
 163                 softc->ramdisk_pages[i] = malloc(PAGE_SIZE, M_RAMDISK,M_WAITOK);
 164 #else
 165         softc->ramdisk_buffer = (uint8_t *)malloc(softc->rd_size, M_RAMDISK,
 166                                                   M_WAITOK);
 167 #endif
 168
 169         return (0);
 170 }
 171
 172 void
 173 ctl_backend_ramdisk_shutdown(void)
 174 {
 175         struct ctl_be_ramdisk_softc *softc = &rd_softc;
 176         struct ctl_be_ramdisk_lun *lun, *next_lun;
 177 #ifdef CTL_RAMDISK_PAGES
 178         int i;
 179 #endif
 180
 181         mtx_lock(&softc->lock);
 182         for (lun = STAILQ_FIRST(&softc->lun_list); lun != NULL; lun = next_lun){
 183                 /*
 184                  * Grab the next LUN.  The current LUN may get removed by
 185                  * ctl_invalidate_lun(), which will call our LUN shutdown
 186                  * routine, if there is no outstanding I/O for this LUN.
 187                  */
 188                 next_lun = STAILQ_NEXT(lun, links);
 189
 190                 /*
 191                  * Drop our lock here.  Since ctl_invalidate_lun() can call
 192                  * back into us, this could potentially lead to a recursive
 193                  * lock of the same mutex, which would cause a hang.
 194                  */
 195                 mtx_unlock(&softc->lock);
 196                 ctl_disable_lun(&lun->cbe_lun);
 197                 ctl_invalidate_lun(&lun->cbe_lun);
 198                 mtx_lock(&softc->lock);
 199         }
 200         mtx_unlock(&softc->lock);
 201
 202 #ifdef CTL_RAMDISK_PAGES
 203         for (i = 0; i < softc->num_pages; i++)
 204                 free(softc->ramdisk_pages[i], M_RAMDISK);
 205
 206         free(softc->ramdisk_pages, M_RAMDISK);
 207 #else
 208         free(softc->ramdisk_buffer, M_RAMDISK);
 209 #endif
 210
 211         if (ctl_backend_deregister(&ctl_be_ramdisk_driver) != 0) {
 212                 printf("ctl_backend_ramdisk_shutdown: "
 213                        "ctl_backend_deregister() failed!\n");
 214         }
 215 }
 216
 217 static int
 218 ctl_backend_ramdisk_move_done(union ctl_io *io)
 219 {
 220         struct ctl_be_lun *cbe_lun;
 221         struct ctl_be_ramdisk_lun *be_lun;
 222 #ifdef CTL_TIME_IO
 223         struct bintime cur_bt;
 224 #endif
 225
 226         CTL_DEBUG_PRINT(("ctl_backend_ramdisk_move_done\n"));
 227         cbe_lun = (struct ctl_be_lun *)io->io_hdr.ctl_private[
 228                 CTL_PRIV_BACKEND_LUN].ptr;
 229         be_lun = (struct ctl_be_ramdisk_lun *)cbe_lun->be_lun;
 230 #ifdef CTL_TIME_IO
 231         getbinuptime(&cur_bt);
 232         bintime_sub(&cur_bt, &io->io_hdr.dma_start_bt);
 233         bintime_add(&io->io_hdr.dma_bt, &cur_bt);
 234 #endif
 235         io->io_hdr.num_dmas++;
 236         if (io->scsiio.kern_sg_entries > 0)
 237                 free(io->scsiio.kern_data_ptr, M_RAMDISK);
 238         io->scsiio.kern_rel_offset += io->scsiio.kern_data_len;
 239         if (io->io_hdr.flags & CTL_FLAG_ABORT) {
 240                 ;
 241         } else if ((io->io_hdr.port_status == 0) &&
 242             ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE)) {
 243                 if (io->io_hdr.ctl_private[CTL_PRIV_BACKEND].integer > 0) {
 244                         mtx_lock(&be_lun->queue_lock);
 245                         STAILQ_INSERT_TAIL(&be_lun->cont_queue,
 246                             &io->io_hdr, links);
 247                         mtx_unlock(&be_lun->queue_lock);
 248                         taskqueue_enqueue(be_lun->io_taskqueue,
 249                             &be_lun->io_task);
 250                         return (0);
 251                 }
 252                 ctl_set_success(&io->scsiio);
 253         } else if ((io->io_hdr.port_status != 0) &&
 254             ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
 255              (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
 256                 /*
 257                  * For hardware error sense keys, the sense key
 258                  * specific value is defined to be a retry count,
 259                  * but we use it to pass back an internal FETD
 260                  * error code.  XXX KDM  Hopefully the FETD is only
 261                  * using 16 bits for an error code, since that's
 262                  * all the space we have in the sks field.
 263                  */
 264                 ctl_set_internal_failure(&io->scsiio,
 265                                          /*sks_valid*/ 1,
 266                                          /*retry_count*/
 267                                          io->io_hdr.port_status);
 268         }
 269         ctl_data_submit_done(io);
 270         return(0);
 271 }
 272
 273 static int
 274 ctl_backend_ramdisk_submit(union ctl_io *io)
 275 {
 276         struct ctl_be_lun *cbe_lun;
 277         struct ctl_lba_len_flags *lbalen;
 278
 279         cbe_lun = (struct ctl_be_lun *)io->io_hdr.ctl_private[
 280                 CTL_PRIV_BACKEND_LUN].ptr;
 281         lbalen = (struct ctl_lba_len_flags *)&io->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
 282         if (lbalen->flags & CTL_LLF_VERIFY) {
 283                 ctl_set_success(&io->scsiio);
 284                 ctl_data_submit_done(io);
 285                 return (CTL_RETVAL_COMPLETE);
 286         }
 287         io->io_hdr.ctl_private[CTL_PRIV_BACKEND].integer =
 288             lbalen->len * cbe_lun->blocksize;
 289         ctl_backend_ramdisk_continue(io);
 290         return (CTL_RETVAL_COMPLETE);
 291 }
 292
 293 static void
 294 ctl_backend_ramdisk_continue(union ctl_io *io)
 295 {
 296         struct ctl_be_ramdisk_softc *softc;
 297         int len, len_filled, sg_filled;
 298 #ifdef CTL_RAMDISK_PAGES
 299         struct ctl_sg_entry *sg_entries;
 300         int i;
 301 #endif
 302
 303         softc = &rd_softc;
 304         len = io->io_hdr.ctl_private[CTL_PRIV_BACKEND].integer;
 305 #ifdef CTL_RAMDISK_PAGES
 306         sg_filled = min(btoc(len), softc->num_pages);
 307         if (sg_filled > 1) {
 308                 io->scsiio.kern_data_ptr = malloc(sizeof(struct ctl_sg_entry) *
 309                                                   sg_filled, M_RAMDISK,
 310                                                   M_WAITOK);
 311                 sg_entries = (struct ctl_sg_entry *)io->scsiio.kern_data_ptr;
 312                 for (i = 0, len_filled = 0; i < sg_filled; i++) {
 313                         sg_entries[i].addr = softc->ramdisk_pages[i];
 314                         sg_entries[i].len = MIN(PAGE_SIZE, len - len_filled);
 315                         len_filled += sg_entries[i].len;
 316                 }
 317         } else {
 318                 sg_filled = 0;
 319                 len_filled = len;
 320                 io->scsiio.kern_data_ptr = softc->ramdisk_pages[0];
 321         }
 322 #else
 323         sg_filled = 0;
 324         len_filled = min(len, softc->rd_size);
 325         io->scsiio.kern_data_ptr = softc->ramdisk_buffer;
 326 #endif /* CTL_RAMDISK_PAGES */
 327
 328         io->scsiio.be_move_done = ctl_backend_ramdisk_move_done;
 329         io->scsiio.kern_data_resid = 0;
 330         io->scsiio.kern_data_len = len_filled;
 331         io->scsiio.kern_sg_entries = sg_filled;
 332         io->io_hdr.flags |= CTL_FLAG_ALLOCATED;
 333         io->io_hdr.ctl_private[CTL_PRIV_BACKEND].integer -= len_filled;
 334 #ifdef CTL_TIME_IO
 335         getbinuptime(&io->io_hdr.dma_start_bt);
 336 #endif
 337         ctl_datamove(io);
 338 }
 339
 340 static void
 341 ctl_backend_ramdisk_worker(void *context, int pending)
 342 {
 343         struct ctl_be_ramdisk_lun *be_lun;
 344         union ctl_io *io;
 345
 346         be_lun = (struct ctl_be_ramdisk_lun *)context;
 347
 348         mtx_lock(&be_lun->queue_lock);
 349         for (;;) {
 350                 io = (union ctl_io *)STAILQ_FIRST(&be_lun->cont_queue);
 351                 if (io != NULL) {
 352                         STAILQ_REMOVE(&be_lun->cont_queue, &io->io_hdr,
 353                                       ctl_io_hdr, links);
 354                         mtx_unlock(&be_lun->queue_lock);
 355                         ctl_backend_ramdisk_continue(io);
 356                         mtx_lock(&be_lun->queue_lock);
 357                         continue;
 358                 }
 359
 360                 /*
 361                  * If we get here, there is no work left in the queues, so
 362                  * just break out and let the task queue go to sleep.
 363                  */
 364                 break;
 365         }
 366         mtx_unlock(&be_lun->queue_lock);
 367 }
 368
 369 static int
 370 ctl_backend_ramdisk_ioctl(struct cdev *dev, u_long cmd, caddr_t addr,
 371                           int flag, struct thread *td)
 372 {
 373         struct ctl_be_ramdisk_softc *softc = &rd_softc;
 374         struct ctl_lun_req *lun_req;
 375         int retval;
 376
 377         retval = 0;
 378         switch (cmd) {
 379         case CTL_LUN_REQ:
 380                 lun_req = (struct ctl_lun_req *)addr;
 381                 switch (lun_req->reqtype) {
 382                 case CTL_LUNREQ_CREATE:
 383                         retval = ctl_backend_ramdisk_create(softc, lun_req);
 384                         break;
 385                 case CTL_LUNREQ_RM:
 386                         retval = ctl_backend_ramdisk_rm(softc, lun_req);
 387                         break;
 388                 case CTL_LUNREQ_MODIFY:
 389                         retval = ctl_backend_ramdisk_modify(softc, lun_req);
 390                         break;
 391                 default:
 392                         lun_req->status = CTL_LUN_ERROR;
 393                         snprintf(lun_req->error_str, sizeof(lun_req->error_str),
 394                                  "%s: invalid LUN request type %d", __func__,
 395                                  lun_req->reqtype);
 396                         break;
 397                 }
 398                 break;
 399         default:
 400                 retval = ENOTTY;
 401                 break;
 402         }
 403
 404         return (retval);
 405 }
 406
 407 static int
 408 ctl_backend_ramdisk_rm(struct ctl_be_ramdisk_softc *softc,
 409                        struct ctl_lun_req *req)
 410 {
 411         struct ctl_be_ramdisk_lun *be_lun;
 412         struct ctl_lun_rm_params *params;
 413         int retval;
 414
 415         params = &req->reqdata.rm;
 416         mtx_lock(&softc->lock);
 417         STAILQ_FOREACH(be_lun, &softc->lun_list, links) {
 418                 if (be_lun->cbe_lun.lun_id == params->lun_id)
 419                         break;
 420         }
 421         mtx_unlock(&softc->lock);
 422         if (be_lun == NULL) {
 423                 snprintf(req->error_str, sizeof(req->error_str),
 424                          "%s: LUN %u is not managed by the ramdisk backend",
 425                          __func__, params->lun_id);
 426                 goto bailout_error;
 427         }
 428
 429         retval = ctl_disable_lun(&be_lun->cbe_lun);
 430         if (retval != 0) {
 431                 snprintf(req->error_str, sizeof(req->error_str),
 432                          "%s: error %d returned from ctl_disable_lun() for "
 433                          "LUN %d", __func__, retval, params->lun_id);
 434                 goto bailout_error;
 435         }
 436
 437         /*
 438          * Set the waiting flag before we invalidate the LUN.  Our shutdown
 439          * routine can be called any time after we invalidate the LUN,
 440          * and can be called from our context.
 441          *
 442          * This tells the shutdown routine that we're waiting, or we're
 443          * going to wait for the shutdown to happen.
 444          */
 445         mtx_lock(&softc->lock);
 446         be_lun->flags |= CTL_BE_RAMDISK_LUN_WAITING;
 447         mtx_unlock(&softc->lock);
 448
 449         retval = ctl_invalidate_lun(&be_lun->cbe_lun);
 450         if (retval != 0) {
 451                 snprintf(req->error_str, sizeof(req->error_str),
 452                          "%s: error %d returned from ctl_invalidate_lun() for "
 453                          "LUN %d", __func__, retval, params->lun_id);
 454                 mtx_lock(&softc->lock);
 455                 be_lun->flags &= ~CTL_BE_RAMDISK_LUN_WAITING;
 456                 mtx_unlock(&softc->lock);
 457                 goto bailout_error;
 458         }
 459
 460         mtx_lock(&softc->lock);
 461         while ((be_lun->flags & CTL_BE_RAMDISK_LUN_UNCONFIGURED) == 0) {
 462                 retval = msleep(be_lun, &softc->lock, PCATCH, "ctlram", 0);
 463                 if (retval == EINTR)
 464                         break;
 465         }
 466         be_lun->flags &= ~CTL_BE_RAMDISK_LUN_WAITING;
 467
 468         /*
 469          * We only remove this LUN from the list and free it (below) if
 470          * retval == 0.  If the user interrupted the wait, we just bail out
 471          * without actually freeing the LUN.  We let the shutdown routine
 472          * free the LUN if that happens.
 473          */
 474         if (retval == 0) {
 475                 STAILQ_REMOVE(&softc->lun_list, be_lun, ctl_be_ramdisk_lun,
 476                               links);
 477                 softc->num_luns--;
 478         }
 479
 480         mtx_unlock(&softc->lock);
 481
 482         if (retval == 0) {
 483                 taskqueue_drain_all(be_lun->io_taskqueue);
 484                 taskqueue_free(be_lun->io_taskqueue);
 485                 ctl_free_opts(&be_lun->cbe_lun.options);
 486                 mtx_destroy(&be_lun->queue_lock);
 487                 free(be_lun, M_RAMDISK);
 488         }
 489
 490         req->status = CTL_LUN_OK;
 491         return (retval);
 492
 493 bailout_error:
 494         req->status = CTL_LUN_ERROR;
 495         return (0);
 496 }
 497
 498 static int
 499 ctl_backend_ramdisk_create(struct ctl_be_ramdisk_softc *softc,
 500                            struct ctl_lun_req *req)
 501 {
 502         struct ctl_be_ramdisk_lun *be_lun;
 503         struct ctl_be_lun *cbe_lun;
 504         struct ctl_lun_create_params *params;
 505         char *value;
 506         char tmpstr[32];
 507         int retval;
 508
 509         retval = 0;
 510         params = &req->reqdata.create;
 511
 512         be_lun = malloc(sizeof(*be_lun), M_RAMDISK, M_ZERO | M_WAITOK);
 513         cbe_lun = &be_lun->cbe_lun;
 514         cbe_lun->be_lun = be_lun;
 515         be_lun->params = req->reqdata.create;
 516         be_lun->softc = softc;
 517         sprintf(be_lun->lunname, "cram%d", softc->num_luns);
 518         ctl_init_opts(&cbe_lun->options, req->num_be_args, req->kern_be_args);
 519
 520         if (params->flags & CTL_LUN_FLAG_DEV_TYPE)
 521                 cbe_lun->lun_type = params->device_type;
 522         else
 523                 cbe_lun->lun_type = T_DIRECT;
 524         be_lun->flags = CTL_BE_RAMDISK_LUN_UNCONFIGURED;
 525         cbe_lun->flags = 0;
 526         value = ctl_get_opt(&cbe_lun->options, "ha_role");
 527         if (value != NULL) {
 528                 if (strcmp(value, "primary") == 0)
 529                         cbe_lun->flags |= CTL_LUN_FLAG_PRIMARY;
 530         } else if (control_softc->flags & CTL_FLAG_ACTIVE_SHELF)
 531                 cbe_lun->flags |= CTL_LUN_FLAG_PRIMARY;
 532
 533         if (cbe_lun->lun_type == T_DIRECT) {
 534                 if (params->blocksize_bytes != 0)
 535                         cbe_lun->blocksize = params->blocksize_bytes;
 536                 else
 537                         cbe_lun->blocksize = 512;
 538                 if (params->lun_size_bytes < cbe_lun->blocksize) {
 539                         snprintf(req->error_str, sizeof(req->error_str),
 540                                  "%s: LUN size %ju < blocksize %u", __func__,
 541                                  params->lun_size_bytes, cbe_lun->blocksize);
 542                         goto bailout_error;
 543                 }
 544                 be_lun->size_blocks = params->lun_size_bytes / cbe_lun->blocksize;
 545                 be_lun->size_bytes = be_lun->size_blocks * cbe_lun->blocksize;
 546                 cbe_lun->maxlba = be_lun->size_blocks - 1;
 547                 cbe_lun->atomicblock = UINT32_MAX;
 548                 cbe_lun->opttxferlen = softc->rd_size / cbe_lun->blocksize;
 549         }
 550
 551         /* Tell the user the blocksize we ended up using */
 552         params->blocksize_bytes = cbe_lun->blocksize;
 553         params->lun_size_bytes = be_lun->size_bytes;
 554
 555         value = ctl_get_opt(&cbe_lun->options, "unmap");
 556         if (value != NULL && strcmp(value, "on") == 0)
 557                 cbe_lun->flags |= CTL_LUN_FLAG_UNMAP;
 558         value = ctl_get_opt(&cbe_lun->options, "readonly");
 559         if (value != NULL && strcmp(value, "on") == 0)
 560                 cbe_lun->flags |= CTL_LUN_FLAG_READONLY;
 561         cbe_lun->serseq = CTL_LUN_SERSEQ_OFF;
 562         value = ctl_get_opt(&cbe_lun->options, "serseq");
 563         if (value != NULL && strcmp(value, "on") == 0)
 564                 cbe_lun->serseq = CTL_LUN_SERSEQ_ON;
 565         else if (value != NULL && strcmp(value, "read") == 0)
 566                 cbe_lun->serseq = CTL_LUN_SERSEQ_READ;
 567         else if (value != NULL && strcmp(value, "off") == 0)
 568                 cbe_lun->serseq = CTL_LUN_SERSEQ_OFF;
 569
 570         if (params->flags & CTL_LUN_FLAG_ID_REQ) {
 571                 cbe_lun->req_lun_id = params->req_lun_id;
 572                 cbe_lun->flags |= CTL_LUN_FLAG_ID_REQ;
 573         } else
 574                 cbe_lun->req_lun_id = 0;
 575
 576         cbe_lun->lun_shutdown = ctl_backend_ramdisk_lun_shutdown;
 577         cbe_lun->lun_config_status = ctl_backend_ramdisk_lun_config_status;
 578         cbe_lun->be = &ctl_be_ramdisk_driver;
 579         if ((params->flags & CTL_LUN_FLAG_SERIAL_NUM) == 0) {
 580                 snprintf(tmpstr, sizeof(tmpstr), "MYSERIAL%4d",
 581                          softc->num_luns);
 582                 strncpy((char *)cbe_lun->serial_num, tmpstr,
 583                         MIN(sizeof(cbe_lun->serial_num), sizeof(tmpstr)));
 584
 585                 /* Tell the user what we used for a serial number */
 586                 strncpy((char *)params->serial_num, tmpstr,
 587                         MIN(sizeof(params->serial_num), sizeof(tmpstr)));
 588         } else {
 589                 strncpy((char *)cbe_lun->serial_num, params->serial_num,
 590                         MIN(sizeof(cbe_lun->serial_num),
 591                             sizeof(params->serial_num)));
 592         }
 593         if ((params->flags & CTL_LUN_FLAG_DEVID) == 0) {
 594                 snprintf(tmpstr, sizeof(tmpstr), "MYDEVID%4d", softc->num_luns);
 595                 strncpy((char *)cbe_lun->device_id, tmpstr,
 596                         MIN(sizeof(cbe_lun->device_id), sizeof(tmpstr)));
 597
 598                 /* Tell the user what we used for a device ID */
 599                 strncpy((char *)params->device_id, tmpstr,
 600                         MIN(sizeof(params->device_id), sizeof(tmpstr)));
 601         } else {
 602                 strncpy((char *)cbe_lun->device_id, params->device_id,
 603                         MIN(sizeof(cbe_lun->device_id),
 604                             sizeof(params->device_id)));
 605         }
 606
 607         STAILQ_INIT(&be_lun->cont_queue);
 608         mtx_init(&be_lun->queue_lock, "cram queue lock", NULL, MTX_DEF);
 609         TASK_INIT(&be_lun->io_task, /*priority*/0, ctl_backend_ramdisk_worker,
 610             be_lun);
 611
 612         be_lun->io_taskqueue = taskqueue_create(be_lun->lunname, M_WAITOK,
 613             taskqueue_thread_enqueue, /*context*/&be_lun->io_taskqueue);
 614         if (be_lun->io_taskqueue == NULL) {
 615                 snprintf(req->error_str, sizeof(req->error_str),
 616                          "%s: Unable to create taskqueue", __func__);
 617                 goto bailout_error;
 618         }
 619
 620         retval = taskqueue_start_threads(&be_lun->io_taskqueue,
 621                                          /*num threads*/1,
 622                                          /*priority*/PWAIT,
 623                                          /*thread name*/
 624                                          "%s taskq", be_lun->lunname);
 625         if (retval != 0)
 626                 goto bailout_error;
 627
 628         mtx_lock(&softc->lock);
 629         softc->num_luns++;
 630         STAILQ_INSERT_TAIL(&softc->lun_list, be_lun, links);
 631         mtx_unlock(&softc->lock);
 632
 633         retval = ctl_add_lun(&be_lun->cbe_lun);
 634         if (retval != 0) {
 635                 mtx_lock(&softc->lock);
 636                 STAILQ_REMOVE(&softc->lun_list, be_lun, ctl_be_ramdisk_lun,
 637                               links);
 638                 softc->num_luns--;
 639                 mtx_unlock(&softc->lock);
 640                 snprintf(req->error_str, sizeof(req->error_str),
 641                          "%s: ctl_add_lun() returned error %d, see dmesg for "
 642                         "details", __func__, retval);
 643                 retval = 0;
 644                 goto bailout_error;
 645         }
 646
 647         mtx_lock(&softc->lock);
 648
 649         /*
 650          * Tell the config_status routine that we're waiting so it won't
 651          * clean up the LUN in the event of an error.
 652          */
 653         be_lun->flags |= CTL_BE_RAMDISK_LUN_WAITING;
 654
 655         while (be_lun->flags & CTL_BE_RAMDISK_LUN_UNCONFIGURED) {
 656                 retval = msleep(be_lun, &softc->lock, PCATCH, "ctlram", 0);
 657                 if (retval == EINTR)
 658                         break;
 659         }
 660         be_lun->flags &= ~CTL_BE_RAMDISK_LUN_WAITING;
 661
 662         if (be_lun->flags & CTL_BE_RAMDISK_LUN_CONFIG_ERR) {
 663                 snprintf(req->error_str, sizeof(req->error_str),
 664                          "%s: LUN configuration error, see dmesg for details",
 665                          __func__);
 666                 STAILQ_REMOVE(&softc->lun_list, be_lun, ctl_be_ramdisk_lun,
 667                               links);
 668                 softc->num_luns--;
 669                 mtx_unlock(&softc->lock);
 670                 goto bailout_error;
 671         } else {
 672                 params->req_lun_id = cbe_lun->lun_id;
 673         }
 674         mtx_unlock(&softc->lock);
 675
 676         req->status = CTL_LUN_OK;
 677         return (retval);
 678
 679 bailout_error:
 680         req->status = CTL_LUN_ERROR;
 681         if (be_lun != NULL) {
 682                 if (be_lun->io_taskqueue != NULL) {
 683                         taskqueue_free(be_lun->io_taskqueue);
 684                 }
 685                 ctl_free_opts(&cbe_lun->options);
 686                 mtx_destroy(&be_lun->queue_lock);
 687                 free(be_lun, M_RAMDISK);
 688         }
 689         return (retval);
 690 }
 691
 692 static int
 693 ctl_backend_ramdisk_modify(struct ctl_be_ramdisk_softc *softc,
 694                        struct ctl_lun_req *req)
 695 {
 696         struct ctl_be_ramdisk_lun *be_lun;
 697         struct ctl_be_lun *cbe_lun;
 698         struct ctl_lun_modify_params *params;
 699         char *value;
 700         uint32_t blocksize;
 701         int wasprim;
 702
 703         params = &req->reqdata.modify;
 704
 705         mtx_lock(&softc->lock);
 706         STAILQ_FOREACH(be_lun, &softc->lun_list, links) {
 707                 if (be_lun->cbe_lun.lun_id == params->lun_id)
 708                         break;
 709         }
 710         mtx_unlock(&softc->lock);
 711         if (be_lun == NULL) {
 712                 snprintf(req->error_str, sizeof(req->error_str),
 713                          "%s: LUN %u is not managed by the ramdisk backend",
 714                          __func__, params->lun_id);
 715                 goto bailout_error;
 716         }
 717         cbe_lun = &be_lun->cbe_lun;
 718
 719         if (params->lun_size_bytes != 0)
 720                 be_lun->params.lun_size_bytes = params->lun_size_bytes;
 721         ctl_update_opts(&cbe_lun->options, req->num_be_args, req->kern_be_args);
 722
 723         wasprim = (cbe_lun->flags & CTL_LUN_FLAG_PRIMARY);
 724         value = ctl_get_opt(&cbe_lun->options, "ha_role");
 725         if (value != NULL) {
 726                 if (strcmp(value, "primary") == 0)
 727                         cbe_lun->flags |= CTL_LUN_FLAG_PRIMARY;
 728                 else
 729                         cbe_lun->flags &= ~CTL_LUN_FLAG_PRIMARY;
 730         } else if (control_softc->flags & CTL_FLAG_ACTIVE_SHELF)
 731                 cbe_lun->flags |= CTL_LUN_FLAG_PRIMARY;
 732         else
 733                 cbe_lun->flags &= ~CTL_LUN_FLAG_PRIMARY;
 734         if (wasprim != (cbe_lun->flags & CTL_LUN_FLAG_PRIMARY)) {
 735                 if (cbe_lun->flags & CTL_LUN_FLAG_PRIMARY)
 736                         ctl_lun_primary(cbe_lun);
 737                 else
 738                         ctl_lun_secondary(cbe_lun);
 739         }
 740
 741         blocksize = be_lun->cbe_lun.blocksize;
 742         if (be_lun->params.lun_size_bytes < blocksize) {
 743                 snprintf(req->error_str, sizeof(req->error_str),
 744                         "%s: LUN size %ju < blocksize %u", __func__,
 745                         be_lun->params.lun_size_bytes, blocksize);
 746                 goto bailout_error;
 747         }
 748         be_lun->size_blocks = be_lun->params.lun_size_bytes / blocksize;
 749         be_lun->size_bytes = be_lun->size_blocks * blocksize;
 750         be_lun->cbe_lun.maxlba = be_lun->size_blocks - 1;
 751         ctl_lun_capacity_changed(&be_lun->cbe_lun);
 752
 753         /* Tell the user the exact size we ended up using */
 754         params->lun_size_bytes = be_lun->size_bytes;
 755
 756         req->status = CTL_LUN_OK;
 757         return (0);
 758
 759 bailout_error:
 760         req->status = CTL_LUN_ERROR;
 761         return (0);
 762 }
 763
 764 static void
 765 ctl_backend_ramdisk_lun_shutdown(void *be_lun)
 766 {
 767         struct ctl_be_ramdisk_lun *lun;
 768         struct ctl_be_ramdisk_softc *softc;
 769         int do_free;
 770
 771         lun = (struct ctl_be_ramdisk_lun *)be_lun;
 772         softc = lun->softc;
 773         do_free = 0;
 774
 775         mtx_lock(&softc->lock);
 776         lun->flags |= CTL_BE_RAMDISK_LUN_UNCONFIGURED;
 777         if (lun->flags & CTL_BE_RAMDISK_LUN_WAITING) {
 778                 wakeup(lun);
 779         } else {
 780                 STAILQ_REMOVE(&softc->lun_list, lun, ctl_be_ramdisk_lun,
 781                               links);
 782                 softc->num_luns--;
 783                 do_free = 1;
 784         }
 785         mtx_unlock(&softc->lock);
 786
 787         if (do_free != 0)
 788                 free(be_lun, M_RAMDISK);
 789 }
 790
 791 static void
 792 ctl_backend_ramdisk_lun_config_status(void *be_lun,
 793                                       ctl_lun_config_status status)
 794 {
 795         struct ctl_be_ramdisk_lun *lun;
 796         struct ctl_be_ramdisk_softc *softc;
 797
 798         lun = (struct ctl_be_ramdisk_lun *)be_lun;
 799         softc = lun->softc;
 800
 801         if (status == CTL_LUN_CONFIG_OK) {
 802                 mtx_lock(&softc->lock);
 803                 lun->flags &= ~CTL_BE_RAMDISK_LUN_UNCONFIGURED;
 804                 if (lun->flags & CTL_BE_RAMDISK_LUN_WAITING)
 805                         wakeup(lun);
 806                 mtx_unlock(&softc->lock);
 807
 808                 /*
 809                  * We successfully added the LUN, attempt to enable it.
 810                  */
 811                 if (ctl_enable_lun(&lun->cbe_lun) != 0) {
 812                         printf("%s: ctl_enable_lun() failed!\n", __func__);
 813                         if (ctl_invalidate_lun(&lun->cbe_lun) != 0) {
 814                                 printf("%s: ctl_invalidate_lun() failed!\n",
 815                                        __func__);
 816                         }
 817                 }
 818
 819                 return;
 820         }
 821
 822
 823         mtx_lock(&softc->lock);
 824         lun->flags &= ~CTL_BE_RAMDISK_LUN_UNCONFIGURED;
 825
 826         /*
 827          * If we have a user waiting, let him handle the cleanup.  If not,
 828          * clean things up here.
 829          */
 830         if (lun->flags & CTL_BE_RAMDISK_LUN_WAITING) {
 831                 lun->flags |= CTL_BE_RAMDISK_LUN_CONFIG_ERR;
 832                 wakeup(lun);
 833         } else {
 834                 STAILQ_REMOVE(&softc->lun_list, lun, ctl_be_ramdisk_lun,
 835                               links);
 836                 softc->num_luns--;
 837                 free(lun, M_RAMDISK);
 838         }
 839         mtx_unlock(&softc->lock);
 840 }
 841
 842 static int
 843 ctl_backend_ramdisk_config_write(union ctl_io *io)
 844 {
 845         int retval;
 846
 847         retval = 0;
 848         switch (io->scsiio.cdb[0]) {
 849         case SYNCHRONIZE_CACHE:
 850         case SYNCHRONIZE_CACHE_16:
 851                 /*
 852                  * The upper level CTL code will filter out any CDBs with
 853                  * the immediate bit set and return the proper error.  It
 854                  * will also not allow a sync cache command to go to a LUN
 855                  * that is powered down.
 856                  *
 857                  * We don't really need to worry about what LBA range the
 858                  * user asked to be synced out.  When they issue a sync
 859                  * cache command, we'll sync out the whole thing.
 860                  *
 861                  * This is obviously just a stubbed out implementation.
 862                  * The real implementation will be in the RAIDCore/CTL
 863                  * interface, and can only really happen when RAIDCore
 864                  * implements a per-array cache sync.
 865                  */
 866                 ctl_set_success(&io->scsiio);
 867                 ctl_config_write_done(io);
 868                 break;
 869         case START_STOP_UNIT: {
 870                 struct scsi_start_stop_unit *cdb;
 871                 struct ctl_be_lun *cbe_lun;
 872
 873                 cdb = (struct scsi_start_stop_unit *)io->scsiio.cdb;
 874
 875                 cbe_lun = (struct ctl_be_lun *)io->io_hdr.ctl_private[
 876                         CTL_PRIV_BACKEND_LUN].ptr;
 877
 878                 if (cdb->how & SSS_START)
 879                         retval = ctl_start_lun(cbe_lun);
 880                 else
 881                         retval = ctl_stop_lun(cbe_lun);
 882
 883                 /*
 884                  * In general, the above routines should not fail.  They
 885                  * just set state for the LUN.  So we've got something
 886                  * pretty wrong here if we can't start or stop the LUN.
 887                  */
 888                 if (retval != 0) {
 889                         ctl_set_internal_failure(&io->scsiio,
 890                                                  /*sks_valid*/ 1,
 891                                                  /*retry_count*/ 0xf051);
 892                         retval = CTL_RETVAL_COMPLETE;
 893                 } else {
 894                         ctl_set_success(&io->scsiio);
 895                 }
 896                 ctl_config_write_done(io);
 897                 break;
 898         }
 899         case WRITE_SAME_10:
 900         case WRITE_SAME_16:
 901         case UNMAP:
 902                 ctl_set_success(&io->scsiio);
 903                 ctl_config_write_done(io);
 904                 break;
 905         default:
 906                 ctl_set_invalid_opcode(&io->scsiio);
 907                 ctl_config_write_done(io);
 908                 retval = CTL_RETVAL_COMPLETE;
 909                 break;
 910         }
 911
 912         return (retval);
 913 }
 914
 915 static int
 916 ctl_backend_ramdisk_config_read(union ctl_io *io)
 917 {
 918         int retval = 0;
 919
 920         switch (io->scsiio.cdb[0]) {
 921         case SERVICE_ACTION_IN:
 922                 if (io->scsiio.cdb[1] == SGLS_SERVICE_ACTION) {
 923                         /* We have nothing to tell, leave default data. */
 924                         ctl_config_read_done(io);
 925                         retval = CTL_RETVAL_COMPLETE;
 926                         break;
 927                 }
 928                 ctl_set_invalid_field(&io->scsiio,
 929                                       /*sks_valid*/ 1,
 930                                       /*command*/ 1,
 931                                       /*field*/ 1,
 932                                       /*bit_valid*/ 1,
 933                                       /*bit*/ 4);
 934                 ctl_config_read_done(io);
 935                 retval = CTL_RETVAL_COMPLETE;
 936                 break;
 937         default:
 938                 ctl_set_invalid_opcode(&io->scsiio);
 939                 ctl_config_read_done(io);
 940                 retval = CTL_RETVAL_COMPLETE;
 941                 break;
 942         }
 943
 944         return (retval);
 945 }