Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 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> |
Arnaldo Carvalho de Melo | 88f964d | 2005-09-18 00:19:32 -0700 | [diff] [blame] | 17 | #include <linux/compiler.h> |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 18 | #include <linux/dccp.h> |
| 19 | #include <linux/list.h> |
| 20 | #include <linux/module.h> |
| 21 | |
Gerrit Renker | 8ed030d | 2010-02-01 02:12:19 +0000 | [diff] [blame] | 22 | /* maximum value for a CCID (RFC 4340, 19.5) */ |
| 23 | #define CCID_MAX 255 |
| 24 | #define CCID_SLAB_NAME_LENGTH 32 |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 25 | |
Arnaldo Carvalho de Melo | 14c8502 | 2005-12-27 02:43:12 -0200 | [diff] [blame] | 26 | struct tcp_info; |
| 27 | |
Gerrit Renker | 9cb2345 | 2007-12-13 23:31:14 -0200 | [diff] [blame] | 28 | /** |
| 29 | * struct ccid_operations - Interface to Congestion-Control Infrastructure |
| 30 | * |
| 31 | * @ccid_id: numerical CCID ID (up to %CCID_MAX, cf. table 5 in RFC 4340, 10.) |
Gerrit Renker | 6179983 | 2007-12-13 23:37:55 -0200 | [diff] [blame] | 32 | * @ccid_ccmps: the CCMPS including network/transport headers (0 when disabled) |
Gerrit Renker | 9cb2345 | 2007-12-13 23:31:14 -0200 | [diff] [blame] | 33 | * @ccid_name: alphabetical identifier string for @ccid_id |
Gerrit Renker | 9cb2345 | 2007-12-13 23:31:14 -0200 | [diff] [blame] | 34 | * @ccid_hc_{r,t}x_slab: memory pool for the receiver/sender half-connection |
| 35 | * @ccid_hc_{r,t}x_obj_size: size of the receiver/sender half-connection socket |
| 36 | * |
| 37 | * @ccid_hc_{r,t}x_init: CCID-specific initialisation routine (before startup) |
| 38 | * @ccid_hc_{r,t}x_exit: CCID-specific cleanup routine (before destruction) |
| 39 | * @ccid_hc_rx_packet_recv: implements the HC-receiver side |
| 40 | * @ccid_hc_{r,t}x_parse_options: parsing routine for CCID/HC-specific options |
| 41 | * @ccid_hc_{r,t}x_insert_options: insert routine for CCID/HC-specific options |
| 42 | * @ccid_hc_tx_packet_recv: implements feedback processing for the HC-sender |
| 43 | * @ccid_hc_tx_send_packet: implements the sending part of the HC-sender |
| 44 | * @ccid_hc_tx_packet_sent: does accounting for packets in flight by HC-sender |
| 45 | * @ccid_hc_{r,t}x_get_info: INET_DIAG information for HC-receiver/sender |
| 46 | * @ccid_hc_{r,t}x_getsockopt: socket options specific to HC-receiver/sender |
| 47 | */ |
Arnaldo Carvalho de Melo | 91f0ebf | 2006-03-20 19:21:44 -0800 | [diff] [blame] | 48 | struct ccid_operations { |
Gerrit Renker | 9cb2345 | 2007-12-13 23:31:14 -0200 | [diff] [blame] | 49 | unsigned char ccid_id; |
Gerrit Renker | 6179983 | 2007-12-13 23:37:55 -0200 | [diff] [blame] | 50 | __u32 ccid_ccmps; |
Gerrit Renker | 9cb2345 | 2007-12-13 23:31:14 -0200 | [diff] [blame] | 51 | const char *ccid_name; |
Gerrit Renker | 9cb2345 | 2007-12-13 23:31:14 -0200 | [diff] [blame] | 52 | struct kmem_cache *ccid_hc_rx_slab, |
| 53 | *ccid_hc_tx_slab; |
Gerrit Renker | 8ed030d | 2010-02-01 02:12:19 +0000 | [diff] [blame] | 54 | char ccid_hc_rx_slab_name[CCID_SLAB_NAME_LENGTH]; |
| 55 | char ccid_hc_tx_slab_name[CCID_SLAB_NAME_LENGTH]; |
Gerrit Renker | 9cb2345 | 2007-12-13 23:31:14 -0200 | [diff] [blame] | 56 | __u32 ccid_hc_rx_obj_size, |
| 57 | ccid_hc_tx_obj_size; |
| 58 | /* Interface Routines */ |
Arnaldo Carvalho de Melo | 91f0ebf | 2006-03-20 19:21:44 -0800 | [diff] [blame] | 59 | int (*ccid_hc_rx_init)(struct ccid *ccid, struct sock *sk); |
| 60 | int (*ccid_hc_tx_init)(struct ccid *ccid, struct sock *sk); |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 61 | void (*ccid_hc_rx_exit)(struct sock *sk); |
| 62 | void (*ccid_hc_tx_exit)(struct sock *sk); |
Arnaldo Carvalho de Melo | 7690af3 | 2005-08-13 20:34:54 -0300 | [diff] [blame] | 63 | void (*ccid_hc_rx_packet_recv)(struct sock *sk, |
| 64 | struct sk_buff *skb); |
Gerrit Renker | 4874c13 | 2010-09-19 20:06:50 +0200 | [diff] [blame] | 65 | int (*ccid_hc_rx_parse_options)(struct sock *sk, u8 pkt, |
| 66 | u8 opt, u8 *val, u8 len); |
Arnaldo Carvalho de Melo | 2d0817d | 2006-03-20 22:32:06 -0800 | [diff] [blame] | 67 | int (*ccid_hc_rx_insert_options)(struct sock *sk, |
Arnaldo Carvalho de Melo | 7690af3 | 2005-08-13 20:34:54 -0300 | [diff] [blame] | 68 | struct sk_buff *skb); |
Arnaldo Carvalho de Melo | 7690af3 | 2005-08-13 20:34:54 -0300 | [diff] [blame] | 69 | void (*ccid_hc_tx_packet_recv)(struct sock *sk, |
| 70 | struct sk_buff *skb); |
Gerrit Renker | 4874c13 | 2010-09-19 20:06:50 +0200 | [diff] [blame] | 71 | int (*ccid_hc_tx_parse_options)(struct sock *sk, u8 pkt, |
| 72 | u8 opt, u8 *val, u8 len); |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 73 | int (*ccid_hc_tx_send_packet)(struct sock *sk, |
Gerrit Renker | 6b57c93 | 2006-11-28 19:55:06 -0200 | [diff] [blame] | 74 | struct sk_buff *skb); |
| 75 | void (*ccid_hc_tx_packet_sent)(struct sock *sk, |
Gerrit Renker | baf9e78 | 2010-10-11 20:37:38 +0200 | [diff] [blame] | 76 | unsigned int len); |
Arnaldo Carvalho de Melo | 2babe1f | 2005-08-23 21:52:35 -0700 | [diff] [blame] | 77 | void (*ccid_hc_rx_get_info)(struct sock *sk, |
| 78 | struct tcp_info *info); |
| 79 | void (*ccid_hc_tx_get_info)(struct sock *sk, |
| 80 | struct tcp_info *info); |
Arnaldo Carvalho de Melo | 88f964d | 2005-09-18 00:19:32 -0700 | [diff] [blame] | 81 | int (*ccid_hc_rx_getsockopt)(struct sock *sk, |
| 82 | const int optname, int len, |
| 83 | u32 __user *optval, |
| 84 | int __user *optlen); |
| 85 | int (*ccid_hc_tx_getsockopt)(struct sock *sk, |
| 86 | const int optname, int len, |
| 87 | u32 __user *optval, |
| 88 | int __user *optlen); |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 89 | }; |
| 90 | |
Gerrit Renker | ddebc97 | 2009-01-04 21:42:53 -0800 | [diff] [blame] | 91 | extern struct ccid_operations ccid2_ops; |
| 92 | #ifdef CONFIG_IP_DCCP_CCID3 |
| 93 | extern struct ccid_operations ccid3_ops; |
| 94 | #endif |
| 95 | |
| 96 | extern int ccid_initialize_builtins(void); |
| 97 | extern void ccid_cleanup_builtins(void); |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 98 | |
Arnaldo Carvalho de Melo | 91f0ebf | 2006-03-20 19:21:44 -0800 | [diff] [blame] | 99 | struct ccid { |
| 100 | struct ccid_operations *ccid_ops; |
| 101 | char ccid_priv[0]; |
| 102 | }; |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 103 | |
Arnaldo Carvalho de Melo | 91f0ebf | 2006-03-20 19:21:44 -0800 | [diff] [blame] | 104 | static inline void *ccid_priv(const struct ccid *ccid) |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 105 | { |
Arnaldo Carvalho de Melo | 91f0ebf | 2006-03-20 19:21:44 -0800 | [diff] [blame] | 106 | return (void *)ccid->ccid_priv; |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 107 | } |
| 108 | |
Gerrit Renker | d90ebcb | 2008-11-12 00:47:26 -0800 | [diff] [blame] | 109 | extern bool ccid_support_check(u8 const *ccid_array, u8 array_len); |
| 110 | extern int ccid_get_builtin_ccids(u8 **ccid_array, u8 *array_len); |
| 111 | extern int ccid_getsockopt_builtin_ccids(struct sock *sk, int len, |
| 112 | char __user *, int __user *); |
| 113 | |
Gerrit Renker | e5fd56c | 2009-01-04 21:43:23 -0800 | [diff] [blame] | 114 | extern struct ccid *ccid_new(const u8 id, struct sock *sk, bool rx); |
Arnaldo Carvalho de Melo | 91f0ebf | 2006-03-20 19:21:44 -0800 | [diff] [blame] | 115 | |
Gerrit Renker | 71c262a | 2008-11-23 16:04:59 -0800 | [diff] [blame] | 116 | static inline int ccid_get_current_rx_ccid(struct dccp_sock *dp) |
| 117 | { |
| 118 | struct ccid *ccid = dp->dccps_hc_rx_ccid; |
| 119 | |
| 120 | if (ccid == NULL || ccid->ccid_ops == NULL) |
| 121 | return -1; |
| 122 | return ccid->ccid_ops->ccid_id; |
| 123 | } |
| 124 | |
| 125 | static inline int ccid_get_current_tx_ccid(struct dccp_sock *dp) |
| 126 | { |
| 127 | struct ccid *ccid = dp->dccps_hc_tx_ccid; |
| 128 | |
| 129 | if (ccid == NULL || ccid->ccid_ops == NULL) |
| 130 | return -1; |
| 131 | return ccid->ccid_ops->ccid_id; |
| 132 | } |
| 133 | |
Arnaldo Carvalho de Melo | 91f0ebf | 2006-03-20 19:21:44 -0800 | [diff] [blame] | 134 | extern void ccid_hc_rx_delete(struct ccid *ccid, struct sock *sk); |
| 135 | extern void ccid_hc_tx_delete(struct ccid *ccid, struct sock *sk); |
| 136 | |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 137 | static inline int ccid_hc_tx_send_packet(struct ccid *ccid, struct sock *sk, |
Gerrit Renker | 6b57c93 | 2006-11-28 19:55:06 -0200 | [diff] [blame] | 138 | struct sk_buff *skb) |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 139 | { |
| 140 | int rc = 0; |
Arnaldo Carvalho de Melo | 91f0ebf | 2006-03-20 19:21:44 -0800 | [diff] [blame] | 141 | if (ccid->ccid_ops->ccid_hc_tx_send_packet != NULL) |
Gerrit Renker | 6b57c93 | 2006-11-28 19:55:06 -0200 | [diff] [blame] | 142 | rc = ccid->ccid_ops->ccid_hc_tx_send_packet(sk, skb); |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 143 | return rc; |
| 144 | } |
| 145 | |
| 146 | static inline void ccid_hc_tx_packet_sent(struct ccid *ccid, struct sock *sk, |
Gerrit Renker | baf9e78 | 2010-10-11 20:37:38 +0200 | [diff] [blame] | 147 | unsigned int len) |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 148 | { |
Arnaldo Carvalho de Melo | 91f0ebf | 2006-03-20 19:21:44 -0800 | [diff] [blame] | 149 | if (ccid->ccid_ops->ccid_hc_tx_packet_sent != NULL) |
Gerrit Renker | baf9e78 | 2010-10-11 20:37:38 +0200 | [diff] [blame] | 150 | ccid->ccid_ops->ccid_hc_tx_packet_sent(sk, len); |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 151 | } |
| 152 | |
| 153 | static inline void ccid_hc_rx_packet_recv(struct ccid *ccid, struct sock *sk, |
| 154 | struct sk_buff *skb) |
| 155 | { |
Arnaldo Carvalho de Melo | 91f0ebf | 2006-03-20 19:21:44 -0800 | [diff] [blame] | 156 | if (ccid->ccid_ops->ccid_hc_rx_packet_recv != NULL) |
| 157 | ccid->ccid_ops->ccid_hc_rx_packet_recv(sk, skb); |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 158 | } |
| 159 | |
| 160 | static inline void ccid_hc_tx_packet_recv(struct ccid *ccid, struct sock *sk, |
| 161 | struct sk_buff *skb) |
| 162 | { |
Arnaldo Carvalho de Melo | 91f0ebf | 2006-03-20 19:21:44 -0800 | [diff] [blame] | 163 | if (ccid->ccid_ops->ccid_hc_tx_packet_recv != NULL) |
| 164 | ccid->ccid_ops->ccid_hc_tx_packet_recv(sk, skb); |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 165 | } |
| 166 | |
Gerrit Renker | 4874c13 | 2010-09-19 20:06:50 +0200 | [diff] [blame] | 167 | /** |
| 168 | * ccid_hc_tx_parse_options - Parse CCID-specific options sent by the receiver |
| 169 | * @pkt: type of packet that @opt appears on (RFC 4340, 5.1) |
| 170 | * @opt: the CCID-specific option type (RFC 4340, 5.8 and 10.3) |
| 171 | * @val: value of @opt |
| 172 | * @len: length of @val in bytes |
| 173 | */ |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 174 | static inline int ccid_hc_tx_parse_options(struct ccid *ccid, struct sock *sk, |
Gerrit Renker | 4874c13 | 2010-09-19 20:06:50 +0200 | [diff] [blame] | 175 | u8 pkt, u8 opt, u8 *val, u8 len) |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 176 | { |
Gerrit Renker | 4874c13 | 2010-09-19 20:06:50 +0200 | [diff] [blame] | 177 | if (ccid->ccid_ops->ccid_hc_tx_parse_options == NULL) |
| 178 | return 0; |
| 179 | return ccid->ccid_ops->ccid_hc_tx_parse_options(sk, pkt, opt, val, len); |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 180 | } |
| 181 | |
Gerrit Renker | 4874c13 | 2010-09-19 20:06:50 +0200 | [diff] [blame] | 182 | /** |
| 183 | * ccid_hc_rx_parse_options - Parse CCID-specific options sent by the sender |
| 184 | * Arguments are analogous to ccid_hc_tx_parse_options() |
| 185 | */ |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 186 | static inline int ccid_hc_rx_parse_options(struct ccid *ccid, struct sock *sk, |
Gerrit Renker | 4874c13 | 2010-09-19 20:06:50 +0200 | [diff] [blame] | 187 | u8 pkt, u8 opt, u8 *val, u8 len) |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 188 | { |
Gerrit Renker | 4874c13 | 2010-09-19 20:06:50 +0200 | [diff] [blame] | 189 | if (ccid->ccid_ops->ccid_hc_rx_parse_options == NULL) |
| 190 | return 0; |
| 191 | return ccid->ccid_ops->ccid_hc_rx_parse_options(sk, pkt, opt, val, len); |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 192 | } |
| 193 | |
Arnaldo Carvalho de Melo | 2d0817d | 2006-03-20 22:32:06 -0800 | [diff] [blame] | 194 | static inline int ccid_hc_rx_insert_options(struct ccid *ccid, struct sock *sk, |
| 195 | struct sk_buff *skb) |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 196 | { |
Arnaldo Carvalho de Melo | 91f0ebf | 2006-03-20 19:21:44 -0800 | [diff] [blame] | 197 | if (ccid->ccid_ops->ccid_hc_rx_insert_options != NULL) |
Arnaldo Carvalho de Melo | 2d0817d | 2006-03-20 22:32:06 -0800 | [diff] [blame] | 198 | return ccid->ccid_ops->ccid_hc_rx_insert_options(sk, skb); |
| 199 | return 0; |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 200 | } |
Arnaldo Carvalho de Melo | 2babe1f | 2005-08-23 21:52:35 -0700 | [diff] [blame] | 201 | |
| 202 | static inline void ccid_hc_rx_get_info(struct ccid *ccid, struct sock *sk, |
| 203 | struct tcp_info *info) |
| 204 | { |
Arnaldo Carvalho de Melo | 91f0ebf | 2006-03-20 19:21:44 -0800 | [diff] [blame] | 205 | if (ccid->ccid_ops->ccid_hc_rx_get_info != NULL) |
| 206 | ccid->ccid_ops->ccid_hc_rx_get_info(sk, info); |
Arnaldo Carvalho de Melo | 2babe1f | 2005-08-23 21:52:35 -0700 | [diff] [blame] | 207 | } |
| 208 | |
| 209 | static inline void ccid_hc_tx_get_info(struct ccid *ccid, struct sock *sk, |
| 210 | struct tcp_info *info) |
| 211 | { |
Arnaldo Carvalho de Melo | 91f0ebf | 2006-03-20 19:21:44 -0800 | [diff] [blame] | 212 | if (ccid->ccid_ops->ccid_hc_tx_get_info != NULL) |
| 213 | ccid->ccid_ops->ccid_hc_tx_get_info(sk, info); |
Arnaldo Carvalho de Melo | 2babe1f | 2005-08-23 21:52:35 -0700 | [diff] [blame] | 214 | } |
Arnaldo Carvalho de Melo | 88f964d | 2005-09-18 00:19:32 -0700 | [diff] [blame] | 215 | |
| 216 | static inline int ccid_hc_rx_getsockopt(struct ccid *ccid, struct sock *sk, |
| 217 | const int optname, int len, |
| 218 | u32 __user *optval, int __user *optlen) |
| 219 | { |
| 220 | int rc = -ENOPROTOOPT; |
Arnaldo Carvalho de Melo | 91f0ebf | 2006-03-20 19:21:44 -0800 | [diff] [blame] | 221 | if (ccid->ccid_ops->ccid_hc_rx_getsockopt != NULL) |
| 222 | rc = ccid->ccid_ops->ccid_hc_rx_getsockopt(sk, optname, len, |
Arnaldo Carvalho de Melo | 88f964d | 2005-09-18 00:19:32 -0700 | [diff] [blame] | 223 | optval, optlen); |
| 224 | return rc; |
| 225 | } |
| 226 | |
| 227 | static inline int ccid_hc_tx_getsockopt(struct ccid *ccid, struct sock *sk, |
| 228 | const int optname, int len, |
| 229 | u32 __user *optval, int __user *optlen) |
| 230 | { |
| 231 | int rc = -ENOPROTOOPT; |
Arnaldo Carvalho de Melo | 91f0ebf | 2006-03-20 19:21:44 -0800 | [diff] [blame] | 232 | if (ccid->ccid_ops->ccid_hc_tx_getsockopt != NULL) |
| 233 | rc = ccid->ccid_ops->ccid_hc_tx_getsockopt(sk, optname, len, |
Arnaldo Carvalho de Melo | 88f964d | 2005-09-18 00:19:32 -0700 | [diff] [blame] | 234 | optval, optlen); |
| 235 | return rc; |
| 236 | } |
Arnaldo Carvalho de Melo | 7c65787 | 2005-08-09 20:14:34 -0700 | [diff] [blame] | 237 | #endif /* _CCID_H */ |