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