Commit 5d77371e authored by Jiri Pirko's avatar Jiri Pirko Committed by David S. Miller
Browse files

devlink: document devlink_rel_nested_in_notify() function 



Add a documentation for devlink_rel_nested_in_notify() describing the
devlink instance locking consequences.

Signed-off-by: default avatarJiri Pirko <jiri@nvidia.com>
Reviewed-by: default avatarSimon Horman <horms@kernel.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent bb11cf9b

net/devlink/core.c

+14 −0
Original line number Diff line number Diff line
@@ -168,6 +168,20 @@ int devlink_rel_nested_in_add(u32 *rel_index, u32 devlink_index, 
	return 0;

}



/**

 * devlink_rel_nested_in_notify - Notify the object this devlink

 *				  instance is nested in.

 * @devlink: devlink

 *

 * This is called upon network namespace change of devlink instance.

 * In case this devlink instance is nested in another devlink object,

 * a notification of a change of this object should be sent

 * over netlink. The parent devlink instance lock needs to be

 * taken during the notification preparation.

 * However, since the devlink lock of nested instance is held here,

 * we would end with wrong devlink instance lock ordering and

 * deadlock. Therefore the work is utilized to avoid that.

 */

void devlink_rel_nested_in_notify(struct devlink *devlink)

{

	struct devlink_rel *rel = devlink->rel;