Merge origin/netpush (networking code) (XCC)
[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 #include <sys/queue.h>
7 #include <atomic.h>
8
9 #ifdef __cplusplus
10 extern "C" {
11 #endif
12
13 /** Currently, the pbuf_custom code is only needed for one specific configuration
14  * of IP_FRAG */
15 #define LWIP_SUPPORT_CUSTOM_PBUF (IP_FRAG && !IP_FRAG_USES_STATIC_BUF && !LWIP_NETIF_TX_SINGLE_PBUF)
16 /* Ensure IP address are 32-bit aligned on 32bit systems, and thus improving the speed of processing
17  * for regularly accessed fields such as IP addresses
18  */
19 #define ETH_PAD_SIZE 2      // padding to ensure ip packet is longword aligned.
20 #define PBUF_TRANSPORT_HLEN 20
21 #define PBUF_IP_HLEN        20
22 #define PBUF_LINK_HLEN      14 + ETH_PAD_SIZE // Padding
23
24 /** indicates this packet's data should be immediately passed to the application */
25 #define PBUF_FLAG_PUSH      0x01U
26 /** indicates this is a custom pbuf: pbuf_free and pbuf_header handle such a
27     a pbuf differently */
28 #define PBUF_FLAG_IS_CUSTOM 0x02U
29 /** indicates this pbuf is UDP multicast to be looped back */
30 #define PBUF_FLAG_MCASTLOOP 0x04U
31
32 typedef enum {
33   PBUF_TRANSPORT,
34   PBUF_IP,
35   PBUF_LINK,
36   PBUF_RAW
37 } pbuf_layer;
38
39 typedef enum {
40   PBUF_RAM, /* pbuf data is stored in RAM */
41   PBUF_ROM, /* pbuf data is stored in ROM */
42   PBUF_REF, /* pbuf comes from the pbuf pool */
43   PBUF_POOL, /* pbuf payload refers to RAM */
44         PBUF_MTU  /* pbuf with a fixed MTU size */
45 } pbuf_type;
46
47
48 /** indicates this is a custom pbuf: pbuf_free and pbuf_header handle such a
49     a pbuf differently */
50 #define PBUF_FLAG_IS_CUSTOM 0x02U
51 struct pbuf;
52 STAILQ_HEAD(pbuf_tailq, pbuf);
53
54 struct pbuf {
55         /* Several reasons to roll own version of STAIL queue here 
56          * pbuf chain exists without a queue
57          * also pbuf chain need to be moved entirely onto a socket queue
58          */
59         STAILQ_ENTRY(pbuf) next;
60   // struct pbuf *next;
61
62   /** pointer to the actual data in the buffer */
63   void *payload;
64
65   uint16_t tot_len;
66
67   /** length of this buffer */
68   uint16_t len;
69
70         uint16_t alloc_len;
71
72   /** pbuf_type as u8_t instead of enum to save space */
73   uint8_t type;
74
75   /** misc flags */
76   uint8_t flags;
77
78   struct kref bufref;
79 };
80
81 struct pbuf_head {
82         struct pbuf_tailq pbuf_fifo;
83         uint32_t qlen;
84         spinlock_t lock; 
85 };
86
87 static inline void pbuf_head_init(struct pbuf_head *ph) {
88         STAILQ_INIT(&ph->pbuf_fifo);
89         ph->qlen = 0;
90         spinlock_init(&ph->lock);
91 }
92 extern struct kmem_cache *pbuf_kcache;
93 /* Initializes the pbuf module. This call is empty for now, but may not be in future. */
94 void pbuf_init(void);
95 void pbuf_cat(struct pbuf *head, struct pbuf *tail);
96 void pbuf_chain(struct pbuf *head, struct pbuf *tail);
97 void pbuf_ref(struct pbuf *p);
98 bool pbuf_deref(struct pbuf *p);
99 int pbuf_header(struct pbuf *p, int header_size);
100 struct pbuf *pbuf_alloc(pbuf_layer layer, uint16_t length, pbuf_type type);
101 int pbuf_copy_out(struct pbuf *buf, void *dataptr, size_t len, uint16_t offset);
102 void print_pbuf(struct pbuf *p);
103 bool pbuf_free(struct pbuf *p);
104
105 void attach_pbuf(struct pbuf *p, struct pbuf_head *buf_head);
106 struct pbuf* detach_pbuf(struct pbuf_head *buf_head);
107 uint8_t pbuf_clen(struct pbuf *p);  
108 void pbuf_realloc(struct pbuf *p, uint16_t size); 
109 // end
110 #if 0
111 struct pbuf *pbuf_dechain(struct pbuf *p);
112 err_t pbuf_copy(struct pbuf *p_to, struct pbuf *p_from);
113 err_t pbuf_take(struct pbuf *buf, const void *dataptr, u16_t len);
114 struct pbuf *pbuf_coalesce(struct pbuf *p, pbuf_layer layer);
115 #if LWIP_CHECKSUM_ON_COPY
116 err_t pbuf_fill_chksum(struct pbuf *p, u16_t start_offset, const void *dataptr,
117                        u16_t len, u16_t *chksum);
118 #endif /* LWIP_CHECKSUM_ON_COPY */
119
120 u8_t pbuf_get_at(struct pbuf* p, u16_t offset);
121 u16_t pbuf_memcmp(struct pbuf* p, u16_t offset, const void* s2, u16_t n);
122 u16_t pbuf_memfind(struct pbuf* p, const void* mem, u16_t mem_len, u16_t start_offset);
123 u16_t pbuf_strstr(struct pbuf* p, const char* substr);
124
125 #endif
126
127 #ifdef __cplusplus
128 }
129 #endif
130
131 #endif /* __LWIP_PBUF_H__ */