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