2 * linux/include/linux/sunrpc/clnt.h
4 * Declarations for the high-level RPC client interface
6 * Copyright (C) 1995, 1996, Olaf Kirch <okir@monad.swb.de>
9 #ifndef _LINUX_SUNRPC_CLNT_H
10 #define _LINUX_SUNRPC_CLNT_H
12 #include <linux/socket.h>
14 #include <linux/in6.h>
16 #include <linux/sunrpc/msg_prot.h>
17 #include <linux/sunrpc/sched.h>
18 #include <linux/sunrpc/xprt.h>
19 #include <linux/sunrpc/auth.h>
20 #include <linux/sunrpc/stats.h>
21 #include <linux/sunrpc/xdr.h>
22 #include <linux/sunrpc/timer.h>
23 #include <asm/signal.h>
28 * The high-level client handle
31 struct kref cl_kref; /* Number of references */
32 struct list_head cl_clients; /* Global list of clients */
33 struct list_head cl_tasks; /* List of tasks */
34 spinlock_t cl_lock; /* spinlock */
35 struct rpc_xprt * cl_xprt; /* transport */
36 struct rpc_procinfo * cl_procinfo; /* procedure info */
37 u32 cl_prog, /* RPC program number */
38 cl_vers, /* RPC version number */
39 cl_maxproc; /* max procedure number */
41 char * cl_server; /* server machine name */
42 char * cl_protname; /* protocol name */
43 struct rpc_auth * cl_auth; /* authenticator */
44 struct rpc_stat * cl_stats; /* per-program statistics */
45 struct rpc_iostats * cl_metrics; /* per-client statistics */
47 unsigned int cl_softrtry : 1,/* soft timeouts */
48 cl_discrtry : 1,/* disconnect before retry */
49 cl_autobind : 1,/* use getport() */
50 cl_chatty : 1;/* be verbose */
52 struct rpc_rtt * cl_rtt; /* RTO estimator data */
53 const struct rpc_timeout *cl_timeout; /* Timeout strategy */
55 int cl_nodelen; /* nodename length */
56 char cl_nodename[UNX_MAXNODENAME];
57 char cl_pathname[30];/* Path in rpc_pipe_fs */
58 struct vfsmount * cl_vfsmnt;
59 struct dentry * cl_dentry; /* inode */
60 struct rpc_clnt * cl_parent; /* Points to parent of clones */
61 struct rpc_rtt cl_rtt_default;
62 struct rpc_timeout cl_timeout_default;
63 struct rpc_program * cl_program;
64 char cl_inline_name[32];
65 char *cl_principal; /* target to authenticate to */
69 * General RPC program info
71 #define RPC_MAXVERSION 4
73 char * name; /* protocol name */
74 u32 number; /* program number */
75 unsigned int nrvers; /* number of versions */
76 struct rpc_version ** version; /* version array */
77 struct rpc_stat * stats; /* statistics */
78 char * pipe_dir_name; /* path to rpc_pipefs dir */
82 u32 number; /* version number */
83 unsigned int nrprocs; /* number of procs */
84 struct rpc_procinfo * procs; /* procedure array */
88 * Procedure information
91 u32 p_proc; /* RPC procedure number */
92 kxdrproc_t p_encode; /* XDR encode function */
93 kxdrproc_t p_decode; /* XDR decode function */
94 unsigned int p_arglen; /* argument hdr length (u32) */
95 unsigned int p_replen; /* reply hdr length (u32) */
96 unsigned int p_count; /* call count */
97 unsigned int p_timer; /* Which RTT timer to use */
98 u32 p_statidx; /* Which procedure to account */
99 char * p_name; /* name of procedure */
104 struct rpc_create_args {
106 struct sockaddr *address;
108 struct sockaddr *saddress;
109 const struct rpc_timeout *timeout;
111 struct rpc_program *program;
112 u32 prognumber; /* overrides program->number */
114 rpc_authflavor_t authflavor;
119 /* Values for "flags" field */
120 #define RPC_CLNT_CREATE_HARDRTRY (1UL << 0)
121 #define RPC_CLNT_CREATE_AUTOBIND (1UL << 2)
122 #define RPC_CLNT_CREATE_NONPRIVPORT (1UL << 3)
123 #define RPC_CLNT_CREATE_NOPING (1UL << 4)
124 #define RPC_CLNT_CREATE_DISCRTRY (1UL << 5)
125 #define RPC_CLNT_CREATE_QUIET (1UL << 6)
127 struct rpc_clnt *rpc_create(struct rpc_create_args *args);
128 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *,
129 struct rpc_program *, u32);
130 struct rpc_clnt *rpc_clone_client(struct rpc_clnt *);
131 void rpc_shutdown_client(struct rpc_clnt *);
132 void rpc_release_client(struct rpc_clnt *);
134 int rpcb_register(u32, u32, int, unsigned short);
135 int rpcb_v4_register(const u32 program, const u32 version,
136 const struct sockaddr *address,
138 int rpcb_getport_sync(struct sockaddr_in *, u32, u32, int);
139 void rpcb_getport_async(struct rpc_task *);
141 void rpc_call_start(struct rpc_task *);
142 int rpc_call_async(struct rpc_clnt *clnt,
143 const struct rpc_message *msg, int flags,
144 const struct rpc_call_ops *tk_ops,
146 int rpc_call_sync(struct rpc_clnt *clnt,
147 const struct rpc_message *msg, int flags);
148 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred,
150 void rpc_restart_call_prepare(struct rpc_task *);
151 void rpc_restart_call(struct rpc_task *);
152 void rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int);
153 size_t rpc_max_payload(struct rpc_clnt *);
154 void rpc_force_rebind(struct rpc_clnt *);
155 size_t rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t);
156 const char *rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t);
158 size_t rpc_ntop(const struct sockaddr *, char *, const size_t);
159 size_t rpc_pton(const char *, const size_t,
160 struct sockaddr *, const size_t);
161 char * rpc_sockaddr2uaddr(const struct sockaddr *);
162 size_t rpc_uaddr2sockaddr(const char *, const size_t,
163 struct sockaddr *, const size_t);
165 static inline unsigned short rpc_get_port(const struct sockaddr *sap)
167 switch (sap->sa_family) {
169 return ntohs(((struct sockaddr_in *)sap)->sin_port);
171 return ntohs(((struct sockaddr_in6 *)sap)->sin6_port);
176 static inline void rpc_set_port(struct sockaddr *sap,
177 const unsigned short port)
179 switch (sap->sa_family) {
181 ((struct sockaddr_in *)sap)->sin_port = htons(port);
184 ((struct sockaddr_in6 *)sap)->sin6_port = htons(port);
189 #define IPV6_SCOPE_DELIMITER '%'
190 #define IPV6_SCOPE_ID_LEN sizeof("%nnnnnnnnnn")
192 #endif /* __KERNEL__ */
193 #endif /* _LINUX_SUNRPC_CLNT_H */