Clarified packet ownership transfer between a few functions.
[people/xl0/gpxe.git] / src / net / netdevice.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 <stdint.h>
20 #include <byteswap.h>
21 #include <string.h>
22 #include <errno.h>
23 #include <malloc.h>
24 #include <gpxe/if_ether.h>
25 #include <gpxe/pkbuff.h>
26 #include <gpxe/tables.h>
27 #include <gpxe/process.h>
28 #include <gpxe/init.h>
29 #include <gpxe/netdevice.h>
30
31 /** @file
32  *
33  * Network device management
34  *
35  */
36
37 /** Registered network-layer protocols */
38 static struct net_protocol net_protocols[0] __table_start ( net_protocols );
39 static struct net_protocol net_protocols_end[0] __table_end ( net_protocols );
40
41 /** List of network devices */
42 static LIST_HEAD ( net_devices );
43
44 /**
45  * Transmit raw packet via network device
46  *
47  * @v netdev            Network device
48  * @v pkb               Packet buffer
49  * @ret rc              Return status code
50  *
51  * Transmits the packet via the specified network device.  This
52  * function takes ownership of the packet buffer.
53  */
54 int netdev_tx ( struct net_device *netdev, struct pk_buff *pkb ) {
55         DBG ( "%s transmitting %p+%zx\n", netdev_name ( netdev ),
56               pkb->data, pkb_len ( pkb ) );
57         return netdev->transmit ( netdev, pkb );
58 }
59
60 /**
61  * Add packet to receive queue
62  *
63  * @v netdev            Network device
64  * @v pkb               Packet buffer
65  *
66  * The packet is added to the network device's RX queue.  This
67  * function takes ownership of the packet buffer.
68  */
69 void netdev_rx ( struct net_device *netdev, struct pk_buff *pkb ) {
70         DBG ( "%s received %p+%zx\n", netdev_name ( netdev ),
71               pkb->data, pkb_len ( pkb ) );
72         list_add_tail ( &pkb->list, &netdev->rx_queue );
73 }
74
75 /**
76  * Transmit network-layer packet
77  *
78  * @v pkb               Packet buffer
79  * @v netdev            Network device
80  * @v net_protocol      Network-layer protocol
81  * @v ll_dest           Destination link-layer address
82  * @ret rc              Return status code
83  *
84  * Prepends link-layer headers to the packet buffer and transmits the
85  * packet via the specified network device.  This function takes
86  * ownership of the packet buffer.
87  */
88 int net_tx ( struct pk_buff *pkb, struct net_device *netdev,
89              struct net_protocol *net_protocol, const void *ll_dest ) {
90         return netdev->ll_protocol->tx ( pkb, netdev, net_protocol, ll_dest );
91 }
92
93 /**
94  * Process received network-layer packet
95  *
96  * @v pkb               Packet buffer
97  * @v netdev            Network device
98  * @v net_proto         Network-layer protocol, in network-byte order
99  * @v ll_source         Source link-layer address
100  * @ret rc              Return status code
101  */
102 int net_rx ( struct pk_buff *pkb, struct net_device *netdev,
103               uint16_t net_proto, const void *ll_source ) {
104         struct net_protocol *net_protocol;
105
106         /* Hand off to network-layer protocol, if any */
107         for ( net_protocol = net_protocols ; net_protocol < net_protocols_end ;
108               net_protocol++ ) {
109                 if ( net_protocol->net_proto == net_proto ) {
110                         return net_protocol->rx ( pkb, netdev, ll_source );
111                 }
112         }
113         free_pkb ( pkb );
114         return 0;
115 }
116
117 /**
118  * Poll for packet on network device
119  *
120  * @v netdev            Network device
121  * @ret True            There are packets present in the receive queue
122  * @ret False           There are no packets present in the receive queue
123  *
124  * Polls the network device for received packets.  Any received
125  * packets will be added to the RX packet queue via netdev_rx().
126  */
127 int netdev_poll ( struct net_device *netdev ) {
128         netdev->poll ( netdev );
129         return ( ! list_empty ( &netdev->rx_queue ) );
130 }
131
132 /**
133  * Remove packet from device's receive queue
134  *
135  * @v netdev            Network device
136  * @ret pkb             Packet buffer, or NULL
137  *
138  * Removes the first packet from the device's RX queue and returns it.
139  * Ownership of the packet is transferred to the caller.
140  */
141 struct pk_buff * netdev_rx_dequeue ( struct net_device *netdev ) {
142         struct pk_buff *pkb;
143
144         list_for_each_entry ( pkb, &netdev->rx_queue, list ) {
145                 list_del ( &pkb->list );
146                 return pkb;
147         }
148         return NULL;
149 }
150
151 /**
152  * Allocate network device
153  *
154  * @v priv_size         Size of private data area (net_device::priv)
155  * @ret netdev          Network device, or NULL
156  *
157  * Allocates space for a network device and its private data area.
158  */
159 struct net_device * alloc_netdev ( size_t priv_size ) {
160         struct net_device *netdev;
161
162         netdev = calloc ( 1, sizeof ( *netdev ) + priv_size );
163         if ( netdev ) {
164                 INIT_LIST_HEAD ( &netdev->rx_queue );
165                 netdev->priv = ( ( ( void * ) netdev ) + sizeof ( *netdev ) );
166         }
167         return netdev;
168 }
169
170 /**
171  * Register network device
172  *
173  * @v netdev            Network device
174  * @ret rc              Return status code
175  *
176  * Adds the network device to the list of network devices.
177  */
178 int register_netdev ( struct net_device *netdev ) {
179         
180         /* Add to device list */
181         list_add_tail ( &netdev->list, &net_devices );
182         DBG ( "%s registered\n", netdev_name ( netdev ) );
183
184         return 0;
185 }
186
187 /**
188  * Unregister network device
189  *
190  * @v netdev            Network device
191  *
192  * Removes the network device from the list of network devices.
193  */
194 void unregister_netdev ( struct net_device *netdev ) {
195         struct pk_buff *pkb;
196
197         /* Discard any packets in the RX queue */
198         while ( ( pkb = netdev_rx_dequeue ( netdev ) ) ) {
199                 DBG ( "%s discarding %p+%zx\n", netdev_name ( netdev ),
200                       pkb->data, pkb_len ( pkb ) );
201                 free_pkb ( pkb );
202         }
203
204         /* Remove from device list */
205         list_del ( &netdev->list );
206         DBG ( "%s unregistered\n", netdev_name ( netdev ) );
207 }
208
209 /**
210  * Free network device
211  *
212  * @v netdev            Network device
213  */
214 void free_netdev ( struct net_device *netdev ) {
215         free ( netdev );
216 }
217
218 /**
219  * Iterate through network devices
220  *
221  * @ret netdev          Network device, or NULL
222  *
223  * This returns the registered network devices in the order of
224  * registration.  If no network devices are registered, it will return
225  * NULL.
226  */
227 struct net_device * next_netdev ( void ) {
228         struct net_device *netdev;
229
230         list_for_each_entry ( netdev, &net_devices, list ) {
231                 list_del ( &netdev->list );
232                 list_add_tail ( &netdev->list, &net_devices );
233                 return netdev;
234         }
235         return NULL;
236 }
237
238 /**
239  * Single-step the network stack
240  *
241  * @v process           Network stack process
242  *
243  * This polls all interfaces for any received packets, and processes
244  * at most one packet from the RX queue.
245  *
246  * We avoid processing all received packets, because processing the
247  * received packet can trigger transmission of a new packet (e.g. an
248  * ARP response).  Since TX completions will be processed as part of
249  * the poll operation, it is easy to overflow small TX queues if
250  * multiple packets are processed per poll.
251  */
252 static void net_step ( struct process *process ) {
253         struct net_device *netdev;
254         struct pk_buff *pkb;
255
256         /* Poll and process each network device */
257         list_for_each_entry ( netdev, &net_devices, list ) {
258
259                 /* Poll for new packets */
260                 netdev_poll ( netdev );
261
262                 /* Handle at most one received packet per poll */
263                 if ( ( pkb = netdev_rx_dequeue ( netdev ) ) ) {
264                         DBG ( "%s processing %p+%zx\n", netdev_name ( netdev ),
265                               pkb->data, pkb_len ( pkb ) );
266                         netdev->ll_protocol->rx ( pkb, netdev );
267                 }
268         }
269
270         /* Re-schedule ourself */
271         schedule ( process );
272 }
273
274 /** Networking stack process */
275 static struct process net_process = {
276         .step = net_step,
277 };
278
279 /** Initialise the networking stack process */
280 static void init_net ( void ) {
281         schedule ( &net_process );
282 }
283
284 INIT_FN ( INIT_PROCESS, init_net, NULL, NULL );