2 * Copyright (c) 2009, 2010, 2011 Nicira Networks.
3 * Distributed under the terms of the GNU GPL version 2.
5 * Significant portions of this file may be copied from parts of the Linux
6 * kernel, by Linus Torvalds and others.
9 /* Interface exported by openvswitch_mod. */
15 #include <linux/kernel.h>
16 #include <linux/mutex.h>
17 #include <linux/netdevice.h>
18 #include <linux/seqlock.h>
19 #include <linux/skbuff.h>
20 #include <linux/version.h>
29 /* Mask for the priority bits in a vlan header. If we ever merge upstream
30 * then this should go into include/linux/if_vlan.h. */
31 #define VLAN_PCP_MASK 0xe000
32 #define VLAN_PCP_SHIFT 13
34 #define DP_MAX_PORTS 1024
37 * struct dp_stats_percpu - per-cpu packet processing statistics for a given
39 * @n_frags: Number of IP fragments processed by datapath.
40 * @n_hit: Number of received packets for which a matching flow was found in
42 * @n_miss: Number of received packets that had no matching flow in the flow
43 * table. The sum of @n_hit and @n_miss is the number of packets that have
44 * been received by the datapath.
45 * @n_lost: Number of received packets that had no matching flow in the flow
46 * table that could not be sent to userspace (normally due to an overflow in
47 * one of the datapath's queues).
49 struct dp_stats_percpu {
58 * struct datapath - datapath for flow-based packet switching
59 * @rcu: RCU callback head for deferred destruction.
60 * @dp_ifindex: ifindex of local port.
61 * @list_node: Element in global 'dps' list.
62 * @ifobj: Represents /sys/class/net/<devname>/brif. Protected by RTNL.
63 * @drop_frags: Drop all IP fragments if nonzero.
64 * @n_flows: Number of flows currently in flow table.
65 * @table: Current flow table. Protected by genl_lock and RCU.
66 * @ports: Map from port number to &struct vport. %ODPP_LOCAL port
67 * always exists, other ports may be %NULL. Protected by RTNL and RCU.
68 * @port_list: List of all ports in @ports in arbitrary order. RTNL required
69 * to iterate or modify.
70 * @stats_percpu: Per-CPU datapath statistics.
71 * @sflow_probability: Number of packets out of UINT_MAX to sample to the
72 * %ODP_PACKET_CMD_SAMPLE multicast group, e.g. (@sflow_probability/UINT_MAX)
73 * is the probability of sampling a given packet.
75 * Context: See the comment on locking at the top of datapath.c for additional
76 * locking information.
81 struct list_head list_node;
87 struct tbl __rcu *table;
90 struct vport __rcu *ports[DP_MAX_PORTS];
91 struct list_head port_list;
94 struct dp_stats_percpu __percpu *stats_percpu;
97 unsigned int sflow_probability;
101 * struct ovs_skb_cb - OVS data in skb CB
102 * @vport: The datapath port on which the skb entered the switch.
103 * @flow: The flow associated with this packet. May be %NULL if no flow.
104 * @ip_summed: Consistently stores L4 checksumming status across different
106 * @tun_id: ID of the tunnel that encapsulated this packet. It is 0 if the
107 * packet was not received on a tunnel.
108 * @vlan_tci: Provides a substitute for the skb->vlan_tci field on kernels
113 struct sw_flow *flow;
114 #ifdef NEED_CSUM_NORMALIZE
115 enum csum_type ip_summed;
118 #ifdef NEED_VLAN_FIELD
122 #define OVS_CB(skb) ((struct ovs_skb_cb *)(skb)->cb)
125 * struct dp_upcall - metadata to include with a packet to send to userspace
126 * @cmd: One of %ODP_PACKET_CMD_*.
127 * @key: Becomes %ODP_PACKET_ATTR_KEY. Must be nonnull.
128 * @userdata: Becomes %ODP_PACKET_ATTR_USERDATA if nonzero.
129 * @sample_pool: Becomes %ODP_PACKET_ATTR_SAMPLE_POOL if nonzero.
130 * @actions: Becomes %ODP_PACKET_ATTR_ACTIONS if nonnull.
131 * @actions_len: Number of bytes in @actions.
133 struct dp_upcall_info {
135 const struct sw_flow_key *key;
138 const struct nlattr *actions;
142 extern struct notifier_block dp_device_notifier;
143 extern int (*dp_ioctl_hook)(struct net_device *dev, struct ifreq *rq, int cmd);
145 void dp_process_received_packet(struct vport *, struct sk_buff *);
146 int dp_detach_port(struct vport *);
147 int dp_upcall(struct datapath *, struct sk_buff *, const struct dp_upcall_info *);
148 int dp_min_mtu(const struct datapath *dp);
149 void set_internal_devs_mtu(const struct datapath *dp);
151 struct datapath *get_dp(int dp_idx);
152 const char *dp_name(const struct datapath *dp);
154 #endif /* datapath.h */