1 // SPDX-License-Identifier: GPL-2.0
2 /* Generic nexthop implementation
4 * Copyright (c) 2017-19 Cumulus Networks
8 #include <linux/nexthop.h>
9 #include <linux/rtnetlink.h>
10 #include <linux/slab.h>
11 #include <linux/vmalloc.h>
13 #include <net/ipv6_stubs.h>
14 #include <net/lwtunnel.h>
15 #include <net/ndisc.h>
16 #include <net/nexthop.h>
17 #include <net/route.h>
20 #define NH_RES_DEFAULT_IDLE_TIMER (120 * HZ)
21 #define NH_RES_DEFAULT_UNBALANCED_TIMER 0 /* No forced rebalancing. */
23 static void remove_nexthop(struct net *net, struct nexthop *nh,
24 struct nl_info *nlinfo);
26 #define NH_DEV_HASHBITS 8
27 #define NH_DEV_HASHSIZE (1U << NH_DEV_HASHBITS)
29 #define NHA_OP_FLAGS_DUMP_ALL (NHA_OP_FLAG_DUMP_STATS | \
30 NHA_OP_FLAG_DUMP_HW_STATS)
32 static const struct nla_policy rtm_nh_policy_new[] = {
33 [NHA_ID] = { .type = NLA_U32 },
34 [NHA_GROUP] = { .type = NLA_BINARY },
35 [NHA_GROUP_TYPE] = { .type = NLA_U16 },
36 [NHA_BLACKHOLE] = { .type = NLA_FLAG },
37 [NHA_OIF] = { .type = NLA_U32 },
38 [NHA_GATEWAY] = { .type = NLA_BINARY },
39 [NHA_ENCAP_TYPE] = { .type = NLA_U16 },
40 [NHA_ENCAP] = { .type = NLA_NESTED },
41 [NHA_FDB] = { .type = NLA_FLAG },
42 [NHA_RES_GROUP] = { .type = NLA_NESTED },
43 [NHA_HW_STATS_ENABLE] = NLA_POLICY_MAX(NLA_U32, true),
46 static const struct nla_policy rtm_nh_policy_get[] = {
47 [NHA_ID] = { .type = NLA_U32 },
48 [NHA_OP_FLAGS] = NLA_POLICY_MASK(NLA_U32,
49 NHA_OP_FLAGS_DUMP_ALL),
52 static const struct nla_policy rtm_nh_policy_del[] = {
53 [NHA_ID] = { .type = NLA_U32 },
56 static const struct nla_policy rtm_nh_policy_dump[] = {
57 [NHA_OIF] = { .type = NLA_U32 },
58 [NHA_GROUPS] = { .type = NLA_FLAG },
59 [NHA_MASTER] = { .type = NLA_U32 },
60 [NHA_FDB] = { .type = NLA_FLAG },
61 [NHA_OP_FLAGS] = NLA_POLICY_MASK(NLA_U32,
62 NHA_OP_FLAGS_DUMP_ALL),
65 static const struct nla_policy rtm_nh_res_policy_new[] = {
66 [NHA_RES_GROUP_BUCKETS] = { .type = NLA_U16 },
67 [NHA_RES_GROUP_IDLE_TIMER] = { .type = NLA_U32 },
68 [NHA_RES_GROUP_UNBALANCED_TIMER] = { .type = NLA_U32 },
71 static const struct nla_policy rtm_nh_policy_dump_bucket[] = {
72 [NHA_ID] = { .type = NLA_U32 },
73 [NHA_OIF] = { .type = NLA_U32 },
74 [NHA_MASTER] = { .type = NLA_U32 },
75 [NHA_RES_BUCKET] = { .type = NLA_NESTED },
78 static const struct nla_policy rtm_nh_res_bucket_policy_dump[] = {
79 [NHA_RES_BUCKET_NH_ID] = { .type = NLA_U32 },
82 static const struct nla_policy rtm_nh_policy_get_bucket[] = {
83 [NHA_ID] = { .type = NLA_U32 },
84 [NHA_RES_BUCKET] = { .type = NLA_NESTED },
87 static const struct nla_policy rtm_nh_res_bucket_policy_get[] = {
88 [NHA_RES_BUCKET_INDEX] = { .type = NLA_U16 },
91 static bool nexthop_notifiers_is_empty(struct net *net)
93 return !net->nexthop.notifier_chain.head;
97 __nh_notifier_single_info_init(struct nh_notifier_single_info *nh_info,
98 const struct nh_info *nhi)
100 nh_info->dev = nhi->fib_nhc.nhc_dev;
101 nh_info->gw_family = nhi->fib_nhc.nhc_gw_family;
102 if (nh_info->gw_family == AF_INET)
103 nh_info->ipv4 = nhi->fib_nhc.nhc_gw.ipv4;
104 else if (nh_info->gw_family == AF_INET6)
105 nh_info->ipv6 = nhi->fib_nhc.nhc_gw.ipv6;
107 nh_info->id = nhi->nh_parent->id;
108 nh_info->is_reject = nhi->reject_nh;
109 nh_info->is_fdb = nhi->fdb_nh;
110 nh_info->has_encap = !!nhi->fib_nhc.nhc_lwtstate;
113 static int nh_notifier_single_info_init(struct nh_notifier_info *info,
114 const struct nexthop *nh)
116 struct nh_info *nhi = rtnl_dereference(nh->nh_info);
118 info->type = NH_NOTIFIER_INFO_TYPE_SINGLE;
119 info->nh = kzalloc(sizeof(*info->nh), GFP_KERNEL);
123 __nh_notifier_single_info_init(info->nh, nhi);
128 static void nh_notifier_single_info_fini(struct nh_notifier_info *info)
133 static int nh_notifier_mpath_info_init(struct nh_notifier_info *info,
134 struct nh_group *nhg)
136 u16 num_nh = nhg->num_nh;
139 info->type = NH_NOTIFIER_INFO_TYPE_GRP;
140 info->nh_grp = kzalloc(struct_size(info->nh_grp, nh_entries, num_nh),
145 info->nh_grp->num_nh = num_nh;
146 info->nh_grp->is_fdb = nhg->fdb_nh;
147 info->nh_grp->hw_stats = nhg->hw_stats;
149 for (i = 0; i < num_nh; i++) {
150 struct nh_grp_entry *nhge = &nhg->nh_entries[i];
153 nhi = rtnl_dereference(nhge->nh->nh_info);
154 info->nh_grp->nh_entries[i].weight = nhge->weight;
155 __nh_notifier_single_info_init(&info->nh_grp->nh_entries[i].nh,
162 static int nh_notifier_res_table_info_init(struct nh_notifier_info *info,
163 struct nh_group *nhg)
165 struct nh_res_table *res_table = rtnl_dereference(nhg->res_table);
166 u16 num_nh_buckets = res_table->num_nh_buckets;
170 info->type = NH_NOTIFIER_INFO_TYPE_RES_TABLE;
171 size = struct_size(info->nh_res_table, nhs, num_nh_buckets);
172 info->nh_res_table = __vmalloc(size, GFP_KERNEL | __GFP_ZERO |
174 if (!info->nh_res_table)
177 info->nh_res_table->num_nh_buckets = num_nh_buckets;
178 info->nh_res_table->hw_stats = nhg->hw_stats;
180 for (i = 0; i < num_nh_buckets; i++) {
181 struct nh_res_bucket *bucket = &res_table->nh_buckets[i];
182 struct nh_grp_entry *nhge;
185 nhge = rtnl_dereference(bucket->nh_entry);
186 nhi = rtnl_dereference(nhge->nh->nh_info);
187 __nh_notifier_single_info_init(&info->nh_res_table->nhs[i],
194 static int nh_notifier_grp_info_init(struct nh_notifier_info *info,
195 const struct nexthop *nh)
197 struct nh_group *nhg = rtnl_dereference(nh->nh_grp);
199 if (nhg->hash_threshold)
200 return nh_notifier_mpath_info_init(info, nhg);
201 else if (nhg->resilient)
202 return nh_notifier_res_table_info_init(info, nhg);
206 static void nh_notifier_grp_info_fini(struct nh_notifier_info *info,
207 const struct nexthop *nh)
209 struct nh_group *nhg = rtnl_dereference(nh->nh_grp);
211 if (nhg->hash_threshold)
213 else if (nhg->resilient)
214 vfree(info->nh_res_table);
217 static int nh_notifier_info_init(struct nh_notifier_info *info,
218 const struct nexthop *nh)
223 return nh_notifier_grp_info_init(info, nh);
225 return nh_notifier_single_info_init(info, nh);
228 static void nh_notifier_info_fini(struct nh_notifier_info *info,
229 const struct nexthop *nh)
232 nh_notifier_grp_info_fini(info, nh);
234 nh_notifier_single_info_fini(info);
237 static int call_nexthop_notifiers(struct net *net,
238 enum nexthop_event_type event_type,
240 struct netlink_ext_ack *extack)
242 struct nh_notifier_info info = {
250 if (nexthop_notifiers_is_empty(net))
253 err = nh_notifier_info_init(&info, nh);
255 NL_SET_ERR_MSG(extack, "Failed to initialize nexthop notifier info");
259 err = blocking_notifier_call_chain(&net->nexthop.notifier_chain,
261 nh_notifier_info_fini(&info, nh);
263 return notifier_to_errno(err);
267 nh_notifier_res_bucket_idle_timer_get(const struct nh_notifier_info *info,
268 bool force, unsigned int *p_idle_timer_ms)
270 struct nh_res_table *res_table;
271 struct nh_group *nhg;
275 /* When 'force' is false, nexthop bucket replacement is performed
276 * because the bucket was deemed to be idle. In this case, capable
277 * listeners can choose to perform an atomic replacement: The bucket is
278 * only replaced if it is inactive. However, if the idle timer interval
279 * is smaller than the interval in which a listener is querying
280 * buckets' activity from the device, then atomic replacement should
281 * not be tried. Pass the idle timer value to listeners, so that they
282 * could determine which type of replacement to perform.
285 *p_idle_timer_ms = 0;
291 nh = nexthop_find_by_id(info->net, info->id);
297 nhg = rcu_dereference(nh->nh_grp);
298 res_table = rcu_dereference(nhg->res_table);
299 *p_idle_timer_ms = jiffies_to_msecs(res_table->idle_timer);
307 static int nh_notifier_res_bucket_info_init(struct nh_notifier_info *info,
308 u16 bucket_index, bool force,
309 struct nh_info *oldi,
310 struct nh_info *newi)
312 unsigned int idle_timer_ms;
315 err = nh_notifier_res_bucket_idle_timer_get(info, force,
320 info->type = NH_NOTIFIER_INFO_TYPE_RES_BUCKET;
321 info->nh_res_bucket = kzalloc(sizeof(*info->nh_res_bucket),
323 if (!info->nh_res_bucket)
326 info->nh_res_bucket->bucket_index = bucket_index;
327 info->nh_res_bucket->idle_timer_ms = idle_timer_ms;
328 info->nh_res_bucket->force = force;
329 __nh_notifier_single_info_init(&info->nh_res_bucket->old_nh, oldi);
330 __nh_notifier_single_info_init(&info->nh_res_bucket->new_nh, newi);
334 static void nh_notifier_res_bucket_info_fini(struct nh_notifier_info *info)
336 kfree(info->nh_res_bucket);
339 static int __call_nexthop_res_bucket_notifiers(struct net *net, u32 nhg_id,
340 u16 bucket_index, bool force,
341 struct nh_info *oldi,
342 struct nh_info *newi,
343 struct netlink_ext_ack *extack)
345 struct nh_notifier_info info = {
352 if (nexthop_notifiers_is_empty(net))
355 err = nh_notifier_res_bucket_info_init(&info, bucket_index, force,
360 err = blocking_notifier_call_chain(&net->nexthop.notifier_chain,
361 NEXTHOP_EVENT_BUCKET_REPLACE, &info);
362 nh_notifier_res_bucket_info_fini(&info);
364 return notifier_to_errno(err);
367 /* There are three users of RES_TABLE, and NHs etc. referenced from there:
369 * 1) a collection of callbacks for NH maintenance. This operates under
371 * 2) the delayed work that gradually balances the resilient table,
372 * 3) and nexthop_select_path(), operating under RCU.
374 * Both the delayed work and the RTNL block are writers, and need to
375 * maintain mutual exclusion. Since there are only two and well-known
376 * writers for each table, the RTNL code can make sure it has exclusive
379 * - Have the DW operate without locking;
380 * - synchronously cancel the DW;
382 * - if the write was not actually a delete, call upkeep, which schedules
383 * DW again if necessary.
385 * The functions that are always called from the RTNL context use
386 * rtnl_dereference(). The functions that can also be called from the DW do
387 * a raw dereference and rely on the above mutual exclusion scheme.
389 #define nh_res_dereference(p) (rcu_dereference_raw(p))
391 static int call_nexthop_res_bucket_notifiers(struct net *net, u32 nhg_id,
392 u16 bucket_index, bool force,
393 struct nexthop *old_nh,
394 struct nexthop *new_nh,
395 struct netlink_ext_ack *extack)
397 struct nh_info *oldi = nh_res_dereference(old_nh->nh_info);
398 struct nh_info *newi = nh_res_dereference(new_nh->nh_info);
400 return __call_nexthop_res_bucket_notifiers(net, nhg_id, bucket_index,
401 force, oldi, newi, extack);
404 static int call_nexthop_res_table_notifiers(struct net *net, struct nexthop *nh,
405 struct netlink_ext_ack *extack)
407 struct nh_notifier_info info = {
412 struct nh_group *nhg;
417 if (nexthop_notifiers_is_empty(net))
420 /* At this point, the nexthop buckets are still not populated. Only
421 * emit a notification with the logical nexthops, so that a listener
422 * could potentially veto it in case of unsupported configuration.
424 nhg = rtnl_dereference(nh->nh_grp);
425 err = nh_notifier_mpath_info_init(&info, nhg);
427 NL_SET_ERR_MSG(extack, "Failed to initialize nexthop notifier info");
431 err = blocking_notifier_call_chain(&net->nexthop.notifier_chain,
432 NEXTHOP_EVENT_RES_TABLE_PRE_REPLACE,
436 return notifier_to_errno(err);
439 static int call_nexthop_notifier(struct notifier_block *nb, struct net *net,
440 enum nexthop_event_type event_type,
442 struct netlink_ext_ack *extack)
444 struct nh_notifier_info info = {
450 err = nh_notifier_info_init(&info, nh);
454 err = nb->notifier_call(nb, event_type, &info);
455 nh_notifier_info_fini(&info, nh);
457 return notifier_to_errno(err);
460 static unsigned int nh_dev_hashfn(unsigned int val)
462 unsigned int mask = NH_DEV_HASHSIZE - 1;
465 (val >> NH_DEV_HASHBITS) ^
466 (val >> (NH_DEV_HASHBITS * 2))) & mask;
469 static void nexthop_devhash_add(struct net *net, struct nh_info *nhi)
471 struct net_device *dev = nhi->fib_nhc.nhc_dev;
472 struct hlist_head *head;
477 hash = nh_dev_hashfn(dev->ifindex);
478 head = &net->nexthop.devhash[hash];
479 hlist_add_head(&nhi->dev_hash, head);
482 static void nexthop_free_group(struct nexthop *nh)
484 struct nh_group *nhg;
487 nhg = rcu_dereference_raw(nh->nh_grp);
488 for (i = 0; i < nhg->num_nh; ++i) {
489 struct nh_grp_entry *nhge = &nhg->nh_entries[i];
491 WARN_ON(!list_empty(&nhge->nh_list));
492 free_percpu(nhge->stats);
493 nexthop_put(nhge->nh);
496 WARN_ON(nhg->spare == nhg);
499 vfree(rcu_dereference_raw(nhg->res_table));
505 static void nexthop_free_single(struct nexthop *nh)
509 nhi = rcu_dereference_raw(nh->nh_info);
510 switch (nhi->family) {
512 fib_nh_release(nh->net, &nhi->fib_nh);
515 ipv6_stub->fib6_nh_release(&nhi->fib6_nh);
521 void nexthop_free_rcu(struct rcu_head *head)
523 struct nexthop *nh = container_of(head, struct nexthop, rcu);
526 nexthop_free_group(nh);
528 nexthop_free_single(nh);
532 EXPORT_SYMBOL_GPL(nexthop_free_rcu);
534 static struct nexthop *nexthop_alloc(void)
538 nh = kzalloc(sizeof(struct nexthop), GFP_KERNEL);
540 INIT_LIST_HEAD(&nh->fi_list);
541 INIT_LIST_HEAD(&nh->f6i_list);
542 INIT_LIST_HEAD(&nh->grp_list);
543 INIT_LIST_HEAD(&nh->fdb_list);
548 static struct nh_group *nexthop_grp_alloc(u16 num_nh)
550 struct nh_group *nhg;
552 nhg = kzalloc(struct_size(nhg, nh_entries, num_nh), GFP_KERNEL);
554 nhg->num_nh = num_nh;
559 static void nh_res_table_upkeep_dw(struct work_struct *work);
561 static struct nh_res_table *
562 nexthop_res_table_alloc(struct net *net, u32 nhg_id, struct nh_config *cfg)
564 const u16 num_nh_buckets = cfg->nh_grp_res_num_buckets;
565 struct nh_res_table *res_table;
568 size = struct_size(res_table, nh_buckets, num_nh_buckets);
569 res_table = __vmalloc(size, GFP_KERNEL | __GFP_ZERO | __GFP_NOWARN);
573 res_table->net = net;
574 res_table->nhg_id = nhg_id;
575 INIT_DELAYED_WORK(&res_table->upkeep_dw, &nh_res_table_upkeep_dw);
576 INIT_LIST_HEAD(&res_table->uw_nh_entries);
577 res_table->idle_timer = cfg->nh_grp_res_idle_timer;
578 res_table->unbalanced_timer = cfg->nh_grp_res_unbalanced_timer;
579 res_table->num_nh_buckets = num_nh_buckets;
583 static void nh_base_seq_inc(struct net *net)
585 while (++net->nexthop.seq == 0)
589 /* no reference taken; rcu lock or rtnl must be held */
590 struct nexthop *nexthop_find_by_id(struct net *net, u32 id)
592 struct rb_node **pp, *parent = NULL, *next;
594 pp = &net->nexthop.rb_root.rb_node;
598 next = rcu_dereference_raw(*pp);
603 nh = rb_entry(parent, struct nexthop, rb_node);
606 else if (id > nh->id)
607 pp = &next->rb_right;
613 EXPORT_SYMBOL_GPL(nexthop_find_by_id);
615 /* used for auto id allocation; called with rtnl held */
616 static u32 nh_find_unused_id(struct net *net)
618 u32 id_start = net->nexthop.last_id_allocated;
621 net->nexthop.last_id_allocated++;
622 if (net->nexthop.last_id_allocated == id_start)
625 if (!nexthop_find_by_id(net, net->nexthop.last_id_allocated))
626 return net->nexthop.last_id_allocated;
631 static void nh_res_time_set_deadline(unsigned long next_time,
632 unsigned long *deadline)
634 if (time_before(next_time, *deadline))
635 *deadline = next_time;
638 static clock_t nh_res_table_unbalanced_time(struct nh_res_table *res_table)
640 if (list_empty(&res_table->uw_nh_entries))
642 return jiffies_delta_to_clock_t(jiffies - res_table->unbalanced_since);
645 static int nla_put_nh_group_res(struct sk_buff *skb, struct nh_group *nhg)
647 struct nh_res_table *res_table = rtnl_dereference(nhg->res_table);
650 nest = nla_nest_start(skb, NHA_RES_GROUP);
654 if (nla_put_u16(skb, NHA_RES_GROUP_BUCKETS,
655 res_table->num_nh_buckets) ||
656 nla_put_u32(skb, NHA_RES_GROUP_IDLE_TIMER,
657 jiffies_to_clock_t(res_table->idle_timer)) ||
658 nla_put_u32(skb, NHA_RES_GROUP_UNBALANCED_TIMER,
659 jiffies_to_clock_t(res_table->unbalanced_timer)) ||
660 nla_put_u64_64bit(skb, NHA_RES_GROUP_UNBALANCED_TIME,
661 nh_res_table_unbalanced_time(res_table),
663 goto nla_put_failure;
665 nla_nest_end(skb, nest);
669 nla_nest_cancel(skb, nest);
673 static void nh_grp_entry_stats_inc(struct nh_grp_entry *nhge)
675 struct nh_grp_entry_stats *cpu_stats;
677 cpu_stats = get_cpu_ptr(nhge->stats);
678 u64_stats_update_begin(&cpu_stats->syncp);
679 u64_stats_inc(&cpu_stats->packets);
680 u64_stats_update_end(&cpu_stats->syncp);
681 put_cpu_ptr(cpu_stats);
684 static void nh_grp_entry_stats_read(struct nh_grp_entry *nhge,
691 for_each_possible_cpu(i) {
692 struct nh_grp_entry_stats *cpu_stats;
696 cpu_stats = per_cpu_ptr(nhge->stats, i);
698 start = u64_stats_fetch_begin(&cpu_stats->syncp);
699 packets = u64_stats_read(&cpu_stats->packets);
700 } while (u64_stats_fetch_retry(&cpu_stats->syncp, start));
702 *ret_packets += packets;
706 static int nh_notifier_grp_hw_stats_init(struct nh_notifier_info *info,
707 const struct nexthop *nh)
709 struct nh_group *nhg;
713 nhg = rtnl_dereference(nh->nh_grp);
716 info->type = NH_NOTIFIER_INFO_TYPE_GRP_HW_STATS;
717 info->nh_grp_hw_stats = kzalloc(struct_size(info->nh_grp_hw_stats,
720 if (!info->nh_grp_hw_stats)
723 info->nh_grp_hw_stats->num_nh = nhg->num_nh;
724 for (i = 0; i < nhg->num_nh; i++) {
725 struct nh_grp_entry *nhge = &nhg->nh_entries[i];
727 info->nh_grp_hw_stats->stats[i].id = nhge->nh->id;
733 static void nh_notifier_grp_hw_stats_fini(struct nh_notifier_info *info)
735 kfree(info->nh_grp_hw_stats);
738 void nh_grp_hw_stats_report_delta(struct nh_notifier_grp_hw_stats_info *info,
742 info->hw_stats_used = true;
743 info->stats[nh_idx].packets += delta_packets;
745 EXPORT_SYMBOL(nh_grp_hw_stats_report_delta);
747 static void nh_grp_hw_stats_apply_update(struct nexthop *nh,
748 struct nh_notifier_info *info)
750 struct nh_group *nhg;
754 nhg = rtnl_dereference(nh->nh_grp);
756 for (i = 0; i < nhg->num_nh; i++) {
757 struct nh_grp_entry *nhge = &nhg->nh_entries[i];
759 nhge->packets_hw += info->nh_grp_hw_stats->stats[i].packets;
763 static int nh_grp_hw_stats_update(struct nexthop *nh, bool *hw_stats_used)
765 struct nh_notifier_info info = {
768 struct net *net = nh->net;
771 if (nexthop_notifiers_is_empty(net)) {
772 *hw_stats_used = false;
776 err = nh_notifier_grp_hw_stats_init(&info, nh);
780 err = blocking_notifier_call_chain(&net->nexthop.notifier_chain,
781 NEXTHOP_EVENT_HW_STATS_REPORT_DELTA,
784 /* Cache whatever we got, even if there was an error, otherwise the
785 * successful stats retrievals would get lost.
787 nh_grp_hw_stats_apply_update(nh, &info);
788 *hw_stats_used = info.nh_grp_hw_stats->hw_stats_used;
790 nh_notifier_grp_hw_stats_fini(&info);
791 return notifier_to_errno(err);
794 static int nla_put_nh_group_stats_entry(struct sk_buff *skb,
795 struct nh_grp_entry *nhge,
801 nh_grp_entry_stats_read(nhge, &packets);
803 nest = nla_nest_start(skb, NHA_GROUP_STATS_ENTRY);
807 if (nla_put_u32(skb, NHA_GROUP_STATS_ENTRY_ID, nhge->nh->id) ||
808 nla_put_uint(skb, NHA_GROUP_STATS_ENTRY_PACKETS,
809 packets + nhge->packets_hw))
810 goto nla_put_failure;
812 if (op_flags & NHA_OP_FLAG_DUMP_HW_STATS &&
813 nla_put_uint(skb, NHA_GROUP_STATS_ENTRY_PACKETS_HW,
815 goto nla_put_failure;
817 nla_nest_end(skb, nest);
821 nla_nest_cancel(skb, nest);
825 static int nla_put_nh_group_stats(struct sk_buff *skb, struct nexthop *nh,
828 struct nh_group *nhg = rtnl_dereference(nh->nh_grp);
834 if (nla_put_u32(skb, NHA_HW_STATS_ENABLE, nhg->hw_stats))
837 if (op_flags & NHA_OP_FLAG_DUMP_HW_STATS &&
839 err = nh_grp_hw_stats_update(nh, &hw_stats_used);
843 if (nla_put_u32(skb, NHA_HW_STATS_USED, hw_stats_used))
847 nest = nla_nest_start(skb, NHA_GROUP_STATS);
851 for (i = 0; i < nhg->num_nh; i++)
852 if (nla_put_nh_group_stats_entry(skb, &nhg->nh_entries[i],
856 nla_nest_end(skb, nest);
860 nla_nest_cancel(skb, nest);
867 static int nla_put_nh_group(struct sk_buff *skb, struct nexthop *nh,
870 struct nh_group *nhg = rtnl_dereference(nh->nh_grp);
871 struct nexthop_grp *p;
872 size_t len = nhg->num_nh * sizeof(*p);
877 if (nhg->hash_threshold)
878 group_type = NEXTHOP_GRP_TYPE_MPATH;
879 else if (nhg->resilient)
880 group_type = NEXTHOP_GRP_TYPE_RES;
882 if (nla_put_u16(skb, NHA_GROUP_TYPE, group_type))
883 goto nla_put_failure;
885 nla = nla_reserve(skb, NHA_GROUP, len);
887 goto nla_put_failure;
890 for (i = 0; i < nhg->num_nh; ++i) {
891 *p++ = (struct nexthop_grp) {
892 .id = nhg->nh_entries[i].nh->id,
893 .weight = nhg->nh_entries[i].weight - 1,
897 if (nhg->resilient && nla_put_nh_group_res(skb, nhg))
898 goto nla_put_failure;
900 if (op_flags & NHA_OP_FLAG_DUMP_STATS &&
901 (nla_put_u32(skb, NHA_HW_STATS_ENABLE, nhg->hw_stats) ||
902 nla_put_nh_group_stats(skb, nh, op_flags)))
903 goto nla_put_failure;
911 static int nh_fill_node(struct sk_buff *skb, struct nexthop *nh,
912 int event, u32 portid, u32 seq, unsigned int nlflags,
915 struct fib6_nh *fib6_nh;
916 struct fib_nh *fib_nh;
917 struct nlmsghdr *nlh;
921 nlh = nlmsg_put(skb, portid, seq, event, sizeof(*nhm), nlflags);
925 nhm = nlmsg_data(nlh);
926 nhm->nh_family = AF_UNSPEC;
927 nhm->nh_flags = nh->nh_flags;
928 nhm->nh_protocol = nh->protocol;
932 if (nla_put_u32(skb, NHA_ID, nh->id))
933 goto nla_put_failure;
936 struct nh_group *nhg = rtnl_dereference(nh->nh_grp);
938 if (nhg->fdb_nh && nla_put_flag(skb, NHA_FDB))
939 goto nla_put_failure;
940 if (nla_put_nh_group(skb, nh, op_flags))
941 goto nla_put_failure;
945 nhi = rtnl_dereference(nh->nh_info);
946 nhm->nh_family = nhi->family;
947 if (nhi->reject_nh) {
948 if (nla_put_flag(skb, NHA_BLACKHOLE))
949 goto nla_put_failure;
951 } else if (nhi->fdb_nh) {
952 if (nla_put_flag(skb, NHA_FDB))
953 goto nla_put_failure;
955 const struct net_device *dev;
957 dev = nhi->fib_nhc.nhc_dev;
958 if (dev && nla_put_u32(skb, NHA_OIF, dev->ifindex))
959 goto nla_put_failure;
962 nhm->nh_scope = nhi->fib_nhc.nhc_scope;
963 switch (nhi->family) {
965 fib_nh = &nhi->fib_nh;
966 if (fib_nh->fib_nh_gw_family &&
967 nla_put_be32(skb, NHA_GATEWAY, fib_nh->fib_nh_gw4))
968 goto nla_put_failure;
972 fib6_nh = &nhi->fib6_nh;
973 if (fib6_nh->fib_nh_gw_family &&
974 nla_put_in6_addr(skb, NHA_GATEWAY, &fib6_nh->fib_nh_gw6))
975 goto nla_put_failure;
979 if (nhi->fib_nhc.nhc_lwtstate &&
980 lwtunnel_fill_encap(skb, nhi->fib_nhc.nhc_lwtstate,
981 NHA_ENCAP, NHA_ENCAP_TYPE) < 0)
982 goto nla_put_failure;
989 nlmsg_cancel(skb, nlh);
993 static size_t nh_nlmsg_size_grp_res(struct nh_group *nhg)
995 return nla_total_size(0) + /* NHA_RES_GROUP */
996 nla_total_size(2) + /* NHA_RES_GROUP_BUCKETS */
997 nla_total_size(4) + /* NHA_RES_GROUP_IDLE_TIMER */
998 nla_total_size(4) + /* NHA_RES_GROUP_UNBALANCED_TIMER */
999 nla_total_size_64bit(8);/* NHA_RES_GROUP_UNBALANCED_TIME */
1002 static size_t nh_nlmsg_size_grp(struct nexthop *nh)
1004 struct nh_group *nhg = rtnl_dereference(nh->nh_grp);
1005 size_t sz = sizeof(struct nexthop_grp) * nhg->num_nh;
1006 size_t tot = nla_total_size(sz) +
1007 nla_total_size(2); /* NHA_GROUP_TYPE */
1010 tot += nh_nlmsg_size_grp_res(nhg);
1015 static size_t nh_nlmsg_size_single(struct nexthop *nh)
1017 struct nh_info *nhi = rtnl_dereference(nh->nh_info);
1020 /* covers NHA_BLACKHOLE since NHA_OIF and BLACKHOLE
1021 * are mutually exclusive
1023 sz = nla_total_size(4); /* NHA_OIF */
1025 switch (nhi->family) {
1027 if (nhi->fib_nh.fib_nh_gw_family)
1028 sz += nla_total_size(4); /* NHA_GATEWAY */
1033 if (nhi->fib6_nh.fib_nh_gw_family)
1034 sz += nla_total_size(sizeof(const struct in6_addr));
1038 if (nhi->fib_nhc.nhc_lwtstate) {
1039 sz += lwtunnel_get_encap_size(nhi->fib_nhc.nhc_lwtstate);
1040 sz += nla_total_size(2); /* NHA_ENCAP_TYPE */
1046 static size_t nh_nlmsg_size(struct nexthop *nh)
1048 size_t sz = NLMSG_ALIGN(sizeof(struct nhmsg));
1050 sz += nla_total_size(4); /* NHA_ID */
1053 sz += nh_nlmsg_size_grp(nh);
1055 sz += nh_nlmsg_size_single(nh);
1060 static void nexthop_notify(int event, struct nexthop *nh, struct nl_info *info)
1062 unsigned int nlflags = info->nlh ? info->nlh->nlmsg_flags : 0;
1063 u32 seq = info->nlh ? info->nlh->nlmsg_seq : 0;
1064 struct sk_buff *skb;
1067 skb = nlmsg_new(nh_nlmsg_size(nh), gfp_any());
1071 err = nh_fill_node(skb, nh, event, info->portid, seq, nlflags, 0);
1073 /* -EMSGSIZE implies BUG in nh_nlmsg_size() */
1074 WARN_ON(err == -EMSGSIZE);
1079 rtnl_notify(skb, info->nl_net, info->portid, RTNLGRP_NEXTHOP,
1080 info->nlh, gfp_any());
1084 rtnl_set_sk_err(info->nl_net, RTNLGRP_NEXTHOP, err);
1087 static unsigned long nh_res_bucket_used_time(const struct nh_res_bucket *bucket)
1089 return (unsigned long)atomic_long_read(&bucket->used_time);
1092 static unsigned long
1093 nh_res_bucket_idle_point(const struct nh_res_table *res_table,
1094 const struct nh_res_bucket *bucket,
1097 unsigned long time = nh_res_bucket_used_time(bucket);
1099 /* Bucket was not used since it was migrated. The idle time is now. */
1100 if (time == bucket->migrated_time)
1103 return time + res_table->idle_timer;
1106 static unsigned long
1107 nh_res_table_unb_point(const struct nh_res_table *res_table)
1109 return res_table->unbalanced_since + res_table->unbalanced_timer;
1112 static void nh_res_bucket_set_idle(const struct nh_res_table *res_table,
1113 struct nh_res_bucket *bucket)
1115 unsigned long now = jiffies;
1117 atomic_long_set(&bucket->used_time, (long)now);
1118 bucket->migrated_time = now;
1121 static void nh_res_bucket_set_busy(struct nh_res_bucket *bucket)
1123 atomic_long_set(&bucket->used_time, (long)jiffies);
1126 static clock_t nh_res_bucket_idle_time(const struct nh_res_bucket *bucket)
1128 unsigned long used_time = nh_res_bucket_used_time(bucket);
1130 return jiffies_delta_to_clock_t(jiffies - used_time);
1133 static int nh_fill_res_bucket(struct sk_buff *skb, struct nexthop *nh,
1134 struct nh_res_bucket *bucket, u16 bucket_index,
1135 int event, u32 portid, u32 seq,
1136 unsigned int nlflags,
1137 struct netlink_ext_ack *extack)
1139 struct nh_grp_entry *nhge = nh_res_dereference(bucket->nh_entry);
1140 struct nlmsghdr *nlh;
1141 struct nlattr *nest;
1144 nlh = nlmsg_put(skb, portid, seq, event, sizeof(*nhm), nlflags);
1148 nhm = nlmsg_data(nlh);
1149 nhm->nh_family = AF_UNSPEC;
1150 nhm->nh_flags = bucket->nh_flags;
1151 nhm->nh_protocol = nh->protocol;
1155 if (nla_put_u32(skb, NHA_ID, nh->id))
1156 goto nla_put_failure;
1158 nest = nla_nest_start(skb, NHA_RES_BUCKET);
1160 goto nla_put_failure;
1162 if (nla_put_u16(skb, NHA_RES_BUCKET_INDEX, bucket_index) ||
1163 nla_put_u32(skb, NHA_RES_BUCKET_NH_ID, nhge->nh->id) ||
1164 nla_put_u64_64bit(skb, NHA_RES_BUCKET_IDLE_TIME,
1165 nh_res_bucket_idle_time(bucket),
1166 NHA_RES_BUCKET_PAD))
1167 goto nla_put_failure_nest;
1169 nla_nest_end(skb, nest);
1170 nlmsg_end(skb, nlh);
1173 nla_put_failure_nest:
1174 nla_nest_cancel(skb, nest);
1176 nlmsg_cancel(skb, nlh);
1180 static void nexthop_bucket_notify(struct nh_res_table *res_table,
1183 struct nh_res_bucket *bucket = &res_table->nh_buckets[bucket_index];
1184 struct nh_grp_entry *nhge = nh_res_dereference(bucket->nh_entry);
1185 struct nexthop *nh = nhge->nh_parent;
1186 struct sk_buff *skb;
1189 skb = alloc_skb(NLMSG_GOODSIZE, GFP_KERNEL);
1193 err = nh_fill_res_bucket(skb, nh, bucket, bucket_index,
1194 RTM_NEWNEXTHOPBUCKET, 0, 0, NLM_F_REPLACE,
1201 rtnl_notify(skb, nh->net, 0, RTNLGRP_NEXTHOP, NULL, GFP_KERNEL);
1205 rtnl_set_sk_err(nh->net, RTNLGRP_NEXTHOP, err);
1208 static bool valid_group_nh(struct nexthop *nh, unsigned int npaths,
1209 bool *is_fdb, struct netlink_ext_ack *extack)
1212 struct nh_group *nhg = rtnl_dereference(nh->nh_grp);
1214 /* Nesting groups within groups is not supported. */
1215 if (nhg->hash_threshold) {
1216 NL_SET_ERR_MSG(extack,
1217 "Hash-threshold group can not be a nexthop within a group");
1220 if (nhg->resilient) {
1221 NL_SET_ERR_MSG(extack,
1222 "Resilient group can not be a nexthop within a group");
1225 *is_fdb = nhg->fdb_nh;
1227 struct nh_info *nhi = rtnl_dereference(nh->nh_info);
1229 if (nhi->reject_nh && npaths > 1) {
1230 NL_SET_ERR_MSG(extack,
1231 "Blackhole nexthop can not be used in a group with more than 1 path");
1234 *is_fdb = nhi->fdb_nh;
1240 static int nh_check_attr_fdb_group(struct nexthop *nh, u8 *nh_family,
1241 struct netlink_ext_ack *extack)
1243 struct nh_info *nhi;
1245 nhi = rtnl_dereference(nh->nh_info);
1248 NL_SET_ERR_MSG(extack, "FDB nexthop group can only have fdb nexthops");
1252 if (*nh_family == AF_UNSPEC) {
1253 *nh_family = nhi->family;
1254 } else if (*nh_family != nhi->family) {
1255 NL_SET_ERR_MSG(extack, "FDB nexthop group cannot have mixed family nexthops");
1262 static int nh_check_attr_group(struct net *net,
1263 struct nlattr *tb[], size_t tb_size,
1264 u16 nh_grp_type, struct netlink_ext_ack *extack)
1266 unsigned int len = nla_len(tb[NHA_GROUP]);
1267 u8 nh_family = AF_UNSPEC;
1268 struct nexthop_grp *nhg;
1272 if (!len || len & (sizeof(struct nexthop_grp) - 1)) {
1273 NL_SET_ERR_MSG(extack,
1274 "Invalid length for nexthop group attribute");
1278 /* convert len to number of nexthop ids */
1279 len /= sizeof(*nhg);
1281 nhg = nla_data(tb[NHA_GROUP]);
1282 for (i = 0; i < len; ++i) {
1283 if (nhg[i].resvd1 || nhg[i].resvd2) {
1284 NL_SET_ERR_MSG(extack, "Reserved fields in nexthop_grp must be 0");
1287 if (nhg[i].weight > 254) {
1288 NL_SET_ERR_MSG(extack, "Invalid value for weight");
1291 for (j = i + 1; j < len; ++j) {
1292 if (nhg[i].id == nhg[j].id) {
1293 NL_SET_ERR_MSG(extack, "Nexthop id can not be used twice in a group");
1301 nhg = nla_data(tb[NHA_GROUP]);
1302 for (i = 0; i < len; ++i) {
1306 nh = nexthop_find_by_id(net, nhg[i].id);
1308 NL_SET_ERR_MSG(extack, "Invalid nexthop id");
1311 if (!valid_group_nh(nh, len, &is_fdb_nh, extack))
1314 if (nhg_fdb && nh_check_attr_fdb_group(nh, &nh_family, extack))
1317 if (!nhg_fdb && is_fdb_nh) {
1318 NL_SET_ERR_MSG(extack, "Non FDB nexthop group cannot have fdb nexthops");
1322 for (i = NHA_GROUP_TYPE + 1; i < tb_size; ++i) {
1326 case NHA_HW_STATS_ENABLE:
1330 if (nh_grp_type == NEXTHOP_GRP_TYPE_RES)
1334 NL_SET_ERR_MSG(extack,
1335 "No other attributes can be set in nexthop groups");
1342 static bool ipv6_good_nh(const struct fib6_nh *nh)
1344 int state = NUD_REACHABLE;
1345 struct neighbour *n;
1349 n = __ipv6_neigh_lookup_noref_stub(nh->fib_nh_dev, &nh->fib_nh_gw6);
1351 state = READ_ONCE(n->nud_state);
1355 return !!(state & NUD_VALID);
1358 static bool ipv4_good_nh(const struct fib_nh *nh)
1360 int state = NUD_REACHABLE;
1361 struct neighbour *n;
1365 n = __ipv4_neigh_lookup_noref(nh->fib_nh_dev,
1366 (__force u32)nh->fib_nh_gw4);
1368 state = READ_ONCE(n->nud_state);
1372 return !!(state & NUD_VALID);
1375 static bool nexthop_is_good_nh(const struct nexthop *nh)
1377 struct nh_info *nhi = rcu_dereference(nh->nh_info);
1379 switch (nhi->family) {
1381 return ipv4_good_nh(&nhi->fib_nh);
1383 return ipv6_good_nh(&nhi->fib6_nh);
1389 static struct nexthop *nexthop_select_path_fdb(struct nh_group *nhg, int hash)
1393 for (i = 0; i < nhg->num_nh; i++) {
1394 struct nh_grp_entry *nhge = &nhg->nh_entries[i];
1396 if (hash > atomic_read(&nhge->hthr.upper_bound))
1399 nh_grp_entry_stats_inc(nhge);
1407 static struct nexthop *nexthop_select_path_hthr(struct nh_group *nhg, int hash)
1409 struct nh_grp_entry *nhge0 = NULL;
1413 return nexthop_select_path_fdb(nhg, hash);
1415 for (i = 0; i < nhg->num_nh; ++i) {
1416 struct nh_grp_entry *nhge = &nhg->nh_entries[i];
1418 /* nexthops always check if it is good and does
1419 * not rely on a sysctl for this behavior
1421 if (!nexthop_is_good_nh(nhge->nh))
1427 if (hash > atomic_read(&nhge->hthr.upper_bound))
1430 nh_grp_entry_stats_inc(nhge);
1435 nhge0 = &nhg->nh_entries[0];
1436 nh_grp_entry_stats_inc(nhge0);
1440 static struct nexthop *nexthop_select_path_res(struct nh_group *nhg, int hash)
1442 struct nh_res_table *res_table = rcu_dereference(nhg->res_table);
1443 u16 bucket_index = hash % res_table->num_nh_buckets;
1444 struct nh_res_bucket *bucket;
1445 struct nh_grp_entry *nhge;
1447 /* nexthop_select_path() is expected to return a non-NULL value, so
1448 * skip protocol validation and just hand out whatever there is.
1450 bucket = &res_table->nh_buckets[bucket_index];
1451 nh_res_bucket_set_busy(bucket);
1452 nhge = rcu_dereference(bucket->nh_entry);
1453 nh_grp_entry_stats_inc(nhge);
1457 struct nexthop *nexthop_select_path(struct nexthop *nh, int hash)
1459 struct nh_group *nhg;
1464 nhg = rcu_dereference(nh->nh_grp);
1465 if (nhg->hash_threshold)
1466 return nexthop_select_path_hthr(nhg, hash);
1467 else if (nhg->resilient)
1468 return nexthop_select_path_res(nhg, hash);
1473 EXPORT_SYMBOL_GPL(nexthop_select_path);
1475 int nexthop_for_each_fib6_nh(struct nexthop *nh,
1476 int (*cb)(struct fib6_nh *nh, void *arg),
1479 struct nh_info *nhi;
1483 struct nh_group *nhg;
1486 nhg = rcu_dereference_rtnl(nh->nh_grp);
1487 for (i = 0; i < nhg->num_nh; i++) {
1488 struct nh_grp_entry *nhge = &nhg->nh_entries[i];
1490 nhi = rcu_dereference_rtnl(nhge->nh->nh_info);
1491 err = cb(&nhi->fib6_nh, arg);
1496 nhi = rcu_dereference_rtnl(nh->nh_info);
1497 err = cb(&nhi->fib6_nh, arg);
1504 EXPORT_SYMBOL_GPL(nexthop_for_each_fib6_nh);
1506 static int check_src_addr(const struct in6_addr *saddr,
1507 struct netlink_ext_ack *extack)
1509 if (!ipv6_addr_any(saddr)) {
1510 NL_SET_ERR_MSG(extack, "IPv6 routes using source address can not use nexthop objects");
1516 int fib6_check_nexthop(struct nexthop *nh, struct fib6_config *cfg,
1517 struct netlink_ext_ack *extack)
1519 struct nh_info *nhi;
1522 /* fib6_src is unique to a fib6_info and limits the ability to cache
1523 * routes in fib6_nh within a nexthop that is potentially shared
1524 * across multiple fib entries. If the config wants to use source
1525 * routing it can not use nexthop objects. mlxsw also does not allow
1526 * fib6_src on routes.
1528 if (cfg && check_src_addr(&cfg->fc_src, extack) < 0)
1532 struct nh_group *nhg;
1534 nhg = rtnl_dereference(nh->nh_grp);
1537 is_fdb_nh = nhg->fdb_nh;
1539 nhi = rtnl_dereference(nh->nh_info);
1540 if (nhi->family == AF_INET)
1542 is_fdb_nh = nhi->fdb_nh;
1546 NL_SET_ERR_MSG(extack, "Route cannot point to a fdb nexthop");
1552 NL_SET_ERR_MSG(extack, "IPv6 routes can not use an IPv4 nexthop");
1555 EXPORT_SYMBOL_GPL(fib6_check_nexthop);
1557 /* if existing nexthop has ipv6 routes linked to it, need
1558 * to verify this new spec works with ipv6
1560 static int fib6_check_nh_list(struct nexthop *old, struct nexthop *new,
1561 struct netlink_ext_ack *extack)
1563 struct fib6_info *f6i;
1565 if (list_empty(&old->f6i_list))
1568 list_for_each_entry(f6i, &old->f6i_list, nh_list) {
1569 if (check_src_addr(&f6i->fib6_src.addr, extack) < 0)
1573 return fib6_check_nexthop(new, NULL, extack);
1576 static int nexthop_check_scope(struct nh_info *nhi, u8 scope,
1577 struct netlink_ext_ack *extack)
1579 if (scope == RT_SCOPE_HOST && nhi->fib_nhc.nhc_gw_family) {
1580 NL_SET_ERR_MSG(extack,
1581 "Route with host scope can not have a gateway");
1585 if (nhi->fib_nhc.nhc_flags & RTNH_F_ONLINK && scope >= RT_SCOPE_LINK) {
1586 NL_SET_ERR_MSG(extack, "Scope mismatch with nexthop");
1593 /* Invoked by fib add code to verify nexthop by id is ok with
1594 * config for prefix; parts of fib_check_nh not done when nexthop
1597 int fib_check_nexthop(struct nexthop *nh, u8 scope,
1598 struct netlink_ext_ack *extack)
1600 struct nh_info *nhi;
1604 struct nh_group *nhg;
1606 nhg = rtnl_dereference(nh->nh_grp);
1608 NL_SET_ERR_MSG(extack, "Route cannot point to a fdb nexthop");
1613 if (scope == RT_SCOPE_HOST) {
1614 NL_SET_ERR_MSG(extack, "Route with host scope can not have multiple nexthops");
1619 /* all nexthops in a group have the same scope */
1620 nhi = rtnl_dereference(nhg->nh_entries[0].nh->nh_info);
1621 err = nexthop_check_scope(nhi, scope, extack);
1623 nhi = rtnl_dereference(nh->nh_info);
1625 NL_SET_ERR_MSG(extack, "Route cannot point to a fdb nexthop");
1629 err = nexthop_check_scope(nhi, scope, extack);
1636 static int fib_check_nh_list(struct nexthop *old, struct nexthop *new,
1637 struct netlink_ext_ack *extack)
1639 struct fib_info *fi;
1641 list_for_each_entry(fi, &old->fi_list, nh_list) {
1644 err = fib_check_nexthop(new, fi->fib_scope, extack);
1651 static bool nh_res_nhge_is_balanced(const struct nh_grp_entry *nhge)
1653 return nhge->res.count_buckets == nhge->res.wants_buckets;
1656 static bool nh_res_nhge_is_ow(const struct nh_grp_entry *nhge)
1658 return nhge->res.count_buckets > nhge->res.wants_buckets;
1661 static bool nh_res_nhge_is_uw(const struct nh_grp_entry *nhge)
1663 return nhge->res.count_buckets < nhge->res.wants_buckets;
1666 static bool nh_res_table_is_balanced(const struct nh_res_table *res_table)
1668 return list_empty(&res_table->uw_nh_entries);
1671 static void nh_res_bucket_unset_nh(struct nh_res_bucket *bucket)
1673 struct nh_grp_entry *nhge;
1675 if (bucket->occupied) {
1676 nhge = nh_res_dereference(bucket->nh_entry);
1677 nhge->res.count_buckets--;
1678 bucket->occupied = false;
1682 static void nh_res_bucket_set_nh(struct nh_res_bucket *bucket,
1683 struct nh_grp_entry *nhge)
1685 nh_res_bucket_unset_nh(bucket);
1687 bucket->occupied = true;
1688 rcu_assign_pointer(bucket->nh_entry, nhge);
1689 nhge->res.count_buckets++;
1692 static bool nh_res_bucket_should_migrate(struct nh_res_table *res_table,
1693 struct nh_res_bucket *bucket,
1694 unsigned long *deadline, bool *force)
1696 unsigned long now = jiffies;
1697 struct nh_grp_entry *nhge;
1698 unsigned long idle_point;
1700 if (!bucket->occupied) {
1701 /* The bucket is not occupied, its NHGE pointer is either
1702 * NULL or obsolete. We _have to_ migrate: set force.
1708 nhge = nh_res_dereference(bucket->nh_entry);
1710 /* If the bucket is populated by an underweight or balanced
1711 * nexthop, do not migrate.
1713 if (!nh_res_nhge_is_ow(nhge))
1716 /* At this point we know that the bucket is populated with an
1717 * overweight nexthop. It needs to be migrated to a new nexthop if
1718 * the idle timer of unbalanced timer expired.
1721 idle_point = nh_res_bucket_idle_point(res_table, bucket, now);
1722 if (time_after_eq(now, idle_point)) {
1723 /* The bucket is idle. We _can_ migrate: unset force. */
1728 /* Unbalanced timer of 0 means "never force". */
1729 if (res_table->unbalanced_timer) {
1730 unsigned long unb_point;
1732 unb_point = nh_res_table_unb_point(res_table);
1733 if (time_after(now, unb_point)) {
1734 /* The bucket is not idle, but the unbalanced timer
1735 * expired. We _can_ migrate, but set force anyway,
1736 * so that drivers know to ignore activity reports
1743 nh_res_time_set_deadline(unb_point, deadline);
1746 nh_res_time_set_deadline(idle_point, deadline);
1750 static bool nh_res_bucket_migrate(struct nh_res_table *res_table,
1751 u16 bucket_index, bool notify,
1752 bool notify_nl, bool force)
1754 struct nh_res_bucket *bucket = &res_table->nh_buckets[bucket_index];
1755 struct nh_grp_entry *new_nhge;
1756 struct netlink_ext_ack extack;
1759 new_nhge = list_first_entry_or_null(&res_table->uw_nh_entries,
1760 struct nh_grp_entry,
1762 if (WARN_ON_ONCE(!new_nhge))
1763 /* If this function is called, "bucket" is either not
1764 * occupied, or it belongs to a next hop that is
1765 * overweight. In either case, there ought to be a
1766 * corresponding underweight next hop.
1771 struct nh_grp_entry *old_nhge;
1773 old_nhge = nh_res_dereference(bucket->nh_entry);
1774 err = call_nexthop_res_bucket_notifiers(res_table->net,
1776 bucket_index, force,
1778 new_nhge->nh, &extack);
1780 pr_err_ratelimited("%s\n", extack._msg);
1783 /* It is not possible to veto a forced replacement, so
1784 * just clear the hardware flags from the nexthop
1785 * bucket to indicate to user space that this bucket is
1786 * not correctly populated in hardware.
1788 bucket->nh_flags &= ~(RTNH_F_OFFLOAD | RTNH_F_TRAP);
1792 nh_res_bucket_set_nh(bucket, new_nhge);
1793 nh_res_bucket_set_idle(res_table, bucket);
1796 nexthop_bucket_notify(res_table, bucket_index);
1798 if (nh_res_nhge_is_balanced(new_nhge))
1799 list_del(&new_nhge->res.uw_nh_entry);
1803 #define NH_RES_UPKEEP_DW_MINIMUM_INTERVAL (HZ / 2)
1805 static void nh_res_table_upkeep(struct nh_res_table *res_table,
1806 bool notify, bool notify_nl)
1808 unsigned long now = jiffies;
1809 unsigned long deadline;
1812 /* Deadline is the next time that upkeep should be run. It is the
1813 * earliest time at which one of the buckets might be migrated.
1814 * Start at the most pessimistic estimate: either unbalanced_timer
1815 * from now, or if there is none, idle_timer from now. For each
1816 * encountered time point, call nh_res_time_set_deadline() to
1817 * refine the estimate.
1819 if (res_table->unbalanced_timer)
1820 deadline = now + res_table->unbalanced_timer;
1822 deadline = now + res_table->idle_timer;
1824 for (i = 0; i < res_table->num_nh_buckets; i++) {
1825 struct nh_res_bucket *bucket = &res_table->nh_buckets[i];
1828 if (nh_res_bucket_should_migrate(res_table, bucket,
1829 &deadline, &force)) {
1830 if (!nh_res_bucket_migrate(res_table, i, notify,
1831 notify_nl, force)) {
1832 unsigned long idle_point;
1834 /* A driver can override the migration
1835 * decision if the HW reports that the
1836 * bucket is actually not idle. Therefore
1837 * remark the bucket as busy again and
1838 * update the deadline.
1840 nh_res_bucket_set_busy(bucket);
1841 idle_point = nh_res_bucket_idle_point(res_table,
1844 nh_res_time_set_deadline(idle_point, &deadline);
1849 /* If the group is still unbalanced, schedule the next upkeep to
1850 * either the deadline computed above, or the minimum deadline,
1851 * whichever comes later.
1853 if (!nh_res_table_is_balanced(res_table)) {
1854 unsigned long now = jiffies;
1855 unsigned long min_deadline;
1857 min_deadline = now + NH_RES_UPKEEP_DW_MINIMUM_INTERVAL;
1858 if (time_before(deadline, min_deadline))
1859 deadline = min_deadline;
1861 queue_delayed_work(system_power_efficient_wq,
1862 &res_table->upkeep_dw, deadline - now);
1866 static void nh_res_table_upkeep_dw(struct work_struct *work)
1868 struct delayed_work *dw = to_delayed_work(work);
1869 struct nh_res_table *res_table;
1871 res_table = container_of(dw, struct nh_res_table, upkeep_dw);
1872 nh_res_table_upkeep(res_table, true, true);
1875 static void nh_res_table_cancel_upkeep(struct nh_res_table *res_table)
1877 cancel_delayed_work_sync(&res_table->upkeep_dw);
1880 static void nh_res_group_rebalance(struct nh_group *nhg,
1881 struct nh_res_table *res_table)
1883 int prev_upper_bound = 0;
1888 INIT_LIST_HEAD(&res_table->uw_nh_entries);
1890 for (i = 0; i < nhg->num_nh; ++i)
1891 total += nhg->nh_entries[i].weight;
1893 for (i = 0; i < nhg->num_nh; ++i) {
1894 struct nh_grp_entry *nhge = &nhg->nh_entries[i];
1898 upper_bound = DIV_ROUND_CLOSEST(res_table->num_nh_buckets * w,
1900 nhge->res.wants_buckets = upper_bound - prev_upper_bound;
1901 prev_upper_bound = upper_bound;
1903 if (nh_res_nhge_is_uw(nhge)) {
1904 if (list_empty(&res_table->uw_nh_entries))
1905 res_table->unbalanced_since = jiffies;
1906 list_add(&nhge->res.uw_nh_entry,
1907 &res_table->uw_nh_entries);
1912 /* Migrate buckets in res_table so that they reference NHGE's from NHG with
1913 * the right NH ID. Set those buckets that do not have a corresponding NHGE
1914 * entry in NHG as not occupied.
1916 static void nh_res_table_migrate_buckets(struct nh_res_table *res_table,
1917 struct nh_group *nhg)
1921 for (i = 0; i < res_table->num_nh_buckets; i++) {
1922 struct nh_res_bucket *bucket = &res_table->nh_buckets[i];
1923 u32 id = rtnl_dereference(bucket->nh_entry)->nh->id;
1927 for (j = 0; j < nhg->num_nh; j++) {
1928 struct nh_grp_entry *nhge = &nhg->nh_entries[j];
1930 if (nhge->nh->id == id) {
1931 nh_res_bucket_set_nh(bucket, nhge);
1938 nh_res_bucket_unset_nh(bucket);
1942 static void replace_nexthop_grp_res(struct nh_group *oldg,
1943 struct nh_group *newg)
1945 /* For NH group replacement, the new NHG might only have a stub
1946 * hash table with 0 buckets, because the number of buckets was not
1947 * specified. For NH removal, oldg and newg both reference the same
1948 * res_table. So in any case, in the following, we want to work
1949 * with oldg->res_table.
1951 struct nh_res_table *old_res_table = rtnl_dereference(oldg->res_table);
1952 unsigned long prev_unbalanced_since = old_res_table->unbalanced_since;
1953 bool prev_has_uw = !list_empty(&old_res_table->uw_nh_entries);
1955 nh_res_table_cancel_upkeep(old_res_table);
1956 nh_res_table_migrate_buckets(old_res_table, newg);
1957 nh_res_group_rebalance(newg, old_res_table);
1958 if (prev_has_uw && !list_empty(&old_res_table->uw_nh_entries))
1959 old_res_table->unbalanced_since = prev_unbalanced_since;
1960 nh_res_table_upkeep(old_res_table, true, false);
1963 static void nh_hthr_group_rebalance(struct nh_group *nhg)
1969 for (i = 0; i < nhg->num_nh; ++i)
1970 total += nhg->nh_entries[i].weight;
1972 for (i = 0; i < nhg->num_nh; ++i) {
1973 struct nh_grp_entry *nhge = &nhg->nh_entries[i];
1977 upper_bound = DIV_ROUND_CLOSEST_ULL((u64)w << 31, total) - 1;
1978 atomic_set(&nhge->hthr.upper_bound, upper_bound);
1982 static void remove_nh_grp_entry(struct net *net, struct nh_grp_entry *nhge,
1983 struct nl_info *nlinfo)
1985 struct nh_grp_entry *nhges, *new_nhges;
1986 struct nexthop *nhp = nhge->nh_parent;
1987 struct netlink_ext_ack extack;
1988 struct nexthop *nh = nhge->nh;
1989 struct nh_group *nhg, *newg;
1994 nhg = rtnl_dereference(nhp->nh_grp);
1997 /* last entry, keep it visible and remove the parent */
1998 if (nhg->num_nh == 1) {
1999 remove_nexthop(net, nhp, nlinfo);
2003 newg->has_v4 = false;
2004 newg->is_multipath = nhg->is_multipath;
2005 newg->hash_threshold = nhg->hash_threshold;
2006 newg->resilient = nhg->resilient;
2007 newg->fdb_nh = nhg->fdb_nh;
2008 newg->num_nh = nhg->num_nh;
2010 /* copy old entries to new except the one getting removed */
2011 nhges = nhg->nh_entries;
2012 new_nhges = newg->nh_entries;
2013 for (i = 0, j = 0; i < nhg->num_nh; ++i) {
2014 struct nh_info *nhi;
2016 /* current nexthop getting removed */
2017 if (nhg->nh_entries[i].nh == nh) {
2022 nhi = rtnl_dereference(nhges[i].nh->nh_info);
2023 if (nhi->family == AF_INET)
2024 newg->has_v4 = true;
2026 list_del(&nhges[i].nh_list);
2027 new_nhges[j].stats = nhges[i].stats;
2028 new_nhges[j].nh_parent = nhges[i].nh_parent;
2029 new_nhges[j].nh = nhges[i].nh;
2030 new_nhges[j].weight = nhges[i].weight;
2031 list_add(&new_nhges[j].nh_list, &new_nhges[j].nh->grp_list);
2035 if (newg->hash_threshold)
2036 nh_hthr_group_rebalance(newg);
2037 else if (newg->resilient)
2038 replace_nexthop_grp_res(nhg, newg);
2040 rcu_assign_pointer(nhp->nh_grp, newg);
2042 list_del(&nhge->nh_list);
2043 free_percpu(nhge->stats);
2044 nexthop_put(nhge->nh);
2046 /* Removal of a NH from a resilient group is notified through
2047 * bucket notifications.
2049 if (newg->hash_threshold) {
2050 err = call_nexthop_notifiers(net, NEXTHOP_EVENT_REPLACE, nhp,
2053 pr_err("%s\n", extack._msg);
2057 nexthop_notify(RTM_NEWNEXTHOP, nhp, nlinfo);
2060 static void remove_nexthop_from_groups(struct net *net, struct nexthop *nh,
2061 struct nl_info *nlinfo)
2063 struct nh_grp_entry *nhge, *tmp;
2065 list_for_each_entry_safe(nhge, tmp, &nh->grp_list, nh_list)
2066 remove_nh_grp_entry(net, nhge, nlinfo);
2068 /* make sure all see the newly published array before releasing rtnl */
2072 static void remove_nexthop_group(struct nexthop *nh, struct nl_info *nlinfo)
2074 struct nh_group *nhg = rcu_dereference_rtnl(nh->nh_grp);
2075 struct nh_res_table *res_table;
2076 int i, num_nh = nhg->num_nh;
2078 for (i = 0; i < num_nh; ++i) {
2079 struct nh_grp_entry *nhge = &nhg->nh_entries[i];
2081 if (WARN_ON(!nhge->nh))
2084 list_del_init(&nhge->nh_list);
2087 if (nhg->resilient) {
2088 res_table = rtnl_dereference(nhg->res_table);
2089 nh_res_table_cancel_upkeep(res_table);
2093 /* not called for nexthop replace */
2094 static void __remove_nexthop_fib(struct net *net, struct nexthop *nh)
2096 struct fib6_info *f6i, *tmp;
2097 bool do_flush = false;
2098 struct fib_info *fi;
2100 list_for_each_entry(fi, &nh->fi_list, nh_list) {
2101 fi->fib_flags |= RTNH_F_DEAD;
2107 /* ip6_del_rt removes the entry from this list hence the _safe */
2108 list_for_each_entry_safe(f6i, tmp, &nh->f6i_list, nh_list) {
2109 /* __ip6_del_rt does a release, so do a hold here */
2110 fib6_info_hold(f6i);
2111 ipv6_stub->ip6_del_rt(net, f6i,
2112 !READ_ONCE(net->ipv4.sysctl_nexthop_compat_mode));
2116 static void __remove_nexthop(struct net *net, struct nexthop *nh,
2117 struct nl_info *nlinfo)
2119 __remove_nexthop_fib(net, nh);
2122 remove_nexthop_group(nh, nlinfo);
2124 struct nh_info *nhi;
2126 nhi = rtnl_dereference(nh->nh_info);
2127 if (nhi->fib_nhc.nhc_dev)
2128 hlist_del(&nhi->dev_hash);
2130 remove_nexthop_from_groups(net, nh, nlinfo);
2134 static void remove_nexthop(struct net *net, struct nexthop *nh,
2135 struct nl_info *nlinfo)
2137 call_nexthop_notifiers(net, NEXTHOP_EVENT_DEL, nh, NULL);
2139 /* remove from the tree */
2140 rb_erase(&nh->rb_node, &net->nexthop.rb_root);
2143 nexthop_notify(RTM_DELNEXTHOP, nh, nlinfo);
2145 __remove_nexthop(net, nh, nlinfo);
2146 nh_base_seq_inc(net);
2151 /* if any FIB entries reference this nexthop, any dst entries
2152 * need to be regenerated
2154 static void nh_rt_cache_flush(struct net *net, struct nexthop *nh,
2155 struct nexthop *replaced_nh)
2157 struct fib6_info *f6i;
2158 struct nh_group *nhg;
2161 if (!list_empty(&nh->fi_list))
2162 rt_cache_flush(net);
2164 list_for_each_entry(f6i, &nh->f6i_list, nh_list)
2165 ipv6_stub->fib6_update_sernum(net, f6i);
2167 /* if an IPv6 group was replaced, we have to release all old
2168 * dsts to make sure all refcounts are released
2170 if (!replaced_nh->is_group)
2173 nhg = rtnl_dereference(replaced_nh->nh_grp);
2174 for (i = 0; i < nhg->num_nh; i++) {
2175 struct nh_grp_entry *nhge = &nhg->nh_entries[i];
2176 struct nh_info *nhi = rtnl_dereference(nhge->nh->nh_info);
2178 if (nhi->family == AF_INET6)
2179 ipv6_stub->fib6_nh_release_dsts(&nhi->fib6_nh);
2183 static int replace_nexthop_grp(struct net *net, struct nexthop *old,
2184 struct nexthop *new, const struct nh_config *cfg,
2185 struct netlink_ext_ack *extack)
2187 struct nh_res_table *tmp_table = NULL;
2188 struct nh_res_table *new_res_table;
2189 struct nh_res_table *old_res_table;
2190 struct nh_group *oldg, *newg;
2193 if (!new->is_group) {
2194 NL_SET_ERR_MSG(extack, "Can not replace a nexthop group with a nexthop.");
2198 oldg = rtnl_dereference(old->nh_grp);
2199 newg = rtnl_dereference(new->nh_grp);
2201 if (newg->hash_threshold != oldg->hash_threshold) {
2202 NL_SET_ERR_MSG(extack, "Can not replace a nexthop group with one of a different type.");
2206 if (newg->hash_threshold) {
2207 err = call_nexthop_notifiers(net, NEXTHOP_EVENT_REPLACE, new,
2211 } else if (newg->resilient) {
2212 new_res_table = rtnl_dereference(newg->res_table);
2213 old_res_table = rtnl_dereference(oldg->res_table);
2215 /* Accept if num_nh_buckets was not given, but if it was
2216 * given, demand that the value be correct.
2218 if (cfg->nh_grp_res_has_num_buckets &&
2219 cfg->nh_grp_res_num_buckets !=
2220 old_res_table->num_nh_buckets) {
2221 NL_SET_ERR_MSG(extack, "Can not change number of buckets of a resilient nexthop group.");
2225 /* Emit a pre-replace notification so that listeners could veto
2226 * a potentially unsupported configuration. Otherwise,
2227 * individual bucket replacement notifications would need to be
2228 * vetoed, which is something that should only happen if the
2229 * bucket is currently active.
2231 err = call_nexthop_res_table_notifiers(net, new, extack);
2235 if (cfg->nh_grp_res_has_idle_timer)
2236 old_res_table->idle_timer = cfg->nh_grp_res_idle_timer;
2237 if (cfg->nh_grp_res_has_unbalanced_timer)
2238 old_res_table->unbalanced_timer =
2239 cfg->nh_grp_res_unbalanced_timer;
2241 replace_nexthop_grp_res(oldg, newg);
2243 tmp_table = new_res_table;
2244 rcu_assign_pointer(newg->res_table, old_res_table);
2245 rcu_assign_pointer(newg->spare->res_table, old_res_table);
2248 /* update parents - used by nexthop code for cleanup */
2249 for (i = 0; i < newg->num_nh; i++)
2250 newg->nh_entries[i].nh_parent = old;
2252 rcu_assign_pointer(old->nh_grp, newg);
2254 /* Make sure concurrent readers are not using 'oldg' anymore. */
2257 if (newg->resilient) {
2258 rcu_assign_pointer(oldg->res_table, tmp_table);
2259 rcu_assign_pointer(oldg->spare->res_table, tmp_table);
2262 for (i = 0; i < oldg->num_nh; i++)
2263 oldg->nh_entries[i].nh_parent = new;
2265 rcu_assign_pointer(new->nh_grp, oldg);
2270 static void nh_group_v4_update(struct nh_group *nhg)
2272 struct nh_grp_entry *nhges;
2273 bool has_v4 = false;
2276 nhges = nhg->nh_entries;
2277 for (i = 0; i < nhg->num_nh; i++) {
2278 struct nh_info *nhi;
2280 nhi = rtnl_dereference(nhges[i].nh->nh_info);
2281 if (nhi->family == AF_INET)
2284 nhg->has_v4 = has_v4;
2287 static int replace_nexthop_single_notify_res(struct net *net,
2288 struct nh_res_table *res_table,
2289 struct nexthop *old,
2290 struct nh_info *oldi,
2291 struct nh_info *newi,
2292 struct netlink_ext_ack *extack)
2294 u32 nhg_id = res_table->nhg_id;
2298 for (i = 0; i < res_table->num_nh_buckets; i++) {
2299 struct nh_res_bucket *bucket = &res_table->nh_buckets[i];
2300 struct nh_grp_entry *nhge;
2302 nhge = rtnl_dereference(bucket->nh_entry);
2303 if (nhge->nh == old) {
2304 err = __call_nexthop_res_bucket_notifiers(net, nhg_id,
2317 struct nh_res_bucket *bucket = &res_table->nh_buckets[i];
2318 struct nh_grp_entry *nhge;
2320 nhge = rtnl_dereference(bucket->nh_entry);
2321 if (nhge->nh == old)
2322 __call_nexthop_res_bucket_notifiers(net, nhg_id, i,
2329 static int replace_nexthop_single_notify(struct net *net,
2330 struct nexthop *group_nh,
2331 struct nexthop *old,
2332 struct nh_info *oldi,
2333 struct nh_info *newi,
2334 struct netlink_ext_ack *extack)
2336 struct nh_group *nhg = rtnl_dereference(group_nh->nh_grp);
2337 struct nh_res_table *res_table;
2339 if (nhg->hash_threshold) {
2340 return call_nexthop_notifiers(net, NEXTHOP_EVENT_REPLACE,
2342 } else if (nhg->resilient) {
2343 res_table = rtnl_dereference(nhg->res_table);
2344 return replace_nexthop_single_notify_res(net, res_table,
2352 static int replace_nexthop_single(struct net *net, struct nexthop *old,
2353 struct nexthop *new,
2354 struct netlink_ext_ack *extack)
2356 u8 old_protocol, old_nh_flags;
2357 struct nh_info *oldi, *newi;
2358 struct nh_grp_entry *nhge;
2361 if (new->is_group) {
2362 NL_SET_ERR_MSG(extack, "Can not replace a nexthop with a nexthop group.");
2366 err = call_nexthop_notifiers(net, NEXTHOP_EVENT_REPLACE, new, extack);
2370 /* Hardware flags were set on 'old' as 'new' is not in the red-black
2371 * tree. Therefore, inherit the flags from 'old' to 'new'.
2373 new->nh_flags |= old->nh_flags & (RTNH_F_OFFLOAD | RTNH_F_TRAP);
2375 oldi = rtnl_dereference(old->nh_info);
2376 newi = rtnl_dereference(new->nh_info);
2378 newi->nh_parent = old;
2379 oldi->nh_parent = new;
2381 old_protocol = old->protocol;
2382 old_nh_flags = old->nh_flags;
2384 old->protocol = new->protocol;
2385 old->nh_flags = new->nh_flags;
2387 rcu_assign_pointer(old->nh_info, newi);
2388 rcu_assign_pointer(new->nh_info, oldi);
2390 /* Send a replace notification for all the groups using the nexthop. */
2391 list_for_each_entry(nhge, &old->grp_list, nh_list) {
2392 struct nexthop *nhp = nhge->nh_parent;
2394 err = replace_nexthop_single_notify(net, nhp, old, oldi, newi,
2400 /* When replacing an IPv4 nexthop with an IPv6 nexthop, potentially
2401 * update IPv4 indication in all the groups using the nexthop.
2403 if (oldi->family == AF_INET && newi->family == AF_INET6) {
2404 list_for_each_entry(nhge, &old->grp_list, nh_list) {
2405 struct nexthop *nhp = nhge->nh_parent;
2406 struct nh_group *nhg;
2408 nhg = rtnl_dereference(nhp->nh_grp);
2409 nh_group_v4_update(nhg);
2416 rcu_assign_pointer(new->nh_info, newi);
2417 rcu_assign_pointer(old->nh_info, oldi);
2418 old->nh_flags = old_nh_flags;
2419 old->protocol = old_protocol;
2420 oldi->nh_parent = old;
2421 newi->nh_parent = new;
2422 list_for_each_entry_continue_reverse(nhge, &old->grp_list, nh_list) {
2423 struct nexthop *nhp = nhge->nh_parent;
2425 replace_nexthop_single_notify(net, nhp, old, newi, oldi, NULL);
2427 call_nexthop_notifiers(net, NEXTHOP_EVENT_REPLACE, old, extack);
2431 static void __nexthop_replace_notify(struct net *net, struct nexthop *nh,
2432 struct nl_info *info)
2434 struct fib6_info *f6i;
2436 if (!list_empty(&nh->fi_list)) {
2437 struct fib_info *fi;
2439 /* expectation is a few fib_info per nexthop and then
2440 * a lot of routes per fib_info. So mark the fib_info
2441 * and then walk the fib tables once
2443 list_for_each_entry(fi, &nh->fi_list, nh_list)
2444 fi->nh_updated = true;
2446 fib_info_notify_update(net, info);
2448 list_for_each_entry(fi, &nh->fi_list, nh_list)
2449 fi->nh_updated = false;
2452 list_for_each_entry(f6i, &nh->f6i_list, nh_list)
2453 ipv6_stub->fib6_rt_update(net, f6i, info);
2456 /* send RTM_NEWROUTE with REPLACE flag set for all FIB entries
2457 * linked to this nexthop and for all groups that the nexthop
2460 static void nexthop_replace_notify(struct net *net, struct nexthop *nh,
2461 struct nl_info *info)
2463 struct nh_grp_entry *nhge;
2465 __nexthop_replace_notify(net, nh, info);
2467 list_for_each_entry(nhge, &nh->grp_list, nh_list)
2468 __nexthop_replace_notify(net, nhge->nh_parent, info);
2471 static int replace_nexthop(struct net *net, struct nexthop *old,
2472 struct nexthop *new, const struct nh_config *cfg,
2473 struct netlink_ext_ack *extack)
2475 bool new_is_reject = false;
2476 struct nh_grp_entry *nhge;
2479 /* check that existing FIB entries are ok with the
2480 * new nexthop definition
2482 err = fib_check_nh_list(old, new, extack);
2486 err = fib6_check_nh_list(old, new, extack);
2490 if (!new->is_group) {
2491 struct nh_info *nhi = rtnl_dereference(new->nh_info);
2493 new_is_reject = nhi->reject_nh;
2496 list_for_each_entry(nhge, &old->grp_list, nh_list) {
2497 /* if new nexthop is a blackhole, any groups using this
2498 * nexthop cannot have more than 1 path
2500 if (new_is_reject &&
2501 nexthop_num_path(nhge->nh_parent) > 1) {
2502 NL_SET_ERR_MSG(extack, "Blackhole nexthop can not be a member of a group with more than one path");
2506 err = fib_check_nh_list(nhge->nh_parent, new, extack);
2510 err = fib6_check_nh_list(nhge->nh_parent, new, extack);
2516 err = replace_nexthop_grp(net, old, new, cfg, extack);
2518 err = replace_nexthop_single(net, old, new, extack);
2521 nh_rt_cache_flush(net, old, new);
2523 __remove_nexthop(net, new, NULL);
2530 /* called with rtnl_lock held */
2531 static int insert_nexthop(struct net *net, struct nexthop *new_nh,
2532 struct nh_config *cfg, struct netlink_ext_ack *extack)
2534 struct rb_node **pp, *parent = NULL, *next;
2535 struct rb_root *root = &net->nexthop.rb_root;
2536 bool replace = !!(cfg->nlflags & NLM_F_REPLACE);
2537 bool create = !!(cfg->nlflags & NLM_F_CREATE);
2538 u32 new_id = new_nh->id;
2539 int replace_notify = 0;
2542 pp = &root->rb_node;
2552 nh = rb_entry(parent, struct nexthop, rb_node);
2553 if (new_id < nh->id) {
2554 pp = &next->rb_left;
2555 } else if (new_id > nh->id) {
2556 pp = &next->rb_right;
2557 } else if (replace) {
2558 rc = replace_nexthop(net, nh, new_nh, cfg, extack);
2560 new_nh = nh; /* send notification with old nh */
2565 /* id already exists and not a replace */
2570 if (replace && !create) {
2571 NL_SET_ERR_MSG(extack, "Replace specified without create and no entry exists");
2576 if (new_nh->is_group) {
2577 struct nh_group *nhg = rtnl_dereference(new_nh->nh_grp);
2578 struct nh_res_table *res_table;
2580 if (nhg->resilient) {
2581 res_table = rtnl_dereference(nhg->res_table);
2583 /* Not passing the number of buckets is OK when
2584 * replacing, but not when creating a new group.
2586 if (!cfg->nh_grp_res_has_num_buckets) {
2587 NL_SET_ERR_MSG(extack, "Number of buckets not specified for nexthop group insertion");
2592 nh_res_group_rebalance(nhg, res_table);
2594 /* Do not send bucket notifications, we do full
2595 * notification below.
2597 nh_res_table_upkeep(res_table, false, false);
2601 rb_link_node_rcu(&new_nh->rb_node, parent, pp);
2602 rb_insert_color(&new_nh->rb_node, root);
2604 /* The initial insertion is a full notification for hash-threshold as
2605 * well as resilient groups.
2607 rc = call_nexthop_notifiers(net, NEXTHOP_EVENT_REPLACE, new_nh, extack);
2609 rb_erase(&new_nh->rb_node, &net->nexthop.rb_root);
2613 nh_base_seq_inc(net);
2614 nexthop_notify(RTM_NEWNEXTHOP, new_nh, &cfg->nlinfo);
2615 if (replace_notify &&
2616 READ_ONCE(net->ipv4.sysctl_nexthop_compat_mode))
2617 nexthop_replace_notify(net, new_nh, &cfg->nlinfo);
2624 /* remove all nexthops tied to a device being deleted */
2625 static void nexthop_flush_dev(struct net_device *dev, unsigned long event)
2627 unsigned int hash = nh_dev_hashfn(dev->ifindex);
2628 struct net *net = dev_net(dev);
2629 struct hlist_head *head = &net->nexthop.devhash[hash];
2630 struct hlist_node *n;
2631 struct nh_info *nhi;
2633 hlist_for_each_entry_safe(nhi, n, head, dev_hash) {
2634 if (nhi->fib_nhc.nhc_dev != dev)
2637 if (nhi->reject_nh &&
2638 (event == NETDEV_DOWN || event == NETDEV_CHANGE))
2641 remove_nexthop(net, nhi->nh_parent, NULL);
2645 /* rtnl; called when net namespace is deleted */
2646 static void flush_all_nexthops(struct net *net)
2648 struct rb_root *root = &net->nexthop.rb_root;
2649 struct rb_node *node;
2652 while ((node = rb_first(root))) {
2653 nh = rb_entry(node, struct nexthop, rb_node);
2654 remove_nexthop(net, nh, NULL);
2659 static struct nexthop *nexthop_create_group(struct net *net,
2660 struct nh_config *cfg)
2662 struct nlattr *grps_attr = cfg->nh_grp;
2663 struct nexthop_grp *entry = nla_data(grps_attr);
2664 u16 num_nh = nla_len(grps_attr) / sizeof(*entry);
2665 struct nh_group *nhg;
2670 if (WARN_ON(!num_nh))
2671 return ERR_PTR(-EINVAL);
2673 nh = nexthop_alloc();
2675 return ERR_PTR(-ENOMEM);
2679 nhg = nexthop_grp_alloc(num_nh);
2682 return ERR_PTR(-ENOMEM);
2685 /* spare group used for removals */
2686 nhg->spare = nexthop_grp_alloc(num_nh);
2690 return ERR_PTR(-ENOMEM);
2692 nhg->spare->spare = nhg;
2694 for (i = 0; i < nhg->num_nh; ++i) {
2695 struct nexthop *nhe;
2696 struct nh_info *nhi;
2698 nhe = nexthop_find_by_id(net, entry[i].id);
2699 if (!nexthop_get(nhe)) {
2704 nhi = rtnl_dereference(nhe->nh_info);
2705 if (nhi->family == AF_INET)
2708 nhg->nh_entries[i].stats =
2709 netdev_alloc_pcpu_stats(struct nh_grp_entry_stats);
2710 if (!nhg->nh_entries[i].stats) {
2715 nhg->nh_entries[i].nh = nhe;
2716 nhg->nh_entries[i].weight = entry[i].weight + 1;
2717 list_add(&nhg->nh_entries[i].nh_list, &nhe->grp_list);
2718 nhg->nh_entries[i].nh_parent = nh;
2721 if (cfg->nh_grp_type == NEXTHOP_GRP_TYPE_MPATH) {
2722 nhg->hash_threshold = 1;
2723 nhg->is_multipath = true;
2724 } else if (cfg->nh_grp_type == NEXTHOP_GRP_TYPE_RES) {
2725 struct nh_res_table *res_table;
2727 res_table = nexthop_res_table_alloc(net, cfg->nh_id, cfg);
2733 rcu_assign_pointer(nhg->spare->res_table, res_table);
2734 rcu_assign_pointer(nhg->res_table, res_table);
2735 nhg->resilient = true;
2736 nhg->is_multipath = true;
2739 WARN_ON_ONCE(nhg->hash_threshold + nhg->resilient != 1);
2741 if (nhg->hash_threshold)
2742 nh_hthr_group_rebalance(nhg);
2747 if (cfg->nh_hw_stats)
2748 nhg->hw_stats = true;
2750 rcu_assign_pointer(nh->nh_grp, nhg);
2755 for (i--; i >= 0; --i) {
2756 list_del(&nhg->nh_entries[i].nh_list);
2757 free_percpu(nhg->nh_entries[i].stats);
2758 nexthop_put(nhg->nh_entries[i].nh);
2765 return ERR_PTR(err);
2768 static int nh_create_ipv4(struct net *net, struct nexthop *nh,
2769 struct nh_info *nhi, struct nh_config *cfg,
2770 struct netlink_ext_ack *extack)
2772 struct fib_nh *fib_nh = &nhi->fib_nh;
2773 struct fib_config fib_cfg = {
2774 .fc_oif = cfg->nh_ifindex,
2775 .fc_gw4 = cfg->gw.ipv4,
2776 .fc_gw_family = cfg->gw.ipv4 ? AF_INET : 0,
2777 .fc_flags = cfg->nh_flags,
2778 .fc_nlinfo = cfg->nlinfo,
2779 .fc_encap = cfg->nh_encap,
2780 .fc_encap_type = cfg->nh_encap_type,
2782 u32 tb_id = (cfg->dev ? l3mdev_fib_table(cfg->dev) : RT_TABLE_MAIN);
2785 err = fib_nh_init(net, fib_nh, &fib_cfg, 1, extack);
2787 fib_nh_release(net, fib_nh);
2794 /* sets nh_dev if successful */
2795 err = fib_check_nh(net, fib_nh, tb_id, 0, extack);
2797 nh->nh_flags = fib_nh->fib_nh_flags;
2798 fib_info_update_nhc_saddr(net, &fib_nh->nh_common,
2799 !fib_nh->fib_nh_scope ? 0 : fib_nh->fib_nh_scope - 1);
2801 fib_nh_release(net, fib_nh);
2807 static int nh_create_ipv6(struct net *net, struct nexthop *nh,
2808 struct nh_info *nhi, struct nh_config *cfg,
2809 struct netlink_ext_ack *extack)
2811 struct fib6_nh *fib6_nh = &nhi->fib6_nh;
2812 struct fib6_config fib6_cfg = {
2813 .fc_table = l3mdev_fib_table(cfg->dev),
2814 .fc_ifindex = cfg->nh_ifindex,
2815 .fc_gateway = cfg->gw.ipv6,
2816 .fc_flags = cfg->nh_flags,
2817 .fc_nlinfo = cfg->nlinfo,
2818 .fc_encap = cfg->nh_encap,
2819 .fc_encap_type = cfg->nh_encap_type,
2820 .fc_is_fdb = cfg->nh_fdb,
2824 if (!ipv6_addr_any(&cfg->gw.ipv6))
2825 fib6_cfg.fc_flags |= RTF_GATEWAY;
2827 /* sets nh_dev if successful */
2828 err = ipv6_stub->fib6_nh_init(net, fib6_nh, &fib6_cfg, GFP_KERNEL,
2831 /* IPv6 is not enabled, don't call fib6_nh_release */
2832 if (err == -EAFNOSUPPORT)
2834 ipv6_stub->fib6_nh_release(fib6_nh);
2836 nh->nh_flags = fib6_nh->fib_nh_flags;
2842 static struct nexthop *nexthop_create(struct net *net, struct nh_config *cfg,
2843 struct netlink_ext_ack *extack)
2845 struct nh_info *nhi;
2849 nh = nexthop_alloc();
2851 return ERR_PTR(-ENOMEM);
2853 nhi = kzalloc(sizeof(*nhi), GFP_KERNEL);
2856 return ERR_PTR(-ENOMEM);
2859 nh->nh_flags = cfg->nh_flags;
2862 nhi->nh_parent = nh;
2863 nhi->family = cfg->nh_family;
2864 nhi->fib_nhc.nhc_scope = RT_SCOPE_LINK;
2869 if (cfg->nh_blackhole) {
2871 cfg->nh_ifindex = net->loopback_dev->ifindex;
2874 switch (cfg->nh_family) {
2876 err = nh_create_ipv4(net, nh, nhi, cfg, extack);
2879 err = nh_create_ipv6(net, nh, nhi, cfg, extack);
2886 return ERR_PTR(err);
2889 /* add the entry to the device based hash */
2891 nexthop_devhash_add(net, nhi);
2893 rcu_assign_pointer(nh->nh_info, nhi);
2898 /* called with rtnl lock held */
2899 static struct nexthop *nexthop_add(struct net *net, struct nh_config *cfg,
2900 struct netlink_ext_ack *extack)
2905 if (cfg->nlflags & NLM_F_REPLACE && !cfg->nh_id) {
2906 NL_SET_ERR_MSG(extack, "Replace requires nexthop id");
2907 return ERR_PTR(-EINVAL);
2911 cfg->nh_id = nh_find_unused_id(net);
2913 NL_SET_ERR_MSG(extack, "No unused id");
2914 return ERR_PTR(-EINVAL);
2919 nh = nexthop_create_group(net, cfg);
2921 nh = nexthop_create(net, cfg, extack);
2926 refcount_set(&nh->refcnt, 1);
2927 nh->id = cfg->nh_id;
2928 nh->protocol = cfg->nh_protocol;
2931 err = insert_nexthop(net, nh, cfg, extack);
2933 __remove_nexthop(net, nh, NULL);
2941 static int rtm_nh_get_timer(struct nlattr *attr, unsigned long fallback,
2942 unsigned long *timer_p, bool *has_p,
2943 struct netlink_ext_ack *extack)
2945 unsigned long timer;
2949 *timer_p = fallback;
2954 value = nla_get_u32(attr);
2955 timer = clock_t_to_jiffies(value);
2956 if (timer == ~0UL) {
2957 NL_SET_ERR_MSG(extack, "Timer value too large");
2966 static int rtm_to_nh_config_grp_res(struct nlattr *res, struct nh_config *cfg,
2967 struct netlink_ext_ack *extack)
2969 struct nlattr *tb[ARRAY_SIZE(rtm_nh_res_policy_new)] = {};
2973 err = nla_parse_nested(tb,
2974 ARRAY_SIZE(rtm_nh_res_policy_new) - 1,
2975 res, rtm_nh_res_policy_new, extack);
2980 if (tb[NHA_RES_GROUP_BUCKETS]) {
2981 cfg->nh_grp_res_num_buckets =
2982 nla_get_u16(tb[NHA_RES_GROUP_BUCKETS]);
2983 cfg->nh_grp_res_has_num_buckets = true;
2984 if (!cfg->nh_grp_res_num_buckets) {
2985 NL_SET_ERR_MSG(extack, "Number of buckets needs to be non-0");
2990 err = rtm_nh_get_timer(tb[NHA_RES_GROUP_IDLE_TIMER],
2991 NH_RES_DEFAULT_IDLE_TIMER,
2992 &cfg->nh_grp_res_idle_timer,
2993 &cfg->nh_grp_res_has_idle_timer,
2998 return rtm_nh_get_timer(tb[NHA_RES_GROUP_UNBALANCED_TIMER],
2999 NH_RES_DEFAULT_UNBALANCED_TIMER,
3000 &cfg->nh_grp_res_unbalanced_timer,
3001 &cfg->nh_grp_res_has_unbalanced_timer,
3005 static int rtm_to_nh_config(struct net *net, struct sk_buff *skb,
3006 struct nlmsghdr *nlh, struct nh_config *cfg,
3007 struct netlink_ext_ack *extack)
3009 struct nhmsg *nhm = nlmsg_data(nlh);
3010 struct nlattr *tb[ARRAY_SIZE(rtm_nh_policy_new)];
3013 err = nlmsg_parse(nlh, sizeof(*nhm), tb,
3014 ARRAY_SIZE(rtm_nh_policy_new) - 1,
3015 rtm_nh_policy_new, extack);
3020 if (nhm->resvd || nhm->nh_scope) {
3021 NL_SET_ERR_MSG(extack, "Invalid values in ancillary header");
3024 if (nhm->nh_flags & ~NEXTHOP_VALID_USER_FLAGS) {
3025 NL_SET_ERR_MSG(extack, "Invalid nexthop flags in ancillary header");
3029 switch (nhm->nh_family) {
3038 NL_SET_ERR_MSG(extack, "Invalid address family");
3042 memset(cfg, 0, sizeof(*cfg));
3043 cfg->nlflags = nlh->nlmsg_flags;
3044 cfg->nlinfo.portid = NETLINK_CB(skb).portid;
3045 cfg->nlinfo.nlh = nlh;
3046 cfg->nlinfo.nl_net = net;
3048 cfg->nh_family = nhm->nh_family;
3049 cfg->nh_protocol = nhm->nh_protocol;
3050 cfg->nh_flags = nhm->nh_flags;
3053 cfg->nh_id = nla_get_u32(tb[NHA_ID]);
3056 if (tb[NHA_OIF] || tb[NHA_BLACKHOLE] ||
3057 tb[NHA_ENCAP] || tb[NHA_ENCAP_TYPE]) {
3058 NL_SET_ERR_MSG(extack, "Fdb attribute can not be used with encap, oif or blackhole");
3061 if (nhm->nh_flags) {
3062 NL_SET_ERR_MSG(extack, "Unsupported nexthop flags in ancillary header");
3065 cfg->nh_fdb = nla_get_flag(tb[NHA_FDB]);
3068 if (tb[NHA_GROUP]) {
3069 if (nhm->nh_family != AF_UNSPEC) {
3070 NL_SET_ERR_MSG(extack, "Invalid family for group");
3073 cfg->nh_grp = tb[NHA_GROUP];
3075 cfg->nh_grp_type = NEXTHOP_GRP_TYPE_MPATH;
3076 if (tb[NHA_GROUP_TYPE])
3077 cfg->nh_grp_type = nla_get_u16(tb[NHA_GROUP_TYPE]);
3079 if (cfg->nh_grp_type > NEXTHOP_GRP_TYPE_MAX) {
3080 NL_SET_ERR_MSG(extack, "Invalid group type");
3083 err = nh_check_attr_group(net, tb, ARRAY_SIZE(tb),
3084 cfg->nh_grp_type, extack);
3088 if (cfg->nh_grp_type == NEXTHOP_GRP_TYPE_RES)
3089 err = rtm_to_nh_config_grp_res(tb[NHA_RES_GROUP],
3092 if (tb[NHA_HW_STATS_ENABLE])
3093 cfg->nh_hw_stats = nla_get_u32(tb[NHA_HW_STATS_ENABLE]);
3095 /* no other attributes should be set */
3099 if (tb[NHA_BLACKHOLE]) {
3100 if (tb[NHA_GATEWAY] || tb[NHA_OIF] ||
3101 tb[NHA_ENCAP] || tb[NHA_ENCAP_TYPE] || tb[NHA_FDB]) {
3102 NL_SET_ERR_MSG(extack, "Blackhole attribute can not be used with gateway, oif, encap or fdb");
3106 cfg->nh_blackhole = 1;
3111 if (!cfg->nh_fdb && !tb[NHA_OIF]) {
3112 NL_SET_ERR_MSG(extack, "Device attribute required for non-blackhole and non-fdb nexthops");
3116 if (!cfg->nh_fdb && tb[NHA_OIF]) {
3117 cfg->nh_ifindex = nla_get_u32(tb[NHA_OIF]);
3118 if (cfg->nh_ifindex)
3119 cfg->dev = __dev_get_by_index(net, cfg->nh_ifindex);
3122 NL_SET_ERR_MSG(extack, "Invalid device index");
3124 } else if (!(cfg->dev->flags & IFF_UP)) {
3125 NL_SET_ERR_MSG(extack, "Nexthop device is not up");
3128 } else if (!netif_carrier_ok(cfg->dev)) {
3129 NL_SET_ERR_MSG(extack, "Carrier for nexthop device is down");
3136 if (tb[NHA_GATEWAY]) {
3137 struct nlattr *gwa = tb[NHA_GATEWAY];
3139 switch (cfg->nh_family) {
3141 if (nla_len(gwa) != sizeof(u32)) {
3142 NL_SET_ERR_MSG(extack, "Invalid gateway");
3145 cfg->gw.ipv4 = nla_get_be32(gwa);
3148 if (nla_len(gwa) != sizeof(struct in6_addr)) {
3149 NL_SET_ERR_MSG(extack, "Invalid gateway");
3152 cfg->gw.ipv6 = nla_get_in6_addr(gwa);
3155 NL_SET_ERR_MSG(extack,
3156 "Unknown address family for gateway");
3160 /* device only nexthop (no gateway) */
3161 if (cfg->nh_flags & RTNH_F_ONLINK) {
3162 NL_SET_ERR_MSG(extack,
3163 "ONLINK flag can not be set for nexthop without a gateway");
3168 if (tb[NHA_ENCAP]) {
3169 cfg->nh_encap = tb[NHA_ENCAP];
3171 if (!tb[NHA_ENCAP_TYPE]) {
3172 NL_SET_ERR_MSG(extack, "LWT encapsulation type is missing");
3176 cfg->nh_encap_type = nla_get_u16(tb[NHA_ENCAP_TYPE]);
3177 err = lwtunnel_valid_encap_type(cfg->nh_encap_type, extack);
3181 } else if (tb[NHA_ENCAP_TYPE]) {
3182 NL_SET_ERR_MSG(extack, "LWT encapsulation attribute is missing");
3186 if (tb[NHA_HW_STATS_ENABLE]) {
3187 NL_SET_ERR_MSG(extack, "Cannot enable nexthop hardware statistics for non-group nexthops");
3197 static int rtm_new_nexthop(struct sk_buff *skb, struct nlmsghdr *nlh,
3198 struct netlink_ext_ack *extack)
3200 struct net *net = sock_net(skb->sk);
3201 struct nh_config cfg;
3205 err = rtm_to_nh_config(net, skb, nlh, &cfg, extack);
3207 nh = nexthop_add(net, &cfg, extack);
3215 static int nh_valid_get_del_req(const struct nlmsghdr *nlh,
3216 struct nlattr **tb, u32 *id, u32 *op_flags,
3217 struct netlink_ext_ack *extack)
3219 struct nhmsg *nhm = nlmsg_data(nlh);
3221 if (nhm->nh_protocol || nhm->resvd || nhm->nh_scope || nhm->nh_flags) {
3222 NL_SET_ERR_MSG(extack, "Invalid values in header");
3227 NL_SET_ERR_MSG(extack, "Nexthop id is missing");
3231 *id = nla_get_u32(tb[NHA_ID]);
3233 NL_SET_ERR_MSG(extack, "Invalid nexthop id");
3238 if (tb[NHA_OP_FLAGS])
3239 *op_flags = nla_get_u32(tb[NHA_OP_FLAGS]);
3248 static int rtm_del_nexthop(struct sk_buff *skb, struct nlmsghdr *nlh,
3249 struct netlink_ext_ack *extack)
3251 struct nlattr *tb[ARRAY_SIZE(rtm_nh_policy_del)];
3252 struct net *net = sock_net(skb->sk);
3253 struct nl_info nlinfo = {
3256 .portid = NETLINK_CB(skb).portid,
3262 err = nlmsg_parse(nlh, sizeof(struct nhmsg), tb,
3263 ARRAY_SIZE(rtm_nh_policy_del) - 1, rtm_nh_policy_del,
3268 err = nh_valid_get_del_req(nlh, tb, &id, NULL, extack);
3272 nh = nexthop_find_by_id(net, id);
3276 remove_nexthop(net, nh, &nlinfo);
3282 static int rtm_get_nexthop(struct sk_buff *in_skb, struct nlmsghdr *nlh,
3283 struct netlink_ext_ack *extack)
3285 struct nlattr *tb[ARRAY_SIZE(rtm_nh_policy_get)];
3286 struct net *net = sock_net(in_skb->sk);
3287 struct sk_buff *skb = NULL;
3293 err = nlmsg_parse(nlh, sizeof(struct nhmsg), tb,
3294 ARRAY_SIZE(rtm_nh_policy_get) - 1, rtm_nh_policy_get,
3299 err = nh_valid_get_del_req(nlh, tb, &id, &op_flags, extack);
3304 skb = alloc_skb(NLMSG_GOODSIZE, GFP_KERNEL);
3309 nh = nexthop_find_by_id(net, id);
3313 err = nh_fill_node(skb, nh, RTM_NEWNEXTHOP, NETLINK_CB(in_skb).portid,
3314 nlh->nlmsg_seq, 0, op_flags);
3316 WARN_ON(err == -EMSGSIZE);
3320 err = rtnl_unicast(skb, net, NETLINK_CB(in_skb).portid);
3328 struct nh_dump_filter {
3334 u32 res_bucket_nh_id;
3338 static bool nh_dump_filtered(struct nexthop *nh,
3339 struct nh_dump_filter *filter, u8 family)
3341 const struct net_device *dev;
3342 const struct nh_info *nhi;
3344 if (filter->group_filter && !nh->is_group)
3347 if (!filter->dev_idx && !filter->master_idx && !family)
3353 nhi = rtnl_dereference(nh->nh_info);
3354 if (family && nhi->family != family)
3357 dev = nhi->fib_nhc.nhc_dev;
3358 if (filter->dev_idx && (!dev || dev->ifindex != filter->dev_idx))
3361 if (filter->master_idx) {
3362 struct net_device *master;
3367 master = netdev_master_upper_dev_get((struct net_device *)dev);
3368 if (!master || master->ifindex != filter->master_idx)
3375 static int __nh_valid_dump_req(const struct nlmsghdr *nlh, struct nlattr **tb,
3376 struct nh_dump_filter *filter,
3377 struct netlink_ext_ack *extack)
3383 idx = nla_get_u32(tb[NHA_OIF]);
3384 if (idx > INT_MAX) {
3385 NL_SET_ERR_MSG(extack, "Invalid device index");
3388 filter->dev_idx = idx;
3390 if (tb[NHA_MASTER]) {
3391 idx = nla_get_u32(tb[NHA_MASTER]);
3392 if (idx > INT_MAX) {
3393 NL_SET_ERR_MSG(extack, "Invalid master device index");
3396 filter->master_idx = idx;
3398 filter->group_filter = nla_get_flag(tb[NHA_GROUPS]);
3399 filter->fdb_filter = nla_get_flag(tb[NHA_FDB]);
3401 nhm = nlmsg_data(nlh);
3402 if (nhm->nh_protocol || nhm->resvd || nhm->nh_scope || nhm->nh_flags) {
3403 NL_SET_ERR_MSG(extack, "Invalid values in header for nexthop dump request");
3410 static int nh_valid_dump_req(const struct nlmsghdr *nlh,
3411 struct nh_dump_filter *filter,
3412 struct netlink_callback *cb)
3414 struct nlattr *tb[ARRAY_SIZE(rtm_nh_policy_dump)];
3417 err = nlmsg_parse(nlh, sizeof(struct nhmsg), tb,
3418 ARRAY_SIZE(rtm_nh_policy_dump) - 1,
3419 rtm_nh_policy_dump, cb->extack);
3423 if (tb[NHA_OP_FLAGS])
3424 filter->op_flags = nla_get_u32(tb[NHA_OP_FLAGS]);
3426 filter->op_flags = 0;
3428 return __nh_valid_dump_req(nlh, tb, filter, cb->extack);
3431 struct rtm_dump_nh_ctx {
3435 static struct rtm_dump_nh_ctx *
3436 rtm_dump_nh_ctx(struct netlink_callback *cb)
3438 struct rtm_dump_nh_ctx *ctx = (void *)cb->ctx;
3440 BUILD_BUG_ON(sizeof(*ctx) > sizeof(cb->ctx));
3444 static int rtm_dump_walk_nexthops(struct sk_buff *skb,
3445 struct netlink_callback *cb,
3446 struct rb_root *root,
3447 struct rtm_dump_nh_ctx *ctx,
3448 int (*nh_cb)(struct sk_buff *skb,
3449 struct netlink_callback *cb,
3450 struct nexthop *nh, void *data),
3453 struct rb_node *node;
3458 for (node = rb_first(root); node; node = rb_next(node)) {
3461 nh = rb_entry(node, struct nexthop, rb_node);
3466 err = nh_cb(skb, cb, nh, data);
3474 static int rtm_dump_nexthop_cb(struct sk_buff *skb, struct netlink_callback *cb,
3475 struct nexthop *nh, void *data)
3477 struct nhmsg *nhm = nlmsg_data(cb->nlh);
3478 struct nh_dump_filter *filter = data;
3480 if (nh_dump_filtered(nh, filter, nhm->nh_family))
3483 return nh_fill_node(skb, nh, RTM_NEWNEXTHOP,
3484 NETLINK_CB(cb->skb).portid,
3485 cb->nlh->nlmsg_seq, NLM_F_MULTI, filter->op_flags);
3489 static int rtm_dump_nexthop(struct sk_buff *skb, struct netlink_callback *cb)
3491 struct rtm_dump_nh_ctx *ctx = rtm_dump_nh_ctx(cb);
3492 struct net *net = sock_net(skb->sk);
3493 struct rb_root *root = &net->nexthop.rb_root;
3494 struct nh_dump_filter filter = {};
3497 err = nh_valid_dump_req(cb->nlh, &filter, cb);
3501 err = rtm_dump_walk_nexthops(skb, cb, root, ctx,
3502 &rtm_dump_nexthop_cb, &filter);
3504 cb->seq = net->nexthop.seq;
3505 nl_dump_check_consistent(cb, nlmsg_hdr(skb));
3509 static struct nexthop *
3510 nexthop_find_group_resilient(struct net *net, u32 id,
3511 struct netlink_ext_ack *extack)
3513 struct nh_group *nhg;
3516 nh = nexthop_find_by_id(net, id);
3518 return ERR_PTR(-ENOENT);
3520 if (!nh->is_group) {
3521 NL_SET_ERR_MSG(extack, "Not a nexthop group");
3522 return ERR_PTR(-EINVAL);
3525 nhg = rtnl_dereference(nh->nh_grp);
3526 if (!nhg->resilient) {
3527 NL_SET_ERR_MSG(extack, "Nexthop group not of type resilient");
3528 return ERR_PTR(-EINVAL);
3534 static int nh_valid_dump_nhid(struct nlattr *attr, u32 *nh_id_p,
3535 struct netlink_ext_ack *extack)
3540 idx = nla_get_u32(attr);
3542 NL_SET_ERR_MSG(extack, "Invalid nexthop id");
3553 static int nh_valid_dump_bucket_req(const struct nlmsghdr *nlh,
3554 struct nh_dump_filter *filter,
3555 struct netlink_callback *cb)
3557 struct nlattr *res_tb[ARRAY_SIZE(rtm_nh_res_bucket_policy_dump)];
3558 struct nlattr *tb[ARRAY_SIZE(rtm_nh_policy_dump_bucket)];
3561 err = nlmsg_parse(nlh, sizeof(struct nhmsg), tb,
3562 ARRAY_SIZE(rtm_nh_policy_dump_bucket) - 1,
3563 rtm_nh_policy_dump_bucket, NULL);
3567 err = nh_valid_dump_nhid(tb[NHA_ID], &filter->nh_id, cb->extack);
3571 if (tb[NHA_RES_BUCKET]) {
3572 size_t max = ARRAY_SIZE(rtm_nh_res_bucket_policy_dump) - 1;
3574 err = nla_parse_nested(res_tb, max,
3576 rtm_nh_res_bucket_policy_dump,
3581 err = nh_valid_dump_nhid(res_tb[NHA_RES_BUCKET_NH_ID],
3582 &filter->res_bucket_nh_id,
3588 return __nh_valid_dump_req(nlh, tb, filter, cb->extack);
3591 struct rtm_dump_res_bucket_ctx {
3592 struct rtm_dump_nh_ctx nh;
3596 static struct rtm_dump_res_bucket_ctx *
3597 rtm_dump_res_bucket_ctx(struct netlink_callback *cb)
3599 struct rtm_dump_res_bucket_ctx *ctx = (void *)cb->ctx;
3601 BUILD_BUG_ON(sizeof(*ctx) > sizeof(cb->ctx));
3605 struct rtm_dump_nexthop_bucket_data {
3606 struct rtm_dump_res_bucket_ctx *ctx;
3607 struct nh_dump_filter filter;
3610 static int rtm_dump_nexthop_bucket_nh(struct sk_buff *skb,
3611 struct netlink_callback *cb,
3613 struct rtm_dump_nexthop_bucket_data *dd)
3615 u32 portid = NETLINK_CB(cb->skb).portid;
3616 struct nhmsg *nhm = nlmsg_data(cb->nlh);
3617 struct nh_res_table *res_table;
3618 struct nh_group *nhg;
3622 nhg = rtnl_dereference(nh->nh_grp);
3623 res_table = rtnl_dereference(nhg->res_table);
3624 for (bucket_index = dd->ctx->bucket_index;
3625 bucket_index < res_table->num_nh_buckets;
3627 struct nh_res_bucket *bucket;
3628 struct nh_grp_entry *nhge;
3630 bucket = &res_table->nh_buckets[bucket_index];
3631 nhge = rtnl_dereference(bucket->nh_entry);
3632 if (nh_dump_filtered(nhge->nh, &dd->filter, nhm->nh_family))
3635 if (dd->filter.res_bucket_nh_id &&
3636 dd->filter.res_bucket_nh_id != nhge->nh->id)
3639 dd->ctx->bucket_index = bucket_index;
3640 err = nh_fill_res_bucket(skb, nh, bucket, bucket_index,
3641 RTM_NEWNEXTHOPBUCKET, portid,
3642 cb->nlh->nlmsg_seq, NLM_F_MULTI,
3648 dd->ctx->bucket_index = 0;
3653 static int rtm_dump_nexthop_bucket_cb(struct sk_buff *skb,
3654 struct netlink_callback *cb,
3655 struct nexthop *nh, void *data)
3657 struct rtm_dump_nexthop_bucket_data *dd = data;
3658 struct nh_group *nhg;
3663 nhg = rtnl_dereference(nh->nh_grp);
3664 if (!nhg->resilient)
3667 return rtm_dump_nexthop_bucket_nh(skb, cb, nh, dd);
3671 static int rtm_dump_nexthop_bucket(struct sk_buff *skb,
3672 struct netlink_callback *cb)
3674 struct rtm_dump_res_bucket_ctx *ctx = rtm_dump_res_bucket_ctx(cb);
3675 struct rtm_dump_nexthop_bucket_data dd = { .ctx = ctx };
3676 struct net *net = sock_net(skb->sk);
3680 err = nh_valid_dump_bucket_req(cb->nlh, &dd.filter, cb);
3684 if (dd.filter.nh_id) {
3685 nh = nexthop_find_group_resilient(net, dd.filter.nh_id,
3689 err = rtm_dump_nexthop_bucket_nh(skb, cb, nh, &dd);
3691 struct rb_root *root = &net->nexthop.rb_root;
3693 err = rtm_dump_walk_nexthops(skb, cb, root, &ctx->nh,
3694 &rtm_dump_nexthop_bucket_cb, &dd);
3697 cb->seq = net->nexthop.seq;
3698 nl_dump_check_consistent(cb, nlmsg_hdr(skb));
3702 static int nh_valid_get_bucket_req_res_bucket(struct nlattr *res,
3704 struct netlink_ext_ack *extack)
3706 struct nlattr *tb[ARRAY_SIZE(rtm_nh_res_bucket_policy_get)];
3709 err = nla_parse_nested(tb, ARRAY_SIZE(rtm_nh_res_bucket_policy_get) - 1,
3710 res, rtm_nh_res_bucket_policy_get, extack);
3714 if (!tb[NHA_RES_BUCKET_INDEX]) {
3715 NL_SET_ERR_MSG(extack, "Bucket index is missing");
3719 *bucket_index = nla_get_u16(tb[NHA_RES_BUCKET_INDEX]);
3723 static int nh_valid_get_bucket_req(const struct nlmsghdr *nlh,
3724 u32 *id, u16 *bucket_index,
3725 struct netlink_ext_ack *extack)
3727 struct nlattr *tb[ARRAY_SIZE(rtm_nh_policy_get_bucket)];
3730 err = nlmsg_parse(nlh, sizeof(struct nhmsg), tb,
3731 ARRAY_SIZE(rtm_nh_policy_get_bucket) - 1,
3732 rtm_nh_policy_get_bucket, extack);
3736 err = nh_valid_get_del_req(nlh, tb, id, NULL, extack);
3740 if (!tb[NHA_RES_BUCKET]) {
3741 NL_SET_ERR_MSG(extack, "Bucket information is missing");
3745 err = nh_valid_get_bucket_req_res_bucket(tb[NHA_RES_BUCKET],
3746 bucket_index, extack);
3754 static int rtm_get_nexthop_bucket(struct sk_buff *in_skb, struct nlmsghdr *nlh,
3755 struct netlink_ext_ack *extack)
3757 struct net *net = sock_net(in_skb->sk);
3758 struct nh_res_table *res_table;
3759 struct sk_buff *skb = NULL;
3760 struct nh_group *nhg;
3766 err = nh_valid_get_bucket_req(nlh, &id, &bucket_index, extack);
3770 nh = nexthop_find_group_resilient(net, id, extack);
3774 nhg = rtnl_dereference(nh->nh_grp);
3775 res_table = rtnl_dereference(nhg->res_table);
3776 if (bucket_index >= res_table->num_nh_buckets) {
3777 NL_SET_ERR_MSG(extack, "Bucket index out of bounds");
3781 skb = alloc_skb(NLMSG_GOODSIZE, GFP_KERNEL);
3785 err = nh_fill_res_bucket(skb, nh, &res_table->nh_buckets[bucket_index],
3786 bucket_index, RTM_NEWNEXTHOPBUCKET,
3787 NETLINK_CB(in_skb).portid, nlh->nlmsg_seq,
3790 WARN_ON(err == -EMSGSIZE);
3794 return rtnl_unicast(skb, net, NETLINK_CB(in_skb).portid);
3801 static void nexthop_sync_mtu(struct net_device *dev, u32 orig_mtu)
3803 unsigned int hash = nh_dev_hashfn(dev->ifindex);
3804 struct net *net = dev_net(dev);
3805 struct hlist_head *head = &net->nexthop.devhash[hash];
3806 struct hlist_node *n;
3807 struct nh_info *nhi;
3809 hlist_for_each_entry_safe(nhi, n, head, dev_hash) {
3810 if (nhi->fib_nhc.nhc_dev == dev) {
3811 if (nhi->family == AF_INET)
3812 fib_nhc_update_mtu(&nhi->fib_nhc, dev->mtu,
3819 static int nh_netdev_event(struct notifier_block *this,
3820 unsigned long event, void *ptr)
3822 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
3823 struct netdev_notifier_info_ext *info_ext;
3827 case NETDEV_UNREGISTER:
3828 nexthop_flush_dev(dev, event);
3831 if (!(dev_get_flags(dev) & (IFF_RUNNING | IFF_LOWER_UP)))
3832 nexthop_flush_dev(dev, event);
3834 case NETDEV_CHANGEMTU:
3836 nexthop_sync_mtu(dev, info_ext->ext.mtu);
3837 rt_cache_flush(dev_net(dev));
3843 static struct notifier_block nh_netdev_notifier = {
3844 .notifier_call = nh_netdev_event,
3847 static int nexthops_dump(struct net *net, struct notifier_block *nb,
3848 enum nexthop_event_type event_type,
3849 struct netlink_ext_ack *extack)
3851 struct rb_root *root = &net->nexthop.rb_root;
3852 struct rb_node *node;
3855 for (node = rb_first(root); node; node = rb_next(node)) {
3858 nh = rb_entry(node, struct nexthop, rb_node);
3859 err = call_nexthop_notifier(nb, net, event_type, nh, extack);
3867 int register_nexthop_notifier(struct net *net, struct notifier_block *nb,
3868 struct netlink_ext_ack *extack)
3873 err = nexthops_dump(net, nb, NEXTHOP_EVENT_REPLACE, extack);
3876 err = blocking_notifier_chain_register(&net->nexthop.notifier_chain,
3882 EXPORT_SYMBOL(register_nexthop_notifier);
3884 int __unregister_nexthop_notifier(struct net *net, struct notifier_block *nb)
3888 err = blocking_notifier_chain_unregister(&net->nexthop.notifier_chain,
3891 nexthops_dump(net, nb, NEXTHOP_EVENT_DEL, NULL);
3894 EXPORT_SYMBOL(__unregister_nexthop_notifier);
3896 int unregister_nexthop_notifier(struct net *net, struct notifier_block *nb)
3901 err = __unregister_nexthop_notifier(net, nb);
3905 EXPORT_SYMBOL(unregister_nexthop_notifier);
3907 void nexthop_set_hw_flags(struct net *net, u32 id, bool offload, bool trap)
3909 struct nexthop *nexthop;
3913 nexthop = nexthop_find_by_id(net, id);
3917 nexthop->nh_flags &= ~(RTNH_F_OFFLOAD | RTNH_F_TRAP);
3919 nexthop->nh_flags |= RTNH_F_OFFLOAD;
3921 nexthop->nh_flags |= RTNH_F_TRAP;
3926 EXPORT_SYMBOL(nexthop_set_hw_flags);
3928 void nexthop_bucket_set_hw_flags(struct net *net, u32 id, u16 bucket_index,
3929 bool offload, bool trap)
3931 struct nh_res_table *res_table;
3932 struct nh_res_bucket *bucket;
3933 struct nexthop *nexthop;
3934 struct nh_group *nhg;
3938 nexthop = nexthop_find_by_id(net, id);
3939 if (!nexthop || !nexthop->is_group)
3942 nhg = rcu_dereference(nexthop->nh_grp);
3943 if (!nhg->resilient)
3946 if (bucket_index >= nhg->res_table->num_nh_buckets)
3949 res_table = rcu_dereference(nhg->res_table);
3950 bucket = &res_table->nh_buckets[bucket_index];
3951 bucket->nh_flags &= ~(RTNH_F_OFFLOAD | RTNH_F_TRAP);
3953 bucket->nh_flags |= RTNH_F_OFFLOAD;
3955 bucket->nh_flags |= RTNH_F_TRAP;
3960 EXPORT_SYMBOL(nexthop_bucket_set_hw_flags);
3962 void nexthop_res_grp_activity_update(struct net *net, u32 id, u16 num_buckets,
3963 unsigned long *activity)
3965 struct nh_res_table *res_table;
3966 struct nexthop *nexthop;
3967 struct nh_group *nhg;
3972 nexthop = nexthop_find_by_id(net, id);
3973 if (!nexthop || !nexthop->is_group)
3976 nhg = rcu_dereference(nexthop->nh_grp);
3977 if (!nhg->resilient)
3980 /* Instead of silently ignoring some buckets, demand that the sizes
3983 res_table = rcu_dereference(nhg->res_table);
3984 if (num_buckets != res_table->num_nh_buckets)
3987 for (i = 0; i < num_buckets; i++) {
3988 if (test_bit(i, activity))
3989 nh_res_bucket_set_busy(&res_table->nh_buckets[i]);
3995 EXPORT_SYMBOL(nexthop_res_grp_activity_update);
3997 static void __net_exit nexthop_net_exit_batch_rtnl(struct list_head *net_list,
3998 struct list_head *dev_to_kill)
4003 list_for_each_entry(net, net_list, exit_list)
4004 flush_all_nexthops(net);
4007 static void __net_exit nexthop_net_exit(struct net *net)
4009 kfree(net->nexthop.devhash);
4010 net->nexthop.devhash = NULL;
4013 static int __net_init nexthop_net_init(struct net *net)
4015 size_t sz = sizeof(struct hlist_head) * NH_DEV_HASHSIZE;
4017 net->nexthop.rb_root = RB_ROOT;
4018 net->nexthop.devhash = kzalloc(sz, GFP_KERNEL);
4019 if (!net->nexthop.devhash)
4021 BLOCKING_INIT_NOTIFIER_HEAD(&net->nexthop.notifier_chain);
4026 static struct pernet_operations nexthop_net_ops = {
4027 .init = nexthop_net_init,
4028 .exit = nexthop_net_exit,
4029 .exit_batch_rtnl = nexthop_net_exit_batch_rtnl,
4032 static int __init nexthop_init(void)
4034 register_pernet_subsys(&nexthop_net_ops);
4036 register_netdevice_notifier(&nh_netdev_notifier);
4038 rtnl_register(PF_UNSPEC, RTM_NEWNEXTHOP, rtm_new_nexthop, NULL, 0);
4039 rtnl_register(PF_UNSPEC, RTM_DELNEXTHOP, rtm_del_nexthop, NULL, 0);
4040 rtnl_register(PF_UNSPEC, RTM_GETNEXTHOP, rtm_get_nexthop,
4041 rtm_dump_nexthop, 0);
4043 rtnl_register(PF_INET, RTM_NEWNEXTHOP, rtm_new_nexthop, NULL, 0);
4044 rtnl_register(PF_INET, RTM_GETNEXTHOP, NULL, rtm_dump_nexthop, 0);
4046 rtnl_register(PF_INET6, RTM_NEWNEXTHOP, rtm_new_nexthop, NULL, 0);
4047 rtnl_register(PF_INET6, RTM_GETNEXTHOP, NULL, rtm_dump_nexthop, 0);
4049 rtnl_register(PF_UNSPEC, RTM_GETNEXTHOPBUCKET, rtm_get_nexthop_bucket,
4050 rtm_dump_nexthop_bucket, 0);
4054 subsys_initcall(nexthop_init);