datapath: Add usage of __rcu annotation.
[sliver-openvswitch.git] / 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 {
33         struct rcu_head rcu;
34         struct tbl_node tbl_node;
35
36         struct odp_flow_key key;
37         struct sw_flow_actions __rcu *sf_acts;
38
39         atomic_t refcnt;
40         bool dead;
41
42         spinlock_t lock;        /* Lock for values below. */
43         unsigned long used;     /* Last used time (in jiffies). */
44         u64 packet_count;       /* Number of packets matched. */
45         u64 byte_count;         /* Number of bytes matched. */
46         u8 tcp_flags;           /* Union of seen TCP flags. */
47 };
48
49 struct arp_eth_header
50 {
51         __be16      ar_hrd;     /* format of hardware address   */
52         __be16      ar_pro;     /* format of protocol address   */
53         unsigned char   ar_hln; /* length of hardware address   */
54         unsigned char   ar_pln; /* length of protocol address   */
55         __be16      ar_op;      /* ARP opcode (command)     */
56
57         /* Ethernet+IPv4 specific members. */
58         unsigned char       ar_sha[ETH_ALEN];   /* sender hardware address  */
59         unsigned char       ar_sip[4];          /* sender IP address        */
60         unsigned char       ar_tha[ETH_ALEN];   /* target hardware address  */
61         unsigned char       ar_tip[4];          /* target IP address        */
62 } __packed;
63
64 int flow_init(void);
65 void flow_exit(void);
66
67 struct sw_flow *flow_alloc(void);
68 void flow_deferred_free(struct sw_flow *);
69 void flow_free_tbl(struct tbl_node *);
70
71 struct sw_flow_actions *flow_actions_alloc(u32 actions_len);
72 void flow_deferred_free_acts(struct sw_flow_actions *);
73
74 void flow_hold(struct sw_flow *);
75 void flow_put(struct sw_flow *);
76
77 int flow_extract(struct sk_buff *, u16 in_port, struct odp_flow_key *, bool *is_frag);
78 void flow_used(struct sw_flow *, struct sk_buff *);
79
80 u32 flow_hash(const struct odp_flow_key *key);
81 int flow_cmp(const struct tbl_node *, void *target);
82
83 static inline struct sw_flow *flow_cast(const struct tbl_node *node)
84 {
85         return container_of(node, struct sw_flow, tbl_node);
86 }
87
88 #endif /* flow.h */