xref: /linux/net/devlink/devl_internal.h (revision 79ac11393328fb1717d17c12e3c0eef0e9fa0647)
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 	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 	devl_assert_locked(devlink);
97 	return xa_get_mark(&devlinks, devlink->index, DEVLINK_REGISTERED);
98 }
99 
100 static inline void devl_dev_lock(struct devlink *devlink, bool dev_lock)
101 {
102 	if (dev_lock)
103 		device_lock(devlink->dev);
104 	devl_lock(devlink);
105 }
106 
107 static inline void devl_dev_unlock(struct devlink *devlink, bool dev_lock)
108 {
109 	devl_unlock(devlink);
110 	if (dev_lock)
111 		device_unlock(devlink->dev);
112 }
113 
114 typedef void devlink_rel_notify_cb_t(struct devlink *devlink, u32 obj_index);
115 typedef void devlink_rel_cleanup_cb_t(struct devlink *devlink, u32 obj_index,
116 				      u32 rel_index);
117 
118 void devlink_rel_nested_in_clear(u32 rel_index);
119 int devlink_rel_nested_in_add(u32 *rel_index, u32 devlink_index,
120 			      u32 obj_index, devlink_rel_notify_cb_t *notify_cb,
121 			      devlink_rel_cleanup_cb_t *cleanup_cb,
122 			      struct devlink *devlink);
123 void devlink_rel_nested_in_notify(struct devlink *devlink);
124 int devlink_rel_devlink_handle_put(struct sk_buff *msg, struct devlink *devlink,
125 				   u32 rel_index, int attrtype,
126 				   bool *msg_updated);
127 
128 /* Netlink */
129 enum devlink_multicast_groups {
130 	DEVLINK_MCGRP_CONFIG,
131 };
132 
133 /* state held across netlink dumps */
134 struct devlink_nl_dump_state {
135 	unsigned long instance;
136 	int idx;
137 	union {
138 		/* DEVLINK_CMD_REGION_READ */
139 		struct {
140 			u64 start_offset;
141 		};
142 		/* DEVLINK_CMD_HEALTH_REPORTER_DUMP_GET */
143 		struct {
144 			u64 dump_ts;
145 		};
146 	};
147 };
148 
149 typedef int devlink_nl_dump_one_func_t(struct sk_buff *msg,
150 				       struct devlink *devlink,
151 				       struct netlink_callback *cb,
152 				       int flags);
153 
154 struct devlink *
155 devlink_get_from_attrs_lock(struct net *net, struct nlattr **attrs,
156 			    bool dev_lock);
157 
158 int devlink_nl_dumpit(struct sk_buff *msg, struct netlink_callback *cb,
159 		      devlink_nl_dump_one_func_t *dump_one);
160 
161 static inline struct devlink_nl_dump_state *
162 devlink_dump_state(struct netlink_callback *cb)
163 {
164 	NL_ASSERT_DUMP_CTX_FITS(struct devlink_nl_dump_state);
165 
166 	return (struct devlink_nl_dump_state *)cb->ctx;
167 }
168 
169 static inline int
170 devlink_nl_put_handle(struct sk_buff *msg, struct devlink *devlink)
171 {
172 	if (nla_put_string(msg, DEVLINK_ATTR_BUS_NAME, devlink->dev->bus->name))
173 		return -EMSGSIZE;
174 	if (nla_put_string(msg, DEVLINK_ATTR_DEV_NAME, dev_name(devlink->dev)))
175 		return -EMSGSIZE;
176 	return 0;
177 }
178 
179 int devlink_nl_put_nested_handle(struct sk_buff *msg, struct net *net,
180 				 struct devlink *devlink, int attrtype);
181 int devlink_nl_msg_reply_and_new(struct sk_buff **msg, struct genl_info *info);
182 
183 /* Notify */
184 void devlink_notify_register(struct devlink *devlink);
185 void devlink_notify_unregister(struct devlink *devlink);
186 void devlink_ports_notify_register(struct devlink *devlink);
187 void devlink_ports_notify_unregister(struct devlink *devlink);
188 void devlink_params_notify_register(struct devlink *devlink);
189 void devlink_params_notify_unregister(struct devlink *devlink);
190 void devlink_regions_notify_register(struct devlink *devlink);
191 void devlink_regions_notify_unregister(struct devlink *devlink);
192 void devlink_trap_policers_notify_register(struct devlink *devlink);
193 void devlink_trap_policers_notify_unregister(struct devlink *devlink);
194 void devlink_trap_groups_notify_register(struct devlink *devlink);
195 void devlink_trap_groups_notify_unregister(struct devlink *devlink);
196 void devlink_traps_notify_register(struct devlink *devlink);
197 void devlink_traps_notify_unregister(struct devlink *devlink);
198 void devlink_rates_notify_register(struct devlink *devlink);
199 void devlink_rates_notify_unregister(struct devlink *devlink);
200 void devlink_linecards_notify_register(struct devlink *devlink);
201 void devlink_linecards_notify_unregister(struct devlink *devlink);
202 
203 /* Ports */
204 #define ASSERT_DEVLINK_PORT_INITIALIZED(devlink_port)				\
205 	WARN_ON_ONCE(!(devlink_port)->initialized)
206 
207 struct devlink_port *devlink_port_get_by_index(struct devlink *devlink,
208 					       unsigned int port_index);
209 int devlink_port_netdevice_event(struct notifier_block *nb,
210 				 unsigned long event, void *ptr);
211 struct devlink_port *
212 devlink_port_get_from_info(struct devlink *devlink, struct genl_info *info);
213 struct devlink_port *devlink_port_get_from_attrs(struct devlink *devlink,
214 						 struct nlattr **attrs);
215 
216 /* Reload */
217 bool devlink_reload_actions_valid(const struct devlink_ops *ops);
218 int devlink_reload(struct devlink *devlink, struct net *dest_net,
219 		   enum devlink_reload_action action,
220 		   enum devlink_reload_limit limit,
221 		   u32 *actions_performed, struct netlink_ext_ack *extack);
222 
223 static inline bool devlink_reload_supported(const struct devlink_ops *ops)
224 {
225 	return ops->reload_down && ops->reload_up;
226 }
227 
228 /* Params */
229 void devlink_params_driverinit_load_new(struct devlink *devlink);
230 
231 /* Resources */
232 struct devlink_resource;
233 int devlink_resources_validate(struct devlink *devlink,
234 			       struct devlink_resource *resource,
235 			       struct genl_info *info);
236 
237 /* Rates */
238 int devlink_rate_nodes_check(struct devlink *devlink, u16 mode,
239 			     struct netlink_ext_ack *extack);
240 
241 /* Linecards */
242 unsigned int devlink_linecard_index(struct devlink_linecard *linecard);
243