/
iSCSIVirtualHBA.cpp
2146 lines (1708 loc) · 80.2 KB
/
iSCSIVirtualHBA.cpp
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) 2016, Nareg Sinenian
* All rights reserved.
*
* 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.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 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 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 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 DAMAGE.
*/
#include "iSCSIVirtualHBA.h"
#include "iSCSIIOEventSource.h"
#include "iSCSITaskQueue.h"
#include "iSCSITypesKernel.h"
#include "iSCSIRFC3720Defaults.h"
#include "iSCSIHBAUserClient.h"
#include "crc32c.h"
#include <sys/ioctl.h>
#include <sys/unistd.h>
#include <sys/select.h>
#include <IOKit/IORegistryEntry.h>
// Use DBLog() for debug outputs and IOLog() for all outputs
// DBLog() is only enabled for debug builds
#ifdef DEBUG
#define DBLog(...) IOLog(__VA_ARGS__)
#else
#define DBLog(...)
#endif
#define super IOSCSIParallelInterfaceController
#define ISCSI_PRODUCT_NAME "iSCSI Virtual Host Bus Adapter"
#define ISCSI_PRODUCT_REVISION_LEVEL "1.0"
using namespace iSCSIPDU;
/*! Maximum number of connections allowed per session. */
const UInt16 iSCSIVirtualHBA::kMaxConnectionsPerSession = kiSCSIMaxConnectionsPerSession;
/*! Maximum number of session allowed (globally). */
const UInt16 iSCSIVirtualHBA::kMaxSessions = kiSCSIMaxSessions;
/*! Highest LUN supported by the virtual HBA. Due to internal design
* contraints, this number should never exceed 2**8 - 1 or 255 (8-bits). */
const SCSILogicalUnitNumber iSCSIVirtualHBA::kHighestLun = 63;
/*! Highest SCSI device ID supported by the HBA. SCSI device identifiers are
* just the session identifiers. */
const SCSIDeviceIdentifier iSCSIVirtualHBA::kHighestSupportedDeviceId = kMaxSessions - 1;
/*! Maximum number of SCSI tasks the HBA can handle. Increasing this number will
* increase the wired memory consumed by this kernel extension. */
const UInt32 iSCSIVirtualHBA::kMaxTaskCount = 10;
/*! Number of bytes that are transmitted before we calculate an average speed
* for the connection (1024^2 = 1048576). */
const UInt32 iSCSIVirtualHBA::kNumBytesPerAvgBW = 1048576;
/*! Default task timeout for new tasks (milliseconds). */
const UInt32 iSCSIVirtualHBA::kiSCSITaskTimeoutMs = 20000;
/*! Default TCP timeout for new connections (seconds). */
const UInt32 iSCSIVirtualHBA::kiSCSITCPTimeoutSec = 1;
OSDefineMetaClassAndStructors(iSCSIVirtualHBA,IOSCSIParallelInterfaceController);
SCSILogicalUnitNumber iSCSIVirtualHBA::ReportHBAHighestLogicalUnitNumber()
{
return kHighestLun;
}
bool iSCSIVirtualHBA::DoesHBASupportSCSIParallelFeature(SCSIParallelFeature theFeature)
{
bool supported = false; // return false for any unimplemented or unknown features
switch (theFeature) {
case kSCSIParallelFeature_WideDataTransfer:
supported = true;
break;
case kSCSIParallelFeature_SynchronousDataTransfer:
supported = true;
break;
case kSCSIParallelFeature_QuickArbitrationAndSelection:
supported = true;
break;
case kSCSIParallelFeature_DoubleTransitionDataTransfers:
supported = true;
break;
case kSCSIParallelFeature_InformationUnitTransfers:
supported = true;
break;
default: break;
}
return supported;
}
bool iSCSIVirtualHBA::InitializeTargetForID(SCSITargetIdentifier targetId)
{
// Find and set the IQN of the target in the IORegistry. First we need
// to iterate over the target names and find the one that matches our
// target identifiers (session identifier). Next, we copy the existing
// protocol dictionary and add a custom property for the IQN.
OSCollectionIterator * iterator = OSCollectionIterator::withCollection(targetList);
if(!iterator)
return false;
OSObject * object;
while((object = iterator->getNextObject()))
{
OSString * targetIQN = OSDynamicCast(OSString,object);
OSNumber * sessionIdNumber = OSDynamicCast(OSNumber,targetList->getObject(targetIQN));
if(sessionIdNumber->unsigned16BitValue() == targetId)
break;
}
// Set the name of the target in the IORegistry
IOService * device;
if(!(device = (IOService*)GetTargetForID(targetId)))
return false;
OSDictionary * copyDict, * protocolDict;
if(!(copyDict = OSDynamicCast(OSDictionary,device->getProperty(kIOPropertyProtocolCharacteristicsKey))))
return false;
if((protocolDict = OSDynamicCast(OSDictionary,copyDict->copyCollection())))
{
OSString * targetIQN = OSDynamicCast(OSString,object);
if(targetIQN) {
protocolDict->setObject("iSCSI Qualified Name",targetIQN);
}
protocolDict->setObject(kIOPropertyPhysicalInterconnectTypeKey,OSString::withCString("iSCSI"));
device->setProperty(kIOPropertyProtocolCharacteristicsKey,protocolDict);
protocolDict->release();
}
return true;
}
SCSIServiceResponse iSCSIVirtualHBA::AbortTaskRequest(SCSITargetIdentifier targetId,
SCSILogicalUnitNumber LUN,
SCSITaggedTaskIdentifier taggedTaskID)
{
// Grab session and connection, send task managment request
iSCSISession * session = sessionList[targetId];
if(session == NULL)
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
DBLog("iscsi: Abort task request (TID: %llu, LUN: %llu)\n",targetId,LUN);
// Create a SCSI target management PDU and send
iSCSIPDUTaskMgmtReqBHS bhs = iSCSIPDUTaskMgmtReqBHSInit;
bhs.initiatorTaskTag = BuildInitiatorTaskTag(kInitiatorTaskTypeTaskMgmt,LUN,kiSCSIPDUTaskMgmtFuncAbortTask);
bhs.LUN = OSSwapHostToBigInt64(LUN);
bhs.function = kiSCSIPDUTaskMgmtFuncFlag | kiSCSIPDUTaskMgmtFuncAbortTask;
bhs.referencedTaskTag = OSSwapHostToBigInt32((UInt32)taggedTaskID);
if(SendPDU(session,session->connections[0],(iSCSIPDUInitiatorBHS *)&bhs,NULL,NULL,0))
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
return kSCSIServiceResponse_Request_In_Process;
}
SCSIServiceResponse iSCSIVirtualHBA::AbortTaskSetRequest(SCSITargetIdentifier targetId,
SCSILogicalUnitNumber LUN)
{
// Grab session and connection, send task managment request
iSCSISession * session = sessionList[targetId];
if(session == NULL)
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
DBLog("iscsi: Abort task set request (TID: %llu, LUN: %llu)\n",targetId,LUN);
// Create a SCSI target management PDU and send
iSCSIPDUTaskMgmtReqBHS bhs = iSCSIPDUTaskMgmtReqBHSInit;
bhs.initiatorTaskTag = BuildInitiatorTaskTag(kInitiatorTaskTypeTaskMgmt,LUN,kiSCSIPDUTaskMgmtFuncAbortTaskSet);
bhs.LUN = OSSwapHostToBigInt64(LUN);
bhs.function = kiSCSIPDUTaskMgmtFuncFlag | kiSCSIPDUTaskMgmtFuncAbortTaskSet;
if(SendPDU(session,session->connections[0],(iSCSIPDUInitiatorBHS *)&bhs,NULL,NULL,0))
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
return kSCSIServiceResponse_Request_In_Process;
}
SCSIServiceResponse iSCSIVirtualHBA::ClearACARequest(SCSITargetIdentifier targetId,
SCSILogicalUnitNumber LUN)
{
// Grab session and connection, send task managment request
iSCSISession * session = sessionList[targetId];
if(session == NULL)
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
DBLog("iscsi: Clear ACA request (TID: %llu, LUN: %llu)\n",targetId,LUN);
// Create a SCSI target management PDU and send
iSCSIPDUTaskMgmtReqBHS bhs = iSCSIPDUTaskMgmtReqBHSInit;
bhs.initiatorTaskTag = BuildInitiatorTaskTag(kInitiatorTaskTypeTaskMgmt,LUN,kiSCSIPDUTaskMgmtFuncClearACA);
bhs.LUN = OSSwapHostToBigInt64(LUN);
bhs.function = kiSCSIPDUTaskMgmtFuncFlag | kiSCSIPDUTaskMgmtFuncClearACA;
if(SendPDU(session,session->connections[0],(iSCSIPDUInitiatorBHS *)&bhs,NULL,NULL,0))
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
return kSCSIServiceResponse_Request_In_Process;
}
SCSIServiceResponse iSCSIVirtualHBA::ClearTaskSetRequest(SCSITargetIdentifier targetId,
SCSILogicalUnitNumber LUN)
{
// Grab session and connection, send task managment request
iSCSISession * session = sessionList[targetId];
if(session == NULL)
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
DBLog("iscsi: Clear task set request (TID: %llu, LUN: %llu)\n",targetId,LUN);
// Create a SCSI target management PDU and send
iSCSIPDUTaskMgmtReqBHS bhs = iSCSIPDUTaskMgmtReqBHSInit;
bhs.initiatorTaskTag = BuildInitiatorTaskTag(kInitiatorTaskTypeTaskMgmt,LUN,kiSCSIPDUTaskMgmtFuncClearTaskSet);
bhs.LUN = OSSwapHostToBigInt64(LUN);
bhs.function = kiSCSIPDUTaskMgmtFuncFlag | kiSCSIPDUTaskMgmtFuncClearTaskSet;
if(SendPDU(session,session->connections[0],(iSCSIPDUInitiatorBHS *)&bhs,NULL,NULL,0))
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
return kSCSIServiceResponse_Request_In_Process;
}
SCSIServiceResponse iSCSIVirtualHBA::LogicalUnitResetRequest(SCSITargetIdentifier targetId,
SCSILogicalUnitNumber LUN)
{
// Grab session and connection, send task managment request
iSCSISession * session = sessionList[targetId];
if(session == NULL)
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
DBLog("iscsi: LUN reset request (TID: %llu, LUN: %llu)\n",targetId,LUN);
// Create a SCSI target management PDU and send
iSCSIPDUTaskMgmtReqBHS bhs = iSCSIPDUTaskMgmtReqBHSInit;
bhs.initiatorTaskTag = BuildInitiatorTaskTag(kInitiatorTaskTypeTaskMgmt,LUN,kiSCSIPDUTaskMgmtFuncLUNReset);
bhs.LUN = OSSwapHostToBigInt64(LUN);
bhs.function = kiSCSIPDUTaskMgmtFuncFlag | kiSCSIPDUTaskMgmtFuncLUNReset;
if(SendPDU(session,session->connections[0],(iSCSIPDUInitiatorBHS *)&bhs,NULL,NULL,0))
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
return kSCSIServiceResponse_Request_In_Process;
}
SCSIServiceResponse iSCSIVirtualHBA::TargetResetRequest(SCSITargetIdentifier targetId)
{
// Grab session and connection, send task managment request
iSCSISession * session = sessionList[targetId];
if(session == NULL)
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
DBLog("iscsi: Target reset request (TID: %llu)\n",targetId);
// Create a SCSI target management PDU and send
iSCSIPDUTaskMgmtReqBHS bhs = iSCSIPDUTaskMgmtReqBHSInit;
bhs.function = kiSCSIPDUTaskMgmtFuncFlag | kiSCSIPDUTaskMgmtFuncTargetWarmReset;
bhs.initiatorTaskTag = BuildInitiatorTaskTag(kInitiatorTaskTypeTaskMgmt,0,kiSCSIPDUTaskMgmtFuncTargetWarmReset);
if(SendPDU(session,session->connections[0],(iSCSIPDUInitiatorBHS *)&bhs,NULL,NULL,0))
return kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
return kSCSIServiceResponse_Request_In_Process;
}
SCSIInitiatorIdentifier iSCSIVirtualHBA::ReportInitiatorIdentifier()
{
// Random number generated each time this kext loads
return kInitiatorId;
}
SCSIDeviceIdentifier iSCSIVirtualHBA::ReportHighestSupportedDeviceID()
{
return kHighestSupportedDeviceId;
}
UInt32 iSCSIVirtualHBA::ReportMaximumTaskCount()
{
return kMaxTaskCount;
}
UInt32 iSCSIVirtualHBA::ReportHBASpecificTaskDataSize()
{
// Due to a bug (feature?) in the SCSI family driver, this value cannot
// be zero, even if task data is not required.
return 1;
}
UInt32 iSCSIVirtualHBA::ReportHBASpecificDeviceDataSize()
{
// Due to a bug (feature?) in the SCSI family driver, this value cannot
// be zero, even if device data is not required.
return 1;
}
bool iSCSIVirtualHBA::DoesHBAPerformDeviceManagement()
{
// Lets the superclass know that we are going to create and destroy
// our own targets as we setup/teardown iSCSI connections
return true;
}
bool iSCSIVirtualHBA::InitializeController()
{
DBLog("iscsi: Initializing virtual HBA\n");
// Initialize CRC32C
crc32c_init();
// Setup session & target list
sessionList = (iSCSISession **)IOMalloc(kMaxSessions*sizeof(iSCSISession*));
targetList = OSDictionary::withCapacity(kMaxSessions);
if(!sessionList)
return false;
memset(sessionList,0,kMaxSessions*sizeof(iSCSISession *));
// Set product name.
SetHBAProperty(kIOPropertyProductNameKey,OSString::withCString(ISCSI_PRODUCT_NAME));
SetHBAProperty(kIOPropertyProductRevisionLevelKey,OSString::withCString(ISCSI_PRODUCT_REVISION_LEVEL));
// Generate an initiator id using a random number (per RFC3720)
kInitiatorId = random();
// Make ourselves discoverable to user clients (we do this last after
// everything is initialized).
registerService();
// Successfully initialized controller
return true;
}
void iSCSIVirtualHBA::TerminateController()
{
DBLog("iscsi: Terminating virtual HBA\n");
ReleaseAllSessions();
// Free up our list of sessions and targets
IOFree(sessionList,kMaxSessions*sizeof(iSCSISession*));
targetList->free();
}
bool iSCSIVirtualHBA::StartController()
{
// Successfully started controller
return true;
}
void iSCSIVirtualHBA::StopController()
{
}
void iSCSIVirtualHBA::HandleInterruptRequest()
{
// We don't use physical interrupts (this is a virtual HBA)
}
/*! Handles task timeouts.
* @param task the task that timed out. */
void iSCSIVirtualHBA::HandleTimeout(SCSIParallelTaskIdentifier task)
{
// Determine the target identifier (session identifier) and connection
// associated with this task and remove the task from the task queue.
SessionIdentifier sessionId = (UInt16)GetTargetIdentifier(task);
ConnectionIdentifier connectionId = *((UInt32*)GetHBADataPointer(task));
if(connectionId >= kMaxConnectionsPerSession)
return;
iSCSISession * session = sessionList[sessionId];
if(!session)
return;
iSCSIConnection * connection = session->connections[connectionId];
if(!connection)
return;
// Note: task tag is always 32-bits, even though the SCSI stack allows for 64-bit storage of the tag
DBLog("iscsi: Task timeout for task %#x (sid: %d, cid: %d)\n",(UInt32)GetControllerTaskIdentifier(task),sessionId,connectionId);
// If the task timeout is due to a broken connection, handle it.
// Otherwise the target may be taking too long, just report it up the
// driver stack
struct sockaddr peername;
if(sock_getpeername(connection->socket,&peername,sizeof(peername))) {
HandleConnectionTimeout(sessionId,connectionId);
return;
}
// Let task queue know that the last (current) task should be removed
connection->taskQueue->completeCurrentTask();
// Notify the SCSI stack that the task could not be delivered
CompleteParallelTask(session,
connection,
task,
kSCSITaskStatus_DeliveryFailure,
kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE);
}
/*! Handles connection timeouts.
* @param sessionId the session associated with the timed-out connection.
* @param connectionId the connection that timed out. */
void iSCSIVirtualHBA::HandleConnectionTimeout(SessionIdentifier sessionId,ConnectionIdentifier connectionId)
{
// If this is the last connection, release the session...
iSCSISession * session;
if(!(session = sessionList[sessionId]))
return;
DBLog("iscsi: Connection timeout (sid: %d, cid: %d)\n",sessionId,connectionId);
ConnectionIdentifier connectionCount = 0;
for(ConnectionIdentifier connectionId = 0; connectionId < kiSCSIMaxConnectionsPerSession; connectionId++)
if(session->connections[connectionId])
connectionCount++;
// In the future add recovery here...
if(connectionCount > 1)
DeactivateConnection(sessionId,connectionId);
else
DeactivateAllConnections(sessionId);
// Send a notification to the daemon; if the daemon does not respond then
// release the session or connection as appropriate
iSCSIHBAUserClient * client = (iSCSIHBAUserClient*)getClient();
if(client)
client->sendTimeoutMessageNotification(sessionId,connectionId);
else
{
if(connectionCount > 1)
ReleaseConnection(sessionId,connectionId);
else
ReleaseSession(sessionId);
}
}
SCSIServiceResponse iSCSIVirtualHBA::ProcessParallelTask(SCSIParallelTaskIdentifier parallelTask)
{
// Here we set an (iSCSI) initiator task tag for the SCSI task and queue
// the iSCSI task for later processing
SCSITargetIdentifier targetId = GetTargetIdentifier(parallelTask);
SCSILogicalUnitNumber LUN = GetLogicalUnitNumber(parallelTask);
SCSITaggedTaskIdentifier taskId = GetTaggedTaskIdentifier(parallelTask);
iSCSISession * session = sessionList[(SessionIdentifier)targetId];
if(!session)
return kSCSIServiceResponse_FUNCTION_REJECTED;
// Determine which connection this task should be assigned to based on
// bitrate and processing load; we do this by looking at the amount of
// data each connection needs to transfer
iSCSIConnection * connection = NULL;
size_t minTimeToTransfer = INT64_MAX;
for(UInt32 idx = 0; idx < kiSCSIMaxConnectionsPerSession; idx++)
{
iSCSIConnection * conn = session->connections[idx];
// If this connection slot doesn't exist or isn't enabled, move on...
if(!conn || !conn->taskQueue->isEnabled())
continue;
if(conn->bytesPerSecond == 0) {
connection = conn;
break;
}
size_t timeToTransfer = conn->dataToTransfer / conn->bytesPerSecond;
if(timeToTransfer <= minTimeToTransfer) {
minTimeToTransfer = timeToTransfer;
connection = conn;
}
}
connection = session->connections[0];
if(!connection || !connection->dataRecvEventSource)
return kSCSIServiceResponse_FUNCTION_REJECTED;
// Associate a connection identifier with this task; this is used to
// maintain the connection associated with a task when only task information
// is available (e.g., in the case of a task timeout).
*((UInt32*)GetHBADataPointer(parallelTask)) = 0;
// Add the amount of data that we need to transfer to this connection
OSAddAtomic64(GetRequestedDataTransferCount(parallelTask),&connection->dataToTransfer);
// Build and set iSCSI initiator task tag
UInt32 initiatorTaskTag = BuildInitiatorTaskTag(kInitiatorTaskTypeSCSITask,LUN,taskId);
SetControllerTaskIdentifier(parallelTask,initiatorTaskTag);
DBLog("iscsi: Transfer size: %llu (sid: %d, cid: %d)\n",
connection->dataToTransfer,session->sessionId,connection->cid);
// Queue task in the event source (we'll remove it from the queue when were
// done processing the task)
connection->taskQueue->queueTask(initiatorTaskTag);
DBLog("iscsi: Queued task %#x (sid: %d, cid: %d)\n",
initiatorTaskTag,session->sessionId,connection->cid);
return kSCSIServiceResponse_Request_In_Process;
}
void iSCSIVirtualHBA::BeginTaskOnWorkloopThread(iSCSIVirtualHBA * owner,
iSCSISession * session,
iSCSIConnection * connection,
UInt32 initiatorTaskTag)
{
// Task tag corresponding to a connection timeout measurement
if(owner->ParseInitiatorTaskTagForTaskType(initiatorTaskTag) == kInitiatorTaskTypeLatency) {
owner->MeasureConnectionLatency(session,connection);
return;
}
// Grab parallel task associated with this iSCSI task
SCSIParallelTaskIdentifier parallelTask =
owner->FindTaskForControllerIdentifier(session->sessionId,initiatorTaskTag);
if(!parallelTask) {
DBLog("iscsi: Task not found, flushing stream (BeginTaskOnWorkloopThread) (sid: %d, cid: %d)\n",
session->sessionId,connection->cid);
return;
}
// Extract information about this SCSI task
SCSITaskAttribute attribute = owner->GetTaskAttribute(parallelTask);
UInt8 transferDirection = owner->GetDataTransferDirection(parallelTask);
UInt32 transferSize = (UInt32)owner->GetRequestedDataTransferCount(parallelTask);
UInt8 cdbSize = owner->GetCommandDescriptorBlockSize(parallelTask);
DBLog("iscsi: Starting task %#x (sid: %d, cid: %d)\n",
initiatorTaskTag,session->sessionId,connection->cid);
// Timestamp the connection indicating when we started processing the task
clock_get_system_microtime(&(connection->taskStartTimeSec),
&(connection->taskStartTimeUSec));
iSCSIPDUSCSICmdBHS bhs = iSCSIPDUSCSICmdBHSInit;
bhs.dataTransferLength = OSSwapHostToBigInt32(transferSize);
owner->GetLogicalUnitBytes(parallelTask,(SCSILogicalUnitBytes*)&bhs.LUN);
// The initiator task tag is just LUN and task identifier
bhs.initiatorTaskTag = initiatorTaskTag;
if(transferDirection == kSCSIDataTransfer_FromInitiatorToTarget)
bhs.flags |= kiSCSIPDUSCSICmdFlagWrite;
else if(transferDirection == kSCSIDataTransfer_FromTargetToInitiator)
bhs.flags |= kiSCSIPDUSCSICmdFlagRead;
// For CDB sizes less than 16 bytes, plug directly into SCSI command PDU
// (Currently, OS X doesn't support CDB's larger than 16 bytes, so
// there's no need for an iSCSI additional header segment for spillover).
switch(cdbSize) {
case kSCSICDBSize_6Byte:
case kSCSICDBSize_10Byte:
case kSCSICDBSize_12Byte:
case kSCSICDBSize_16Byte:
owner->GetCommandDescriptorBlock(parallelTask,&bhs.CDB);
break;
};
// Setup the task attribute for this PDU
switch(attribute) {
case kSCSITask_ACA:
bhs.flags |= kiSCSIPDUSCSICmdTaskAttrACA; break;
case kSCSITask_HEAD_OF_QUEUE:
bhs.flags |= kiSCSIPDUSCSICmdTaskAttrHead; break;
case kSCSITask_ORDERED:
bhs.flags |= kiSCSIPDUSCSICmdTaskAttrOrdered; break;
case kSCSITask_SIMPLE:
bhs.flags |= kiSCSIPDUSCSICmdTaskAttrSimple; break;
};
// Default timeout for new tasks...
owner->SetTimeoutForTask(parallelTask,kiSCSITaskTimeoutMs);
// For non-WRITE commands, send off SCSI command PDU immediately.
if(transferDirection != kSCSIDataTransfer_FromInitiatorToTarget) {
bhs.flags |= kiSCSIPDUSCSICmdFlagNoUnsolicitedData;
owner->SendPDU(session,connection,(iSCSIPDUInitiatorBHS *)&bhs,NULL,NULL,0);
return;
}
// If there is no unsolicited data to send, simply send the WRITE
// command and return.
if(session->initialR2T && !session->immediateData) {
bhs.flags |= kiSCSIPDUSCSICmdFlagNoUnsolicitedData;
owner->SendPDU(session,connection,(iSCSIPDUInitiatorBHS *)&bhs,NULL,NULL,0);
return;
}
// At this point either immediate data, data-out PDUs or both
// are going to be sent out.
IOMemoryDescriptor * dataDesc = owner->GetDataBuffer(parallelTask);
UInt32 dataOffset = 0, dataLength = 0;
// First use immediate data to send data with command PDU...
if(session->immediateData) {
// Either send the max allowed data (immediate data length) or
// all of the data if it is lesser than the max allowed limit
dataLength = min(connection->immediateDataLength,transferSize);
UInt8 * data = (UInt8*)IOMalloc(dataLength);
dataDesc->readBytes(dataOffset,data,dataLength);
// If we need to wait for an R2T or we've transferred all data
// as immediate data then no additional data will follow this PDU...
if(session->initialR2T || dataLength == transferSize)
bhs.flags |= kiSCSIPDUSCSICmdFlagNoUnsolicitedData;
owner->SendPDU(session,connection,(iSCSIPDUInitiatorBHS *)&bhs,NULL,data,dataLength);
dataOffset += dataLength;
owner->IncrementRealizedDataTransferCount(parallelTask,dataLength);
connection->dataToTransfer -= dataLength;
IOFree(data,dataLength);
}
else {
// No immediate data (but there will be data-out following this)
// just send the WRITE command without immediate data
owner->SendPDU(session,connection,(iSCSIPDUInitiatorBHS *)&bhs,NULL,NULL,0);
}
// Follow up with data out PDUs up to the firstBurstLength bytes if...
if(!session->initialR2T && // Initial R2T = No
dataOffset < session->firstBurstLength && // Haven't hit burst limit
dataOffset < transferSize) // Data left to send
{
// Determine amount of data left to transfer and send data out PDUs
dataLength = min(session->firstBurstLength-dataOffset,transferSize-dataOffset);
owner->ProcessDataOutForTask(session,connection,parallelTask,dataOffset,dataLength,bhs.LUN,
initiatorTaskTag,kiSCSIPDUTargetTransferTagReserved);
}
}
bool iSCSIVirtualHBA::ProcessTaskOnWorkloopThread(iSCSIVirtualHBA * owner,
iSCSISession * session,
iSCSIConnection * connection)
{
// Quit if the connection isn't active (if it is not in full feature phase)
if(!owner || !session || !connection)
return true;
// Grab incoming bhs (we are guaranteed to have a basic header at this
// point (iSCSIIOEventSource ensures that this is the case)
iSCSIPDUTargetBHS bhs;
if(owner->RecvPDUHeader(session,connection,&bhs,0))
{
DBLog("iscsi: Failed to get PDU header (sid: %d, cid: %d)\n",
session->sessionId,connection->cid);
return true;
}
else
DBLog("iscsi: Received PDU type %#x (sid: %d, cid: %d)\n",
bhs.opCode,session->sessionId,connection->cid);
// Determine the kind of PDU that was received and process accordingly
enum iSCSIPDUTargetOpCodes opCode = (iSCSIPDUTargetOpCodes)bhs.opCode;
switch(opCode)
{
// Process a SCSI response
case kiSCSIPDUOpCodeSCSIRsp:
owner->ProcessSCSIResponse(session,connection,(iSCSIPDUSCSIRspBHS*)&bhs);
break;
case kiSCSIPDUOpCodeDataIn:
owner->ProcessDataIn(session,connection,(iSCSIPDUDataInBHS*)&bhs);
break;
case kiSCSIPDUOpCodeAsyncMsg:
owner->ProcessAsyncMsg(session,connection,(iSCSIPDUAsyncMsgBHS*)&bhs);
break;
case kiSCSIPDUOpCodeNOPIn:
owner->ProcessNOPIn(session,connection,(iSCSIPDUNOPInBHS*)&bhs);
break;
case kiSCSIPDUOpCodeR2T:
owner->ProcessR2T(session,connection,(iSCSIPDUR2TBHS*)&bhs);
break;
case kiSCSIPDUOpCodeReject:
owner->ProcessReject(session,connection,(iSCSIPDURejectBHS*)&bhs);
break;
case kiSCSIPDUOpCodeTaskMgmtRsp:
owner->ProcessTaskMgmtRsp(session,connection,(iSCSIPDUTaskMgmtRspBHS*)&bhs);
break;
// Catch-all for anything else...
default: break;
};
return true;
}
/** This function has been overloaded to provide additional task-timing
* support for multiple connections.
* @param parallelRequest the request to complete.
* @param completionStatus status of the request.
* @param serviceResponse the SCSI service response. */
void iSCSIVirtualHBA::CompleteParallelTask(iSCSISession * session,
iSCSIConnection * connection,
SCSIParallelTaskIdentifier parallelRequest,
SCSITaskStatus completionStatus,
SCSIServiceResponse serviceResponse)
{
if(GetDataTransferDirection(parallelRequest) == kSCSIDataTransfer_NoDataTransfer) {
super::CompleteParallelTask(parallelRequest,completionStatus,serviceResponse);
return;
}
// Compute the time it took to complete this task; first grab the timestamp
// when task was first started
clock_usec_t usecs;
clock_sec_t secs;
clock_get_system_microtime(&secs,&usecs);
UInt64 duration_usecs = (secs - connection->taskStartTimeSec)*1e6 +
(usecs - connection->taskStartTimeUSec);
// Calculate transfer speed over entire task...
UInt64 bytesTransferred = GetRequestedDataTransferCount(parallelRequest);
// Add newest measurement to list (overwriting oldest one)
connection->bytesPerSecondHistory[connection->bytesPerSecHistoryIdx]
= (UInt32)(bytesTransferred / (duration_usecs / 1.0e6));
// Advance index so next oldest record is overwritten next time (roll over)
connection->bytesPerSecHistoryIdx++;
if(connection->bytesPerSecHistoryIdx == connection->kBytesPerSecAvgWindowSize)
{
connection->bytesPerSecHistoryIdx = 0;
// Queue a latency measurement operation
UInt32 initiatorTaskTag = BuildInitiatorTaskTag(kInitiatorTaskTypeLatency,0,0);
connection->taskQueue->queueTask(initiatorTaskTag);
}
// Iterate over last few points, compute peak value
connection->bytesPerSecond = 0;
for(UInt8 i = 0; i < connection->kBytesPerSecAvgWindowSize; i++)
if(connection->bytesPerSecond < connection->bytesPerSecondHistory[i])
connection->bytesPerSecond = connection->bytesPerSecondHistory[i];
DBLog("iscsi: Bytes per second: %d (sid: %d, cid: %d)\n",
connection->bytesPerSecond,session->sessionId,connection->cid);
super::CompleteParallelTask(parallelRequest,completionStatus,serviceResponse);
}
void iSCSIVirtualHBA::ProcessTaskMgmtRsp(iSCSISession * session,
iSCSIConnection * connection,
iSCSIPDU::iSCSIPDUTaskMgmtRspBHS * bhs)
{
// Extract LUN and function code from task tag
UInt8 taskMgmtFunction = ParseInitiatorTaskTagForTaskId(bhs->initiatorTaskTag);
UInt64 LUN = ParseInitiatorTaskTagForLUN(bhs->initiatorTaskTag);
// Setup the SCSI response code based on response from PDU
SCSIServiceResponse serviceResponse;
enum iSCSIPDUTaskMgmtRspCodes rspCode = (iSCSIPDUTaskMgmtRspCodes)bhs->response;
switch(rspCode)
{
case kiSCSIPDUTaskMgmtFuncComplete:
serviceResponse = kSCSIServiceResponse_TASK_COMPLETE;
break;
case kiSCSIPDUTaskMgmtFuncRejected:
serviceResponse = kSCSIServiceResponse_FUNCTION_REJECTED;
break;
case kiSCSIPDUTaskMgmtInvalidLUN:
case kiSCSIPDUTaskMgmtAuthFail:
case kiSCSIPDUTaskMgmtFuncUnsupported:
case kiSCSIPDUTaskMgmtInvalidTask:
case kiSCSIPDUTaskMgmtReassignUnsupported:
case kiSCSIPDUTaskMgmtTaskAllegiant:
default:
serviceResponse = kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
break;
};
// Tell the SCSI stack that the function completed or failed
if(taskMgmtFunction == kiSCSIPDUTaskMgmtFuncAbortTask)
CompleteAbortTask(session->sessionId, LUN, 0, serviceResponse);
else if (taskMgmtFunction == kiSCSIPDUTaskMgmtFuncAbortTaskSet)
CompleteAbortTaskSet(session->sessionId, LUN, serviceResponse);
else if (taskMgmtFunction == kiSCSIPDUTaskMgmtFuncClearACA)
CompleteClearACA(session->sessionId, LUN, serviceResponse);
else if (taskMgmtFunction == kiSCSIPDUTaskMgmtFuncClearTaskSet)
CompleteClearTaskSet(session->sessionId, LUN, serviceResponse);
else if (taskMgmtFunction == kiSCSIPDUTaskMgmtFuncLUNReset)
CompleteLogicalUnitReset(session->sessionId, LUN, serviceResponse);
else if (taskMgmtFunction == kiSCSIPDUTaskMgmtFuncTargetWarmReset)
CompleteTargetReset(session->sessionId, serviceResponse);
// Task is complete, remove it from the queue
connection->taskQueue->completeCurrentTask();
}
void iSCSIVirtualHBA::ProcessNOPIn(iSCSISession * session,
iSCSIConnection * connection,
iSCSIPDU::iSCSIPDUNOPInBHS * bhs)
{
const size_t length = GetDataSegmentLength((iSCSIPDUTargetBHS*)bhs);
// Grab data payload (could be ping data or other data, if it exists)
UInt8 data[length];
if(length > 0 && RecvPDUData(session,connection,data,length,MSG_WAITALL) != 0) {
DBLog("iscsi: Failed to retreive NOP in data (sid: %d, cid: %d)\n",
session->sessionId,connection->cid);
return;
}
// Response to a previous ping from this initiator
if(bhs->targetTransferTag == kiSCSIPDUTargetTransferTagReserved)
{
// Will use this to calculate latency; our initiated NOP contained
// a timestamp that is sent back to us
if(length != (sizeof(clock_sec_t) + sizeof(clock_usec_t)))
return;
clock_sec_t secs_stamp, secs;
clock_usec_t usecs_stamp, usecs;
// Grab timestamp from NOP-in PDU
memcpy(&secs_stamp,data,sizeof(secs_stamp));
memcpy(&usecs_stamp,data+sizeof(secs_stamp),sizeof(usecs_stamp));
// Grab current system uptime
clock_get_system_microtime(&secs,&usecs);
connection->latency_ms = (secs - secs_stamp)*1e3 + (usecs - usecs_stamp)/1e3;
DBLog("iscsi: Connection latency: %d ms (sid: %d, cid: %d)\n",
connection->latency_ms,session->sessionId,connection->cid);
// Remove latency measurement task from queue
connection->taskQueue->completeCurrentTask();
}
// The target initiated this ping, just copy parameters and respond
else {
iSCSIPDUNOPOutBHS bhsRsp = iSCSIPDUNOPOutBHSInit;
bhsRsp.opCode |= kiSCSIPDUImmediateDeliveryFlag;
bhsRsp.LUN = bhs->LUN;
bhsRsp.targetTransferTag = bhs->targetTransferTag;
bhsRsp.initiatorTaskTag = kiSCSIPDUInitiatorTaskTagReserved;
if(SendPDU(session,connection,(iSCSIPDUInitiatorBHS*)&bhsRsp,NULL,data,length))
DBLog("iscsi: Failed to send NOP response (sid: %d, cid: %d)\n",
session->sessionId,connection->cid);
}
}
void iSCSIVirtualHBA::ProcessSCSIResponse(iSCSISession * session,
iSCSIConnection * connection,
iSCSIPDU::iSCSIPDUSCSIRspBHS * bhs)
{
// Byte size of sense data (SAM)
const UInt8 senseDataHeaderSize = 2;
const UInt32 length = GetDataSegmentLength((iSCSIPDUTargetBHS*)bhs);
UInt8 data[length];
memset(data, length, 0);
if(length > 0) {
if(RecvPDUData(session,connection,data,length,MSG_WAITALL))
DBLog("iscsi: Error retrieving data segment (sid: %d, cid: %d)\n",
session->sessionId,connection->cid);
else
DBLog("iscsi: Received sense data (sid: %d, cid: %d)\n",
session->sessionId,connection->cid);
}
// Grab parallel task associated with this PDU, indexed by task tag
SCSIParallelTaskIdentifier parallelTask =
FindTaskForControllerIdentifier(session->sessionId,bhs->initiatorTaskTag);
if(!parallelTask)
{
DBLog("iscsi: Task not found, flushing stream (ProcessSCSIResponse) (sid: %d, cid: %d)\n",
session->sessionId,connection->cid);
// Flush stream
UInt8 buffer[length];
RecvPDUData(session,connection,buffer,length,MSG_WAITALL);
return;
}
SetRealizedDataTransferCount(parallelTask,(UInt32)GetRequestedDataTransferCount(parallelTask));
// Process sense data if the PDU came with any...
bool senseDataPresent = false;
if(length >= senseDataHeaderSize)
{
// First two bytes of the data segment are the size of the sense data
UInt16 senseDataLength = *((UInt16*)&data[0]);
senseDataLength = OSSwapBigToHostInt16(senseDataLength);
if(length < senseDataLength + senseDataHeaderSize) {
DBLog("iscsi: Received invalid sense data (sid: %d, cid: %d)\n",
session->sessionId,connection->cid);
}
else {
// Remaining data is sense data, advance pointer by two bytes to get this
SCSI_Sense_Data * newSenseData = (SCSI_Sense_Data *)(data + senseDataHeaderSize);
// Incorporate sense data into the task
SetAutoSenseData(parallelTask,newSenseData,senseDataLength);
senseDataPresent = true;
DBLog("iscsi: Processed sense data (sid: %d, cid: %d)\n",
session->sessionId,connection->cid);
}
}
// Set the SCSI completion status and service response, let SCSI stack
// know that we're done with this task...
SCSITaskStatus completionStatus = (SCSITaskStatus)bhs->status;
// If sense data has been included along with a check condition response,
// the macOS SCSI stack expects that the task status is "GOOD". Otherwise,
// it queries for auto sense data.
if(completionStatus == kSCSITaskStatus_CHECK_CONDITION && senseDataPresent)
completionStatus = kSCSITaskStatus_GOOD;
SCSIServiceResponse serviceResponse;
if(bhs->response == kiSCSIPDUSCSICmdCompleted)
serviceResponse = kSCSIServiceResponse_TASK_COMPLETE;
else
serviceResponse = kSCSIServiceResponse_SERVICE_DELIVERY_OR_TARGET_FAILURE;
CompleteParallelTask(session,connection,parallelTask,completionStatus,serviceResponse);
// Task is complete, remove it from the queue
connection->taskQueue->completeCurrentTask();
DBLog("iscsi: Processed SCSI response (sid: %d, cid: %d)\n",
session->sessionId,connection->cid);
}
void iSCSIVirtualHBA::ProcessDataIn(iSCSISession * session,
iSCSIConnection * connection,
iSCSIPDU::iSCSIPDUDataInBHS * bhs)