rxrpc: Implement slow-start
[cascardo/linux.git] / net / rxrpc / call_object.c
1 /* RxRPC individual remote procedure call handling
2  *
3  * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
4  * Written by David Howells (dhowells@redhat.com)
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version
9  * 2 of the License, or (at your option) any later version.
10  */
11
12 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
13
14 #include <linux/slab.h>
15 #include <linux/module.h>
16 #include <linux/circ_buf.h>
17 #include <linux/spinlock_types.h>
18 #include <net/sock.h>
19 #include <net/af_rxrpc.h>
20 #include "ar-internal.h"
21
22 /*
23  * Maximum lifetime of a call (in jiffies).
24  */
25 unsigned int rxrpc_max_call_lifetime = 60 * HZ;
26
27 const char *const rxrpc_call_states[NR__RXRPC_CALL_STATES] = {
28         [RXRPC_CALL_UNINITIALISED]              = "Uninit  ",
29         [RXRPC_CALL_CLIENT_AWAIT_CONN]          = "ClWtConn",
30         [RXRPC_CALL_CLIENT_SEND_REQUEST]        = "ClSndReq",
31         [RXRPC_CALL_CLIENT_AWAIT_REPLY]         = "ClAwtRpl",
32         [RXRPC_CALL_CLIENT_RECV_REPLY]          = "ClRcvRpl",
33         [RXRPC_CALL_SERVER_PREALLOC]            = "SvPrealc",
34         [RXRPC_CALL_SERVER_SECURING]            = "SvSecure",
35         [RXRPC_CALL_SERVER_ACCEPTING]           = "SvAccept",
36         [RXRPC_CALL_SERVER_RECV_REQUEST]        = "SvRcvReq",
37         [RXRPC_CALL_SERVER_ACK_REQUEST]         = "SvAckReq",
38         [RXRPC_CALL_SERVER_SEND_REPLY]          = "SvSndRpl",
39         [RXRPC_CALL_SERVER_AWAIT_ACK]           = "SvAwtACK",
40         [RXRPC_CALL_COMPLETE]                   = "Complete",
41 };
42
43 const char *const rxrpc_call_completions[NR__RXRPC_CALL_COMPLETIONS] = {
44         [RXRPC_CALL_SUCCEEDED]                  = "Complete",
45         [RXRPC_CALL_REMOTELY_ABORTED]           = "RmtAbort",
46         [RXRPC_CALL_LOCALLY_ABORTED]            = "LocAbort",
47         [RXRPC_CALL_LOCAL_ERROR]                = "LocError",
48         [RXRPC_CALL_NETWORK_ERROR]              = "NetError",
49 };
50
51 const char rxrpc_call_traces[rxrpc_call__nr_trace][4] = {
52         [rxrpc_call_new_client]         = "NWc",
53         [rxrpc_call_new_service]        = "NWs",
54         [rxrpc_call_queued]             = "QUE",
55         [rxrpc_call_queued_ref]         = "QUR",
56         [rxrpc_call_connected]          = "CON",
57         [rxrpc_call_release]            = "RLS",
58         [rxrpc_call_seen]               = "SEE",
59         [rxrpc_call_got]                = "GOT",
60         [rxrpc_call_got_userid]         = "Gus",
61         [rxrpc_call_got_kernel]         = "Gke",
62         [rxrpc_call_put]                = "PUT",
63         [rxrpc_call_put_userid]         = "Pus",
64         [rxrpc_call_put_kernel]         = "Pke",
65         [rxrpc_call_put_noqueue]        = "PNQ",
66         [rxrpc_call_error]              = "*E*",
67 };
68
69 struct kmem_cache *rxrpc_call_jar;
70 LIST_HEAD(rxrpc_calls);
71 DEFINE_RWLOCK(rxrpc_call_lock);
72
73 static void rxrpc_call_timer_expired(unsigned long _call)
74 {
75         struct rxrpc_call *call = (struct rxrpc_call *)_call;
76
77         _enter("%d", call->debug_id);
78
79         if (call->state < RXRPC_CALL_COMPLETE) {
80                 trace_rxrpc_timer(call, rxrpc_timer_expired, jiffies);
81                 rxrpc_queue_call(call);
82         }
83 }
84
85 /*
86  * find an extant server call
87  * - called in process context with IRQs enabled
88  */
89 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *rx,
90                                               unsigned long user_call_ID)
91 {
92         struct rxrpc_call *call;
93         struct rb_node *p;
94
95         _enter("%p,%lx", rx, user_call_ID);
96
97         read_lock(&rx->call_lock);
98
99         p = rx->calls.rb_node;
100         while (p) {
101                 call = rb_entry(p, struct rxrpc_call, sock_node);
102
103                 if (user_call_ID < call->user_call_ID)
104                         p = p->rb_left;
105                 else if (user_call_ID > call->user_call_ID)
106                         p = p->rb_right;
107                 else
108                         goto found_extant_call;
109         }
110
111         read_unlock(&rx->call_lock);
112         _leave(" = NULL");
113         return NULL;
114
115 found_extant_call:
116         rxrpc_get_call(call, rxrpc_call_got);
117         read_unlock(&rx->call_lock);
118         _leave(" = %p [%d]", call, atomic_read(&call->usage));
119         return call;
120 }
121
122 /*
123  * allocate a new call
124  */
125 struct rxrpc_call *rxrpc_alloc_call(gfp_t gfp)
126 {
127         struct rxrpc_call *call;
128
129         call = kmem_cache_zalloc(rxrpc_call_jar, gfp);
130         if (!call)
131                 return NULL;
132
133         call->rxtx_buffer = kcalloc(RXRPC_RXTX_BUFF_SIZE,
134                                     sizeof(struct sk_buff *),
135                                     gfp);
136         if (!call->rxtx_buffer)
137                 goto nomem;
138
139         call->rxtx_annotations = kcalloc(RXRPC_RXTX_BUFF_SIZE, sizeof(u8), gfp);
140         if (!call->rxtx_annotations)
141                 goto nomem_2;
142
143         setup_timer(&call->timer, rxrpc_call_timer_expired,
144                     (unsigned long)call);
145         INIT_WORK(&call->processor, &rxrpc_process_call);
146         INIT_LIST_HEAD(&call->link);
147         INIT_LIST_HEAD(&call->chan_wait_link);
148         INIT_LIST_HEAD(&call->accept_link);
149         INIT_LIST_HEAD(&call->recvmsg_link);
150         INIT_LIST_HEAD(&call->sock_link);
151         init_waitqueue_head(&call->waitq);
152         spin_lock_init(&call->lock);
153         rwlock_init(&call->state_lock);
154         atomic_set(&call->usage, 1);
155         call->debug_id = atomic_inc_return(&rxrpc_debug_id);
156
157         memset(&call->sock_node, 0xed, sizeof(call->sock_node));
158
159         /* Leave space in the ring to handle a maxed-out jumbo packet */
160         call->rx_winsize = rxrpc_rx_window_size;
161         call->tx_winsize = 16;
162         call->rx_expect_next = 1;
163
164         if (RXRPC_TX_SMSS > 2190)
165                 call->cong_cwnd = 2;
166         else if (RXRPC_TX_SMSS > 1095)
167                 call->cong_cwnd = 3;
168         else
169                 call->cong_cwnd = 4;
170         call->cong_ssthresh = RXRPC_RXTX_BUFF_SIZE - 1;
171         return call;
172
173 nomem_2:
174         kfree(call->rxtx_buffer);
175 nomem:
176         kmem_cache_free(rxrpc_call_jar, call);
177         return NULL;
178 }
179
180 /*
181  * Allocate a new client call.
182  */
183 static struct rxrpc_call *rxrpc_alloc_client_call(struct sockaddr_rxrpc *srx,
184                                                   gfp_t gfp)
185 {
186         struct rxrpc_call *call;
187         ktime_t now;
188
189         _enter("");
190
191         call = rxrpc_alloc_call(gfp);
192         if (!call)
193                 return ERR_PTR(-ENOMEM);
194         call->state = RXRPC_CALL_CLIENT_AWAIT_CONN;
195         call->service_id = srx->srx_service;
196         call->tx_phase = true;
197         now = ktime_get_real();
198         call->acks_latest_ts = now;
199         call->cong_tstamp = now;
200
201         _leave(" = %p", call);
202         return call;
203 }
204
205 /*
206  * Initiate the call ack/resend/expiry timer.
207  */
208 static void rxrpc_start_call_timer(struct rxrpc_call *call)
209 {
210         unsigned long expire_at;
211
212         expire_at = jiffies + rxrpc_max_call_lifetime;
213         call->expire_at = expire_at;
214         call->ack_at = expire_at;
215         call->resend_at = expire_at;
216         call->timer.expires = expire_at + 1;
217         rxrpc_set_timer(call, rxrpc_timer_begin);
218 }
219
220 /*
221  * set up a call for the given data
222  * - called in process context with IRQs enabled
223  */
224 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *rx,
225                                          struct rxrpc_conn_parameters *cp,
226                                          struct sockaddr_rxrpc *srx,
227                                          unsigned long user_call_ID,
228                                          gfp_t gfp)
229 {
230         struct rxrpc_call *call, *xcall;
231         struct rb_node *parent, **pp;
232         const void *here = __builtin_return_address(0);
233         int ret;
234
235         _enter("%p,%lx", rx, user_call_ID);
236
237         call = rxrpc_alloc_client_call(srx, gfp);
238         if (IS_ERR(call)) {
239                 _leave(" = %ld", PTR_ERR(call));
240                 return call;
241         }
242
243         trace_rxrpc_call(call, rxrpc_call_new_client, atomic_read(&call->usage),
244                          here, (const void *)user_call_ID);
245
246         /* Publish the call, even though it is incompletely set up as yet */
247         write_lock(&rx->call_lock);
248
249         pp = &rx->calls.rb_node;
250         parent = NULL;
251         while (*pp) {
252                 parent = *pp;
253                 xcall = rb_entry(parent, struct rxrpc_call, sock_node);
254
255                 if (user_call_ID < xcall->user_call_ID)
256                         pp = &(*pp)->rb_left;
257                 else if (user_call_ID > xcall->user_call_ID)
258                         pp = &(*pp)->rb_right;
259                 else
260                         goto error_dup_user_ID;
261         }
262
263         rcu_assign_pointer(call->socket, rx);
264         call->user_call_ID = user_call_ID;
265         __set_bit(RXRPC_CALL_HAS_USERID, &call->flags);
266         rxrpc_get_call(call, rxrpc_call_got_userid);
267         rb_link_node(&call->sock_node, parent, pp);
268         rb_insert_color(&call->sock_node, &rx->calls);
269         list_add(&call->sock_link, &rx->sock_calls);
270
271         write_unlock(&rx->call_lock);
272
273         write_lock(&rxrpc_call_lock);
274         list_add_tail(&call->link, &rxrpc_calls);
275         write_unlock(&rxrpc_call_lock);
276
277         /* Set up or get a connection record and set the protocol parameters,
278          * including channel number and call ID.
279          */
280         ret = rxrpc_connect_call(call, cp, srx, gfp);
281         if (ret < 0)
282                 goto error;
283
284         trace_rxrpc_call(call, rxrpc_call_connected, atomic_read(&call->usage),
285                          here, ERR_PTR(ret));
286
287         spin_lock_bh(&call->conn->params.peer->lock);
288         hlist_add_head(&call->error_link,
289                        &call->conn->params.peer->error_targets);
290         spin_unlock_bh(&call->conn->params.peer->lock);
291
292         rxrpc_start_call_timer(call);
293
294         _net("CALL new %d on CONN %d", call->debug_id, call->conn->debug_id);
295
296         _leave(" = %p [new]", call);
297         return call;
298
299         /* We unexpectedly found the user ID in the list after taking
300          * the call_lock.  This shouldn't happen unless the user races
301          * with itself and tries to add the same user ID twice at the
302          * same time in different threads.
303          */
304 error_dup_user_ID:
305         write_unlock(&rx->call_lock);
306         ret = -EEXIST;
307
308 error:
309         __rxrpc_set_call_completion(call, RXRPC_CALL_LOCAL_ERROR,
310                                     RX_CALL_DEAD, ret);
311         trace_rxrpc_call(call, rxrpc_call_error, atomic_read(&call->usage),
312                          here, ERR_PTR(ret));
313         rxrpc_release_call(rx, call);
314         rxrpc_put_call(call, rxrpc_call_put);
315         _leave(" = %d", ret);
316         return ERR_PTR(ret);
317 }
318
319 /*
320  * Set up an incoming call.  call->conn points to the connection.
321  * This is called in BH context and isn't allowed to fail.
322  */
323 void rxrpc_incoming_call(struct rxrpc_sock *rx,
324                          struct rxrpc_call *call,
325                          struct sk_buff *skb)
326 {
327         struct rxrpc_connection *conn = call->conn;
328         struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
329         u32 chan;
330
331         _enter(",%d", call->conn->debug_id);
332
333         rcu_assign_pointer(call->socket, rx);
334         call->call_id           = sp->hdr.callNumber;
335         call->service_id        = sp->hdr.serviceId;
336         call->cid               = sp->hdr.cid;
337         call->state             = RXRPC_CALL_SERVER_ACCEPTING;
338         if (sp->hdr.securityIndex > 0)
339                 call->state     = RXRPC_CALL_SERVER_SECURING;
340         call->cong_tstamp       = skb->tstamp;
341
342         /* Set the channel for this call.  We don't get channel_lock as we're
343          * only defending against the data_ready handler (which we're called
344          * from) and the RESPONSE packet parser (which is only really
345          * interested in call_counter and can cope with a disagreement with the
346          * call pointer).
347          */
348         chan = sp->hdr.cid & RXRPC_CHANNELMASK;
349         conn->channels[chan].call_counter = call->call_id;
350         conn->channels[chan].call_id = call->call_id;
351         rcu_assign_pointer(conn->channels[chan].call, call);
352
353         spin_lock(&conn->params.peer->lock);
354         hlist_add_head(&call->error_link, &conn->params.peer->error_targets);
355         spin_unlock(&conn->params.peer->lock);
356
357         _net("CALL incoming %d on CONN %d", call->debug_id, call->conn->debug_id);
358
359         rxrpc_start_call_timer(call);
360         _leave("");
361 }
362
363 /*
364  * Queue a call's work processor, getting a ref to pass to the work queue.
365  */
366 bool rxrpc_queue_call(struct rxrpc_call *call)
367 {
368         const void *here = __builtin_return_address(0);
369         int n = __atomic_add_unless(&call->usage, 1, 0);
370         if (n == 0)
371                 return false;
372         if (rxrpc_queue_work(&call->processor))
373                 trace_rxrpc_call(call, rxrpc_call_queued, n + 1, here, NULL);
374         else
375                 rxrpc_put_call(call, rxrpc_call_put_noqueue);
376         return true;
377 }
378
379 /*
380  * Queue a call's work processor, passing the callers ref to the work queue.
381  */
382 bool __rxrpc_queue_call(struct rxrpc_call *call)
383 {
384         const void *here = __builtin_return_address(0);
385         int n = atomic_read(&call->usage);
386         ASSERTCMP(n, >=, 1);
387         if (rxrpc_queue_work(&call->processor))
388                 trace_rxrpc_call(call, rxrpc_call_queued_ref, n, here, NULL);
389         else
390                 rxrpc_put_call(call, rxrpc_call_put_noqueue);
391         return true;
392 }
393
394 /*
395  * Note the re-emergence of a call.
396  */
397 void rxrpc_see_call(struct rxrpc_call *call)
398 {
399         const void *here = __builtin_return_address(0);
400         if (call) {
401                 int n = atomic_read(&call->usage);
402
403                 trace_rxrpc_call(call, rxrpc_call_seen, n, here, NULL);
404         }
405 }
406
407 /*
408  * Note the addition of a ref on a call.
409  */
410 void rxrpc_get_call(struct rxrpc_call *call, enum rxrpc_call_trace op)
411 {
412         const void *here = __builtin_return_address(0);
413         int n = atomic_inc_return(&call->usage);
414
415         trace_rxrpc_call(call, op, n, here, NULL);
416 }
417
418 /*
419  * Detach a call from its owning socket.
420  */
421 void rxrpc_release_call(struct rxrpc_sock *rx, struct rxrpc_call *call)
422 {
423         const void *here = __builtin_return_address(0);
424         struct rxrpc_connection *conn = call->conn;
425         bool put = false;
426         int i;
427
428         _enter("{%d,%d}", call->debug_id, atomic_read(&call->usage));
429
430         trace_rxrpc_call(call, rxrpc_call_release, atomic_read(&call->usage),
431                          here, (const void *)call->flags);
432
433         ASSERTCMP(call->state, ==, RXRPC_CALL_COMPLETE);
434
435         spin_lock_bh(&call->lock);
436         if (test_and_set_bit(RXRPC_CALL_RELEASED, &call->flags))
437                 BUG();
438         spin_unlock_bh(&call->lock);
439
440         del_timer_sync(&call->timer);
441
442         /* Make sure we don't get any more notifications */
443         write_lock_bh(&rx->recvmsg_lock);
444
445         if (!list_empty(&call->recvmsg_link)) {
446                 _debug("unlinking once-pending call %p { e=%lx f=%lx }",
447                        call, call->events, call->flags);
448                 list_del(&call->recvmsg_link);
449                 put = true;
450         }
451
452         /* list_empty() must return false in rxrpc_notify_socket() */
453         call->recvmsg_link.next = NULL;
454         call->recvmsg_link.prev = NULL;
455
456         write_unlock_bh(&rx->recvmsg_lock);
457         if (put)
458                 rxrpc_put_call(call, rxrpc_call_put);
459
460         write_lock(&rx->call_lock);
461
462         if (test_and_clear_bit(RXRPC_CALL_HAS_USERID, &call->flags)) {
463                 rb_erase(&call->sock_node, &rx->calls);
464                 memset(&call->sock_node, 0xdd, sizeof(call->sock_node));
465                 rxrpc_put_call(call, rxrpc_call_put_userid);
466         }
467
468         list_del(&call->sock_link);
469         write_unlock(&rx->call_lock);
470
471         _debug("RELEASE CALL %p (%d CONN %p)", call, call->debug_id, conn);
472
473         if (conn)
474                 rxrpc_disconnect_call(call);
475
476         for (i = 0; i < RXRPC_RXTX_BUFF_SIZE; i++) {
477                 rxrpc_free_skb(call->rxtx_buffer[i],
478                                (call->tx_phase ? rxrpc_skb_tx_cleaned :
479                                 rxrpc_skb_rx_cleaned));
480                 call->rxtx_buffer[i] = NULL;
481         }
482
483         _leave("");
484 }
485
486 /*
487  * release all the calls associated with a socket
488  */
489 void rxrpc_release_calls_on_socket(struct rxrpc_sock *rx)
490 {
491         struct rxrpc_call *call;
492
493         _enter("%p", rx);
494
495         while (!list_empty(&rx->to_be_accepted)) {
496                 call = list_entry(rx->to_be_accepted.next,
497                                   struct rxrpc_call, accept_link);
498                 list_del(&call->accept_link);
499                 rxrpc_abort_call("SKR", call, 0, RX_CALL_DEAD, ECONNRESET);
500                 rxrpc_put_call(call, rxrpc_call_put);
501         }
502
503         while (!list_empty(&rx->sock_calls)) {
504                 call = list_entry(rx->sock_calls.next,
505                                   struct rxrpc_call, sock_link);
506                 rxrpc_get_call(call, rxrpc_call_got);
507                 rxrpc_abort_call("SKT", call, 0, RX_CALL_DEAD, ECONNRESET);
508                 rxrpc_send_call_packet(call, RXRPC_PACKET_TYPE_ABORT);
509                 rxrpc_release_call(rx, call);
510                 rxrpc_put_call(call, rxrpc_call_put);
511         }
512
513         _leave("");
514 }
515
516 /*
517  * release a call
518  */
519 void rxrpc_put_call(struct rxrpc_call *call, enum rxrpc_call_trace op)
520 {
521         const void *here = __builtin_return_address(0);
522         int n;
523
524         ASSERT(call != NULL);
525
526         n = atomic_dec_return(&call->usage);
527         trace_rxrpc_call(call, op, n, here, NULL);
528         ASSERTCMP(n, >=, 0);
529         if (n == 0) {
530                 _debug("call %d dead", call->debug_id);
531                 ASSERTCMP(call->state, ==, RXRPC_CALL_COMPLETE);
532
533                 write_lock(&rxrpc_call_lock);
534                 list_del_init(&call->link);
535                 write_unlock(&rxrpc_call_lock);
536
537                 rxrpc_cleanup_call(call);
538         }
539 }
540
541 /*
542  * Final call destruction under RCU.
543  */
544 static void rxrpc_rcu_destroy_call(struct rcu_head *rcu)
545 {
546         struct rxrpc_call *call = container_of(rcu, struct rxrpc_call, rcu);
547
548         rxrpc_put_peer(call->peer);
549         kfree(call->rxtx_buffer);
550         kfree(call->rxtx_annotations);
551         kmem_cache_free(rxrpc_call_jar, call);
552 }
553
554 /*
555  * clean up a call
556  */
557 void rxrpc_cleanup_call(struct rxrpc_call *call)
558 {
559         int i;
560
561         _net("DESTROY CALL %d", call->debug_id);
562
563         memset(&call->sock_node, 0xcd, sizeof(call->sock_node));
564
565         del_timer_sync(&call->timer);
566
567         ASSERTCMP(call->state, ==, RXRPC_CALL_COMPLETE);
568         ASSERT(test_bit(RXRPC_CALL_RELEASED, &call->flags));
569         ASSERTCMP(call->conn, ==, NULL);
570
571         /* Clean up the Rx/Tx buffer */
572         for (i = 0; i < RXRPC_RXTX_BUFF_SIZE; i++)
573                 rxrpc_free_skb(call->rxtx_buffer[i],
574                                (call->tx_phase ? rxrpc_skb_tx_cleaned :
575                                 rxrpc_skb_rx_cleaned));
576
577         rxrpc_free_skb(call->tx_pending, rxrpc_skb_tx_cleaned);
578
579         call_rcu(&call->rcu, rxrpc_rcu_destroy_call);
580 }
581
582 /*
583  * Make sure that all calls are gone.
584  */
585 void __exit rxrpc_destroy_all_calls(void)
586 {
587         struct rxrpc_call *call;
588
589         _enter("");
590
591         if (list_empty(&rxrpc_calls))
592                 return;
593
594         write_lock(&rxrpc_call_lock);
595
596         while (!list_empty(&rxrpc_calls)) {
597                 call = list_entry(rxrpc_calls.next, struct rxrpc_call, link);
598                 _debug("Zapping call %p", call);
599
600                 rxrpc_see_call(call);
601                 list_del_init(&call->link);
602
603                 pr_err("Call %p still in use (%d,%s,%lx,%lx)!\n",
604                        call, atomic_read(&call->usage),
605                        rxrpc_call_states[call->state],
606                        call->flags, call->events);
607
608                 write_unlock(&rxrpc_call_lock);
609                 cond_resched();
610                 write_lock(&rxrpc_call_lock);
611         }
612
613         write_unlock(&rxrpc_call_lock);
614 }