]> git.proxmox.com Git - mirror_edk2.git/blob - NetworkPkg/IScsiDxe/IScsiProto.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
NetworkPkg/IScsiDxe: re-set session-level authentication state before login
[mirror_edk2.git] / NetworkPkg / IScsiDxe / IScsiProto.c
1 /** @file
2 The implementation of iSCSI protocol based on RFC3720.
3
4 Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
6
7 **/
8
9 #include "IScsiImpl.h"
10
11 UINT32 mDataSegPad = 0;
12
13 /**
14 Attach the iSCSI connection to the iSCSI session.
15
16 @param[in, out] Session The iSCSI session.
17 @param[in, out] Conn The iSCSI connection.
18
19 **/
20 VOID
21 IScsiAttatchConnection (
22 IN OUT ISCSI_SESSION *Session,
23 IN OUT ISCSI_CONNECTION *Conn
24 )
25 {
26 InsertTailList (&Session->Conns, &Conn->Link);
27 Conn->Session = Session;
28 Session->NumConns++;
29 }
30
31 /**
32 Detach the iSCSI connection from the session it belongs to.
33
34 @param[in, out] Conn The iSCSI connection.
35
36 **/
37 VOID
38 IScsiDetatchConnection (
39 IN OUT ISCSI_CONNECTION *Conn
40 )
41 {
42 RemoveEntryList (&Conn->Link);
43 Conn->Session->NumConns--;
44 Conn->Session = NULL;
45 }
46
47
48 /**
49 Check the sequence number according to RFC3720.
50
51 @param[in, out] ExpSN The currently expected sequence number.
52 @param[in] NewSN The sequence number to check.
53
54 @retval EFI_SUCCESS The check passed and the ExpSN is increased.
55 @retval EFI_NOT_READY Response was sent due to a retransmission request.
56 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
57
58 **/
59 EFI_STATUS
60 IScsiCheckSN (
61 IN OUT UINT32 *ExpSN,
62 IN UINT32 NewSN
63 )
64 {
65 if (!ISCSI_SEQ_EQ (NewSN, *ExpSN)) {
66 if (ISCSI_SEQ_LT (NewSN, *ExpSN)) {
67 //
68 // Duplicate
69 //
70 return EFI_NOT_READY;
71 } else {
72 return EFI_PROTOCOL_ERROR;
73 }
74 } else {
75 //
76 // Advance the ExpSN
77 //
78 (*ExpSN)++;
79 return EFI_SUCCESS;
80 }
81 }
82
83
84 /**
85 Update the sequence numbers for the iSCSI command.
86
87 @param[in, out] Session The iSCSI session.
88 @param[in] MaxCmdSN Maximum CmdSN from the target.
89 @param[in] ExpCmdSN Next expected CmdSN from the target.
90
91 **/
92 VOID
93 IScsiUpdateCmdSN (
94 IN OUT ISCSI_SESSION *Session,
95 IN UINT32 MaxCmdSN,
96 IN UINT32 ExpCmdSN
97 )
98 {
99 if (ISCSI_SEQ_LT (MaxCmdSN, ExpCmdSN - 1)) {
100 return ;
101 }
102
103 if (ISCSI_SEQ_GT (MaxCmdSN, Session->MaxCmdSN)) {
104 Session->MaxCmdSN = MaxCmdSN;
105 }
106
107 if (ISCSI_SEQ_GT (ExpCmdSN, Session->ExpCmdSN)) {
108 Session->ExpCmdSN = ExpCmdSN;
109 }
110 }
111
112
113 /**
114 This function does the iSCSI connection login.
115
116 @param[in, out] Conn The iSCSI connection to login.
117 @param Timeout The timeout value in millisecond.
118
119 @retval EFI_SUCCESS The iSCSI connection is logged into the iSCSI target.
120 @retval EFI_TIMEOUT Timeout occurred during the login procedure.
121 @retval Others Other errors as indicated.
122
123 **/
124 EFI_STATUS
125 IScsiConnLogin (
126 IN OUT ISCSI_CONNECTION *Conn,
127 IN UINT16 Timeout
128 )
129 {
130 EFI_STATUS Status;
131
132 //
133 // Start the timer, and wait Timeout seconds to establish the TCP connection.
134 //
135 Status = gBS->SetTimer (
136 Conn->TimeoutEvent,
137 TimerRelative,
138 MultU64x32 (Timeout, TICKS_PER_MS)
139 );
140 if (EFI_ERROR (Status)) {
141 return Status;
142 }
143
144 //
145 // Try to establish the tcp connection.
146 //
147 Status = TcpIoConnect (&Conn->TcpIo, Conn->TimeoutEvent);
148 gBS->SetTimer (Conn->TimeoutEvent, TimerCancel, 0);
149
150 if (EFI_ERROR (Status)) {
151 return Status;
152 }
153
154 Conn->State = CONN_STATE_IN_LOGIN;
155
156 //
157 // Connection is established, start the iSCSI Login.
158 //
159 do {
160 Status = IScsiSendLoginReq (Conn);
161 if (EFI_ERROR (Status)) {
162 break;
163 }
164
165 Status = IScsiReceiveLoginRsp (Conn);
166 if (EFI_ERROR (Status)) {
167 break;
168 }
169 } while (Conn->CurrentStage != ISCSI_FULL_FEATURE_PHASE);
170
171 return Status;
172 }
173
174
175 /**
176 Reset the iSCSI connection.
177
178 @param[in, out] Conn The iSCSI connection to reset.
179
180 **/
181 VOID
182 IScsiConnReset (
183 IN OUT ISCSI_CONNECTION *Conn
184 )
185 {
186 TcpIoReset (&Conn->TcpIo);
187 }
188
189
190 /**
191 Create a TCP connection for the iSCSI session.
192
193 @param[in] Session Points to the iSCSI session.
194
195 @return The newly created iSCSI connection.
196
197 **/
198 ISCSI_CONNECTION *
199 IScsiCreateConnection (
200 IN ISCSI_SESSION *Session
201 )
202 {
203 ISCSI_DRIVER_DATA *Private;
204 ISCSI_SESSION_CONFIG_NVDATA *NvData;
205 ISCSI_CONNECTION *Conn;
206 TCP_IO_CONFIG_DATA TcpIoConfig;
207 TCP4_IO_CONFIG_DATA *Tcp4IoConfig;
208 TCP6_IO_CONFIG_DATA *Tcp6IoConfig;
209 EFI_STATUS Status;
210
211 Private = Session->Private;
212 NvData = &Session->ConfigData->SessionConfigData;
213
214 Conn = AllocateZeroPool (sizeof (ISCSI_CONNECTION));
215 if (Conn == NULL) {
216 return NULL;
217 }
218
219 Conn->Signature = ISCSI_CONNECTION_SIGNATURE;
220 Conn->State = CONN_STATE_FREE;
221 Conn->CurrentStage = ISCSI_SECURITY_NEGOTIATION;
222 Conn->NextStage = ISCSI_LOGIN_OPERATIONAL_NEGOTIATION;
223 Conn->AuthStep = ISCSI_AUTH_INITIAL;
224 Conn->ExpStatSN = 0;
225 Conn->PartialReqSent = FALSE;
226 Conn->PartialRspRcvd = FALSE;
227 Conn->ParamNegotiated = FALSE;
228 Conn->Cid = Session->NextCid++;
229 Conn->Ipv6Flag = NvData->IpMode == IP_MODE_IP6 || Session->ConfigData->AutoConfigureMode == IP_MODE_AUTOCONFIG_IP6;
230
231 Status = gBS->CreateEvent (
232 EVT_TIMER,
233 TPL_CALLBACK,
234 NULL,
235 NULL,
236 &Conn->TimeoutEvent
237 );
238 if (EFI_ERROR (Status)) {
239 FreePool (Conn);
240 return NULL;
241 }
242
243 NetbufQueInit (&Conn->RspQue);
244
245 //
246 // Set the default connection-only parameters.
247 //
248 Conn->MaxRecvDataSegmentLength = DEFAULT_MAX_RECV_DATA_SEG_LEN;
249 Conn->HeaderDigest = IScsiDigestNone;
250 Conn->DataDigest = IScsiDigestNone;
251
252 if (NvData->DnsMode) {
253 //
254 // perform dns process if target address expressed by domain name.
255 //
256 if (!Conn->Ipv6Flag) {
257 Status = IScsiDns4 (Private->Image, Private->Controller, NvData);
258 } else {
259 Status = IScsiDns6 (Private->Image, Private->Controller, NvData);
260 }
261
262 if (EFI_ERROR(Status)) {
263 DEBUG ((EFI_D_ERROR, "The configuration of Target address or DNS server address is invalid!\n"));
264 FreePool (Conn);
265 return NULL;
266 }
267 }
268
269 if (!Conn->Ipv6Flag) {
270 Tcp4IoConfig = &TcpIoConfig.Tcp4IoConfigData;
271
272 CopyMem (&Tcp4IoConfig->LocalIp, &NvData->LocalIp, sizeof (EFI_IPv4_ADDRESS));
273 CopyMem (&Tcp4IoConfig->SubnetMask, &NvData->SubnetMask, sizeof (EFI_IPv4_ADDRESS));
274 CopyMem (&Tcp4IoConfig->Gateway, &NvData->Gateway, sizeof (EFI_IPv4_ADDRESS));
275 CopyMem (&Tcp4IoConfig->RemoteIp, &NvData->TargetIp, sizeof (EFI_IPv4_ADDRESS));
276
277 Tcp4IoConfig->RemotePort = NvData->TargetPort;
278 Tcp4IoConfig->ActiveFlag = TRUE;
279 Tcp4IoConfig->StationPort = 0;
280 } else {
281 Tcp6IoConfig = &TcpIoConfig.Tcp6IoConfigData;
282
283 CopyMem (&Tcp6IoConfig->RemoteIp, &NvData->TargetIp, sizeof (EFI_IPv6_ADDRESS));
284 Tcp6IoConfig->RemotePort = NvData->TargetPort;
285 Tcp6IoConfig->ActiveFlag = TRUE;
286 Tcp6IoConfig->StationPort = 0;
287 }
288
289 //
290 // Create the TCP IO for this connection.
291 //
292 Status = TcpIoCreateSocket (
293 Private->Image,
294 Private->Controller,
295 (UINT8) (!Conn->Ipv6Flag ? TCP_VERSION_4: TCP_VERSION_6),
296 &TcpIoConfig,
297 &Conn->TcpIo
298 );
299 if (EFI_ERROR (Status)) {
300 gBS->CloseEvent (Conn->TimeoutEvent);
301 FreePool (Conn);
302 Conn = NULL;
303 }
304
305 return Conn;
306 }
307
308
309 /**
310 Destroy an iSCSI connection.
311
312 @param[in] Conn The connection to destroy.
313
314 **/
315 VOID
316 IScsiDestroyConnection (
317 IN ISCSI_CONNECTION *Conn
318 )
319 {
320 TcpIoDestroySocket (&Conn->TcpIo);
321
322 NetbufQueFlush (&Conn->RspQue);
323 gBS->CloseEvent (Conn->TimeoutEvent);
324 FreePool (Conn);
325 }
326
327 /**
328 Retrieve the IPv6 Address/Prefix/Gateway from the established TCP connection, these informations
329 will be filled in the iSCSI Boot Firmware Table.
330
331 @param[in] Conn The connection used in the iSCSI login phase.
332
333 @retval EFI_SUCCESS Get the NIC information successfully.
334 @retval Others Other errors as indicated.
335
336 **/
337 EFI_STATUS
338 IScsiGetIp6NicInfo (
339 IN ISCSI_CONNECTION *Conn
340 )
341 {
342 ISCSI_SESSION_CONFIG_NVDATA *NvData;
343 EFI_TCP6_PROTOCOL *Tcp6;
344 EFI_IP6_MODE_DATA Ip6ModeData;
345 EFI_STATUS Status;
346 EFI_IPv6_ADDRESS *TargetIp;
347 UINTN Index;
348 UINT8 SubnetPrefixLength;
349 UINTN RouteEntry;
350
351 NvData = &Conn->Session->ConfigData->SessionConfigData;
352 TargetIp = &NvData->TargetIp.v6;
353 Tcp6 = Conn->TcpIo.Tcp.Tcp6;
354
355 ZeroMem (&Ip6ModeData, sizeof (EFI_IP6_MODE_DATA));
356 Status = Tcp6->GetModeData (
357 Tcp6,
358 NULL,
359 NULL,
360 &Ip6ModeData,
361 NULL,
362 NULL
363 );
364 if (EFI_ERROR (Status)) {
365 return Status;
366 }
367
368 if (!Ip6ModeData.IsConfigured) {
369 Status = EFI_ABORTED;
370 goto ON_EXIT;
371 }
372
373 IP6_COPY_ADDRESS (&NvData->LocalIp, &Ip6ModeData.ConfigData.StationAddress);
374
375 NvData->PrefixLength = 0;
376 for (Index = 0; Index < Ip6ModeData.AddressCount; Index++) {
377 if (EFI_IP6_EQUAL (&NvData->LocalIp.v6, &Ip6ModeData.AddressList[Index].Address)) {
378 NvData->PrefixLength = Ip6ModeData.AddressList[Index].PrefixLength;
379 break;
380 }
381 }
382
383 SubnetPrefixLength = 0;
384 RouteEntry = Ip6ModeData.RouteCount;
385 for (Index = 0; Index < Ip6ModeData.RouteCount; Index++) {
386 if (NetIp6IsNetEqual (TargetIp, &Ip6ModeData.RouteTable[Index].Destination, Ip6ModeData.RouteTable[Index].PrefixLength)) {
387 if (SubnetPrefixLength < Ip6ModeData.RouteTable[Index].PrefixLength) {
388 SubnetPrefixLength = Ip6ModeData.RouteTable[Index].PrefixLength;
389 RouteEntry = Index;
390 }
391 }
392 }
393 if (RouteEntry != Ip6ModeData.RouteCount) {
394 IP6_COPY_ADDRESS (&NvData->Gateway, &Ip6ModeData.RouteTable[RouteEntry].Gateway);
395 }
396
397 ON_EXIT:
398 if (Ip6ModeData.AddressList != NULL) {
399 FreePool (Ip6ModeData.AddressList);
400 }
401 if (Ip6ModeData.GroupTable!= NULL) {
402 FreePool (Ip6ModeData.GroupTable);
403 }
404 if (Ip6ModeData.RouteTable!= NULL) {
405 FreePool (Ip6ModeData.RouteTable);
406 }
407 if (Ip6ModeData.NeighborCache!= NULL) {
408 FreePool (Ip6ModeData.NeighborCache);
409 }
410 if (Ip6ModeData.PrefixTable!= NULL) {
411 FreePool (Ip6ModeData.PrefixTable);
412 }
413 if (Ip6ModeData.IcmpTypeList!= NULL) {
414 FreePool (Ip6ModeData.IcmpTypeList);
415 }
416
417 return Status;
418 }
419
420 /**
421 Re-set any stateful session-level authentication information that is used by
422 the leading login / leading connection.
423
424 (Note that this driver only supports a single connection per session -- see
425 ISCSI_MAX_CONNS_PER_SESSION.)
426
427 @param[in,out] Session The iSCSI session.
428 **/
429 STATIC
430 VOID
431 IScsiSessionResetAuthData (
432 IN OUT ISCSI_SESSION *Session
433 )
434 {
435 }
436
437 /**
438 Login the iSCSI session.
439
440 @param[in] Session The iSCSI session.
441
442 @retval EFI_SUCCESS The iSCSI session login procedure finished.
443 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
444 @retval EFI_NO_MEDIA There was a media error.
445 @retval Others Other errors as indicated.
446
447 **/
448 EFI_STATUS
449 IScsiSessionLogin (
450 IN ISCSI_SESSION *Session
451 )
452 {
453 EFI_STATUS Status;
454 ISCSI_CONNECTION *Conn;
455 VOID *Tcp;
456 EFI_GUID *ProtocolGuid;
457 UINT8 RetryCount;
458 EFI_STATUS MediaStatus;
459
460 //
461 // Check media status before session login.
462 //
463 MediaStatus = EFI_SUCCESS;
464 NetLibDetectMediaWaitTimeout (Session->Private->Controller, ISCSI_CHECK_MEDIA_LOGIN_WAITING_TIME, &MediaStatus);
465 if (MediaStatus != EFI_SUCCESS) {
466 return EFI_NO_MEDIA;
467 }
468
469 //
470 // Set session identifier
471 //
472 CopyMem (Session->Isid, Session->ConfigData->SessionConfigData.IsId, 6);
473
474 RetryCount = 0;
475
476 do {
477 //
478 // Create a connection for the session.
479 //
480 Conn = IScsiCreateConnection (Session);
481 if (Conn == NULL) {
482 return EFI_OUT_OF_RESOURCES;
483 }
484
485 IScsiAttatchConnection (Session, Conn);
486
487 //
488 // Login through the newly created connection.
489 //
490 IScsiSessionResetAuthData (Session);
491 Status = IScsiConnLogin (Conn, Session->ConfigData->SessionConfigData.ConnectTimeout);
492 if (EFI_ERROR (Status)) {
493 IScsiConnReset (Conn);
494 IScsiDetatchConnection (Conn);
495 IScsiDestroyConnection (Conn);
496 }
497
498 if (Status != EFI_TIMEOUT) {
499 break;
500 }
501
502 RetryCount++;
503 } while (RetryCount <= Session->ConfigData->SessionConfigData.ConnectRetryCount);
504
505 if (!EFI_ERROR (Status)) {
506 Session->State = SESSION_STATE_LOGGED_IN;
507
508 if (!Conn->Ipv6Flag) {
509 ProtocolGuid = &gEfiTcp4ProtocolGuid;
510 } else {
511 ProtocolGuid = &gEfiTcp6ProtocolGuid;
512 }
513
514 Status = gBS->OpenProtocol (
515 Conn->TcpIo.Handle,
516 ProtocolGuid,
517 (VOID **) &Tcp,
518 Session->Private->Image,
519 Session->Private->ExtScsiPassThruHandle,
520 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
521 );
522
523 ASSERT_EFI_ERROR (Status);
524
525 if (Conn->Ipv6Flag) {
526 Status = IScsiGetIp6NicInfo (Conn);
527 }
528 }
529
530 return Status;
531 }
532
533
534 /**
535 Wait for IPsec negotiation, then try to login the iSCSI session again.
536
537 @param[in] Session The iSCSI session.
538
539 @retval EFI_SUCCESS The iSCSI session login procedure finished.
540 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
541 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
542
543 **/
544 EFI_STATUS
545 IScsiSessionReLogin (
546 IN ISCSI_SESSION *Session
547 )
548 {
549
550 EFI_STATUS Status;
551 EFI_STATUS TimerStatus;
552 EFI_EVENT Timer;
553
554 Status = gBS->CreateEvent (EVT_TIMER, TPL_CALLBACK, NULL, NULL, &Timer);
555 if (EFI_ERROR (Status)) {
556 return Status;
557 }
558
559 Status = gBS->SetTimer (
560 Timer,
561 TimerRelative,
562 ISCSI_WAIT_IPSEC_TIMEOUT
563 );
564
565 if (EFI_ERROR (Status)) {
566 gBS->CloseEvent (Timer);
567 return Status;
568 }
569
570 do {
571
572 TimerStatus = gBS->CheckEvent (Timer);
573
574 if (!EFI_ERROR (TimerStatus)) {
575 Status = IScsiSessionLogin (Session);
576 }
577
578 } while (TimerStatus == EFI_NOT_READY);
579
580 gBS->CloseEvent (Timer);
581 return Status;
582 }
583
584
585 /**
586 Build and send the iSCSI login request to the iSCSI target according to
587 the current login stage.
588
589 @param[in] Conn The connection in the iSCSI login phase.
590
591 @retval EFI_SUCCESS The iSCSI login request PDU is built and sent on this
592 connection.
593 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
594 @retval EFI_DEVICE_ERROR Some kind of device error occurred.
595
596 **/
597 EFI_STATUS
598 IScsiSendLoginReq (
599 IN ISCSI_CONNECTION *Conn
600 )
601 {
602 NET_BUF *Pdu;
603 EFI_STATUS Status;
604
605 //
606 // Build the Login Request PDU.
607 //
608 Pdu = IScsiPrepareLoginReq (Conn);
609 if (Pdu == NULL) {
610 return EFI_DEVICE_ERROR;
611 }
612 //
613 // Send it to the iSCSI target.
614 //
615 Status = TcpIoTransmit (&Conn->TcpIo, Pdu);
616
617 NetbufFree (Pdu);
618
619 return Status;
620 }
621
622
623 /**
624 Receive and process the iSCSI login response.
625
626 @param[in] Conn The connection in the iSCSI login phase.
627
628 @retval EFI_SUCCESS The iSCSI login response PDU is received and processed.
629 @retval Others Other errors as indicated.
630
631 **/
632 EFI_STATUS
633 IScsiReceiveLoginRsp (
634 IN ISCSI_CONNECTION *Conn
635 )
636 {
637 EFI_STATUS Status;
638 NET_BUF *Pdu;
639
640 Pdu = NULL;
641
642 //
643 // Receive the iSCSI login response.
644 //
645 Status = IScsiReceivePdu (Conn, &Pdu, NULL, FALSE, FALSE, NULL);
646 if (EFI_ERROR (Status)) {
647 return Status;
648 }
649 ASSERT (Pdu != NULL);
650
651 //
652 // A Login Response is received; process it.
653 //
654 Status = IScsiProcessLoginRsp (Conn, Pdu);
655
656 NetbufFree (Pdu);
657
658 return Status;
659 }
660
661
662 /**
663 Add an iSCSI key-value pair as a string into the data segment of the Login Request PDU.
664 The DataSegmentLength and the actual size of the net buffer containing this PDU will be
665 updated.
666
667 @param[in, out] Pdu The iSCSI PDU whose data segment the key-value pair will
668 be added to.
669 @param[in] Key The key name string.
670 @param[in] Value The value string.
671
672 @retval EFI_SUCCESS The key-value pair is added to the PDU's data segment and
673 the correspondence length fields are updated.
674 @retval EFI_OUT_OF_RESOURCES There is not enough space in the PDU to add the key-value
675 pair.
676 @retval EFI_PROTOCOL_ERROR There is no such data in the net buffer.
677 **/
678 EFI_STATUS
679 IScsiAddKeyValuePair (
680 IN OUT NET_BUF *Pdu,
681 IN CHAR8 *Key,
682 IN CHAR8 *Value
683 )
684 {
685 UINT32 DataSegLen;
686 UINT32 KeyLen;
687 UINT32 ValueLen;
688 UINT32 TotalLen;
689 ISCSI_LOGIN_REQUEST *LoginReq;
690 CHAR8 *Data;
691
692 LoginReq = (ISCSI_LOGIN_REQUEST *) NetbufGetByte (Pdu, 0, NULL);
693 if (LoginReq == NULL) {
694 return EFI_PROTOCOL_ERROR;
695 }
696 DataSegLen = NTOH24 (LoginReq->DataSegmentLength);
697
698 KeyLen = (UINT32) AsciiStrLen (Key);
699 ValueLen = (UINT32) AsciiStrLen (Value);
700
701 //
702 // 1 byte for the key value separator '=' and 1 byte for the null
703 // delimiter after the value.
704 //
705 TotalLen = KeyLen + 1 + ValueLen + 1;
706
707 //
708 // Allocate the space for the key-value pair.
709 //
710 Data = (CHAR8 *) NetbufAllocSpace (Pdu, TotalLen, NET_BUF_TAIL);
711 if (Data == NULL) {
712 return EFI_OUT_OF_RESOURCES;
713 }
714 //
715 // Add the key.
716 //
717 CopyMem (Data, Key, KeyLen);
718 Data += KeyLen;
719
720 *Data = '=';
721 Data++;
722
723 //
724 // Add the value.
725 //
726 CopyMem (Data, Value, ValueLen);
727 Data += ValueLen;
728
729 *Data = '\0';
730
731 //
732 // Update the DataSegmentLength
733 //
734 ISCSI_SET_DATASEG_LEN (LoginReq, DataSegLen + TotalLen);
735
736 return EFI_SUCCESS;
737 }
738
739
740 /**
741 Prepare the iSCSI login request to be sent according to the current login status.
742
743 @param[in, out] Conn The connection in the iSCSI login phase.
744
745 @return The pointer to the net buffer containing the iSCSI login request built.
746 @retval NULL Other errors as indicated.
747
748 **/
749 NET_BUF *
750 IScsiPrepareLoginReq (
751 IN OUT ISCSI_CONNECTION *Conn
752 )
753 {
754 ISCSI_SESSION *Session;
755 NET_BUF *Nbuf;
756 ISCSI_LOGIN_REQUEST *LoginReq;
757 EFI_STATUS Status;
758
759 Session = Conn->Session;
760
761 Nbuf = NetbufAlloc (sizeof (ISCSI_LOGIN_REQUEST) + DEFAULT_MAX_RECV_DATA_SEG_LEN);
762 if (Nbuf == NULL) {
763 return NULL;
764 }
765
766 LoginReq = (ISCSI_LOGIN_REQUEST *) NetbufAllocSpace (Nbuf, sizeof (ISCSI_LOGIN_REQUEST), NET_BUF_TAIL);
767 if (LoginReq == NULL) {
768 NetbufFree (Nbuf);
769 return NULL;
770 }
771 ZeroMem (LoginReq, sizeof (ISCSI_LOGIN_REQUEST));
772
773 //
774 // Init the login request pdu
775 //
776 ISCSI_SET_OPCODE (LoginReq, ISCSI_OPCODE_LOGIN_REQ, ISCSI_REQ_IMMEDIATE);
777 ISCSI_SET_STAGES (LoginReq, Conn->CurrentStage, Conn->NextStage);
778 LoginReq->VersionMax = ISCSI_VERSION_MAX;
779 LoginReq->VersionMin = ISCSI_VERSION_MIN;
780 LoginReq->Tsih = HTONS (Session->Tsih);
781 LoginReq->InitiatorTaskTag = HTONL (Session->InitiatorTaskTag);
782 LoginReq->Cid = HTONS (Conn->Cid);
783 LoginReq->CmdSN = HTONL (Session->CmdSN);
784
785 //
786 // For the first Login Request on a connection this is ExpStatSN for the
787 // old connection, and this field is only valid if the Login Request restarts
788 // a connection.
789 // For subsequent Login Requests it is used to acknowledge the Login Responses
790 // with their increasing StatSN values.
791 //
792 LoginReq->ExpStatSN = HTONL (Conn->ExpStatSN);
793 CopyMem (LoginReq->Isid, Session->Isid, sizeof (LoginReq->Isid));
794
795 if (Conn->PartialRspRcvd) {
796 //
797 // A partial response. The initiator must send an empty Login Request.
798 //
799 return Nbuf;
800 }
801
802 Status = EFI_SUCCESS;
803
804 switch (Conn->CurrentStage) {
805 case ISCSI_SECURITY_NEGOTIATION:
806 //
807 // Both none authentication and CHAP authentication share the CHAP path.
808 //
809 //
810 if (Session->AuthType != ISCSI_AUTH_TYPE_KRB) {
811 Status = IScsiCHAPToSendReq (Conn, Nbuf);
812 }
813
814 break;
815
816 case ISCSI_LOGIN_OPERATIONAL_NEGOTIATION:
817 //
818 // Only negotiate the parameter once.
819 //
820 if (!Conn->ParamNegotiated) {
821 IScsiFillOpParams (Conn, Nbuf);
822 }
823
824 ISCSI_SET_FLAG (LoginReq, ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT);
825 break;
826
827 default:
828 //
829 // An error occurs...
830 //
831 Status = EFI_DEVICE_ERROR;
832 break;
833 }
834
835 if (EFI_ERROR (Status)) {
836 NetbufFree (Nbuf);
837 Nbuf = NULL;
838 } else {
839 //
840 // Pad the data segment if needed.
841 //
842 IScsiPadSegment (Nbuf, ISCSI_GET_DATASEG_LEN (LoginReq));
843 //
844 // Check whether we will issue the stage transition signal?
845 //
846 Conn->TransitInitiated = ISCSI_FLAG_ON (LoginReq, ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT);
847 }
848
849 return Nbuf;
850 }
851
852
853 /**
854 Process the iSCSI Login Response.
855
856 @param[in, out] Conn The connection on which the iSCSI login response is received.
857 @param[in, out] Pdu The iSCSI login response PDU.
858
859 @retval EFI_SUCCESS The iSCSI login response PDU is processed, and all checks are passed.
860 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
861 @retval EFI_MEDIA_CHANGED Target is redirected.
862 @retval Others Other errors as indicated.
863
864 **/
865 EFI_STATUS
866 IScsiProcessLoginRsp (
867 IN OUT ISCSI_CONNECTION *Conn,
868 IN OUT NET_BUF *Pdu
869 )
870 {
871 EFI_STATUS Status;
872 ISCSI_SESSION *Session;
873 ISCSI_LOGIN_RESPONSE *LoginRsp;
874 BOOLEAN Transit;
875 BOOLEAN Continue;
876 UINT8 CurrentStage;
877 UINT8 NextStage;
878 UINT8 *DataSeg;
879 UINT32 DataSegLen;
880
881 Status = EFI_SUCCESS;
882 Session = Conn->Session;
883
884 LoginRsp = (ISCSI_LOGIN_RESPONSE *) NetbufGetByte (Pdu, 0, NULL);
885 if (LoginRsp == NULL) {
886 return EFI_PROTOCOL_ERROR;
887 }
888 if (!ISCSI_CHECK_OPCODE (LoginRsp, ISCSI_OPCODE_LOGIN_RSP)) {
889 //
890 // It is not a Login Response.
891 //
892 return EFI_PROTOCOL_ERROR;
893 }
894 //
895 // Get the data segment, if any.
896 //
897 DataSegLen = ISCSI_GET_DATASEG_LEN (LoginRsp);
898 if (DataSegLen != 0) {
899 DataSeg = NetbufGetByte (Pdu, sizeof (ISCSI_LOGIN_RESPONSE), NULL);
900 } else {
901 DataSeg = NULL;
902 }
903 //
904 // Check the status class in the login response PDU.
905 //
906 switch (LoginRsp->StatusClass) {
907 case ISCSI_LOGIN_STATUS_SUCCESS:
908 //
909 // Just break here; the response and the data segment will be processed later.
910 //
911 break;
912
913 case ISCSI_LOGIN_STATUS_REDIRECTION:
914 //
915 // The target may be moved to a different address.
916 //
917 if (DataSeg == NULL) {
918 return EFI_PROTOCOL_ERROR;
919 }
920 //
921 // Process the TargetAddress key-value strings in the data segment to update the
922 // target address info.
923 //
924 Status = IScsiUpdateTargetAddress (Session, (CHAR8 *) DataSeg, DataSegLen);
925 if (EFI_ERROR (Status)) {
926 return Status;
927 }
928 //
929 // Session will be restarted on this error status because the Target is
930 // redirected by this Login Response.
931 //
932 return EFI_MEDIA_CHANGED;
933
934 default:
935 //
936 // Initiator Error, Target Error, or any other undefined error code.
937 //
938 return EFI_PROTOCOL_ERROR;
939 }
940 //
941 // The status is success; extract the wanted fields from the header segment.
942 //
943 Transit = ISCSI_FLAG_ON (LoginRsp, ISCSI_LOGIN_RSP_PDU_FLAG_TRANSIT);
944 Continue = ISCSI_FLAG_ON (LoginRsp, ISCSI_LOGIN_RSP_PDU_FLAG_CONTINUE);
945
946 CurrentStage = ISCSI_GET_CURRENT_STAGE (LoginRsp);
947 NextStage = ISCSI_GET_NEXT_STAGE (LoginRsp);
948
949 LoginRsp->InitiatorTaskTag = NTOHL (LoginRsp->InitiatorTaskTag);
950
951 if ((Transit && Continue) ||
952 (CurrentStage != Conn->CurrentStage) ||
953 (!Conn->TransitInitiated && Transit) ||
954 (Transit && (NextStage != Conn->NextStage)) ||
955 (CompareMem (Session->Isid, LoginRsp->Isid, sizeof (LoginRsp->Isid)) != 0) ||
956 (LoginRsp->InitiatorTaskTag != Session->InitiatorTaskTag)
957 ) {
958 //
959 // A Login Response with the C bit set to 1 MUST have the T bit set to 0.
960 // The CSG in the Login Response MUST be the same with the I-end of this connection.
961 // The T bit can't be 1 if the last Login Response sent by the initiator doesn't
962 // initiate the transition.
963 // The NSG MUST be the same with the I-end of this connection if Transit is required.
964 // The ISID in the Login Response MUST be the same with this session.
965 //
966 return EFI_PROTOCOL_ERROR;
967 }
968
969 LoginRsp->StatSN = NTOHL (LoginRsp->StatSN);
970 LoginRsp->ExpCmdSN = NTOHL (LoginRsp->ExpCmdSN);
971 LoginRsp->MaxCmdSN = NTOHL (LoginRsp->MaxCmdSN);
972
973 if ((Conn->CurrentStage == ISCSI_SECURITY_NEGOTIATION) && (Conn->AuthStep == ISCSI_AUTH_INITIAL)) {
974 //
975 // If the Login Request is a leading Login Request, the target MUST use
976 // the value presented in CmdSN as the target value for ExpCmdSN.
977 //
978 if ((Session->State == SESSION_STATE_FREE) && (Session->CmdSN != LoginRsp->ExpCmdSN)) {
979 return EFI_PROTOCOL_ERROR;
980 }
981
982 //
983 // It's the initial Login Response, initialize the local ExpStatSN, MaxCmdSN
984 // and ExpCmdSN.
985 //
986 Conn->ExpStatSN = LoginRsp->StatSN + 1;
987 Session->MaxCmdSN = LoginRsp->MaxCmdSN;
988 Session->ExpCmdSN = LoginRsp->ExpCmdSN;
989 } else {
990 //
991 // Check the StatSN of this PDU.
992 //
993 Status = IScsiCheckSN (&Conn->ExpStatSN, LoginRsp->StatSN);
994 if (!EFI_ERROR (Status)) {
995 //
996 // Update the MaxCmdSN and ExpCmdSN.
997 //
998 IScsiUpdateCmdSN (Session, LoginRsp->MaxCmdSN, LoginRsp->ExpCmdSN);
999 } else {
1000 return Status;
1001 }
1002 }
1003 //
1004 // Trim off the header segment.
1005 //
1006 NetbufTrim (Pdu, sizeof (ISCSI_LOGIN_RESPONSE), NET_BUF_HEAD);
1007
1008 //
1009 // Queue this login response first in case it's a partial response so that
1010 // later when the full response list is received we can combine these scattered
1011 // responses' data segment and then process it.
1012 //
1013 NET_GET_REF (Pdu);
1014 NetbufQueAppend (&Conn->RspQue, Pdu);
1015
1016 Conn->PartialRspRcvd = Continue;
1017 if (Continue) {
1018 //
1019 // It is a partial response; must wait for another or more Request/Response
1020 // conversations to get the full response.
1021 //
1022 return EFI_SUCCESS;
1023 }
1024
1025 switch (CurrentStage) {
1026 case ISCSI_SECURITY_NEGOTIATION:
1027 //
1028 // In security negotiation stage, let CHAP module handle it.
1029 //
1030 if (Session->AuthType != ISCSI_AUTH_TYPE_KRB) {
1031 Status = IScsiCHAPOnRspReceived (Conn);
1032 }
1033 break;
1034
1035 case ISCSI_LOGIN_OPERATIONAL_NEGOTIATION:
1036 //
1037 // Response received with negotiation response on iSCSI parameters: check them.
1038 //
1039 Status = IScsiCheckOpParams (Conn);
1040 if (!EFI_ERROR (Status)) {
1041 Conn->ParamNegotiated = TRUE;
1042 }
1043
1044 break;
1045
1046 default:
1047 //
1048 // Should never get here.
1049 //
1050 Status = EFI_PROTOCOL_ERROR;
1051 break;
1052 }
1053
1054 if (Transit && (Status == EFI_SUCCESS)) {
1055 //
1056 // Do the state transition.
1057 //
1058 Conn->CurrentStage = Conn->NextStage;
1059
1060 if (Conn->CurrentStage == ISCSI_LOGIN_OPERATIONAL_NEGOTIATION) {
1061 Conn->NextStage = ISCSI_FULL_FEATURE_PHASE;
1062 } else {
1063 //
1064 // CurrentStage is iSCSI Full Feature. It is the Login-Final Response;
1065 // get the TSIH from the Login Response.
1066 //
1067 Session->Tsih = NTOHS (LoginRsp->Tsih);
1068 }
1069 }
1070 //
1071 // Flush the response(s) received.
1072 //
1073 NetbufQueFlush (&Conn->RspQue);
1074
1075 return Status;
1076 }
1077
1078
1079 /**
1080 Updated the target information according the data received in the iSCSI
1081 login response with an target redirection status.
1082
1083 @param[in, out] Session The iSCSI session.
1084 @param[in] Data The data segment that should contain the
1085 TargetAddress key-value list.
1086 @param[in] Len Length of the data.
1087
1088 @retval EFI_SUCCESS The target address is updated.
1089 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1090 @retval EFI_NOT_FOUND The TargetAddress key is not found.
1091 @retval Others Other errors as indicated.
1092
1093 **/
1094 EFI_STATUS
1095 IScsiUpdateTargetAddress (
1096 IN OUT ISCSI_SESSION *Session,
1097 IN CHAR8 *Data,
1098 IN UINT32 Len
1099 )
1100 {
1101 LIST_ENTRY *KeyValueList;
1102 CHAR8 *TargetAddress;
1103 CHAR8 *IpStr;
1104 EFI_STATUS Status;
1105 UINTN Number;
1106 UINT8 IpMode;
1107 ISCSI_SESSION_CONFIG_NVDATA *NvData;
1108
1109 KeyValueList = IScsiBuildKeyValueList (Data, Len);
1110 if (KeyValueList == NULL) {
1111 return EFI_OUT_OF_RESOURCES;
1112 }
1113
1114 Status = EFI_NOT_FOUND;
1115 NvData = &Session->ConfigData->SessionConfigData;
1116
1117 while (TRUE) {
1118 TargetAddress = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_TARGET_ADDRESS);
1119 if (TargetAddress == NULL) {
1120 break;
1121 }
1122
1123 //
1124 // RFC 3720 defines format of the TargetAddress=domainname[:port][,portal-group-tag]
1125 // The domainname can be specified as either a DNS host name, adotted-decimal IPv4 address,
1126 // or a bracketed IPv6 address as specified in [RFC2732].
1127 //
1128 if (NET_IS_DIGIT (TargetAddress[0])) {
1129 //
1130 // The domainname of the target is presented in a dotted-decimal IPv4 address format.
1131 //
1132 IpStr = TargetAddress;
1133
1134 while ((*TargetAddress != '\0') && (*TargetAddress != ':') && (*TargetAddress != ',')) {
1135 //
1136 // NULL, ':', or ',' ends the IPv4 string.
1137 //
1138 TargetAddress++;
1139 }
1140 } else if (*TargetAddress == ISCSI_REDIRECT_ADDR_START_DELIMITER){
1141 //
1142 // The domainname of the target is presented in a bracketed IPv6 address format.
1143 //
1144 TargetAddress ++;
1145 IpStr = TargetAddress;
1146 while ((*TargetAddress != '\0') && (*TargetAddress != ISCSI_REDIRECT_ADDR_END_DELIMITER)) {
1147 //
1148 // ']' ends the IPv6 string.
1149 //
1150 TargetAddress++;
1151 }
1152
1153 if (*TargetAddress != ISCSI_REDIRECT_ADDR_END_DELIMITER) {
1154 continue;
1155 }
1156
1157 *TargetAddress = '\0';
1158 TargetAddress ++;
1159
1160 } else {
1161 //
1162 // The domainname of the target is presented in the format of a DNS host name.
1163 //
1164 IpStr = TargetAddress;
1165
1166 while ((*TargetAddress != '\0') && (*TargetAddress != ':') && (*TargetAddress != ',')) {
1167 TargetAddress++;
1168 }
1169 NvData->DnsMode = TRUE;
1170 }
1171
1172 //
1173 // Save the original user setting which specifies the proxy/virtual iSCSI target.
1174 //
1175 NvData->OriginalTargetPort = NvData->TargetPort;
1176
1177 if (*TargetAddress == ',') {
1178 //
1179 // Comma and the portal group tag MUST be omitted if the TargetAddress is sent
1180 // as the result of a redirection.
1181 //
1182 continue;
1183 } else if (*TargetAddress == ':') {
1184 *TargetAddress = '\0';
1185
1186 TargetAddress++;
1187
1188 Number = AsciiStrDecimalToUintn (TargetAddress);
1189 if (Number > 0xFFFF) {
1190 continue;
1191 } else {
1192 NvData->TargetPort = (UINT16) Number;
1193 }
1194 } else {
1195 //
1196 // The string only contains the Target address. Use the well-known port.
1197 //
1198 NvData->TargetPort = ISCSI_WELL_KNOWN_PORT;
1199 }
1200
1201 //
1202 // Save the original user setting which specifies the proxy/virtual iSCSI target.
1203 //
1204 CopyMem (&NvData->OriginalTargetIp, &NvData->TargetIp, sizeof (EFI_IP_ADDRESS));
1205
1206 //
1207 // Update the target IP address.
1208 //
1209 if (NvData->IpMode < IP_MODE_AUTOCONFIG) {
1210 IpMode = NvData->IpMode;
1211 } else {
1212 IpMode = Session->ConfigData->AutoConfigureMode;
1213 }
1214
1215 if (NvData->DnsMode) {
1216 //
1217 // Target address is expressed as URL format, just save it and
1218 // do DNS resolution when creating a TCP connection.
1219 //
1220 if (AsciiStrSize (IpStr) > sizeof (Session->ConfigData->SessionConfigData.TargetUrl)){
1221 return EFI_INVALID_PARAMETER;
1222 }
1223 CopyMem (&Session->ConfigData->SessionConfigData.TargetUrl, IpStr, AsciiStrSize (IpStr));
1224 } else {
1225 Status = IScsiAsciiStrToIp (
1226 IpStr,
1227 IpMode,
1228 &Session->ConfigData->SessionConfigData.TargetIp
1229 );
1230
1231 if (EFI_ERROR (Status)) {
1232 continue;
1233 } else {
1234 NvData->RedirectFlag = TRUE;
1235 break;
1236 }
1237 }
1238 }
1239
1240 IScsiFreeKeyValueList (KeyValueList);
1241
1242 return Status;
1243 }
1244
1245
1246 /**
1247 The callback function to free the net buffer list.
1248
1249 @param[in] Arg The opaque parameter.
1250
1251 **/
1252 VOID
1253 EFIAPI
1254 IScsiFreeNbufList (
1255 VOID *Arg
1256 )
1257 {
1258 ASSERT (Arg != NULL);
1259
1260 NetbufFreeList ((LIST_ENTRY *) Arg);
1261 FreePool (Arg);
1262 }
1263
1264
1265 /**
1266 The callback function called in NetBufFree; it does nothing.
1267
1268 @param[in] Arg The opaque parameter.
1269
1270 **/
1271 VOID
1272 EFIAPI
1273 IScsiNbufExtFree (
1274 VOID *Arg
1275 )
1276 {
1277 }
1278
1279
1280 /**
1281 Receive an iSCSI response PDU. An iSCSI response PDU contains an iSCSI PDU header and
1282 an optional data segment. The two parts will be put into two blocks of buffers in the
1283 net buffer. The digest check will be conducted in this function if needed and the digests
1284 will be trimmed from the PDU buffer.
1285
1286 @param[in] Conn The iSCSI connection to receive data from.
1287 @param[out] Pdu The received iSCSI pdu.
1288 @param[in] Context The context used to describe information on the caller provided
1289 buffer to receive data segment of the iSCSI pdu. It is optional.
1290 @param[in] HeaderDigest Whether there will be header digest received.
1291 @param[in] DataDigest Whether there will be data digest.
1292 @param[in] TimeoutEvent The timeout event. It is optional.
1293
1294 @retval EFI_SUCCESS An iSCSI pdu is received.
1295 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1296 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
1297 @retval Others Other errors as indicated.
1298
1299 **/
1300 EFI_STATUS
1301 IScsiReceivePdu (
1302 IN ISCSI_CONNECTION *Conn,
1303 OUT NET_BUF **Pdu,
1304 IN ISCSI_IN_BUFFER_CONTEXT *Context, OPTIONAL
1305 IN BOOLEAN HeaderDigest,
1306 IN BOOLEAN DataDigest,
1307 IN EFI_EVENT TimeoutEvent OPTIONAL
1308 )
1309 {
1310 LIST_ENTRY *NbufList;
1311 UINT32 Len;
1312 NET_BUF *PduHdr;
1313 UINT8 *Header;
1314 EFI_STATUS Status;
1315 UINT32 PadLen;
1316 UINT32 InDataOffset;
1317 NET_FRAGMENT Fragment[2];
1318 UINT32 FragmentCount;
1319 NET_BUF *DataSeg;
1320 UINT32 PadAndCRC32[2];
1321
1322 NbufList = AllocatePool (sizeof (LIST_ENTRY));
1323 if (NbufList == NULL) {
1324 return EFI_OUT_OF_RESOURCES;
1325 }
1326
1327 InitializeListHead (NbufList);
1328
1329 //
1330 // The header digest will be received together with the PDU header, if exists.
1331 //
1332 Len = sizeof (ISCSI_BASIC_HEADER) + (HeaderDigest ? sizeof (UINT32) : 0);
1333 PduHdr = NetbufAlloc (Len);
1334 if (PduHdr == NULL) {
1335 Status = EFI_OUT_OF_RESOURCES;
1336 goto ON_EXIT;
1337 }
1338
1339 Header = NetbufAllocSpace (PduHdr, Len, NET_BUF_TAIL);
1340 if (Header == NULL) {
1341 Status = EFI_OUT_OF_RESOURCES;
1342 goto ON_EXIT;
1343 }
1344 InsertTailList (NbufList, &PduHdr->List);
1345
1346 //
1347 // First step, receive the BHS of the PDU.
1348 //
1349 Status = TcpIoReceive (&Conn->TcpIo, PduHdr, FALSE, TimeoutEvent);
1350
1351 if (EFI_ERROR (Status)) {
1352 goto ON_EXIT;
1353 }
1354
1355 if (HeaderDigest) {
1356 //
1357 // TODO: check the header-digest.
1358 //
1359 //
1360 // Trim off the digest.
1361 //
1362 NetbufTrim (PduHdr, sizeof (UINT32), NET_BUF_TAIL);
1363 }
1364
1365 Len = ISCSI_GET_DATASEG_LEN (Header);
1366 if (Len == 0) {
1367 //
1368 // No data segment.
1369 //
1370 goto FORM_PDU;
1371 }
1372 //
1373 // Get the length of the padding bytes of the data segment.
1374 //
1375 PadLen = ISCSI_GET_PAD_LEN (Len);
1376
1377 switch (ISCSI_GET_OPCODE (Header)) {
1378 case ISCSI_OPCODE_SCSI_DATA_IN:
1379 //
1380 // To reduce memory copy overhead, try to use the buffer described by Context
1381 // if the PDU is an iSCSI SCSI data.
1382 //
1383 InDataOffset = ISCSI_GET_BUFFER_OFFSET (Header);
1384 if ((Context == NULL) || ((InDataOffset + Len) > Context->InDataLen)) {
1385 Status = EFI_PROTOCOL_ERROR;
1386 goto ON_EXIT;
1387 }
1388
1389 Fragment[0].Len = Len;
1390 Fragment[0].Bulk = Context->InData + InDataOffset;
1391
1392 if (DataDigest || (PadLen != 0)) {
1393 //
1394 // The data segment is padded. Use two fragments to receive it:
1395 // the first to receive the useful data; the second to receive the padding.
1396 //
1397 Fragment[1].Len = PadLen + (DataDigest ? sizeof (UINT32) : 0);
1398 Fragment[1].Bulk = (UINT8 *)PadAndCRC32 + (4 - PadLen);
1399
1400 FragmentCount = 2;
1401 } else {
1402 FragmentCount = 1;
1403 }
1404
1405 DataSeg = NetbufFromExt (&Fragment[0], FragmentCount, 0, 0, IScsiNbufExtFree, NULL);
1406 if (DataSeg == NULL) {
1407 Status = EFI_OUT_OF_RESOURCES;
1408 goto ON_EXIT;
1409 }
1410
1411 break;
1412
1413 case ISCSI_OPCODE_SCSI_RSP:
1414 case ISCSI_OPCODE_NOP_IN:
1415 case ISCSI_OPCODE_LOGIN_RSP:
1416 case ISCSI_OPCODE_TEXT_RSP:
1417 case ISCSI_OPCODE_ASYNC_MSG:
1418 case ISCSI_OPCODE_REJECT:
1419 case ISCSI_OPCODE_VENDOR_T0:
1420 case ISCSI_OPCODE_VENDOR_T1:
1421 case ISCSI_OPCODE_VENDOR_T2:
1422 //
1423 // Allocate buffer to receive the data segment.
1424 //
1425 Len += PadLen + (DataDigest ? sizeof (UINT32) : 0);
1426 DataSeg = NetbufAlloc (Len);
1427 if (DataSeg == NULL) {
1428 Status = EFI_OUT_OF_RESOURCES;
1429 goto ON_EXIT;
1430 }
1431
1432 NetbufAllocSpace (DataSeg, Len, NET_BUF_TAIL);
1433 break;
1434
1435 default:
1436 Status = EFI_PROTOCOL_ERROR;
1437 goto ON_EXIT;
1438 }
1439
1440 InsertTailList (NbufList, &DataSeg->List);
1441
1442 //
1443 // Receive the data segment with the data digest, if any.
1444 //
1445 Status = TcpIoReceive (&Conn->TcpIo, DataSeg, FALSE, TimeoutEvent);
1446
1447 if (EFI_ERROR (Status)) {
1448 goto ON_EXIT;
1449 }
1450
1451 if (DataDigest) {
1452 //
1453 // TODO: Check the data digest.
1454 //
1455 NetbufTrim (DataSeg, sizeof (UINT32), NET_BUF_TAIL);
1456 }
1457
1458 if (PadLen != 0) {
1459 //
1460 // Trim off the padding bytes in the data segment.
1461 //
1462 NetbufTrim (DataSeg, PadLen, NET_BUF_TAIL);
1463 }
1464
1465 FORM_PDU:
1466 //
1467 // Form the pdu from a list of pdu segments.
1468 //
1469 *Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);
1470 if (*Pdu == NULL) {
1471 Status = EFI_OUT_OF_RESOURCES;
1472 }
1473
1474 ON_EXIT:
1475
1476 if (EFI_ERROR (Status)) {
1477 //
1478 // Free the Nbufs in this NbufList and the NbufList itself.
1479 //
1480 IScsiFreeNbufList (NbufList);
1481 }
1482
1483 return Status;
1484 }
1485
1486
1487 /**
1488 Check and get the result of the parameter negotiation.
1489
1490 @param[in, out] Conn The connection in iSCSI login.
1491
1492 @retval EFI_SUCCESS The parameter check is passed and negotiation is finished.
1493 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
1494 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1495
1496 **/
1497 EFI_STATUS
1498 IScsiCheckOpParams (
1499 IN OUT ISCSI_CONNECTION *Conn
1500 )
1501 {
1502 EFI_STATUS Status;
1503 LIST_ENTRY *KeyValueList;
1504 CHAR8 *Data;
1505 UINT32 Len;
1506 ISCSI_SESSION *Session;
1507 CHAR8 *Value;
1508 UINTN NumericValue;
1509
1510 ASSERT (Conn->RspQue.BufNum != 0);
1511
1512 Session = Conn->Session;
1513
1514 Len = Conn->RspQue.BufSize;
1515 Data = AllocatePool (Len);
1516 if (Data == NULL) {
1517 return EFI_OUT_OF_RESOURCES;
1518 }
1519
1520 NetbufQueCopy (&Conn->RspQue, 0, Len, (UINT8 *) Data);
1521
1522 Status = EFI_PROTOCOL_ERROR;
1523
1524 //
1525 // Extract the Key-Value pairs into a list.
1526 //
1527 KeyValueList = IScsiBuildKeyValueList (Data, Len);
1528 if (KeyValueList == NULL) {
1529 FreePool (Data);
1530 return Status;
1531 }
1532 //
1533 // HeaderDigest
1534 //
1535 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_HEADER_DIGEST);
1536 if (Value == NULL) {
1537 goto ON_ERROR;
1538 }
1539
1540 if (AsciiStrCmp (Value, "CRC32") == 0) {
1541 if (Conn->HeaderDigest != IScsiDigestCRC32) {
1542 goto ON_ERROR;
1543 }
1544 } else if (AsciiStrCmp (Value, ISCSI_KEY_VALUE_NONE) == 0) {
1545 Conn->HeaderDigest = IScsiDigestNone;
1546 } else {
1547 goto ON_ERROR;
1548 }
1549 //
1550 // DataDigest
1551 //
1552 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_DIGEST);
1553 if (Value == NULL) {
1554 goto ON_ERROR;
1555 }
1556
1557 if (AsciiStrCmp (Value, "CRC32") == 0) {
1558 if (Conn->DataDigest != IScsiDigestCRC32) {
1559 goto ON_ERROR;
1560 }
1561 } else if (AsciiStrCmp (Value, ISCSI_KEY_VALUE_NONE) == 0) {
1562 Conn->DataDigest = IScsiDigestNone;
1563 } else {
1564 goto ON_ERROR;
1565 }
1566 //
1567 // ErrorRecoveryLevel: result function is Minimum.
1568 //
1569 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_ERROR_RECOVERY_LEVEL);
1570 if (Value == NULL) {
1571 goto ON_ERROR;
1572 }
1573
1574 NumericValue = IScsiNetNtoi (Value);
1575 if (NumericValue > 2) {
1576 goto ON_ERROR;
1577 }
1578
1579 Session->ErrorRecoveryLevel = (UINT8) MIN (Session->ErrorRecoveryLevel, NumericValue);
1580
1581 //
1582 // InitialR2T: result function is OR.
1583 //
1584 if (!Session->InitialR2T) {
1585 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_INITIAL_R2T);
1586 if (Value == NULL) {
1587 goto ON_ERROR;
1588 }
1589
1590 Session->InitialR2T = (BOOLEAN) (AsciiStrCmp (Value, "Yes") == 0);
1591 }
1592
1593 //
1594 // ImmediateData: result function is AND.
1595 //
1596 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_IMMEDIATE_DATA);
1597 if (Value == NULL) {
1598 goto ON_ERROR;
1599 }
1600
1601 Session->ImmediateData = (BOOLEAN) (Session->ImmediateData && (BOOLEAN) (AsciiStrCmp (Value, "Yes") == 0));
1602
1603 //
1604 // MaxRecvDataSegmentLength is declarative.
1605 //
1606 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH);
1607 if (Value != NULL) {
1608 Conn->MaxRecvDataSegmentLength = (UINT32) IScsiNetNtoi (Value);
1609 }
1610 //
1611 // MaxBurstLength: result function is Minimum.
1612 //
1613 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_BURST_LENGTH);
1614 if (Value == NULL) {
1615 goto ON_ERROR;
1616 }
1617
1618 NumericValue = IScsiNetNtoi (Value);
1619 Session->MaxBurstLength = (UINT32) MIN (Session->MaxBurstLength, NumericValue);
1620
1621 //
1622 // FirstBurstLength: result function is Minimum. Irrelevant when InitialR2T=Yes and
1623 // ImmediateData=No.
1624 //
1625 if (!(Session->InitialR2T && !Session->ImmediateData)) {
1626 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_FIRST_BURST_LENGTH);
1627 if (Value == NULL) {
1628 goto ON_ERROR;
1629 }
1630
1631 NumericValue = IScsiNetNtoi (Value);
1632 Session->FirstBurstLength = (UINT32) MIN (Session->FirstBurstLength, NumericValue);
1633 }
1634
1635 //
1636 // MaxConnections: result function is Minimum.
1637 //
1638 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_CONNECTIONS);
1639 if (Value == NULL) {
1640 goto ON_ERROR;
1641 }
1642
1643 NumericValue = IScsiNetNtoi (Value);
1644 if ((NumericValue == 0) || (NumericValue > 65535)) {
1645 goto ON_ERROR;
1646 }
1647
1648 Session->MaxConnections = (UINT32) MIN (Session->MaxConnections, NumericValue);
1649
1650 //
1651 // DataPDUInOrder: result function is OR.
1652 //
1653 if (!Session->DataPDUInOrder) {
1654 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_PDU_IN_ORDER);
1655 if (Value == NULL) {
1656 goto ON_ERROR;
1657 }
1658
1659 Session->DataPDUInOrder = (BOOLEAN) (AsciiStrCmp (Value, "Yes") == 0);
1660 }
1661
1662 //
1663 // DataSequenceInorder: result function is OR.
1664 //
1665 if (!Session->DataSequenceInOrder) {
1666 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER);
1667 if (Value == NULL) {
1668 goto ON_ERROR;
1669 }
1670
1671 Session->DataSequenceInOrder = (BOOLEAN) (AsciiStrCmp (Value, "Yes") == 0);
1672 }
1673
1674 //
1675 // DefaultTime2Wait: result function is Maximum.
1676 //
1677 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DEFAULT_TIME2WAIT);
1678 if (Value == NULL) {
1679 goto ON_ERROR;
1680 }
1681
1682 NumericValue = IScsiNetNtoi (Value);
1683 if (NumericValue == 0) {
1684 Session->DefaultTime2Wait = 0;
1685 } else if (NumericValue > 3600) {
1686 goto ON_ERROR;
1687 } else {
1688 Session->DefaultTime2Wait = (UINT32) MAX (Session->DefaultTime2Wait, NumericValue);
1689 }
1690 //
1691 // DefaultTime2Retain: result function is Minimum.
1692 //
1693 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DEFAULT_TIME2RETAIN);
1694 if (Value == NULL) {
1695 goto ON_ERROR;
1696 }
1697
1698 NumericValue = IScsiNetNtoi (Value);
1699 if (NumericValue == 0) {
1700 Session->DefaultTime2Retain = 0;
1701 } else if (NumericValue > 3600) {
1702 goto ON_ERROR;
1703 } else {
1704 Session->DefaultTime2Retain = (UINT32) MIN (Session->DefaultTime2Retain, NumericValue);
1705 }
1706 //
1707 // MaxOutstandingR2T: result function is Minimum.
1708 //
1709 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_OUTSTANDING_R2T);
1710 if (Value == NULL) {
1711 goto ON_ERROR;
1712 }
1713
1714 NumericValue = IScsiNetNtoi (Value);
1715 if ((NumericValue == 0) || (NumericValue > 65535)) {
1716 goto ON_ERROR;
1717 }
1718
1719 Session->MaxOutstandingR2T = (UINT16) MIN (Session->MaxOutstandingR2T, NumericValue);
1720
1721 //
1722 // Remove declarative key-value pairs, if any.
1723 //
1724 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_SESSION_TYPE);
1725 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_TARGET_ALIAS);
1726 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_TARGET_PORTAL_GROUP_TAG);
1727
1728
1729 //
1730 // Remove the key-value that may not needed for result function is OR.
1731 //
1732 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_INITIAL_R2T);
1733 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_PDU_IN_ORDER);
1734 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER);
1735
1736 //
1737 // Remove irrelevant parameter, if any.
1738 //
1739 if (Session->InitialR2T && !Session->ImmediateData) {
1740 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_FIRST_BURST_LENGTH);
1741 }
1742
1743 if (IsListEmpty (KeyValueList)) {
1744 //
1745 // Succeed if no more keys in the list.
1746 //
1747 Status = EFI_SUCCESS;
1748 }
1749
1750 ON_ERROR:
1751
1752 IScsiFreeKeyValueList (KeyValueList);
1753
1754 FreePool (Data);
1755
1756 return Status;
1757 }
1758
1759
1760 /**
1761 Fill the operational parameters.
1762
1763 @param[in] Conn The connection in iSCSI login.
1764 @param[in, out] Pdu The iSCSI login request PDU to fill the parameters.
1765
1766 **/
1767 VOID
1768 IScsiFillOpParams (
1769 IN ISCSI_CONNECTION *Conn,
1770 IN OUT NET_BUF *Pdu
1771 )
1772 {
1773 ISCSI_SESSION *Session;
1774 CHAR8 Value[256];
1775
1776 Session = Conn->Session;
1777
1778 AsciiSPrint (Value, sizeof (Value), "%a", (Conn->HeaderDigest == IScsiDigestCRC32) ? "None,CRC32" : "None");
1779 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_HEADER_DIGEST, Value);
1780
1781 AsciiSPrint (Value, sizeof (Value), "%a", (Conn->DataDigest == IScsiDigestCRC32) ? "None,CRC32" : "None");
1782 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_DIGEST, Value);
1783
1784 AsciiSPrint (Value, sizeof (Value), "%d", Session->ErrorRecoveryLevel);
1785 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_ERROR_RECOVERY_LEVEL, Value);
1786
1787 AsciiSPrint (Value, sizeof (Value), "%a", Session->InitialR2T ? "Yes" : "No");
1788 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_INITIAL_R2T, Value);
1789
1790 AsciiSPrint (Value, sizeof (Value), "%a", Session->ImmediateData ? "Yes" : "No");
1791 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_IMMEDIATE_DATA, Value);
1792
1793 AsciiSPrint (Value, sizeof (Value), "%d", MAX_RECV_DATA_SEG_LEN_IN_FFP);
1794 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH, Value);
1795
1796 AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxBurstLength);
1797 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_BURST_LENGTH, Value);
1798
1799 AsciiSPrint (Value, sizeof (Value), "%d", Session->FirstBurstLength);
1800 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_FIRST_BURST_LENGTH, Value);
1801
1802 AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxConnections);
1803 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_CONNECTIONS, Value);
1804
1805 AsciiSPrint (Value, sizeof (Value), "%a", Session->DataPDUInOrder ? "Yes" : "No");
1806 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_PDU_IN_ORDER, Value);
1807
1808 AsciiSPrint (Value, sizeof (Value), "%a", Session->DataSequenceInOrder ? "Yes" : "No");
1809 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER, Value);
1810
1811 AsciiSPrint (Value, sizeof (Value), "%d", Session->DefaultTime2Wait);
1812 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DEFAULT_TIME2WAIT, Value);
1813
1814 AsciiSPrint (Value, sizeof (Value), "%d", Session->DefaultTime2Retain);
1815 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DEFAULT_TIME2RETAIN, Value);
1816
1817 AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxOutstandingR2T);
1818 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_OUTSTANDING_R2T, Value);
1819 }
1820
1821
1822 /**
1823 Pad the iSCSI AHS or data segment to an integer number of 4 byte words.
1824
1825 @param[in, out] Pdu The iSCSI pdu which contains segments to pad.
1826 @param[in] Len The length of the last segment in the PDU.
1827
1828 @retval EFI_SUCCESS The segment is padded or there is no need to pad it.
1829 @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the
1830 padding bytes.
1831 **/
1832 EFI_STATUS
1833 IScsiPadSegment (
1834 IN OUT NET_BUF *Pdu,
1835 IN UINT32 Len
1836 )
1837 {
1838 UINT32 PadLen;
1839 UINT8 *Data;
1840
1841 PadLen = ISCSI_GET_PAD_LEN (Len);
1842
1843 if (PadLen != 0) {
1844 Data = NetbufAllocSpace (Pdu, PadLen, NET_BUF_TAIL);
1845 if (Data == NULL) {
1846 return EFI_OUT_OF_RESOURCES;
1847 }
1848
1849 ZeroMem (Data, PadLen);
1850 }
1851
1852 return EFI_SUCCESS;
1853 }
1854
1855
1856 /**
1857 Build a key-value list from the data segment.
1858
1859 @param[in] Data The data segment containing the key-value pairs.
1860 @param[in] Len Length of the data segment.
1861
1862 @return The key-value list.
1863 @retval NULL Other errors as indicated.
1864
1865 **/
1866 LIST_ENTRY *
1867 IScsiBuildKeyValueList (
1868 IN CHAR8 *Data,
1869 IN UINT32 Len
1870 )
1871 {
1872 LIST_ENTRY *ListHead;
1873 ISCSI_KEY_VALUE_PAIR *KeyValuePair;
1874
1875 ListHead = AllocatePool (sizeof (LIST_ENTRY));
1876 if (ListHead == NULL) {
1877 return NULL;
1878 }
1879
1880 InitializeListHead (ListHead);
1881
1882 while (Len > 0) {
1883 KeyValuePair = AllocatePool (sizeof (ISCSI_KEY_VALUE_PAIR));
1884 if (KeyValuePair == NULL) {
1885 goto ON_ERROR;
1886 }
1887
1888 InitializeListHead (&KeyValuePair->List);
1889
1890 KeyValuePair->Key = Data;
1891
1892 while ((Len > 0) && (*Data != '=')) {
1893 Len--;
1894 Data++;
1895 }
1896
1897 if (*Data == '=') {
1898 *Data = '\0';
1899
1900 Data++;
1901 Len--;
1902 } else {
1903 FreePool (KeyValuePair);
1904 goto ON_ERROR;
1905 }
1906
1907 KeyValuePair->Value = Data;
1908
1909 InsertTailList (ListHead, &KeyValuePair->List);;
1910
1911 Data += AsciiStrLen (KeyValuePair->Value) + 1;
1912 Len -= (UINT32) AsciiStrLen (KeyValuePair->Value) + 1;
1913 }
1914
1915 return ListHead;
1916
1917 ON_ERROR:
1918
1919 IScsiFreeKeyValueList (ListHead);
1920
1921 return NULL;
1922 }
1923
1924
1925 /**
1926 Get the value string by the key name from the key-value list. If found,
1927 the key-value entry will be removed from the list.
1928
1929 @param[in, out] KeyValueList The key-value list.
1930 @param[in] Key The key name to find.
1931
1932 @return The value string.
1933 @retval NULL The key value pair cannot be found.
1934
1935 **/
1936 CHAR8 *
1937 IScsiGetValueByKeyFromList (
1938 IN OUT LIST_ENTRY *KeyValueList,
1939 IN CHAR8 *Key
1940 )
1941 {
1942 LIST_ENTRY *Entry;
1943 ISCSI_KEY_VALUE_PAIR *KeyValuePair;
1944 CHAR8 *Value;
1945
1946 Value = NULL;
1947
1948 NET_LIST_FOR_EACH (Entry, KeyValueList) {
1949 KeyValuePair = NET_LIST_USER_STRUCT (Entry, ISCSI_KEY_VALUE_PAIR, List);
1950
1951 if (AsciiStrCmp (KeyValuePair->Key, Key) == 0) {
1952 Value = KeyValuePair->Value;
1953
1954 RemoveEntryList (&KeyValuePair->List);
1955 FreePool (KeyValuePair);
1956 break;
1957 }
1958 }
1959
1960 return Value;
1961 }
1962
1963
1964 /**
1965 Free the key-value list.
1966
1967 @param[in] KeyValueList The key-value list.
1968
1969 **/
1970 VOID
1971 IScsiFreeKeyValueList (
1972 IN LIST_ENTRY *KeyValueList
1973 )
1974 {
1975 LIST_ENTRY *Entry;
1976 ISCSI_KEY_VALUE_PAIR *KeyValuePair;
1977
1978 while (!IsListEmpty (KeyValueList)) {
1979 Entry = NetListRemoveHead (KeyValueList);
1980 KeyValuePair = NET_LIST_USER_STRUCT (Entry, ISCSI_KEY_VALUE_PAIR, List);
1981
1982 FreePool (KeyValuePair);
1983 }
1984
1985 FreePool (KeyValueList);
1986 }
1987
1988
1989 /**
1990 Normalize the iSCSI name according to RFC.
1991
1992 @param[in, out] Name The iSCSI name.
1993 @param[in] Len Length of the iSCSI name.
1994
1995 @retval EFI_SUCCESS The iSCSI name is valid and normalized.
1996 @retval EFI_PROTOCOL_ERROR The iSCSI name is malformatted or not in the IQN format.
1997
1998 **/
1999 EFI_STATUS
2000 IScsiNormalizeName (
2001 IN OUT CHAR8 *Name,
2002 IN UINTN Len
2003 )
2004 {
2005 UINTN Index;
2006
2007 for (Index = 0; Index < Len; Index++) {
2008 if (NET_IS_UPPER_CASE_CHAR (Name[Index])) {
2009 //
2010 // Convert the upper-case characters to lower-case ones.
2011 //
2012 Name[Index] = (CHAR8) (Name[Index] - 'A' + 'a');
2013 }
2014
2015 if (!NET_IS_LOWER_CASE_CHAR (Name[Index]) &&
2016 !NET_IS_DIGIT (Name[Index]) &&
2017 (Name[Index] != '-') &&
2018 (Name[Index] != '.') &&
2019 (Name[Index] != ':')
2020 ) {
2021 //
2022 // ASCII dash, dot, colon lower-case characters and digit characters
2023 // are allowed.
2024 //
2025 return EFI_PROTOCOL_ERROR;
2026 }
2027 }
2028
2029 if ((Len < 4) || (CompareMem (Name, "iqn.", 4) != 0)) {
2030 //
2031 // Only IQN format is accepted now.
2032 //
2033 return EFI_PROTOCOL_ERROR;
2034 }
2035
2036 return EFI_SUCCESS;
2037 }
2038
2039
2040 /**
2041 Create an iSCSI task control block.
2042
2043 @param[in] Conn The connection on which the task control block will be created.
2044 @param[out] Tcb The newly created task control block.
2045
2046 @retval EFI_SUCCESS The task control block is created.
2047 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
2048 @retval EFI_NOT_READY The target cannot accept new commands.
2049
2050 **/
2051 EFI_STATUS
2052 IScsiNewTcb (
2053 IN ISCSI_CONNECTION *Conn,
2054 OUT ISCSI_TCB **Tcb
2055 )
2056 {
2057 ISCSI_SESSION *Session;
2058 ISCSI_TCB *NewTcb;
2059
2060 ASSERT (Tcb != NULL);
2061
2062 Session = Conn->Session;
2063
2064 if (ISCSI_SEQ_GT (Session->CmdSN, Session->MaxCmdSN)) {
2065 return EFI_NOT_READY;
2066 }
2067
2068 NewTcb = AllocateZeroPool (sizeof (ISCSI_TCB));
2069 if (NewTcb == NULL) {
2070 return EFI_OUT_OF_RESOURCES;
2071 }
2072
2073 InitializeListHead (&NewTcb->Link);
2074
2075 NewTcb->SoFarInOrder = TRUE;
2076 NewTcb->InitiatorTaskTag = Session->InitiatorTaskTag;
2077 NewTcb->CmdSN = Session->CmdSN;
2078 NewTcb->Conn = Conn;
2079
2080 InsertTailList (&Session->TcbList, &NewTcb->Link);
2081
2082 //
2083 // Advance the initiator task tag.
2084 //
2085 Session->InitiatorTaskTag++;
2086 Session->CmdSN++;
2087
2088 *Tcb = NewTcb;
2089
2090 return EFI_SUCCESS;
2091 }
2092
2093
2094 /**
2095 Delete the tcb from the connection and destroy it.
2096
2097 @param[in] Tcb The tcb to delete.
2098
2099 **/
2100 VOID
2101 IScsiDelTcb (
2102 IN ISCSI_TCB *Tcb
2103 )
2104 {
2105 RemoveEntryList (&Tcb->Link);
2106
2107 FreePool (Tcb);
2108 }
2109
2110
2111 /**
2112 Create a data segment, pad it, and calculate the CRC if needed.
2113
2114 @param[in] Data The data to fill into the data segment.
2115 @param[in] Len Length of the data.
2116 @param[in] DataDigest Whether to calculate CRC for this data segment.
2117
2118 @return The net buffer wrapping the data segment.
2119
2120 **/
2121 NET_BUF *
2122 IScsiNewDataSegment (
2123 IN UINT8 *Data,
2124 IN UINT32 Len,
2125 IN BOOLEAN DataDigest
2126 )
2127 {
2128 NET_FRAGMENT Fragment[2];
2129 UINT32 FragmentCount;
2130 UINT32 PadLen;
2131 NET_BUF *DataSeg;
2132
2133 Fragment[0].Len = Len;
2134 Fragment[0].Bulk = Data;
2135
2136 PadLen = ISCSI_GET_PAD_LEN (Len);
2137 if (PadLen != 0) {
2138 Fragment[1].Len = PadLen;
2139 Fragment[1].Bulk = (UINT8 *) &mDataSegPad;
2140
2141 FragmentCount = 2;
2142 } else {
2143 FragmentCount = 1;
2144 }
2145
2146 DataSeg = NetbufFromExt (&Fragment[0], FragmentCount, 0, 0, IScsiNbufExtFree, NULL);
2147
2148 return DataSeg;
2149 }
2150
2151
2152 /**
2153 Create a iSCSI SCSI command PDU to encapsulate the command issued
2154 by SCSI through the EXT SCSI PASS THRU Protocol.
2155
2156 @param[in] Packet The EXT SCSI PASS THRU request packet containing the SCSI command.
2157 @param[in] Lun The LUN.
2158 @param[in] Tcb The tcb associated with this SCSI command.
2159
2160 @return The created iSCSI SCSI command PDU.
2161 @retval NULL Other errors as indicated.
2162
2163 **/
2164 NET_BUF *
2165 IScsiNewScsiCmdPdu (
2166 IN EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,
2167 IN UINT64 Lun,
2168 IN ISCSI_TCB *Tcb
2169 )
2170 {
2171 LIST_ENTRY *NbufList;
2172 NET_BUF *Pdu;
2173 NET_BUF *PduHeader;
2174 NET_BUF *DataSeg;
2175 SCSI_COMMAND *ScsiCmd;
2176 UINT8 AHSLength;
2177 UINT32 Length;
2178 ISCSI_ADDITIONAL_HEADER *Header;
2179 ISCSI_BI_EXP_READ_DATA_LEN_AHS *BiExpReadDataLenAHS;
2180 ISCSI_SESSION *Session;
2181 UINT32 ImmediateDataLen;
2182
2183 AHSLength = 0;
2184
2185 if (Packet->DataDirection == DataBi) {
2186 //
2187 // Bidirectional Read/Write command, the bidirectional expected
2188 // read data length AHS is required.
2189 //
2190 AHSLength += sizeof (ISCSI_BI_EXP_READ_DATA_LEN_AHS);
2191 }
2192
2193 if (Packet->CdbLength > 16) {
2194 //
2195 // The CDB exceeds 16 bytes. An extended CDB AHS is required.
2196 //
2197 AHSLength = (UINT8) (AHSLength + ISCSI_ROUNDUP (Packet->CdbLength - 16) + sizeof (ISCSI_ADDITIONAL_HEADER));
2198 }
2199
2200 Length = sizeof (SCSI_COMMAND) + AHSLength;
2201 PduHeader = NetbufAlloc (Length);
2202 if (PduHeader == NULL) {
2203 return NULL;
2204 }
2205
2206 ScsiCmd = (SCSI_COMMAND *) NetbufAllocSpace (PduHeader, Length, NET_BUF_TAIL);
2207 if (ScsiCmd == NULL) {
2208 NetbufFree (PduHeader);
2209 return NULL;
2210 }
2211 Header = (ISCSI_ADDITIONAL_HEADER *) (ScsiCmd + 1);
2212
2213 ZeroMem (ScsiCmd, Length);
2214
2215 ISCSI_SET_OPCODE (ScsiCmd, ISCSI_OPCODE_SCSI_CMD, 0);
2216 ISCSI_SET_FLAG (ScsiCmd, ISCSI_TASK_ATTR_SIMPLE);
2217
2218 //
2219 // Set the READ/WRITE flags according to the IO type of this request.
2220 //
2221 switch (Packet->DataDirection) {
2222 case DataIn:
2223 ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_READ);
2224 ScsiCmd->ExpDataXferLength = NTOHL (Packet->InTransferLength);
2225 break;
2226
2227 case DataOut:
2228 ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_WRITE);
2229 ScsiCmd->ExpDataXferLength = NTOHL (Packet->OutTransferLength);
2230 break;
2231
2232 case DataBi:
2233 ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_READ | SCSI_CMD_PDU_FLAG_WRITE);
2234 ScsiCmd->ExpDataXferLength = NTOHL (Packet->OutTransferLength);
2235
2236 //
2237 // Fill the bidirectional expected read data length AHS.
2238 //
2239 BiExpReadDataLenAHS = (ISCSI_BI_EXP_READ_DATA_LEN_AHS *) Header;
2240 Header = (ISCSI_ADDITIONAL_HEADER *) (BiExpReadDataLenAHS + 1);
2241
2242 BiExpReadDataLenAHS->Length = NTOHS (5);
2243 BiExpReadDataLenAHS->Type = ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN;
2244 BiExpReadDataLenAHS->ExpReadDataLength = NTOHL (Packet->InTransferLength);
2245
2246 break;
2247 }
2248
2249 ScsiCmd->TotalAHSLength = AHSLength;
2250 CopyMem (ScsiCmd->Lun, &Lun, sizeof (ScsiCmd->Lun));
2251 ScsiCmd->InitiatorTaskTag = NTOHL (Tcb->InitiatorTaskTag);
2252 ScsiCmd->CmdSN = NTOHL (Tcb->CmdSN);
2253 ScsiCmd->ExpStatSN = NTOHL (Tcb->Conn->ExpStatSN);
2254
2255 CopyMem (ScsiCmd->Cdb, Packet->Cdb, sizeof (ScsiCmd->Cdb));
2256
2257 if (Packet->CdbLength > 16) {
2258 Header->Length = NTOHS ((UINT16) (Packet->CdbLength - 15));
2259 Header->Type = ISCSI_AHS_TYPE_EXT_CDB;
2260
2261 CopyMem (Header + 1, (UINT8 *) Packet->Cdb + 16, Packet->CdbLength - 16);
2262 }
2263
2264 Pdu = PduHeader;
2265 Session = Tcb->Conn->Session;
2266 ImmediateDataLen = 0;
2267
2268 if (Session->ImmediateData && (Packet->OutTransferLength != 0)) {
2269 //
2270 // Send immediate data in this SCSI Command PDU. The length of the immediate
2271 // data is the minimum of FirstBurstLength, the data length to be xfered, and
2272 // the MaxRecvdataSegmentLength on this connection.
2273 //
2274 ImmediateDataLen = MIN (Session->FirstBurstLength, Packet->OutTransferLength);
2275 ImmediateDataLen = MIN (ImmediateDataLen, Tcb->Conn->MaxRecvDataSegmentLength);
2276
2277 //
2278 // Update the data segment length in the PDU header.
2279 //
2280 ISCSI_SET_DATASEG_LEN (ScsiCmd, ImmediateDataLen);
2281
2282 //
2283 // Create the data segment.
2284 //
2285 DataSeg = IScsiNewDataSegment ((UINT8 *) Packet->OutDataBuffer, ImmediateDataLen, FALSE);
2286 if (DataSeg == NULL) {
2287 NetbufFree (PduHeader);
2288 Pdu = NULL;
2289 goto ON_EXIT;
2290 }
2291
2292 NbufList = AllocatePool (sizeof (LIST_ENTRY));
2293 if (NbufList == NULL) {
2294 NetbufFree (PduHeader);
2295 NetbufFree (DataSeg);
2296
2297 Pdu = NULL;
2298 goto ON_EXIT;
2299 }
2300
2301 InitializeListHead (NbufList);
2302 InsertTailList (NbufList, &PduHeader->List);
2303 InsertTailList (NbufList, &DataSeg->List);
2304
2305 Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);
2306 if (Pdu == NULL) {
2307 IScsiFreeNbufList (NbufList);
2308 }
2309 }
2310
2311 if (Session->InitialR2T ||
2312 (ImmediateDataLen == Session->FirstBurstLength) ||
2313 (ImmediateDataLen == Packet->OutTransferLength)
2314 ) {
2315 //
2316 // Unsolicited data out sequence is not allowed,
2317 // or FirstBustLength data is already sent out by immediate data,
2318 // or all the OUT data accompany this SCSI packet are sent as
2319 // immediate data. The final flag should be set on this SCSI Command
2320 // PDU.
2321 //
2322 ISCSI_SET_FLAG (ScsiCmd, ISCSI_BHS_FLAG_FINAL);
2323 }
2324
2325 ON_EXIT:
2326
2327 return Pdu;
2328 }
2329
2330
2331 /**
2332 Create a new iSCSI SCSI Data Out PDU.
2333
2334 @param[in] Data The data to put into the Data Out PDU.
2335 @param[in] Len Length of the data.
2336 @param[in] DataSN The DataSN of the Data Out PDU.
2337 @param[in] Tcb The task control block of this Data Out PDU.
2338 @param[in] Lun The LUN.
2339
2340 @return The net buffer wrapping the Data Out PDU.
2341 @retval NULL Other errors as indicated.
2342
2343 **/
2344 NET_BUF *
2345 IScsiNewDataOutPdu (
2346 IN UINT8 *Data,
2347 IN UINT32 Len,
2348 IN UINT32 DataSN,
2349 IN ISCSI_TCB *Tcb,
2350 IN UINT64 Lun
2351 )
2352 {
2353 LIST_ENTRY *NbufList;
2354 NET_BUF *PduHdr;
2355 NET_BUF *DataSeg;
2356 NET_BUF *Pdu;
2357 ISCSI_SCSI_DATA_OUT *DataOutHdr;
2358 ISCSI_XFER_CONTEXT *XferContext;
2359
2360 NbufList = AllocatePool (sizeof (LIST_ENTRY));
2361 if (NbufList == NULL) {
2362 return NULL;
2363 }
2364
2365 InitializeListHead (NbufList);
2366
2367 //
2368 // Allocate memory for the BHS.
2369 //
2370 PduHdr = NetbufAlloc (sizeof (ISCSI_SCSI_DATA_OUT));
2371 if (PduHdr == NULL) {
2372 FreePool (NbufList);
2373 return NULL;
2374 }
2375 //
2376 // Insert the BHS into the buffer list.
2377 //
2378 InsertTailList (NbufList, &PduHdr->List);
2379
2380 DataOutHdr = (ISCSI_SCSI_DATA_OUT *) NetbufAllocSpace (PduHdr, sizeof (ISCSI_SCSI_DATA_OUT), NET_BUF_TAIL);
2381 if (DataOutHdr == NULL) {
2382 IScsiFreeNbufList (NbufList);
2383 return NULL;
2384 }
2385 XferContext = &Tcb->XferContext;
2386
2387 ZeroMem (DataOutHdr, sizeof (ISCSI_SCSI_DATA_OUT));
2388
2389 //
2390 // Set the flags and fields of the Data Out PDU BHS.
2391 //
2392 ISCSI_SET_OPCODE (DataOutHdr, ISCSI_OPCODE_SCSI_DATA_OUT, 0);
2393 ISCSI_SET_DATASEG_LEN (DataOutHdr, Len);
2394
2395 DataOutHdr->InitiatorTaskTag = HTONL (Tcb->InitiatorTaskTag);
2396 DataOutHdr->TargetTransferTag = HTONL (XferContext->TargetTransferTag);
2397 DataOutHdr->ExpStatSN = HTONL (Tcb->Conn->ExpStatSN);
2398 DataOutHdr->DataSN = HTONL (DataSN);
2399 DataOutHdr->BufferOffset = HTONL (XferContext->Offset);
2400
2401 if (XferContext->TargetTransferTag != ISCSI_RESERVED_TAG) {
2402 CopyMem (&DataOutHdr->Lun, &Lun, sizeof (DataOutHdr->Lun));
2403 }
2404 //
2405 // Build the data segment for this Data Out PDU.
2406 //
2407 DataSeg = IScsiNewDataSegment (Data, Len, FALSE);
2408 if (DataSeg == NULL) {
2409 IScsiFreeNbufList (NbufList);
2410 return NULL;
2411 }
2412 //
2413 // Put the data segment into the buffer list and combine it with the BHS
2414 // into a full Data Out PDU.
2415 //
2416 InsertTailList (NbufList, &DataSeg->List);
2417 Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);
2418 if (Pdu == NULL) {
2419 IScsiFreeNbufList (NbufList);
2420 }
2421
2422 return Pdu;
2423 }
2424
2425
2426 /**
2427 Generate a consecutive sequence of iSCSI SCSI Data Out PDUs.
2428
2429 @param[in] Data The data which will be carried by the sequence of iSCSI SCSI Data Out PDUs.
2430 @param[in] Tcb The task control block of the data to send out.
2431 @param[in] Lun The LUN the data will be sent to.
2432
2433 @return A list of net buffers with each of them wrapping an iSCSI SCSI Data Out PDU.
2434 @retval NULL Other errors as indicated.
2435
2436 **/
2437 LIST_ENTRY *
2438 IScsiGenerateDataOutPduSequence (
2439 IN UINT8 *Data,
2440 IN ISCSI_TCB *Tcb,
2441 IN UINT64 Lun
2442 )
2443 {
2444 LIST_ENTRY *PduList;
2445 UINT32 DataSN;
2446 UINT32 DataLen;
2447 NET_BUF *DataOutPdu;
2448 ISCSI_CONNECTION *Conn;
2449 ISCSI_XFER_CONTEXT *XferContext;
2450 UINT8 *DataOutPacket;
2451
2452 PduList = AllocatePool (sizeof (LIST_ENTRY));
2453 if (PduList == NULL) {
2454 return NULL;
2455 }
2456
2457 InitializeListHead (PduList);
2458
2459 DataSN = 0;
2460 Conn = Tcb->Conn;
2461 DataOutPdu = NULL;
2462 XferContext = &Tcb->XferContext;
2463
2464 while (XferContext->DesiredLength > 0) {
2465 //
2466 // Determine the length of data this Data Out PDU can carry.
2467 //
2468 DataLen = MIN (XferContext->DesiredLength, Conn->MaxRecvDataSegmentLength);
2469
2470 //
2471 // Create a Data Out PDU.
2472 //
2473 DataOutPdu = IScsiNewDataOutPdu (Data, DataLen, DataSN, Tcb, Lun);
2474 if (DataOutPdu == NULL) {
2475 IScsiFreeNbufList (PduList);
2476 PduList = NULL;
2477
2478 goto ON_EXIT;
2479 }
2480
2481 InsertTailList (PduList, &DataOutPdu->List);
2482
2483 //
2484 // Update the context and DataSN.
2485 //
2486 Data += DataLen;
2487 XferContext->Offset += DataLen;
2488 XferContext->DesiredLength -= DataLen;
2489 DataSN++;
2490 }
2491 //
2492 // Set the F bit for the last data out PDU in this sequence.
2493 //
2494 DataOutPacket = NetbufGetByte (DataOutPdu, 0, NULL);
2495 if (DataOutPacket == NULL) {
2496 IScsiFreeNbufList (PduList);
2497 PduList = NULL;
2498 goto ON_EXIT;
2499 }
2500
2501 ISCSI_SET_FLAG (DataOutPacket, ISCSI_BHS_FLAG_FINAL);
2502
2503 ON_EXIT:
2504
2505 return PduList;
2506 }
2507
2508 /**
2509 Send the Data in a sequence of Data Out PDUs one by one.
2510
2511 @param[in] Data The data to carry by Data Out PDUs.
2512 @param[in] Lun The LUN the data will be sent to.
2513 @param[in] Tcb The task control block.
2514
2515 @retval EFI_SUCCESS The data is sent out to the LUN.
2516 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
2517 @retval Others Other errors as indicated.
2518
2519 **/
2520 EFI_STATUS
2521 IScsiSendDataOutPduSequence (
2522 IN UINT8 *Data,
2523 IN UINT64 Lun,
2524 IN ISCSI_TCB *Tcb
2525 )
2526 {
2527 LIST_ENTRY *DataOutPduList;
2528 LIST_ENTRY *Entry;
2529 NET_BUF *Pdu;
2530 EFI_STATUS Status;
2531
2532 //
2533 // Generate the Data Out PDU sequence.
2534 //
2535 DataOutPduList = IScsiGenerateDataOutPduSequence (Data, Tcb, Lun);
2536 if (DataOutPduList == NULL) {
2537 return EFI_OUT_OF_RESOURCES;
2538 }
2539
2540 Status = EFI_SUCCESS;
2541
2542 //
2543 // Send the Data Out PDU's one by one.
2544 //
2545 NET_LIST_FOR_EACH (Entry, DataOutPduList) {
2546 Pdu = NET_LIST_USER_STRUCT (Entry, NET_BUF, List);
2547
2548 Status = TcpIoTransmit (&Tcb->Conn->TcpIo, Pdu);
2549
2550 if (EFI_ERROR (Status)) {
2551 break;
2552 }
2553 }
2554
2555 IScsiFreeNbufList (DataOutPduList);
2556
2557 return Status;
2558 }
2559
2560
2561 /**
2562 Process the received iSCSI SCSI Data In PDU.
2563
2564 @param[in] Pdu The Data In PDU received.
2565 @param[in] Tcb The task control block.
2566 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2567
2568 @retval EFI_SUCCESS The check on the Data IN PDU is passed and some update
2569 actions are taken.
2570 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
2571 @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.
2572 @retval Others Other errors as indicated.
2573
2574 **/
2575 EFI_STATUS
2576 IScsiOnDataInRcvd (
2577 IN NET_BUF *Pdu,
2578 IN ISCSI_TCB *Tcb,
2579 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
2580 )
2581 {
2582 ISCSI_SCSI_DATA_IN *DataInHdr;
2583 EFI_STATUS Status;
2584
2585 DataInHdr = (ISCSI_SCSI_DATA_IN *) NetbufGetByte (Pdu, 0, NULL);
2586 if (DataInHdr == NULL) {
2587 return EFI_PROTOCOL_ERROR;
2588 }
2589
2590 DataInHdr->InitiatorTaskTag = NTOHL (DataInHdr->InitiatorTaskTag);
2591 DataInHdr->ExpCmdSN = NTOHL (DataInHdr->ExpCmdSN);
2592 DataInHdr->MaxCmdSN = NTOHL (DataInHdr->MaxCmdSN);
2593 DataInHdr->DataSN = NTOHL (DataInHdr->DataSN);
2594
2595 //
2596 // Check the DataSN.
2597 //
2598 Status = IScsiCheckSN (&Tcb->ExpDataSN, DataInHdr->DataSN);
2599 if (EFI_ERROR (Status)) {
2600 return Status;
2601 }
2602
2603 if (DataInHdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) {
2604 return EFI_PROTOCOL_ERROR;
2605 }
2606 //
2607 // Update the command related sequence numbers.
2608 //
2609 IScsiUpdateCmdSN (Tcb->Conn->Session, DataInHdr->MaxCmdSN, DataInHdr->ExpCmdSN);
2610
2611 if (ISCSI_FLAG_ON (DataInHdr, SCSI_DATA_IN_PDU_FLAG_STATUS_VALID)) {
2612 if (!ISCSI_FLAG_ON (DataInHdr, ISCSI_BHS_FLAG_FINAL)) {
2613 //
2614 // The S bit is on but the F bit is off.
2615 //
2616 return EFI_PROTOCOL_ERROR;
2617 }
2618
2619 Tcb->StatusXferd = TRUE;
2620
2621 if (ISCSI_FLAG_ON (DataInHdr, SCSI_DATA_IN_PDU_FLAG_OVERFLOW | SCSI_DATA_IN_PDU_FLAG_UNDERFLOW)) {
2622 //
2623 // Underflow and Overflow are mutual flags.
2624 //
2625 return EFI_PROTOCOL_ERROR;
2626 }
2627 //
2628 // S bit is on, the StatSN is valid.
2629 //
2630 Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, NTOHL (DataInHdr->StatSN));
2631 if (EFI_ERROR (Status)) {
2632 return Status;
2633 }
2634
2635 Packet->HostAdapterStatus = 0;
2636 Packet->TargetStatus = DataInHdr->Status;
2637
2638 if (ISCSI_FLAG_ON (DataInHdr, SCSI_RSP_PDU_FLAG_OVERFLOW)) {
2639 Packet->InTransferLength += NTOHL (DataInHdr->ResidualCount);
2640 Status = EFI_BAD_BUFFER_SIZE;
2641 }
2642
2643 if (ISCSI_FLAG_ON (DataInHdr, SCSI_RSP_PDU_FLAG_UNDERFLOW)) {
2644 Packet->InTransferLength -= NTOHL (DataInHdr->ResidualCount);
2645 }
2646 }
2647
2648 return Status;
2649 }
2650
2651
2652 /**
2653 Process the received iSCSI R2T PDU.
2654
2655 @param[in] Pdu The R2T PDU received.
2656 @param[in] Tcb The task control block.
2657 @param[in] Lun The Lun.
2658 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2659
2660 @retval EFI_SUCCESS The R2T PDU is valid and the solicited data is sent out.
2661 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
2662 @retval Others Other errors as indicated.
2663
2664 **/
2665 EFI_STATUS
2666 IScsiOnR2TRcvd (
2667 IN NET_BUF *Pdu,
2668 IN ISCSI_TCB *Tcb,
2669 IN UINT64 Lun,
2670 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
2671 )
2672 {
2673 ISCSI_READY_TO_TRANSFER *R2THdr;
2674 EFI_STATUS Status;
2675 ISCSI_XFER_CONTEXT *XferContext;
2676 UINT8 *Data;
2677
2678 R2THdr = (ISCSI_READY_TO_TRANSFER *) NetbufGetByte (Pdu, 0, NULL);
2679 if (R2THdr == NULL) {
2680 return EFI_PROTOCOL_ERROR;
2681 }
2682
2683 R2THdr->InitiatorTaskTag = NTOHL (R2THdr->InitiatorTaskTag);
2684 R2THdr->TargetTransferTag = NTOHL (R2THdr->TargetTransferTag);
2685 R2THdr->StatSN = NTOHL (R2THdr->StatSN);
2686 R2THdr->R2TSeqNum = NTOHL (R2THdr->R2TSeqNum);
2687 R2THdr->BufferOffset = NTOHL (R2THdr->BufferOffset);
2688 R2THdr->DesiredDataTransferLength = NTOHL (R2THdr->DesiredDataTransferLength);
2689
2690 if ((R2THdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) || !ISCSI_SEQ_EQ (R2THdr->StatSN, Tcb->Conn->ExpStatSN)) {
2691 return EFI_PROTOCOL_ERROR;;
2692 }
2693 //
2694 // Check the sequence number.
2695 //
2696 Status = IScsiCheckSN (&Tcb->ExpDataSN, R2THdr->R2TSeqNum);
2697 if (EFI_ERROR (Status)) {
2698 return Status;
2699 }
2700
2701 XferContext = &Tcb->XferContext;
2702 XferContext->TargetTransferTag = R2THdr->TargetTransferTag;
2703 XferContext->Offset = R2THdr->BufferOffset;
2704 XferContext->DesiredLength = R2THdr->DesiredDataTransferLength;
2705
2706 if (((XferContext->Offset + XferContext->DesiredLength) > Packet->OutTransferLength) ||
2707 (XferContext->DesiredLength > Tcb->Conn->Session->MaxBurstLength)
2708 ) {
2709 return EFI_PROTOCOL_ERROR;
2710 }
2711 //
2712 // Send the data solicited by this R2T.
2713 //
2714 Data = (UINT8 *) Packet->OutDataBuffer + XferContext->Offset;
2715 Status = IScsiSendDataOutPduSequence (Data, Lun, Tcb);
2716
2717 return Status;
2718 }
2719
2720
2721 /**
2722 Process the received iSCSI SCSI Response PDU.
2723
2724 @param[in] Pdu The Response PDU received.
2725 @param[in] Tcb The task control block.
2726 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2727
2728 @retval EFI_SUCCESS The Response PDU is processed.
2729 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
2730 @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.
2731 @retval Others Other errors as indicated.
2732
2733 **/
2734 EFI_STATUS
2735 IScsiOnScsiRspRcvd (
2736 IN NET_BUF *Pdu,
2737 IN ISCSI_TCB *Tcb,
2738 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
2739 )
2740 {
2741 SCSI_RESPONSE *ScsiRspHdr;
2742 ISCSI_SENSE_DATA *SenseData;
2743 EFI_STATUS Status;
2744 UINT32 DataSegLen;
2745
2746 ScsiRspHdr = (SCSI_RESPONSE *) NetbufGetByte (Pdu, 0, NULL);
2747 if (ScsiRspHdr == NULL) {
2748 return EFI_PROTOCOL_ERROR;
2749 }
2750
2751 ScsiRspHdr->InitiatorTaskTag = NTOHL (ScsiRspHdr->InitiatorTaskTag);
2752 if (ScsiRspHdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) {
2753 return EFI_PROTOCOL_ERROR;
2754 }
2755
2756 ScsiRspHdr->StatSN = NTOHL (ScsiRspHdr->StatSN);
2757
2758 Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, ScsiRspHdr->StatSN);
2759 if (EFI_ERROR (Status)) {
2760 return Status;
2761 }
2762
2763 ScsiRspHdr->MaxCmdSN = NTOHL (ScsiRspHdr->MaxCmdSN);
2764 ScsiRspHdr->ExpCmdSN = NTOHL (ScsiRspHdr->ExpCmdSN);
2765 IScsiUpdateCmdSN (Tcb->Conn->Session, ScsiRspHdr->MaxCmdSN, ScsiRspHdr->ExpCmdSN);
2766
2767 Tcb->StatusXferd = TRUE;
2768
2769 Packet->HostAdapterStatus = ScsiRspHdr->Response;
2770 if (Packet->HostAdapterStatus != ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET) {
2771 return EFI_SUCCESS;
2772 }
2773
2774 Packet->TargetStatus = ScsiRspHdr->Status;
2775
2776 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW | SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW) ||
2777 ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_OVERFLOW | SCSI_RSP_PDU_FLAG_UNDERFLOW)
2778 ) {
2779 return EFI_PROTOCOL_ERROR;
2780 }
2781
2782 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW)) {
2783 Packet->InTransferLength += NTOHL (ScsiRspHdr->BiReadResidualCount);
2784 Status = EFI_BAD_BUFFER_SIZE;
2785 }
2786
2787 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW)) {
2788 Packet->InTransferLength -= NTOHL (ScsiRspHdr->BiReadResidualCount);
2789 }
2790
2791 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_OVERFLOW)) {
2792 if (Packet->DataDirection == DataIn) {
2793 Packet->InTransferLength += NTOHL (ScsiRspHdr->ResidualCount);
2794 } else {
2795 Packet->OutTransferLength += NTOHL (ScsiRspHdr->ResidualCount);
2796 }
2797
2798 Status = EFI_BAD_BUFFER_SIZE;
2799 }
2800
2801 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_UNDERFLOW)) {
2802 if (Packet->DataDirection == DataIn) {
2803 Packet->InTransferLength -= NTOHL (ScsiRspHdr->ResidualCount);
2804 } else {
2805 Packet->OutTransferLength -= NTOHL (ScsiRspHdr->ResidualCount);
2806 }
2807 }
2808
2809 DataSegLen = ISCSI_GET_DATASEG_LEN (ScsiRspHdr);
2810 if (DataSegLen != 0) {
2811 SenseData = (ISCSI_SENSE_DATA *) NetbufGetByte (Pdu, sizeof (SCSI_RESPONSE), NULL);
2812 if (SenseData == NULL) {
2813 return EFI_PROTOCOL_ERROR;
2814 }
2815
2816 SenseData->Length = NTOHS (SenseData->Length);
2817
2818 Packet->SenseDataLength = (UINT8) MIN (SenseData->Length, Packet->SenseDataLength);
2819 if (Packet->SenseDataLength != 0) {
2820 CopyMem (Packet->SenseData, &SenseData->Data[0], Packet->SenseDataLength);
2821 }
2822 } else {
2823 Packet->SenseDataLength = 0;
2824 }
2825
2826 return Status;
2827 }
2828
2829
2830 /**
2831 Process the received NOP In PDU.
2832
2833 @param[in] Pdu The NOP In PDU received.
2834 @param[in] Tcb The task control block.
2835
2836 @retval EFI_SUCCESS The NOP In PDU is processed and the related sequence
2837 numbers are updated.
2838 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
2839
2840 **/
2841 EFI_STATUS
2842 IScsiOnNopInRcvd (
2843 IN NET_BUF *Pdu,
2844 IN ISCSI_TCB *Tcb
2845 )
2846 {
2847 ISCSI_NOP_IN *NopInHdr;
2848 EFI_STATUS Status;
2849
2850 NopInHdr = (ISCSI_NOP_IN *) NetbufGetByte (Pdu, 0, NULL);
2851 if (NopInHdr == NULL) {
2852 return EFI_PROTOCOL_ERROR;
2853 }
2854
2855 NopInHdr->StatSN = NTOHL (NopInHdr->StatSN);
2856 NopInHdr->ExpCmdSN = NTOHL (NopInHdr->ExpCmdSN);
2857 NopInHdr->MaxCmdSN = NTOHL (NopInHdr->MaxCmdSN);
2858
2859 if (NopInHdr->InitiatorTaskTag == ISCSI_RESERVED_TAG) {
2860 if (NopInHdr->StatSN != Tcb->Conn->ExpStatSN) {
2861 return EFI_PROTOCOL_ERROR;
2862 }
2863 } else {
2864 Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, NopInHdr->StatSN);
2865 if (EFI_ERROR (Status)) {
2866 return Status;
2867 }
2868 }
2869
2870 IScsiUpdateCmdSN (Tcb->Conn->Session, NopInHdr->MaxCmdSN, NopInHdr->ExpCmdSN);
2871
2872 return EFI_SUCCESS;
2873 }
2874
2875
2876 /**
2877 Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.
2878
2879 @param[in] PassThru The EXT SCSI PASS THRU protocol.
2880 @param[in] Target The target ID.
2881 @param[in] Lun The LUN.
2882 @param[in, out] Packet The request packet containing IO request, SCSI command
2883 buffer and buffers to read/write.
2884
2885 @retval EFI_SUCCESS The SCSI command is executed and the result is updated to
2886 the Packet.
2887 @retval EFI_DEVICE_ERROR Session state was not as required.
2888 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
2889 @retval EFI_PROTOCOL_ERROR There is no such data in the net buffer.
2890 @retval EFI_NOT_READY The target can not accept new commands.
2891 @retval Others Other errors as indicated.
2892
2893 **/
2894 EFI_STATUS
2895 IScsiExecuteScsiCommand (
2896 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *PassThru,
2897 IN UINT8 *Target,
2898 IN UINT64 Lun,
2899 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
2900 )
2901 {
2902 EFI_STATUS Status;
2903 ISCSI_DRIVER_DATA *Private;
2904 ISCSI_SESSION *Session;
2905 EFI_EVENT TimeoutEvent;
2906 ISCSI_CONNECTION *Conn;
2907 ISCSI_TCB *Tcb;
2908 NET_BUF *Pdu;
2909 ISCSI_XFER_CONTEXT *XferContext;
2910 UINT8 *Data;
2911 ISCSI_IN_BUFFER_CONTEXT InBufferContext;
2912 UINT64 Timeout;
2913 UINT8 *PduHdr;
2914
2915 Private = ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (PassThru);
2916 Session = Private->Session;
2917 Status = EFI_SUCCESS;
2918 Tcb = NULL;
2919 TimeoutEvent = NULL;
2920 Timeout = 0;
2921
2922 if (Session->State != SESSION_STATE_LOGGED_IN) {
2923 Status = EFI_DEVICE_ERROR;
2924 goto ON_EXIT;
2925 }
2926
2927 Conn = NET_LIST_USER_STRUCT_S (
2928 Session->Conns.ForwardLink,
2929 ISCSI_CONNECTION,
2930 Link,
2931 ISCSI_CONNECTION_SIGNATURE
2932 );
2933
2934 if (Packet->Timeout != 0) {
2935 Timeout = MultU64x32 (Packet->Timeout, 4);
2936 }
2937
2938 Status = IScsiNewTcb (Conn, &Tcb);
2939 if (EFI_ERROR (Status)) {
2940 goto ON_EXIT;
2941 }
2942 //
2943 // Encapsulate the SCSI request packet into an iSCSI SCSI Command PDU.
2944 //
2945 Pdu = IScsiNewScsiCmdPdu (Packet, Lun, Tcb);
2946 if (Pdu == NULL) {
2947 Status = EFI_OUT_OF_RESOURCES;
2948 goto ON_EXIT;
2949 }
2950
2951 XferContext = &Tcb->XferContext;
2952 PduHdr = NetbufGetByte (Pdu, 0, NULL);
2953 if (PduHdr == NULL) {
2954 Status = EFI_PROTOCOL_ERROR;
2955 NetbufFree (Pdu);
2956 goto ON_EXIT;
2957 }
2958 XferContext->Offset = ISCSI_GET_DATASEG_LEN (PduHdr);
2959
2960 //
2961 // Transmit the SCSI Command PDU.
2962 //
2963 Status = TcpIoTransmit (&Conn->TcpIo, Pdu);
2964
2965 NetbufFree (Pdu);
2966
2967 if (EFI_ERROR (Status)) {
2968 goto ON_EXIT;
2969 }
2970
2971 if (!Session->InitialR2T &&
2972 (XferContext->Offset < Session->FirstBurstLength) &&
2973 (XferContext->Offset < Packet->OutTransferLength)
2974 ) {
2975 //
2976 // Unsolicited Data-Out sequence is allowed. There is remaining SCSI
2977 // OUT data, and the limit of FirstBurstLength is not reached.
2978 //
2979 XferContext->TargetTransferTag = ISCSI_RESERVED_TAG;
2980 XferContext->DesiredLength = MIN (
2981 Session->FirstBurstLength,
2982 Packet->OutTransferLength - XferContext->Offset
2983 );
2984
2985 Data = (UINT8 *) Packet->OutDataBuffer + XferContext->Offset;
2986 Status = IScsiSendDataOutPduSequence (Data, Lun, Tcb);
2987 if (EFI_ERROR (Status)) {
2988 goto ON_EXIT;
2989 }
2990 }
2991
2992 InBufferContext.InData = (UINT8 *) Packet->InDataBuffer;
2993 InBufferContext.InDataLen = Packet->InTransferLength;
2994
2995 while (!Tcb->StatusXferd) {
2996 //
2997 // Start the timeout timer.
2998 //
2999 if (Timeout != 0) {
3000 Status = gBS->SetTimer (Conn->TimeoutEvent, TimerRelative, Timeout);
3001 if (EFI_ERROR (Status)) {
3002 goto ON_EXIT;
3003 }
3004
3005 TimeoutEvent = Conn->TimeoutEvent;
3006 }
3007
3008 //
3009 // Try to receive PDU from target.
3010 //
3011 Status = IScsiReceivePdu (Conn, &Pdu, &InBufferContext, FALSE, FALSE, TimeoutEvent);
3012 if (EFI_ERROR (Status)) {
3013 goto ON_EXIT;
3014 }
3015
3016 PduHdr = NetbufGetByte (Pdu, 0, NULL);
3017 if (PduHdr == NULL) {
3018 Status = EFI_PROTOCOL_ERROR;
3019 NetbufFree (Pdu);
3020 goto ON_EXIT;
3021 }
3022 switch (ISCSI_GET_OPCODE (PduHdr)) {
3023 case ISCSI_OPCODE_SCSI_DATA_IN:
3024 Status = IScsiOnDataInRcvd (Pdu, Tcb, Packet);
3025 break;
3026
3027 case ISCSI_OPCODE_R2T:
3028 Status = IScsiOnR2TRcvd (Pdu, Tcb, Lun, Packet);
3029 break;
3030
3031 case ISCSI_OPCODE_SCSI_RSP:
3032 Status = IScsiOnScsiRspRcvd (Pdu, Tcb, Packet);
3033 break;
3034
3035 case ISCSI_OPCODE_NOP_IN:
3036 Status = IScsiOnNopInRcvd (Pdu, Tcb);
3037 break;
3038
3039 case ISCSI_OPCODE_VENDOR_T0:
3040 case ISCSI_OPCODE_VENDOR_T1:
3041 case ISCSI_OPCODE_VENDOR_T2:
3042 //
3043 // These messages are vendor specific. Skip them.
3044 //
3045 break;
3046
3047 default:
3048 Status = EFI_PROTOCOL_ERROR;
3049 break;
3050 }
3051
3052 NetbufFree (Pdu);
3053
3054 if (EFI_ERROR (Status)) {
3055 break;
3056 }
3057 }
3058
3059 ON_EXIT:
3060
3061 if (TimeoutEvent != NULL) {
3062 gBS->SetTimer (TimeoutEvent, TimerCancel, 0);
3063 }
3064
3065 if (Tcb != NULL) {
3066 IScsiDelTcb (Tcb);
3067 }
3068
3069 return Status;
3070 }
3071
3072
3073 /**
3074 Reinstate the session on some error.
3075
3076 @param[in] Session The iSCSI session
3077
3078 @retval EFI_SUCCESS The session is reinstated from some error.
3079 @retval Other Reinstatement failed.
3080
3081 **/
3082 EFI_STATUS
3083 IScsiSessionReinstatement (
3084 IN ISCSI_SESSION *Session
3085 )
3086 {
3087 EFI_STATUS Status;
3088
3089 ASSERT (Session->State != SESSION_STATE_FREE);
3090
3091 //
3092 // Abort the session and re-init it.
3093 //
3094 IScsiSessionAbort (Session);
3095 IScsiSessionInit (Session, TRUE);
3096
3097 //
3098 // Login again.
3099 //
3100 Status = IScsiSessionLogin (Session);
3101
3102 return Status;
3103 }
3104
3105
3106 /**
3107 Initialize some session parameters before login.
3108
3109 @param[in, out] Session The iSCSI session.
3110 @param[in] Recovery Whether the request is from a fresh new start or recovery.
3111
3112 **/
3113 VOID
3114 IScsiSessionInit (
3115 IN OUT ISCSI_SESSION *Session,
3116 IN BOOLEAN Recovery
3117 )
3118 {
3119 if (!Recovery) {
3120 Session->Signature = ISCSI_SESSION_SIGNATURE;
3121 Session->State = SESSION_STATE_FREE;
3122
3123 InitializeListHead (&Session->Conns);
3124 InitializeListHead (&Session->TcbList);
3125 }
3126
3127 Session->Tsih = 0;
3128
3129 Session->CmdSN = 1;
3130 Session->InitiatorTaskTag = 1;
3131 Session->NextCid = 1;
3132
3133 Session->TargetPortalGroupTag = 0;
3134 Session->MaxConnections = ISCSI_MAX_CONNS_PER_SESSION;
3135 Session->InitialR2T = FALSE;
3136 Session->ImmediateData = TRUE;
3137 Session->MaxBurstLength = 262144;
3138 Session->FirstBurstLength = MAX_RECV_DATA_SEG_LEN_IN_FFP;
3139 Session->DefaultTime2Wait = 2;
3140 Session->DefaultTime2Retain = 20;
3141 Session->MaxOutstandingR2T = DEFAULT_MAX_OUTSTANDING_R2T;
3142 Session->DataPDUInOrder = TRUE;
3143 Session->DataSequenceInOrder = TRUE;
3144 Session->ErrorRecoveryLevel = 0;
3145 }
3146
3147
3148 /**
3149 Abort the iSCSI session. That is, reset all the connection(s), and free the
3150 resources.
3151
3152 @param[in, out] Session The iSCSI session.
3153
3154 **/
3155 VOID
3156 IScsiSessionAbort (
3157 IN OUT ISCSI_SESSION *Session
3158 )
3159 {
3160 ISCSI_CONNECTION *Conn;
3161 EFI_GUID *ProtocolGuid;
3162
3163 if (Session->State != SESSION_STATE_LOGGED_IN) {
3164 return ;
3165 }
3166
3167 ASSERT (!IsListEmpty (&Session->Conns));
3168
3169 while (!IsListEmpty (&Session->Conns)) {
3170 Conn = NET_LIST_USER_STRUCT_S (
3171 Session->Conns.ForwardLink,
3172 ISCSI_CONNECTION,
3173 Link,
3174 ISCSI_CONNECTION_SIGNATURE
3175 );
3176 if (!Conn->Ipv6Flag) {
3177 ProtocolGuid = &gEfiTcp4ProtocolGuid;
3178 } else {
3179 ProtocolGuid = &gEfiTcp6ProtocolGuid;
3180 }
3181
3182 gBS->CloseProtocol (
3183 Conn->TcpIo.Handle,
3184 ProtocolGuid,
3185 Session->Private->Image,
3186 Session->Private->ExtScsiPassThruHandle
3187 );
3188
3189 IScsiConnReset (Conn);
3190
3191 IScsiDetatchConnection (Conn);
3192 IScsiDestroyConnection (Conn);
3193 }
3194
3195 Session->State = SESSION_STATE_FAILED;
3196
3197 return ;
3198 }
EFI Development Kit II mirror for PVE