[deliverable/linux.git] / net / core / gen_stats.c

/*
 * net/core/gen_stats.c
 *
 *             This program is free software; you can redistribute it and/or
 *             modify it under the terms of the GNU General Public License
 *             as published by the Free Software Foundation; either version
 *             2 of the License, or (at your option) any later version.
 *
 * Authors:  Thomas Graf <tgraf@suug.ch>
 *           Jamal Hadi Salim
 *           Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
 *
 * See Documentation/networking/gen_stats.txt
 */

#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/interrupt.h>
#include <linux/socket.h>
#include <linux/rtnetlink.h>
#include <linux/gen_stats.h>
#include <net/netlink.h>
#include <net/gen_stats.h>


static inline int
gnet_stats_copy(struct gnet_dump *d, int type, void *buf, int size)
{
	NLA_PUT(d->skb, type, size, buf);
	return 0;

nla_put_failure:
	spin_unlock_bh(d->lock);
	return -1;
}

/**
 * gnet_stats_start_copy_compat - start dumping procedure in compatibility mode
 * @skb: socket buffer to put statistics TLVs into
 * @type: TLV type for top level statistic TLV
 * @tc_stats_type: TLV type for backward compatibility struct tc_stats TLV
 * @xstats_type: TLV type for backward compatibility xstats TLV
 * @lock: statistics lock
 * @d: dumping handle
 *
 * Initializes the dumping handle, grabs the statistic lock and appends
 * an empty TLV header to the socket buffer for use a container for all
 * other statistic TLVS.
 *
 * The dumping handle is marked to be in backward compatibility mode telling
 * all gnet_stats_copy_XXX() functions to fill a local copy of struct tc_stats.
 *
 * Returns 0 on success or -1 if the room in the socket buffer was not sufficient.
 */
int
gnet_stats_start_copy_compat(struct sk_buff *skb, int type, int tc_stats_type,
	int xstats_type, spinlock_t *lock, struct gnet_dump *d)
	__acquires(lock)
{
	memset(d, 0, sizeof(*d));

	spin_lock_bh(lock);
	d->lock = lock;
	if (type)
		d->tail = (struct nlattr *)skb_tail_pointer(skb);
	d->skb = skb;
	d->compat_tc_stats = tc_stats_type;
	d->compat_xstats = xstats_type;

	if (d->tail)
		return gnet_stats_copy(d, type, NULL, 0);

	return 0;
}

/**
 * gnet_stats_start_copy_compat - start dumping procedure in compatibility mode
 * @skb: socket buffer to put statistics TLVs into
 * @type: TLV type for top level statistic TLV
 * @lock: statistics lock
 * @d: dumping handle
 *
 * Initializes the dumping handle, grabs the statistic lock and appends
 * an empty TLV header to the socket buffer for use a container for all
 * other statistic TLVS.
 *
 * Returns 0 on success or -1 if the room in the socket buffer was not sufficient.
 */
int
gnet_stats_start_copy(struct sk_buff *skb, int type, spinlock_t *lock,
	struct gnet_dump *d)
{
	return gnet_stats_start_copy_compat(skb, type, 0, 0, lock, d);
}

/**
 * gnet_stats_copy_basic - copy basic statistics into statistic TLV
 * @d: dumping handle
 * @b: basic statistics
 *
 * Appends the basic statistics to the top level TLV created by
 * gnet_stats_start_copy().
 *
 * Returns 0 on success or -1 with the statistic lock released
 * if the room in the socket buffer was not sufficient.
 */
int
gnet_stats_copy_basic(struct gnet_dump *d, struct gnet_stats_basic_packed *b)
{
	if (d->compat_tc_stats) {
		d->tc_stats.bytes = b->bytes;
		d->tc_stats.packets = b->packets;
	}

	if (d->tail) {
		struct gnet_stats_basic sb;

		memset(&sb, 0, sizeof(sb));
		sb.bytes = b->bytes;
		sb.packets = b->packets;
		return gnet_stats_copy(d, TCA_STATS_BASIC, &sb, sizeof(sb));
	}
	return 0;
}

/**
 * gnet_stats_copy_rate_est - copy rate estimator statistics into statistics TLV
 * @d: dumping handle
 * @r: rate estimator statistics
 *
 * Appends the rate estimator statistics to the top level TLV created by
 * gnet_stats_start_copy().
 *
 * Returns 0 on success or -1 with the statistic lock released
 * if the room in the socket buffer was not sufficient.
 */
