Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit bbb03029 authored by Tom Herbert's avatar Tom Herbert Committed by David S. Miller
Browse files

strparser: Generalize strparser 



Generalize strparser from more than just being used in conjunction
with read_sock. strparser will also be used in the send path with
zero proxy. The primary change is to create strp_process function
that performs the critical processing on skbs. The documentation
is also updated to reflect the new uses.

Signed-off-by: default avatarTom Herbert <tom@quantonium.net>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 20bf50de

Documentation/networking/strparser.txt

+139 −68
Original line number Diff line number Diff line 
Stream Parser

-------------

Stream Parser (strparser)



Introduction

============



The stream parser (strparser) is a utility that parses messages of an

application layer protocol running over a TCP connection. The stream

application layer protocol running over a data stream. The stream

parser works in conjunction with an upper layer in the kernel to provide

kernel support for application layer messages. For instance, Kernel

Connection Multiplexor (KCM) uses the Stream Parser to parse messages

using a BPF program.



The strparser works in one of two modes: receive callback or general

mode.



In receive callback mode, the strparser is called from the data_ready

callback of a TCP socket. Messages are parsed and delivered as they are

received on the socket.



In general mode, a sequence of skbs are fed to strparser from an

outside source. Message are parsed and delivered as the sequence is

processed. This modes allows strparser to be applied to arbitrary

streams of data.



Interface

---------

=========



The API includes a context structure, a set of callbacks, utility

functions, and a data_ready function. The callbacks include

a parse_msg function that is called to perform parsing (e.g.

BPF parsing in case of KCM), and a rcv_msg function that is called

when a full message has been completed.

functions, and a data_ready function for receive callback mode. The

callbacks include a parse_msg function that is called to perform

parsing (e.g.  BPF parsing in case of KCM), and a rcv_msg function

that is called when a full message has been completed.



A stream parser can be instantiated for a TCP connection. This is done

by:

Functions

=========



strp_init(struct strparser *strp, struct sock *csk,

strp_init(struct strparser *strp, struct sock *sk,

	  struct strp_callbacks *cb)



strp is a struct of type strparser that is allocated by the upper layer.

csk is the TCP socket associated with the stream parser. Callbacks are

called by the stream parser.

     Called to initialize a stream parser. strp is a struct of type

     strparser that is allocated by the upper layer. sk is the TCP

     socket associated with the stream parser for use with receive

     callback mode; in general mode this is set to NULL. Callbacks

     are called by the stream parser (the callbacks are listed below).



void strp_pause(struct strparser *strp)



     Temporarily pause a stream parser. Message parsing is suspended

     and no new messages are delivered to the upper layer.



void strp_pause(struct strparser *strp)



     Unpause a paused stream parser.



void strp_stop(struct strparser *strp);



     strp_stop is called to completely stop stream parser operations.

     This is called internally when the stream parser encounters an

     error, and it is called from the upper layer to stop parsing

     operations.



void strp_done(struct strparser *strp);



     strp_done is called to release any resources held by the stream

     parser instance. This must be called after the stream processor

     has been stopped.



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)



    strp_process is called in general mode for a stream parser to

    parse an sk_buff. The number of bytes processed or a negative

    error number is returned. Note that strp_process does not

    consume the sk_buff. max_msg_size is maximum size the stream

    parser will parse. timeo is timeout for completing a message.



void strp_data_ready(struct strparser *strp);



    The upper layer calls strp_tcp_data_ready when data is ready on

    the lower socket for strparser to process. This should be called

    from a data_ready callback that is set on the socket. Note that

    maximum messages size is the limit of the receive socket

    buffer and message timeout is the receive timeout for the socket.



void strp_check_rcv(struct strparser *strp);



    strp_check_rcv is called to check for new messages on the socket.

    This is normally called at initialization of a stream parser

    instance or after strp_unpause.



Callbacks

---------

=========



There are four callbacks:

There are six callbacks:



int (*parse_msg)(struct strparser *strp, struct sk_buff *skb);



    parse_msg is called to determine the length of the next message

    in the stream. The upper layer must implement this function. It

    should parse the sk_buff as containing the headers for the

    next application layer messages in the stream.

    next application layer message in the stream.



    The skb->cb in the input skb is a struct strp_rx_msg. Only

    The skb->cb in the input skb is a struct strp_msg. Only

    the offset field is relevant in parse_msg and gives the offset

    where the message starts in the skb.
