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: BufferedSerial FatFileSystemCpp mbed
EthernetInterface/lwip/api/netbuf.c@74:a1bf25282cb1, 2022-02-10 (annotated)
- Committer:
- JamieB
- Date:
- Thu Feb 10 10:43:50 2022 +0000
- Revision:
- 74:a1bf25282cb1
- Parent:
- 22:0dd9c1b5664a
Incremented version to 0.27 (forgot to on the last commit...)
Who changed what in which revision?
| User | Revision | Line number | New contents of line | 
|---|---|---|---|
| AndyA | 22:0dd9c1b5664a | 1 | /** | 
| AndyA | 22:0dd9c1b5664a | 2 | * @file | 
| AndyA | 22:0dd9c1b5664a | 3 | * Network buffer management | 
| AndyA | 22:0dd9c1b5664a | 4 | * | 
| AndyA | 22:0dd9c1b5664a | 5 | */ | 
| AndyA | 22:0dd9c1b5664a | 6 | |
| AndyA | 22:0dd9c1b5664a | 7 | /* | 
| AndyA | 22:0dd9c1b5664a | 8 | * Copyright (c) 2001-2004 Swedish Institute of Computer Science. | 
| AndyA | 22:0dd9c1b5664a | 9 | * All rights reserved. | 
| AndyA | 22:0dd9c1b5664a | 10 | * | 
| AndyA | 22:0dd9c1b5664a | 11 | * Redistribution and use in source and binary forms, with or without modification, | 
| AndyA | 22:0dd9c1b5664a | 12 | * are permitted provided that the following conditions are met: | 
| AndyA | 22:0dd9c1b5664a | 13 | * | 
| AndyA | 22:0dd9c1b5664a | 14 | * 1. Redistributions of source code must retain the above copyright notice, | 
| AndyA | 22:0dd9c1b5664a | 15 | * this list of conditions and the following disclaimer. | 
| AndyA | 22:0dd9c1b5664a | 16 | * 2. Redistributions in binary form must reproduce the above copyright notice, | 
| AndyA | 22:0dd9c1b5664a | 17 | * this list of conditions and the following disclaimer in the documentation | 
| AndyA | 22:0dd9c1b5664a | 18 | * and/or other materials provided with the distribution. | 
| AndyA | 22:0dd9c1b5664a | 19 | * 3. The name of the author may not be used to endorse or promote products | 
| AndyA | 22:0dd9c1b5664a | 20 | * derived from this software without specific prior written permission. | 
| AndyA | 22:0dd9c1b5664a | 21 | * | 
| AndyA | 22:0dd9c1b5664a | 22 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED | 
| AndyA | 22:0dd9c1b5664a | 23 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF | 
| AndyA | 22:0dd9c1b5664a | 24 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT | 
| AndyA | 22:0dd9c1b5664a | 25 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, | 
| AndyA | 22:0dd9c1b5664a | 26 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT | 
| AndyA | 22:0dd9c1b5664a | 27 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | 
| AndyA | 22:0dd9c1b5664a | 28 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | 
| AndyA | 22:0dd9c1b5664a | 29 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING | 
| AndyA | 22:0dd9c1b5664a | 30 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY | 
| AndyA | 22:0dd9c1b5664a | 31 | * OF SUCH DAMAGE. | 
| AndyA | 22:0dd9c1b5664a | 32 | * | 
| AndyA | 22:0dd9c1b5664a | 33 | * This file is part of the lwIP TCP/IP stack. | 
| AndyA | 22:0dd9c1b5664a | 34 | * | 
| AndyA | 22:0dd9c1b5664a | 35 | * Author: Adam Dunkels <adam@sics.se> | 
| AndyA | 22:0dd9c1b5664a | 36 | * | 
| AndyA | 22:0dd9c1b5664a | 37 | */ | 
| AndyA | 22:0dd9c1b5664a | 38 | |
| AndyA | 22:0dd9c1b5664a | 39 | #include "lwip/opt.h" | 
| AndyA | 22:0dd9c1b5664a | 40 | |
| AndyA | 22:0dd9c1b5664a | 41 | #if LWIP_NETCONN /* don't build if not configured for use in lwipopts.h */ | 
| AndyA | 22:0dd9c1b5664a | 42 | |
| AndyA | 22:0dd9c1b5664a | 43 | #include "lwip/netbuf.h" | 
| AndyA | 22:0dd9c1b5664a | 44 | #include "lwip/memp.h" | 
| AndyA | 22:0dd9c1b5664a | 45 | |
| AndyA | 22:0dd9c1b5664a | 46 | #include <string.h> | 
| AndyA | 22:0dd9c1b5664a | 47 | |
| AndyA | 22:0dd9c1b5664a | 48 | /** | 
| AndyA | 22:0dd9c1b5664a | 49 | * Create (allocate) and initialize a new netbuf. | 
| AndyA | 22:0dd9c1b5664a | 50 | * The netbuf doesn't yet contain a packet buffer! | 
| AndyA | 22:0dd9c1b5664a | 51 | * | 
| AndyA | 22:0dd9c1b5664a | 52 | * @return a pointer to a new netbuf | 
| AndyA | 22:0dd9c1b5664a | 53 | * NULL on lack of memory | 
| AndyA | 22:0dd9c1b5664a | 54 | */ | 
| AndyA | 22:0dd9c1b5664a | 55 | struct | 
| AndyA | 22:0dd9c1b5664a | 56 | netbuf *netbuf_new(void) | 
| AndyA | 22:0dd9c1b5664a | 57 | { | 
| AndyA | 22:0dd9c1b5664a | 58 | struct netbuf *buf; | 
| AndyA | 22:0dd9c1b5664a | 59 | |
| AndyA | 22:0dd9c1b5664a | 60 | buf = (struct netbuf *)memp_malloc(MEMP_NETBUF); | 
| AndyA | 22:0dd9c1b5664a | 61 | if (buf != NULL) { | 
| AndyA | 22:0dd9c1b5664a | 62 | buf->p = NULL; | 
| AndyA | 22:0dd9c1b5664a | 63 | buf->ptr = NULL; | 
| AndyA | 22:0dd9c1b5664a | 64 | ip_addr_set_any(&buf->addr); | 
| AndyA | 22:0dd9c1b5664a | 65 | buf->port = 0; | 
| AndyA | 22:0dd9c1b5664a | 66 | #if LWIP_NETBUF_RECVINFO || LWIP_CHECKSUM_ON_COPY | 
| AndyA | 22:0dd9c1b5664a | 67 | #if LWIP_CHECKSUM_ON_COPY | 
| AndyA | 22:0dd9c1b5664a | 68 | buf->flags = 0; | 
| AndyA | 22:0dd9c1b5664a | 69 | #endif /* LWIP_CHECKSUM_ON_COPY */ | 
| AndyA | 22:0dd9c1b5664a | 70 | buf->toport_chksum = 0; | 
| AndyA | 22:0dd9c1b5664a | 71 | #if LWIP_NETBUF_RECVINFO | 
| AndyA | 22:0dd9c1b5664a | 72 | ip_addr_set_any(&buf->toaddr); | 
| AndyA | 22:0dd9c1b5664a | 73 | #endif /* LWIP_NETBUF_RECVINFO */ | 
| AndyA | 22:0dd9c1b5664a | 74 | #endif /* LWIP_NETBUF_RECVINFO || LWIP_CHECKSUM_ON_COPY */ | 
| AndyA | 22:0dd9c1b5664a | 75 | return buf; | 
| AndyA | 22:0dd9c1b5664a | 76 | } else { | 
| AndyA | 22:0dd9c1b5664a | 77 | return NULL; | 
| AndyA | 22:0dd9c1b5664a | 78 | } | 
| AndyA | 22:0dd9c1b5664a | 79 | } | 
| AndyA | 22:0dd9c1b5664a | 80 | |
| AndyA | 22:0dd9c1b5664a | 81 | /** | 
| AndyA | 22:0dd9c1b5664a | 82 | * Deallocate a netbuf allocated by netbuf_new(). | 
| AndyA | 22:0dd9c1b5664a | 83 | * | 
| AndyA | 22:0dd9c1b5664a | 84 | * @param buf pointer to a netbuf allocated by netbuf_new() | 
| AndyA | 22:0dd9c1b5664a | 85 | */ | 
| AndyA | 22:0dd9c1b5664a | 86 | void | 
| AndyA | 22:0dd9c1b5664a | 87 | netbuf_delete(struct netbuf *buf) | 
| AndyA | 22:0dd9c1b5664a | 88 | { | 
| AndyA | 22:0dd9c1b5664a | 89 | if (buf != NULL) { | 
| AndyA | 22:0dd9c1b5664a | 90 | if (buf->p != NULL) { | 
| AndyA | 22:0dd9c1b5664a | 91 | pbuf_free(buf->p); | 
| AndyA | 22:0dd9c1b5664a | 92 | buf->p = buf->ptr = NULL; | 
| AndyA | 22:0dd9c1b5664a | 93 | } | 
| AndyA | 22:0dd9c1b5664a | 94 | memp_free(MEMP_NETBUF, buf); | 
| AndyA | 22:0dd9c1b5664a | 95 | } | 
| AndyA | 22:0dd9c1b5664a | 96 | } | 
| AndyA | 22:0dd9c1b5664a | 97 | |
| AndyA | 22:0dd9c1b5664a | 98 | /** | 
| AndyA | 22:0dd9c1b5664a | 99 | * Allocate memory for a packet buffer for a given netbuf. | 
| AndyA | 22:0dd9c1b5664a | 100 | * | 
| AndyA | 22:0dd9c1b5664a | 101 | * @param buf the netbuf for which to allocate a packet buffer | 
| AndyA | 22:0dd9c1b5664a | 102 | * @param size the size of the packet buffer to allocate | 
| AndyA | 22:0dd9c1b5664a | 103 | * @return pointer to the allocated memory | 
| AndyA | 22:0dd9c1b5664a | 104 | * NULL if no memory could be allocated | 
| AndyA | 22:0dd9c1b5664a | 105 | */ | 
| AndyA | 22:0dd9c1b5664a | 106 | void * | 
| AndyA | 22:0dd9c1b5664a | 107 | netbuf_alloc(struct netbuf *buf, u16_t size) | 
| AndyA | 22:0dd9c1b5664a | 108 | { | 
| AndyA | 22:0dd9c1b5664a | 109 | LWIP_ERROR("netbuf_alloc: invalid buf", (buf != NULL), return NULL;); | 
| AndyA | 22:0dd9c1b5664a | 110 | |
| AndyA | 22:0dd9c1b5664a | 111 | /* Deallocate any previously allocated memory. */ | 
| AndyA | 22:0dd9c1b5664a | 112 | if (buf->p != NULL) { | 
| AndyA | 22:0dd9c1b5664a | 113 | pbuf_free(buf->p); | 
| AndyA | 22:0dd9c1b5664a | 114 | } | 
| AndyA | 22:0dd9c1b5664a | 115 | buf->p = pbuf_alloc(PBUF_TRANSPORT, size, PBUF_RAM); | 
| AndyA | 22:0dd9c1b5664a | 116 | if (buf->p == NULL) { | 
| AndyA | 22:0dd9c1b5664a | 117 | return NULL; | 
| AndyA | 22:0dd9c1b5664a | 118 | } | 
| AndyA | 22:0dd9c1b5664a | 119 | LWIP_ASSERT("check that first pbuf can hold size", | 
| AndyA | 22:0dd9c1b5664a | 120 | (buf->p->len >= size)); | 
| AndyA | 22:0dd9c1b5664a | 121 | buf->ptr = buf->p; | 
| AndyA | 22:0dd9c1b5664a | 122 | return buf->p->payload; | 
| AndyA | 22:0dd9c1b5664a | 123 | } | 
| AndyA | 22:0dd9c1b5664a | 124 | |
| AndyA | 22:0dd9c1b5664a | 125 | /** | 
| AndyA | 22:0dd9c1b5664a | 126 | * Free the packet buffer included in a netbuf | 
| AndyA | 22:0dd9c1b5664a | 127 | * | 
| AndyA | 22:0dd9c1b5664a | 128 | * @param buf pointer to the netbuf which contains the packet buffer to free | 
| AndyA | 22:0dd9c1b5664a | 129 | */ | 
| AndyA | 22:0dd9c1b5664a | 130 | void | 
| AndyA | 22:0dd9c1b5664a | 131 | netbuf_free(struct netbuf *buf) | 
| AndyA | 22:0dd9c1b5664a | 132 | { | 
| AndyA | 22:0dd9c1b5664a | 133 | LWIP_ERROR("netbuf_free: invalid buf", (buf != NULL), return;); | 
| AndyA | 22:0dd9c1b5664a | 134 | if (buf->p != NULL) { | 
| AndyA | 22:0dd9c1b5664a | 135 | pbuf_free(buf->p); | 
| AndyA | 22:0dd9c1b5664a | 136 | } | 
| AndyA | 22:0dd9c1b5664a | 137 | buf->p = buf->ptr = NULL; | 
| AndyA | 22:0dd9c1b5664a | 138 | } | 
| AndyA | 22:0dd9c1b5664a | 139 | |
| AndyA | 22:0dd9c1b5664a | 140 | /** | 
| AndyA | 22:0dd9c1b5664a | 141 | * Let a netbuf reference existing (non-volatile) data. | 
| AndyA | 22:0dd9c1b5664a | 142 | * | 
| AndyA | 22:0dd9c1b5664a | 143 | * @param buf netbuf which should reference the data | 
| AndyA | 22:0dd9c1b5664a | 144 | * @param dataptr pointer to the data to reference | 
| AndyA | 22:0dd9c1b5664a | 145 | * @param size size of the data | 
| AndyA | 22:0dd9c1b5664a | 146 | * @return ERR_OK if data is referenced | 
| AndyA | 22:0dd9c1b5664a | 147 | * ERR_MEM if data couldn't be referenced due to lack of memory | 
| AndyA | 22:0dd9c1b5664a | 148 | */ | 
| AndyA | 22:0dd9c1b5664a | 149 | err_t | 
| AndyA | 22:0dd9c1b5664a | 150 | netbuf_ref(struct netbuf *buf, const void *dataptr, u16_t size) | 
| AndyA | 22:0dd9c1b5664a | 151 | { | 
| AndyA | 22:0dd9c1b5664a | 152 | LWIP_ERROR("netbuf_ref: invalid buf", (buf != NULL), return ERR_ARG;); | 
| AndyA | 22:0dd9c1b5664a | 153 | if (buf->p != NULL) { | 
| AndyA | 22:0dd9c1b5664a | 154 | pbuf_free(buf->p); | 
| AndyA | 22:0dd9c1b5664a | 155 | } | 
| AndyA | 22:0dd9c1b5664a | 156 | buf->p = pbuf_alloc(PBUF_TRANSPORT, 0, PBUF_REF); | 
| AndyA | 22:0dd9c1b5664a | 157 | if (buf->p == NULL) { | 
| AndyA | 22:0dd9c1b5664a | 158 | buf->ptr = NULL; | 
| AndyA | 22:0dd9c1b5664a | 159 | return ERR_MEM; | 
| AndyA | 22:0dd9c1b5664a | 160 | } | 
| AndyA | 22:0dd9c1b5664a | 161 | buf->p->payload = (void*)dataptr; | 
| AndyA | 22:0dd9c1b5664a | 162 | buf->p->len = buf->p->tot_len = size; | 
| AndyA | 22:0dd9c1b5664a | 163 | buf->ptr = buf->p; | 
| AndyA | 22:0dd9c1b5664a | 164 | return ERR_OK; | 
| AndyA | 22:0dd9c1b5664a | 165 | } | 
| AndyA | 22:0dd9c1b5664a | 166 | |
| AndyA | 22:0dd9c1b5664a | 167 | /** | 
| AndyA | 22:0dd9c1b5664a | 168 | * Chain one netbuf to another (@see pbuf_chain) | 
| AndyA | 22:0dd9c1b5664a | 169 | * | 
| AndyA | 22:0dd9c1b5664a | 170 | * @param head the first netbuf | 
| AndyA | 22:0dd9c1b5664a | 171 | * @param tail netbuf to chain after head, freed by this function, may not be reference after returning | 
| AndyA | 22:0dd9c1b5664a | 172 | */ | 
| AndyA | 22:0dd9c1b5664a | 173 | void | 
| AndyA | 22:0dd9c1b5664a | 174 | netbuf_chain(struct netbuf *head, struct netbuf *tail) | 
| AndyA | 22:0dd9c1b5664a | 175 | { | 
| AndyA | 22:0dd9c1b5664a | 176 | LWIP_ERROR("netbuf_ref: invalid head", (head != NULL), return;); | 
| AndyA | 22:0dd9c1b5664a | 177 | LWIP_ERROR("netbuf_chain: invalid tail", (tail != NULL), return;); | 
| AndyA | 22:0dd9c1b5664a | 178 | pbuf_cat(head->p, tail->p); | 
| AndyA | 22:0dd9c1b5664a | 179 | head->ptr = head->p; | 
| AndyA | 22:0dd9c1b5664a | 180 | memp_free(MEMP_NETBUF, tail); | 
| AndyA | 22:0dd9c1b5664a | 181 | } | 
| AndyA | 22:0dd9c1b5664a | 182 | |
| AndyA | 22:0dd9c1b5664a | 183 | /** | 
| AndyA | 22:0dd9c1b5664a | 184 | * Get the data pointer and length of the data inside a netbuf. | 
| AndyA | 22:0dd9c1b5664a | 185 | * | 
| AndyA | 22:0dd9c1b5664a | 186 | * @param buf netbuf to get the data from | 
| AndyA | 22:0dd9c1b5664a | 187 | * @param dataptr pointer to a void pointer where to store the data pointer | 
| AndyA | 22:0dd9c1b5664a | 188 | * @param len pointer to an u16_t where the length of the data is stored | 
| AndyA | 22:0dd9c1b5664a | 189 | * @return ERR_OK if the information was retreived, | 
| AndyA | 22:0dd9c1b5664a | 190 | * ERR_BUF on error. | 
| AndyA | 22:0dd9c1b5664a | 191 | */ | 
| AndyA | 22:0dd9c1b5664a | 192 | err_t | 
| AndyA | 22:0dd9c1b5664a | 193 | netbuf_data(struct netbuf *buf, void **dataptr, u16_t *len) | 
| AndyA | 22:0dd9c1b5664a | 194 | { | 
| AndyA | 22:0dd9c1b5664a | 195 | LWIP_ERROR("netbuf_data: invalid buf", (buf != NULL), return ERR_ARG;); | 
| AndyA | 22:0dd9c1b5664a | 196 | LWIP_ERROR("netbuf_data: invalid dataptr", (dataptr != NULL), return ERR_ARG;); | 
| AndyA | 22:0dd9c1b5664a | 197 | LWIP_ERROR("netbuf_data: invalid len", (len != NULL), return ERR_ARG;); | 
| AndyA | 22:0dd9c1b5664a | 198 | |
| AndyA | 22:0dd9c1b5664a | 199 | if (buf->ptr == NULL) { | 
| AndyA | 22:0dd9c1b5664a | 200 | return ERR_BUF; | 
| AndyA | 22:0dd9c1b5664a | 201 | } | 
| AndyA | 22:0dd9c1b5664a | 202 | *dataptr = buf->ptr->payload; | 
| AndyA | 22:0dd9c1b5664a | 203 | *len = buf->ptr->len; | 
| AndyA | 22:0dd9c1b5664a | 204 | return ERR_OK; | 
| AndyA | 22:0dd9c1b5664a | 205 | } | 
| AndyA | 22:0dd9c1b5664a | 206 | |
| AndyA | 22:0dd9c1b5664a | 207 | /** | 
| AndyA | 22:0dd9c1b5664a | 208 | * Move the current data pointer of a packet buffer contained in a netbuf | 
| AndyA | 22:0dd9c1b5664a | 209 | * to the next part. | 
| AndyA | 22:0dd9c1b5664a | 210 | * The packet buffer itself is not modified. | 
| AndyA | 22:0dd9c1b5664a | 211 | * | 
| AndyA | 22:0dd9c1b5664a | 212 | * @param buf the netbuf to modify | 
| AndyA | 22:0dd9c1b5664a | 213 | * @return -1 if there is no next part | 
| AndyA | 22:0dd9c1b5664a | 214 | * 1 if moved to the next part but now there is no next part | 
| AndyA | 22:0dd9c1b5664a | 215 | * 0 if moved to the next part and there are still more parts | 
| AndyA | 22:0dd9c1b5664a | 216 | */ | 
| AndyA | 22:0dd9c1b5664a | 217 | s8_t | 
| AndyA | 22:0dd9c1b5664a | 218 | netbuf_next(struct netbuf *buf) | 
| AndyA | 22:0dd9c1b5664a | 219 | { | 
| AndyA | 22:0dd9c1b5664a | 220 | LWIP_ERROR("netbuf_free: invalid buf", (buf != NULL), return -1;); | 
| AndyA | 22:0dd9c1b5664a | 221 | if (buf->ptr->next == NULL) { | 
| AndyA | 22:0dd9c1b5664a | 222 | return -1; | 
| AndyA | 22:0dd9c1b5664a | 223 | } | 
| AndyA | 22:0dd9c1b5664a | 224 | buf->ptr = buf->ptr->next; | 
| AndyA | 22:0dd9c1b5664a | 225 | if (buf->ptr->next == NULL) { | 
| AndyA | 22:0dd9c1b5664a | 226 | return 1; | 
| AndyA | 22:0dd9c1b5664a | 227 | } | 
| AndyA | 22:0dd9c1b5664a | 228 | return 0; | 
| AndyA | 22:0dd9c1b5664a | 229 | } | 
| AndyA | 22:0dd9c1b5664a | 230 | |
| AndyA | 22:0dd9c1b5664a | 231 | /** | 
| AndyA | 22:0dd9c1b5664a | 232 | * Move the current data pointer of a packet buffer contained in a netbuf | 
| AndyA | 22:0dd9c1b5664a | 233 | * to the beginning of the packet. | 
| AndyA | 22:0dd9c1b5664a | 234 | * The packet buffer itself is not modified. | 
| AndyA | 22:0dd9c1b5664a | 235 | * | 
| AndyA | 22:0dd9c1b5664a | 236 | * @param buf the netbuf to modify | 
| AndyA | 22:0dd9c1b5664a | 237 | */ | 
| AndyA | 22:0dd9c1b5664a | 238 | void | 
| AndyA | 22:0dd9c1b5664a | 239 | netbuf_first(struct netbuf *buf) | 
| AndyA | 22:0dd9c1b5664a | 240 | { | 
| AndyA | 22:0dd9c1b5664a | 241 | LWIP_ERROR("netbuf_free: invalid buf", (buf != NULL), return;); | 
| AndyA | 22:0dd9c1b5664a | 242 | buf->ptr = buf->p; | 
| AndyA | 22:0dd9c1b5664a | 243 | } | 
| AndyA | 22:0dd9c1b5664a | 244 | |
| AndyA | 22:0dd9c1b5664a | 245 | #endif /* LWIP_NETCONN */ |