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