943bdefc1606a77f5f682d3310ce8d6edae4f723
[people/sha0/gpxe.git] / src / net / tcp / iscsi.c
1 /*
2  * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 FILE_LICENCE ( GPL2_OR_LATER );
20
21 #include <stddef.h>
22 #include <string.h>
23 #include <stdlib.h>
24 #include <stdio.h>
25 #include <errno.h>
26 #include <assert.h>
27 #include <byteswap.h>
28 #include <gpxe/vsprintf.h>
29 #include <gpxe/socket.h>
30 #include <gpxe/xfer.h>
31 #include <gpxe/open.h>
32 #include <gpxe/scsi.h>
33 #include <gpxe/process.h>
34 #include <gpxe/uaccess.h>
35 #include <gpxe/tcpip.h>
36 #include <gpxe/settings.h>
37 #include <gpxe/features.h>
38 #include <gpxe/iscsi.h>
39
40 /** @file
41  *
42  * iSCSI protocol
43  *
44  */
45
46 FEATURE ( FEATURE_PROTOCOL, "iSCSI", DHCP_EB_FEATURE_ISCSI, 1 );
47
48 /** iSCSI initiator name (explicitly specified) */
49 static char *iscsi_explicit_initiator_iqn;
50
51 /** Default iSCSI initiator name (constructed from hostname) */
52 static char *iscsi_default_initiator_iqn;
53
54 /** iSCSI initiator username */
55 static char *iscsi_initiator_username;
56
57 /** iSCSI initiator password */
58 static char *iscsi_initiator_password;
59
60 /** iSCSI target username */
61 static char *iscsi_target_username;
62
63 /** iSCSI target password */
64 static char *iscsi_target_password;
65
66 static void iscsi_start_tx ( struct iscsi_session *iscsi );
67 static void iscsi_start_login ( struct iscsi_session *iscsi );
68 static void iscsi_start_data_out ( struct iscsi_session *iscsi,
69                                    unsigned int datasn );
70
71 /**
72  * Finish receiving PDU data into buffer
73  *
74  * @v iscsi             iSCSI session
75  */
76 static void iscsi_rx_buffered_data_done ( struct iscsi_session *iscsi ) {
77         free ( iscsi->rx_buffer );
78         iscsi->rx_buffer = NULL;
79 }
80
81 /**
82  * Free iSCSI session
83  *
84  * @v refcnt            Reference counter
85  */
86 static void iscsi_free ( struct refcnt *refcnt ) {
87         struct iscsi_session *iscsi =
88                 container_of ( refcnt, struct iscsi_session, refcnt );
89
90         free ( iscsi->target_address );
91         free ( iscsi->target_iqn );
92         free ( iscsi->initiator_username );
93         free ( iscsi->initiator_password );
94         free ( iscsi->target_username );
95         free ( iscsi->target_password );
96         chap_finish ( &iscsi->chap );
97         iscsi_rx_buffered_data_done ( iscsi );
98         free ( iscsi );
99 }
100
101 /**
102  * Open iSCSI transport-layer connection
103  *
104  * @v iscsi             iSCSI session
105  * @ret rc              Return status code
106  */
107 static int iscsi_open_connection ( struct iscsi_session *iscsi ) {
108         struct sockaddr_tcpip target;
109         int rc;
110
111         assert ( iscsi->tx_state == ISCSI_TX_IDLE );
112         assert ( iscsi->rx_state == ISCSI_RX_BHS );
113         assert ( iscsi->rx_offset == 0 );
114
115         /* Open socket */
116         memset ( &target, 0, sizeof ( target ) );
117         target.st_port = htons ( iscsi->target_port );
118         if ( ( rc = xfer_open_named_socket ( &iscsi->socket, SOCK_STREAM,
119                                              ( struct sockaddr * ) &target,
120                                              iscsi->target_address,
121                                              NULL ) ) != 0 ) {
122                 DBGC ( iscsi, "iSCSI %p could not open socket: %s\n",
123                        iscsi, strerror ( rc ) );
124                 return rc;
125         }
126
127         /* Enter security negotiation phase */
128         iscsi->status = ( ISCSI_STATUS_SECURITY_NEGOTIATION_PHASE |
129                           ISCSI_STATUS_STRINGS_SECURITY );
130         if ( iscsi->target_username )
131                 iscsi->status |= ISCSI_STATUS_AUTH_REVERSE_REQUIRED;
132
133         /* Assign fresh initiator task tag */
134         iscsi->itt++;
135
136         /* Initiate login */
137         iscsi_start_login ( iscsi );
138
139         return 0;
140 }
141
142 /**
143  * Close iSCSI transport-layer connection
144  *
145  * @v iscsi             iSCSI session
146  * @v rc                Reason for close
147  *
148  * Closes the transport-layer connection and resets the session state
149  * ready to attempt a fresh login.
150  */
151 static void iscsi_close_connection ( struct iscsi_session *iscsi, int rc ) {
152
153         /* Close all data transfer interfaces */
154         xfer_close ( &iscsi->socket, rc );
155
156         /* Clear connection status */
157         iscsi->status = 0;
158
159         /* Reset TX and RX state machines */
160         iscsi->tx_state = ISCSI_TX_IDLE;
161         iscsi->rx_state = ISCSI_RX_BHS;
162         iscsi->rx_offset = 0;
163
164         /* Free any temporary dynamically allocated memory */
165         chap_finish ( &iscsi->chap );
166         iscsi_rx_buffered_data_done ( iscsi );
167 }
168
169 /**
170  * Mark iSCSI SCSI operation as complete
171  *
172  * @v iscsi             iSCSI session
173  * @v rc                Return status code
174  *
175  * Note that iscsi_scsi_done() will not close the connection, and must
176  * therefore be called only when the internal state machines are in an
177  * appropriate state, otherwise bad things may happen on the next call
178  * to iscsi_issue().  The general rule is to call iscsi_scsi_done()
179  * only at the end of receiving a PDU; at this point the TX and RX
180  * engines should both be idle.
181  */
182 static void iscsi_scsi_done ( struct iscsi_session *iscsi, int rc ) {
183
184         assert ( iscsi->tx_state == ISCSI_TX_IDLE );
185
186         iscsi->command = NULL;
187         iscsi->rc = rc;
188 }
189
190 /****************************************************************************
191  *
192  * iSCSI SCSI command issuing
193  *
194  */
195
196 /**
197  * Build iSCSI SCSI command BHS
198  *
199  * @v iscsi             iSCSI session
200  *
201  * We don't currently support bidirectional commands (i.e. with both
202  * Data-In and Data-Out segments); these would require providing code
203  * to generate an AHS, and there doesn't seem to be any need for it at
204  * the moment.
205  */
206 static void iscsi_start_command ( struct iscsi_session *iscsi ) {
207         struct iscsi_bhs_scsi_command *command = &iscsi->tx_bhs.scsi_command;
208
209         assert ( ! ( iscsi->command->data_in && iscsi->command->data_out ) );
210
211         /* Construct BHS and initiate transmission */
212         iscsi_start_tx ( iscsi );
213         command->opcode = ISCSI_OPCODE_SCSI_COMMAND;
214         command->flags = ( ISCSI_FLAG_FINAL |
215                            ISCSI_COMMAND_ATTR_SIMPLE );
216         if ( iscsi->command->data_in )
217                 command->flags |= ISCSI_COMMAND_FLAG_READ;
218         if ( iscsi->command->data_out )
219                 command->flags |= ISCSI_COMMAND_FLAG_WRITE;
220         /* lengths left as zero */
221         command->lun = iscsi->lun;
222         command->itt = htonl ( ++iscsi->itt );
223         command->exp_len = htonl ( iscsi->command->data_in_len |
224                                    iscsi->command->data_out_len );
225         command->cmdsn = htonl ( iscsi->cmdsn );
226         command->expstatsn = htonl ( iscsi->statsn + 1 );
227         memcpy ( &command->cdb, &iscsi->command->cdb, sizeof ( command->cdb ));
228         DBGC2 ( iscsi, "iSCSI %p start " SCSI_CDB_FORMAT " %s %#zx\n",
229                 iscsi, SCSI_CDB_DATA ( command->cdb ),
230                 ( iscsi->command->data_in ? "in" : "out" ),
231                 ( iscsi->command->data_in ?
232                   iscsi->command->data_in_len :
233                   iscsi->command->data_out_len ) );
234 }
235
236 /**
237  * Receive data segment of an iSCSI SCSI response PDU
238  *
239  * @v iscsi             iSCSI session
240  * @v data              Received data
241  * @v len               Length of received data
242  * @v remaining         Data remaining after this data
243  * @ret rc              Return status code
244  */
245 static int iscsi_rx_scsi_response ( struct iscsi_session *iscsi,
246                                     const void *data, size_t len,
247                                     size_t remaining ) {
248         struct iscsi_bhs_scsi_response *response
249                 = &iscsi->rx_bhs.scsi_response;
250         int sense_offset;
251
252         /* Capture the sense response code as it floats past, if present */
253         sense_offset = ISCSI_SENSE_RESPONSE_CODE_OFFSET - iscsi->rx_offset;
254         if ( ( sense_offset >= 0 ) && len ) {
255                 iscsi->command->sense_response =
256                         * ( ( char * ) data + sense_offset );
257         }
258
259         /* Wait for whole SCSI response to arrive */
260         if ( remaining )
261                 return 0;
262         
263         /* Record SCSI status code */
264         iscsi->command->status = response->status;
265
266         /* Check for errors */
267         if ( response->response != ISCSI_RESPONSE_COMMAND_COMPLETE )
268                 return -EIO;
269
270         /* Mark as completed */
271         iscsi_scsi_done ( iscsi, 0 );
272         return 0;
273 }
274
275 /**
276  * Receive data segment of an iSCSI data-in PDU
277  *
278  * @v iscsi             iSCSI session
279  * @v data              Received data
280  * @v len               Length of received data
281  * @v remaining         Data remaining after this data
282  * @ret rc              Return status code
283  */
284 static int iscsi_rx_data_in ( struct iscsi_session *iscsi,
285                               const void *data, size_t len,
286                               size_t remaining ) {
287         struct iscsi_bhs_data_in *data_in = &iscsi->rx_bhs.data_in;
288         unsigned long offset;
289
290         /* Copy data to data-in buffer */
291         offset = ntohl ( data_in->offset ) + iscsi->rx_offset;
292         assert ( iscsi->command != NULL );
293         assert ( iscsi->command->data_in );
294         assert ( ( offset + len ) <= iscsi->command->data_in_len );
295         copy_to_user ( iscsi->command->data_in, offset, data, len );
296
297         /* Wait for whole SCSI response to arrive */
298         if ( remaining )
299                 return 0;
300
301         /* Mark as completed if status is present */
302         if ( data_in->flags & ISCSI_DATA_FLAG_STATUS ) {
303                 assert ( ( offset + len ) == iscsi->command->data_in_len );
304                 assert ( data_in->flags & ISCSI_FLAG_FINAL );
305                 iscsi->command->status = data_in->status;
306                 /* iSCSI cannot return an error status via a data-in */
307                 iscsi_scsi_done ( iscsi, 0 );
308         }
309
310         return 0;
311 }
312
313 /**
314  * Receive data segment of an iSCSI R2T PDU
315  *
316  * @v iscsi             iSCSI session
317  * @v data              Received data
318  * @v len               Length of received data
319  * @v remaining         Data remaining after this data
320  * @ret rc              Return status code
321  */
322 static int iscsi_rx_r2t ( struct iscsi_session *iscsi,
323                           const void *data __unused, size_t len __unused,
324                           size_t remaining __unused ) {
325         struct iscsi_bhs_r2t *r2t = &iscsi->rx_bhs.r2t;
326
327         /* Record transfer parameters and trigger first data-out */
328         iscsi->ttt = ntohl ( r2t->ttt );
329         iscsi->transfer_offset = ntohl ( r2t->offset );
330         iscsi->transfer_len = ntohl ( r2t->len );
331         iscsi_start_data_out ( iscsi, 0 );
332
333         return 0;
334 }
335
336 /**
337  * Build iSCSI data-out BHS
338  *
339  * @v iscsi             iSCSI session
340  * @v datasn            Data sequence number within the transfer
341  *
342  */
343 static void iscsi_start_data_out ( struct iscsi_session *iscsi,
344                                    unsigned int datasn ) {
345         struct iscsi_bhs_data_out *data_out = &iscsi->tx_bhs.data_out;
346         unsigned long offset;
347         unsigned long remaining;
348         unsigned long len;
349
350         /* We always send 512-byte Data-Out PDUs; this removes the
351          * need to worry about the target's MaxRecvDataSegmentLength.
352          */
353         offset = datasn * 512;
354         remaining = iscsi->transfer_len - offset;
355         len = remaining;
356         if ( len > 512 )
357                 len = 512;
358
359         /* Construct BHS and initiate transmission */
360         iscsi_start_tx ( iscsi );
361         data_out->opcode = ISCSI_OPCODE_DATA_OUT;
362         if ( len == remaining )
363                 data_out->flags = ( ISCSI_FLAG_FINAL );
364         ISCSI_SET_LENGTHS ( data_out->lengths, 0, len );
365         data_out->lun = iscsi->lun;
366         data_out->itt = htonl ( iscsi->itt );
367         data_out->ttt = htonl ( iscsi->ttt );
368         data_out->expstatsn = htonl ( iscsi->statsn + 1 );
369         data_out->datasn = htonl ( datasn );
370         data_out->offset = htonl ( iscsi->transfer_offset + offset );
371         DBGC ( iscsi, "iSCSI %p start data out DataSN %#x len %#lx\n",
372                iscsi, datasn, len );
373 }
374
375 /**
376  * Complete iSCSI data-out PDU transmission
377  *
378  * @v iscsi             iSCSI session
379  *
380  */
381 static void iscsi_data_out_done ( struct iscsi_session *iscsi ) {
382         struct iscsi_bhs_data_out *data_out = &iscsi->tx_bhs.data_out;
383
384         /* If we haven't reached the end of the sequence, start
385          * sending the next data-out PDU.
386          */
387         if ( ! ( data_out->flags & ISCSI_FLAG_FINAL ) )
388                 iscsi_start_data_out ( iscsi, ntohl ( data_out->datasn ) + 1 );
389 }
390
391 /**
392  * Send iSCSI data-out data segment
393  *
394  * @v iscsi             iSCSI session
395  * @ret rc              Return status code
396  */
397 static int iscsi_tx_data_out ( struct iscsi_session *iscsi ) {
398         struct iscsi_bhs_data_out *data_out = &iscsi->tx_bhs.data_out;
399         struct io_buffer *iobuf;
400         unsigned long offset;
401         size_t len;
402
403         offset = ntohl ( data_out->offset );
404         len = ISCSI_DATA_LEN ( data_out->lengths );
405
406         assert ( iscsi->command != NULL );
407         assert ( iscsi->command->data_out );
408         assert ( ( offset + len ) <= iscsi->command->data_out_len );
409
410         iobuf = xfer_alloc_iob ( &iscsi->socket, len );
411         if ( ! iobuf )
412                 return -ENOMEM;
413         
414         copy_from_user ( iob_put ( iobuf, len ),
415                          iscsi->command->data_out, offset, len );
416
417         return xfer_deliver_iob ( &iscsi->socket, iobuf );
418 }
419
420 /****************************************************************************
421  *
422  * iSCSI login
423  *
424  */
425
426 /**
427  * Build iSCSI login request strings
428  *
429  * @v iscsi             iSCSI session
430  *
431  * These are the initial set of strings sent in the first login
432  * request PDU.  We want the following settings:
433  *
434  *     HeaderDigest=None
435  *     DataDigest=None
436  *     MaxConnections is irrelevant; we make only one connection anyway
437  *     InitialR2T=Yes [1]
438  *     ImmediateData is irrelevant; we never send immediate data
439  *     MaxRecvDataSegmentLength=8192 (default; we don't care) [3]
440  *     MaxBurstLength=262144 (default; we don't care) [3]
441  *     FirstBurstLength=262144 (default; we don't care)
442  *     DefaultTime2Wait=0 [2]
443  *     DefaultTime2Retain=0 [2]
444  *     MaxOutstandingR2T=1
445  *     DataPDUInOrder=Yes
446  *     DataSequenceInOrder=Yes
447  *     ErrorRecoveryLevel=0
448  *
449  * [1] InitialR2T has an OR resolution function, so the target may
450  * force us to use it.  We therefore simplify our logic by always
451  * using it.
452  *
453  * [2] These ensure that we can safely start a new task once we have
454  * reconnected after a failure, without having to manually tidy up
455  * after the old one.
456  *
457  * [3] We are quite happy to use the RFC-defined default values for
458  * these parameters, but some targets (notably OpenSolaris)
459  * incorrectly assume a default value of zero, so we explicitly
460  * specify the default values.
461  */
462 static int iscsi_build_login_request_strings ( struct iscsi_session *iscsi,
463                                                void *data, size_t len ) {
464         unsigned int used = 0;
465         unsigned int i;
466         const char *auth_method;
467
468         if ( iscsi->status & ISCSI_STATUS_STRINGS_SECURITY ) {
469                 /* Default to allowing no authentication */
470                 auth_method = "None";
471                 /* If we have a credential to supply, permit CHAP */
472                 if ( iscsi->initiator_username )
473                         auth_method = "CHAP,None";
474                 /* If we have a credential to check, force CHAP */
475                 if ( iscsi->target_username )
476                         auth_method = "CHAP";
477                 used += ssnprintf ( data + used, len - used,
478                                     "InitiatorName=%s%c"
479                                     "TargetName=%s%c"
480                                     "SessionType=Normal%c"
481                                     "AuthMethod=%s%c",
482                                     iscsi_initiator_iqn(), 0,
483                                     iscsi->target_iqn, 0, 0,
484                                     auth_method, 0 );
485         }
486
487         if ( iscsi->status & ISCSI_STATUS_STRINGS_CHAP_ALGORITHM ) {
488                 used += ssnprintf ( data + used, len - used, "CHAP_A=5%c", 0 );
489         }
490         
491         if ( ( iscsi->status & ISCSI_STATUS_STRINGS_CHAP_RESPONSE ) ) {
492                 assert ( iscsi->initiator_username != NULL );
493                 used += ssnprintf ( data + used, len - used,
494                                     "CHAP_N=%s%cCHAP_R=0x",
495                                     iscsi->initiator_username, 0 );
496                 for ( i = 0 ; i < iscsi->chap.response_len ; i++ ) {
497                         used += ssnprintf ( data + used, len - used, "%02x",
498                                             iscsi->chap.response[i] );
499                 }
500                 used += ssnprintf ( data + used, len - used, "%c", 0 );
501         }
502
503         if ( ( iscsi->status & ISCSI_STATUS_STRINGS_CHAP_CHALLENGE ) ) {
504                 used += ssnprintf ( data + used, len - used,
505                                     "CHAP_I=%d%cCHAP_C=0x",
506                                     iscsi->chap_challenge[0], 0 );
507                 for ( i = 1 ; i < sizeof ( iscsi->chap_challenge ) ; i++ ) {
508                         used += ssnprintf ( data + used, len - used, "%02x",
509                                             iscsi->chap_challenge[i] );
510                 }
511                 used += ssnprintf ( data + used, len - used, "%c", 0 );
512         }
513
514         if ( iscsi->status & ISCSI_STATUS_STRINGS_OPERATIONAL ) {
515                 used += ssnprintf ( data + used, len - used,
516                                     "HeaderDigest=None%c"
517                                     "DataDigest=None%c"
518                                     "InitialR2T=Yes%c"
519                                     "MaxRecvDataSegmentLength=8192%c"
520                                     "MaxBurstLength=262144%c"
521                                     "DefaultTime2Wait=0%c"
522                                     "DefaultTime2Retain=0%c"
523                                     "MaxOutstandingR2T=1%c"
524                                     "DataPDUInOrder=Yes%c"
525                                     "DataSequenceInOrder=Yes%c"
526                                     "ErrorRecoveryLevel=0%c",
527                                     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 );
528         }
529
530         return used;
531 }
532
533 /**
534  * Build iSCSI login request BHS
535  *
536  * @v iscsi             iSCSI session
537  */
538 static void iscsi_start_login ( struct iscsi_session *iscsi ) {
539         struct iscsi_bhs_login_request *request = &iscsi->tx_bhs.login_request;
540         int len;
541
542         /* Construct BHS and initiate transmission */
543         iscsi_start_tx ( iscsi );
544         request->opcode = ( ISCSI_OPCODE_LOGIN_REQUEST |
545                             ISCSI_FLAG_IMMEDIATE );
546         request->flags = ( ( iscsi->status & ISCSI_STATUS_PHASE_MASK ) |
547                            ISCSI_LOGIN_FLAG_TRANSITION );
548         /* version_max and version_min left as zero */
549         len = iscsi_build_login_request_strings ( iscsi, NULL, 0 );
550         ISCSI_SET_LENGTHS ( request->lengths, 0, len );
551         request->isid_iana_en = htonl ( ISCSI_ISID_IANA |
552                                         IANA_EN_FEN_SYSTEMS );
553         /* isid_iana_qual left as zero */
554         request->tsih = htons ( iscsi->tsih );
555         request->itt = htonl ( iscsi->itt );
556         /* cid left as zero */
557         request->cmdsn = htonl ( iscsi->cmdsn );
558         request->expstatsn = htonl ( iscsi->statsn + 1 );
559 }
560
561 /**
562  * Complete iSCSI login request PDU transmission
563  *
564  * @v iscsi             iSCSI session
565  *
566  */
567 static void iscsi_login_request_done ( struct iscsi_session *iscsi ) {
568
569         /* Clear any "strings to send" flags */
570         iscsi->status &= ~ISCSI_STATUS_STRINGS_MASK;
571
572         /* Free any dynamically allocated storage used for login */
573         chap_finish ( &iscsi->chap );
574 }
575
576 /**
577  * Transmit data segment of an iSCSI login request PDU
578  *
579  * @v iscsi             iSCSI session
580  * @ret rc              Return status code
581  *
582  * For login requests, the data segment consists of the login strings.
583  */
584 static int iscsi_tx_login_request ( struct iscsi_session *iscsi ) {
585         struct iscsi_bhs_login_request *request = &iscsi->tx_bhs.login_request;
586         struct io_buffer *iobuf;
587         size_t len;
588
589         len = ISCSI_DATA_LEN ( request->lengths );
590         iobuf = xfer_alloc_iob ( &iscsi->socket, len );
591         if ( ! iobuf )
592                 return -ENOMEM;
593         iob_put ( iobuf, len );
594         iscsi_build_login_request_strings ( iscsi, iobuf->data, len );
595         return xfer_deliver_iob ( &iscsi->socket, iobuf );
596 }
597
598 /**
599  * Handle iSCSI TargetAddress text value
600  *
601  * @v iscsi             iSCSI session
602  * @v value             TargetAddress value
603  * @ret rc              Return status code
604  */
605 static int iscsi_handle_targetaddress_value ( struct iscsi_session *iscsi,
606                                               const char *value ) {
607         char *separator;
608
609         DBGC ( iscsi, "iSCSI %p will redirect to %s\n", iscsi, value );
610
611         /* Replace target address */
612         free ( iscsi->target_address );
613         iscsi->target_address = strdup ( value );
614         if ( ! iscsi->target_address )
615                 return -ENOMEM;
616
617         /* Replace target port */
618         iscsi->target_port = htons ( ISCSI_PORT );
619         separator = strchr ( iscsi->target_address, ':' );
620         if ( separator ) {
621                 *separator = '\0';
622                 iscsi->target_port = strtoul ( ( separator + 1 ), NULL, 0 );
623         }
624
625         return 0;
626 }
627
628 /**
629  * Handle iSCSI AuthMethod text value
630  *
631  * @v iscsi             iSCSI session
632  * @v value             AuthMethod value
633  * @ret rc              Return status code
634  */
635 static int iscsi_handle_authmethod_value ( struct iscsi_session *iscsi,
636                                            const char *value ) {
637
638         /* If server requests CHAP, send the CHAP_A string */
639         if ( strcmp ( value, "CHAP" ) == 0 ) {
640                 DBGC ( iscsi, "iSCSI %p initiating CHAP authentication\n",
641                        iscsi );
642                 iscsi->status |= ( ISCSI_STATUS_STRINGS_CHAP_ALGORITHM |
643                                    ISCSI_STATUS_AUTH_FORWARD_REQUIRED );
644         }
645
646         return 0;
647 }
648
649 /**
650  * Handle iSCSI CHAP_A text value
651  *
652  * @v iscsi             iSCSI session
653  * @v value             CHAP_A value
654  * @ret rc              Return status code
655  */
656 static int iscsi_handle_chap_a_value ( struct iscsi_session *iscsi,
657                                        const char *value ) {
658
659         /* We only ever offer "5" (i.e. MD5) as an algorithm, so if
660          * the server responds with anything else it is a protocol
661          * violation.
662          */
663         if ( strcmp ( value, "5" ) != 0 ) {
664                 DBGC ( iscsi, "iSCSI %p got invalid CHAP algorithm \"%s\"\n",
665                        iscsi, value );
666                 return -EPROTO;
667         }
668
669         return 0;
670 }
671
672 /**
673  * Handle iSCSI CHAP_I text value
674  *
675  * @v iscsi             iSCSI session
676  * @v value             CHAP_I value
677  * @ret rc              Return status code
678  */
679 static int iscsi_handle_chap_i_value ( struct iscsi_session *iscsi,
680                                        const char *value ) {
681         unsigned int identifier;
682         char *endp;
683         int rc;
684
685         /* The CHAP identifier is an integer value */
686         identifier = strtoul ( value, &endp, 0 );
687         if ( *endp != '\0' ) {
688                 DBGC ( iscsi, "iSCSI %p saw invalid CHAP identifier \"%s\"\n",
689                        iscsi, value );
690                 return -EPROTO;
691         }
692
693         /* Prepare for CHAP with MD5 */
694         chap_finish ( &iscsi->chap );
695         if ( ( rc = chap_init ( &iscsi->chap, &md5_algorithm ) ) != 0 ) {
696                 DBGC ( iscsi, "iSCSI %p could not initialise CHAP: %s\n",
697                        iscsi, strerror ( rc ) );
698                 return rc;
699         }
700
701         /* Identifier and secret are the first two components of the
702          * challenge.
703          */
704         chap_set_identifier ( &iscsi->chap, identifier );
705         if ( iscsi->initiator_password ) {
706                 chap_update ( &iscsi->chap, iscsi->initiator_password,
707                               strlen ( iscsi->initiator_password ) );
708         }
709
710         return 0;
711 }
712
713 /**
714  * Handle iSCSI CHAP_C text value
715  *
716  * @v iscsi             iSCSI session
717  * @v value             CHAP_C value
718  * @ret rc              Return status code
719  */
720 static int iscsi_handle_chap_c_value ( struct iscsi_session *iscsi,
721                                        const char *value ) {
722         char buf[3];
723         char *endp;
724         uint8_t byte;
725         unsigned int i;
726
727         /* Check and strip leading "0x" */
728         if ( ( value[0] != '0' ) || ( value[1] != 'x' ) ) {
729                 DBGC ( iscsi, "iSCSI %p saw invalid CHAP challenge \"%s\"\n",
730                        iscsi, value );
731                 return -EPROTO;
732         }
733         value += 2;
734
735         /* Process challenge an octet at a time */
736         for ( ; ( value[0] && value[1] ) ; value += 2 ) {
737                 memcpy ( buf, value, 2 );
738                 buf[2] = 0;
739                 byte = strtoul ( buf, &endp, 16 );
740                 if ( *endp != '\0' ) {
741                         DBGC ( iscsi, "iSCSI %p saw invalid CHAP challenge "
742                                "byte \"%s\"\n", iscsi, buf );
743                         return -EPROTO;
744                 }
745                 chap_update ( &iscsi->chap, &byte, sizeof ( byte ) );
746         }
747
748         /* Build CHAP response */
749         DBGC ( iscsi, "iSCSI %p sending CHAP response\n", iscsi );
750         chap_respond ( &iscsi->chap );
751         iscsi->status |= ISCSI_STATUS_STRINGS_CHAP_RESPONSE;
752
753         /* Send CHAP challenge, if applicable */
754         if ( iscsi->target_username ) {
755                 iscsi->status |= ISCSI_STATUS_STRINGS_CHAP_CHALLENGE;
756                 /* Generate CHAP challenge data */
757                 for ( i = 0 ; i < sizeof ( iscsi->chap_challenge ) ; i++ ) {
758                         iscsi->chap_challenge[i] = random();
759                 }
760         }
761
762         return 0;
763 }
764
765 /**
766  * Handle iSCSI CHAP_N text value
767  *
768  * @v iscsi             iSCSI session
769  * @v value             CHAP_N value
770  * @ret rc              Return status code
771  */
772 static int iscsi_handle_chap_n_value ( struct iscsi_session *iscsi,
773                                        const char *value ) {
774
775         /* The target username isn't actually involved at any point in
776          * the authentication process; it merely serves to identify
777          * which password the target is using to generate the CHAP
778          * response.  We unnecessarily verify that the username is as
779          * expected, in order to provide mildly helpful diagnostics if
780          * the target is supplying the wrong username/password
781          * combination.
782          */
783         if ( iscsi->target_username &&
784              ( strcmp ( iscsi->target_username, value ) != 0 ) ) {
785                 DBGC ( iscsi, "iSCSI %p target username \"%s\" incorrect "
786                        "(wanted \"%s\")\n",
787                        iscsi, value, iscsi->target_username );
788                 return -EACCES;
789         }
790
791         return 0;
792 }
793
794 /**
795  * Handle iSCSI CHAP_R text value
796  *
797  * @v iscsi             iSCSI session
798  * @v value             CHAP_R value
799  * @ret rc              Return status code
800  */
801 static int iscsi_handle_chap_r_value ( struct iscsi_session *iscsi,
802                                        const char *value ) {
803         char buf[3];
804         char *endp;
805         uint8_t byte;
806         unsigned int i;
807         int rc;
808
809         /* Generate CHAP response for verification */
810         chap_finish ( &iscsi->chap );
811         if ( ( rc = chap_init ( &iscsi->chap, &md5_algorithm ) ) != 0 ) {
812                 DBGC ( iscsi, "iSCSI %p could not initialise CHAP: %s\n",
813                        iscsi, strerror ( rc ) );
814                 return rc;
815         }
816         chap_set_identifier ( &iscsi->chap, iscsi->chap_challenge[0] );
817         if ( iscsi->target_password ) {
818                 chap_update ( &iscsi->chap, iscsi->target_password,
819                               strlen ( iscsi->target_password ) );
820         }
821         chap_update ( &iscsi->chap, &iscsi->chap_challenge[1],
822                       ( sizeof ( iscsi->chap_challenge ) - 1 ) );
823         chap_respond ( &iscsi->chap );
824
825         /* Check and strip leading "0x" */
826         if ( ( value[0] != '0' ) || ( value[1] != 'x' ) ) {
827                 DBGC ( iscsi, "iSCSI %p saw invalid CHAP response \"%s\"\n",
828                        iscsi, value );
829                 return -EPROTO;
830         }
831         value += 2;
832
833         /* Check CHAP response length */
834         if ( strlen ( value ) != ( 2 * iscsi->chap.response_len ) ) {
835                 DBGC ( iscsi, "iSCSI %p invalid CHAP response length\n",
836                        iscsi );
837                 return -EPROTO;
838         }
839
840         /* Process response an octet at a time */
841         for ( i = 0 ; ( value[0] && value[1] ) ; value += 2, i++ ) {
842                 memcpy ( buf, value, 2 );
843                 buf[2] = 0;
844                 byte = strtoul ( buf, &endp, 16 );
845                 if ( *endp != '\0' ) {
846                         DBGC ( iscsi, "iSCSI %p saw invalid CHAP response "
847                                "byte \"%s\"\n", iscsi, buf );
848                         return -EPROTO;
849                 }
850                 if ( byte != iscsi->chap.response[i] ) {
851                         DBGC ( iscsi, "iSCSI %p saw incorrect CHAP "
852                                "response\n", iscsi );
853                         return -EACCES;
854                 }
855         }
856         assert ( i == iscsi->chap.response_len );
857
858         /* Mark session as authenticated */
859         iscsi->status |= ISCSI_STATUS_AUTH_REVERSE_OK;
860
861         return 0;
862 }
863
864 /** An iSCSI text string that we want to handle */
865 struct iscsi_string_type {
866         /** String key
867          *
868          * This is the portion up to and including the "=" sign,
869          * e.g. "InitiatorName=", "CHAP_A=", etc.
870          */
871         const char *key;
872         /** Handle iSCSI string value
873          *
874          * @v iscsi             iSCSI session
875          * @v value             iSCSI string value
876          * @ret rc              Return status code
877          */
878         int ( * handle ) ( struct iscsi_session *iscsi, const char *value );
879 };
880
881 /** iSCSI text strings that we want to handle */
882 static struct iscsi_string_type iscsi_string_types[] = {
883         { "TargetAddress=", iscsi_handle_targetaddress_value },
884         { "AuthMethod=", iscsi_handle_authmethod_value },
885         { "CHAP_A=", iscsi_handle_chap_a_value },
886         { "CHAP_I=", iscsi_handle_chap_i_value },
887         { "CHAP_C=", iscsi_handle_chap_c_value },
888         { "CHAP_N=", iscsi_handle_chap_n_value },
889         { "CHAP_R=", iscsi_handle_chap_r_value },
890         { NULL, NULL }
891 };
892
893 /**
894  * Handle iSCSI string
895  *
896  * @v iscsi             iSCSI session
897  * @v string            iSCSI string (in "key=value" format)
898  * @ret rc              Return status code
899  */
900 static int iscsi_handle_string ( struct iscsi_session *iscsi,
901                                  const char *string ) {
902         struct iscsi_string_type *type;
903         size_t key_len;
904         int rc;
905
906         for ( type = iscsi_string_types ; type->key ; type++ ) {
907                 key_len = strlen ( type->key );
908                 if ( strncmp ( string, type->key, key_len ) != 0 )
909                         continue;
910                 DBGC ( iscsi, "iSCSI %p handling %s\n", iscsi, string );
911                 if ( ( rc = type->handle ( iscsi,
912                                            ( string + key_len ) ) ) != 0 ) {
913                         DBGC ( iscsi, "iSCSI %p could not handle %s: %s\n",
914                                iscsi, string, strerror ( rc ) );
915                         return rc;
916                 }
917                 return 0;
918         }
919         DBGC ( iscsi, "iSCSI %p ignoring %s\n", iscsi, string );
920         return 0;
921 }
922
923 /**
924  * Handle iSCSI strings
925  *
926  * @v iscsi             iSCSI session
927  * @v string            iSCSI string buffer
928  * @v len               Length of string buffer
929  * @ret rc              Return status code
930  */
931 static int iscsi_handle_strings ( struct iscsi_session *iscsi,
932                                   const char *strings, size_t len ) {
933         size_t string_len;
934         int rc;
935
936         /* Handle each string in turn, taking care not to overrun the
937          * data buffer in case of badly-terminated data.
938          */
939         while ( 1 ) {
940                 string_len = ( strnlen ( strings, len ) + 1 );
941                 if ( string_len > len )
942                         break;
943                 if ( ( rc = iscsi_handle_string ( iscsi, strings ) ) != 0 )
944                         return rc;
945                 strings += string_len;
946                 len -= string_len;
947         }
948         return 0;
949 }
950
951 /**
952  * Receive PDU data into buffer
953  *
954  * @v iscsi             iSCSI session
955  * @v data              Data to receive
956  * @v len               Length of data
957  * @ret rc              Return status code
958  *
959  * This can be used when the RX PDU type handler wishes to buffer up
960  * all received data and process the PDU as a single unit.  The caller
961  * is repsonsible for calling iscsi_rx_buffered_data_done() after
962  * processing the data.
963  */
964 static int iscsi_rx_buffered_data ( struct iscsi_session *iscsi,
965                                     const void *data, size_t len ) {
966
967         /* Allocate buffer on first call */
968         if ( ! iscsi->rx_buffer ) {
969                 iscsi->rx_buffer = malloc ( iscsi->rx_len );
970                 if ( ! iscsi->rx_buffer )
971                         return -ENOMEM;
972         }
973
974         /* Copy data to buffer */
975         assert ( ( iscsi->rx_offset + len ) <= iscsi->rx_len );
976         memcpy ( ( iscsi->rx_buffer + iscsi->rx_offset ), data, len );
977
978         return 0;
979 }
980
981 /**
982  * Convert iSCSI response status to return status code
983  *
984  * @v status_class      iSCSI status class
985  * @v status_detail     iSCSI status detail
986  * @ret rc              Return status code
987  */
988 static int iscsi_status_to_rc ( unsigned int status_class,
989                                 unsigned int status_detail ) {
990         switch ( status_class ) {
991         case ISCSI_STATUS_INITIATOR_ERROR :
992                 switch ( status_detail ) {
993                 case ISCSI_STATUS_INITIATOR_ERROR_AUTHENTICATION :
994                         return -EACCES;
995                 case ISCSI_STATUS_INITIATOR_ERROR_AUTHORISATION :
996                         return -EPERM;
997                 case ISCSI_STATUS_INITIATOR_ERROR_NOT_FOUND :
998                 case ISCSI_STATUS_INITIATOR_ERROR_REMOVED :
999                         return -ENODEV;
1000                 default :
1001                         return -ENOTSUP;
1002                 }
1003         case ISCSI_STATUS_TARGET_ERROR :
1004                 return -EIO;
1005         default :
1006                 return -EINVAL;
1007         }
1008 }
1009
1010 /**
1011  * Receive data segment of an iSCSI login response PDU
1012  *
1013  * @v iscsi             iSCSI session
1014  * @v data              Received data
1015  * @v len               Length of received data
1016  * @v remaining         Data remaining after this data
1017  * @ret rc              Return status code
1018  */
1019 static int iscsi_rx_login_response ( struct iscsi_session *iscsi,
1020                                      const void *data, size_t len,
1021                                      size_t remaining ) {
1022         struct iscsi_bhs_login_response *response
1023                 = &iscsi->rx_bhs.login_response;
1024         int rc;
1025
1026         /* Buffer up the PDU data */
1027         if ( ( rc = iscsi_rx_buffered_data ( iscsi, data, len ) ) != 0 ) {
1028                 DBGC ( iscsi, "iSCSI %p could not buffer login response: %s\n",
1029                        iscsi, strerror ( rc ) );
1030                 return rc;
1031         }
1032         if ( remaining )
1033                 return 0;
1034
1035         /* Process string data and discard string buffer */
1036         if ( ( rc = iscsi_handle_strings ( iscsi, iscsi->rx_buffer,
1037                                            iscsi->rx_len ) ) != 0 )
1038                 return rc;
1039         iscsi_rx_buffered_data_done ( iscsi );
1040
1041         /* Check for login redirection */
1042         if ( response->status_class == ISCSI_STATUS_REDIRECT ) {
1043                 DBGC ( iscsi, "iSCSI %p redirecting to new server\n", iscsi );
1044                 iscsi_close_connection ( iscsi, 0 );
1045                 if ( ( rc = iscsi_open_connection ( iscsi ) ) != 0 ) {
1046                         DBGC ( iscsi, "iSCSI %p could not redirect: %s\n ",
1047                                iscsi, strerror ( rc ) );
1048                         return rc;
1049                 }
1050                 return 0;
1051         }
1052
1053         /* Check for fatal errors */
1054         if ( response->status_class != 0 ) {
1055                 DBGC ( iscsi, "iSCSI login failure: class %02x detail %02x\n",
1056                        response->status_class, response->status_detail );
1057                 rc = iscsi_status_to_rc ( response->status_class,
1058                                           response->status_detail );
1059                 iscsi->instant_rc = rc;
1060                 return rc;
1061         }
1062
1063         /* Handle login transitions */
1064         if ( response->flags & ISCSI_LOGIN_FLAG_TRANSITION ) {
1065                 iscsi->status &= ~( ISCSI_STATUS_PHASE_MASK |
1066                                     ISCSI_STATUS_STRINGS_MASK );
1067                 switch ( response->flags & ISCSI_LOGIN_NSG_MASK ) {
1068                 case ISCSI_LOGIN_NSG_OPERATIONAL_NEGOTIATION:
1069                         iscsi->status |=
1070                                 ( ISCSI_STATUS_OPERATIONAL_NEGOTIATION_PHASE |
1071                                   ISCSI_STATUS_STRINGS_OPERATIONAL );
1072                         break;
1073                 case ISCSI_LOGIN_NSG_FULL_FEATURE_PHASE:
1074                         iscsi->status |= ISCSI_STATUS_FULL_FEATURE_PHASE;
1075                         break;
1076                 default:
1077                         DBGC ( iscsi, "iSCSI %p got invalid response flags "
1078                                "%02x\n", iscsi, response->flags );
1079                         return -EIO;
1080                 }
1081         }
1082
1083         /* Send next login request PDU if we haven't reached the full
1084          * feature phase yet.
1085          */
1086         if ( ( iscsi->status & ISCSI_STATUS_PHASE_MASK ) !=
1087              ISCSI_STATUS_FULL_FEATURE_PHASE ) {
1088                 iscsi_start_login ( iscsi );
1089                 return 0;
1090         }
1091
1092         /* Check that target authentication was successful (if required) */
1093         if ( ( iscsi->status & ISCSI_STATUS_AUTH_REVERSE_REQUIRED ) &&
1094              ! ( iscsi->status & ISCSI_STATUS_AUTH_REVERSE_OK ) ) {
1095                 DBGC ( iscsi, "iSCSI %p nefarious target tried to bypass "
1096                        "authentication\n", iscsi );
1097                 return -EPROTO;
1098         }
1099
1100         /* Reset retry count */
1101         iscsi->retry_count = 0;
1102
1103         /* Record TSIH for future reference */
1104         iscsi->tsih = ntohl ( response->tsih );
1105         
1106         /* Send the actual SCSI command */
1107         iscsi_start_command ( iscsi );
1108
1109         return 0;
1110 }
1111
1112 /****************************************************************************
1113  *
1114  * iSCSI to socket interface
1115  *
1116  */
1117
1118 /**
1119  * Start up a new TX PDU
1120  *
1121  * @v iscsi             iSCSI session
1122  *
1123  * This initiates the process of sending a new PDU.  Only one PDU may
1124  * be in transit at any one time.
1125  */
1126 static void iscsi_start_tx ( struct iscsi_session *iscsi ) {
1127         assert ( iscsi->tx_state == ISCSI_TX_IDLE );
1128         
1129         /* Initialise TX BHS */
1130         memset ( &iscsi->tx_bhs, 0, sizeof ( iscsi->tx_bhs ) );
1131
1132         /* Flag TX engine to start transmitting */
1133         iscsi->tx_state = ISCSI_TX_BHS;
1134 }
1135
1136 /**
1137  * Transmit nothing
1138  *
1139  * @v iscsi             iSCSI session
1140  * @ret rc              Return status code
1141  */
1142 static int iscsi_tx_nothing ( struct iscsi_session *iscsi __unused ) {
1143         return 0;
1144 }
1145
1146 /**
1147  * Transmit basic header segment of an iSCSI PDU
1148  *
1149  * @v iscsi             iSCSI session
1150  * @ret rc              Return status code
1151  */
1152 static int iscsi_tx_bhs ( struct iscsi_session *iscsi ) {
1153         return xfer_deliver_raw ( &iscsi->socket,  &iscsi->tx_bhs,
1154                                   sizeof ( iscsi->tx_bhs ) );
1155 }
1156
1157 /**
1158  * Transmit data segment of an iSCSI PDU
1159  *
1160  * @v iscsi             iSCSI session
1161  * @ret rc              Return status code
1162  * 
1163  * Handle transmission of part of a PDU data segment.  iscsi::tx_bhs
1164  * will be valid when this is called.
1165  */
1166 static int iscsi_tx_data ( struct iscsi_session *iscsi ) {
1167         struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
1168
1169         switch ( common->opcode & ISCSI_OPCODE_MASK ) {
1170         case ISCSI_OPCODE_DATA_OUT:
1171                 return iscsi_tx_data_out ( iscsi );
1172         case ISCSI_OPCODE_LOGIN_REQUEST:
1173                 return iscsi_tx_login_request ( iscsi );
1174         default:
1175                 /* Nothing to send in other states */
1176                 return 0;
1177         }
1178 }
1179
1180 /**
1181  * Transmit data padding of an iSCSI PDU
1182  *
1183  * @v iscsi             iSCSI session
1184  * @ret rc              Return status code
1185  * 
1186  * Handle transmission of any data padding in a PDU data segment.
1187  * iscsi::tx_bhs will be valid when this is called.
1188  */
1189 static int iscsi_tx_data_padding ( struct iscsi_session *iscsi ) {
1190         static const char pad[] = { '\0', '\0', '\0' };
1191         struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
1192         size_t pad_len;
1193         
1194         pad_len = ISCSI_DATA_PAD_LEN ( common->lengths );
1195         if ( ! pad_len )
1196                 return 0;
1197
1198         return xfer_deliver_raw ( &iscsi->socket, pad, pad_len );
1199 }
1200
1201 /**
1202  * Complete iSCSI PDU transmission
1203  *
1204  * @v iscsi             iSCSI session
1205  *
1206  * Called when a PDU has been completely transmitted and the TX state
1207  * machine is about to enter the idle state.  iscsi::tx_bhs will be
1208  * valid for the just-completed PDU when this is called.
1209  */
1210 static void iscsi_tx_done ( struct iscsi_session *iscsi ) {
1211         struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
1212
1213         switch ( common->opcode & ISCSI_OPCODE_MASK ) {
1214         case ISCSI_OPCODE_DATA_OUT:
1215                 iscsi_data_out_done ( iscsi );
1216         case ISCSI_OPCODE_LOGIN_REQUEST:
1217                 iscsi_login_request_done ( iscsi );
1218         default:
1219                 /* No action */
1220                 break;
1221         }
1222 }
1223
1224 /**
1225  * Transmit iSCSI PDU
1226  *
1227  * @v iscsi             iSCSI session
1228  * @v buf               Temporary data buffer
1229  * @v len               Length of temporary data buffer
1230  * 
1231  * Constructs data to be sent for the current TX state
1232  */
1233 static void iscsi_tx_step ( struct process *process ) {
1234         struct iscsi_session *iscsi =
1235                 container_of ( process, struct iscsi_session, process );
1236         struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
1237         int ( * tx ) ( struct iscsi_session *iscsi );
1238         enum iscsi_tx_state next_state;
1239         size_t tx_len;
1240         int rc;
1241
1242         /* Select fragment to transmit */
1243         while ( 1 ) {
1244                 switch ( iscsi->tx_state ) {
1245                 case ISCSI_TX_IDLE:
1246                         /* Stop processing */
1247                         return;
1248                 case ISCSI_TX_BHS:
1249                         tx = iscsi_tx_bhs;
1250                         tx_len = sizeof ( iscsi->tx_bhs );
1251                         next_state = ISCSI_TX_AHS;
1252                         break;
1253                 case ISCSI_TX_AHS:
1254                         tx = iscsi_tx_nothing;
1255                         tx_len = 0;
1256                         next_state = ISCSI_TX_DATA;
1257                         break;
1258                 case ISCSI_TX_DATA:
1259                         tx = iscsi_tx_data;
1260                         tx_len = ISCSI_DATA_LEN ( common->lengths );
1261                         next_state = ISCSI_TX_DATA_PADDING;
1262                         break;
1263                 case ISCSI_TX_DATA_PADDING:
1264                         tx = iscsi_tx_data_padding;
1265                         tx_len = ISCSI_DATA_PAD_LEN ( common->lengths );
1266                         next_state = ISCSI_TX_IDLE;
1267                         break;
1268                 default:
1269                         assert ( 0 );
1270                         return;
1271                 }
1272
1273                 /* Check for window availability, if needed */
1274                 if ( tx_len && ( xfer_window ( &iscsi->socket ) == 0 ) ) {
1275                         /* Cannot transmit at this point; stop processing */
1276                         return;
1277                 }
1278
1279                 /* Transmit data */
1280                 if ( ( rc = tx ( iscsi ) ) != 0 ) {
1281                         DBGC ( iscsi, "iSCSI %p could not transmit: %s\n",
1282                                iscsi, strerror ( rc ) );
1283                         return;
1284                 }
1285
1286                 /* Move to next state */
1287                 iscsi->tx_state = next_state;
1288                 if ( next_state == ISCSI_TX_IDLE )
1289                         iscsi_tx_done ( iscsi );
1290         }
1291 }
1292
1293 /**
1294  * Receive basic header segment of an iSCSI PDU
1295  *
1296  * @v iscsi             iSCSI session
1297  * @v data              Received data
1298  * @v len               Length of received data
1299  * @v remaining         Data remaining after this data
1300  * @ret rc              Return status code
1301  *
1302  * This fills in iscsi::rx_bhs with the data from the BHS portion of
1303  * the received PDU.
1304  */
1305 static int iscsi_rx_bhs ( struct iscsi_session *iscsi, const void *data,
1306                           size_t len, size_t remaining __unused ) {
1307         memcpy ( &iscsi->rx_bhs.bytes[iscsi->rx_offset], data, len );
1308         if ( ( iscsi->rx_offset + len ) >= sizeof ( iscsi->rx_bhs ) ) {
1309                 DBGC2 ( iscsi, "iSCSI %p received PDU opcode %#x len %#x\n",
1310                         iscsi, iscsi->rx_bhs.common.opcode,
1311                         ISCSI_DATA_LEN ( iscsi->rx_bhs.common.lengths ) );
1312         }
1313         return 0;
1314 }
1315
1316 /**
1317  * Discard portion of an iSCSI PDU.
1318  *
1319  * @v iscsi             iSCSI session
1320  * @v data              Received data
1321  * @v len               Length of received data
1322  * @v remaining         Data remaining after this data
1323  * @ret rc              Return status code
1324  *
1325  * This discards data from a portion of a received PDU.
1326  */
1327 static int iscsi_rx_discard ( struct iscsi_session *iscsi __unused,
1328                               const void *data __unused, size_t len __unused,
1329                               size_t remaining __unused ) {
1330         /* Do nothing */
1331         return 0;
1332 }
1333
1334 /**
1335  * Receive data segment of an iSCSI PDU
1336  *
1337  * @v iscsi             iSCSI session
1338  * @v data              Received data
1339  * @v len               Length of received data
1340  * @v remaining         Data remaining after this data
1341  * @ret rc              Return status code
1342  *
1343  * Handle processing of part of a PDU data segment.  iscsi::rx_bhs
1344  * will be valid when this is called.
1345  */
1346 static int iscsi_rx_data ( struct iscsi_session *iscsi, const void *data,
1347                            size_t len, size_t remaining ) {
1348         struct iscsi_bhs_common_response *response
1349                 = &iscsi->rx_bhs.common_response;
1350
1351         /* Update cmdsn and statsn */
1352         iscsi->cmdsn = ntohl ( response->expcmdsn );
1353         iscsi->statsn = ntohl ( response->statsn );
1354
1355         switch ( response->opcode & ISCSI_OPCODE_MASK ) {
1356         case ISCSI_OPCODE_LOGIN_RESPONSE:
1357                 return iscsi_rx_login_response ( iscsi, data, len, remaining );
1358         case ISCSI_OPCODE_SCSI_RESPONSE:
1359                 return iscsi_rx_scsi_response ( iscsi, data, len, remaining );
1360         case ISCSI_OPCODE_DATA_IN:
1361                 return iscsi_rx_data_in ( iscsi, data, len, remaining );
1362         case ISCSI_OPCODE_R2T:
1363                 return iscsi_rx_r2t ( iscsi, data, len, remaining );
1364         default:
1365                 if ( remaining )
1366                         return 0;
1367                 DBGC ( iscsi, "iSCSI %p unknown opcode %02x\n", iscsi,
1368                        response->opcode );
1369                 return -ENOTSUP;
1370         }
1371 }
1372
1373 /**
1374  * Receive new data
1375  *
1376  * @v socket            Transport layer interface
1377  * @v data              Received data
1378  * @v len               Length of received data
1379  * @ret rc              Return status code
1380  *
1381  * This handles received PDUs.  The receive strategy is to fill in
1382  * iscsi::rx_bhs with the contents of the BHS portion of the PDU,
1383  * throw away any AHS portion, and then process each part of the data
1384  * portion as it arrives.  The data processing routine therefore
1385  * always has a full copy of the BHS available, even for portions of
1386  * the data in different packets to the BHS.
1387  */
1388 static int iscsi_socket_deliver_raw ( struct xfer_interface *socket,
1389                                       const void *data, size_t len ) {
1390         struct iscsi_session *iscsi =
1391                 container_of ( socket, struct iscsi_session, socket );
1392         struct iscsi_bhs_common *common = &iscsi->rx_bhs.common;
1393         int ( * rx ) ( struct iscsi_session *iscsi, const void *data,
1394                        size_t len, size_t remaining );
1395         enum iscsi_rx_state next_state;
1396         size_t frag_len;
1397         size_t remaining;
1398         int rc;
1399
1400         while ( 1 ) {
1401                 switch ( iscsi->rx_state ) {
1402                 case ISCSI_RX_BHS:
1403                         rx = iscsi_rx_bhs;
1404                         iscsi->rx_len = sizeof ( iscsi->rx_bhs );
1405                         next_state = ISCSI_RX_AHS;                      
1406                         break;
1407                 case ISCSI_RX_AHS:
1408                         rx = iscsi_rx_discard;
1409                         iscsi->rx_len = 4 * ISCSI_AHS_LEN ( common->lengths );
1410                         next_state = ISCSI_RX_DATA;
1411                         break;
1412                 case ISCSI_RX_DATA:
1413                         rx = iscsi_rx_data;
1414                         iscsi->rx_len = ISCSI_DATA_LEN ( common->lengths );
1415                         next_state = ISCSI_RX_DATA_PADDING;
1416                         break;
1417                 case ISCSI_RX_DATA_PADDING:
1418                         rx = iscsi_rx_discard;
1419                         iscsi->rx_len = ISCSI_DATA_PAD_LEN ( common->lengths );
1420                         next_state = ISCSI_RX_BHS;
1421                         break;
1422                 default:
1423                         assert ( 0 );
1424                         return -EINVAL;
1425                 }
1426
1427                 frag_len = iscsi->rx_len - iscsi->rx_offset;
1428                 if ( frag_len > len )
1429                         frag_len = len;
1430                 remaining = iscsi->rx_len - iscsi->rx_offset - frag_len;
1431                 if ( ( rc = rx ( iscsi, data, frag_len, remaining ) ) != 0 ) {
1432                         DBGC ( iscsi, "iSCSI %p could not process received "
1433                                "data: %s\n", iscsi, strerror ( rc ) );
1434                         iscsi_close_connection ( iscsi, rc );
1435                         iscsi_scsi_done ( iscsi, rc );
1436                         return rc;
1437                 }
1438
1439                 iscsi->rx_offset += frag_len;
1440                 data += frag_len;
1441                 len -= frag_len;
1442
1443                 /* If all the data for this state has not yet been
1444                  * received, stay in this state for now.
1445                  */
1446                 if ( iscsi->rx_offset != iscsi->rx_len )
1447                         return 0;
1448
1449                 iscsi->rx_state = next_state;
1450                 iscsi->rx_offset = 0;
1451         }
1452
1453         return 0;
1454 }
1455
1456 /**
1457  * Handle stream connection closure
1458  *
1459  * @v socket            Transport layer interface
1460  * @v rc                Reason for close
1461  *
1462  */
1463 static void iscsi_socket_close ( struct xfer_interface *socket, int rc ) {
1464         struct iscsi_session *iscsi =
1465                 container_of ( socket, struct iscsi_session, socket );
1466
1467         /* Even a graceful close counts as an error for iSCSI */
1468         if ( ! rc )
1469                 rc = -ECONNRESET;
1470
1471         /* Close session cleanly */
1472         iscsi_close_connection ( iscsi, rc );
1473
1474         /* Retry connection if within the retry limit, otherwise fail */
1475         if ( ++iscsi->retry_count <= ISCSI_MAX_RETRIES ) {
1476                 DBGC ( iscsi, "iSCSI %p retrying connection (retry #%d)\n",
1477                        iscsi, iscsi->retry_count );
1478                 if ( ( rc = iscsi_open_connection ( iscsi ) ) != 0 ) {
1479                         DBGC ( iscsi, "iSCSI %p could not reconnect: %s\n",
1480                                iscsi, strerror ( rc ) );
1481                         iscsi_scsi_done ( iscsi, rc );
1482                 }
1483         } else {
1484                 DBGC ( iscsi, "iSCSI %p retry count exceeded\n", iscsi );
1485                 iscsi->instant_rc = rc;
1486                 iscsi_scsi_done ( iscsi, rc );
1487         }
1488 }
1489
1490 /**
1491  * Handle redirection event
1492  *
1493  * @v socket            Transport layer interface
1494  * @v type              Location type
1495  * @v args              Remaining arguments depend upon location type
1496  * @ret rc              Return status code
1497  */
1498 static int iscsi_vredirect ( struct xfer_interface *socket, int type,
1499                              va_list args ) {
1500         struct iscsi_session *iscsi =
1501                 container_of ( socket, struct iscsi_session, socket );
1502         va_list tmp;
1503         struct sockaddr *peer;
1504
1505         /* Intercept redirects to a LOCATION_SOCKET and record the IP
1506          * address for the iBFT.  This is a bit of a hack, but avoids
1507          * inventing an ioctl()-style call to retrieve the socket
1508          * address from a data-xfer interface.
1509          */
1510         if ( type == LOCATION_SOCKET ) {
1511                 va_copy ( tmp, args );
1512                 ( void ) va_arg ( tmp, int ); /* Discard "semantics" */
1513                 peer = va_arg ( tmp, struct sockaddr * );
1514                 memcpy ( &iscsi->target_sockaddr, peer,
1515                          sizeof ( iscsi->target_sockaddr ) );
1516                 va_end ( tmp );
1517         }
1518
1519         return xfer_vreopen ( socket, type, args );
1520 }
1521                              
1522
1523 /** iSCSI socket operations */
1524 static struct xfer_interface_operations iscsi_socket_operations = {
1525         .close          = iscsi_socket_close,
1526         .vredirect      = iscsi_vredirect,
1527         .window         = unlimited_xfer_window,
1528         .alloc_iob      = default_xfer_alloc_iob,
1529         .deliver_iob    = xfer_deliver_as_raw,
1530         .deliver_raw    = iscsi_socket_deliver_raw,
1531 };
1532
1533
1534 /****************************************************************************
1535  *
1536  * iSCSI command issuing
1537  *
1538  */
1539
1540 /**
1541  * Issue SCSI command
1542  *
1543  * @v scsi              SCSI device
1544  * @v command           SCSI command
1545  * @ret rc              Return status code
1546  */
1547 static int iscsi_command ( struct scsi_device *scsi,
1548                            struct scsi_command *command ) {
1549         struct iscsi_session *iscsi =
1550                 container_of ( scsi->backend, struct iscsi_session, refcnt );
1551         int rc;
1552
1553         /* Record SCSI command */
1554         iscsi->command = command;
1555
1556         /* Abort immediately if we have a recorded permanent failure */
1557         if ( iscsi->instant_rc ) {
1558                 rc = iscsi->instant_rc;
1559                 goto done;
1560         }
1561
1562         /* Issue command or open connection as appropriate */
1563         if ( iscsi->status ) {
1564                 iscsi_start_command ( iscsi );
1565         } else {
1566                 if ( ( rc = iscsi_open_connection ( iscsi ) ) != 0 )
1567                         goto done;
1568         }
1569
1570         /* Wait for command to complete */
1571         iscsi->rc = -EINPROGRESS;
1572         while ( iscsi->rc == -EINPROGRESS )
1573                 step();
1574         rc = iscsi->rc;
1575
1576  done:
1577         iscsi->command = NULL;
1578         return rc;
1579 }
1580
1581 static int iscsi_detached_command ( struct scsi_device *scsi __unused,
1582                                     struct scsi_command *command __unused ) {
1583         return -ENODEV;
1584 }
1585
1586 /**
1587  * Shut down iSCSI interface
1588  *
1589  * @v scsi              SCSI device
1590  */
1591 void iscsi_detach ( struct scsi_device *scsi ) {
1592         struct iscsi_session *iscsi =
1593                 container_of ( scsi->backend, struct iscsi_session, refcnt );
1594
1595         xfer_nullify ( &iscsi->socket );
1596         iscsi_close_connection ( iscsi, 0 );
1597         process_del ( &iscsi->process );
1598         scsi->command = iscsi_detached_command;
1599         ref_put ( scsi->backend );
1600         scsi->backend = NULL;
1601 }
1602
1603 /****************************************************************************
1604  *
1605  * Instantiator
1606  *
1607  */
1608
1609 /** iSCSI root path components (as per RFC4173) */
1610 enum iscsi_root_path_component {
1611         RP_LITERAL = 0,
1612         RP_SERVERNAME,
1613         RP_PROTOCOL,
1614         RP_PORT,
1615         RP_LUN,
1616         RP_TARGETNAME,
1617         NUM_RP_COMPONENTS
1618 };
1619
1620 /**
1621  * Parse iSCSI LUN
1622  *
1623  * @v iscsi             iSCSI session
1624  * @v lun_string        LUN string representation (as per RFC4173)
1625  * @ret rc              Return status code
1626  */
1627 static int iscsi_parse_lun ( struct iscsi_session *iscsi,
1628                              const char *lun_string ) {
1629         union {
1630                 uint64_t u64;
1631                 uint16_t u16[4];
1632         } lun;
1633         char *p;
1634         int i;
1635
1636         memset ( &lun, 0, sizeof ( lun ) );
1637         if ( lun_string ) {
1638                 p = ( char * ) lun_string;
1639                 
1640                 for ( i = 0 ; i < 4 ; i++ ) {
1641                         lun.u16[i] = htons ( strtoul ( p, &p, 16 ) );
1642                         if ( *p == '\0' )
1643                                 break;
1644                         if ( *p != '-' )
1645                                 return -EINVAL;
1646                         p++;
1647                 }
1648                 if ( *p )
1649                         return -EINVAL;
1650         }
1651
1652         iscsi->lun = lun.u64;
1653         return 0;
1654 }
1655
1656 /**
1657  * Parse iSCSI root path
1658  *
1659  * @v iscsi             iSCSI session
1660  * @v root_path         iSCSI root path (as per RFC4173)
1661  * @ret rc              Return status code
1662  */
1663 static int iscsi_parse_root_path ( struct iscsi_session *iscsi,
1664                                    const char *root_path ) {
1665         char rp_copy[ strlen ( root_path ) + 1 ];
1666         char *rp_comp[NUM_RP_COMPONENTS];
1667         char *rp = rp_copy;
1668         int i = 0;
1669         int rc;
1670
1671         /* Split root path into component parts */
1672         strcpy ( rp_copy, root_path );
1673         while ( 1 ) {
1674                 rp_comp[i++] = rp;
1675                 if ( i == NUM_RP_COMPONENTS )
1676                         break;
1677                 for ( ; *rp != ':' ; rp++ ) {
1678                         if ( ! *rp ) {
1679                                 DBGC ( iscsi, "iSCSI %p root path \"%s\" "
1680                                        "too short\n", iscsi, root_path );
1681                                 return -EINVAL;
1682                         }
1683                 }
1684                 *(rp++) = '\0';
1685         }
1686
1687         /* Use root path components to configure iSCSI session */
1688         iscsi->target_address = strdup ( rp_comp[RP_SERVERNAME] );
1689         if ( ! iscsi->target_address )
1690                 return -ENOMEM;
1691         iscsi->target_port = strtoul ( rp_comp[RP_PORT], NULL, 10 );
1692         if ( ! iscsi->target_port )
1693                 iscsi->target_port = ISCSI_PORT;
1694         if ( ( rc = iscsi_parse_lun ( iscsi, rp_comp[RP_LUN] ) ) != 0 ) {
1695                 DBGC ( iscsi, "iSCSI %p invalid LUN \"%s\"\n",
1696                        iscsi, rp_comp[RP_LUN] );
1697                 return rc;
1698         }
1699         iscsi->target_iqn = strdup ( rp_comp[RP_TARGETNAME] );
1700         if ( ! iscsi->target_iqn )
1701                 return -ENOMEM;
1702
1703         return 0;
1704 }
1705
1706 /**
1707  * Set iSCSI authentication details
1708  *
1709  * @v iscsi             iSCSI session
1710  * @v initiator_username Initiator username, if any
1711  * @v initiator_password Initiator password, if any
1712  * @v target_username   Target username, if any
1713  * @v target_password   Target password, if any
1714  * @ret rc              Return status code
1715  */
1716 static int iscsi_set_auth ( struct iscsi_session *iscsi,
1717                             const char *initiator_username,
1718                             const char *initiator_password,
1719                             const char *target_username,
1720                             const char *target_password ) {
1721
1722         /* Check for initiator or target credentials */
1723         if ( initiator_username || initiator_password ||
1724              target_username || target_password ) {
1725
1726                 /* We must have at least an initiator username+password */
1727                 if ( ! ( initiator_username && initiator_password ) )
1728                         goto invalid_auth;
1729
1730                 /* Store initiator credentials */
1731                 iscsi->initiator_username = strdup ( initiator_username );
1732                 if ( ! iscsi->initiator_username )
1733                         return -ENOMEM;
1734                 iscsi->initiator_password = strdup ( initiator_password );
1735                 if ( ! iscsi->initiator_password )
1736                         return -ENOMEM;
1737
1738                 /* Check for target credentials */
1739                 if ( target_username || target_password ) {
1740
1741                         /* We must have target username+password */
1742                         if ( ! ( target_username && target_password ) )
1743                                 goto invalid_auth;
1744
1745                         /* Store target credentials */
1746                         iscsi->target_username = strdup ( target_username );
1747                         if ( ! iscsi->target_username )
1748                                 return -ENOMEM;
1749                         iscsi->target_password = strdup ( target_password );
1750                         if ( ! iscsi->target_password )
1751                                 return -ENOMEM;
1752                 }
1753         }
1754
1755         return 0;
1756
1757  invalid_auth:
1758         DBGC ( iscsi, "iSCSI %p invalid credentials: initiator "
1759                "%sname,%spw, target %sname,%spw\n", iscsi,
1760                ( initiator_username ? "" : "no " ),
1761                ( initiator_password ? "" : "no " ),
1762                ( target_username ? "" : "no " ),
1763                ( target_password ? "" : "no " ) );
1764         return -EINVAL;
1765 }
1766
1767 /**
1768  * Attach iSCSI interface
1769  *
1770  * @v scsi              SCSI device
1771  * @v root_path         iSCSI root path (as per RFC4173)
1772  * @ret rc              Return status code
1773  */
1774 int iscsi_attach ( struct scsi_device *scsi, const char *root_path ) {
1775         struct iscsi_session *iscsi;
1776         int rc;
1777
1778         /* Allocate and initialise structure */
1779         iscsi = zalloc ( sizeof ( *iscsi ) );
1780         if ( ! iscsi )
1781                 return -ENOMEM;
1782         iscsi->refcnt.free = iscsi_free;
1783         xfer_init ( &iscsi->socket, &iscsi_socket_operations, &iscsi->refcnt );
1784         process_init ( &iscsi->process, iscsi_tx_step, &iscsi->refcnt );
1785
1786         /* Parse root path */
1787         if ( ( rc = iscsi_parse_root_path ( iscsi, root_path ) ) != 0 )
1788                 goto err;
1789         /* Set fields not specified by root path */
1790         if ( ( rc = iscsi_set_auth ( iscsi,
1791                                      iscsi_initiator_username,
1792                                      iscsi_initiator_password,
1793                                      iscsi_target_username,
1794                                      iscsi_target_password ) ) != 0 )
1795                 goto err;
1796
1797         /* Sanity checks */
1798         if ( ! iscsi->target_address ) {
1799                 DBGC ( iscsi, "iSCSI %p does not yet support discovery\n",
1800                        iscsi );
1801                 rc = -ENOTSUP;
1802                 goto err;
1803         }
1804         if ( ! iscsi->target_iqn ) {
1805                 DBGC ( iscsi, "iSCSI %p no target address supplied in %s\n",
1806                        iscsi, root_path );
1807                 rc = -EINVAL;
1808                 goto err;
1809         }
1810
1811         /* Attach parent interface, mortalise self, and return */
1812         scsi->backend = ref_get ( &iscsi->refcnt );
1813         scsi->command = iscsi_command;
1814         scsi->lun = iscsi->lun;
1815         ref_put ( &iscsi->refcnt );
1816         return 0;
1817         
1818  err:
1819         ref_put ( &iscsi->refcnt );
1820         return rc;
1821 }
1822
1823 /****************************************************************************
1824  *
1825  * Settings
1826  *
1827  */
1828
1829 /** iSCSI initiator IQN setting */
1830 struct setting initiator_iqn_setting __setting = {
1831         .name = "initiator-iqn",
1832         .description = "iSCSI initiator name",
1833         .tag = DHCP_ISCSI_INITIATOR_IQN,
1834         .type = &setting_type_string,
1835 };
1836
1837 /** iSCSI reverse username setting */
1838 struct setting reverse_username_setting __setting = {
1839         .name = "reverse-username",
1840         .description = "Reverse user name",
1841         .tag = DHCP_EB_REVERSE_USERNAME,
1842         .type = &setting_type_string,
1843 };
1844
1845 /** iSCSI reverse password setting */
1846 struct setting reverse_password_setting __setting = {
1847         .name = "reverse-password",
1848         .description = "Reverse password",
1849         .tag = DHCP_EB_REVERSE_PASSWORD,
1850         .type = &setting_type_string,
1851 };
1852
1853 /** An iSCSI string setting */
1854 struct iscsi_string_setting {
1855         /** Setting */
1856         struct setting *setting;
1857         /** String to update */
1858         char **string;
1859         /** String prefix */
1860         const char *prefix;
1861 };
1862
1863 /** iSCSI string settings */
1864 static struct iscsi_string_setting iscsi_string_settings[] = {
1865         {
1866                 .setting = &initiator_iqn_setting,
1867                 .string = &iscsi_explicit_initiator_iqn,
1868                 .prefix = "",
1869         },
1870         {
1871                 .setting = &username_setting,
1872                 .string = &iscsi_initiator_username,
1873                 .prefix = "",
1874         },
1875         {
1876                 .setting = &password_setting,
1877                 .string = &iscsi_initiator_password,
1878                 .prefix = "",
1879         },
1880         {
1881                 .setting = &reverse_username_setting,
1882                 .string = &iscsi_target_username,
1883                 .prefix = "",
1884         },
1885         {
1886                 .setting = &reverse_password_setting,
1887                 .string = &iscsi_target_password,
1888                 .prefix = "",
1889         },
1890         {
1891                 .setting = &hostname_setting,
1892                 .string = &iscsi_default_initiator_iqn,
1893                 .prefix = "iqn.2000-01.org.etherboot:",
1894         },
1895 };
1896
1897 /**
1898  * Apply iSCSI setting
1899  *
1900  * @v setting           iSCSI string setting
1901  * @ret rc              Return status code
1902  */
1903 static int apply_iscsi_string_setting ( struct iscsi_string_setting *setting ){
1904         size_t prefix_len;
1905         int setting_len;
1906         size_t len;
1907         int check_len;
1908         char *p;
1909
1910         /* Free old string */
1911         free ( *setting->string );
1912         *setting->string = NULL;
1913
1914         /* Allocate new string */
1915         prefix_len = strlen ( setting->prefix );
1916         setting_len = fetch_setting_len ( NULL, setting->setting );
1917         if ( setting_len < 0 ) {
1918                 /* Missing settings are not errors; leave strings as NULL */
1919                 return 0;
1920         }
1921         len = ( prefix_len + setting_len + 1 );
1922         p = *setting->string = malloc ( len );
1923         if ( ! p )
1924                 return -ENOMEM;
1925
1926         /* Fill new string */
1927         strcpy ( p, setting->prefix );
1928         check_len = fetch_string_setting ( NULL, setting->setting,
1929                                            ( p + prefix_len ),
1930                                            ( len - prefix_len ) );
1931         assert ( check_len == setting_len );
1932
1933         return 0;
1934 }
1935
1936 /**
1937  * Apply iSCSI settings
1938  *
1939  * @ret rc              Return status code
1940  */
1941 static int apply_iscsi_settings ( void ) {
1942         struct iscsi_string_setting *setting;
1943         unsigned int i;
1944         int rc;
1945
1946         for ( i = 0 ; i < ( sizeof ( iscsi_string_settings ) /
1947                             sizeof ( iscsi_string_settings[0] ) ) ; i++ ) {
1948                 setting = &iscsi_string_settings[i];
1949                 if ( ( rc = apply_iscsi_string_setting ( setting ) ) != 0 ) {
1950                         DBG ( "iSCSI could not apply setting %s\n",
1951                               setting->setting->name );
1952                         return rc;
1953                 }
1954         }
1955
1956         return 0;
1957 }
1958
1959 /** iSCSI settings applicator */
1960 struct settings_applicator iscsi_settings_applicator __settings_applicator = {
1961         .apply = apply_iscsi_settings,
1962 };
1963
1964 /****************************************************************************
1965  *
1966  * Initiator name
1967  *
1968  */
1969
1970 /**
1971  * Get iSCSI initiator IQN
1972  *
1973  * @v iscsi             iSCSI session
1974  * @ret rc              Return status code
1975  */
1976 const char * iscsi_initiator_iqn ( void ) {
1977
1978         if ( iscsi_explicit_initiator_iqn )
1979                 return iscsi_explicit_initiator_iqn;
1980         if ( iscsi_default_initiator_iqn )
1981                 return iscsi_default_initiator_iqn;
1982         return "iqn.2000-09.org.etherboot:UNKNOWN";
1983 }