projects / linux-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
dccp: Header option insertion routine for feature-negotiation
[linux-block.git] / net / dccp / ccid.h
CommitLineData
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		 24struct 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 47struct 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);
7c657876
ACM		 63 int (*ccid_hc_rx_parse_options)(struct sock *sk,
64 unsigned char option,
65 unsigned char len, u16 idx,
66 unsigned char* value);
2d0817d1 67 int (*ccid_hc_rx_insert_options)(struct sock *sk,
7690af3f 68 struct sk_buff *skb);
7690af3f
ACM		 69 void (*ccid_hc_tx_packet_recv)(struct sock *sk,
70 struct sk_buff *skb);
7c657876
ACM		 71 int (*ccid_hc_tx_parse_options)(struct sock *sk,
72 unsigned char option,
73 unsigned char len, u16 idx,
74 unsigned char* value);
75 int (*ccid_hc_tx_send_packet)(struct sock *sk,
6b57c93d
GR		 76 struct sk_buff *skb);
77 void (*ccid_hc_tx_packet_sent)(struct sock *sk,
78 int more, unsigned int len);
2babe1f6
ACM		 79 void (*ccid_hc_rx_get_info)(struct sock *sk,
80 struct tcp_info *info);
81 void (*ccid_hc_tx_get_info)(struct sock *sk,
82 struct tcp_info *info);
88f964db
ACM		 83 int (*ccid_hc_rx_getsockopt)(struct sock *sk,
84 const int optname, int len,
85 u32 __user *optval,
86 int __user *optlen);
87 int (*ccid_hc_tx_getsockopt)(struct sock *sk,
88 const int optname, int len,
89 u32 __user *optval,
90 int __user *optlen);
7c657876
ACM		 91};
92
91f0ebf7
ACM		 93extern int ccid_register(struct ccid_operations *ccid_ops);
94extern int ccid_unregister(struct ccid_operations *ccid_ops);
7c657876 95
91f0ebf7
ACM		 96struct ccid {
97 struct ccid_operations *ccid_ops;
98 char ccid_priv[0];
99};
7c657876 100
91f0ebf7 101static inline void *ccid_priv(const struct ccid *ccid)
7c657876 102{
91f0ebf7 103 return (void *)ccid->ccid_priv;
7c657876
ACM		 104}
105
d90ebcbf
GR		 106extern bool ccid_support_check(u8 const *ccid_array, u8 array_len);
107extern int ccid_get_builtin_ccids(u8 **ccid_array, u8 *array_len);
108extern int ccid_getsockopt_builtin_ccids(struct sock *sk, int len,
109 char __user *, int __user *);
110
91f0ebf7
ACM		 111extern struct ccid *ccid_new(unsigned char id, struct sock *sk, int rx,
112 gfp_t gfp);
113
114extern struct ccid *ccid_hc_rx_new(unsigned char id, struct sock *sk,
115 gfp_t gfp);
116extern struct ccid *ccid_hc_tx_new(unsigned char id, struct sock *sk,
117 gfp_t gfp);
118
71c262a3
GR		 119static inline int ccid_get_current_rx_ccid(struct dccp_sock *dp)
120{
121 struct ccid *ccid = dp->dccps_hc_rx_ccid;
122
123 if (ccid == NULL || ccid->ccid_ops == NULL)
124 return -1;
125 return ccid->ccid_ops->ccid_id;
126}
127
128static inline int ccid_get_current_tx_ccid(struct dccp_sock *dp)
129{
130 struct ccid *ccid = dp->dccps_hc_tx_ccid;
131
132 if (ccid == NULL || ccid->ccid_ops == NULL)
133 return -1;
134 return ccid->ccid_ops->ccid_id;
135}
136
91f0ebf7
ACM		 137extern void ccid_hc_rx_delete(struct ccid *ccid, struct sock *sk);
138extern void ccid_hc_tx_delete(struct ccid *ccid, struct sock *sk);
139
7c657876 140static inline int ccid_hc_tx_send_packet(struct ccid *ccid, struct sock *sk,
6b57c93d 141 struct sk_buff *skb)
7c657876
ACM		 142{
143 int rc = 0;
91f0ebf7 144 if (ccid->ccid_ops->ccid_hc_tx_send_packet != NULL)
6b57c93d 145 rc = ccid->ccid_ops->ccid_hc_tx_send_packet(sk, skb);
7c657876
ACM		 146 return rc;
147}
148
149static inline void ccid_hc_tx_packet_sent(struct ccid *ccid, struct sock *sk,
6b57c93d 150 int more, unsigned int len)
7c657876 151{
91f0ebf7
ACM		 152 if (ccid->ccid_ops->ccid_hc_tx_packet_sent != NULL)
153 ccid->ccid_ops->ccid_hc_tx_packet_sent(sk, more, len);
7c657876
ACM		 154}
155
156static inline void ccid_hc_rx_packet_recv(struct ccid *ccid, struct sock *sk,
157 struct sk_buff *skb)
158{
91f0ebf7
ACM		 159 if (ccid->ccid_ops->ccid_hc_rx_packet_recv != NULL)
160 ccid->ccid_ops->ccid_hc_rx_packet_recv(sk, skb);
7c657876
ACM		 161}
162
163static inline void ccid_hc_tx_packet_recv(struct ccid *ccid, struct sock *sk,
164 struct sk_buff *skb)
165{
91f0ebf7
ACM		 166 if (ccid->ccid_ops->ccid_hc_tx_packet_recv != NULL)
167 ccid->ccid_ops->ccid_hc_tx_packet_recv(sk, skb);
7c657876
ACM		 168}
169
170static inline int ccid_hc_tx_parse_options(struct ccid *ccid, struct sock *sk,
171 unsigned char option,
172 unsigned char len, u16 idx,
173 unsigned char* value)
174{
175 int rc = 0;
91f0ebf7
ACM		 176 if (ccid->ccid_ops->ccid_hc_tx_parse_options != NULL)
177 rc = ccid->ccid_ops->ccid_hc_tx_parse_options(sk, option, len, idx,
7690af3f 178 value);
7c657876
ACM		 179 return rc;
180}
181
182static inline int ccid_hc_rx_parse_options(struct ccid *ccid, struct sock *sk,
183 unsigned char option,
184 unsigned char len, u16 idx,
185 unsigned char* value)
186{
187 int rc = 0;
91f0ebf7
ACM		 188 if (ccid->ccid_ops->ccid_hc_rx_parse_options != NULL)
189 rc = ccid->ccid_ops->ccid_hc_rx_parse_options(sk, option, len, idx, value);
7c657876
ACM		 190 return rc;
191}
192
2d0817d1
ACM		 193static inline int ccid_hc_rx_insert_options(struct ccid *ccid, struct sock *sk,
194 struct sk_buff *skb)
7c657876 195{
91f0ebf7 196 if (ccid->ccid_ops->ccid_hc_rx_insert_options != NULL)
2d0817d1
ACM		 197 return ccid->ccid_ops->ccid_hc_rx_insert_options(sk, skb);
198 return 0;
7c657876 199}
2babe1f6
ACM		 200
201static inline void ccid_hc_rx_get_info(struct ccid *ccid, struct sock *sk,
202 struct tcp_info *info)
203{
91f0ebf7
ACM		 204 if (ccid->ccid_ops->ccid_hc_rx_get_info != NULL)
205 ccid->ccid_ops->ccid_hc_rx_get_info(sk, info);
2babe1f6
ACM		 206}
207
208static inline void ccid_hc_tx_get_info(struct ccid *ccid, struct sock *sk,
209 struct tcp_info *info)
210{
91f0ebf7
ACM		 211 if (ccid->ccid_ops->ccid_hc_tx_get_info != NULL)
212 ccid->ccid_ops->ccid_hc_tx_get_info(sk, info);
2babe1f6 213}
88f964db
ACM		 214
215static inline int ccid_hc_rx_getsockopt(struct ccid *ccid, struct sock *sk,
216 const int optname, int len,
217 u32 __user *optval, int __user *optlen)
218{
219 int rc = -ENOPROTOOPT;
91f0ebf7
ACM		 220 if (ccid->ccid_ops->ccid_hc_rx_getsockopt != NULL)
221 rc = ccid->ccid_ops->ccid_hc_rx_getsockopt(sk, optname, len,
88f964db
ACM		 222 optval, optlen);
223 return rc;
224}
225
226static inline int ccid_hc_tx_getsockopt(struct ccid *ccid, struct sock *sk,
227 const int optname, int len,
228 u32 __user *optval, int __user *optlen)
229{
230 int rc = -ENOPROTOOPT;
91f0ebf7
ACM		 231 if (ccid->ccid_ops->ccid_hc_tx_getsockopt != NULL)
232 rc = ccid->ccid_ops->ccid_hc_tx_getsockopt(sk, optname, len,
88f964db
ACM		 233 optval, optlen);
234 return rc;
235}
7c657876 236#endif /* _CCID_H */
Linux 6.x block layer and io_uring tree(s)