datapath/datapath.h

   1 /*
   2  * Copyright (c) 2007-2011 Nicira Networks.
   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 DATAPATH_H
  20 #define DATAPATH_H 1
  21
  22 #include <asm/page.h>
  23 #include <linux/kernel.h>
  24 #include <linux/mutex.h>
  25 #include <linux/netdevice.h>
  26 #include <linux/skbuff.h>
  27 #include <linux/u64_stats_sync.h>
  28
  29 #include "checksum.h"
  30 #include "compat.h"
  31 #include "flow.h"
  32 #include "dp_sysfs.h"
  33 #include "vlan.h"
  34
  35 struct vport;
  36
  37 #define DP_MAX_PORTS 1024
  38 #define SAMPLE_ACTION_DEPTH 3
  39
  40 /**
  41  * struct dp_stats_percpu - per-cpu packet processing statistics for a given
  42  * 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_hit;
  54         u64 n_missed;
  55         u64 n_lost;
  56         struct u64_stats_sync sync;
  57 };
  58
  59 /**
  60  * struct datapath - datapath for flow-based packet switching
  61  * @rcu: RCU callback head for deferred destruction.
  62  * @list_node: Element in global 'dps' list.
  63  * @ifobj: Represents /sys/class/net/<devname>/brif.  Protected by RTNL.
  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.  %OVSP_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  *
  72  * Context: See the comment on locking at the top of datapath.c for additional
  73  * locking information.
  74  */
  75 struct datapath {
  76         struct rcu_head rcu;
  77         struct list_head list_node;
  78         struct kobject ifobj;
  79
  80         /* Flow table. */
  81         struct flow_table __rcu *table;
  82
  83         /* Switch ports. */
  84         struct vport __rcu *ports[DP_MAX_PORTS];
  85         struct list_head port_list;
  86
  87         /* Stats. */
  88         struct dp_stats_percpu __percpu *stats_percpu;
  89 };
  90
  91 /**
  92  * struct ovs_skb_cb - OVS data in skb CB
  93  * @flow: The flow associated with this packet.  May be %NULL if no flow.
  94  * @tun_id: ID of the tunnel that encapsulated this packet.  It is 0 if the
  95  * @ip_summed: Consistently stores L4 checksumming status across different
  96  * kernel versions.
  97  * @csum_start: Stores the offset from which to start checksumming independent
  98  * of the transport header on all kernel versions.
  99  * packet was not received on a tunnel.
 100  * @vlan_tci: Provides a substitute for the skb->vlan_tci field on kernels
 101  * before 2.6.27.
 102  */
 103 struct ovs_skb_cb {
 104         struct sw_flow          *flow;
 105         __be64                  tun_id;
 106 #ifdef NEED_CSUM_NORMALIZE
 107         enum csum_type          ip_summed;
 108         u16                     csum_start;
 109 #endif
 110 #ifdef NEED_VLAN_FIELD
 111         u16                     vlan_tci;
 112 #endif
 113 };
 114 #define OVS_CB(skb) ((struct ovs_skb_cb *)(skb)->cb)
 115
 116 /**
 117  * struct dp_upcall - metadata to include with a packet to send to userspace
 118  * @cmd: One of %OVS_PACKET_CMD_*.
 119  * @key: Becomes %OVS_PACKET_ATTR_KEY.  Must be nonnull.
 120  * @userdata: If nonnull, its u64 value is extracted and passed to userspace as
 121  * %OVS_PACKET_ATTR_USERDATA.
 122  * @pid: Netlink PID to which packet should be sent.  If @pid is 0 then no
 123  * packet is sent and the packet is accounted in the datapath's @n_lost
 124  * counter.
 125  */
 126 struct dp_upcall_info {
 127         u8 cmd;
 128         const struct sw_flow_key *key;
 129         const struct nlattr *userdata;
 130         u32 pid;
 131 };
 132
 133 extern struct notifier_block ovs_dp_device_notifier;
 134 extern struct genl_multicast_group ovs_dp_vport_multicast_group;
 135 extern int (*ovs_dp_ioctl_hook)(struct net_device *dev, struct ifreq *rq, int cmd);
 136
 137 void ovs_dp_process_received_packet(struct vport *, struct sk_buff *);
 138 void ovs_dp_detach_port(struct vport *);
 139 int ovs_dp_upcall(struct datapath *, struct sk_buff *,
 140                   const struct dp_upcall_info *);
 141
 142 const char *ovs_dp_name(const struct datapath *dp);
 143 struct sk_buff *ovs_vport_cmd_build_info(struct vport *, u32 pid, u32 seq,
 144                                          u8 cmd);
 145
 146 int ovs_execute_actions(struct datapath *dp, struct sk_buff *skb);
 147 #endif /* datapath.h */