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