Michael Spencer / Mbed 2 deprecated LaOS

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

NetServices/lwip/core/pbuf.c@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

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