@@ -50,26 +112,41 @@ int (*parse_msg)(struct strparser *strp, struct sk_buff *skb); 
    -ESTRPIPE : current message should not be processed by the

          kernel, return control of the socket to userspace which

          can proceed to read the messages itself

    other < 0 : Error is parsing, give control back to userspace

    other < 0 : Error in parsing, give control back to userspace

          assuming that synchronization is lost and the stream

          is unrecoverable (application expected to close TCP socket)



    In the case that an error is returned (return value is less than

    zero) the stream parser will set the error on TCP socket and wake

    it up. If parse_msg returned -ESTRPIPE and the stream parser had

    previously read some bytes for the current message, then the error

    set on the attached socket is ENODATA since the stream is

    unrecoverable in that case.

    zero) and the parser is in receive callback mode, then it will set

    the error on TCP socket and wake it up. If parse_msg returned

    -ESTRPIPE and the stream parser had previously read some bytes for

    the current message, then the error set on the attached socket is

    ENODATA since the stream is unrecoverable in that case.



void (*lock)(struct strparser *strp)



    The lock callback is called to lock the strp structure when

    the strparser is performing an asynchronous operation (such as

    processing a timeout). In receive callback mode the default

    function is to lock_sock for the associated socket. In general

    mode the callback must be set appropriately.



void (*unlock)(struct strparser *strp)



    The unlock callback is called to release the lock obtained

    by the lock callback. In receive callback mode the default

    function is release_sock for the associated socket. In general

    mode the callback must be set appropriately.



void (*rcv_msg)(struct strparser *strp, struct sk_buff *skb);



    rcv_msg is called when a full message has been received and

    is queued. The callee must consume the sk_buff; it can

    call strp_pause to prevent any further messages from being

    received in rcv_msg (see strp_pause below). This callback

    received in rcv_msg (see strp_pause above). This callback

    must be set.



    The skb->cb in the input skb is a struct strp_rx_msg. This

    The skb->cb in the input skb is a struct strp_msg. This

    struct contains two fields: offset and full_len. Offset is

    where the message starts in the skb, and full_len is the

    the length of the message. skb->len - offset may be greater
@@ -78,59 +155,53 @@ void (*rcv_msg)(struct strparser *strp, struct sk_buff *skb); 
int (*read_sock_done)(struct strparser *strp, int err);



     read_sock_done is called when the stream parser is done reading

     the TCP socket. The stream parser may read multiple messages

     in a loop and this function allows cleanup to occur when existing

     the loop. If the callback is not set (NULL in strp_init) a

     default function is used.

     the TCP socket in receive callback mode. The stream parser may

     read multiple messages in a loop and this function allows cleanup

     to occur when exiting the loop. If the callback is not set (NULL

     in strp_init) a default function is used.



void (*abort_parser)(struct strparser *strp, int err);



     This function is called when stream parser encounters an error

     in parsing. The default function stops the stream parser for the

     TCP socket and sets the error in the socket. The default function

     can be changed by setting the callback to non-NULL in strp_init.

     in parsing. The default function stops the stream parser and

     sets the error in the socket if the parser is in receive callback

     mode. The default function can be changed by setting the callback

     to non-NULL in strp_init.



Functions

---------

Statistics

==========



The upper layer calls strp_tcp_data_ready when data is ready on the lower

socket for strparser to process. This should be called from a data_ready

callback that is set on the socket.

Various counters are kept for each stream parser instance. These are in

the strp_stats structure. strp_aggr_stats is a convenience structure for

accumulating statistics for multiple stream parser instances.

save_strp_stats and aggregate_strp_stats are helper functions to save

and aggregate statistics.



strp_stop is called to completely stop stream parser operations. This

is called internally when the stream parser encounters an error, and

it is called from the upper layer when unattaching a TCP socket.

Message assembly limits

=======================



strp_done is called to unattach the stream parser from the TCP socket.

This must be called after the stream processor has be stopped.

The stream parser provide mechanisms to limit the resources consumed by

message assembly.



strp_check_rcv is called to check for new messages on the socket. This

is normally called at initialization of the a stream parser instance

of after strp_unpause.

A timer is set when assembly starts for a new message. In receive

callback mode the message timeout is taken from rcvtime for the

associated TCP socket. In general mode, the timeout is passed as an

argument in strp_process. If the timer fires before assembly completes

the stream parser is aborted and the ETIMEDOUT error is set on the TCP

socket if in receive callback mode.



Statistics

