pintos-os.org Git - openvswitch/blob - switch/forward.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 #ifndef FORWARD_H
  35 #define FORWARD_H 1
  36
  37 #include <stddef.h>
  38 #include <stdint.h>
  39
  40 struct buffer;
  41 struct datapath;
  42 struct ofp_action;
  43 struct sw_flow_key;
  44
  45 /* Buffers are identified to userspace by a 31-bit opaque ID.  We divide the ID
  46  * into a buffer number (low bits) and a cookie (high bits).  The buffer number
  47  * is an index into an array of buffers.  The cookie distinguishes between
  48  * different packets that have occupied a single buffer.  Thus, the more
  49  * buffers we have, the lower-quality the cookie... */
  50 #define PKT_BUFFER_BITS 8
  51 #define N_PKT_BUFFERS (1 << PKT_BUFFER_BITS)
  52 #define PKT_BUFFER_MASK (N_PKT_BUFFERS - 1)
  53
  54 #define PKT_COOKIE_BITS (32 - PKT_BUFFER_BITS)
  55
  56
  57 void fwd_port_input(struct datapath *, struct buffer *, int in_port);
  58 int fwd_control_input(struct datapath *, const void *, size_t);
  59
  60 uint32_t fwd_save_buffer(struct buffer *);
  61
  62 void fwd_exit(void);
  63
  64 struct buffer *execute_setter(struct buffer *, uint16_t,
  65                               const struct sw_flow_key *,
  66                               const struct ofp_action *);
  67
  68 #endif /* forward.h */