int
gnet_stats_copy_rate_est(struct gnet_dump *d, struct gnet_stats_rate_est *r)
{
	if (d->compat_tc_stats) {
		d->tc_stats.bps = r->bps;
		d->tc_stats.pps = r->pps;
	}

	if (d->tail)
		return gnet_stats_copy(d, TCA_STATS_RATE_EST, r, sizeof(*r));

	return 0;
}

/**
 * gnet_stats_copy_queue - copy queue statistics into statistics TLV
 * @d: dumping handle
 * @q: queue statistics
 *
 * Appends the queue statistics to the top level TLV created by
 * gnet_stats_start_copy().
 *
 * Returns 0 on success or -1 with the statistic lock released
 * if the room in the socket buffer was not sufficient.
 */
int
gnet_stats_copy_queue(struct gnet_dump *d, struct gnet_stats_queue *q)
{
	if (d->compat_tc_stats) {
		d->tc_stats.drops = q->drops;
		d->tc_stats.qlen = q->qlen;
		d->tc_stats.backlog = q->backlog;
		d->tc_stats.overlimits = q->overlimits;
	}

	if (d->tail)
		return gnet_stats_copy(d, TCA_STATS_QUEUE, q, sizeof(*q));

	return 0;
}

/**
 * gnet_stats_copy_app - copy application specific statistics into statistics TLV
 * @d: dumping handle
 * @st: application specific statistics data
 * @len: length of data
 *
 * Appends the application sepecific statistics to the top level TLV created by
 * gnet_stats_start_copy() and remembers the data for XSTATS if the dumping
 * handle is in backward compatibility mode.
 *
 * Returns 0 on success or -1 with the statistic lock released
 * if the room in the socket buffer was not sufficient.
 */
int
gnet_stats_copy_app(struct gnet_dump *d, void *st, int len)
{
	if (d->compat_xstats) {
		d->xstats = st;
		d->xstats_len = len;
	}

	if (d->tail)
		return gnet_stats_copy(d, TCA_STATS_APP, st, len);

	return 0;
}

/**
 * gnet_stats_finish_copy - finish dumping procedure
 * @d: dumping handle
 *
 * Corrects the length of the top level TLV to include all TLVs added
 * by gnet_stats_copy_XXX() calls. Adds the backward compatibility TLVs
 * if gnet_stats_start_copy_compat() was used and releases the statistics
 * lock.
 *
 * Returns 0 on success or -1 with the statistic lock released
 * if the room in the socket buffer was not sufficient.
 */
int
gnet_stats_finish_copy(struct gnet_dump *d)
{
	if (d->tail)
		d->tail->nla_len = skb_tail_pointer(d->skb) - (u8 *)d->tail;

	if (d->compat_tc_stats)
		if (gnet_stats_copy(d, d->compat_tc_stats, &d->tc_stats,
			sizeof(d->tc_stats)) < 0)
			return -1;

	if (d->compat_xstats && d->xstats) {
		if (gnet_stats_copy(d, d->compat_xstats, d->xstats,
			d->xstats_len) < 0)
			return -1;
	}

	spin_unlock_bh(d->lock);
	return 0;
}


EXPORT_SYMBOL(gnet_stats_start_copy);
EXPORT_SYMBOL(gnet_stats_start_copy_compat);
EXPORT_SYMBOL(gnet_stats_copy_basic);
EXPORT_SYMBOL(gnet_stats_copy_rate_est);
EXPORT_SYMBOL(gnet_stats_copy_queue);
EXPORT_SYMBOL(gnet_stats_copy_app);
EXPORT_SYMBOL(gnet_stats_finish_copy);
Commit	Line	Data
1da177e4 LT	1	/*
	2	* net/core/gen_stats.c
	3	*
	4	* This program is free software; you can redistribute it and/or
	5	* modify it under the terms of the GNU General Public License
	6	* as published by the Free Software Foundation; either version
	7	* 2 of the License, or (at your option) any later version.
	8	*
	9	* Authors: Thomas Graf <tgraf@suug.ch>
	10	* Jamal Hadi Salim
	11	* Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
	12	*
	13	* See Documentation/networking/gen_stats.txt
	14	*/
	15
	16	#include <linux/types.h>
	17	#include <linux/kernel.h>
	18	#include <linux/module.h>
	19	#include <linux/interrupt.h>
	20	#include <linux/socket.h>
	21	#include <linux/rtnetlink.h>
	22	#include <linux/gen_stats.h>
