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