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_name: alphabetical identifier string for @ccid_id
  31  *  @ccid_owner: module which implements/owns this CCID
  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         const char              *ccid_name;
  49         struct module           *ccid_owner;
  50         struct kmem_cache       *ccid_hc_rx_slab,
  51                                 *ccid_hc_tx_slab;
  52         __u32                   ccid_hc_rx_obj_size,
  53                                 ccid_hc_tx_obj_size;
  54         /* Interface Routines */
  55         int             (*ccid_hc_rx_init)(struct ccid *ccid, struct sock *sk);
  56         int             (*ccid_hc_tx_init)(struct ccid *ccid, struct sock *sk);
  57         void            (*ccid_hc_rx_exit)(struct sock *sk);
  58         void            (*ccid_hc_tx_exit)(struct sock *sk);
  59         void            (*ccid_hc_rx_packet_recv)(struct sock *sk,
  60                                                   struct sk_buff *skb);
  61         int             (*ccid_hc_rx_parse_options)(struct sock *sk,
  62                                                     unsigned char option,
  63                                                     unsigned char len, u16 idx,
  64                                                     unsigned char* value);
  65         int             (*ccid_hc_rx_insert_options)(struct sock *sk,
  66                                                      struct sk_buff *skb);
  67         void            (*ccid_hc_tx_packet_recv)(struct sock *sk,
  68                                                   struct sk_buff *skb);
  69         int             (*ccid_hc_tx_parse_options)(struct sock *sk,
  70                                                     unsigned char option,
  71                                                     unsigned char len, u16 idx,
  72                                                     unsigned char* value);
  73         int             (*ccid_hc_tx_send_packet)(struct sock *sk,
  74                                                   struct sk_buff *skb);
  75         void            (*ccid_hc_tx_packet_sent)(struct sock *sk,
  76                                                   int more, unsigned int len);
  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);
  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);
  89 };
  90
  91 extern int ccid_register(struct ccid_operations *ccid_ops);
  92 extern int ccid_unregister(struct ccid_operations *ccid_ops);
  93
  94 struct ccid {
  95         struct ccid_operations *ccid_ops;
  96         char                   ccid_priv[0];
  97 };
  98
  99 static inline void *ccid_priv(const struct ccid *ccid)
 100 {
 101         return (void *)ccid->ccid_priv;
 102 }
 103
 104 extern struct ccid *ccid_new(unsigned char id, struct sock *sk, int rx,
 105                              gfp_t gfp);
 106
 107 extern struct ccid *ccid_hc_rx_new(unsigned char id, struct sock *sk,
 108                                    gfp_t gfp);
 109 extern struct ccid *ccid_hc_tx_new(unsigned char id, struct sock *sk,
 110                                    gfp_t gfp);
 111
 112 extern void ccid_hc_rx_delete(struct ccid *ccid, struct sock *sk);
 113 extern void ccid_hc_tx_delete(struct ccid *ccid, struct sock *sk);
 114
 115 static inline int ccid_hc_tx_send_packet(struct ccid *ccid, struct sock *sk,
 116                                          struct sk_buff *skb)
 117 {
 118         int rc = 0;
 119         if (ccid->ccid_ops->ccid_hc_tx_send_packet != NULL)
 120                 rc = ccid->ccid_ops->ccid_hc_tx_send_packet(sk, skb);
 121         return rc;
 122 }
 123
 124 static inline void ccid_hc_tx_packet_sent(struct ccid *ccid, struct sock *sk,
 125                                           int more, unsigned int len)
 126 {
 127         if (ccid->ccid_ops->ccid_hc_tx_packet_sent != NULL)
 128                 ccid->ccid_ops->ccid_hc_tx_packet_sent(sk, more, len);
 129 }
 130
 131 static inline void ccid_hc_rx_packet_recv(struct ccid *ccid, struct sock *sk,
 132                                           struct sk_buff *skb)
 133 {
 134         if (ccid->ccid_ops->ccid_hc_rx_packet_recv != NULL)
 135                 ccid->ccid_ops->ccid_hc_rx_packet_recv(sk, skb);
 136 }
 137
 138 static inline void ccid_hc_tx_packet_recv(struct ccid *ccid, struct sock *sk,
 139                                           struct sk_buff *skb)
 140 {
 141         if (ccid->ccid_ops->ccid_hc_tx_packet_recv != NULL)
 142                 ccid->ccid_ops->ccid_hc_tx_packet_recv(sk, skb);
 143 }
 144
 145 static inline int ccid_hc_tx_parse_options(struct ccid *ccid, struct sock *sk,
 146                                            unsigned char option,
 147                                            unsigned char len, u16 idx,
 148                                            unsigned char* value)
 149 {
 150         int rc = 0;
 151         if (ccid->ccid_ops->ccid_hc_tx_parse_options != NULL)
 152                 rc = ccid->ccid_ops->ccid_hc_tx_parse_options(sk, option, len, idx,
 153                                                     value);
 154         return rc;
 155 }
 156
 157 static inline int ccid_hc_rx_parse_options(struct ccid *ccid, struct sock *sk,
 158                                            unsigned char option,
 159                                            unsigned char len, u16 idx,
 160                                            unsigned char* value)
 161 {
 162         int rc = 0;
 163         if (ccid->ccid_ops->ccid_hc_rx_parse_options != NULL)
 164                 rc = ccid->ccid_ops->ccid_hc_rx_parse_options(sk, option, len, idx, value);
 165         return rc;
 166 }
 167
 168 static inline int ccid_hc_rx_insert_options(struct ccid *ccid, struct sock *sk,
 169                                             struct sk_buff *skb)
 170 {
 171         if (ccid->ccid_ops->ccid_hc_rx_insert_options != NULL)
 172                 return ccid->ccid_ops->ccid_hc_rx_insert_options(sk, skb);
 173         return 0;
 174 }
 175
 176 static inline void ccid_hc_rx_get_info(struct ccid *ccid, struct sock *sk,
 177                                        struct tcp_info *info)
 178 {
 179         if (ccid->ccid_ops->ccid_hc_rx_get_info != NULL)
 180                 ccid->ccid_ops->ccid_hc_rx_get_info(sk, info);
 181 }
 182
 183 static inline void ccid_hc_tx_get_info(struct ccid *ccid, struct sock *sk,
 184                                        struct tcp_info *info)
 185 {
 186         if (ccid->ccid_ops->ccid_hc_tx_get_info != NULL)
 187                 ccid->ccid_ops->ccid_hc_tx_get_info(sk, info);
 188 }
 189
 190 static inline int ccid_hc_rx_getsockopt(struct ccid *ccid, struct sock *sk,
 191                                         const int optname, int len,
 192                                         u32 __user *optval, int __user *optlen)
 193 {
 194         int rc = -ENOPROTOOPT;
 195         if (ccid->ccid_ops->ccid_hc_rx_getsockopt != NULL)
 196                 rc = ccid->ccid_ops->ccid_hc_rx_getsockopt(sk, optname, len,
 197                                                  optval, optlen);
 198         return rc;
 199 }
 200
 201 static inline int ccid_hc_tx_getsockopt(struct ccid *ccid, struct sock *sk,
 202                                         const int optname, int len,
 203                                         u32 __user *optval, int __user *optlen)
 204 {
 205         int rc = -ENOPROTOOPT;
 206         if (ccid->ccid_ops->ccid_hc_tx_getsockopt != NULL)
 207                 rc = ccid->ccid_ops->ccid_hc_tx_getsockopt(sk, optname, len,
 208                                                  optval, optlen);
 209         return rc;
 210 }
 211 #endif /* _CCID_H */