switch/switch-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
  34 #ifndef SWITCH_FLOW_H
  35 #define SWITCH_FLOW_H 1
  36
  37 #include <time.h>
  38 #include "openflow/openflow.h"
  39 #include "flow.h"
  40 #include "list.h"
  41
  42 struct ofp_match;
  43
  44 /* Identification data for a flow. */
  45 struct sw_flow_key {
  46     struct flow flow;           /* Flow data (in network byte order). */
  47     uint32_t wildcards;         /* Wildcard fields (in host byte order). */
  48     uint32_t nw_src_mask;       /* 1-bit in each significant nw_src bit. */
  49     uint32_t nw_dst_mask;       /* 1-bit in each significant nw_dst bit. */
  50 };
  51
  52 struct sw_flow_actions {
  53     size_t actions_len;
  54     struct ofp_action_header actions[0];
  55 };
  56
  57 struct sw_flow {
  58     struct sw_flow_key key;
  59
  60     uint16_t priority;          /* Only used on entries with wildcards. */
  61     uint16_t idle_timeout;      /* Idle time before discarding (seconds). */
  62     uint16_t hard_timeout;      /* Hard expiration time (seconds) */
  63     time_t used;                /* Last used time. */
  64     time_t created;             /* When the flow was created. */
  65     uint64_t packet_count;      /* Number of packets seen. */
  66     uint64_t byte_count;        /* Number of bytes seen. */
  67     uint8_t reason;             /* Reason flow expired (one of OFPER_*). */
  68
  69     struct sw_flow_actions *sf_acts;
  70
  71     /* Private to table implementations. */
  72     struct list node;
  73     struct list iter_node;
  74     unsigned long int serial;
  75 };
  76
  77 int flow_matches_1wild(const struct sw_flow_key *, const struct sw_flow_key *);
  78 int flow_matches_2wild(const struct sw_flow_key *, const struct sw_flow_key *);
  79 int flow_matches_desc(const struct sw_flow_key *, const struct sw_flow_key *,
  80                      int);
  81 int flow_has_out_port(struct sw_flow *flow, uint16_t out_port);
  82 struct sw_flow *flow_alloc(size_t);
  83 void flow_free(struct sw_flow *);
  84 void flow_deferred_free(struct sw_flow *);
  85 void flow_deferred_free_acts(struct sw_flow_actions *);
  86 void flow_replace_acts(struct sw_flow *, const struct ofp_action_header *,
  87         size_t);
  88 void flow_extract_match(struct sw_flow_key* to, const struct ofp_match* from);
  89 void flow_fill_match(struct ofp_match* to, const struct sw_flow_key* from);
  90
  91 void print_flow(const struct sw_flow_key *);
  92 bool flow_timeout(struct sw_flow *flow);
  93 void flow_used(struct sw_flow *flow, struct ofpbuf *buffer);
  94
  95 #endif /* switch-flow.h */