strparser: Stream parser for messages
[muen/linux.git] / include / net / strparser.h
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 {
21         unsigned long long rx_msgs;
22         unsigned long long rx_bytes;
23         unsigned int rx_mem_fail;
24         unsigned int rx_need_more_hdr;
25         unsigned int rx_msg_too_big;
26         unsigned int rx_msg_timeouts;
27         unsigned int rx_bad_hdr_len;
28 };
29
30 struct strp_aggr_stats {
31         unsigned long long rx_msgs;
32         unsigned long long rx_bytes;
33         unsigned int rx_mem_fail;
34         unsigned int rx_need_more_hdr;
35         unsigned int rx_msg_too_big;
36         unsigned int rx_msg_timeouts;
37         unsigned int rx_bad_hdr_len;
38         unsigned int rx_aborts;
39         unsigned int rx_interrupted;
40         unsigned int rx_unrecov_intr;
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);
51 };
52
53 struct strp_rx_msg {
54         int full_len;
55         int offset;
56 };
57
58 static inline struct strp_rx_msg *strp_rx_msg(struct sk_buff *skb)
59 {
60         return (struct strp_rx_msg *)((void *)skb->cb +
61                 offsetof(struct qdisc_skb_cb, data));
62 }
63
64 /* Structure for an attached lower socket */
65 struct strparser {
66         struct sock *sk;
67
68         u32 rx_stopped : 1;
69         u32 rx_paused : 1;
70         u32 rx_aborted : 1;
71         u32 rx_interrupted : 1;
72         u32 rx_unrecov_intr : 1;
73
74         struct sk_buff **rx_skb_nextp;
75         struct timer_list rx_msg_timer;
76         struct sk_buff *rx_skb_head;
77         unsigned int rx_need_bytes;
78         struct delayed_work rx_delayed_work;
79         struct work_struct rx_work;
80         struct strp_stats stats;
81         struct strp_callbacks cb;
82 };
83
84 /* Must be called with lock held for attached socket */
85 static inline void strp_pause(struct strparser *strp)
86 {
87         strp->rx_paused = 1;
88 }
89
90 /* May be called without holding lock for attached socket */
91 static inline void strp_unpause(struct strparser *strp)
92 {
93         strp->rx_paused = 0;
94 }
95
96 static inline void save_strp_stats(struct strparser *strp,
97                                    struct strp_aggr_stats *agg_stats)
98 {
99         /* Save psock statistics in the mux when psock is being unattached. */
100
101 #define SAVE_PSOCK_STATS(_stat) (agg_stats->_stat +=            \
102                                  strp->stats._stat)
103         SAVE_PSOCK_STATS(rx_msgs);
104         SAVE_PSOCK_STATS(rx_bytes);
105         SAVE_PSOCK_STATS(rx_mem_fail);
106         SAVE_PSOCK_STATS(rx_need_more_hdr);
107         SAVE_PSOCK_STATS(rx_msg_too_big);
108         SAVE_PSOCK_STATS(rx_msg_timeouts);
109         SAVE_PSOCK_STATS(rx_bad_hdr_len);
110 #undef SAVE_PSOCK_STATS
111
112         if (strp->rx_aborted)
113                 agg_stats->rx_aborts++;
114         if (strp->rx_interrupted)
115                 agg_stats->rx_interrupted++;
116         if (strp->rx_unrecov_intr)
117                 agg_stats->rx_unrecov_intr++;
118 }
119
120 static inline void aggregate_strp_stats(struct strp_aggr_stats *stats,
121                                         struct strp_aggr_stats *agg_stats)
122 {
123 #define SAVE_PSOCK_STATS(_stat) (agg_stats->_stat += stats->_stat)
124         SAVE_PSOCK_STATS(rx_msgs);
125         SAVE_PSOCK_STATS(rx_bytes);
126         SAVE_PSOCK_STATS(rx_mem_fail);
127         SAVE_PSOCK_STATS(rx_need_more_hdr);
128         SAVE_PSOCK_STATS(rx_msg_too_big);
129         SAVE_PSOCK_STATS(rx_msg_timeouts);
130         SAVE_PSOCK_STATS(rx_bad_hdr_len);
131         SAVE_PSOCK_STATS(rx_aborts);
132         SAVE_PSOCK_STATS(rx_interrupted);
133         SAVE_PSOCK_STATS(rx_unrecov_intr);
134 #undef SAVE_PSOCK_STATS
135
136 }
137
138 void strp_done(struct strparser *strp);
139 void strp_stop(struct strparser *strp);
140 void strp_check_rcv(struct strparser *strp);
141 int strp_init(struct strparser *strp, struct sock *csk,
142               struct strp_callbacks *cb);
143 void strp_tcp_data_ready(struct strparser *strp);
144
145 #endif /* __NET_STRPARSER_H_ */