datapath/flow.h

   1 #ifndef FLOW_H
   2 #define FLOW_H 1
   3
   4 #include <linux/kernel.h>
   5 #include <linux/spinlock.h>
   6 #include <linux/list.h>
   7 #include <linux/types.h>
   8 #include <linux/rcupdate.h>
   9 #include <linux/gfp.h>
  10 #include <linux/skbuff.h>
  11 #include <linux/if_ether.h>
  12
  13 #include "openflow.h"
  14
  15 struct sk_buff;
  16 struct ofp_flow_mod;
  17
  18 /* Identification data for a flow.
  19  * Network byte order except for the "wildcards" field.
  20  * Ordered to make bytewise comparisons (e.g. with memcmp()) fail quickly and
  21  * to keep the amount of padding to a minimum.
  22  * If you change the ordering of fields here, change flow_keys_equal() to
  23  * compare the proper fields.
  24  */
  25 struct sw_flow_key {
  26         uint32_t nw_src;        /* IP source address. */
  27         uint32_t nw_dst;        /* IP destination address. */
  28         uint16_t in_port;       /* Input switch port */
  29         uint16_t dl_vlan;       /* Input VLAN. */
  30         uint16_t dl_type;       /* Ethernet frame type. */
  31         uint16_t tp_src;        /* TCP/UDP source port. */
  32         uint16_t tp_dst;        /* TCP/UDP destination port. */
  33         uint8_t dl_src[ETH_ALEN]; /* Ethernet source address. */
  34         uint8_t dl_dst[ETH_ALEN]; /* Ethernet destination address. */
  35         uint8_t nw_proto;       /* IP protocol. */
  36         uint8_t pad;            /* Pad to 32-bit alignment. */
  37         uint32_t wildcards;     /* Wildcard fields (host byte order). */
  38         uint32_t nw_src_mask;   /* 1-bit in each significant nw_src bit. */
  39         uint32_t nw_dst_mask;   /* 1-bit in each significant nw_dst bit. */
  40 };
  41
  42 /* Compare two sw_flow_keys and return true if they are the same flow, false
  43  * otherwise.  Wildcards and netmasks are not considered. */
  44 static inline int flow_keys_equal(const struct sw_flow_key *a,
  45                                    const struct sw_flow_key *b)
  46 {
  47         return !memcmp(a, b, offsetof(struct sw_flow_key, wildcards));
  48 }
  49
  50 /* We need to manually make sure that the structure is 32-bit aligned,
  51  * since we don't want garbage values in compiler-generated pads from
  52  * messing up hash matches.
  53  */
  54 static inline void check_key_align(void)
  55 {
  56         BUILD_BUG_ON(sizeof(struct sw_flow_key) != 44);
  57 }
  58
  59 /* Locking:
  60  *
  61  * - Readers must take rcu_read_lock and hold it the entire time that the flow
  62  *   must continue to exist.
  63  *
  64  * - Writers must hold dp_mutex.
  65  */
  66 struct sw_flow {
  67         struct sw_flow_key key;
  68
  69         uint16_t priority;      /* Only used on entries with wildcards. */
  70         uint16_t idle_timeout;  /* Idle time before discarding (seconds). */
  71         uint16_t hard_timeout;  /* Hard expiration time (seconds) */
  72         unsigned long used;     /* Last used time (in jiffies). */
  73
  74         /* FIXME?  Probably most flows have only a single action. */
  75         unsigned int n_actions;
  76         struct ofp_action *actions;
  77
  78         /* For use by table implementation. */
  79         struct list_head node;
  80         struct list_head iter_node;
  81         unsigned long serial;
  82         void *private;
  83
  84         spinlock_t lock;         /* Lock this entry...mostly for stat updates */
  85         unsigned long init_time; /* When the flow was created (in jiffies). */
  86         uint64_t packet_count;   /* Number of packets associated with this entry */
  87         uint64_t byte_count;     /* Number of bytes associated with this entry */
  88
  89         struct rcu_head rcu;
  90 };
  91
  92 int flow_matches_1wild(const struct sw_flow_key *, const struct sw_flow_key *);
  93 int flow_matches_2wild(const struct sw_flow_key *, const struct sw_flow_key *);
  94 int flow_del_matches(const struct sw_flow_key *, const struct sw_flow_key *,
  95                 int);
  96 struct sw_flow *flow_alloc(int n_actions, gfp_t flags);
  97 void flow_free(struct sw_flow *);
  98 void flow_deferred_free(struct sw_flow *);
  99 int flow_extract(struct sk_buff *, uint16_t in_port, struct sw_flow_key *);
 100 void flow_extract_match(struct sw_flow_key* to, const struct ofp_match* from);
 101 void flow_fill_match(struct ofp_match* to, const struct sw_flow_key* from);
 102 int flow_timeout(struct sw_flow *);
 103
 104 void print_flow(const struct sw_flow_key *);
 105
 106 static inline void flow_used(struct sw_flow *flow, struct sk_buff *skb)
 107 {
 108         unsigned long flags;
 109
 110         flow->used = jiffies;
 111
 112         spin_lock_irqsave(&flow->lock, flags);
 113         flow->packet_count++;
 114         flow->byte_count += skb->len;
 115         spin_unlock_irqrestore(&flow->lock, flags);
 116 }
 117
 118 extern struct kmem_cache *flow_cache;
 119
 120 int flow_init(void);
 121 void flow_exit(void);
 122
 123 #endif /* flow.h */