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: head/sys/cam/ctl/ctl_backend_ramdisk.c 252569 2013-07-03 14:58:11Z mav $");
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/time.h>
54#include <sys/queue.h>
55#include <sys/conf.h>
56#include <sys/ioccom.h>
57#include <sys/module.h>
58
59#include <cam/scsi/scsi_all.h>
60#include <cam/ctl/ctl_io.h>
61#include <cam/ctl/ctl.h>
62#include <cam/ctl/ctl_util.h>
63#include <cam/ctl/ctl_backend.h>
64#include <cam/ctl/ctl_frontend_internal.h>
65#include <cam/ctl/ctl_debug.h>
66#include <cam/ctl/ctl_ioctl.h>
67#include <cam/ctl/ctl_error.h>
68
69typedef enum {
70 CTL_BE_RAMDISK_LUN_UNCONFIGURED = 0x01,
71 CTL_BE_RAMDISK_LUN_CONFIG_ERR = 0x02,
72 CTL_BE_RAMDISK_LUN_WAITING = 0x04
73} ctl_be_ramdisk_lun_flags;
74
75struct ctl_be_ramdisk_lun {
76 uint64_t size_bytes;
77 uint64_t size_blocks;
78 struct ctl_be_ramdisk_softc *softc;
79 ctl_be_ramdisk_lun_flags flags;
80 STAILQ_ENTRY(ctl_be_ramdisk_lun) links;
81 struct ctl_be_lun ctl_be_lun;
82};
83
84struct ctl_be_ramdisk_softc {
85 struct mtx lock;
86 int rd_size;
87#ifdef CTL_RAMDISK_PAGES
88 uint8_t **ramdisk_pages;
89 int num_pages;
90#else
91 uint8_t *ramdisk_buffer;
92#endif
93 int num_luns;
94 STAILQ_HEAD(, ctl_be_ramdisk_lun) lun_list;
95};
96
97static struct ctl_be_ramdisk_softc rd_softc;
98
99int ctl_backend_ramdisk_init(void);
100void ctl_backend_ramdisk_shutdown(void);
101static int ctl_backend_ramdisk_move_done(union ctl_io *io);
102static int ctl_backend_ramdisk_submit(union ctl_io *io);
103static int ctl_backend_ramdisk_ioctl(struct cdev *dev, u_long cmd,
104 caddr_t addr, int flag, struct thread *td);
105static int ctl_backend_ramdisk_rm(struct ctl_be_ramdisk_softc *softc,
106 struct ctl_lun_req *req);
107static int ctl_backend_ramdisk_create(struct ctl_be_ramdisk_softc *softc,
108 struct ctl_lun_req *req, int do_wait);
109static int ctl_backend_ramdisk_modify(struct ctl_be_ramdisk_softc *softc,
110 struct ctl_lun_req *req);
111static void ctl_backend_ramdisk_lun_shutdown(void *be_lun);
112static void ctl_backend_ramdisk_lun_config_status(void *be_lun,
113 ctl_lun_config_status status);
114static int ctl_backend_ramdisk_config_write(union ctl_io *io);
115static int ctl_backend_ramdisk_config_read(union ctl_io *io);
116
117static struct ctl_backend_driver ctl_be_ramdisk_driver =
118{
119 .name = "ramdisk",
120 .flags = CTL_BE_FLAG_HAS_CONFIG,
121 .init = ctl_backend_ramdisk_init,
122 .data_submit = ctl_backend_ramdisk_submit,
123 .data_move_done = ctl_backend_ramdisk_move_done,
124 .config_read = ctl_backend_ramdisk_config_read,
125 .config_write = ctl_backend_ramdisk_config_write,
126 .ioctl = ctl_backend_ramdisk_ioctl
127};
128
129MALLOC_DEFINE(M_RAMDISK, "ramdisk", "Memory used for CTL RAMdisk");
130CTL_BACKEND_DECLARE(cbr, ctl_be_ramdisk_driver);
131
132int
133ctl_backend_ramdisk_init(void)
134{
135 struct ctl_be_ramdisk_softc *softc;
136#ifdef CTL_RAMDISK_PAGES
137 int i;
138#endif
139
140
141 softc = &rd_softc;
142
143 memset(softc, 0, sizeof(*softc));
144
145 mtx_init(&softc->lock, "ramdisk", NULL, MTX_DEF);
146
147 STAILQ_INIT(&softc->lun_list);
148 softc->rd_size = 4 * 1024 * 1024;
149#ifdef CTL_RAMDISK_PAGES
150 softc->num_pages = softc->rd_size / PAGE_SIZE;
151 softc->ramdisk_pages = (uint8_t **)malloc(sizeof(uint8_t *) *
152 softc->num_pages, M_RAMDISK,
153 M_WAITOK);
154 for (i = 0; i < softc->num_pages; i++)
155 softc->ramdisk_pages[i] = malloc(PAGE_SIZE, M_RAMDISK,M_WAITOK);
156#else
157 softc->ramdisk_buffer = (uint8_t *)malloc(softc->rd_size, M_RAMDISK,
158 M_WAITOK);
159#endif
160
161 return (0);
162}
163
164void
165ctl_backend_ramdisk_shutdown(void)
166{
167 struct ctl_be_ramdisk_softc *softc;
168 struct ctl_be_ramdisk_lun *lun, *next_lun;
169#ifdef CTL_RAMDISK_PAGES
170 int i;
171#endif
172
173 softc = &rd_softc;
174
175 mtx_lock(&softc->lock);
176 for (lun = STAILQ_FIRST(&softc->lun_list); lun != NULL; lun = next_lun){
177 /*
178 * Grab the next LUN. The current LUN may get removed by
179 * ctl_invalidate_lun(), which will call our LUN shutdown
180 * routine, if there is no outstanding I/O for this LUN.
181 */
182 next_lun = STAILQ_NEXT(lun, links);
183
184 /*
185 * Drop our lock here. Since ctl_invalidate_lun() can call
186 * back into us, this could potentially lead to a recursive
187 * lock of the same mutex, which would cause a hang.
188 */
189 mtx_unlock(&softc->lock);
190 ctl_disable_lun(&lun->ctl_be_lun);
191 ctl_invalidate_lun(&lun->ctl_be_lun);
192 mtx_lock(&softc->lock);
193 }
194 mtx_unlock(&softc->lock);
195
196#ifdef CTL_RAMDISK_PAGES
197 for (i = 0; i < softc->num_pages; i++)
198 free(softc->ramdisk_pages[i], M_RAMDISK);
199
200 free(softc->ramdisk_pages, M_RAMDISK);
201#else
202 free(softc->ramdisk_buffer, M_RAMDISK);
203#endif
204
205 if (ctl_backend_deregister(&ctl_be_ramdisk_driver) != 0) {
206 printf("ctl_backend_ramdisk_shutdown: "
207 "ctl_backend_deregister() failed!\n");
208 }
209}
210
211static int
212ctl_backend_ramdisk_move_done(union ctl_io *io)
213{
214#ifdef CTL_TIME_IO
215 struct bintime cur_bt;
216#endif
217
218 CTL_DEBUG_PRINT(("ctl_backend_ramdisk_move_done\n"));
219 if ((io->io_hdr.port_status == 0)
220 && ((io->io_hdr.flags & CTL_FLAG_ABORT) == 0)
221 && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE))
222 io->io_hdr.status = CTL_SUCCESS;
223 else if ((io->io_hdr.port_status != 0)
224 && ((io->io_hdr.flags & CTL_FLAG_ABORT) == 0)
225 && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE)){
226 /*
227 * For hardware error sense keys, the sense key
228 * specific value is defined to be a retry count,
229 * but we use it to pass back an internal FETD
230 * error code. XXX KDM Hopefully the FETD is only
231 * using 16 bits for an error code, since that's
232 * all the space we have in the sks field.
233 */
234 ctl_set_internal_failure(&io->scsiio,
235 /*sks_valid*/ 1,
236 /*retry_count*/
237 io->io_hdr.port_status);
238 }
239#ifdef CTL_TIME_IO
240 getbintime(&cur_bt);
241 bintime_sub(&cur_bt, &io->io_hdr.dma_start_bt);
242 bintime_add(&io->io_hdr.dma_bt, &cur_bt);
243 io->io_hdr.num_dmas++;
244#endif
245
246 if (io->scsiio.kern_sg_entries > 0)
247 free(io->scsiio.kern_data_ptr, M_RAMDISK);
248 ctl_done(io);
249 return(0);
250}
251
252static int
253ctl_backend_ramdisk_submit(union ctl_io *io)
254{
255 struct ctl_lba_len lbalen;
256#ifdef CTL_RAMDISK_PAGES
257 struct ctl_sg_entry *sg_entries;
258 int len_filled;
259 int i;
260#endif
261 int num_sg_entries, len;
262 struct ctl_be_ramdisk_softc *softc;
263 struct ctl_be_lun *ctl_be_lun;
264 struct ctl_be_ramdisk_lun *be_lun;
265
266 softc = &rd_softc;
267
268 ctl_be_lun = (struct ctl_be_lun *)io->io_hdr.ctl_private[
269 CTL_PRIV_BACKEND_LUN].ptr;
270 be_lun = (struct ctl_be_ramdisk_lun *)ctl_be_lun->be_lun;
271
272 memcpy(&lbalen, io->io_hdr.ctl_private[CTL_PRIV_LBA_LEN].bytes,
273 sizeof(lbalen));
274
275 len = lbalen.len * ctl_be_lun->blocksize;
276
277 /*
278 * Kick out the request if it's bigger than we can handle.
279 */
280 if (len > softc->rd_size) {
281 ctl_set_internal_failure(&io->scsiio,
282 /*sks_valid*/ 0,
283 /*retry_count*/ 0);
284 ctl_done(io);
285 return (CTL_RETVAL_COMPLETE);
286 }
287
288 /*
289 * Kick out the request if it's larger than the device size that
290 * the user requested.
291 */
292 if (((lbalen.lba * ctl_be_lun->blocksize) + len) > be_lun->size_bytes) {
293 ctl_set_lba_out_of_range(&io->scsiio);
294 ctl_done(io);
295 return (CTL_RETVAL_COMPLETE);
296 }
297
298#ifdef CTL_RAMDISK_PAGES
299 num_sg_entries = len >> PAGE_SHIFT;
300 if ((len & (PAGE_SIZE - 1)) != 0)
301 num_sg_entries++;
302
303 if (num_sg_entries > 1) {
304 io->scsiio.kern_data_ptr = malloc(sizeof(struct ctl_sg_entry) *
305 num_sg_entries, M_RAMDISK,
306 M_WAITOK);
307 sg_entries = (struct ctl_sg_entry *)io->scsiio.kern_data_ptr;
308 for (i = 0, len_filled = 0; i < num_sg_entries;
309 i++, len_filled += PAGE_SIZE) {
310 sg_entries[i].addr = softc->ramdisk_pages[i];
311 sg_entries[i].len = ctl_min(PAGE_SIZE,
312 len - len_filled);
313 }
314 } else {
315#endif /* CTL_RAMDISK_PAGES */
316 /*
317 * If this is less than 1 page, don't bother allocating a
318 * scatter/gather list for it. This saves time/overhead.
319 */
320 num_sg_entries = 0;
321#ifdef CTL_RAMDISK_PAGES
322 io->scsiio.kern_data_ptr = softc->ramdisk_pages[0];
323#else
324 io->scsiio.kern_data_ptr = softc->ramdisk_buffer;
325#endif
326#ifdef CTL_RAMDISK_PAGES
327 }
328#endif
329
330 io->scsiio.be_move_done = ctl_backend_ramdisk_move_done;
331 io->scsiio.kern_data_len = len;
332 io->scsiio.kern_total_len = len;
333 io->scsiio.kern_rel_offset = 0;
334 io->scsiio.kern_data_resid = 0;
335 io->scsiio.kern_sg_entries = num_sg_entries;
336 io->io_hdr.flags |= CTL_FLAG_ALLOCATED | CTL_FLAG_KDPTR_SGLIST;
337#ifdef CTL_TIME_IO
338 getbintime(&io->io_hdr.dma_start_bt);
339#endif
340 ctl_datamove(io);
341
342 return (CTL_RETVAL_COMPLETE);
343}
344
345static int
346ctl_backend_ramdisk_ioctl(struct cdev *dev, u_long cmd, caddr_t addr,
347 int flag, struct thread *td)
348{
349 struct ctl_be_ramdisk_softc *softc;
350 int retval;
351
352 retval = 0;
353 softc = &rd_softc;
354
355 switch (cmd) {
356 case CTL_LUN_REQ: {
357 struct ctl_lun_req *lun_req;
358
359 lun_req = (struct ctl_lun_req *)addr;
360
361 switch (lun_req->reqtype) {
362 case CTL_LUNREQ_CREATE:
363 retval = ctl_backend_ramdisk_create(softc, lun_req,
364 /*do_wait*/ 1);
365 break;
366 case CTL_LUNREQ_RM:
367 retval = ctl_backend_ramdisk_rm(softc, lun_req);
368 break;
369 case CTL_LUNREQ_MODIFY:
370 retval = ctl_backend_ramdisk_modify(softc, lun_req);
371 break;
372 default:
373 lun_req->status = CTL_LUN_ERROR;
374 snprintf(lun_req->error_str, sizeof(lun_req->error_str),
375 "%s: invalid LUN request type %d", __func__,
376 lun_req->reqtype);
377 break;
378 }
379 break;
380 }
381 default:
382 retval = ENOTTY;
383 break;
384 }
385
386 return (retval);
387}
388
389static int
390ctl_backend_ramdisk_rm(struct ctl_be_ramdisk_softc *softc,
391 struct ctl_lun_req *req)
392{
393 struct ctl_be_ramdisk_lun *be_lun;
394 struct ctl_lun_rm_params *params;
395 int retval;
396
397
398 retval = 0;
399 params = &req->reqdata.rm;
400
401 be_lun = NULL;
402
403 mtx_lock(&softc->lock);
404
405 STAILQ_FOREACH(be_lun, &softc->lun_list, links) {
406 if (be_lun->ctl_be_lun.lun_id == params->lun_id)
407 break;
408 }
409 mtx_unlock(&softc->lock);
410
411 if (be_lun == NULL) {
412 snprintf(req->error_str, sizeof(req->error_str),
413 "%s: LUN %u is not managed by the ramdisk backend",
414 __func__, params->lun_id);
415 goto bailout_error;
416 }
417
418 retval = ctl_disable_lun(&be_lun->ctl_be_lun);
419
420 if (retval != 0) {
421 snprintf(req->error_str, sizeof(req->error_str),
422 "%s: error %d returned from ctl_disable_lun() for "
423 "LUN %d", __func__, retval, params->lun_id);
424 goto bailout_error;
425 }
426
427 /*
428 * Set the waiting flag before we invalidate the LUN. Our shutdown
429 * routine can be called any time after we invalidate the LUN,
430 * and can be called from our context.
431 *
432 * This tells the shutdown routine that we're waiting, or we're
433 * going to wait for the shutdown to happen.
434 */
435 mtx_lock(&softc->lock);
436 be_lun->flags |= CTL_BE_RAMDISK_LUN_WAITING;
437 mtx_unlock(&softc->lock);
438
439 retval = ctl_invalidate_lun(&be_lun->ctl_be_lun);
440 if (retval != 0) {
441 snprintf(req->error_str, sizeof(req->error_str),
442 "%s: error %d returned from ctl_invalidate_lun() for "
443 "LUN %d", __func__, retval, params->lun_id);
444 mtx_lock(&softc->lock);
445 be_lun->flags &= ~CTL_BE_RAMDISK_LUN_WAITING;
446 mtx_unlock(&softc->lock);
447 goto bailout_error;
448 }
449
450 mtx_lock(&softc->lock);
451
452 while ((be_lun->flags & CTL_BE_RAMDISK_LUN_UNCONFIGURED) == 0) {
453 retval = msleep(be_lun, &softc->lock, PCATCH, "ctlram", 0);
454 if (retval == EINTR)
455 break;
456 }
457 be_lun->flags &= ~CTL_BE_RAMDISK_LUN_WAITING;
458
459 /*
460 * We only remove this LUN from the list and free it (below) if
461 * retval == 0. If the user interrupted the wait, we just bail out
462 * without actually freeing the LUN. We let the shutdown routine
463 * free the LUN if that happens.
464 */
465 if (retval == 0) {
466 STAILQ_REMOVE(&softc->lun_list, be_lun, ctl_be_ramdisk_lun,
467 links);
468 softc->num_luns--;
469 }
470
471 mtx_unlock(&softc->lock);
472
473 if (retval == 0)
474 free(be_lun, M_RAMDISK);
475
476 req->status = CTL_LUN_OK;
477
478 return (retval);
479
480bailout_error:
481 req->status = CTL_LUN_ERROR;
482
483 return (0);
484}
485
486static int
487ctl_backend_ramdisk_create(struct ctl_be_ramdisk_softc *softc,
488 struct ctl_lun_req *req, int do_wait)
489{
490 struct ctl_be_ramdisk_lun *be_lun;
491 struct ctl_lun_create_params *params;
492 uint32_t blocksize;
493 char tmpstr[32];
494 int retval;
495
496 retval = 0;
497 params = &req->reqdata.create;
498 if (params->blocksize_bytes != 0)
499 blocksize = params->blocksize_bytes;
500 else
501 blocksize = 512;
502
503 be_lun = malloc(sizeof(*be_lun), M_RAMDISK, M_ZERO | (do_wait ?
504 M_WAITOK : M_NOWAIT));
505
506 if (be_lun == NULL) {
507 snprintf(req->error_str, sizeof(req->error_str),
508 "%s: error allocating %zd bytes", __func__,
509 sizeof(*be_lun));
510 goto bailout_error;
511 }
512
513 if (params->flags & CTL_LUN_FLAG_DEV_TYPE)
514 be_lun->ctl_be_lun.lun_type = params->device_type;
515 else
516 be_lun->ctl_be_lun.lun_type = T_DIRECT;
517
518 if (be_lun->ctl_be_lun.lun_type == T_DIRECT) {
519
520 if (params->lun_size_bytes < blocksize) {
521 snprintf(req->error_str, sizeof(req->error_str),
522 "%s: LUN size %ju < blocksize %u", __func__,
523 params->lun_size_bytes, blocksize);
524 goto bailout_error;
525 }
526
527 be_lun->size_blocks = params->lun_size_bytes / blocksize;
528 be_lun->size_bytes = be_lun->size_blocks * blocksize;
529
530 be_lun->ctl_be_lun.maxlba = be_lun->size_blocks - 1;
531 } else {
532 be_lun->ctl_be_lun.maxlba = 0;
533 blocksize = 0;
534 be_lun->size_bytes = 0;
535 be_lun->size_blocks = 0;
536 }
537
538 be_lun->ctl_be_lun.blocksize = blocksize;
539
540 /* Tell the user the blocksize we ended up using */
541 params->blocksize_bytes = blocksize;
542
543 /* Tell the user the exact size we ended up using */
544 params->lun_size_bytes = be_lun->size_bytes;
545
546 be_lun->softc = softc;
547
548 be_lun->flags = CTL_BE_RAMDISK_LUN_UNCONFIGURED;
549 be_lun->ctl_be_lun.flags = CTL_LUN_FLAG_PRIMARY;
550 be_lun->ctl_be_lun.be_lun = be_lun;
551
552 if (params->flags & CTL_LUN_FLAG_ID_REQ) {
553 be_lun->ctl_be_lun.req_lun_id = params->req_lun_id;
554 be_lun->ctl_be_lun.flags |= CTL_LUN_FLAG_ID_REQ;
555 } else
556 be_lun->ctl_be_lun.req_lun_id = 0;
557
558 be_lun->ctl_be_lun.lun_shutdown = ctl_backend_ramdisk_lun_shutdown;
559 be_lun->ctl_be_lun.lun_config_status =
560 ctl_backend_ramdisk_lun_config_status;
561 be_lun->ctl_be_lun.be = &ctl_be_ramdisk_driver;
562 if ((params->flags & CTL_LUN_FLAG_SERIAL_NUM) == 0) {
563 snprintf(tmpstr, sizeof(tmpstr), "MYSERIAL%4d",
564 softc->num_luns);
565 strncpy((char *)be_lun->ctl_be_lun.serial_num, tmpstr,
566 ctl_min(sizeof(be_lun->ctl_be_lun.serial_num),
567 sizeof(tmpstr)));
568
569 /* Tell the user what we used for a serial number */
570 strncpy((char *)params->serial_num, tmpstr,
571 ctl_min(sizeof(params->serial_num), sizeof(tmpstr)));
572 } else {
573 strncpy((char *)be_lun->ctl_be_lun.serial_num,
574 params->serial_num,
575 ctl_min(sizeof(be_lun->ctl_be_lun.serial_num),
576 sizeof(params->serial_num)));
577 }
578 if ((params->flags & CTL_LUN_FLAG_DEVID) == 0) {
579 snprintf(tmpstr, sizeof(tmpstr), "MYDEVID%4d", softc->num_luns);
580 strncpy((char *)be_lun->ctl_be_lun.device_id, tmpstr,
581 ctl_min(sizeof(be_lun->ctl_be_lun.device_id),
582 sizeof(tmpstr)));
583
584 /* Tell the user what we used for a device ID */
585 strncpy((char *)params->device_id, tmpstr,
586 ctl_min(sizeof(params->device_id), sizeof(tmpstr)));
587 } else {
588 strncpy((char *)be_lun->ctl_be_lun.device_id,
589 params->device_id,
590 ctl_min(sizeof(be_lun->ctl_be_lun.device_id),
591 sizeof(params->device_id)));
592 }
593
594 mtx_lock(&softc->lock);
595 softc->num_luns++;
596 STAILQ_INSERT_TAIL(&softc->lun_list, be_lun, links);
597
598 mtx_unlock(&softc->lock);
599
600 retval = ctl_add_lun(&be_lun->ctl_be_lun);
601 if (retval != 0) {
602 mtx_lock(&softc->lock);
603 STAILQ_REMOVE(&softc->lun_list, be_lun, ctl_be_ramdisk_lun,
604 links);
605 softc->num_luns--;
606 mtx_unlock(&softc->lock);
607 snprintf(req->error_str, sizeof(req->error_str),
608 "%s: ctl_add_lun() returned error %d, see dmesg for "
609 "details", __func__, retval);
610 retval = 0;
611 goto bailout_error;
612 }
613
614 if (do_wait == 0)
615 return (retval);
616
617 mtx_lock(&softc->lock);
618
619 /*
620 * Tell the config_status routine that we're waiting so it won't
621 * clean up the LUN in the event of an error.
622 */
623 be_lun->flags |= CTL_BE_RAMDISK_LUN_WAITING;
624
625 while (be_lun->flags & CTL_BE_RAMDISK_LUN_UNCONFIGURED) {
626 retval = msleep(be_lun, &softc->lock, PCATCH, "ctlram", 0);
627 if (retval == EINTR)
628 break;
629 }
630 be_lun->flags &= ~CTL_BE_RAMDISK_LUN_WAITING;
631
632 if (be_lun->flags & CTL_BE_RAMDISK_LUN_CONFIG_ERR) {
633 snprintf(req->error_str, sizeof(req->error_str),
634 "%s: LUN configuration error, see dmesg for details",
635 __func__);
636 STAILQ_REMOVE(&softc->lun_list, be_lun, ctl_be_ramdisk_lun,
637 links);
638 softc->num_luns--;
639 mtx_unlock(&softc->lock);
640 goto bailout_error;
641 } else {
642 params->req_lun_id = be_lun->ctl_be_lun.lun_id;
643 }
644 mtx_unlock(&softc->lock);
645
646 req->status = CTL_LUN_OK;
647
648 return (retval);
649
650bailout_error:
651 req->status = CTL_LUN_ERROR;
652 free(be_lun, M_RAMDISK);
653
654 return (retval);
655}
656
657static int
658ctl_backend_ramdisk_modify(struct ctl_be_ramdisk_softc *softc,
659 struct ctl_lun_req *req)
660{
661 struct ctl_be_ramdisk_lun *be_lun;
662 struct ctl_lun_modify_params *params;
663 uint32_t blocksize;
664
665 params = &req->reqdata.modify;
666
667 be_lun = NULL;
668
669 mtx_lock(&softc->lock);
670 STAILQ_FOREACH(be_lun, &softc->lun_list, links) {
671 if (be_lun->ctl_be_lun.lun_id == params->lun_id)
672 break;
673 }
674 mtx_unlock(&softc->lock);
675
676 if (be_lun == NULL) {
677 snprintf(req->error_str, sizeof(req->error_str),
678 "%s: LUN %u is not managed by the ramdisk backend",
679 __func__, params->lun_id);
680 goto bailout_error;
681 }
682
683 if (params->lun_size_bytes == 0) {
684 snprintf(req->error_str, sizeof(req->error_str),
685 "%s: LUN size \"auto\" not supported "
686 "by the ramdisk backend", __func__);
687 goto bailout_error;
688 }
689
690 blocksize = be_lun->ctl_be_lun.blocksize;
691
692 if (params->lun_size_bytes < blocksize) {
693 snprintf(req->error_str, sizeof(req->error_str),
694 "%s: LUN size %ju < blocksize %u", __func__,
695 params->lun_size_bytes, blocksize);
696 goto bailout_error;
697 }
698
699 be_lun->size_blocks = params->lun_size_bytes / blocksize;
700 be_lun->size_bytes = be_lun->size_blocks * blocksize;
701
702 /*
703 * The maximum LBA is the size - 1.
704 *
705 * XXX: Note that this field is being updated without locking,
706 * which might cause problems on 32-bit architectures.
707 */
708 be_lun->ctl_be_lun.maxlba = be_lun->size_blocks - 1;
709 ctl_lun_capacity_changed(&be_lun->ctl_be_lun);
710
711 /* Tell the user the exact size we ended up using */
712 params->lun_size_bytes = be_lun->size_bytes;
713
714 req->status = CTL_LUN_OK;
715
716 return (0);
717
718bailout_error:
719 req->status = CTL_LUN_ERROR;
720
721 return (0);
722}
723
724static void
725ctl_backend_ramdisk_lun_shutdown(void *be_lun)
726{
727 struct ctl_be_ramdisk_lun *lun;
728 struct ctl_be_ramdisk_softc *softc;
729 int do_free;
730
731 lun = (struct ctl_be_ramdisk_lun *)be_lun;
732 softc = lun->softc;
733 do_free = 0;
734
735 mtx_lock(&softc->lock);
736
737 lun->flags |= CTL_BE_RAMDISK_LUN_UNCONFIGURED;
738
739 if (lun->flags & CTL_BE_RAMDISK_LUN_WAITING) {
740 wakeup(lun);
741 } else {
742 STAILQ_REMOVE(&softc->lun_list, be_lun, ctl_be_ramdisk_lun,
743 links);
744 softc->num_luns--;
745 do_free = 1;
746 }
747
748 mtx_unlock(&softc->lock);
749
750 if (do_free != 0)
751 free(be_lun, M_RAMDISK);
752}
753
754static void
755ctl_backend_ramdisk_lun_config_status(void *be_lun,
756 ctl_lun_config_status status)
757{
758 struct ctl_be_ramdisk_lun *lun;
759 struct ctl_be_ramdisk_softc *softc;
760
761 lun = (struct ctl_be_ramdisk_lun *)be_lun;
762 softc = lun->softc;
763
764 if (status == CTL_LUN_CONFIG_OK) {
765 mtx_lock(&softc->lock);
766 lun->flags &= ~CTL_BE_RAMDISK_LUN_UNCONFIGURED;
767 if (lun->flags & CTL_BE_RAMDISK_LUN_WAITING)
768 wakeup(lun);
769 mtx_unlock(&softc->lock);
770
771 /*
772 * We successfully added the LUN, attempt to enable it.
773 */
774 if (ctl_enable_lun(&lun->ctl_be_lun) != 0) {
775 printf("%s: ctl_enable_lun() failed!\n", __func__);
776 if (ctl_invalidate_lun(&lun->ctl_be_lun) != 0) {
777 printf("%s: ctl_invalidate_lun() failed!\n",
778 __func__);
779 }
780 }
781
782 return;
783 }
784
785
786 mtx_lock(&softc->lock);
787 lun->flags &= ~CTL_BE_RAMDISK_LUN_UNCONFIGURED;
788
789 /*
790 * If we have a user waiting, let him handle the cleanup. If not,
791 * clean things up here.
792 */
793 if (lun->flags & CTL_BE_RAMDISK_LUN_WAITING) {
794 lun->flags |= CTL_BE_RAMDISK_LUN_CONFIG_ERR;
795 wakeup(lun);
796 } else {
797 STAILQ_REMOVE(&softc->lun_list, lun, ctl_be_ramdisk_lun,
798 links);
799 softc->num_luns--;
800 free(lun, M_RAMDISK);
801 }
802 mtx_unlock(&softc->lock);
803}
804
805static int
806ctl_backend_ramdisk_config_write(union ctl_io *io)
807{
808 struct ctl_be_ramdisk_softc *softc;
809 int retval;
810
811 retval = 0;
812 softc = &rd_softc;
813
814 switch (io->scsiio.cdb[0]) {
815 case SYNCHRONIZE_CACHE:
816 case SYNCHRONIZE_CACHE_16:
817 /*
818 * The upper level CTL code will filter out any CDBs with
819 * the immediate bit set and return the proper error. It
820 * will also not allow a sync cache command to go to a LUN
821 * that is powered down.
822 *
823 * We don't really need to worry about what LBA range the
824 * user asked to be synced out. When they issue a sync
825 * cache command, we'll sync out the whole thing.
826 *
827 * This is obviously just a stubbed out implementation.
828 * The real implementation will be in the RAIDCore/CTL
829 * interface, and can only really happen when RAIDCore
830 * implements a per-array cache sync.
831 */
832 ctl_set_success(&io->scsiio);
833 ctl_config_write_done(io);
834 break;
835 case START_STOP_UNIT: {
836 struct scsi_start_stop_unit *cdb;
837 struct ctl_be_lun *ctl_be_lun;
838 struct ctl_be_ramdisk_lun *be_lun;
839
840 cdb = (struct scsi_start_stop_unit *)io->scsiio.cdb;
841
842 ctl_be_lun = (struct ctl_be_lun *)io->io_hdr.ctl_private[
843 CTL_PRIV_BACKEND_LUN].ptr;
844 be_lun = (struct ctl_be_ramdisk_lun *)ctl_be_lun->be_lun;
845
846 if (cdb->how & SSS_START)
847 retval = ctl_start_lun(ctl_be_lun);
848 else {
849 retval = ctl_stop_lun(ctl_be_lun);
850#ifdef NEEDTOPORT
851 if ((retval == 0)
852 && (cdb->byte2 & SSS_ONOFFLINE))
853 retval = ctl_lun_offline(ctl_be_lun);
854#endif
855 }
856
857 /*
858 * In general, the above routines should not fail. They
859 * just set state for the LUN. So we've got something
860 * pretty wrong here if we can't start or stop the LUN.
861 */
862 if (retval != 0) {
863 ctl_set_internal_failure(&io->scsiio,
864 /*sks_valid*/ 1,
865 /*retry_count*/ 0xf051);
866 retval = CTL_RETVAL_COMPLETE;
867 } else {
868 ctl_set_success(&io->scsiio);
869 }
870 ctl_config_write_done(io);
871 break;
872 }
873 default:
874 ctl_set_invalid_opcode(&io->scsiio);
875 ctl_config_write_done(io);
876 retval = CTL_RETVAL_COMPLETE;
877 break;
878 }
879
880 return (retval);
881}
882
883static int
884ctl_backend_ramdisk_config_read(union ctl_io *io)
885{
886 /*
887 * XXX KDM need to implement!!
888 */
889 return (0);
890}
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: head/sys/cam/ctl/ctl_backend_ramdisk.c 252569 2013-07-03 14:58:11Z mav $");
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/time.h>
54#include <sys/queue.h>
55#include <sys/conf.h>
56#include <sys/ioccom.h>
57#include <sys/module.h>
58
59#include <cam/scsi/scsi_all.h>
60#include <cam/ctl/ctl_io.h>
61#include <cam/ctl/ctl.h>
62#include <cam/ctl/ctl_util.h>
63#include <cam/ctl/ctl_backend.h>
64#include <cam/ctl/ctl_frontend_internal.h>
65#include <cam/ctl/ctl_debug.h>
66#include <cam/ctl/ctl_ioctl.h>
67#include <cam/ctl/ctl_error.h>
68
69typedef enum {
70 CTL_BE_RAMDISK_LUN_UNCONFIGURED = 0x01,
71 CTL_BE_RAMDISK_LUN_CONFIG_ERR = 0x02,
72 CTL_BE_RAMDISK_LUN_WAITING = 0x04
73} ctl_be_ramdisk_lun_flags;
74
75struct ctl_be_ramdisk_lun {
76 uint64_t size_bytes;
77 uint64_t size_blocks;
78 struct ctl_be_ramdisk_softc *softc;
79 ctl_be_ramdisk_lun_flags flags;
80 STAILQ_ENTRY(ctl_be_ramdisk_lun) links;
81 struct ctl_be_lun ctl_be_lun;
82};
83
84struct ctl_be_ramdisk_softc {
85 struct mtx lock;
86 int rd_size;
87#ifdef CTL_RAMDISK_PAGES
88 uint8_t **ramdisk_pages;
89 int num_pages;
90#else
91 uint8_t *ramdisk_buffer;
92#endif
93 int num_luns;
94 STAILQ_HEAD(, ctl_be_ramdisk_lun) lun_list;
95};
96
97static struct ctl_be_ramdisk_softc rd_softc;
98
99int ctl_backend_ramdisk_init(void);
100void ctl_backend_ramdisk_shutdown(void);
101static int ctl_backend_ramdisk_move_done(union ctl_io *io);
102static int ctl_backend_ramdisk_submit(union ctl_io *io);
103static int ctl_backend_ramdisk_ioctl(struct cdev *dev, u_long cmd,
104 caddr_t addr, int flag, struct thread *td);
105static int ctl_backend_ramdisk_rm(struct ctl_be_ramdisk_softc *softc,
106 struct ctl_lun_req *req);
107static int ctl_backend_ramdisk_create(struct ctl_be_ramdisk_softc *softc,
108 struct ctl_lun_req *req, int do_wait);
109static int ctl_backend_ramdisk_modify(struct ctl_be_ramdisk_softc *softc,
110 struct ctl_lun_req *req);
111static void ctl_backend_ramdisk_lun_shutdown(void *be_lun);
112static void ctl_backend_ramdisk_lun_config_status(void *be_lun,
113 ctl_lun_config_status status);
114static int ctl_backend_ramdisk_config_write(union ctl_io *io);
115static int ctl_backend_ramdisk_config_read(union ctl_io *io);
116
117static struct ctl_backend_driver ctl_be_ramdisk_driver =
118{
119 .name = "ramdisk",
120 .flags = CTL_BE_FLAG_HAS_CONFIG,
121 .init = ctl_backend_ramdisk_init,
122 .data_submit = ctl_backend_ramdisk_submit,
123 .data_move_done = ctl_backend_ramdisk_move_done,
124 .config_read = ctl_backend_ramdisk_config_read,
125 .config_write = ctl_backend_ramdisk_config_write,
126 .ioctl = ctl_backend_ramdisk_ioctl
127};
128
129MALLOC_DEFINE(M_RAMDISK, "ramdisk", "Memory used for CTL RAMdisk");
130CTL_BACKEND_DECLARE(cbr, ctl_be_ramdisk_driver);
131
132int
133ctl_backend_ramdisk_init(void)
134{
135 struct ctl_be_ramdisk_softc *softc;
136#ifdef CTL_RAMDISK_PAGES
137 int i;
138#endif
139
140
141 softc = &rd_softc;
142
143 memset(softc, 0, sizeof(*softc));
144
145 mtx_init(&softc->lock, "ramdisk", NULL, MTX_DEF);
146
147 STAILQ_INIT(&softc->lun_list);
148 softc->rd_size = 4 * 1024 * 1024;
149#ifdef CTL_RAMDISK_PAGES
150 softc->num_pages = softc->rd_size / PAGE_SIZE;
151 softc->ramdisk_pages = (uint8_t **)malloc(sizeof(uint8_t *) *
152 softc->num_pages, M_RAMDISK,
153 M_WAITOK);
154 for (i = 0; i < softc->num_pages; i++)
155 softc->ramdisk_pages[i] = malloc(PAGE_SIZE, M_RAMDISK,M_WAITOK);
156#else
157 softc->ramdisk_buffer = (uint8_t *)malloc(softc->rd_size, M_RAMDISK,
158 M_WAITOK);
159#endif
160
161 return (0);
162}
163
164void
165ctl_backend_ramdisk_shutdown(void)
166{
167 struct ctl_be_ramdisk_softc *softc;
168 struct ctl_be_ramdisk_lun *lun, *next_lun;
169#ifdef CTL_RAMDISK_PAGES
170 int i;
171#endif
172
173 softc = &rd_softc;
174
175 mtx_lock(&softc->lock);
176 for (lun = STAILQ_FIRST(&softc->lun_list); lun != NULL; lun = next_lun){
177 /*
178 * Grab the next LUN. The current LUN may get removed by
179 * ctl_invalidate_lun(), which will call our LUN shutdown
180 * routine, if there is no outstanding I/O for this LUN.
181 */
182 next_lun = STAILQ_NEXT(lun, links);
183
184 /*
185 * Drop our lock here. Since ctl_invalidate_lun() can call
186 * back into us, this could potentially lead to a recursive
187 * lock of the same mutex, which would cause a hang.
188 */
189 mtx_unlock(&softc->lock);
190 ctl_disable_lun(&lun->ctl_be_lun);
191 ctl_invalidate_lun(&lun->ctl_be_lun);
192 mtx_lock(&softc->lock);
193 }
194 mtx_unlock(&softc->lock);
195
196#ifdef CTL_RAMDISK_PAGES
197 for (i = 0; i < softc->num_pages; i++)
198 free(softc->ramdisk_pages[i], M_RAMDISK);
199
200 free(softc->ramdisk_pages, M_RAMDISK);
201#else
202 free(softc->ramdisk_buffer, M_RAMDISK);
203#endif
204
205 if (ctl_backend_deregister(&ctl_be_ramdisk_driver) != 0) {
206 printf("ctl_backend_ramdisk_shutdown: "
207 "ctl_backend_deregister() failed!\n");
208 }
209}
210
211static int
212ctl_backend_ramdisk_move_done(union ctl_io *io)
213{
214#ifdef CTL_TIME_IO
215 struct bintime cur_bt;
216#endif
217
218 CTL_DEBUG_PRINT(("ctl_backend_ramdisk_move_done\n"));
219 if ((io->io_hdr.port_status == 0)
220 && ((io->io_hdr.flags & CTL_FLAG_ABORT) == 0)
221 && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE))
222 io->io_hdr.status = CTL_SUCCESS;
223 else if ((io->io_hdr.port_status != 0)
224 && ((io->io_hdr.flags & CTL_FLAG_ABORT) == 0)
225 && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE)){
226 /*
227 * For hardware error sense keys, the sense key
228 * specific value is defined to be a retry count,
229 * but we use it to pass back an internal FETD
230 * error code. XXX KDM Hopefully the FETD is only
231 * using 16 bits for an error code, since that's
232 * all the space we have in the sks field.
233 */
234 ctl_set_internal_failure(&io->scsiio,
235 /*sks_valid*/ 1,
236 /*retry_count*/
237 io->io_hdr.port_status);
238 }
239#ifdef CTL_TIME_IO
240 getbintime(&cur_bt);
241 bintime_sub(&cur_bt, &io->io_hdr.dma_start_bt);
242 bintime_add(&io->io_hdr.dma_bt, &cur_bt);
243 io->io_hdr.num_dmas++;
244#endif
245
246 if (io->scsiio.kern_sg_entries > 0)
247 free(io->scsiio.kern_data_ptr, M_RAMDISK);
248 ctl_done(io);
249 return(0);
250}
251
252static int
253ctl_backend_ramdisk_submit(union ctl_io *io)
254{
255 struct ctl_lba_len lbalen;
256#ifdef CTL_RAMDISK_PAGES
257 struct ctl_sg_entry *sg_entries;
258 int len_filled;
259 int i;
260#endif
261 int num_sg_entries, len;
262 struct ctl_be_ramdisk_softc *softc;
263 struct ctl_be_lun *ctl_be_lun;
264 struct ctl_be_ramdisk_lun *be_lun;
265
266 softc = &rd_softc;
267
268 ctl_be_lun = (struct ctl_be_lun *)io->io_hdr.ctl_private[
269 CTL_PRIV_BACKEND_LUN].ptr;
270 be_lun = (struct ctl_be_ramdisk_lun *)ctl_be_lun->be_lun;
271
272 memcpy(&lbalen, io->io_hdr.ctl_private[CTL_PRIV_LBA_LEN].bytes,
273 sizeof(lbalen));
274
275 len = lbalen.len * ctl_be_lun->blocksize;
276
277 /*
278 * Kick out the request if it's bigger than we can handle.
279 */
280 if (len > softc->rd_size) {
281 ctl_set_internal_failure(&io->scsiio,
282 /*sks_valid*/ 0,
283 /*retry_count*/ 0);
284 ctl_done(io);
285 return (CTL_RETVAL_COMPLETE);
286 }
287
288 /*
289 * Kick out the request if it's larger than the device size that
290 * the user requested.
291 */
292 if (((lbalen.lba * ctl_be_lun->blocksize) + len) > be_lun->size_bytes) {
293 ctl_set_lba_out_of_range(&io->scsiio);
294 ctl_done(io);
295 return (CTL_RETVAL_COMPLETE);
296 }
297
298#ifdef CTL_RAMDISK_PAGES
299 num_sg_entries = len >> PAGE_SHIFT;
300 if ((len & (PAGE_SIZE - 1)) != 0)
301 num_sg_entries++;
302
303 if (num_sg_entries > 1) {
304 io->scsiio.kern_data_ptr = malloc(sizeof(struct ctl_sg_entry) *
305 num_sg_entries, M_RAMDISK,
306 M_WAITOK);
307 sg_entries = (struct ctl_sg_entry *)io->scsiio.kern_data_ptr;
308 for (i = 0, len_filled = 0; i < num_sg_entries;
309 i++, len_filled += PAGE_SIZE) {
310 sg_entries[i].addr = softc->ramdisk_pages[i];
311 sg_entries[i].len = ctl_min(PAGE_SIZE,
312 len - len_filled);
313 }
314 } else {
315#endif /* CTL_RAMDISK_PAGES */
316 /*
317 * If this is less than 1 page, don't bother allocating a
318 * scatter/gather list for it. This saves time/overhead.
319 */
320 num_sg_entries = 0;
321#ifdef CTL_RAMDISK_PAGES
322 io->scsiio.kern_data_ptr = softc->ramdisk_pages[0];
323#else
324 io->scsiio.kern_data_ptr = softc->ramdisk_buffer;
325#endif
326#ifdef CTL_RAMDISK_PAGES
327 }
328#endif
329
330 io->scsiio.be_move_done = ctl_backend_ramdisk_move_done;
331 io->scsiio.kern_data_len = len;
332 io->scsiio.kern_total_len = len;
333 io->scsiio.kern_rel_offset = 0;
334 io->scsiio.kern_data_resid = 0;
335 io->scsiio.kern_sg_entries = num_sg_entries;
336 io->io_hdr.flags |= CTL_FLAG_ALLOCATED | CTL_FLAG_KDPTR_SGLIST;
337#ifdef CTL_TIME_IO
338 getbintime(&io->io_hdr.dma_start_bt);
339#endif
340 ctl_datamove(io);
341
342 return (CTL_RETVAL_COMPLETE);
343}
344
345static int
346ctl_backend_ramdisk_ioctl(struct cdev *dev, u_long cmd, caddr_t addr,
347 int flag, struct thread *td)
348{
349 struct ctl_be_ramdisk_softc *softc;
350 int retval;
351
352 retval = 0;
353 softc = &rd_softc;
354
355 switch (cmd) {
356 case CTL_LUN_REQ: {
357 struct ctl_lun_req *lun_req;
358
359 lun_req = (struct ctl_lun_req *)addr;
360
361 switch (lun_req->reqtype) {
362 case CTL_LUNREQ_CREATE:
363 retval = ctl_backend_ramdisk_create(softc, lun_req,
364 /*do_wait*/ 1);
365 break;
366 case CTL_LUNREQ_RM:
367 retval = ctl_backend_ramdisk_rm(softc, lun_req);
368 break;
369 case CTL_LUNREQ_MODIFY:
370 retval = ctl_backend_ramdisk_modify(softc, lun_req);
371 break;
372 default:
373 lun_req->status = CTL_LUN_ERROR;
374 snprintf(lun_req->error_str, sizeof(lun_req->error_str),
375 "%s: invalid LUN request type %d", __func__,
376 lun_req->reqtype);
377 break;
378 }
379 break;
380 }
381 default:
382 retval = ENOTTY;
383 break;
384 }
385
386 return (retval);
387}
388
389static int
390ctl_backend_ramdisk_rm(struct ctl_be_ramdisk_softc *softc,
391 struct ctl_lun_req *req)
392{
393 struct ctl_be_ramdisk_lun *be_lun;
394 struct ctl_lun_rm_params *params;
395 int retval;
396
397
398 retval = 0;
399 params = &req->reqdata.rm;
400
401 be_lun = NULL;
402
403 mtx_lock(&softc->lock);
404
405 STAILQ_FOREACH(be_lun, &softc->lun_list, links) {
406 if (be_lun->ctl_be_lun.lun_id == params->lun_id)
407 break;
408 }
409 mtx_unlock(&softc->lock);
410
411 if (be_lun == NULL) {
412 snprintf(req->error_str, sizeof(req->error_str),
413 "%s: LUN %u is not managed by the ramdisk backend",
414 __func__, params->lun_id);
415 goto bailout_error;
416 }
417
418 retval = ctl_disable_lun(&be_lun->ctl_be_lun);
419
420 if (retval != 0) {
421 snprintf(req->error_str, sizeof(req->error_str),
422 "%s: error %d returned from ctl_disable_lun() for "
423 "LUN %d", __func__, retval, params->lun_id);
424 goto bailout_error;
425 }
426
427 /*
428 * Set the waiting flag before we invalidate the LUN. Our shutdown
429 * routine can be called any time after we invalidate the LUN,
430 * and can be called from our context.
431 *
432 * This tells the shutdown routine that we're waiting, or we're
433 * going to wait for the shutdown to happen.
434 */
435 mtx_lock(&softc->lock);
436 be_lun->flags |= CTL_BE_RAMDISK_LUN_WAITING;
437 mtx_unlock(&softc->lock);
438
439 retval = ctl_invalidate_lun(&be_lun->ctl_be_lun);
440 if (retval != 0) {
441 snprintf(req->error_str, sizeof(req->error_str),
442 "%s: error %d returned from ctl_invalidate_lun() for "
443 "LUN %d", __func__, retval, params->lun_id);
444 mtx_lock(&softc->lock);
445 be_lun->flags &= ~CTL_BE_RAMDISK_LUN_WAITING;
446 mtx_unlock(&softc->lock);
447 goto bailout_error;
448 }
449
450 mtx_lock(&softc->lock);
451
452 while ((be_lun->flags & CTL_BE_RAMDISK_LUN_UNCONFIGURED) == 0) {
453 retval = msleep(be_lun, &softc->lock, PCATCH, "ctlram", 0);
454 if (retval == EINTR)
455 break;
456 }
457 be_lun->flags &= ~CTL_BE_RAMDISK_LUN_WAITING;
458
459 /*
460 * We only remove this LUN from the list and free it (below) if
461 * retval == 0. If the user interrupted the wait, we just bail out
462 * without actually freeing the LUN. We let the shutdown routine
463 * free the LUN if that happens.
464 */
465 if (retval == 0) {
466 STAILQ_REMOVE(&softc->lun_list, be_lun, ctl_be_ramdisk_lun,
467 links);
468 softc->num_luns--;
469 }
470
471 mtx_unlock(&softc->lock);
472
473 if (retval == 0)
474 free(be_lun, M_RAMDISK);
475
476 req->status = CTL_LUN_OK;
477
478 return (retval);
479
480bailout_error:
481 req->status = CTL_LUN_ERROR;
482
483 return (0);
484}
485
486static int
487ctl_backend_ramdisk_create(struct ctl_be_ramdisk_softc *softc,
488 struct ctl_lun_req *req, int do_wait)
489{
490 struct ctl_be_ramdisk_lun *be_lun;
491 struct ctl_lun_create_params *params;
492 uint32_t blocksize;
493 char tmpstr[32];
494 int retval;
495
496 retval = 0;
497 params = &req->reqdata.create;
498 if (params->blocksize_bytes != 0)
499 blocksize = params->blocksize_bytes;
500 else
501 blocksize = 512;
502
503 be_lun = malloc(sizeof(*be_lun), M_RAMDISK, M_ZERO | (do_wait ?
504 M_WAITOK : M_NOWAIT));
505
506 if (be_lun == NULL) {
507 snprintf(req->error_str, sizeof(req->error_str),
508 "%s: error allocating %zd bytes", __func__,
509 sizeof(*be_lun));
510 goto bailout_error;
511 }
512
513 if (params->flags & CTL_LUN_FLAG_DEV_TYPE)
514 be_lun->ctl_be_lun.lun_type = params->device_type;
515 else
516 be_lun->ctl_be_lun.lun_type = T_DIRECT;
517
518 if (be_lun->ctl_be_lun.lun_type == T_DIRECT) {
519
520 if (params->lun_size_bytes < blocksize) {
521 snprintf(req->error_str, sizeof(req->error_str),
522 "%s: LUN size %ju < blocksize %u", __func__,
523 params->lun_size_bytes, blocksize);
524 goto bailout_error;
525 }
526
527 be_lun->size_blocks = params->lun_size_bytes / blocksize;
528 be_lun->size_bytes = be_lun->size_blocks * blocksize;
529
530 be_lun->ctl_be_lun.maxlba = be_lun->size_blocks - 1;
531 } else {
532 be_lun->ctl_be_lun.maxlba = 0;
533 blocksize = 0;
534 be_lun->size_bytes = 0;
535 be_lun->size_blocks = 0;
536 }
537
538 be_lun->ctl_be_lun.blocksize = blocksize;
539
540 /* Tell the user the blocksize we ended up using */
541 params->blocksize_bytes = blocksize;
542
543 /* Tell the user the exact size we ended up using */
544 params->lun_size_bytes = be_lun->size_bytes;
545
546 be_lun->softc = softc;
547
548 be_lun->flags = CTL_BE_RAMDISK_LUN_UNCONFIGURED;
549 be_lun->ctl_be_lun.flags = CTL_LUN_FLAG_PRIMARY;
550 be_lun->ctl_be_lun.be_lun = be_lun;
551
552 if (params->flags & CTL_LUN_FLAG_ID_REQ) {
553 be_lun->ctl_be_lun.req_lun_id = params->req_lun_id;
554 be_lun->ctl_be_lun.flags |= CTL_LUN_FLAG_ID_REQ;
555 } else
556 be_lun->ctl_be_lun.req_lun_id = 0;
557
558 be_lun->ctl_be_lun.lun_shutdown = ctl_backend_ramdisk_lun_shutdown;
559 be_lun->ctl_be_lun.lun_config_status =
560 ctl_backend_ramdisk_lun_config_status;
561 be_lun->ctl_be_lun.be = &ctl_be_ramdisk_driver;
562 if ((params->flags & CTL_LUN_FLAG_SERIAL_NUM) == 0) {
563 snprintf(tmpstr, sizeof(tmpstr), "MYSERIAL%4d",
564 softc->num_luns);
565 strncpy((char *)be_lun->ctl_be_lun.serial_num, tmpstr,
566 ctl_min(sizeof(be_lun->ctl_be_lun.serial_num),
567 sizeof(tmpstr)));
568
569 /* Tell the user what we used for a serial number */
570 strncpy((char *)params->serial_num, tmpstr,
571 ctl_min(sizeof(params->serial_num), sizeof(tmpstr)));
572 } else {
573 strncpy((char *)be_lun->ctl_be_lun.serial_num,
574 params->serial_num,
575 ctl_min(sizeof(be_lun->ctl_be_lun.serial_num),
576 sizeof(params->serial_num)));
577 }
578 if ((params->flags & CTL_LUN_FLAG_DEVID) == 0) {
579 snprintf(tmpstr, sizeof(tmpstr), "MYDEVID%4d", softc->num_luns);
580 strncpy((char *)be_lun->ctl_be_lun.device_id, tmpstr,
581 ctl_min(sizeof(be_lun->ctl_be_lun.device_id),
582 sizeof(tmpstr)));
583
584 /* Tell the user what we used for a device ID */
585 strncpy((char *)params->device_id, tmpstr,
586 ctl_min(sizeof(params->device_id), sizeof(tmpstr)));
587 } else {
588 strncpy((char *)be_lun->ctl_be_lun.device_id,
589 params->device_id,
590 ctl_min(sizeof(be_lun->ctl_be_lun.device_id),
591 sizeof(params->device_id)));
592 }
593
594 mtx_lock(&softc->lock);
595 softc->num_luns++;
596 STAILQ_INSERT_TAIL(&softc->lun_list, be_lun, links);
597
598 mtx_unlock(&softc->lock);
599
600 retval = ctl_add_lun(&be_lun->ctl_be_lun);
601 if (retval != 0) {
602 mtx_lock(&softc->lock);
603 STAILQ_REMOVE(&softc->lun_list, be_lun, ctl_be_ramdisk_lun,
604 links);
605 softc->num_luns--;
606 mtx_unlock(&softc->lock);
607 snprintf(req->error_str, sizeof(req->error_str),
608 "%s: ctl_add_lun() returned error %d, see dmesg for "
609 "details", __func__, retval);
610 retval = 0;
611 goto bailout_error;
612 }
613
614 if (do_wait == 0)
615 return (retval);
616
617 mtx_lock(&softc->lock);
618
619 /*
620 * Tell the config_status routine that we're waiting so it won't
621 * clean up the LUN in the event of an error.
622 */
623 be_lun->flags |= CTL_BE_RAMDISK_LUN_WAITING;
624
625 while (be_lun->flags & CTL_BE_RAMDISK_LUN_UNCONFIGURED) {
626 retval = msleep(be_lun, &softc->lock, PCATCH, "ctlram", 0);
627 if (retval == EINTR)
628 break;
629 }
630 be_lun->flags &= ~CTL_BE_RAMDISK_LUN_WAITING;
631
632 if (be_lun->flags & CTL_BE_RAMDISK_LUN_CONFIG_ERR) {
633 snprintf(req->error_str, sizeof(req->error_str),
634 "%s: LUN configuration error, see dmesg for details",
635 __func__);
636 STAILQ_REMOVE(&softc->lun_list, be_lun, ctl_be_ramdisk_lun,
637 links);
638 softc->num_luns--;
639 mtx_unlock(&softc->lock);
640 goto bailout_error;
641 } else {
642 params->req_lun_id = be_lun->ctl_be_lun.lun_id;
643 }
644 mtx_unlock(&softc->lock);
645
646 req->status = CTL_LUN_OK;
647
648 return (retval);
649
650bailout_error:
651 req->status = CTL_LUN_ERROR;
652 free(be_lun, M_RAMDISK);
653
654 return (retval);
655}
656
657static int
658ctl_backend_ramdisk_modify(struct ctl_be_ramdisk_softc *softc,
659 struct ctl_lun_req *req)
660{
661 struct ctl_be_ramdisk_lun *be_lun;
662 struct ctl_lun_modify_params *params;
663 uint32_t blocksize;
664
665 params = &req->reqdata.modify;
666
667 be_lun = NULL;
668
669 mtx_lock(&softc->lock);
670 STAILQ_FOREACH(be_lun, &softc->lun_list, links) {
671 if (be_lun->ctl_be_lun.lun_id == params->lun_id)
672 break;
673 }
674 mtx_unlock(&softc->lock);
675
676 if (be_lun == NULL) {
677 snprintf(req->error_str, sizeof(req->error_str),
678 "%s: LUN %u is not managed by the ramdisk backend",
679 __func__, params->lun_id);
680 goto bailout_error;
681 }
682
683 if (params->lun_size_bytes == 0) {
684 snprintf(req->error_str, sizeof(req->error_str),
685 "%s: LUN size \"auto\" not supported "
686 "by the ramdisk backend", __func__);
687 goto bailout_error;
688 }
689
690 blocksize = be_lun->ctl_be_lun.blocksize;
691
692 if (params->lun_size_bytes < blocksize) {
693 snprintf(req->error_str, sizeof(req->error_str),
694 "%s: LUN size %ju < blocksize %u", __func__,
695 params->lun_size_bytes, blocksize);
696 goto bailout_error;
697 }
698
699 be_lun->size_blocks = params->lun_size_bytes / blocksize;
700 be_lun->size_bytes = be_lun->size_blocks * blocksize;
701
702 /*
703 * The maximum LBA is the size - 1.
704 *
705 * XXX: Note that this field is being updated without locking,
706 * which might cause problems on 32-bit architectures.
707 */
708 be_lun->ctl_be_lun.maxlba = be_lun->size_blocks - 1;
709 ctl_lun_capacity_changed(&be_lun->ctl_be_lun);
710
711 /* Tell the user the exact size we ended up using */
712 params->lun_size_bytes = be_lun->size_bytes;
713
714 req->status = CTL_LUN_OK;
715
716 return (0);
717
718bailout_error:
719 req->status = CTL_LUN_ERROR;
720
721 return (0);
722}
723
724static void
725ctl_backend_ramdisk_lun_shutdown(void *be_lun)
726{
727 struct ctl_be_ramdisk_lun *lun;
728 struct ctl_be_ramdisk_softc *softc;
729 int do_free;
730
731 lun = (struct ctl_be_ramdisk_lun *)be_lun;
732 softc = lun->softc;
733 do_free = 0;
734
735 mtx_lock(&softc->lock);
736
737 lun->flags |= CTL_BE_RAMDISK_LUN_UNCONFIGURED;
738
739 if (lun->flags & CTL_BE_RAMDISK_LUN_WAITING) {
740 wakeup(lun);
741 } else {
742 STAILQ_REMOVE(&softc->lun_list, be_lun, ctl_be_ramdisk_lun,
743 links);
744 softc->num_luns--;
745 do_free = 1;
746 }
747
748 mtx_unlock(&softc->lock);
749
750 if (do_free != 0)
751 free(be_lun, M_RAMDISK);
752}
753
754static void
755ctl_backend_ramdisk_lun_config_status(void *be_lun,
756 ctl_lun_config_status status)
757{
758 struct ctl_be_ramdisk_lun *lun;
759 struct ctl_be_ramdisk_softc *softc;
760
761 lun = (struct ctl_be_ramdisk_lun *)be_lun;
762 softc = lun->softc;
763
764 if (status == CTL_LUN_CONFIG_OK) {
765 mtx_lock(&softc->lock);
766 lun->flags &= ~CTL_BE_RAMDISK_LUN_UNCONFIGURED;
767 if (lun->flags & CTL_BE_RAMDISK_LUN_WAITING)
768 wakeup(lun);
769 mtx_unlock(&softc->lock);
770
771 /*
772 * We successfully added the LUN, attempt to enable it.
773 */
774 if (ctl_enable_lun(&lun->ctl_be_lun) != 0) {
775 printf("%s: ctl_enable_lun() failed!\n", __func__);
776 if (ctl_invalidate_lun(&lun->ctl_be_lun) != 0) {
777 printf("%s: ctl_invalidate_lun() failed!\n",
778 __func__);
779 }
780 }
781
782 return;
783 }
784
785
786 mtx_lock(&softc->lock);
787 lun->flags &= ~CTL_BE_RAMDISK_LUN_UNCONFIGURED;
788
789 /*
790 * If we have a user waiting, let him handle the cleanup. If not,
791 * clean things up here.
792 */
793 if (lun->flags & CTL_BE_RAMDISK_LUN_WAITING) {
794 lun->flags |= CTL_BE_RAMDISK_LUN_CONFIG_ERR;
795 wakeup(lun);
796 } else {
797 STAILQ_REMOVE(&softc->lun_list, lun, ctl_be_ramdisk_lun,
798 links);
799 softc->num_luns--;
800 free(lun, M_RAMDISK);
801 }
802 mtx_unlock(&softc->lock);
803}
804
805static int
806ctl_backend_ramdisk_config_write(union ctl_io *io)
807{
808 struct ctl_be_ramdisk_softc *softc;
809 int retval;
810
811 retval = 0;
812 softc = &rd_softc;
813
814 switch (io->scsiio.cdb[0]) {
815 case SYNCHRONIZE_CACHE:
816 case SYNCHRONIZE_CACHE_16:
817 /*
818 * The upper level CTL code will filter out any CDBs with
819 * the immediate bit set and return the proper error. It
820 * will also not allow a sync cache command to go to a LUN
821 * that is powered down.
822 *
823 * We don't really need to worry about what LBA range the
824 * user asked to be synced out. When they issue a sync
825 * cache command, we'll sync out the whole thing.
826 *
827 * This is obviously just a stubbed out implementation.
828 * The real implementation will be in the RAIDCore/CTL
829 * interface, and can only really happen when RAIDCore
830 * implements a per-array cache sync.
831 */
832 ctl_set_success(&io->scsiio);
833 ctl_config_write_done(io);
834 break;
835 case START_STOP_UNIT: {
836 struct scsi_start_stop_unit *cdb;
837 struct ctl_be_lun *ctl_be_lun;
838 struct ctl_be_ramdisk_lun *be_lun;
839
840 cdb = (struct scsi_start_stop_unit *)io->scsiio.cdb;
841
842 ctl_be_lun = (struct ctl_be_lun *)io->io_hdr.ctl_private[
843 CTL_PRIV_BACKEND_LUN].ptr;
844 be_lun = (struct ctl_be_ramdisk_lun *)ctl_be_lun->be_lun;
845
846 if (cdb->how & SSS_START)
847 retval = ctl_start_lun(ctl_be_lun);
848 else {
849 retval = ctl_stop_lun(ctl_be_lun);
850#ifdef NEEDTOPORT
851 if ((retval == 0)
852 && (cdb->byte2 & SSS_ONOFFLINE))
853 retval = ctl_lun_offline(ctl_be_lun);
854#endif
855 }
856
857 /*
858 * In general, the above routines should not fail. They
859 * just set state for the LUN. So we've got something
860 * pretty wrong here if we can't start or stop the LUN.
861 */
862 if (retval != 0) {
863 ctl_set_internal_failure(&io->scsiio,
864 /*sks_valid*/ 1,
865 /*retry_count*/ 0xf051);
866 retval = CTL_RETVAL_COMPLETE;
867 } else {
868 ctl_set_success(&io->scsiio);
869 }
870 ctl_config_write_done(io);
871 break;
872 }
873 default:
874 ctl_set_invalid_opcode(&io->scsiio);
875 ctl_config_write_done(io);
876 retval = CTL_RETVAL_COMPLETE;
877 break;
878 }
879
880 return (retval);
881}
882
883static int
884ctl_backend_ramdisk_config_read(union ctl_io *io)
885{
886 /*
887 * XXX KDM need to implement!!
888 */
889 return (0);
890}