[mirror_ubuntu-bionic-kernel.git] / include / net / strparser.h

/*
 * Stream Parser
 *
 * Copyright (c) 2016 Tom Herbert <tom@herbertland.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2
 * as published by the Free Software Foundation.
 */

#ifndef __NET_STRPARSER_H_
#define __NET_STRPARSER_H_

#include <linux/skbuff.h>
#include <net/sock.h>

#define STRP_STATS_ADD(stat, count) ((stat) += (count))
#define STRP_STATS_INCR(stat) ((stat)++)

struct strp_stats {
	unsigned long long msgs;
	unsigned long long bytes;
	unsigned int mem_fail;
	unsigned int need_more_hdr;
	unsigned int msg_too_big;
	unsigned int msg_timeouts;
	unsigned int bad_hdr_len;
};

struct strp_aggr_stats {
	unsigned long long msgs;
	unsigned long long bytes;
	unsigned int mem_fail;
	unsigned int need_more_hdr;
	unsigned int msg_too_big;
	unsigned int msg_timeouts;
	unsigned int bad_hdr_len;
	unsigned int aborts;
	unsigned int interrupted;
	unsigned int unrecov_intr;
};

struct strparser;

/* Callbacks are called with lock held for the attached socket */
struct strp_callbacks {
	int (*parse_msg)(struct strparser *strp, struct sk_buff *skb);
	void (*rcv_msg)(struct strparser *strp, struct sk_buff *skb);
	int (*read_sock_done)(struct strparser *strp, int err);
	void (*abort_parser)(struct strparser *strp, int err);
	void (*lock)(struct strparser *strp);
	void (*unlock)(struct strparser *strp);
};

struct strp_msg {
	int full_len;
	int offset;
};

static inline struct strp_msg *strp_msg(struct sk_buff *skb)
{
	return (struct strp_msg *)((void *)skb->cb +
		offsetof(struct qdisc_skb_cb, data));
}

/* Structure for an attached lower socket */
struct strparser {
	struct sock *sk;

	u32 stopped : 1;
	u32 paused : 1;
	u32 aborted : 1;
	u32 interrupted : 1;
	u32 unrecov_intr : 1;

	struct sk_buff **skb_nextp;
	struct sk_buff *skb_head;
	unsigned int need_bytes;
	struct delayed_work msg_timer_work;
	struct work_struct work;
	struct strp_stats stats;
	struct strp_callbacks cb;
};

/* Must be called with lock held for attached socket */
static inline void strp_pause(struct strparser *strp)
{
	strp->paused = 1;
}

/* May be called without holding lock for attached socket */
void strp_unpause(struct strparser *strp);

static inline void save_strp_stats(struct strparser *strp,
				   struct strp_aggr_stats *agg_stats)
{
	/* Save psock statistics in the mux when psock is being unattached. */

#define SAVE_PSOCK_STATS(_stat) (agg_stats->_stat +=		\
				 strp->stats._stat)
	SAVE_PSOCK_STATS(msgs);
	SAVE_PSOCK_STATS(bytes);
	SAVE_PSOCK_STATS(mem_fail);
	SAVE_PSOCK_STATS(need_more_hdr);
	SAVE_PSOCK_STATS(msg_too_big);
	SAVE_PSOCK_STATS(msg_timeouts);
	SAVE_PSOCK_STATS(bad_hdr_len);
#undef SAVE_PSOCK_STATS

	if (strp->aborted)
		agg_stats->aborts++;
	if (strp->interrupted)
		agg_stats->interrupted++;
	if (strp->unrecov_intr)
		agg_stats->unrecov_intr++;
}

static inline void aggregate_strp_stats(struct strp_aggr_stats *stats,
					struct strp_aggr_stats *agg_stats)
{
#define SAVE_PSOCK_STATS(_stat) (agg_stats->_stat += stats->_stat)
	SAVE_PSOCK_STATS(msgs);
	SAVE_PSOCK_STATS(bytes);
	SAVE_PSOCK_STATS(mem_fail);
	SAVE_PSOCK_STATS(need_more_hdr);
	SAVE_PSOCK_STATS(msg_too_big);
	SAVE_PSOCK_STATS(msg_timeouts);
	SAVE_PSOCK_STATS(bad_hdr_len);
	SAVE_PSOCK_STATS(aborts);
	SAVE_PSOCK_STATS(interrupted);
	SAVE_PSOCK_STATS(unrecov_intr);
#undef SAVE_PSOCK_STATS

}

void strp_done(struct strparser *strp);
void strp_stop(struct strparser *strp);
void strp_check_rcv(struct strparser *strp);
int strp_init(struct strparser *strp, struct sock *sk,
	      const struct strp_callbacks *cb);
void strp_data_ready(struct strparser *strp);
int strp_process(struct strparser *strp, struct sk_buff *orig_skb,
		 unsigned int orig_offset, size_t orig_len,
		 size_t max_msg_size, long timeo);

