Debian: make debian/copyright more friendly to the ftpmasters
[sliver-openvswitch.git] / datapath / tunnel.h
1 /*
2  * Copyright (c) 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 TUNNEL_H
10 #define TUNNEL_H 1
11
12 #include "openvswitch/tunnel.h"
13 #include "table.h"
14 #include "vport.h"
15
16 /*
17  * The absolute minimum fragment size.  Note that there are many other
18  * definitions of the minimum MTU.
19  */
20 #define IP_MIN_MTU 68
21
22 /*
23  * One of these goes in your struct tnl_ops and in tnl_find_port().
24  * These values are in the same namespace as other TNL_T_* values, so
25  * you have only the first 10 bits to define protocol identifiers.
26  */
27 #define TNL_T_PROTO_GRE         0
28 #define TNL_T_PROTO_CAPWAP      1
29
30 /* You only need these flags when you are calling tnl_find_port(). */
31 #define TNL_T_KEY_EXACT         (1 << 10)
32 #define TNL_T_KEY_MATCH         (1 << 11)
33 #define TNL_T_KEY_EITHER        (TNL_T_KEY_EXACT | TNL_T_KEY_MATCH)
34
35 struct tnl_mutable_config {
36         struct rcu_head rcu;
37
38         unsigned char eth_addr[ETH_ALEN];
39         unsigned int mtu;
40         struct tnl_port_config port_config;
41
42         /* Set of TNL_T_* flags that define the category for lookup. */
43         u32 tunnel_type;
44
45         int tunnel_hlen; /* Tunnel header length. */
46 };
47
48 struct tnl_ops {
49         /* Put your TNL_T_PROTO_* type in here. */
50         u32 tunnel_type;
51         u8 ipproto;
52
53         /*
54          * Returns the length of the tunnel header you will add in
55          * build_header() (i.e. excludes the IP header).  Returns a negative
56          * error code if the configuration is invalid.
57          */
58         int (*hdr_len)(const struct tnl_port_config *);
59
60         /*
61          * Returns a linked list of SKBs with tunnel headers (multiple
62          * packets may be generated in the event of fragmentation).  Space
63          * will have already been allocated at the start of the packet equal
64          * to sizeof(struct iphdr) + value returned by hdr_len().  The IP
65          * header will have already been constructed.
66          */
67         struct sk_buff *(*build_header)(struct sk_buff *,
68                                         const struct vport *,
69                                         const struct tnl_mutable_config *,
70                                         struct dst_entry *);
71 };
72
73 struct tnl_vport {
74         struct rcu_head rcu;
75         struct tbl_node tbl_node;
76
77         char name[IFNAMSIZ];
78         const struct tnl_ops *tnl_ops;
79
80         /* Protected by RCU. */
81         struct tnl_mutable_config *mutable;
82
83         atomic_t frag_id;
84 };
85
86 int tnl_init(void);
87 void tnl_exit(void);
88 struct vport *tnl_create(const char *name, const void __user *config,
89                          const struct vport_ops *,
90                          const struct tnl_ops *);
91 int tnl_modify(struct vport *, const void __user *config);
92 int tnl_destroy(struct vport *);
93 int tnl_set_mtu(struct vport *vport, int mtu);
94 int tnl_set_addr(struct vport *vport, const unsigned char *addr);
95 const char *tnl_get_name(const struct vport *vport);
96 const unsigned char *tnl_get_addr(const struct vport *vport);
97 int tnl_get_mtu(const struct vport *vport);
98 int tnl_send(struct vport *vport, struct sk_buff *skb);
99 void tnl_rcv(struct vport *vport, struct sk_buff *skb);
100
101 struct vport *tnl_find_port(__be32 saddr, __be32 daddr, __be32 key,
102                             int tunnel_type,
103                             const struct tnl_mutable_config **mutable);
104 bool tnl_frag_needed(struct vport *vport,
105                      const struct tnl_mutable_config *mutable,
106                      struct sk_buff *skb, unsigned int mtu, __be32 flow_key);
107
108 static inline struct tnl_vport *tnl_vport_priv(const struct vport *vport)
109 {
110         return vport_priv(vport);
111 }
112
113 #endif /* tunnel.h */