6c504029fb1ac3ae010b56c264b7ea363ec752dd
[people/xl0/gpxe.git] / src / include / gpxe / pkbuff.h
1 #ifndef _GPXE_PKBUFF_H
2 #define _GPXE_PKBUFF_H
3
4 /** @file
5  *
6  * Packet buffers
7  *
8  * Packet buffers are used to contain network packets.  Methods are
9  * provided for appending, prepending, etc. data.
10  *
11  */
12
13 #include <stdint.h>
14 #include <assert.h>
15 #include <gpxe/list.h>
16
17 struct net_protocol;
18 struct ll_protocol;
19
20 /**
21  * Packet buffer alignment
22  *
23  * Packet buffers allocated via alloc_pkb() are guaranteed to be
24  * physically aligned to this boundary.  Some cards cannot DMA across
25  * a 4kB boundary.  With a standard Ethernet MTU, aligning to a 2kB
26  * boundary is sufficient to guarantee no 4kB boundary crossings.  For
27  * a jumbo Ethernet MTU, a packet may be larger than 4kB anyway.
28  */
29 #define PKBUFF_ALIGN 2048
30
31 /**
32  * Minimum packet buffer length
33  *
34  * alloc_pkb() will round up the allocated length to this size if
35  * necessary.  This is used on behalf of hardware that is not capable
36  * of auto-padding.
37  */
38 #define PKB_ZLEN 64
39
40 /** A packet buffer
41  *
42  * This structure is used to represent a network packet within gPXE.
43  */
44 struct pk_buff {
45         /** Start of the buffer */
46         void *head;
47         /** Start of data */
48         void *data;
49         /** End of data */
50         void *tail;
51         /** End of the buffer */
52         void *end;
53
54         /** List of which this buffer is a member */
55         struct list_head list;
56
57         /** The network-layer protocol */
58         struct net_protocol *net_protocol;
59         /** The link-layer protocol */
60         struct ll_protocol *ll_protocol;
61 };
62
63 /**
64  * Reserve space at start of packet buffer
65  *
66  * @v pkb       Packet buffer
67  * @v len       Length to reserve
68  * @ret data    Pointer to new start of buffer
69  */
70 static inline void * pkb_reserve ( struct pk_buff *pkb, size_t len ) {
71         pkb->data += len;
72         pkb->tail += len;
73         assert ( pkb->tail <= pkb->end );
74         return pkb->data;
75 }
76
77 /**
78  * Add data to start of packet buffer
79  *
80  * @v pkb       Packet buffer
81  * @v len       Length to add
82  * @ret data    Pointer to new start of buffer
83  */
84 static inline void * pkb_push ( struct pk_buff *pkb, size_t len ) {
85         pkb->data -= len;
86         assert ( pkb->data >= pkb->head );
87         return pkb->data;
88 }
89
90 /**
91  * Remove data from start of packet buffer
92  *
93  * @v pkb       Packet buffer
94  * @v len       Length to remove
95  * @ret data    Pointer to new start of buffer
96  */
97 static inline void * pkb_pull ( struct pk_buff *pkb, size_t len ) {
98         pkb->data += len;
99         assert ( pkb->data <= pkb->tail );
100         return pkb->data;
101 }
102
103 /**
104  * Add data to end of packet buffer
105  *
106  * @v pkb       Packet buffer
107  * @v len       Length to add
108  * @ret data    Pointer to newly added space
109  */
110 static inline void * pkb_put ( struct pk_buff *pkb, size_t len ) {
111         void *old_tail = pkb->tail;
112         pkb->tail += len;
113         assert ( pkb->tail <= pkb->end );
114         return old_tail;
115 }
116
117 /**
118  * Remove data from end of packet buffer
119  *
120  * @v pkb       Packet buffer
121  * @v len       Length to remove
122  */
123 static inline void pkb_unput ( struct pk_buff *pkb, size_t len ) {
124         pkb->tail -= len;
125         assert ( pkb->tail >= pkb->data );
126 }
127
128 /**
129  * Empty a packet buffer
130  *
131  * @v pkb       Packet buffer
132  */
133 static inline void pkb_empty ( struct pk_buff *pkb ) {
134         pkb->tail = pkb->data;
135 }
136
137 /**
138  * Calculate length of data in a packet buffer
139  *
140  * @v pkb       Packet buffer
141  * @ret len     Length of data in buffer
142  */
143 static inline size_t pkb_len ( struct pk_buff *pkb ) {
144         return ( pkb->tail - pkb->data );
145 }
146
147 extern struct pk_buff * alloc_pkb ( size_t len );
148 extern void free_pkb ( struct pk_buff *pkb );
149
150 #endif /* _GPXE_PKBUFF_H */