linux/sunrpc/clnt.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /*
0003  *  linux/include/linux/sunrpc/clnt.h
0004  *
0005  *  Declarations for the high-level RPC client interface
0006  *
0007  *  Copyright (C) 1995, 1996, Olaf Kirch <okir@monad.swb.de>
0008  */
0009
0010 #ifndef _LINUX_SUNRPC_CLNT_H
0011 #define _LINUX_SUNRPC_CLNT_H
0012
0013 #include <linux/types.h>
0014 #include <linux/socket.h>
0015 #include <linux/in.h>
0016 #include <linux/in6.h>
0017 #include <linux/refcount.h>
0018
0019 #include <linux/sunrpc/msg_prot.h>
0020 #include <linux/sunrpc/sched.h>
0021 #include <linux/sunrpc/xprt.h>
0022 #include <linux/sunrpc/auth.h>
0023 #include <linux/sunrpc/stats.h>
0024 #include <linux/sunrpc/xdr.h>
0025 #include <linux/sunrpc/timer.h>
0026 #include <linux/sunrpc/rpc_pipe_fs.h>
0027 #include <asm/signal.h>
0028 #include <linux/path.h>
0029 #include <net/ipv6.h>
0030 #include <linux/sunrpc/xprtmultipath.h>
0031
0032 struct rpc_inode;
0033 struct rpc_sysfs_client;
0034
0035 /*
0036  * The high-level client handle
0037  */
0038 struct rpc_clnt {
0039     refcount_t      cl_count;   /* Number of references */
0040     unsigned int        cl_clid;    /* client id */
0041     struct list_head    cl_clients; /* Global list of clients */
0042     struct list_head    cl_tasks;   /* List of tasks */
0043     atomic_t        cl_pid;     /* task PID counter */
0044     spinlock_t      cl_lock;    /* spinlock */
0045     struct rpc_xprt __rcu * cl_xprt;    /* transport */
0046     const struct rpc_procinfo *cl_procinfo; /* procedure info */
0047     u32         cl_prog,    /* RPC program number */
0048                 cl_vers,    /* RPC version number */
0049                 cl_maxproc; /* max procedure number */
0050
0051     struct rpc_auth *   cl_auth;    /* authenticator */
0052     struct rpc_stat *   cl_stats;   /* per-program statistics */
0053     struct rpc_iostats *    cl_metrics; /* per-client statistics */
0054
0055     unsigned int        cl_softrtry : 1,/* soft timeouts */
0056                 cl_softerr  : 1,/* Timeouts return errors */
0057                 cl_discrtry : 1,/* disconnect before retry */
0058                 cl_noretranstimeo: 1,/* No retransmit timeouts */
0059                 cl_autobind : 1,/* use getport() */
0060                 cl_chatty   : 1;/* be verbose */
0061
0062     struct rpc_rtt *    cl_rtt;     /* RTO estimator data */
0063     const struct rpc_timeout *cl_timeout;   /* Timeout strategy */
0064
0065     atomic_t        cl_swapper; /* swapfile count */
0066     int         cl_nodelen; /* nodename length */
0067     char            cl_nodename[UNX_MAXNODENAME+1];
0068     struct rpc_pipe_dir_head cl_pipedir_objects;
0069     struct rpc_clnt *   cl_parent;  /* Points to parent of clones */
0070     struct rpc_rtt      cl_rtt_default;
0071     struct rpc_timeout  cl_timeout_default;
0072     const struct rpc_program *cl_program;
0073     const char *        cl_principal;   /* use for machine cred */
0074 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
0075     struct dentry       *cl_debugfs;    /* debugfs directory */
0076 #endif
0077     struct rpc_sysfs_client *cl_sysfs;  /* sysfs directory */
0078     /* cl_work is only needed after cl_xpi is no longer used,
0079      * and that are of similar size
0080      */
0081     union {
0082         struct rpc_xprt_iter    cl_xpi;
0083         struct work_struct  cl_work;
0084     };
0085     const struct cred   *cl_cred;
0086     unsigned int        cl_max_connect; /* max number of transports not to the same IP */
0087 };
0088
0089 /*
0090  * General RPC program info
0091  */
0092 #define RPC_MAXVERSION      4
0093 struct rpc_program {
0094     const char *        name;       /* protocol name */
0095     u32         number;     /* program number */
0096     unsigned int        nrvers;     /* number of versions */
0097     const struct rpc_version ** version;    /* version array */
0098     struct rpc_stat *   stats;      /* statistics */
0099     const char *        pipe_dir_name;  /* path to rpc_pipefs dir */
0100 };
0101
0102 struct rpc_version {
0103     u32         number;     /* version number */
0104     unsigned int        nrprocs;    /* number of procs */
0105     const struct rpc_procinfo *procs;   /* procedure array */
0106     unsigned int        *counts;    /* call counts */
0107 };
0108
0109 /*
0110  * Procedure information
0111  */
0112 struct rpc_procinfo {
0113     u32         p_proc;     /* RPC procedure number */
0114     kxdreproc_t     p_encode;   /* XDR encode function */
0115     kxdrdproc_t     p_decode;   /* XDR decode function */
0116     unsigned int        p_arglen;   /* argument hdr length (u32) */
0117     unsigned int        p_replen;   /* reply hdr length (u32) */
0118     unsigned int        p_timer;    /* Which RTT timer to use */
0119     u32         p_statidx;  /* Which procedure to account */
0120     const char *        p_name;     /* name of procedure */
0121 };
0122
0123 struct rpc_create_args {
0124     struct net      *net;
0125     int         protocol;
0126     struct sockaddr     *address;
0127     size_t          addrsize;
0128     struct sockaddr     *saddress;
0129     const struct rpc_timeout *timeout;
0130     const char      *servername;
0131     const char      *nodename;
0132     const struct rpc_program *program;
0133     u32         prognumber; /* overrides program->number */
0134     u32         version;
0135     rpc_authflavor_t    authflavor;
0136     u32         nconnect;
0137     unsigned long       flags;
0138     char            *client_name;
0139     struct svc_xprt     *bc_xprt;   /* NFSv4.1 backchannel */
0140     const struct cred   *cred;
0141     unsigned int        max_connect;
0142 };
0143
0144 struct rpc_add_xprt_test {
0145     void (*add_xprt_test)(struct rpc_clnt *clnt,
0146         struct rpc_xprt *xprt,
0147         void *calldata);
0148     void *data;
0149 };
0150
0151 /* Values for "flags" field */
0152 #define RPC_CLNT_CREATE_HARDRTRY    (1UL << 0)
0153 #define RPC_CLNT_CREATE_AUTOBIND    (1UL << 2)
0154 #define RPC_CLNT_CREATE_NONPRIVPORT (1UL << 3)
0155 #define RPC_CLNT_CREATE_NOPING      (1UL << 4)
0156 #define RPC_CLNT_CREATE_DISCRTRY    (1UL << 5)
0157 #define RPC_CLNT_CREATE_QUIET       (1UL << 6)
0158 #define RPC_CLNT_CREATE_INFINITE_SLOTS  (1UL << 7)
0159 #define RPC_CLNT_CREATE_NO_IDLE_TIMEOUT (1UL << 8)
0160 #define RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT  (1UL << 9)
0161 #define RPC_CLNT_CREATE_SOFTERR     (1UL << 10)
0162 #define RPC_CLNT_CREATE_REUSEPORT   (1UL << 11)
0163 #define RPC_CLNT_CREATE_CONNECTED   (1UL << 12)
0164
0165 struct rpc_clnt *rpc_create(struct rpc_create_args *args);
0166 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *,
0167                 const struct rpc_program *, u32);
0168 struct rpc_clnt *rpc_clone_client(struct rpc_clnt *);
0169 struct rpc_clnt *rpc_clone_client_set_auth(struct rpc_clnt *,
0170                 rpc_authflavor_t);
0171 int     rpc_switch_client_transport(struct rpc_clnt *,
0172                 struct xprt_create *,
0173                 const struct rpc_timeout *);
0174
0175 void        rpc_shutdown_client(struct rpc_clnt *);
0176 void        rpc_release_client(struct rpc_clnt *);
0177 void        rpc_task_release_transport(struct rpc_task *);
0178 void        rpc_task_release_client(struct rpc_task *);
0179 struct rpc_xprt *rpc_task_get_xprt(struct rpc_clnt *clnt,
0180         struct rpc_xprt *xprt);
0181
0182 int     rpcb_create_local(struct net *);
0183 void        rpcb_put_local(struct net *);
0184 int     rpcb_register(struct net *, u32, u32, int, unsigned short);
0185 int     rpcb_v4_register(struct net *net, const u32 program,
0186                  const u32 version,
0187                  const struct sockaddr *address,
0188                  const char *netid);
0189 void        rpcb_getport_async(struct rpc_task *);
0190
0191 void rpc_prepare_reply_pages(struct rpc_rqst *req, struct page **pages,
0192                  unsigned int base, unsigned int len,
0193                  unsigned int hdrsize);
0194 void        rpc_call_start(struct rpc_task *);
0195 int     rpc_call_async(struct rpc_clnt *clnt,
0196                    const struct rpc_message *msg, int flags,
0197                    const struct rpc_call_ops *tk_ops,
0198                    void *calldata);
0199 int     rpc_call_sync(struct rpc_clnt *clnt,
0200                   const struct rpc_message *msg, int flags);
0201 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred,
0202                    int flags);
0203 int     rpc_restart_call_prepare(struct rpc_task *);
0204 int     rpc_restart_call(struct rpc_task *);
0205 void        rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int);
0206 struct net *    rpc_net_ns(struct rpc_clnt *);
0207 size_t      rpc_max_payload(struct rpc_clnt *);
0208 size_t      rpc_max_bc_payload(struct rpc_clnt *);
0209 unsigned int    rpc_num_bc_slots(struct rpc_clnt *);
0210 void        rpc_force_rebind(struct rpc_clnt *);
0211 size_t      rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t);
0212 const char  *rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t);
0213 int     rpc_localaddr(struct rpc_clnt *, struct sockaddr *, size_t);
0214
0215 int         rpc_clnt_iterate_for_each_xprt(struct rpc_clnt *clnt,
0216             int (*fn)(struct rpc_clnt *, struct rpc_xprt *, void *),
0217             void *data);
0218
0219 int         rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt,
0220             struct rpc_xprt_switch *xps,
0221             struct rpc_xprt *xprt,
0222             void *dummy);
0223 int     rpc_clnt_add_xprt(struct rpc_clnt *, struct xprt_create *,
0224             int (*setup)(struct rpc_clnt *,
0225                 struct rpc_xprt_switch *,
0226                 struct rpc_xprt *,
0227                 void *),
0228             void *data);
0229 void        rpc_set_connect_timeout(struct rpc_clnt *clnt,
0230             unsigned long connect_timeout,
0231             unsigned long reconnect_timeout);
0232
0233 int     rpc_clnt_setup_test_and_add_xprt(struct rpc_clnt *,
0234             struct rpc_xprt_switch *,
0235             struct rpc_xprt *,
0236             void *);
0237 void        rpc_clnt_manage_trunked_xprts(struct rpc_clnt *);
0238 void        rpc_clnt_probe_trunked_xprts(struct rpc_clnt *,
0239             struct rpc_add_xprt_test *);
0240
0241 const char *rpc_proc_name(const struct rpc_task *task);
0242
0243 void rpc_clnt_xprt_switch_put(struct rpc_clnt *);
0244 void rpc_clnt_xprt_switch_add_xprt(struct rpc_clnt *, struct rpc_xprt *);
0245 void rpc_clnt_xprt_switch_remove_xprt(struct rpc_clnt *, struct rpc_xprt *);
0246 bool rpc_clnt_xprt_switch_has_addr(struct rpc_clnt *clnt,
0247             const struct sockaddr *sap);
0248 void rpc_clnt_xprt_set_online(struct rpc_clnt *clnt, struct rpc_xprt *xprt);
0249 void rpc_cleanup_clids(void);
0250
0251 static inline int rpc_reply_expected(struct rpc_task *task)
0252 {
0253     return (task->tk_msg.rpc_proc != NULL) &&
0254         (task->tk_msg.rpc_proc->p_decode != NULL);
0255 }
0256
0257 static inline void rpc_task_close_connection(struct rpc_task *task)
0258 {
0259     if (task->tk_xprt)
0260         xprt_force_disconnect(task->tk_xprt);
0261 }
0262 #endif /* _LINUX_SUNRPC_CLNT_H */