----------

In receive callback mode, message length is limited to the receive

buffer size of the associated TCP socket. If the length returned by

parse_msg is greater than the socket buffer size then the stream parser

is aborted with EMSGSIZE error set on the TCP socket. Note that this

makes the maximum size of receive skbuffs for a socket with a stream

parser to be 2*sk_rcvbuf of the TCP socket.



Various counters are kept for each stream parser for a TCP socket.

These are in the strp_stats structure. strp_aggr_stats is a convenience

structure for accumulating statistics for multiple stream parser

instances. save_strp_stats and aggregate_strp_stats are helper functions

to save and aggregate statistics.

In general mode the message length limit is passed in as an argument

to strp_process.



Message assembly limits

-----------------------

Author

======



The stream parser provide mechanisms to limit the resources consumed by

message assembly.

Tom Herbert (tom@quantonium.net)

A timer is set when assembly starts for a new message. The message

timeout is taken from rcvtime for the associated TCP socket. If the

timer fires before assembly completes the stream parser is aborted

and the ETIMEDOUT error is set on the TCP socket.



Message length is limited to the receive buffer size of the associated

TCP socket. If the length returned by parse_msg is greater than

the socket buffer size then the stream parser is aborted with

EMSGSIZE error set on the TCP socket. Note that this makes the

maximum size of receive skbuffs for a socket with a stream parser

to be 2*sk_rcvbuf of the TCP socket.

include/net/strparser.h

+62 −57
Original line number Diff line number Diff line
@@ -18,26 +18,26 @@ 
#define STRP_STATS_INCR(stat) ((stat)++)



struct strp_stats {

	unsigned long long rx_msgs;

	unsigned long long rx_bytes;

	unsigned int rx_mem_fail;

	unsigned int rx_need_more_hdr;

	unsigned int rx_msg_too_big;

	unsigned int rx_msg_timeouts;

	unsigned int rx_bad_hdr_len;

	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 rx_msgs;

	unsigned long long rx_bytes;

	unsigned int rx_mem_fail;

	unsigned int rx_need_more_hdr;

	unsigned int rx_msg_too_big;

	unsigned int rx_msg_timeouts;

	unsigned int rx_bad_hdr_len;

	unsigned int rx_aborts;

	unsigned int rx_interrupted;