1e90474c	23	#include <net/netlink.h>
1da177e4 LT	24	#include <net/gen_stats.h>
	25
	26
	27	static inline int
	28	gnet_stats_copy(struct gnet_dump d, int type, void buf, int size)
	29	{
1e90474c	30	NLA_PUT(d->skb, type, size, buf);
1da177e4 LT	31	return 0;
1da177e4 LT	32
1e90474c	33	nla_put_failure:
1da177e4 LT	34	spin_unlock_bh(d->lock);
	35	return -1;
	36	}
	37
	38	/**
	39	* gnet_stats_start_copy_compat - start dumping procedure in compatibility mode
	40	* @skb: socket buffer to put statistics TLVs into
	41	* @type: TLV type for top level statistic TLV
	42	* @tc_stats_type: TLV type for backward compatibility struct tc_stats TLV
	43	* @xstats_type: TLV type for backward compatibility xstats TLV
	44	* @lock: statistics lock
	45	* @d: dumping handle
	46	*
	47	* Initializes the dumping handle, grabs the statistic lock and appends
	48	* an empty TLV header to the socket buffer for use a container for all
	49	* other statistic TLVS.
	50	*
	51	* The dumping handle is marked to be in backward compatibility mode telling
	52	* all gnet_stats_copy_XXX() functions to fill a local copy of struct tc_stats.
	53	*
	54	* Returns 0 on success or -1 if the room in the socket buffer was not sufficient.
	55	*/
	56	int
	57	gnet_stats_start_copy_compat(struct sk_buff *skb, int type, int tc_stats_type,
	58	int xstats_type, spinlock_t lock, struct gnet_dump d)
9a429c49	59	__acquires(lock)
1da177e4 LT	60	{
1da177e4 LT	61	memset(d, 0, sizeof(*d));
4ec93edb	62
1da177e4 LT	63	spin_lock_bh(lock);
	64	d->lock = lock;
	65	if (type)
1e90474c	66	d->tail = (struct nlattr *)skb_tail_pointer(skb);
1da177e4 LT	67	d->skb = skb;
	68	d->compat_tc_stats = tc_stats_type;
	69	d->compat_xstats = xstats_type;
	70
	71	if (d->tail)
	72	return gnet_stats_copy(d, type, NULL, 0);
	73
	74	return 0;
	75	}
	76
	77	/**
	78	* gnet_stats_start_copy_compat - start dumping procedure in compatibility mode
	79	* @skb: socket buffer to put statistics TLVs into
	80	* @type: TLV type for top level statistic TLV
	81	* @lock: statistics lock
	82	* @d: dumping handle
	83	*
	84	* Initializes the dumping handle, grabs the statistic lock and appends
	85	* an empty TLV header to the socket buffer for use a container for all
	86	* other statistic TLVS.
	87	*
	88	* Returns 0 on success or -1 if the room in the socket buffer was not sufficient.
	89	*/
	90	int
	91	gnet_stats_start_copy(struct sk_buff skb, int type, spinlock_t lock,
	92	struct gnet_dump *d)
	93	{
	94	return gnet_stats_start_copy_compat(skb, type, 0, 0, lock, d);
	95	}
	96
	97	/**
	98	* gnet_stats_copy_basic - copy basic statistics into statistic TLV
	99	* @d: dumping handle
	100	* @b: basic statistics
	101	*
	102	* Appends the basic statistics to the top level TLV created by
	103	* gnet_stats_start_copy().
	104	*
	105	* Returns 0 on success or -1 with the statistic lock released
	106	* if the room in the socket buffer was not sufficient.
	107	*/
	108	int
