-
Notifications
You must be signed in to change notification settings - Fork 2.8k
/
ctl_backend_ramdisk.c
1436 lines (1306 loc) · 39.4 KB
/
ctl_backend_ramdisk.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*-
* SPDX-License-Identifier: BSD-2-Clause
*
* Copyright (c) 2003, 2008 Silicon Graphics International Corp.
* Copyright (c) 2012 The FreeBSD Foundation
* Copyright (c) 2014-2017 Alexander Motin <mav@FreeBSD.org>
* All rights reserved.
*
* Portions of this software were developed by Edward Tomasz Napierala
* under sponsorship from the FreeBSD Foundation.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions, and the following disclaimer,
* without modification.
* 2. Redistributions in binary form must reproduce at minimum a disclaimer
* substantially similar to the "NO WARRANTY" disclaimer below
* ("Disclaimer") and any redistribution must be conditioned upon
* including a substantially similar Disclaimer requirement for further
* binary redistribution.
*
* NO WARRANTY
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGES.
*
* $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_backend_ramdisk.c#3 $
*/
/*
* CAM Target Layer black hole and RAM disk backend.
*
* Author: Ken Merry <ken@FreeBSD.org>
*/
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/condvar.h>
#include <sys/types.h>
#include <sys/limits.h>
#include <sys/lock.h>
#include <sys/mutex.h>
#include <sys/malloc.h>
#include <sys/sx.h>
#include <sys/taskqueue.h>
#include <sys/time.h>
#include <sys/queue.h>
#include <sys/conf.h>
#include <sys/ioccom.h>
#include <sys/module.h>
#include <sys/sysctl.h>
#include <sys/nv.h>
#include <sys/dnv.h>
#include <cam/scsi/scsi_all.h>
#include <cam/scsi/scsi_da.h>
#include <cam/ctl/ctl_io.h>
#include <cam/ctl/ctl.h>
#include <cam/ctl/ctl_util.h>
#include <cam/ctl/ctl_backend.h>
#include <cam/ctl/ctl_debug.h>
#include <cam/ctl/ctl_ioctl.h>
#include <cam/ctl/ctl_ha.h>
#include <cam/ctl/ctl_private.h>
#include <cam/ctl/ctl_error.h>
#define PRIV(io) \
((struct ctl_ptr_len_flags *)&(io)->io_hdr.ctl_private[CTL_PRIV_BACKEND])
#define ARGS(io) \
((struct ctl_lba_len_flags *)&(io)->io_hdr.ctl_private[CTL_PRIV_LBA_LEN])
#define PPP (PAGE_SIZE / sizeof(uint8_t **))
#ifdef __LP64__
#define PPPS (PAGE_SHIFT - 3)
#else
#define PPPS (PAGE_SHIFT - 2)
#endif
#define SGPP (PAGE_SIZE / sizeof(struct ctl_sg_entry))
#define P_UNMAPPED NULL /* Page is unmapped. */
#define P_ANCHORED ((void *)(uintptr_t)1) /* Page is anchored. */
typedef enum {
GP_READ, /* Return data page or zero page. */
GP_WRITE, /* Return data page, try allocate if none. */
GP_ANCHOR, /* Return data page, try anchor if none. */
GP_OTHER, /* Return what present, do not allocate/anchor. */
} getpage_op_t;
typedef enum {
CTL_BE_RAMDISK_LUN_UNCONFIGURED = 0x01,
CTL_BE_RAMDISK_LUN_WAITING = 0x04
} ctl_be_ramdisk_lun_flags;
struct ctl_be_ramdisk_lun {
struct ctl_be_lun cbe_lun; /* Must be first element. */
struct ctl_lun_create_params params;
int indir;
uint8_t **pages;
uint8_t *zero_page;
struct sx page_lock;
u_int pblocksize;
u_int pblockmul;
uint64_t size_bytes;
uint64_t size_blocks;
uint64_t cap_bytes;
uint64_t cap_used;
struct ctl_be_ramdisk_softc *softc;
ctl_be_ramdisk_lun_flags flags;
SLIST_ENTRY(ctl_be_ramdisk_lun) links;
struct taskqueue *io_taskqueue;
struct task io_task;
STAILQ_HEAD(, ctl_io_hdr) cont_queue;
struct mtx_padalign queue_lock;
};
struct ctl_be_ramdisk_softc {
struct sx modify_lock;
struct mtx lock;
int num_luns;
SLIST_HEAD(, ctl_be_ramdisk_lun) lun_list;
};
static struct ctl_be_ramdisk_softc rd_softc;
extern struct ctl_softc *control_softc;
static int ctl_backend_ramdisk_init(void);
static int ctl_backend_ramdisk_shutdown(void);
static int ctl_backend_ramdisk_move_done(union ctl_io *io, bool samethr);
static void ctl_backend_ramdisk_compare(union ctl_io *io);
static void ctl_backend_ramdisk_rw(union ctl_io *io);
static int ctl_backend_ramdisk_submit(union ctl_io *io);
static void ctl_backend_ramdisk_worker(void *context, int pending);
static int ctl_backend_ramdisk_config_read(union ctl_io *io);
static int ctl_backend_ramdisk_config_write(union ctl_io *io);
static uint64_t ctl_backend_ramdisk_lun_attr(struct ctl_be_lun *cbe_lun, const char *attrname);
static int ctl_backend_ramdisk_ioctl(struct cdev *dev, u_long cmd,
caddr_t addr, int flag, struct thread *td);
static int ctl_backend_ramdisk_rm(struct ctl_be_ramdisk_softc *softc,
struct ctl_lun_req *req);
static int ctl_backend_ramdisk_create(struct ctl_be_ramdisk_softc *softc,
struct ctl_lun_req *req);
static int ctl_backend_ramdisk_modify(struct ctl_be_ramdisk_softc *softc,
struct ctl_lun_req *req);
static void ctl_backend_ramdisk_lun_shutdown(struct ctl_be_lun *cbe_lun);
static struct ctl_backend_driver ctl_be_ramdisk_driver =
{
.name = "ramdisk",
.flags = CTL_BE_FLAG_HAS_CONFIG,
.init = ctl_backend_ramdisk_init,
.shutdown = ctl_backend_ramdisk_shutdown,
.data_submit = ctl_backend_ramdisk_submit,
.config_read = ctl_backend_ramdisk_config_read,
.config_write = ctl_backend_ramdisk_config_write,
.ioctl = ctl_backend_ramdisk_ioctl,
.lun_attr = ctl_backend_ramdisk_lun_attr,
};
MALLOC_DEFINE(M_RAMDISK, "ctlramdisk", "Memory used for CTL RAMdisk");
CTL_BACKEND_DECLARE(cbr, ctl_be_ramdisk_driver);
static int
ctl_backend_ramdisk_init(void)
{
struct ctl_be_ramdisk_softc *softc = &rd_softc;
memset(softc, 0, sizeof(*softc));
sx_init(&softc->modify_lock, "ctlrammod");
mtx_init(&softc->lock, "ctlram", NULL, MTX_DEF);
SLIST_INIT(&softc->lun_list);
return (0);
}
static int
ctl_backend_ramdisk_shutdown(void)
{
struct ctl_be_ramdisk_softc *softc = &rd_softc;
struct ctl_be_ramdisk_lun *lun;
mtx_lock(&softc->lock);
while ((lun = SLIST_FIRST(&softc->lun_list)) != NULL) {
SLIST_REMOVE_HEAD(&softc->lun_list, links);
softc->num_luns--;
/*
* Drop our lock here. Since ctl_remove_lun() can call
* back into us, this could potentially lead to a recursive
* lock of the same mutex, which would cause a hang.
*/
mtx_unlock(&softc->lock);
ctl_remove_lun(&lun->cbe_lun);
mtx_lock(&softc->lock);
}
mtx_unlock(&softc->lock);
mtx_destroy(&softc->lock);
sx_destroy(&softc->modify_lock);
return (0);
}
static uint8_t *
ctl_backend_ramdisk_getpage(struct ctl_be_ramdisk_lun *be_lun, off_t pn,
getpage_op_t op)
{
uint8_t **p, ***pp;
off_t i;
int s;
if (be_lun->cap_bytes == 0) {
switch (op) {
case GP_READ:
return (be_lun->zero_page);
case GP_WRITE:
return ((uint8_t *)be_lun->pages);
case GP_ANCHOR:
return (P_ANCHORED);
default:
return (P_UNMAPPED);
}
}
if (op == GP_WRITE || op == GP_ANCHOR) {
sx_xlock(&be_lun->page_lock);
pp = &be_lun->pages;
for (s = (be_lun->indir - 1) * PPPS; s >= 0; s -= PPPS) {
if (*pp == NULL) {
*pp = malloc(PAGE_SIZE, M_RAMDISK,
M_WAITOK|M_ZERO);
}
i = pn >> s;
pp = (uint8_t ***)&(*pp)[i];
pn -= i << s;
}
if (*pp == P_UNMAPPED && be_lun->cap_used < be_lun->cap_bytes) {
if (op == GP_WRITE) {
*pp = malloc(be_lun->pblocksize, M_RAMDISK,
M_WAITOK|M_ZERO);
} else
*pp = P_ANCHORED;
be_lun->cap_used += be_lun->pblocksize;
} else if (*pp == P_ANCHORED && op == GP_WRITE) {
*pp = malloc(be_lun->pblocksize, M_RAMDISK,
M_WAITOK|M_ZERO);
}
sx_xunlock(&be_lun->page_lock);
return ((uint8_t *)*pp);
} else {
sx_slock(&be_lun->page_lock);
p = be_lun->pages;
for (s = (be_lun->indir - 1) * PPPS; s >= 0; s -= PPPS) {
if (p == NULL)
break;
i = pn >> s;
p = (uint8_t **)p[i];
pn -= i << s;
}
sx_sunlock(&be_lun->page_lock);
if ((p == P_UNMAPPED || p == P_ANCHORED) && op == GP_READ)
return (be_lun->zero_page);
return ((uint8_t *)p);
}
};
static void
ctl_backend_ramdisk_unmappage(struct ctl_be_ramdisk_lun *be_lun, off_t pn)
{
uint8_t ***pp;
off_t i;
int s;
if (be_lun->cap_bytes == 0)
return;
sx_xlock(&be_lun->page_lock);
pp = &be_lun->pages;
for (s = (be_lun->indir - 1) * PPPS; s >= 0; s -= PPPS) {
if (*pp == NULL)
goto noindir;
i = pn >> s;
pp = (uint8_t ***)&(*pp)[i];
pn -= i << s;
}
if (*pp == P_ANCHORED) {
be_lun->cap_used -= be_lun->pblocksize;
*pp = P_UNMAPPED;
} else if (*pp != P_UNMAPPED) {
free(*pp, M_RAMDISK);
be_lun->cap_used -= be_lun->pblocksize;
*pp = P_UNMAPPED;
}
noindir:
sx_xunlock(&be_lun->page_lock);
};
static void
ctl_backend_ramdisk_anchorpage(struct ctl_be_ramdisk_lun *be_lun, off_t pn)
{
uint8_t ***pp;
off_t i;
int s;
if (be_lun->cap_bytes == 0)
return;
sx_xlock(&be_lun->page_lock);
pp = &be_lun->pages;
for (s = (be_lun->indir - 1) * PPPS; s >= 0; s -= PPPS) {
if (*pp == NULL)
goto noindir;
i = pn >> s;
pp = (uint8_t ***)&(*pp)[i];
pn -= i << s;
}
if (*pp == P_UNMAPPED && be_lun->cap_used < be_lun->cap_bytes) {
be_lun->cap_used += be_lun->pblocksize;
*pp = P_ANCHORED;
} else if (*pp != P_ANCHORED) {
free(*pp, M_RAMDISK);
*pp = P_ANCHORED;
}
noindir:
sx_xunlock(&be_lun->page_lock);
};
static void
ctl_backend_ramdisk_freeallpages(uint8_t **p, int indir)
{
int i;
if (p == NULL)
return;
if (indir == 0) {
free(p, M_RAMDISK);
return;
}
for (i = 0; i < PPP; i++) {
if (p[i] == NULL)
continue;
ctl_backend_ramdisk_freeallpages((uint8_t **)p[i], indir - 1);
}
free(p, M_RAMDISK);
};
static size_t
cmp(uint8_t *a, uint8_t *b, size_t size)
{
size_t i;
for (i = 0; i < size; i++) {
if (a[i] != b[i])
break;
}
return (i);
}
static int
ctl_backend_ramdisk_cmp(union ctl_io *io)
{
struct ctl_be_lun *cbe_lun = CTL_BACKEND_LUN(io);
struct ctl_be_ramdisk_lun *be_lun = (struct ctl_be_ramdisk_lun *)cbe_lun;
uint8_t *page;
uint64_t lba;
u_int lbaoff, lbas, res, off;
lbas = ctl_kern_data_len(io) / cbe_lun->blocksize;
lba = ARGS(io)->lba + PRIV(io)->len - lbas;
off = 0;
for (; lbas > 0; lbas--, lba++) {
page = ctl_backend_ramdisk_getpage(be_lun,
lba >> cbe_lun->pblockexp, GP_READ);
lbaoff = lba & ~(UINT_MAX << cbe_lun->pblockexp);
page += lbaoff * cbe_lun->blocksize;
res = cmp(ctl_kern_data_ptr(io) + off, page,
cbe_lun->blocksize);
off += res;
if (res < cbe_lun->blocksize)
break;
}
free(io->scsiio.kern_data_ptr, M_RAMDISK);
if (lbas > 0) {
off += ctl_kern_rel_offset(io) - ctl_kern_data_len(io);
ctl_io_set_compare_failure(io, off);
return (1);
}
return (0);
}
static int
ctl_backend_ramdisk_move_done(union ctl_io *io, bool samethr)
{
struct ctl_be_ramdisk_lun *be_lun =
(struct ctl_be_ramdisk_lun *)CTL_BACKEND_LUN(io);
CTL_DEBUG_PRINT(("ctl_backend_ramdisk_move_done\n"));
if (ctl_kern_sg_entries(io) > 0)
free(ctl_kern_data_ptr(io), M_RAMDISK);
ctl_add_kern_rel_offset(io, ctl_kern_data_len(io));
if ((io->io_hdr.flags & CTL_FLAG_ABORT) == 0 &&
(io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE) {
if (ARGS(io)->flags & CTL_LLF_COMPARE) {
/* We have data block ready for comparison. */
if (ctl_backend_ramdisk_cmp(io))
goto done;
}
if (ARGS(io)->len > PRIV(io)->len) {
mtx_lock(&be_lun->queue_lock);
STAILQ_INSERT_TAIL(&be_lun->cont_queue,
&io->io_hdr, links);
mtx_unlock(&be_lun->queue_lock);
taskqueue_enqueue(be_lun->io_taskqueue,
&be_lun->io_task);
return (0);
}
ctl_io_set_success(io);
}
done:
ctl_data_submit_done(io);
return(0);
}
static void
ctl_backend_ramdisk_compare(union ctl_io *io)
{
struct ctl_be_lun *cbe_lun = CTL_BACKEND_LUN(io);
u_int lbas, len;
lbas = ARGS(io)->len - PRIV(io)->len;
lbas = MIN(lbas, 131072 / cbe_lun->blocksize);
len = lbas * cbe_lun->blocksize;
ctl_set_be_move_done(io, ctl_backend_ramdisk_move_done);
ctl_set_kern_data_ptr(io, malloc(len, M_RAMDISK, M_WAITOK));
ctl_set_kern_data_len(io, len);
ctl_set_kern_sg_entries(io, 0);
io->io_hdr.flags |= CTL_FLAG_ALLOCATED;
PRIV(io)->len += lbas;
ctl_datamove(io);
}
static void
ctl_backend_ramdisk_rw(union ctl_io *io)
{
struct ctl_be_lun *cbe_lun = CTL_BACKEND_LUN(io);
struct ctl_be_ramdisk_lun *be_lun = (struct ctl_be_ramdisk_lun *)cbe_lun;
struct ctl_sg_entry *sg_entries;
uint8_t *page;
uint64_t lba;
u_int i, len, lbaoff, lbas, sgs, off;
getpage_op_t op;
lba = ARGS(io)->lba + PRIV(io)->len;
lbaoff = lba & ~(UINT_MAX << cbe_lun->pblockexp);
lbas = ARGS(io)->len - PRIV(io)->len;
lbas = MIN(lbas, (SGPP << cbe_lun->pblockexp) - lbaoff);
sgs = (lbas + lbaoff + be_lun->pblockmul - 1) >> cbe_lun->pblockexp;
off = lbaoff * cbe_lun->blocksize;
op = (ARGS(io)->flags & CTL_LLF_WRITE) ? GP_WRITE : GP_READ;
if (sgs > 1) {
sg_entries = malloc(sizeof(struct ctl_sg_entry) * sgs,
M_RAMDISK, M_WAITOK);
ctl_set_kern_data_ptr(io, sg_entries);
len = lbas * cbe_lun->blocksize;
for (i = 0; i < sgs; i++) {
page = ctl_backend_ramdisk_getpage(be_lun,
(lba >> cbe_lun->pblockexp) + i, op);
if (page == P_UNMAPPED || page == P_ANCHORED) {
free(sg_entries, M_RAMDISK);
nospc:
ctl_io_set_space_alloc_fail(io);
ctl_data_submit_done(io);
return;
}
sg_entries[i].addr = page + off;
sg_entries[i].len = MIN(len, be_lun->pblocksize - off);
len -= sg_entries[i].len;
off = 0;
}
} else {
page = ctl_backend_ramdisk_getpage(be_lun,
lba >> cbe_lun->pblockexp, op);
if (page == P_UNMAPPED || page == P_ANCHORED)
goto nospc;
sgs = 0;
ctl_set_kern_data_ptr(io, page + off);
}
ctl_set_be_move_done(io, ctl_backend_ramdisk_move_done);
ctl_set_kern_data_len(io, lbas * cbe_lun->blocksize);
ctl_set_kern_sg_entries(io, sgs);
io->io_hdr.flags |= CTL_FLAG_ALLOCATED;
PRIV(io)->len += lbas;
if ((ARGS(io)->flags & CTL_LLF_READ) &&
ARGS(io)->len <= PRIV(io)->len) {
ctl_io_set_success(io);
if (cbe_lun->serseq >= CTL_LUN_SERSEQ_SOFT)
ctl_serseq_done(io);
}
ctl_datamove(io);
}
static int
ctl_backend_ramdisk_submit(union ctl_io *io)
{
struct ctl_lba_len_flags *lbalen = ARGS(io);
if (lbalen->flags & CTL_LLF_VERIFY) {
ctl_io_set_success(io);
ctl_data_submit_done(io);
return (CTL_RETVAL_COMPLETE);
}
PRIV(io)->len = 0;
if (lbalen->flags & CTL_LLF_COMPARE)
ctl_backend_ramdisk_compare(io);
else
ctl_backend_ramdisk_rw(io);
return (CTL_RETVAL_COMPLETE);
}
static void
ctl_backend_ramdisk_worker(void *context, int pending)
{
struct ctl_be_ramdisk_lun *be_lun;
union ctl_io *io;
be_lun = (struct ctl_be_ramdisk_lun *)context;
mtx_lock(&be_lun->queue_lock);
for (;;) {
io = (union ctl_io *)STAILQ_FIRST(&be_lun->cont_queue);
if (io != NULL) {
STAILQ_REMOVE_HEAD(&be_lun->cont_queue, links);
mtx_unlock(&be_lun->queue_lock);
if (ARGS(io)->flags & CTL_LLF_COMPARE)
ctl_backend_ramdisk_compare(io);
else
ctl_backend_ramdisk_rw(io);
mtx_lock(&be_lun->queue_lock);
continue;
}
/*
* If we get here, there is no work left in the queues, so
* just break out and let the task queue go to sleep.
*/
break;
}
mtx_unlock(&be_lun->queue_lock);
}
static int
ctl_backend_ramdisk_gls(union ctl_io *io)
{
struct ctl_be_lun *cbe_lun = CTL_BACKEND_LUN(io);
struct ctl_be_ramdisk_lun *be_lun = (struct ctl_be_ramdisk_lun *)cbe_lun;
struct scsi_get_lba_status_data *data;
uint8_t *page;
u_int lbaoff;
data = (struct scsi_get_lba_status_data *)io->scsiio.kern_data_ptr;
scsi_u64to8b(ARGS(io)->lba, data->descr[0].addr);
lbaoff = ARGS(io)->lba & ~(UINT_MAX << cbe_lun->pblockexp);
scsi_ulto4b(be_lun->pblockmul - lbaoff, data->descr[0].length);
page = ctl_backend_ramdisk_getpage(be_lun,
ARGS(io)->lba >> cbe_lun->pblockexp, GP_OTHER);
if (page == P_UNMAPPED)
data->descr[0].status = 1;
else if (page == P_ANCHORED)
data->descr[0].status = 2;
else
data->descr[0].status = 0;
ctl_config_read_done(io);
return (CTL_RETVAL_COMPLETE);
}
static int
ctl_backend_ramdisk_scsi_config_read(union ctl_io *io)
{
int retval = 0;
switch (io->scsiio.cdb[0]) {
case SERVICE_ACTION_IN:
if (io->scsiio.cdb[1] == SGLS_SERVICE_ACTION) {
retval = ctl_backend_ramdisk_gls(io);
break;
}
ctl_set_invalid_field(&io->scsiio,
/*sks_valid*/ 1,
/*command*/ 1,
/*field*/ 1,
/*bit_valid*/ 1,
/*bit*/ 4);
ctl_config_read_done(io);
retval = CTL_RETVAL_COMPLETE;
break;
default:
ctl_set_invalid_opcode(&io->scsiio);
ctl_config_read_done(io);
retval = CTL_RETVAL_COMPLETE;
break;
}
return (retval);
}
static int
ramdisk_namespace_data(union ctl_io *io)
{
struct ctl_be_lun *cbe_lun = CTL_BACKEND_LUN(io);
struct ctl_be_ramdisk_lun *be_lun = (struct ctl_be_ramdisk_lun *)cbe_lun;
struct nvme_namespace_data *nsdata;
if (io->nvmeio.kern_data_len != sizeof(struct nvme_namespace_data) ||
io->nvmeio.kern_sg_entries != 0)
return (CTL_RETVAL_ERROR);
nsdata = (struct nvme_namespace_data *)io->nvmeio.kern_data_ptr;
memset(nsdata, 0, sizeof(*nsdata));
nsdata->nsze = htole64(be_lun->size_blocks);
nsdata->ncap = htole64(be_lun->cap_bytes / cbe_lun->blocksize);
nsdata->nuse = htole64(be_lun->cap_used / cbe_lun->blocksize);
nsdata->nsfeat = NVMEM(NVME_NS_DATA_NSFEAT_THIN_PROV) |
NVMEM(NVME_NS_DATA_NSFEAT_DEALLOC);
nsdata->nlbaf = 1 - 1;
nsdata->dlfeat = NVMEM(NVME_NS_DATA_DLFEAT_DWZ) |
NVMEF(NVME_NS_DATA_DLFEAT_READ, NVME_NS_DATA_DLFEAT_READ_00);
nsdata->flbas = NVMEF(NVME_NS_DATA_FLBAS_FORMAT, 0);
nsdata->lbaf[0] = NVMEF(NVME_NS_DATA_LBAF_LBADS,
ffs(cbe_lun->blocksize) - 1);
ctl_lun_nsdata_ids(cbe_lun, nsdata);
ctl_config_read_done(io);
return (CTL_RETVAL_COMPLETE);
}
static int
ramdisk_nvme_ids(union ctl_io *io)
{
struct ctl_be_lun *cbe_lun = CTL_BACKEND_LUN(io);
if (io->nvmeio.kern_data_len != 4096 || io->nvmeio.kern_sg_entries != 0)
return (CTL_RETVAL_ERROR);
ctl_lun_nvme_ids(cbe_lun, io->nvmeio.kern_data_ptr);
ctl_config_read_done(io);
return (CTL_RETVAL_COMPLETE);
}
static int
ctl_backend_ramdisk_nvme_config_read(union ctl_io *io)
{
switch (io->nvmeio.cmd.opc) {
case NVME_OPC_IDENTIFY:
{
uint8_t cns;
cns = le32toh(io->nvmeio.cmd.cdw10) & 0xff;
switch (cns) {
case 0:
return (ramdisk_namespace_data(io));
case 3:
return (ramdisk_nvme_ids(io));
default:
ctl_nvme_set_invalid_field(&io->nvmeio);
ctl_config_read_done(io);
return (CTL_RETVAL_COMPLETE);
}
}
default:
ctl_nvme_set_invalid_opcode(&io->nvmeio);
ctl_config_read_done(io);
return (CTL_RETVAL_COMPLETE);
}
}
static int
ctl_backend_ramdisk_config_read(union ctl_io *io)
{
switch (io->io_hdr.io_type) {
case CTL_IO_SCSI:
return (ctl_backend_ramdisk_scsi_config_read(io));
case CTL_IO_NVME_ADMIN:
return (ctl_backend_ramdisk_nvme_config_read(io));
default:
__assert_unreachable();
}
}
static void
ctl_backend_ramdisk_delete(struct ctl_be_lun *cbe_lun, off_t lba, off_t len,
int anchor)
{
struct ctl_be_ramdisk_lun *be_lun = (struct ctl_be_ramdisk_lun *)cbe_lun;
uint8_t *page;
uint64_t p, lp;
u_int lbaoff;
getpage_op_t op = anchor ? GP_ANCHOR : GP_OTHER;
/* Partially zero first partial page. */
p = lba >> cbe_lun->pblockexp;
lbaoff = lba & ~(UINT_MAX << cbe_lun->pblockexp);
if (lbaoff != 0) {
page = ctl_backend_ramdisk_getpage(be_lun, p, op);
if (page != P_UNMAPPED && page != P_ANCHORED) {
memset(page + lbaoff * cbe_lun->blocksize, 0,
min(len, be_lun->pblockmul - lbaoff) *
cbe_lun->blocksize);
}
p++;
}
/* Partially zero last partial page. */
lp = (lba + len) >> cbe_lun->pblockexp;
lbaoff = (lba + len) & ~(UINT_MAX << cbe_lun->pblockexp);
if (p <= lp && lbaoff != 0) {
page = ctl_backend_ramdisk_getpage(be_lun, lp, op);
if (page != P_UNMAPPED && page != P_ANCHORED)
memset(page, 0, lbaoff * cbe_lun->blocksize);
}
/* Delete remaining full pages. */
if (anchor) {
for (; p < lp; p++)
ctl_backend_ramdisk_anchorpage(be_lun, p);
} else {
for (; p < lp; p++)
ctl_backend_ramdisk_unmappage(be_lun, p);
}
}
static void
ctl_backend_ramdisk_ws(union ctl_io *io)
{
struct ctl_be_lun *cbe_lun = CTL_BACKEND_LUN(io);
struct ctl_be_ramdisk_lun *be_lun = (struct ctl_be_ramdisk_lun *)cbe_lun;
struct ctl_lba_len_flags *lbalen = ARGS(io);
uint8_t *page;
uint64_t lba;
u_int lbaoff, lbas;
CTL_IO_ASSERT(io, SCSI);
if (lbalen->flags & ~(SWS_LBDATA | SWS_UNMAP | SWS_ANCHOR | SWS_NDOB)) {
ctl_set_invalid_field(&io->scsiio,
/*sks_valid*/ 1,
/*command*/ 1,
/*field*/ 1,
/*bit_valid*/ 0,
/*bit*/ 0);
ctl_config_write_done(io);
return;
}
if (lbalen->flags & SWS_UNMAP) {
ctl_backend_ramdisk_delete(cbe_lun, lbalen->lba, lbalen->len,
(lbalen->flags & SWS_ANCHOR) != 0);
ctl_set_success(&io->scsiio);
ctl_config_write_done(io);
return;
}
for (lba = lbalen->lba, lbas = lbalen->len; lbas > 0; lba++, lbas--) {
page = ctl_backend_ramdisk_getpage(be_lun,
lba >> cbe_lun->pblockexp, GP_WRITE);
if (page == P_UNMAPPED || page == P_ANCHORED) {
ctl_set_space_alloc_fail(&io->scsiio);
ctl_data_submit_done(io);
return;
}
lbaoff = lba & ~(UINT_MAX << cbe_lun->pblockexp);
page += lbaoff * cbe_lun->blocksize;
if (lbalen->flags & SWS_NDOB) {
memset(page, 0, cbe_lun->blocksize);
} else {
memcpy(page, io->scsiio.kern_data_ptr,
cbe_lun->blocksize);
}
if (lbalen->flags & SWS_LBDATA)
scsi_ulto4b(lba, page);
}
ctl_set_success(&io->scsiio);
ctl_config_write_done(io);
}
static void
ctl_backend_ramdisk_unmap(union ctl_io *io)
{
struct ctl_be_lun *cbe_lun = CTL_BACKEND_LUN(io);
struct ctl_ptr_len_flags *ptrlen = (struct ctl_ptr_len_flags *)ARGS(io);
struct scsi_unmap_desc *buf, *end;
CTL_IO_ASSERT(io, SCSI);
if ((ptrlen->flags & ~SU_ANCHOR) != 0) {
ctl_set_invalid_field(&io->scsiio,
/*sks_valid*/ 0,
/*command*/ 0,
/*field*/ 0,
/*bit_valid*/ 0,
/*bit*/ 0);
ctl_config_write_done(io);
return;
}
buf = (struct scsi_unmap_desc *)ptrlen->ptr;
end = buf + ptrlen->len / sizeof(*buf);
for (; buf < end; buf++) {
ctl_backend_ramdisk_delete(cbe_lun,
scsi_8btou64(buf->lba), scsi_4btoul(buf->length),
(ptrlen->flags & SU_ANCHOR) != 0);
}
ctl_set_success(&io->scsiio);
ctl_config_write_done(io);
}
static int
ctl_backend_ramdisk_scsi_config_write(union ctl_io *io)
{
struct ctl_be_lun *cbe_lun = CTL_BACKEND_LUN(io);
int retval = 0;
switch (io->scsiio.cdb[0]) {
case SYNCHRONIZE_CACHE:
case SYNCHRONIZE_CACHE_16:
/* We have no cache to flush. */
ctl_set_success(&io->scsiio);
ctl_config_write_done(io);
break;
case START_STOP_UNIT: {
struct scsi_start_stop_unit *cdb;
cdb = (struct scsi_start_stop_unit *)io->scsiio.cdb;
if ((cdb->how & SSS_PC_MASK) != 0) {
ctl_set_success(&io->scsiio);
ctl_config_write_done(io);
break;
}
if (cdb->how & SSS_START) {
if (cdb->how & SSS_LOEJ)
ctl_lun_has_media(cbe_lun);
ctl_start_lun(cbe_lun);
} else {
ctl_stop_lun(cbe_lun);
if (cdb->how & SSS_LOEJ)
ctl_lun_ejected(cbe_lun);
}
ctl_set_success(&io->scsiio);
ctl_config_write_done(io);
break;
}
case PREVENT_ALLOW:
ctl_set_success(&io->scsiio);
ctl_config_write_done(io);
break;
case WRITE_SAME_10:
case WRITE_SAME_16:
ctl_backend_ramdisk_ws(io);
break;
case UNMAP:
ctl_backend_ramdisk_unmap(io);
break;
default:
ctl_set_invalid_opcode(&io->scsiio);
ctl_config_write_done(io);
retval = CTL_RETVAL_COMPLETE;
break;
}
return (retval);
}
static void
ctl_backend_ramdisk_wu(union ctl_io *io)
{
struct ctl_be_lun *cbe_lun = CTL_BACKEND_LUN(io);
struct ctl_lba_len_flags *lbalen = ARGS(io);
CTL_IO_ASSERT(io, NVME);
/*
* XXX: Not quite right as reads will return zeroes rather
* than failing.
*/
ctl_backend_ramdisk_delete(cbe_lun, lbalen->lba, lbalen->len, 1);
ctl_nvme_set_success(&io->nvmeio);
ctl_config_write_done(io);
}
static void
ctl_backend_ramdisk_wz(union ctl_io *io)
{
struct ctl_be_lun *cbe_lun = CTL_BACKEND_LUN(io);
struct ctl_be_ramdisk_lun *be_lun = (struct ctl_be_ramdisk_lun *)cbe_lun;
struct ctl_lba_len_flags *lbalen = ARGS(io);
uint8_t *page;
uint64_t lba;
u_int lbaoff, lbas;
CTL_IO_ASSERT(io, NVME);
if ((le32toh(io->nvmeio.cmd.cdw12) & (1U << 25)) != 0) {
ctl_backend_ramdisk_delete(cbe_lun, lbalen->lba, lbalen->len,
0);
ctl_nvme_set_success(&io->nvmeio);
ctl_config_write_done(io);
return;
}
for (lba = lbalen->lba, lbas = lbalen->len; lbas > 0; lba++, lbas--) {
page = ctl_backend_ramdisk_getpage(be_lun,
lba >> cbe_lun->pblockexp, GP_WRITE);
if (page == P_UNMAPPED || page == P_ANCHORED) {
ctl_nvme_set_space_alloc_fail(&io->nvmeio);
ctl_data_submit_done(io);
return;
}
lbaoff = lba & ~(UINT_MAX << cbe_lun->pblockexp);
page += lbaoff * cbe_lun->blocksize;
memset(page, 0, cbe_lun->blocksize);
}
ctl_nvme_set_success(&io->nvmeio);
ctl_config_write_done(io);
}
static void
ctl_backend_ramdisk_dsm(union ctl_io *io)
{
struct ctl_be_lun *cbe_lun = CTL_BACKEND_LUN(io);
struct nvme_dsm_range *r;
uint64_t lba;
uint32_t num_blocks;
u_int i, ranges;
CTL_IO_ASSERT(io, NVME);
ranges = le32toh(io->nvmeio.cmd.cdw10) & 0xff;
r = (struct nvme_dsm_range *)io->nvmeio.kern_data_ptr;
for (i = 0; i < ranges; i++) {
lba = le64toh(r[i].starting_lba);
num_blocks = le32toh(r[i].length);
if ((le32toh(r[i].attributes) & (1U << 2)) != 0)
ctl_backend_ramdisk_delete(cbe_lun, lba, num_blocks, 0);
}
ctl_nvme_set_success(&io->nvmeio);
ctl_config_write_done(io);
}
static int
ctl_backend_ramdisk_nvme_config_write(union ctl_io *io)
{
switch (io->nvmeio.cmd.opc) {
case NVME_OPC_FLUSH:
/* We have no cache to flush. */
ctl_nvme_set_success(&io->nvmeio);
ctl_config_write_done(io);
break;
case NVME_OPC_WRITE_UNCORRECTABLE:
ctl_backend_ramdisk_wu(io);
break;
case NVME_OPC_WRITE_ZEROES:
ctl_backend_ramdisk_wz(io);
break;
case NVME_OPC_DATASET_MANAGEMENT:
ctl_backend_ramdisk_dsm(io);
break;
default:
ctl_nvme_set_invalid_opcode(&io->nvmeio);
ctl_config_write_done(io);
break;
}
return (CTL_RETVAL_COMPLETE);
}
static int
ctl_backend_ramdisk_config_write(union ctl_io *io)
{
switch (io->io_hdr.io_type) {
case CTL_IO_SCSI:
return (ctl_backend_ramdisk_scsi_config_write(io));
case CTL_IO_NVME:
return (ctl_backend_ramdisk_nvme_config_write(io));
default:
__assert_unreachable();
}
}
static uint64_t
ctl_backend_ramdisk_lun_attr(struct ctl_be_lun *cbe_lun, const char *attrname)
{
struct ctl_be_ramdisk_lun *be_lun = (struct ctl_be_ramdisk_lun *)cbe_lun;
uint64_t val;
val = UINT64_MAX;
if (be_lun->cap_bytes == 0)
return (val);
sx_slock(&be_lun->page_lock);