sctp: avoid irq lock inversion while call sk->sk_data_ready()
[linux-2.6.git] / net / sctp / endpointola.c
1 /* SCTP kernel implementation
2  * Copyright (c) 1999-2000 Cisco, Inc.
3  * Copyright (c) 1999-2001 Motorola, Inc.
4  * Copyright (c) 2001-2002 International Business Machines, Corp.
5  * Copyright (c) 2001 Intel Corp.
6  * Copyright (c) 2001 Nokia, Inc.
7  * Copyright (c) 2001 La Monte H.P. Yarroll
8  *
9  * This file is part of the SCTP kernel implementation
10  *
11  * This abstraction represents an SCTP endpoint.
12  *
13  * The SCTP implementation is free software;
14  * you can redistribute it and/or modify it under the terms of
15  * the GNU General Public License as published by
16  * the Free Software Foundation; either version 2, or (at your option)
17  * any later version.
18  *
19  * The SCTP implementation is distributed in the hope that it
20  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
21  *                 ************************
22  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
23  * See the GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with GNU CC; see the file COPYING.  If not, write to
27  * the Free Software Foundation, 59 Temple Place - Suite 330,
28  * Boston, MA 02111-1307, USA.
29  *
30  * Please send any bug reports or fixes you make to the
31  * email address(es):
32  *    lksctp developers <lksctp-developers@lists.sourceforge.net>
33  *
34  * Or submit a bug report through the following website:
35  *    http://www.sf.net/projects/lksctp
36  *
37  * Written or modified by:
38  *    La Monte H.P. Yarroll <piggy@acm.org>
39  *    Karl Knutson <karl@athena.chicago.il.us>
40  *    Jon Grimm <jgrimm@austin.ibm.com>
41  *    Daisy Chang <daisyc@us.ibm.com>
42  *    Dajiang Zhang <dajiang.zhang@nokia.com>
43  *
44  * Any bugs reported given to us we will try to fix... any fixes shared will
45  * be incorporated into the next SCTP release.
46  */
47
48 #include <linux/types.h>
49 #include <linux/slab.h>
50 #include <linux/in.h>
51 #include <linux/random.h>       /* get_random_bytes() */
52 #include <linux/crypto.h>
53 #include <net/sock.h>
54 #include <net/ipv6.h>
55 #include <net/sctp/sctp.h>
56 #include <net/sctp/sm.h>
57
58 /* Forward declarations for internal helpers. */
59 static void sctp_endpoint_bh_rcv(struct work_struct *work);
60
61 /*
62  * Initialize the base fields of the endpoint structure.
63  */
64 static struct sctp_endpoint *sctp_endpoint_init(struct sctp_endpoint *ep,
65                                                 struct sock *sk,
66                                                 gfp_t gfp)
67 {
68         struct sctp_hmac_algo_param *auth_hmacs = NULL;
69         struct sctp_chunks_param *auth_chunks = NULL;
70         struct sctp_shared_key *null_key;
71         int err;
72
73         memset(ep, 0, sizeof(struct sctp_endpoint));
74
75         ep->digest = kzalloc(SCTP_SIGNATURE_SIZE, gfp);
76         if (!ep->digest)
77                 return NULL;
78
79         if (sctp_auth_enable) {
80                 /* Allocate space for HMACS and CHUNKS authentication
81                  * variables.  There are arrays that we encode directly
82                  * into parameters to make the rest of the operations easier.
83                  */
84                 auth_hmacs = kzalloc(sizeof(sctp_hmac_algo_param_t) +
85                                 sizeof(__u16) * SCTP_AUTH_NUM_HMACS, gfp);
86                 if (!auth_hmacs)
87                         goto nomem;
88
89                 auth_chunks = kzalloc(sizeof(sctp_chunks_param_t) +
90                                         SCTP_NUM_CHUNK_TYPES, gfp);
91                 if (!auth_chunks)
92                         goto nomem;
93
94                 /* Initialize the HMACS parameter.
95                  * SCTP-AUTH: Section 3.3
96                  *    Every endpoint supporting SCTP chunk authentication MUST
97                  *    support the HMAC based on the SHA-1 algorithm.
98                  */
99                 auth_hmacs->param_hdr.type = SCTP_PARAM_HMAC_ALGO;
100                 auth_hmacs->param_hdr.length =
101                                         htons(sizeof(sctp_paramhdr_t) + 2);
102                 auth_hmacs->hmac_ids[0] = htons(SCTP_AUTH_HMAC_ID_SHA1);
103
104                 /* Initialize the CHUNKS parameter */
105                 auth_chunks->param_hdr.type = SCTP_PARAM_CHUNKS;
106                 auth_chunks->param_hdr.length = htons(sizeof(sctp_paramhdr_t));
107
108                 /* If the Add-IP functionality is enabled, we must
109                  * authenticate, ASCONF and ASCONF-ACK chunks
110                  */
111                 if (sctp_addip_enable) {
112                         auth_chunks->chunks[0] = SCTP_CID_ASCONF;
113                         auth_chunks->chunks[1] = SCTP_CID_ASCONF_ACK;
114                         auth_chunks->param_hdr.length =
115                                         htons(sizeof(sctp_paramhdr_t) + 2);
116                 }
117         }
118
119         /* Initialize the base structure. */
120         /* What type of endpoint are we?  */
121         ep->base.type = SCTP_EP_TYPE_SOCKET;
122
123         /* Initialize the basic object fields. */
124         atomic_set(&ep->base.refcnt, 1);
125         ep->base.dead = 0;
126         ep->base.malloced = 1;
127
128         /* Create an input queue.  */
129         sctp_inq_init(&ep->base.inqueue);
130
131         /* Set its top-half handler */
132         sctp_inq_set_th_handler(&ep->base.inqueue, sctp_endpoint_bh_rcv);
133
134         /* Initialize the bind addr area */
135         sctp_bind_addr_init(&ep->base.bind_addr, 0);
136
137         /* Remember who we are attached to.  */
138         ep->base.sk = sk;
139         sock_hold(ep->base.sk);
140
141         /* Create the lists of associations.  */
142         INIT_LIST_HEAD(&ep->asocs);
143
144         /* Use SCTP specific send buffer space queues.  */
145         ep->sndbuf_policy = sctp_sndbuf_policy;
146
147         sk->sk_data_ready = sctp_data_ready;
148         sk->sk_write_space = sctp_write_space;
149         sock_set_flag(sk, SOCK_USE_WRITE_QUEUE);
150
151         /* Get the receive buffer policy for this endpoint */
152         ep->rcvbuf_policy = sctp_rcvbuf_policy;
153
154         /* Initialize the secret key used with cookie. */
155         get_random_bytes(&ep->secret_key[0], SCTP_SECRET_SIZE);
156         ep->last_key = ep->current_key = 0;
157         ep->key_changed_at = jiffies;
158
159         /* SCTP-AUTH extensions*/
160         INIT_LIST_HEAD(&ep->endpoint_shared_keys);
161         null_key = sctp_auth_shkey_create(0, GFP_KERNEL);
162         if (!null_key)
163                 goto nomem;
164
165         list_add(&null_key->key_list, &ep->endpoint_shared_keys);
166
167         /* Allocate and initialize transorms arrays for suported HMACs. */
168         err = sctp_auth_init_hmacs(ep, gfp);
169         if (err)
170                 goto nomem_hmacs;
171
172         /* Add the null key to the endpoint shared keys list and
173          * set the hmcas and chunks pointers.
174          */
175         ep->auth_hmacs_list = auth_hmacs;
176         ep->auth_chunk_list = auth_chunks;
177
178         return ep;
179
180 nomem_hmacs:
181         sctp_auth_destroy_keys(&ep->endpoint_shared_keys);
182 nomem:
183         /* Free all allocations */
184         kfree(auth_hmacs);
185         kfree(auth_chunks);
186         kfree(ep->digest);
187         return NULL;
188
189 }
190
191 /* Create a sctp_endpoint with all that boring stuff initialized.
192  * Returns NULL if there isn't enough memory.
193  */
194 struct sctp_endpoint *sctp_endpoint_new(struct sock *sk, gfp_t gfp)
195 {
196         struct sctp_endpoint *ep;
197
198         /* Build a local endpoint. */
199         ep = t_new(struct sctp_endpoint, gfp);
200         if (!ep)
201                 goto fail;
202         if (!sctp_endpoint_init(ep, sk, gfp))
203                 goto fail_init;
204         ep->base.malloced = 1;
205         SCTP_DBG_OBJCNT_INC(ep);
206         return ep;
207
208 fail_init:
209         kfree(ep);
210 fail:
211         return NULL;
212 }
213
214 /* Add an association to an endpoint.  */
215 void sctp_endpoint_add_asoc(struct sctp_endpoint *ep,
216                             struct sctp_association *asoc)
217 {
218         struct sock *sk = ep->base.sk;
219
220         /* If this is a temporary association, don't bother
221          * since we'll be removing it shortly and don't
222          * want anyone to find it anyway.
223          */
224         if (asoc->temp)
225                 return;
226
227         /* Now just add it to our list of asocs */
228         list_add_tail(&asoc->asocs, &ep->asocs);
229
230         /* Increment the backlog value for a TCP-style listening socket. */
231         if (sctp_style(sk, TCP) && sctp_sstate(sk, LISTENING))
232                 sk->sk_ack_backlog++;
233 }
234
235 /* Free the endpoint structure.  Delay cleanup until
236  * all users have released their reference count on this structure.
237  */
238 void sctp_endpoint_free(struct sctp_endpoint *ep)
239 {
240         ep->base.dead = 1;
241
242         ep->base.sk->sk_state = SCTP_SS_CLOSED;
243
244         /* Unlink this endpoint, so we can't find it again! */
245         sctp_unhash_endpoint(ep);
246
247         sctp_endpoint_put(ep);
248 }
249
250 /* Final destructor for endpoint.  */
251 static void sctp_endpoint_destroy(struct sctp_endpoint *ep)
252 {
253         SCTP_ASSERT(ep->base.dead, "Endpoint is not dead", return);
254
255         /* Free up the HMAC transform. */
256         crypto_free_hash(sctp_sk(ep->base.sk)->hmac);
257
258         /* Free the digest buffer */
259         kfree(ep->digest);
260
261         /* SCTP-AUTH: Free up AUTH releated data such as shared keys
262          * chunks and hmacs arrays that were allocated
263          */
264         sctp_auth_destroy_keys(&ep->endpoint_shared_keys);
265         kfree(ep->auth_hmacs_list);
266         kfree(ep->auth_chunk_list);
267
268         /* AUTH - Free any allocated HMAC transform containers */
269         sctp_auth_destroy_hmacs(ep->auth_hmacs);
270
271         /* Cleanup. */
272         sctp_inq_free(&ep->base.inqueue);
273         sctp_bind_addr_free(&ep->base.bind_addr);
274
275         /* Remove and free the port */
276         if (sctp_sk(ep->base.sk)->bind_hash)
277                 sctp_put_port(ep->base.sk);
278
279         /* Give up our hold on the sock. */
280         if (ep->base.sk)
281                 sock_put(ep->base.sk);
282
283         /* Finally, free up our memory. */
284         if (ep->base.malloced) {
285                 kfree(ep);
286                 SCTP_DBG_OBJCNT_DEC(ep);
287         }
288 }
289
290 /* Hold a reference to an endpoint. */
291 void sctp_endpoint_hold(struct sctp_endpoint *ep)
292 {
293         atomic_inc(&ep->base.refcnt);
294 }
295
296 /* Release a reference to an endpoint and clean up if there are
297  * no more references.
298  */
299 void sctp_endpoint_put(struct sctp_endpoint *ep)
300 {
301         if (atomic_dec_and_test(&ep->base.refcnt))
302                 sctp_endpoint_destroy(ep);
303 }
304
305 /* Is this the endpoint we are looking for?  */
306 struct sctp_endpoint *sctp_endpoint_is_match(struct sctp_endpoint *ep,
307                                                const union sctp_addr *laddr)
308 {
309         struct sctp_endpoint *retval = NULL;
310
311         if (htons(ep->base.bind_addr.port) == laddr->v4.sin_port) {
312                 if (sctp_bind_addr_match(&ep->base.bind_addr, laddr,
313                                          sctp_sk(ep->base.sk)))
314                         retval = ep;
315         }
316
317         return retval;
318 }
319
320 /* Find the association that goes with this chunk.
321  * We do a linear search of the associations for this endpoint.
322  * We return the matching transport address too.
323  */
324 static struct sctp_association *__sctp_endpoint_lookup_assoc(
325         const struct sctp_endpoint *ep,
326         const union sctp_addr *paddr,
327         struct sctp_transport **transport)
328 {
329         struct sctp_association *asoc = NULL;
330         struct sctp_transport *t = NULL;
331         struct sctp_hashbucket *head;
332         struct sctp_ep_common *epb;
333         struct hlist_node *node;
334         int hash;
335         int rport;
336
337         *transport = NULL;
338         rport = ntohs(paddr->v4.sin_port);
339
340         hash = sctp_assoc_hashfn(ep->base.bind_addr.port, rport);
341         head = &sctp_assoc_hashtable[hash];
342         read_lock(&head->lock);
343         sctp_for_each_hentry(epb, node, &head->chain) {
344                 asoc = sctp_assoc(epb);
345                 if (asoc->ep != ep || rport != asoc->peer.port)
346                         goto next;
347
348                 t = sctp_assoc_lookup_paddr(asoc, paddr);
349                 if (t) {
350                         *transport = t;
351                         break;
352                 }
353 next:
354                 asoc = NULL;
355         }
356         read_unlock(&head->lock);
357         return asoc;
358 }
359
360 /* Lookup association on an endpoint based on a peer address.  BH-safe.  */
361 struct sctp_association *sctp_endpoint_lookup_assoc(
362         const struct sctp_endpoint *ep,
363         const union sctp_addr *paddr,
364         struct sctp_transport **transport)
365 {
366         struct sctp_association *asoc;
367
368         sctp_local_bh_disable();
369         asoc = __sctp_endpoint_lookup_assoc(ep, paddr, transport);
370         sctp_local_bh_enable();
371
372         return asoc;
373 }
374
375 /* Look for any peeled off association from the endpoint that matches the
376  * given peer address.
377  */
378 int sctp_endpoint_is_peeled_off(struct sctp_endpoint *ep,
379                                 const union sctp_addr *paddr)
380 {
381         struct sctp_sockaddr_entry *addr;
382         struct sctp_bind_addr *bp;
383
384         bp = &ep->base.bind_addr;
385         /* This function is called with the socket lock held,
386          * so the address_list can not change.
387          */
388         list_for_each_entry(addr, &bp->address_list, list) {
389                 if (sctp_has_association(&addr->a, paddr))
390                         return 1;
391         }
392
393         return 0;
394 }
395
396 /* Do delayed input processing.  This is scheduled by sctp_rcv().
397  * This may be called on BH or task time.
398  */
399 static void sctp_endpoint_bh_rcv(struct work_struct *work)
400 {
401         struct sctp_endpoint *ep =
402                 container_of(work, struct sctp_endpoint,
403                              base.inqueue.immediate);
404         struct sctp_association *asoc;
405         struct sock *sk;
406         struct sctp_transport *transport;
407         struct sctp_chunk *chunk;
408         struct sctp_inq *inqueue;
409         sctp_subtype_t subtype;
410         sctp_state_t state;
411         int error = 0;
412         int first_time = 1;     /* is this the first time through the looop */
413
414         if (ep->base.dead)
415                 return;
416
417         asoc = NULL;
418         inqueue = &ep->base.inqueue;
419         sk = ep->base.sk;
420
421         while (NULL != (chunk = sctp_inq_pop(inqueue))) {
422                 subtype = SCTP_ST_CHUNK(chunk->chunk_hdr->type);
423
424                 /* If the first chunk in the packet is AUTH, do special
425                  * processing specified in Section 6.3 of SCTP-AUTH spec
426                  */
427                 if (first_time && (subtype.chunk == SCTP_CID_AUTH)) {
428                         struct sctp_chunkhdr *next_hdr;
429
430                         next_hdr = sctp_inq_peek(inqueue);
431                         if (!next_hdr)
432                                 goto normal;
433
434                         /* If the next chunk is COOKIE-ECHO, skip the AUTH
435                          * chunk while saving a pointer to it so we can do
436                          * Authentication later (during cookie-echo
437                          * processing).
438                          */
439                         if (next_hdr->type == SCTP_CID_COOKIE_ECHO) {
440                                 chunk->auth_chunk = skb_clone(chunk->skb,
441                                                                 GFP_ATOMIC);
442                                 chunk->auth = 1;
443                                 continue;
444                         }
445                 }
446 normal:
447                 /* We might have grown an association since last we
448                  * looked, so try again.
449                  *
450                  * This happens when we've just processed our
451                  * COOKIE-ECHO chunk.
452                  */
453                 if (NULL == chunk->asoc) {
454                         asoc = sctp_endpoint_lookup_assoc(ep,
455                                                           sctp_source(chunk),
456                                                           &transport);
457                         chunk->asoc = asoc;
458                         chunk->transport = transport;
459                 }
460
461                 state = asoc ? asoc->state : SCTP_STATE_CLOSED;
462                 if (sctp_auth_recv_cid(subtype.chunk, asoc) && !chunk->auth)
463                         continue;
464
465                 /* Remember where the last DATA chunk came from so we
466                  * know where to send the SACK.
467                  */
468                 if (asoc && sctp_chunk_is_data(chunk))
469                         asoc->peer.last_data_from = chunk->transport;
470                 else
471                         SCTP_INC_STATS(SCTP_MIB_INCTRLCHUNKS);
472
473                 if (chunk->transport)
474                         chunk->transport->last_time_heard = jiffies;
475
476                 error = sctp_do_sm(SCTP_EVENT_T_CHUNK, subtype, state,
477                                    ep, asoc, chunk, GFP_ATOMIC);
478
479                 if (error && chunk)
480                         chunk->pdiscard = 1;
481
482                 /* Check to see if the endpoint is freed in response to
483                  * the incoming chunk. If so, get out of the while loop.
484                  */
485                 if (!sctp_sk(sk)->ep)
486                         break;
487
488                 if (first_time)
489                         first_time = 0;
490         }
491 }