include/linux/sunrpc/svc_xprt.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * linux/include/linux/sunrpc/svc_xprt.h
   4  *
   5  * RPC server transport I/O
   6  */
   7
   8 #ifndef SUNRPC_SVC_XPRT_H
   9 #define SUNRPC_SVC_XPRT_H
  10
  11 #include <linux/sunrpc/svc.h>
  12
  13 struct module;
  14
  15 struct svc_xprt_ops {
  16         struct svc_xprt *(*xpo_create)(struct svc_serv *,
  17                                        struct net *net,
  18                                        struct sockaddr *, int,
  19                                        int);
  20         struct svc_xprt *(*xpo_accept)(struct svc_xprt *);
  21         int             (*xpo_has_wspace)(struct svc_xprt *);
  22         int             (*xpo_recvfrom)(struct svc_rqst *);
  23         int             (*xpo_sendto)(struct svc_rqst *);
  24         int             (*xpo_result_payload)(struct svc_rqst *, unsigned int,
  25                                               unsigned int);
  26         void            (*xpo_release_rqst)(struct svc_rqst *);
  27         void            (*xpo_detach)(struct svc_xprt *);
  28         void            (*xpo_free)(struct svc_xprt *);
  29         void            (*xpo_secure_port)(struct svc_rqst *rqstp);
  30         void            (*xpo_kill_temp_xprt)(struct svc_xprt *);
  31 };
  32
  33 struct svc_xprt_class {
  34         const char              *xcl_name;
  35         struct module           *xcl_owner;
  36         const struct svc_xprt_ops *xcl_ops;
  37         struct list_head        xcl_list;
  38         u32                     xcl_max_payload;
  39         int                     xcl_ident;
  40 };
  41
  42 /*
  43  * This is embedded in an object that wants a callback before deleting
  44  * an xprt; intended for use by NFSv4.1, which needs to know when a
  45  * client's tcp connection (and hence possibly a backchannel) goes away.
  46  */
  47 struct svc_xpt_user {
  48         struct list_head list;
  49         void (*callback)(struct svc_xpt_user *);
  50 };
  51
  52 struct svc_xprt {
  53         struct svc_xprt_class   *xpt_class;
  54         const struct svc_xprt_ops *xpt_ops;
  55         struct kref             xpt_ref;
  56         struct list_head        xpt_list;
  57         struct list_head        xpt_ready;
  58         unsigned long           xpt_flags;
  59 #define XPT_BUSY        0               /* enqueued/receiving */
  60 #define XPT_CONN        1               /* conn pending */
  61 #define XPT_CLOSE       2               /* dead or dying */
  62 #define XPT_DATA        3               /* data pending */
  63 #define XPT_TEMP        4               /* connected transport */
  64 #define XPT_DEAD        6               /* transport closed */
  65 #define XPT_CHNGBUF     7               /* need to change snd/rcv buf sizes */
  66 #define XPT_DEFERRED    8               /* deferred request pending */
  67 #define XPT_OLD         9               /* used for xprt aging mark+sweep */
  68 #define XPT_LISTENER    10              /* listening endpoint */
  69 #define XPT_CACHE_AUTH  11              /* cache auth info */
  70 #define XPT_LOCAL       12              /* connection from loopback interface */
  71 #define XPT_KILL_TEMP   13              /* call xpo_kill_temp_xprt before closing */
  72 #define XPT_CONG_CTRL   14              /* has congestion control */
  73
  74         struct svc_serv         *xpt_server;    /* service for transport */
  75         atomic_t                xpt_reserved;   /* space on outq that is rsvd */
  76         atomic_t                xpt_nr_rqsts;   /* Number of requests */
  77         struct mutex            xpt_mutex;      /* to serialize sending data */
  78         spinlock_t              xpt_lock;       /* protects sk_deferred
  79                                                  * and xpt_auth_cache */
  80         void                    *xpt_auth_cache;/* auth cache */
  81         struct list_head        xpt_deferred;   /* deferred requests that need
  82                                                  * to be revisted */
  83         struct sockaddr_storage xpt_local;      /* local address */
  84         size_t                  xpt_locallen;   /* length of address */
  85         struct sockaddr_storage xpt_remote;     /* remote peer's address */
  86         size_t                  xpt_remotelen;  /* length of address */
  87         char                    xpt_remotebuf[INET6_ADDRSTRLEN + 10];
  88         struct list_head        xpt_users;      /* callbacks on free */
  89
  90         struct net              *xpt_net;
  91         const struct cred       *xpt_cred;
  92         struct rpc_xprt         *xpt_bc_xprt;   /* NFSv4.1 backchannel */
  93         struct rpc_xprt_switch  *xpt_bc_xps;    /* NFSv4.1 backchannel */
  94 };
  95
  96 static inline void unregister_xpt_user(struct svc_xprt *xpt, struct svc_xpt_user *u)
  97 {
  98         spin_lock(&xpt->xpt_lock);
  99         list_del_init(&u->list);
 100         spin_unlock(&xpt->xpt_lock);
 101 }
 102
 103 static inline int register_xpt_user(struct svc_xprt *xpt, struct svc_xpt_user *u)
 104 {
 105         spin_lock(&xpt->xpt_lock);
 106         if (test_bit(XPT_CLOSE, &xpt->xpt_flags)) {
 107                 /*
 108                  * The connection is about to be deleted soon (or,
 109                  * worse, may already be deleted--in which case we've
 110                  * already notified the xpt_users).
 111                  */
 112                 spin_unlock(&xpt->xpt_lock);
 113                 return -ENOTCONN;
 114         }
 115         list_add(&u->list, &xpt->xpt_users);
 116         spin_unlock(&xpt->xpt_lock);
 117         return 0;
 118 }
 119
 120 static inline bool svc_xprt_is_dead(const struct svc_xprt *xprt)
 121 {
 122         return (test_bit(XPT_DEAD, &xprt->xpt_flags) != 0) ||
 123                 (test_bit(XPT_CLOSE, &xprt->xpt_flags) != 0);
 124 }
 125
 126 int     svc_reg_xprt_class(struct svc_xprt_class *);
 127 void    svc_unreg_xprt_class(struct svc_xprt_class *);
 128 void    svc_xprt_init(struct net *, struct svc_xprt_class *, struct svc_xprt *,
 129                       struct svc_serv *);
 130 int     svc_create_xprt(struct svc_serv *, const char *, struct net *,
 131                         const int, const unsigned short, int,
 132                         const struct cred *);
 133 void    svc_xprt_received(struct svc_xprt *xprt);
 134 void    svc_xprt_do_enqueue(struct svc_xprt *xprt);
 135 void    svc_xprt_enqueue(struct svc_xprt *xprt);
 136 void    svc_xprt_put(struct svc_xprt *xprt);
 137 void    svc_xprt_copy_addrs(struct svc_rqst *rqstp, struct svc_xprt *xprt);
 138 void    svc_close_xprt(struct svc_xprt *xprt);
 139 int     svc_port_is_privileged(struct sockaddr *sin);
 140 int     svc_print_xprts(char *buf, int maxlen);
 141 struct  svc_xprt *svc_find_xprt(struct svc_serv *serv, const char *xcl_name,
 142                         struct net *net, const sa_family_t af,
 143                         const unsigned short port);
 144 int     svc_xprt_names(struct svc_serv *serv, char *buf, const int buflen);
 145 void    svc_add_new_perm_xprt(struct svc_serv *serv, struct svc_xprt *xprt);
 146 void    svc_age_temp_xprts_now(struct svc_serv *, struct sockaddr *);
 147 void    svc_xprt_deferred_close(struct svc_xprt *xprt);
 148
 149 static inline void svc_xprt_get(struct svc_xprt *xprt)
 150 {
 151         kref_get(&xprt->xpt_ref);
 152 }
 153 static inline void svc_xprt_set_local(struct svc_xprt *xprt,
 154                                       const struct sockaddr *sa,
 155                                       const size_t salen)
 156 {
 157         memcpy(&xprt->xpt_local, sa, salen);
 158         xprt->xpt_locallen = salen;
 159 }
 160 static inline void svc_xprt_set_remote(struct svc_xprt *xprt,
 161                                        const struct sockaddr *sa,
 162                                        const size_t salen)
 163 {
 164         memcpy(&xprt->xpt_remote, sa, salen);
 165         xprt->xpt_remotelen = salen;
 166         snprintf(xprt->xpt_remotebuf, sizeof(xprt->xpt_remotebuf) - 1,
 167                  "%pISpc", sa);
 168 }
 169
 170 static inline unsigned short svc_addr_port(const struct sockaddr *sa)
 171 {
 172         const struct sockaddr_in *sin = (const struct sockaddr_in *)sa;
 173         const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)sa;
 174
 175         switch (sa->sa_family) {
 176         case AF_INET:
 177                 return ntohs(sin->sin_port);
 178         case AF_INET6:
 179                 return ntohs(sin6->sin6_port);
 180         }
 181
 182         return 0;
 183 }
 184
 185 static inline size_t svc_addr_len(const struct sockaddr *sa)
 186 {
 187         switch (sa->sa_family) {
 188         case AF_INET:
 189                 return sizeof(struct sockaddr_in);
 190         case AF_INET6:
 191                 return sizeof(struct sockaddr_in6);
 192         }
 193         BUG();
 194 }
 195
 196 static inline unsigned short svc_xprt_local_port(const struct svc_xprt *xprt)
 197 {
 198         return svc_addr_port((const struct sockaddr *)&xprt->xpt_local);
 199 }
 200
 201 static inline unsigned short svc_xprt_remote_port(const struct svc_xprt *xprt)
 202 {
 203         return svc_addr_port((const struct sockaddr *)&xprt->xpt_remote);
 204 }
 205
 206 static inline char *__svc_print_addr(const struct sockaddr *addr,
 207                                      char *buf, const size_t len)
 208 {
 209         const struct sockaddr_in *sin = (const struct sockaddr_in *)addr;
 210         const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)addr;
 211
 212         switch (addr->sa_family) {
 213         case AF_INET:
 214                 snprintf(buf, len, "%pI4, port=%u", &sin->sin_addr,
 215                         ntohs(sin->sin_port));
 216                 break;
 217
 218         case AF_INET6:
 219                 snprintf(buf, len, "%pI6, port=%u",
 220                          &sin6->sin6_addr,
 221                         ntohs(sin6->sin6_port));
 222                 break;
 223
 224         default:
 225                 snprintf(buf, len, "unknown address type: %d", addr->sa_family);
 226                 break;
 227         }
 228
 229         return buf;
 230 }
 231 #endif /* SUNRPC_SVC_XPRT_H */