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 void gnrc_pktbuf_init(void);
72 
94 gnrc_pktsnip_t *gnrc_pktbuf_add(gnrc_pktsnip_t *next, const void *data, size_t size,
95  gnrc_nettype_t type);
96 
131 
152 
159 void gnrc_pktbuf_hold(gnrc_pktsnip_t *pkt, unsigned int num);
160 
171 void gnrc_pktbuf_release_error(gnrc_pktsnip_t *pkt, uint32_t err);
172 
179 static inline void gnrc_pktbuf_release(gnrc_pktsnip_t *pkt)
180 {
182 }
183 
199 
209 
227 
281 
282 #ifdef DEVELHELP
290 void gnrc_pktbuf_stats(void);
291 #endif
292 
293 /* for testing */
294 #ifdef TEST_SUITES
302 
310 #endif
311 
312 #ifdef __cplusplus
313 }
314 #endif
315 
316 #endif /* NET_GNRC_PKTBUF_H */
#define GNRC_NETERR_SUCCESS
Error code to signalise success (no error occurred) to an gnrc_neterr subscriber.
Definition: neterr.h:42
gnrc_nettype_t
Definition of protocol types in the network stack.
Definition: nettype.h:50
bool gnrc_pktbuf_is_sane(void)
Checks if the implementation's internal invariants still uphold.
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...
bool gnrc_pktbuf_is_empty(void)
Checks if packet buffer is empty.
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...
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_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_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_pktsnip_t * gnrc_pktbuf_reverse_snips(gnrc_pktsnip_t *pkt)
Reverses snip order of a packet in a write-protected manner.
void gnrc_pktbuf_init(void)
Initializes packet buffer module.
void gnrc_pktbuf_hold(gnrc_pktsnip_t *pkt, unsigned int num)
Increases gnrc_pktsnip_t::users of pkt atomically.
int gnrc_pktbuf_merge(gnrc_pktsnip_t *pkt)
Merge pktsnip chain to single pktsnip.
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:179
void gnrc_pktbuf_stats(void)
Prints some statistics about the packet buffer to stdout.
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 for thread synchronization.
General definitions for network packets and their helper functions.
Error reporting definitions.
Protocol type definitions.
Type to represent parts (either headers or payload) of a packet, called snips.
Definition: pkt.h:108
Macros for basic linked list operations.