Back to home page

OSCL-LXR

 
 

    


0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  *  net/dccp/feat.c
0004  *
0005  *  Feature negotiation for the DCCP protocol (RFC 4340, section 6)
0006  *
0007  *  Copyright (c) 2008 Gerrit Renker <gerrit@erg.abdn.ac.uk>
0008  *  Rewrote from scratch, some bits from earlier code by
0009  *  Copyright (c) 2005 Andrea Bittau <a.bittau@cs.ucl.ac.uk>
0010  *
0011  *  ASSUMPTIONS
0012  *  -----------
0013  *  o Feature negotiation is coordinated with connection setup (as in TCP), wild
0014  *    changes of parameters of an established connection are not supported.
0015  *  o Changing non-negotiable (NN) values is supported in state OPEN/PARTOPEN.
0016  *  o All currently known SP features have 1-byte quantities. If in the future
0017  *    extensions of RFCs 4340..42 define features with item lengths larger than
0018  *    one byte, a feature-specific extension of the code will be required.
0019  */
0020 #include <linux/module.h>
0021 #include <linux/slab.h>
0022 #include "ccid.h"
0023 #include "feat.h"
0024 
0025 /* feature-specific sysctls - initialised to the defaults from RFC 4340, 6.4 */
0026 unsigned long   sysctl_dccp_sequence_window __read_mostly = 100;
0027 int     sysctl_dccp_rx_ccid     __read_mostly = 2,
0028         sysctl_dccp_tx_ccid     __read_mostly = 2;
0029 
0030 /*
0031  * Feature activation handlers.
0032  *
0033  * These all use an u64 argument, to provide enough room for NN/SP features. At
0034  * this stage the negotiated values have been checked to be within their range.
0035  */
0036 static int dccp_hdlr_ccid(struct sock *sk, u64 ccid, bool rx)
0037 {
0038     struct dccp_sock *dp = dccp_sk(sk);
0039     struct ccid *new_ccid = ccid_new(ccid, sk, rx);
0040 
0041     if (new_ccid == NULL)
0042         return -ENOMEM;
0043 
0044     if (rx) {
0045         ccid_hc_rx_delete(dp->dccps_hc_rx_ccid, sk);
0046         dp->dccps_hc_rx_ccid = new_ccid;
0047     } else {
0048         ccid_hc_tx_delete(dp->dccps_hc_tx_ccid, sk);
0049         dp->dccps_hc_tx_ccid = new_ccid;
0050     }
0051     return 0;
0052 }
0053 
0054 static int dccp_hdlr_seq_win(struct sock *sk, u64 seq_win, bool rx)
0055 {
0056     struct dccp_sock *dp = dccp_sk(sk);
0057 
0058     if (rx) {
0059         dp->dccps_r_seq_win = seq_win;
0060         /* propagate changes to update SWL/SWH */
0061         dccp_update_gsr(sk, dp->dccps_gsr);
0062     } else {
0063         dp->dccps_l_seq_win = seq_win;
0064         /* propagate changes to update AWL */
0065         dccp_update_gss(sk, dp->dccps_gss);
0066     }
0067     return 0;
0068 }
0069 
0070 static int dccp_hdlr_ack_ratio(struct sock *sk, u64 ratio, bool rx)
0071 {
0072     if (rx)
0073         dccp_sk(sk)->dccps_r_ack_ratio = ratio;
0074     else
0075         dccp_sk(sk)->dccps_l_ack_ratio = ratio;
0076     return 0;
0077 }
0078 
0079 static int dccp_hdlr_ackvec(struct sock *sk, u64 enable, bool rx)
0080 {
0081     struct dccp_sock *dp = dccp_sk(sk);
0082 
0083     if (rx) {
0084         if (enable && dp->dccps_hc_rx_ackvec == NULL) {
0085             dp->dccps_hc_rx_ackvec = dccp_ackvec_alloc(gfp_any());
0086             if (dp->dccps_hc_rx_ackvec == NULL)
0087                 return -ENOMEM;
0088         } else if (!enable) {
0089             dccp_ackvec_free(dp->dccps_hc_rx_ackvec);
0090             dp->dccps_hc_rx_ackvec = NULL;
0091         }
0092     }
0093     return 0;
0094 }
0095 
0096 static int dccp_hdlr_ndp(struct sock *sk, u64 enable, bool rx)
0097 {
0098     if (!rx)
0099         dccp_sk(sk)->dccps_send_ndp_count = (enable > 0);
0100     return 0;
0101 }
0102 
0103 /*
0104  * Minimum Checksum Coverage is located at the RX side (9.2.1). This means that
0105  * `rx' holds when the sending peer informs about his partial coverage via a
0106  * ChangeR() option. In the other case, we are the sender and the receiver
0107  * announces its coverage via ChangeL() options. The policy here is to honour
0108  * such communication by enabling the corresponding partial coverage - but only
0109  * if it has not been set manually before; the warning here means that all
0110  * packets will be dropped.
0111  */
0112 static int dccp_hdlr_min_cscov(struct sock *sk, u64 cscov, bool rx)
0113 {
0114     struct dccp_sock *dp = dccp_sk(sk);
0115 
0116     if (rx)
0117         dp->dccps_pcrlen = cscov;
0118     else {
0119         if (dp->dccps_pcslen == 0)
0120             dp->dccps_pcslen = cscov;
0121         else if (cscov > dp->dccps_pcslen)
0122             DCCP_WARN("CsCov %u too small, peer requires >= %u\n",
0123                   dp->dccps_pcslen, (u8)cscov);
0124     }
0125     return 0;
0126 }
0127 
0128 static const struct {
0129     u8          feat_num;       /* DCCPF_xxx */
0130     enum dccp_feat_type rxtx;           /* RX or TX  */
0131     enum dccp_feat_type reconciliation;     /* SP or NN  */
0132     u8          default_value;      /* as in 6.4 */
0133     int (*activation_hdlr)(struct sock *sk, u64 val, bool rx);
0134 /*
0135  *    Lookup table for location and type of features (from RFC 4340/4342)
0136  *  +--------------------------+----+-----+----+----+---------+-----------+
0137  *  | Feature                  | Location | Reconc. | Initial |  Section  |
0138  *  |                          | RX | TX  | SP | NN |  Value  | Reference |
0139  *  +--------------------------+----+-----+----+----+---------+-----------+
0140  *  | DCCPF_CCID               |    |  X  | X  |    |   2     | 10        |
0141  *  | DCCPF_SHORT_SEQNOS       |    |  X  | X  |    |   0     |  7.6.1    |
0142  *  | DCCPF_SEQUENCE_WINDOW    |    |  X  |    | X  | 100     |  7.5.2    |
0143  *  | DCCPF_ECN_INCAPABLE      | X  |     | X  |    |   0     | 12.1      |
0144  *  | DCCPF_ACK_RATIO          |    |  X  |    | X  |   2     | 11.3      |
0145  *  | DCCPF_SEND_ACK_VECTOR    | X  |     | X  |    |   0     | 11.5      |
0146  *  | DCCPF_SEND_NDP_COUNT     |    |  X  | X  |    |   0     |  7.7.2    |
0147  *  | DCCPF_MIN_CSUM_COVER     | X  |     | X  |    |   0     |  9.2.1    |
0148  *  | DCCPF_DATA_CHECKSUM      | X  |     | X  |    |   0     |  9.3.1    |
0149  *  | DCCPF_SEND_LEV_RATE      | X  |     | X  |    |   0     | 4342/8.4  |
0150  *  +--------------------------+----+-----+----+----+---------+-----------+
0151  */
0152 } dccp_feat_table[] = {
0153     { DCCPF_CCID,        FEAT_AT_TX, FEAT_SP, 2,   dccp_hdlr_ccid     },
0154     { DCCPF_SHORT_SEQNOS,    FEAT_AT_TX, FEAT_SP, 0,   NULL },
0155     { DCCPF_SEQUENCE_WINDOW, FEAT_AT_TX, FEAT_NN, 100, dccp_hdlr_seq_win  },
0156     { DCCPF_ECN_INCAPABLE,   FEAT_AT_RX, FEAT_SP, 0,   NULL },
0157     { DCCPF_ACK_RATIO,   FEAT_AT_TX, FEAT_NN, 2,   dccp_hdlr_ack_ratio},
0158     { DCCPF_SEND_ACK_VECTOR, FEAT_AT_RX, FEAT_SP, 0,   dccp_hdlr_ackvec   },
0159     { DCCPF_SEND_NDP_COUNT,  FEAT_AT_TX, FEAT_SP, 0,   dccp_hdlr_ndp      },
0160     { DCCPF_MIN_CSUM_COVER,  FEAT_AT_RX, FEAT_SP, 0,   dccp_hdlr_min_cscov},
0161     { DCCPF_DATA_CHECKSUM,   FEAT_AT_RX, FEAT_SP, 0,   NULL },
0162     { DCCPF_SEND_LEV_RATE,   FEAT_AT_RX, FEAT_SP, 0,   NULL },
0163 };
0164 #define DCCP_FEAT_SUPPORTED_MAX     ARRAY_SIZE(dccp_feat_table)
0165 
0166 /**
0167  * dccp_feat_index  -  Hash function to map feature number into array position
0168  * @feat_num: feature to hash, one of %dccp_feature_numbers
0169  *
0170  * Returns consecutive array index or -1 if the feature is not understood.
0171  */
0172 static int dccp_feat_index(u8 feat_num)
0173 {
0174     /* The first 9 entries are occupied by the types from RFC 4340, 6.4 */
0175     if (feat_num > DCCPF_RESERVED && feat_num <= DCCPF_DATA_CHECKSUM)
0176         return feat_num - 1;
0177 
0178     /*
0179      * Other features: add cases for new feature types here after adding
0180      * them to the above table.
0181      */
0182     switch (feat_num) {
0183     case DCCPF_SEND_LEV_RATE:
0184             return DCCP_FEAT_SUPPORTED_MAX - 1;
0185     }
0186     return -1;
0187 }
0188 
0189 static u8 dccp_feat_type(u8 feat_num)
0190 {
0191     int idx = dccp_feat_index(feat_num);
0192 
0193     if (idx < 0)
0194         return FEAT_UNKNOWN;
0195     return dccp_feat_table[idx].reconciliation;
0196 }
0197 
0198 static int dccp_feat_default_value(u8 feat_num)
0199 {
0200     int idx = dccp_feat_index(feat_num);
0201     /*
0202      * There are no default values for unknown features, so encountering a
0203      * negative index here indicates a serious problem somewhere else.
0204      */
0205     DCCP_BUG_ON(idx < 0);
0206 
0207     return idx < 0 ? 0 : dccp_feat_table[idx].default_value;
0208 }
0209 
0210 /*
0211  *  Debugging and verbose-printing section
0212  */
0213 static const char *dccp_feat_fname(const u8 feat)
0214 {
0215     static const char *const feature_names[] = {
0216         [DCCPF_RESERVED]    = "Reserved",
0217         [DCCPF_CCID]        = "CCID",
0218         [DCCPF_SHORT_SEQNOS]    = "Allow Short Seqnos",
0219         [DCCPF_SEQUENCE_WINDOW] = "Sequence Window",
0220         [DCCPF_ECN_INCAPABLE]   = "ECN Incapable",
0221         [DCCPF_ACK_RATIO]   = "Ack Ratio",
0222         [DCCPF_SEND_ACK_VECTOR] = "Send ACK Vector",
0223         [DCCPF_SEND_NDP_COUNT]  = "Send NDP Count",
0224         [DCCPF_MIN_CSUM_COVER]  = "Min. Csum Coverage",
0225         [DCCPF_DATA_CHECKSUM]   = "Send Data Checksum",
0226     };
0227     if (feat > DCCPF_DATA_CHECKSUM && feat < DCCPF_MIN_CCID_SPECIFIC)
0228         return feature_names[DCCPF_RESERVED];
0229 
0230     if (feat ==  DCCPF_SEND_LEV_RATE)
0231         return "Send Loss Event Rate";
0232     if (feat >= DCCPF_MIN_CCID_SPECIFIC)
0233         return "CCID-specific";
0234 
0235     return feature_names[feat];
0236 }
0237 
0238 static const char *const dccp_feat_sname[] = {
0239     "DEFAULT", "INITIALISING", "CHANGING", "UNSTABLE", "STABLE",
0240 };
0241 
0242 #ifdef CONFIG_IP_DCCP_DEBUG
0243 static const char *dccp_feat_oname(const u8 opt)
0244 {
0245     switch (opt) {
0246     case DCCPO_CHANGE_L:  return "Change_L";
0247     case DCCPO_CONFIRM_L: return "Confirm_L";
0248     case DCCPO_CHANGE_R:  return "Change_R";
0249     case DCCPO_CONFIRM_R: return "Confirm_R";
0250     }
0251     return NULL;
0252 }
0253 
0254 static void dccp_feat_printval(u8 feat_num, dccp_feat_val const *val)
0255 {
0256     u8 i, type = dccp_feat_type(feat_num);
0257 
0258     if (val == NULL || (type == FEAT_SP && val->sp.vec == NULL))
0259         dccp_pr_debug_cat("(NULL)");
0260     else if (type == FEAT_SP)
0261         for (i = 0; i < val->sp.len; i++)
0262             dccp_pr_debug_cat("%s%u", i ? " " : "", val->sp.vec[i]);
0263     else if (type == FEAT_NN)
0264         dccp_pr_debug_cat("%llu", (unsigned long long)val->nn);
0265     else
0266         dccp_pr_debug_cat("unknown type %u", type);
0267 }
0268 
0269 static void dccp_feat_printvals(u8 feat_num, u8 *list, u8 len)
0270 {
0271     u8 type = dccp_feat_type(feat_num);
0272     dccp_feat_val fval = { .sp.vec = list, .sp.len = len };
0273 
0274     if (type == FEAT_NN)
0275         fval.nn = dccp_decode_value_var(list, len);
0276     dccp_feat_printval(feat_num, &fval);
0277 }
0278 
0279 static void dccp_feat_print_entry(struct dccp_feat_entry const *entry)
0280 {
0281     dccp_debug("   * %s %s = ", entry->is_local ? "local" : "remote",
0282                     dccp_feat_fname(entry->feat_num));
0283     dccp_feat_printval(entry->feat_num, &entry->val);
0284     dccp_pr_debug_cat(", state=%s %s\n", dccp_feat_sname[entry->state],
0285               entry->needs_confirm ? "(Confirm pending)" : "");
0286 }
0287 
0288 #define dccp_feat_print_opt(opt, feat, val, len, mandatory) do {          \
0289     dccp_pr_debug("%s(%s, ", dccp_feat_oname(opt), dccp_feat_fname(feat));\
0290     dccp_feat_printvals(feat, val, len);                      \
0291     dccp_pr_debug_cat(") %s\n", mandatory ? "!" : "");  } while (0)
0292 
0293 #define dccp_feat_print_fnlist(fn_list)  {      \
0294     const struct dccp_feat_entry *___entry;     \
0295                             \
0296     dccp_pr_debug("List Dump:\n");          \
0297     list_for_each_entry(___entry, fn_list, node)    \
0298         dccp_feat_print_entry(___entry);    \
0299 }
0300 #else   /* ! CONFIG_IP_DCCP_DEBUG */
0301 #define dccp_feat_print_opt(opt, feat, val, len, mandatory)
0302 #define dccp_feat_print_fnlist(fn_list)
0303 #endif
0304 
0305 static int __dccp_feat_activate(struct sock *sk, const int idx,
0306                 const bool is_local, dccp_feat_val const *fval)
0307 {
0308     bool rx;
0309     u64 val;
0310 
0311     if (idx < 0 || idx >= DCCP_FEAT_SUPPORTED_MAX)
0312         return -1;
0313     if (dccp_feat_table[idx].activation_hdlr == NULL)
0314         return 0;
0315 
0316     if (fval == NULL) {
0317         val = dccp_feat_table[idx].default_value;
0318     } else if (dccp_feat_table[idx].reconciliation == FEAT_SP) {
0319         if (fval->sp.vec == NULL) {
0320             /*
0321              * This can happen when an empty Confirm is sent
0322              * for an SP (i.e. known) feature. In this case
0323              * we would be using the default anyway.
0324              */
0325             DCCP_CRIT("Feature #%d undefined: using default", idx);
0326             val = dccp_feat_table[idx].default_value;
0327         } else {
0328             val = fval->sp.vec[0];
0329         }
0330     } else {
0331         val = fval->nn;
0332     }
0333 
0334     /* Location is RX if this is a local-RX or remote-TX feature */
0335     rx = (is_local == (dccp_feat_table[idx].rxtx == FEAT_AT_RX));
0336 
0337     dccp_debug("   -> activating %s %s, %sval=%llu\n", rx ? "RX" : "TX",
0338            dccp_feat_fname(dccp_feat_table[idx].feat_num),
0339            fval ? "" : "default ",  (unsigned long long)val);
0340 
0341     return dccp_feat_table[idx].activation_hdlr(sk, val, rx);
0342 }
0343 
0344 /**
0345  * dccp_feat_activate  -  Activate feature value on socket
0346  * @sk: fully connected DCCP socket (after handshake is complete)
0347  * @feat_num: feature to activate, one of %dccp_feature_numbers
0348  * @local: whether local (1) or remote (0) @feat_num is meant
0349  * @fval: the value (SP or NN) to activate, or NULL to use the default value
0350  *
0351  * For general use this function is preferable over __dccp_feat_activate().
0352  */
0353 static int dccp_feat_activate(struct sock *sk, u8 feat_num, bool local,
0354                   dccp_feat_val const *fval)
0355 {
0356     return __dccp_feat_activate(sk, dccp_feat_index(feat_num), local, fval);
0357 }
0358 
0359 /* Test for "Req'd" feature (RFC 4340, 6.4) */
0360 static inline int dccp_feat_must_be_understood(u8 feat_num)
0361 {
0362     return  feat_num == DCCPF_CCID || feat_num == DCCPF_SHORT_SEQNOS ||
0363         feat_num == DCCPF_SEQUENCE_WINDOW;
0364 }
0365 
0366 /* copy constructor, fval must not already contain allocated memory */
0367 static int dccp_feat_clone_sp_val(dccp_feat_val *fval, u8 const *val, u8 len)
0368 {
0369     fval->sp.len = len;
0370     if (fval->sp.len > 0) {
0371         fval->sp.vec = kmemdup(val, len, gfp_any());
0372         if (fval->sp.vec == NULL) {
0373             fval->sp.len = 0;
0374             return -ENOMEM;
0375         }
0376     }
0377     return 0;
0378 }
0379 
0380 static void dccp_feat_val_destructor(u8 feat_num, dccp_feat_val *val)
0381 {
0382     if (unlikely(val == NULL))
0383         return;
0384     if (dccp_feat_type(feat_num) == FEAT_SP)
0385         kfree(val->sp.vec);
0386     memset(val, 0, sizeof(*val));
0387 }
0388 
0389 static struct dccp_feat_entry *
0390           dccp_feat_clone_entry(struct dccp_feat_entry const *original)
0391 {
0392     struct dccp_feat_entry *new;
0393     u8 type = dccp_feat_type(original->feat_num);
0394 
0395     if (type == FEAT_UNKNOWN)
0396         return NULL;
0397 
0398     new = kmemdup(original, sizeof(struct dccp_feat_entry), gfp_any());
0399     if (new == NULL)
0400         return NULL;
0401 
0402     if (type == FEAT_SP && dccp_feat_clone_sp_val(&new->val,
0403                               original->val.sp.vec,
0404                               original->val.sp.len)) {
0405         kfree(new);
0406         return NULL;
0407     }
0408     return new;
0409 }
0410 
0411 static void dccp_feat_entry_destructor(struct dccp_feat_entry *entry)
0412 {
0413     if (entry != NULL) {
0414         dccp_feat_val_destructor(entry->feat_num, &entry->val);
0415         kfree(entry);
0416     }
0417 }
0418 
0419 /*
0420  * List management functions
0421  *
0422  * Feature negotiation lists rely on and maintain the following invariants:
0423  * - each feat_num in the list is known, i.e. we know its type and default value
0424  * - each feat_num/is_local combination is unique (old entries are overwritten)
0425  * - SP values are always freshly allocated
0426  * - list is sorted in increasing order of feature number (faster lookup)
0427  */
0428 static struct dccp_feat_entry *dccp_feat_list_lookup(struct list_head *fn_list,
0429                              u8 feat_num, bool is_local)
0430 {
0431     struct dccp_feat_entry *entry;
0432 
0433     list_for_each_entry(entry, fn_list, node) {
0434         if (entry->feat_num == feat_num && entry->is_local == is_local)
0435             return entry;
0436         else if (entry->feat_num > feat_num)
0437             break;
0438     }
0439     return NULL;
0440 }
0441 
0442 /**
0443  * dccp_feat_entry_new  -  Central list update routine (called by all others)
0444  * @head:  list to add to
0445  * @feat:  feature number
0446  * @local: whether the local (1) or remote feature with number @feat is meant
0447  *
0448  * This is the only constructor and serves to ensure the above invariants.
0449  */
0450 static struct dccp_feat_entry *
0451           dccp_feat_entry_new(struct list_head *head, u8 feat, bool local)
0452 {
0453     struct dccp_feat_entry *entry;
0454 
0455     list_for_each_entry(entry, head, node)
0456         if (entry->feat_num == feat && entry->is_local == local) {
0457             dccp_feat_val_destructor(entry->feat_num, &entry->val);
0458             return entry;
0459         } else if (entry->feat_num > feat) {
0460             head = &entry->node;
0461             break;
0462         }
0463 
0464     entry = kmalloc(sizeof(*entry), gfp_any());
0465     if (entry != NULL) {
0466         entry->feat_num = feat;
0467         entry->is_local = local;
0468         list_add_tail(&entry->node, head);
0469     }
0470     return entry;
0471 }
0472 
0473 /**
0474  * dccp_feat_push_change  -  Add/overwrite a Change option in the list
0475  * @fn_list: feature-negotiation list to update
0476  * @feat: one of %dccp_feature_numbers
0477  * @local: whether local (1) or remote (0) @feat_num is meant
0478  * @mandatory: whether to use Mandatory feature negotiation options
0479  * @fval: pointer to NN/SP value to be inserted (will be copied)
0480  */
0481 static int dccp_feat_push_change(struct list_head *fn_list, u8 feat, u8 local,
0482                  u8 mandatory, dccp_feat_val *fval)
0483 {
0484     struct dccp_feat_entry *new = dccp_feat_entry_new(fn_list, feat, local);
0485 
0486     if (new == NULL)
0487         return -ENOMEM;
0488 
0489     new->feat_num        = feat;
0490     new->is_local        = local;
0491     new->state       = FEAT_INITIALISING;
0492     new->needs_confirm   = false;
0493     new->empty_confirm   = false;
0494     new->val         = *fval;
0495     new->needs_mandatory = mandatory;
0496 
0497     return 0;
0498 }
0499 
0500 /**
0501  * dccp_feat_push_confirm  -  Add a Confirm entry to the FN list
0502  * @fn_list: feature-negotiation list to add to
0503  * @feat: one of %dccp_feature_numbers
0504  * @local: whether local (1) or remote (0) @feat_num is being confirmed
0505  * @fval: pointer to NN/SP value to be inserted or NULL
0506  *
0507  * Returns 0 on success, a Reset code for further processing otherwise.
0508  */
0509 static int dccp_feat_push_confirm(struct list_head *fn_list, u8 feat, u8 local,
0510                   dccp_feat_val *fval)
0511 {
0512     struct dccp_feat_entry *new = dccp_feat_entry_new(fn_list, feat, local);
0513 
0514     if (new == NULL)
0515         return DCCP_RESET_CODE_TOO_BUSY;
0516 
0517     new->feat_num        = feat;
0518     new->is_local        = local;
0519     new->state       = FEAT_STABLE; /* transition in 6.6.2 */
0520     new->needs_confirm   = true;
0521     new->empty_confirm   = (fval == NULL);
0522     new->val.nn      = 0;       /* zeroes the whole structure */
0523     if (!new->empty_confirm)
0524         new->val     = *fval;
0525     new->needs_mandatory = false;
0526 
0527     return 0;
0528 }
0529 
0530 static int dccp_push_empty_confirm(struct list_head *fn_list, u8 feat, u8 local)
0531 {
0532     return dccp_feat_push_confirm(fn_list, feat, local, NULL);
0533 }
0534 
0535 static inline void dccp_feat_list_pop(struct dccp_feat_entry *entry)
0536 {
0537     list_del(&entry->node);
0538     dccp_feat_entry_destructor(entry);
0539 }
0540 
0541 void dccp_feat_list_purge(struct list_head *fn_list)
0542 {
0543     struct dccp_feat_entry *entry, *next;
0544 
0545     list_for_each_entry_safe(entry, next, fn_list, node)
0546         dccp_feat_entry_destructor(entry);
0547     INIT_LIST_HEAD(fn_list);
0548 }
0549 EXPORT_SYMBOL_GPL(dccp_feat_list_purge);
0550 
0551 /* generate @to as full clone of @from - @to must not contain any nodes */
0552 int dccp_feat_clone_list(struct list_head const *from, struct list_head *to)
0553 {
0554     struct dccp_feat_entry *entry, *new;
0555 
0556     INIT_LIST_HEAD(to);
0557     list_for_each_entry(entry, from, node) {
0558         new = dccp_feat_clone_entry(entry);
0559         if (new == NULL)
0560             goto cloning_failed;
0561         list_add_tail(&new->node, to);
0562     }
0563     return 0;
0564 
0565 cloning_failed:
0566     dccp_feat_list_purge(to);
0567     return -ENOMEM;
0568 }
0569 
0570 /**
0571  * dccp_feat_valid_nn_length  -  Enforce length constraints on NN options
0572  * @feat_num: feature to return length of, one of %dccp_feature_numbers
0573  *
0574  * Length is between 0 and %DCCP_OPTVAL_MAXLEN. Used for outgoing packets only,
0575  * incoming options are accepted as long as their values are valid.
0576  */
0577 static u8 dccp_feat_valid_nn_length(u8 feat_num)
0578 {
0579     if (feat_num == DCCPF_ACK_RATIO)    /* RFC 4340, 11.3 and 6.6.8 */
0580         return 2;
0581     if (feat_num == DCCPF_SEQUENCE_WINDOW)  /* RFC 4340, 7.5.2 and 6.5  */
0582         return 6;
0583     return 0;
0584 }
0585 
0586 static u8 dccp_feat_is_valid_nn_val(u8 feat_num, u64 val)
0587 {
0588     switch (feat_num) {
0589     case DCCPF_ACK_RATIO:
0590         return val <= DCCPF_ACK_RATIO_MAX;
0591     case DCCPF_SEQUENCE_WINDOW:
0592         return val >= DCCPF_SEQ_WMIN && val <= DCCPF_SEQ_WMAX;
0593     }
0594     return 0;   /* feature unknown - so we can't tell */
0595 }
0596 
0597 /* check that SP values are within the ranges defined in RFC 4340 */
0598 static u8 dccp_feat_is_valid_sp_val(u8 feat_num, u8 val)
0599 {
0600     switch (feat_num) {
0601     case DCCPF_CCID:
0602         return val == DCCPC_CCID2 || val == DCCPC_CCID3;
0603     /* Type-check Boolean feature values: */
0604     case DCCPF_SHORT_SEQNOS:
0605     case DCCPF_ECN_INCAPABLE:
0606     case DCCPF_SEND_ACK_VECTOR:
0607     case DCCPF_SEND_NDP_COUNT:
0608     case DCCPF_DATA_CHECKSUM:
0609     case DCCPF_SEND_LEV_RATE:
0610         return val < 2;
0611     case DCCPF_MIN_CSUM_COVER:
0612         return val < 16;
0613     }
0614     return 0;           /* feature unknown */
0615 }
0616 
0617 static u8 dccp_feat_sp_list_ok(u8 feat_num, u8 const *sp_list, u8 sp_len)
0618 {
0619     if (sp_list == NULL || sp_len < 1)
0620         return 0;
0621     while (sp_len--)
0622         if (!dccp_feat_is_valid_sp_val(feat_num, *sp_list++))
0623             return 0;
0624     return 1;
0625 }
0626 
0627 /**
0628  * dccp_feat_insert_opts  -  Generate FN options from current list state
0629  * @skb: next sk_buff to be sent to the peer
0630  * @dp: for client during handshake and general negotiation
0631  * @dreq: used by the server only (all Changes/Confirms in LISTEN/RESPOND)
0632  */
0633 int dccp_feat_insert_opts(struct dccp_sock *dp, struct dccp_request_sock *dreq,
0634               struct sk_buff *skb)
0635 {
0636     struct list_head *fn = dreq ? &dreq->dreq_featneg : &dp->dccps_featneg;
0637     struct dccp_feat_entry *pos, *next;
0638     u8 opt, type, len, *ptr, nn_in_nbo[DCCP_OPTVAL_MAXLEN];
0639     bool rpt;
0640 
0641     /* put entries into @skb in the order they appear in the list */
0642     list_for_each_entry_safe_reverse(pos, next, fn, node) {
0643         opt  = dccp_feat_genopt(pos);
0644         type = dccp_feat_type(pos->feat_num);
0645         rpt  = false;
0646 
0647         if (pos->empty_confirm) {
0648             len = 0;
0649             ptr = NULL;
0650         } else {
0651             if (type == FEAT_SP) {
0652                 len = pos->val.sp.len;
0653                 ptr = pos->val.sp.vec;
0654                 rpt = pos->needs_confirm;
0655             } else if (type == FEAT_NN) {
0656                 len = dccp_feat_valid_nn_length(pos->feat_num);
0657                 ptr = nn_in_nbo;
0658                 dccp_encode_value_var(pos->val.nn, ptr, len);
0659             } else {
0660                 DCCP_BUG("unknown feature %u", pos->feat_num);
0661                 return -1;
0662             }
0663         }
0664         dccp_feat_print_opt(opt, pos->feat_num, ptr, len, 0);
0665 
0666         if (dccp_insert_fn_opt(skb, opt, pos->feat_num, ptr, len, rpt))
0667             return -1;
0668         if (pos->needs_mandatory && dccp_insert_option_mandatory(skb))
0669             return -1;
0670 
0671         if (skb->sk->sk_state == DCCP_OPEN &&
0672             (opt == DCCPO_CONFIRM_R || opt == DCCPO_CONFIRM_L)) {
0673             /*
0674              * Confirms don't get retransmitted (6.6.3) once the
0675              * connection is in state OPEN
0676              */
0677             dccp_feat_list_pop(pos);
0678         } else {
0679             /*
0680              * Enter CHANGING after transmitting the Change
0681              * option (6.6.2).
0682              */
0683             if (pos->state == FEAT_INITIALISING)
0684                 pos->state = FEAT_CHANGING;
0685         }
0686     }
0687     return 0;
0688 }
0689 
0690 /**
0691  * __feat_register_nn  -  Register new NN value on socket
0692  * @fn: feature-negotiation list to register with
0693  * @feat: an NN feature from %dccp_feature_numbers
0694  * @mandatory: use Mandatory option if 1
0695  * @nn_val: value to register (restricted to 4 bytes)
0696  *
0697  * Note that NN features are local by definition (RFC 4340, 6.3.2).
0698  */
0699 static int __feat_register_nn(struct list_head *fn, u8 feat,
0700                   u8 mandatory, u64 nn_val)
0701 {
0702     dccp_feat_val fval = { .nn = nn_val };
0703 
0704     if (dccp_feat_type(feat) != FEAT_NN ||
0705         !dccp_feat_is_valid_nn_val(feat, nn_val))
0706         return -EINVAL;
0707 
0708     /* Don't bother with default values, they will be activated anyway. */
0709     if (nn_val - (u64)dccp_feat_default_value(feat) == 0)
0710         return 0;
0711 
0712     return dccp_feat_push_change(fn, feat, 1, mandatory, &fval);
0713 }
0714 
0715 /**
0716  * __feat_register_sp  -  Register new SP value/list on socket
0717  * @fn: feature-negotiation list to register with
0718  * @feat: an SP feature from %dccp_feature_numbers
0719  * @is_local: whether the local (1) or the remote (0) @feat is meant
0720  * @mandatory: use Mandatory option if 1
0721  * @sp_val: SP value followed by optional preference list
0722  * @sp_len: length of @sp_val in bytes
0723  */
0724 static int __feat_register_sp(struct list_head *fn, u8 feat, u8 is_local,
0725                   u8 mandatory, u8 const *sp_val, u8 sp_len)
0726 {
0727     dccp_feat_val fval;
0728 
0729     if (dccp_feat_type(feat) != FEAT_SP ||
0730         !dccp_feat_sp_list_ok(feat, sp_val, sp_len))
0731         return -EINVAL;
0732 
0733     /* Avoid negotiating alien CCIDs by only advertising supported ones */
0734     if (feat == DCCPF_CCID && !ccid_support_check(sp_val, sp_len))
0735         return -EOPNOTSUPP;
0736 
0737     if (dccp_feat_clone_sp_val(&fval, sp_val, sp_len))
0738         return -ENOMEM;
0739 
0740     if (dccp_feat_push_change(fn, feat, is_local, mandatory, &fval)) {
0741         kfree(fval.sp.vec);
0742         return -ENOMEM;
0743     }
0744 
0745     return 0;
0746 }
0747 
0748 /**
0749  * dccp_feat_register_sp  -  Register requests to change SP feature values
0750  * @sk: client or listening socket
0751  * @feat: one of %dccp_feature_numbers
0752  * @is_local: whether the local (1) or remote (0) @feat is meant
0753  * @list: array of preferred values, in descending order of preference
0754  * @len: length of @list in bytes
0755  */
0756 int dccp_feat_register_sp(struct sock *sk, u8 feat, u8 is_local,
0757               u8 const *list, u8 len)
0758 {    /* any changes must be registered before establishing the connection */
0759     if (sk->sk_state != DCCP_CLOSED)
0760         return -EISCONN;
0761     if (dccp_feat_type(feat) != FEAT_SP)
0762         return -EINVAL;
0763     return __feat_register_sp(&dccp_sk(sk)->dccps_featneg, feat, is_local,
0764                   0, list, len);
0765 }
0766 
0767 /**
0768  * dccp_feat_nn_get  -  Query current/pending value of NN feature
0769  * @sk: DCCP socket of an established connection
0770  * @feat: NN feature number from %dccp_feature_numbers
0771  *
0772  * For a known NN feature, returns value currently being negotiated, or
0773  * current (confirmed) value if no negotiation is going on.
0774  */
0775 u64 dccp_feat_nn_get(struct sock *sk, u8 feat)
0776 {
0777     if (dccp_feat_type(feat) == FEAT_NN) {
0778         struct dccp_sock *dp = dccp_sk(sk);
0779         struct dccp_feat_entry *entry;
0780 
0781         entry = dccp_feat_list_lookup(&dp->dccps_featneg, feat, 1);
0782         if (entry != NULL)
0783             return entry->val.nn;
0784 
0785         switch (feat) {
0786         case DCCPF_ACK_RATIO:
0787             return dp->dccps_l_ack_ratio;
0788         case DCCPF_SEQUENCE_WINDOW:
0789             return dp->dccps_l_seq_win;
0790         }
0791     }
0792     DCCP_BUG("attempt to look up unsupported feature %u", feat);
0793     return 0;
0794 }
0795 EXPORT_SYMBOL_GPL(dccp_feat_nn_get);
0796 
0797 /**
0798  * dccp_feat_signal_nn_change  -  Update NN values for an established connection
0799  * @sk: DCCP socket of an established connection
0800  * @feat: NN feature number from %dccp_feature_numbers
0801  * @nn_val: the new value to use
0802  *
0803  * This function is used to communicate NN updates out-of-band.
0804  */
0805 int dccp_feat_signal_nn_change(struct sock *sk, u8 feat, u64 nn_val)
0806 {
0807     struct list_head *fn = &dccp_sk(sk)->dccps_featneg;
0808     dccp_feat_val fval = { .nn = nn_val };
0809     struct dccp_feat_entry *entry;
0810 
0811     if (sk->sk_state != DCCP_OPEN && sk->sk_state != DCCP_PARTOPEN)
0812         return 0;
0813 
0814     if (dccp_feat_type(feat) != FEAT_NN ||
0815         !dccp_feat_is_valid_nn_val(feat, nn_val))
0816         return -EINVAL;
0817 
0818     if (nn_val == dccp_feat_nn_get(sk, feat))
0819         return 0;   /* already set or negotiation under way */
0820 
0821     entry = dccp_feat_list_lookup(fn, feat, 1);
0822     if (entry != NULL) {
0823         dccp_pr_debug("Clobbering existing NN entry %llu -> %llu\n",
0824                   (unsigned long long)entry->val.nn,
0825                   (unsigned long long)nn_val);
0826         dccp_feat_list_pop(entry);
0827     }
0828 
0829     inet_csk_schedule_ack(sk);
0830     return dccp_feat_push_change(fn, feat, 1, 0, &fval);
0831 }
0832 EXPORT_SYMBOL_GPL(dccp_feat_signal_nn_change);
0833 
0834 /*
0835  *  Tracking features whose value depend on the choice of CCID
0836  *
0837  * This is designed with an extension in mind so that a list walk could be done
0838  * before activating any features. However, the existing framework was found to
0839  * work satisfactorily up until now, the automatic verification is left open.
0840  * When adding new CCIDs, add a corresponding dependency table here.
0841  */
0842 static const struct ccid_dependency *dccp_feat_ccid_deps(u8 ccid, bool is_local)
0843 {
0844     static const struct ccid_dependency ccid2_dependencies[2][2] = {
0845         /*
0846          * CCID2 mandates Ack Vectors (RFC 4341, 4.): as CCID is a TX
0847          * feature and Send Ack Vector is an RX feature, `is_local'
0848          * needs to be reversed.
0849          */
0850         {   /* Dependencies of the receiver-side (remote) CCID2 */
0851             {
0852                 .dependent_feat = DCCPF_SEND_ACK_VECTOR,
0853                 .is_local   = true,
0854                 .is_mandatory   = true,
0855                 .val        = 1
0856             },
0857             { 0, 0, 0, 0 }
0858         },
0859         {   /* Dependencies of the sender-side (local) CCID2 */
0860             {
0861                 .dependent_feat = DCCPF_SEND_ACK_VECTOR,
0862                 .is_local   = false,
0863                 .is_mandatory   = true,
0864                 .val        = 1
0865             },
0866             { 0, 0, 0, 0 }
0867         }
0868     };
0869     static const struct ccid_dependency ccid3_dependencies[2][5] = {
0870         {   /*
0871              * Dependencies of the receiver-side CCID3
0872              */
0873             {   /* locally disable Ack Vectors */
0874                 .dependent_feat = DCCPF_SEND_ACK_VECTOR,
0875                 .is_local   = true,
0876                 .is_mandatory   = false,
0877                 .val        = 0
0878             },
0879             {   /* see below why Send Loss Event Rate is on */
0880                 .dependent_feat = DCCPF_SEND_LEV_RATE,
0881                 .is_local   = true,
0882                 .is_mandatory   = true,
0883                 .val        = 1
0884             },
0885             {   /* NDP Count is needed as per RFC 4342, 6.1.1 */
0886                 .dependent_feat = DCCPF_SEND_NDP_COUNT,
0887                 .is_local   = false,
0888                 .is_mandatory   = true,
0889                 .val        = 1
0890             },
0891             { 0, 0, 0, 0 },
0892         },
0893         {   /*
0894              * CCID3 at the TX side: we request that the HC-receiver
0895              * will not send Ack Vectors (they will be ignored, so
0896              * Mandatory is not set); we enable Send Loss Event Rate
0897              * (Mandatory since the implementation does not support
0898              * the Loss Intervals option of RFC 4342, 8.6).
0899              * The last two options are for peer's information only.
0900             */
0901             {
0902                 .dependent_feat = DCCPF_SEND_ACK_VECTOR,
0903                 .is_local   = false,
0904                 .is_mandatory   = false,
0905                 .val        = 0
0906             },
0907             {
0908                 .dependent_feat = DCCPF_SEND_LEV_RATE,
0909                 .is_local   = false,
0910                 .is_mandatory   = true,
0911                 .val        = 1
0912             },
0913             {   /* this CCID does not support Ack Ratio */
0914                 .dependent_feat = DCCPF_ACK_RATIO,
0915                 .is_local   = true,
0916                 .is_mandatory   = false,
0917                 .val        = 0
0918             },
0919             {   /* tell receiver we are sending NDP counts */
0920                 .dependent_feat = DCCPF_SEND_NDP_COUNT,
0921                 .is_local   = true,
0922                 .is_mandatory   = false,
0923                 .val        = 1
0924             },
0925             { 0, 0, 0, 0 }
0926         }
0927     };
0928     switch (ccid) {
0929     case DCCPC_CCID2:
0930         return ccid2_dependencies[is_local];
0931     case DCCPC_CCID3:
0932         return ccid3_dependencies[is_local];
0933     default:
0934         return NULL;
0935     }
0936 }
0937 
0938 /**
0939  * dccp_feat_propagate_ccid - Resolve dependencies of features on choice of CCID
0940  * @fn: feature-negotiation list to update
0941  * @id: CCID number to track
0942  * @is_local: whether TX CCID (1) or RX CCID (0) is meant
0943  *
0944  * This function needs to be called after registering all other features.
0945  */
0946 static int dccp_feat_propagate_ccid(struct list_head *fn, u8 id, bool is_local)
0947 {
0948     const struct ccid_dependency *table = dccp_feat_ccid_deps(id, is_local);
0949     int i, rc = (table == NULL);
0950 
0951     for (i = 0; rc == 0 && table[i].dependent_feat != DCCPF_RESERVED; i++)
0952         if (dccp_feat_type(table[i].dependent_feat) == FEAT_SP)
0953             rc = __feat_register_sp(fn, table[i].dependent_feat,
0954                             table[i].is_local,
0955                             table[i].is_mandatory,
0956                             &table[i].val, 1);
0957         else
0958             rc = __feat_register_nn(fn, table[i].dependent_feat,
0959                             table[i].is_mandatory,
0960                             table[i].val);
0961     return rc;
0962 }
0963 
0964 /**
0965  * dccp_feat_finalise_settings  -  Finalise settings before starting negotiation
0966  * @dp: client or listening socket (settings will be inherited)
0967  *
0968  * This is called after all registrations (socket initialisation, sysctls, and
0969  * sockopt calls), and before sending the first packet containing Change options
0970  * (ie. client-Request or server-Response), to ensure internal consistency.
0971  */
0972 int dccp_feat_finalise_settings(struct dccp_sock *dp)
0973 {
0974     struct list_head *fn = &dp->dccps_featneg;
0975     struct dccp_feat_entry *entry;
0976     int i = 2, ccids[2] = { -1, -1 };
0977 
0978     /*
0979      * Propagating CCIDs:
0980      * 1) not useful to propagate CCID settings if this host advertises more
0981      *    than one CCID: the choice of CCID  may still change - if this is
0982      *    the client, or if this is the server and the client sends
0983      *    singleton CCID values.
0984      * 2) since is that propagate_ccid changes the list, we defer changing
0985      *    the sorted list until after the traversal.
0986      */
0987     list_for_each_entry(entry, fn, node)
0988         if (entry->feat_num == DCCPF_CCID && entry->val.sp.len == 1)
0989             ccids[entry->is_local] = entry->val.sp.vec[0];
0990     while (i--)
0991         if (ccids[i] > 0 && dccp_feat_propagate_ccid(fn, ccids[i], i))
0992             return -1;
0993     dccp_feat_print_fnlist(fn);
0994     return 0;
0995 }
0996 
0997 /**
0998  * dccp_feat_server_ccid_dependencies  -  Resolve CCID-dependent features
0999  * @dreq: server socket to resolve
1000  *
1001  * It is the server which resolves the dependencies once the CCID has been
1002  * fully negotiated. If no CCID has been negotiated, it uses the default CCID.
1003  */
1004 int dccp_feat_server_ccid_dependencies(struct dccp_request_sock *dreq)
1005 {
1006     struct list_head *fn = &dreq->dreq_featneg;
1007     struct dccp_feat_entry *entry;
1008     u8 is_local, ccid;
1009 
1010     for (is_local = 0; is_local <= 1; is_local++) {
1011         entry = dccp_feat_list_lookup(fn, DCCPF_CCID, is_local);
1012 
1013         if (entry != NULL && !entry->empty_confirm)
1014             ccid = entry->val.sp.vec[0];
1015         else
1016             ccid = dccp_feat_default_value(DCCPF_CCID);
1017 
1018         if (dccp_feat_propagate_ccid(fn, ccid, is_local))
1019             return -1;
1020     }
1021     return 0;
1022 }
1023 
1024 /* Select the first entry in @servlist that also occurs in @clilist (6.3.1) */
1025 static int dccp_feat_preflist_match(u8 *servlist, u8 slen, u8 *clilist, u8 clen)
1026 {
1027     u8 c, s;
1028 
1029     for (s = 0; s < slen; s++)
1030         for (c = 0; c < clen; c++)
1031             if (servlist[s] == clilist[c])
1032                 return servlist[s];
1033     return -1;
1034 }
1035 
1036 /**
1037  * dccp_feat_prefer  -  Move preferred entry to the start of array
1038  * @preferred_value: entry to move to start of array
1039  * @array: array of preferred entries
1040  * @array_len: size of the array
1041  *
1042  * Reorder the @array_len elements in @array so that @preferred_value comes
1043  * first. Returns >0 to indicate that @preferred_value does occur in @array.
1044  */
1045 static u8 dccp_feat_prefer(u8 preferred_value, u8 *array, u8 array_len)
1046 {
1047     u8 i, does_occur = 0;
1048 
1049     if (array != NULL) {
1050         for (i = 0; i < array_len; i++)
1051             if (array[i] == preferred_value) {
1052                 array[i] = array[0];
1053                 does_occur++;
1054             }
1055         if (does_occur)
1056             array[0] = preferred_value;
1057     }
1058     return does_occur;
1059 }
1060 
1061 /**
1062  * dccp_feat_reconcile  -  Reconcile SP preference lists
1063  *  @fv: SP list to reconcile into
1064  *  @arr: received SP preference list
1065  *  @len: length of @arr in bytes
1066  *  @is_server: whether this side is the server (and @fv is the server's list)
1067  *  @reorder: whether to reorder the list in @fv after reconciling with @arr
1068  * When successful, > 0 is returned and the reconciled list is in @fval.
1069  * A value of 0 means that negotiation failed (no shared entry).
1070  */
1071 static int dccp_feat_reconcile(dccp_feat_val *fv, u8 *arr, u8 len,
1072                    bool is_server, bool reorder)
1073 {
1074     int rc;
1075 
1076     if (!fv->sp.vec || !arr) {
1077         DCCP_CRIT("NULL feature value or array");
1078         return 0;
1079     }
1080 
1081     if (is_server)
1082         rc = dccp_feat_preflist_match(fv->sp.vec, fv->sp.len, arr, len);
1083     else
1084         rc = dccp_feat_preflist_match(arr, len, fv->sp.vec, fv->sp.len);
1085 
1086     if (!reorder)
1087         return rc;
1088     if (rc < 0)
1089         return 0;
1090 
1091     /*
1092      * Reorder list: used for activating features and in dccp_insert_fn_opt.
1093      */
1094     return dccp_feat_prefer(rc, fv->sp.vec, fv->sp.len);
1095 }
1096 
1097 /**
1098  * dccp_feat_change_recv  -  Process incoming ChangeL/R options
1099  * @fn: feature-negotiation list to update
1100  * @is_mandatory: whether the Change was preceded by a Mandatory option
1101  * @opt: %DCCPO_CHANGE_L or %DCCPO_CHANGE_R
1102  * @feat: one of %dccp_feature_numbers
1103  * @val: NN value or SP value/preference list
1104  * @len: length of @val in bytes
1105  * @server: whether this node is the server (1) or the client (0)
1106  */
1107 static u8 dccp_feat_change_recv(struct list_head *fn, u8 is_mandatory, u8 opt,
1108                 u8 feat, u8 *val, u8 len, const bool server)
1109 {
1110     u8 defval, type = dccp_feat_type(feat);
1111     const bool local = (opt == DCCPO_CHANGE_R);
1112     struct dccp_feat_entry *entry;
1113     dccp_feat_val fval;
1114 
1115     if (len == 0 || type == FEAT_UNKNOWN)       /* 6.1 and 6.6.8 */
1116         goto unknown_feature_or_value;
1117 
1118     dccp_feat_print_opt(opt, feat, val, len, is_mandatory);
1119 
1120     /*
1121      *  Negotiation of NN features: Change R is invalid, so there is no
1122      *  simultaneous negotiation; hence we do not look up in the list.
1123      */
1124     if (type == FEAT_NN) {
1125         if (local || len > sizeof(fval.nn))
1126             goto unknown_feature_or_value;
1127 
1128         /* 6.3.2: "The feature remote MUST accept any valid value..." */
1129         fval.nn = dccp_decode_value_var(val, len);
1130         if (!dccp_feat_is_valid_nn_val(feat, fval.nn))
1131             goto unknown_feature_or_value;
1132 
1133         return dccp_feat_push_confirm(fn, feat, local, &fval);
1134     }
1135 
1136     /*
1137      *  Unidirectional/simultaneous negotiation of SP features (6.3.1)
1138      */
1139     entry = dccp_feat_list_lookup(fn, feat, local);
1140     if (entry == NULL) {
1141         /*
1142          * No particular preferences have been registered. We deal with
1143          * this situation by assuming that all valid values are equally
1144          * acceptable, and apply the following checks:
1145          * - if the peer's list is a singleton, we accept a valid value;
1146          * - if we are the server, we first try to see if the peer (the
1147          *   client) advertises the default value. If yes, we use it,
1148          *   otherwise we accept the preferred value;
1149          * - else if we are the client, we use the first list element.
1150          */
1151         if (dccp_feat_clone_sp_val(&fval, val, 1))
1152             return DCCP_RESET_CODE_TOO_BUSY;
1153 
1154         if (len > 1 && server) {
1155             defval = dccp_feat_default_value(feat);
1156             if (dccp_feat_preflist_match(&defval, 1, val, len) > -1)
1157                 fval.sp.vec[0] = defval;
1158         } else if (!dccp_feat_is_valid_sp_val(feat, fval.sp.vec[0])) {
1159             kfree(fval.sp.vec);
1160             goto unknown_feature_or_value;
1161         }
1162 
1163         /* Treat unsupported CCIDs like invalid values */
1164         if (feat == DCCPF_CCID && !ccid_support_check(fval.sp.vec, 1)) {
1165             kfree(fval.sp.vec);
1166             goto not_valid_or_not_known;
1167         }
1168 
1169         return dccp_feat_push_confirm(fn, feat, local, &fval);
1170 
1171     } else if (entry->state == FEAT_UNSTABLE) { /* 6.6.2 */
1172         return 0;
1173     }
1174 
1175     if (dccp_feat_reconcile(&entry->val, val, len, server, true)) {
1176         entry->empty_confirm = false;
1177     } else if (is_mandatory) {
1178         return DCCP_RESET_CODE_MANDATORY_ERROR;
1179     } else if (entry->state == FEAT_INITIALISING) {
1180         /*
1181          * Failed simultaneous negotiation (server only): try to `save'
1182          * the connection by checking whether entry contains the default
1183          * value for @feat. If yes, send an empty Confirm to signal that
1184          * the received Change was not understood - which implies using
1185          * the default value.
1186          * If this also fails, we use Reset as the last resort.
1187          */
1188         WARN_ON(!server);
1189         defval = dccp_feat_default_value(feat);
1190         if (!dccp_feat_reconcile(&entry->val, &defval, 1, server, true))
1191             return DCCP_RESET_CODE_OPTION_ERROR;
1192         entry->empty_confirm = true;
1193     }
1194     entry->needs_confirm   = true;
1195     entry->needs_mandatory = false;
1196     entry->state           = FEAT_STABLE;
1197     return 0;
1198 
1199 unknown_feature_or_value:
1200     if (!is_mandatory)
1201         return dccp_push_empty_confirm(fn, feat, local);
1202 
1203 not_valid_or_not_known:
1204     return is_mandatory ? DCCP_RESET_CODE_MANDATORY_ERROR
1205                 : DCCP_RESET_CODE_OPTION_ERROR;
1206 }
1207 
1208 /**
1209  * dccp_feat_confirm_recv  -  Process received Confirm options
1210  * @fn: feature-negotiation list to update
1211  * @is_mandatory: whether @opt was preceded by a Mandatory option
1212  * @opt: %DCCPO_CONFIRM_L or %DCCPO_CONFIRM_R
1213  * @feat: one of %dccp_feature_numbers
1214  * @val: NN value or SP value/preference list
1215  * @len: length of @val in bytes
1216  * @server: whether this node is server (1) or client (0)
1217  */
1218 static u8 dccp_feat_confirm_recv(struct list_head *fn, u8 is_mandatory, u8 opt,
1219                  u8 feat, u8 *val, u8 len, const bool server)
1220 {
1221     u8 *plist, plen, type = dccp_feat_type(feat);
1222     const bool local = (opt == DCCPO_CONFIRM_R);
1223     struct dccp_feat_entry *entry = dccp_feat_list_lookup(fn, feat, local);
1224 
1225     dccp_feat_print_opt(opt, feat, val, len, is_mandatory);
1226 
1227     if (entry == NULL) {    /* nothing queued: ignore or handle error */
1228         if (is_mandatory && type == FEAT_UNKNOWN)
1229             return DCCP_RESET_CODE_MANDATORY_ERROR;
1230 
1231         if (!local && type == FEAT_NN)      /* 6.3.2 */
1232             goto confirmation_failed;
1233         return 0;
1234     }
1235 
1236     if (entry->state != FEAT_CHANGING)      /* 6.6.2 */
1237         return 0;
1238 
1239     if (len == 0) {
1240         if (dccp_feat_must_be_understood(feat)) /* 6.6.7 */
1241             goto confirmation_failed;
1242         /*
1243          * Empty Confirm during connection setup: this means reverting
1244          * to the `old' value, which in this case is the default. Since
1245          * we handle default values automatically when no other values
1246          * have been set, we revert to the old value by removing this
1247          * entry from the list.
1248          */
1249         dccp_feat_list_pop(entry);
1250         return 0;
1251     }
1252 
1253     if (type == FEAT_NN) {
1254         if (len > sizeof(entry->val.nn))
1255             goto confirmation_failed;
1256 
1257         if (entry->val.nn == dccp_decode_value_var(val, len))
1258             goto confirmation_succeeded;
1259 
1260         DCCP_WARN("Bogus Confirm for non-existing value\n");
1261         goto confirmation_failed;
1262     }
1263 
1264     /*
1265      * Parsing SP Confirms: the first element of @val is the preferred
1266      * SP value which the peer confirms, the remainder depends on @len.
1267      * Note that only the confirmed value need to be a valid SP value.
1268      */
1269     if (!dccp_feat_is_valid_sp_val(feat, *val))
1270         goto confirmation_failed;
1271 
1272     if (len == 1) {     /* peer didn't supply a preference list */
1273         plist = val;
1274         plen  = len;
1275     } else {        /* preferred value + preference list */
1276         plist = val + 1;
1277         plen  = len - 1;
1278     }
1279 
1280     /* Check whether the peer got the reconciliation right (6.6.8) */
1281     if (dccp_feat_reconcile(&entry->val, plist, plen, server, 0) != *val) {
1282         DCCP_WARN("Confirm selected the wrong value %u\n", *val);
1283         return DCCP_RESET_CODE_OPTION_ERROR;
1284     }
1285     entry->val.sp.vec[0] = *val;
1286 
1287 confirmation_succeeded:
1288     entry->state = FEAT_STABLE;
1289     return 0;
1290 
1291 confirmation_failed:
1292     DCCP_WARN("Confirmation failed\n");
1293     return is_mandatory ? DCCP_RESET_CODE_MANDATORY_ERROR
1294                 : DCCP_RESET_CODE_OPTION_ERROR;
1295 }
1296 
1297 /**
1298  * dccp_feat_handle_nn_established  -  Fast-path reception of NN options
1299  * @sk:     socket of an established DCCP connection
1300  * @mandatory:  whether @opt was preceded by a Mandatory option
1301  * @opt:    %DCCPO_CHANGE_L | %DCCPO_CONFIRM_R (NN only)
1302  * @feat:   NN number, one of %dccp_feature_numbers
1303  * @val:    NN value
1304  * @len:    length of @val in bytes
1305  *
1306  * This function combines the functionality of change_recv/confirm_recv, with
1307  * the following differences (reset codes are the same):
1308  *    - cleanup after receiving the Confirm;
1309  *    - values are directly activated after successful parsing;
1310  *    - deliberately restricted to NN features.
1311  * The restriction to NN features is essential since SP features can have non-
1312  * predictable outcomes (depending on the remote configuration), and are inter-
1313  * dependent (CCIDs for instance cause further dependencies).
1314  */
1315 static u8 dccp_feat_handle_nn_established(struct sock *sk, u8 mandatory, u8 opt,
1316                       u8 feat, u8 *val, u8 len)
1317 {
1318     struct list_head *fn = &dccp_sk(sk)->dccps_featneg;
1319     const bool local = (opt == DCCPO_CONFIRM_R);
1320     struct dccp_feat_entry *entry;
1321     u8 type = dccp_feat_type(feat);
1322     dccp_feat_val fval;
1323 
1324     dccp_feat_print_opt(opt, feat, val, len, mandatory);
1325 
1326     /* Ignore non-mandatory unknown and non-NN features */
1327     if (type == FEAT_UNKNOWN) {
1328         if (local && !mandatory)
1329             return 0;
1330         goto fast_path_unknown;
1331     } else if (type != FEAT_NN) {
1332         return 0;
1333     }
1334 
1335     /*
1336      * We don't accept empty Confirms, since in fast-path feature
1337      * negotiation the values are enabled immediately after sending
1338      * the Change option.
1339      * Empty Changes on the other hand are invalid (RFC 4340, 6.1).
1340      */
1341     if (len == 0 || len > sizeof(fval.nn))
1342         goto fast_path_unknown;
1343 
1344     if (opt == DCCPO_CHANGE_L) {
1345         fval.nn = dccp_decode_value_var(val, len);
1346         if (!dccp_feat_is_valid_nn_val(feat, fval.nn))
1347             goto fast_path_unknown;
1348 
1349         if (dccp_feat_push_confirm(fn, feat, local, &fval) ||
1350             dccp_feat_activate(sk, feat, local, &fval))
1351             return DCCP_RESET_CODE_TOO_BUSY;
1352 
1353         /* set the `Ack Pending' flag to piggyback a Confirm */
1354         inet_csk_schedule_ack(sk);
1355 
1356     } else if (opt == DCCPO_CONFIRM_R) {
1357         entry = dccp_feat_list_lookup(fn, feat, local);
1358         if (entry == NULL || entry->state != FEAT_CHANGING)
1359             return 0;
1360 
1361         fval.nn = dccp_decode_value_var(val, len);
1362         /*
1363          * Just ignore a value that doesn't match our current value.
1364          * If the option changes twice within two RTTs, then at least
1365          * one CONFIRM will be received for the old value after a
1366          * new CHANGE was sent.
1367          */
1368         if (fval.nn != entry->val.nn)
1369             return 0;
1370 
1371         /* Only activate after receiving the Confirm option (6.6.1). */
1372         dccp_feat_activate(sk, feat, local, &fval);
1373 
1374         /* It has been confirmed - so remove the entry */
1375         dccp_feat_list_pop(entry);
1376 
1377     } else {
1378         DCCP_WARN("Received illegal option %u\n", opt);
1379         goto fast_path_failed;
1380     }
1381     return 0;
1382 
1383 fast_path_unknown:
1384     if (!mandatory)
1385         return dccp_push_empty_confirm(fn, feat, local);
1386 
1387 fast_path_failed:
1388     return mandatory ? DCCP_RESET_CODE_MANDATORY_ERROR
1389              : DCCP_RESET_CODE_OPTION_ERROR;
1390 }
1391 
1392 /**
1393  * dccp_feat_parse_options  -  Process Feature-Negotiation Options
1394  * @sk: for general use and used by the client during connection setup
1395  * @dreq: used by the server during connection setup
1396  * @mandatory: whether @opt was preceded by a Mandatory option
1397  * @opt: %DCCPO_CHANGE_L | %DCCPO_CHANGE_R | %DCCPO_CONFIRM_L | %DCCPO_CONFIRM_R
1398  * @feat: one of %dccp_feature_numbers
1399  * @val: value contents of @opt
1400  * @len: length of @val in bytes
1401  *
1402  * Returns 0 on success, a Reset code for ending the connection otherwise.
1403  */
1404 int dccp_feat_parse_options(struct sock *sk, struct dccp_request_sock *dreq,
1405                 u8 mandatory, u8 opt, u8 feat, u8 *val, u8 len)
1406 {
1407     struct dccp_sock *dp = dccp_sk(sk);
1408     struct list_head *fn = dreq ? &dreq->dreq_featneg : &dp->dccps_featneg;
1409     bool server = false;
1410 
1411     switch (sk->sk_state) {
1412     /*
1413      *  Negotiation during connection setup
1414      */
1415     case DCCP_LISTEN:
1416         server = true;
1417         fallthrough;
1418     case DCCP_REQUESTING:
1419         switch (opt) {
1420         case DCCPO_CHANGE_L:
1421         case DCCPO_CHANGE_R:
1422             return dccp_feat_change_recv(fn, mandatory, opt, feat,
1423                              val, len, server);
1424         case DCCPO_CONFIRM_R:
1425         case DCCPO_CONFIRM_L:
1426             return dccp_feat_confirm_recv(fn, mandatory, opt, feat,
1427                               val, len, server);
1428         }
1429         break;
1430     /*
1431      *  Support for exchanging NN options on an established connection.
1432      */
1433     case DCCP_OPEN:
1434     case DCCP_PARTOPEN:
1435         return dccp_feat_handle_nn_established(sk, mandatory, opt, feat,
1436                                val, len);
1437     }
1438     return 0;   /* ignore FN options in all other states */
1439 }
1440 
1441 /**
1442  * dccp_feat_init  -  Seed feature negotiation with host-specific defaults
1443  * @sk: Socket to initialize.
1444  *
1445  * This initialises global defaults, depending on the value of the sysctls.
1446  * These can later be overridden by registering changes via setsockopt calls.
1447  * The last link in the chain is finalise_settings, to make sure that between
1448  * here and the start of actual feature negotiation no inconsistencies enter.
1449  *
1450  * All features not appearing below use either defaults or are otherwise
1451  * later adjusted through dccp_feat_finalise_settings().
1452  */
1453 int dccp_feat_init(struct sock *sk)
1454 {
1455     struct list_head *fn = &dccp_sk(sk)->dccps_featneg;
1456     u8 on = 1, off = 0;
1457     int rc;
1458     struct {
1459         u8 *val;
1460         u8 len;
1461     } tx, rx;
1462 
1463     /* Non-negotiable (NN) features */
1464     rc = __feat_register_nn(fn, DCCPF_SEQUENCE_WINDOW, 0,
1465                     sysctl_dccp_sequence_window);
1466     if (rc)
1467         return rc;
1468 
1469     /* Server-priority (SP) features */
1470 
1471     /* Advertise that short seqnos are not supported (7.6.1) */
1472     rc = __feat_register_sp(fn, DCCPF_SHORT_SEQNOS, true, true, &off, 1);
1473     if (rc)
1474         return rc;
1475 
1476     /* RFC 4340 12.1: "If a DCCP is not ECN capable, ..." */
1477     rc = __feat_register_sp(fn, DCCPF_ECN_INCAPABLE, true, true, &on, 1);
1478     if (rc)
1479         return rc;
1480 
1481     /*
1482      * We advertise the available list of CCIDs and reorder according to
1483      * preferences, to avoid failure resulting from negotiating different
1484      * singleton values (which always leads to failure).
1485      * These settings can still (later) be overridden via sockopts.
1486      */
1487     if (ccid_get_builtin_ccids(&tx.val, &tx.len))
1488         return -ENOBUFS;
1489     if (ccid_get_builtin_ccids(&rx.val, &rx.len)) {
1490         kfree(tx.val);
1491         return -ENOBUFS;
1492     }
1493 
1494     if (!dccp_feat_prefer(sysctl_dccp_tx_ccid, tx.val, tx.len) ||
1495         !dccp_feat_prefer(sysctl_dccp_rx_ccid, rx.val, rx.len))
1496         goto free_ccid_lists;
1497 
1498     rc = __feat_register_sp(fn, DCCPF_CCID, true, false, tx.val, tx.len);
1499     if (rc)
1500         goto free_ccid_lists;
1501 
1502     rc = __feat_register_sp(fn, DCCPF_CCID, false, false, rx.val, rx.len);
1503 
1504 free_ccid_lists:
1505     kfree(tx.val);
1506     kfree(rx.val);
1507     return rc;
1508 }
1509 
1510 int dccp_feat_activate_values(struct sock *sk, struct list_head *fn_list)
1511 {
1512     struct dccp_sock *dp = dccp_sk(sk);
1513     struct dccp_feat_entry *cur, *next;
1514     int idx;
1515     dccp_feat_val *fvals[DCCP_FEAT_SUPPORTED_MAX][2] = {
1516          [0 ... DCCP_FEAT_SUPPORTED_MAX-1] = { NULL, NULL }
1517     };
1518 
1519     list_for_each_entry(cur, fn_list, node) {
1520         /*
1521          * An empty Confirm means that either an unknown feature type
1522          * or an invalid value was present. In the first case there is
1523          * nothing to activate, in the other the default value is used.
1524          */
1525         if (cur->empty_confirm)
1526             continue;
1527 
1528         idx = dccp_feat_index(cur->feat_num);
1529         if (idx < 0) {
1530             DCCP_BUG("Unknown feature %u", cur->feat_num);
1531             goto activation_failed;
1532         }
1533         if (cur->state != FEAT_STABLE) {
1534             DCCP_CRIT("Negotiation of %s %s failed in state %s",
1535                   cur->is_local ? "local" : "remote",
1536                   dccp_feat_fname(cur->feat_num),
1537                   dccp_feat_sname[cur->state]);
1538             goto activation_failed;
1539         }
1540         fvals[idx][cur->is_local] = &cur->val;
1541     }
1542 
1543     /*
1544      * Activate in decreasing order of index, so that the CCIDs are always
1545      * activated as the last feature. This avoids the case where a CCID
1546      * relies on the initialisation of one or more features that it depends
1547      * on (e.g. Send NDP Count, Send Ack Vector, and Ack Ratio features).
1548      */
1549     for (idx = DCCP_FEAT_SUPPORTED_MAX; --idx >= 0;)
1550         if (__dccp_feat_activate(sk, idx, 0, fvals[idx][0]) ||
1551             __dccp_feat_activate(sk, idx, 1, fvals[idx][1])) {
1552             DCCP_CRIT("Could not activate %d", idx);
1553             goto activation_failed;
1554         }
1555 
1556     /* Clean up Change options which have been confirmed already */
1557     list_for_each_entry_safe(cur, next, fn_list, node)
1558         if (!cur->needs_confirm)
1559             dccp_feat_list_pop(cur);
1560 
1561     dccp_pr_debug("Activation OK\n");
1562     return 0;
1563 
1564 activation_failed:
1565     /*
1566      * We clean up everything that may have been allocated, since
1567      * it is difficult to track at which stage negotiation failed.
1568      * This is ok, since all allocation functions below are robust
1569      * against NULL arguments.
1570      */
1571     ccid_hc_rx_delete(dp->dccps_hc_rx_ccid, sk);
1572     ccid_hc_tx_delete(dp->dccps_hc_tx_ccid, sk);
1573     dp->dccps_hc_rx_ccid = dp->dccps_hc_tx_ccid = NULL;
1574     dccp_ackvec_free(dp->dccps_hc_rx_ackvec);
1575     dp->dccps_hc_rx_ackvec = NULL;
1576     return -1;
1577 }