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