-
Notifications
You must be signed in to change notification settings - Fork 66
/
mhvtl.c
1785 lines (1510 loc) · 45.7 KB
/
mhvtl.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
/*
* linux/kernel/vtl.c
* vvvvvvvvvvvvvvvvvvvvvvv Original vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
* Copyright (C) 1992 Eric Youngdale
* Simulate a host adapter with 2 disks attached. Do a lot of checking
* to make sure that we are not getting blocks mixed up, and PANIC if
* anything out of the ordinary is seen.
* ^^^^^^^^^^^^^^^^^^^^^^^ Original ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
*
* For documentation see http://sg.danny.cz/sg/sdebug26.html
*
* D. Gilbert (dpg) work for Magneto-Optical device test [20010421]
* dpg: work for devfs large number of disks [20010809]
* forked for lk 2.5 series [20011216, 20020101]
* use vmalloc() more inquiry+mode_sense [20020302]
* Patrick Mansfield <patmans@us.ibm.com> max_luns+scsi_level [20021031]
* Mike Anderson <andmike@us.ibm.com> sysfs work [20021118]
* dpg: change style of boot options to "vtl.num_tgts=2" and
* module options to "modprobe vtl num_tgts=2" [20021221]
*
* Mark Harvey 2005-6-1
*
* markh794@gmail.com
* or
* Current employ address: mark.harvey@nutanix.com
*
* Pinched wholesale from scsi_debug.[ch]
*
* Hacked to represent SCSI tape drives & Library.
*
* Registered char driver to handle data to user space daemon.
* Idea is for user space daemons (vtltape & vtllibrary) to emulate
* and process the SCSI SSC/SMC device command set.
*
* I've used it for testing NetBackup - but there is no reason any
* other backup utility could not use it as well.
*
* Modification History:
* 2010-04-18 hstadler - some source code revision in mhvtl_init,
* mhvtl_exit, some return code checking
*
*
*/
#define pr_fmt(fmt) "%s:%s: " fmt, KBUILD_MODNAME, __func__
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/sched.h>
#include <linux/errno.h>
#include <linux/timer.h>
#include <linux/types.h>
#include <linux/string.h>
#include <linux/fs.h>
#include <linux/init.h>
#include <linux/moduleparam.h>
#include <linux/slab.h>
#include <asm/uaccess.h>
#include <linux/blkdev.h>
#include <linux/cdev.h>
#include <scsi/scsi_host.h>
#include <scsi/scsi_tcq.h>
#include <scsi/scsicam.h>
#include <linux/stat.h>
#ifndef LINUX_VERSION_CODE
#include <linux/version.h>
#endif
#if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,39)
#include <linux/smp_lock.h>
#endif
#ifndef _SCSI_H
#define _SCSI_H
#include <scsi/scsi_cmnd.h>
#include <scsi/scsi_device.h>
#include <scsi/scsi_eh.h>
#include <scsi/scsi_tcq.h>
#include <scsi/scsi.h>
struct Scsi_Host;
struct scsi_cmnd;
struct scsi_device;
struct scsi_target;
struct scatterlist;
#endif /* _SCSI_H */
#include "vtl_common.h"
#include "backport.h"
#if defined(HAVE_GENHD)
#include <linux/genhd.h>
#endif
#include <scsi/scsi_driver.h>
#include <scsi/scsi_ioctl.h>
/* version of scsi_debug I started from
#define VTL_VERSION "1.75"
*/
#ifndef MHVTL_VERSION
#define MHVTL_VERSION "0.18.32"
#endif
static const char *mhvtl_version_date = "20230224-0";
static const char mhvtl_driver_name[] = "mhvtl";
/* Additional Sense Code (ASC) used */
#define INVALID_FIELD_IN_CDB 0x24
#define VTL_TAGGED_QUEUING 0 /* 0 | MSG_SIMPLE_TAG | MSG_ORDERED_TAG */
#ifndef SCSI_MAX_SG_CHAIN_SEGMENTS
#define SCSI_MAX_SG_CHAIN_SEGMENTS SG_ALL
#endif
#define TIMEOUT_FOR_USER_DAEMON 50000
/* Default values for driver parameters */
#define DEF_NUM_HOST 1
#define DEF_NUM_TGTS 0
#define DEF_MAX_LUNS 32
#define DEF_OPTS 1 /* Default to verbose logging */
/* bit mask values for mhvtl_opts */
#define VTL_OPT_NOISE 3
#ifndef MHVTL_DEBUG
#define MHVTL_DBG_PRT_CDB(lvl, s...)
#else
#define MHVTL_DBG_PRT_CDB(lvl, sn, s, len) \
{ \
if ((mhvtl_opts & VTL_OPT_NOISE) >= (lvl)) { \
pr_info("(%llu) %d bytes", (long long unsigned)sn, len); \
switch (len) { \
case 6: \
pr_cont(" %02x %02x %02x %02x %02x %02x", \
s[0], s[1], s[2], s[3], \
s[4], s[5]); \
break; \
case 8: \
pr_cont(" %02x %02x %02x %02x %02x %02x %02x %02x", \
s[0], s[1], s[2], s[3], \
s[4], s[5], s[6], s[7]); \
break; \
case 10: \
pr_cont(" %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x", \
s[0], s[1], s[2], s[3], \
s[4], s[5], s[6], s[7], \
s[8], s[9]); \
break; \
case 12: \
pr_cont(" %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x", \
s[0], s[1], s[2], s[3], \
s[4], s[5], s[6], s[7], \
s[8], s[9], s[10], s[11]); \
break; \
case 16: \
default: \
pr_cont(" %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x", \
s[0], s[1], s[2], s[3], \
s[4], s[5], s[6], s[7], \
s[8], s[9], s[10], s[11], \
s[12], s[13], s[14], s[15]); \
break; \
} \
} \
}
#endif /* MHVTL_DEBUG */
/* If REPORT LUNS has luns >= 256 it can choose "flat space" (value 1)
* or "peripheral device" addressing (value 0) */
#define SAM2_LUN_ADDRESS_METHOD 0
/* Major number assigned to vtl driver => 0 means to ask for one */
static int mhvtl_major = 0;
#define DEF_MAX_MINOR_NO 1024 /* Max number of minor nos. this driver will handle */
#define VTL_CANQUEUE 1 /* needs to be >= 1 */
#define VTL_MAX_CMD_LEN 16
static struct kmem_cache *dsp;
static struct kmem_cache *sgp;
static int mhvtl_add_host = DEF_NUM_HOST;
static int mhvtl_max_luns = DEF_MAX_LUNS;
static int mhvtl_num_tgts = DEF_NUM_TGTS; /* targets per host */
static int mhvtl_opts = DEF_OPTS;
static int mhvtl_cmnd_count = 0;
static unsigned long long serial_number;
struct mhvtl_lu_info {
struct list_head lu_sibling;
unsigned char sense_buff[SENSE_BUF_SIZE]; /* weak nexus */
unsigned int channel;
unsigned int target;
unsigned int lun;
unsigned int minor;
struct mhvtl_hba_info *mhvtl_hba;
struct scsi_device *sdev;
char reset;
struct list_head cmd_list; /* list of outstanding cmds for this lu */
spinlock_t cmd_list_lock;
};
static struct mhvtl_lu_info *devp[DEF_MAX_MINOR_NO];
struct mhvtl_hba_info {
struct list_head hba_sibling; /* List of adapters */
struct list_head lu_list; /* List of lu */
struct Scsi_Host *shost;
struct device dev;
};
#define to_mhvtl_hba(d) \
container_of(d, struct mhvtl_hba_info, dev)
static LIST_HEAD(mhvtl_hba_list); /* dll of adapters */
#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 39)
static spinlock_t mhvtl_hba_list_lock = __SPIN_LOCK_UNLOCKED(mhvtl_hba_list_lock);
#else
static spinlock_t mhvtl_hba_list_lock = SPIN_LOCK_UNLOCKED;
#endif
typedef void (*done_funct_t) (struct scsi_cmnd *);
/* mhvtl_queued_cmd-> state */
enum cmd_state {
CMD_STATE_FREE = 0,
CMD_STATE_QUEUED,
CMD_STATE_IN_USE,
};
struct mhvtl_queued_cmd {
int state;
struct timer_list cmnd_timer;
done_funct_t done_funct;
struct scsi_cmnd *a_cmnd;
int scsi_result;
struct mhvtl_header op_header;
struct list_head queued_sibling;
unsigned long long serial_number;
};
static int num_aborts = 0;
static int num_dev_resets = 0;
static int num_bus_resets = 0;
static int num_host_resets = 0;
static int mhvtl_driver_probe(struct device *);
static int mhvtl_driver_remove(struct device *);
static struct bus_type mhvtl_pseudo_lld_bus;
static struct device_driver mhvtl_driverfs_driver = {
.name = mhvtl_driver_name,
.bus = &mhvtl_pseudo_lld_bus,
.probe = mhvtl_driver_probe,
.remove = mhvtl_driver_remove,
};
/* function declarations */
static int mhvtl_resp_report_luns(struct scsi_cmnd *SCpnt, struct mhvtl_lu_info *lu);
static int mhvtl_fill_from_user_buffer(struct scsi_cmnd *scp, char __user *arr,
int arr_len);
static int mhvtl_fill_from_dev_buffer(struct scsi_cmnd *scp, unsigned char *arr,
int arr_len);
#if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 15, 0)
static void mhvtl_timer_intr_handler(struct timer_list *indx);
#else
static void mhvtl_timer_intr_handler(unsigned long indx);
#endif
static struct mhvtl_lu_info *devInfoReg(struct scsi_device *sdp);
static void mk_sense_buffer(struct mhvtl_lu_info *lu, int key, int asc, int asq);
static void mhvtl_stop_all_queued(void);
static int do_create_driverfs_files(void);
static void do_remove_driverfs_files(void);
static int mhvtl_add_adapter(void);
static void mhvtl_remove_adapter(void);
static int mhvtl_slave_alloc(struct scsi_device *);
static int mhvtl_slave_configure(struct scsi_device *);
static void mhvtl_slave_destroy(struct scsi_device *);
#if LINUX_VERSION_CODE != KERNEL_VERSION(2, 6, 9)
#if (LINUX_VERSION_CODE > KERNEL_VERSION(3, 19, 0) || LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 33))
static int mhvtl_change_queue_depth(struct scsi_device *sdev, int qdepth);
#else
static int mhvtl_change_queue_depth(struct scsi_device *sdev, int qdepth,
int reason);
#endif
#endif
#ifdef QUEUECOMMAND_LCK_ONE_ARG
static int mhvtl_queuecommand_lck(struct scsi_cmnd *);
#else
static int mhvtl_queuecommand_lck(struct scsi_cmnd *, done_funct_t done);
#endif
#if LINUX_VERSION_CODE >= KERNEL_VERSION(5, 0, 0)
static int mhvtl_b_ioctl(struct scsi_device *, unsigned int, void __user *);
#else
static int mhvtl_b_ioctl(struct scsi_device *, int, void __user *);
#endif
static long mhvtl_c_ioctl(struct file *, unsigned int, unsigned long);
static int mhvtl_c_ioctl_bkl(struct inode *, struct file *, unsigned int, unsigned long);
static int mhvtl_abort(struct scsi_cmnd *);
static int mhvtl_bus_reset(struct scsi_cmnd *);
static int mhvtl_device_reset(struct scsi_cmnd *);
static int mhvtl_host_reset(struct scsi_cmnd *);
static const char * mhvtl_info(struct Scsi_Host *);
static int mhvtl_open(struct inode *, struct file *);
static int mhvtl_release(struct inode *, struct file *);
#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 37)
static DEF_SCSI_QCMD(mhvtl_queuecommand)
#endif
static struct device mhvtl_pseudo_primary;
#ifdef DEFINE_CONST_STRUCT_SCSI_HOST_TEMPLATE
static const struct scsi_host_template mhvtl_driver_template = {
#else
static struct scsi_host_template mhvtl_driver_template = {
#endif
.name = "VTL",
.info = mhvtl_info,
.slave_alloc = mhvtl_slave_alloc,
.slave_configure = mhvtl_slave_configure,
.slave_destroy = mhvtl_slave_destroy,
.ioctl = mhvtl_b_ioctl,
#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 37)
.queuecommand = mhvtl_queuecommand,
#else
.queuecommand = mhvtl_queuecommand_lck,
#endif
#if LINUX_VERSION_CODE != KERNEL_VERSION(2, 6, 9)
.change_queue_depth = mhvtl_change_queue_depth,
#if LINUX_VERSION_CODE < KERNEL_VERSION(3, 19, 0)
.ordered_tag = 1,
#endif
#endif
.eh_abort_handler = mhvtl_abort,
.eh_bus_reset_handler = mhvtl_bus_reset,
.eh_device_reset_handler = mhvtl_device_reset,
.eh_host_reset_handler = mhvtl_host_reset,
.can_queue = VTL_CANQUEUE,
.this_id = -1,
.proc_name = mhvtl_driver_name,
.sg_tablesize = SCSI_MAX_SG_CHAIN_SEGMENTS,
.cmd_per_lun = 1,
.max_sectors = 4096,
#if LINUX_VERSION_CODE < KERNEL_VERSION(5, 0, 0)
.use_clustering = ENABLE_CLUSTERING,
#else
.dma_boundary = PAGE_SIZE - 1,
#endif
.module = THIS_MODULE,
};
static const struct file_operations mhvtl_fops = {
.owner = THIS_MODULE,
#if defined(HAVE_UNLOCKED_IOCTL)
.unlocked_ioctl = mhvtl_c_ioctl,
#else
.ioctl = mhvtl_c_ioctl_bkl,
#endif
.open = mhvtl_open,
.release = mhvtl_release,
};
#if LINUX_VERSION_CODE > KERNEL_VERSION(4, 17, 0)
#include "fetch50.c"
#elif LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 26)
#include "fetch27.c"
#elif LINUX_VERSION_CODE == KERNEL_VERSION(2, 6, 26)
#include "fetch26.c"
#elif LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 23)
#include "fetch24.c"
#else
#include "fetch.c"
#endif
/**********************************************************************
* misc functions to handle queuing SCSI commands
**********************************************************************/
/*
* mhvtl_schedule_resp() - handle SCSI commands that are processed from the
* queuecommand() interface. i.e. No callback to done()
* outside the queuecommand() function.
*
* Any SCSI command handled directly by the kernel driver
* will use this.
*/
static int mhvtl_schedule_resp(struct scsi_cmnd *SCpnt,
struct mhvtl_lu_info *lu,
done_funct_t done, int scsi_result)
{
if ((VTL_OPT_NOISE & mhvtl_opts) && SCpnt) {
if (scsi_result) {
struct scsi_device *sdp = SCpnt->device;
pr_info(" <%u %u %u %llu> non-zero result=0x%x\n",
sdp->host->host_no,
sdp->channel, sdp->id,
(unsigned long long)sdp->lun, scsi_result);
}
}
if (SCpnt && lu) {
/* simulate autosense by this driver */
if (SAM_STAT_CHECK_CONDITION == (scsi_result & 0xff))
memcpy(SCpnt->sense_buffer, lu->sense_buff,
(SCSI_SENSE_BUFFERSIZE > SENSE_BUF_SIZE) ?
SENSE_BUF_SIZE : SCSI_SENSE_BUFFERSIZE);
}
if (SCpnt)
SCpnt->result = scsi_result;
if (done)
done(SCpnt);
return 0;
}
/**********************************************************************
* SCSI data handling routines
**********************************************************************/
static int mhvtl_resp_write_to_user(struct scsi_cmnd *SCpnt,
void __user *up, int count)
{
int fetched;
fetched = mhvtl_fetch_to_dev_buffer(SCpnt, up, count);
if (fetched < count) {
pr_err(" cdb indicated=%d, IO sent=%d bytes\n",
count, fetched);
return -EIO;
}
return 0;
}
static void mhvtl_debug_queued_list(struct mhvtl_lu_info *lu)
{
unsigned long iflags = 0;
struct mhvtl_queued_cmd *sqcp, *n;
int k = 0;
spin_lock_irqsave(&lu->cmd_list_lock, iflags);
list_for_each_entry_safe(sqcp, n, &lu->cmd_list, queued_sibling) {
if (sqcp->state) {
if (sqcp->a_cmnd) {
pr_info("%d entry in use "
"SCpnt: %p, SCSI result: %d, done: %p, "
"Serial No: %lld\n",
k, sqcp->a_cmnd, sqcp->scsi_result,
sqcp->done_funct,
sqcp->serial_number);
} else {
pr_info("%d entry in use "
"SCpnt: %p, SCSI result: %d, done: %p\n",
k, sqcp->a_cmnd, sqcp->scsi_result,
sqcp->done_funct);
}
} else
pr_info("entry free %d\n", k);
k++;
}
spin_unlock_irqrestore(&lu->cmd_list_lock, iflags);
pr_info("found %d entr%s\n", k, (k == 1) ? "y" : "ies");
}
static struct mhvtl_hba_info *mhvtl_get_hba_entry(void)
{
struct mhvtl_hba_info *mhvtl_hba;
spin_lock(&mhvtl_hba_list_lock);
if (list_empty(&mhvtl_hba_list))
mhvtl_hba = NULL;
else
mhvtl_hba = list_entry(mhvtl_hba_list.prev,
struct mhvtl_hba_info, hba_sibling);
spin_unlock(&mhvtl_hba_list_lock);
return mhvtl_hba;
}
static void mhvtl_dump_queued_list(void)
{
struct mhvtl_lu_info *lu, *__lu;
struct mhvtl_hba_info *mhvtl_hba;
mhvtl_hba = mhvtl_get_hba_entry();
if (!mhvtl_hba)
return;
/* Now that the work list is split per lu, we have to check each
* lu to see if we can find the serial number in question
*/
list_for_each_entry_safe(lu, __lu, &mhvtl_hba->lu_list, lu_sibling) {
pr_debug("Channel %d, ID %d, LUN %d\n", lu->channel, lu->target, lu->lun);
mhvtl_debug_queued_list(lu);
}
}
/*********************************************************
* Generic interface to queue SCSI cmd to userspace daemon
*********************************************************/
/*
* mhvtl_q_cmd returns success if we successfully added the SCSI
* cmd to the queued_list
*
* - Set state to indicate that the SCSI cmnd is ready for processing.
*/
static int mhvtl_q_cmd(struct scsi_cmnd *scp,
done_funct_t done,
struct mhvtl_lu_info *lu)
{
unsigned long iflags = 0;
struct mhvtl_header *vheadp;
struct mhvtl_queued_cmd *sqcp;
sqcp = kmalloc(sizeof(*sqcp), GFP_ATOMIC);
if (!sqcp) {
pr_err("%s: %s kmalloc failed\n", mhvtl_driver_name, __func__);
return 1;
}
#if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 15, 0)
timer_setup(&sqcp->cmnd_timer, mhvtl_timer_intr_handler, 0);
#else
init_timer(&sqcp->cmnd_timer);
sqcp->cmnd_timer.function = mhvtl_timer_intr_handler;
#endif
sqcp->a_cmnd = scp;
sqcp->scsi_result = 0;
sqcp->done_funct = done;
sqcp->cmnd_timer.expires = jiffies + TIMEOUT_FOR_USER_DAEMON;
add_timer(&sqcp->cmnd_timer);
vheadp = &sqcp->op_header;
vheadp->serialNo = serial_number;
sqcp->serial_number = serial_number;
/* Make sure serial_number can't wrap to '0' */
if (unlikely(serial_number < 2))
serial_number = 2;
serial_number++;
memcpy(vheadp->cdb, scp->cmnd, scp->cmd_len);
/* Set flag.
* Next ioctl() poll by user-daemon will check this state.
*/
sqcp->state = CMD_STATE_QUEUED;
spin_lock_irqsave(&lu->cmd_list_lock, iflags);
list_add_tail(&sqcp->queued_sibling, &lu->cmd_list);
spin_unlock_irqrestore(&lu->cmd_list_lock, iflags);
if ((mhvtl_opts & VTL_OPT_NOISE) >= 2)
mhvtl_dump_queued_list();
return 0;
}
/**********************************************************************
* Main interface from SCSI mid level
**********************************************************************/
static int _mhvtl_queuecommand_lck(struct scsi_cmnd *SCpnt, done_funct_t done)
{
unsigned char *cmd = (unsigned char *) SCpnt->cmnd;
int errsts = 0;
struct mhvtl_lu_info *lu = NULL;
if (done == NULL)
return 0; /* assume mid level reprocessing command */
if (cmd)
MHVTL_DBG_PRT_CDB(1, serial_number, cmd, SCpnt->cmd_len);
if (SCpnt->device->id == mhvtl_driver_template.this_id) {
pr_err("%s: initiator's id used as target!\n", mhvtl_driver_name);
return mhvtl_schedule_resp(SCpnt, NULL, done, DID_NO_CONNECT << 16);
}
if (SCpnt->device->lun >= mhvtl_max_luns) {
pr_err("%s: %s max luns exceeded\n", mhvtl_driver_name, __func__);
return mhvtl_schedule_resp(SCpnt, NULL, done, DID_NO_CONNECT << 16);
}
lu = devInfoReg(SCpnt->device);
if (NULL == lu) {
pr_err("%s: %s could not find lu\n", mhvtl_driver_name, __func__);
return mhvtl_schedule_resp(SCpnt, NULL, done, DID_NO_CONNECT << 16);
}
switch (*cmd) {
case REPORT_LUNS: /* mandatory, ignore unit attention */
errsts = mhvtl_resp_report_luns(SCpnt, lu);
break;
/* All commands down the list are handled by a user-space daemon */
default: /* Pass on to user space daemon to process */
errsts = mhvtl_q_cmd(SCpnt, done, lu);
if (!errsts)
return 0;
break;
}
return mhvtl_schedule_resp(SCpnt, lu, done, errsts);
}
#ifdef QUEUECOMMAND_LCK_ONE_ARG
static int mhvtl_queuecommand_lck(struct scsi_cmnd *SCpnt)
{
void (*done)(struct scsi_cmnd *) = scsi_done;
return _mhvtl_queuecommand_lck(SCpnt, done);
}
#else
static int mhvtl_queuecommand_lck(struct scsi_cmnd *SCpnt, done_funct_t done)
{
return _mhvtl_queuecommand_lck(SCpnt, done);
}
#endif
/* FIXME: I don't know what version this inline routine was introduced */
#if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,9)
/* RedHat 4 appears to define 'scsi_get_tag_type' but doesn't understand
* change_queue_depth
* Disabling for kernel 2.6.9 (RedHat AS 4)
*/
#define MSG_SIMPLE_TAG 0x20
#define MSG_ORDERED_TAG 0x22
/**
* scsi_get_tag_type - get the type of tag the device supports
* @sdev: the scsi device
*
* Notes:
* If the drive only supports simple tags, returns MSG_SIMPLE_TAG
* if it supports all tag types, returns MSG_ORDERED_TAG.
*/
static inline int scsi_get_tag_type(struct scsi_device *sdev)
{
if (!sdev->tagged_supported)
return 0;
if (sdev->ordered_tags)
return MSG_ORDERED_TAG;
if (sdev->simple_tags)
return MSG_SIMPLE_TAG;
return 0;
}
#endif
/* RedHat 4 appears to define 'scsi_get_tag_type' but doesn't understand
* change_queue_depth
* Disabling for kernel 2.6.9 (RedHat AS 4)
*/
#if LINUX_VERSION_CODE != KERNEL_VERSION(2,6,9)
#if (LINUX_VERSION_CODE > KERNEL_VERSION(3,19,0) || LINUX_VERSION_CODE < KERNEL_VERSION(2,6,33))
static int mhvtl_change_queue_depth(struct scsi_device *sdev, int qdepth)
#else
static int mhvtl_change_queue_depth(struct scsi_device *sdev, int qdepth,
int reason)
#endif
{
pr_info("mhvtl %s(%d)\n", __func__, qdepth);
if (qdepth < 1)
qdepth = 1;
else if (qdepth > sdev->host->cmd_per_lun)
qdepth = sdev->host->cmd_per_lun;
#if LINUX_VERSION_CODE < KERNEL_VERSION(3,19,0)
scsi_adjust_queue_depth(sdev, scsi_get_tag_type(sdev), qdepth);
#else
scsi_change_queue_depth(sdev, qdepth);
#endif
return sdev->queue_depth;
}
#endif
static struct mhvtl_queued_cmd *lookup_sqcp(struct mhvtl_lu_info *lu,
unsigned long serialNo)
{
unsigned long iflags;
struct mhvtl_queued_cmd *sqcp;
spin_lock_irqsave(&lu->cmd_list_lock, iflags);
list_for_each_entry(sqcp, &lu->cmd_list, queued_sibling) {
if (sqcp->state && (sqcp->serial_number == serialNo)) {
spin_unlock_irqrestore(&lu->cmd_list_lock, iflags);
return sqcp;
}
}
spin_unlock_irqrestore(&lu->cmd_list_lock, iflags);
return NULL;
}
/*
* Block device ioctl
*/
#if LINUX_VERSION_CODE >= KERNEL_VERSION(5, 0, 0)
static int mhvtl_b_ioctl(struct scsi_device *sdp, unsigned int cmd, void __user *arg)
#else
static int mhvtl_b_ioctl(struct scsi_device *sdp, int cmd, void __user *arg)
#endif
{
pr_debug("ioctl: cmd=0x%x\n", cmd);
return -ENOTTY;
}
#define MHVTL_RLUN_ARR_SZ 128
static int mhvtl_resp_report_luns(struct scsi_cmnd *scp, struct mhvtl_lu_info *lu)
{
unsigned int alloc_len;
int lun_cnt, i, upper;
unsigned char *cmd = (unsigned char *)scp->cmnd;
int select_report = (int)cmd[2];
struct scsi_lun *one_lun;
unsigned char arr[MHVTL_RLUN_ARR_SZ];
alloc_len = cmd[9] + (cmd[8] << 8) + (cmd[7] << 16) + (cmd[6] << 24);
if ((alloc_len < 16) || (select_report > 2)) {
mk_sense_buffer(lu, ILLEGAL_REQUEST, INVALID_FIELD_IN_CDB,0);
return SAM_STAT_CHECK_CONDITION;
}
/* can produce response with up to 16k luns (lun 0 to lun 16383) */
memset(arr, 0, MHVTL_RLUN_ARR_SZ);
lun_cnt = mhvtl_max_luns;
arr[2] = ((sizeof(struct scsi_lun) * lun_cnt) >> 8) & 0xff;
arr[3] = (sizeof(struct scsi_lun) * lun_cnt) & 0xff;
lun_cnt = min((int)((MHVTL_RLUN_ARR_SZ - 8) /
sizeof(struct scsi_lun)), lun_cnt);
one_lun = (struct scsi_lun *) &arr[8];
for (i = 0; i < lun_cnt; i++) {
upper = (i >> 8) & 0x3f;
if (upper)
one_lun[i].scsi_lun[0] =
(upper | (SAM2_LUN_ADDRESS_METHOD << 6));
one_lun[i].scsi_lun[1] = i & 0xff;
}
return mhvtl_fill_from_dev_buffer(scp, arr, min((int)alloc_len, MHVTL_RLUN_ARR_SZ));
}
static void __mhvtl_remove_sqcp(struct mhvtl_queued_cmd *sqcp)
{
list_del(&sqcp->queued_sibling);
kfree(sqcp);
}
static void mhvtl_remove_sqcp(struct mhvtl_lu_info *lu, struct mhvtl_queued_cmd *sqcp)
{
unsigned long iflags;
spin_lock_irqsave(&lu->cmd_list_lock, iflags);
__mhvtl_remove_sqcp(sqcp);
spin_unlock_irqrestore(&lu->cmd_list_lock, iflags);
}
/* When timer goes off this function is called. */
#if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 15, 0)
static void mhvtl_timer_intr_handler(struct timer_list *t)
{
struct mhvtl_queued_cmd *sqcp = from_timer(sqcp, t, cmnd_timer);
unsigned long long indx = sqcp->serial_number;
#else
static void mhvtl_timer_intr_handler(unsigned long indx)
{
struct mhvtl_queued_cmd *sqcp = NULL;
#endif
struct mhvtl_lu_info *lu;
struct mhvtl_hba_info *mhvtl_hba;
mhvtl_hba = mhvtl_get_hba_entry();
if (!mhvtl_hba)
return;
/* Now that the work list is split per lu, we have to check each
* lu to see if we can find the serial number in question
*/
list_for_each_entry(lu, &mhvtl_hba->lu_list, lu_sibling) {
sqcp = lookup_sqcp(lu, indx);
if (sqcp)
break;
}
if (!sqcp) {
pr_err("%s: %s: Unexpected interrupt, indx %ld\n",
mhvtl_driver_name, __func__, (unsigned long)indx);
return;
}
sqcp->state = CMD_STATE_FREE;
if (sqcp->done_funct) {
sqcp->a_cmnd->result = sqcp->scsi_result;
sqcp->done_funct(sqcp->a_cmnd); /* callback to mid level */
}
sqcp->done_funct = NULL;
mhvtl_remove_sqcp(lu, sqcp);
}
static int mhvtl_slave_alloc(struct scsi_device *sdp)
{
struct mhvtl_hba_info *mhvtl_hba;
struct mhvtl_lu_info *lu = (struct mhvtl_lu_info *)sdp->hostdata;
pr_debug("slave_alloc <%u %u %u %llu>\n",
sdp->host->host_no, sdp->channel, sdp->id,
(unsigned long long)sdp->lun);
if (lu)
return 0;
mhvtl_hba = *(struct mhvtl_hba_info **) sdp->host->hostdata;
if (!mhvtl_hba) {
pr_err("%s: Host info NULL\n", mhvtl_driver_name);
return -1;
}
list_for_each_entry(lu, &mhvtl_hba->lu_list, lu_sibling) {
if ((lu->channel == sdp->channel) &&
(lu->target == sdp->id) &&
(lu->lun == sdp->lun)) {
pr_debug("line %d found matching lu\n", __LINE__);
return 0;
}
}
return -1;
}
static int mhvtl_slave_configure(struct scsi_device *sdp)
{
struct mhvtl_lu_info *lu;
pr_debug("slave_configure <%u %u %u %llu>\n",
sdp->host->host_no, sdp->channel, sdp->id,
(unsigned long long)sdp->lun);
if (sdp->host->max_cmd_len != VTL_MAX_CMD_LEN)
sdp->host->max_cmd_len = VTL_MAX_CMD_LEN;
lu = devInfoReg(sdp);
sdp->hostdata = lu;
if (sdp->host->cmd_per_lun)
#if LINUX_VERSION_CODE < KERNEL_VERSION(3,19,0)
scsi_adjust_queue_depth(sdp, VTL_TAGGED_QUEUING,
sdp->host->cmd_per_lun);
#else
scsi_change_queue_depth(sdp, sdp->host->cmd_per_lun);
#endif
return 0;
}
static void mhvtl_slave_destroy(struct scsi_device *sdp)
{
struct mhvtl_lu_info *lu = (struct mhvtl_lu_info *)sdp->hostdata;
pr_notice("slave_destroy <%u %u %u %llu>\n",
sdp->host->host_no, sdp->channel, sdp->id,
(unsigned long long)sdp->lun);
if (lu) {
pr_debug("Removing lu structure, minor %d\n", lu->minor);
/* make this slot avaliable for re-use */
devp[lu->minor] = NULL;
kfree(sdp->hostdata);
sdp->hostdata = NULL;
}
}
static struct mhvtl_lu_info *devInfoReg(struct scsi_device *sdp)
{
struct mhvtl_hba_info *mhvtl_hba;
struct mhvtl_lu_info *lu = (struct mhvtl_lu_info *)sdp->hostdata;
if (lu)
return lu;
mhvtl_hba = *(struct mhvtl_hba_info **) sdp->host->hostdata;
if (!mhvtl_hba) {
pr_err("%s: %s Host info NULL\n", mhvtl_driver_name, __func__);
return NULL;
}
list_for_each_entry(lu, &mhvtl_hba->lu_list, lu_sibling) {
if ((lu->channel == sdp->channel) &&
(lu->target == sdp->id) &&
(lu->lun == sdp->lun))
return lu;
}
return NULL;
}
static void mk_sense_buffer(struct mhvtl_lu_info *lu, int key, int asc, int asq)
{
unsigned char *sbuff;
sbuff = lu->sense_buff;
memset(sbuff, 0, SENSE_BUF_SIZE);
sbuff[0] = 0x70; /* fixed, current */
sbuff[2] = key;
sbuff[7] = 0xa; /* implies 18 byte sense buffer */
sbuff[12] = asc;
sbuff[13] = asq;
pr_notice(" [key,asc,ascq]: [0x%x,0x%x,0x%x]\n", key, asc, asq);
}
static int mhvtl_device_reset(struct scsi_cmnd *SCpnt)
{
struct mhvtl_lu_info *lu;
pr_notice("Device reset called\n");
++num_dev_resets;
if (SCpnt) {
lu = devInfoReg(SCpnt->device);
if (lu)
lu->reset = 1;
}
return SUCCESS;
}
static int mhvtl_bus_reset(struct scsi_cmnd *SCpnt)
{
struct mhvtl_hba_info *mhvtl_hba;
struct mhvtl_lu_info *lu;
struct scsi_device *sdp;
struct Scsi_Host *hp;
pr_notice("Bus reset called\n");
++num_bus_resets;
if (SCpnt && ((sdp = SCpnt->device)) && ((hp = sdp->host))) {
mhvtl_hba = *(struct mhvtl_hba_info **) hp->hostdata;
if (mhvtl_hba) {
list_for_each_entry(lu, &mhvtl_hba->lu_list,
lu_sibling)
lu->reset = 1;
}
}
return SUCCESS;
}
static int mhvtl_host_reset(struct scsi_cmnd *SCpnt)
{
struct mhvtl_hba_info *mhvtl_hba;
struct mhvtl_lu_info *lu;
pr_notice("Host reset called\n");
++num_host_resets;
spin_lock(&mhvtl_hba_list_lock);
list_for_each_entry(mhvtl_hba, &mhvtl_hba_list, hba_sibling) {
list_for_each_entry(lu, &mhvtl_hba->lu_list, lu_sibling)
lu->reset = 1;
}
spin_unlock(&mhvtl_hba_list_lock);
mhvtl_stop_all_queued();
return SUCCESS;
}
/* Returns 1 if found 'cmnd' and deleted its timer. else returns 0 */
static int mhvtl_stop_queued_cmnd(struct scsi_cmnd *SCpnt)
{
int found = 0;
unsigned long iflags;
struct mhvtl_queued_cmd *sqcp, *n;
struct mhvtl_lu_info *lu;
lu = devInfoReg(SCpnt->device);
spin_lock_irqsave(&lu->cmd_list_lock, iflags);
list_for_each_entry_safe(sqcp, n, &lu->cmd_list, queued_sibling) {
if (sqcp->state && (SCpnt == sqcp->a_cmnd)) {
del_timer_sync(&sqcp->cmnd_timer);
sqcp->state = CMD_STATE_FREE;
sqcp->a_cmnd = NULL;
found = 1;
__mhvtl_remove_sqcp(sqcp);
break;
}
}
spin_unlock_irqrestore(&lu->cmd_list_lock, iflags);