1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* Copyright (c) 2016 Mellanox Technologies. All rights reserved. 3 * Copyright (c) 2016 Jiri Pirko <[email protected]> 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 possible_net_t _net; 53 /* Serializes access to devlink instance specific objects such as 54 * port, sb, dpipe, resource, params, region, traps and more. 55 */ 56 struct mutex lock; 57 struct lock_class_key lock_key; 58 u8 reload_failed:1; 59 refcount_t refcount; 60 struct rcu_work rwork; 61 struct devlink_rel *rel; 62 struct xarray nested_rels; 63 char priv[] __aligned(NETDEV_ALIGN); 64 }; 65 66 extern struct xarray devlinks; 67 extern struct genl_family devlink_nl_family; 68 69 /* devlink instances are open to the access from the user space after 70 * devlink_register() call. Such logical barrier allows us to have certain 71 * expectations related to locking. 72 * 73 * Before *_register() - we are in initialization stage and no parallel 74 * access possible to the devlink instance. All drivers perform that phase 75 * by implicitly holding device_lock. 76 * 77 * After *_register() - users and driver can access devlink instance at 78 * the same time. 79 */ 80 #define ASSERT_DEVLINK_REGISTERED(d) \ 81 WARN_ON_ONCE(!xa_get_mark(&devlinks, (d)->index, DEVLINK_REGISTERED)) 82 #define ASSERT_DEVLINK_NOT_REGISTERED(d) \ 83 WARN_ON_ONCE(xa_get_mark(&devlinks, (d)->index, DEVLINK_REGISTERED)) 84 85 /* Iterate over devlink pointers which were possible to get reference to. 86 * devlink_put() needs to be called for each iterated devlink pointer 87 * in loop body in order to release the reference. 88 */ 89 #define devlinks_xa_for_each_registered_get(net, index, devlink) \ 90 for (index = 0; (devlink = devlinks_xa_find_get(net, &index)); index++) 91 92 struct devlink *devlinks_xa_find_get(struct net *net, unsigned long *indexp); 93 94 static inline bool __devl_is_registered(struct devlink *devlink) 95 { 96 return xa_get_mark(&devlinks, devlink->index, DEVLINK_REGISTERED); 97 } 98 99 static inline bool devl_is_registered(struct devlink *devlink) 100 { 101 devl_assert_locked(devlink); 102 return __devl_is_registered(devlink); 103 } 104 105 static inline void devl_dev_lock(struct devlink *devlink, bool dev_lock) 106 { 107 if (dev_lock) 108 device_lock(devlink->dev); 109 devl_lock(devlink); 110 } 111 112 static inline void devl_dev_unlock(struct devlink *devlink, bool dev_lock) 113 { 114 devl_unlock(devlink); 115 if (dev_lock) 116 device_unlock(devlink->dev); 117 } 118 119 typedef void devlink_rel_notify_cb_t(struct devlink *devlink, u32 obj_index); 120 typedef void devlink_rel_cleanup_cb_t(struct devlink *devlink, u32 obj_index, 121 u32 rel_index); 122 123 void devlink_rel_nested_in_clear(u32 rel_index); 124 int devlink_rel_nested_in_add(u32 *rel_index, u32 devlink_index, 125 u32 obj_index, devlink_rel_notify_cb_t *notify_cb, 126 devlink_rel_cleanup_cb_t *cleanup_cb, 127 struct devlink *devlink); 128 void devlink_rel_nested_in_notify(struct devlink *devlink); 129 int devlink_rel_devlink_handle_put(struct sk_buff *msg, struct devlink *devlink, 130 u32 rel_index, int attrtype, 131 bool *msg_updated); 132 133 /* Netlink */ 134 enum devlink_multicast_groups { 135 DEVLINK_MCGRP_CONFIG, 136 }; 137 138 /* state held across netlink dumps */ 139 struct devlink_nl_dump_state { 140 unsigned long instance; 141 int idx; 142 union { 143 /* DEVLINK_CMD_REGION_READ */ 144 struct { 145 u64 start_offset; 146 }; 147 /* DEVLINK_CMD_HEALTH_REPORTER_DUMP_GET */ 148 struct { 149 u64 dump_ts; 150 }; 151 }; 152 }; 153 154 typedef int devlink_nl_dump_one_func_t(struct sk_buff *msg, 155 struct devlink *devlink, 156 struct netlink_callback *cb, 157 int flags); 158 159 struct devlink * 160 devlink_get_from_attrs_lock(struct net *net, struct nlattr **attrs, 161 bool dev_lock); 162 163 int devlink_nl_dumpit(struct sk_buff *msg, struct netlink_callback *cb, 164 devlink_nl_dump_one_func_t *dump_one); 165 166 static inline struct devlink_nl_dump_state * 167 devlink_dump_state(struct netlink_callback *cb) 168 { 169 NL_ASSERT_DUMP_CTX_FITS(struct devlink_nl_dump_state); 170 171 return (struct devlink_nl_dump_state *)cb->ctx; 172 } 173 174 static inline int 175 devlink_nl_put_handle(struct sk_buff *msg, struct devlink *devlink) 176 { 177 if (nla_put_string(msg, DEVLINK_ATTR_BUS_NAME, devlink->dev->bus->name)) 178 return -EMSGSIZE; 179 if (nla_put_string(msg, DEVLINK_ATTR_DEV_NAME, dev_name(devlink->dev))) 180 return -EMSGSIZE; 181 return 0; 182 } 183 184 int devlink_nl_put_nested_handle(struct sk_buff *msg, struct net *net, 185 struct devlink *devlink, int attrtype); 186 int devlink_nl_msg_reply_and_new(struct sk_buff **msg, struct genl_info *info); 187 188 static inline bool devlink_nl_notify_need(struct devlink *devlink) 189 { 190 return genl_has_listeners(&devlink_nl_family, devlink_net(devlink), 191 DEVLINK_MCGRP_CONFIG); 192 } 193 194 struct devlink_obj_desc { 195 struct rcu_head rcu; 196 const char *bus_name; 197 const char *dev_name; 198 long data[]; 199 }; 200 201 static inline void devlink_nl_obj_desc_init(struct devlink_obj_desc *desc, 202 struct devlink *devlink) 203 { 204 memset(desc, 0, sizeof(*desc)); 205 desc->bus_name = devlink->dev->bus->name; 206 desc->dev_name = dev_name(devlink->dev); 207 } 208 209 int devlink_nl_notify_filter(struct sock *dsk, struct sk_buff *skb, void *data); 210 211 static inline void devlink_nl_notify_send_desc(struct devlink *devlink, 212 struct sk_buff *msg, 213 struct devlink_obj_desc *desc) 214 { 215 genlmsg_multicast_netns_filtered(&devlink_nl_family, 216 devlink_net(devlink), 217 msg, 0, DEVLINK_MCGRP_CONFIG, 218 GFP_KERNEL, 219 devlink_nl_notify_filter, desc); 220 } 221 222 static inline void devlink_nl_notify_send(struct devlink *devlink, 223 struct sk_buff *msg) 224 { 225 struct devlink_obj_desc desc; 226 227 devlink_nl_obj_desc_init(&desc, devlink); 228 devlink_nl_notify_send_desc(devlink, msg, &desc); 229 } 230 231 /* Notify */ 232 void devlink_notify_register(struct devlink *devlink); 233 void devlink_notify_unregister(struct devlink *devlink); 234 void devlink_ports_notify_register(struct devlink *devlink); 235 void devlink_ports_notify_unregister(struct devlink *devlink); 236 void devlink_params_notify_register(struct devlink *devlink); 237 void devlink_params_notify_unregister(struct devlink *devlink); 238 void devlink_regions_notify_register(struct devlink *devlink); 239 void devlink_regions_notify_unregister(struct devlink *devlink); 240 void devlink_trap_policers_notify_register(struct devlink *devlink); 241 void devlink_trap_policers_notify_unregister(struct devlink *devlink); 242 void devlink_trap_groups_notify_register(struct devlink *devlink); 243 void devlink_trap_groups_notify_unregister(struct devlink *devlink); 244 void devlink_traps_notify_register(struct devlink *devlink); 245 void devlink_traps_notify_unregister(struct devlink *devlink); 246 void devlink_rates_notify_register(struct devlink *devlink); 247 void devlink_rates_notify_unregister(struct devlink *devlink); 248 void devlink_linecards_notify_register(struct devlink *devlink); 249 void devlink_linecards_notify_unregister(struct devlink *devlink); 250 251 /* Ports */ 252 #define ASSERT_DEVLINK_PORT_INITIALIZED(devlink_port) \ 253 WARN_ON_ONCE(!(devlink_port)->initialized) 254 255 struct devlink_port *devlink_port_get_by_index(struct devlink *devlink, 256 unsigned int port_index); 257 int devlink_port_netdevice_event(struct notifier_block *nb, 258 unsigned long event, void *ptr); 259 struct devlink_port * 260 devlink_port_get_from_info(struct devlink *devlink, struct genl_info *info); 261 struct devlink_port *devlink_port_get_from_attrs(struct devlink *devlink, 262 struct nlattr **attrs); 263 264 /* Reload */ 265 bool devlink_reload_actions_valid(const struct devlink_ops *ops); 266 int devlink_reload(struct devlink *devlink, struct net *dest_net, 267 enum devlink_reload_action action, 268 enum devlink_reload_limit limit, 269 u32 *actions_performed, struct netlink_ext_ack *extack); 270 271 static inline bool devlink_reload_supported(const struct devlink_ops *ops) 272 { 273 return ops->reload_down && ops->reload_up; 274 } 275 276 /* Params */ 277 void devlink_params_driverinit_load_new(struct devlink *devlink); 278 279 /* Resources */ 280 struct devlink_resource; 281 int devlink_resources_validate(struct devlink *devlink, 282 struct devlink_resource *resource, 283 struct genl_info *info); 284 285 /* Rates */ 286 int devlink_rate_nodes_check(struct devlink *devlink, u16 mode, 287 struct netlink_ext_ack *extack); 288 289 /* Linecards */ 290 unsigned int devlink_linecard_index(struct devlink_linecard *linecard); 291