Commit c30b70de authored by GhantaKrishnamurthy MohanKrishna's avatar GhantaKrishnamurthy MohanKrishna Committed by David S. Miller
Browse files

tipc: implement socket diagnostics for AF_TIPC 



This commit adds socket diagnostics capability for AF_TIPC in netlink
family NETLINK_SOCK_DIAG in a new kernel module (diag.ko).

The following are key design considerations:
- config TIPC_DIAG has default y, like INET_DIAG.
- only requests with flag NLM_F_DUMP is supported (dump all).
- tipc_sock_diag_req message is introduced to send filter parameters.
- the response attributes are of TLV, some nested.

To avoid exposing data structures between diag and tipc modules and
avoid code duplication, the following additions are required:
- export tipc_nl_sk_walk function to reuse socket iterator.
- export tipc_sk_fill_sock_diag to fill the tipc diag attributes.
- create a sock_diag response message in __tipc_add_sock_diag defined
  in diag.c and use the above exported tipc_sk_fill_sock_diag
  to fill response.

Acked-by: default avatarJon Maloy <jon.maloy@ericsson.com>
Acked-by: default avatarYing Xue <ying.xue@windriver.com>
Signed-off-by: default avatarGhantaKrishnamurthy MohanKrishna <mohan.krishna.ghanta.krishnamurthy@ericsson.com>
Signed-off-by: default avatarParthasarathy Bhuvaragan <parthasarathy.bhuvaragan@gmail.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent dfde331e

include/uapi/linux/tipc_netlink.h

