[164] | 1 | /*
|
---|
| 2 | * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
|
---|
| 3 | * All rights reserved.
|
---|
| 4 | *
|
---|
| 5 | * Redistribution and use in source and binary forms, with or without modification,
|
---|
| 6 | * are permitted provided that the following conditions are met:
|
---|
| 7 | *
|
---|
| 8 | * 1. Redistributions of source code must retain the above copyright notice,
|
---|
| 9 | * this list of conditions and the following disclaimer.
|
---|
| 10 | * 2. Redistributions in binary form must reproduce the above copyright notice,
|
---|
| 11 | * this list of conditions and the following disclaimer in the documentation
|
---|
| 12 | * and/or other materials provided with the distribution.
|
---|
| 13 | * 3. The name of the author may not be used to endorse or promote products
|
---|
| 14 | * derived from this software without specific prior written permission.
|
---|
| 15 | *
|
---|
| 16 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
|
---|
| 17 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
---|
| 18 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
|
---|
| 19 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
---|
| 20 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
|
---|
| 21 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
---|
| 22 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
---|
| 23 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
|
---|
| 24 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
|
---|
| 25 | * OF SUCH DAMAGE.
|
---|
| 26 | *
|
---|
| 27 | * This file is part of the lwIP TCP/IP stack.
|
---|
| 28 | *
|
---|
| 29 | * Author: Adam Dunkels <adam@sics.se>
|
---|
| 30 | *
|
---|
| 31 | */
|
---|
| 32 |
|
---|
| 33 | #ifndef __LWIP_PBUF_H__
|
---|
| 34 | #define __LWIP_PBUF_H__
|
---|
| 35 |
|
---|
| 36 | #include "lwip/opt.h"
|
---|
| 37 | #include "lwip/err.h"
|
---|
| 38 |
|
---|
| 39 | #ifdef __cplusplus
|
---|
| 40 | extern "C" {
|
---|
| 41 | #endif
|
---|
| 42 |
|
---|
| 43 | /** Currently, the pbuf_custom code is only needed for one specific configuration
|
---|
| 44 | * of IP_FRAG */
|
---|
| 45 | #define LWIP_SUPPORT_CUSTOM_PBUF (IP_FRAG && !IP_FRAG_USES_STATIC_BUF && !LWIP_NETIF_TX_SINGLE_PBUF)
|
---|
| 46 |
|
---|
| 47 | #define PBUF_TRANSPORT_HLEN 20
|
---|
| 48 | #define PBUF_IP_HLEN 20
|
---|
| 49 |
|
---|
| 50 | typedef enum {
|
---|
| 51 | PBUF_TRANSPORT,
|
---|
| 52 | PBUF_IP,
|
---|
| 53 | PBUF_LINK,
|
---|
| 54 | PBUF_RAW
|
---|
| 55 | } pbuf_layer;
|
---|
| 56 |
|
---|
| 57 | typedef enum {
|
---|
| 58 | PBUF_RAM, /* pbuf data is stored in RAM */
|
---|
| 59 | PBUF_ROM, /* pbuf data is stored in ROM */
|
---|
| 60 | PBUF_REF, /* pbuf comes from the pbuf pool */
|
---|
| 61 | PBUF_POOL /* pbuf payload refers to RAM */
|
---|
| 62 | } pbuf_type;
|
---|
| 63 |
|
---|
| 64 |
|
---|
| 65 | /** indicates this packet's data should be immediately passed to the application */
|
---|
| 66 | #define PBUF_FLAG_PUSH 0x01U
|
---|
| 67 | /** indicates this is a custom pbuf: pbuf_free and pbuf_header handle such a
|
---|
| 68 | a pbuf differently */
|
---|
| 69 | #define PBUF_FLAG_IS_CUSTOM 0x02U
|
---|
| 70 | /** indicates this pbuf is UDP multicast to be looped back */
|
---|
| 71 | #define PBUF_FLAG_MCASTLOOP 0x04U
|
---|
| 72 | /** indicates this pbuf was received as link-level broadcast */
|
---|
| 73 | #define PBUF_FLAG_LLBCAST 0x08U
|
---|
| 74 | /** indicates this pbuf was received as link-level multicast */
|
---|
| 75 | #define PBUF_FLAG_LLMCAST 0x10U
|
---|
| 76 | /** indicates this pbuf includes a TCP FIN flag */
|
---|
| 77 | #define PBUF_FLAG_TCP_FIN 0x20U
|
---|
| 78 |
|
---|
| 79 | struct pbuf {
|
---|
| 80 | /** next pbuf in singly linked pbuf chain */
|
---|
| 81 | struct pbuf *next;
|
---|
| 82 |
|
---|
| 83 | /** pointer to the actual data in the buffer */
|
---|
| 84 | void *payload;
|
---|
| 85 |
|
---|
| 86 | /**
|
---|
| 87 | * total length of this buffer and all next buffers in chain
|
---|
| 88 | * belonging to the same packet.
|
---|
| 89 | *
|
---|
| 90 | * For non-queue packet chains this is the invariant:
|
---|
| 91 | * p->tot_len == p->len + (p->next? p->next->tot_len: 0)
|
---|
| 92 | */
|
---|
| 93 | u16_t tot_len;
|
---|
| 94 |
|
---|
| 95 | /** length of this buffer */
|
---|
| 96 | u16_t len;
|
---|
| 97 |
|
---|
| 98 | /** pbuf_type as u8_t instead of enum to save space */
|
---|
| 99 | u8_t /*pbuf_type*/ type;
|
---|
| 100 |
|
---|
| 101 | /** misc flags */
|
---|
| 102 | u8_t flags;
|
---|
| 103 |
|
---|
| 104 | /**
|
---|
| 105 | * the reference count always equals the number of pointers
|
---|
| 106 | * that refer to this pbuf. This can be pointers from an application,
|
---|
| 107 | * the stack itself, or pbuf->next pointers from a chain.
|
---|
| 108 | */
|
---|
| 109 | u16_t ref;
|
---|
| 110 | };
|
---|
| 111 |
|
---|
| 112 | #if LWIP_SUPPORT_CUSTOM_PBUF
|
---|
| 113 | /** Prototype for a function to free a custom pbuf */
|
---|
| 114 | typedef void (*pbuf_free_custom_fn)(struct pbuf *p);
|
---|
| 115 |
|
---|
| 116 | /** A custom pbuf: like a pbuf, but following a function pointer to free it. */
|
---|
| 117 | struct pbuf_custom {
|
---|
| 118 | /** The actual pbuf */
|
---|
| 119 | struct pbuf pbuf;
|
---|
| 120 | /** This function is called when pbuf_free deallocates this pbuf(_custom) */
|
---|
| 121 | pbuf_free_custom_fn custom_free_function;
|
---|
| 122 | };
|
---|
| 123 | #endif /* LWIP_SUPPORT_CUSTOM_PBUF */
|
---|
| 124 |
|
---|
| 125 | #if LWIP_TCP && TCP_QUEUE_OOSEQ
|
---|
| 126 | /** Define this to 0 to prevent freeing ooseq pbufs when the PBUF_POOL is empty */
|
---|
| 127 | #ifndef PBUF_POOL_FREE_OOSEQ
|
---|
| 128 | #define PBUF_POOL_FREE_OOSEQ 1
|
---|
| 129 | #endif /* PBUF_POOL_FREE_OOSEQ */
|
---|
| 130 | #if NO_SYS && PBUF_POOL_FREE_OOSEQ
|
---|
| 131 | extern volatile u8_t pbuf_free_ooseq_pending;
|
---|
| 132 | void pbuf_free_ooseq();
|
---|
| 133 | /** When not using sys_check_timeouts(), call PBUF_CHECK_FREE_OOSEQ()
|
---|
| 134 | at regular intervals from main level to check if ooseq pbufs need to be
|
---|
| 135 | freed! */
|
---|
| 136 | #define PBUF_CHECK_FREE_OOSEQ() do { if(pbuf_free_ooseq_pending) { \
|
---|
| 137 | /* pbuf_alloc() reported PBUF_POOL to be empty -> try to free some \
|
---|
| 138 | ooseq queued pbufs now */ \
|
---|
| 139 | pbuf_free_ooseq(); }}while(0)
|
---|
| 140 | #endif /* NO_SYS && PBUF_POOL_FREE_OOSEQ*/
|
---|
| 141 | #endif /* LWIP_TCP && TCP_QUEUE_OOSEQ */
|
---|
| 142 |
|
---|
| 143 | /* Initializes the pbuf module. This call is empty for now, but may not be in future. */
|
---|
| 144 | #define pbuf_init()
|
---|
| 145 |
|
---|
| 146 | struct pbuf *pbuf_alloc(pbuf_layer l, u16_t length, pbuf_type type);
|
---|
| 147 | #if LWIP_SUPPORT_CUSTOM_PBUF
|
---|
| 148 | struct pbuf *pbuf_alloced_custom(pbuf_layer l, u16_t length, pbuf_type type,
|
---|
| 149 | struct pbuf_custom *p, void *payload_mem,
|
---|
| 150 | u16_t payload_mem_len);
|
---|
| 151 | #endif /* LWIP_SUPPORT_CUSTOM_PBUF */
|
---|
| 152 | void pbuf_realloc(struct pbuf *p, u16_t size);
|
---|
| 153 | u8_t pbuf_header(struct pbuf *p, s16_t header_size);
|
---|
| 154 | void pbuf_ref(struct pbuf *p);
|
---|
| 155 | u8_t pbuf_free(struct pbuf *p);
|
---|
| 156 | u8_t pbuf_clen(struct pbuf *p);
|
---|
| 157 | void pbuf_cat(struct pbuf *head, struct pbuf *tail);
|
---|
| 158 | void pbuf_chain(struct pbuf *head, struct pbuf *tail);
|
---|
| 159 | struct pbuf *pbuf_dechain(struct pbuf *p);
|
---|
| 160 | err_t pbuf_copy(struct pbuf *p_to, struct pbuf *p_from);
|
---|
| 161 | u16_t pbuf_copy_partial(struct pbuf *p, void *dataptr, u16_t len, u16_t offset);
|
---|
| 162 | err_t pbuf_take(struct pbuf *buf, const void *dataptr, u16_t len);
|
---|
| 163 | struct pbuf *pbuf_coalesce(struct pbuf *p, pbuf_layer layer);
|
---|
| 164 | #if LWIP_CHECKSUM_ON_COPY
|
---|
| 165 | err_t pbuf_fill_chksum(struct pbuf *p, u16_t start_offset, const void *dataptr,
|
---|
| 166 | u16_t len, u16_t *chksum);
|
---|
| 167 | #endif /* LWIP_CHECKSUM_ON_COPY */
|
---|
| 168 |
|
---|
| 169 | u8_t pbuf_get_at(struct pbuf* p, u16_t offset);
|
---|
| 170 | u16_t pbuf_memcmp(struct pbuf* p, u16_t offset, const void* s2, u16_t n);
|
---|
| 171 | u16_t pbuf_memfind(struct pbuf* p, const void* mem, u16_t mem_len, u16_t start_offset);
|
---|
| 172 | u16_t pbuf_strstr(struct pbuf* p, const char* substr);
|
---|
| 173 |
|
---|
| 174 | #ifdef __cplusplus
|
---|
| 175 | }
|
---|
| 176 | #endif
|
---|
| 177 |
|
---|
| 178 | #endif /* __LWIP_PBUF_H__ */
|
---|