pktbuf.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2014 Martine Lenders <mlenders@inf.fu-berlin.de>
3  * 2015 Freie Universität Berlin
4  *
5  * This file is subject to the terms and conditions of the GNU Lesser
6  * General Public License v2.1. See the file LICENSE in the top level
7  * directory for more details.
8  */
9 
30 #ifndef NET_GNRC_PKTBUF_H
31 #define NET_GNRC_PKTBUF_H
32 
33 #include <stdbool.h>
34 #include <stdlib.h>
35 #include <string.h>
36 
37 #include "cpu_conf.h"
38 #include "mutex.h"
39 #include "net/gnrc/pkt.h"
40 #include "net/gnrc/neterr.h"
41 #include "net/gnrc/nettype.h"
42 #include "utlist.h"
43 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
63 #ifndef CONFIG_GNRC_PKTBUF_SIZE
64 #define CONFIG_GNRC_PKTBUF_SIZE (6144)
65 #endif
71 #ifndef CONFIG_GNRC_PKTBUF_CHECK_USE_AFTER_FREE
72 #define CONFIG_GNRC_PKTBUF_CHECK_USE_AFTER_FREE (0)
73 #endif
74 
83 #define GNRC_PKTBUF_CANARY (0x55)
84 
88 void gnrc_pktbuf_init(void);
89 
111 gnrc_pktsnip_t *gnrc_pktbuf_add(gnrc_pktsnip_t *next, const void *data, size_t size,
112  gnrc_nettype_t type);
113 
147 gnrc_pktsnip_t *gnrc_pktbuf_mark(gnrc_pktsnip_t *pkt, size_t size, gnrc_nettype_t type);
148 
168 int gnrc_pktbuf_realloc_data(gnrc_pktsnip_t *pkt, size_t size);
169 
176 void gnrc_pktbuf_hold(gnrc_pktsnip_t *pkt, unsigned int num);
177 
188 void gnrc_pktbuf_release_error(gnrc_pktsnip_t *pkt, uint32_t err);
189 
196 static inline void gnrc_pktbuf_release(gnrc_pktsnip_t *pkt)
197 {
198  gnrc_pktbuf_release_error(pkt, GNRC_NETERR_SUCCESS);
199 }
200 
215 gnrc_pktsnip_t *gnrc_pktbuf_start_write(gnrc_pktsnip_t *pkt);
216 
225 gnrc_pktsnip_t *gnrc_pktbuf_remove_snip(gnrc_pktsnip_t *pkt, gnrc_pktsnip_t *snip);
226 
243 gnrc_pktsnip_t *gnrc_pktbuf_reverse_snips(gnrc_pktsnip_t *pkt);
244 
297 int gnrc_pktbuf_merge(gnrc_pktsnip_t *pkt);
298 
299 #ifdef DEVELHELP
307 void gnrc_pktbuf_stats(void);
308 #endif
309 
310 /* for testing */
311 #ifdef TEST_SUITES
318 bool gnrc_pktbuf_is_empty(void);
319 
326 bool gnrc_pktbuf_is_sane(void);
327 #endif
328 
329 #ifdef __cplusplus
330 }
331 #endif
332 
333 #endif /* NET_GNRC_PKTBUF_H */
GNRC_NETERR_SUCCESS
#define GNRC_NETERR_SUCCESS
Error code to signalise success (no error occurred) to an gnrc_neterr subscriber.
Definition: neterr.h:42
gnrc_nettype_t
gnrc_nettype_t
Definition of protocol types in the network stack.
Definition: nettype.h:51
gnrc_pktbuf_is_sane
bool gnrc_pktbuf_is_sane(void)
Checks if the implementation's internal invariants still uphold.
gnrc_pktbuf_release_error
void gnrc_pktbuf_release_error(gnrc_pktsnip_t *pkt, uint32_t err)
Decreases gnrc_pktsnip_t::users of pkt atomically and removes it if it reaches 0 and reports a possib...
gnrc_pktbuf_is_empty
bool gnrc_pktbuf_is_empty(void)
Checks if packet buffer is empty.
gnrc_pktbuf_mark
gnrc_pktsnip_t * gnrc_pktbuf_mark(gnrc_pktsnip_t *pkt, size_t size, gnrc_nettype_t type)
Marks the first size bytes in a received packet with a new packet snip that is appended to the packet...
gnrc_pktbuf_realloc_data
int gnrc_pktbuf_realloc_data(gnrc_pktsnip_t *pkt, size_t size)
Reallocates gnrc_pktsnip_t::data of pkt in the packet buffer, without changing the content.
gnrc_pktbuf_start_write
gnrc_pktsnip_t * gnrc_pktbuf_start_write(gnrc_pktsnip_t *pkt)
Must be called once before there is a write operation on a packet snip in a thread.
gnrc_pktbuf_add
gnrc_pktsnip_t * gnrc_pktbuf_add(gnrc_pktsnip_t *next, const void *data, size_t size, gnrc_nettype_t type)
Adds a new gnrc_pktsnip_t and its packet to the packet buffer.
gnrc_pktbuf_reverse_snips
gnrc_pktsnip_t * gnrc_pktbuf_reverse_snips(gnrc_pktsnip_t *pkt)
Reverses snip order of a packet in a write-protected manner.
gnrc_pktbuf_init
void gnrc_pktbuf_init(void)
Initializes packet buffer module.
gnrc_pktbuf_hold
void gnrc_pktbuf_hold(gnrc_pktsnip_t *pkt, unsigned int num)
Increases gnrc_pktsnip_t::users of pkt atomically.
gnrc_pktbuf_merge
int gnrc_pktbuf_merge(gnrc_pktsnip_t *pkt)
Merge pktsnip chain to single pktsnip.
gnrc_pktbuf_release
static void gnrc_pktbuf_release(gnrc_pktsnip_t *pkt)
Decreases gnrc_pktsnip_t::users of pkt atomically and removes it if it reaches 0 and reports GNRC_NET...
Definition: pktbuf.h:196
gnrc_pktbuf_stats
void gnrc_pktbuf_stats(void)
Prints some statistics about the packet buffer to stdout.
gnrc_pktbuf_remove_snip
gnrc_pktsnip_t * gnrc_pktbuf_remove_snip(gnrc_pktsnip_t *pkt, gnrc_pktsnip_t *snip)
Deletes a snip from a packet and the packet buffer.
mutex.h
Mutex for thread synchronization.
pkt.h
General definitions for network packets and their helper functions.
neterr.h
Error reporting definitions.
nettype.h
Protocol type definitions.
gnrc_pktsnip
Type to represent parts (either headers or payload) of a packet, called snips.
Definition: pkt.h:108
utlist.h
Macros for basic linked list operations.