+18 −0
Original line number Diff line number Diff line
@@ -114,6 +114,13 @@ enum { 
	TIPC_NLA_SOCK_REF,		/* u32 */

	TIPC_NLA_SOCK_CON,		/* nest */

	TIPC_NLA_SOCK_HAS_PUBL,		/* flag */

	TIPC_NLA_SOCK_STAT,		/* nest */

	TIPC_NLA_SOCK_TYPE,		/* u32 */

	TIPC_NLA_SOCK_INO,		/* u32 */

	TIPC_NLA_SOCK_UID,		/* u32 */

	TIPC_NLA_SOCK_TIPC_STATE,	/* u32 */

	TIPC_NLA_SOCK_COOKIE,		/* u64 */

	TIPC_NLA_SOCK_PAD,		/* flag */



	__TIPC_NLA_SOCK_MAX,

	TIPC_NLA_SOCK_MAX = __TIPC_NLA_SOCK_MAX - 1
@@ -238,6 +245,17 @@ enum { 
	TIPC_NLA_CON_MAX = __TIPC_NLA_CON_MAX - 1

};



/* Nest, socket statistics info */

enum {

	TIPC_NLA_SOCK_STAT_RCVQ,	/* u32 */

	TIPC_NLA_SOCK_STAT_SENDQ,	/* u32 */

	TIPC_NLA_SOCK_STAT_LINK_CONG,	/* flag */

	TIPC_NLA_SOCK_STAT_CONN_CONG,	/* flag */



	__TIPC_NLA_SOCK_STAT_MAX,

	TIPC_NLA_SOCK_STAT_MAX = __TIPC_NLA_SOCK_STAT_MAX - 1

};



/* Nest, link propreties. Valid for link, media and bearer */

enum {

	TIPC_NLA_PROP_UNSPEC,

include/uapi/linux/tipc_sockets_diag.h

0 → 100644
+17 −0
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */

/* AF_TIPC sock_diag interface for querying open sockets */



#ifndef _UAPI__TIPC_SOCKETS_DIAG_H__

#define _UAPI__TIPC_SOCKETS_DIAG_H__



#include <linux/types.h>

#include <linux/sock_diag.h>



/* Request */

struct tipc_sock_diag_req {

	__u8	sdiag_family;	/* must be AF_TIPC */

	__u8	sdiag_protocol;	/* must be 0 */

	__u16	pad;		/* must be 0 */

	__u32	tidiag_states;	/* query*/

};

#endif /* _UAPI__TIPC_SOCKETS_DIAG_H__ */

net/tipc/Kconfig

+8 −0
Original line number Diff line number Diff line
@@ -34,3 +34,11 @@ config TIPC_MEDIA_UDP 
	  Saying Y here will enable support for running TIPC over IP/UDP

	bool

	default y



config TIPC_DIAG

	tristate "TIPC: socket monitoring interface"

	depends on TIPC

	default y

	---help---

	Support for TIPC socket monitoring interface used by ss tool.

	If unsure, say Y.

net/tipc/Makefile

+5 −0
Original line number Diff line number Diff line
@@ -14,3 +14,8 @@ tipc-y += addr.o bcast.o bearer.o \ 
tipc-$(CONFIG_TIPC_MEDIA_UDP)	+= udp_media.o

tipc-$(CONFIG_TIPC_MEDIA_IB)	+= ib_media.o

tipc-$(CONFIG_SYSCTL)		+= sysctl.o





obj-$(CONFIG_TIPC_DIAG)	+= diag.o



tipc_diag-y	:= diag.o

net/tipc/diag.c

0 → 100644
+114 −0
Original line number Diff line number Diff line 
/*

 * net/tipc/diag.c: TIPC socket diag

 *

 * Copyright (c) 2018, Ericsson AB

 * All rights reserved.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions are met:

 *

 * 1. Redistributions of source code must retain the above copyright

 *    notice, this list of conditions and the following disclaimer.

 * 2. Redistributions in binary form must reproduce the above copyright

 *    notice, this list of conditions and the following disclaimer in the

 *    documentation and/or other materials provided with the distribution.

 * 3. Neither the names of the copyright holders nor the names of its

 *    contributors may be used to endorse or promote products derived from

 *    this software without specific prior written permission.

 *

 * Alternatively, this software may be distributed under the terms of the

 * GNU General Public License ("GPL") version 2 as published by the Free

 * Software Foundation.

 *

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "ASIS"

 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,THE

 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE

 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

 * POSSIBILITY OF SUCH DAMAGE.

 */



#include "core.h"

#include "socket.h"

#include <linux/sock_diag.h>

#include <linux/tipc_sockets_diag.h>



static u64 __tipc_diag_gen_cookie(struct sock *sk)

{

	u32 res[2];



	sock_diag_save_cookie(sk, res);

	return *((u64 *)res);

}



static int __tipc_add_sock_diag(struct sk_buff *skb,

				struct netlink_callback *cb,

				struct tipc_sock *tsk)

{

	struct tipc_sock_diag_req *req = nlmsg_data(cb->nlh);

	struct nlmsghdr *nlh;

	int err;



	nlh = nlmsg_put_answer(skb, cb, SOCK_DIAG_BY_FAMILY, 0,

			       NLM_F_MULTI);

	if (!nlh)

		return -EMSGSIZE;



	err = tipc_sk_fill_sock_diag(skb, tsk, req->tidiag_states,

				     __tipc_diag_gen_cookie);

	if (err)

		return err;



	nlmsg_end(skb, nlh);

	return 0;

}



static int tipc_diag_dump(struct sk_buff *skb, struct netlink_callback *cb)

{

	return tipc_nl_sk_walk(skb, cb, __tipc_add_sock_diag);

}



static int tipc_sock_diag_handler_dump(struct sk_buff *skb,

				       struct nlmsghdr *h)

{

	int hdrlen = sizeof(struct tipc_sock_diag_req);

	struct net *net = sock_net(skb->sk);



	if (nlmsg_len(h) < hdrlen)

		return -EINVAL;



	if (h->nlmsg_flags & NLM_F_DUMP) {

		struct netlink_dump_control c = {

			.dump = tipc_diag_dump,

		};

		netlink_dump_start(net->diag_nlsk, skb, h, &c);

		return 0;

	}

	return -EOPNOTSUPP;

}



static const struct sock_diag_handler tipc_sock_diag_handler = {

	.family = AF_TIPC,

	.dump = tipc_sock_diag_handler_dump,

};



static int __init tipc_diag_init(void)

{

	return sock_diag_register(&tipc_sock_diag_handler);

}



static void __exit tipc_diag_exit(void)

{

	sock_diag_unregister(&tipc_sock_diag_handler);

}



module_init(tipc_diag_init);

module_exit(tipc_diag_exit);



MODULE_LICENSE("Dual BSD/GPL");

MODULE_ALIAS_NET_PF_PROTO_TYPE(PF_NETLINK, NETLINK_SOCK_DIAG, AF_TIPC);

CRA Git | Maintained and supported by SUSTech CRA and CCSE