datapath/datapath.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011 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 /* Interface exported by openvswitch_mod. */
  10
  11 #ifndef DATAPATH_H
  12 #define DATAPATH_H 1
  13
  14 #include <asm/page.h>
  15 #include <linux/kernel.h>
  16 #include <linux/mutex.h>
  17 #include <linux/netdevice.h>
  18 #include <linux/workqueue.h>
  19 #include <linux/seqlock.h>
  20 #include <linux/skbuff.h>
  21 #include <linux/version.h>
  22
  23 #include "checksum.h"
  24 #include "flow.h"
  25 #include "dp_sysfs.h"
  26
  27 struct vport;
  28
  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
  33
  34 #define DP_MAX_PORTS 1024
  35
  36 #define DP_N_QUEUES 3
  37 #define DP_MAX_QUEUE_LEN 100
  38
  39 /**
  40  * struct dp_stats_percpu - per-cpu packet processing statistics for a given
  41  * datapath.
  42  * @n_frags: Number of IP fragments processed by datapath.
  43  * @n_hit: Number of received packets for which a matching flow was found in
  44  * the flow table.
  45  * @n_miss: Number of received packets that had no matching flow in the flow
  46  * table.  The sum of @n_hit and @n_miss is the number of packets that have
  47  * been received by the datapath.
  48  * @n_lost: Number of received packets that had no matching flow in the flow
  49  * table that could not be sent to userspace (normally due to an overflow in
  50  * one of the datapath's queues).
  51  */
  52 struct dp_stats_percpu {
  53         u64 n_frags;
  54         u64 n_hit;
  55         u64 n_missed;
  56         u64 n_lost;
  57         seqcount_t seqlock;
  58 };
  59
  60 /**
  61  * struct datapath - datapath for flow-based packet switching
  62  * @rcu: RCU callback head for deferred destruction.
  63  * @mutex: Mutual exclusion for ioctls.
  64  * @dp_idx: Datapath number (index into the dps[] array in datapath.c).
  65  * @ifobj: Represents /sys/class/net/<devname>/brif.
  66  * @drop_frags: Drop all IP fragments if nonzero.
  67  * @queues: %DP_N_QUEUES sets of queued packets for userspace to handle.
  68  * @waitqueue: Waitqueue, for waiting for new packets in @queues.
  69  * @n_flows: Number of flows currently in flow table.
  70  * @table: Current flow table.
  71  * @ports: Map from port number to &struct vport.  %ODPP_LOCAL port
  72  * always exists, other ports may be %NULL.
  73  * @port_list: List of all ports in @ports in arbitrary order.
  74  * @stats_percpu: Per-CPU datapath statistics.
  75  * @sflow_probability: Number of packets out of UINT_MAX to sample to the
  76  * %ODPL_SFLOW queue, e.g. (@sflow_probability/UINT_MAX) is the probability of
  77  * sampling a given packet.
  78  */
  79 struct datapath {
  80         struct rcu_head rcu;
  81         struct mutex mutex;
  82         int dp_idx;
  83         struct kobject ifobj;
  84
  85         int drop_frags;
  86
  87         /* Queued data. */
  88         struct sk_buff_head queues[DP_N_QUEUES];
  89         wait_queue_head_t waitqueue;
  90
  91         /* Flow table. */
  92         struct tbl __rcu *table;
  93
  94         /* Switch ports. */
  95         struct vport __rcu *ports[DP_MAX_PORTS];
  96         struct list_head port_list;
  97
  98         /* Stats. */
  99         struct dp_stats_percpu __percpu *stats_percpu;
 100
 101         /* sFlow Sampling */
 102         unsigned int sflow_probability;
 103 };
 104
 105 /**
 106  * struct ovs_skb_cb - OVS data in skb CB
 107  * @vport: The datapath port on which the skb entered the switch.
 108  * @flow: The flow associated with this packet.  May be %NULL if no flow.
 109  * @ip_summed: Consistently stores L4 checksumming status across different
 110  * kernel versions.
 111  * @tun_id: ID of the tunnel that encapsulated this packet.  It is 0 if the
 112  * packet was not received on a tunnel.
 113  */
 114 struct ovs_skb_cb {
 115         struct vport            *vport;
 116         struct sw_flow          *flow;
 117 #ifdef NEED_CSUM_NORMALIZE
 118         enum csum_type          ip_summed;
 119 #endif
 120         __be64                  tun_id;
 121 };
 122 #define OVS_CB(skb) ((struct ovs_skb_cb *)(skb)->cb)
 123
 124 /**
 125  * struct dp_upcall - metadata to include with a packet to send to userspace
 126  * @type: One of %_ODPL_*_NR.
 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.
 132 */
 133 struct dp_upcall_info {
 134         u32 type;
 135         const struct sw_flow_key *key;
 136         u64 userdata;
 137         u32 sample_pool;
 138         const struct nlattr *actions;
 139         u32 actions_len;
 140 };
 141
 142 extern struct notifier_block dp_device_notifier;
 143 extern int (*dp_ioctl_hook)(struct net_device *dev, struct ifreq *rq, int cmd);
 144
 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);
 150
 151 struct datapath *get_dp(int dp_idx);
 152 const char *dp_name(const struct datapath *dp);
 153
 154 #endif /* datapath.h */