examples/ip_pipeline/pipeline/pipeline_routing.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef __INCLUDE_PIPELINE_ROUTING_H__
  35 #define __INCLUDE_PIPELINE_ROUTING_H__
  36
  37 #include "pipeline.h"
  38 #include "pipeline_routing_be.h"
  39
  40 /*
  41  * Route
  42  */
  43
  44 struct app_pipeline_routing_route_params {
  45         uint32_t flags;
  46         uint32_t port_id; /* Output port ID */
  47         uint32_t ip; /* IP address for the next hop (only for remote routes) */
  48 };
  49
  50 int
  51 app_pipeline_routing_add_route(struct app_params *app,
  52         uint32_t pipeline_id,
  53         struct pipeline_routing_route_key *key,
  54         struct app_pipeline_routing_route_params *route_params);
  55
  56 int
  57 app_pipeline_routing_delete_route(struct app_params *app,
  58         uint32_t pipeline_id,
  59         struct pipeline_routing_route_key *key);
  60
  61 int
  62 app_pipeline_routing_add_default_route(struct app_params *app,
  63         uint32_t pipeline_id,
  64         uint32_t port_id);
  65
  66 int
  67 app_pipeline_routing_delete_default_route(struct app_params *app,
  68         uint32_t pipeline_id);
  69
  70 /*
  71  * ARP
  72  */
  73
  74 int
  75 app_pipeline_routing_add_arp_entry(struct app_params *app,
  76         uint32_t pipeline_id,
  77         struct pipeline_routing_arp_key *key,
  78         struct ether_addr *macaddr);
  79
  80 int
  81 app_pipeline_routing_delete_arp_entry(struct app_params *app,
  82         uint32_t pipeline_id,
  83         struct pipeline_routing_arp_key *key);
  84
  85 int
  86 app_pipeline_routing_add_default_arp_entry(struct app_params *app,
  87         uint32_t pipeline_id,
  88         uint32_t port_id);
  89
  90 int
  91 app_pipeline_routing_delete_default_arp_entry(struct app_params *app,
  92         uint32_t pipeline_id);
  93
  94 /*
  95  * Pipeline type
  96  */
  97 extern struct pipeline_type pipeline_routing;
  98
  99 #endif