[SCTP]: Stop claiming that this is a "reference implementation"
[linux/fpc-iii.git] / net / sctp / bind_addr.c
bloba27511ebc4cb6ae80749a41c6b85239021749fee
1 /* SCTP kernel 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
7 * This file is part of the SCTP kernel implementation.
9 * A collection class to handle the storage of transport addresses.
11 * This SCTP 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.
17 * This SCTP 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.
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.
28 * Please send any bug reports or fixes you make to the
29 * email address(es):
30 * lksctp developers <lksctp-developers@lists.sourceforge.net>
32 * Or submit a bug report through the following website:
33 * http://www.sf.net/projects/lksctp
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>
41 * Any bugs reported given to us we will try to fix... any fixes shared will
42 * be incorporated into the next SCTP release.
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>
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 *);
59 /* First Level Abstractions. */
61 /* Copy 'src' to 'dest' taking 'scope' into account. Omit addresses
62 * in 'src' which have a broader scope than 'scope'.
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)
69 struct sctp_sockaddr_entry *addr;
70 struct list_head *pos;
71 int error = 0;
73 /* All addresses share the same port. */
74 dest->port = src->port;
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;
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.
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;
101 out:
102 if (error)
103 sctp_bind_addr_clean(dest);
105 return error;
108 /* Exactly duplicate the address lists. This is necessary when doing
109 * peer-offs and accepts. We don't want to put all the current system
110 * addresses into the endpoint. That's useless. But we do want duplicat
111 * the list of bound addresses that the older endpoint used.
113 int sctp_bind_addr_dup(struct sctp_bind_addr *dest,
114 const struct sctp_bind_addr *src,
115 gfp_t gfp)
117 struct sctp_sockaddr_entry *addr;
118 struct list_head *pos;
119 int error = 0;
121 /* All addresses share the same port. */
122 dest->port = src->port;
124 list_for_each(pos, &src->address_list) {
125 addr = list_entry(pos, struct sctp_sockaddr_entry, list);
126 error = sctp_add_bind_addr(dest, &addr->a, 1, gfp);
127 if (error < 0)
128 break;
131 return error;
134 /* Initialize the SCTP_bind_addr structure for either an endpoint or
135 * an association.
137 void sctp_bind_addr_init(struct sctp_bind_addr *bp, __u16 port)
139 bp->malloced = 0;
141 INIT_LIST_HEAD(&bp->address_list);
142 bp->port = port;
145 /* Dispose of the address list. */
146 static void sctp_bind_addr_clean(struct sctp_bind_addr *bp)
148 struct sctp_sockaddr_entry *addr;
149 struct list_head *pos, *temp;
151 /* Empty the bind address list. */
152 list_for_each_safe(pos, temp, &bp->address_list) {
153 addr = list_entry(pos, struct sctp_sockaddr_entry, list);
154 list_del(pos);
155 kfree(addr);
156 SCTP_DBG_OBJCNT_DEC(addr);
160 /* Dispose of an SCTP_bind_addr structure */
161 void sctp_bind_addr_free(struct sctp_bind_addr *bp)
163 /* Empty the bind address list. */
164 sctp_bind_addr_clean(bp);
166 if (bp->malloced) {
167 kfree(bp);
168 SCTP_DBG_OBJCNT_DEC(bind_addr);
172 /* Add an address to the bind address list in the SCTP_bind_addr structure. */
173 int sctp_add_bind_addr(struct sctp_bind_addr *bp, union sctp_addr *new,
174 __u8 addr_state, gfp_t gfp)
176 struct sctp_sockaddr_entry *addr;
178 /* Add the address to the bind address list. */
179 addr = t_new(struct sctp_sockaddr_entry, gfp);
180 if (!addr)
181 return -ENOMEM;
183 memcpy(&addr->a, new, sizeof(*new));
185 /* Fix up the port if it has not yet been set.
186 * Both v4 and v6 have the port at the same offset.
188 if (!addr->a.v4.sin_port)
189 addr->a.v4.sin_port = htons(bp->port);
191 addr->state = addr_state;
192 addr->valid = 1;
194 INIT_LIST_HEAD(&addr->list);
195 INIT_RCU_HEAD(&addr->rcu);
197 /* We always hold a socket lock when calling this function,
198 * and that acts as a writer synchronizing lock.
200 list_add_tail_rcu(&addr->list, &bp->address_list);
201 SCTP_DBG_OBJCNT_INC(addr);
203 return 0;
206 /* Delete an address from the bind address list in the SCTP_bind_addr
207 * structure.
209 int sctp_del_bind_addr(struct sctp_bind_addr *bp, union sctp_addr *del_addr)
211 struct sctp_sockaddr_entry *addr, *temp;
213 /* We hold the socket lock when calling this function,
214 * and that acts as a writer synchronizing lock.
216 list_for_each_entry_safe(addr, temp, &bp->address_list, list) {
217 if (sctp_cmp_addr_exact(&addr->a, del_addr)) {
218 /* Found the exact match. */
219 addr->valid = 0;
220 list_del_rcu(&addr->list);
221 break;
225 if (addr && !addr->valid) {
226 call_rcu(&addr->rcu, sctp_local_addr_free);
227 SCTP_DBG_OBJCNT_DEC(addr);
228 return 0;
231 return -EINVAL;
234 /* Create a network byte-order representation of all the addresses
235 * formated as SCTP parameters.
237 * The second argument is the return value for the length.
239 union sctp_params sctp_bind_addrs_to_raw(const struct sctp_bind_addr *bp,
240 int *addrs_len,
241 gfp_t gfp)
243 union sctp_params addrparms;
244 union sctp_params retval;
245 int addrparms_len;
246 union sctp_addr_param rawaddr;
247 int len;
248 struct sctp_sockaddr_entry *addr;
249 struct list_head *pos;
250 struct sctp_af *af;
252 addrparms_len = 0;
253 len = 0;
255 /* Allocate enough memory at once. */
256 list_for_each(pos, &bp->address_list) {
257 len += sizeof(union sctp_addr_param);
260 /* Don't even bother embedding an address if there
261 * is only one.
263 if (len == sizeof(union sctp_addr_param)) {
264 retval.v = NULL;
265 goto end_raw;
268 retval.v = kmalloc(len, gfp);
269 if (!retval.v)
270 goto end_raw;
272 addrparms = retval;
274 list_for_each(pos, &bp->address_list) {
275 addr = list_entry(pos, struct sctp_sockaddr_entry, list);
276 af = sctp_get_af_specific(addr->a.v4.sin_family);
277 len = af->to_addr_param(&addr->a, &rawaddr);
278 memcpy(addrparms.v, &rawaddr, len);
279 addrparms.v += len;
280 addrparms_len += len;
283 end_raw:
284 *addrs_len = addrparms_len;
285 return retval;
289 * Create an address list out of the raw address list format (IPv4 and IPv6
290 * address parameters).
292 int sctp_raw_to_bind_addrs(struct sctp_bind_addr *bp, __u8 *raw_addr_list,
293 int addrs_len, __u16 port, gfp_t gfp)
295 union sctp_addr_param *rawaddr;
296 struct sctp_paramhdr *param;
297 union sctp_addr addr;
298 int retval = 0;
299 int len;
300 struct sctp_af *af;
302 /* Convert the raw address to standard address format */
303 while (addrs_len) {
304 param = (struct sctp_paramhdr *)raw_addr_list;
305 rawaddr = (union sctp_addr_param *)raw_addr_list;
307 af = sctp_get_af_specific(param_type2af(param->type));
308 if (unlikely(!af)) {
309 retval = -EINVAL;
310 sctp_bind_addr_clean(bp);
311 break;
314 af->from_addr_param(&addr, rawaddr, htons(port), 0);
315 retval = sctp_add_bind_addr(bp, &addr, SCTP_ADDR_SRC, gfp);
316 if (retval) {
317 /* Can't finish building the list, clean up. */
318 sctp_bind_addr_clean(bp);
319 break;
322 len = ntohs(param->length);
323 addrs_len -= len;
324 raw_addr_list += len;
327 return retval;
330 /********************************************************************
331 * 2nd Level Abstractions
332 ********************************************************************/
334 /* Does this contain a specified address? Allow wildcarding. */
335 int sctp_bind_addr_match(struct sctp_bind_addr *bp,
336 const union sctp_addr *addr,
337 struct sctp_sock *opt)
339 struct sctp_sockaddr_entry *laddr;
340 int match = 0;
342 rcu_read_lock();
343 list_for_each_entry_rcu(laddr, &bp->address_list, list) {
344 if (!laddr->valid)
345 continue;
346 if (opt->pf->cmp_addr(&laddr->a, addr, opt)) {
347 match = 1;
348 break;
351 rcu_read_unlock();
353 return match;
356 /* Get the state of the entry in the bind_addr_list */
357 int sctp_bind_addr_state(const struct sctp_bind_addr *bp,
358 const union sctp_addr *addr)
360 struct sctp_sockaddr_entry *laddr;
361 struct sctp_af *af;
362 int state = -1;
364 af = sctp_get_af_specific(addr->sa.sa_family);
365 if (unlikely(!af))
366 return state;
368 rcu_read_lock();
369 list_for_each_entry_rcu(laddr, &bp->address_list, list) {
370 if (!laddr->valid)
371 continue;
372 if (af->cmp_addr(&laddr->a, addr)) {
373 state = laddr->state;
374 break;
377 rcu_read_unlock();
379 return state;
382 /* Find the first address in the bind address list that is not present in
383 * the addrs packed array.
385 union sctp_addr *sctp_find_unmatch_addr(struct sctp_bind_addr *bp,
386 const union sctp_addr *addrs,
387 int addrcnt,
388 struct sctp_sock *opt)
390 struct sctp_sockaddr_entry *laddr;
391 union sctp_addr *addr;
392 void *addr_buf;
393 struct sctp_af *af;
394 int i;
396 /* This is only called sctp_send_asconf_del_ip() and we hold
397 * the socket lock in that code patch, so that address list
398 * can't change.
400 list_for_each_entry(laddr, &bp->address_list, list) {
401 addr_buf = (union sctp_addr *)addrs;
402 for (i = 0; i < addrcnt; i++) {
403 addr = (union sctp_addr *)addr_buf;
404 af = sctp_get_af_specific(addr->v4.sin_family);
405 if (!af)
406 break;
408 if (opt->pf->cmp_addr(&laddr->a, addr, opt))
409 break;
411 addr_buf += af->sockaddr_len;
413 if (i == addrcnt)
414 return &laddr->a;
417 return NULL;
420 /* Copy out addresses from the global local address list. */
421 static int sctp_copy_one_addr(struct sctp_bind_addr *dest,
422 union sctp_addr *addr,
423 sctp_scope_t scope, gfp_t gfp,
424 int flags)
426 int error = 0;
428 if (sctp_is_any(addr)) {
429 error = sctp_copy_local_addr_list(dest, scope, gfp, flags);
430 } else if (sctp_in_scope(addr, scope)) {
431 /* Now that the address is in scope, check to see if
432 * the address type is supported by local sock as
433 * well as the remote peer.
435 if ((((AF_INET == addr->sa.sa_family) &&
436 (flags & SCTP_ADDR4_PEERSUPP))) ||
437 (((AF_INET6 == addr->sa.sa_family) &&
438 (flags & SCTP_ADDR6_ALLOWED) &&
439 (flags & SCTP_ADDR6_PEERSUPP))))
440 error = sctp_add_bind_addr(dest, addr, SCTP_ADDR_SRC,
441 gfp);
444 return error;
447 /* Is this a wildcard address? */
448 int sctp_is_any(const union sctp_addr *addr)
450 struct sctp_af *af = sctp_get_af_specific(addr->sa.sa_family);
451 if (!af)
452 return 0;
453 return af->is_any(addr);
456 /* Is 'addr' valid for 'scope'? */
457 int sctp_in_scope(const union sctp_addr *addr, sctp_scope_t scope)
459 sctp_scope_t addr_scope = sctp_scope(addr);
461 /* The unusable SCTP addresses will not be considered with
462 * any defined scopes.
464 if (SCTP_SCOPE_UNUSABLE == addr_scope)
465 return 0;
467 * For INIT and INIT-ACK address list, let L be the level of
468 * of requested destination address, sender and receiver
469 * SHOULD include all of its addresses with level greater
470 * than or equal to L.
472 if (addr_scope <= scope)
473 return 1;
475 return 0;
478 /********************************************************************
479 * 3rd Level Abstractions
480 ********************************************************************/
482 /* What is the scope of 'addr'? */
483 sctp_scope_t sctp_scope(const union sctp_addr *addr)
485 struct sctp_af *af;
487 af = sctp_get_af_specific(addr->sa.sa_family);
488 if (!af)
489 return SCTP_SCOPE_UNUSABLE;
491 return af->scope((union sctp_addr *)addr);