-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathsg_pt_freebsd.c
3173 lines (2936 loc) · 101 KB
/
sg_pt_freebsd.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
/*
* Copyright (c) 2005-2023 Douglas Gilbert.
* All rights reserved.
* Use of this source code is governed by a BSD-style
* license that can be found in the BSD_LICENSE file.
*
* SPDX-License-Identifier: BSD-2-Clause
*/
/* sg_pt_freebsd version 1.51 20231124 */
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <stdbool.h>
#include <string.h>
#include <sys/types.h>
#include <dirent.h>
#include <limits.h>
#include <libgen.h> /* for basename */
#include <fcntl.h>
#include <errno.h>
#define __STDC_FORMAT_MACROS 1
#include <inttypes.h> /* from PRIx macros */
#include <err.h>
#include <camlib.h>
#include <cam/scsi/scsi_message.h>
// #include <sys/ata.h>
#include <sys/stat.h>
#include <unistd.h>
#include <fcntl.h>
#include <glob.h>
#include <fcntl.h>
#include <stddef.h>
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "sg_pt.h"
#include "sg_lib.h"
#include "sg_unaligned.h"
#include "sg_nvme.h"
#include "sg_snt.h"
#include "sg_pr2serr.h"
#if (HAVE_NVME && (! IGNORE_NVME))
#include "freebsd_nvme_ioctl.h"
#else
#define NVME_CTRLR_PREFIX "/dev/nvme"
#define NVME_NS_PREFIX "ns"
#endif
#define SG_NVME_NVD_PREFIX "/dev/nvd" /* >= FreeBSD 9.2 */
#define SG_NVME_NDA_PREFIX "/dev/nda" /* >= FreeBSD 12.0, CAM compatible */
#define FREEBSD_MAXDEV 64
#define FREEBSD_FDOFFSET 16;
#if __FreeBSD_version > 500000
#define CAM_ERROR_PRINT(a, b, c, d, e) cam_error_print(a, b, c, d, e);
#else
#define CAM_ERROR_PRINT(a, b, c, d, e)
#endif
struct freebsd_dev_channel { /* one instance per open file descriptor */
bool is_nvme_dev; /* true if NVMe device attached, else SCSI */
bool is_cam_nvme; /* NVMe via /dev/nda<n> or /dev/pass<n> devices */
bool is_pass; /* CAM passthrough device (i.e. 'pass<n>') */
int unitnum; /* the SCSI unit number, NVMe controller id? */
uint32_t nsid;
// uint32_t nv_ctrlid; /* unitnum seems to have this role */
int nvme_fd_ns; // for non-CAM NVMe, use -1 to indicate not provided
int nvme_fd_ctrl; // open("/dev/nvme<n>") if needed */
char* devname; // from cam_get_device() or ioctl(NVME_GET_NSID)
struct cam_device* cam_dev;
uint8_t * nvme_id_ctlp;
uint8_t * free_nvme_id_ctlp;
struct sg_snt_dev_state_t dev_stat; // owner
};
// Private table of open devices: guaranteed zero on startup since
// part of static data.
static struct freebsd_dev_channel *devicetable[FREEBSD_MAXDEV];
#define DEF_TIMEOUT 60000 /* 60,000 milliseconds (60 seconds) */
struct sg_pt_freebsd_scsi { /* context of one SCSI/NVME command (pt object) */
union ccb *ccb;
uint8_t * cdb;
int cdb_len;
uint8_t * sense;
int sense_len;
uint8_t * dxferp;
int dxfer_len;
int dxfer_dir; /* CAM_DIR_NONE, _IN, _OUT and _BOTH */
uint8_t * dxferip;
uint8_t * dxferop;
uint8_t * mdxferp;
uint32_t dxfer_ilen;
uint32_t dxfer_olen;
uint32_t mdxfer_len;
uint32_t nvme_result; // cdw0 from completion
uint16_t nvme_status; // from completion: ((sct << 8) | sc)
uint8_t cq_dw0_3[16];
int timeout_ms;
int scsi_status;
int resid;
int sense_resid;
int in_err;
int os_err;
int transport_err;
int dev_han; // should be >= FREEBSD_FDOFFSET then
// (dev_han - FREEBSD_FDOFFSET) is the
// index into devicetable[]
bool mdxfer_out;
bool is_nvme_dev; /* copied from owning mchanp */
bool nvme_our_snt; /* true: our SNTL; false: received NVMe command */
struct freebsd_dev_channel * mchanp; /* associated device info */
};
struct sg_pt_base {
struct sg_pt_freebsd_scsi impl;
};
// static const uint32_t broadcast_nsid = SG_NVME_BROADCAST_NSID;
#if (HAVE_NVME && (! IGNORE_NVME))
static int sg_do_nvme_pt(struct sg_pt_freebsd_scsi * ptp, int fd,
bool is_admin, int timeout_secs, int vb);
#endif
static struct freebsd_dev_channel *
get_fdc_p(struct sg_pt_freebsd_scsi * ptp)
{
int han = ptp->dev_han - FREEBSD_FDOFFSET;
if ((han < 0) || (han >= FREEBSD_MAXDEV))
return NULL;
return devicetable[han];
}
static const struct freebsd_dev_channel *
get_fdc_cp(const struct sg_pt_freebsd_scsi * ptp)
{
int han = ptp->dev_han - FREEBSD_FDOFFSET;
if ((han < 0) || (han >= FREEBSD_MAXDEV))
return NULL;
return devicetable[han];
}
#if __FreeBSD_version >= 1100000
/* This works with /dev/nvme*, /dev/nvd* and /dev/nda* but not /dev/pass* */
static int
nvme_get_nsid(int fd, uint32_t *nsid, char *b, int blen, int vb)
{
struct nvme_get_nsid gnsid;
int n_cdev = sizeof(gnsid.cdev);
if (ioctl(fd, NVME_GET_NSID, &gnsid) < 0) {
int err = errno;
if (vb > 2)
pr2ws("%s: ioctl(NVME_GET_NSID) failed, errno=%d\n", __func__,
err);
return -err;
}
if (n_cdev < blen) {
strncpy(b, gnsid.cdev, n_cdev);
b[n_cdev] = '\0';
} else {
strncpy(b, gnsid.cdev, blen);
b[blen - 1] = '\0';
}
if (nsid != NULL)
*nsid = gnsid.nsid;
return 0;
}
#endif
/* Returns >= 0 if successful. If error in Unix returns negated errno. */
int
scsi_pt_open_device(const char * device_name, bool read_only, int vb)
{
int oflags = 0 /* O_NONBLOCK*/ ;
oflags |= (read_only ? O_RDONLY : O_RDWR);
return scsi_pt_open_flags(device_name, oflags, vb);
}
#if __FreeBSD_version >= 1100000
/* Get a get device CCB for the specified device, borrowed from camdd.c */
int
sg_cam_get_cgd(struct cam_device *device, struct ccb_getdev *cgd, int vb)
{
union ccb *ccb;
FILE * ferrp = sg_warnings_strm ? sg_warnings_strm : stderr;
int retval = 0;
ccb = cam_getccb(device);
if (ccb == NULL) {
if (vb)
pr2ws("%s: couldn't allocate CCB\n", __func__);
return -ENOMEM;
}
CCB_CLEAR_ALL_EXCEPT_HDR(&ccb->cgd);
ccb->ccb_h.func_code = XPT_GDEV_TYPE;
if (cam_send_ccb(device, ccb) < 0) {
if (vb > 1) {
pr2ws("%s: error sending Get Device Information CCB\n", __func__);
CAM_ERROR_PRINT(device, ccb, CAM_ESF_ALL, CAM_EPF_ALL, ferrp);
}
retval = -ENODEV;
goto bailout;
}
if ((ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
if (vb > 1)
CAM_ERROR_PRINT(device, ccb, CAM_ESF_ALL, CAM_EPF_ALL, ferrp);
retval = -ENODEV;
goto bailout;
}
bcopy(&ccb->cgd, cgd, sizeof(struct ccb_getdev));
bailout:
cam_freeccb(ccb);
return retval;
}
#endif
/* Similar to scsi_pt_open_device() but takes Unix style open flags OR-ed
* together. The 'oflags' is only used on NVMe devices. It is ignored on
* SCSI and ATA devices in FreeBSD.
* Returns >= 0 if successful, otherwise returns negated errno. */
int
scsi_pt_open_flags(const char * device_name, int oflags, int vb)
{
bool maybe_non_cam_nvme = false;
bool basnam0_n = false;
char first_ch;
int k, err, dev_fd, ret, handle_idx;
ssize_t s;
struct freebsd_dev_channel *fdc_p = NULL;
struct cam_device* cam_dev;
struct stat a_stat;
char dev_nm[PATH_MAX];
if (vb > 6)
pr2ws("%s: device_name=%s, oflags=0x%x\n", __func__, device_name,
oflags);
// Search table for a free entry
for (k = 0; k < FREEBSD_MAXDEV; k++)
if (! devicetable[k])
break;
// If no free entry found, return error. We have max allowed number
// of "file descriptors" already allocated.
if (k == FREEBSD_MAXDEV) {
if (vb)
pr2ws("too many open file descriptors (%d)\n", FREEBSD_MAXDEV);
ret = -EMFILE;
goto err_out;
}
handle_idx = k;
fdc_p = (struct freebsd_dev_channel *)
calloc(1,sizeof(struct freebsd_dev_channel));
if (fdc_p == NULL) {
// errno already set by call to calloc()
ret = -ENOMEM;
goto err_out;
}
fdc_p->nvme_fd_ns = -1;
fdc_p->nvme_fd_ctrl = -1;
if (! (fdc_p->devname = (char *)calloc(1, DEV_IDLEN+1))) {
ret = -ENOMEM;
goto err_out;
}
/* Don't know yet whether device_name is a SCSI, NVME(non-CAM) or
* NVME(CAM) device. Start by assuming it is CAM. */
if (cam_get_device(device_name, fdc_p->devname, DEV_IDLEN,
&(fdc_p->unitnum)) == -1) {
if (vb > 3)
pr2ws("%s: cam_get_device(%s) fails, should work for SCSI and "
"NVMe devices\n", __func__, device_name, errno);
ret = -EINVAL;
goto err_out;
} else if (vb > 6)
pr2ws("%s: cam_get_device() works, devname=%s unit=%u\n", __func__,
fdc_p->devname, fdc_p->unitnum);
if (! (cam_dev = cam_open_spec_device(fdc_p->devname,
fdc_p->unitnum, O_RDWR, NULL))) {
if (vb > 6) {
pr2ws("cam_open_spec_device: %s\n", cam_errbuf);
pr2ws("%s: so not CAM, but still maybe NVME\n", __func__);
}
maybe_non_cam_nvme = true;
} else { /* found CAM, could be SCSI or NVME(CAM) [nda driver] */
#if __FreeBSD_version >= 1100000
struct ccb_getdev cgd;
fdc_p->cam_dev = cam_dev;
ret = sg_cam_get_cgd(cam_dev, &cgd, vb);
if (ret)
goto err_out;
switch (cgd.protocol) {
case PROTO_SCSI:
fdc_p->is_nvme_dev = false;
break;
case PROTO_NVME:
fdc_p->is_nvme_dev = true;
fdc_p->is_cam_nvme = true;
fdc_p->nsid = cam_dev->target_lun & UINT32_MAX;
break;
case PROTO_ATA:
case PROTO_ATAPI:
case PROTO_SATAPM:
case PROTO_SEMB: /* SATA Enclosure Management bridge */
if (vb) {
pr2ws("%s: ATA and derivative devices not supported\n",
__func__);
if (vb > 2)
pr2ws(" ... FreeBSD doesn't have a SAT in its kernel\n");
}
ret = -EINVAL;
break;
#if __FreeBSD_version > 1200058
case PROTO_MMCSD:
if (vb)
pr2ws("%s: MMC and SD devices not supported\n",
__func__);
ret = -EINVAL;
break;
#endif
default:
if (vb)
pr2ws("%s: unexpected device protocol\n", __func__);
ret = -EINVAL;
break;
}
if (ret)
goto err_out;
if (0 == memcpy(fdc_p->devname, "pass", 4))
fdc_p->is_pass = true;
#else
ret = 0;
fdc_p->is_nvme_dev = false;
#endif
}
if (maybe_non_cam_nvme) {
first_ch = device_name[0];
if (('/' != first_ch) && ('.' != first_ch)) {
char b[PATH_MAX];
/* Step 1: if device_name is symlink, follow it */
s = readlink(device_name, b, sizeof(b));
if (s <= 0) {
strncpy(b, device_name, PATH_MAX - 1);
b[PATH_MAX - 1] = '\0';
}
/* Step 2: if no leading '/' nor '.' given, prepend '/dev/' */
first_ch = b[0];
basnam0_n = ('n' == first_ch);
if (('/' != first_ch) && ('.' != first_ch))
snprintf(dev_nm, PATH_MAX, "%s%s", "/dev/", b);
else
strcpy(dev_nm, b);
} else {
const char * cp;
strcpy(dev_nm, device_name);
cp = basename(dev_nm);
basnam0_n = ('n' == *cp);
strcpy(dev_nm, device_name);
}
if (stat(dev_nm, &a_stat) < 0) {
err = errno;
if (vb)
pr2ws("%s: unable to stat(%s): %s; basnam0_n=%d\n",
__func__, dev_nm, strerror(err), basnam0_n);
ret = -err;
goto err_out;
}
if (! (S_ISCHR(a_stat.st_mode))) {
if (vb > 1)
pr2ws("%s: %s is not a char device ??\n", __func__, dev_nm);
ret = -ENODEV;
goto err_out;
}
dev_fd = open(dev_nm, oflags);
if (dev_fd < 0) {
err = errno;
if (vb > 1)
pr2ws("%s: open(%s) failed: %s (errno=%d), try SCSI/ATA\n",
__func__, dev_nm, strerror(err), err);
ret = -err;
goto err_out;
}
#if __FreeBSD_version >= 1100000
ret = nvme_get_nsid(dev_fd, &fdc_p->nsid, fdc_p->devname, DEV_IDLEN,
vb);
if (ret)
goto err_out;
#else
{
unsigned int u;
/* only support /dev/nvme<n> and /dev/nvme<n>ns<m> */
k = sscanf(dev_nm, "nvme%uns%u", &u, &fdc_p->nsid);
if (2 == k) {
char * cp = strchr(dev_nm, 's');
*(cp - 2) = '\0';
strcpy(fdc_p->devname, dev_nm);
} else if (1 == k) {
strncpy(fdc_p->devname, dev_nm, DEV_IDLEN);
fdc_p->nsid = 0;
} else if (vb > 1) {
pr2ws("%s: only support '[/dev/]nvme<n>[ns<m>]'\n", __func__);
goto err_out;
}
}
#endif
if (vb > 6)
pr2ws("%s: nvme_dev_nm: %s, nsid=%u\n", __func__, fdc_p->devname,
fdc_p->nsid);
fdc_p->is_nvme_dev = true;
fdc_p->is_cam_nvme = false;
if (fdc_p->nsid > 0)
fdc_p->nvme_fd_ns = dev_fd;
else
fdc_p->nvme_fd_ctrl = dev_fd;
}
// return pointer to "file descriptor" table entry, properly offset.
devicetable[handle_idx] = fdc_p;
return handle_idx + FREEBSD_FDOFFSET;
err_out: /* ret should be negative value (negated errno) */
if (fdc_p) {
if (fdc_p->devname)
free(fdc_p->devname);
if (fdc_p->nvme_fd_ns >= 0)
close(fdc_p->nvme_fd_ns);
if (fdc_p->nvme_fd_ctrl >= 0)
close(fdc_p->nvme_fd_ctrl);
free(fdc_p);
fdc_p = NULL;
}
return ret;
}
/* Returns 0 if successful. If error in Unix returns negated errno. */
int
scsi_pt_close_device(int device_han)
{
struct freebsd_dev_channel *fdc_p;
int han = device_han - FREEBSD_FDOFFSET;
if ((han < 0) || (han >= FREEBSD_MAXDEV)) {
errno = ENODEV;
return -errno;
}
fdc_p = devicetable[han];
if (NULL == fdc_p) {
errno = ENODEV;
return -errno;
}
if (fdc_p->devname)
free(fdc_p->devname);
if (fdc_p->cam_dev) /* N.B. can be cam_nvme devices */
cam_close_device(fdc_p->cam_dev);
else if (fdc_p->is_nvme_dev) {
if (fdc_p->nvme_fd_ns >= 0)
close(fdc_p->nvme_fd_ns);
if (fdc_p->nvme_fd_ctrl >= 0)
close(fdc_p->nvme_fd_ctrl);
if (fdc_p->free_nvme_id_ctlp) {
free(fdc_p->free_nvme_id_ctlp);
fdc_p->nvme_id_ctlp = NULL;
fdc_p->free_nvme_id_ctlp = NULL;
}
}
free(fdc_p);
devicetable[han] = NULL;
errno = 0;
return 0;
}
/* Assumes device_han is an "open" file handle associated with some device.
* Returns 1 if SCSI generic pass-though device [SCSI CAM primary: nda0],
* returns 2 if secondary * SCSI pass-through device [SCSI CAM: pass<n>];
* returns 3 if non-CAM NVMe with no nsid [nvme0]; returns 4 if non-CAM
* NVMe device with nsid (> 0) [nvme0ns1, nvd0]; returns 5 if CAM NVMe
* (with or without nsid) [nda0]; or returns 0 if something else (e.g. ATA
* block device) or device_han < 0.
* If error, returns negated errno (operating system) value. */
int
check_pt_file_handle(int device_han, const char * device_name, int vb)
{
struct freebsd_dev_channel *fdc_p;
int han = device_han - FREEBSD_FDOFFSET;
if (vb > 6)
pr2ws("%s: device_handle=%d, device_name: %s\n", __func__,
device_han, device_name);
if ((han < 0) || (han >= FREEBSD_MAXDEV))
return -ENODEV;
fdc_p = devicetable[han];
if (NULL == fdc_p)
return -ENODEV;
if (fdc_p->is_nvme_dev) {
if (fdc_p->is_cam_nvme)
return 5;
else if (fdc_p->nsid == 0)
return 3;
else
return 4; /* Something like nvme0ns1 or nvd0 */
} else if (fdc_p->cam_dev)
return fdc_p->is_pass ? 2 : 1;
else {
if (vb > 1)
pr2ws("%s: neither SCSI nor NVMe ... hmm, device name: %s\n",
__func__, device_name);
return 0;
}
}
#if (HAVE_NVME && (! IGNORE_NVME))
static bool checked_ev_dsense = false;
static bool ev_dsense = false;
#endif
struct sg_pt_base *
construct_scsi_pt_obj_with_fd(int dev_han, int vb)
{
struct sg_pt_freebsd_scsi * ptp;
ptp = (struct sg_pt_freebsd_scsi *)
calloc(1, sizeof(struct sg_pt_freebsd_scsi));
if (ptp) {
ptp->dxfer_dir = CAM_DIR_NONE;
ptp->dev_han = (dev_han < 0) ? -1 : dev_han;
if (ptp->dev_han >= 0) {
struct freebsd_dev_channel *fdc_p;
fdc_p = get_fdc_p(ptp);
if (fdc_p) {
ptp->mchanp = fdc_p;
#if (HAVE_NVME && (! IGNORE_NVME))
sg_snt_init_dev_stat(&fdc_p->dev_stat);
if (! checked_ev_dsense) {
ev_dsense = sg_get_initial_dsense();
checked_ev_dsense = true;
}
fdc_p->dev_stat.scsi_dsense = ev_dsense;
#endif
} else if (vb)
pr2ws("%s: bad dev_han=%d\n", __func__, dev_han);
}
} else if (vb)
pr2ws("%s: calloc() out of memory\n", __func__);
return (struct sg_pt_base *)ptp;
}
struct sg_pt_base *
construct_scsi_pt_obj()
{
return construct_scsi_pt_obj_with_fd(-1, 0);
}
void
destruct_scsi_pt_obj(struct sg_pt_base * vp)
{
struct sg_pt_freebsd_scsi * ptp;
if (NULL == vp) {
pr2ws(">>>> %s: given NULL pointer\n", __func__);
return;
}
if ((ptp = &vp->impl)) {
if (ptp->ccb)
cam_freeccb(ptp->ccb);
free(vp);
}
}
void
clear_scsi_pt_obj(struct sg_pt_base * vp)
{
struct sg_pt_freebsd_scsi * ptp;
if (NULL == vp) {
pr2ws(">>>>> %s: NULL pointer given\n", __func__);
return;
}
if ((ptp = &vp->impl)) {
int dev_han = ptp->dev_han;
struct freebsd_dev_channel *fdc_p = ptp->mchanp;
if (ptp->ccb)
cam_freeccb(ptp->ccb);
memset(ptp, 0, sizeof(struct sg_pt_freebsd_scsi));
ptp->dxfer_dir = CAM_DIR_NONE;
ptp->dev_han = dev_han;
ptp->mchanp = fdc_p;
}
}
void
partial_clear_scsi_pt_obj(struct sg_pt_base * vp)
{
struct sg_pt_freebsd_scsi * ptp = &vp->impl;
if (NULL == ptp)
return;
ptp->in_err = 0;
ptp->os_err = 0;
ptp->transport_err = 0;
ptp->scsi_status = 0;
ptp->dxfer_dir = CAM_DIR_NONE;
ptp->dxferip = NULL;
ptp->dxfer_ilen = 0;
ptp->dxferop = NULL;
ptp->dxfer_olen = 0;
ptp->nvme_result = 0;
}
/* Forget any previous dev_han and install the one given. May attempt to
* find file type (e.g. if pass-though) from OS so there could be an error.
* Returns 0 for success or the same value as get_scsi_pt_os_err()
* will return. dev_han should be >= 0 for a valid file handle or -1 . */
int
set_pt_file_handle(struct sg_pt_base * vp, int dev_han, int vb)
{
struct sg_pt_freebsd_scsi * ptp;
if (NULL == vp) {
if (vb)
pr2ws(">>>> %s: pointer to object is NULL\n", __func__);
return EINVAL;
}
if ((ptp = &vp->impl)) {
struct freebsd_dev_channel *fdc_p;
if (dev_han < 0) {
ptp->dev_han = -1;
ptp->dxfer_dir = CAM_DIR_NONE;
return 0;
}
fdc_p = get_fdc_p(ptp);
if (NULL == fdc_p) {
if (vb)
pr2ws("%s: dev_han (%d) is invalid\n", __func__, dev_han);
ptp->os_err = EINVAL;
return ptp->os_err;
}
ptp->os_err = 0;
ptp->transport_err = 0;
ptp->in_err = 0;
ptp->scsi_status = 0;
ptp->dev_han = dev_han;
ptp->dxfer_dir = CAM_DIR_NONE;
ptp->mchanp = fdc_p;
}
return 0;
}
/* Valid file handles (which is the return value) are >= 0 . Returns -1
* if there is no valid file handle. */
int
get_pt_file_handle(const struct sg_pt_base * vp)
{
const struct sg_pt_freebsd_scsi * ptp = &vp->impl;
return ptp ? ptp->dev_han : -1;
}
void
set_scsi_pt_cdb(struct sg_pt_base * vp, const uint8_t * cdb, int cdb_len)
{
struct sg_pt_freebsd_scsi * ptp = &vp->impl;
ptp->cdb = (uint8_t *)cdb;
ptp->cdb_len = cdb_len;
}
int
get_scsi_pt_cdb_len(const struct sg_pt_base * vp)
{
const struct sg_pt_freebsd_scsi * ptp = &vp->impl;
return ptp->cdb_len;
}
uint8_t *
get_scsi_pt_cdb_buf(const struct sg_pt_base * vp)
{
const struct sg_pt_freebsd_scsi * ptp = &vp->impl;
return ptp->cdb;
}
void
set_scsi_pt_sense(struct sg_pt_base * vp, uint8_t * sense,
int max_sense_len)
{
struct sg_pt_freebsd_scsi * ptp = &vp->impl;
if (sense) {
if (max_sense_len > 0)
memset(sense, 0, max_sense_len);
}
ptp->sense = sense;
ptp->sense_len = max_sense_len;
}
/* Setup for data transfer from device */
void
set_scsi_pt_data_in(struct sg_pt_base * vp, uint8_t * dxferp,
int dxfer_len)
{
struct sg_pt_freebsd_scsi * ptp = &vp->impl;
if (ptp->dxferip)
++ptp->in_err;
ptp->dxferip = dxferp;
ptp->dxfer_ilen = dxfer_len;
if (dxfer_len > 0) {
ptp->dxferp = dxferp;
ptp->dxfer_len = dxfer_len;
if (ptp->dxfer_dir == CAM_DIR_OUT)
ptp->dxfer_dir = CAM_DIR_BOTH;
else
ptp->dxfer_dir = CAM_DIR_IN;
}
}
/* Setup for data transfer toward device */
void
set_scsi_pt_data_out(struct sg_pt_base * vp, const uint8_t * dxferp,
int dxfer_len)
{
struct sg_pt_freebsd_scsi * ptp = &vp->impl;
if (ptp->dxferop)
++ptp->in_err;
ptp->dxferop = (uint8_t *)dxferp;
ptp->dxfer_olen = dxfer_len;
if (dxfer_len > 0) {
ptp->dxferp = (uint8_t *)dxferp;
ptp->dxfer_len = dxfer_len;
if (ptp->dxfer_dir == CAM_DIR_IN)
ptp->dxfer_dir = CAM_DIR_BOTH;
else
ptp->dxfer_dir = CAM_DIR_OUT;
}
}
void
set_pt_metadata_xfer(struct sg_pt_base * vp, uint8_t * mdxferp,
uint32_t mdxfer_len, bool out_true)
{
struct sg_pt_freebsd_scsi * ptp = &vp->impl;
if (ptp->mdxferp)
++ptp->in_err;
ptp->mdxferp = mdxferp;
ptp->mdxfer_len = mdxfer_len;
if (mdxfer_len > 0)
ptp->mdxfer_out = out_true;
}
void
set_scsi_pt_packet_id(struct sg_pt_base * vp __attribute__ ((unused)),
int pack_id __attribute__ ((unused)))
{
}
void
set_scsi_pt_tag(struct sg_pt_base * vp, uint64_t tag __attribute__ ((unused)))
{
struct sg_pt_freebsd_scsi * ptp = &vp->impl;
++ptp->in_err;
}
void
set_scsi_pt_task_management(struct sg_pt_base * vp,
int tmf_code __attribute__ ((unused)))
{
struct sg_pt_freebsd_scsi * ptp = &vp->impl;
++ptp->in_err;
}
void
set_scsi_pt_task_attr(struct sg_pt_base * vp,
int attrib __attribute__ ((unused)),
int priority __attribute__ ((unused)))
{
struct sg_pt_freebsd_scsi * ptp = &vp->impl;
++ptp->in_err;
}
void
set_scsi_pt_flags(struct sg_pt_base * objp, int flags)
{
if (objp) { ; } /* unused, suppress warning */
if (flags) { ; } /* unused, suppress warning */
}
/* Executes SCSI command (or at least forwards it to lower layers).
* Clears os_err field prior to active call (whose result may set it
* again). */
int
do_scsi_pt(struct sg_pt_base * vp, int dev_han, int time_secs, int vb)
{
struct sg_pt_freebsd_scsi * ptp = &vp->impl;
struct freebsd_dev_channel *fdc_p;
FILE * ferrp = sg_warnings_strm ? sg_warnings_strm : stderr;
union ccb *ccb;
if (vb > 6)
pr2ws("%s: dev_han=%d, time_secs=%d\n", __func__, dev_han, time_secs);
ptp->os_err = 0;
if (ptp->in_err) {
if (vb)
pr2ws("Replicated or unused set_scsi_pt...\n");
return SCSI_PT_DO_BAD_PARAMS;
}
if (dev_han < 0) {
if (ptp->dev_han < 0) {
if (vb)
pr2ws("%s: No device file handle given\n", __func__);
return SCSI_PT_DO_BAD_PARAMS;
}
dev_han = ptp->dev_han;
} else {
if (ptp->dev_han >= 0) {
if (dev_han != ptp->dev_han) {
if (vb)
pr2ws("%s: file handle given to create and this "
"differ\n", __func__);
return SCSI_PT_DO_BAD_PARAMS;
}
} else
ptp->dev_han = dev_han;
}
if (NULL == ptp->cdb) {
if (vb)
pr2ws("No command (cdb) given\n");
return SCSI_PT_DO_BAD_PARAMS;
}
fdc_p = ptp->mchanp;
if (NULL == fdc_p) {
fdc_p = get_fdc_p(ptp);
if (NULL == fdc_p) {
if (vb)
pr2ws("File descriptor bad or closed??\n");
ptp->os_err = ENODEV;
return -ptp->os_err;
}
ptp->mchanp = fdc_p;
}
#if (HAVE_NVME && (! IGNORE_NVME))
if (fdc_p->is_nvme_dev)
return sg_do_nvme_pt(ptp, -1, true /* assume Admin */, time_secs, vb);
#endif
/* SCSI CAM pass-through follows */
ptp->is_nvme_dev = fdc_p->is_nvme_dev;
if (NULL == fdc_p->cam_dev) {
if (vb)
pr2ws("No open CAM device\n");
return SCSI_PT_DO_BAD_PARAMS;
}
if (NULL == ptp->ccb) { /* re-use if we have one already */
if (! (ccb = cam_getccb(fdc_p->cam_dev))) {
if (vb)
pr2ws("cam_getccb: failed\n");
ptp->os_err = ENOMEM;
return -ptp->os_err;
}
ptp->ccb = ccb;
} else
ccb = ptp->ccb;
// clear out structure, except for header that was filled in for us
bzero(&(&ccb->ccb_h)[1],
sizeof(struct ccb_scsiio) - sizeof(struct ccb_hdr));
ptp->timeout_ms = (time_secs > 0) ? (time_secs * 1000) : DEF_TIMEOUT;
cam_fill_csio(&ccb->csio,
/* retries */ 1,
/* cbfcnp */ NULL,
/* flags */ ptp->dxfer_dir,
/* tagaction */ MSG_SIMPLE_Q_TAG,
/* dataptr */ ptp->dxferp,
/* datalen */ ptp->dxfer_len,
/* senselen */ ptp->sense_len,
/* cdblen */ ptp->cdb_len,
/* timeout (millisecs) */ ptp->timeout_ms);
memcpy(ccb->csio.cdb_io.cdb_bytes, ptp->cdb, ptp->cdb_len);
if (cam_send_ccb(fdc_p->cam_dev, ccb) < 0) {
if (vb) {
pr2serr("%s: cam_send_ccb() error\n", __func__);
CAM_ERROR_PRINT(fdc_p->cam_dev, ccb, CAM_ESF_ALL,
CAM_EPF_ALL, ferrp);
}
cam_freeccb(ptp->ccb);
ptp->ccb = NULL;
ptp->os_err = EIO;
return -ptp->os_err;
}
if (((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_CMP) ||
((ccb->ccb_h.status & CAM_STATUS_MASK) == CAM_SCSI_STATUS_ERROR)) {
ptp->scsi_status = ccb->csio.scsi_status;
ptp->resid = ccb->csio.resid;
ptp->sense_resid = ccb->csio.sense_resid;
if ((SAM_STAT_CHECK_CONDITION == ptp->scsi_status) ||
(SAM_STAT_COMMAND_TERMINATED == ptp->scsi_status)) {
int len;
if (ptp->sense_resid > ptp->sense_len)
len = ptp->sense_len; /* crazy; ignore sense_resid */
else
len = ptp->sense_len - ptp->sense_resid;
if (len > 0)
memcpy(ptp->sense, &(ccb->csio.sense_data), len);
}
} else
ptp->transport_err = 1;
return 0;
}
int
get_scsi_pt_result_category(const struct sg_pt_base * vp)
{
const struct sg_pt_freebsd_scsi * ptp = &vp->impl;
if (ptp->os_err)
return SCSI_PT_RESULT_OS_ERR;
else if (ptp->transport_err)
return SCSI_PT_RESULT_TRANSPORT_ERR;
else if ((SAM_STAT_CHECK_CONDITION == ptp->scsi_status) ||
(SAM_STAT_COMMAND_TERMINATED == ptp->scsi_status))
return SCSI_PT_RESULT_SENSE;
else if (ptp->scsi_status)
return SCSI_PT_RESULT_STATUS;
else
return SCSI_PT_RESULT_GOOD;
}
int
get_scsi_pt_resid(const struct sg_pt_base * vp)
{
const struct sg_pt_freebsd_scsi * ptp = &vp->impl;
if ((NULL == ptp) || (NULL == ptp->mchanp))
return 0;
return ((ptp->is_nvme_dev && ! ptp->nvme_our_snt)) ? 0 : ptp->resid;
}
void
get_pt_req_lengths(const struct sg_pt_base * vp, int * req_dinp,
int * req_doutp)
{
const struct sg_pt_freebsd_scsi * ptp = &vp->impl;
bool bidi = (ptp->dxfer_dir == CAM_DIR_BOTH);
if (req_dinp) {
if (ptp->dxfer_ilen > 0)
*req_dinp = ptp->dxfer_ilen;
else
*req_dinp = 0;
}
if (req_doutp) {
if ((!bidi) && (ptp->dxfer_olen > 0))
*req_doutp = ptp->dxfer_olen;
else
*req_doutp = 0;
}
}
void
get_pt_actual_lengths(const struct sg_pt_base * vp, int * act_dinp,
int * act_doutp)
{