	unsigned int rx_unrecov_intr;

	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;
@@ -48,16 +48,18 @@ struct strp_callbacks { 
	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_rx_msg {

struct strp_msg {

	int full_len;

	int offset;

};



static inline struct strp_rx_msg *strp_rx_msg(struct sk_buff *skb)

static inline struct strp_msg *strp_msg(struct sk_buff *skb)

{

	return (struct strp_rx_msg *)((void *)skb->cb +

	return (struct strp_msg *)((void *)skb->cb +

		offsetof(struct qdisc_skb_cb, data));

}
@@ -65,18 +67,18 @@ static inline struct strp_rx_msg *strp_rx_msg(struct sk_buff *skb) 
struct strparser {

	struct sock *sk;



	u32 rx_stopped : 1;

	u32 rx_paused : 1;

	u32 rx_aborted : 1;

	u32 rx_interrupted : 1;

	u32 rx_unrecov_intr : 1;



	struct sk_buff **rx_skb_nextp;

	struct timer_list rx_msg_timer;

	struct sk_buff *rx_skb_head;

	unsigned int rx_need_bytes;

	struct delayed_work rx_delayed_work;

	struct work_struct rx_work;

	u32 stopped : 1;

	u32 paused : 1;

	u32 aborted : 1;

	u32 interrupted : 1;

	u32 unrecov_intr : 1;



	struct sk_buff **skb_nextp;

	struct timer_list msg_timer;

	struct sk_buff *skb_head;

	unsigned int need_bytes;

	struct delayed_work delayed_work;

	struct work_struct work;

	struct strp_stats stats;

	struct strp_callbacks cb;

};
@@ -84,7 +86,7 @@ struct strparser { 
/* Must be called with lock held for attached socket */

static inline void strp_pause(struct strparser *strp)

{

	strp->rx_paused = 1;

	strp->paused = 1;

}



/* May be called without holding lock for attached socket */
@@ -97,37 +99,37 @@ static inline void save_strp_stats(struct strparser *strp, 


#define SAVE_PSOCK_STATS(_stat) (agg_stats->_stat +=		\

				 strp->stats._stat)

	SAVE_PSOCK_STATS(rx_msgs);

	SAVE_PSOCK_STATS(rx_bytes);

	SAVE_PSOCK_STATS(rx_mem_fail);

	SAVE_PSOCK_STATS(rx_need_more_hdr);

	SAVE_PSOCK_STATS(rx_msg_too_big);

	SAVE_PSOCK_STATS(rx_msg_timeouts);

	SAVE_PSOCK_STATS(rx_bad_hdr_len);

	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->rx_aborted)

		agg_stats->rx_aborts++;

	if (strp->rx_interrupted)

		agg_stats->rx_interrupted++;

	if (strp->rx_unrecov_intr)

		agg_stats->rx_unrecov_intr++;

	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(rx_msgs);

	SAVE_PSOCK_STATS(rx_bytes);

	SAVE_PSOCK_STATS(rx_mem_fail);

	SAVE_PSOCK_STATS(rx_need_more_hdr);

	SAVE_PSOCK_STATS(rx_msg_too_big);

	SAVE_PSOCK_STATS(rx_msg_timeouts);

	SAVE_PSOCK_STATS(rx_bad_hdr_len);

	SAVE_PSOCK_STATS(rx_aborts);

	SAVE_PSOCK_STATS(rx_interrupted);

	SAVE_PSOCK_STATS(rx_unrecov_intr);

	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



}
@@ -135,8 +137,11 @@ static inline void aggregate_strp_stats(struct strp_aggr_stats *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 *csk,

int strp_init(struct strparser *strp, struct sock *sk,

	      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_ */

net/kcm/kcmproc.c

+17 −17
Original line number Diff line number Diff line
@@ -155,8 +155,8 @@ static void kcm_format_psock(struct kcm_psock *psock, struct seq_file *seq, 
	seq_printf(seq,

		   "   psock-%-5u %-10llu %-16llu %-10llu %-16llu %-8d %-8d %-8d %-8d ",

		   psock->index,

		   psock->strp.stats.rx_msgs,

		   psock->strp.stats.rx_bytes,

		   psock->strp.stats.msgs,

		   psock->strp.stats.bytes,

		   psock->stats.tx_msgs,

		   psock->stats.tx_bytes,

		   psock->sk->sk_receive_queue.qlen,
@@ -170,22 +170,22 @@ static void kcm_format_psock(struct kcm_psock *psock, struct seq_file *seq, 
	if (psock->tx_stopped)

		seq_puts(seq, "TxStop ");



	if (psock->strp.rx_stopped)

	if (psock->strp.stopped)

		seq_puts(seq, "RxStop ");



	if (psock->tx_kcm)

		seq_printf(seq, "Rsvd-%d ", psock->tx_kcm->index);



	if (!psock->strp.rx_paused && !psock->ready_rx_msg) {

	if (!psock->strp.paused && !psock->ready_rx_msg) {

		if (psock->sk->sk_receive_queue.qlen) {

			if (psock->strp.rx_need_bytes)

			if (psock->strp.need_bytes)

				seq_printf(seq, "RxWait=%u ",

					   psock->strp.rx_need_bytes);

					   psock->strp.need_bytes);

			else

				seq_printf(seq, "RxWait ");

		}

	} else  {

		if (psock->strp.rx_paused)

		if (psock->strp.paused)

			seq_puts(seq, "RxPause ");



		if (psock->ready_rx_msg)
@@ -371,20 +371,20 @@ static int kcm_stats_seq_show(struct seq_file *seq, void *v) 
	seq_printf(seq,

		   "%-8s %-10llu %-16llu %-10llu %-16llu %-10llu %-10llu %-10u %-10u %-10u %-10u %-10u %-10u %-10u %-10u %-10u\n",

		   "",

		   strp_stats.rx_msgs,

		   strp_stats.rx_bytes,

		   strp_stats.msgs,

		   strp_stats.bytes,

		   psock_stats.tx_msgs,

		   psock_stats.tx_bytes,

		   psock_stats.reserved,

		   psock_stats.unreserved,

		   strp_stats.rx_aborts,

		   strp_stats.rx_interrupted,

		   strp_stats.rx_unrecov_intr,

		   strp_stats.rx_mem_fail,

		   strp_stats.rx_need_more_hdr,

		   strp_stats.rx_bad_hdr_len,

		   strp_stats.rx_msg_too_big,

		   strp_stats.rx_msg_timeouts,

		   strp_stats.aborts,

		   strp_stats.interrupted,

		   strp_stats.unrecov_intr,

		   strp_stats.mem_fail,

		   strp_stats.need_more_hdr,

		   strp_stats.bad_hdr_len,

		   strp_stats.msg_too_big,

		   strp_stats.msg_timeouts,

		   psock_stats.tx_aborts);



	return 0;

net/kcm/kcmsock.c

+19 −19
Original line number Diff line number Diff line
@@ -96,12 +96,12 @@ static void kcm_update_rx_mux_stats(struct kcm_mux *mux, 
				    struct kcm_psock *psock)

{

	STRP_STATS_ADD(mux->stats.rx_bytes,

		       psock->strp.stats.rx_bytes -

		       psock->strp.stats.bytes -

		       psock->saved_rx_bytes);

	mux->stats.rx_msgs +=

		psock->strp.stats.rx_msgs - psock->saved_rx_msgs;

	psock->saved_rx_msgs = psock->strp.stats.rx_msgs;

	psock->saved_rx_bytes = psock->strp.stats.rx_bytes;

		psock->strp.stats.msgs - psock->saved_rx_msgs;

	psock->saved_rx_msgs = psock->strp.stats.msgs;

	psock->saved_rx_bytes = psock->strp.stats.bytes;

}



static void kcm_update_tx_mux_stats(struct kcm_mux *mux,
@@ -1118,7 +1118,7 @@ static int kcm_recvmsg(struct socket *sock, struct msghdr *msg, 
	struct kcm_sock *kcm = kcm_sk(sk);

	int err = 0;

	long timeo;

	struct strp_rx_msg *rxm;

	struct strp_msg *stm;

	int copied = 0;

	struct sk_buff *skb;
@@ -1132,26 +1132,26 @@ static int kcm_recvmsg(struct socket *sock, struct msghdr *msg, 


	/* Okay, have a message on the receive queue */



	rxm = strp_rx_msg(skb);

	stm = strp_msg(skb);



	if (len > rxm->full_len)

		len = rxm->full_len;

	if (len > stm->full_len)

		len = stm->full_len;



	err = skb_copy_datagram_msg(skb, rxm->offset, msg, len);

	err = skb_copy_datagram_msg(skb, stm->offset, msg, len);

	if (err < 0)

		goto out;



	copied = len;

	if (likely(!(flags & MSG_PEEK))) {

		KCM_STATS_ADD(kcm->stats.rx_bytes, copied);

		if (copied < rxm->full_len) {

		if (copied < stm->full_len) {

			if (sock->type == SOCK_DGRAM) {

				/* Truncated message */

				msg->msg_flags |= MSG_TRUNC;

				goto msg_finished;

			}

			rxm->offset += copied;

			rxm->full_len -= copied;

			stm->offset += copied;

			stm->full_len -= copied;

		} else {

msg_finished:

			/* Finished with message */
@@ -1175,7 +1175,7 @@ static ssize_t kcm_splice_read(struct socket *sock, loff_t *ppos, 
	struct sock *sk = sock->sk;

	struct kcm_sock *kcm = kcm_sk(sk);

	long timeo;

	struct strp_rx_msg *rxm;

	struct strp_msg *stm;

	int err = 0;

	ssize_t copied;

	struct sk_buff *skb;
@@ -1192,12 +1192,12 @@ static ssize_t kcm_splice_read(struct socket *sock, loff_t *ppos, 


	/* Okay, have a message on the receive queue */



	rxm = strp_rx_msg(skb);

	stm = strp_msg(skb);



	if (len > rxm->full_len)

		len = rxm->full_len;

	if (len > stm->full_len)

		len = stm->full_len;



	copied = skb_splice_bits(skb, sk, rxm->offset, pipe, len, flags);

	copied = skb_splice_bits(skb, sk, stm->offset, pipe, len, flags);

	if (copied < 0) {

		err = copied;

		goto err_out;
@@ -1205,8 +1205,8 @@ static ssize_t kcm_splice_read(struct socket *sock, loff_t *ppos, 


	KCM_STATS_ADD(kcm->stats.rx_bytes, copied);



	rxm->offset += copied;

	rxm->full_len -= copied;

	stm->offset += copied;

	stm->full_len -= copied;



	/* We have no way to return MSG_EOR. If all the bytes have been

	 * read we still leave the message in the receive socket buffer.

net/strparser/strparser.c

+187 −126

File changed.

Preview size limit exceeded, changes collapsed.