]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
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 | ||
d77385f2 | 12 | #include <linux/types.h> |
a02d6926 CL |
13 | #include <linux/socket.h> |
14 | #include <linux/in.h> | |
15 | #include <linux/in6.h> | |
16 | ||
1da177e4 LT |
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> | |
6739ffb7 | 24 | #include <linux/sunrpc/rpc_pipe_fs.h> |
1da177e4 | 25 | #include <asm/signal.h> |
7d217cac | 26 | #include <linux/path.h> |
4516fc04 | 27 | #include <net/ipv6.h> |
1da177e4 | 28 | |
1da177e4 LT |
29 | struct rpc_inode; |
30 | ||
31 | /* | |
32 | * The high-level client handle | |
33 | */ | |
34 | struct rpc_clnt { | |
006abe88 | 35 | atomic_t cl_count; /* Number of references */ |
2f048db4 | 36 | unsigned int cl_clid; /* client id */ |
6529eba0 TM |
37 | struct list_head cl_clients; /* Global list of clients */ |
38 | struct list_head cl_tasks; /* List of tasks */ | |
4bef61ff | 39 | spinlock_t cl_lock; /* spinlock */ |
2446ab60 | 40 | struct rpc_xprt __rcu * cl_xprt; /* transport */ |
1da177e4 | 41 | struct rpc_procinfo * cl_procinfo; /* procedure info */ |
4a68179d CL |
42 | u32 cl_prog, /* RPC program number */ |
43 | cl_vers, /* RPC version number */ | |
44 | cl_maxproc; /* max procedure number */ | |
1da177e4 | 45 | |
1da177e4 | 46 | struct rpc_auth * cl_auth; /* authenticator */ |
11c556b3 CL |
47 | struct rpc_stat * cl_stats; /* per-program statistics */ |
48 | struct rpc_iostats * cl_metrics; /* per-client statistics */ | |
1da177e4 LT |
49 | |
50 | unsigned int cl_softrtry : 1,/* soft timeouts */ | |
43d78ef2 | 51 | cl_discrtry : 1,/* disconnect before retry */ |
8a19a0b6 | 52 | cl_noretranstimeo: 1,/* No retransmit timeouts */ |
b6b6152c OK |
53 | cl_autobind : 1,/* use getport() */ |
54 | cl_chatty : 1;/* be verbose */ | |
1da177e4 LT |
55 | |
56 | struct rpc_rtt * cl_rtt; /* RTO estimator data */ | |
ba7392bb | 57 | const struct rpc_timeout *cl_timeout; /* Timeout strategy */ |
1da177e4 LT |
58 | |
59 | int cl_nodelen; /* nodename length */ | |
60 | char cl_nodename[UNX_MAXNODENAME]; | |
6739ffb7 | 61 | struct rpc_pipe_dir_head cl_pipedir_objects; |
1da177e4 LT |
62 | struct rpc_clnt * cl_parent; /* Points to parent of clones */ |
63 | struct rpc_rtt cl_rtt_default; | |
ba7392bb | 64 | struct rpc_timeout cl_timeout_default; |
a613fa16 | 65 | const struct rpc_program *cl_program; |
b4b9d2cc JL |
66 | #if IS_ENABLED(CONFIG_SUNRPC_DEBUG) |
67 | struct dentry *cl_debugfs; /* debugfs directory */ | |
68 | #endif | |
1da177e4 | 69 | }; |
1da177e4 LT |
70 | |
71 | /* | |
72 | * General RPC program info | |
73 | */ | |
74 | #define RPC_MAXVERSION 4 | |
75 | struct rpc_program { | |
080b794c | 76 | const char * name; /* protocol name */ |
1da177e4 LT |
77 | u32 number; /* program number */ |
78 | unsigned int nrvers; /* number of versions */ | |
a613fa16 | 79 | const struct rpc_version ** version; /* version array */ |
1da177e4 | 80 | struct rpc_stat * stats; /* statistics */ |
080b794c | 81 | const char * pipe_dir_name; /* path to rpc_pipefs dir */ |
1da177e4 LT |
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 */ | |
9f06c719 | 95 | kxdreproc_t p_encode; /* XDR encode function */ |
bf269551 | 96 | kxdrdproc_t p_decode; /* XDR decode function */ |
2bea90d4 CL |
97 | unsigned int p_arglen; /* argument hdr length (u32) */ |
98 | unsigned int p_replen; /* reply hdr length (u32) */ | |
1da177e4 LT |
99 | unsigned int p_count; /* call count */ |
100 | unsigned int p_timer; /* Which RTT timer to use */ | |
cc0175c1 | 101 | u32 p_statidx; /* Which procedure to account */ |
6eac7d3f | 102 | const char * p_name; /* name of procedure */ |
1da177e4 LT |
103 | }; |
104 | ||
1da177e4 LT |
105 | #ifdef __KERNEL__ |
106 | ||
c2866763 | 107 | struct rpc_create_args { |
c653ce3f | 108 | struct net *net; |
c2866763 CL |
109 | int protocol; |
110 | struct sockaddr *address; | |
111 | size_t addrsize; | |
d3bc9a1d | 112 | struct sockaddr *saddress; |
ba7392bb | 113 | const struct rpc_timeout *timeout; |
6eac7d3f | 114 | const char *servername; |
a613fa16 | 115 | const struct rpc_program *program; |
d5b337b4 | 116 | u32 prognumber; /* overrides program->number */ |
c2866763 CL |
117 | u32 version; |
118 | rpc_authflavor_t authflavor; | |
119 | unsigned long flags; | |
608207e8 | 120 | char *client_name; |
f300baba | 121 | struct svc_xprt *bc_xprt; /* NFSv4.1 backchannel */ |
c2866763 CL |
122 | }; |
123 | ||
124 | /* Values for "flags" field */ | |
125 | #define RPC_CLNT_CREATE_HARDRTRY (1UL << 0) | |
c2866763 | 126 | #define RPC_CLNT_CREATE_AUTOBIND (1UL << 2) |
90c5755f TM |
127 | #define RPC_CLNT_CREATE_NONPRIVPORT (1UL << 3) |
128 | #define RPC_CLNT_CREATE_NOPING (1UL << 4) | |
129 | #define RPC_CLNT_CREATE_DISCRTRY (1UL << 5) | |
b6b6152c | 130 | #define RPC_CLNT_CREATE_QUIET (1UL << 6) |
b7993ceb | 131 | #define RPC_CLNT_CREATE_INFINITE_SLOTS (1UL << 7) |
33d90ac0 | 132 | #define RPC_CLNT_CREATE_NO_IDLE_TIMEOUT (1UL << 8) |
8a19a0b6 | 133 | #define RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT (1UL << 9) |
c2866763 CL |
134 | |
135 | struct rpc_clnt *rpc_create(struct rpc_create_args *args); | |
83ddfebd KM |
136 | struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args, |
137 | struct rpc_xprt *xprt); | |
007e251f | 138 | struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *, |
a613fa16 | 139 | const struct rpc_program *, u32); |
cbdabc7f | 140 | void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt); |
1da177e4 | 141 | struct rpc_clnt *rpc_clone_client(struct rpc_clnt *); |
ba9b584c CL |
142 | struct rpc_clnt *rpc_clone_client_set_auth(struct rpc_clnt *, |
143 | rpc_authflavor_t); | |
40b00b6b TM |
144 | int rpc_switch_client_transport(struct rpc_clnt *, |
145 | struct xprt_create *, | |
146 | const struct rpc_timeout *); | |
147 | ||
4c402b40 | 148 | void rpc_shutdown_client(struct rpc_clnt *); |
1da177e4 | 149 | void rpc_release_client(struct rpc_clnt *); |
58f9612c | 150 | void rpc_task_release_client(struct rpc_task *); |
cce63cd6 | 151 | |
f7a30c18 SK |
152 | int rpcb_create_local(struct net *); |
153 | void rpcb_put_local(struct net *); | |
977ac315 SK |
154 | int rpcb_register(struct net *, u32, u32, int, unsigned short); |
155 | int rpcb_v4_register(struct net *net, const u32 program, | |
156 | const u32 version, | |
c2e1b09f | 157 | const struct sockaddr *address, |
14aeb211 | 158 | const char *netid); |
45160d62 | 159 | void rpcb_getport_async(struct rpc_task *); |
1da177e4 | 160 | |
77de2c59 | 161 | void rpc_call_start(struct rpc_task *); |
cbc20059 TM |
162 | int rpc_call_async(struct rpc_clnt *clnt, |
163 | const struct rpc_message *msg, int flags, | |
164 | const struct rpc_call_ops *tk_ops, | |
963d8fe5 | 165 | void *calldata); |
cbc20059 TM |
166 | int rpc_call_sync(struct rpc_clnt *clnt, |
167 | const struct rpc_message *msg, int flags); | |
5e1550d6 TM |
168 | struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, |
169 | int flags); | |
f1f88fc7 TM |
170 | int rpc_restart_call_prepare(struct rpc_task *); |
171 | int rpc_restart_call(struct rpc_task *); | |
1da177e4 | 172 | void rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int); |
2446ab60 TM |
173 | int rpc_protocol(struct rpc_clnt *); |
174 | struct net * rpc_net_ns(struct rpc_clnt *); | |
1da177e4 | 175 | size_t rpc_max_payload(struct rpc_clnt *); |
edddbb1e | 176 | unsigned long rpc_get_timeout(struct rpc_clnt *clnt); |
35f5a422 | 177 | void rpc_force_rebind(struct rpc_clnt *); |
ed39440a | 178 | size_t rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t); |
b454ae90 | 179 | const char *rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t); |
2e738fdc | 180 | int rpc_localaddr(struct rpc_clnt *, struct sockaddr *, size_t); |
1da177e4 | 181 | |
b4b9d2cc | 182 | const char *rpc_proc_name(const struct rpc_task *task); |
1da177e4 LT |
183 | #endif /* __KERNEL__ */ |
184 | #endif /* _LINUX_SUNRPC_CLNT_H */ |