git.sur5r.net Git - freertos/blob - Demo/Common/ethernet/lwIP/core/raw.c

   1 /**\r
   2  * @file\r
   3  * \r
   4  * Implementation of raw protocol PCBs for low-level handling of\r
   5  * different types of protocols besides (or overriding) those\r
   6  * already available in lwIP.\r
   7  *\r
   8  */\r
   9 /*\r
  10  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.\r
  11  * All rights reserved.\r
  12  *\r
  13  * Redistribution and use in source and binary forms, with or without modification,\r
  14  * are permitted provided that the following conditions are met:\r
  15  *\r
  16  * 1. Redistributions of source code must retain the above copyright notice,\r
  17  *    this list of conditions and the following disclaimer.\r
  18  * 2. Redistributions in binary form must reproduce the above copyright notice,\r
  19  *    this list of conditions and the following disclaimer in the documentation\r
  20  *    and/or other materials provided with the distribution.\r
  21  * 3. The name of the author may not be used to endorse or promote products\r
  22  *    derived from this software without specific prior written permission.\r
  23  *\r
  24  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED\r
  25  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  26  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT\r
  27  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\r
  28  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT\r
  29  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
  30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
  31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING\r
  32  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY\r
  33  * OF SUCH DAMAGE.\r
  34  *\r
  35  * This file is part of the lwIP TCP/IP stack.\r
  36  *\r
  37  * Author: Adam Dunkels <adam@sics.se>\r
  38  *\r
  39  */\r
  40 \r
  41 #include <string.h>\r
  42 \r
  43 #include "lwip/opt.h"\r
  44 \r
  45 #include "lwip/def.h"\r
  46 #include "lwip/memp.h"\r
  47 #include "lwip/inet.h"\r
  48 #include "lwip/ip_addr.h"\r
  49 #include "lwip/netif.h"\r
  50 #include "lwip/raw.h"\r
  51 \r
  52 #include "lwip/stats.h"\r
  53 \r
  54 #include "arch/perf.h"\r
  55 #include "lwip/snmp.h"\r
  56 \r
  57 #if LWIP_RAW\r
  58 \r
  59 /** The list of RAW PCBs */\r
  60 static struct raw_pcb *raw_pcbs = NULL;\r
  61 \r
  62 void\r
  63 raw_init(void)\r
  64 {\r
  65   raw_pcbs = NULL;\r
  66 }\r
  67 \r
  68 /**\r
  69  * Determine if in incoming IP packet is covered by a RAW PCB\r
  70  * and if so, pass it to a user-provided receive callback function.\r
  71  *\r
  72  * Given an incoming IP datagram (as a chain of pbufs) this function\r
  73  * finds a corresponding RAW PCB and calls the corresponding receive\r
  74  * callback function.\r
  75  *\r
  76  * @param pbuf pbuf to be demultiplexed to a RAW PCB.\r
  77  * @param netif network interface on which the datagram was received.\r
  78  * @Return - 1 if the packet has been eaten by a RAW PCB receive\r
  79  *           callback function. The caller MAY NOT not reference the\r
  80  *           packet any longer, and MAY NOT call pbuf_free().\r
  81  * @return - 0 if packet is not eaten (pbuf is still referenced by the\r
  82  *           caller).\r
  83  *\r
  84  */\r
  85 u8_t\r
  86 raw_input(struct pbuf *p, struct netif *inp)\r
  87 {\r
  88   struct raw_pcb *pcb;\r
  89   struct ip_hdr *iphdr;\r
  90   s16_t proto;\r
  91   u8_t eaten = 0;\r
  92 \r
  93   iphdr = p->payload;\r
  94   proto = IPH_PROTO(iphdr);\r
  95 \r
  96   pcb = raw_pcbs;\r
  97   /* loop through all raw pcbs until the packet is eaten by one */\r
  98   /* this allows multiple pcbs to match against the packet by design */\r
  99   while ((eaten == 0) && (pcb != NULL)) {\r
 100     if (pcb->protocol == proto) {\r
 101       /* receive callback function available? */\r
 102       if (pcb->recv != NULL) {\r
 103         /* the receive callback function did not eat the packet? */\r
 104         if (pcb->recv(pcb->recv_arg, pcb, p, &(iphdr->src)) != 0)\r
 105         {\r
 106           /* receive function ate the packet */\r
 107           p = NULL;\r
 108           eaten = 1;\r
 109         }\r
 110       }\r
 111       /* no receive callback function was set for this raw PCB */\r
 112       /* drop the packet */\r
 113     }\r
 114     pcb = pcb->next;\r
 115   }\r
 116   return eaten;\r
 117 }\r
 118 \r
 119 /**\r
 120  * Bind a RAW PCB.\r
 121  *\r
 122  * @param pcb RAW PCB to be bound with a local address ipaddr.\r
 123  * @param ipaddr local IP address to bind with. Use IP_ADDR_ANY to\r
 124  * bind to all local interfaces.\r
 125  *\r
 126  * @return lwIP error code.\r
 127  * - ERR_OK. Successful. No error occured.\r
 128  * - ERR_USE. The specified IP address is already bound to by\r
 129  * another RAW PCB.\r
 130  *\r
 131  * @see raw_disconnect()\r
 132  */\r
 133 err_t\r
 134 raw_bind(struct raw_pcb *pcb, struct ip_addr *ipaddr)\r
 135 {\r
 136   ip_addr_set(&pcb->local_ip, ipaddr);\r
 137   return ERR_OK;\r
 138 }\r
 139 \r
 140 /**\r
 141  * Connect an RAW PCB. This function is required by upper layers\r
 142  * of lwip. Using the raw api you could use raw_sendto() instead\r
 143  *\r
 144  * This will associate the RAW PCB with the remote address.\r
 145  *\r
 146  * @param pcb RAW PCB to be connected with remote address ipaddr and port.\r
 147  * @param ipaddr remote IP address to connect with.\r
 148  *\r
 149  * @return lwIP error code\r
 150  *\r
 151  * @see raw_disconnect() and raw_sendto()\r
 152  */\r
 153 err_t\r
 154 raw_connect(struct raw_pcb *pcb, struct ip_addr *ipaddr)\r
 155 {\r
 156   ip_addr_set(&pcb->remote_ip, ipaddr);\r
 157   return ERR_OK;\r
 158 }\r
 159 \r
 160 \r
 161 /**\r
 162  * Set the callback function for received packets that match the\r
 163  * raw PCB's protocol and binding. \r
 164  * \r
 165  * The callback function MUST either\r
 166  * - eat the packet by calling pbuf_free() and returning non-zero. The\r
 167  *   packet will not be passed to other raw PCBs or other protocol layers.\r
 168  * - not free the packet, and return zero. The packet will be matched\r
 169  *   against further PCBs and/or forwarded to another protocol layers.\r
 170  * \r
 171  * @return non-zero if the packet was free()d, zero if the packet remains\r
 172  * available for others.\r
 173  */\r
 174 void\r
 175 raw_recv(struct raw_pcb *pcb,\r
 176          u8_t (* recv)(void *arg, struct raw_pcb *upcb, struct pbuf *p,\r
 177                       struct ip_addr *addr),\r
 178          void *recv_arg)\r
 179 {\r
 180   /* remember recv() callback and user data */\r
 181   pcb->recv = recv;\r
 182   pcb->recv_arg = recv_arg;\r
 183 }\r
 184 \r
 185 /**\r
 186  * Send the raw IP packet to the given address. Note that actually you cannot\r
 187  * modify the IP headers (this is inconsistent with the receive callback where\r
 188  * you actually get the IP headers), you can only specify the IP payload here.\r
 189  * It requires some more changes in lwIP. (there will be a raw_send() function\r
 190  * then.)\r
 191  *\r
 192  * @param pcb the raw pcb which to send\r
 193  * @param p the IP payload to send\r
 194  * @param ipaddr the destination address of the IP packet\r
 195  *\r
 196  */\r
 197 err_t\r
 198 raw_sendto(struct raw_pcb *pcb, struct pbuf *p, struct ip_addr *ipaddr)\r
 199 {\r
 200   err_t err;\r
 201   struct netif *netif;\r
 202   struct ip_addr *src_ip;\r
 203   struct pbuf *q; /* q will be sent down the stack */\r
 204   \r
 205   LWIP_DEBUGF(RAW_DEBUG | DBG_TRACE | 3, ("raw_sendto\n"));\r
 206   \r
 207   /* not enough space to add an IP header to first pbuf in given p chain? */\r
 208   if (pbuf_header(p, IP_HLEN)) {\r
 209     /* allocate header in new pbuf */\r
 210     q = pbuf_alloc(PBUF_IP, 0, PBUF_RAM);\r
 211     /* new header pbuf could not be allocated? */\r
 212     if (q == NULL) {\r
 213       LWIP_DEBUGF(RAW_DEBUG | DBG_TRACE | 2, ("raw_sendto: could not allocate header\n"));\r
 214       return ERR_MEM;\r
 215     }\r
 216     /* chain header q in front of given pbuf p */\r
 217     pbuf_chain(q, p);\r
 218     /* { first pbuf q points to header pbuf } */\r
 219     LWIP_DEBUGF(RAW_DEBUG, ("raw_sendto: added header pbuf %p before given pbuf %p\n", (void *)q, (void *)p));\r
 220   }  else {\r
 221     /* first pbuf q equals given pbuf */\r
 222     q = p;\r
 223     pbuf_header(q, -IP_HLEN);\r
 224   }\r
 225   \r
 226   if ((netif = ip_route(ipaddr)) == NULL) {\r
 227     LWIP_DEBUGF(RAW_DEBUG | 1, ("raw_sendto: No route to 0x%"X32_F"\n", ipaddr->addr));\r
 228 #if RAW_STATS\r
 229     /*    ++lwip_stats.raw.rterr;*/\r
 230 #endif /* RAW_STATS */\r
 231     /* free any temporary header pbuf allocated by pbuf_header() */\r
 232     if (q != p) {\r
 233       pbuf_free(q);\r
 234     }\r
 235     return ERR_RTE;\r
 236   }\r
 237 \r
 238   if (ip_addr_isany(&pcb->local_ip)) {\r
 239     /* use outgoing network interface IP address as source address */\r
 240     src_ip = &(netif->ip_addr);\r
 241   } else {\r
 242     /* use RAW PCB local IP address as source address */\r
 243     src_ip = &(pcb->local_ip);\r
 244   }\r
 245 \r
 246   err = ip_output_if (q, src_ip, ipaddr, pcb->ttl, pcb->tos, pcb->protocol, netif);\r
 247 \r
 248   /* did we chain a header earlier? */\r
 249   if (q != p) {\r
 250     /* free the header */\r
 251     pbuf_free(q);\r
 252   }\r
 253   return err;\r
 254 }\r
 255 \r
 256 /**\r
 257  * Send the raw IP packet to the address given by raw_connect()\r
 258  *\r
 259  * @param pcb the raw pcb which to send\r
 260  * @param p the IP payload to send\r
 261  * @param ipaddr the destination address of the IP packet\r
 262  *\r
 263  */\r
 264 err_t\r
 265 raw_send(struct raw_pcb *pcb, struct pbuf *p)\r
 266 {\r
 267   return raw_sendto(pcb, p, &pcb->remote_ip);\r
 268 }\r
 269 \r
 270 /**\r
 271  * Remove an RAW PCB.\r
 272  *\r
 273  * @param pcb RAW PCB to be removed. The PCB is removed from the list of\r
 274  * RAW PCB's and the data structure is freed from memory.\r
 275  *\r
 276  * @see raw_new()\r
 277  */\r
 278 void\r
 279 raw_remove(struct raw_pcb *pcb)\r
 280 {\r
 281   struct raw_pcb *pcb2;\r
 282   /* pcb to be removed is first in list? */\r
 283   if (raw_pcbs == pcb) {\r
 284     /* make list start at 2nd pcb */\r
 285     raw_pcbs = raw_pcbs->next;\r
 286     /* pcb not 1st in list */\r
 287   } else for(pcb2 = raw_pcbs; pcb2 != NULL; pcb2 = pcb2->next) {\r
 288     /* find pcb in raw_pcbs list */\r
 289     if (pcb2->next != NULL && pcb2->next == pcb) {\r
 290       /* remove pcb from list */\r
 291       pcb2->next = pcb->next;\r
 292     }\r
 293   }\r
 294   memp_free(MEMP_RAW_PCB, pcb);\r
 295 }\r
 296 \r
 297 /**\r
 298  * Create a RAW PCB.\r
 299  *\r
 300  * @return The RAW PCB which was created. NULL if the PCB data structure\r
 301  * could not be allocated.\r
 302  *\r
 303  * @param proto the protocol number of the IPs payload (e.g. IP_PROTO_ICMP)\r
 304  *\r
 305  * @see raw_remove()\r
 306  */\r
 307 struct raw_pcb *\r
 308 raw_new(u16_t proto) {\r
 309   struct raw_pcb *pcb;\r
 310 \r
 311   LWIP_DEBUGF(RAW_DEBUG | DBG_TRACE | 3, ("raw_new\n"));\r
 312 \r
 313   pcb = memp_malloc(MEMP_RAW_PCB);\r
 314   /* could allocate RAW PCB? */\r
 315   if (pcb != NULL) {\r
 316     /* initialize PCB to all zeroes */\r
 317     memset(pcb, 0, sizeof(struct raw_pcb));\r
 318     pcb->protocol = proto;\r
 319     pcb->ttl = RAW_TTL;\r
 320     pcb->next = raw_pcbs;\r
 321     raw_pcbs = pcb;\r
 322   }\r
 323   return pcb;\r
 324 }\r
 325 \r
 326 #endif /* LWIP_RAW */\r