net/dccp/ccid.h

   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>
  17 #include <linux/compiler.h>
  18 #include <linux/dccp.h>
  19 #include <linux/list.h>
  20 #include <linux/module.h>
  21
  22 #define CCID_MAX 255
  23
  24 struct tcp_info;
  25
  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.)
  30  *  @ccid_ccmps: the CCMPS including network/transport headers (0 when disabled)
  31  *  @ccid_name: alphabetical identifier string for @ccid_id
  32  *  @ccid_hc_{r,t}x_slab: memory pool for the receiver/sender half-connection
  33  *  @ccid_hc_{r,t}x_obj_size: size of the receiver/sender half-connection socket
  34  *
  35  *  @ccid_hc_{r,t}x_init: CCID-specific initialisation routine (before startup)
  36  *  @ccid_hc_{r,t}x_exit: CCID-specific cleanup routine (before destruction)
  37  *  @ccid_hc_rx_packet_recv: implements the HC-receiver side
  38  *  @ccid_hc_{r,t}x_parse_options: parsing routine for CCID/HC-specific options
  39  *  @ccid_hc_{r,t}x_insert_options: insert routine for CCID/HC-specific options
  40  *  @ccid_hc_tx_packet_recv: implements feedback processing for the HC-sender
  41  *  @ccid_hc_tx_send_packet: implements the sending part of the HC-sender
  42  *  @ccid_hc_tx_packet_sent: does accounting for packets in flight by HC-sender
  43  *  @ccid_hc_{r,t}x_get_info: INET_DIAG information for HC-receiver/sender
  44  *  @ccid_hc_{r,t}x_getsockopt: socket options specific to HC-receiver/sender
  45  */
  46 struct ccid_operations {
  47         unsigned char           ccid_id;
  48         __u32                   ccid_ccmps;
  49         const char              *ccid_name;
  50         struct kmem_cache       *ccid_hc_rx_slab,
  51                                 *ccid_hc_tx_slab;
  52         char                    ccid_hc_rx_slab_name[32];
  53         char                    ccid_hc_tx_slab_name[32];
  54         __u32                   ccid_hc_rx_obj_size,
  55                                 ccid_hc_tx_obj_size;
  56         /* Interface Routines */
  57         int             (*ccid_hc_rx_init)(struct ccid *ccid, struct sock *sk);
  58         int             (*ccid_hc_tx_init)(struct ccid *ccid, struct sock *sk);
  59         void            (*ccid_hc_rx_exit)(struct sock *sk);
  60         void            (*ccid_hc_tx_exit)(struct sock *sk);
  61         void            (*ccid_hc_rx_packet_recv)(struct sock *sk,
  62                                                   struct sk_buff *skb);
  63         int             (*ccid_hc_rx_parse_options)(struct sock *sk,
  64                                                     unsigned char option,
  65                                                     unsigned char len, u16 idx,
  66                                                     unsigned char* value);
  67         int             (*ccid_hc_rx_insert_options)(struct sock *sk,
  68                                                      struct sk_buff *skb);
  69         void            (*ccid_hc_tx_packet_recv)(struct sock *sk,
  70                                                   struct sk_buff *skb);
  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,
  76                                                   struct sk_buff *skb);
  77         void            (*ccid_hc_tx_packet_sent)(struct sock *sk,
  78                                                   int more, unsigned int len);
  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);
  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);
  91 };
  92
  93 extern struct ccid_operations ccid2_ops;
  94 #ifdef CONFIG_IP_DCCP_CCID3
  95 extern struct ccid_operations ccid3_ops;
  96 #endif
  97
  98 extern int  ccid_initialize_builtins(void);
  99 extern void ccid_cleanup_builtins(void);
 100
 101 struct ccid {
 102         struct ccid_operations *ccid_ops;
 103         char                   ccid_priv[0];
 104 };
 105
 106 static inline void *ccid_priv(const struct ccid *ccid)
 107 {
 108         return (void *)ccid->ccid_priv;
 109 }
 110
 111 extern bool ccid_support_check(u8 const *ccid_array, u8 array_len);
 112 extern int  ccid_get_builtin_ccids(u8 **ccid_array, u8 *array_len);
 113 extern int  ccid_getsockopt_builtin_ccids(struct sock *sk, int len,
 114                                           char __user *, int __user *);
 115
 116 extern struct ccid *ccid_new(const u8 id, struct sock *sk, bool rx);
 117
 118 static inline int ccid_get_current_rx_ccid(struct dccp_sock *dp)
 119 {
 120         struct ccid *ccid = dp->dccps_hc_rx_ccid;
 121
 122         if (ccid == NULL || ccid->ccid_ops == NULL)
 123                 return -1;
 124         return ccid->ccid_ops->ccid_id;
 125 }
 126
 127 static inline int ccid_get_current_tx_ccid(struct dccp_sock *dp)
 128 {
 129         struct ccid *ccid = dp->dccps_hc_tx_ccid;
 130
 131         if (ccid == NULL || ccid->ccid_ops == NULL)
 132                 return -1;
 133         return ccid->ccid_ops->ccid_id;
 134 }
 135
 136 extern void ccid_hc_rx_delete(struct ccid *ccid, struct sock *sk);
 137 extern void ccid_hc_tx_delete(struct ccid *ccid, struct sock *sk);
 138
 139 static inline int ccid_hc_tx_send_packet(struct ccid *ccid, struct sock *sk,
 140                                          struct sk_buff *skb)
 141 {
 142         int rc = 0;
 143         if (ccid->ccid_ops->ccid_hc_tx_send_packet != NULL)
 144                 rc = ccid->ccid_ops->ccid_hc_tx_send_packet(sk, skb);
 145         return rc;
 146 }
 147
 148 static inline void ccid_hc_tx_packet_sent(struct ccid *ccid, struct sock *sk,
 149                                           int more, unsigned int len)
 150 {
 151         if (ccid->ccid_ops->ccid_hc_tx_packet_sent != NULL)
 152                 ccid->ccid_ops->ccid_hc_tx_packet_sent(sk, more, len);
 153 }
 154
 155 static inline void ccid_hc_rx_packet_recv(struct ccid *ccid, struct sock *sk,
 156                                           struct sk_buff *skb)
 157 {
 158         if (ccid->ccid_ops->ccid_hc_rx_packet_recv != NULL)
 159                 ccid->ccid_ops->ccid_hc_rx_packet_recv(sk, skb);
 160 }
 161
 162 static inline void ccid_hc_tx_packet_recv(struct ccid *ccid, struct sock *sk,
 163                                           struct sk_buff *skb)
 164 {
 165         if (ccid->ccid_ops->ccid_hc_tx_packet_recv != NULL)
 166                 ccid->ccid_ops->ccid_hc_tx_packet_recv(sk, skb);
 167 }
 168
 169 static inline int ccid_hc_tx_parse_options(struct ccid *ccid, struct sock *sk,
 170                                            unsigned char option,
 171                                            unsigned char len, u16 idx,
 172                                            unsigned char* value)
 173 {
 174         int rc = 0;
 175         if (ccid->ccid_ops->ccid_hc_tx_parse_options != NULL)
 176                 rc = ccid->ccid_ops->ccid_hc_tx_parse_options(sk, option, len, idx,
 177                                                     value);
 178         return rc;
 179 }
 180
 181 static inline int ccid_hc_rx_parse_options(struct ccid *ccid, struct sock *sk,
 182                                            unsigned char option,
 183                                            unsigned char len, u16 idx,
 184                                            unsigned char* value)
 185 {
 186         int rc = 0;
 187         if (ccid->ccid_ops->ccid_hc_rx_parse_options != NULL)
 188                 rc = ccid->ccid_ops->ccid_hc_rx_parse_options(sk, option, len, idx, value);
 189         return rc;
 190 }
 191
 192 static inline int ccid_hc_rx_insert_options(struct ccid *ccid, struct sock *sk,
 193                                             struct sk_buff *skb)
 194 {
 195         if (ccid->ccid_ops->ccid_hc_rx_insert_options != NULL)
 196                 return ccid->ccid_ops->ccid_hc_rx_insert_options(sk, skb);
 197         return 0;
 198 }
 199
 200 static inline void ccid_hc_rx_get_info(struct ccid *ccid, struct sock *sk,
 201                                        struct tcp_info *info)
 202 {
 203         if (ccid->ccid_ops->ccid_hc_rx_get_info != NULL)
 204                 ccid->ccid_ops->ccid_hc_rx_get_info(sk, info);
 205 }
 206
 207 static inline void ccid_hc_tx_get_info(struct ccid *ccid, struct sock *sk,
 208                                        struct tcp_info *info)
 209 {
 210         if (ccid->ccid_ops->ccid_hc_tx_get_info != NULL)
 211                 ccid->ccid_ops->ccid_hc_tx_get_info(sk, info);
 212 }
 213
 214 static inline int ccid_hc_rx_getsockopt(struct ccid *ccid, struct sock *sk,
 215                                         const int optname, int len,
 216                                         u32 __user *optval, int __user *optlen)
 217 {
 218         int rc = -ENOPROTOOPT;
 219         if (ccid->ccid_ops->ccid_hc_rx_getsockopt != NULL)
 220                 rc = ccid->ccid_ops->ccid_hc_rx_getsockopt(sk, optname, len,
 221                                                  optval, optlen);
 222         return rc;
 223 }
 224
 225 static inline int ccid_hc_tx_getsockopt(struct ccid *ccid, struct sock *sk,
 226                                         const int optname, int len,
 227                                         u32 __user *optval, int __user *optlen)
 228 {
 229         int rc = -ENOPROTOOPT;
 230         if (ccid->ccid_ops->ccid_hc_tx_getsockopt != NULL)
 231                 rc = ccid->ccid_ops->ccid_hc_tx_getsockopt(sk, optname, len,
 232                                                  optval, optlen);
 233         return rc;
 234 }
 235 #endif /* _CCID_H */