/
iSCSIHBAUserClient.cpp
1518 lines (1237 loc) · 52.5 KB
/
iSCSIHBAUserClient.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 "iSCSIHBAUserClient.h"
#include "iSCSITypesShared.h"
#include "iSCSITypesKernel.h"
#include <IOKit/IOLib.h>
/*! Required IOKit macro that defines the constructors, destructors, etc. */
OSDefineMetaClassAndStructors(iSCSIHBAUserClient,IOUserClient);
/*! The superclass is defined as a macro to follow IOKit conventions. */
#define super IOUserClient
/*! Array of methods that can be called by user-space. */
const IOExternalMethodDispatch iSCSIHBAUserClient::methods[kiSCSIInitiatorNumMethods] = {
{
(IOExternalMethodAction) &iSCSIHBAUserClient::OpenInitiator,
0, // Scalar input count
0, // Structure input size
0, // Scalar output count
0 // Structure output size
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::CloseInitiator,
0,
0,
0,
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::CreateSession,
1, // Number of parameters in struct
kIOUCVariableStructureSize, // Packed parameters for session
3, // Returned identifiers, error code
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::ReleaseSession,
1, // Session ID
0,
0,
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::SetSessionParameter,
3, // Session ID, param ID, param value
0,
0,
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::GetSessionParameter,
2, // Session ID, param ID
0,
1, // param to get
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::CreateConnection,
2, // Session ID, number of params
kIOUCVariableStructureSize, // Packed parameters for connection
2, // Returned connection identifier, error code
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::ReleaseConnection,
2, // Session ID, connection ID
0,
0,
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::ActivateConnection,
2, // Session ID, connection ID
0,
0,
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::ActivateAllConnections,
1, // Session ID
0,
0, // Return value
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::DeactivateConnection,
2, // Session ID, connection ID
0,
0, // Return value
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::DeactivateAllConnections,
1, // Session ID
0,
0, // Return value
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::SendBHS,
0, // Session ID, connection ID
sizeof(struct __iSCSIPDUCommonBHS), // Buffer to send
0, // Return value
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::SendData,
2, // Session ID, connection ID
kIOUCVariableStructureSize, // Data is a variable size block
0,
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::RecvBHS,
2, // Session ID, connection ID
0,
0,
sizeof(struct __iSCSIPDUCommonBHS), // Receive buffer
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::RecvData,
2, // Session ID, connection ID
0,
0,
kIOUCVariableStructureSize, // Receive buffer
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::SetConnectionParameter,
4, // Session ID, connection ID, param ID, param value
0,
0,
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::GetConnectionParameter,
3, // Session ID, connection ID, param ID
0,
1, // param to get
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::GetConnection,
1, // Session ID
0,
1, // Returned connection identifier
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::GetNumConnections,
1, // Session ID
0,
1, // Returned number of connections
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::GetSessionIdForTargetIQN,
0,
kIOUCVariableStructureSize, // Target name
1, // Returned session identifier
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::GetConnectionIdForPortalAddress,
1, // Session ID
kIOUCVariableStructureSize, // Connection address structure
1, // Returned connection identifier
0
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::GetSessionIds,
0,
0,
1, // Returned session count
kIOUCVariableStructureSize // List of session identifiers
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::GetConnectionIds,
1, // Session ID
0,
1, // Returned connection count
kIOUCVariableStructureSize // List of connection ids
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::GetTargetIQNForSessionId,
1, // Session ID
0,
0,
kIOUCVariableStructureSize // Target name
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::GetPortalAddressForConnectionId,
2, // Session ID, connection ID
0,
0,
kIOUCVariableStructureSize // Portal address (C string)
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::GetPortalPortForConnectionId,
2, // Session ID, connection ID
0,
0, // Returned connection count
kIOUCVariableStructureSize // connection address structures
},
{
(IOExternalMethodAction) &iSCSIHBAUserClient::GetHostInterfaceForConnectionId,
2, // Session ID, connection ID
0,
0, // Returned connection count
kIOUCVariableStructureSize // connection address structures
}
};
IOReturn iSCSIHBAUserClient::externalMethod(uint32_t selector,
IOExternalMethodArguments * args,
IOExternalMethodDispatch * dispatch,
OSObject * target,
void * ref)
{
// Sanity check the selector
if(selector >= kiSCSIInitiatorNumMethods)
return kIOReturnUnsupported;
// Call the appropriate function for the current instance of the class
return super::externalMethod(selector,
args,
(IOExternalMethodDispatch *)&iSCSIHBAUserClient::methods[selector],
this,
ref);
}
// Called as a result of user-space call to IOServiceOpen()
bool iSCSIHBAUserClient::initWithTask(task_t owningTask,
void * securityToken,
UInt32 type,
OSDictionary * properties)
{
// Save owning task, securty token and type so that we can validate user
// as a root user (UID 0) for secure operations (e.g., adding an iSCSI
// target requires privileges).
this->owningTask = owningTask;
this->securityToken = securityToken;
this->type = type;
this->accessLock = IOLockAlloc();
this->notificationPort = MACH_PORT_NULL;
// Perform any initialization tasks here
return super::initWithTask(owningTask,securityToken,type,properties);
}
//Called after initWithTask as a result of call to IOServiceOpen()
bool iSCSIHBAUserClient::start(IOService * provider)
{
// Check to ensure that the provider is actually an iSCSI initiator
if((this->provider = OSDynamicCast(iSCSIVirtualHBA,provider)) == NULL)
return false;
return super::start(provider);
}
void iSCSIHBAUserClient::stop(IOService * provider)
{
super::stop(provider);
}
// Called as a result of user-space call to IOServiceClose()
IOReturn iSCSIHBAUserClient::clientClose()
{
// Tell HBA to release any resources that aren't active (e.g.,
// connections we started to establish but didn't activate)
// Ensure that the connection has been closed (in case the user calls
// IOServiceClose() before calling our close() method
close();
if(accessLock) {
IOLockFree(accessLock);
accessLock = NULL;
}
// Terminate ourselves
terminate();
return kIOReturnSuccess;
}
// Called if the user-space client is terminated without calling
// IOServiceClose() or close()
IOReturn iSCSIHBAUserClient::clientDied()
{
// Tell HBA to release any resources that aren't active (e.g.,
// connections we started to establish but didn't activate)
return super::clientDied();
}
/*! Invoked when a user-space application registers a notification port
* with this user client.
* @param port the port associated with the client connection.
* @param type the type.
* @param refCon a user reference value.
* @return an error code indicating the result of the operation. */
IOReturn iSCSIHBAUserClient::registerNotificationPort(mach_port_t port,
UInt32 type,
io_user_reference_t refCon)
{
notificationPort = port;
return kIOReturnSuccess;
}
/*! Send a notification message to the user-space application.
* @param message details regarding the notification message.
* @return an error code indicating the result of the operation. */
IOReturn iSCSIHBAUserClient::sendNotification(iSCSIHBANotificationMessage * message)
{
if(notificationPort == MACH_PORT_NULL)
return kIOReturnNotOpen;
if(isInactive() || provider == NULL)
return kIOReturnNotAttached;
message->header.msgh_bits = MACH_MSGH_BITS(MACH_MSG_TYPE_COPY_SEND,0);
message->header.msgh_size = sizeof(iSCSIHBANotificationMessage);
message->header.msgh_remote_port = notificationPort;
message->header.msgh_local_port = MACH_PORT_NULL;
message->header.msgh_reserved = 0;
message->header.msgh_id = 0;
mach_msg_send_from_kernel_proper(&message->header,message->header.msgh_size);
return kIOReturnSuccess;
}
/*! Sends a notification message to the user indicating that an
* iSCSI asynchronous event has occured.
* @param sessionId the session identifier.
* @param connectionId the connection identifier.
* @param event the asynchronsou event.
* @return an error code indicating the result of the operation. */
IOReturn iSCSIHBAUserClient::sendAsyncMessageNotification(SessionIdentifier sessionId,
ConnectionIdentifier connectionId,
enum iSCSIPDUAsyncMsgEvent event)
{
iSCSIHBANotificationAsyncMessage message;
message.notificationType = kiSCSIHBANotificationAsyncMessage;
message.asyncEvent = event;
message.sessionId = sessionId;
message.connectionId = connectionId;
return sendNotification((iSCSIHBANotificationMessage*)&message);
}
/*! Notifies clients that a network connnectivity issue has
* caused the specified connection and session to be dropped.
* @param sessionId session identifier.
* @param connectionId conncetion identifier.
* @return an error code indicating the result of the operation. */
IOReturn iSCSIHBAUserClient::sendTimeoutMessageNotification(SessionIdentifier sessionId,
ConnectionIdentifier connectionId)
{
iSCSIHBANotificationMessage message;
message.notificationType = kiSCSIHBANotificationTimeout;
message.sessionId = sessionId;
message.connectionId = connectionId;
return sendNotification((iSCSIHBANotificationMessage*)&message);
}
/*! Sends a notification message to the user indicating that the kernel
* extension will be terminating.
* @return an error code indicating the result of the operation. */
IOReturn iSCSIHBAUserClient::sendTerminateMessageNotification()
{
iSCSIHBANotificationMessage message;
message.notificationType = kiSCSIHBANotificationTerminate;
return sendNotification(&message);
}
// Invoked from user space remotely by calling iSCSIInitiatorOpen()
IOReturn iSCSIHBAUserClient::open()
{
// Ensure that we are attached to a provider
if(isInactive() || provider == NULL)
return kIOReturnNotAttached;
// Open the provider (iSCSIInitiator) for this client
if(provider->open(this))
return kIOReturnSuccess;
// At this point we couldn't open the client for the provider for some
// other reason
return kIOReturnNotOpen;
}
// Invoked from user space remotely by calling iSCSIInitiatorClose()
IOReturn iSCSIHBAUserClient::close()
{
// If we're not active or have no provider we're not attached
if(isInactive() || provider == NULL)
return kIOReturnNotAttached;
// If the provider isn't open for us then return not open
else if(!provider->isOpen(this))
return kIOReturnNotOpen;
// At this point we're attached & open, close the connection
provider->close(this);
return kIOReturnSuccess;
}
/*! Dispatched function called from the device interface to this user
* client .*/
IOReturn iSCSIHBAUserClient::OpenInitiator(iSCSIHBAUserClient * target,
void * reference,
IOExternalMethodArguments * args)
{
return target->open();
}
/*! Dispatched function called from the device interface to this user
* client .*/
IOReturn iSCSIHBAUserClient::CloseInitiator(iSCSIHBAUserClient * target,
void * reference,
IOExternalMethodArguments * args)
{
return target->close();
}
/*! Dispatched function invoked from user-space to create new session. */
IOReturn iSCSIHBAUserClient::CreateSession(iSCSIHBAUserClient * target,
void * reference,
IOExternalMethodArguments * args)
{
// Create a new session and return session ID
SessionIdentifier sessionId;
ConnectionIdentifier connectionId;
// Unpack the struct to get targetIQN, portalAddress, etc.
UInt64 kNumParams = *args->scalarInput;
// We expect six input arguments to CreateSession...
if(kNumParams < 6)
return kIOReturnBadArgument;
void * params[kNumParams];
size_t paramSize[kNumParams];
size_t header = sizeof(UInt64*)*kNumParams;
UInt8 * inputPos = ((UInt8*)args->structureInput)+header;
for(int idx = 0; idx < kNumParams; idx++) {
paramSize[idx] = ((UInt64*)args->structureInput)[idx];
params[idx] = inputPos;
inputPos += paramSize[idx];
}
OSString * targetIQN = OSString::withCString((const char *)params[0]);
OSString * portalAddress = OSString::withCString((const char *)params[1]);
OSString * portalPort = OSString::withCString((const char *)params[2]);
OSString * hostInterface = OSString::withCString((const char *)params[3]);
const sockaddr_storage * remoteAddress = (struct sockaddr_storage*)params[4];
const sockaddr_storage * localAddress = (struct sockaddr_storage*)params[5];
IOLockLock(target->accessLock);
// Create a connection
errno_t error = target->provider->CreateSession(
targetIQN,portalAddress,portalPort,hostInterface,remoteAddress,
localAddress,&sessionId,&connectionId);
IOLockUnlock(target->accessLock);
args->scalarOutput[0] = sessionId;
args->scalarOutput[1] = connectionId;
args->scalarOutput[2] = error;
args->scalarOutputCount = 3;
targetIQN->release();
portalAddress->release();
portalPort->release();
hostInterface->release();
return kIOReturnSuccess;
}
/*! Dispatched function invoked from user-space to release session. */
IOReturn iSCSIHBAUserClient::ReleaseSession(iSCSIHBAUserClient * target,
void * reference,
IOExternalMethodArguments * args)
{
// Release the session with the specified ID
IOLockLock(target->accessLock);
target->provider->ReleaseSession(*args->scalarInput);
IOLockUnlock(target->accessLock);
return kIOReturnSuccess;
}
// TODO: Set session options only once, when session is still inactive...
IOReturn iSCSIHBAUserClient::SetSessionParameter(iSCSIHBAUserClient * target,
void * reference,
IOExternalMethodArguments * args)
{
iSCSIVirtualHBA * hba = OSDynamicCast(iSCSIVirtualHBA,target->provider);
if(args->scalarInputCount != 3)
return kIOReturnBadArgument;
SessionIdentifier sessionId = (SessionIdentifier)args->scalarInput[0];
enum iSCSIHBASessionParameters paramType = (enum iSCSIHBASessionParameters)args->scalarInput[1];
UInt64 paramVal = args->scalarInput[2];
// Range-check input
if(sessionId >= kiSCSIMaxSessions)
return kIOReturnBadArgument;
IOLockLock(target->accessLock);
// Do nothing if session doesn't exist
iSCSISession * session = hba->sessionList[sessionId];
IOReturn retVal = kIOReturnSuccess;
if(session)
{
switch(paramType)
{
case kiSCSIHBASODataPDUInOrder:
session->dataPDUInOrder = paramVal;
break;
case kiSCSIHBASODataSequenceInOrder:
session->dataSequenceInOrder = paramVal;
break;
case kiSCSIHBASODefaultTime2Retain:
session->defaultTime2Retain = paramVal;
break;
case kiSCSIHBASODefaultTime2Wait:
session->defaultTime2Wait = paramVal;
break;
case kiSCSIHBASOErrorRecoveryLevel:
session->errorRecoveryLevel = paramVal;
break;
case kiSCSIHBASOFirstBurstLength:
session->firstBurstLength = (UInt32)paramVal;
break;
case kiSCSIHBASOImmediateData:
session->immediateData = paramVal;
break;
case kiSCSIHBASOMaxConnections:
session->maxConnections = (ConnectionIdentifier)paramVal;
break;
case kiSCSIHBASOMaxOutstandingR2T:
session->maxOutStandingR2T = paramVal;
break;
case kiSCSIHBASOMaxBurstLength:
session->maxBurstLength = (UInt32)paramVal;
break;
case kiSCSIHBASOInitialR2T:
session->initialR2T = paramVal;
break;
case kiSCSIHBASOTargetPortalGroupTag:
session->targetPortalGroupTag = paramVal;
break;
case kiSCSIHBASOTargetSessionId:
session->targetSessionId = paramVal;
break;
default:
retVal = kIOReturnBadArgument;
};
}
else {
retVal = kIOReturnBadArgument;
}
IOLockUnlock(target->accessLock);
return retVal;
}
IOReturn iSCSIHBAUserClient::GetSessionParameter(iSCSIHBAUserClient * target,
void * reference,
IOExternalMethodArguments * args)
{
iSCSIVirtualHBA * hba = OSDynamicCast(iSCSIVirtualHBA,target->provider);
if(args->scalarInputCount != 2)
return kIOReturnBadArgument;
SessionIdentifier sessionId = (SessionIdentifier)args->scalarInput[0];
enum iSCSIHBASessionParameters paramType = (enum iSCSIHBASessionParameters)args->scalarInput[1];
// Range-check input
if(sessionId >= kiSCSIMaxSessions)
return kIOReturnBadArgument;
IOLockLock(target->accessLock);
// Do nothing if session doesn't exist
iSCSISession * session = hba->sessionList[sessionId];
IOReturn retVal = kIOReturnSuccess;
UInt64 * paramVal = args->scalarOutput;
if(session)
{
switch(paramType)
{
case kiSCSIHBASODataPDUInOrder:
*paramVal = session->dataPDUInOrder;
break;
case kiSCSIHBASODataSequenceInOrder:
*paramVal = session->dataSequenceInOrder;
break;
case kiSCSIHBASODefaultTime2Retain:
*paramVal = session->defaultTime2Retain;
break;
case kiSCSIHBASODefaultTime2Wait:
*paramVal = session->defaultTime2Wait;
break;
case kiSCSIHBASOErrorRecoveryLevel:
*paramVal = session->errorRecoveryLevel;
break;
case kiSCSIHBASOFirstBurstLength:
*paramVal = session->firstBurstLength;
break;
case kiSCSIHBASOImmediateData:
*paramVal = session->immediateData;
break;
case kiSCSIHBASOMaxConnections:
*paramVal = session->maxConnections;
break;
case kiSCSIHBASOMaxOutstandingR2T:
*paramVal = session->maxOutStandingR2T;
break;
case kiSCSIHBASOMaxBurstLength:
*paramVal = session->maxBurstLength;
break;
case kiSCSIHBASOInitialR2T:
*paramVal = session->initialR2T;
break;
case kiSCSIHBASOTargetPortalGroupTag:
*paramVal = session->targetPortalGroupTag;
break;
case kiSCSIHBASOTargetSessionId:
*paramVal = session->targetSessionId;
break;
default:
retVal = kIOReturnBadArgument;
};
}
else {
retVal = kIOReturnNotFound;
}
IOLockUnlock(target->accessLock);
return retVal;
}
/*! Dispatched function invoked from user-space to create new connection. */
IOReturn iSCSIHBAUserClient::CreateConnection(iSCSIHBAUserClient * target,
void * reference,
IOExternalMethodArguments * args)
{
SessionIdentifier sessionId = (SessionIdentifier)args->scalarInput[0];
ConnectionIdentifier connectionId;
// Unpack the struct to get targetIQN, portalAddress, etc.
UInt64 kNumParams = args->scalarInput[1];
// We expect six input arguments to CreateSession...
if(kNumParams < 5)
return kIOReturnBadArgument;
void * params[kNumParams];
size_t paramSize[kNumParams];
size_t header = sizeof(UInt64*)*kNumParams;
UInt8 * inputPos = ((UInt8*)args->structureInput)+header;
for(int idx = 0; idx < kNumParams; idx++) {
paramSize[idx] = ((UInt64*)args->structureInput)[idx];
params[idx] = inputPos;
inputPos += paramSize[idx];
}
OSString * portalAddress = OSString::withCString((const char *)params[0]);
OSString * portalPort = OSString::withCString((const char *)params[1]);
OSString * hostInterface = OSString::withCString((const char *)params[2]);
const sockaddr_storage * remoteAddress = (struct sockaddr_storage*)params[3];
const sockaddr_storage * localAddress = (struct sockaddr_storage*)params[4];
IOLockLock(target->accessLock);
// Create a connection
errno_t error = target->provider->CreateConnection(
sessionId,portalAddress,portalPort,hostInterface,remoteAddress,
localAddress,&connectionId);
IOLockUnlock(target->accessLock);
args->scalarOutput[0] = connectionId;
args->scalarOutput[1] = error;
args->scalarOutputCount = 2;
return kIOReturnSuccess;
}
/*! Dispatched function invoked from user-space to release connection. */
IOReturn iSCSIHBAUserClient::ReleaseConnection(iSCSIHBAUserClient * target,
void * reference,
IOExternalMethodArguments * args)
{
iSCSIVirtualHBA * hba = OSDynamicCast(iSCSIVirtualHBA,target->provider);
SessionIdentifier sessionId = (SessionIdentifier)args->scalarInput[0];
ConnectionIdentifier connectionId = (ConnectionIdentifier)args->scalarInput[1];
// Range-check input
if(sessionId >= kiSCSIMaxSessions || connectionId >= kiSCSIMaxConnectionsPerSession)
return kIOReturnBadArgument;
IOLockLock(target->accessLock);
iSCSISession * session = hba->sessionList[sessionId];
// If this is the only connection, releasing the connection should
// release the session as well...
ConnectionIdentifier connectionCount = 0;
if(session) {
// Iterate over list of connections to see how many are valid
for(ConnectionIdentifier connectionId = 0; connectionId < kiSCSIMaxConnectionsPerSession; connectionId++)
if(session->connections[connectionId])
connectionCount++;
}
if(connectionCount == 1)
target->provider->ReleaseSession(sessionId);
else
target->provider->ReleaseConnection(sessionId,connectionId);
IOLockUnlock(target->accessLock);
return kIOReturnSuccess;
}
IOReturn iSCSIHBAUserClient::ActivateConnection(iSCSIHBAUserClient * target,
void * reference,
IOExternalMethodArguments * args)
{
IOLockLock(target->accessLock);
*args->scalarOutput =
target->provider->ActivateConnection((SessionIdentifier)args->scalarInput[0],
(ConnectionIdentifier)args->scalarInput[1]);
IOLockUnlock(target->accessLock);
return kIOReturnSuccess;
}
IOReturn iSCSIHBAUserClient::ActivateAllConnections(iSCSIHBAUserClient * target,
void * reference,
IOExternalMethodArguments * args)
{
IOLockLock(target->accessLock);
*args->scalarOutput =
target->provider->ActivateAllConnections((SessionIdentifier)args->scalarInput[0]);
IOLockUnlock(target->accessLock);
return kIOReturnSuccess;
}
IOReturn iSCSIHBAUserClient::DeactivateConnection(iSCSIHBAUserClient * target,
void * reference,
IOExternalMethodArguments * args)
{
IOLockLock(target->accessLock);
*args->scalarOutput =
target->provider->DeactivateConnection((SessionIdentifier)args->scalarInput[0],
(ConnectionIdentifier)args->scalarInput[1]);
IOLockUnlock(target->accessLock);
return kIOReturnSuccess;
}
IOReturn iSCSIHBAUserClient::DeactivateAllConnections(iSCSIHBAUserClient * target,
void * reference,
IOExternalMethodArguments * args)
{
IOLockLock(target->accessLock);
*args->scalarOutput =
target->provider->DeactivateAllConnections((SessionIdentifier)args->scalarInput[0]);
IOLockUnlock(target->accessLock);
return kIOReturnSuccess;
}
/*! Dispatched function invoked from user-space to send data
* over an existing, active connection. */
IOReturn iSCSIHBAUserClient::SendBHS(iSCSIHBAUserClient * target,
void * reference,
IOExternalMethodArguments * args)
{
// Validate input
if(args->structureInputSize != kiSCSIPDUBasicHeaderSegmentSize)
return kIOReturnNoSpace;
IOLockLock(target->accessLock);
memcpy(&target->bhsBuffer,args->structureInput,kiSCSIPDUBasicHeaderSegmentSize);
IOLockUnlock(target->accessLock);
return kIOReturnSuccess;
}
/*! Dispatched function invoked from user-space to send data
* over an existing, active connection. */
IOReturn iSCSIHBAUserClient::SendData(iSCSIHBAUserClient * target,
void * reference,
IOExternalMethodArguments * args)
{
iSCSIVirtualHBA * hba = OSDynamicCast(iSCSIVirtualHBA,target->provider);
SessionIdentifier sessionId = (SessionIdentifier)args->scalarInput[0];
ConnectionIdentifier connectionId = (ConnectionIdentifier)args->scalarInput[1];
// Range-check input
if(sessionId >= kiSCSIMaxSessions || connectionId >= kiSCSIMaxConnectionsPerSession)
return kIOReturnBadArgument;
IOLockLock(target->accessLock);
// Do nothing if session doesn't exist
iSCSISession * session = hba->sessionList[sessionId];
iSCSIConnection * connection = NULL;
if(session)
connection = session->connections[connectionId];
const void * data = args->structureInput;
size_t length = args->structureInputSize;
// Send data and return the result
IOReturn retVal = kIOReturnNotFound;
if(connection) {
if(hba->SendPDU(session,connection,&(target->bhsBuffer),nullptr,data,length))
retVal = kIOReturnError;
else
retVal = kIOReturnSuccess;
}
IOLockUnlock(target->accessLock);
return retVal;
}
/*! Dispatched function invoked from user-space to receive data
* over an existing, active connection, and to retrieve the size of
* a user-space buffer that is required to hold the data. */
IOReturn iSCSIHBAUserClient::RecvBHS(iSCSIHBAUserClient * target,
void * reference,
IOExternalMethodArguments * args)
{
// Verify user-supplied buffer is large enough to hold BHS
if(args->structureOutputSize != kiSCSIPDUBasicHeaderSegmentSize)
return kIOReturnNoSpace;
iSCSIVirtualHBA * hba = OSDynamicCast(iSCSIVirtualHBA,target->provider);
SessionIdentifier sessionId = (SessionIdentifier)args->scalarInput[0];
ConnectionIdentifier connectionId = (ConnectionIdentifier)args->scalarInput[1];
// Range-check input
if(sessionId >= kiSCSIMaxSessions || connectionId >= kiSCSIMaxConnectionsPerSession)
return kIOReturnBadArgument;
IOLockLock(target->accessLock);
// Do nothing if session doesn't exist
iSCSISession * session = hba->sessionList[sessionId];
iSCSIConnection * connection = NULL;
if(session)
connection = session->connections[connectionId];
// Receive data and return the result
IOReturn retVal = kIOReturnNotFound;
iSCSIPDUTargetBHS * bhs = (iSCSIPDUTargetBHS*)args->structureOutput;
if(connection) {
if(hba->RecvPDUHeader(session,connection,bhs,MSG_WAITALL))
retVal = kIOReturnIOError;
else
retVal = kIOReturnSuccess;
}
IOLockUnlock(target->accessLock);
return retVal;
}
/*! Dispatched function invoked from user-space to receive data
* over an existing, active connection, and to retrieve the size of
* a user-space buffer that is required to hold the data. */
IOReturn iSCSIHBAUserClient::RecvData(iSCSIHBAUserClient * target,
void * reference,
IOExternalMethodArguments * args)
{
iSCSIVirtualHBA * hba = OSDynamicCast(iSCSIVirtualHBA,target->provider);
SessionIdentifier sessionId = (SessionIdentifier)args->scalarInput[0];
ConnectionIdentifier connectionId = (ConnectionIdentifier)args->scalarInput[1];
// Range-check input
if(sessionId >= kiSCSIMaxSessions || connectionId >= kiSCSIMaxConnectionsPerSession)
return kIOReturnBadArgument;
IOLockLock(target->accessLock);
// Do nothing if session doesn't exist
iSCSISession * session = hba->sessionList[sessionId];
iSCSIConnection * connection = NULL;
if(session)
connection = session->connections[connectionId];
// Receive data and return the result
IOReturn retVal = kIOReturnNotFound;
void * data = (void *)args->structureOutput;
size_t length = args->structureOutputSize;
if(hba->RecvPDUData(session,connection,data,length,MSG_WAITALL))
retVal = kIOReturnIOError;
else
retVal = kIOReturnSuccess;
IOLockUnlock(target->accessLock);
return retVal;
}
// TODO: Only allow user to set options when connection is inactive
// TODO: optimize socket parameters based on connection options
IOReturn iSCSIHBAUserClient::SetConnectionParameter(iSCSIHBAUserClient * target,
void * reference,
IOExternalMethodArguments * args)
{
iSCSIVirtualHBA * hba = OSDynamicCast(iSCSIVirtualHBA,target->provider);
if(args->scalarInputCount != 4)
return kIOReturnBadArgument;
SessionIdentifier sessionId = (SessionIdentifier)args->scalarInput[0];
ConnectionIdentifier connectionId = (ConnectionIdentifier)args->scalarInput[1];
enum iSCSIHBAConnectionParameters paramType = (enum iSCSIHBAConnectionParameters)args->scalarInput[2];
UInt64 paramVal = args->scalarInput[3];
// Range-check input
if(sessionId >= kiSCSIMaxSessions || connectionId >= kiSCSIMaxConnectionsPerSession)
return kIOReturnBadArgument;
IOLockLock(target->accessLock);
// Do nothing if session doesn't exist
iSCSISession * session = hba->sessionList[sessionId];
iSCSIConnection * connection = NULL;
if(session)
connection = session->connections[connectionId];