c1a8f1f1	109	gnet_stats_copy_basic(struct gnet_dump d, struct gnet_stats_basic_packed b)
1da177e4 LT	110	{
	111	if (d->compat_tc_stats) {
	112	d->tc_stats.bytes = b->bytes;
	113	d->tc_stats.packets = b->packets;
	114	}
	115
c1a8f1f1 ED	116	if (d->tail) {
c1a8f1f1 ED	117	struct gnet_stats_basic sb;
1da177e4	118
c1a8f1f1 ED	119	memset(&sb, 0, sizeof(sb));
	120	sb.bytes = b->bytes;
	121	sb.packets = b->packets;
	122	return gnet_stats_copy(d, TCA_STATS_BASIC, &sb, sizeof(sb));
	123	}
1da177e4 LT	124	return 0;
	125	}
	126
	127	/**
	128	* gnet_stats_copy_rate_est - copy rate estimator statistics into statistics TLV
	129	* @d: dumping handle
	130	* @r: rate estimator statistics
	131	*
	132	* Appends the rate estimator statistics to the top level TLV created by
	133	* gnet_stats_start_copy().
	134	*
	135	* Returns 0 on success or -1 with the statistic lock released
	136	* if the room in the socket buffer was not sufficient.
	137	*/
	138	int
	139	gnet_stats_copy_rate_est(struct gnet_dump d, struct gnet_stats_rate_est r)
	140	{
	141	if (d->compat_tc_stats) {
	142	d->tc_stats.bps = r->bps;
	143	d->tc_stats.pps = r->pps;
	144	}
	145
	146	if (d->tail)
	147	return gnet_stats_copy(d, TCA_STATS_RATE_EST, r, sizeof(*r));
	148
	149	return 0;
	150	}
	151
	152	/**
	153	* gnet_stats_copy_queue - copy queue statistics into statistics TLV
	154	* @d: dumping handle
	155	* @q: queue statistics
	156	*
	157	* Appends the queue statistics to the top level TLV created by
	158	* gnet_stats_start_copy().
	159	*
	160	* Returns 0 on success or -1 with the statistic lock released
	161	* if the room in the socket buffer was not sufficient.
	162	*/
	163	int
	164	gnet_stats_copy_queue(struct gnet_dump d, struct gnet_stats_queue q)
	165	{
	166	if (d->compat_tc_stats) {
	167	d->tc_stats.drops = q->drops;
	168	d->tc_stats.qlen = q->qlen;
	169	d->tc_stats.backlog = q->backlog;
	170	d->tc_stats.overlimits = q->overlimits;
	171	}
	172
	173	if (d->tail)
	174	return gnet_stats_copy(d, TCA_STATS_QUEUE, q, sizeof(*q));
	175
	176	return 0;
	177	}
	178
	179	/**
	180	* gnet_stats_copy_app - copy application specific statistics into statistics TLV
	181	* @d: dumping handle
	182	* @st: application specific statistics data
	183	* @len: length of data
	184	*
	185	* Appends the application sepecific statistics to the top level TLV created by
	186	* gnet_stats_start_copy() and remembers the data for XSTATS if the dumping
	187	* handle is in backward compatibility mode.
188	*
189	* Returns 0 on success or -1 with the statistic lock released
190	* if the room in the socket buffer was not sufficient.
191	*/
192	int
193	gnet_stats_copy_app(struct gnet_dump d, void st, int len)
194	{
195	if (d->compat_xstats) {
196	d->xstats = st;
197	d->xstats_len = len;
198	}
199
200	if (d->tail)
201	return gnet_stats_copy(d, TCA_STATS_APP, st, len);
202
203	return 0;
204	}
205
206	/**
207	* gnet_stats_finish_copy - finish dumping procedure
208	* @d: dumping handle
209	*
210	* Corrects the length of the top level TLV to include all TLVs added
211	* by gnet_stats_copy_XXX() calls. Adds the backward compatibility TLVs
212	* if gnet_stats_start_copy_compat() was used and releases the statistics
213	* lock.
214	*
215	* Returns 0 on success or -1 with the statistic lock released
216	* if the room in the socket buffer was not sufficient.
217	*/
218	int
219	gnet_stats_finish_copy(struct gnet_dump *d)
220	{
221	if (d->tail)
1e90474c	222	d->tail->nla_len = skb_tail_pointer(d->skb) - (u8 *)d->tail;
1da177e4 LT	223
	224	if (d->compat_tc_stats)
	225	if (gnet_stats_copy(d, d->compat_tc_stats, &d->tc_stats,
	226	sizeof(d->tc_stats)) < 0)
	227	return -1;
	228
	229	if (d->compat_xstats && d->xstats) {
	230	if (gnet_stats_copy(d, d->compat_xstats, d->xstats,
	231	d->xstats_len) < 0)
	232	return -1;
	233	}
	234
	235	spin_unlock_bh(d->lock);
	236	return 0;
	237	}
	238
	239
	240	EXPORT_SYMBOL(gnet_stats_start_copy);
	241	EXPORT_SYMBOL(gnet_stats_start_copy_compat);
	242	EXPORT_SYMBOL(gnet_stats_copy_basic);
	243	EXPORT_SYMBOL(gnet_stats_copy_rate_est);
	244	EXPORT_SYMBOL(gnet_stats_copy_queue);
	245	EXPORT_SYMBOL(gnet_stats_copy_app);
	246	EXPORT_SYMBOL(gnet_stats_finish_copy);