src/api/tcpip.c

   1 /**
   2  * @file
   3  * Sequential API Main thread module
   4  *
   5  */
   6
   7 /*
   8  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without modification,
  12  * are permitted provided that the following conditions are met:
  13  *
  14  * 1. Redistributions of source code must retain the above copyright notice,
  15  *    this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright notice,
  17  *    this list of conditions and the following disclaimer in the documentation
  18  *    and/or other materials provided with the distribution.
  19  * 3. The name of the author may not be used to endorse or promote products
  20  *    derived from this software without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  23  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  24  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
  25  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  26  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  27  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  30  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  31  * OF SUCH DAMAGE.
  32  *
  33  * This file is part of the lwIP TCP/IP stack.
  34  *
  35  * Author: Adam Dunkels <adam@sics.se>
  36  *
  37  */
  38
  39 #include "lwip/opt.h"
  40
  41 #if !NO_SYS /* don't build if not configured for use in lwipopts.h */
  42
  43 #include "lwip/sys.h"
  44 #include "lwip/memp.h"
  45 #include "lwip/mem.h"
  46 #include "lwip/pbuf.h"
  47 #include "lwip/tcpip.h"
  48 #include "lwip/init.h"
  49 #include "netif/etharp.h"
  50 #include "netif/ppp_oe.h"
  51
  52 /* global variables */
  53 static tcpip_init_done_fn tcpip_init_done;
  54 static void *tcpip_init_done_arg;
  55 static sys_mbox_t mbox;
  56
  57 #if LWIP_TCPIP_CORE_LOCKING
  58 /** The global semaphore to lock the stack. */
  59 sys_mutex_t lock_tcpip_core;
  60 #endif /* LWIP_TCPIP_CORE_LOCKING */
  61
  62
  63 /**
  64  * The main lwIP thread. This thread has exclusive access to lwIP core functions
  65  * (unless access to them is not locked). Other threads communicate with this
  66  * thread using message boxes.
  67  *
  68  * It also starts all the timers to make sure they are running in the right
  69  * thread context.
  70  *
  71  * @param arg unused argument
  72  */
  73 static void
  74 tcpip_thread(void *arg)
  75 {
  76   struct tcpip_msg *msg;
  77   LWIP_UNUSED_ARG(arg);
  78
  79   if (tcpip_init_done != NULL) {
  80     tcpip_init_done(tcpip_init_done_arg);
  81   }
  82
  83   LOCK_TCPIP_CORE();
  84   while (1) {                          /* MAIN Loop */
  85     UNLOCK_TCPIP_CORE();
  86     /* wait for a message, timeouts are processed while waiting */
  87     sys_timeouts_mbox_fetch(&mbox, (void **)&msg);
  88     LOCK_TCPIP_CORE();
  89     switch (msg->type) {
  90 #if LWIP_NETCONN
  91     case TCPIP_MSG_API:
  92       LWIP_DEBUGF(TCPIP_DEBUG, ("tcpip_thread: API message %p\n", (void *)msg));
  93       msg->msg.apimsg->function(&(msg->msg.apimsg->msg));
  94       break;
  95 #endif /* LWIP_NETCONN */
  96
  97 #if !LWIP_TCPIP_CORE_LOCKING_INPUT
  98     case TCPIP_MSG_INPKT:
  99       LWIP_DEBUGF(TCPIP_DEBUG, ("tcpip_thread: PACKET %p\n", (void *)msg));
 100 #if LWIP_ETHERNET
 101       if (msg->msg.inp.netif->flags & (NETIF_FLAG_ETHARP | NETIF_FLAG_ETHERNET)) {
 102         ethernet_input(msg->msg.inp.p, msg->msg.inp.netif);
 103       } else
 104 #endif /* LWIP_ETHERNET */
 105       {
 106         ip_input(msg->msg.inp.p, msg->msg.inp.netif);
 107       }
 108       memp_free(MEMP_TCPIP_MSG_INPKT, msg);
 109       break;
 110 #endif /* LWIP_TCPIP_CORE_LOCKING_INPUT */
 111
 112 #if LWIP_NETIF_API
 113     case TCPIP_MSG_NETIFAPI:
 114       LWIP_DEBUGF(TCPIP_DEBUG, ("tcpip_thread: Netif API message %p\n", (void *)msg));
 115       msg->msg.netifapimsg->function(&(msg->msg.netifapimsg->msg));
 116       break;
 117 #endif /* LWIP_NETIF_API */
 118
 119     case TCPIP_MSG_CALLBACK:
 120       LWIP_DEBUGF(TCPIP_DEBUG, ("tcpip_thread: CALLBACK %p\n", (void *)msg));
 121       msg->msg.cb.function(msg->msg.cb.ctx);
 122       memp_free(MEMP_TCPIP_MSG_API, msg);
 123       break;
 124
 125 #if LWIP_TCPIP_TIMEOUT
 126     case TCPIP_MSG_TIMEOUT:
 127       LWIP_DEBUGF(TCPIP_DEBUG, ("tcpip_thread: TIMEOUT %p\n", (void *)msg));
 128       sys_timeout(msg->msg.tmo.msecs, msg->msg.tmo.h, msg->msg.tmo.arg);
 129       memp_free(MEMP_TCPIP_MSG_API, msg);
 130       break;
 131     case TCPIP_MSG_UNTIMEOUT:
 132       LWIP_DEBUGF(TCPIP_DEBUG, ("tcpip_thread: UNTIMEOUT %p\n", (void *)msg));
 133       sys_untimeout(msg->msg.tmo.h, msg->msg.tmo.arg);
 134       memp_free(MEMP_TCPIP_MSG_API, msg);
 135       break;
 136 #endif /* LWIP_TCPIP_TIMEOUT */
 137
 138     default:
 139       LWIP_DEBUGF(TCPIP_DEBUG, ("tcpip_thread: invalid message: %d\n", msg->type));
 140       LWIP_ASSERT("tcpip_thread: invalid message", 0);
 141       break;
 142     }
 143   }
 144 }
 145
 146 /**
 147  * Pass a received packet to tcpip_thread for input processing
 148  *
 149  * @param p the received packet, p->payload pointing to the Ethernet header or
 150  *          to an IP header (if inp doesn't have NETIF_FLAG_ETHARP or
 151  *          NETIF_FLAG_ETHERNET flags)
 152  * @param inp the network interface on which the packet was received
 153  */
 154 err_t
 155 tcpip_input(struct pbuf *p, struct netif *inp)
 156 {
 157 #if LWIP_TCPIP_CORE_LOCKING_INPUT
 158   err_t ret;
 159   LWIP_DEBUGF(TCPIP_DEBUG, ("tcpip_input: PACKET %p/%p\n", (void *)p, (void *)inp));
 160   LOCK_TCPIP_CORE();
 161 #if LWIP_ETHERNET
 162   if (inp->flags & (NETIF_FLAG_ETHARP | NETIF_FLAG_ETHERNET)) {
 163     ret = ethernet_input(p, inp);
 164   } else
 165 #endif /* LWIP_ETHERNET */
 166   {
 167     ret = ip_input(p, inp);
 168   }
 169   UNLOCK_TCPIP_CORE();
 170   return ret;
 171 #else /* LWIP_TCPIP_CORE_LOCKING_INPUT */
 172   struct tcpip_msg *msg;
 173
 174   if (sys_mbox_valid(&mbox)) {
 175     msg = (struct tcpip_msg *)memp_malloc(MEMP_TCPIP_MSG_INPKT);
 176     if (msg == NULL) {
 177       return ERR_MEM;
 178     }
 179
 180     msg->type = TCPIP_MSG_INPKT;
 181     msg->msg.inp.p = p;
 182     msg->msg.inp.netif = inp;
 183     if (sys_mbox_trypost(&mbox, msg) != ERR_OK) {
 184       memp_free(MEMP_TCPIP_MSG_INPKT, msg);
 185       return ERR_MEM;
 186     }
 187     return ERR_OK;
 188   }
 189   return ERR_VAL;
 190 #endif /* LWIP_TCPIP_CORE_LOCKING_INPUT */
 191 }
 192
 193 /**
 194  * Call a specific function in the thread context of
 195  * tcpip_thread for easy access synchronization.
 196  * A function called in that way may access lwIP core code
 197  * without fearing concurrent access.
 198  *
 199  * @param f the function to call
 200  * @param ctx parameter passed to f
 201  * @param block 1 to block until the request is posted, 0 to non-blocking mode
 202  * @return ERR_OK if the function was called, another err_t if not
 203  */
 204 err_t
 205 tcpip_callback_with_block(tcpip_callback_fn function, void *ctx, u8_t block)
 206 {
 207   struct tcpip_msg *msg;
 208
 209   if (sys_mbox_valid(&mbox)) {
 210     msg = (struct tcpip_msg *)memp_malloc(MEMP_TCPIP_MSG_API);
 211     if (msg == NULL) {
 212       return ERR_MEM;
 213     }
 214
 215     msg->type = TCPIP_MSG_CALLBACK;
 216     msg->msg.cb.function = function;
 217     msg->msg.cb.ctx = ctx;
 218     if (block) {
 219       sys_mbox_post(&mbox, msg);
 220     } else {
 221       if (sys_mbox_trypost(&mbox, msg) != ERR_OK) {
 222         memp_free(MEMP_TCPIP_MSG_API, msg);
 223         return ERR_MEM;
 224       }
 225     }
 226     return ERR_OK;
 227   }
 228   return ERR_VAL;
 229 }
 230
 231 #if LWIP_TCPIP_TIMEOUT
 232 /**
 233  * call sys_timeout in tcpip_thread
 234  *
 235  * @param msec time in milliseconds for timeout
 236  * @param h function to be called on timeout
 237  * @param arg argument to pass to timeout function h
 238  * @return ERR_MEM on memory error, ERR_OK otherwise
 239  */
 240 err_t
 241 tcpip_timeout(u32_t msecs, sys_timeout_handler h, void *arg)
 242 {
 243   struct tcpip_msg *msg;
 244
 245   if (sys_mbox_valid(&mbox)) {
 246     msg = (struct tcpip_msg *)memp_malloc(MEMP_TCPIP_MSG_API);
 247     if (msg == NULL) {
 248       return ERR_MEM;
 249     }
 250
 251     msg->type = TCPIP_MSG_TIMEOUT;
 252     msg->msg.tmo.msecs = msecs;
 253     msg->msg.tmo.h = h;
 254     msg->msg.tmo.arg = arg;
 255     sys_mbox_post(&mbox, msg);
 256     return ERR_OK;
 257   }
 258   return ERR_VAL;
 259 }
 260
 261 /**
 262  * call sys_untimeout in tcpip_thread
 263  *
 264  * @param msec time in milliseconds for timeout
 265  * @param h function to be called on timeout
 266  * @param arg argument to pass to timeout function h
 267  * @return ERR_MEM on memory error, ERR_OK otherwise
 268  */
 269 err_t
 270 tcpip_untimeout(sys_timeout_handler h, void *arg)
 271 {
 272   struct tcpip_msg *msg;
 273
 274   if (sys_mbox_valid(&mbox)) {
 275     msg = (struct tcpip_msg *)memp_malloc(MEMP_TCPIP_MSG_API);
 276     if (msg == NULL) {
 277       return ERR_MEM;
 278     }
 279
 280     msg->type = TCPIP_MSG_UNTIMEOUT;
 281     msg->msg.tmo.h = h;
 282     msg->msg.tmo.arg = arg;
 283     sys_mbox_post(&mbox, msg);
 284     return ERR_OK;
 285   }
 286   return ERR_VAL;
 287 }
 288 #endif /* LWIP_TCPIP_TIMEOUT */
 289
 290 #if LWIP_NETCONN
 291 /**
 292  * Call the lower part of a netconn_* function
 293  * This function is then running in the thread context
 294  * of tcpip_thread and has exclusive access to lwIP core code.
 295  *
 296  * @param apimsg a struct containing the function to call and its parameters
 297  * @return ERR_OK if the function was called, another err_t if not
 298  */
 299 err_t
 300 tcpip_apimsg(struct api_msg *apimsg)
 301 {
 302   struct tcpip_msg msg;
 303 #ifdef LWIP_DEBUG
 304   /* catch functions that don't set err */
 305   apimsg->msg.err = ERR_VAL;
 306 #endif
 307
 308   if (sys_mbox_valid(&mbox)) {
 309     msg.type = TCPIP_MSG_API;
 310     msg.msg.apimsg = apimsg;
 311     sys_mbox_post(&mbox, &msg);
 312     sys_arch_sem_wait(&apimsg->msg.conn->op_completed, 0);
 313     return apimsg->msg.err;
 314   }
 315   return ERR_VAL;
 316 }
 317
 318 #if LWIP_TCPIP_CORE_LOCKING
 319 /**
 320  * Call the lower part of a netconn_* function
 321  * This function has exclusive access to lwIP core code by locking it
 322  * before the function is called.
 323  *
 324  * @param apimsg a struct containing the function to call and its parameters
 325  * @return ERR_OK (only for compatibility fo tcpip_apimsg())
 326  */
 327 err_t
 328 tcpip_apimsg_lock(struct api_msg *apimsg)
 329 {
 330 #ifdef LWIP_DEBUG
 331   /* catch functions that don't set err */
 332   apimsg->msg.err = ERR_VAL;
 333 #endif
 334
 335   LOCK_TCPIP_CORE();
 336   apimsg->function(&(apimsg->msg));
 337   UNLOCK_TCPIP_CORE();
 338   return apimsg->msg.err;
 339
 340 }
 341 #endif /* LWIP_TCPIP_CORE_LOCKING */
 342 #endif /* LWIP_NETCONN */
 343
 344 #if LWIP_NETIF_API
 345 #if !LWIP_TCPIP_CORE_LOCKING
 346 /**
 347  * Much like tcpip_apimsg, but calls the lower part of a netifapi_*
 348  * function.
 349  *
 350  * @param netifapimsg a struct containing the function to call and its parameters
 351  * @return error code given back by the function that was called
 352  */
 353 err_t
 354 tcpip_netifapi(struct netifapi_msg* netifapimsg)
 355 {
 356   struct tcpip_msg msg;
 357
 358   if (sys_mbox_valid(&mbox)) {
 359     err_t err = sys_sem_new(&netifapimsg->msg.sem, 0);
 360     if (err != ERR_OK) {
 361       netifapimsg->msg.err = err;
 362       return err;
 363     }
 364
 365     msg.type = TCPIP_MSG_NETIFAPI;
 366     msg.msg.netifapimsg = netifapimsg;
 367     sys_mbox_post(&mbox, &msg);
 368     sys_sem_wait(&netifapimsg->msg.sem);
 369     sys_sem_free(&netifapimsg->msg.sem);
 370     return netifapimsg->msg.err;
 371   }
 372   return ERR_VAL;
 373 }
 374 #else /* !LWIP_TCPIP_CORE_LOCKING */
 375 /**
 376  * Call the lower part of a netifapi_* function
 377  * This function has exclusive access to lwIP core code by locking it
 378  * before the function is called.
 379  *
 380  * @param netifapimsg a struct containing the function to call and its parameters
 381  * @return ERR_OK (only for compatibility fo tcpip_netifapi())
 382  */
 383 err_t
 384 tcpip_netifapi_lock(struct netifapi_msg* netifapimsg)
 385 {
 386   LOCK_TCPIP_CORE();
 387   netifapimsg->function(&(netifapimsg->msg));
 388   UNLOCK_TCPIP_CORE();
 389   return netifapimsg->msg.err;
 390 }
 391 #endif /* !LWIP_TCPIP_CORE_LOCKING */
 392 #endif /* LWIP_NETIF_API */
 393
 394 /**
 395  * Initialize this module:
 396  * - initialize all sub modules
 397  * - start the tcpip_thread
 398  *
 399  * @param initfunc a function to call when tcpip_thread is running and finished initializing
 400  * @param arg argument to pass to initfunc
 401  */
 402 void
 403 tcpip_init(tcpip_init_done_fn initfunc, void *arg)
 404 {
 405   lwip_init();
 406
 407   tcpip_init_done = initfunc;
 408   tcpip_init_done_arg = arg;
 409   if(sys_mbox_new(&mbox, TCPIP_MBOX_SIZE) != ERR_OK) {
 410     LWIP_ASSERT("failed to create tcpip_thread mbox", 0);
 411   }
 412 #if LWIP_TCPIP_CORE_LOCKING
 413   if(sys_mutex_new(&lock_tcpip_core) != ERR_OK) {
 414     LWIP_ASSERT("failed to create lock_tcpip_core", 0);
 415   }
 416 #endif /* LWIP_TCPIP_CORE_LOCKING */
 417
 418   sys_thread_new(TCPIP_THREAD_NAME, tcpip_thread, NULL, TCPIP_THREAD_STACKSIZE, TCPIP_THREAD_PRIO);
 419 }
 420
 421 /**
 422  * Simple callback function used with tcpip_callback to free a pbuf
 423  * (pbuf_free has a wrong signature for tcpip_callback)
 424  *
 425  * @param p The pbuf (chain) to be dereferenced.
 426  */
 427 static void
 428 pbuf_free_int(void *p)
 429 {
 430   struct pbuf *q = (struct pbuf *)p;
 431   pbuf_free(q);
 432 }
 433
 434 /**
 435  * A simple wrapper function that allows you to free a pbuf from interrupt context.
 436  *
 437  * @param p The pbuf (chain) to be dereferenced.
 438  * @return ERR_OK if callback could be enqueued, an err_t if not
 439  */
 440 err_t
 441 pbuf_free_callback(struct pbuf *p)
 442 {
 443   return tcpip_callback_with_block(pbuf_free_int, p, 0);
 444 }
 445
 446 /**
 447  * A simple wrapper function that allows you to free heap memory from
 448  * interrupt context.
 449  *
 450  * @param m the heap memory to free
 451  * @return ERR_OK if callback could be enqueued, an err_t if not
 452  */
 453 err_t
 454 mem_free_callback(void *m)
 455 {
 456   return tcpip_callback_with_block(mem_free, m, 0);
 457 }
 458
 459 #endif /* !NO_SYS */