Improve tcpdump legibility.
[people/xl0/gpxe.git] / src / net / aoe.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/list.h>
26 #include <gpxe/if_ether.h>
27 #include <gpxe/pkbuff.h>
28 #include <gpxe/uaccess.h>
29 #include <gpxe/ata.h>
30 #include <gpxe/netdevice.h>
31 #include <gpxe/async.h>
32 #include <gpxe/aoe.h>
33
34 /** @file
35  *
36  * AoE protocol
37  *
38  */
39
40 struct net_protocol aoe_protocol;
41
42 /** List of all AoE sessions */
43 static LIST_HEAD ( aoe_sessions );
44
45 /**
46  * Mark current AoE command complete
47  *
48  * @v aoe               AoE session
49  * @v rc                Return status code
50  */
51 static void aoe_done ( struct aoe_session *aoe, int rc ) {
52
53         /* Record overall command status */
54         aoe->command->cb.cmd_stat = aoe->status;
55         aoe->command = NULL;
56
57         /* Mark async operation as complete */
58         async_done ( &aoe->aop, rc );
59 }
60
61 /**
62  * Send AoE command
63  *
64  * @v aoe               AoE session
65  * @ret rc              Return status code
66  *
67  * This transmits an AoE command packet.  It does not wait for a
68  * response.
69  */
70 static int aoe_send_command ( struct aoe_session *aoe ) {
71         struct ata_command *command = aoe->command;
72         struct pk_buff *pkb;
73         struct aoehdr *aoehdr;
74         struct aoecmd *aoecmd;
75         unsigned int count;
76         unsigned int data_out_len;
77
78         /* Calculate count and data_out_len for this subcommand */
79         count = command->cb.count.native;
80         if ( count > AOE_MAX_COUNT )
81                 count = AOE_MAX_COUNT;
82         data_out_len = ( command->data_out ? ( count * ATA_SECTOR_SIZE ) : 0 );
83
84         /* Create outgoing packet buffer */
85         pkb = alloc_pkb ( ETH_HLEN + sizeof ( *aoehdr ) + sizeof ( *aoecmd ) +
86                           data_out_len );
87         if ( ! pkb )
88                 return -ENOMEM;
89         pkb->net_protocol = &aoe_protocol;
90         pkb_reserve ( pkb, ETH_HLEN );
91         aoehdr = pkb_put ( pkb, sizeof ( *aoehdr ) );
92         aoecmd = pkb_put ( pkb, sizeof ( *aoecmd ) );
93         memset ( aoehdr, 0, ( sizeof ( *aoehdr ) + sizeof ( *aoecmd ) ) );
94
95         /* Fill AoE header */
96         aoehdr->ver_flags = AOE_VERSION;
97         aoehdr->major = htons ( aoe->major );
98         aoehdr->minor = aoe->minor;
99         aoehdr->tag = htonl ( ++aoe->tag );
100
101         /* Fill AoE command */
102         linker_assert ( AOE_FL_DEV_HEAD == ATA_DEV_SLAVE, __fix_ata_h__ );
103         aoecmd->aflags = ( ( command->cb.lba48 ? AOE_FL_EXTENDED : 0 ) |
104                            ( command->cb.device & ATA_DEV_SLAVE ) |
105                            ( data_out_len ? AOE_FL_WRITE : 0 ) );
106         aoecmd->err_feat = command->cb.err_feat.bytes.cur;
107         aoecmd->count = count;
108         aoecmd->cmd_stat = command->cb.cmd_stat;
109         aoecmd->lba.u64 = cpu_to_le64 ( command->cb.lba.native );
110         if ( ! command->cb.lba48 )
111                 aoecmd->lba.bytes[3] |= ( command->cb.device & ATA_DEV_MASK );
112
113         /* Fill data payload */
114         copy_from_user ( pkb_put ( pkb, data_out_len ), command->data_out,
115                          aoe->command_offset, data_out_len );
116
117         /* Send packet */
118         start_timer ( &aoe->timer );
119         return net_transmit_via ( pkb, aoe->netdev );
120 }
121
122 /**
123  * Handle AoE retry timer expiry
124  *
125  * @v timer             AoE retry timer
126  * @v fail              Failure indicator
127  */
128 static void aoe_timer_expired ( struct retry_timer *timer, int fail ) {
129         struct aoe_session *aoe =
130                 container_of ( timer, struct aoe_session, timer );
131
132         if ( fail ) {
133                 aoe_done ( aoe, -ETIMEDOUT );
134         } else {
135                 aoe_send_command ( aoe );
136         }
137 }
138
139 /**
140  * Handle AoE response
141  *
142  * @v aoe               AoE session
143  * @v aoehdr            AoE header
144  * @ret rc              Return status code
145  */
146 static int aoe_rx_response ( struct aoe_session *aoe, struct aoehdr *aoehdr,
147                              unsigned int len ) {
148         struct aoecmd *aoecmd = aoehdr->arg.command;
149         struct ata_command *command = aoe->command;
150         unsigned int rx_data_len;
151         unsigned int count;
152         unsigned int data_len;
153         
154         /* Sanity check */
155         if ( len < ( sizeof ( *aoehdr ) + sizeof ( *aoecmd ) ) ) {
156                 /* Ignore packet; allow timer to trigger retransmit */
157                 return -EINVAL;
158         }
159         rx_data_len = ( len - sizeof ( *aoehdr ) - sizeof ( *aoecmd ) );
160
161         /* Stop retry timer.  After this point, every code path must
162          * either terminate the AoE operation via aoe_done(), or
163          * transmit a new packet.
164          */
165         stop_timer ( &aoe->timer );
166
167         /* Check for fatal errors */
168         if ( aoehdr->ver_flags & AOE_FL_ERROR ) {
169                 aoe_done ( aoe, -EIO );
170                 return 0;
171         }
172
173         /* Calculate count and data_len for this subcommand */
174         count = command->cb.count.native;
175         if ( count > AOE_MAX_COUNT )
176                 count = AOE_MAX_COUNT;
177         data_len = count * ATA_SECTOR_SIZE;
178
179         /* Merge into overall ATA status */
180         aoe->status |= aoecmd->cmd_stat;
181
182         /* Copy data payload */
183         if ( command->data_in ) {
184                 if ( rx_data_len > data_len )
185                         rx_data_len = data_len;
186                 copy_to_user ( command->data_in, aoe->command_offset,
187                                aoecmd->data, rx_data_len );
188         }
189
190         /* Update ATA command and offset */
191         aoe->command_offset += data_len;
192         command->cb.lba.native += count;
193         command->cb.count.native -= count;
194
195         /* Check for operation complete */
196         if ( ! command->cb.count.native ) {
197                 aoe_done ( aoe, 0 );
198                 return 0;
199         }
200
201         /* Transmit next portion of request */
202         aoe_send_command ( aoe );
203
204         return 0;
205 }
206
207 /**
208  * Process incoming AoE packets
209  *
210  * @v pkb               Packet buffer
211  * @ret rc              Return status code
212  *
213  */
214 static int aoe_rx ( struct pk_buff *pkb ) {
215         struct aoehdr *aoehdr = pkb->data;
216         unsigned int len = pkb_len ( pkb );
217         struct ethhdr *ethhdr = pkb_push ( pkb, sizeof ( *ethhdr ) );
218         struct aoe_session *aoe;
219         int rc = 0;
220
221         /* Sanity checks */
222         if ( len < sizeof ( *aoehdr ) ) {
223                 rc = -EINVAL;
224                 goto done;
225         }
226         if ( ( aoehdr->ver_flags & AOE_VERSION_MASK ) != AOE_VERSION ) {
227                 rc = -EPROTONOSUPPORT;
228                 goto done;
229         }
230         if ( ! ( aoehdr->ver_flags & AOE_FL_RESPONSE ) ) {
231                 /* Ignore AoE requests that we happen to see */
232                 goto done;
233         }
234
235         /* Demultiplex amongst active AoE sessions */
236         list_for_each_entry ( aoe, &aoe_sessions, list ) {
237                 if ( ntohs ( aoehdr->major ) != aoe->major )
238                         continue;
239                 if ( aoehdr->minor != aoe->minor )
240                         continue;
241                 if ( ntohl ( aoehdr->tag ) != aoe->tag )
242                         continue;
243                 memcpy ( aoe->target, ethhdr->h_source,
244                          sizeof ( aoe->target ) );
245                 rc = aoe_rx_response ( aoe, aoehdr, len );
246                 break;
247         }
248
249  done:
250         free_pkb ( pkb );
251         return rc;
252 }
253
254 /**
255  * Perform AoE network-layer routing
256  *
257  * @v pkb       Packet buffer
258  * @ret source  Network-layer source address
259  * @ret dest    Network-layer destination address
260  * @ret rc      Return status code
261  */
262 static int aoe_route ( const struct pk_buff *pkb __unused,
263                        struct net_header *nethdr ) {
264         struct aoehdr *aoehdr = pkb->data;
265         struct aoe_session *aoe;
266
267         list_for_each_entry ( aoe, &aoe_sessions, list ) {
268                 if ( ( ntohs ( aoehdr->major ) == aoe->major ) &&
269                      ( aoehdr->minor == aoe->minor ) ) {
270                         nethdr->flags = PKT_FL_RAW_ADDR;
271                         memcpy ( nethdr->dest_net_addr, aoe->target,
272                                  sizeof ( aoe->target ) );
273                         return 0;
274                 }
275         }
276                 
277         return -EHOSTUNREACH;
278 }
279
280 /** AoE protocol */
281 struct net_protocol aoe_protocol = {
282         .name = "AoE",
283         .net_proto = htons ( ETH_P_AOE ),
284         .rx_process = aoe_rx,
285         .route = aoe_route,
286 };
287
288 NET_PROTOCOL ( aoe_protocol );
289
290 /**
291  * Open AoE session
292  *
293  * @v aoe               AoE session
294  */
295 void aoe_open ( struct aoe_session *aoe ) {
296         memset ( aoe->target, 0xff, sizeof ( aoe->target ) );
297         aoe->tag = AOE_TAG_MAGIC;
298         aoe->timer.expired = aoe_timer_expired;
299         list_add ( &aoe->list, &aoe_sessions );
300 }
301
302 /**
303  * Close AoE session
304  *
305  * @v aoe               AoE session
306  */
307 void aoe_close ( struct aoe_session *aoe ) {
308         list_del ( &aoe->list );
309 }
310
311 /**
312  * Issue ATA command via an open AoE session
313  *
314  * @v aoe               AoE session
315  * @v command           ATA command
316  * @ret aop             Asynchronous operation
317  *
318  * Only one command may be issued concurrently per session.  This call
319  * is non-blocking; use async_wait() to wait for the command to
320  * complete.
321  */
322 struct async_operation * aoe_issue ( struct aoe_session *aoe,
323                                      struct ata_command *command ) {
324         aoe->command = command;
325         aoe->status = 0;
326         aoe->command_offset = 0;
327         aoe_send_command ( aoe );
328         return &aoe->aop;
329 }