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 <linux/sunrpc/rpc_pipe_fs.h> 25 #include <asm/signal.h> 26 #include <linux/path.h> 27 #include <net/ipv6.h> 28 #include <linux/sunrpc/xprtmultipath.h> 29 30 struct rpc_inode; 31 32 /* 33 * The high-level client handle 34 */ 35 struct rpc_clnt { 36 atomic_t cl_count; /* Number of references */ 37 unsigned int cl_clid; /* client id */ 38 struct list_head cl_clients; /* Global list of clients */ 39 struct list_head cl_tasks; /* List of tasks */ 40 spinlock_t cl_lock; /* spinlock */ 41 struct rpc_xprt __rcu * cl_xprt; /* transport */ 42 struct rpc_procinfo * cl_procinfo; /* procedure info */ 43 u32 cl_prog, /* RPC program number */ 44 cl_vers, /* RPC version number */ 45 cl_maxproc; /* max procedure number */ 46 47 struct rpc_auth * cl_auth; /* authenticator */ 48 struct rpc_stat * cl_stats; /* per-program statistics */ 49 struct rpc_iostats * cl_metrics; /* per-client statistics */ 50 51 unsigned int cl_softrtry : 1,/* soft timeouts */ 52 cl_discrtry : 1,/* disconnect before retry */ 53 cl_noretranstimeo: 1,/* No retransmit timeouts */ 54 cl_autobind : 1,/* use getport() */ 55 cl_chatty : 1;/* be verbose */ 56 57 struct rpc_rtt * cl_rtt; /* RTO estimator data */ 58 const struct rpc_timeout *cl_timeout; /* Timeout strategy */ 59 60 atomic_t cl_swapper; /* swapfile count */ 61 int cl_nodelen; /* nodename length */ 62 char cl_nodename[UNX_MAXNODENAME+1]; 63 struct rpc_pipe_dir_head cl_pipedir_objects; 64 struct rpc_clnt * cl_parent; /* Points to parent of clones */ 65 struct rpc_rtt cl_rtt_default; 66 struct rpc_timeout cl_timeout_default; 67 const struct rpc_program *cl_program; 68 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG) 69 struct dentry *cl_debugfs; /* debugfs directory */ 70 #endif 71 struct rpc_xprt_iter cl_xpi; 72 }; 73 74 /* 75 * General RPC program info 76 */ 77 #define RPC_MAXVERSION 4 78 struct rpc_program { 79 const char * name; /* protocol name */ 80 u32 number; /* program number */ 81 unsigned int nrvers; /* number of versions */ 82 const struct rpc_version ** version; /* version array */ 83 struct rpc_stat * stats; /* statistics */ 84 const char * pipe_dir_name; /* path to rpc_pipefs dir */ 85 }; 86 87 struct rpc_version { 88 u32 number; /* version number */ 89 unsigned int nrprocs; /* number of procs */ 90 struct rpc_procinfo * procs; /* procedure array */ 91 }; 92 93 /* 94 * Procedure information 95 */ 96 struct rpc_procinfo { 97 u32 p_proc; /* RPC procedure number */ 98 kxdreproc_t p_encode; /* XDR encode function */ 99 kxdrdproc_t p_decode; /* XDR decode function */ 100 unsigned int p_arglen; /* argument hdr length (u32) */ 101 unsigned int p_replen; /* reply hdr length (u32) */ 102 unsigned int p_count; /* call count */ 103 unsigned int p_timer; /* Which RTT timer to use */ 104 u32 p_statidx; /* Which procedure to account */ 105 const char * p_name; /* name of procedure */ 106 }; 107 108 #ifdef __KERNEL__ 109 110 struct rpc_create_args { 111 struct net *net; 112 int protocol; 113 struct sockaddr *address; 114 size_t addrsize; 115 struct sockaddr *saddress; 116 const struct rpc_timeout *timeout; 117 const char *servername; 118 const char *nodename; 119 const struct rpc_program *program; 120 u32 prognumber; /* overrides program->number */ 121 u32 version; 122 rpc_authflavor_t authflavor; 123 unsigned long flags; 124 char *client_name; 125 struct svc_xprt *bc_xprt; /* NFSv4.1 backchannel */ 126 }; 127 128 struct rpc_add_xprt_test { 129 int (*add_xprt_test)(struct rpc_clnt *, 130 struct rpc_xprt *, 131 void *calldata); 132 void *data; 133 }; 134 135 /* Values for "flags" field */ 136 #define RPC_CLNT_CREATE_HARDRTRY (1UL << 0) 137 #define RPC_CLNT_CREATE_AUTOBIND (1UL << 2) 138 #define RPC_CLNT_CREATE_NONPRIVPORT (1UL << 3) 139 #define RPC_CLNT_CREATE_NOPING (1UL << 4) 140 #define RPC_CLNT_CREATE_DISCRTRY (1UL << 5) 141 #define RPC_CLNT_CREATE_QUIET (1UL << 6) 142 #define RPC_CLNT_CREATE_INFINITE_SLOTS (1UL << 7) 143 #define RPC_CLNT_CREATE_NO_IDLE_TIMEOUT (1UL << 8) 144 #define RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT (1UL << 9) 145 146 struct rpc_clnt *rpc_create(struct rpc_create_args *args); 147 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *, 148 const struct rpc_program *, u32); 149 struct rpc_clnt *rpc_clone_client(struct rpc_clnt *); 150 struct rpc_clnt *rpc_clone_client_set_auth(struct rpc_clnt *, 151 rpc_authflavor_t); 152 int rpc_switch_client_transport(struct rpc_clnt *, 153 struct xprt_create *, 154 const struct rpc_timeout *); 155 156 void rpc_shutdown_client(struct rpc_clnt *); 157 void rpc_release_client(struct rpc_clnt *); 158 void rpc_task_release_client(struct rpc_task *); 159 160 int rpcb_create_local(struct net *); 161 void rpcb_put_local(struct net *); 162 int rpcb_register(struct net *, u32, u32, int, unsigned short); 163 int rpcb_v4_register(struct net *net, const u32 program, 164 const u32 version, 165 const struct sockaddr *address, 166 const char *netid); 167 void rpcb_getport_async(struct rpc_task *); 168 169 void rpc_call_start(struct rpc_task *); 170 int rpc_call_async(struct rpc_clnt *clnt, 171 const struct rpc_message *msg, int flags, 172 const struct rpc_call_ops *tk_ops, 173 void *calldata); 174 int rpc_call_sync(struct rpc_clnt *clnt, 175 const struct rpc_message *msg, int flags); 176 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, 177 int flags); 178 int rpc_restart_call_prepare(struct rpc_task *); 179 int rpc_restart_call(struct rpc_task *); 180 void rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int); 181 int rpc_protocol(struct rpc_clnt *); 182 struct net * rpc_net_ns(struct rpc_clnt *); 183 size_t rpc_max_payload(struct rpc_clnt *); 184 size_t rpc_max_bc_payload(struct rpc_clnt *); 185 unsigned long rpc_get_timeout(struct rpc_clnt *clnt); 186 void rpc_force_rebind(struct rpc_clnt *); 187 size_t rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t); 188 const char *rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t); 189 int rpc_localaddr(struct rpc_clnt *, struct sockaddr *, size_t); 190 191 int rpc_clnt_iterate_for_each_xprt(struct rpc_clnt *clnt, 192 int (*fn)(struct rpc_clnt *, struct rpc_xprt *, void *), 193 void *data); 194 195 int rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt, 196 struct rpc_xprt_switch *xps, 197 struct rpc_xprt *xprt, 198 void *dummy); 199 int rpc_clnt_add_xprt(struct rpc_clnt *, struct xprt_create *, 200 int (*setup)(struct rpc_clnt *, 201 struct rpc_xprt_switch *, 202 struct rpc_xprt *, 203 void *), 204 void *data); 205 void rpc_cap_max_reconnect_timeout(struct rpc_clnt *clnt, 206 unsigned long timeo); 207 208 int rpc_clnt_setup_test_and_add_xprt(struct rpc_clnt *, 209 struct rpc_xprt_switch *, 210 struct rpc_xprt *, 211 void *); 212 213 const char *rpc_proc_name(const struct rpc_task *task); 214 215 void rpc_clnt_xprt_switch_put(struct rpc_clnt *); 216 void rpc_clnt_xprt_switch_add_xprt(struct rpc_clnt *, struct rpc_xprt *); 217 bool rpc_clnt_xprt_switch_has_addr(struct rpc_clnt *clnt, 218 const struct sockaddr *sap); 219 void rpc_cleanup_clids(void); 220 #endif /* __KERNEL__ */ 221 #endif /* _LINUX_SUNRPC_CLNT_H */ 222