1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * linux/include/linux/sunrpc/clnt.h 4 * 5 * Declarations for the high-level RPC client interface 6 * 7 * Copyright (C) 1995, 1996, Olaf Kirch <okir@monad.swb.de> 8 */ 9 10 #ifndef _LINUX_SUNRPC_CLNT_H 11 #define _LINUX_SUNRPC_CLNT_H 12 13 #include <linux/types.h> 14 #include <linux/socket.h> 15 #include <linux/in.h> 16 #include <linux/in6.h> 17 #include <linux/refcount.h> 18 19 #include <linux/sunrpc/msg_prot.h> 20 #include <linux/sunrpc/sched.h> 21 #include <linux/sunrpc/xprt.h> 22 #include <linux/sunrpc/auth.h> 23 #include <linux/sunrpc/stats.h> 24 #include <linux/sunrpc/xdr.h> 25 #include <linux/sunrpc/timer.h> 26 #include <linux/sunrpc/rpc_pipe_fs.h> 27 #include <asm/signal.h> 28 #include <linux/path.h> 29 #include <net/ipv6.h> 30 #include <linux/sunrpc/xprtmultipath.h> 31 32 struct rpc_inode; 33 struct rpc_sysfs_client { 34 struct kobject kobject; 35 struct net *net; 36 struct rpc_clnt *clnt; 37 struct rpc_xprt_switch *xprt_switch; 38 }; 39 40 41 /* 42 * The high-level client handle 43 */ 44 struct rpc_clnt { 45 refcount_t cl_count; /* Number of references */ 46 unsigned int cl_clid; /* client id */ 47 struct list_head cl_clients; /* Global list of clients */ 48 struct list_head cl_tasks; /* List of tasks */ 49 atomic_t cl_pid; /* task PID counter */ 50 spinlock_t cl_lock; /* spinlock */ 51 struct rpc_xprt __rcu * cl_xprt; /* transport */ 52 const struct rpc_procinfo *cl_procinfo; /* procedure info */ 53 u32 cl_prog, /* RPC program number */ 54 cl_vers, /* RPC version number */ 55 cl_maxproc; /* max procedure number */ 56 57 struct rpc_auth * cl_auth; /* authenticator */ 58 struct rpc_stat * cl_stats; /* per-program statistics */ 59 struct rpc_iostats * cl_metrics; /* per-client statistics */ 60 61 unsigned int cl_softrtry : 1,/* soft timeouts */ 62 cl_softerr : 1,/* Timeouts return errors */ 63 cl_discrtry : 1,/* disconnect before retry */ 64 cl_noretranstimeo: 1,/* No retransmit timeouts */ 65 cl_autobind : 1,/* use getport() */ 66 cl_chatty : 1,/* be verbose */ 67 cl_shutdown : 1;/* rpc immediate -EIO */ 68 struct xprtsec_parms cl_xprtsec; /* transport security policy */ 69 70 struct rpc_rtt * cl_rtt; /* RTO estimator data */ 71 const struct rpc_timeout *cl_timeout; /* Timeout strategy */ 72 73 atomic_t cl_swapper; /* swapfile count */ 74 int cl_nodelen; /* nodename length */ 75 char cl_nodename[UNX_MAXNODENAME+1]; 76 struct rpc_pipe_dir_head cl_pipedir_objects; 77 struct rpc_clnt * cl_parent; /* Points to parent of clones */ 78 struct rpc_rtt cl_rtt_default; 79 struct rpc_timeout cl_timeout_default; 80 const struct rpc_program *cl_program; 81 const char * cl_principal; /* use for machine cred */ 82 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG) 83 struct dentry *cl_debugfs; /* debugfs directory */ 84 #endif 85 struct rpc_sysfs_client *cl_sysfs; /* sysfs directory */ 86 /* cl_work is only needed after cl_xpi is no longer used, 87 * and that are of similar size 88 */ 89 union { 90 struct rpc_xprt_iter cl_xpi; 91 struct work_struct cl_work; 92 }; 93 const struct cred *cl_cred; 94 unsigned int cl_max_connect; /* max number of transports not to the same IP */ 95 struct super_block *pipefs_sb; 96 atomic_t cl_task_count; 97 }; 98 99 /* 100 * General RPC program info 101 */ 102 #define RPC_MAXVERSION 4 103 struct rpc_program { 104 const char * name; /* protocol name */ 105 u32 number; /* program number */ 106 unsigned int nrvers; /* number of versions */ 107 const struct rpc_version ** version; /* version array */ 108 struct rpc_stat * stats; /* statistics */ 109 const char * pipe_dir_name; /* path to rpc_pipefs dir */ 110 }; 111 112 struct rpc_version { 113 u32 number; /* version number */ 114 unsigned int nrprocs; /* number of procs */ 115 const struct rpc_procinfo *procs; /* procedure array */ 116 unsigned int *counts; /* call counts */ 117 }; 118 119 /* 120 * Procedure information 121 */ 122 struct rpc_procinfo { 123 u32 p_proc; /* RPC procedure number */ 124 kxdreproc_t p_encode; /* XDR encode function */ 125 kxdrdproc_t p_decode; /* XDR decode function */ 126 unsigned int p_arglen; /* argument hdr length (u32) */ 127 unsigned int p_replen; /* reply hdr length (u32) */ 128 unsigned int p_timer; /* Which RTT timer to use */ 129 u32 p_statidx; /* Which procedure to account */ 130 const char * p_name; /* name of procedure */ 131 }; 132 133 struct rpc_create_args { 134 struct net *net; 135 int protocol; 136 struct sockaddr *address; 137 size_t addrsize; 138 struct sockaddr *saddress; 139 const struct rpc_timeout *timeout; 140 const char *servername; 141 const char *nodename; 142 const struct rpc_program *program; 143 struct rpc_stat *stats; 144 u32 prognumber; /* overrides program->number */ 145 u32 version; 146 rpc_authflavor_t authflavor; 147 u32 nconnect; 148 unsigned long flags; 149 char *client_name; 150 struct svc_xprt *bc_xprt; /* NFSv4.1 backchannel */ 151 const struct cred *cred; 152 unsigned int max_connect; 153 struct xprtsec_parms xprtsec; 154 unsigned long connect_timeout; 155 unsigned long reconnect_timeout; 156 }; 157 158 struct rpc_add_xprt_test { 159 void (*add_xprt_test)(struct rpc_clnt *clnt, 160 struct rpc_xprt *xprt, 161 void *calldata); 162 void *data; 163 }; 164 165 /* Values for "flags" field */ 166 #define RPC_CLNT_CREATE_HARDRTRY (1UL << 0) 167 #define RPC_CLNT_CREATE_AUTOBIND (1UL << 2) 168 #define RPC_CLNT_CREATE_NONPRIVPORT (1UL << 3) 169 #define RPC_CLNT_CREATE_NOPING (1UL << 4) 170 #define RPC_CLNT_CREATE_DISCRTRY (1UL << 5) 171 #define RPC_CLNT_CREATE_QUIET (1UL << 6) 172 #define RPC_CLNT_CREATE_INFINITE_SLOTS (1UL << 7) 173 #define RPC_CLNT_CREATE_NO_IDLE_TIMEOUT (1UL << 8) 174 #define RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT (1UL << 9) 175 #define RPC_CLNT_CREATE_SOFTERR (1UL << 10) 176 #define RPC_CLNT_CREATE_REUSEPORT (1UL << 11) 177 #define RPC_CLNT_CREATE_CONNECTED (1UL << 12) 178 179 struct rpc_clnt *rpc_create(struct rpc_create_args *args); 180 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *, 181 const struct rpc_program *, u32); 182 struct rpc_clnt *rpc_clone_client(struct rpc_clnt *); 183 struct rpc_clnt *rpc_clone_client_set_auth(struct rpc_clnt *, 184 rpc_authflavor_t); 185 int rpc_switch_client_transport(struct rpc_clnt *, 186 struct xprt_create *, 187 const struct rpc_timeout *); 188 189 void rpc_shutdown_client(struct rpc_clnt *); 190 void rpc_release_client(struct rpc_clnt *); 191 void rpc_task_release_transport(struct rpc_task *); 192 void rpc_task_release_client(struct rpc_task *); 193 struct rpc_xprt *rpc_task_get_xprt(struct rpc_clnt *clnt, 194 struct rpc_xprt *xprt); 195 196 int rpcb_create_local(struct net *); 197 void rpcb_put_local(struct net *); 198 int rpcb_register(struct net *, u32, u32, int, unsigned short); 199 int rpcb_v4_register(struct net *net, const u32 program, 200 const u32 version, 201 const struct sockaddr *address, 202 const char *netid); 203 void rpcb_getport_async(struct rpc_task *); 204 205 void rpc_prepare_reply_pages(struct rpc_rqst *req, struct page **pages, 206 unsigned int base, unsigned int len, 207 unsigned int hdrsize); 208 void rpc_call_start(struct rpc_task *); 209 int rpc_call_async(struct rpc_clnt *clnt, 210 const struct rpc_message *msg, int flags, 211 const struct rpc_call_ops *tk_ops, 212 void *calldata); 213 int rpc_call_sync(struct rpc_clnt *clnt, 214 const struct rpc_message *msg, int flags); 215 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, 216 int flags); 217 int rpc_restart_call_prepare(struct rpc_task *); 218 int rpc_restart_call(struct rpc_task *); 219 void rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int); 220 struct net * rpc_net_ns(struct rpc_clnt *); 221 size_t rpc_max_payload(struct rpc_clnt *); 222 size_t rpc_max_bc_payload(struct rpc_clnt *); 223 unsigned int rpc_num_bc_slots(struct rpc_clnt *); 224 void rpc_force_rebind(struct rpc_clnt *); 225 size_t rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t); 226 const char *rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t); 227 int rpc_localaddr(struct rpc_clnt *, struct sockaddr *, size_t); 228 229 int rpc_clnt_iterate_for_each_xprt(struct rpc_clnt *clnt, 230 int (*fn)(struct rpc_clnt *, struct rpc_xprt *, void *), 231 void *data); 232 233 int rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt, 234 struct rpc_xprt_switch *xps, 235 struct rpc_xprt *xprt, 236 void *dummy); 237 int rpc_clnt_add_xprt(struct rpc_clnt *, struct xprt_create *, 238 int (*setup)(struct rpc_clnt *, 239 struct rpc_xprt_switch *, 240 struct rpc_xprt *, 241 void *), 242 void *data); 243 void rpc_set_connect_timeout(struct rpc_clnt *clnt, 244 unsigned long connect_timeout, 245 unsigned long reconnect_timeout); 246 247 int rpc_clnt_setup_test_and_add_xprt(struct rpc_clnt *, 248 struct rpc_xprt_switch *, 249 struct rpc_xprt *, 250 void *); 251 void rpc_clnt_manage_trunked_xprts(struct rpc_clnt *); 252 void rpc_clnt_probe_trunked_xprts(struct rpc_clnt *, 253 struct rpc_add_xprt_test *); 254 255 const char *rpc_proc_name(const struct rpc_task *task); 256 257 void rpc_clnt_xprt_switch_add_xprt(struct rpc_clnt *, struct rpc_xprt *); 258 void rpc_clnt_xprt_switch_remove_xprt(struct rpc_clnt *, struct rpc_xprt *); 259 bool rpc_clnt_xprt_switch_has_addr(struct rpc_clnt *clnt, 260 const struct sockaddr *sap); 261 void rpc_clnt_xprt_set_online(struct rpc_clnt *clnt, struct rpc_xprt *xprt); 262 void rpc_clnt_disconnect(struct rpc_clnt *clnt); 263 void rpc_cleanup_clids(void); 264 265 static inline int rpc_reply_expected(struct rpc_task *task) 266 { 267 return (task->tk_msg.rpc_proc != NULL) && 268 (task->tk_msg.rpc_proc->p_decode != NULL); 269 } 270 271 static inline void rpc_task_close_connection(struct rpc_task *task) 272 { 273 if (task->tk_xprt) 274 xprt_force_disconnect(task->tk_xprt); 275 } 276 #endif /* _LINUX_SUNRPC_CLNT_H */ 277