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;
 149 #ifdef CTL_RAMDISK_PAGES
 150         int i;
 151 #endif
 152
 153
 154         softc = &rd_softc;
 155
 156         memset(softc, 0, sizeof(*softc));
 157
 158         mtx_init(&softc->lock, "ctlramdisk", NULL, MTX_DEF);
 159
 160         STAILQ_INIT(&softc->lun_list);
 161         softc->rd_size = 1024 * 1024;
 162 #ifdef CTL_RAMDISK_PAGES
 163         softc->num_pages = softc->rd_size / PAGE_SIZE;
 164         softc->ramdisk_pages = (uint8_t **)malloc(sizeof(uint8_t *) *
 165                                                   softc->num_pages, M_RAMDISK,
 166                                                   M_WAITOK);
 167         for (i = 0; i < softc->num_pages; i++)
 168                 softc->ramdisk_pages[i] = malloc(PAGE_SIZE, M_RAMDISK,M_WAITOK);
 169 #else
 170         softc->ramdisk_buffer = (uint8_t *)malloc(softc->rd_size, M_RAMDISK,
 171                                                   M_WAITOK);
 172 #endif
 173
 174         return (0);
 175 }
 176
 177 void
 178 ctl_backend_ramdisk_shutdown(void)
 179 {
 180         struct ctl_be_ramdisk_softc *softc;
 181         struct ctl_be_ramdisk_lun *lun, *next_lun;
 182 #ifdef CTL_RAMDISK_PAGES
 183         int i;
 184 #endif
 185
 186         softc = &rd_softc;
 187
 188         mtx_lock(&softc->lock);
 189         for (lun = STAILQ_FIRST(&softc->lun_list); lun != NULL; lun = next_lun){
 190                 /*
 191                  * Grab the next LUN.  The current LUN may get removed by
 192                  * ctl_invalidate_lun(), which will call our LUN shutdown
 193                  * routine, if there is no outstanding I/O for this LUN.
 194                  */
 195                 next_lun = STAILQ_NEXT(lun, links);
 196
 197                 /*
 198                  * Drop our lock here.  Since ctl_invalidate_lun() can call
 199                  * back into us, this could potentially lead to a recursive
 200                  * lock of the same mutex, which would cause a hang.
 201                  */
 202                 mtx_unlock(&softc->lock);
 203                 ctl_disable_lun(&lun->cbe_lun);
 204                 ctl_invalidate_lun(&lun->cbe_lun);
 205                 mtx_lock(&softc->lock);
 206         }
 207         mtx_unlock(&softc->lock);
 208
 209 #ifdef CTL_RAMDISK_PAGES
 210         for (i = 0; i < softc->num_pages; i++)
 211                 free(softc->ramdisk_pages[i], M_RAMDISK);
 212
 213         free(softc->ramdisk_pages, M_RAMDISK);
 214 #else
 215         free(softc->ramdisk_buffer, M_RAMDISK);
 216 #endif
 217
 218         if (ctl_backend_deregister(&ctl_be_ramdisk_driver) != 0) {
 219                 printf("ctl_backend_ramdisk_shutdown: "
 220                        "ctl_backend_deregister() failed!\n");
 221         }
 222 }
 223
 224 static int
 225 ctl_backend_ramdisk_move_done(union ctl_io *io)
 226 {
 227         struct ctl_be_lun *cbe_lun;
 228         struct ctl_be_ramdisk_lun *be_lun;
 229 #ifdef CTL_TIME_IO
 230         struct bintime cur_bt;
 231 #endif
 232
 233         CTL_DEBUG_PRINT(("ctl_backend_ramdisk_move_done\n"));
 234         cbe_lun = (struct ctl_be_lun *)io->io_hdr.ctl_private[
 235                 CTL_PRIV_BACKEND_LUN].ptr;
 236         be_lun = (struct ctl_be_ramdisk_lun *)cbe_lun->be_lun;
 237 #ifdef CTL_TIME_IO
 238         getbintime(&cur_bt);
 239         bintime_sub(&cur_bt, &io->io_hdr.dma_start_bt);
 240         bintime_add(&io->io_hdr.dma_bt, &cur_bt);
 241         io->io_hdr.num_dmas++;
 242 #endif
 243         if (io->scsiio.kern_sg_entries > 0)
 244                 free(io->scsiio.kern_data_ptr, M_RAMDISK);
 245         io->scsiio.kern_rel_offset += io->scsiio.kern_data_len;
 246         if (io->io_hdr.flags & CTL_FLAG_ABORT) {
 247                 ;
 248         } else if ((io->io_hdr.port_status == 0) &&
 249             ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE)) {
 250                 if (io->io_hdr.ctl_private[CTL_PRIV_BACKEND].integer > 0) {
 251                         mtx_lock(&be_lun->queue_lock);
 252                         STAILQ_INSERT_TAIL(&be_lun->cont_queue,
 253                             &io->io_hdr, links);
 254                         mtx_unlock(&be_lun->queue_lock);
 255                         taskqueue_enqueue(be_lun->io_taskqueue,
 256                             &be_lun->io_task);
 257                         return (0);
 258                 }
 259                 ctl_set_success(&io->scsiio);
 260         } else if ((io->io_hdr.port_status != 0) &&
 261             ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE ||
 262              (io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)) {
 263                 /*
 264                  * For hardware error sense keys, the sense key
 265                  * specific value is defined to be a retry count,
 266                  * but we use it to pass back an internal FETD
 267                  * error code.  XXX KDM  Hopefully the FETD is only
 268                  * using 16 bits for an error code, since that's
 269                  * all the space we have in the sks field.
 270                  */
 271                 ctl_set_internal_failure(&io->scsiio,
 272                                          /*sks_valid*/ 1,
 273                                          /*retry_count*/
 274                                          io->io_hdr.port_status);
 275         }
 276         ctl_data_submit_done(io);
 277         return(0);
 278 }
 279
 280 static int
 281 ctl_backend_ramdisk_submit(union ctl_io *io)
 282 {
 283         struct ctl_be_lun *cbe_lun;
 284         struct ctl_lba_len_flags *lbalen;
 285
 286         cbe_lun = (struct ctl_be_lun *)io->io_hdr.ctl_private[
 287                 CTL_PRIV_BACKEND_LUN].ptr;
 288         lbalen = (struct ctl_lba_len_flags *)&io->io_hdr.ctl_private[CTL_PRIV_LBA_LEN];
 289         if (lbalen->flags & CTL_LLF_VERIFY) {
 290                 ctl_set_success(&io->scsiio);
 291                 ctl_data_submit_done(io);
 292                 return (CTL_RETVAL_COMPLETE);
 293         }
 294         io->io_hdr.ctl_private[CTL_PRIV_BACKEND].integer =
 295             lbalen->len * cbe_lun->blocksize;
 296         ctl_backend_ramdisk_continue(io);
 297         return (CTL_RETVAL_COMPLETE);
 298 }
 299
 300 static void
 301 ctl_backend_ramdisk_continue(union ctl_io *io)
 302 {
 303         struct ctl_be_ramdisk_softc *softc;
 304         int len, len_filled, sg_filled;
 305 #ifdef CTL_RAMDISK_PAGES
 306         struct ctl_sg_entry *sg_entries;
 307         int i;
 308 #endif
 309
 310         softc = &rd_softc;
 311         len = io->io_hdr.ctl_private[CTL_PRIV_BACKEND].integer;
 312 #ifdef CTL_RAMDISK_PAGES
 313         sg_filled = min(btoc(len), softc->num_pages);
 314         if (sg_filled > 1) {
 315                 io->scsiio.kern_data_ptr = malloc(sizeof(struct ctl_sg_entry) *
 316                                                   sg_filled, M_RAMDISK,
 317                                                   M_WAITOK);
 318                 sg_entries = (struct ctl_sg_entry *)io->scsiio.kern_data_ptr;
 319                 for (i = 0, len_filled = 0; i < sg_filled; i++) {
 320                         sg_entries[i].addr = softc->ramdisk_pages[i];
 321                         sg_entries[i].len = MIN(PAGE_SIZE, len - len_filled);
 322                         len_filled += sg_entries[i].len;
 323                 }
 324                 io->io_hdr.flags |= CTL_FLAG_KDPTR_SGLIST;
 325         } else {
 326                 sg_filled = 0;
 327                 len_filled = len;
 328                 io->scsiio.kern_data_ptr = softc->ramdisk_pages[0];
 329         }
 330 #else
 331         sg_filled = 0;
 332         len_filled = min(len, softc->rd_size);
 333         io->scsiio.kern_data_ptr = softc->ramdisk_buffer;
 334 #endif /* CTL_RAMDISK_PAGES */
 335
 336         io->scsiio.be_move_done = ctl_backend_ramdisk_move_done;
 337         io->scsiio.kern_data_resid = 0;
 338         io->scsiio.kern_data_len = len_filled;
 339         io->scsiio.kern_sg_entries = sg_filled;
 340         io->io_hdr.flags |= CTL_FLAG_ALLOCATED;
 341         io->io_hdr.ctl_private[CTL_PRIV_BACKEND].integer -= len_filled;
 342 #ifdef CTL_TIME_IO
 343         getbintime(&io->io_hdr.dma_start_bt);
 344 #endif
 345         ctl_datamove(io);
 346 }
 347
 348 static void
 349 ctl_backend_ramdisk_worker(void *context, int pending)
 350 {
 351         struct ctl_be_ramdisk_softc *softc;
 352         struct ctl_be_ramdisk_lun *be_lun;
 353         union ctl_io *io;
 354
 355         be_lun = (struct ctl_be_ramdisk_lun *)context;
 356         softc = be_lun->softc;
 357
 358         mtx_lock(&be_lun->queue_lock);
 359         for (;;) {
 360                 io = (union ctl_io *)STAILQ_FIRST(&be_lun->cont_queue);
 361                 if (io != NULL) {
 362                         STAILQ_REMOVE(&be_lun->cont_queue, &io->io_hdr,
 363                                       ctl_io_hdr, links);
 364
 365                         mtx_unlock(&be_lun->queue_lock);
 366
 367                         ctl_backend_ramdisk_continue(io);
 368
 369                         mtx_lock(&be_lun->queue_lock);
 370                         continue;
 371                 }
 372
 373                 /*
 374                  * If we get here, there is no work left in the queues, so
 375                  * just break out and let the task queue go to sleep.
 376                  */
 377                 break;
 378         }
 379         mtx_unlock(&be_lun->queue_lock);
 380 }
 381
 382 static int
 383 ctl_backend_ramdisk_ioctl(struct cdev *dev, u_long cmd, caddr_t addr,
 384                           int flag, struct thread *td)
 385 {
 386         struct ctl_be_ramdisk_softc *softc;
 387         int retval;
 388
 389         retval = 0;
 390         softc = &rd_softc;
 391
 392         switch (cmd) {
 393         case CTL_LUN_REQ: {
 394                 struct ctl_lun_req *lun_req;
 395
 396                 lun_req = (struct ctl_lun_req *)addr;
 397
 398                 switch (lun_req->reqtype) {
 399                 case CTL_LUNREQ_CREATE:
 400                         retval = ctl_backend_ramdisk_create(softc, lun_req);
 401                         break;
 402                 case CTL_LUNREQ_RM:
 403                         retval = ctl_backend_ramdisk_rm(softc, lun_req);
 404                         break;
 405                 case CTL_LUNREQ_MODIFY:
 406                         retval = ctl_backend_ramdisk_modify(softc, lun_req);
 407                         break;
 408                 default:
 409                         lun_req->status = CTL_LUN_ERROR;
 410                         snprintf(lun_req->error_str, sizeof(lun_req->error_str),
 411                                  "%s: invalid LUN request type %d", __func__,
 412                                  lun_req->reqtype);
 413                         break;
 414                 }
 415                 break;
 416         }
 417         default:
 418                 retval = ENOTTY;
 419                 break;
 420         }
 421
 422         return (retval);
 423 }
 424
 425 static int
 426 ctl_backend_ramdisk_rm(struct ctl_be_ramdisk_softc *softc,
 427                        struct ctl_lun_req *req)
 428 {
 429         struct ctl_be_ramdisk_lun *be_lun;
 430         struct ctl_lun_rm_params *params;
 431         int retval;
 432
 433
 434         retval = 0;
 435         params = &req->reqdata.rm;
 436
 437         be_lun = NULL;
 438
 439         mtx_lock(&softc->lock);
 440
 441         STAILQ_FOREACH(be_lun, &softc->lun_list, links) {
 442                 if (be_lun->cbe_lun.lun_id == params->lun_id)
 443                         break;
 444         }
 445         mtx_unlock(&softc->lock);
 446
 447         if (be_lun == NULL) {
 448                 snprintf(req->error_str, sizeof(req->error_str),
 449                          "%s: LUN %u is not managed by the ramdisk backend",
 450                          __func__, params->lun_id);
 451                 goto bailout_error;
 452         }
 453
 454         retval = ctl_disable_lun(&be_lun->cbe_lun);
 455
 456         if (retval != 0) {
 457                 snprintf(req->error_str, sizeof(req->error_str),
 458                          "%s: error %d returned from ctl_disable_lun() for "
 459                          "LUN %d", __func__, retval, params->lun_id);
 460                 goto bailout_error;
 461         }
 462
 463         /*
 464          * Set the waiting flag before we invalidate the LUN.  Our shutdown
 465          * routine can be called any time after we invalidate the LUN,
 466          * and can be called from our context.
 467          *
 468          * This tells the shutdown routine that we're waiting, or we're
 469          * going to wait for the shutdown to happen.
 470          */
 471         mtx_lock(&softc->lock);
 472         be_lun->flags |= CTL_BE_RAMDISK_LUN_WAITING;
 473         mtx_unlock(&softc->lock);
 474
 475         retval = ctl_invalidate_lun(&be_lun->cbe_lun);
 476         if (retval != 0) {
 477                 snprintf(req->error_str, sizeof(req->error_str),
 478                          "%s: error %d returned from ctl_invalidate_lun() for "
 479                          "LUN %d", __func__, retval, params->lun_id);
 480                 mtx_lock(&softc->lock);
 481                 be_lun->flags &= ~CTL_BE_RAMDISK_LUN_WAITING;
 482                 mtx_unlock(&softc->lock);
 483                 goto bailout_error;
 484         }
 485
 486         mtx_lock(&softc->lock);
 487
 488         while ((be_lun->flags & CTL_BE_RAMDISK_LUN_UNCONFIGURED) == 0) {
 489                 retval = msleep(be_lun, &softc->lock, PCATCH, "ctlram", 0);
 490                 if (retval == EINTR)
 491                         break;
 492         }
 493         be_lun->flags &= ~CTL_BE_RAMDISK_LUN_WAITING;
 494
 495         /*
 496          * We only remove this LUN from the list and free it (below) if
 497          * retval == 0.  If the user interrupted the wait, we just bail out
 498          * without actually freeing the LUN.  We let the shutdown routine
 499          * free the LUN if that happens.
 500          */
 501         if (retval == 0) {
 502                 STAILQ_REMOVE(&softc->lun_list, be_lun, ctl_be_ramdisk_lun,
 503                               links);
 504                 softc->num_luns--;
 505         }
 506
 507         mtx_unlock(&softc->lock);
 508
 509         if (retval == 0) {
 510                 taskqueue_drain(be_lun->io_taskqueue, &be_lun->io_task);
 511                 taskqueue_free(be_lun->io_taskqueue);
 512                 ctl_free_opts(&be_lun->cbe_lun.options);
 513                 mtx_destroy(&be_lun->queue_lock);
 514                 free(be_lun, M_RAMDISK);
 515         }
 516
 517         req->status = CTL_LUN_OK;
 518
 519         return (retval);
 520
 521 bailout_error:
 522         req->status = CTL_LUN_ERROR;
 523
 524         return (0);
 525 }
 526
 527 static int
 528 ctl_backend_ramdisk_create(struct ctl_be_ramdisk_softc *softc,
 529                            struct ctl_lun_req *req)
 530 {
 531         struct ctl_be_ramdisk_lun *be_lun;
 532         struct ctl_be_lun *cbe_lun;
 533         struct ctl_lun_create_params *params;
 534         char *value;
 535         char tmpstr[32];
 536         int retval;
 537
 538         retval = 0;
 539         params = &req->reqdata.create;
 540
 541         be_lun = malloc(sizeof(*be_lun), M_RAMDISK, M_ZERO | M_WAITOK);
 542         cbe_lun = &be_lun->cbe_lun;
 543         cbe_lun->be_lun = be_lun;
 544         be_lun->params = req->reqdata.create;
 545         be_lun->softc = softc;
 546         sprintf(be_lun->lunname, "cram%d", softc->num_luns);
 547         ctl_init_opts(&cbe_lun->options, req->num_be_args, req->kern_be_args);
 548
 549         if (params->flags & CTL_LUN_FLAG_DEV_TYPE)
 550                 cbe_lun->lun_type = params->device_type;
 551         else
 552                 cbe_lun->lun_type = T_DIRECT;
 553         be_lun->flags = CTL_BE_RAMDISK_LUN_UNCONFIGURED;
 554         cbe_lun->flags = 0;
 555         value = ctl_get_opt(&cbe_lun->options, "ha_role");
 556         if (value != NULL) {
 557                 if (strcmp(value, "primary") == 0)
 558                         cbe_lun->flags |= CTL_LUN_FLAG_PRIMARY;
 559         } else if (control_softc->flags & CTL_FLAG_ACTIVE_SHELF)
 560                 cbe_lun->flags |= CTL_LUN_FLAG_PRIMARY;
 561
 562         if (cbe_lun->lun_type == T_DIRECT) {
 563                 if (params->blocksize_bytes != 0)
 564                         cbe_lun->blocksize = params->blocksize_bytes;
 565                 else
 566                         cbe_lun->blocksize = 512;
 567                 if (params->lun_size_bytes < cbe_lun->blocksize) {
 568                         snprintf(req->error_str, sizeof(req->error_str),
 569                                  "%s: LUN size %ju < blocksize %u", __func__,
 570                                  params->lun_size_bytes, cbe_lun->blocksize);
 571                         goto bailout_error;
 572                 }
 573                 be_lun->size_blocks = params->lun_size_bytes / cbe_lun->blocksize;
 574                 be_lun->size_bytes = be_lun->size_blocks * cbe_lun->blocksize;
 575                 cbe_lun->maxlba = be_lun->size_blocks - 1;
 576                 cbe_lun->atomicblock = UINT32_MAX;
 577                 cbe_lun->opttxferlen = softc->rd_size / cbe_lun->blocksize;
 578         }
 579
 580         /* Tell the user the blocksize we ended up using */
 581         params->blocksize_bytes = cbe_lun->blocksize;
 582         params->lun_size_bytes = be_lun->size_bytes;
 583
 584         value = ctl_get_opt(&cbe_lun->options, "unmap");
 585         if (value != NULL && strcmp(value, "on") == 0)
 586                 cbe_lun->flags |= CTL_LUN_FLAG_UNMAP;
 587         value = ctl_get_opt(&cbe_lun->options, "readonly");
 588         if (value != NULL && strcmp(value, "on") == 0)
 589                 cbe_lun->flags |= CTL_LUN_FLAG_READONLY;
 590         cbe_lun->serseq = CTL_LUN_SERSEQ_OFF;
 591         value = ctl_get_opt(&cbe_lun->options, "serseq");
 592         if (value != NULL && strcmp(value, "on") == 0)
 593                 cbe_lun->serseq = CTL_LUN_SERSEQ_ON;
 594         else if (value != NULL && strcmp(value, "read") == 0)
 595                 cbe_lun->serseq = CTL_LUN_SERSEQ_READ;
 596         else if (value != NULL && strcmp(value, "off") == 0)
 597                 cbe_lun->serseq = CTL_LUN_SERSEQ_OFF;
 598
 599         if (params->flags & CTL_LUN_FLAG_ID_REQ) {
 600                 cbe_lun->req_lun_id = params->req_lun_id;
 601                 cbe_lun->flags |= CTL_LUN_FLAG_ID_REQ;
 602         } else
 603                 cbe_lun->req_lun_id = 0;
 604
 605         cbe_lun->lun_shutdown = ctl_backend_ramdisk_lun_shutdown;
 606         cbe_lun->lun_config_status = ctl_backend_ramdisk_lun_config_status;
 607         cbe_lun->be = &ctl_be_ramdisk_driver;
 608         if ((params->flags & CTL_LUN_FLAG_SERIAL_NUM) == 0) {
 609                 snprintf(tmpstr, sizeof(tmpstr), "MYSERIAL%4d",
 610                          softc->num_luns);
 611                 strncpy((char *)cbe_lun->serial_num, tmpstr,
 612                         MIN(sizeof(cbe_lun->serial_num), sizeof(tmpstr)));
 613
 614                 /* Tell the user what we used for a serial number */
 615                 strncpy((char *)params->serial_num, tmpstr,
 616                         MIN(sizeof(params->serial_num), sizeof(tmpstr)));
 617         } else {
 618                 strncpy((char *)cbe_lun->serial_num, params->serial_num,
 619                         MIN(sizeof(cbe_lun->serial_num),
 620                             sizeof(params->serial_num)));
 621         }
 622         if ((params->flags & CTL_LUN_FLAG_DEVID) == 0) {
 623                 snprintf(tmpstr, sizeof(tmpstr), "MYDEVID%4d", softc->num_luns);
 624                 strncpy((char *)cbe_lun->device_id, tmpstr,
 625                         MIN(sizeof(cbe_lun->device_id), sizeof(tmpstr)));
 626
 627                 /* Tell the user what we used for a device ID */
 628                 strncpy((char *)params->device_id, tmpstr,
 629                         MIN(sizeof(params->device_id), sizeof(tmpstr)));
 630         } else {
 631                 strncpy((char *)cbe_lun->device_id, params->device_id,
 632                         MIN(sizeof(cbe_lun->device_id),
 633                             sizeof(params->device_id)));
 634         }
 635
 636         STAILQ_INIT(&be_lun->cont_queue);
 637         mtx_init(&be_lun->queue_lock, "cram queue lock", NULL, MTX_DEF);
 638         TASK_INIT(&be_lun->io_task, /*priority*/0, ctl_backend_ramdisk_worker,
 639             be_lun);
 640
 641         be_lun->io_taskqueue = taskqueue_create(be_lun->lunname, M_WAITOK,
 642             taskqueue_thread_enqueue, /*context*/&be_lun->io_taskqueue);
 643         if (be_lun->io_taskqueue == NULL) {
 644                 snprintf(req->error_str, sizeof(req->error_str),
 645                          "%s: Unable to create taskqueue", __func__);
 646                 goto bailout_error;
 647         }
 648
 649         retval = taskqueue_start_threads(&be_lun->io_taskqueue,
 650                                          /*num threads*/1,
 651                                          /*priority*/PWAIT,
 652                                          /*thread name*/
 653                                          "%s taskq", be_lun->lunname);
 654         if (retval != 0)
 655                 goto bailout_error;
 656
 657         mtx_lock(&softc->lock);
 658         softc->num_luns++;
 659         STAILQ_INSERT_TAIL(&softc->lun_list, be_lun, links);
 660
 661         mtx_unlock(&softc->lock);
 662
 663         retval = ctl_add_lun(&be_lun->cbe_lun);
 664         if (retval != 0) {
 665                 mtx_lock(&softc->lock);
 666                 STAILQ_REMOVE(&softc->lun_list, be_lun, ctl_be_ramdisk_lun,
 667                               links);
 668                 softc->num_luns--;
 669                 mtx_unlock(&softc->lock);
 670                 snprintf(req->error_str, sizeof(req->error_str),
 671                          "%s: ctl_add_lun() returned error %d, see dmesg for "
 672                         "details", __func__, retval);
 673                 retval = 0;
 674                 goto bailout_error;
 675         }
 676
 677         mtx_lock(&softc->lock);
 678
 679         /*
 680          * Tell the config_status routine that we're waiting so it won't
 681          * clean up the LUN in the event of an error.
 682          */
 683         be_lun->flags |= CTL_BE_RAMDISK_LUN_WAITING;
 684
 685         while (be_lun->flags & CTL_BE_RAMDISK_LUN_UNCONFIGURED) {
 686                 retval = msleep(be_lun, &softc->lock, PCATCH, "ctlram", 0);
 687                 if (retval == EINTR)
 688                         break;
 689         }
 690         be_lun->flags &= ~CTL_BE_RAMDISK_LUN_WAITING;
 691
 692         if (be_lun->flags & CTL_BE_RAMDISK_LUN_CONFIG_ERR) {
 693                 snprintf(req->error_str, sizeof(req->error_str),
 694                          "%s: LUN configuration error, see dmesg for details",
 695                          __func__);
 696                 STAILQ_REMOVE(&softc->lun_list, be_lun, ctl_be_ramdisk_lun,
 697                               links);
 698                 softc->num_luns--;
 699                 mtx_unlock(&softc->lock);
 700                 goto bailout_error;
 701         } else {
 702                 params->req_lun_id = cbe_lun->lun_id;
 703         }
 704         mtx_unlock(&softc->lock);
 705
 706         req->status = CTL_LUN_OK;
 707
 708         return (retval);
 709
 710 bailout_error:
 711         req->status = CTL_LUN_ERROR;
 712         if (be_lun != NULL) {
 713                 if (be_lun->io_taskqueue != NULL) {
 714                         taskqueue_free(be_lun->io_taskqueue);
 715                 }
 716                 ctl_free_opts(&cbe_lun->options);
 717                 mtx_destroy(&be_lun->queue_lock);
 718                 free(be_lun, M_RAMDISK);
 719         }
 720
 721         return (retval);
 722 }
 723
 724 static int
 725 ctl_backend_ramdisk_modify(struct ctl_be_ramdisk_softc *softc,
 726                        struct ctl_lun_req *req)
 727 {
 728         struct ctl_be_ramdisk_lun *be_lun;
 729         struct ctl_be_lun *cbe_lun;
 730         struct ctl_lun_modify_params *params;
 731         char *value;
 732         uint32_t blocksize;
 733         int wasprim;
 734
 735         params = &req->reqdata.modify;
 736
 737         mtx_lock(&softc->lock);
 738         STAILQ_FOREACH(be_lun, &softc->lun_list, links) {
 739                 if (be_lun->cbe_lun.lun_id == params->lun_id)
 740                         break;
 741         }
 742         mtx_unlock(&softc->lock);
 743
 744         if (be_lun == NULL) {
 745                 snprintf(req->error_str, sizeof(req->error_str),
 746                          "%s: LUN %u is not managed by the ramdisk backend",
 747                          __func__, params->lun_id);
 748                 goto bailout_error;
 749         }
 750         cbe_lun = &be_lun->cbe_lun;
 751
 752         if (params->lun_size_bytes != 0)
 753                 be_lun->params.lun_size_bytes = params->lun_size_bytes;
 754         ctl_update_opts(&cbe_lun->options, req->num_be_args, req->kern_be_args);
 755
 756         wasprim = (cbe_lun->flags & CTL_LUN_FLAG_PRIMARY);
 757         value = ctl_get_opt(&cbe_lun->options, "ha_role");
 758         if (value != NULL) {
 759                 if (strcmp(value, "primary") == 0)
 760                         cbe_lun->flags |= CTL_LUN_FLAG_PRIMARY;
 761                 else
 762                         cbe_lun->flags &= ~CTL_LUN_FLAG_PRIMARY;
 763         } else if (control_softc->flags & CTL_FLAG_ACTIVE_SHELF)
 764                 cbe_lun->flags |= CTL_LUN_FLAG_PRIMARY;
 765         else
 766                 cbe_lun->flags &= ~CTL_LUN_FLAG_PRIMARY;
 767         if (wasprim != (cbe_lun->flags & CTL_LUN_FLAG_PRIMARY)) {
 768                 if (cbe_lun->flags & CTL_LUN_FLAG_PRIMARY)
 769                         ctl_lun_primary(cbe_lun);
 770                 else
 771                         ctl_lun_secondary(cbe_lun);
 772         }
 773
 774         blocksize = be_lun->cbe_lun.blocksize;
 775         if (be_lun->params.lun_size_bytes < blocksize) {
 776                 snprintf(req->error_str, sizeof(req->error_str),
 777                         "%s: LUN size %ju < blocksize %u", __func__,
 778                         be_lun->params.lun_size_bytes, blocksize);
 779                 goto bailout_error;
 780         }
 781         be_lun->size_blocks = be_lun->params.lun_size_bytes / blocksize;
 782         be_lun->size_bytes = be_lun->size_blocks * blocksize;
 783         be_lun->cbe_lun.maxlba = be_lun->size_blocks - 1;
 784         ctl_lun_capacity_changed(&be_lun->cbe_lun);
 785
 786         /* Tell the user the exact size we ended up using */
 787         params->lun_size_bytes = be_lun->size_bytes;
 788
 789         req->status = CTL_LUN_OK;
 790
 791         return (0);
 792
 793 bailout_error:
 794         req->status = CTL_LUN_ERROR;
 795
 796         return (0);
 797 }
 798
 799 static void
 800 ctl_backend_ramdisk_lun_shutdown(void *be_lun)
 801 {
 802         struct ctl_be_ramdisk_lun *lun;
 803         struct ctl_be_ramdisk_softc *softc;
 804         int do_free;
 805
 806         lun = (struct ctl_be_ramdisk_lun *)be_lun;
 807         softc = lun->softc;
 808         do_free = 0;
 809
 810         mtx_lock(&softc->lock);
 811
 812         lun->flags |= CTL_BE_RAMDISK_LUN_UNCONFIGURED;
 813
 814         if (lun->flags & CTL_BE_RAMDISK_LUN_WAITING) {
 815                 wakeup(lun);
 816         } else {
 817                 STAILQ_REMOVE(&softc->lun_list, lun, ctl_be_ramdisk_lun,
 818                               links);
 819                 softc->num_luns--;
 820                 do_free = 1;
 821         }
 822
 823         mtx_unlock(&softc->lock);
 824
 825         if (do_free != 0)
 826                 free(be_lun, M_RAMDISK);
 827 }
 828
 829 static void
 830 ctl_backend_ramdisk_lun_config_status(void *be_lun,
 831                                       ctl_lun_config_status status)
 832 {
 833         struct ctl_be_ramdisk_lun *lun;
 834         struct ctl_be_ramdisk_softc *softc;
 835
 836         lun = (struct ctl_be_ramdisk_lun *)be_lun;
 837         softc = lun->softc;
 838
 839         if (status == CTL_LUN_CONFIG_OK) {
 840                 mtx_lock(&softc->lock);
 841                 lun->flags &= ~CTL_BE_RAMDISK_LUN_UNCONFIGURED;
 842                 if (lun->flags & CTL_BE_RAMDISK_LUN_WAITING)
 843                         wakeup(lun);
 844                 mtx_unlock(&softc->lock);
 845
 846                 /*
 847                  * We successfully added the LUN, attempt to enable it.
 848                  */
 849                 if (ctl_enable_lun(&lun->cbe_lun) != 0) {
 850                         printf("%s: ctl_enable_lun() failed!\n", __func__);
 851                         if (ctl_invalidate_lun(&lun->cbe_lun) != 0) {
 852                                 printf("%s: ctl_invalidate_lun() failed!\n",
 853                                        __func__);
 854                         }
 855                 }
 856
 857                 return;
 858         }
 859
 860
 861         mtx_lock(&softc->lock);
 862         lun->flags &= ~CTL_BE_RAMDISK_LUN_UNCONFIGURED;
 863
 864         /*
 865          * If we have a user waiting, let him handle the cleanup.  If not,
 866          * clean things up here.
 867          */
 868         if (lun->flags & CTL_BE_RAMDISK_LUN_WAITING) {
 869                 lun->flags |= CTL_BE_RAMDISK_LUN_CONFIG_ERR;
 870                 wakeup(lun);
 871         } else {
 872                 STAILQ_REMOVE(&softc->lun_list, lun, ctl_be_ramdisk_lun,
 873                               links);
 874                 softc->num_luns--;
 875                 free(lun, M_RAMDISK);
 876         }
 877         mtx_unlock(&softc->lock);
 878 }
 879
 880 static int
 881 ctl_backend_ramdisk_config_write(union ctl_io *io)
 882 {
 883         struct ctl_be_ramdisk_softc *softc;
 884         int retval;
 885
 886         retval = 0;
 887         softc = &rd_softc;
 888
 889         switch (io->scsiio.cdb[0]) {
 890         case SYNCHRONIZE_CACHE:
 891         case SYNCHRONIZE_CACHE_16:
 892                 /*
 893                  * The upper level CTL code will filter out any CDBs with
 894                  * the immediate bit set and return the proper error.  It
 895                  * will also not allow a sync cache command to go to a LUN
 896                  * that is powered down.
 897                  *
 898                  * We don't really need to worry about what LBA range the
 899                  * user asked to be synced out.  When they issue a sync
 900                  * cache command, we'll sync out the whole thing.
 901                  *
 902                  * This is obviously just a stubbed out implementation.
 903                  * The real implementation will be in the RAIDCore/CTL
 904                  * interface, and can only really happen when RAIDCore
 905                  * implements a per-array cache sync.
 906                  */
 907                 ctl_set_success(&io->scsiio);
 908                 ctl_config_write_done(io);
 909                 break;
 910         case START_STOP_UNIT: {
 911                 struct scsi_start_stop_unit *cdb;
 912                 struct ctl_be_lun *cbe_lun;
 913                 struct ctl_be_ramdisk_lun *be_lun;
 914
 915                 cdb = (struct scsi_start_stop_unit *)io->scsiio.cdb;
 916
 917                 cbe_lun = (struct ctl_be_lun *)io->io_hdr.ctl_private[
 918                         CTL_PRIV_BACKEND_LUN].ptr;
 919                 be_lun = (struct ctl_be_ramdisk_lun *)cbe_lun->be_lun;
 920
 921                 if (cdb->how & SSS_START)
 922                         retval = ctl_start_lun(cbe_lun);
 923                 else {
 924                         retval = ctl_stop_lun(cbe_lun);
 925 #ifdef NEEDTOPORT
 926                         if ((retval == 0)
 927                          && (cdb->byte2 & SSS_ONOFFLINE))
 928                                 retval = ctl_lun_offline(cbe_lun);
 929 #endif
 930                 }
 931
 932                 /*
 933                  * In general, the above routines should not fail.  They
 934                  * just set state for the LUN.  So we've got something
 935                  * pretty wrong here if we can't start or stop the LUN.
 936                  */
 937                 if (retval != 0) {
 938                         ctl_set_internal_failure(&io->scsiio,
 939                                                  /*sks_valid*/ 1,
 940                                                  /*retry_count*/ 0xf051);
 941                         retval = CTL_RETVAL_COMPLETE;
 942                 } else {
 943                         ctl_set_success(&io->scsiio);
 944                 }
 945                 ctl_config_write_done(io);
 946                 break;
 947         }
 948         case WRITE_SAME_10:
 949         case WRITE_SAME_16:
 950         case UNMAP:
 951                 ctl_set_success(&io->scsiio);
 952                 ctl_config_write_done(io);
 953                 break;
 954         default:
 955                 ctl_set_invalid_opcode(&io->scsiio);
 956                 ctl_config_write_done(io);
 957                 retval = CTL_RETVAL_COMPLETE;
 958                 break;
 959         }
 960
 961         return (retval);
 962 }
 963
 964 static int
 965 ctl_backend_ramdisk_config_read(union ctl_io *io)
 966 {
 967         int retval = 0;
 968
 969         switch (io->scsiio.cdb[0]) {
 970         case SERVICE_ACTION_IN:
 971                 if (io->scsiio.cdb[1] == SGLS_SERVICE_ACTION) {
 972                         /* We have nothing to tell, leave default data. */
 973                         ctl_config_read_done(io);
 974                         retval = CTL_RETVAL_COMPLETE;
 975                         break;
 976                 }
 977                 ctl_set_invalid_field(&io->scsiio,
 978                                       /*sks_valid*/ 1,
 979                                       /*command*/ 1,
 980                                       /*field*/ 1,
 981                                       /*bit_valid*/ 1,
 982                                       /*bit*/ 4);
 983                 ctl_config_read_done(io);
 984                 retval = CTL_RETVAL_COMPLETE;
 985                 break;
 986         default:
 987                 ctl_set_invalid_opcode(&io->scsiio);
 988                 ctl_config_read_done(io);
 989                 retval = CTL_RETVAL_COMPLETE;
 990                 break;
 991         }
 992
 993         return (retval);
 994 }