Yann Garcia / Mbed 2 deprecated DS130x_I2CApp

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed DebugLibrary

NetServices/lwip/core/pbuf.c@0:f30e2135b0db, 2011-02-09 (annotated)

Committer:
Yann
Date:
Wed Feb 09 13:57:49 2011 +0000
Revision:
0:f30e2135b0db
V0.0.0.1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Yann 0:f30e2135b0db 1 /**
Yann 0:f30e2135b0db 2 * @file
Yann 0:f30e2135b0db 3 * Packet buffer management
Yann 0:f30e2135b0db 4 *
Yann 0:f30e2135b0db 5 * Packets are built from the pbuf data structure. It supports dynamic
Yann 0:f30e2135b0db 6 * memory allocation for packet contents or can reference externally
Yann 0:f30e2135b0db 7 * managed packet contents both in RAM and ROM. Quick allocation for
Yann 0:f30e2135b0db 8 * incoming packets is provided through pools with fixed sized pbufs.
Yann 0:f30e2135b0db 9 *
Yann 0:f30e2135b0db 10 * A packet may span over multiple pbufs, chained as a singly linked
Yann 0:f30e2135b0db 11 * list. This is called a "pbuf chain".
Yann 0:f30e2135b0db 12 *
Yann 0:f30e2135b0db 13 * Multiple packets may be queued, also using this singly linked list.
Yann 0:f30e2135b0db 14 * This is called a "packet queue".
Yann 0:f30e2135b0db 15 *
Yann 0:f30e2135b0db 16 * So, a packet queue consists of one or more pbuf chains, each of
Yann 0:f30e2135b0db 17 * which consist of one or more pbufs. CURRENTLY, PACKET QUEUES ARE
Yann 0:f30e2135b0db 18 * NOT SUPPORTED!!! Use helper structs to queue multiple packets.
Yann 0:f30e2135b0db 19 *
Yann 0:f30e2135b0db 20 * The differences between a pbuf chain and a packet queue are very
Yann 0:f30e2135b0db 21 * precise but subtle.
Yann 0:f30e2135b0db 22 *
Yann 0:f30e2135b0db 23 * The last pbuf of a packet has a ->tot_len field that equals the
Yann 0:f30e2135b0db 24 * ->len field. It can be found by traversing the list. If the last
Yann 0:f30e2135b0db 25 * pbuf of a packet has a ->next field other than NULL, more packets
Yann 0:f30e2135b0db 26 * are on the queue.
Yann 0:f30e2135b0db 27 *
Yann 0:f30e2135b0db 28 * Therefore, looping through a pbuf of a single packet, has an
Yann 0:f30e2135b0db 29 * loop end condition (tot_len == p->len), NOT (next == NULL).
Yann 0:f30e2135b0db 30 */
Yann 0:f30e2135b0db 31
Yann 0:f30e2135b0db 32 /*
Yann 0:f30e2135b0db 33 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
Yann 0:f30e2135b0db 34 * All rights reserved.
Yann 0:f30e2135b0db 35 *
Yann 0:f30e2135b0db 36 * Redistribution and use in source and binary forms, with or without modification,
Yann 0:f30e2135b0db 37 * are permitted provided that the following conditions are met:
Yann 0:f30e2135b0db 38 *
Yann 0:f30e2135b0db 39 * 1. Redistributions of source code must retain the above copyright notice,
Yann 0:f30e2135b0db 40 * this list of conditions and the following disclaimer.
Yann 0:f30e2135b0db 41 * 2. Redistributions in binary form must reproduce the above copyright notice,
Yann 0:f30e2135b0db 42 * this list of conditions and the following disclaimer in the documentation
Yann 0:f30e2135b0db 43 * and/or other materials provided with the distribution.
Yann 0:f30e2135b0db 44 * 3. The name of the author may not be used to endorse or promote products
Yann 0:f30e2135b0db 45 * derived from this software without specific prior written permission.
Yann 0:f30e2135b0db 46 *
Yann 0:f30e2135b0db 47 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
Yann 0:f30e2135b0db 48 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
Yann 0:f30e2135b0db 49 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
Yann 0:f30e2135b0db 50 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
Yann 0:f30e2135b0db 51 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
Yann 0:f30e2135b0db 52 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
Yann 0:f30e2135b0db 53 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
Yann 0:f30e2135b0db 54 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
Yann 0:f30e2135b0db 55 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
Yann 0:f30e2135b0db 56 * OF SUCH DAMAGE.
Yann 0:f30e2135b0db 57 *
Yann 0:f30e2135b0db 58 * This file is part of the lwIP TCP/IP stack.
Yann 0:f30e2135b0db 59 *
Yann 0:f30e2135b0db 60 * Author: Adam Dunkels <adam@sics.se>
Yann 0:f30e2135b0db 61 *
Yann 0:f30e2135b0db 62 */
Yann 0:f30e2135b0db 63
Yann 0:f30e2135b0db 64 #include "lwip/opt.h"
Yann 0:f30e2135b0db 65
Yann 0:f30e2135b0db 66 #include "lwip/stats.h"
Yann 0:f30e2135b0db 67 #include "lwip/def.h"
Yann 0:f30e2135b0db 68 #include "lwip/mem.h"
Yann 0:f30e2135b0db 69 #include "lwip/memp.h"
Yann 0:f30e2135b0db 70 #include "lwip/pbuf.h"
Yann 0:f30e2135b0db 71 #include "lwip/sys.h"
Yann 0:f30e2135b0db 72 #include "arch/perf.h"
Yann 0:f30e2135b0db 73 #if TCP_QUEUE_OOSEQ
Yann 0:f30e2135b0db 74 #include "lwip/tcp_impl.h"
Yann 0:f30e2135b0db 75 #endif
Yann 0:f30e2135b0db 76 #if LWIP_CHECKSUM_ON_COPY
Yann 0:f30e2135b0db 77 #include "lwip/inet_chksum.h"
Yann 0:f30e2135b0db 78 #endif
Yann 0:f30e2135b0db 79
Yann 0:f30e2135b0db 80 #include <string.h>
Yann 0:f30e2135b0db 81
Yann 0:f30e2135b0db 82 #define SIZEOF_STRUCT_PBUF LWIP_MEM_ALIGN_SIZE(sizeof(struct pbuf))
Yann 0:f30e2135b0db 83 /* Since the pool is created in memp, PBUF_POOL_BUFSIZE will be automatically
Yann 0:f30e2135b0db 84 aligned there. Therefore, PBUF_POOL_BUFSIZE_ALIGNED can be used here. */
Yann 0:f30e2135b0db 85 #define PBUF_POOL_BUFSIZE_ALIGNED LWIP_MEM_ALIGN_SIZE(PBUF_POOL_BUFSIZE)
Yann 0:f30e2135b0db 86
Yann 0:f30e2135b0db 87 #if !LWIP_TCP || !TCP_QUEUE_OOSEQ || NO_SYS
Yann 0:f30e2135b0db 88 #define PBUF_POOL_IS_EMPTY()
Yann 0:f30e2135b0db 89 #else /* !LWIP_TCP || !TCP_QUEUE_OOSEQ || NO_SYS */
Yann 0:f30e2135b0db 90 /** Define this to 0 to prevent freeing ooseq pbufs when the PBUF_POOL is empty */
Yann 0:f30e2135b0db 91 #ifndef PBUF_POOL_FREE_OOSEQ
Yann 0:f30e2135b0db 92 #define PBUF_POOL_FREE_OOSEQ 1
Yann 0:f30e2135b0db 93 #endif /* PBUF_POOL_FREE_OOSEQ */
Yann 0:f30e2135b0db 94
Yann 0:f30e2135b0db 95 #if PBUF_POOL_FREE_OOSEQ
Yann 0:f30e2135b0db 96 #include "lwip/tcpip.h"
Yann 0:f30e2135b0db 97 #define PBUF_POOL_IS_EMPTY() pbuf_pool_is_empty()
Yann 0:f30e2135b0db 98 static u8_t pbuf_free_ooseq_queued;
Yann 0:f30e2135b0db 99 /**
Yann 0:f30e2135b0db 100 * Attempt to reclaim some memory from queued out-of-sequence TCP segments
Yann 0:f30e2135b0db 101 * if we run out of pool pbufs. It's better to give priority to new packets
Yann 0:f30e2135b0db 102 * if we're running out.
Yann 0:f30e2135b0db 103 *
Yann 0:f30e2135b0db 104 * This must be done in the correct thread context therefore this function
Yann 0:f30e2135b0db 105 * can only be used with NO_SYS=0 and through tcpip_callback.
Yann 0:f30e2135b0db 106 */
Yann 0:f30e2135b0db 107 static void
Yann 0:f30e2135b0db 108 pbuf_free_ooseq(void* arg)
Yann 0:f30e2135b0db 109 {
Yann 0:f30e2135b0db 110 struct tcp_pcb* pcb;
Yann 0:f30e2135b0db 111 SYS_ARCH_DECL_PROTECT(old_level);
Yann 0:f30e2135b0db 112 LWIP_UNUSED_ARG(arg);
Yann 0:f30e2135b0db 113
Yann 0:f30e2135b0db 114 SYS_ARCH_PROTECT(old_level);
Yann 0:f30e2135b0db 115 pbuf_free_ooseq_queued = 0;
Yann 0:f30e2135b0db 116 SYS_ARCH_UNPROTECT(old_level);
Yann 0:f30e2135b0db 117
Yann 0:f30e2135b0db 118 for (pcb = tcp_active_pcbs; NULL != pcb; pcb = pcb->next) {
Yann 0:f30e2135b0db 119 if (NULL != pcb->ooseq) {
Yann 0:f30e2135b0db 120 /** Free the ooseq pbufs of one PCB only */
Yann 0:f30e2135b0db 121 LWIP_DEBUGF(PBUF_DEBUG | LWIP_DBG_TRACE, ("pbuf_free_ooseq: freeing out-of-sequence pbufs\n"));
Yann 0:f30e2135b0db 122 tcp_segs_free(pcb->ooseq);
Yann 0:f30e2135b0db 123 pcb->ooseq = NULL;
Yann 0:f30e2135b0db 124 return;
Yann 0:f30e2135b0db 125 }
Yann 0:f30e2135b0db 126 }
Yann 0:f30e2135b0db 127 }
Yann 0:f30e2135b0db 128
Yann 0:f30e2135b0db 129 /** Queue a call to pbuf_free_ooseq if not already queued. */
Yann 0:f30e2135b0db 130 static void
Yann 0:f30e2135b0db 131 pbuf_pool_is_empty(void)
Yann 0:f30e2135b0db 132 {
Yann 0:f30e2135b0db 133 u8_t queued;
Yann 0:f30e2135b0db 134 SYS_ARCH_DECL_PROTECT(old_level);
Yann 0:f30e2135b0db 135
Yann 0:f30e2135b0db 136 SYS_ARCH_PROTECT(old_level);
Yann 0:f30e2135b0db 137 queued = pbuf_free_ooseq_queued;
Yann 0:f30e2135b0db 138 pbuf_free_ooseq_queued = 1;
Yann 0:f30e2135b0db 139 SYS_ARCH_UNPROTECT(old_level);
Yann 0:f30e2135b0db 140
Yann 0:f30e2135b0db 141 if(!queued) {
Yann 0:f30e2135b0db 142 /* queue a call to pbuf_free_ooseq if not already queued */
Yann 0:f30e2135b0db 143 if(tcpip_callback_with_block(pbuf_free_ooseq, NULL, 0) != ERR_OK) {
Yann 0:f30e2135b0db 144 SYS_ARCH_PROTECT(old_level);
Yann 0:f30e2135b0db 145 pbuf_free_ooseq_queued = 0;
Yann 0:f30e2135b0db 146 SYS_ARCH_UNPROTECT(old_level);
Yann 0:f30e2135b0db 147 }
Yann 0:f30e2135b0db 148 }
Yann 0:f30e2135b0db 149 }
Yann 0:f30e2135b0db 150 #endif /* PBUF_POOL_FREE_OOSEQ */
Yann 0:f30e2135b0db 151 #endif /* !LWIP_TCP || !TCP_QUEUE_OOSEQ || NO_SYS */
Yann 0:f30e2135b0db 152
Yann 0:f30e2135b0db 153 /**
Yann 0:f30e2135b0db 154 * Allocates a pbuf of the given type (possibly a chain for PBUF_POOL type).
Yann 0:f30e2135b0db 155 *
Yann 0:f30e2135b0db 156 * The actual memory allocated for the pbuf is determined by the
Yann 0:f30e2135b0db 157 * layer at which the pbuf is allocated and the requested size
Yann 0:f30e2135b0db 158 * (from the size parameter).
Yann 0:f30e2135b0db 159 *
Yann 0:f30e2135b0db 160 * @param layer flag to define header size
Yann 0:f30e2135b0db 161 * @param length size of the pbuf's payload
Yann 0:f30e2135b0db 162 * @param type this parameter decides how and where the pbuf
Yann 0:f30e2135b0db 163 * should be allocated as follows:
Yann 0:f30e2135b0db 164 *
Yann 0:f30e2135b0db 165 * - PBUF_RAM: buffer memory for pbuf is allocated as one large
Yann 0:f30e2135b0db 166 * chunk. This includes protocol headers as well.
Yann 0:f30e2135b0db 167 * - PBUF_ROM: no buffer memory is allocated for the pbuf, even for
Yann 0:f30e2135b0db 168 * protocol headers. Additional headers must be prepended
Yann 0:f30e2135b0db 169 * by allocating another pbuf and chain in to the front of
Yann 0:f30e2135b0db 170 * the ROM pbuf. It is assumed that the memory used is really
Yann 0:f30e2135b0db 171 * similar to ROM in that it is immutable and will not be
Yann 0:f30e2135b0db 172 * changed. Memory which is dynamic should generally not
Yann 0:f30e2135b0db 173 * be attached to PBUF_ROM pbufs. Use PBUF_REF instead.
Yann 0:f30e2135b0db 174 * - PBUF_REF: no buffer memory is allocated for the pbuf, even for
Yann 0:f30e2135b0db 175 * protocol headers. It is assumed that the pbuf is only
Yann 0:f30e2135b0db 176 * being used in a single thread. If the pbuf gets queued,
Yann 0:f30e2135b0db 177 * then pbuf_take should be called to copy the buffer.
Yann 0:f30e2135b0db 178 * - PBUF_POOL: the pbuf is allocated as a pbuf chain, with pbufs from
Yann 0:f30e2135b0db 179 * the pbuf pool that is allocated during pbuf_init().
Yann 0:f30e2135b0db 180 *
Yann 0:f30e2135b0db 181 * @return the allocated pbuf. If multiple pbufs where allocated, this
Yann 0:f30e2135b0db 182 * is the first pbuf of a pbuf chain.
Yann 0:f30e2135b0db 183 */
Yann 0:f30e2135b0db 184 struct pbuf *
Yann 0:f30e2135b0db 185 pbuf_alloc(pbuf_layer layer, u16_t length, pbuf_type type)
Yann 0:f30e2135b0db 186 {
Yann 0:f30e2135b0db 187 struct pbuf *p, *q, *r;
Yann 0:f30e2135b0db 188 u16_t offset;
Yann 0:f30e2135b0db 189 s32_t rem_len; /* remaining length */
Yann 0:f30e2135b0db 190 LWIP_DEBUGF(PBUF_DEBUG | LWIP_DBG_TRACE, ("pbuf_alloc(length=%"U16_F")\n", length));
Yann 0:f30e2135b0db 191
Yann 0:f30e2135b0db 192 /* determine header offset */
Yann 0:f30e2135b0db 193 offset = 0;
Yann 0:f30e2135b0db 194 switch (layer) {
Yann 0:f30e2135b0db 195 case PBUF_TRANSPORT:
Yann 0:f30e2135b0db 196 /* add room for transport (often TCP) layer header */
Yann 0:f30e2135b0db 197 offset += PBUF_TRANSPORT_HLEN;
Yann 0:f30e2135b0db 198 /* FALLTHROUGH */
Yann 0:f30e2135b0db 199 case PBUF_IP:
Yann 0:f30e2135b0db 200 /* add room for IP layer header */
Yann 0:f30e2135b0db 201 offset += PBUF_IP_HLEN;
Yann 0:f30e2135b0db 202 /* FALLTHROUGH */
Yann 0:f30e2135b0db 203 case PBUF_LINK:
Yann 0:f30e2135b0db 204 /* add room for link layer header */
Yann 0:f30e2135b0db 205 offset += PBUF_LINK_HLEN;
Yann 0:f30e2135b0db 206 break;
Yann 0:f30e2135b0db 207 case PBUF_RAW:
Yann 0:f30e2135b0db 208 break;
Yann 0:f30e2135b0db 209 default:
Yann 0:f30e2135b0db 210 LWIP_ASSERT("pbuf_alloc: bad pbuf layer", 0);
Yann 0:f30e2135b0db 211 return NULL;
Yann 0:f30e2135b0db 212 }
Yann 0:f30e2135b0db 213
Yann 0:f30e2135b0db 214 switch (type) {
Yann 0:f30e2135b0db 215 case PBUF_POOL:
Yann 0:f30e2135b0db 216 /* allocate head of pbuf chain into p */
Yann 0:f30e2135b0db 217 p = (struct pbuf *)memp_malloc(MEMP_PBUF_POOL);
Yann 0:f30e2135b0db 218 LWIP_DEBUGF(PBUF_DEBUG | LWIP_DBG_TRACE, ("pbuf_alloc: allocated pbuf %p\n", (void *)p));
Yann 0:f30e2135b0db 219 if (p == NULL) {
Yann 0:f30e2135b0db 220 PBUF_POOL_IS_EMPTY();
Yann 0:f30e2135b0db 221 return NULL;
Yann 0:f30e2135b0db 222 }
Yann 0:f30e2135b0db 223 p->type = type;
Yann 0:f30e2135b0db 224 p->next = NULL;
Yann 0:f30e2135b0db 225
Yann 0:f30e2135b0db 226 /* make the payload pointer point 'offset' bytes into pbuf data memory */
Yann 0:f30e2135b0db 227 p->payload = LWIP_MEM_ALIGN((void *)((u8_t *)p + (SIZEOF_STRUCT_PBUF + offset)));
Yann 0:f30e2135b0db 228 LWIP_ASSERT("pbuf_alloc: pbuf p->payload properly aligned",
Yann 0:f30e2135b0db 229 ((mem_ptr_t)p->payload % MEM_ALIGNMENT) == 0);
Yann 0:f30e2135b0db 230 /* the total length of the pbuf chain is the requested size */
Yann 0:f30e2135b0db 231 p->tot_len = length;
Yann 0:f30e2135b0db 232 /* set the length of the first pbuf in the chain */
Yann 0:f30e2135b0db 233 p->len = LWIP_MIN(length, PBUF_POOL_BUFSIZE_ALIGNED - LWIP_MEM_ALIGN_SIZE(offset));
Yann 0:f30e2135b0db 234 LWIP_ASSERT("check p->payload + p->len does not overflow pbuf",
Yann 0:f30e2135b0db 235 ((u8_t*)p->payload + p->len <=
Yann 0:f30e2135b0db 236 (u8_t*)p + SIZEOF_STRUCT_PBUF + PBUF_POOL_BUFSIZE_ALIGNED));
Yann 0:f30e2135b0db 237 LWIP_ASSERT("PBUF_POOL_BUFSIZE must be bigger than MEM_ALIGNMENT",
Yann 0:f30e2135b0db 238 (PBUF_POOL_BUFSIZE_ALIGNED - LWIP_MEM_ALIGN_SIZE(offset)) > 0 );
Yann 0:f30e2135b0db 239 /* set reference count (needed here in case we fail) */
Yann 0:f30e2135b0db 240 p->ref = 1;
Yann 0:f30e2135b0db 241
Yann 0:f30e2135b0db 242 /* now allocate the tail of the pbuf chain */
Yann 0:f30e2135b0db 243
Yann 0:f30e2135b0db 244 /* remember first pbuf for linkage in next iteration */
Yann 0:f30e2135b0db 245 r = p;
Yann 0:f30e2135b0db 246 /* remaining length to be allocated */
Yann 0:f30e2135b0db 247 rem_len = length - p->len;
Yann 0:f30e2135b0db 248 /* any remaining pbufs to be allocated? */
Yann 0:f30e2135b0db 249 while (rem_len > 0) {
Yann 0:f30e2135b0db 250 q = (struct pbuf *)memp_malloc(MEMP_PBUF_POOL);
Yann 0:f30e2135b0db 251 if (q == NULL) {
Yann 0:f30e2135b0db 252 PBUF_POOL_IS_EMPTY();
Yann 0:f30e2135b0db 253 /* free chain so far allocated */
Yann 0:f30e2135b0db 254 pbuf_free(p);
Yann 0:f30e2135b0db 255 /* bail out unsuccesfully */
Yann 0:f30e2135b0db 256 return NULL;
Yann 0:f30e2135b0db 257 }
Yann 0:f30e2135b0db 258 q->type = type;
Yann 0:f30e2135b0db 259 q->flags = 0;
Yann 0:f30e2135b0db 260 q->next = NULL;
Yann 0:f30e2135b0db 261 /* make previous pbuf point to this pbuf */
Yann 0:f30e2135b0db 262 r->next = q;
Yann 0:f30e2135b0db 263 /* set total length of this pbuf and next in chain */
Yann 0:f30e2135b0db 264 LWIP_ASSERT("rem_len < max_u16_t", rem_len < 0xffff);
Yann 0:f30e2135b0db 265 q->tot_len = (u16_t)rem_len;
Yann 0:f30e2135b0db 266 /* this pbuf length is pool size, unless smaller sized tail */
Yann 0:f30e2135b0db 267 q->len = LWIP_MIN((u16_t)rem_len, PBUF_POOL_BUFSIZE_ALIGNED);
Yann 0:f30e2135b0db 268 q->payload = (void *)((u8_t *)q + SIZEOF_STRUCT_PBUF);
Yann 0:f30e2135b0db 269 LWIP_ASSERT("pbuf_alloc: pbuf q->payload properly aligned",
Yann 0:f30e2135b0db 270 ((mem_ptr_t)q->payload % MEM_ALIGNMENT) == 0);
Yann 0:f30e2135b0db 271 LWIP_ASSERT("check p->payload + p->len does not overflow pbuf",
Yann 0:f30e2135b0db 272 ((u8_t*)p->payload + p->len <=
Yann 0:f30e2135b0db 273 (u8_t*)p + SIZEOF_STRUCT_PBUF + PBUF_POOL_BUFSIZE_ALIGNED));
Yann 0:f30e2135b0db 274 q->ref = 1;
Yann 0:f30e2135b0db 275 /* calculate remaining length to be allocated */
Yann 0:f30e2135b0db 276 rem_len -= q->len;
Yann 0:f30e2135b0db 277 /* remember this pbuf for linkage in next iteration */
Yann 0:f30e2135b0db 278 r = q;
Yann 0:f30e2135b0db 279 }
Yann 0:f30e2135b0db 280 /* end of chain */
Yann 0:f30e2135b0db 281 /*r->next = NULL;*/
Yann 0:f30e2135b0db 282
Yann 0:f30e2135b0db 283 break;
Yann 0:f30e2135b0db 284 case PBUF_RAM:
Yann 0:f30e2135b0db 285 /* If pbuf is to be allocated in RAM, allocate memory for it. */
Yann 0:f30e2135b0db 286 p = (struct pbuf*)mem_malloc(LWIP_MEM_ALIGN_SIZE(SIZEOF_STRUCT_PBUF + offset) + LWIP_MEM_ALIGN_SIZE(length));
Yann 0:f30e2135b0db 287 if (p == NULL) {
Yann 0:f30e2135b0db 288 return NULL;
Yann 0:f30e2135b0db 289 }
Yann 0:f30e2135b0db 290 /* Set up internal structure of the pbuf. */
Yann 0:f30e2135b0db 291 p->payload = LWIP_MEM_ALIGN((void *)((u8_t *)p + SIZEOF_STRUCT_PBUF + offset));
Yann 0:f30e2135b0db 292 p->len = p->tot_len = length;
Yann 0:f30e2135b0db 293 p->next = NULL;
Yann 0:f30e2135b0db 294 p->type = type;
Yann 0:f30e2135b0db 295
Yann 0:f30e2135b0db 296 LWIP_ASSERT("pbuf_alloc: pbuf->payload properly aligned",
Yann 0:f30e2135b0db 297 ((mem_ptr_t)p->payload % MEM_ALIGNMENT) == 0);
Yann 0:f30e2135b0db 298 break;
Yann 0:f30e2135b0db 299 /* pbuf references existing (non-volatile static constant) ROM payload? */
Yann 0:f30e2135b0db 300 case PBUF_ROM:
Yann 0:f30e2135b0db 301 /* pbuf references existing (externally allocated) RAM payload? */
Yann 0:f30e2135b0db 302 case PBUF_REF:
Yann 0:f30e2135b0db 303 /* only allocate memory for the pbuf structure */
Yann 0:f30e2135b0db 304 p = (struct pbuf *)memp_malloc(MEMP_PBUF);
Yann 0:f30e2135b0db 305 if (p == NULL) {
Yann 0:f30e2135b0db 306 LWIP_DEBUGF(PBUF_DEBUG | LWIP_DBG_LEVEL_SERIOUS,
Yann 0:f30e2135b0db 307 ("pbuf_alloc: Could not allocate MEMP_PBUF for PBUF_%s.\n",
Yann 0:f30e2135b0db 308 (type == PBUF_ROM) ? "ROM" : "REF"));
Yann 0:f30e2135b0db 309 return NULL;
Yann 0:f30e2135b0db 310 }
Yann 0:f30e2135b0db 311 /* caller must set this field properly, afterwards */
Yann 0:f30e2135b0db 312 p->payload = NULL;
Yann 0:f30e2135b0db 313 p->len = p->tot_len = length;
Yann 0:f30e2135b0db 314 p->next = NULL;
Yann 0:f30e2135b0db 315 p->type = type;
Yann 0:f30e2135b0db 316 break;
Yann 0:f30e2135b0db 317 default:
Yann 0:f30e2135b0db 318 LWIP_ASSERT("pbuf_alloc: erroneous type", 0);
Yann 0:f30e2135b0db 319 return NULL;
Yann 0:f30e2135b0db 320 }
Yann 0:f30e2135b0db 321 /* set reference count */
Yann 0:f30e2135b0db 322 p->ref = 1;
Yann 0:f30e2135b0db 323 /* set flags */
Yann 0:f30e2135b0db 324 p->flags = 0;
Yann 0:f30e2135b0db 325 LWIP_DEBUGF(PBUF_DEBUG | LWIP_DBG_TRACE, ("pbuf_alloc(length=%"U16_F") == %p\n", length, (void *)p));
Yann 0:f30e2135b0db 326 return p;
Yann 0:f30e2135b0db 327 }
Yann 0:f30e2135b0db 328
Yann 0:f30e2135b0db 329 #if LWIP_SUPPORT_CUSTOM_PBUF
Yann 0:f30e2135b0db 330 /** Initialize a custom pbuf (already allocated).
Yann 0:f30e2135b0db 331 *
Yann 0:f30e2135b0db 332 * @param layer flag to define header size
Yann 0:f30e2135b0db 333 * @param length size of the pbuf's payload
Yann 0:f30e2135b0db 334 * @param type type of the pbuf (only used to treat the pbuf accordingly, as
Yann 0:f30e2135b0db 335 * this function allocates no memory)
Yann 0:f30e2135b0db 336 * @param p pointer to the custom pbuf to initialize (already allocated)
Yann 0:f30e2135b0db 337 * @param payload_mem pointer to the buffer that is used for payload and headers,
Yann 0:f30e2135b0db 338 * must be at least big enough to hold 'length' plus the header size,
Yann 0:f30e2135b0db 339 * may be NULL if set later
Yann 0:f30e2135b0db 340 * @param payload_mem_len the size of the 'payload_mem' buffer, must be at least
Yann 0:f30e2135b0db 341 * big enough to hold 'length' plus the header size
Yann 0:f30e2135b0db 342 */
Yann 0:f30e2135b0db 343 struct pbuf*
Yann 0:f30e2135b0db 344 pbuf_alloced_custom(pbuf_layer l, u16_t length, pbuf_type type, struct pbuf_custom *p,
Yann 0:f30e2135b0db 345 void *payload_mem, u16_t payload_mem_len)
Yann 0:f30e2135b0db 346 {
Yann 0:f30e2135b0db 347 u16_t offset;
Yann 0:f30e2135b0db 348 LWIP_DEBUGF(PBUF_DEBUG | LWIP_DBG_TRACE, ("pbuf_alloced_custom(length=%"U16_F")\n", length));
Yann 0:f30e2135b0db 349
Yann 0:f30e2135b0db 350 /* determine header offset */
Yann 0:f30e2135b0db 351 offset = 0;
Yann 0:f30e2135b0db 352 switch (l) {
Yann 0:f30e2135b0db 353 case PBUF_TRANSPORT:
Yann 0:f30e2135b0db 354 /* add room for transport (often TCP) layer header */
Yann 0:f30e2135b0db 355 offset += PBUF_TRANSPORT_HLEN;
Yann 0:f30e2135b0db 356 /* FALLTHROUGH */
Yann 0:f30e2135b0db 357 case PBUF_IP:
Yann 0:f30e2135b0db 358 /* add room for IP layer header */
Yann 0:f30e2135b0db 359 offset += PBUF_IP_HLEN;
Yann 0:f30e2135b0db 360 /* FALLTHROUGH */
Yann 0:f30e2135b0db 361 case PBUF_LINK:
Yann 0:f30e2135b0db 362 /* add room for link layer header */
Yann 0:f30e2135b0db 363 offset += PBUF_LINK_HLEN;
Yann 0:f30e2135b0db 364 break;
Yann 0:f30e2135b0db 365 case PBUF_RAW:
Yann 0:f30e2135b0db 366 break;
Yann 0:f30e2135b0db 367 default:
Yann 0:f30e2135b0db 368 LWIP_ASSERT("pbuf_alloced_custom: bad pbuf layer", 0);
Yann 0:f30e2135b0db 369 return NULL;
Yann 0:f30e2135b0db 370 }
Yann 0:f30e2135b0db 371
Yann 0:f30e2135b0db 372 if (LWIP_MEM_ALIGN_SIZE(offset) + length < payload_mem_len) {
Yann 0:f30e2135b0db 373 LWIP_DEBUGF(PBUF_DEBUG | LWIP_DBG_LEVEL_WARNING, ("pbuf_alloced_custom(length=%"U16_F") buffer too short\n", length));
Yann 0:f30e2135b0db 374 return NULL;
Yann 0:f30e2135b0db 375 }
Yann 0:f30e2135b0db 376
Yann 0:f30e2135b0db 377 p->pbuf.next = NULL;
Yann 0:f30e2135b0db 378 if (payload_mem != NULL) {
Yann 0:f30e2135b0db 379 p->pbuf.payload = LWIP_MEM_ALIGN((void *)((u8_t *)payload_mem + offset));
Yann 0:f30e2135b0db 380 } else {
Yann 0:f30e2135b0db 381 p->pbuf.payload = NULL;
Yann 0:f30e2135b0db 382 }
Yann 0:f30e2135b0db 383 p->pbuf.flags = PBUF_FLAG_IS_CUSTOM;
Yann 0:f30e2135b0db 384 p->pbuf.len = p->pbuf.tot_len = length;
Yann 0:f30e2135b0db 385 p->pbuf.type = type;
Yann 0:f30e2135b0db 386 p->pbuf.ref = 1;
Yann 0:f30e2135b0db 387 return &p->pbuf;
Yann 0:f30e2135b0db 388 }
Yann 0:f30e2135b0db 389 #endif /* LWIP_SUPPORT_CUSTOM_PBUF */
Yann 0:f30e2135b0db 390
Yann 0:f30e2135b0db 391 /**
Yann 0:f30e2135b0db 392 * Shrink a pbuf chain to a desired length.
Yann 0:f30e2135b0db 393 *
Yann 0:f30e2135b0db 394 * @param p pbuf to shrink.
Yann 0:f30e2135b0db 395 * @param new_len desired new length of pbuf chain
Yann 0:f30e2135b0db 396 *
Yann 0:f30e2135b0db 397 * Depending on the desired length, the first few pbufs in a chain might
Yann 0:f30e2135b0db 398 * be skipped and left unchanged. The new last pbuf in the chain will be
Yann 0:f30e2135b0db 399 * resized, and any remaining pbufs will be freed.
Yann 0:f30e2135b0db 400 *
Yann 0:f30e2135b0db 401 * @note If the pbuf is ROM/REF, only the ->tot_len and ->len fields are adjusted.
Yann 0:f30e2135b0db 402 * @note May not be called on a packet queue.
Yann 0:f30e2135b0db 403 *
Yann 0:f30e2135b0db 404 * @note Despite its name, pbuf_realloc cannot grow the size of a pbuf (chain).
Yann 0:f30e2135b0db 405 */
Yann 0:f30e2135b0db 406 void
Yann 0:f30e2135b0db 407 pbuf_realloc(struct pbuf *p, u16_t new_len)
Yann 0:f30e2135b0db 408 {
Yann 0:f30e2135b0db 409 struct pbuf *q;
Yann 0:f30e2135b0db 410 u16_t rem_len; /* remaining length */
Yann 0:f30e2135b0db 411 s32_t grow;
Yann 0:f30e2135b0db 412
Yann 0:f30e2135b0db 413 LWIP_ASSERT("pbuf_realloc: p != NULL", p != NULL);
Yann 0:f30e2135b0db 414 LWIP_ASSERT("pbuf_realloc: sane p->type", p->type == PBUF_POOL ||
Yann 0:f30e2135b0db 415 p->type == PBUF_ROM ||
Yann 0:f30e2135b0db 416 p->type == PBUF_RAM ||
Yann 0:f30e2135b0db 417 p->type == PBUF_REF);
Yann 0:f30e2135b0db 418
Yann 0:f30e2135b0db 419 /* desired length larger than current length? */
Yann 0:f30e2135b0db 420 if (new_len >= p->tot_len) {
Yann 0:f30e2135b0db 421 /* enlarging not yet supported */
Yann 0:f30e2135b0db 422 return;
Yann 0:f30e2135b0db 423 }
Yann 0:f30e2135b0db 424
Yann 0:f30e2135b0db 425 /* the pbuf chain grows by (new_len - p->tot_len) bytes
Yann 0:f30e2135b0db 426 * (which may be negative in case of shrinking) */
Yann 0:f30e2135b0db 427 grow = new_len - p->tot_len;
Yann 0:f30e2135b0db 428
Yann 0:f30e2135b0db 429 /* first, step over any pbufs that should remain in the chain */
Yann 0:f30e2135b0db 430 rem_len = new_len;
Yann 0:f30e2135b0db 431 q = p;
Yann 0:f30e2135b0db 432 /* should this pbuf be kept? */
Yann 0:f30e2135b0db 433 while (rem_len > q->len) {
Yann 0:f30e2135b0db 434 /* decrease remaining length by pbuf length */
Yann 0:f30e2135b0db 435 rem_len -= q->len;
Yann 0:f30e2135b0db 436 /* decrease total length indicator */
Yann 0:f30e2135b0db 437 LWIP_ASSERT("grow < max_u16_t", grow < 0xffff);
Yann 0:f30e2135b0db 438 q->tot_len += (u16_t)grow;
Yann 0:f30e2135b0db 439 /* proceed to next pbuf in chain */
Yann 0:f30e2135b0db 440 q = q->next;
Yann 0:f30e2135b0db 441 LWIP_ASSERT("pbuf_realloc: q != NULL", q != NULL);
Yann 0:f30e2135b0db 442 }
Yann 0:f30e2135b0db 443 /* we have now reached the new last pbuf (in q) */
Yann 0:f30e2135b0db 444 /* rem_len == desired length for pbuf q */
Yann 0:f30e2135b0db 445
Yann 0:f30e2135b0db 446 /* shrink allocated memory for PBUF_RAM */
Yann 0:f30e2135b0db 447 /* (other types merely adjust their length fields */
Yann 0:f30e2135b0db 448 if ((q->type == PBUF_RAM) && (rem_len != q->len)) {
Yann 0:f30e2135b0db 449 /* reallocate and adjust the length of the pbuf that will be split */
Yann 0:f30e2135b0db 450 q = (struct pbuf *)mem_trim(q, (u16_t)((u8_t *)q->payload - (u8_t *)q) + rem_len);
Yann 0:f30e2135b0db 451 LWIP_ASSERT("mem_trim returned q == NULL", q != NULL);
Yann 0:f30e2135b0db 452 }
Yann 0:f30e2135b0db 453 /* adjust length fields for new last pbuf */
Yann 0:f30e2135b0db 454 q->len = rem_len;
Yann 0:f30e2135b0db 455 q->tot_len = q->len;
Yann 0:f30e2135b0db 456
Yann 0:f30e2135b0db 457 /* any remaining pbufs in chain? */
Yann 0:f30e2135b0db 458 if (q->next != NULL) {
Yann 0:f30e2135b0db 459 /* free remaining pbufs in chain */
Yann 0:f30e2135b0db 460 pbuf_free(q->next);
Yann 0:f30e2135b0db 461 }
Yann 0:f30e2135b0db 462 /* q is last packet in chain */
Yann 0:f30e2135b0db 463 q->next = NULL;
Yann 0:f30e2135b0db 464
Yann 0:f30e2135b0db 465 }
Yann 0:f30e2135b0db 466
Yann 0:f30e2135b0db 467 /**
Yann 0:f30e2135b0db 468 * Adjusts the payload pointer to hide or reveal headers in the payload.
Yann 0:f30e2135b0db 469 *
Yann 0:f30e2135b0db 470 * Adjusts the ->payload pointer so that space for a header
Yann 0:f30e2135b0db 471 * (dis)appears in the pbuf payload.
Yann 0:f30e2135b0db 472 *
Yann 0:f30e2135b0db 473 * The ->payload, ->tot_len and ->len fields are adjusted.
Yann 0:f30e2135b0db 474 *
Yann 0:f30e2135b0db 475 * @param p pbuf to change the header size.
Yann 0:f30e2135b0db 476 * @param header_size_increment Number of bytes to increment header size which
Yann 0:f30e2135b0db 477 * increases the size of the pbuf. New space is on the front.
Yann 0:f30e2135b0db 478 * (Using a negative value decreases the header size.)
Yann 0:f30e2135b0db 479 * If hdr_size_inc is 0, this function does nothing and returns succesful.
Yann 0:f30e2135b0db 480 *
Yann 0:f30e2135b0db 481 * PBUF_ROM and PBUF_REF type buffers cannot have their sizes increased, so
Yann 0:f30e2135b0db 482 * the call will fail. A check is made that the increase in header size does
Yann 0:f30e2135b0db 483 * not move the payload pointer in front of the start of the buffer.
Yann 0:f30e2135b0db 484 * @return non-zero on failure, zero on success.
Yann 0:f30e2135b0db 485 *
Yann 0:f30e2135b0db 486 */
Yann 0:f30e2135b0db 487 u8_t
Yann 0:f30e2135b0db 488 pbuf_header(struct pbuf *p, s16_t header_size_increment)
Yann 0:f30e2135b0db 489 {
Yann 0:f30e2135b0db 490 u16_t type;
Yann 0:f30e2135b0db 491 void *payload;
Yann 0:f30e2135b0db 492 u16_t increment_magnitude;
Yann 0:f30e2135b0db 493
Yann 0:f30e2135b0db 494 LWIP_ASSERT("p != NULL", p != NULL);
Yann 0:f30e2135b0db 495 if ((header_size_increment == 0) || (p == NULL)) {
Yann 0:f30e2135b0db 496 return 0;
Yann 0:f30e2135b0db 497 }
Yann 0:f30e2135b0db 498
Yann 0:f30e2135b0db 499 if (header_size_increment < 0){
Yann 0:f30e2135b0db 500 increment_magnitude = -header_size_increment;
Yann 0:f30e2135b0db 501 /* Check that we aren't going to move off the end of the pbuf */
Yann 0:f30e2135b0db 502 LWIP_ERROR("increment_magnitude <= p->len", (increment_magnitude <= p->len), return 1;);
Yann 0:f30e2135b0db 503 } else {
Yann 0:f30e2135b0db 504 increment_magnitude = header_size_increment;
Yann 0:f30e2135b0db 505 #if 0
Yann 0:f30e2135b0db 506 /* Can't assert these as some callers speculatively call
Yann 0:f30e2135b0db 507 pbuf_header() to see if it's OK. Will return 1 below instead. */
Yann 0:f30e2135b0db 508 /* Check that we've got the correct type of pbuf to work with */
Yann 0:f30e2135b0db 509 LWIP_ASSERT("p->type == PBUF_RAM || p->type == PBUF_POOL",
Yann 0:f30e2135b0db 510 p->type == PBUF_RAM || p->type == PBUF_POOL);
Yann 0:f30e2135b0db 511 /* Check that we aren't going to move off the beginning of the pbuf */
Yann 0:f30e2135b0db 512 LWIP_ASSERT("p->payload - increment_magnitude >= p + SIZEOF_STRUCT_PBUF",
Yann 0:f30e2135b0db 513 (u8_t *)p->payload - increment_magnitude >= (u8_t *)p + SIZEOF_STRUCT_PBUF);
Yann 0:f30e2135b0db 514 #endif
Yann 0:f30e2135b0db 515 }
Yann 0:f30e2135b0db 516
Yann 0:f30e2135b0db 517 type = p->type;
Yann 0:f30e2135b0db 518 /* remember current payload pointer */
Yann 0:f30e2135b0db 519 payload = p->payload;
Yann 0:f30e2135b0db 520
Yann 0:f30e2135b0db 521 /* pbuf types containing payloads? */
Yann 0:f30e2135b0db 522 if (type == PBUF_RAM || type == PBUF_POOL) {
Yann 0:f30e2135b0db 523 /* set new payload pointer */
Yann 0:f30e2135b0db 524 p->payload = (u8_t *)p->payload - header_size_increment;
Yann 0:f30e2135b0db 525 /* boundary check fails? */
Yann 0:f30e2135b0db 526 if ((u8_t *)p->payload < (u8_t *)p + SIZEOF_STRUCT_PBUF) {
Yann 0:f30e2135b0db 527 LWIP_DEBUGF( PBUF_DEBUG | LWIP_DBG_LEVEL_SERIOUS,
Yann 0:f30e2135b0db 528 ("pbuf_header: failed as %p < %p (not enough space for new header size)\n",
Yann 0:f30e2135b0db 529 (void *)p->payload, (void *)(p + 1)));
Yann 0:f30e2135b0db 530 /* restore old payload pointer */
Yann 0:f30e2135b0db 531 p->payload = payload;
Yann 0:f30e2135b0db 532 /* bail out unsuccesfully */
Yann 0:f30e2135b0db 533 return 1;
Yann 0:f30e2135b0db 534 }
Yann 0:f30e2135b0db 535 /* pbuf types refering to external payloads? */
Yann 0:f30e2135b0db 536 } else if (type == PBUF_REF || type == PBUF_ROM) {
Yann 0:f30e2135b0db 537 /* hide a header in the payload? */
Yann 0:f30e2135b0db 538 if ((header_size_increment < 0) && (increment_magnitude <= p->len)) {
Yann 0:f30e2135b0db 539 /* increase payload pointer */
Yann 0:f30e2135b0db 540 p->payload = (u8_t *)p->payload - header_size_increment;
Yann 0:f30e2135b0db 541 } else {
Yann 0:f30e2135b0db 542 /* cannot expand payload to front (yet!)
Yann 0:f30e2135b0db 543 * bail out unsuccesfully */
Yann 0:f30e2135b0db 544 return 1;
Yann 0:f30e2135b0db 545 }
Yann 0:f30e2135b0db 546 } else {
Yann 0:f30e2135b0db 547 /* Unknown type */
Yann 0:f30e2135b0db 548 LWIP_ASSERT("bad pbuf type", 0);
Yann 0:f30e2135b0db 549 return 1;
Yann 0:f30e2135b0db 550 }
Yann 0:f30e2135b0db 551 /* modify pbuf length fields */
Yann 0:f30e2135b0db 552 p->len += header_size_increment;
Yann 0:f30e2135b0db 553 p->tot_len += header_size_increment;
Yann 0:f30e2135b0db 554
Yann 0:f30e2135b0db 555 LWIP_DEBUGF(PBUF_DEBUG | LWIP_DBG_TRACE, ("pbuf_header: old %p new %p (%"S16_F")\n",
Yann 0:f30e2135b0db 556 (void *)payload, (void *)p->payload, header_size_increment));
Yann 0:f30e2135b0db 557
Yann 0:f30e2135b0db 558 return 0;
Yann 0:f30e2135b0db 559 }
Yann 0:f30e2135b0db 560
Yann 0:f30e2135b0db 561 /**
Yann 0:f30e2135b0db 562 * Dereference a pbuf chain or queue and deallocate any no-longer-used
Yann 0:f30e2135b0db 563 * pbufs at the head of this chain or queue.
Yann 0:f30e2135b0db 564 *
Yann 0:f30e2135b0db 565 * Decrements the pbuf reference count. If it reaches zero, the pbuf is
Yann 0:f30e2135b0db 566 * deallocated.
Yann 0:f30e2135b0db 567 *
Yann 0:f30e2135b0db 568 * For a pbuf chain, this is repeated for each pbuf in the chain,
Yann 0:f30e2135b0db 569 * up to the first pbuf which has a non-zero reference count after
Yann 0:f30e2135b0db 570 * decrementing. So, when all reference counts are one, the whole
Yann 0:f30e2135b0db 571 * chain is free'd.
Yann 0:f30e2135b0db 572 *
Yann 0:f30e2135b0db 573 * @param p The pbuf (chain) to be dereferenced.
Yann 0:f30e2135b0db 574 *
Yann 0:f30e2135b0db 575 * @return the number of pbufs that were de-allocated
Yann 0:f30e2135b0db 576 * from the head of the chain.
Yann 0:f30e2135b0db 577 *
Yann 0:f30e2135b0db 578 * @note MUST NOT be called on a packet queue (Not verified to work yet).
Yann 0:f30e2135b0db 579 * @note the reference counter of a pbuf equals the number of pointers
Yann 0:f30e2135b0db 580 * that refer to the pbuf (or into the pbuf).
Yann 0:f30e2135b0db 581 *
Yann 0:f30e2135b0db 582 * @internal examples:
Yann 0:f30e2135b0db 583 *
Yann 0:f30e2135b0db 584 * Assuming existing chains a->b->c with the following reference
Yann 0:f30e2135b0db 585 * counts, calling pbuf_free(a) results in:
Yann 0:f30e2135b0db 586 *
Yann 0:f30e2135b0db 587 * 1->2->3 becomes ...1->3
Yann 0:f30e2135b0db 588 * 3->3->3 becomes 2->3->3
Yann 0:f30e2135b0db 589 * 1->1->2 becomes ......1
Yann 0:f30e2135b0db 590 * 2->1->1 becomes 1->1->1
Yann 0:f30e2135b0db 591 * 1->1->1 becomes .......
Yann 0:f30e2135b0db 592 *
Yann 0:f30e2135b0db 593 */
Yann 0:f30e2135b0db 594 u8_t
Yann 0:f30e2135b0db 595 pbuf_free(struct pbuf *p)
Yann 0:f30e2135b0db 596 {
Yann 0:f30e2135b0db 597 u16_t type;
Yann 0:f30e2135b0db 598 struct pbuf *q;
Yann 0:f30e2135b0db 599 u8_t count;
Yann 0:f30e2135b0db 600
Yann 0:f30e2135b0db 601 if (p == NULL) {
Yann 0:f30e2135b0db 602 LWIP_ASSERT("p != NULL", p != NULL);
Yann 0:f30e2135b0db 603 /* if assertions are disabled, proceed with debug output */
Yann 0:f30e2135b0db 604 LWIP_DEBUGF(PBUF_DEBUG | LWIP_DBG_LEVEL_SERIOUS,
Yann 0:f30e2135b0db 605 ("pbuf_free(p == NULL) was called.\n"));
Yann 0:f30e2135b0db 606 return 0;
Yann 0:f30e2135b0db 607 }
Yann 0:f30e2135b0db 608 LWIP_DEBUGF(PBUF_DEBUG | LWIP_DBG_TRACE, ("pbuf_free(%p)\n", (void *)p));
Yann 0:f30e2135b0db 609
Yann 0:f30e2135b0db 610 PERF_START;
Yann 0:f30e2135b0db 611
Yann 0:f30e2135b0db 612 LWIP_ASSERT("pbuf_free: sane type",
Yann 0:f30e2135b0db 613 p->type == PBUF_RAM || p->type == PBUF_ROM ||
Yann 0:f30e2135b0db 614 p->type == PBUF_REF || p->type == PBUF_POOL);
Yann 0:f30e2135b0db 615
Yann 0:f30e2135b0db 616 count = 0;
Yann 0:f30e2135b0db 617 /* de-allocate all consecutive pbufs from the head of the chain that
Yann 0:f30e2135b0db 618 * obtain a zero reference count after decrementing*/
Yann 0:f30e2135b0db 619 while (p != NULL) {
Yann 0:f30e2135b0db 620 u16_t ref;
Yann 0:f30e2135b0db 621 SYS_ARCH_DECL_PROTECT(old_level);
Yann 0:f30e2135b0db 622 /* Since decrementing ref cannot be guaranteed to be a single machine operation
Yann 0:f30e2135b0db 623 * we must protect it. We put the new ref into a local variable to prevent
Yann 0:f30e2135b0db 624 * further protection. */
Yann 0:f30e2135b0db 625 SYS_ARCH_PROTECT(old_level);
Yann 0:f30e2135b0db 626 /* all pbufs in a chain are referenced at least once */
Yann 0:f30e2135b0db 627 LWIP_ASSERT("pbuf_free: p->ref > 0", p->ref > 0);
Yann 0:f30e2135b0db 628 /* decrease reference count (number of pointers to pbuf) */
Yann 0:f30e2135b0db 629 ref = --(p->ref);
Yann 0:f30e2135b0db 630 SYS_ARCH_UNPROTECT(old_level);
Yann 0:f30e2135b0db 631 /* this pbuf is no longer referenced to? */
Yann 0:f30e2135b0db 632 if (ref == 0) {
Yann 0:f30e2135b0db 633 /* remember next pbuf in chain for next iteration */
Yann 0:f30e2135b0db 634 q = p->next;
Yann 0:f30e2135b0db 635 LWIP_DEBUGF( PBUF_DEBUG | LWIP_DBG_TRACE, ("pbuf_free: deallocating %p\n", (void *)p));
Yann 0:f30e2135b0db 636 type = p->type;
Yann 0:f30e2135b0db 637 #if LWIP_SUPPORT_CUSTOM_PBUF
Yann 0:f30e2135b0db 638 /* is this a custom pbuf? */
Yann 0:f30e2135b0db 639 if ((p->flags & PBUF_FLAG_IS_CUSTOM) != 0) {
Yann 0:f30e2135b0db 640 struct pbuf_custom *pc = (struct pbuf_custom*)p;
Yann 0:f30e2135b0db 641 LWIP_ASSERT("pc->custom_free_function != NULL", pc->custom_free_function != NULL);
Yann 0:f30e2135b0db 642 pc->custom_free_function(p);
Yann 0:f30e2135b0db 643 } else
Yann 0:f30e2135b0db 644 #endif /* LWIP_SUPPORT_CUSTOM_PBUF */
Yann 0:f30e2135b0db 645 {
Yann 0:f30e2135b0db 646 /* is this a pbuf from the pool? */
Yann 0:f30e2135b0db 647 if (type == PBUF_POOL) {
Yann 0:f30e2135b0db 648 memp_free(MEMP_PBUF_POOL, p);
Yann 0:f30e2135b0db 649 /* is this a ROM or RAM referencing pbuf? */
Yann 0:f30e2135b0db 650 } else if (type == PBUF_ROM || type == PBUF_REF) {
Yann 0:f30e2135b0db 651 memp_free(MEMP_PBUF, p);
Yann 0:f30e2135b0db 652 /* type == PBUF_RAM */
Yann 0:f30e2135b0db 653 } else {
Yann 0:f30e2135b0db 654 mem_free(p);
Yann 0:f30e2135b0db 655 }
Yann 0:f30e2135b0db 656 }
Yann 0:f30e2135b0db 657 count++;
Yann 0:f30e2135b0db 658 /* proceed to next pbuf */
Yann 0:f30e2135b0db 659 p = q;
Yann 0:f30e2135b0db 660 /* p->ref > 0, this pbuf is still referenced to */
Yann 0:f30e2135b0db 661 /* (and so the remaining pbufs in chain as well) */
Yann 0:f30e2135b0db 662 } else {
Yann 0:f30e2135b0db 663 LWIP_DEBUGF( PBUF_DEBUG | LWIP_DBG_TRACE, ("pbuf_free: %p has ref %"U16_F", ending here.\n", (void *)p, ref));
Yann 0:f30e2135b0db 664 /* stop walking through the chain */
Yann 0:f30e2135b0db 665 p = NULL;
Yann 0:f30e2135b0db 666 }
Yann 0:f30e2135b0db 667 }
Yann 0:f30e2135b0db 668 PERF_STOP("pbuf_free");
Yann 0:f30e2135b0db 669 /* return number of de-allocated pbufs */
Yann 0:f30e2135b0db 670 return count;
Yann 0:f30e2135b0db 671 }
Yann 0:f30e2135b0db 672
Yann 0:f30e2135b0db 673 /**
Yann 0:f30e2135b0db 674 * Count number of pbufs in a chain
Yann 0:f30e2135b0db 675 *
Yann 0:f30e2135b0db 676 * @param p first pbuf of chain
Yann 0:f30e2135b0db 677 * @return the number of pbufs in a chain
Yann 0:f30e2135b0db 678 */
Yann 0:f30e2135b0db 679
Yann 0:f30e2135b0db 680 u8_t
Yann 0:f30e2135b0db 681 pbuf_clen(struct pbuf *p)
Yann 0:f30e2135b0db 682 {
Yann 0:f30e2135b0db 683 u8_t len;
Yann 0:f30e2135b0db 684
Yann 0:f30e2135b0db 685 len = 0;
Yann 0:f30e2135b0db 686 while (p != NULL) {
Yann 0:f30e2135b0db 687 ++len;
Yann 0:f30e2135b0db 688 p = p->next;
Yann 0:f30e2135b0db 689 }
Yann 0:f30e2135b0db 690 return len;
Yann 0:f30e2135b0db 691 }
Yann 0:f30e2135b0db 692
Yann 0:f30e2135b0db 693 /**
Yann 0:f30e2135b0db 694 * Increment the reference count of the pbuf.
Yann 0:f30e2135b0db 695 *
Yann 0:f30e2135b0db 696 * @param p pbuf to increase reference counter of
Yann 0:f30e2135b0db 697 *
Yann 0:f30e2135b0db 698 */
Yann 0:f30e2135b0db 699 void
Yann 0:f30e2135b0db 700 pbuf_ref(struct pbuf *p)
Yann 0:f30e2135b0db 701 {
Yann 0:f30e2135b0db 702 SYS_ARCH_DECL_PROTECT(old_level);
Yann 0:f30e2135b0db 703 /* pbuf given? */
Yann 0:f30e2135b0db 704 if (p != NULL) {
Yann 0:f30e2135b0db 705 SYS_ARCH_PROTECT(old_level);
Yann 0:f30e2135b0db 706 ++(p->ref);
Yann 0:f30e2135b0db 707 SYS_ARCH_UNPROTECT(old_level);
Yann 0:f30e2135b0db 708 }
Yann 0:f30e2135b0db 709 }
Yann 0:f30e2135b0db 710
Yann 0:f30e2135b0db 711 /**
Yann 0:f30e2135b0db 712 * Concatenate two pbufs (each may be a pbuf chain) and take over
Yann 0:f30e2135b0db 713 * the caller's reference of the tail pbuf.
Yann 0:f30e2135b0db 714 *
Yann 0:f30e2135b0db 715 * @note The caller MAY NOT reference the tail pbuf afterwards.
Yann 0:f30e2135b0db 716 * Use pbuf_chain() for that purpose.
Yann 0:f30e2135b0db 717 *
Yann 0:f30e2135b0db 718 * @see pbuf_chain()
Yann 0:f30e2135b0db 719 */
Yann 0:f30e2135b0db 720
Yann 0:f30e2135b0db 721 void
Yann 0:f30e2135b0db 722 pbuf_cat(struct pbuf *h, struct pbuf *t)
Yann 0:f30e2135b0db 723 {
Yann 0:f30e2135b0db 724 struct pbuf *p;
Yann 0:f30e2135b0db 725
Yann 0:f30e2135b0db 726 LWIP_ERROR("(h != NULL) && (t != NULL) (programmer violates API)",
Yann 0:f30e2135b0db 727 ((h != NULL) && (t != NULL)), return;);
Yann 0:f30e2135b0db 728
Yann 0:f30e2135b0db 729 /* proceed to last pbuf of chain */
Yann 0:f30e2135b0db 730 for (p = h; p->next != NULL; p = p->next) {
Yann 0:f30e2135b0db 731 /* add total length of second chain to all totals of first chain */
Yann 0:f30e2135b0db 732 p->tot_len += t->tot_len;
Yann 0:f30e2135b0db 733 }
Yann 0:f30e2135b0db 734 /* { p is last pbuf of first h chain, p->next == NULL } */
Yann 0:f30e2135b0db 735 LWIP_ASSERT("p->tot_len == p->len (of last pbuf in chain)", p->tot_len == p->len);
Yann 0:f30e2135b0db 736 LWIP_ASSERT("p->next == NULL", p->next == NULL);
Yann 0:f30e2135b0db 737 /* add total length of second chain to last pbuf total of first chain */
Yann 0:f30e2135b0db 738 p->tot_len += t->tot_len;
Yann 0:f30e2135b0db 739 /* chain last pbuf of head (p) with first of tail (t) */
Yann 0:f30e2135b0db 740 p->next = t;
Yann 0:f30e2135b0db 741 /* p->next now references t, but the caller will drop its reference to t,
Yann 0:f30e2135b0db 742 * so netto there is no change to the reference count of t.
Yann 0:f30e2135b0db 743 */
Yann 0:f30e2135b0db 744 }
Yann 0:f30e2135b0db 745
Yann 0:f30e2135b0db 746 /**
Yann 0:f30e2135b0db 747 * Chain two pbufs (or pbuf chains) together.
Yann 0:f30e2135b0db 748 *
Yann 0:f30e2135b0db 749 * The caller MUST call pbuf_free(t) once it has stopped
Yann 0:f30e2135b0db 750 * using it. Use pbuf_cat() instead if you no longer use t.
Yann 0:f30e2135b0db 751 *
Yann 0:f30e2135b0db 752 * @param h head pbuf (chain)
Yann 0:f30e2135b0db 753 * @param t tail pbuf (chain)
Yann 0:f30e2135b0db 754 * @note The pbufs MUST belong to the same packet.
Yann 0:f30e2135b0db 755 * @note MAY NOT be called on a packet queue.
Yann 0:f30e2135b0db 756 *
Yann 0:f30e2135b0db 757 * The ->tot_len fields of all pbufs of the head chain are adjusted.
Yann 0:f30e2135b0db 758 * The ->next field of the last pbuf of the head chain is adjusted.
Yann 0:f30e2135b0db 759 * The ->ref field of the first pbuf of the tail chain is adjusted.
Yann 0:f30e2135b0db 760 *
Yann 0:f30e2135b0db 761 */
Yann 0:f30e2135b0db 762 void
Yann 0:f30e2135b0db 763 pbuf_chain(struct pbuf *h, struct pbuf *t)
Yann 0:f30e2135b0db 764 {
Yann 0:f30e2135b0db 765 pbuf_cat(h, t);
Yann 0:f30e2135b0db 766 /* t is now referenced by h */
Yann 0:f30e2135b0db 767 pbuf_ref(t);
Yann 0:f30e2135b0db 768 LWIP_DEBUGF(PBUF_DEBUG | LWIP_DBG_TRACE, ("pbuf_chain: %p references %p\n", (void *)h, (void *)t));
Yann 0:f30e2135b0db 769 }
Yann 0:f30e2135b0db 770
Yann 0:f30e2135b0db 771 /**
Yann 0:f30e2135b0db 772 * Dechains the first pbuf from its succeeding pbufs in the chain.
Yann 0:f30e2135b0db 773 *
Yann 0:f30e2135b0db 774 * Makes p->tot_len field equal to p->len.
Yann 0:f30e2135b0db 775 * @param p pbuf to dechain
Yann 0:f30e2135b0db 776 * @return remainder of the pbuf chain, or NULL if it was de-allocated.
Yann 0:f30e2135b0db 777 * @note May not be called on a packet queue.
Yann 0:f30e2135b0db 778 */
Yann 0:f30e2135b0db 779 struct pbuf *
Yann 0:f30e2135b0db 780 pbuf_dechain(struct pbuf *p)
Yann 0:f30e2135b0db 781 {
Yann 0:f30e2135b0db 782 struct pbuf *q;
Yann 0:f30e2135b0db 783 u8_t tail_gone = 1;
Yann 0:f30e2135b0db 784 /* tail */
Yann 0:f30e2135b0db 785 q = p->next;
Yann 0:f30e2135b0db 786 /* pbuf has successor in chain? */
Yann 0:f30e2135b0db 787 if (q != NULL) {
Yann 0:f30e2135b0db 788 /* assert tot_len invariant: (p->tot_len == p->len + (p->next? p->next->tot_len: 0) */
Yann 0:f30e2135b0db 789 LWIP_ASSERT("p->tot_len == p->len + q->tot_len", q->tot_len == p->tot_len - p->len);
Yann 0:f30e2135b0db 790 /* enforce invariant if assertion is disabled */
Yann 0:f30e2135b0db 791 q->tot_len = p->tot_len - p->len;
Yann 0:f30e2135b0db 792 /* decouple pbuf from remainder */
Yann 0:f30e2135b0db 793 p->next = NULL;
Yann 0:f30e2135b0db 794 /* total length of pbuf p is its own length only */
Yann 0:f30e2135b0db 795 p->tot_len = p->len;
Yann 0:f30e2135b0db 796 /* q is no longer referenced by p, free it */
Yann 0:f30e2135b0db 797 LWIP_DEBUGF(PBUF_DEBUG | LWIP_DBG_TRACE, ("pbuf_dechain: unreferencing %p\n", (void *)q));
Yann 0:f30e2135b0db 798 tail_gone = pbuf_free(q);
Yann 0:f30e2135b0db 799 if (tail_gone > 0) {
Yann 0:f30e2135b0db 800 LWIP_DEBUGF(PBUF_DEBUG | LWIP_DBG_TRACE,
Yann 0:f30e2135b0db 801 ("pbuf_dechain: deallocated %p (as it is no longer referenced)\n", (void *)q));
Yann 0:f30e2135b0db 802 }
Yann 0:f30e2135b0db 803 /* return remaining tail or NULL if deallocated */
Yann 0:f30e2135b0db 804 }
Yann 0:f30e2135b0db 805 /* assert tot_len invariant: (p->tot_len == p->len + (p->next? p->next->tot_len: 0) */
Yann 0:f30e2135b0db 806 LWIP_ASSERT("p->tot_len == p->len", p->tot_len == p->len);
Yann 0:f30e2135b0db 807 return ((tail_gone > 0) ? NULL : q);
Yann 0:f30e2135b0db 808 }
Yann 0:f30e2135b0db 809
Yann 0:f30e2135b0db 810 /**
Yann 0:f30e2135b0db 811 *
Yann 0:f30e2135b0db 812 * Create PBUF_RAM copies of pbufs.
Yann 0:f30e2135b0db 813 *
Yann 0:f30e2135b0db 814 * Used to queue packets on behalf of the lwIP stack, such as
Yann 0:f30e2135b0db 815 * ARP based queueing.
Yann 0:f30e2135b0db 816 *
Yann 0:f30e2135b0db 817 * @note You MUST explicitly use p = pbuf_take(p);
Yann 0:f30e2135b0db 818 *
Yann 0:f30e2135b0db 819 * @note Only one packet is copied, no packet queue!
Yann 0:f30e2135b0db 820 *
Yann 0:f30e2135b0db 821 * @param p_to pbuf destination of the copy
Yann 0:f30e2135b0db 822 * @param p_from pbuf source of the copy
Yann 0:f30e2135b0db 823 *
Yann 0:f30e2135b0db 824 * @return ERR_OK if pbuf was copied
Yann 0:f30e2135b0db 825 * ERR_ARG if one of the pbufs is NULL or p_to is not big
Yann 0:f30e2135b0db 826 * enough to hold p_from
Yann 0:f30e2135b0db 827 */
Yann 0:f30e2135b0db 828 err_t
Yann 0:f30e2135b0db 829 pbuf_copy(struct pbuf *p_to, struct pbuf *p_from)
Yann 0:f30e2135b0db 830 {
Yann 0:f30e2135b0db 831 u16_t offset_to=0, offset_from=0, len;
Yann 0:f30e2135b0db 832
Yann 0:f30e2135b0db 833 LWIP_DEBUGF(PBUF_DEBUG | LWIP_DBG_TRACE, ("pbuf_copy(%p, %p)\n",
Yann 0:f30e2135b0db 834 (void*)p_to, (void*)p_from));
Yann 0:f30e2135b0db 835
Yann 0:f30e2135b0db 836 /* is the target big enough to hold the source? */
Yann 0:f30e2135b0db 837 LWIP_ERROR("pbuf_copy: target not big enough to hold source", ((p_to != NULL) &&
Yann 0:f30e2135b0db 838 (p_from != NULL) && (p_to->tot_len >= p_from->tot_len)), return ERR_ARG;);
Yann 0:f30e2135b0db 839
Yann 0:f30e2135b0db 840 /* iterate through pbuf chain */
Yann 0:f30e2135b0db 841 do
Yann 0:f30e2135b0db 842 {
Yann 0:f30e2135b0db 843 LWIP_ASSERT("p_to != NULL", p_to != NULL);
Yann 0:f30e2135b0db 844 /* copy one part of the original chain */
Yann 0:f30e2135b0db 845 if ((p_to->len - offset_to) >= (p_from->len - offset_from)) {
Yann 0:f30e2135b0db 846 /* complete current p_from fits into current p_to */
Yann 0:f30e2135b0db 847 len = p_from->len - offset_from;
Yann 0:f30e2135b0db 848 } else {
Yann 0:f30e2135b0db 849 /* current p_from does not fit into current p_to */
Yann 0:f30e2135b0db 850 len = p_to->len - offset_to;
Yann 0:f30e2135b0db 851 }
Yann 0:f30e2135b0db 852 MEMCPY((u8_t*)p_to->payload + offset_to, (u8_t*)p_from->payload + offset_from, len);
Yann 0:f30e2135b0db 853 offset_to += len;
Yann 0:f30e2135b0db 854 offset_from += len;
Yann 0:f30e2135b0db 855 LWIP_ASSERT("offset_to <= p_to->len", offset_to <= p_to->len);
Yann 0:f30e2135b0db 856 if (offset_to == p_to->len) {
Yann 0:f30e2135b0db 857 /* on to next p_to (if any) */
Yann 0:f30e2135b0db 858 offset_to = 0;
Yann 0:f30e2135b0db 859 p_to = p_to->next;
Yann 0:f30e2135b0db 860 }
Yann 0:f30e2135b0db 861 LWIP_ASSERT("offset_from <= p_from->len", offset_from <= p_from->len);
Yann 0:f30e2135b0db 862 if (offset_from >= p_from->len) {
Yann 0:f30e2135b0db 863 /* on to next p_from (if any) */
Yann 0:f30e2135b0db 864 offset_from = 0;
Yann 0:f30e2135b0db 865 p_from = p_from->next;
Yann 0:f30e2135b0db 866 }
Yann 0:f30e2135b0db 867
Yann 0:f30e2135b0db 868 if((p_from != NULL) && (p_from->len == p_from->tot_len)) {
Yann 0:f30e2135b0db 869 /* don't copy more than one packet! */
Yann 0:f30e2135b0db 870 LWIP_ERROR("pbuf_copy() does not allow packet queues!\n",
Yann 0:f30e2135b0db 871 (p_from->next == NULL), return ERR_VAL;);
Yann 0:f30e2135b0db 872 }
Yann 0:f30e2135b0db 873 if((p_to != NULL) && (p_to->len == p_to->tot_len)) {
Yann 0:f30e2135b0db 874 /* don't copy more than one packet! */
Yann 0:f30e2135b0db 875 LWIP_ERROR("pbuf_copy() does not allow packet queues!\n",
Yann 0:f30e2135b0db 876 (p_to->next == NULL), return ERR_VAL;);
Yann 0:f30e2135b0db 877 }
Yann 0:f30e2135b0db 878 } while (p_from);
Yann 0:f30e2135b0db 879 LWIP_DEBUGF(PBUF_DEBUG | LWIP_DBG_TRACE, ("pbuf_copy: end of chain reached.\n"));
Yann 0:f30e2135b0db 880 return ERR_OK;
Yann 0:f30e2135b0db 881 }
Yann 0:f30e2135b0db 882
Yann 0:f30e2135b0db 883 /**
Yann 0:f30e2135b0db 884 * Copy (part of) the contents of a packet buffer
Yann 0:f30e2135b0db 885 * to an application supplied buffer.
Yann 0:f30e2135b0db 886 *
Yann 0:f30e2135b0db 887 * @param buf the pbuf from which to copy data
Yann 0:f30e2135b0db 888 * @param dataptr the application supplied buffer
Yann 0:f30e2135b0db 889 * @param len length of data to copy (dataptr must be big enough). No more
Yann 0:f30e2135b0db 890 * than buf->tot_len will be copied, irrespective of len
Yann 0:f30e2135b0db 891 * @param offset offset into the packet buffer from where to begin copying len bytes
Yann 0:f30e2135b0db 892 * @return the number of bytes copied, or 0 on failure
Yann 0:f30e2135b0db 893 */
Yann 0:f30e2135b0db 894 u16_t
Yann 0:f30e2135b0db 895 pbuf_copy_partial(struct pbuf *buf, void *dataptr, u16_t len, u16_t offset)
Yann 0:f30e2135b0db 896 {
Yann 0:f30e2135b0db 897 struct pbuf *p;
Yann 0:f30e2135b0db 898 u16_t left;
Yann 0:f30e2135b0db 899 u16_t buf_copy_len;
Yann 0:f30e2135b0db 900 u16_t copied_total = 0;
Yann 0:f30e2135b0db 901
Yann 0:f30e2135b0db 902 LWIP_ERROR("pbuf_copy_partial: invalid buf", (buf != NULL), return 0;);
Yann 0:f30e2135b0db 903 LWIP_ERROR("pbuf_copy_partial: invalid dataptr", (dataptr != NULL), return 0;);
Yann 0:f30e2135b0db 904
Yann 0:f30e2135b0db 905 left = 0;
Yann 0:f30e2135b0db 906
Yann 0:f30e2135b0db 907 if((buf == NULL) || (dataptr == NULL)) {
Yann 0:f30e2135b0db 908 return 0;
Yann 0:f30e2135b0db 909 }
Yann 0:f30e2135b0db 910
Yann 0:f30e2135b0db 911 /* Note some systems use byte copy if dataptr or one of the pbuf payload pointers are unaligned. */
Yann 0:f30e2135b0db 912 for(p = buf; len != 0 && p != NULL; p = p->next) {
Yann 0:f30e2135b0db 913 if ((offset != 0) && (offset >= p->len)) {
Yann 0:f30e2135b0db 914 /* don't copy from this buffer -> on to the next */
Yann 0:f30e2135b0db 915 offset -= p->len;
Yann 0:f30e2135b0db 916 } else {
Yann 0:f30e2135b0db 917 /* copy from this buffer. maybe only partially. */
Yann 0:f30e2135b0db 918 buf_copy_len = p->len - offset;
Yann 0:f30e2135b0db 919 if (buf_copy_len > len)
Yann 0:f30e2135b0db 920 buf_copy_len = len;
Yann 0:f30e2135b0db 921 /* copy the necessary parts of the buffer */
Yann 0:f30e2135b0db 922 MEMCPY(&((char*)dataptr)[left], &((char*)p->payload)[offset], buf_copy_len);
Yann 0:f30e2135b0db 923 copied_total += buf_copy_len;
Yann 0:f30e2135b0db 924 left += buf_copy_len;
Yann 0:f30e2135b0db 925 len -= buf_copy_len;
Yann 0:f30e2135b0db 926 offset = 0;
Yann 0:f30e2135b0db 927 }
Yann 0:f30e2135b0db 928 }
Yann 0:f30e2135b0db 929 return copied_total;
Yann 0:f30e2135b0db 930 }
Yann 0:f30e2135b0db 931
Yann 0:f30e2135b0db 932 /**
Yann 0:f30e2135b0db 933 * Copy application supplied data into a pbuf.
Yann 0:f30e2135b0db 934 * This function can only be used to copy the equivalent of buf->tot_len data.
Yann 0:f30e2135b0db 935 *
Yann 0:f30e2135b0db 936 * @param buf pbuf to fill with data
Yann 0:f30e2135b0db 937 * @param dataptr application supplied data buffer
Yann 0:f30e2135b0db 938 * @param len length of the application supplied data buffer
Yann 0:f30e2135b0db 939 *
Yann 0:f30e2135b0db 940 * @return ERR_OK if successful, ERR_MEM if the pbuf is not big enough
Yann 0:f30e2135b0db 941 */
Yann 0:f30e2135b0db 942 err_t
Yann 0:f30e2135b0db 943 pbuf_take(struct pbuf *buf, const void *dataptr, u16_t len)
Yann 0:f30e2135b0db 944 {
Yann 0:f30e2135b0db 945 struct pbuf *p;
Yann 0:f30e2135b0db 946 u16_t buf_copy_len;
Yann 0:f30e2135b0db 947 u16_t total_copy_len = len;
Yann 0:f30e2135b0db 948 u16_t copied_total = 0;
Yann 0:f30e2135b0db 949
Yann 0:f30e2135b0db 950 LWIP_ERROR("pbuf_take: invalid buf", (buf != NULL), return 0;);
Yann 0:f30e2135b0db 951 LWIP_ERROR("pbuf_take: invalid dataptr", (dataptr != NULL), return 0;);
Yann 0:f30e2135b0db 952
Yann 0:f30e2135b0db 953 if ((buf == NULL) || (dataptr == NULL) || (buf->tot_len < len)) {
Yann 0:f30e2135b0db 954 return ERR_ARG;
Yann 0:f30e2135b0db 955 }
Yann 0:f30e2135b0db 956
Yann 0:f30e2135b0db 957 /* Note some systems use byte copy if dataptr or one of the pbuf payload pointers are unaligned. */
Yann 0:f30e2135b0db 958 for(p = buf; total_copy_len != 0; p = p->next) {
Yann 0:f30e2135b0db 959 LWIP_ASSERT("pbuf_take: invalid pbuf", p != NULL);
Yann 0:f30e2135b0db 960 buf_copy_len = total_copy_len;
Yann 0:f30e2135b0db 961 if (buf_copy_len > p->len) {
Yann 0:f30e2135b0db 962 /* this pbuf cannot hold all remaining data */
Yann 0:f30e2135b0db 963 buf_copy_len = p->len;
Yann 0:f30e2135b0db 964 }
Yann 0:f30e2135b0db 965 /* copy the necessary parts of the buffer */
Yann 0:f30e2135b0db 966 MEMCPY(p->payload, &((char*)dataptr)[copied_total], buf_copy_len);
Yann 0:f30e2135b0db 967 total_copy_len -= buf_copy_len;
Yann 0:f30e2135b0db 968 copied_total += buf_copy_len;
Yann 0:f30e2135b0db 969 }
Yann 0:f30e2135b0db 970 LWIP_ASSERT("did not copy all data", total_copy_len == 0 && copied_total == len);
Yann 0:f30e2135b0db 971 return ERR_OK;
Yann 0:f30e2135b0db 972 }
Yann 0:f30e2135b0db 973
Yann 0:f30e2135b0db 974 /**
Yann 0:f30e2135b0db 975 * Creates a single pbuf out of a queue of pbufs.
Yann 0:f30e2135b0db 976 *
Yann 0:f30e2135b0db 977 * @remark: Either the source pbuf 'p' is freed by this function or the original
Yann 0:f30e2135b0db 978 * pbuf 'p' is returned, therefore the caller has to check the result!
Yann 0:f30e2135b0db 979 *
Yann 0:f30e2135b0db 980 * @param p the source pbuf
Yann 0:f30e2135b0db 981 * @param layer pbuf_layer of the new pbuf
Yann 0:f30e2135b0db 982 *
Yann 0:f30e2135b0db 983 * @return a new, single pbuf (p->next is NULL)
Yann 0:f30e2135b0db 984 * or the old pbuf if allocation fails
Yann 0:f30e2135b0db 985 */
Yann 0:f30e2135b0db 986 struct pbuf*
Yann 0:f30e2135b0db 987 pbuf_coalesce(struct pbuf *p, pbuf_layer layer)
Yann 0:f30e2135b0db 988 {
Yann 0:f30e2135b0db 989 struct pbuf *q;
Yann 0:f30e2135b0db 990 err_t err;
Yann 0:f30e2135b0db 991 if (p->next == NULL) {
Yann 0:f30e2135b0db 992 return p;
Yann 0:f30e2135b0db 993 }
Yann 0:f30e2135b0db 994 q = pbuf_alloc(layer, p->tot_len, PBUF_RAM);
Yann 0:f30e2135b0db 995 if (q == NULL) {
Yann 0:f30e2135b0db 996 /* @todo: what do we do now? */
Yann 0:f30e2135b0db 997 return p;
Yann 0:f30e2135b0db 998 }
Yann 0:f30e2135b0db 999 err = pbuf_copy(q, p);
Yann 0:f30e2135b0db 1000 LWIP_ASSERT("pbuf_copy failed", err == ERR_OK);
Yann 0:f30e2135b0db 1001 pbuf_free(p);
Yann 0:f30e2135b0db 1002 return q;
Yann 0:f30e2135b0db 1003 }
Yann 0:f30e2135b0db 1004
Yann 0:f30e2135b0db 1005 #if LWIP_CHECKSUM_ON_COPY
Yann 0:f30e2135b0db 1006 /**
Yann 0:f30e2135b0db 1007 * Copies data into a single pbuf (*not* into a pbuf queue!) and updates
Yann 0:f30e2135b0db 1008 * the checksum while copying
Yann 0:f30e2135b0db 1009 *
Yann 0:f30e2135b0db 1010 * @param p the pbuf to copy data into
Yann 0:f30e2135b0db 1011 * @param start_offset offset of p->payload where to copy the data to
Yann 0:f30e2135b0db 1012 * @param dataptr data to copy into the pbuf
Yann 0:f30e2135b0db 1013 * @param len length of data to copy into the pbuf
Yann 0:f30e2135b0db 1014 * @param chksum pointer to the checksum which is updated
Yann 0:f30e2135b0db 1015 * @return ERR_OK if successful, another error if the data does not fit
Yann 0:f30e2135b0db 1016 * within the (first) pbuf (no pbuf queues!)
Yann 0:f30e2135b0db 1017 */
Yann 0:f30e2135b0db 1018 err_t
Yann 0:f30e2135b0db 1019 pbuf_fill_chksum(struct pbuf *p, u16_t start_offset, const void *dataptr,
Yann 0:f30e2135b0db 1020 u16_t len, u16_t *chksum)
Yann 0:f30e2135b0db 1021 {
Yann 0:f30e2135b0db 1022 u32_t acc;
Yann 0:f30e2135b0db 1023 u16_t copy_chksum;
Yann 0:f30e2135b0db 1024 char *dst_ptr;
Yann 0:f30e2135b0db 1025 LWIP_ASSERT("p != NULL", p != NULL);
Yann 0:f30e2135b0db 1026 LWIP_ASSERT("dataptr != NULL", dataptr != NULL);
Yann 0:f30e2135b0db 1027 LWIP_ASSERT("chksum != NULL", chksum != NULL);
Yann 0:f30e2135b0db 1028 LWIP_ASSERT("len != 0", len != 0);
Yann 0:f30e2135b0db 1029
Yann 0:f30e2135b0db 1030 if ((start_offset >= p->len) || (start_offset + len > p->len)) {
Yann 0:f30e2135b0db 1031 return ERR_ARG;
Yann 0:f30e2135b0db 1032 }
Yann 0:f30e2135b0db 1033
Yann 0:f30e2135b0db 1034 dst_ptr = ((char*)p->payload) + start_offset;
Yann 0:f30e2135b0db 1035 copy_chksum = LWIP_CHKSUM_COPY(dst_ptr, dataptr, len);
Yann 0:f30e2135b0db 1036 if ((start_offset & 1) != 0) {
Yann 0:f30e2135b0db 1037 copy_chksum = SWAP_BYTES_IN_WORD(copy_chksum);
Yann 0:f30e2135b0db 1038 }
Yann 0:f30e2135b0db 1039 acc = *chksum;
Yann 0:f30e2135b0db 1040 acc += copy_chksum;
Yann 0:f30e2135b0db 1041 *chksum = FOLD_U32T(acc);
Yann 0:f30e2135b0db 1042 return ERR_OK;
Yann 0:f30e2135b0db 1043 }
Yann 0:f30e2135b0db 1044 #endif /* LWIP_CHECKSUM_ON_COPY */
Yann 0:f30e2135b0db 1045
Yann 0:f30e2135b0db 1046 /** Get one byte from the specified position in a pbuf
Yann 0:f30e2135b0db 1047 * WARNING: returns zero for offset >= p->tot_len
Yann 0:f30e2135b0db 1048 *
Yann 0:f30e2135b0db 1049 * @param p pbuf to parse
Yann 0:f30e2135b0db 1050 * @param offset offset into p of the byte to return
Yann 0:f30e2135b0db 1051 * @return byte at an offset into p OR ZERO IF 'offset' >= p->tot_len
Yann 0:f30e2135b0db 1052 */
Yann 0:f30e2135b0db 1053 u8_t
Yann 0:f30e2135b0db 1054 pbuf_get_at(struct pbuf* p, u16_t offset)
Yann 0:f30e2135b0db 1055 {
Yann 0:f30e2135b0db 1056 u16_t copy_from = offset;
Yann 0:f30e2135b0db 1057 struct pbuf* q = p;
Yann 0:f30e2135b0db 1058
Yann 0:f30e2135b0db 1059 /* get the correct pbuf */
Yann 0:f30e2135b0db 1060 while ((q != NULL) && (q->len <= copy_from)) {
Yann 0:f30e2135b0db 1061 copy_from -= q->len;
Yann 0:f30e2135b0db 1062 q = q->next;
Yann 0:f30e2135b0db 1063 }
Yann 0:f30e2135b0db 1064 /* return requested data if pbuf is OK */
Yann 0:f30e2135b0db 1065 if ((q != NULL) && (q->len > copy_from)) {
Yann 0:f30e2135b0db 1066 return ((u8_t*)q->payload)[copy_from];
Yann 0:f30e2135b0db 1067 }
Yann 0:f30e2135b0db 1068 return 0;
Yann 0:f30e2135b0db 1069 }
Yann 0:f30e2135b0db 1070
Yann 0:f30e2135b0db 1071 /** Compare pbuf contents at specified offset with memory s2, both of length n
Yann 0:f30e2135b0db 1072 *
Yann 0:f30e2135b0db 1073 * @param p pbuf to compare
Yann 0:f30e2135b0db 1074 * @param offset offset into p at wich to start comparing
Yann 0:f30e2135b0db 1075 * @param s2 buffer to compare
Yann 0:f30e2135b0db 1076 * @param n length of buffer to compare
Yann 0:f30e2135b0db 1077 * @return zero if equal, nonzero otherwise
Yann 0:f30e2135b0db 1078 * (0xffff if p is too short, diffoffset+1 otherwise)
Yann 0:f30e2135b0db 1079 */
Yann 0:f30e2135b0db 1080 u16_t
Yann 0:f30e2135b0db 1081 pbuf_memcmp(struct pbuf* p, u16_t offset, const void* s2, u16_t n)
Yann 0:f30e2135b0db 1082 {
Yann 0:f30e2135b0db 1083 u16_t start = offset;
Yann 0:f30e2135b0db 1084 struct pbuf* q = p;
Yann 0:f30e2135b0db 1085
Yann 0:f30e2135b0db 1086 /* get the correct pbuf */
Yann 0:f30e2135b0db 1087 while ((q != NULL) && (q->len <= start)) {
Yann 0:f30e2135b0db 1088 start -= q->len;
Yann 0:f30e2135b0db 1089 q = q->next;
Yann 0:f30e2135b0db 1090 }
Yann 0:f30e2135b0db 1091 /* return requested data if pbuf is OK */
Yann 0:f30e2135b0db 1092 if ((q != NULL) && (q->len > start)) {
Yann 0:f30e2135b0db 1093 u16_t i;
Yann 0:f30e2135b0db 1094 for(i = 0; i < n; i++) {
Yann 0:f30e2135b0db 1095 u8_t a = pbuf_get_at(q, start + i);
Yann 0:f30e2135b0db 1096 u8_t b = ((u8_t*)s2)[i];
Yann 0:f30e2135b0db 1097 if (a != b) {
Yann 0:f30e2135b0db 1098 return i+1;
Yann 0:f30e2135b0db 1099 }
Yann 0:f30e2135b0db 1100 }
Yann 0:f30e2135b0db 1101 return 0;
Yann 0:f30e2135b0db 1102 }
Yann 0:f30e2135b0db 1103 return 0xffff;
Yann 0:f30e2135b0db 1104 }
Yann 0:f30e2135b0db 1105
Yann 0:f30e2135b0db 1106 /** Find occurrence of mem (with length mem_len) in pbuf p, starting at offset
Yann 0:f30e2135b0db 1107 * start_offset.
Yann 0:f30e2135b0db 1108 *
Yann 0:f30e2135b0db 1109 * @param p pbuf to search, maximum length is 0xFFFE since 0xFFFF is used as
Yann 0:f30e2135b0db 1110 * return value 'not found'
Yann 0:f30e2135b0db 1111 * @param mem search for the contents of this buffer
Yann 0:f30e2135b0db 1112 * @param mem_len length of 'mem'
Yann 0:f30e2135b0db 1113 * @param start_offset offset into p at which to start searching
Yann 0:f30e2135b0db 1114 * @return 0xFFFF if substr was not found in p or the index where it was found
Yann 0:f30e2135b0db 1115 */
Yann 0:f30e2135b0db 1116 u16_t
Yann 0:f30e2135b0db 1117 pbuf_memfind(struct pbuf* p, const void* mem, u16_t mem_len, u16_t start_offset)
Yann 0:f30e2135b0db 1118 {
Yann 0:f30e2135b0db 1119 u16_t i;
Yann 0:f30e2135b0db 1120 u16_t max = p->tot_len - mem_len;
Yann 0:f30e2135b0db 1121 if (p->tot_len >= mem_len + start_offset) {
Yann 0:f30e2135b0db 1122 for(i = start_offset; i <= max; ) {
Yann 0:f30e2135b0db 1123 u16_t plus = pbuf_memcmp(p, i, mem, mem_len);
Yann 0:f30e2135b0db 1124 if (plus == 0) {
Yann 0:f30e2135b0db 1125 return i;
Yann 0:f30e2135b0db 1126 } else {
Yann 0:f30e2135b0db 1127 i += plus;
Yann 0:f30e2135b0db 1128 }
Yann 0:f30e2135b0db 1129 }
Yann 0:f30e2135b0db 1130 }
Yann 0:f30e2135b0db 1131 return 0xFFFF;
Yann 0:f30e2135b0db 1132 }
Yann 0:f30e2135b0db 1133
Yann 0:f30e2135b0db 1134 /** Find occurrence of substr with length substr_len in pbuf p, start at offset
Yann 0:f30e2135b0db 1135 * start_offset
Yann 0:f30e2135b0db 1136 * WARNING: in contrast to strstr(), this one does not stop at the first \0 in
Yann 0:f30e2135b0db 1137 * the pbuf/source string!
Yann 0:f30e2135b0db 1138 *
Yann 0:f30e2135b0db 1139 * @param p pbuf to search, maximum length is 0xFFFE since 0xFFFF is used as
Yann 0:f30e2135b0db 1140 * return value 'not found'
Yann 0:f30e2135b0db 1141 * @param substr string to search for in p, maximum length is 0xFFFE
Yann 0:f30e2135b0db 1142 * @return 0xFFFF if substr was not found in p or the index where it was found
Yann 0:f30e2135b0db 1143 */
Yann 0:f30e2135b0db 1144 u16_t
Yann 0:f30e2135b0db 1145 pbuf_strstr(struct pbuf* p, const char* substr)
Yann 0:f30e2135b0db 1146 {
Yann 0:f30e2135b0db 1147 size_t substr_len;
Yann 0:f30e2135b0db 1148 if ((substr == NULL) || (substr[0] == 0) || (p->tot_len == 0xFFFF)) {
Yann 0:f30e2135b0db 1149 return 0xFFFF;
Yann 0:f30e2135b0db 1150 }
Yann 0:f30e2135b0db 1151 substr_len = strlen(substr);
Yann 0:f30e2135b0db 1152 if (substr_len >= 0xFFFF) {
Yann 0:f30e2135b0db 1153 return 0xFFFF;
Yann 0:f30e2135b0db 1154 }
Yann 0:f30e2135b0db 1155 return pbuf_memfind(p, substr, (u16_t)substr_len, 0);
Yann 0:f30e2135b0db 1156 }