a12fca8579581598b2d92b25e6b52d538c6cbef0
[people/mcb30/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  * Convert iSCSI response status to return status code
835  *
836  * @v status_class      iSCSI status class
837  * @v status_detail     iSCSI status detail
838  * @ret rc              Return status code
839  */
840 static int iscsi_status_to_rc ( unsigned int status_class,
841                                 unsigned int status_detail ) {
842         switch ( status_class ) {
843         case ISCSI_STATUS_INITIATOR_ERROR :
844                 switch ( status_detail ) {
845                 case ISCSI_STATUS_INITIATOR_ERROR_AUTHENTICATION :
846                         return -EACCES;
847                 case ISCSI_STATUS_INITIATOR_ERROR_AUTHORISATION :
848                         return -EPERM;
849                 case ISCSI_STATUS_INITIATOR_ERROR_NOT_FOUND :
850                 case ISCSI_STATUS_INITIATOR_ERROR_REMOVED :
851                         return -ENODEV;
852                 default :
853                         return -ENOTSUP;
854                 }
855         case ISCSI_STATUS_TARGET_ERROR :
856                 return -EIO;
857         default :
858                 return -EINVAL;
859         }
860 }
861
862 /**
863  * Receive data segment of an iSCSI login response PDU
864  *
865  * @v iscsi             iSCSI session
866  * @v data              Received data
867  * @v len               Length of received data
868  * @v remaining         Data remaining after this data
869  * @ret rc              Return status code
870  */
871 static int iscsi_rx_login_response ( struct iscsi_session *iscsi,
872                                      const void *data, size_t len,
873                                      size_t remaining ) {
874         struct iscsi_bhs_login_response *response
875                 = &iscsi->rx_bhs.login_response;
876         int rc;
877
878         /* Buffer up the PDU data */
879         if ( ( rc = iscsi_rx_buffered_data ( iscsi, data, len ) ) != 0 ) {
880                 DBGC ( iscsi, "iSCSI %p could not buffer login response: %s\n",
881                        iscsi, strerror ( rc ) );
882                 return rc;
883         }
884         if ( remaining )
885                 return 0;
886
887         /* Process string data and discard string buffer */
888         if ( ( rc = iscsi_handle_strings ( iscsi, iscsi->rx_buffer,
889                                            iscsi->rx_len ) ) != 0 )
890                 return rc;
891         iscsi_rx_buffered_data_done ( iscsi );
892
893         /* Check for login redirection */
894         if ( response->status_class == ISCSI_STATUS_REDIRECT ) {
895                 DBGC ( iscsi, "iSCSI %p redirecting to new server\n", iscsi );
896                 iscsi_close_connection ( iscsi, 0 );
897                 if ( ( rc = iscsi_open_connection ( iscsi ) ) != 0 ) {
898                         DBGC ( iscsi, "iSCSI %p could not redirect: %s\n ",
899                                iscsi, strerror ( rc ) );
900                         return rc;
901                 }
902                 return 0;
903         }
904
905         /* Check for fatal errors */
906         if ( response->status_class != 0 ) {
907                 DBGC ( iscsi, "iSCSI login failure: class %02x detail %02x\n",
908                        response->status_class, response->status_detail );
909                 rc = iscsi_status_to_rc ( response->status_class,
910                                           response->status_detail );
911                 iscsi->instant_rc = rc;
912                 return rc;
913         }
914
915         /* Handle login transitions */
916         if ( response->flags & ISCSI_LOGIN_FLAG_TRANSITION ) {
917                 switch ( response->flags & ISCSI_LOGIN_NSG_MASK ) {
918                 case ISCSI_LOGIN_NSG_OPERATIONAL_NEGOTIATION:
919                         iscsi->status =
920                                 ( ISCSI_STATUS_OPERATIONAL_NEGOTIATION_PHASE |
921                                   ISCSI_STATUS_STRINGS_OPERATIONAL );
922                         break;
923                 case ISCSI_LOGIN_NSG_FULL_FEATURE_PHASE:
924                         iscsi->status = ISCSI_STATUS_FULL_FEATURE_PHASE;
925                         break;
926                 default:
927                         DBGC ( iscsi, "iSCSI %p got invalid response flags "
928                                "%02x\n", iscsi, response->flags );
929                         return -EIO;
930                 }
931         }
932
933         /* Send next login request PDU if we haven't reached the full
934          * feature phase yet.
935          */
936         if ( ( iscsi->status & ISCSI_STATUS_PHASE_MASK ) !=
937              ISCSI_STATUS_FULL_FEATURE_PHASE ) {
938                 iscsi_start_login ( iscsi );
939                 return 0;
940         }
941
942         /* Reset retry count */
943         iscsi->retry_count = 0;
944
945         /* Record TSIH for future reference */
946         iscsi->tsih = ntohl ( response->tsih );
947         
948         /* Send the actual SCSI command */
949         iscsi_start_command ( iscsi );
950
951         return 0;
952 }
953
954 /****************************************************************************
955  *
956  * iSCSI to socket interface
957  *
958  */
959
960 /**
961  * Start up a new TX PDU
962  *
963  * @v iscsi             iSCSI session
964  *
965  * This initiates the process of sending a new PDU.  Only one PDU may
966  * be in transit at any one time.
967  */
968 static void iscsi_start_tx ( struct iscsi_session *iscsi ) {
969         assert ( iscsi->tx_state == ISCSI_TX_IDLE );
970         
971         /* Initialise TX BHS */
972         memset ( &iscsi->tx_bhs, 0, sizeof ( iscsi->tx_bhs ) );
973
974         /* Flag TX engine to start transmitting */
975         iscsi->tx_state = ISCSI_TX_BHS;
976 }
977
978 /**
979  * Transmit nothing
980  *
981  * @v iscsi             iSCSI session
982  * @ret rc              Return status code
983  */
984 static int iscsi_tx_nothing ( struct iscsi_session *iscsi __unused ) {
985         return 0;
986 }
987
988 /**
989  * Transmit basic header segment of an iSCSI PDU
990  *
991  * @v iscsi             iSCSI session
992  * @ret rc              Return status code
993  */
994 static int iscsi_tx_bhs ( struct iscsi_session *iscsi ) {
995         return xfer_deliver_raw ( &iscsi->socket,  &iscsi->tx_bhs,
996                                   sizeof ( iscsi->tx_bhs ) );
997 }
998
999 /**
1000  * Transmit data segment of an iSCSI PDU
1001  *
1002  * @v iscsi             iSCSI session
1003  * @ret rc              Return status code
1004  * 
1005  * Handle transmission of part of a PDU data segment.  iscsi::tx_bhs
1006  * will be valid when this is called.
1007  */
1008 static int iscsi_tx_data ( struct iscsi_session *iscsi ) {
1009         struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
1010
1011         switch ( common->opcode & ISCSI_OPCODE_MASK ) {
1012         case ISCSI_OPCODE_DATA_OUT:
1013                 return iscsi_tx_data_out ( iscsi );
1014         case ISCSI_OPCODE_LOGIN_REQUEST:
1015                 return iscsi_tx_login_request ( iscsi );
1016         default:
1017                 /* Nothing to send in other states */
1018                 return 0;
1019         }
1020 }
1021
1022 /**
1023  * Transmit data padding of an iSCSI PDU
1024  *
1025  * @v iscsi             iSCSI session
1026  * @ret rc              Return status code
1027  * 
1028  * Handle transmission of any data padding in a PDU data segment.
1029  * iscsi::tx_bhs will be valid when this is called.
1030  */
1031 static int iscsi_tx_data_padding ( struct iscsi_session *iscsi ) {
1032         static const char pad[] = { '\0', '\0', '\0' };
1033         struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
1034         size_t pad_len;
1035         
1036         pad_len = ISCSI_DATA_PAD_LEN ( common->lengths );
1037         if ( ! pad_len )
1038                 return 0;
1039
1040         return xfer_deliver_raw ( &iscsi->socket, pad, pad_len );
1041 }
1042
1043 /**
1044  * Complete iSCSI PDU transmission
1045  *
1046  * @v iscsi             iSCSI session
1047  *
1048  * Called when a PDU has been completely transmitted and the TX state
1049  * machine is about to enter the idle state.  iscsi::tx_bhs will be
1050  * valid for the just-completed PDU when this is called.
1051  */
1052 static void iscsi_tx_done ( struct iscsi_session *iscsi ) {
1053         struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
1054
1055         switch ( common->opcode & ISCSI_OPCODE_MASK ) {
1056         case ISCSI_OPCODE_DATA_OUT:
1057                 iscsi_data_out_done ( iscsi );
1058         case ISCSI_OPCODE_LOGIN_REQUEST:
1059                 iscsi_login_request_done ( iscsi );
1060         default:
1061                 /* No action */
1062                 break;
1063         }
1064 }
1065
1066 /**
1067  * Transmit iSCSI PDU
1068  *
1069  * @v iscsi             iSCSI session
1070  * @v buf               Temporary data buffer
1071  * @v len               Length of temporary data buffer
1072  * 
1073  * Constructs data to be sent for the current TX state
1074  */
1075 static void iscsi_tx_step ( struct process *process ) {
1076         struct iscsi_session *iscsi =
1077                 container_of ( process, struct iscsi_session, process );
1078         struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
1079         int ( * tx ) ( struct iscsi_session *iscsi );
1080         enum iscsi_tx_state next_state;
1081         size_t tx_len;
1082         int rc;
1083
1084         /* Select fragment to transmit */
1085         while ( 1 ) {
1086                 switch ( iscsi->tx_state ) {
1087                 case ISCSI_TX_IDLE:
1088                         /* Stop processing */
1089                         return;
1090                 case ISCSI_TX_BHS:
1091                         tx = iscsi_tx_bhs;
1092                         tx_len = sizeof ( iscsi->tx_bhs );
1093                         next_state = ISCSI_TX_AHS;
1094                         break;
1095                 case ISCSI_TX_AHS:
1096                         tx = iscsi_tx_nothing;
1097                         tx_len = 0;
1098                         next_state = ISCSI_TX_DATA;
1099                         break;
1100                 case ISCSI_TX_DATA:
1101                         tx = iscsi_tx_data;
1102                         tx_len = ISCSI_DATA_LEN ( common->lengths );
1103                         next_state = ISCSI_TX_DATA_PADDING;
1104                         break;
1105                 case ISCSI_TX_DATA_PADDING:
1106                         tx = iscsi_tx_data_padding;
1107                         tx_len = ISCSI_DATA_PAD_LEN ( common->lengths );
1108                         next_state = ISCSI_TX_IDLE;
1109                         break;
1110                 default:
1111                         assert ( 0 );
1112                         return;
1113                 }
1114
1115                 /* Check for window availability, if needed */
1116                 if ( tx_len && ( xfer_window ( &iscsi->socket ) == 0 ) ) {
1117                         /* Cannot transmit at this point; stop processing */
1118                         return;
1119                 }
1120
1121                 /* Transmit data */
1122                 if ( ( rc = tx ( iscsi ) ) != 0 ) {
1123                         DBGC ( iscsi, "iSCSI %p could not transmit: %s\n",
1124                                iscsi, strerror ( rc ) );
1125                         return;
1126                 }
1127
1128                 /* Move to next state */
1129                 iscsi->tx_state = next_state;
1130                 if ( next_state == ISCSI_TX_IDLE )
1131                         iscsi_tx_done ( iscsi );
1132         }
1133 }
1134
1135 /**
1136  * Receive basic header segment of an iSCSI PDU
1137  *
1138  * @v iscsi             iSCSI session
1139  * @v data              Received data
1140  * @v len               Length of received data
1141  * @v remaining         Data remaining after this data
1142  * @ret rc              Return status code
1143  *
1144  * This fills in iscsi::rx_bhs with the data from the BHS portion of
1145  * the received PDU.
1146  */
1147 static int iscsi_rx_bhs ( struct iscsi_session *iscsi, const void *data,
1148                           size_t len, size_t remaining __unused ) {
1149         memcpy ( &iscsi->rx_bhs.bytes[iscsi->rx_offset], data, len );
1150         if ( ( iscsi->rx_offset + len ) >= sizeof ( iscsi->rx_bhs ) ) {
1151                 DBGC ( iscsi, "iSCSI %p received PDU opcode %#x len %#lx\n",
1152                        iscsi, iscsi->rx_bhs.common.opcode,
1153                        ISCSI_DATA_LEN ( iscsi->rx_bhs.common.lengths ) );
1154         }
1155         return 0;
1156 }
1157
1158 /**
1159  * Discard portion of an iSCSI PDU.
1160  *
1161  * @v iscsi             iSCSI session
1162  * @v data              Received data
1163  * @v len               Length of received data
1164  * @v remaining         Data remaining after this data
1165  * @ret rc              Return status code
1166  *
1167  * This discards data from a portion of a received PDU.
1168  */
1169 static int iscsi_rx_discard ( struct iscsi_session *iscsi __unused,
1170                               const void *data __unused, size_t len __unused,
1171                               size_t remaining __unused ) {
1172         /* Do nothing */
1173         return 0;
1174 }
1175
1176 /**
1177  * Receive data segment of an iSCSI PDU
1178  *
1179  * @v iscsi             iSCSI session
1180  * @v data              Received data
1181  * @v len               Length of received data
1182  * @v remaining         Data remaining after this data
1183  * @ret rc              Return status code
1184  *
1185  * Handle processing of part of a PDU data segment.  iscsi::rx_bhs
1186  * will be valid when this is called.
1187  */
1188 static int iscsi_rx_data ( struct iscsi_session *iscsi, const void *data,
1189                            size_t len, size_t remaining ) {
1190         struct iscsi_bhs_common_response *response
1191                 = &iscsi->rx_bhs.common_response;
1192
1193         /* Update cmdsn and statsn */
1194         iscsi->cmdsn = ntohl ( response->expcmdsn );
1195         iscsi->statsn = ntohl ( response->statsn );
1196
1197         switch ( response->opcode & ISCSI_OPCODE_MASK ) {
1198         case ISCSI_OPCODE_LOGIN_RESPONSE:
1199                 return iscsi_rx_login_response ( iscsi, data, len, remaining );
1200         case ISCSI_OPCODE_SCSI_RESPONSE:
1201                 return iscsi_rx_scsi_response ( iscsi, data, len, remaining );
1202         case ISCSI_OPCODE_DATA_IN:
1203                 return iscsi_rx_data_in ( iscsi, data, len, remaining );
1204         case ISCSI_OPCODE_R2T:
1205                 return iscsi_rx_r2t ( iscsi, data, len, remaining );
1206         default:
1207                 if ( remaining )
1208                         return 0;
1209                 DBGC ( iscsi, "iSCSI %p unknown opcode %02x\n", iscsi,
1210                        response->opcode );
1211                 return -ENOTSUP;
1212         }
1213 }
1214
1215 /**
1216  * Receive new data
1217  *
1218  * @v socket            Transport layer interface
1219  * @v data              Received data
1220  * @v len               Length of received data
1221  * @ret rc              Return status code
1222  *
1223  * This handles received PDUs.  The receive strategy is to fill in
1224  * iscsi::rx_bhs with the contents of the BHS portion of the PDU,
1225  * throw away any AHS portion, and then process each part of the data
1226  * portion as it arrives.  The data processing routine therefore
1227  * always has a full copy of the BHS available, even for portions of
1228  * the data in different packets to the BHS.
1229  */
1230 static int iscsi_socket_deliver_raw ( struct xfer_interface *socket,
1231                                       const void *data, size_t len ) {
1232         struct iscsi_session *iscsi =
1233                 container_of ( socket, struct iscsi_session, socket );
1234         struct iscsi_bhs_common *common = &iscsi->rx_bhs.common;
1235         int ( * rx ) ( struct iscsi_session *iscsi, const void *data,
1236                        size_t len, size_t remaining );
1237         enum iscsi_rx_state next_state;
1238         size_t frag_len;
1239         size_t remaining;
1240         int rc;
1241
1242         while ( 1 ) {
1243                 switch ( iscsi->rx_state ) {
1244                 case ISCSI_RX_BHS:
1245                         rx = iscsi_rx_bhs;
1246                         iscsi->rx_len = sizeof ( iscsi->rx_bhs );
1247                         next_state = ISCSI_RX_AHS;                      
1248                         break;
1249                 case ISCSI_RX_AHS:
1250                         rx = iscsi_rx_discard;
1251                         iscsi->rx_len = 4 * ISCSI_AHS_LEN ( common->lengths );
1252                         next_state = ISCSI_RX_DATA;
1253                         break;
1254                 case ISCSI_RX_DATA:
1255                         rx = iscsi_rx_data;
1256                         iscsi->rx_len = ISCSI_DATA_LEN ( common->lengths );
1257                         next_state = ISCSI_RX_DATA_PADDING;
1258                         break;
1259                 case ISCSI_RX_DATA_PADDING:
1260                         rx = iscsi_rx_discard;
1261                         iscsi->rx_len = ISCSI_DATA_PAD_LEN ( common->lengths );
1262                         next_state = ISCSI_RX_BHS;
1263                         break;
1264                 default:
1265                         assert ( 0 );
1266                         return -EINVAL;
1267                 }
1268
1269                 frag_len = iscsi->rx_len - iscsi->rx_offset;
1270                 if ( frag_len > len )
1271                         frag_len = len;
1272                 remaining = iscsi->rx_len - iscsi->rx_offset - frag_len;
1273                 if ( ( rc = rx ( iscsi, data, frag_len, remaining ) ) != 0 ) {
1274                         DBGC ( iscsi, "iSCSI %p could not process received "
1275                                "data: %s\n", iscsi, strerror ( rc ) );
1276                         iscsi_close_connection ( iscsi, rc );
1277                         iscsi_scsi_done ( iscsi, rc );
1278                         return rc;
1279                 }
1280
1281                 iscsi->rx_offset += frag_len;
1282                 data += frag_len;
1283                 len -= frag_len;
1284
1285                 /* If all the data for this state has not yet been
1286                  * received, stay in this state for now.
1287                  */
1288                 if ( iscsi->rx_offset != iscsi->rx_len )
1289                         return 0;
1290
1291                 iscsi->rx_state = next_state;
1292                 iscsi->rx_offset = 0;
1293         }
1294
1295         return 0;
1296 }
1297
1298 /**
1299  * Handle stream connection closure
1300  *
1301  * @v socket            Transport layer interface
1302  * @v rc                Reason for close
1303  *
1304  */
1305 static void iscsi_socket_close ( struct xfer_interface *socket, int rc ) {
1306         struct iscsi_session *iscsi =
1307                 container_of ( socket, struct iscsi_session, socket );
1308
1309         /* Even a graceful close counts as an error for iSCSI */
1310         if ( ! rc )
1311                 rc = -ECONNRESET;
1312
1313         /* Close session cleanly */
1314         iscsi_close_connection ( iscsi, rc );
1315
1316         /* Retry connection if within the retry limit, otherwise fail */
1317         if ( ++iscsi->retry_count <= ISCSI_MAX_RETRIES ) {
1318                 DBGC ( iscsi, "iSCSI %p retrying connection (retry #%d)\n",
1319                        iscsi, iscsi->retry_count );
1320                 if ( ( rc = iscsi_open_connection ( iscsi ) ) != 0 ) {
1321                         DBGC ( iscsi, "iSCSI %p could not reconnect: %s\n",
1322                                iscsi, strerror ( rc ) );
1323                         iscsi_scsi_done ( iscsi, rc );
1324                 }
1325         } else {
1326                 DBGC ( iscsi, "iSCSI %p retry count exceeded\n", iscsi );
1327                 iscsi->instant_rc = rc;
1328                 iscsi_scsi_done ( iscsi, rc );
1329         }
1330 }
1331
1332 /**
1333  * Handle redirection event
1334  *
1335  * @v socket            Transport layer interface
1336  * @v type              Location type
1337  * @v args              Remaining arguments depend upon location type
1338  * @ret rc              Return status code
1339  */
1340 static int iscsi_vredirect ( struct xfer_interface *socket, int type,
1341                              va_list args ) {
1342         struct iscsi_session *iscsi =
1343                 container_of ( socket, struct iscsi_session, socket );
1344         va_list tmp;
1345         struct sockaddr *peer;
1346
1347         /* Intercept redirects to a LOCATION_SOCKET and record the IP
1348          * address for the iBFT.  This is a bit of a hack, but avoids
1349          * inventing an ioctl()-style call to retrieve the socket
1350          * address from a data-xfer interface.
1351          */
1352         if ( type == LOCATION_SOCKET ) {
1353                 va_copy ( tmp, args );
1354                 ( void ) va_arg ( tmp, int ); /* Discard "semantics" */
1355                 peer = va_arg ( tmp, struct sockaddr * );
1356                 memcpy ( &iscsi->target_sockaddr, peer,
1357                          sizeof ( iscsi->target_sockaddr ) );
1358                 va_end ( tmp );
1359         }
1360
1361         return xfer_vopen ( socket, type, args );
1362 }
1363                              
1364
1365 /** iSCSI socket operations */
1366 static struct xfer_interface_operations iscsi_socket_operations = {
1367         .close          = iscsi_socket_close,
1368         .vredirect      = iscsi_vredirect,
1369         .window         = unlimited_xfer_window,
1370         .alloc_iob      = default_xfer_alloc_iob,
1371         .deliver_iob    = xfer_deliver_as_raw,
1372         .deliver_raw    = iscsi_socket_deliver_raw,
1373 };
1374
1375
1376 /****************************************************************************
1377  *
1378  * iSCSI command issuing
1379  *
1380  */
1381
1382 /**
1383  * Issue SCSI command
1384  *
1385  * @v scsi              SCSI device
1386  * @v command           SCSI command
1387  * @ret rc              Return status code
1388  */
1389 static int iscsi_command ( struct scsi_device *scsi,
1390                            struct scsi_command *command ) {
1391         struct iscsi_session *iscsi =
1392                 container_of ( scsi->backend, struct iscsi_session, refcnt );
1393         int rc;
1394
1395         /* Record SCSI command */
1396         iscsi->command = command;
1397
1398         /* Abort immediately if we have a recorded permanent failure */
1399         if ( iscsi->instant_rc ) {
1400                 rc = iscsi->instant_rc;
1401                 goto done;
1402         }
1403
1404         /* Issue command or open connection as appropriate */
1405         if ( iscsi->status ) {
1406                 iscsi_start_command ( iscsi );
1407         } else {
1408                 if ( ( rc = iscsi_open_connection ( iscsi ) ) != 0 )
1409                         goto done;
1410         }
1411
1412         /* Wait for command to complete */
1413         iscsi->rc = -EINPROGRESS;
1414         while ( iscsi->rc == -EINPROGRESS )
1415                 step();
1416         rc = iscsi->rc;
1417
1418  done:
1419         iscsi->command = NULL;
1420         return rc;
1421 }
1422
1423 static int iscsi_detached_command ( struct scsi_device *scsi __unused,
1424                                     struct scsi_command *command __unused ) {
1425         return -ENODEV;
1426 }
1427
1428 /**
1429  * Shut down iSCSI interface
1430  *
1431  * @v scsi              SCSI device
1432  */
1433 void iscsi_detach ( struct scsi_device *scsi ) {
1434         struct iscsi_session *iscsi =
1435                 container_of ( scsi->backend, struct iscsi_session, refcnt );
1436
1437         xfer_nullify ( &iscsi->socket );
1438         iscsi_close_connection ( iscsi, 0 );
1439         process_del ( &iscsi->process );
1440         scsi->command = iscsi_detached_command;
1441         ref_put ( scsi->backend );
1442         scsi->backend = NULL;
1443 }
1444
1445 /****************************************************************************
1446  *
1447  * Instantiator
1448  *
1449  */
1450
1451 /** iSCSI root path components (as per RFC4173) */
1452 enum iscsi_root_path_component {
1453         RP_LITERAL = 0,
1454         RP_SERVERNAME,
1455         RP_PROTOCOL,
1456         RP_PORT,
1457         RP_LUN,
1458         RP_TARGETNAME,
1459         NUM_RP_COMPONENTS
1460 };
1461
1462 /**
1463  * Parse iSCSI LUN
1464  *
1465  * @v iscsi             iSCSI session
1466  * @v lun_string        LUN string representation (as per RFC4173)
1467  * @ret rc              Return status code
1468  */
1469 static int iscsi_parse_lun ( struct iscsi_session *iscsi,
1470                              const char *lun_string ) {
1471         char *p = ( char * ) lun_string;
1472         union {
1473                 uint64_t u64;
1474                 uint16_t u16[4];
1475         } lun;
1476         int i;
1477
1478         /* Empty LUN; assume LUN 0 */
1479         if ( ! *lun_string )
1480                 return 0;
1481
1482         for ( i = 0 ; i < 4 ; i++ ) {
1483                 lun.u16[i] = strtoul ( p, &p, 16 );
1484                 if ( *p != '-' )
1485                         return -EINVAL;
1486                 p++;
1487         }
1488         if ( *p )
1489                 return -EINVAL;
1490
1491         iscsi->lun = lun.u64;
1492         return 0;
1493 }
1494
1495 /**
1496  * Parse iSCSI root path
1497  *
1498  * @v iscsi             iSCSI session
1499  * @v root_path         iSCSI root path (as per RFC4173)
1500  * @ret rc              Return status code
1501  */
1502 static int iscsi_parse_root_path ( struct iscsi_session *iscsi,
1503                                    const char *root_path ) {
1504         char rp_copy[ strlen ( root_path ) + 1 ];
1505         char *rp_comp[NUM_RP_COMPONENTS];
1506         char *rp = rp_copy;
1507         int i = 0;
1508         int rc;
1509
1510         /* Split root path into component parts */
1511         strcpy ( rp_copy, root_path );
1512         while ( 1 ) {
1513                 rp_comp[i++] = rp;
1514                 if ( i == NUM_RP_COMPONENTS )
1515                         break;
1516                 for ( ; *rp != ':' ; rp++ ) {
1517                         if ( ! *rp ) {
1518                                 DBGC ( iscsi, "iSCSI %p root path \"%s\" "
1519                                        "too short\n", iscsi, root_path );
1520                                 return -EINVAL;
1521                         }
1522                 }
1523                 *(rp++) = '\0';
1524         }
1525
1526         /* Use root path components to configure iSCSI session */
1527         iscsi->target_address = strdup ( rp_comp[RP_SERVERNAME] );
1528         if ( ! iscsi->target_address )
1529                 return -ENOMEM;
1530         iscsi->target_port = strtoul ( rp_comp[RP_PORT], NULL, 10 );
1531         if ( ! iscsi->target_port )
1532                 iscsi->target_port = ISCSI_PORT;
1533         if ( ( rc = iscsi_parse_lun ( iscsi, rp_comp[RP_LUN] ) ) != 0 ) {
1534                 DBGC ( iscsi, "iSCSI %p invalid LUN \"%s\"\n",
1535                        iscsi, rp_comp[RP_LUN] );
1536                 return rc;
1537         }
1538         iscsi->target_iqn = strdup ( rp_comp[RP_TARGETNAME] );
1539         if ( ! iscsi->target_iqn )
1540                 return -ENOMEM;
1541
1542         return 0;
1543 }
1544
1545 /**
1546  * Set iSCSI authentication details
1547  *
1548  * @v iscsi             iSCSI session
1549  * @v username          Username, if any
1550  * @v password          Password, if any
1551  * @ret rc              Return status code
1552  */
1553 static int iscsi_set_auth ( struct iscsi_session *iscsi,
1554                             const char *username, const char *password ) {
1555
1556         if ( username ) {
1557                 iscsi->username = strdup ( username );
1558                 if ( ! iscsi->username )
1559                         return -ENOMEM;
1560         }
1561
1562         if ( password ) {
1563                 iscsi->password = strdup ( password );
1564                 if ( ! iscsi->password )
1565                         return -ENOMEM;
1566         }
1567
1568         return 0;
1569 }
1570
1571 /**
1572  * Attach iSCSI interface
1573  *
1574  * @v scsi              SCSI device
1575  * @v root_path         iSCSI root path (as per RFC4173)
1576  * @ret rc              Return status code
1577  */
1578 int iscsi_attach ( struct scsi_device *scsi, const char *root_path ) {
1579         struct iscsi_session *iscsi;
1580         int rc;
1581
1582         /* Allocate and initialise structure */
1583         iscsi = zalloc ( sizeof ( *iscsi ) );
1584         if ( ! iscsi )
1585                 return -ENOMEM;
1586         iscsi->refcnt.free = iscsi_free;
1587         xfer_init ( &iscsi->socket, &iscsi_socket_operations, &iscsi->refcnt );
1588         process_init ( &iscsi->process, iscsi_tx_step, &iscsi->refcnt );
1589
1590         /* Parse root path */
1591         if ( ( rc = iscsi_parse_root_path ( iscsi, root_path ) ) != 0 )
1592                 goto err;
1593         /* Set fields not specified by root path */
1594         if ( ( rc = iscsi_set_auth ( iscsi, iscsi_username,
1595                                      iscsi_password ) ) != 0 )
1596                 goto err;
1597
1598         /* Sanity checks */
1599         if ( ! iscsi->target_address ) {
1600                 DBGC ( iscsi, "iSCSI %p does not yet support discovery\n",
1601                        iscsi );
1602                 rc = -ENOTSUP;
1603                 goto err;
1604         }
1605         if ( ! iscsi->target_iqn ) {
1606                 DBGC ( iscsi, "iSCSI %p no target address supplied in %s\n",
1607                        iscsi, root_path );
1608                 rc = -EINVAL;
1609                 goto err;
1610         }
1611
1612         /* Attach parent interface, mortalise self, and return */
1613         scsi->backend = ref_get ( &iscsi->refcnt );
1614         scsi->command = iscsi_command;
1615         scsi->lun = iscsi->lun;
1616         ref_put ( &iscsi->refcnt );
1617         return 0;
1618         
1619  err:
1620         ref_put ( &iscsi->refcnt );
1621         return rc;
1622 }
1623
1624 /****************************************************************************
1625  *
1626  * Settings
1627  *
1628  */
1629
1630 /** iSCSI initiator IQN setting */
1631 struct setting initiator_iqn_setting __setting = {
1632         .name = "initiator-iqn",
1633         .description = "iSCSI initiator name",
1634         .tag = DHCP_ISCSI_INITIATOR_IQN,
1635         .type = &setting_type_string,
1636 };
1637
1638 /** An iSCSI string setting */
1639 struct iscsi_string_setting {
1640         /** Setting */
1641         struct setting *setting;
1642         /** String to update */
1643         char **string;
1644         /** String prefix */
1645         const char *prefix;
1646 };
1647
1648 /** iSCSI string settings */
1649 static struct iscsi_string_setting iscsi_string_settings[] = {
1650         {
1651                 .setting = &initiator_iqn_setting,
1652                 .string = &iscsi_explicit_initiator_iqn,
1653                 .prefix = "",
1654         },
1655         {
1656                 .setting = &username_setting,
1657                 .string = &iscsi_username,
1658                 .prefix = "",
1659         },
1660         {
1661                 .setting = &password_setting,
1662                 .string = &iscsi_password,
1663                 .prefix = "",
1664         },
1665         {
1666                 .setting = &hostname_setting,
1667                 .string = &iscsi_default_initiator_iqn,
1668                 .prefix = "iqn.2000-09.org.etherboot:",
1669         },
1670 };
1671
1672 /**
1673  * Apply iSCSI setting
1674  *
1675  * @v setting           iSCSI string setting
1676  * @ret rc              Return status code
1677  */
1678 static int apply_iscsi_string_setting ( struct iscsi_string_setting *setting ){
1679         size_t prefix_len;
1680         int setting_len;
1681         size_t len;
1682         int check_len;
1683         char *p;
1684
1685         /* Free old string */
1686         free ( *setting->string );
1687         *setting->string = NULL;
1688
1689         /* Allocate new string */
1690         prefix_len = strlen ( setting->prefix );
1691         setting_len = fetch_setting_len ( NULL, setting->setting );
1692         if ( setting_len < 0 ) {
1693                 /* Missing settings are not errors; leave strings as NULL */
1694                 return 0;
1695         }
1696         len = ( prefix_len + setting_len + 1 );
1697         p = *setting->string = malloc ( len );
1698         if ( ! p )
1699                 return -ENOMEM;
1700
1701         /* Fill new string */
1702         strcpy ( p, setting->prefix );
1703         check_len = fetch_string_setting ( NULL, setting->setting,
1704                                            ( p + prefix_len ),
1705                                            ( len - prefix_len ) );
1706         assert ( check_len == setting_len );
1707
1708         return 0;
1709 }
1710
1711 /**
1712  * Apply iSCSI settings
1713  *
1714  * @ret rc              Return status code
1715  */
1716 static int apply_iscsi_settings ( void ) {
1717         struct iscsi_string_setting *setting;
1718         unsigned int i;
1719         int rc;
1720
1721         for ( i = 0 ; i < ( sizeof ( iscsi_string_settings ) /
1722                             sizeof ( iscsi_string_settings[0] ) ) ; i++ ) {
1723                 setting = &iscsi_string_settings[i];
1724                 if ( ( rc = apply_iscsi_string_setting ( setting ) ) != 0 ) {
1725                         DBG ( "iSCSI could not apply setting %s\n",
1726                               setting->setting->name );
1727                         return rc;
1728                 }
1729         }
1730
1731         return 0;
1732 }
1733
1734 /** iSCSI settings applicator */
1735 struct settings_applicator iscsi_settings_applicator __settings_applicator = {
1736         .apply = apply_iscsi_settings,
1737 };
1738
1739 /****************************************************************************
1740  *
1741  * Initiator name
1742  *
1743  */
1744
1745 /**
1746  * Get iSCSI initiator IQN
1747  *
1748  * @v iscsi             iSCSI session
1749  * @ret rc              Return status code
1750  */
1751 const char * iscsi_initiator_iqn ( void ) {
1752
1753         if ( iscsi_explicit_initiator_iqn )
1754                 return iscsi_explicit_initiator_iqn;
1755         if ( iscsi_default_initiator_iqn )
1756                 return iscsi_default_initiator_iqn;
1757         return "iqn.2000-09.org.etherboot:UNKNOWN";
1758 }