[IPV6]: Support Source Address Selection API (RFC5014).
[linux-3.10.git] / include / linux / in6.h
1 /*
2  *      Types and definitions for AF_INET6 
3  *      Linux INET6 implementation 
4  *
5  *      Authors:
6  *      Pedro Roque             <roque@di.fc.ul.pt>     
7  *
8  *      Sources:
9  *      IPv6 Program Interfaces for BSD Systems
10  *      <draft-ietf-ipngwg-bsd-api-05.txt>
11  *
12  *      Advanced Sockets API for IPv6
13  *      <draft-stevens-advanced-api-00.txt>
14  *
15  *      This program is free software; you can redistribute it and/or
16  *      modify it under the terms of the GNU General Public License
17  *      as published by the Free Software Foundation; either version
18  *      2 of the License, or (at your option) any later version.
19  */
20
21 #ifndef _LINUX_IN6_H
22 #define _LINUX_IN6_H
23
24 #include <linux/types.h>
25
26 /*
27  *      IPv6 address structure
28  */
29
30 struct in6_addr
31 {
32         union 
33         {
34                 __u8            u6_addr8[16];
35                 __be16          u6_addr16[8];
36                 __be32          u6_addr32[4];
37         } in6_u;
38 #define s6_addr                 in6_u.u6_addr8
39 #define s6_addr16               in6_u.u6_addr16
40 #define s6_addr32               in6_u.u6_addr32
41 };
42
43 /* IPv6 Wildcard Address (::) and Loopback Address (::1) defined in RFC2553
44  * NOTE: Be aware the IN6ADDR_* constants and in6addr_* externals are defined
45  * in network byte order, not in host byte order as are the IPv4 equivalents
46  */
47 extern const struct in6_addr in6addr_any;
48 #define IN6ADDR_ANY_INIT { { { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 } } }
49 extern const struct in6_addr in6addr_loopback;
50 #define IN6ADDR_LOOPBACK_INIT { { { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1 } } }
51
52 struct sockaddr_in6 {
53         unsigned short int      sin6_family;    /* AF_INET6 */
54         __be16                  sin6_port;      /* Transport layer port # */
55         __be32                  sin6_flowinfo;  /* IPv6 flow information */
56         struct in6_addr         sin6_addr;      /* IPv6 address */
57         __u32                   sin6_scope_id;  /* scope id (new in RFC2553) */
58 };
59
60 struct ipv6_mreq {
61         /* IPv6 multicast address of group */
62         struct in6_addr ipv6mr_multiaddr;
63
64         /* local IPv6 address of interface */
65         int             ipv6mr_ifindex;
66 };
67
68 #define ipv6mr_acaddr   ipv6mr_multiaddr
69
70 struct in6_flowlabel_req
71 {
72         struct in6_addr flr_dst;
73         __be32  flr_label;
74         __u8    flr_action;
75         __u8    flr_share;
76         __u16   flr_flags;
77         __u16   flr_expires;
78         __u16   flr_linger;
79         __u32   __flr_pad;
80         /* Options in format of IPV6_PKTOPTIONS */
81 };
82
83 #define IPV6_FL_A_GET   0
84 #define IPV6_FL_A_PUT   1
85 #define IPV6_FL_A_RENEW 2
86
87 #define IPV6_FL_F_CREATE        1
88 #define IPV6_FL_F_EXCL          2
89
90 #define IPV6_FL_S_NONE          0
91 #define IPV6_FL_S_EXCL          1
92 #define IPV6_FL_S_PROCESS       2
93 #define IPV6_FL_S_USER          3
94 #define IPV6_FL_S_ANY           255
95
96
97 /*
98  *      Bitmask constant declarations to help applications select out the 
99  *      flow label and priority fields.
100  *
101  *      Note that this are in host byte order while the flowinfo field of
102  *      sockaddr_in6 is in network byte order.
103  */
104
105 #define IPV6_FLOWINFO_FLOWLABEL         0x000fffff
106 #define IPV6_FLOWINFO_PRIORITY          0x0ff00000
107
108 /* These defintions are obsolete */
109 #define IPV6_PRIORITY_UNCHARACTERIZED   0x0000
110 #define IPV6_PRIORITY_FILLER            0x0100
111 #define IPV6_PRIORITY_UNATTENDED        0x0200
112 #define IPV6_PRIORITY_RESERVED1         0x0300
113 #define IPV6_PRIORITY_BULK              0x0400
114 #define IPV6_PRIORITY_RESERVED2         0x0500
115 #define IPV6_PRIORITY_INTERACTIVE       0x0600
116 #define IPV6_PRIORITY_CONTROL           0x0700
117 #define IPV6_PRIORITY_8                 0x0800
118 #define IPV6_PRIORITY_9                 0x0900
119 #define IPV6_PRIORITY_10                0x0a00
120 #define IPV6_PRIORITY_11                0x0b00
121 #define IPV6_PRIORITY_12                0x0c00
122 #define IPV6_PRIORITY_13                0x0d00
123 #define IPV6_PRIORITY_14                0x0e00
124 #define IPV6_PRIORITY_15                0x0f00
125
126 /*
127  *      IPV6 extension headers
128  */
129 #define IPPROTO_HOPOPTS         0       /* IPv6 hop-by-hop options      */
130 #define IPPROTO_ROUTING         43      /* IPv6 routing header          */
131 #define IPPROTO_FRAGMENT        44      /* IPv6 fragmentation header    */
132 #define IPPROTO_ICMPV6          58      /* ICMPv6                       */
133 #define IPPROTO_NONE            59      /* IPv6 no next header          */
134 #define IPPROTO_DSTOPTS         60      /* IPv6 destination options     */
135 #define IPPROTO_MH              135     /* IPv6 mobility header         */
136
137 /*
138  *      IPv6 TLV options.
139  */
140 #define IPV6_TLV_PAD0           0
141 #define IPV6_TLV_PADN           1
142 #define IPV6_TLV_ROUTERALERT    5
143 #define IPV6_TLV_JUMBO          194
144 #define IPV6_TLV_HAO            201     /* home address option */
145
146 /*
147  *      IPV6 socket options
148  */
149
150 #define IPV6_ADDRFORM           1
151 #define IPV6_2292PKTINFO        2
152 #define IPV6_2292HOPOPTS        3
153 #define IPV6_2292DSTOPTS        4
154 #define IPV6_2292RTHDR          5
155 #define IPV6_2292PKTOPTIONS     6
156 #define IPV6_CHECKSUM           7
157 #define IPV6_2292HOPLIMIT       8
158 #define IPV6_NEXTHOP            9
159 #define IPV6_AUTHHDR            10      /* obsolete */
160 #define IPV6_FLOWINFO           11
161
162 #define IPV6_UNICAST_HOPS       16
163 #define IPV6_MULTICAST_IF       17
164 #define IPV6_MULTICAST_HOPS     18
165 #define IPV6_MULTICAST_LOOP     19
166 #define IPV6_ADD_MEMBERSHIP     20
167 #define IPV6_DROP_MEMBERSHIP    21
168 #define IPV6_ROUTER_ALERT       22
169 #define IPV6_MTU_DISCOVER       23
170 #define IPV6_MTU                24
171 #define IPV6_RECVERR            25
172 #define IPV6_V6ONLY             26
173 #define IPV6_JOIN_ANYCAST       27
174 #define IPV6_LEAVE_ANYCAST      28
175
176 /* IPV6_MTU_DISCOVER values */
177 #define IPV6_PMTUDISC_DONT              0
178 #define IPV6_PMTUDISC_WANT              1
179 #define IPV6_PMTUDISC_DO                2
180 #define IPV6_PMTUDISC_PROBE             3
181
182 /* Flowlabel */
183 #define IPV6_FLOWLABEL_MGR      32
184 #define IPV6_FLOWINFO_SEND      33
185
186 #define IPV6_IPSEC_POLICY       34
187 #define IPV6_XFRM_POLICY        35
188
189 /*
190  * Multicast:
191  * Following socket options are shared between IPv4 and IPv6.
192  *
193  * MCAST_JOIN_GROUP             42
194  * MCAST_BLOCK_SOURCE           43
195  * MCAST_UNBLOCK_SOURCE         44
196  * MCAST_LEAVE_GROUP            45
197  * MCAST_JOIN_SOURCE_GROUP      46
198  * MCAST_LEAVE_SOURCE_GROUP     47
199  * MCAST_MSFILTER               48
200  */
201
202 /*
203  * Advanced API (RFC3542) (1)
204  *
205  * Note: IPV6_RECVRTHDRDSTOPTS does not exist. see net/ipv6/datagram.c.
206  */
207
208 #define IPV6_RECVPKTINFO        49
209 #define IPV6_PKTINFO            50
210 #define IPV6_RECVHOPLIMIT       51
211 #define IPV6_HOPLIMIT           52
212 #define IPV6_RECVHOPOPTS        53
213 #define IPV6_HOPOPTS            54
214 #define IPV6_RTHDRDSTOPTS       55
215 #define IPV6_RECVRTHDR          56
216 #define IPV6_RTHDR              57
217 #define IPV6_RECVDSTOPTS        58
218 #define IPV6_DSTOPTS            59
219 #if 0   /* not yet */
220 #define IPV6_RECVPATHMTU        60
221 #define IPV6_PATHMTU            61
222 #define IPV6_DONTFRAG           62
223 #define IPV6_USE_MIN_MTU        63
224 #endif
225
226 /*
227  * Netfilter (1)
228  *
229  * Following socket options are used in ip6_tables;
230  * see include/linux/netfilter_ipv6/ip6_tables.h.
231  *
232  * IP6T_SO_SET_REPLACE / IP6T_SO_GET_INFO               64
233  * IP6T_SO_SET_ADD_COUNTERS / IP6T_SO_GET_ENTRIES       65
234  */
235
236 /*
237  * Advanced API (RFC3542) (2)
238  */
239 #define IPV6_RECVTCLASS         66
240 #define IPV6_TCLASS             67
241
242 /*
243  * Netfilter (2)
244  *
245  * Following socket options are used in ip6_tables;
246  * see include/linux/netfilter_ipv6/ip6_tables.h.
247  *
248  * IP6T_SO_GET_REVISION_MATCH   68
249  * IP6T_SO_GET_REVISION_TARGET  69
250  */
251
252 /* RFC5014: Source address selection */
253 #define IPV6_ADDR_PREFERENCES   72
254
255 #define IPV6_PREFER_SRC_TMP             0x0001
256 #define IPV6_PREFER_SRC_PUBLIC          0x0002
257 #define IPV6_PREFER_SRC_PUBTMP_DEFAULT  0x0100
258 #define IPV6_PREFER_SRC_COA             0x0004
259 #define IPV6_PREFER_SRC_HOME            0x0400
260 #define IPV6_PREFER_SRC_CGA             0x0008
261 #define IPV6_PREFER_SRC_NONCGA          0x0800
262
263 #endif