net/devlink/devl_internal.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /* Copyright (c) 2016 Mellanox Technologies. All rights reserved.
   3  * Copyright (c) 2016 Jiri Pirko <jiri@mellanox.com>
   4  */
   5
   6 #include <linux/mutex.h>
   7 #include <linux/netdevice.h>
   8 #include <linux/notifier.h>
   9 #include <linux/types.h>
  10 #include <linux/workqueue.h>
  11 #include <linux/xarray.h>
  12 #include <net/devlink.h>
  13 #include <net/net_namespace.h>
  14
  15 #define DEVLINK_REGISTERED XA_MARK_1
  16
  17 #define DEVLINK_RELOAD_STATS_ARRAY_SIZE \
  18         (__DEVLINK_RELOAD_LIMIT_MAX * __DEVLINK_RELOAD_ACTION_MAX)
  19
  20 struct devlink_dev_stats {
  21         u32 reload_stats[DEVLINK_RELOAD_STATS_ARRAY_SIZE];
  22         u32 remote_reload_stats[DEVLINK_RELOAD_STATS_ARRAY_SIZE];
  23 };
  24
  25 struct devlink {
  26         u32 index;
  27         struct xarray ports;
  28         struct list_head rate_list;
  29         struct list_head sb_list;
  30         struct list_head dpipe_table_list;
  31         struct list_head resource_list;
  32         struct xarray params;
  33         struct list_head region_list;
  34         struct list_head reporter_list;
  35         struct devlink_dpipe_headers *dpipe_headers;
  36         struct list_head trap_list;
  37         struct list_head trap_group_list;
  38         struct list_head trap_policer_list;
  39         struct list_head linecard_list;
  40         const struct devlink_ops *ops;
  41         struct xarray snapshot_ids;
  42         struct devlink_dev_stats stats;
  43         struct device *dev;
  44         possible_net_t _net;
  45         /* Serializes access to devlink instance specific objects such as
  46          * port, sb, dpipe, resource, params, region, traps and more.
  47          */
  48         struct mutex lock;
  49         struct lock_class_key lock_key;
  50         u8 reload_failed:1;
  51         refcount_t refcount;
  52         struct rcu_work rwork;
  53         char priv[] __aligned(NETDEV_ALIGN);
  54 };
  55
  56 extern struct xarray devlinks;
  57 extern struct genl_family devlink_nl_family;
  58
  59 /* devlink instances are open to the access from the user space after
  60  * devlink_register() call. Such logical barrier allows us to have certain
  61  * expectations related to locking.
  62  *
  63  * Before *_register() - we are in initialization stage and no parallel
  64  * access possible to the devlink instance. All drivers perform that phase
  65  * by implicitly holding device_lock.
  66  *
  67  * After *_register() - users and driver can access devlink instance at
  68  * the same time.
  69  */
  70 #define ASSERT_DEVLINK_REGISTERED(d)                                           \
  71         WARN_ON_ONCE(!xa_get_mark(&devlinks, (d)->index, DEVLINK_REGISTERED))
  72 #define ASSERT_DEVLINK_NOT_REGISTERED(d)                                       \
  73         WARN_ON_ONCE(xa_get_mark(&devlinks, (d)->index, DEVLINK_REGISTERED))
  74
  75 /* Iterate over devlink pointers which were possible to get reference to.
  76  * devlink_put() needs to be called for each iterated devlink pointer
  77  * in loop body in order to release the reference.
  78  */
  79 #define devlinks_xa_for_each_registered_get(net, index, devlink)        \
  80         for (index = 0; (devlink = devlinks_xa_find_get(net, &index)); index++)
  81
  82 struct devlink *devlinks_xa_find_get(struct net *net, unsigned long *indexp);
  83
  84 static inline bool devl_is_registered(struct devlink *devlink)
  85 {
  86         devl_assert_locked(devlink);
  87         return xa_get_mark(&devlinks, devlink->index, DEVLINK_REGISTERED);
  88 }
  89
  90 /* Netlink */
  91 #define DEVLINK_NL_FLAG_NEED_PORT               BIT(0)
  92 #define DEVLINK_NL_FLAG_NEED_DEVLINK_OR_PORT    BIT(1)
  93 #define DEVLINK_NL_FLAG_NEED_RATE               BIT(2)
  94 #define DEVLINK_NL_FLAG_NEED_RATE_NODE          BIT(3)
  95 #define DEVLINK_NL_FLAG_NEED_LINECARD           BIT(4)
  96
  97 enum devlink_multicast_groups {
  98         DEVLINK_MCGRP_CONFIG,
  99 };
 100
 101 /* state held across netlink dumps */
 102 struct devlink_nl_dump_state {
 103         unsigned long instance;
 104         int idx;
 105         union {
 106                 /* DEVLINK_CMD_REGION_READ */
 107                 struct {
 108                         u64 start_offset;
 109                 };
 110                 /* DEVLINK_CMD_HEALTH_REPORTER_DUMP_GET */
 111                 struct {
 112                         u64 dump_ts;
 113                 };
 114         };
 115 };
 116
 117 struct devlink_cmd {
 118         int (*dump_one)(struct sk_buff *msg, struct devlink *devlink,
 119                         struct netlink_callback *cb);
 120 };
 121
 122 extern const struct genl_small_ops devlink_nl_ops[56];
 123
 124 struct devlink *
 125 devlink_get_from_attrs_lock(struct net *net, struct nlattr **attrs);
 126
 127 void devlink_notify_unregister(struct devlink *devlink);
 128 void devlink_notify_register(struct devlink *devlink);
 129
 130 int devlink_nl_instance_iter_dumpit(struct sk_buff *msg,
 131                                     struct netlink_callback *cb);
 132
 133 static inline struct devlink_nl_dump_state *
 134 devlink_dump_state(struct netlink_callback *cb)
 135 {
 136         NL_ASSERT_DUMP_CTX_FITS(struct devlink_nl_dump_state);
 137
 138         return (struct devlink_nl_dump_state *)cb->ctx;
 139 }
 140
 141 static inline int
 142 devlink_nl_put_handle(struct sk_buff *msg, struct devlink *devlink)
 143 {
 144         if (nla_put_string(msg, DEVLINK_ATTR_BUS_NAME, devlink->dev->bus->name))
 145                 return -EMSGSIZE;
 146         if (nla_put_string(msg, DEVLINK_ATTR_DEV_NAME, dev_name(devlink->dev)))
 147                 return -EMSGSIZE;
 148         return 0;
 149 }
 150
 151 /* Commands */
 152 extern const struct devlink_cmd devl_cmd_get;
 153 extern const struct devlink_cmd devl_cmd_port_get;
 154 extern const struct devlink_cmd devl_cmd_sb_get;
 155 extern const struct devlink_cmd devl_cmd_sb_pool_get;
 156 extern const struct devlink_cmd devl_cmd_sb_port_pool_get;
 157 extern const struct devlink_cmd devl_cmd_sb_tc_pool_bind_get;
 158 extern const struct devlink_cmd devl_cmd_param_get;
 159 extern const struct devlink_cmd devl_cmd_region_get;
 160 extern const struct devlink_cmd devl_cmd_info_get;
 161 extern const struct devlink_cmd devl_cmd_health_reporter_get;
 162 extern const struct devlink_cmd devl_cmd_trap_get;
 163 extern const struct devlink_cmd devl_cmd_trap_group_get;
 164 extern const struct devlink_cmd devl_cmd_trap_policer_get;
 165 extern const struct devlink_cmd devl_cmd_rate_get;
 166 extern const struct devlink_cmd devl_cmd_linecard_get;
 167 extern const struct devlink_cmd devl_cmd_selftests_get;
 168
 169 /* Notify */
 170 void devlink_notify(struct devlink *devlink, enum devlink_command cmd);
 171
 172 /* Ports */
 173 int devlink_port_netdevice_event(struct notifier_block *nb,
 174                                  unsigned long event, void *ptr);
 175
 176 struct devlink_port *
 177 devlink_port_get_from_info(struct devlink *devlink, struct genl_info *info);
 178 struct devlink_port *devlink_port_get_from_attrs(struct devlink *devlink,
 179                                                  struct nlattr **attrs);
 180
 181 /* Reload */
 182 bool devlink_reload_actions_valid(const struct devlink_ops *ops);
 183 int devlink_reload(struct devlink *devlink, struct net *dest_net,
 184                    enum devlink_reload_action action,
 185                    enum devlink_reload_limit limit,
 186                    u32 *actions_performed, struct netlink_ext_ack *extack);
 187
 188 static inline bool devlink_reload_supported(const struct devlink_ops *ops)
 189 {
 190         return ops->reload_down && ops->reload_up;
 191 }
 192
 193 /* Params */
 194 void devlink_params_driverinit_load_new(struct devlink *devlink);
 195
 196 /* Resources */
 197 struct devlink_resource;
 198 int devlink_resources_validate(struct devlink *devlink,
 199                                struct devlink_resource *resource,
 200                                struct genl_info *info);
 201
 202 /* Line cards */
 203 struct devlink_linecard;
 204
 205 struct devlink_linecard *
 206 devlink_linecard_get_from_info(struct devlink *devlink, struct genl_info *info);
 207
 208 /* Rates */
 209 int devlink_rate_nodes_check(struct devlink *devlink, u16 mode,
 210                              struct netlink_ext_ack *extack);
 211 struct devlink_rate *
 212 devlink_rate_get_from_info(struct devlink *devlink, struct genl_info *info);
 213 struct devlink_rate *
 214 devlink_rate_node_get_from_info(struct devlink *devlink,
 215                                 struct genl_info *info);
 216 /* Devlink nl cmds */
 217 int devlink_nl_cmd_get_doit(struct sk_buff *skb, struct genl_info *info);
 218 int devlink_nl_cmd_reload(struct sk_buff *skb, struct genl_info *info);
 219 int devlink_nl_cmd_eswitch_get_doit(struct sk_buff *skb, struct genl_info *info);
 220 int devlink_nl_cmd_eswitch_set_doit(struct sk_buff *skb, struct genl_info *info);
 221 int devlink_nl_cmd_info_get_doit(struct sk_buff *skb, struct genl_info *info);
 222 int devlink_nl_cmd_flash_update(struct sk_buff *skb, struct genl_info *info);
 223 int devlink_nl_cmd_selftests_get_doit(struct sk_buff *skb, struct genl_info *info);
 224 int devlink_nl_cmd_selftests_run(struct sk_buff *skb, struct genl_info *info);
 225 int devlink_nl_cmd_health_reporter_get_doit(struct sk_buff *skb,
 226                                             struct genl_info *info);
 227 int devlink_nl_cmd_health_reporter_set_doit(struct sk_buff *skb,
 228                                             struct genl_info *info);
 229 int devlink_nl_cmd_health_reporter_recover_doit(struct sk_buff *skb,
 230                                                 struct genl_info *info);
 231 int devlink_nl_cmd_health_reporter_diagnose_doit(struct sk_buff *skb,
 232                                                  struct genl_info *info);
 233 int devlink_nl_cmd_health_reporter_dump_get_dumpit(struct sk_buff *skb,
 234                                                    struct netlink_callback *cb);
 235 int devlink_nl_cmd_health_reporter_dump_clear_doit(struct sk_buff *skb,
 236                                                    struct genl_info *info);
 237 int devlink_nl_cmd_health_reporter_test_doit(struct sk_buff *skb,
 238                                              struct genl_info *info);