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