Switch compiler warning on tcp_open() to a #warning
[people/xl0/gpxe-arm.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/scsi.h>
28 #include <gpxe/process.h>
29 #include <gpxe/uaccess.h>
30 #include <gpxe/tcp.h>
31 #include <gpxe/iscsi.h>
32
33 /** @file
34  *
35  * iSCSI protocol
36  *
37  */
38
39 #warning "Update to use data-xfer interface"
40 extern int tcp_open ( struct stream_application *stream );
41
42 static void iscsi_start_tx ( struct iscsi_session *iscsi );
43 static void iscsi_start_data_out ( struct iscsi_session *iscsi,
44                                    unsigned int datasn );
45
46 /**
47  * Receive PDU data into buffer
48  *
49  * @v iscsi             iSCSI session
50  * @v data              Data to receive
51  * @v len               Length of data
52  * @ret rc              Return status code
53  *
54  * This can be used when the RX PDU type handler wishes to buffer up
55  * all received data and process the PDU as a single unit.  The caller
56  * is repsonsible for calling iscsi_rx_buffered_data_done() after
57  * processing the data.
58  */
59 static int iscsi_rx_buffered_data ( struct iscsi_session *iscsi,
60                                     const void *data, size_t len ) {
61
62         /* Allocate buffer on first call */
63         if ( ! iscsi->rx_buffer ) {
64                 iscsi->rx_buffer = malloc ( iscsi->rx_len );
65                 if ( ! iscsi->rx_buffer )
66                         return -ENOMEM;
67         }
68
69         /* Copy data to buffer */
70         assert ( ( iscsi->rx_offset + len ) <= iscsi->rx_len );
71         memcpy ( ( iscsi->rx_buffer + iscsi->rx_offset ), data, len );
72
73         return 0;
74 }
75
76 /**
77  * Finish receiving PDU data into buffer
78  *
79  * @v iscsi             iSCSI session
80  */
81 static void iscsi_rx_buffered_data_done ( struct iscsi_session *iscsi ) {
82         free ( iscsi->rx_buffer );
83         iscsi->rx_buffer = NULL;
84 }
85
86 /**
87  * Close iSCSI connection
88  *
89  * @v iscsi             iSCSI session
90  */
91 static void iscsi_close ( struct iscsi_session *iscsi ) {
92
93         /* Close stream connection */
94         stream_close ( &iscsi->stream );
95
96         /* Clear connection status */
97         iscsi->status = 0;
98
99         /* Reset TX and RX state machines */
100         iscsi->tx_state = ISCSI_TX_IDLE;
101         iscsi->rx_state = ISCSI_RX_BHS;
102
103         /* Free any dynamically allocated memory */
104         chap_finish ( &iscsi->chap );
105         iscsi_rx_buffered_data_done ( iscsi );
106 }
107
108 /**
109  * Mark iSCSI operation as complete
110  *
111  * @v iscsi             iSCSI session
112  * @v rc                Return status code
113  *
114  * Note that iscsi_done() will not close the connection, and must
115  * therefore be called only when the internal state machines are in an
116  * appropriate state, otherwise bad things may happen on the next call
117  * to iscsi_issue().  The general rule is to call iscsi_done() only at
118  * the end of receiving a PDU; at this point the TX and RX engines
119  * should both be idle.
120  */
121 static void iscsi_done ( struct iscsi_session *iscsi, int rc ) {
122
123         assert ( iscsi->tx_state == ISCSI_TX_IDLE );
124
125         /* Clear current SCSI command */
126         iscsi->command = NULL;
127
128         /* Mark asynchronous operation as complete */
129         async_done ( &iscsi->async, rc );
130 }
131
132 /****************************************************************************
133  *
134  * iSCSI SCSI command issuing
135  *
136  */
137
138 /**
139  * Build iSCSI SCSI command BHS
140  *
141  * @v iscsi             iSCSI session
142  *
143  * We don't currently support bidirectional commands (i.e. with both
144  * Data-In and Data-Out segments); these would require providing code
145  * to generate an AHS, and there doesn't seem to be any need for it at
146  * the moment.
147  */
148 static void iscsi_start_command ( struct iscsi_session *iscsi ) {
149         struct iscsi_bhs_scsi_command *command = &iscsi->tx_bhs.scsi_command;
150
151         assert ( ! ( iscsi->command->data_in && iscsi->command->data_out ) );
152
153         /* Construct BHS and initiate transmission */
154         iscsi_start_tx ( iscsi );
155         command->opcode = ISCSI_OPCODE_SCSI_COMMAND;
156         command->flags = ( ISCSI_FLAG_FINAL |
157                            ISCSI_COMMAND_ATTR_SIMPLE );
158         if ( iscsi->command->data_in )
159                 command->flags |= ISCSI_COMMAND_FLAG_READ;
160         if ( iscsi->command->data_out )
161                 command->flags |= ISCSI_COMMAND_FLAG_WRITE;
162         /* lengths left as zero */
163         command->lun = iscsi->lun;
164         command->itt = htonl ( ++iscsi->itt );
165         command->exp_len = htonl ( iscsi->command->data_in_len |
166                                    iscsi->command->data_out_len );
167         command->cmdsn = htonl ( iscsi->cmdsn );
168         command->expstatsn = htonl ( iscsi->statsn + 1 );
169         memcpy ( &command->cdb, &iscsi->command->cdb, sizeof ( command->cdb ));
170         DBGC ( iscsi, "iSCSI %p start " SCSI_CDB_FORMAT " %s %#x\n",
171                iscsi, SCSI_CDB_DATA ( command->cdb ),
172                ( iscsi->command->data_in ? "in" : "out" ),
173                ( iscsi->command->data_in ?
174                  iscsi->command->data_in_len : iscsi->command->data_out_len ));
175 }
176
177 /**
178  * Receive data segment of an iSCSI SCSI response PDU
179  *
180  * @v iscsi             iSCSI session
181  * @v data              Received data
182  * @v len               Length of received data
183  * @v remaining         Data remaining after this data
184  * 
185  */
186 static void iscsi_rx_scsi_response ( struct iscsi_session *iscsi, void *data,
187                                      size_t len, size_t remaining ) {
188         struct iscsi_bhs_scsi_response *response
189                 = &iscsi->rx_bhs.scsi_response;
190         int sense_offset;
191
192         /* Capture the sense response code as it floats past, if present */
193         sense_offset = ISCSI_SENSE_RESPONSE_CODE_OFFSET - iscsi->rx_offset;
194         if ( ( sense_offset >= 0 ) && len ) {
195                 iscsi->command->sense_response =
196                         * ( ( char * ) data + sense_offset );
197         }
198
199         /* Wait for whole SCSI response to arrive */
200         if ( remaining )
201                 return;
202         
203         /* Record SCSI status code */
204         iscsi->command->status = response->status;
205
206         /* Mark as completed, with error if applicable */
207         if ( response->response == ISCSI_RESPONSE_COMMAND_COMPLETE ) {
208                 iscsi_done ( iscsi, 0 );
209         } else {
210                 iscsi_done ( iscsi, -EIO );
211         }
212 }
213
214 /**
215  * Receive data segment of an iSCSI data-in PDU
216  *
217  * @v iscsi             iSCSI session
218  * @v data              Received data
219  * @v len               Length of received data
220  * @v remaining         Data remaining after this data
221  * 
222  */
223 static void iscsi_rx_data_in ( struct iscsi_session *iscsi, void *data,
224                                size_t len, size_t remaining __unused ) {
225         struct iscsi_bhs_data_in *data_in = &iscsi->rx_bhs.data_in;
226         unsigned long offset;
227
228         /* Copy data to data-in buffer */
229         offset = ntohl ( data_in->offset ) + iscsi->rx_offset;
230         assert ( iscsi->command != NULL );
231         assert ( iscsi->command->data_in );
232         assert ( ( offset + len ) <= iscsi->command->data_in_len );
233         copy_to_user ( iscsi->command->data_in, offset, data, len );
234
235         /* Record SCSI status, if present */
236         if ( data_in->flags & ISCSI_DATA_FLAG_STATUS )
237                 iscsi->command->status = data_in->status;
238
239         /* If this is the end, flag as complete */
240         if ( ( offset + len ) == iscsi->command->data_in_len ) {
241                 assert ( data_in->flags & ISCSI_FLAG_FINAL );
242                 assert ( remaining == 0 );
243                 iscsi_done ( iscsi, 0 );
244         }
245 }
246
247 /**
248  * Receive data segment of an iSCSI R2T PDU
249  *
250  * @v iscsi             iSCSI session
251  * @v data              Received data
252  * @v len               Length of received data
253  * @v remaining         Data remaining after this data
254  * 
255  */
256 static void iscsi_rx_r2t ( struct iscsi_session *iscsi, void *data __unused,
257                            size_t len __unused, size_t remaining __unused ) {
258         struct iscsi_bhs_r2t *r2t = &iscsi->rx_bhs.r2t;
259
260         /* Record transfer parameters and trigger first data-out */
261         iscsi->ttt = ntohl ( r2t->ttt );
262         iscsi->transfer_offset = ntohl ( r2t->offset );
263         iscsi->transfer_len = ntohl ( r2t->len );
264         iscsi_start_data_out ( iscsi, 0 );
265 }
266
267 /**
268  * Build iSCSI data-out BHS
269  *
270  * @v iscsi             iSCSI session
271  * @v datasn            Data sequence number within the transfer
272  *
273  */
274 static void iscsi_start_data_out ( struct iscsi_session *iscsi,
275                                    unsigned int datasn ) {
276         struct iscsi_bhs_data_out *data_out = &iscsi->tx_bhs.data_out;
277         unsigned long offset;
278         unsigned long remaining;
279         unsigned long len;
280
281         /* We always send 512-byte Data-Out PDUs; this removes the
282          * need to worry about the target's MaxRecvDataSegmentLength.
283          */
284         offset = datasn * 512;
285         remaining = iscsi->transfer_len - offset;
286         len = remaining;
287         if ( len > 512 )
288                 len = 512;
289
290         /* Construct BHS and initiate transmission */
291         iscsi_start_tx ( iscsi );
292         data_out->opcode = ISCSI_OPCODE_DATA_OUT;
293         if ( len == remaining )
294                 data_out->flags = ( ISCSI_FLAG_FINAL );
295         ISCSI_SET_LENGTHS ( data_out->lengths, 0, len );
296         data_out->lun = iscsi->lun;
297         data_out->itt = htonl ( iscsi->itt );
298         data_out->ttt = htonl ( iscsi->ttt );
299         data_out->expstatsn = htonl ( iscsi->statsn + 1 );
300         data_out->datasn = htonl ( datasn );
301         data_out->offset = htonl ( iscsi->transfer_offset + offset );
302         DBGC ( iscsi, "iSCSI %p start data out DataSN %#x len %#lx\n",
303                iscsi, datasn, len );
304 }
305
306 /**
307  * Complete iSCSI data-out PDU transmission
308  *
309  * @v iscsi             iSCSI session
310  *
311  */
312 static void iscsi_data_out_done ( struct iscsi_session *iscsi ) {
313         struct iscsi_bhs_data_out *data_out = &iscsi->tx_bhs.data_out;
314
315         /* If we haven't reached the end of the sequence, start
316          * sending the next data-out PDU.
317          */
318         if ( ! ( data_out->flags & ISCSI_FLAG_FINAL ) )
319                 iscsi_start_data_out ( iscsi, ntohl ( data_out->datasn ) + 1 );
320 }
321
322 /**
323  * Send iSCSI data-out data segment
324  *
325  * @v iscsi             iSCSI session
326  * @v buf               Temporary data buffer
327  * @v len               Length of temporary data buffer
328  */
329 static void iscsi_tx_data_out ( struct iscsi_session *iscsi,
330                                 void *buf, size_t len ) {
331         struct iscsi_bhs_data_out *data_out = &iscsi->tx_bhs.data_out;
332         unsigned long offset;
333         unsigned long remaining;
334
335         offset = ( iscsi->transfer_offset + ntohl ( data_out->offset ) +
336                    iscsi->tx_offset );
337         remaining = ( iscsi->tx_len - iscsi->tx_offset );
338         assert ( iscsi->command != NULL );
339         assert ( iscsi->command->data_out );
340         assert ( ( offset + remaining ) <= iscsi->command->data_out_len );
341         
342         if ( remaining < len )
343                 len = remaining;
344         copy_from_user ( buf, iscsi->command->data_out, offset, len );
345
346         stream_send ( &iscsi->stream, buf, len );
347 }
348
349 /****************************************************************************
350  *
351  * iSCSI login
352  *
353  */
354
355 /**
356  * Build iSCSI login request strings
357  *
358  * @v iscsi             iSCSI session
359  *
360  * These are the initial set of strings sent in the first login
361  * request PDU.  We want the following settings:
362  *
363  *     HeaderDigest=None
364  *     DataDigest=None
365  *     MaxConnections is irrelevant; we make only one connection anyway
366  *     InitialR2T=Yes [1]
367  *     ImmediateData is irrelevant; we never send immediate data
368  *     MaxRecvDataSegmentLength=8192 (default; we don't care)
369  *     MaxBurstLength=262144 (default; we don't care)
370  *     FirstBurstLength=262144 (default; we don't care)
371  *     DefaultTime2Wait=0 [2]
372  *     DefaultTime2Retain=0 [2]
373  *     MaxOutstandingR2T=1
374  *     DataPDUInOrder=Yes
375  *     DataSequenceInOrder=Yes
376  *     ErrorRecoveryLevel=0
377  *
378  * [1] InitialR2T has an OR resolution function, so the target may
379  * force us to use it.  We therefore simplify our logic by always
380  * using it.
381  *
382  * [2] These ensure that we can safely start a new task once we have
383  * reconnected after a failure, without having to manually tidy up
384  * after the old one.
385  */
386 static int iscsi_build_login_request_strings ( struct iscsi_session *iscsi,
387                                                void *data, size_t len ) {
388         unsigned int used = 0;
389         unsigned int i;
390
391         if ( iscsi->status & ISCSI_STATUS_STRINGS_SECURITY ) {
392                 used += ssnprintf ( data + used, len - used,
393                                     "InitiatorName=%s%c"
394                                     "TargetName=%s%c"
395                                     "SessionType=Normal%c"
396                                     "AuthMethod=CHAP,None%c",
397                                     iscsi->initiator_iqn, 0,
398                                     iscsi->target_iqn, 0, 0, 0 );
399         }
400
401         if ( iscsi->status & ISCSI_STATUS_STRINGS_CHAP_ALGORITHM ) {
402                 used += ssnprintf ( data + used, len - used, "CHAP_A=5%c", 0 );
403         }
404         
405         if ( ( iscsi->status & ISCSI_STATUS_STRINGS_CHAP_RESPONSE ) &&
406              iscsi->username ) {
407                 used += ssnprintf ( data + used, len - used,
408                                     "CHAP_N=%s%cCHAP_R=0x",
409                                     iscsi->username, 0 );
410                 for ( i = 0 ; i < iscsi->chap.response_len ; i++ ) {
411                         used += ssnprintf ( data + used, len - used, "%02x",
412                                             iscsi->chap.response[i] );
413                 }
414                 used += ssnprintf ( data + used, len - used, "%c", 0 );
415         }
416
417         if ( iscsi->status & ISCSI_STATUS_STRINGS_OPERATIONAL ) {
418                 used += ssnprintf ( data + used, len - used,
419                                     "HeaderDigest=None%c"
420                                     "DataDigest=None%c"
421                                     "InitialR2T=Yes%c"
422                                     "DefaultTime2Wait=0%c"
423                                     "DefaultTime2Retain=0%c"
424                                     "MaxOutstandingR2T=1%c"
425                                     "DataPDUInOrder=Yes%c"
426                                     "DataSequenceInOrder=Yes%c"
427                                     "ErrorRecoveryLevel=0%c",
428                                     0, 0, 0, 0, 0, 0, 0, 0, 0 );
429         }
430
431         return used;
432 }
433
434 /**
435  * Build iSCSI login request BHS
436  *
437  * @v iscsi             iSCSI session
438  */
439 static void iscsi_start_login ( struct iscsi_session *iscsi ) {
440         struct iscsi_bhs_login_request *request = &iscsi->tx_bhs.login_request;
441         int len;
442
443         /* Construct BHS and initiate transmission */
444         iscsi_start_tx ( iscsi );
445         request->opcode = ( ISCSI_OPCODE_LOGIN_REQUEST |
446                             ISCSI_FLAG_IMMEDIATE );
447         request->flags = ( ( iscsi->status & ISCSI_STATUS_PHASE_MASK ) |
448                            ISCSI_LOGIN_FLAG_TRANSITION );
449         /* version_max and version_min left as zero */
450         len = iscsi_build_login_request_strings ( iscsi, NULL, 0 );
451         ISCSI_SET_LENGTHS ( request->lengths, 0, len );
452         request->isid_iana_en = htonl ( ISCSI_ISID_IANA |
453                                         IANA_EN_FEN_SYSTEMS );
454         /* isid_iana_qual left as zero */
455         request->tsih = htons ( iscsi->tsih );
456         request->itt = htonl ( iscsi->itt );
457         /* cid left as zero */
458         request->cmdsn = htonl ( iscsi->cmdsn );
459         request->expstatsn = htonl ( iscsi->statsn + 1 );
460 }
461
462 /**
463  * Complete iSCSI login request PDU transmission
464  *
465  * @v iscsi             iSCSI session
466  *
467  */
468 static void iscsi_login_request_done ( struct iscsi_session *iscsi ) {
469
470         /* Clear any "strings to send" flags */
471         iscsi->status &= ~ISCSI_STATUS_STRINGS_MASK;
472
473         /* Free any dynamically allocated storage used for login */
474         chap_finish ( &iscsi->chap );
475 }
476
477 /**
478  * Transmit data segment of an iSCSI login request PDU
479  *
480  * @v iscsi             iSCSI session
481  * @v buf               Temporary data buffer
482  * @v len               Length of temporary data buffer
483  *
484  * For login requests, the data segment consists of the login strings.
485  */
486 static void iscsi_tx_login_request ( struct iscsi_session *iscsi,
487                                      void *buf, size_t len ) {
488         len = iscsi_build_login_request_strings ( iscsi, buf, len );
489         stream_send ( &iscsi->stream, buf + iscsi->tx_offset,
490                    len - iscsi->tx_offset );
491 }
492
493 /**
494  * Handle iSCSI TargetAddress text value
495  *
496  * @v iscsi             iSCSI session
497  * @v value             TargetAddress value
498  */
499 static void iscsi_handle_targetaddress_value ( struct iscsi_session *iscsi,
500                                                const char *value ) {
501         struct in_addr address;
502         struct sockaddr_in *sin = ( struct sockaddr_in * ) &iscsi->target;
503
504         if ( inet_aton ( value, &address ) == 0 ) {
505                 DBGC ( iscsi, "iSCSI %p received invalid TargetAddress "
506                        "\"%s\"\n", iscsi, value );
507                 return;
508         }
509
510         DBGC ( iscsi, "iSCSI %p will redirect to %s\n", iscsi, value );
511         sin->sin_addr = address;
512 }
513
514 /**
515  * Handle iSCSI AuthMethod text value
516  *
517  * @v iscsi             iSCSI session
518  * @v value             AuthMethod value
519  */
520 static void iscsi_handle_authmethod_value ( struct iscsi_session *iscsi,
521                                             const char *value ) {
522
523         /* If server requests CHAP, send the CHAP_A string */
524         if ( strcmp ( value, "CHAP" ) == 0 ) {
525                 DBGC ( iscsi, "iSCSI %p initiating CHAP authentication\n",
526                        iscsi );
527                 iscsi->status |= ISCSI_STATUS_STRINGS_CHAP_ALGORITHM;
528         }
529 }
530
531 /**
532  * Handle iSCSI CHAP_A text value
533  *
534  * @v iscsi             iSCSI session
535  * @v value             CHAP_A value
536  */
537 static void iscsi_handle_chap_a_value ( struct iscsi_session *iscsi,
538                                         const char *value ) {
539         int rc;
540
541         /* We only ever offer "5" (i.e. MD5) as an algorithm, so if
542          * the server responds with anything else it is a protocol
543          * violation.
544          */
545         if ( strcmp ( value, "5" ) != 0 ) {
546                 DBGC ( iscsi, "iSCSI %p got invalid CHAP algorithm \"%s\"\n",
547                        iscsi, value );
548         }
549
550         /* Prepare for CHAP with MD5 */
551         if ( ( rc = chap_init ( &iscsi->chap, &md5_algorithm ) ) != 0 ) {
552                 DBGC ( iscsi, "iSCSI %p could not initialise CHAP: %s\n",
553                        iscsi, strerror ( rc ) );
554                 iscsi_close ( iscsi );
555                 iscsi_done ( iscsi, rc );
556         }
557 }
558
559 /**
560  * Handle iSCSI CHAP_I text value
561  *
562  * @v iscsi             iSCSI session
563  * @v value             CHAP_I value
564  */
565 static void iscsi_handle_chap_i_value ( struct iscsi_session *iscsi,
566                                         const char *value ) {
567         unsigned int identifier;
568         char *endp;
569
570         /* The CHAP identifier is an integer value */
571         identifier = strtoul ( value, &endp, 0 );
572         if ( *endp != '\0' ) {
573                 DBGC ( iscsi, "iSCSI %p saw invalid CHAP identifier \"%s\"\n",
574                        iscsi, value );
575         }
576
577         /* Identifier and secret are the first two components of the
578          * challenge.
579          */
580         chap_set_identifier ( &iscsi->chap, identifier );
581         if ( iscsi->password ) {
582                 chap_update ( &iscsi->chap, iscsi->password,
583                               strlen ( iscsi->password ) );
584         }
585 }
586
587 /**
588  * Handle iSCSI CHAP_C text value
589  *
590  * @v iscsi             iSCSI session
591  * @v value             CHAP_C value
592  */
593 static void iscsi_handle_chap_c_value ( struct iscsi_session *iscsi,
594                                         const char *value ) {
595         char buf[3];
596         char *endp;
597         uint8_t byte;
598
599         /* Check and strip leading "0x" */
600         if ( ( value[0] != '0' ) || ( value[1] != 'x' ) ) {
601                 DBGC ( iscsi, "iSCSI %p saw invalid CHAP challenge \"%s\"\n",
602                        iscsi, value );
603         }
604         value += 2;
605
606         /* Process challenge an octet at a time */
607         for ( ; ( value[0] && value[1] ) ; value += 2 ) {
608                 memcpy ( buf, value, 2 );
609                 buf[3] = 0;
610                 byte = strtoul ( buf, &endp, 16 );
611                 if ( *endp != '\0' ) {
612                         DBGC ( iscsi, "iSCSI %p saw invalid CHAP challenge "
613                                "byte \"%s\"\n", iscsi, buf );
614                 }
615                 chap_update ( &iscsi->chap, &byte, sizeof ( byte ) );
616         }
617
618         /* Build CHAP response */
619         DBGC ( iscsi, "iSCSI %p sending CHAP response\n", iscsi );
620         chap_respond ( &iscsi->chap );
621         iscsi->status |= ISCSI_STATUS_STRINGS_CHAP_RESPONSE;
622 }
623
624 /** An iSCSI text string that we want to handle */
625 struct iscsi_string_type {
626         /** String key
627          *
628          * This is the portion up to and including the "=" sign,
629          * e.g. "InitiatorName=", "CHAP_A=", etc.
630          */
631         const char *key;
632         /** Handle iSCSI string value
633          *
634          * @v iscsi             iSCSI session
635          * @v value             iSCSI string value
636          */
637         void ( * handle_value ) ( struct iscsi_session *iscsi,
638                                   const char *value );
639 };
640
641 /** iSCSI text strings that we want to handle */
642 struct iscsi_string_type iscsi_string_types[] = {
643         { "TargetAddress=", iscsi_handle_targetaddress_value },
644         { "AuthMethod=", iscsi_handle_authmethod_value },
645         { "CHAP_A=", iscsi_handle_chap_a_value },
646         { "CHAP_I=", iscsi_handle_chap_i_value },
647         { "CHAP_C=", iscsi_handle_chap_c_value },
648         { NULL, NULL }
649 };
650
651 /**
652  * Handle iSCSI string
653  *
654  * @v iscsi             iSCSI session
655  * @v string            iSCSI string (in "key=value" format)
656  */
657 static void iscsi_handle_string ( struct iscsi_session *iscsi,
658                                   const char *string ) {
659         struct iscsi_string_type *type;
660         size_t key_len;
661
662         for ( type = iscsi_string_types ; type->key ; type++ ) {
663                 key_len = strlen ( type->key );
664                 if ( strncmp ( string, type->key, key_len ) == 0 ) {
665                         DBGC ( iscsi, "iSCSI %p handling %s\n",
666                                iscsi, string );
667                         type->handle_value ( iscsi, ( string + key_len ) );
668                         return;
669                 }
670         }
671         DBGC ( iscsi, "iSCSI %p ignoring %s\n", iscsi, string );
672 }
673
674 /**
675  * Handle iSCSI strings
676  *
677  * @v iscsi             iSCSI session
678  * @v string            iSCSI string buffer
679  * @v len               Length of string buffer
680  */
681 static void iscsi_handle_strings ( struct iscsi_session *iscsi,
682                                    const char *strings, size_t len ) {
683         size_t string_len;
684
685         /* Handle each string in turn, taking care not to overrun the
686          * data buffer in case of badly-terminated data.
687          */
688         while ( 1 ) {
689                 string_len = ( strnlen ( strings, len ) + 1 );
690                 if ( string_len > len )
691                         break;
692                 iscsi_handle_string ( iscsi, strings );
693                 strings += string_len;
694                 len -= string_len;
695         }
696 }
697
698 /**
699  * Receive data segment of an iSCSI login response PDU
700  *
701  * @v iscsi             iSCSI session
702  * @v data              Received data
703  * @v len               Length of received data
704  * @v remaining         Data remaining after this data
705  * 
706  */
707 static void iscsi_rx_login_response ( struct iscsi_session *iscsi, void *data,
708                                       size_t len, size_t remaining ) {
709         struct iscsi_bhs_login_response *response
710                 = &iscsi->rx_bhs.login_response;
711         int rc;
712
713         /* Buffer up the PDU data */
714         if ( ( rc = iscsi_rx_buffered_data ( iscsi, data, len ) ) != 0 ) {
715                 DBGC ( iscsi, "iSCSI %p could not buffer login response: %s\n",
716                        iscsi, strerror ( rc ) );
717                 iscsi_close ( iscsi );
718                 iscsi_done ( iscsi, rc );
719                 return;
720         }
721         if ( remaining )
722                 return;
723
724         /* Process string data and discard string buffer */
725         iscsi_handle_strings ( iscsi, iscsi->rx_buffer, iscsi->rx_len );
726         iscsi_rx_buffered_data_done ( iscsi );
727
728         /* Check for login redirection */
729         if ( response->status_class == ISCSI_STATUS_REDIRECT ) {
730                 DBGC ( iscsi, "iSCSI %p redirecting to new server\n", iscsi );
731                 iscsi_close ( iscsi );
732                 if ( ( rc = tcp_open ( &iscsi->stream ) ) != 0 ) {
733                         DBGC ( iscsi, "iSCSI %p could not open stream: %s\n ",
734                                iscsi, strerror ( rc ) );
735                         iscsi_done ( iscsi, rc );
736                         return;
737                 }
738                 if ( ( rc = stream_connect ( &iscsi->stream,
739                                              &iscsi->target ) != 0 ) != 0 ) {
740                         DBGC ( iscsi, "iSCSI %p could not connect: %s\n ",
741                                iscsi, strerror ( rc ) );
742                         iscsi_done ( iscsi, rc );
743                         return;
744                 }
745                 return;
746         }
747
748         /* Check for fatal errors */
749         if ( response->status_class != 0 ) {
750                 DBGC ( iscsi, "iSCSI login failure: class %02x detail %02x\n",
751                        response->status_class, response->status_detail );
752                 iscsi->instant_rc = -EPERM;
753                 iscsi_close ( iscsi );
754                 iscsi_done ( iscsi, -EPERM );
755                 return;
756         }
757
758         /* Handle login transitions */
759         if ( response->flags & ISCSI_LOGIN_FLAG_TRANSITION ) {
760                 switch ( response->flags & ISCSI_LOGIN_NSG_MASK ) {
761                 case ISCSI_LOGIN_NSG_OPERATIONAL_NEGOTIATION:
762                         iscsi->status =
763                                 ( ISCSI_STATUS_OPERATIONAL_NEGOTIATION_PHASE |
764                                   ISCSI_STATUS_STRINGS_OPERATIONAL );
765                         break;
766                 case ISCSI_LOGIN_NSG_FULL_FEATURE_PHASE:
767                         iscsi->status = ISCSI_STATUS_FULL_FEATURE_PHASE;
768                         break;
769                 default:
770                         DBGC ( iscsi, "iSCSI %p got invalid response flags "
771                                "%02x\n", iscsi, response->flags );
772                         iscsi_close ( iscsi );
773                         iscsi_done ( iscsi, -EIO );
774                         return;
775                 }
776         }
777
778         /* Send next login request PDU if we haven't reached the full
779          * feature phase yet.
780          */
781         if ( ( iscsi->status & ISCSI_STATUS_PHASE_MASK ) !=
782              ISCSI_STATUS_FULL_FEATURE_PHASE ) {
783                 iscsi_start_login ( iscsi );
784                 return;
785         }
786
787         /* Reset retry count */
788         iscsi->retry_count = 0;
789
790         /* Record TSIH for future reference */
791         iscsi->tsih = ntohl ( response->tsih );
792         
793         /* Send the actual SCSI command */
794         iscsi_start_command ( iscsi );
795 }
796
797 /****************************************************************************
798  *
799  * iSCSI to stream interface
800  *
801  */
802
803 static inline struct iscsi_session *
804 stream_to_iscsi ( struct stream_application *app ) {
805         return container_of ( app, struct iscsi_session, stream );
806 }
807
808 /**
809  * Start up a new TX PDU
810  *
811  * @v iscsi             iSCSI session
812  *
813  * This initiates the process of sending a new PDU.  Only one PDU may
814  * be in transit at any one time.
815  */
816 static void iscsi_start_tx ( struct iscsi_session *iscsi ) {
817         assert ( iscsi->tx_state == ISCSI_TX_IDLE );
818         
819         /* Initialise TX BHS */
820         memset ( &iscsi->tx_bhs, 0, sizeof ( iscsi->tx_bhs ) );
821
822         /* Flag TX engine to start transmitting */
823         iscsi->tx_state = ISCSI_TX_BHS;
824         iscsi->tx_offset = 0;
825 }
826
827 /**
828  * Transmit data segment of an iSCSI PDU
829  *
830  * @v iscsi             iSCSI session
831  * @v buf               Temporary data buffer
832  * @v len               Length of temporary data buffer
833  * 
834  * Handle transmission of part of a PDU data segment.  iscsi::tx_bhs
835  * will be valid when this is called.
836  */
837 static void iscsi_tx_data ( struct iscsi_session *iscsi,
838                             void *buf, size_t len ) {
839         struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
840
841         switch ( common->opcode & ISCSI_OPCODE_MASK ) {
842         case ISCSI_OPCODE_DATA_OUT:
843                 iscsi_tx_data_out ( iscsi, buf, len );
844                 break;
845         case ISCSI_OPCODE_LOGIN_REQUEST:
846                 iscsi_tx_login_request ( iscsi, buf, len );
847                 break;
848         default:
849                 assert ( 0 );
850                 break;
851         }
852 }
853
854 /**
855  * Complete iSCSI PDU transmission
856  *
857  * @v iscsi             iSCSI session
858  *
859  * Called when a PDU has been completely transmitted and the TX state
860  * machine is about to enter the idle state.  iscsi::tx_bhs will be
861  * valid for the just-completed PDU when this is called.
862  */
863 static void iscsi_tx_done ( struct iscsi_session *iscsi ) {
864         struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
865
866         switch ( common->opcode & ISCSI_OPCODE_MASK ) {
867         case ISCSI_OPCODE_DATA_OUT:
868                 iscsi_data_out_done ( iscsi );
869         case ISCSI_OPCODE_LOGIN_REQUEST:
870                 iscsi_login_request_done ( iscsi );
871         default:
872                 /* No action */
873                 break;
874         }
875 }
876
877 /**
878  * Handle stream ACKs
879  *
880  * @v iscsi             iSCSI session
881  * 
882  * Updates iscsi->tx_offset and, if applicable, transitions to the
883  * next TX state.
884  */
885 static void iscsi_acked ( struct stream_application *app, size_t len ) {
886         struct iscsi_session *iscsi = stream_to_iscsi ( app );
887         struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
888         enum iscsi_tx_state next_state;
889         
890         iscsi->tx_offset += len;
891         while ( 1 ) {
892                 switch ( iscsi->tx_state ) {
893                 case ISCSI_TX_BHS:
894                         iscsi->tx_len = sizeof ( iscsi->tx_bhs );
895                         next_state = ISCSI_TX_AHS;
896                         break;
897                 case ISCSI_TX_AHS:
898                         iscsi->tx_len = 4 * ISCSI_AHS_LEN ( common->lengths );
899                         next_state = ISCSI_TX_DATA;
900                         break;
901                 case ISCSI_TX_DATA:
902                         iscsi->tx_len = ISCSI_DATA_LEN ( common->lengths );
903                         next_state = ISCSI_TX_DATA_PADDING;
904                         break;
905                 case ISCSI_TX_DATA_PADDING:
906                         iscsi->tx_len = ISCSI_DATA_PAD_LEN ( common->lengths );
907                         next_state = ISCSI_TX_IDLE;
908                         break;
909                 case ISCSI_TX_IDLE:
910                         return;
911                 default:
912                         assert ( 0 );
913                         return;
914                 }
915                 assert ( iscsi->tx_offset <= iscsi->tx_len );
916
917                 /* If the whole of the current portion has not yet
918                  * been acked, stay in this state for now.
919                  */
920                 if ( iscsi->tx_offset != iscsi->tx_len )
921                         return;
922
923                 /* Move to next state.  Call iscsi_tx_done() when PDU
924                  * transmission is complete.
925                  */
926                 iscsi->tx_state = next_state;
927                 iscsi->tx_offset = 0;
928                 if ( next_state == ISCSI_TX_IDLE )
929                         iscsi_tx_done ( iscsi );
930         }
931 }
932
933 /**
934  * Transmit iSCSI PDU
935  *
936  * @v iscsi             iSCSI session
937  * @v buf               Temporary data buffer
938  * @v len               Length of temporary data buffer
939  * 
940  * Constructs data to be sent for the current TX state
941  */
942 static void iscsi_senddata ( struct stream_application *app,
943                              void *buf, size_t len ) {
944         struct iscsi_session *iscsi = stream_to_iscsi ( app );
945         struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
946         static const char pad[] = { '\0', '\0', '\0' };
947
948         switch ( iscsi->tx_state ) {
949         case ISCSI_TX_IDLE:
950                 /* Nothing to send */
951                 break;
952         case ISCSI_TX_BHS:
953                 stream_send ( app, &iscsi->tx_bhs.bytes[iscsi->tx_offset],
954                            ( sizeof ( iscsi->tx_bhs ) - iscsi->tx_offset ) );
955                 break;
956         case ISCSI_TX_AHS:
957                 /* We don't yet have an AHS transmission mechanism */
958                 assert ( 0 );
959                 break;
960         case ISCSI_TX_DATA:
961                 iscsi_tx_data ( iscsi, buf, len );
962                 break;
963         case ISCSI_TX_DATA_PADDING:
964                 stream_send ( app, pad, ( ISCSI_DATA_PAD_LEN( common->lengths )
965                                           - iscsi->tx_offset ) );
966                 break;
967         default:
968                 assert ( 0 );
969                 break;
970         }
971 }
972
973 /**
974  * Receive data segment of an iSCSI PDU
975  *
976  * @v iscsi             iSCSI session
977  * @v data              Received data
978  * @v len               Length of received data
979  * @v remaining         Data remaining after this data
980  *
981  * Handle processing of part of a PDU data segment.  iscsi::rx_bhs
982  * will be valid when this is called.
983  */
984 static void iscsi_rx_data ( struct iscsi_session *iscsi, void *data,
985                             size_t len, size_t remaining ) {
986         struct iscsi_bhs_common_response *response
987                 = &iscsi->rx_bhs.common_response;
988
989         /* Update cmdsn and statsn */
990         iscsi->cmdsn = ntohl ( response->expcmdsn );
991         iscsi->statsn = ntohl ( response->statsn );
992
993         switch ( response->opcode & ISCSI_OPCODE_MASK ) {
994         case ISCSI_OPCODE_LOGIN_RESPONSE:
995                 iscsi_rx_login_response ( iscsi, data, len, remaining );
996                 break;
997         case ISCSI_OPCODE_SCSI_RESPONSE:
998                 iscsi_rx_scsi_response ( iscsi, data, len, remaining );
999                 break;
1000         case ISCSI_OPCODE_DATA_IN:
1001                 iscsi_rx_data_in ( iscsi, data, len, remaining );
1002                 break;
1003         case ISCSI_OPCODE_R2T:
1004                 iscsi_rx_r2t ( iscsi, data, len, remaining );
1005                 break;
1006         default:
1007                 if ( remaining )
1008                         return;
1009                 DBGC ( iscsi, "iSCSI %p unknown opcode %02x\n", iscsi,
1010                        response->opcode );
1011                 iscsi_close ( iscsi );
1012                 iscsi_done ( iscsi, -EOPNOTSUPP );
1013                 break;
1014         }
1015 }
1016
1017 /**
1018  * Discard portion of an iSCSI PDU.
1019  *
1020  * @v iscsi             iSCSI session
1021  * @v data              Received data
1022  * @v len               Length of received data
1023  * @v remaining         Data remaining after this data
1024  *
1025  * This discards data from a portion of a received PDU.
1026  */
1027 static void iscsi_rx_discard ( struct iscsi_session *iscsi __unused,
1028                                void *data __unused, size_t len __unused,
1029                                size_t remaining __unused ) {
1030         /* Do nothing */
1031 }
1032
1033 /**
1034  * Receive basic header segment of an iSCSI PDU
1035  *
1036  * @v iscsi             iSCSI session
1037  * @v data              Received data
1038  * @v len               Length of received data
1039  * @v remaining         Data remaining after this data
1040  *
1041  * This fills in iscsi::rx_bhs with the data from the BHS portion of
1042  * the received PDU.
1043  */
1044 static void iscsi_rx_bhs ( struct iscsi_session *iscsi, void *data,
1045                            size_t len, size_t remaining __unused ) {
1046         memcpy ( &iscsi->rx_bhs.bytes[iscsi->rx_offset], data, len );
1047         if ( ( iscsi->rx_offset + len ) >= sizeof ( iscsi->rx_bhs ) ) {
1048                 DBGC ( iscsi, "iSCSI %p received PDU opcode %#x len %#lx\n",
1049                        iscsi, iscsi->rx_bhs.common.opcode,
1050                        ISCSI_DATA_LEN ( iscsi->rx_bhs.common.lengths ) );
1051         }
1052 }
1053
1054 /**
1055  * Receive new data
1056  *
1057  * @v stream            Stream application
1058  * @v data              Received data
1059  * @v len               Length of received data
1060  *
1061  * This handles received PDUs.  The receive strategy is to fill in
1062  * iscsi::rx_bhs with the contents of the BHS portion of the PDU,
1063  * throw away any AHS portion, and then process each part of the data
1064  * portion as it arrives.  The data processing routine therefore
1065  * always has a full copy of the BHS available, even for portions of
1066  * the data in different packets to the BHS.
1067  */
1068 static void iscsi_newdata ( struct stream_application *app, void *data,
1069                             size_t len ) {
1070         struct iscsi_session *iscsi = stream_to_iscsi ( app );
1071         struct iscsi_bhs_common *common = &iscsi->rx_bhs.common;
1072         void ( *process ) ( struct iscsi_session *iscsi, void *data,
1073                             size_t len, size_t remaining );
1074         enum iscsi_rx_state next_state;
1075         size_t frag_len;
1076         size_t remaining;
1077
1078         while ( 1 ) {
1079                 switch ( iscsi->rx_state ) {
1080                 case ISCSI_RX_BHS:
1081                         process = iscsi_rx_bhs;
1082                         iscsi->rx_len = sizeof ( iscsi->rx_bhs );
1083                         next_state = ISCSI_RX_AHS;                      
1084                         break;
1085                 case ISCSI_RX_AHS:
1086                         process = iscsi_rx_discard;
1087                         iscsi->rx_len = 4 * ISCSI_AHS_LEN ( common->lengths );
1088                         next_state = ISCSI_RX_DATA;
1089                         break;
1090                 case ISCSI_RX_DATA:
1091                         process = iscsi_rx_data;
1092                         iscsi->rx_len = ISCSI_DATA_LEN ( common->lengths );
1093                         next_state = ISCSI_RX_DATA_PADDING;
1094                         break;
1095                 case ISCSI_RX_DATA_PADDING:
1096                         process = iscsi_rx_discard;
1097                         iscsi->rx_len = ISCSI_DATA_PAD_LEN ( common->lengths );
1098                         next_state = ISCSI_RX_BHS;
1099                         break;
1100                 default:
1101                         assert ( 0 );
1102                         return;
1103                 }
1104
1105                 frag_len = iscsi->rx_len - iscsi->rx_offset;
1106                 if ( frag_len > len )
1107                         frag_len = len;
1108                 remaining = iscsi->rx_len - iscsi->rx_offset - frag_len;
1109                 process ( iscsi, data, frag_len, remaining );
1110
1111                 iscsi->rx_offset += frag_len;
1112                 data += frag_len;
1113                 len -= frag_len;
1114
1115                 /* If all the data for this state has not yet been
1116                  * received, stay in this state for now.
1117                  */
1118                 if ( iscsi->rx_offset != iscsi->rx_len )
1119                         return;
1120
1121                 iscsi->rx_state = next_state;
1122                 iscsi->rx_offset = 0;
1123         }
1124 }
1125
1126 /**
1127  * Handle stream connection closure
1128  *
1129  * @v app               Stream application
1130  * @v status            Error code, if any
1131  *
1132  */
1133 static void iscsi_closed ( struct stream_application *app, int status ) {
1134         struct iscsi_session *iscsi = stream_to_iscsi ( app );
1135         int rc;
1136
1137         /* Even a graceful close counts as an error for iSCSI */
1138         if ( ! status )
1139                 status = -ECONNRESET;
1140
1141         /* Close session cleanly */
1142         iscsi_close ( iscsi );
1143
1144         /* Retry connection if within the retry limit, otherwise fail */
1145         if ( ++iscsi->retry_count <= ISCSI_MAX_RETRIES ) {
1146                 DBGC ( iscsi, "iSCSI %p retrying connection (retry #%d)\n",
1147                        iscsi, iscsi->retry_count );
1148                 if ( ( rc = tcp_open ( app ) ) != 0 ) {
1149                         DBGC ( iscsi, "iSCSI %p could not open stream: %s\n ",
1150                                iscsi, strerror ( rc ) );
1151                         iscsi_done ( iscsi, rc );
1152                         return;
1153                 }
1154                 if ( ( rc = stream_connect ( app, &iscsi->target ) ) != 0 ){
1155                         DBGC ( iscsi, "iSCSI %p could not connect: %s\n",
1156                                iscsi, strerror ( rc ) );
1157                         iscsi_done ( iscsi, rc );
1158                         return;
1159                 }
1160         } else {
1161                 DBGC ( iscsi, "iSCSI %p retry count exceeded\n", iscsi );
1162                 iscsi->instant_rc = status;
1163                 iscsi_done ( iscsi, status );
1164                 return;
1165         }
1166 }
1167
1168 /**
1169  * Handle stream connection opening
1170  *
1171  * @v app               Stream application
1172  *
1173  */
1174 static void iscsi_connected ( struct stream_application *app ) {
1175         struct iscsi_session *iscsi = stream_to_iscsi ( app );
1176
1177         assert ( iscsi->rx_state == ISCSI_RX_BHS );
1178         assert ( iscsi->rx_offset == 0 );
1179
1180         /* Enter security negotiation phase */
1181         iscsi->status = ( ISCSI_STATUS_SECURITY_NEGOTIATION_PHASE |
1182                           ISCSI_STATUS_STRINGS_SECURITY );
1183
1184         /* Assign fresh initiator task tag */
1185         iscsi->itt++;
1186
1187         /* Start logging in */
1188         iscsi_start_login ( iscsi );
1189 }
1190
1191 /** iSCSI stream operations */
1192 static struct stream_application_operations iscsi_stream_operations = {
1193         .closed         = iscsi_closed,
1194         .connected      = iscsi_connected,
1195         .acked          = iscsi_acked,
1196         .newdata        = iscsi_newdata,
1197         .senddata       = iscsi_senddata,
1198 };
1199
1200 /**
1201  * Issue SCSI command via iSCSI session
1202  *
1203  * @v iscsi             iSCSI session
1204  * @v command           SCSI command
1205  * @v parent            Parent asynchronous operation
1206  * @ret rc              Return status code
1207  */
1208 int iscsi_issue ( struct iscsi_session *iscsi, struct scsi_command *command,
1209                   struct async *parent ) {
1210         int rc;
1211
1212         assert ( iscsi->command == NULL );
1213         iscsi->command = command;
1214
1215         if ( iscsi->instant_rc ) {
1216                 /* Abort immediately rather than retrying */
1217                 return iscsi->instant_rc;
1218         } else if ( iscsi->status ) {
1219                 /* Session already open: issue command */
1220                 iscsi_start_command ( iscsi );
1221                 stream_kick ( &iscsi->stream );
1222         } else {
1223                 /* Session not open: initiate login */
1224                 iscsi->stream.op = &iscsi_stream_operations;
1225                 if ( ( rc = tcp_open ( &iscsi->stream ) ) != 0 ) {
1226                         DBGC ( iscsi, "iSCSI %p could not open stream: %s\n ",
1227                                iscsi, strerror ( rc ) );
1228                         return rc;
1229                 }
1230                 if ( ( rc = stream_connect ( &iscsi->stream,
1231                                              &iscsi->target ) ) != 0 ) {
1232                         DBGC ( iscsi, "iSCSI %p could not connect: %s\n",
1233                                iscsi, strerror ( rc ) );
1234                         return rc;
1235                 }
1236         }
1237
1238         async_init ( &iscsi->async, &default_async_operations, parent );
1239         return 0;
1240 }
1241
1242 /**
1243  * Close down iSCSI session
1244  *
1245  * @v iscsi             iSCSI session
1246  * @ret aop             Asynchronous operation
1247  */
1248 void iscsi_shutdown ( struct iscsi_session *iscsi ) {
1249         iscsi_close ( iscsi );
1250 }