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