datapath/flow.h

   1 /*
   2  * Copyright (c) 2009, 2010 Nicira Networks.
   3  * Distributed under the terms of the GNU GPL version 2.
   4  *
   5  * Significant portions of this file may be copied from parts of the Linux
   6  * kernel, by Linus Torvalds and others.
   7  */
   8
   9 #ifndef FLOW_H
  10 #define FLOW_H 1
  11
  12 #include <linux/kernel.h>
  13 #include <linux/netlink.h>
  14 #include <linux/spinlock.h>
  15 #include <linux/types.h>
  16 #include <linux/rcupdate.h>
  17 #include <linux/if_ether.h>
  18 #include <linux/jiffies.h>
  19 #include <linux/time.h>
  20
  21 #include "openvswitch/datapath-protocol.h"
  22 #include "table.h"
  23
  24 struct sk_buff;
  25
  26 struct sw_flow_actions {
  27         struct rcu_head rcu;
  28         u32 actions_len;
  29         struct nlattr actions[];
  30 };
  31
  32 struct sw_flow_key {
  33         __be64  tun_id;     /* Encapsulating tunnel ID. */
  34         __be32  nw_src;     /* IP source address. */
  35         __be32  nw_dst;     /* IP destination address. */
  36         u16     in_port;    /* Input switch port. */
  37         __be16  dl_tci;     /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
  38         __be16  dl_type;    /* Ethernet frame type. */
  39         __be16  tp_src;     /* TCP/UDP source port. */
  40         __be16  tp_dst;     /* TCP/UDP destination port. */
  41         u8      dl_src[ETH_ALEN]; /* Ethernet source address. */
  42         u8      dl_dst[ETH_ALEN]; /* Ethernet destination address. */
  43         u8      nw_proto;   /* IP protocol or lower 8 bits of ARP opcode. */
  44         u8      nw_tos;     /* IP ToS (DSCP field, 6 bits). */
  45 };
  46
  47 struct sw_flow {
  48         struct rcu_head rcu;
  49         struct tbl_node tbl_node;
  50
  51         struct sw_flow_key key;
  52         struct sw_flow_actions __rcu *sf_acts;
  53
  54         atomic_t refcnt;
  55         bool dead;
  56
  57         spinlock_t lock;        /* Lock for values below. */
  58         unsigned long used;     /* Last used time (in jiffies). */
  59         u64 packet_count;       /* Number of packets matched. */
  60         u64 byte_count;         /* Number of bytes matched. */
  61         u8 tcp_flags;           /* Union of seen TCP flags. */
  62 };
  63
  64 struct arp_eth_header
  65 {
  66         __be16      ar_hrd;     /* format of hardware address   */
  67         __be16      ar_pro;     /* format of protocol address   */
  68         unsigned char   ar_hln; /* length of hardware address   */
  69         unsigned char   ar_pln; /* length of protocol address   */
  70         __be16      ar_op;      /* ARP opcode (command)     */
  71
  72         /* Ethernet+IPv4 specific members. */
  73         unsigned char       ar_sha[ETH_ALEN];   /* sender hardware address  */
  74         unsigned char       ar_sip[4];          /* sender IP address        */
  75         unsigned char       ar_tha[ETH_ALEN];   /* target hardware address  */
  76         unsigned char       ar_tip[4];          /* target IP address        */
  77 } __packed;
  78
  79 int flow_init(void);
  80 void flow_exit(void);
  81
  82 struct sw_flow *flow_alloc(void);
  83 void flow_deferred_free(struct sw_flow *);
  84 void flow_free_tbl(struct tbl_node *);
  85
  86 struct sw_flow_actions *flow_actions_alloc(u32 actions_len);
  87 void flow_deferred_free_acts(struct sw_flow_actions *);
  88
  89 void flow_hold(struct sw_flow *);
  90 void flow_put(struct sw_flow *);
  91
  92 int flow_extract(struct sk_buff *, u16 in_port, struct sw_flow_key *, bool *is_frag);
  93 void flow_used(struct sw_flow *, struct sk_buff *);
  94
  95 u32 flow_hash(const struct sw_flow_key *);
  96 int flow_cmp(const struct tbl_node *, void *target);
  97
  98 /* By my calculations currently the longest valid nlattr-formatted flow key is
  99  * 80 bytes long, so this leaves some safety margin.
 100  */
 101 #define FLOW_BUFSIZE 96
 102
 103 u32 flow_to_nlattrs(const struct sw_flow_key *, struct sk_buff *);
 104 int flow_copy_from_user(struct sw_flow_key *, const struct nlattr __user *ukey, u32 key_len);
 105 int flow_copy_to_user(struct nlattr __user *ukey, const struct sw_flow_key *, u32 key_len);
 106
 107 static inline struct sw_flow *flow_cast(const struct tbl_node *node)
 108 {
 109         return container_of(node, struct sw_flow, tbl_node);
 110 }
 111
 112 #endif /* flow.h */