[SCTP]: Add RCU synchronization around sctp_localaddr_list
[linux-3.10.git] / net / sctp / bind_addr.c
1 /* SCTP kernel reference Implementation
2  * (C) Copyright IBM Corp. 2001, 2003
3  * Copyright (c) Cisco 1999,2000
4  * Copyright (c) Motorola 1999,2000,2001
5  * Copyright (c) La Monte H.P. Yarroll 2001
6  *
7  * This file is part of the SCTP kernel reference implementation.
8  *
9  * A collection class to handle the storage of transport addresses.
10  *
11  * The SCTP reference implementation is free software;
12  * you can redistribute it and/or modify it under the terms of
13  * the GNU General Public License as published by
14  * the Free Software Foundation; either version 2, or (at your option)
15  * any later version.
16  *
17  * The SCTP reference implementation is distributed in the hope that it
18  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
19  *                 ************************
20  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
21  * See the GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with GNU CC; see the file COPYING.  If not, write to
25  * the Free Software Foundation, 59 Temple Place - Suite 330,
26  * Boston, MA 02111-1307, USA.
27  *
28  * Please send any bug reports or fixes you make to the
29  * email address(es):
30  *    lksctp developers <lksctp-developers@lists.sourceforge.net>
31  *
32  * Or submit a bug report through the following website:
33  *    http://www.sf.net/projects/lksctp
34  *
35  * Written or modified by:
36  *    La Monte H.P. Yarroll <piggy@acm.org>
37  *    Karl Knutson          <karl@athena.chicago.il.us>
38  *    Jon Grimm             <jgrimm@us.ibm.com>
39  *    Daisy Chang           <daisyc@us.ibm.com>
40  *
41  * Any bugs reported given to us we will try to fix... any fixes shared will
42  * be incorporated into the next SCTP release.
43  */
44
45 #include <linux/types.h>
46 #include <linux/in.h>
47 #include <net/sock.h>
48 #include <net/ipv6.h>
49 #include <net/if_inet6.h>
50 #include <net/sctp/sctp.h>
51 #include <net/sctp/sm.h>
52
53 /* Forward declarations for internal helpers. */
54 static int sctp_copy_one_addr(struct sctp_bind_addr *, union sctp_addr *,
55                               sctp_scope_t scope, gfp_t gfp,
56                               int flags);
57 static void sctp_bind_addr_clean(struct sctp_bind_addr *);
58
59 /* First Level Abstractions. */
60
61 /* Copy 'src' to 'dest' taking 'scope' into account.  Omit addresses
62  * in 'src' which have a broader scope than 'scope'.
63  */
64 int sctp_bind_addr_copy(struct sctp_bind_addr *dest,
65                         const struct sctp_bind_addr *src,
66                         sctp_scope_t scope, gfp_t gfp,
67                         int flags)
68 {
69         struct sctp_sockaddr_entry *addr;
70         struct list_head *pos;
71         int error = 0;
72
73         /* All addresses share the same port.  */
74         dest->port = src->port;
75
76         /* Extract the addresses which are relevant for this scope.  */
77         list_for_each(pos, &src->address_list) {
78                 addr = list_entry(pos, struct sctp_sockaddr_entry, list);
79                 error = sctp_copy_one_addr(dest, &addr->a, scope,
80                                            gfp, flags);
81                 if (error < 0)
82                         goto out;
83         }
84
85         /* If there are no addresses matching the scope and
86          * this is global scope, try to get a link scope address, with
87          * the assumption that we must be sitting behind a NAT.
88          */
89         if (list_empty(&dest->address_list) && (SCTP_SCOPE_GLOBAL == scope)) {
90                 list_for_each(pos, &src->address_list) {
91                         addr = list_entry(pos, struct sctp_sockaddr_entry,
92                                           list);
93                         error = sctp_copy_one_addr(dest, &addr->a,
94                                                    SCTP_SCOPE_LINK, gfp,
95                                                    flags);
96                         if (error < 0)
97                                 goto out;
98                 }
99         }
100
101 out:
102         if (error)
103                 sctp_bind_addr_clean(dest);
104
105         return error;
106 }
107
108 /* Initialize the SCTP_bind_addr structure for either an endpoint or
109  * an association.
110  */
111 void sctp_bind_addr_init(struct sctp_bind_addr *bp, __u16 port)
112 {
113         bp->malloced = 0;
114
115         INIT_LIST_HEAD(&bp->address_list);
116         bp->port = port;
117 }
118
119 /* Dispose of the address list. */
120 static void sctp_bind_addr_clean(struct sctp_bind_addr *bp)
121 {
122         struct sctp_sockaddr_entry *addr;
123         struct list_head *pos, *temp;
124
125         /* Empty the bind address list. */
126         list_for_each_safe(pos, temp, &bp->address_list) {
127                 addr = list_entry(pos, struct sctp_sockaddr_entry, list);
128                 list_del(pos);
129                 kfree(addr);
130                 SCTP_DBG_OBJCNT_DEC(addr);
131         }
132 }
133
134 /* Dispose of an SCTP_bind_addr structure  */
135 void sctp_bind_addr_free(struct sctp_bind_addr *bp)
136 {
137         /* Empty the bind address list. */
138         sctp_bind_addr_clean(bp);
139
140         if (bp->malloced) {
141                 kfree(bp);
142                 SCTP_DBG_OBJCNT_DEC(bind_addr);
143         }
144 }
145
146 /* Add an address to the bind address list in the SCTP_bind_addr structure. */
147 int sctp_add_bind_addr(struct sctp_bind_addr *bp, union sctp_addr *new,
148                        __u8 use_as_src, gfp_t gfp)
149 {
150         struct sctp_sockaddr_entry *addr;
151
152         /* Add the address to the bind address list.  */
153         addr = t_new(struct sctp_sockaddr_entry, gfp);
154         if (!addr)
155                 return -ENOMEM;
156
157         memcpy(&addr->a, new, sizeof(*new));
158
159         /* Fix up the port if it has not yet been set.
160          * Both v4 and v6 have the port at the same offset.
161          */
162         if (!addr->a.v4.sin_port)
163                 addr->a.v4.sin_port = htons(bp->port);
164
165         addr->use_as_src = use_as_src;
166         addr->valid = 1;
167
168         INIT_LIST_HEAD(&addr->list);
169         INIT_RCU_HEAD(&addr->rcu);
170         list_add_tail(&addr->list, &bp->address_list);
171         SCTP_DBG_OBJCNT_INC(addr);
172
173         return 0;
174 }
175
176 /* Delete an address from the bind address list in the SCTP_bind_addr
177  * structure.
178  */
179 int sctp_del_bind_addr(struct sctp_bind_addr *bp, union sctp_addr *del_addr)
180 {
181         struct list_head *pos, *temp;
182         struct sctp_sockaddr_entry *addr;
183
184         list_for_each_safe(pos, temp, &bp->address_list) {
185                 addr = list_entry(pos, struct sctp_sockaddr_entry, list);
186                 if (sctp_cmp_addr_exact(&addr->a, del_addr)) {
187                         /* Found the exact match. */
188                         list_del(pos);
189                         kfree(addr);
190                         SCTP_DBG_OBJCNT_DEC(addr);
191
192                         return 0;
193                 }
194         }
195
196         return -EINVAL;
197 }
198
199 /* Create a network byte-order representation of all the addresses
200  * formated as SCTP parameters.
201  *
202  * The second argument is the return value for the length.
203  */
204 union sctp_params sctp_bind_addrs_to_raw(const struct sctp_bind_addr *bp,
205                                          int *addrs_len,
206                                          gfp_t gfp)
207 {
208         union sctp_params addrparms;
209         union sctp_params retval;
210         int addrparms_len;
211         union sctp_addr_param rawaddr;
212         int len;
213         struct sctp_sockaddr_entry *addr;
214         struct list_head *pos;
215         struct sctp_af *af;
216
217         addrparms_len = 0;
218         len = 0;
219
220         /* Allocate enough memory at once. */
221         list_for_each(pos, &bp->address_list) {
222                 len += sizeof(union sctp_addr_param);
223         }
224
225         /* Don't even bother embedding an address if there
226          * is only one.
227          */
228         if (len == sizeof(union sctp_addr_param)) {
229                 retval.v = NULL;
230                 goto end_raw;
231         }
232
233         retval.v = kmalloc(len, gfp);
234         if (!retval.v)
235                 goto end_raw;
236
237         addrparms = retval;
238
239         list_for_each(pos, &bp->address_list) {
240                 addr = list_entry(pos, struct sctp_sockaddr_entry, list);
241                 af = sctp_get_af_specific(addr->a.v4.sin_family);
242                 len = af->to_addr_param(&addr->a, &rawaddr);
243                 memcpy(addrparms.v, &rawaddr, len);
244                 addrparms.v += len;
245                 addrparms_len += len;
246         }
247
248 end_raw:
249         *addrs_len = addrparms_len;
250         return retval;
251 }
252
253 /*
254  * Create an address list out of the raw address list format (IPv4 and IPv6
255  * address parameters).
256  */
257 int sctp_raw_to_bind_addrs(struct sctp_bind_addr *bp, __u8 *raw_addr_list,
258                            int addrs_len, __u16 port, gfp_t gfp)
259 {
260         union sctp_addr_param *rawaddr;
261         struct sctp_paramhdr *param;
262         union sctp_addr addr;
263         int retval = 0;
264         int len;
265         struct sctp_af *af;
266
267         /* Convert the raw address to standard address format */
268         while (addrs_len) {
269                 param = (struct sctp_paramhdr *)raw_addr_list;
270                 rawaddr = (union sctp_addr_param *)raw_addr_list;
271
272                 af = sctp_get_af_specific(param_type2af(param->type));
273                 if (unlikely(!af)) {
274                         retval = -EINVAL;
275                         sctp_bind_addr_clean(bp);
276                         break;
277                 }
278
279                 af->from_addr_param(&addr, rawaddr, htons(port), 0);
280                 retval = sctp_add_bind_addr(bp, &addr, 1, gfp);
281                 if (retval) {
282                         /* Can't finish building the list, clean up. */
283                         sctp_bind_addr_clean(bp);
284                         break;
285                 }
286
287                 len = ntohs(param->length);
288                 addrs_len -= len;
289                 raw_addr_list += len;
290         }
291
292         return retval;
293 }
294
295 /********************************************************************
296  * 2nd Level Abstractions
297  ********************************************************************/
298
299 /* Does this contain a specified address?  Allow wildcarding. */
300 int sctp_bind_addr_match(struct sctp_bind_addr *bp,
301                          const union sctp_addr *addr,
302                          struct sctp_sock *opt)
303 {
304         struct sctp_sockaddr_entry *laddr;
305         struct list_head *pos;
306
307         list_for_each(pos, &bp->address_list) {
308                 laddr = list_entry(pos, struct sctp_sockaddr_entry, list);
309                 if (opt->pf->cmp_addr(&laddr->a, addr, opt))
310                         return 1;
311         }
312
313         return 0;
314 }
315
316 /* Find the first address in the bind address list that is not present in
317  * the addrs packed array.
318  */
319 union sctp_addr *sctp_find_unmatch_addr(struct sctp_bind_addr   *bp,
320                                         const union sctp_addr   *addrs,
321                                         int                     addrcnt,
322                                         struct sctp_sock        *opt)
323 {
324         struct sctp_sockaddr_entry      *laddr;
325         union sctp_addr                 *addr;
326         void                            *addr_buf;
327         struct sctp_af                  *af;
328         struct list_head                *pos;
329         int                             i;
330
331         list_for_each(pos, &bp->address_list) {
332                 laddr = list_entry(pos, struct sctp_sockaddr_entry, list);
333
334                 addr_buf = (union sctp_addr *)addrs;
335                 for (i = 0; i < addrcnt; i++) {
336                         addr = (union sctp_addr *)addr_buf;
337                         af = sctp_get_af_specific(addr->v4.sin_family);
338                         if (!af)
339                                 return NULL;
340
341                         if (opt->pf->cmp_addr(&laddr->a, addr, opt))
342                                 break;
343
344                         addr_buf += af->sockaddr_len;
345                 }
346                 if (i == addrcnt)
347                         return &laddr->a;
348         }
349
350         return NULL;
351 }
352
353 /* Copy out addresses from the global local address list. */
354 static int sctp_copy_one_addr(struct sctp_bind_addr *dest,
355                               union sctp_addr *addr,
356                               sctp_scope_t scope, gfp_t gfp,
357                               int flags)
358 {
359         int error = 0;
360
361         if (sctp_is_any(addr)) {
362                 error = sctp_copy_local_addr_list(dest, scope, gfp, flags);
363         } else if (sctp_in_scope(addr, scope)) {
364                 /* Now that the address is in scope, check to see if
365                  * the address type is supported by local sock as
366                  * well as the remote peer.
367                  */
368                 if ((((AF_INET == addr->sa.sa_family) &&
369                       (flags & SCTP_ADDR4_PEERSUPP))) ||
370                     (((AF_INET6 == addr->sa.sa_family) &&
371                       (flags & SCTP_ADDR6_ALLOWED) &&
372                       (flags & SCTP_ADDR6_PEERSUPP))))
373                         error = sctp_add_bind_addr(dest, addr, 1, gfp);
374         }
375
376         return error;
377 }
378
379 /* Is this a wildcard address?  */
380 int sctp_is_any(const union sctp_addr *addr)
381 {
382         struct sctp_af *af = sctp_get_af_specific(addr->sa.sa_family);
383         if (!af)
384                 return 0;
385         return af->is_any(addr);
386 }
387
388 /* Is 'addr' valid for 'scope'?  */
389 int sctp_in_scope(const union sctp_addr *addr, sctp_scope_t scope)
390 {
391         sctp_scope_t addr_scope = sctp_scope(addr);
392
393         /* The unusable SCTP addresses will not be considered with
394          * any defined scopes.
395          */
396         if (SCTP_SCOPE_UNUSABLE == addr_scope)
397                 return 0;
398         /*
399          * For INIT and INIT-ACK address list, let L be the level of
400          * of requested destination address, sender and receiver
401          * SHOULD include all of its addresses with level greater
402          * than or equal to L.
403          */
404         if (addr_scope <= scope)
405                 return 1;
406
407         return 0;
408 }
409
410 /********************************************************************
411  * 3rd Level Abstractions
412  ********************************************************************/
413
414 /* What is the scope of 'addr'?  */
415 sctp_scope_t sctp_scope(const union sctp_addr *addr)
416 {
417         struct sctp_af *af;
418
419         af = sctp_get_af_specific(addr->sa.sa_family);
420         if (!af)
421                 return SCTP_SCOPE_UNUSABLE;
422
423         return af->scope((union sctp_addr *)addr);
424 }