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/device.h> 7 #include <linux/etherdevice.h> 8 #include <linux/mutex.h> 9 #include <linux/netdevice.h> 10 #include <linux/notifier.h> 11 #include <linux/types.h> 12 #include <linux/workqueue.h> 13 #include <linux/xarray.h> 14 #include <net/devlink.h> 15 #include <net/net_namespace.h> 16 #include <net/rtnetlink.h> 17 #include <rdma/ib_verbs.h> 18 19 #include "netlink_gen.h" 20 21 struct devlink_rel; 22 23 #define DEVLINK_REGISTERED XA_MARK_1 24 25 #define DEVLINK_RELOAD_STATS_ARRAY_SIZE \ 26 (__DEVLINK_RELOAD_LIMIT_MAX * __DEVLINK_RELOAD_ACTION_MAX) 27 28 struct devlink_dev_stats { 29 u32 reload_stats[DEVLINK_RELOAD_STATS_ARRAY_SIZE]; 30 u32 remote_reload_stats[DEVLINK_RELOAD_STATS_ARRAY_SIZE]; 31 }; 32 33 struct devlink { 34 u32 index; 35 struct xarray ports; 36 struct list_head rate_list; 37 struct list_head sb_list; 38 struct list_head dpipe_table_list; 39 struct list_head resource_list; 40 struct xarray params; 41 struct list_head region_list; 42 struct list_head reporter_list; 43 struct devlink_dpipe_headers *dpipe_headers; 44 struct list_head trap_list; 45 struct list_head trap_group_list; 46 struct list_head trap_policer_list; 47 struct list_head linecard_list; 48 const struct devlink_ops *ops; 49 struct xarray snapshot_ids; 50 struct devlink_dev_stats stats; 51 struct device *dev; 52 const char *dev_name_index; 53 const struct device_driver *dev_driver; 54 possible_net_t _net; 55 /* Serializes access to devlink instance specific objects such as 56 * port, sb, dpipe, resource, params, region, traps and more. 57 */ 58 struct mutex lock; 59 struct lock_class_key lock_key; 60 u8 reload_failed:1; 61 refcount_t refcount; 62 struct rcu_work rwork; 63 struct devlink_rel *rel; 64 struct xarray nested_rels; 65 char priv[] __aligned(NETDEV_ALIGN); 66 }; 67 68 extern struct xarray devlinks; 69 extern struct genl_family devlink_nl_family; 70 71 struct devlink *__devlink_alloc(const struct devlink_ops *ops, size_t priv_size, 72 struct net *net, struct device *dev, 73 const struct device_driver *dev_driver); 74 75 #define devl_warn(devlink, format, args...) \ 76 do { \ 77 if ((devlink)->dev) \ 78 dev_warn((devlink)->dev, format, ##args); \ 79 else \ 80 pr_warn("devlink (%s): " format, \ 81 devlink_dev_name(devlink), ##args); \ 82 } while (0) 83 84 /* devlink instances are open to the access from the user space after 85 * devlink_register() call. Such logical barrier allows us to have certain 86 * expectations related to locking. 87 * 88 * Before *_register() - we are in initialization stage and no parallel 89 * access possible to the devlink instance. All drivers perform that phase 90 * by implicitly holding device_lock. 91 * 92 * After *_register() - users and driver can access devlink instance at 93 * the same time. 94 */ 95 #define ASSERT_DEVLINK_REGISTERED(d) \ 96 WARN_ON_ONCE(!xa_get_mark(&devlinks, (d)->index, DEVLINK_REGISTERED)) 97 #define ASSERT_DEVLINK_NOT_REGISTERED(d) \ 98 WARN_ON_ONCE(xa_get_mark(&devlinks, (d)->index, DEVLINK_REGISTERED)) 99 100 /* Iterate over devlink pointers which were possible to get reference to. 101 * devlink_put() needs to be called for each iterated devlink pointer 102 * in loop body in order to release the reference. 103 */ 104 #define devlinks_xa_for_each_registered_get(net, index, devlink) \ 105 for (index = 0; (devlink = devlinks_xa_find_get(net, &index)); index++) 106 107 struct devlink *devlinks_xa_find_get(struct net *net, unsigned long *indexp); 108 struct devlink *devlinks_xa_lookup_get(struct net *net, unsigned long index); 109 110 static inline bool __devl_is_registered(struct devlink *devlink) 111 { 112 return xa_get_mark(&devlinks, devlink->index, DEVLINK_REGISTERED); 113 } 114 115 static inline bool devl_is_registered(struct devlink *devlink) 116 { 117 devl_assert_locked(devlink); 118 return __devl_is_registered(devlink); 119 } 120 121 static inline void devl_dev_lock(struct devlink *devlink, bool dev_lock) 122 { 123 if (dev_lock && devlink->dev) 124 device_lock(devlink->dev); 125 devl_lock(devlink); 126 } 127 128 static inline void devl_dev_unlock(struct devlink *devlink, bool dev_lock) 129 { 130 devl_unlock(devlink); 131 if (dev_lock && devlink->dev) 132 device_unlock(devlink->dev); 133 } 134 135 typedef void devlink_rel_notify_cb_t(struct devlink *devlink, u32 obj_index); 136 typedef void devlink_rel_cleanup_cb_t(struct devlink *devlink, u32 obj_index, 137 u32 rel_index); 138 139 void devlink_rel_nested_in_clear(u32 rel_index); 140 int devlink_rel_nested_in_add(u32 *rel_index, u32 devlink_index, 141 u32 obj_index, devlink_rel_notify_cb_t *notify_cb, 142 devlink_rel_cleanup_cb_t *cleanup_cb, 143 struct devlink *devlink); 144 void devlink_rel_nested_in_notify(struct devlink *devlink); 145 int devlink_rel_devlink_handle_put(struct sk_buff *msg, struct devlink *devlink, 146 u32 rel_index, int attrtype, 147 bool *msg_updated); 148 149 /* Netlink */ 150 enum devlink_multicast_groups { 151 DEVLINK_MCGRP_CONFIG, 152 }; 153 154 /* state held across netlink dumps */ 155 struct devlink_nl_dump_state { 156 unsigned long instance; 157 int idx; 158 union { 159 /* DEVLINK_CMD_REGION_READ */ 160 struct { 161 u64 start_offset; 162 }; 163 /* DEVLINK_CMD_HEALTH_REPORTER_DUMP_GET */ 164 struct { 165 u64 dump_ts; 166 }; 167 }; 168 }; 169 170 typedef int devlink_nl_dump_one_func_t(struct sk_buff *msg, 171 struct devlink *devlink, 172 struct netlink_callback *cb, 173 int flags); 174 175 struct devlink * 176 devlink_get_from_attrs_lock(struct net *net, struct nlattr **attrs, 177 bool dev_lock); 178 179 int devlink_nl_dumpit(struct sk_buff *msg, struct netlink_callback *cb, 180 devlink_nl_dump_one_func_t *dump_one); 181 182 static inline struct devlink_nl_dump_state * 183 devlink_dump_state(struct netlink_callback *cb) 184 { 185 NL_ASSERT_CTX_FITS(struct devlink_nl_dump_state); 186 187 return (struct devlink_nl_dump_state *)cb->ctx; 188 } 189 190 static inline int 191 devlink_nl_put_handle(struct sk_buff *msg, struct devlink *devlink) 192 { 193 if (nla_put_string(msg, DEVLINK_ATTR_BUS_NAME, devlink_bus_name(devlink))) 194 return -EMSGSIZE; 195 if (nla_put_string(msg, DEVLINK_ATTR_DEV_NAME, devlink_dev_name(devlink))) 196 return -EMSGSIZE; 197 if (nla_put_uint(msg, DEVLINK_ATTR_INDEX, devlink->index)) 198 return -EMSGSIZE; 199 return 0; 200 } 201 202 static inline int devlink_nl_put_u64(struct sk_buff *msg, int attrtype, u64 val) 203 { 204 return nla_put_u64_64bit(msg, attrtype, val, DEVLINK_ATTR_PAD); 205 } 206 207 int devlink_nl_put_nested_handle(struct sk_buff *msg, struct net *net, 208 struct devlink *devlink, int attrtype); 209 int devlink_nl_msg_reply_and_new(struct sk_buff **msg, struct genl_info *info); 210 211 static inline bool devlink_nl_notify_need(struct devlink *devlink) 212 { 213 return genl_has_listeners(&devlink_nl_family, devlink_net(devlink), 214 DEVLINK_MCGRP_CONFIG); 215 } 216 217 struct devlink_obj_desc { 218 struct rcu_head rcu; 219 const char *bus_name; 220 const char *dev_name; 221 unsigned int port_index; 222 bool port_index_valid; 223 unsigned int devlink_index; 224 bool devlink_index_valid; 225 long data[]; 226 }; 227 228 static inline void devlink_nl_obj_desc_init(struct devlink_obj_desc *desc, 229 struct devlink *devlink) 230 { 231 memset(desc, 0, sizeof(*desc)); 232 desc->bus_name = devlink_bus_name(devlink); 233 desc->dev_name = devlink_dev_name(devlink); 234 desc->devlink_index = devlink->index; 235 desc->devlink_index_valid = true; 236 } 237 238 static inline void devlink_nl_obj_desc_port_set(struct devlink_obj_desc *desc, 239 struct devlink_port *devlink_port) 240 { 241 desc->port_index = devlink_port->index; 242 desc->port_index_valid = true; 243 } 244 245 int devlink_nl_notify_filter(struct sock *dsk, struct sk_buff *skb, void *data); 246 247 static inline void devlink_nl_notify_send_desc(struct devlink *devlink, 248 struct sk_buff *msg, 249 struct devlink_obj_desc *desc) 250 { 251 genlmsg_multicast_netns_filtered(&devlink_nl_family, 252 devlink_net(devlink), 253 msg, 0, DEVLINK_MCGRP_CONFIG, 254 GFP_KERNEL, 255 devlink_nl_notify_filter, desc); 256 } 257 258 static inline void devlink_nl_notify_send(struct devlink *devlink, 259 struct sk_buff *msg) 260 { 261 struct devlink_obj_desc desc; 262 263 devlink_nl_obj_desc_init(&desc, devlink); 264 devlink_nl_notify_send_desc(devlink, msg, &desc); 265 } 266 267 /* Notify */ 268 void devlink_notify_register(struct devlink *devlink); 269 void devlink_notify_unregister(struct devlink *devlink); 270 void devlink_ports_notify_register(struct devlink *devlink); 271 void devlink_ports_notify_unregister(struct devlink *devlink); 272 void devlink_params_notify_register(struct devlink *devlink); 273 void devlink_params_notify_unregister(struct devlink *devlink); 274 void devlink_regions_notify_register(struct devlink *devlink); 275 void devlink_regions_notify_unregister(struct devlink *devlink); 276 void devlink_trap_policers_notify_register(struct devlink *devlink); 277 void devlink_trap_policers_notify_unregister(struct devlink *devlink); 278 void devlink_trap_groups_notify_register(struct devlink *devlink); 279 void devlink_trap_groups_notify_unregister(struct devlink *devlink); 280 void devlink_traps_notify_register(struct devlink *devlink); 281 void devlink_traps_notify_unregister(struct devlink *devlink); 282 void devlink_rates_notify_register(struct devlink *devlink); 283 void devlink_rates_notify_unregister(struct devlink *devlink); 284 void devlink_linecards_notify_register(struct devlink *devlink); 285 void devlink_linecards_notify_unregister(struct devlink *devlink); 286 287 /* Ports */ 288 #define ASSERT_DEVLINK_PORT_INITIALIZED(devlink_port) \ 289 WARN_ON_ONCE(!(devlink_port)->initialized) 290 291 struct devlink_port *devlink_port_get_by_index(struct devlink *devlink, 292 unsigned int port_index); 293 int devlink_port_netdevice_event(struct notifier_block *nb, 294 unsigned long event, void *ptr); 295 struct devlink_port * 296 devlink_port_get_from_info(struct devlink *devlink, struct genl_info *info); 297 struct devlink_port *devlink_port_get_from_attrs(struct devlink *devlink, 298 struct nlattr **attrs); 299 300 /* Reload */ 301 bool devlink_reload_actions_valid(const struct devlink_ops *ops); 302 int devlink_reload(struct devlink *devlink, struct net *dest_net, 303 enum devlink_reload_action action, 304 enum devlink_reload_limit limit, 305 u32 *actions_performed, struct netlink_ext_ack *extack); 306 307 static inline bool devlink_reload_supported(const struct devlink_ops *ops) 308 { 309 return ops->reload_down && ops->reload_up; 310 } 311 312 /* Params */ 313 void devlink_params_driverinit_load_new(struct devlink *devlink); 314 315 /* Resources */ 316 struct devlink_resource; 317 int devlink_resources_validate(struct devlink *devlink, 318 struct devlink_resource *resource, 319 struct genl_info *info); 320 321 /* Rates */ 322 bool devlink_rate_is_node(const struct devlink_rate *devlink_rate); 323 int devlink_rates_check(struct devlink *devlink, 324 bool (*rate_filter)(const struct devlink_rate *), 325 struct netlink_ext_ack *extack); 326 327 /* Linecards */ 328 unsigned int devlink_linecard_index(struct devlink_linecard *linecard); 329