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