udatapath/datapath.h

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 /* Interface exported by OpenFlow module. */
  35
  36 #ifndef DATAPATH_H
  37 #define DATAPATH_H 1
  38
  39 #include <stdbool.h>
  40 #include <stdint.h>
  41 #include "openflow/nicira-ext.h"
  42 #include "ofpbuf.h"
  43 #include "timeval.h"
  44 #include "list.h"
  45
  46 struct rconn;
  47 struct pvconn;
  48 struct sw_flow;
  49 struct sender;
  50
  51 struct sw_port {
  52     uint32_t config;            /* Some subset of OFPPC_* flags. */
  53     uint32_t state;             /* Some subset of OFPPS_* flags. */
  54     struct datapath *dp;
  55     struct netdev *netdev;
  56     struct list node; /* Element in datapath.ports. */
  57     unsigned long long int rx_packets, tx_packets;
  58     unsigned long long int rx_bytes, tx_bytes;
  59     unsigned long long int tx_dropped;
  60     uint16_t port_no;
  61 };
  62
  63 #define DP_MAX_PORTS 255
  64 BUILD_ASSERT_DECL(DP_MAX_PORTS <= OFPP_MAX);
  65
  66 struct datapath {
  67     /* Remote connections. */
  68     struct list remotes;        /* All connections (including controller). */
  69
  70     /* Listeners. */
  71     struct pvconn **listeners;
  72     size_t n_listeners;
  73
  74     time_t last_timeout;
  75
  76     /* Unique identifier for this datapath */
  77     uint64_t  id;
  78
  79     struct sw_chain *chain;  /* Forwarding rules. */
  80
  81     /* Configuration set from controller. */
  82     uint16_t flags;
  83     uint16_t miss_send_len;
  84
  85     /* Flag controlling whether Flow End messages are generated. */
  86     uint8_t send_flow_end;
  87
  88     /* Switch ports. */
  89     struct sw_port ports[DP_MAX_PORTS];
  90     struct sw_port *local_port;  /* OFPP_LOCAL port, if any. */
  91     struct list port_list; /* All ports, including local_port. */
  92 };
  93
  94 int dp_new(struct datapath **, uint64_t dpid);
  95 int dp_add_port(struct datapath *, const char *netdev);
  96 int dp_add_local_port(struct datapath *, const char *netdev);
  97 void dp_add_pvconn(struct datapath *, struct pvconn *);
  98 void dp_run(struct datapath *);
  99 void dp_wait(struct datapath *);
 100 void dp_send_error_msg(struct datapath *, const struct sender *,
 101                   uint16_t, uint16_t, const void *, size_t);
 102 void dp_send_flow_end(struct datapath *, struct sw_flow *,
 103                       enum nx_flow_end_reason);
 104 void dp_output_port(struct datapath *, struct ofpbuf *, int in_port,
 105         int out_port, bool ignore_no_fwd);
 106 void dp_output_control(struct datapath *, struct ofpbuf *, int in_port,
 107         size_t max_len, int reason);
 108
 109 #endif /* datapath.h */