Merge branch 'timers-fixes-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-2.6] / net / dccp / options.c
1 /*
2  *  net/dccp/options.c
3  *
4  *  An implementation of the DCCP protocol
5  *  Copyright (c) 2005 Aristeu Sergio Rozanski Filho <aris@cathedrallabs.org>
6  *  Copyright (c) 2005 Arnaldo Carvalho de Melo <acme@ghostprotocols.net>
7  *  Copyright (c) 2005 Ian McDonald <ian.mcdonald@jandi.co.nz>
8  *
9  *      This program is free software; you can redistribute it and/or
10  *      modify it under the terms of the GNU General Public License
11  *      as published by the Free Software Foundation; either version
12  *      2 of the License, or (at your option) any later version.
13  */
14 #include <linux/dccp.h>
15 #include <linux/module.h>
16 #include <linux/types.h>
17 #include <asm/unaligned.h>
18 #include <linux/kernel.h>
19 #include <linux/skbuff.h>
20
21 #include "ackvec.h"
22 #include "ccid.h"
23 #include "dccp.h"
24 #include "feat.h"
25
26 int sysctl_dccp_feat_sequence_window = DCCPF_INITIAL_SEQUENCE_WINDOW;
27 int sysctl_dccp_feat_rx_ccid          = DCCPF_INITIAL_CCID;
28 int sysctl_dccp_feat_tx_ccid          = DCCPF_INITIAL_CCID;
29 int sysctl_dccp_feat_ack_ratio        = DCCPF_INITIAL_ACK_RATIO;
30 int sysctl_dccp_feat_send_ack_vector = DCCPF_INITIAL_SEND_ACK_VECTOR;
31 int sysctl_dccp_feat_send_ndp_count  = DCCPF_INITIAL_SEND_NDP_COUNT;
32
33 static u32 dccp_decode_value_var(const unsigned char *bf, const u8 len)
34 {
35         u32 value = 0;
36
37         if (len > 3)
38                 value += *bf++ << 24;
39         if (len > 2)
40                 value += *bf++ << 16;
41         if (len > 1)
42                 value += *bf++ << 8;
43         if (len > 0)
44                 value += *bf;
45
46         return value;
47 }
48
49 /**
50  * dccp_parse_options  -  Parse DCCP options present in @skb
51  * @sk: client|server|listening dccp socket (when @dreq != NULL)
52  * @dreq: request socket to use during connection setup, or NULL
53  */
54 int dccp_parse_options(struct sock *sk, struct dccp_request_sock *dreq,
55                        struct sk_buff *skb)
56 {
57         struct dccp_sock *dp = dccp_sk(sk);
58         const struct dccp_hdr *dh = dccp_hdr(skb);
59         const u8 pkt_type = DCCP_SKB_CB(skb)->dccpd_type;
60         u64 ackno = DCCP_SKB_CB(skb)->dccpd_ack_seq;
61         unsigned char *options = (unsigned char *)dh + dccp_hdr_len(skb);
62         unsigned char *opt_ptr = options;
63         const unsigned char *opt_end = (unsigned char *)dh +
64                                         (dh->dccph_doff * 4);
65         struct dccp_options_received *opt_recv = &dp->dccps_options_received;
66         unsigned char opt, len;
67         unsigned char *value;
68         u32 elapsed_time;
69         __be32 opt_val;
70         int rc;
71         int mandatory = 0;
72
73         memset(opt_recv, 0, sizeof(*opt_recv));
74
75         opt = len = 0;
76         while (opt_ptr != opt_end) {
77                 opt   = *opt_ptr++;
78                 len   = 0;
79                 value = NULL;
80
81                 /* Check if this isn't a single byte option */
82                 if (opt > DCCPO_MAX_RESERVED) {
83                         if (opt_ptr == opt_end)
84                                 goto out_invalid_option;
85
86                         len = *opt_ptr++;
87                         if (len < 3)
88                                 goto out_invalid_option;
89                         /*
90                          * Remove the type and len fields, leaving
91                          * just the value size
92                          */
93                         len     -= 2;
94                         value   = opt_ptr;
95                         opt_ptr += len;
96
97                         if (opt_ptr > opt_end)
98                                 goto out_invalid_option;
99                 }
100
101                 /*
102                  * CCID-Specific Options (from RFC 4340, sec. 10.3):
103                  *
104                  * Option numbers 128 through 191 are for options sent from the
105                  * HC-Sender to the HC-Receiver; option numbers 192 through 255
106                  * are for options sent from the HC-Receiver to the HC-Sender.
107                  *
108                  * CCID-specific options are ignored during connection setup, as
109                  * negotiation may still be in progress (see RFC 4340, 10.3).
110                  * The same applies to Ack Vectors, as these depend on the CCID.
111                  *
112                  */
113                 if (dreq != NULL && (opt >= 128 ||
114                     opt == DCCPO_ACK_VECTOR_0 || opt == DCCPO_ACK_VECTOR_1))
115                         goto ignore_option;
116
117                 switch (opt) {
118                 case DCCPO_PADDING:
119                         break;
120                 case DCCPO_MANDATORY:
121                         if (mandatory)
122                                 goto out_invalid_option;
123                         if (pkt_type != DCCP_PKT_DATA)
124                                 mandatory = 1;
125                         break;
126                 case DCCPO_NDP_COUNT:
127                         if (len > 6)
128                                 goto out_invalid_option;
129
130                         opt_recv->dccpor_ndp = dccp_decode_value_var(value, len);
131                         dccp_pr_debug("%s opt: NDP count=%llu\n", dccp_role(sk),
132                                       (unsigned long long)opt_recv->dccpor_ndp);
133                         break;
134                 case DCCPO_CHANGE_L:
135                         /* fall through */
136                 case DCCPO_CHANGE_R:
137                         if (pkt_type == DCCP_PKT_DATA)
138                                 break;
139                         if (len < 2)
140                                 goto out_invalid_option;
141                         rc = dccp_feat_change_recv(sk, opt, *value, value + 1,
142                                                    len - 1);
143                         /*
144                          * When there is a change error, change_recv is
145                          * responsible for dealing with it.  i.e. reply with an
146                          * empty confirm.
147                          * If the change was mandatory, then we need to die.
148                          */
149                         if (rc && mandatory)
150                                 goto out_invalid_option;
151                         break;
152                 case DCCPO_CONFIRM_L:
153                         /* fall through */
154                 case DCCPO_CONFIRM_R:
155                         if (pkt_type == DCCP_PKT_DATA)
156                                 break;
157                         if (len < 2)    /* FIXME this disallows empty confirm */
158                                 goto out_invalid_option;
159                         if (dccp_feat_confirm_recv(sk, opt, *value,
160                                                    value + 1, len - 1))
161                                 goto out_invalid_option;
162                         break;
163                 case DCCPO_ACK_VECTOR_0:
164                 case DCCPO_ACK_VECTOR_1:
165                         if (dccp_packet_without_ack(skb))   /* RFC 4340, 11.4 */
166                                 break;
167
168                         if (dccp_msk(sk)->dccpms_send_ack_vector &&
169                             dccp_ackvec_parse(sk, skb, &ackno, opt, value, len))
170                                 goto out_invalid_option;
171                         break;
172                 case DCCPO_TIMESTAMP:
173                         if (len != 4)
174                                 goto out_invalid_option;
175                         /*
176                          * RFC 4340 13.1: "The precise time corresponding to
177                          * Timestamp Value zero is not specified". We use
178                          * zero to indicate absence of a meaningful timestamp.
179                          */
180                         opt_val = get_unaligned((__be32 *)value);
181                         if (unlikely(opt_val == 0)) {
182                                 DCCP_WARN("Timestamp with zero value\n");
183                                 break;
184                         }
185
186                         if (dreq != NULL) {
187                                 dreq->dreq_timestamp_echo = ntohl(opt_val);
188                                 dreq->dreq_timestamp_time = dccp_timestamp();
189                         } else {
190                                 opt_recv->dccpor_timestamp =
191                                         dp->dccps_timestamp_echo = ntohl(opt_val);
192                                 dp->dccps_timestamp_time = dccp_timestamp();
193                         }
194                         dccp_pr_debug("%s rx opt: TIMESTAMP=%u, ackno=%llu\n",
195                                       dccp_role(sk), ntohl(opt_val),
196                                       (unsigned long long)
197                                       DCCP_SKB_CB(skb)->dccpd_ack_seq);
198                         break;
199                 case DCCPO_TIMESTAMP_ECHO:
200                         if (len != 4 && len != 6 && len != 8)
201                                 goto out_invalid_option;
202
203                         opt_val = get_unaligned((__be32 *)value);
204                         opt_recv->dccpor_timestamp_echo = ntohl(opt_val);
205
206                         dccp_pr_debug("%s rx opt: TIMESTAMP_ECHO=%u, len=%d, "
207                                       "ackno=%llu", dccp_role(sk),
208                                       opt_recv->dccpor_timestamp_echo,
209                                       len + 2,
210                                       (unsigned long long)
211                                       DCCP_SKB_CB(skb)->dccpd_ack_seq);
212
213                         value += 4;
214
215                         if (len == 4) {         /* no elapsed time included */
216                                 dccp_pr_debug_cat("\n");
217                                 break;
218                         }
219
220                         if (len == 6) {         /* 2-byte elapsed time */
221                                 __be16 opt_val2 = get_unaligned((__be16 *)value);
222                                 elapsed_time = ntohs(opt_val2);
223                         } else {                /* 4-byte elapsed time */
224                                 opt_val = get_unaligned((__be32 *)value);
225                                 elapsed_time = ntohl(opt_val);
226                         }
227
228                         dccp_pr_debug_cat(", ELAPSED_TIME=%u\n", elapsed_time);
229
230                         /* Give precedence to the biggest ELAPSED_TIME */
231                         if (elapsed_time > opt_recv->dccpor_elapsed_time)
232                                 opt_recv->dccpor_elapsed_time = elapsed_time;
233                         break;
234                 case DCCPO_ELAPSED_TIME:
235                         if (dccp_packet_without_ack(skb))   /* RFC 4340, 13.2 */
236                                 break;
237
238                         if (len == 2) {
239                                 __be16 opt_val2 = get_unaligned((__be16 *)value);
240                                 elapsed_time = ntohs(opt_val2);
241                         } else if (len == 4) {
242                                 opt_val = get_unaligned((__be32 *)value);
243                                 elapsed_time = ntohl(opt_val);
244                         } else {
245                                 goto out_invalid_option;
246                         }
247
248                         if (elapsed_time > opt_recv->dccpor_elapsed_time)
249                                 opt_recv->dccpor_elapsed_time = elapsed_time;
250
251                         dccp_pr_debug("%s rx opt: ELAPSED_TIME=%d\n",
252                                       dccp_role(sk), elapsed_time);
253                         break;
254                 case 128 ... 191: {
255                         const u16 idx = value - options;
256
257                         if (ccid_hc_rx_parse_options(dp->dccps_hc_rx_ccid, sk,
258                                                      opt, len, idx,
259                                                      value) != 0)
260                                 goto out_invalid_option;
261                 }
262                         break;
263                 case 192 ... 255: {
264                         const u16 idx = value - options;
265
266                         if (ccid_hc_tx_parse_options(dp->dccps_hc_tx_ccid, sk,
267                                                      opt, len, idx,
268                                                      value) != 0)
269                                 goto out_invalid_option;
270                 }
271                         break;
272                 default:
273                         DCCP_CRIT("DCCP(%p): option %d(len=%d) not "
274                                   "implemented, ignoring", sk, opt, len);
275                         break;
276                 }
277 ignore_option:
278                 if (opt != DCCPO_MANDATORY)
279                         mandatory = 0;
280         }
281
282         /* mandatory was the last byte in option list -> reset connection */
283         if (mandatory)
284                 goto out_invalid_option;
285
286         return 0;
287
288 out_invalid_option:
289         DCCP_INC_STATS_BH(DCCP_MIB_INVALIDOPT);
290         DCCP_SKB_CB(skb)->dccpd_reset_code = DCCP_RESET_CODE_OPTION_ERROR;
291         DCCP_WARN("DCCP(%p): invalid option %d, len=%d", sk, opt, len);
292         return -1;
293 }
294
295 EXPORT_SYMBOL_GPL(dccp_parse_options);
296
297 static void dccp_encode_value_var(const u32 value, unsigned char *to,
298                                   const unsigned int len)
299 {
300         if (len > 3)
301                 *to++ = (value & 0xFF000000) >> 24;
302         if (len > 2)
303                 *to++ = (value & 0xFF0000) >> 16;
304         if (len > 1)
305                 *to++ = (value & 0xFF00) >> 8;
306         if (len > 0)
307                 *to++ = (value & 0xFF);
308 }
309
310 static inline u8 dccp_ndp_len(const u64 ndp)
311 {
312         if (likely(ndp <= 0xFF))
313                 return 1;
314         return likely(ndp <= USHORT_MAX) ? 2 : (ndp <= UINT_MAX ? 4 : 6);
315 }
316
317 int dccp_insert_option(struct sock *sk, struct sk_buff *skb,
318                         const unsigned char option,
319                         const void *value, const unsigned char len)
320 {
321         unsigned char *to;
322
323         if (DCCP_SKB_CB(skb)->dccpd_opt_len + len + 2 > DCCP_MAX_OPT_LEN)
324                 return -1;
325
326         DCCP_SKB_CB(skb)->dccpd_opt_len += len + 2;
327
328         to    = skb_push(skb, len + 2);
329         *to++ = option;
330         *to++ = len + 2;
331
332         memcpy(to, value, len);
333         return 0;
334 }
335
336 EXPORT_SYMBOL_GPL(dccp_insert_option);
337
338 static int dccp_insert_option_ndp(struct sock *sk, struct sk_buff *skb)
339 {
340         struct dccp_sock *dp = dccp_sk(sk);
341         u64 ndp = dp->dccps_ndp_count;
342
343         if (dccp_non_data_packet(skb))
344                 ++dp->dccps_ndp_count;
345         else
346                 dp->dccps_ndp_count = 0;
347
348         if (ndp > 0) {
349                 unsigned char *ptr;
350                 const int ndp_len = dccp_ndp_len(ndp);
351                 const int len = ndp_len + 2;
352
353                 if (DCCP_SKB_CB(skb)->dccpd_opt_len + len > DCCP_MAX_OPT_LEN)
354                         return -1;
355
356                 DCCP_SKB_CB(skb)->dccpd_opt_len += len;
357
358                 ptr = skb_push(skb, len);
359                 *ptr++ = DCCPO_NDP_COUNT;
360                 *ptr++ = len;
361                 dccp_encode_value_var(ndp, ptr, ndp_len);
362         }
363
364         return 0;
365 }
366
367 static inline int dccp_elapsed_time_len(const u32 elapsed_time)
368 {
369         return elapsed_time == 0 ? 0 : elapsed_time <= 0xFFFF ? 2 : 4;
370 }
371
372 int dccp_insert_option_elapsed_time(struct sock *sk, struct sk_buff *skb,
373                                     u32 elapsed_time)
374 {
375         const int elapsed_time_len = dccp_elapsed_time_len(elapsed_time);
376         const int len = 2 + elapsed_time_len;
377         unsigned char *to;
378
379         if (elapsed_time_len == 0)
380                 return 0;
381
382         if (DCCP_SKB_CB(skb)->dccpd_opt_len + len > DCCP_MAX_OPT_LEN)
383                 return -1;
384
385         DCCP_SKB_CB(skb)->dccpd_opt_len += len;
386
387         to    = skb_push(skb, len);
388         *to++ = DCCPO_ELAPSED_TIME;
389         *to++ = len;
390
391         if (elapsed_time_len == 2) {
392                 const __be16 var16 = htons((u16)elapsed_time);
393                 memcpy(to, &var16, 2);
394         } else {
395                 const __be32 var32 = htonl(elapsed_time);
396                 memcpy(to, &var32, 4);
397         }
398
399         return 0;
400 }
401
402 EXPORT_SYMBOL_GPL(dccp_insert_option_elapsed_time);
403
404 int dccp_insert_option_timestamp(struct sock *sk, struct sk_buff *skb)
405 {
406         __be32 now = htonl(dccp_timestamp());
407         /* yes this will overflow but that is the point as we want a
408          * 10 usec 32 bit timer which mean it wraps every 11.9 hours */
409
410         return dccp_insert_option(sk, skb, DCCPO_TIMESTAMP, &now, sizeof(now));
411 }
412
413 EXPORT_SYMBOL_GPL(dccp_insert_option_timestamp);
414
415 static int dccp_insert_option_timestamp_echo(struct dccp_sock *dp,
416                                              struct dccp_request_sock *dreq,
417                                              struct sk_buff *skb)
418 {
419         __be32 tstamp_echo;
420         unsigned char *to;
421         u32 elapsed_time, elapsed_time_len, len;
422
423         if (dreq != NULL) {
424                 elapsed_time = dccp_timestamp() - dreq->dreq_timestamp_time;
425                 tstamp_echo  = htonl(dreq->dreq_timestamp_echo);
426                 dreq->dreq_timestamp_echo = 0;
427         } else {
428                 elapsed_time = dccp_timestamp() - dp->dccps_timestamp_time;
429                 tstamp_echo  = htonl(dp->dccps_timestamp_echo);
430                 dp->dccps_timestamp_echo = 0;
431         }
432
433         elapsed_time_len = dccp_elapsed_time_len(elapsed_time);
434         len = 6 + elapsed_time_len;
435
436         if (DCCP_SKB_CB(skb)->dccpd_opt_len + len > DCCP_MAX_OPT_LEN)
437                 return -1;
438
439         DCCP_SKB_CB(skb)->dccpd_opt_len += len;
440
441         to    = skb_push(skb, len);
442         *to++ = DCCPO_TIMESTAMP_ECHO;
443         *to++ = len;
444
445         memcpy(to, &tstamp_echo, 4);
446         to += 4;
447
448         if (elapsed_time_len == 2) {
449                 const __be16 var16 = htons((u16)elapsed_time);
450                 memcpy(to, &var16, 2);
451         } else if (elapsed_time_len == 4) {
452                 const __be32 var32 = htonl(elapsed_time);
453                 memcpy(to, &var32, 4);
454         }
455
456         return 0;
457 }
458
459 static int dccp_insert_feat_opt(struct sk_buff *skb, u8 type, u8 feat,
460                                 u8 *val, u8 len)
461 {
462         u8 *to;
463
464         if (DCCP_SKB_CB(skb)->dccpd_opt_len + len + 3 > DCCP_MAX_OPT_LEN) {
465                 DCCP_WARN("packet too small for feature %d option!\n", feat);
466                 return -1;
467         }
468
469         DCCP_SKB_CB(skb)->dccpd_opt_len += len + 3;
470
471         to    = skb_push(skb, len + 3);
472         *to++ = type;
473         *to++ = len + 3;
474         *to++ = feat;
475
476         if (len)
477                 memcpy(to, val, len);
478
479         dccp_pr_debug("%s(%s (%d), ...), length %d\n",
480                       dccp_feat_typename(type),
481                       dccp_feat_name(feat), feat, len);
482         return 0;
483 }
484
485 static int dccp_insert_options_feat(struct sock *sk, struct sk_buff *skb)
486 {
487         struct dccp_sock *dp = dccp_sk(sk);
488         struct dccp_minisock *dmsk = dccp_msk(sk);
489         struct dccp_opt_pend *opt, *next;
490         int change = 0;
491
492         /* confirm any options [NN opts] */
493         list_for_each_entry_safe(opt, next, &dmsk->dccpms_conf, dccpop_node) {
494                 dccp_insert_feat_opt(skb, opt->dccpop_type,
495                                      opt->dccpop_feat, opt->dccpop_val,
496                                      opt->dccpop_len);
497                 /* fear empty confirms */
498                 if (opt->dccpop_val)
499                         kfree(opt->dccpop_val);
500                 kfree(opt);
501         }
502         INIT_LIST_HEAD(&dmsk->dccpms_conf);
503
504         /* see which features we need to send */
505         list_for_each_entry(opt, &dmsk->dccpms_pending, dccpop_node) {
506                 /* see if we need to send any confirm */
507                 if (opt->dccpop_sc) {
508                         dccp_insert_feat_opt(skb, opt->dccpop_type + 1,
509                                              opt->dccpop_feat,
510                                              opt->dccpop_sc->dccpoc_val,
511                                              opt->dccpop_sc->dccpoc_len);
512
513                         BUG_ON(!opt->dccpop_sc->dccpoc_val);
514                         kfree(opt->dccpop_sc->dccpoc_val);
515                         kfree(opt->dccpop_sc);
516                         opt->dccpop_sc = NULL;
517                 }
518
519                 /* any option not confirmed, re-send it */
520                 if (!opt->dccpop_conf) {
521                         dccp_insert_feat_opt(skb, opt->dccpop_type,
522                                              opt->dccpop_feat, opt->dccpop_val,
523                                              opt->dccpop_len);
524                         change++;
525                 }
526         }
527
528         /* Retransmit timer.
529          * If this is the master listening sock, we don't set a timer on it.  It
530          * should be fine because if the dude doesn't receive our RESPONSE
531          * [which will contain the CHANGE] he will send another REQUEST which
532          * will "retrnasmit" the change.
533          */
534         if (change && dp->dccps_role != DCCP_ROLE_LISTEN) {
535                 dccp_pr_debug("reset feat negotiation timer %p\n", sk);
536
537                 /* XXX don't reset the timer on re-transmissions.  I.e. reset it
538                  * only when sending new stuff i guess.  Currently the timer
539                  * never backs off because on re-transmission it just resets it!
540                  */
541                 inet_csk_reset_xmit_timer(sk, ICSK_TIME_RETRANS,
542                                           inet_csk(sk)->icsk_rto, DCCP_RTO_MAX);
543         }
544
545         return 0;
546 }
547
548 /* The length of all options needs to be a multiple of 4 (5.8) */
549 static void dccp_insert_option_padding(struct sk_buff *skb)
550 {
551         int padding = DCCP_SKB_CB(skb)->dccpd_opt_len % 4;
552
553         if (padding != 0) {
554                 padding = 4 - padding;
555                 memset(skb_push(skb, padding), 0, padding);
556                 DCCP_SKB_CB(skb)->dccpd_opt_len += padding;
557         }
558 }
559
560 int dccp_insert_options(struct sock *sk, struct sk_buff *skb)
561 {
562         struct dccp_sock *dp = dccp_sk(sk);
563         struct dccp_minisock *dmsk = dccp_msk(sk);
564
565         DCCP_SKB_CB(skb)->dccpd_opt_len = 0;
566
567         if (dmsk->dccpms_send_ndp_count &&
568             dccp_insert_option_ndp(sk, skb))
569                 return -1;
570
571         if (!dccp_packet_without_ack(skb)) {
572                 if (dmsk->dccpms_send_ack_vector &&
573                     dccp_ackvec_pending(dp->dccps_hc_rx_ackvec) &&
574                     dccp_insert_option_ackvec(sk, skb))
575                         return -1;
576         }
577
578         if (dp->dccps_hc_rx_insert_options) {
579                 if (ccid_hc_rx_insert_options(dp->dccps_hc_rx_ccid, sk, skb))
580                         return -1;
581                 dp->dccps_hc_rx_insert_options = 0;
582         }
583
584         /* Feature negotiation */
585         /* Data packets can't do feat negotiation */
586         if (DCCP_SKB_CB(skb)->dccpd_type != DCCP_PKT_DATA &&
587             DCCP_SKB_CB(skb)->dccpd_type != DCCP_PKT_DATAACK &&
588             dccp_insert_options_feat(sk, skb))
589                 return -1;
590
591         /*
592          * Obtain RTT sample from Request/Response exchange.
593          * This is currently used in CCID 3 initialisation.
594          */
595         if (DCCP_SKB_CB(skb)->dccpd_type == DCCP_PKT_REQUEST &&
596             dccp_insert_option_timestamp(sk, skb))
597                 return -1;
598
599         if (dp->dccps_timestamp_echo != 0 &&
600             dccp_insert_option_timestamp_echo(dp, NULL, skb))
601                 return -1;
602
603         dccp_insert_option_padding(skb);
604         return 0;
605 }
606
607 int dccp_insert_options_rsk(struct dccp_request_sock *dreq, struct sk_buff *skb)
608 {
609         DCCP_SKB_CB(skb)->dccpd_opt_len = 0;
610
611         if (dreq->dreq_timestamp_echo != 0 &&
612             dccp_insert_option_timestamp_echo(NULL, dreq, skb))
613                 return -1;
614
615         dccp_insert_option_padding(skb);
616         return 0;
617 }