9412373f1e3188d9993f90b0db0c98e51ae603be
[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 <vsprintf.h>
22 #include <errno.h>
23 #include <assert.h>
24 #include <byteswap.h>
25 #include <gpxe/scsi.h>
26 #include <gpxe/process.h>
27 #include <gpxe/uaccess.h>
28 #include <gpxe/iscsi.h>
29
30 /** @file
31  *
32  * iSCSI protocol
33  *
34  */
35
36 static void iscsi_start_tx ( struct iscsi_session *iscsi );
37 static void iscsi_start_data_out ( struct iscsi_session *iscsi,
38                                    unsigned int datasn );
39
40 /****************************************************************************
41  *
42  * iSCSI SCSI command issuing
43  *
44  */
45
46 /**
47  * Build iSCSI SCSI command BHS
48  *
49  * @v iscsi             iSCSI session
50  *
51  * We don't currently support bidirectional commands (i.e. with both
52  * Data-In and Data-Out segments); these would require providing code
53  * to generate an AHS, and there doesn't seem to be any need for it at
54  * the moment.
55  */
56 static void iscsi_start_command ( struct iscsi_session *iscsi ) {
57         struct iscsi_bhs_scsi_command *command = &iscsi->tx_bhs.scsi_command;
58
59         assert ( ! ( iscsi->command->data_in && iscsi->command->data_out ) );
60
61         /* Construct BHS and initiate transmission */
62         iscsi_start_tx ( iscsi );
63         command->opcode = ISCSI_OPCODE_SCSI_COMMAND;
64         command->flags = ( ISCSI_FLAG_FINAL |
65                            ISCSI_COMMAND_ATTR_SIMPLE );
66         if ( iscsi->command->data_in )
67                 command->flags |= ISCSI_COMMAND_FLAG_READ;
68         if ( iscsi->command->data_out )
69                 command->flags |= ISCSI_COMMAND_FLAG_WRITE;
70         /* lengths left as zero */
71         command->lun = iscsi->lun;
72         command->itt = htonl ( ++iscsi->itt );
73         command->exp_len = htonl ( iscsi->command->data_in_len |
74                                    iscsi->command->data_out_len );
75         command->cmdsn = htonl ( iscsi->cmdsn );
76         command->expstatsn = htonl ( iscsi->statsn + 1 );
77         memcpy ( &command->cdb, &iscsi->command->cdb, sizeof ( command->cdb ));
78         DBG ( "iSCSI %p start " SCSI_CDB_FORMAT " %s %#x\n",
79               iscsi, SCSI_CDB_DATA ( command->cdb ),
80               ( iscsi->command->data_in ? "in" : "out" ),
81               ( iscsi->command->data_in ?
82                 iscsi->command->data_in_len : iscsi->command->data_out_len ) );
83 }
84
85 /**
86  * Receive data segment of an iSCSI SCSI response PDU
87  *
88  * @v iscsi             iSCSI session
89  * @v data              Received data
90  * @v len               Length of received data
91  * @v remaining         Data remaining after this data
92  * 
93  */
94 static void iscsi_rx_scsi_response ( struct iscsi_session *iscsi, void *data,
95                                      size_t len, size_t remaining ) {
96         struct iscsi_bhs_scsi_response *response
97                 = &iscsi->rx_bhs.scsi_response;
98         int sense_offset;
99
100         /* Capture the sense response code as it floats past, if present */
101         sense_offset = ISCSI_SENSE_RESPONSE_CODE_OFFSET - iscsi->rx_offset;
102         if ( ( sense_offset >= 0 ) && len ) {
103                 iscsi->command->sense_response =
104                         * ( ( char * ) data + sense_offset );
105         }
106
107         /* Wait for whole SCSI response to arrive */
108         if ( remaining )
109                 return;
110         
111         /* Record SCSI status code */
112         iscsi->command->status = response->status;
113
114         /* Mark as completed, with error if applicable */
115         iscsi->status |= ISCSI_STATUS_DONE;
116         if ( response->response != ISCSI_RESPONSE_COMMAND_COMPLETE )
117                 iscsi->status |= ISCSI_STATUS_ERR;
118 }
119
120 /**
121  * Receive data segment of an iSCSI data-in PDU
122  *
123  * @v iscsi             iSCSI session
124  * @v data              Received data
125  * @v len               Length of received data
126  * @v remaining         Data remaining after this data
127  * 
128  */
129 static void iscsi_rx_data_in ( struct iscsi_session *iscsi, void *data,
130                                size_t len, size_t remaining __unused ) {
131         struct iscsi_bhs_data_in *data_in = &iscsi->rx_bhs.data_in;
132         unsigned long offset;
133
134         /* Copy data to data-in buffer */
135         offset = ntohl ( data_in->offset ) + iscsi->rx_offset;
136         assert ( iscsi->command != NULL );
137         assert ( iscsi->command->data_in );
138         assert ( ( offset + len ) <= iscsi->command->data_in_len );
139         copy_to_user ( iscsi->command->data_in, offset, data, len );
140
141         /* Record SCSI status, if present */
142         if ( data_in->flags & ISCSI_DATA_FLAG_STATUS )
143                 iscsi->command->status = data_in->status;
144
145         /* If this is the end, flag as complete */
146         if ( ( offset + len ) == iscsi->command->data_in_len ) {
147                 assert ( data_in->flags & ISCSI_FLAG_FINAL );
148                 assert ( remaining == 0 );
149                 iscsi->status |= ISCSI_STATUS_DONE;
150         }
151 }
152
153 /**
154  * Receive data segment of an iSCSI R2T PDU
155  *
156  * @v iscsi             iSCSI session
157  * @v data              Received data
158  * @v len               Length of received data
159  * @v remaining         Data remaining after this data
160  * 
161  */
162 static void iscsi_rx_r2t ( struct iscsi_session *iscsi, void *data __unused,
163                            size_t len __unused, size_t remaining __unused ) {
164         struct iscsi_bhs_r2t *r2t = &iscsi->rx_bhs.r2t;
165
166         /* Record transfer parameters and trigger first data-out */
167         iscsi->ttt = ntohl ( r2t->ttt );
168         iscsi->transfer_offset = ntohl ( r2t->offset );
169         iscsi->transfer_len = ntohl ( r2t->len );
170         iscsi_start_data_out ( iscsi, 0 );
171 }
172
173 /**
174  * Build iSCSI data-out BHS
175  *
176  * @v iscsi             iSCSI session
177  * @v datasn            Data sequence number within the transfer
178  *
179  */
180 static void iscsi_start_data_out ( struct iscsi_session *iscsi,
181                                    unsigned int datasn ) {
182         struct iscsi_bhs_data_out *data_out = &iscsi->tx_bhs.data_out;
183         unsigned long offset;
184         unsigned long remaining;
185         unsigned long len;
186
187         /* We always send 512-byte Data-Out PDUs; this removes the
188          * need to worry about the target's MaxRecvDataSegmentLength.
189          */
190         offset = datasn * 512;
191         remaining = iscsi->transfer_len - offset;
192         len = remaining;
193         if ( len > 512 )
194                 len = 512;
195
196         /* Construct BHS and initiate transmission */
197         iscsi_start_tx ( iscsi );
198         data_out->opcode = ISCSI_OPCODE_DATA_OUT;
199         if ( len == remaining )
200                 data_out->flags = ( ISCSI_FLAG_FINAL );
201         ISCSI_SET_LENGTHS ( data_out->lengths, 0, len );
202         data_out->lun = iscsi->lun;
203         data_out->itt = htonl ( iscsi->itt );
204         data_out->ttt = htonl ( iscsi->ttt );
205         data_out->expstatsn = htonl ( iscsi->statsn + 1 );
206         data_out->datasn = htonl ( datasn );
207         data_out->offset = htonl ( iscsi->transfer_offset + offset );
208         DBG ( "iSCSI %p start data out DataSN %#x len %#lx\n",
209               iscsi, datasn, len );
210 }
211
212 /**
213  * Complete iSCSI data-out PDU transmission
214  *
215  * @v iscsi             iSCSI session
216  *
217  */
218 static void iscsi_data_out_done ( struct iscsi_session *iscsi ) {
219         struct iscsi_bhs_data_out *data_out = &iscsi->tx_bhs.data_out;
220
221         /* If we haven't reached the end of the sequence, start
222          * sending the next data-out PDU.
223          */
224         if ( ! ( data_out->flags & ISCSI_FLAG_FINAL ) )
225                 iscsi_start_data_out ( iscsi, ntohl ( data_out->datasn ) + 1 );
226 }
227
228 /**
229  * Send iSCSI data-out data segment
230  *
231  * @v iscsi             iSCSI session
232  * @v buf               Temporary data buffer
233  * @v len               Length of temporary data buffer
234  */
235 static void iscsi_tx_data_out ( struct iscsi_session *iscsi,
236                                 void *buf, size_t len ) {
237         struct iscsi_bhs_data_out *data_out = &iscsi->tx_bhs.data_out;
238         unsigned long offset;
239         unsigned long remaining;
240
241         offset = ( iscsi->transfer_offset + ntohl ( data_out->offset ) +
242                    iscsi->tx_offset );
243         remaining = ( ISCSI_DATA_LEN ( data_out->lengths ) - iscsi->tx_offset);
244         assert ( iscsi->command != NULL );
245         assert ( iscsi->command->data_out );
246         assert ( ( offset + remaining ) <= iscsi->command->data_out_len );
247         
248         if ( remaining < len )
249                 len = remaining;
250         copy_from_user ( buf, iscsi->command->data_out, offset, len );
251
252         tcp_send ( &iscsi->tcp, buf, len );
253 }
254
255 /****************************************************************************
256  *
257  * iSCSI login
258  *
259  */
260
261 /**
262  * Build iSCSI login request strings
263  *
264  * @v iscsi             iSCSI session
265  *
266  * These are the initial set of strings sent in the first login
267  * request PDU.  We want the following settings:
268  *
269  *     HeaderDigest=None
270  *     DataDigest=None
271  *     MaxConnections is irrelevant; we make only one connection anyway
272  *     InitialR2T=Yes [1]
273  *     ImmediateData is irrelevant; we never send immediate data
274  *     MaxRecvDataSegmentLength=8192 (default; we don't care)
275  *     MaxBurstLength=262144 (default; we don't care)
276  *     FirstBurstLength=262144 (default; we don't care)
277  *     DefaultTime2Wait=0 [2]
278  *     DefaultTime2Retain=0 [2]
279  *     MaxOutstandingR2T=1
280  *     DataPDUInOrder=Yes
281  *     DataSequenceInOrder=Yes
282  *     ErrorRecoveryLevel=0
283  *
284  * [1] InitialR2T has an OR resolution function, so the target may
285  * force us to use it.  We therefore simplify our logic by always
286  * using it.
287  *
288  * [2] These ensure that we can safely start a new task once we have
289  * reconnected after a failure, without having to manually tidy up
290  * after the old one.
291  */
292 static int iscsi_build_login_request_strings ( struct iscsi_session *iscsi,
293                                                void *data, size_t len ) {
294         return snprintf ( data, len,
295                           "InitiatorName=%s%c"
296                           "TargetName=%s%c"
297                           "SessionType=Normal%c"
298                           "HeaderDigest=None%c"
299                           "DataDigest=None%c"
300                           "InitialR2T=Yes%c"
301                           "DefaultTime2Wait=0%c"
302                           "DefaultTime2Retain=0%c"
303                           "MaxOutstandingR2T=1%c"
304                           "DataPDUInOrder=Yes%c"
305                           "DataSequenceInOrder=Yes%c"
306                           "ErrorRecoveryLevel=0%c",
307                           iscsi->initiator, 0, iscsi->target, 0,
308                           0, 0, 0, 0, 0, 0, 0, 0, 0, 0 );
309 }
310
311 /**
312  * Build iSCSI login request BHS
313  *
314  * @v iscsi             iSCSI session
315  * @v first             Login request is the first in a sequence
316  */
317 static void iscsi_start_login ( struct iscsi_session *iscsi, int first ) {
318         struct iscsi_bhs_login_request *request = &iscsi->tx_bhs.login_request;
319         int len;
320
321         /* Construct BHS and initiate transmission */
322         iscsi_start_tx ( iscsi );
323         request->opcode = ( ISCSI_OPCODE_LOGIN_REQUEST |
324                             ISCSI_FLAG_IMMEDIATE );
325         request->flags = ( ISCSI_LOGIN_FLAG_TRANSITION |
326                            ISCSI_LOGIN_CSG_OPERATIONAL_NEGOTIATION |
327                            ISCSI_LOGIN_NSG_FULL_FEATURE_PHASE );
328         /* version_max and version_min left as zero */
329         if ( first ) {
330                 len = iscsi_build_login_request_strings ( iscsi, NULL, 0 );
331                 ISCSI_SET_LENGTHS ( request->lengths, 0, len );
332         }
333         request->isid_iana_en = htonl ( ISCSI_ISID_IANA |
334                                         IANA_EN_FEN_SYSTEMS );
335         /* isid_iana_qual left as zero */
336         request->tsih = htons ( iscsi->tsih );
337         if ( first )
338                 iscsi->itt++;
339         request->itt = htonl ( iscsi->itt );
340         /* cid left as zero */
341         request->cmdsn = htonl ( iscsi->cmdsn );
342         request->expstatsn = htonl ( iscsi->statsn + 1 );
343 }
344
345 /**
346  * Transmit data segment of an iSCSI login request PDU
347  *
348  * @v iscsi             iSCSI session
349  * @v buf               Temporary data buffer
350  * @v len               Length of temporary data buffer
351  *
352  * For login requests, the data segment consists of the login strings.
353  */
354 static void iscsi_tx_login_request ( struct iscsi_session *iscsi,
355                                      void *buf, size_t len ) {
356         len = iscsi_build_login_request_strings ( iscsi, buf, len );
357         tcp_send ( &iscsi->tcp, buf + iscsi->tx_offset,
358                    len - iscsi->tx_offset );
359 }
360
361 /**
362  * Receive data segment of an iSCSI login response PDU
363  *
364  * @v iscsi             iSCSI session
365  * @v data              Received data
366  * @v len               Length of received data
367  * @v remaining         Data remaining after this data
368  * 
369  */
370 static void iscsi_rx_login_response ( struct iscsi_session *iscsi,
371                                       void *data __unused,
372                                       size_t len __unused,
373                                       size_t remaining __unused ) {
374         struct iscsi_bhs_login_response *response
375                 = &iscsi->rx_bhs.login_response;
376
377         /* Check for fatal errors */
378         if ( response->status_class != 0 ) {
379                 printf ( "iSCSI login failure: class %02x detail %02x\n",
380                          response->status_class, response->status_detail );
381                 iscsi->status |= ( ISCSI_STATUS_DONE | ISCSI_STATUS_ERR );
382                 tcp_close ( &iscsi->tcp );
383                 return;
384         }
385
386         /* If server did not transition, send back another login
387          * request without any login strings.
388          */
389         if ( ! ( response->flags & ISCSI_LOGIN_FLAG_TRANSITION ) ) {
390                 iscsi_start_login ( iscsi, 0 );
391                 return;
392         }
393
394         /* Record TSIH for future reference */
395         iscsi->tsih = ntohl ( response->tsih );
396         
397         /* Send the SCSI command */
398         iscsi_start_command ( iscsi );
399 }
400
401 /****************************************************************************
402  *
403  * iSCSI to TCP interface
404  *
405  */
406
407 static inline struct iscsi_session *
408 tcp_to_iscsi ( struct tcp_connection *conn ) {
409         return container_of ( conn, struct iscsi_session, tcp );
410 }
411
412 /**
413  * Start up a new TX PDU
414  *
415  * @v iscsi             iSCSI session
416  *
417  * This initiates the process of sending a new PDU.  Only one PDU may
418  * be in transit at any one time.
419  */
420 static void iscsi_start_tx ( struct iscsi_session *iscsi ) {
421         assert ( iscsi->tx_state == ISCSI_TX_IDLE );
422         
423         /* Initialise TX BHS */
424         memset ( &iscsi->tx_bhs, 0, sizeof ( iscsi->tx_bhs ) );
425
426         /* Flag TX engine to start transmitting */
427         iscsi->tx_state = ISCSI_TX_BHS;
428         iscsi->tx_offset = 0;
429 }
430
431 /**
432  * Transmit data segment of an iSCSI PDU
433  *
434  * @v iscsi             iSCSI session
435  * @v buf               Temporary data buffer
436  * @v len               Length of temporary data buffer
437  * 
438  * Handle transmission of part of a PDU data segment.  iscsi::tx_bhs
439  * will be valid when this is called.
440  */
441 static void iscsi_tx_data ( struct iscsi_session *iscsi,
442                             void *buf, size_t len ) {
443         struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
444
445         switch ( common->opcode & ISCSI_OPCODE_MASK ) {
446         case ISCSI_OPCODE_DATA_OUT:
447                 iscsi_tx_data_out ( iscsi, buf, len );
448                 break;
449         case ISCSI_OPCODE_LOGIN_REQUEST:
450                 iscsi_tx_login_request ( iscsi, buf, len );
451                 break;
452         default:
453                 assert ( 0 );
454                 break;
455         }
456 }
457
458 /**
459  * Complete iSCSI PDU transmission
460  *
461  * @v iscsi             iSCSI session
462  *
463  * Called when a PDU has been completely transmitted and the TX state
464  * machine is about to enter the idle state.  iscsi::tx_bhs will be
465  * valid for the just-completed PDU when this is called.
466  */
467 static void iscsi_tx_done ( struct iscsi_session *iscsi ) {
468         struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
469
470         switch ( common->opcode & ISCSI_OPCODE_MASK ) {
471         case ISCSI_OPCODE_DATA_OUT:
472                 iscsi_data_out_done ( iscsi );
473         default:
474                 /* No action */
475                 break;
476         }
477 }
478
479 /**
480  * Handle TCP ACKs
481  *
482  * @v iscsi             iSCSI session
483  * 
484  * Updates iscsi->tx_offset and, if applicable, transitions to the
485  * next TX state.
486  */
487 static void iscsi_acked ( struct tcp_connection *conn, size_t len ) {
488         struct iscsi_session *iscsi = tcp_to_iscsi ( conn );
489         struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
490         size_t max_tx_offset;
491         enum iscsi_tx_state next_state;
492         
493         iscsi->tx_offset += len;
494         while ( 1 ) {
495                 switch ( iscsi->tx_state ) {
496                 case ISCSI_TX_BHS:
497                         max_tx_offset = sizeof ( iscsi->tx_bhs );
498                         next_state = ISCSI_TX_AHS;
499                         break;
500                 case ISCSI_TX_AHS:
501                         max_tx_offset = 4 * ISCSI_AHS_LEN ( common->lengths );
502                         next_state = ISCSI_TX_DATA;
503                         break;
504                 case ISCSI_TX_DATA:
505                         max_tx_offset = ISCSI_DATA_LEN ( common->lengths );
506                         next_state = ISCSI_TX_DATA_PADDING;
507                         break;
508                 case ISCSI_TX_DATA_PADDING:
509                         max_tx_offset = ISCSI_DATA_PAD_LEN ( common->lengths );
510                         next_state = ISCSI_TX_IDLE;
511                         break;
512                 case ISCSI_TX_IDLE:
513                         return;
514                 default:
515                         assert ( 0 );
516                         return;
517                 }
518                 assert ( iscsi->tx_offset <= max_tx_offset );
519
520                 /* If the whole of the current portion has not yet
521                  * been acked, stay in this state for now.
522                  */
523                 if ( iscsi->tx_offset != max_tx_offset )
524                         return;
525
526                 /* Move to next state.  Call iscsi_tx_done() when PDU
527                  * transmission is complete.
528                  */
529                 iscsi->tx_state = next_state;
530                 iscsi->tx_offset = 0;
531                 if ( next_state == ISCSI_TX_IDLE )
532                         iscsi_tx_done ( iscsi );
533         }
534 }
535
536 /**
537  * Transmit iSCSI PDU
538  *
539  * @v iscsi             iSCSI session
540  * @v buf               Temporary data buffer
541  * @v len               Length of temporary data buffer
542  * 
543  * Constructs data to be sent for the current TX state
544  */
545 static void iscsi_senddata ( struct tcp_connection *conn,
546                              void *buf, size_t len ) {
547         struct iscsi_session *iscsi = tcp_to_iscsi ( conn );
548         struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
549         static const char pad[] = { '\0', '\0', '\0' };
550
551         switch ( iscsi->tx_state ) {
552         case ISCSI_TX_IDLE:
553                 /* Nothing to send */
554                 break;
555         case ISCSI_TX_BHS:
556                 tcp_send ( conn, &iscsi->tx_bhs.bytes[iscsi->tx_offset],
557                            ( sizeof ( iscsi->tx_bhs ) - iscsi->tx_offset ) );
558                 break;
559         case ISCSI_TX_AHS:
560                 /* We don't yet have an AHS transmission mechanism */
561                 assert ( 0 );
562                 break;
563         case ISCSI_TX_DATA:
564                 iscsi_tx_data ( iscsi, buf, len );
565                 break;
566         case ISCSI_TX_DATA_PADDING:
567                 tcp_send ( conn, pad, ( ISCSI_DATA_PAD_LEN ( common->lengths )
568                                         - iscsi->tx_offset ) );
569                 break;
570         default:
571                 assert ( 0 );
572                 break;
573         }
574 }
575
576 /**
577  * Receive data segment of an iSCSI PDU
578  *
579  * @v iscsi             iSCSI session
580  * @v data              Received data
581  * @v len               Length of received data
582  * @v remaining         Data remaining after this data
583  *
584  * Handle processing of part of a PDU data segment.  iscsi::rx_bhs
585  * will be valid when this is called.
586  */
587 static void iscsi_rx_data ( struct iscsi_session *iscsi, void *data,
588                             size_t len, size_t remaining ) {
589         struct iscsi_bhs_common_response *response
590                 = &iscsi->rx_bhs.common_response;
591
592         /* Update cmdsn and statsn */
593         iscsi->cmdsn = ntohl ( response->expcmdsn );
594         iscsi->statsn = ntohl ( response->statsn );
595
596         switch ( response->opcode & ISCSI_OPCODE_MASK ) {
597         case ISCSI_OPCODE_LOGIN_RESPONSE:
598                 iscsi_rx_login_response ( iscsi, data, len, remaining );
599                 break;
600         case ISCSI_OPCODE_SCSI_RESPONSE:
601                 iscsi_rx_scsi_response ( iscsi, data, len, remaining );
602                 break;
603         case ISCSI_OPCODE_DATA_IN:
604                 iscsi_rx_data_in ( iscsi, data, len, remaining );
605                 break;
606         case ISCSI_OPCODE_R2T:
607                 iscsi_rx_r2t ( iscsi, data, len, remaining );
608                 break;
609         default:
610                 printf ( "Unknown iSCSI opcode %02x\n", response->opcode );
611                 iscsi->status |= ( ISCSI_STATUS_DONE | ISCSI_STATUS_ERR );
612                 break;
613         }
614 }
615
616 /**
617  * Discard portion of an iSCSI PDU.
618  *
619  * @v iscsi             iSCSI session
620  * @v data              Received data
621  * @v len               Length of received data
622  * @v remaining         Data remaining after this data
623  *
624  * This discards data from a portion of a received PDU.
625  */
626 static void iscsi_rx_discard ( struct iscsi_session *iscsi __unused,
627                                void *data __unused, size_t len __unused,
628                                size_t remaining __unused ) {
629         /* Do nothing */
630 }
631
632 /**
633  * Receive basic header segment of an iSCSI PDU
634  *
635  * @v iscsi             iSCSI session
636  * @v data              Received data
637  * @v len               Length of received data
638  * @v remaining         Data remaining after this data
639  *
640  * This fills in iscsi::rx_bhs with the data from the BHS portion of
641  * the received PDU.
642  */
643 static void iscsi_rx_bhs ( struct iscsi_session *iscsi, void *data,
644                            size_t len, size_t remaining __unused ) {
645         memcpy ( &iscsi->rx_bhs.bytes[iscsi->rx_offset], data, len );
646         if ( ( iscsi->rx_offset + len ) >= sizeof ( iscsi->rx_bhs ) ) {
647                 DBG ( "iSCSI %p received PDU opcode %#x len %#lx\n",
648                       iscsi, iscsi->rx_bhs.common.opcode,
649                       ISCSI_DATA_LEN ( iscsi->rx_bhs.common.lengths ) );
650         }
651 }
652
653 /**
654  * Receive new data
655  *
656  * @v tcp               TCP connection
657  * @v data              Received data
658  * @v len               Length of received data
659  *
660  * This handles received PDUs.  The receive strategy is to fill in
661  * iscsi::rx_bhs with the contents of the BHS portion of the PDU,
662  * throw away any AHS portion, and then process each part of the data
663  * portion as it arrives.  The data processing routine therefore
664  * always has a full copy of the BHS available, even for portions of
665  * the data in different packets to the BHS.
666  */
667 static void iscsi_newdata ( struct tcp_connection *conn, void *data,
668                             size_t len ) {
669         struct iscsi_session *iscsi = tcp_to_iscsi ( conn );
670         struct iscsi_bhs_common *common = &iscsi->rx_bhs.common;
671         void ( *process ) ( struct iscsi_session *iscsi, void *data,
672                             size_t len, size_t remaining );
673         size_t max_rx_offset;
674         enum iscsi_rx_state next_state;
675         size_t frag_len;
676         size_t remaining;
677
678         while ( 1 ) {
679                 switch ( iscsi->rx_state ) {
680                 case ISCSI_RX_BHS:
681                         process = iscsi_rx_bhs;
682                         max_rx_offset = sizeof ( iscsi->rx_bhs );
683                         next_state = ISCSI_RX_AHS;                      
684                         break;
685                 case ISCSI_RX_AHS:
686                         process = iscsi_rx_discard;
687                         max_rx_offset = 4 * ISCSI_AHS_LEN ( common->lengths );
688                         next_state = ISCSI_RX_DATA;
689                         break;
690                 case ISCSI_RX_DATA:
691                         process = iscsi_rx_data;
692                         max_rx_offset = ISCSI_DATA_LEN ( common->lengths );
693                         next_state = ISCSI_RX_DATA_PADDING;
694                         break;
695                 case ISCSI_RX_DATA_PADDING:
696                         process = iscsi_rx_discard;
697                         max_rx_offset = ISCSI_DATA_PAD_LEN ( common->lengths );
698                         next_state = ISCSI_RX_BHS;
699                         break;
700                 default:
701                         assert ( 0 );
702                         return;
703                 }
704
705                 frag_len = max_rx_offset - iscsi->rx_offset;
706                 if ( frag_len > len )
707                         frag_len = len;
708                 remaining = max_rx_offset - iscsi->rx_offset - frag_len;
709                 process ( iscsi, data, frag_len, remaining );
710
711                 iscsi->rx_offset += frag_len;
712                 data += frag_len;
713                 len -= frag_len;
714
715                 /* If all the data for this state has not yet been
716                  * received, stay in this state for now.
717                  */
718                 if ( iscsi->rx_offset != max_rx_offset )
719                         return;
720
721                 iscsi->rx_state = next_state;
722                 iscsi->rx_offset = 0;
723         }
724 }
725
726 /**
727  * Handle TCP connection closure
728  *
729  * @v conn              TCP connection
730  * @v status            Error code, if any
731  *
732  */
733 static void iscsi_closed ( struct tcp_connection *conn, int status __unused ) {
734         struct iscsi_session *iscsi = tcp_to_iscsi ( conn );
735
736         /* Clear connected flag */
737         iscsi->status &= ~ISCSI_STATUS_CONNECTED;
738
739         /* Retry connection if within the retry limit, otherwise fail */
740         if ( ++iscsi->retry_count <= ISCSI_MAX_RETRIES ) {
741                 tcp_connect ( conn );
742         } else {
743                 printf ( "iSCSI retry count exceeded\n" );
744                 iscsi->status |= ( ISCSI_STATUS_DONE | ISCSI_STATUS_ERR );
745         }
746 }
747
748 /**
749  * Handle TCP connection opening
750  *
751  * @v conn              TCP connection
752  *
753  */
754 static void iscsi_connected ( struct tcp_connection *conn ) {
755         struct iscsi_session *iscsi = tcp_to_iscsi ( conn );
756
757         /* Set connected flag and reset retry count */
758         iscsi->status |= ISCSI_STATUS_CONNECTED;
759         iscsi->retry_count = 0;
760
761         /* Prepare to receive PDUs. */
762         iscsi->rx_state = ISCSI_RX_BHS;
763         iscsi->rx_offset = 0;
764
765         /* Start logging in */
766         iscsi_start_login ( iscsi, 1 );
767 }
768
769 /** iSCSI TCP operations */
770 static struct tcp_operations iscsi_tcp_operations = {
771         .closed         = iscsi_closed,
772         .connected      = iscsi_connected,
773         .acked          = iscsi_acked,
774         .newdata        = iscsi_newdata,
775         .senddata       = iscsi_senddata,
776 };
777
778 /**
779  * Issue SCSI command via iSCSI session
780  *
781  * @v iscsi             iSCSI session
782  * @v command           SCSI command
783  * @ret rc              Return status code
784  */
785 int iscsi_issue ( struct iscsi_session *iscsi,
786                   struct scsi_command *command ) {
787         iscsi->command = command;
788         iscsi->status &= ~( ISCSI_STATUS_DONE | ISCSI_STATUS_ERR );
789
790         if ( iscsi->status & ISCSI_STATUS_CONNECTED ) {
791                 iscsi_start_command ( iscsi );
792                 tcp_senddata ( &iscsi->tcp );
793         } else {
794                 iscsi->tcp.tcp_op = &iscsi_tcp_operations;
795                 tcp_connect ( &iscsi->tcp );
796         }
797
798         while ( ! ( iscsi->status & ISCSI_STATUS_DONE ) ) {
799                 step();
800         }
801
802         iscsi->command = NULL;
803
804         return ( ( iscsi->status & ISCSI_STATUS_ERR ) ? -EIO : 0 );     
805 }