pktbuf.h

Go to the documentation of this file.

/*
 * Copyright (C) 2014 Martine Lenders <mlenders@inf.fu-berlin.de>
 *               2015 Freie Universität Berlin
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#pragma once

 
#include <stdbool.h>
#include <stdlib.h>
#include <string.h>
 
#include "compiler_hints.h"
#include "net/gnrc/pkt.h"
#include "net/gnrc/neterr.h"
#include "net/gnrc/nettype.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#ifndef CONFIG_GNRC_PKTBUF_SIZE
#define CONFIG_GNRC_PKTBUF_SIZE    (6144)
#endif

#ifndef CONFIG_GNRC_PKTBUF_CHECK_USE_AFTER_FREE
#define CONFIG_GNRC_PKTBUF_CHECK_USE_AFTER_FREE (0)
#endif

#define GNRC_PKTBUF_CANARY          (0x55)

void gnrc_pktbuf_init(void);

gnrc_pktsnip_t *gnrc_pktbuf_add(gnrc_pktsnip_t *next, const void *data, size_t size,
                                gnrc_nettype_t type);

gnrc_pktsnip_t *gnrc_pktbuf_mark(gnrc_pktsnip_t *pkt, size_t size, gnrc_nettype_t type);

int gnrc_pktbuf_realloc_data(gnrc_pktsnip_t *pkt, size_t size);

void gnrc_pktbuf_hold(gnrc_pktsnip_t *pkt, unsigned int num);

void gnrc_pktbuf_release_error(gnrc_pktsnip_t *pkt, uint32_t err);

static inline void gnrc_pktbuf_release(gnrc_pktsnip_t *pkt)
{
    gnrc_pktbuf_release_error(pkt, GNRC_NETERR_SUCCESS);
}

gnrc_pktsnip_t *gnrc_pktbuf_start_write(gnrc_pktsnip_t *pkt);

gnrc_pktsnip_t *gnrc_pktbuf_remove_snip(gnrc_pktsnip_t *pkt, gnrc_pktsnip_t *snip);

gnrc_pktsnip_t *gnrc_pktbuf_reverse_snips(gnrc_pktsnip_t *pkt);

int gnrc_pktbuf_merge(gnrc_pktsnip_t *pkt);
 
#ifdef DEVELHELP
void gnrc_pktbuf_stats(void);
#endif
 
/* for testing */
#ifdef TEST_SUITES
bool gnrc_pktbuf_is_empty(void);

bool gnrc_pktbuf_is_sane(void);
#endif
 
#ifdef __cplusplus
}
#endif