lib/flow.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 #ifndef FLOW_H
  34 #define FLOW_H 1
  35
  36 #include <stdbool.h>
  37 #include <stdint.h>
  38 #include "util.h"
  39
  40 struct ofpbuf;
  41
  42 /* Identification data for a flow.
  43    All fields are in network byte order.
  44    In decreasing order by size, so that flow structures can be hashed or
  45    compared bytewise. */
  46 struct flow {
  47     uint32_t nw_src;            /* IP source address. */
  48     uint32_t nw_dst;            /* IP destination address. */
  49     uint16_t in_port;           /* Input switch port. */
  50     uint16_t dl_vlan;           /* Input VLAN. */
  51     uint16_t dl_type;           /* Ethernet frame type. */
  52     uint16_t tp_src;            /* TCP/UDP source port. */
  53     uint16_t tp_dst;            /* TCP/UDP destination port. */
  54     uint8_t dl_src[6];          /* Ethernet source address. */
  55     uint8_t dl_dst[6];          /* Ethernet destination address. */
  56     uint8_t nw_proto;           /* IP protocol. */
  57     uint8_t reserved;           /* Pad to 32-bit alignment. */
  58 };
  59 BUILD_ASSERT_DECL(sizeof (struct flow) == 32);
  60
  61 int flow_extract(struct ofpbuf *, uint16_t in_port, struct flow *);
  62 void flow_print(FILE *, const struct flow *);
  63 int flow_compare(const struct flow *, const struct flow *);
  64 unsigned long int flow_hash(const struct flow *, uint32_t basis);
  65
  66 #endif /* flow.h */