#endif /* __NET_STRPARSER_H_ */
Commit	Line	Data
43a0c675 TH	1	/*
	2	* Stream Parser
	3	*
	4	* Copyright (c) 2016 Tom Herbert <tom@herbertland.com>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License version 2
	8	* as published by the Free Software Foundation.
	9	*/
	10
	11	#ifndef __NET_STRPARSER_H_
	12	#define __NET_STRPARSER_H_
	13
	14	#include <linux/skbuff.h>
	15	#include <net/sock.h>
	16
	17	#define STRP_STATS_ADD(stat, count) ((stat) += (count))
	18	#define STRP_STATS_INCR(stat) ((stat)++)
	19
	20	struct strp_stats {
bbb03029 TH	21	unsigned long long msgs;
	22	unsigned long long bytes;
	23	unsigned int mem_fail;
	24	unsigned int need_more_hdr;
	25	unsigned int msg_too_big;
	26	unsigned int msg_timeouts;
	27	unsigned int bad_hdr_len;
43a0c675 TH	28	};
	29
	30	struct strp_aggr_stats {
bbb03029 TH	31	unsigned long long msgs;
	32	unsigned long long bytes;
	33	unsigned int mem_fail;
	34	unsigned int need_more_hdr;
	35	unsigned int msg_too_big;
	36	unsigned int msg_timeouts;
	37	unsigned int bad_hdr_len;
	38	unsigned int aborts;
	39	unsigned int interrupted;
	40	unsigned int unrecov_intr;
43a0c675 TH	41	};
	42
	43	struct strparser;
	44
	45	/* Callbacks are called with lock held for the attached socket */
	46	struct strp_callbacks {
	47	int (parse_msg)(struct strparser strp, struct sk_buff *skb);
	48	void (rcv_msg)(struct strparser strp, struct sk_buff *skb);
	49	int (read_sock_done)(struct strparser strp, int err);
	50	void (abort_parser)(struct strparser strp, int err);
bbb03029 TH	51	void (lock)(struct strparser strp);
bbb03029 TH	52	void (unlock)(struct strparser strp);
43a0c675 TH	53	};
43a0c675 TH	54
bbb03029	55	struct strp_msg {
43a0c675 TH	56	int full_len;
	57	int offset;
	58	};
	59
bbb03029	60	static inline struct strp_msg strp_msg(struct sk_buff skb)
43a0c675	61	{
bbb03029	62	return (struct strp_msg )((void )skb->cb +
43a0c675 TH	63	offsetof(struct qdisc_skb_cb, data));
	64	}
	65
	66	/* Structure for an attached lower socket */
	67	struct strparser {
	68	struct sock *sk;
	69
bbb03029 TH	70	u32 stopped : 1;
	71	u32 paused : 1;
	72	u32 aborted : 1;
	73	u32 interrupted : 1;
	74	u32 unrecov_intr : 1;
	75
	76	struct sk_buff **skb_nextp;
bbb03029 TH	77	struct sk_buff *skb_head;
bbb03029 TH	78	unsigned int need_bytes;
829385f0	79	struct delayed_work msg_timer_work;
bbb03029	80	struct work_struct work;
43a0c675 TH	81	struct strp_stats stats;
	82	struct strp_callbacks cb;
	83	};
	84
	85	/* Must be called with lock held for attached socket */
	86	static inline void strp_pause(struct strparser *strp)
	87	{
bbb03029	88	strp->paused = 1;
43a0c675 TH	89	}
	90
	91	/* May be called without holding lock for attached socket */
cff6a334	92	void strp_unpause(struct strparser *strp);
43a0c675 TH	93
	94	static inline void save_strp_stats(struct strparser *strp,
	95	struct strp_aggr_stats *agg_stats)
	96	{
	97	/* Save psock statistics in the mux when psock is being unattached. */
	98
	99	#define SAVE_PSOCK_STATS(_stat) (agg_stats->_stat += \
	100	strp->stats._stat)
bbb03029 TH	101	SAVE_PSOCK_STATS(msgs);
	102	SAVE_PSOCK_STATS(bytes);
	103	SAVE_PSOCK_STATS(mem_fail);
	104	SAVE_PSOCK_STATS(need_more_hdr);
	105	SAVE_PSOCK_STATS(msg_too_big);
	106	SAVE_PSOCK_STATS(msg_timeouts);
	107	SAVE_PSOCK_STATS(bad_hdr_len);
43a0c675 TH	108	#undef SAVE_PSOCK_STATS
43a0c675 TH	109
bbb03029 TH	110	if (strp->aborted)
	111	agg_stats->aborts++;
	112	if (strp->interrupted)
	113	agg_stats->interrupted++;
	114	if (strp->unrecov_intr)
	115	agg_stats->unrecov_intr++;
43a0c675 TH	116	}
	117
	118	static inline void aggregate_strp_stats(struct strp_aggr_stats *stats,
	119	struct strp_aggr_stats *agg_stats)
	120	{
	121	#define SAVE_PSOCK_STATS(_stat) (agg_stats->_stat += stats->_stat)
bbb03029 TH	122	SAVE_PSOCK_STATS(msgs);
	123	SAVE_PSOCK_STATS(bytes);
	124	SAVE_PSOCK_STATS(mem_fail);
	125	SAVE_PSOCK_STATS(need_more_hdr);
	126	SAVE_PSOCK_STATS(msg_too_big);
	127	SAVE_PSOCK_STATS(msg_timeouts);
	128	SAVE_PSOCK_STATS(bad_hdr_len);
	129	SAVE_PSOCK_STATS(aborts);
	130	SAVE_PSOCK_STATS(interrupted);
	131	SAVE_PSOCK_STATS(unrecov_intr);
43a0c675 TH	132	#undef SAVE_PSOCK_STATS
	133
	134	}
	135
	136	void strp_done(struct strparser *strp);
	137	void strp_stop(struct strparser *strp);
	138	void strp_check_rcv(struct strparser *strp);
bbb03029	139	int strp_init(struct strparser strp, struct sock sk,
3fd87127	140	const struct strp_callbacks *cb);
96a59083	141	void strp_data_ready(struct strparser *strp);
bbb03029 TH	142	int strp_process(struct strparser strp, struct sk_buff orig_skb,
	143	unsigned int orig_offset, size_t orig_len,
	144	size_t max_msg_size, long timeo);
43a0c675 TH	145
43a0c675 TH	146	#endif /* __NET_STRPARSER_H_ */