vsprintf: move local vars to block local vars and remove unneeded ones
[safe/jmp/linux-2.6] / net / dccp / ccid.h
index c6767b2..facedd2 100644 (file)
  */
 
 #include <net/sock.h>
+#include <linux/compiler.h>
 #include <linux/dccp.h>
 #include <linux/list.h>
 #include <linux/module.h>
 
 #define CCID_MAX 255
 
-struct ccid {
-       unsigned char   ccid_id;
-       const char      *ccid_name;
-       struct module   *ccid_owner;
-       int             (*ccid_init)(struct sock *sk);
-       void            (*ccid_exit)(struct sock *sk);
-       int             (*ccid_hc_rx_init)(struct sock *sk);
-       int             (*ccid_hc_tx_init)(struct sock *sk);
+struct tcp_info;
+
+/**
+ *  struct ccid_operations  -  Interface to Congestion-Control Infrastructure
+ *
+ *  @ccid_id: numerical CCID ID (up to %CCID_MAX, cf. table 5 in RFC 4340, 10.)
+ *  @ccid_ccmps: the CCMPS including network/transport headers (0 when disabled)
+ *  @ccid_name: alphabetical identifier string for @ccid_id
+ *  @ccid_hc_{r,t}x_slab: memory pool for the receiver/sender half-connection
+ *  @ccid_hc_{r,t}x_obj_size: size of the receiver/sender half-connection socket
+ *
+ *  @ccid_hc_{r,t}x_init: CCID-specific initialisation routine (before startup)
+ *  @ccid_hc_{r,t}x_exit: CCID-specific cleanup routine (before destruction)
+ *  @ccid_hc_rx_packet_recv: implements the HC-receiver side
+ *  @ccid_hc_{r,t}x_parse_options: parsing routine for CCID/HC-specific options
+ *  @ccid_hc_{r,t}x_insert_options: insert routine for CCID/HC-specific options
+ *  @ccid_hc_tx_packet_recv: implements feedback processing for the HC-sender
+ *  @ccid_hc_tx_send_packet: implements the sending part of the HC-sender
+ *  @ccid_hc_tx_packet_sent: does accounting for packets in flight by HC-sender
+ *  @ccid_hc_{r,t}x_get_info: INET_DIAG information for HC-receiver/sender
+ *  @ccid_hc_{r,t}x_getsockopt: socket options specific to HC-receiver/sender
+ */
+struct ccid_operations {
+       unsigned char           ccid_id;
+       __u32                   ccid_ccmps;
+       const char              *ccid_name;
+       struct kmem_cache       *ccid_hc_rx_slab,
+                               *ccid_hc_tx_slab;
+       __u32                   ccid_hc_rx_obj_size,
+                               ccid_hc_tx_obj_size;
+       /* Interface Routines */
+       int             (*ccid_hc_rx_init)(struct ccid *ccid, struct sock *sk);
+       int             (*ccid_hc_tx_init)(struct ccid *ccid, struct sock *sk);
        void            (*ccid_hc_rx_exit)(struct sock *sk);
        void            (*ccid_hc_tx_exit)(struct sock *sk);
        void            (*ccid_hc_rx_packet_recv)(struct sock *sk,
@@ -36,9 +62,7 @@ struct ccid {
                                                    unsigned char option,
                                                    unsigned char len, u16 idx,
                                                    unsigned char* value);
-       void            (*ccid_hc_rx_insert_options)(struct sock *sk,
-                                                    struct sk_buff *skb);
-       void            (*ccid_hc_tx_insert_options)(struct sock *sk,
+       int             (*ccid_hc_rx_insert_options)(struct sock *sk,
                                                     struct sk_buff *skb);
        void            (*ccid_hc_tx_packet_recv)(struct sock *sk,
                                                  struct sk_buff *skb);
@@ -47,80 +71,97 @@ struct ccid {
                                                    unsigned char len, u16 idx,
                                                    unsigned char* value);
        int             (*ccid_hc_tx_send_packet)(struct sock *sk,
-                                                 struct sk_buff *skb, int len);
-       void            (*ccid_hc_tx_packet_sent)(struct sock *sk, int more,
-                                                 int len);
+                                                 struct sk_buff *skb);
+       void            (*ccid_hc_tx_packet_sent)(struct sock *sk,
+                                                 int more, unsigned int len);
+       void            (*ccid_hc_rx_get_info)(struct sock *sk,
+                                              struct tcp_info *info);
+       void            (*ccid_hc_tx_get_info)(struct sock *sk,
+                                              struct tcp_info *info);
+       int             (*ccid_hc_rx_getsockopt)(struct sock *sk,
+                                                const int optname, int len,
+                                                u32 __user *optval,
+                                                int __user *optlen);
+       int             (*ccid_hc_tx_getsockopt)(struct sock *sk,
+                                                const int optname, int len,
+                                                u32 __user *optval,
+                                                int __user *optlen);
 };
 
-extern int        ccid_register(struct ccid *ccid);
-extern int        ccid_unregister(struct ccid *ccid);
+extern struct ccid_operations ccid2_ops;
+#ifdef CONFIG_IP_DCCP_CCID3
+extern struct ccid_operations ccid3_ops;
+#endif
 
-extern struct ccid *ccid_init(unsigned char id, struct sock *sk);
-extern void       ccid_exit(struct ccid *ccid, struct sock *sk);
+extern int  ccid_initialize_builtins(void);
+extern void ccid_cleanup_builtins(void);
 
-static inline void __ccid_get(struct ccid *ccid)
-{
-       __module_get(ccid->ccid_owner);
-}
+struct ccid {
+       struct ccid_operations *ccid_ops;
+       char                   ccid_priv[0];
+};
 
-static inline int ccid_hc_tx_send_packet(struct ccid *ccid, struct sock *sk,
-                                        struct sk_buff *skb, int len)
+static inline void *ccid_priv(const struct ccid *ccid)
 {
-       int rc = 0;
-       if (ccid->ccid_hc_tx_send_packet != NULL)
-               rc = ccid->ccid_hc_tx_send_packet(sk, skb, len);
-       return rc;
+       return (void *)ccid->ccid_priv;
 }
 
-static inline void ccid_hc_tx_packet_sent(struct ccid *ccid, struct sock *sk,
-                                         int more, int len)
+extern bool ccid_support_check(u8 const *ccid_array, u8 array_len);
+extern int  ccid_get_builtin_ccids(u8 **ccid_array, u8 *array_len);
+extern int  ccid_getsockopt_builtin_ccids(struct sock *sk, int len,
+                                         char __user *, int __user *);
+
+extern struct ccid *ccid_new(const u8 id, struct sock *sk, bool rx);
+
+static inline int ccid_get_current_rx_ccid(struct dccp_sock *dp)
 {
-       if (ccid->ccid_hc_tx_packet_sent != NULL)
-               ccid->ccid_hc_tx_packet_sent(sk, more, len);
+       struct ccid *ccid = dp->dccps_hc_rx_ccid;
+
+       if (ccid == NULL || ccid->ccid_ops == NULL)
+               return -1;
+       return ccid->ccid_ops->ccid_id;
 }
 
-static inline int ccid_hc_rx_init(struct ccid *ccid, struct sock *sk)
+static inline int ccid_get_current_tx_ccid(struct dccp_sock *dp)
 {
-       int rc = 0;
-       if (ccid->ccid_hc_rx_init != NULL)
-               rc = ccid->ccid_hc_rx_init(sk);
-       return rc;
+       struct ccid *ccid = dp->dccps_hc_tx_ccid;
+
+       if (ccid == NULL || ccid->ccid_ops == NULL)
+               return -1;
+       return ccid->ccid_ops->ccid_id;
 }
 
-static inline int ccid_hc_tx_init(struct ccid *ccid, struct sock *sk)
+extern void ccid_hc_rx_delete(struct ccid *ccid, struct sock *sk);
+extern void ccid_hc_tx_delete(struct ccid *ccid, struct sock *sk);
+
+static inline int ccid_hc_tx_send_packet(struct ccid *ccid, struct sock *sk,
+                                        struct sk_buff *skb)
 {
        int rc = 0;
-       if (ccid->ccid_hc_tx_init != NULL)
-               rc = ccid->ccid_hc_tx_init(sk);
+       if (ccid->ccid_ops->ccid_hc_tx_send_packet != NULL)
+               rc = ccid->ccid_ops->ccid_hc_tx_send_packet(sk, skb);
        return rc;
 }
 
-static inline void ccid_hc_rx_exit(struct ccid *ccid, struct sock *sk)
-{
-       if (ccid->ccid_hc_rx_exit != NULL &&
-           dccp_sk(sk)->dccps_hc_rx_ccid_private != NULL)
-               ccid->ccid_hc_rx_exit(sk);
-}
-
-static inline void ccid_hc_tx_exit(struct ccid *ccid, struct sock *sk)
+static inline void ccid_hc_tx_packet_sent(struct ccid *ccid, struct sock *sk,
+                                         int more, unsigned int len)
 {
-       if (ccid->ccid_hc_tx_exit != NULL &&
-           dccp_sk(sk)->dccps_hc_tx_ccid_private != NULL)
-               ccid->ccid_hc_tx_exit(sk);
+       if (ccid->ccid_ops->ccid_hc_tx_packet_sent != NULL)
+               ccid->ccid_ops->ccid_hc_tx_packet_sent(sk, more, len);
 }
 
 static inline void ccid_hc_rx_packet_recv(struct ccid *ccid, struct sock *sk,
                                          struct sk_buff *skb)
 {
-       if (ccid->ccid_hc_rx_packet_recv != NULL)
-               ccid->ccid_hc_rx_packet_recv(sk, skb);
+       if (ccid->ccid_ops->ccid_hc_rx_packet_recv != NULL)
+               ccid->ccid_ops->ccid_hc_rx_packet_recv(sk, skb);
 }
 
 static inline void ccid_hc_tx_packet_recv(struct ccid *ccid, struct sock *sk,
                                          struct sk_buff *skb)
 {
-       if (ccid->ccid_hc_tx_packet_recv != NULL)
-               ccid->ccid_hc_tx_packet_recv(sk, skb);
+       if (ccid->ccid_ops->ccid_hc_tx_packet_recv != NULL)
+               ccid->ccid_ops->ccid_hc_tx_packet_recv(sk, skb);
 }
 
 static inline int ccid_hc_tx_parse_options(struct ccid *ccid, struct sock *sk,
@@ -129,8 +170,8 @@ static inline int ccid_hc_tx_parse_options(struct ccid *ccid, struct sock *sk,
                                           unsigned char* value)
 {
        int rc = 0;
-       if (ccid->ccid_hc_tx_parse_options != NULL)
-               rc = ccid->ccid_hc_tx_parse_options(sk, option, len, idx,
+       if (ccid->ccid_ops->ccid_hc_tx_parse_options != NULL)
+               rc = ccid->ccid_ops->ccid_hc_tx_parse_options(sk, option, len, idx,
                                                    value);
        return rc;
 }
@@ -141,22 +182,52 @@ static inline int ccid_hc_rx_parse_options(struct ccid *ccid, struct sock *sk,
                                           unsigned char* value)
 {
        int rc = 0;
-       if (ccid->ccid_hc_rx_parse_options != NULL)
-               rc = ccid->ccid_hc_rx_parse_options(sk, option, len, idx, value);
+       if (ccid->ccid_ops->ccid_hc_rx_parse_options != NULL)
+               rc = ccid->ccid_ops->ccid_hc_rx_parse_options(sk, option, len, idx, value);
        return rc;
 }
 
-static inline void ccid_hc_tx_insert_options(struct ccid *ccid, struct sock *sk,
-                                            struct sk_buff *skb)
+static inline int ccid_hc_rx_insert_options(struct ccid *ccid, struct sock *sk,
+                                           struct sk_buff *skb)
 {
-       if (ccid->ccid_hc_tx_insert_options != NULL)
-               ccid->ccid_hc_tx_insert_options(sk, skb);
+       if (ccid->ccid_ops->ccid_hc_rx_insert_options != NULL)
+               return ccid->ccid_ops->ccid_hc_rx_insert_options(sk, skb);
+       return 0;
 }
 
-static inline void ccid_hc_rx_insert_options(struct ccid *ccid, struct sock *sk,
-                                            struct sk_buff *skb)
+static inline void ccid_hc_rx_get_info(struct ccid *ccid, struct sock *sk,
+                                      struct tcp_info *info)
 {
-       if (ccid->ccid_hc_rx_insert_options != NULL)
-               ccid->ccid_hc_rx_insert_options(sk, skb);
+       if (ccid->ccid_ops->ccid_hc_rx_get_info != NULL)
+               ccid->ccid_ops->ccid_hc_rx_get_info(sk, info);
+}
+
+static inline void ccid_hc_tx_get_info(struct ccid *ccid, struct sock *sk,
+                                      struct tcp_info *info)
+{
+       if (ccid->ccid_ops->ccid_hc_tx_get_info != NULL)
+               ccid->ccid_ops->ccid_hc_tx_get_info(sk, info);
+}
+
+static inline int ccid_hc_rx_getsockopt(struct ccid *ccid, struct sock *sk,
+                                       const int optname, int len,
+                                       u32 __user *optval, int __user *optlen)
+{
+       int rc = -ENOPROTOOPT;
+       if (ccid->ccid_ops->ccid_hc_rx_getsockopt != NULL)
+               rc = ccid->ccid_ops->ccid_hc_rx_getsockopt(sk, optname, len,
+                                                optval, optlen);
+       return rc;
+}
+
+static inline int ccid_hc_tx_getsockopt(struct ccid *ccid, struct sock *sk,
+                                       const int optname, int len,
+                                       u32 __user *optval, int __user *optlen)
+{
+       int rc = -ENOPROTOOPT;
+       if (ccid->ccid_ops->ccid_hc_tx_getsockopt != NULL)
+               rc = ccid->ccid_ops->ccid_hc_tx_getsockopt(sk, optname, len,
+                                                optval, optlen);
+       return rc;
 }
 #endif /* _CCID_H */