include/linux/sunrpc/svc_xprt.h

   1 /*
   2  * linux/include/linux/sunrpc/svc_xprt.h
   3  *
   4  * RPC server transport I/O
   5  */
   6
   7 #ifndef SUNRPC_SVC_XPRT_H
   8 #define SUNRPC_SVC_XPRT_H
   9
  10 #include <linux/sunrpc/svc.h>
  11 #include <linux/module.h>
  12
  13 struct svc_xprt_ops {
  14         struct svc_xprt *(*xpo_create)(struct svc_serv *,
  15                                        struct net *net,
  16                                        struct sockaddr *, int,
  17                                        int);
  18         struct svc_xprt *(*xpo_accept)(struct svc_xprt *);
  19         int             (*xpo_has_wspace)(struct svc_xprt *);
  20         int             (*xpo_recvfrom)(struct svc_rqst *);
  21         void            (*xpo_prep_reply_hdr)(struct svc_rqst *);
  22         int             (*xpo_sendto)(struct svc_rqst *);
  23         void            (*xpo_release_rqst)(struct svc_rqst *);
  24         void            (*xpo_detach)(struct svc_xprt *);
  25         void            (*xpo_free)(struct svc_xprt *);
  26 };
  27
  28 struct svc_xprt_class {
  29         const char              *xcl_name;
  30         struct module           *xcl_owner;
  31         struct svc_xprt_ops     *xcl_ops;
  32         struct list_head        xcl_list;
  33         u32                     xcl_max_payload;
  34 };
  35
  36 struct svc_xprt {
  37         struct svc_xprt_class   *xpt_class;
  38         struct svc_xprt_ops     *xpt_ops;
  39         struct kref             xpt_ref;
  40         struct list_head        xpt_list;
  41         struct list_head        xpt_ready;
  42         unsigned long           xpt_flags;
  43 #define XPT_BUSY        0               /* enqueued/receiving */
  44 #define XPT_CONN        1               /* conn pending */
  45 #define XPT_CLOSE       2               /* dead or dying */
  46 #define XPT_DATA        3               /* data pending */
  47 #define XPT_TEMP        4               /* connected transport */
  48 #define XPT_DEAD        6               /* transport closed */
  49 #define XPT_CHNGBUF     7               /* need to change snd/rcv buf sizes */
  50 #define XPT_DEFERRED    8               /* deferred request pending */
  51 #define XPT_OLD         9               /* used for xprt aging mark+sweep */
  52 #define XPT_DETACHED    10              /* detached from tempsocks list */
  53 #define XPT_LISTENER    11              /* listening endpoint */
  54 #define XPT_CACHE_AUTH  12              /* cache auth info */
  55
  56         struct svc_pool         *xpt_pool;      /* current pool iff queued */
  57         struct svc_serv         *xpt_server;    /* service for transport */
  58         atomic_t                xpt_reserved;   /* space on outq that is rsvd */
  59         struct mutex            xpt_mutex;      /* to serialize sending data */
  60         spinlock_t              xpt_lock;       /* protects sk_deferred
  61                                                  * and xpt_auth_cache */
  62         void                    *xpt_auth_cache;/* auth cache */
  63         struct list_head        xpt_deferred;   /* deferred requests that need
  64                                                  * to be revisted */
  65         struct sockaddr_storage xpt_local;      /* local address */
  66         size_t                  xpt_locallen;   /* length of address */
  67         struct sockaddr_storage xpt_remote;     /* remote peer's address */
  68         size_t                  xpt_remotelen;  /* length of address */
  69         struct rpc_wait_queue   xpt_bc_pending; /* backchannel wait queue */
  70
  71         struct net              *xpt_net;
  72 };
  73
  74 int     svc_reg_xprt_class(struct svc_xprt_class *);
  75 void    svc_unreg_xprt_class(struct svc_xprt_class *);
  76 void    svc_xprt_init(struct svc_xprt_class *, struct svc_xprt *,
  77                       struct svc_serv *);
  78 int     svc_create_xprt(struct svc_serv *, const char *, struct net *,
  79                         const int, const unsigned short, int);
  80 void    svc_xprt_enqueue(struct svc_xprt *xprt);
  81 void    svc_xprt_received(struct svc_xprt *);
  82 void    svc_xprt_put(struct svc_xprt *xprt);
  83 void    svc_xprt_copy_addrs(struct svc_rqst *rqstp, struct svc_xprt *xprt);
  84 void    svc_close_xprt(struct svc_xprt *xprt);
  85 void    svc_delete_xprt(struct svc_xprt *xprt);
  86 int     svc_port_is_privileged(struct sockaddr *sin);
  87 int     svc_print_xprts(char *buf, int maxlen);
  88 struct  svc_xprt *svc_find_xprt(struct svc_serv *serv, const char *xcl_name,
  89                         const sa_family_t af, const unsigned short port);
  90 int     svc_xprt_names(struct svc_serv *serv, char *buf, const int buflen);
  91
  92 static inline void svc_xprt_get(struct svc_xprt *xprt)
  93 {
  94         kref_get(&xprt->xpt_ref);
  95 }
  96 static inline void svc_xprt_set_local(struct svc_xprt *xprt,
  97                                       const struct sockaddr *sa,
  98                                       const size_t salen)
  99 {
 100         memcpy(&xprt->xpt_local, sa, salen);
 101         xprt->xpt_locallen = salen;
 102 }
 103 static inline void svc_xprt_set_remote(struct svc_xprt *xprt,
 104                                        const struct sockaddr *sa,
 105                                        const size_t salen)
 106 {
 107         memcpy(&xprt->xpt_remote, sa, salen);
 108         xprt->xpt_remotelen = salen;
 109 }
 110 static inline unsigned short svc_addr_port(const struct sockaddr *sa)
 111 {
 112         const struct sockaddr_in *sin = (const struct sockaddr_in *)sa;
 113         const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)sa;
 114
 115         switch (sa->sa_family) {
 116         case AF_INET:
 117                 return ntohs(sin->sin_port);
 118         case AF_INET6:
 119                 return ntohs(sin6->sin6_port);
 120         }
 121
 122         return 0;
 123 }
 124
 125 static inline size_t svc_addr_len(const struct sockaddr *sa)
 126 {
 127         switch (sa->sa_family) {
 128         case AF_INET:
 129                 return sizeof(struct sockaddr_in);
 130         case AF_INET6:
 131                 return sizeof(struct sockaddr_in6);
 132         }
 133
 134         return 0;
 135 }
 136
 137 static inline unsigned short svc_xprt_local_port(const struct svc_xprt *xprt)
 138 {
 139         return svc_addr_port((const struct sockaddr *)&xprt->xpt_local);
 140 }
 141
 142 static inline unsigned short svc_xprt_remote_port(const struct svc_xprt *xprt)
 143 {
 144         return svc_addr_port((const struct sockaddr *)&xprt->xpt_remote);
 145 }
 146
 147 static inline char *__svc_print_addr(const struct sockaddr *addr,
 148                                      char *buf, const size_t len)
 149 {
 150         const struct sockaddr_in *sin = (const struct sockaddr_in *)addr;
 151         const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)addr;
 152
 153         switch (addr->sa_family) {
 154         case AF_INET:
 155                 snprintf(buf, len, "%pI4, port=%u", &sin->sin_addr,
 156                         ntohs(sin->sin_port));
 157                 break;
 158
 159         case AF_INET6:
 160                 snprintf(buf, len, "%pI6, port=%u",
 161                          &sin6->sin6_addr,
 162                         ntohs(sin6->sin6_port));
 163                 break;
 164
 165         default:
 166                 snprintf(buf, len, "unknown address type: %d", addr->sa_family);
 167                 break;
 168         }
 169
 170         return buf;
 171 }
 172 #endif /* SUNRPC_SVC_XPRT_H */