mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
159 lines
5.6 KiB
C
159 lines
5.6 KiB
C
/*
|
|
* Copyright (C) 2014, 2015 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.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup net_ng_pkt Packet
|
|
* @brief Network packet abstraction types
|
|
* @ingroup net
|
|
* @{
|
|
*
|
|
* @file
|
|
* @brief General definitions for network packets
|
|
*
|
|
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
|
|
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
|
|
*/
|
|
#ifndef NG_PKT_H_
|
|
#define NG_PKT_H_
|
|
|
|
#include <inttypes.h>
|
|
#include <stdlib.h>
|
|
|
|
#include "net/ng_nettype.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Type to represent parts (either headers or payload) of a packet,
|
|
* called snips.
|
|
* @details The idea behind the packet snips is that they either can represent
|
|
* protocol-specific headers or payload. A packet can be comprised of
|
|
* multiple pktsnip_t elements.
|
|
*
|
|
* Example:
|
|
*
|
|
* buffer
|
|
* +---------------------------+ +------+
|
|
* | size = 14 | data +-------------->| |
|
|
* | type = NETTYPE_ETHERNET |------+ +------+
|
|
* +---------------------------+ . .
|
|
* | next . .
|
|
* v +------+
|
|
* +---------------------------+ +----------->| |
|
|
* | size = 40 | data | | |
|
|
* | type = NETTYPE_IPV6 |---------+ +------+
|
|
* +---------------------------+ . .
|
|
* | next . .
|
|
* v +------+
|
|
* +---------------------------+ +-------->| |
|
|
* | size = 8 | data | +------+
|
|
* | type = NETTYPE_UDP |------------+ . .
|
|
* +---------------------------+ . .
|
|
* | next +------+
|
|
* v +----->| |
|
|
* +---------------------------+ | | |
|
|
* | size = 59 | data | . .
|
|
* | type = NETTYPE_UNDEF |---------------+ . .
|
|
* +---------------------------+ . .
|
|
*
|
|
* To keep data duplication as low as possible the order of the snips
|
|
* in a packet will be reversed depending on if you send the packet or if
|
|
* you received it. For sending the order is from (in the network stack) lowest
|
|
* protocol snip to the highest, for receiving the order is from highest
|
|
* snip to the lowest. This way, if a layer needs to duplicate the packet
|
|
* a tree is created rather than a duplication of the whole package.
|
|
*
|
|
* A very extreme example for this (we only expect one or two duplications at
|
|
* maximum per package) can be seen here:
|
|
*
|
|
* Sending Receiving
|
|
* ======= =========
|
|
*
|
|
* * Payload * L2 header
|
|
* ^ ^
|
|
* | |
|
|
* |\ |\
|
|
* | * L4 header 1 | * L2.5 header 1
|
|
* | * L3 header 1 | * L3 header 1
|
|
* | * netif header 1 | * L4 header 1
|
|
* * L4 header 2 | * Payload 1
|
|
* ^ * L3 header 2
|
|
* | ^
|
|
* |\ |
|
|
* | * L3 header 2 |\
|
|
* | * L2 header 2 | * L4 header 2
|
|
* * L2 header 3 | * Payload 2
|
|
* |\ * Payload 3
|
|
* | * L2 header 3
|
|
* * L2 header 4
|
|
*
|
|
* @note This type has no initializer on purpose. Please use @ref net_ng_pktbuf
|
|
* as factory.
|
|
*/
|
|
/* packed to be aligned correctly in the static packet buffer */
|
|
typedef struct ng_pktsnip {
|
|
/**
|
|
* @brief Counter of threads currently having control over this packet.
|
|
*
|
|
* @internal
|
|
*/
|
|
unsigned int users;
|
|
struct ng_pktsnip *next; /**< next snip in the packet */
|
|
void *data; /**< pointer to the data of the snip */
|
|
size_t size; /**< the length of the snip in byte */
|
|
ng_nettype_t type; /**< protocol of the packet snip */
|
|
} ng_pktsnip_t;
|
|
|
|
/**
|
|
* @brief Calculates length of a packet in byte.
|
|
*
|
|
* @param[in] pkt list of packet snips.
|
|
*
|
|
* @return length of the list of headers.
|
|
*/
|
|
static inline size_t ng_pkt_len(ng_pktsnip_t *pkt)
|
|
{
|
|
size_t len = 0;
|
|
|
|
while (pkt) {
|
|
len += pkt->size;
|
|
pkt = pkt->next;
|
|
}
|
|
|
|
return len;
|
|
}
|
|
|
|
/**
|
|
* @brief Count the numbers of snips in the given packet
|
|
*
|
|
* @param[in] pkt first snip in the packet
|
|
*
|
|
* @return number of snips in the given packet
|
|
*/
|
|
static inline size_t ng_pkt_count(const ng_pktsnip_t *pkt)
|
|
{
|
|
size_t count = 0;
|
|
|
|
while (pkt) {
|
|
++count;
|
|
pkt = pkt->next;
|
|
}
|
|
|
|
return count;
|
|
}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* NG_PKT_H_ */
|
|
/** @} */
|