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