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