Commit | Line | Data |
---|---|---|
7c657876 ACM |
1 | #ifndef _CCID_H |
2 | #define _CCID_H | |
3 | /* | |
4 | * net/dccp/ccid.h | |
5 | * | |
6 | * An implementation of the DCCP protocol | |
7 | * Arnaldo Carvalho de Melo <acme@conectiva.com.br> | |
8 | * | |
9 | * CCID infrastructure | |
10 | * | |
11 | * This program is free software; you can redistribute it and/or modify it | |
12 | * under the terms of the GNU General Public License version 2 as | |
13 | * published by the Free Software Foundation. | |
14 | */ | |
15 | ||
16 | #include <net/sock.h> | |
88f964db | 17 | #include <linux/compiler.h> |
7c657876 ACM |
18 | #include <linux/dccp.h> |
19 | #include <linux/list.h> | |
20 | #include <linux/module.h> | |
21 | ||
22 | #define CCID_MAX 255 | |
23 | ||
14c85021 ACM |
24 | struct tcp_info; |
25 | ||
9cb2345a GR |
26 | /** |
27 | * struct ccid_operations - Interface to Congestion-Control Infrastructure | |
28 | * | |
29 | * @ccid_id: numerical CCID ID (up to %CCID_MAX, cf. table 5 in RFC 4340, 10.) | |
6179983a | 30 | * @ccid_ccmps: the CCMPS including network/transport headers (0 when disabled) |
9cb2345a GR |
31 | * @ccid_name: alphabetical identifier string for @ccid_id |
32 | * @ccid_owner: module which implements/owns this CCID | |
33 | * @ccid_hc_{r,t}x_slab: memory pool for the receiver/sender half-connection | |
34 | * @ccid_hc_{r,t}x_obj_size: size of the receiver/sender half-connection socket | |
35 | * | |
36 | * @ccid_hc_{r,t}x_init: CCID-specific initialisation routine (before startup) | |
37 | * @ccid_hc_{r,t}x_exit: CCID-specific cleanup routine (before destruction) | |
38 | * @ccid_hc_rx_packet_recv: implements the HC-receiver side | |
39 | * @ccid_hc_{r,t}x_parse_options: parsing routine for CCID/HC-specific options | |
40 | * @ccid_hc_{r,t}x_insert_options: insert routine for CCID/HC-specific options | |
41 | * @ccid_hc_tx_packet_recv: implements feedback processing for the HC-sender | |
42 | * @ccid_hc_tx_send_packet: implements the sending part of the HC-sender | |
43 | * @ccid_hc_tx_packet_sent: does accounting for packets in flight by HC-sender | |
44 | * @ccid_hc_{r,t}x_get_info: INET_DIAG information for HC-receiver/sender | |
45 | * @ccid_hc_{r,t}x_getsockopt: socket options specific to HC-receiver/sender | |
46 | */ | |
91f0ebf7 | 47 | struct ccid_operations { |
9cb2345a | 48 | unsigned char ccid_id; |
6179983a | 49 | __u32 ccid_ccmps; |
9cb2345a GR |
50 | const char *ccid_name; |
51 | struct module *ccid_owner; | |
52 | struct kmem_cache *ccid_hc_rx_slab, | |
53 | *ccid_hc_tx_slab; | |
54 | __u32 ccid_hc_rx_obj_size, | |
55 | ccid_hc_tx_obj_size; | |
56 | /* Interface Routines */ | |
91f0ebf7 ACM |
57 | int (*ccid_hc_rx_init)(struct ccid *ccid, struct sock *sk); |
58 | int (*ccid_hc_tx_init)(struct ccid *ccid, struct sock *sk); | |
7c657876 ACM |
59 | void (*ccid_hc_rx_exit)(struct sock *sk); |
60 | void (*ccid_hc_tx_exit)(struct sock *sk); | |
7690af3f ACM |
61 | void (*ccid_hc_rx_packet_recv)(struct sock *sk, |
62 | struct sk_buff *skb); | |
3306c781 GR |
63 | int (*ccid_hc_rx_parse_options)(struct sock *sk, u8 pkt, |
64 | u8 opt, u8 *val, u8 len); | |
2d0817d1 | 65 | int (*ccid_hc_rx_insert_options)(struct sock *sk, |
7690af3f | 66 | struct sk_buff *skb); |
7690af3f ACM |
67 | void (*ccid_hc_tx_packet_recv)(struct sock *sk, |
68 | struct sk_buff *skb); | |
3306c781 GR |
69 | int (*ccid_hc_tx_parse_options)(struct sock *sk, u8 pkt, |
70 | u8 opt, u8 *val, u8 len); | |
7c657876 | 71 | int (*ccid_hc_tx_send_packet)(struct sock *sk, |
6b57c93d GR |
72 | struct sk_buff *skb); |
73 | void (*ccid_hc_tx_packet_sent)(struct sock *sk, | |
74 | int more, unsigned int len); | |
2babe1f6 ACM |
75 | void (*ccid_hc_rx_get_info)(struct sock *sk, |
76 | struct tcp_info *info); | |
77 | void (*ccid_hc_tx_get_info)(struct sock *sk, | |
78 | struct tcp_info *info); | |
88f964db ACM |
79 | int (*ccid_hc_rx_getsockopt)(struct sock *sk, |
80 | const int optname, int len, | |
81 | u32 __user *optval, | |
82 | int __user *optlen); | |
83 | int (*ccid_hc_tx_getsockopt)(struct sock *sk, | |
84 | const int optname, int len, | |
85 | u32 __user *optval, | |
86 | int __user *optlen); | |
7c657876 ACM |
87 | }; |
88 | ||
91f0ebf7 ACM |
89 | extern int ccid_register(struct ccid_operations *ccid_ops); |
90 | extern int ccid_unregister(struct ccid_operations *ccid_ops); | |
7c657876 | 91 | |
91f0ebf7 ACM |
92 | struct ccid { |
93 | struct ccid_operations *ccid_ops; | |
94 | char ccid_priv[0]; | |
95 | }; | |
7c657876 | 96 | |
91f0ebf7 | 97 | static inline void *ccid_priv(const struct ccid *ccid) |
7c657876 | 98 | { |
91f0ebf7 | 99 | return (void *)ccid->ccid_priv; |
7c657876 ACM |
100 | } |
101 | ||
71bb4959 GR |
102 | extern bool ccid_support_check(u8 const *ccid_array, u8 array_len); |
103 | extern int ccid_get_builtin_ccids(u8 **ccid_array, u8 *array_len); | |
104 | extern int ccid_getsockopt_builtin_ccids(struct sock *sk, int len, | |
105 | char __user *, int __user *); | |
106 | ||
09856c10 | 107 | extern int ccid_request_modules(u8 const *ccid_array, u8 array_len); |
91f0ebf7 ACM |
108 | extern struct ccid *ccid_new(unsigned char id, struct sock *sk, int rx, |
109 | gfp_t gfp); | |
110 | ||
c8041e26 GR |
111 | static inline int ccid_get_current_rx_ccid(struct dccp_sock *dp) |
112 | { | |
113 | struct ccid *ccid = dp->dccps_hc_rx_ccid; | |
114 | ||
115 | if (ccid == NULL || ccid->ccid_ops == NULL) | |
116 | return -1; | |
117 | return ccid->ccid_ops->ccid_id; | |
118 | } | |
119 | ||
120 | static inline int ccid_get_current_tx_ccid(struct dccp_sock *dp) | |
121 | { | |
122 | struct ccid *ccid = dp->dccps_hc_tx_ccid; | |
123 | ||
124 | if (ccid == NULL || ccid->ccid_ops == NULL) | |
125 | return -1; | |
126 | return ccid->ccid_ops->ccid_id; | |
127 | } | |
128 | ||
91f0ebf7 ACM |
129 | extern void ccid_hc_rx_delete(struct ccid *ccid, struct sock *sk); |
130 | extern void ccid_hc_tx_delete(struct ccid *ccid, struct sock *sk); | |
131 | ||
7c657876 | 132 | static inline int ccid_hc_tx_send_packet(struct ccid *ccid, struct sock *sk, |
6b57c93d | 133 | struct sk_buff *skb) |
7c657876 ACM |
134 | { |
135 | int rc = 0; | |
91f0ebf7 | 136 | if (ccid->ccid_ops->ccid_hc_tx_send_packet != NULL) |
6b57c93d | 137 | rc = ccid->ccid_ops->ccid_hc_tx_send_packet(sk, skb); |
7c657876 ACM |
138 | return rc; |
139 | } | |
140 | ||
141 | static inline void ccid_hc_tx_packet_sent(struct ccid *ccid, struct sock *sk, | |
6b57c93d | 142 | int more, unsigned int len) |
7c657876 | 143 | { |
91f0ebf7 ACM |
144 | if (ccid->ccid_ops->ccid_hc_tx_packet_sent != NULL) |
145 | ccid->ccid_ops->ccid_hc_tx_packet_sent(sk, more, len); | |
7c657876 ACM |
146 | } |
147 | ||
148 | static inline void ccid_hc_rx_packet_recv(struct ccid *ccid, struct sock *sk, | |
149 | struct sk_buff *skb) | |
150 | { | |
91f0ebf7 ACM |
151 | if (ccid->ccid_ops->ccid_hc_rx_packet_recv != NULL) |
152 | ccid->ccid_ops->ccid_hc_rx_packet_recv(sk, skb); | |
7c657876 ACM |
153 | } |
154 | ||
155 | static inline void ccid_hc_tx_packet_recv(struct ccid *ccid, struct sock *sk, | |
156 | struct sk_buff *skb) | |
157 | { | |
91f0ebf7 ACM |
158 | if (ccid->ccid_ops->ccid_hc_tx_packet_recv != NULL) |
159 | ccid->ccid_ops->ccid_hc_tx_packet_recv(sk, skb); | |
7c657876 ACM |
160 | } |
161 | ||
3306c781 GR |
162 | /** |
163 | * ccid_hc_tx_parse_options - Parse CCID-specific options sent by the receiver | |
164 | * @pkt: type of packet that @opt appears on (RFC 4340, 5.1) | |
165 | * @opt: the CCID-specific option type (RFC 4340, 5.8 and 10.3) | |
166 | * @val: value of @opt | |
167 | * @len: length of @val in bytes | |
168 | */ | |
7c657876 | 169 | static inline int ccid_hc_tx_parse_options(struct ccid *ccid, struct sock *sk, |
3306c781 | 170 | u8 pkt, u8 opt, u8 *val, u8 len) |
7c657876 | 171 | { |
3306c781 GR |
172 | if (ccid->ccid_ops->ccid_hc_tx_parse_options == NULL) |
173 | return 0; | |
174 | return ccid->ccid_ops->ccid_hc_tx_parse_options(sk, pkt, opt, val, len); | |
7c657876 ACM |
175 | } |
176 | ||
3306c781 GR |
177 | /** |
178 | * ccid_hc_rx_parse_options - Parse CCID-specific options sent by the sender | |
179 | * Arguments are analogous to ccid_hc_tx_parse_options() | |
180 | */ | |
7c657876 | 181 | static inline int ccid_hc_rx_parse_options(struct ccid *ccid, struct sock *sk, |
3306c781 | 182 | u8 pkt, u8 opt, u8 *val, u8 len) |
7c657876 | 183 | { |
3306c781 GR |
184 | if (ccid->ccid_ops->ccid_hc_rx_parse_options == NULL) |
185 | return 0; | |
186 | return ccid->ccid_ops->ccid_hc_rx_parse_options(sk, pkt, opt, val, len); | |
7c657876 ACM |
187 | } |
188 | ||
2d0817d1 ACM |
189 | static inline int ccid_hc_rx_insert_options(struct ccid *ccid, struct sock *sk, |
190 | struct sk_buff *skb) | |
7c657876 | 191 | { |
91f0ebf7 | 192 | if (ccid->ccid_ops->ccid_hc_rx_insert_options != NULL) |
2d0817d1 ACM |
193 | return ccid->ccid_ops->ccid_hc_rx_insert_options(sk, skb); |
194 | return 0; | |
7c657876 | 195 | } |
2babe1f6 ACM |
196 | |
197 | static inline void ccid_hc_rx_get_info(struct ccid *ccid, struct sock *sk, | |
198 | struct tcp_info *info) | |
199 | { | |
91f0ebf7 ACM |
200 | if (ccid->ccid_ops->ccid_hc_rx_get_info != NULL) |
201 | ccid->ccid_ops->ccid_hc_rx_get_info(sk, info); | |
2babe1f6 ACM |
202 | } |
203 | ||
204 | static inline void ccid_hc_tx_get_info(struct ccid *ccid, struct sock *sk, | |
205 | struct tcp_info *info) | |
206 | { | |
91f0ebf7 ACM |
207 | if (ccid->ccid_ops->ccid_hc_tx_get_info != NULL) |
208 | ccid->ccid_ops->ccid_hc_tx_get_info(sk, info); | |
2babe1f6 | 209 | } |
88f964db ACM |
210 | |
211 | static inline int ccid_hc_rx_getsockopt(struct ccid *ccid, struct sock *sk, | |
212 | const int optname, int len, | |
213 | u32 __user *optval, int __user *optlen) | |
214 | { | |
215 | int rc = -ENOPROTOOPT; | |
91f0ebf7 ACM |
216 | if (ccid->ccid_ops->ccid_hc_rx_getsockopt != NULL) |
217 | rc = ccid->ccid_ops->ccid_hc_rx_getsockopt(sk, optname, len, | |
88f964db ACM |
218 | optval, optlen); |
219 | return rc; | |
220 | } | |
221 | ||
222 | static inline int ccid_hc_tx_getsockopt(struct ccid *ccid, struct sock *sk, | |
223 | const int optname, int len, | |
224 | u32 __user *optval, int __user *optlen) | |
225 | { | |
226 | int rc = -ENOPROTOOPT; | |
91f0ebf7 ACM |
227 | if (ccid->ccid_ops->ccid_hc_tx_getsockopt != NULL) |
228 | rc = ccid->ccid_ops->ccid_hc_tx_getsockopt(sk, optname, len, | |
88f964db ACM |
229 | optval, optlen); |
230 | return rc; | |
231 | } | |
7c657876 | 232 | #endif /* _CCID_H */ |