Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 1 | /* |
Raju Subramanian | caf2ee1 | 2012-05-03 18:55:23 -0700 | [diff] [blame] | 2 | * Copyright (c) 2007-2012 Nicira, Inc. |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 3 | * |
| 4 | * This program is free software; you can redistribute it and/or |
| 5 | * modify it under the terms of version 2 of the GNU General Public |
| 6 | * License as published by the Free Software Foundation. |
| 7 | * |
| 8 | * This program is distributed in the hope that it will be useful, but |
| 9 | * WITHOUT ANY WARRANTY; without even the implied warranty of |
| 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 11 | * General Public License for more details. |
| 12 | * |
| 13 | * You should have received a copy of the GNU General Public License |
| 14 | * along with this program; if not, write to the Free Software |
| 15 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
| 16 | * 02110-1301, USA |
| 17 | */ |
| 18 | |
| 19 | #ifndef VPORT_H |
| 20 | #define VPORT_H 1 |
| 21 | |
Pravin B Shelar | e0f0ecf | 2013-04-15 13:30:37 -0700 | [diff] [blame] | 22 | #include <linux/if_tunnel.h> |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 23 | #include <linux/list.h> |
Pravin B Shelar | 46df7b8 | 2012-02-22 19:58:59 -0800 | [diff] [blame] | 24 | #include <linux/netlink.h> |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 25 | #include <linux/openvswitch.h> |
Alex Wang | 5cd667b | 2014-07-17 15:14:13 -0700 | [diff] [blame] | 26 | #include <linux/reciprocal_div.h> |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 27 | #include <linux/skbuff.h> |
| 28 | #include <linux/spinlock.h> |
| 29 | #include <linux/u64_stats_sync.h> |
| 30 | |
| 31 | #include "datapath.h" |
| 32 | |
| 33 | struct vport; |
| 34 | struct vport_parms; |
| 35 | |
| 36 | /* The following definitions are for users of the vport subsytem: */ |
| 37 | |
| 38 | int ovs_vport_init(void); |
| 39 | void ovs_vport_exit(void); |
| 40 | |
| 41 | struct vport *ovs_vport_add(const struct vport_parms *); |
| 42 | void ovs_vport_del(struct vport *); |
| 43 | |
Thomas Graf | 12eb18f | 2014-11-06 06:58:52 -0800 | [diff] [blame] | 44 | struct vport *ovs_vport_locate(const struct net *net, const char *name); |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 45 | |
| 46 | void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *); |
| 47 | |
| 48 | int ovs_vport_set_options(struct vport *, struct nlattr *options); |
| 49 | int ovs_vport_get_options(const struct vport *, struct sk_buff *); |
| 50 | |
Thomas Graf | 12eb18f | 2014-11-06 06:58:52 -0800 | [diff] [blame] | 51 | int ovs_vport_set_upcall_portids(struct vport *, const struct nlattr *pids); |
Alex Wang | 5cd667b | 2014-07-17 15:14:13 -0700 | [diff] [blame] | 52 | int ovs_vport_get_upcall_portids(const struct vport *, struct sk_buff *); |
| 53 | u32 ovs_vport_find_upcall_portid(const struct vport *, struct sk_buff *); |
| 54 | |
Alex Wang | 5cd667b | 2014-07-17 15:14:13 -0700 | [diff] [blame] | 55 | /** |
| 56 | * struct vport_portids - array of netlink portids of a vport. |
| 57 | * must be protected by rcu. |
| 58 | * @rn_ids: The reciprocal value of @n_ids. |
| 59 | * @rcu: RCU callback head for deferred destruction. |
| 60 | * @n_ids: Size of @ids array. |
| 61 | * @ids: Array storing the Netlink socket pids to be used for packets received |
| 62 | * on this port that miss the flow table. |
| 63 | */ |
| 64 | struct vport_portids { |
| 65 | struct reciprocal_value rn_ids; |
| 66 | struct rcu_head rcu; |
| 67 | u32 n_ids; |
| 68 | u32 ids[]; |
| 69 | }; |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 70 | |
| 71 | /** |
| 72 | * struct vport - one port within a datapath |
| 73 | * @rcu: RCU callback head for deferred destruction. |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 74 | * @dp: Datapath to which this port belongs. |
Alex Wang | 5cd667b | 2014-07-17 15:14:13 -0700 | [diff] [blame] | 75 | * @upcall_portids: RCU protected 'struct vport_portids'. |
Thomas Graf | 03599c9 | 2012-12-03 22:24:32 +0000 | [diff] [blame] | 76 | * @port_no: Index into @dp's @ports array. |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 77 | * @hash_node: Element in @dev_table hash table in vport.c. |
Pravin B Shelar | 15eac2a | 2012-08-23 12:40:54 -0700 | [diff] [blame] | 78 | * @dp_hash_node: Element in @datapath->ports hash table in datapath.c. |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 79 | * @ops: Class structure. |
Pravin B Shelar | 7b4577a | 2015-02-17 11:23:10 -0800 | [diff] [blame] | 80 | * @detach_list: list used for detaching vport in net-exit call. |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 81 | */ |
| 82 | struct vport { |
Thomas Graf | be4ace6 | 2015-07-21 10:44:04 +0200 | [diff] [blame] | 83 | struct net_device *dev; |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 84 | struct datapath *dp; |
Alex Wang | 5cd667b | 2014-07-17 15:14:13 -0700 | [diff] [blame] | 85 | struct vport_portids __rcu *upcall_portids; |
Thomas Graf | 03599c9 | 2012-12-03 22:24:32 +0000 | [diff] [blame] | 86 | u16 port_no; |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 87 | |
| 88 | struct hlist_node hash_node; |
Pravin B Shelar | 15eac2a | 2012-08-23 12:40:54 -0700 | [diff] [blame] | 89 | struct hlist_node dp_hash_node; |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 90 | const struct vport_ops *ops; |
| 91 | |
Pravin B Shelar | 7b4577a | 2015-02-17 11:23:10 -0800 | [diff] [blame] | 92 | struct list_head detach_list; |
Thomas Graf | be4ace6 | 2015-07-21 10:44:04 +0200 | [diff] [blame] | 93 | struct rcu_head rcu; |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 94 | }; |
| 95 | |
| 96 | /** |
| 97 | * struct vport_parms - parameters for creating a new vport |
| 98 | * |
| 99 | * @name: New vport's name. |
| 100 | * @type: New vport's type. |
| 101 | * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if |
| 102 | * none was supplied. |
| 103 | * @dp: New vport's datapath. |
| 104 | * @port_no: New vport's port number. |
| 105 | */ |
| 106 | struct vport_parms { |
| 107 | const char *name; |
| 108 | enum ovs_vport_type type; |
| 109 | struct nlattr *options; |
| 110 | |
| 111 | /* For ovs_vport_alloc(). */ |
| 112 | struct datapath *dp; |
| 113 | u16 port_no; |
Alex Wang | 5cd667b | 2014-07-17 15:14:13 -0700 | [diff] [blame] | 114 | struct nlattr *upcall_portids; |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 115 | }; |
| 116 | |
| 117 | /** |
| 118 | * struct vport_ops - definition of a type of virtual port |
| 119 | * |
| 120 | * @type: %OVS_VPORT_TYPE_* value for this type of virtual port. |
| 121 | * @create: Create a new vport configured as specified. On success returns |
| 122 | * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value. |
| 123 | * @destroy: Destroys a vport. Must call vport_free() on the vport but not |
| 124 | * before an RCU grace period has elapsed. |
| 125 | * @set_options: Modify the configuration of an existing vport. May be %NULL |
| 126 | * if modification is not supported. |
| 127 | * @get_options: Appends vport-specific attributes for the configuration of an |
| 128 | * existing vport to a &struct sk_buff. May be %NULL for a vport that does not |
| 129 | * have any configuration. |
Pravin B Shelar | 8c87663 | 2015-08-29 17:44:07 -0700 | [diff] [blame] | 130 | * @send: Send a packet on the device. |
Pravin B Shelar | 91b7514 | 2013-05-13 08:22:34 -0700 | [diff] [blame] | 131 | * zero for dropped packets or negative for error. |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 132 | */ |
| 133 | struct vport_ops { |
| 134 | enum ovs_vport_type type; |
| 135 | |
Pravin B Shelar | 8e4e171 | 2013-04-15 13:23:03 -0700 | [diff] [blame] | 136 | /* Called with ovs_mutex. */ |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 137 | struct vport *(*create)(const struct vport_parms *); |
| 138 | void (*destroy)(struct vport *); |
| 139 | |
| 140 | int (*set_options)(struct vport *, struct nlattr *); |
| 141 | int (*get_options)(const struct vport *, struct sk_buff *); |
| 142 | |
Pravin B Shelar | aec1592 | 2015-10-20 23:00:10 -0700 | [diff] [blame] | 143 | netdev_tx_t (*send) (struct sk_buff *skb); |
Thomas Graf | 62b9c8d | 2014-10-22 17:29:06 +0200 | [diff] [blame] | 144 | struct module *owner; |
| 145 | struct list_head list; |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 146 | }; |
| 147 | |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 148 | struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *, |
| 149 | const struct vport_parms *); |
| 150 | void ovs_vport_free(struct vport *); |
Pravin B Shelar | aa31070 | 2013-06-17 17:50:33 -0700 | [diff] [blame] | 151 | void ovs_vport_deferred_free(struct vport *vport); |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 152 | |
| 153 | #define VPORT_ALIGN 8 |
| 154 | |
| 155 | /** |
| 156 | * vport_priv - access private data area of vport |
| 157 | * |
| 158 | * @vport: vport to access |
| 159 | * |
| 160 | * If a nonzero size was passed in priv_size of vport_alloc() a private data |
| 161 | * area was allocated on creation. This allows that area to be accessed and |
| 162 | * used for any purpose needed by the vport implementer. |
| 163 | */ |
| 164 | static inline void *vport_priv(const struct vport *vport) |
| 165 | { |
Daniele Di Proietto | 07dc060 | 2014-02-03 14:08:29 -0800 | [diff] [blame] | 166 | return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN); |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 167 | } |
| 168 | |
| 169 | /** |
| 170 | * vport_from_priv - lookup vport from private data pointer |
| 171 | * |
| 172 | * @priv: Start of private data area. |
| 173 | * |
| 174 | * It is sometimes useful to translate from a pointer to the private data |
| 175 | * area to the vport, such as in the case where the private data pointer is |
| 176 | * the result of a hash table lookup. @priv must point to the start of the |
| 177 | * private data area. |
| 178 | */ |
Daniele Di Proietto | d0b4da1 | 2014-02-03 14:07:43 -0800 | [diff] [blame] | 179 | static inline struct vport *vport_from_priv(void *priv) |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 180 | { |
Daniele Di Proietto | d0b4da1 | 2014-02-03 14:07:43 -0800 | [diff] [blame] | 181 | return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN)); |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 182 | } |
| 183 | |
Pravin B Shelar | 8c87663 | 2015-08-29 17:44:07 -0700 | [diff] [blame] | 184 | int ovs_vport_receive(struct vport *, struct sk_buff *, |
| 185 | const struct ip_tunnel_info *); |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 186 | |
Pravin B Shelar | b34df5e | 2013-06-13 11:11:44 -0700 | [diff] [blame] | 187 | static inline void ovs_skb_postpush_rcsum(struct sk_buff *skb, |
| 188 | const void *start, unsigned int len) |
| 189 | { |
| 190 | if (skb->ip_summed == CHECKSUM_COMPLETE) |
| 191 | skb->csum = csum_add(skb->csum, csum_partial(start, len, 0)); |
| 192 | } |
| 193 | |
Thomas Graf | c9db965 | 2015-07-21 10:44:05 +0200 | [diff] [blame] | 194 | static inline const char *ovs_vport_name(struct vport *vport) |
| 195 | { |
Pravin B Shelar | 24d43f3 | 2015-08-29 17:44:05 -0700 | [diff] [blame] | 196 | return vport->dev->name; |
Thomas Graf | c9db965 | 2015-07-21 10:44:05 +0200 | [diff] [blame] | 197 | } |
| 198 | |
Paolo Abeni | 83e4bf7 | 2015-11-30 12:31:43 +0100 | [diff] [blame] | 199 | int __ovs_vport_ops_register(struct vport_ops *ops); |
| 200 | #define ovs_vport_ops_register(ops) \ |
| 201 | ({ \ |
| 202 | (ops)->owner = THIS_MODULE; \ |
| 203 | __ovs_vport_ops_register(ops); \ |
| 204 | }) |
| 205 | |
Thomas Graf | 62b9c8d | 2014-10-22 17:29:06 +0200 | [diff] [blame] | 206 | void ovs_vport_ops_unregister(struct vport_ops *ops); |
| 207 | |
Fan Du | 3f4c1d8 | 2015-01-14 13:10:35 +0800 | [diff] [blame] | 208 | static inline struct rtable *ovs_tunnel_route_lookup(struct net *net, |
Thomas Graf | 1d8fff9 | 2015-07-21 10:43:54 +0200 | [diff] [blame] | 209 | const struct ip_tunnel_key *key, |
Fan Du | 3f4c1d8 | 2015-01-14 13:10:35 +0800 | [diff] [blame] | 210 | u32 mark, |
| 211 | struct flowi4 *fl, |
| 212 | u8 protocol) |
| 213 | { |
| 214 | struct rtable *rt; |
| 215 | |
| 216 | memset(fl, 0, sizeof(*fl)); |
Jiri Benc | c1ea5d6 | 2015-08-20 13:56:23 +0200 | [diff] [blame] | 217 | fl->daddr = key->u.ipv4.dst; |
| 218 | fl->saddr = key->u.ipv4.src; |
Jiri Benc | 7c383fb | 2015-08-20 13:56:24 +0200 | [diff] [blame] | 219 | fl->flowi4_tos = RT_TOS(key->tos); |
Fan Du | 3f4c1d8 | 2015-01-14 13:10:35 +0800 | [diff] [blame] | 220 | fl->flowi4_mark = mark; |
| 221 | fl->flowi4_proto = protocol; |
| 222 | |
| 223 | rt = ip_route_output_key(net, fl); |
| 224 | return rt; |
| 225 | } |
Pravin B Shelar | 8c87663 | 2015-08-29 17:44:07 -0700 | [diff] [blame] | 226 | |
Pravin B Shelar | aec1592 | 2015-10-20 23:00:10 -0700 | [diff] [blame] | 227 | void ovs_vport_send(struct vport *vport, struct sk_buff *skb); |
Pravin B Shelar | 8c87663 | 2015-08-29 17:44:07 -0700 | [diff] [blame] | 228 | |
Jesse Gross | ccb1352 | 2011-10-25 19:26:31 -0700 | [diff] [blame] | 229 | #endif /* vport.h */ |