1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Stream Parser
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Copyright (c) 2016 Tom Herbert <tom@herbertland.com>
6*4882a593Smuzhiyun */
7*4882a593Smuzhiyun
8*4882a593Smuzhiyun #ifndef __NET_STRPARSER_H_
9*4882a593Smuzhiyun #define __NET_STRPARSER_H_
10*4882a593Smuzhiyun
11*4882a593Smuzhiyun #include <linux/skbuff.h>
12*4882a593Smuzhiyun #include <net/sock.h>
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun #define STRP_STATS_ADD(stat, count) ((stat) += (count))
15*4882a593Smuzhiyun #define STRP_STATS_INCR(stat) ((stat)++)
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun struct strp_stats {
18*4882a593Smuzhiyun unsigned long long msgs;
19*4882a593Smuzhiyun unsigned long long bytes;
20*4882a593Smuzhiyun unsigned int mem_fail;
21*4882a593Smuzhiyun unsigned int need_more_hdr;
22*4882a593Smuzhiyun unsigned int msg_too_big;
23*4882a593Smuzhiyun unsigned int msg_timeouts;
24*4882a593Smuzhiyun unsigned int bad_hdr_len;
25*4882a593Smuzhiyun };
26*4882a593Smuzhiyun
27*4882a593Smuzhiyun struct strp_aggr_stats {
28*4882a593Smuzhiyun unsigned long long msgs;
29*4882a593Smuzhiyun unsigned long long bytes;
30*4882a593Smuzhiyun unsigned int mem_fail;
31*4882a593Smuzhiyun unsigned int need_more_hdr;
32*4882a593Smuzhiyun unsigned int msg_too_big;
33*4882a593Smuzhiyun unsigned int msg_timeouts;
34*4882a593Smuzhiyun unsigned int bad_hdr_len;
35*4882a593Smuzhiyun unsigned int aborts;
36*4882a593Smuzhiyun unsigned int interrupted;
37*4882a593Smuzhiyun unsigned int unrecov_intr;
38*4882a593Smuzhiyun };
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun struct strparser;
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun /* Callbacks are called with lock held for the attached socket */
43*4882a593Smuzhiyun struct strp_callbacks {
44*4882a593Smuzhiyun int (*parse_msg)(struct strparser *strp, struct sk_buff *skb);
45*4882a593Smuzhiyun void (*rcv_msg)(struct strparser *strp, struct sk_buff *skb);
46*4882a593Smuzhiyun int (*read_sock_done)(struct strparser *strp, int err);
47*4882a593Smuzhiyun void (*abort_parser)(struct strparser *strp, int err);
48*4882a593Smuzhiyun void (*lock)(struct strparser *strp);
49*4882a593Smuzhiyun void (*unlock)(struct strparser *strp);
50*4882a593Smuzhiyun };
51*4882a593Smuzhiyun
52*4882a593Smuzhiyun struct strp_msg {
53*4882a593Smuzhiyun int full_len;
54*4882a593Smuzhiyun int offset;
55*4882a593Smuzhiyun };
56*4882a593Smuzhiyun
57*4882a593Smuzhiyun struct _strp_msg {
58*4882a593Smuzhiyun /* Internal cb structure. struct strp_msg must be first for passing
59*4882a593Smuzhiyun * to upper layer.
60*4882a593Smuzhiyun */
61*4882a593Smuzhiyun struct strp_msg strp;
62*4882a593Smuzhiyun int accum_len;
63*4882a593Smuzhiyun };
64*4882a593Smuzhiyun
65*4882a593Smuzhiyun struct sk_skb_cb {
66*4882a593Smuzhiyun #define SK_SKB_CB_PRIV_LEN 20
67*4882a593Smuzhiyun unsigned char data[SK_SKB_CB_PRIV_LEN];
68*4882a593Smuzhiyun struct _strp_msg strp;
69*4882a593Smuzhiyun };
70*4882a593Smuzhiyun
strp_msg(struct sk_buff * skb)71*4882a593Smuzhiyun static inline struct strp_msg *strp_msg(struct sk_buff *skb)
72*4882a593Smuzhiyun {
73*4882a593Smuzhiyun return (struct strp_msg *)((void *)skb->cb +
74*4882a593Smuzhiyun offsetof(struct sk_skb_cb, strp));
75*4882a593Smuzhiyun }
76*4882a593Smuzhiyun
77*4882a593Smuzhiyun /* Structure for an attached lower socket */
78*4882a593Smuzhiyun struct strparser {
79*4882a593Smuzhiyun struct sock *sk;
80*4882a593Smuzhiyun
81*4882a593Smuzhiyun u32 stopped : 1;
82*4882a593Smuzhiyun u32 paused : 1;
83*4882a593Smuzhiyun u32 aborted : 1;
84*4882a593Smuzhiyun u32 interrupted : 1;
85*4882a593Smuzhiyun u32 unrecov_intr : 1;
86*4882a593Smuzhiyun
87*4882a593Smuzhiyun struct sk_buff **skb_nextp;
88*4882a593Smuzhiyun struct sk_buff *skb_head;
89*4882a593Smuzhiyun unsigned int need_bytes;
90*4882a593Smuzhiyun struct delayed_work msg_timer_work;
91*4882a593Smuzhiyun struct work_struct work;
92*4882a593Smuzhiyun struct strp_stats stats;
93*4882a593Smuzhiyun struct strp_callbacks cb;
94*4882a593Smuzhiyun };
95*4882a593Smuzhiyun
96*4882a593Smuzhiyun /* Must be called with lock held for attached socket */
strp_pause(struct strparser * strp)97*4882a593Smuzhiyun static inline void strp_pause(struct strparser *strp)
98*4882a593Smuzhiyun {
99*4882a593Smuzhiyun strp->paused = 1;
100*4882a593Smuzhiyun }
101*4882a593Smuzhiyun
102*4882a593Smuzhiyun /* May be called without holding lock for attached socket */
103*4882a593Smuzhiyun void strp_unpause(struct strparser *strp);
104*4882a593Smuzhiyun /* Must be called with process lock held (lock_sock) */
105*4882a593Smuzhiyun void __strp_unpause(struct strparser *strp);
106*4882a593Smuzhiyun
save_strp_stats(struct strparser * strp,struct strp_aggr_stats * agg_stats)107*4882a593Smuzhiyun static inline void save_strp_stats(struct strparser *strp,
108*4882a593Smuzhiyun struct strp_aggr_stats *agg_stats)
109*4882a593Smuzhiyun {
110*4882a593Smuzhiyun /* Save psock statistics in the mux when psock is being unattached. */
111*4882a593Smuzhiyun
112*4882a593Smuzhiyun #define SAVE_PSOCK_STATS(_stat) (agg_stats->_stat += \
113*4882a593Smuzhiyun strp->stats._stat)
114*4882a593Smuzhiyun SAVE_PSOCK_STATS(msgs);
115*4882a593Smuzhiyun SAVE_PSOCK_STATS(bytes);
116*4882a593Smuzhiyun SAVE_PSOCK_STATS(mem_fail);
117*4882a593Smuzhiyun SAVE_PSOCK_STATS(need_more_hdr);
118*4882a593Smuzhiyun SAVE_PSOCK_STATS(msg_too_big);
119*4882a593Smuzhiyun SAVE_PSOCK_STATS(msg_timeouts);
120*4882a593Smuzhiyun SAVE_PSOCK_STATS(bad_hdr_len);
121*4882a593Smuzhiyun #undef SAVE_PSOCK_STATS
122*4882a593Smuzhiyun
123*4882a593Smuzhiyun if (strp->aborted)
124*4882a593Smuzhiyun agg_stats->aborts++;
125*4882a593Smuzhiyun if (strp->interrupted)
126*4882a593Smuzhiyun agg_stats->interrupted++;
127*4882a593Smuzhiyun if (strp->unrecov_intr)
128*4882a593Smuzhiyun agg_stats->unrecov_intr++;
129*4882a593Smuzhiyun }
130*4882a593Smuzhiyun
aggregate_strp_stats(struct strp_aggr_stats * stats,struct strp_aggr_stats * agg_stats)131*4882a593Smuzhiyun static inline void aggregate_strp_stats(struct strp_aggr_stats *stats,
132*4882a593Smuzhiyun struct strp_aggr_stats *agg_stats)
133*4882a593Smuzhiyun {
134*4882a593Smuzhiyun #define SAVE_PSOCK_STATS(_stat) (agg_stats->_stat += stats->_stat)
135*4882a593Smuzhiyun SAVE_PSOCK_STATS(msgs);
136*4882a593Smuzhiyun SAVE_PSOCK_STATS(bytes);
137*4882a593Smuzhiyun SAVE_PSOCK_STATS(mem_fail);
138*4882a593Smuzhiyun SAVE_PSOCK_STATS(need_more_hdr);
139*4882a593Smuzhiyun SAVE_PSOCK_STATS(msg_too_big);
140*4882a593Smuzhiyun SAVE_PSOCK_STATS(msg_timeouts);
141*4882a593Smuzhiyun SAVE_PSOCK_STATS(bad_hdr_len);
142*4882a593Smuzhiyun SAVE_PSOCK_STATS(aborts);
143*4882a593Smuzhiyun SAVE_PSOCK_STATS(interrupted);
144*4882a593Smuzhiyun SAVE_PSOCK_STATS(unrecov_intr);
145*4882a593Smuzhiyun #undef SAVE_PSOCK_STATS
146*4882a593Smuzhiyun
147*4882a593Smuzhiyun }
148*4882a593Smuzhiyun
149*4882a593Smuzhiyun void strp_done(struct strparser *strp);
150*4882a593Smuzhiyun void strp_stop(struct strparser *strp);
151*4882a593Smuzhiyun void strp_check_rcv(struct strparser *strp);
152*4882a593Smuzhiyun int strp_init(struct strparser *strp, struct sock *sk,
153*4882a593Smuzhiyun const struct strp_callbacks *cb);
154*4882a593Smuzhiyun void strp_data_ready(struct strparser *strp);
155*4882a593Smuzhiyun int strp_process(struct strparser *strp, struct sk_buff *orig_skb,
156*4882a593Smuzhiyun unsigned int orig_offset, size_t orig_len,
157*4882a593Smuzhiyun size_t max_msg_size, long timeo);
158*4882a593Smuzhiyun
159*4882a593Smuzhiyun #endif /* __NET_STRPARSER_H_ */
160