WIP commit, adding support for receiving into a pbuf.
[akaros.git] / kern / include / net / pbuf.h
1 #ifndef _ROS_PBUF_H_
2 #define _ROS_PBUF_H_
3 #include <kmalloc.h>
4 #include <slab.h>
5 #include <kref.h>
6
7 #ifdef __cplusplus
8 extern "C" {
9 #endif
10
11 /** Currently, the pbuf_custom code is only needed for one specific configuration
12  * of IP_FRAG */
13 #define LWIP_SUPPORT_CUSTOM_PBUF (IP_FRAG && !IP_FRAG_USES_STATIC_BUF && !LWIP_NETIF_TX_SINGLE_PBUF)
14 #define ETH_PAD_SIZE 2      // padding to ensure ip packet is longword aligned.
15 #define PBUF_TRANSPORT_HLEN 20
16 #define PBUF_IP_HLEN        20
17 #define PBUF_LINK_HLEN      14 + ETH_PAD_SIZE // Padding
18
19 typedef enum {
20   PBUF_TRANSPORT,
21   PBUF_IP,
22   PBUF_LINK,
23   PBUF_RAW
24 } pbuf_layer;
25
26 typedef enum {
27   PBUF_RAM, /* pbuf data is stored in RAM */
28   PBUF_ROM, /* pbuf data is stored in ROM */
29   PBUF_REF, /* pbuf comes from the pbuf pool */
30   PBUF_POOL, /* pbuf payload refers to RAM */
31         PBUF_MTU  /* pbuf with a fixed MTU size */
32 } pbuf_type;
33
34
35 /** indicates this packet's data should be immediately passed to the application */
36 #define PBUF_FLAG_PUSH      0x01U
37 /** indicates this is a custom pbuf: pbuf_free and pbuf_header handle such a
38     a pbuf differently */
39 #define PBUF_FLAG_IS_CUSTOM 0x02U
40 /** indicates this pbuf is UDP multicast to be looped back */
41 #define PBUF_FLAG_MCASTLOOP 0x04U
42
43 struct pbuf {
44   /** next pbuf in singly linked pbuf chain */
45   struct pbuf *next;
46
47   /** pointer to the actual data in the buffer */
48   void *payload;
49
50   uint16_t tot_len;
51
52   /** length of this buffer */
53   uint16_t len;
54
55   /** pbuf_type as u8_t instead of enum to save space */
56   uint8_t /*pbuf_type*/ type;
57
58   /** misc flags */
59   uint8_t flags;
60
61   struct kref bufref;
62 };
63
64 extern struct kmem_cache *pbuf_kcache;
65 /* Initializes the pbuf module. This call is empty for now, but may not be in future. */
66 void pbuf_init(void);
67 void pbuf_cat(struct pbuf *head, struct pbuf *tail);
68 void pbuf_chain(struct pbuf *head, struct pbuf *tail);
69 void pbuf_ref(struct pbuf *p);
70 int pbuf_header(struct pbuf *p, int header_size);
71 struct pbuf *pbuf_alloc(pbuf_layer layer, uint16_t length, pbuf_type type);
72 int pbuf_copy_out(struct pbuf *buf, void *dataptr, size_t len, uint16_t offset);
73 void print_pbuf(struct pbuf *p);
74 // end
75 #if 0
76 void pbuf_realloc(struct pbuf *p, u16_t size); 
77 u8_t pbuf_free(struct pbuf *p);
78 u8_t pbuf_clen(struct pbuf *p);  
79 struct pbuf *pbuf_dechain(struct pbuf *p);
80 err_t pbuf_copy(struct pbuf *p_to, struct pbuf *p_from);
81 err_t pbuf_take(struct pbuf *buf, const void *dataptr, u16_t len);
82 struct pbuf *pbuf_coalesce(struct pbuf *p, pbuf_layer layer);
83 #if LWIP_CHECKSUM_ON_COPY
84 err_t pbuf_fill_chksum(struct pbuf *p, u16_t start_offset, const void *dataptr,
85                        u16_t len, u16_t *chksum);
86 #endif /* LWIP_CHECKSUM_ON_COPY */
87
88 u8_t pbuf_get_at(struct pbuf* p, u16_t offset);
89 u16_t pbuf_memcmp(struct pbuf* p, u16_t offset, const void* s2, u16_t n);
90 u16_t pbuf_memfind(struct pbuf* p, const void* mem, u16_t mem_len, u16_t start_offset);
91 u16_t pbuf_strstr(struct pbuf* p, const char* substr);
92
93 #endif
94
95 #ifdef __cplusplus
96 }
97 #endif
98
99 #endif /* __LWIP_PBUF_H__ */