include/linux/sunrpc/clnt.h

   1 /*
   2  *  linux/include/linux/sunrpc/clnt.h
   3  *
   4  *  Declarations for the high-level RPC client interface
   5  *
   6  *  Copyright (C) 1995, 1996, Olaf Kirch <okir@monad.swb.de>
   7  */
   8
   9 #ifndef _LINUX_SUNRPC_CLNT_H
  10 #define _LINUX_SUNRPC_CLNT_H
  11
  12 #include <linux/types.h>
  13 #include <linux/socket.h>
  14 #include <linux/in.h>
  15 #include <linux/in6.h>
  16
  17 #include <linux/sunrpc/msg_prot.h>
  18 #include <linux/sunrpc/sched.h>
  19 #include <linux/sunrpc/xprt.h>
  20 #include <linux/sunrpc/auth.h>
  21 #include <linux/sunrpc/stats.h>
  22 #include <linux/sunrpc/xdr.h>
  23 #include <linux/sunrpc/timer.h>
  24 #include <asm/signal.h>
  25 #include <linux/path.h>
  26 #include <net/ipv6.h>
  27
  28 struct rpc_inode;
  29
  30 /*
  31  * The high-level client handle
  32  */
  33 struct rpc_clnt {
  34         atomic_t                cl_count;       /* Number of references */
  35         struct list_head        cl_clients;     /* Global list of clients */
  36         struct list_head        cl_tasks;       /* List of tasks */
  37         spinlock_t              cl_lock;        /* spinlock */
  38         struct rpc_xprt *       cl_xprt;        /* transport */
  39         struct rpc_procinfo *   cl_procinfo;    /* procedure info */
  40         u32                     cl_prog,        /* RPC program number */
  41                                 cl_vers,        /* RPC version number */
  42                                 cl_maxproc;     /* max procedure number */
  43
  44         char *                  cl_server;      /* server machine name */
  45         char *                  cl_protname;    /* protocol name */
  46         struct rpc_auth *       cl_auth;        /* authenticator */
  47         struct rpc_stat *       cl_stats;       /* per-program statistics */
  48         struct rpc_iostats *    cl_metrics;     /* per-client statistics */
  49
  50         unsigned int            cl_softrtry : 1,/* soft timeouts */
  51                                 cl_discrtry : 1,/* disconnect before retry */
  52                                 cl_autobind : 1,/* use getport() */
  53                                 cl_chatty   : 1;/* be verbose */
  54
  55         struct rpc_rtt *        cl_rtt;         /* RTO estimator data */
  56         const struct rpc_timeout *cl_timeout;   /* Timeout strategy */
  57
  58         int                     cl_nodelen;     /* nodename length */
  59         char                    cl_nodename[UNX_MAXNODENAME];
  60         struct path             cl_path;
  61         struct rpc_clnt *       cl_parent;      /* Points to parent of clones */
  62         struct rpc_rtt          cl_rtt_default;
  63         struct rpc_timeout      cl_timeout_default;
  64         struct rpc_program *    cl_program;
  65         char                    cl_inline_name[32];
  66         char                    *cl_principal;  /* target to authenticate to */
  67 };
  68
  69 /*
  70  * General RPC program info
  71  */
  72 #define RPC_MAXVERSION          4
  73 struct rpc_program {
  74         char *                  name;           /* protocol name */
  75         u32                     number;         /* program number */
  76         unsigned int            nrvers;         /* number of versions */
  77         struct rpc_version **   version;        /* version array */
  78         struct rpc_stat *       stats;          /* statistics */
  79         char *                  pipe_dir_name;  /* path to rpc_pipefs dir */
  80 };
  81
  82 struct rpc_version {
  83         u32                     number;         /* version number */
  84         unsigned int            nrprocs;        /* number of procs */
  85         struct rpc_procinfo *   procs;          /* procedure array */
  86 };
  87
  88 /*
  89  * Procedure information
  90  */
  91 struct rpc_procinfo {
  92         u32                     p_proc;         /* RPC procedure number */
  93         kxdreproc_t             p_encode;       /* XDR encode function */
  94         kxdrdproc_t             p_decode;       /* XDR decode function */
  95         unsigned int            p_arglen;       /* argument hdr length (u32) */
  96         unsigned int            p_replen;       /* reply hdr length (u32) */
  97         unsigned int            p_count;        /* call count */
  98         unsigned int            p_timer;        /* Which RTT timer to use */
  99         u32                     p_statidx;      /* Which procedure to account */
 100         char *                  p_name;         /* name of procedure */
 101 };
 102
 103 #ifdef __KERNEL__
 104
 105 struct rpc_create_args {
 106         struct net              *net;
 107         int                     protocol;
 108         struct sockaddr         *address;
 109         size_t                  addrsize;
 110         struct sockaddr         *saddress;
 111         const struct rpc_timeout *timeout;
 112         char                    *servername;
 113         struct rpc_program      *program;
 114         u32                     prognumber;     /* overrides program->number */
 115         u32                     version;
 116         rpc_authflavor_t        authflavor;
 117         unsigned long           flags;
 118         char                    *client_name;
 119         struct svc_xprt         *bc_xprt;       /* NFSv4.1 backchannel */
 120 };
 121
 122 /* Values for "flags" field */
 123 #define RPC_CLNT_CREATE_HARDRTRY        (1UL << 0)
 124 #define RPC_CLNT_CREATE_AUTOBIND        (1UL << 2)
 125 #define RPC_CLNT_CREATE_NONPRIVPORT     (1UL << 3)
 126 #define RPC_CLNT_CREATE_NOPING          (1UL << 4)
 127 #define RPC_CLNT_CREATE_DISCRTRY        (1UL << 5)
 128 #define RPC_CLNT_CREATE_QUIET           (1UL << 6)
 129
 130 struct rpc_clnt *rpc_create(struct rpc_create_args *args);
 131 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *,
 132                                 struct rpc_program *, u32);
 133 void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt);
 134 struct rpc_clnt *rpc_clone_client(struct rpc_clnt *);
 135 void            rpc_shutdown_client(struct rpc_clnt *);
 136 void            rpc_release_client(struct rpc_clnt *);
 137 void            rpc_task_release_client(struct rpc_task *);
 138
 139 int             rpcb_create_local(void);
 140 void            rpcb_put_local(void);
 141 int             rpcb_register(u32, u32, int, unsigned short);
 142 int             rpcb_v4_register(const u32 program, const u32 version,
 143                                  const struct sockaddr *address,
 144                                  const char *netid);
 145 void            rpcb_getport_async(struct rpc_task *);
 146
 147 void            rpc_call_start(struct rpc_task *);
 148 int             rpc_call_async(struct rpc_clnt *clnt,
 149                                const struct rpc_message *msg, int flags,
 150                                const struct rpc_call_ops *tk_ops,
 151                                void *calldata);
 152 int             rpc_call_sync(struct rpc_clnt *clnt,
 153                               const struct rpc_message *msg, int flags);
 154 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred,
 155                                int flags);
 156 int             rpc_restart_call_prepare(struct rpc_task *);
 157 int             rpc_restart_call(struct rpc_task *);
 158 void            rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int);
 159 size_t          rpc_max_payload(struct rpc_clnt *);
 160 void            rpc_force_rebind(struct rpc_clnt *);
 161 size_t          rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t);
 162 const char      *rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t);
 163
 164 size_t          rpc_ntop(const struct sockaddr *, char *, const size_t);
 165 size_t          rpc_pton(const char *, const size_t,
 166                          struct sockaddr *, const size_t);
 167 char *          rpc_sockaddr2uaddr(const struct sockaddr *, gfp_t);
 168 size_t          rpc_uaddr2sockaddr(const char *, const size_t,
 169                                    struct sockaddr *, const size_t);
 170
 171 static inline unsigned short rpc_get_port(const struct sockaddr *sap)
 172 {
 173         switch (sap->sa_family) {
 174         case AF_INET:
 175                 return ntohs(((struct sockaddr_in *)sap)->sin_port);
 176         case AF_INET6:
 177                 return ntohs(((struct sockaddr_in6 *)sap)->sin6_port);
 178         }
 179         return 0;
 180 }
 181
 182 static inline void rpc_set_port(struct sockaddr *sap,
 183                                 const unsigned short port)
 184 {
 185         switch (sap->sa_family) {
 186         case AF_INET:
 187                 ((struct sockaddr_in *)sap)->sin_port = htons(port);
 188                 break;
 189         case AF_INET6:
 190                 ((struct sockaddr_in6 *)sap)->sin6_port = htons(port);
 191                 break;
 192         }
 193 }
 194
 195 #define IPV6_SCOPE_DELIMITER            '%'
 196 #define IPV6_SCOPE_ID_LEN               sizeof("%nnnnnnnnnn")
 197
 198 static inline bool __rpc_cmp_addr4(const struct sockaddr *sap1,
 199                                    const struct sockaddr *sap2)
 200 {
 201         const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sap1;
 202         const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sap2;
 203
 204         return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
 205 }
 206
 207 static inline bool __rpc_copy_addr4(struct sockaddr *dst,
 208                                     const struct sockaddr *src)
 209 {
 210         const struct sockaddr_in *ssin = (struct sockaddr_in *) src;
 211         struct sockaddr_in *dsin = (struct sockaddr_in *) dst;
 212
 213         dsin->sin_family = ssin->sin_family;
 214         dsin->sin_addr.s_addr = ssin->sin_addr.s_addr;
 215         return true;
 216 }
 217
 218 #if IS_ENABLED(CONFIG_IPV6)
 219 static inline bool __rpc_cmp_addr6(const struct sockaddr *sap1,
 220                                    const struct sockaddr *sap2)
 221 {
 222         const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sap1;
 223         const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sap2;
 224
 225         if (!ipv6_addr_equal(&sin1->sin6_addr, &sin2->sin6_addr))
 226                 return false;
 227         else if (ipv6_addr_type(&sin1->sin6_addr) & IPV6_ADDR_LINKLOCAL)
 228                 return sin1->sin6_scope_id == sin2->sin6_scope_id;
 229
 230         return true;
 231 }
 232
 233 static inline bool __rpc_copy_addr6(struct sockaddr *dst,
 234                                     const struct sockaddr *src)
 235 {
 236         const struct sockaddr_in6 *ssin6 = (const struct sockaddr_in6 *) src;
 237         struct sockaddr_in6 *dsin6 = (struct sockaddr_in6 *) dst;
 238
 239         dsin6->sin6_family = ssin6->sin6_family;
 240         dsin6->sin6_addr = ssin6->sin6_addr;
 241         return true;
 242 }
 243 #else   /* !(IS_ENABLED(CONFIG_IPV6) */
 244 static inline bool __rpc_cmp_addr6(const struct sockaddr *sap1,
 245                                    const struct sockaddr *sap2)
 246 {
 247         return false;
 248 }
 249
 250 static inline bool __rpc_copy_addr6(struct sockaddr *dst,
 251                                     const struct sockaddr *src)
 252 {
 253         return false;
 254 }
 255 #endif  /* !(IS_ENABLED(CONFIG_IPV6) */
 256
 257 /**
 258  * rpc_cmp_addr - compare the address portion of two sockaddrs.
 259  * @sap1: first sockaddr
 260  * @sap2: second sockaddr
 261  *
 262  * Just compares the family and address portion. Ignores port, scope, etc.
 263  * Returns true if the addrs are equal, false if they aren't.
 264  */
 265 static inline bool rpc_cmp_addr(const struct sockaddr *sap1,
 266                                 const struct sockaddr *sap2)
 267 {
 268         if (sap1->sa_family == sap2->sa_family) {
 269                 switch (sap1->sa_family) {
 270                 case AF_INET:
 271                         return __rpc_cmp_addr4(sap1, sap2);
 272                 case AF_INET6:
 273                         return __rpc_cmp_addr6(sap1, sap2);
 274                 }
 275         }
 276         return false;
 277 }
 278
 279 /**
 280  * rpc_copy_addr - copy the address portion of one sockaddr to another
 281  * @dst: destination sockaddr
 282  * @src: source sockaddr
 283  *
 284  * Just copies the address portion and family. Ignores port, scope, etc.
 285  * Caller is responsible for making certain that dst is large enough to hold
 286  * the address in src. Returns true if address family is supported. Returns
 287  * false otherwise.
 288  */
 289 static inline bool rpc_copy_addr(struct sockaddr *dst,
 290                                  const struct sockaddr *src)
 291 {
 292         switch (src->sa_family) {
 293         case AF_INET:
 294                 return __rpc_copy_addr4(dst, src);
 295         case AF_INET6:
 296                 return __rpc_copy_addr6(dst, src);
 297         }
 298         return false;
 299 }
 300
 301 /**
 302  * rpc_get_scope_id - return scopeid for a given sockaddr
 303  * @sa: sockaddr to get scopeid from
 304  *
 305  * Returns the value of the sin6_scope_id for AF_INET6 addrs, or 0 if
 306  * not an AF_INET6 address.
 307  */
 308 static inline u32 rpc_get_scope_id(const struct sockaddr *sa)
 309 {
 310         if (sa->sa_family != AF_INET6)
 311                 return 0;
 312
 313         return ((struct sockaddr_in6 *) sa)->sin6_scope_id;
 314 }
 315
 316 #endif /* __KERNEL__ */
 317 #endif /* _LINUX_SUNRPC_CLNT_H */