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