Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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 <asm/signal.h>
25#include <linux/path.h>
26#include <net/ipv6.h>
27
28struct rpc_inode;
29
30/*
31 * The high-level client handle
32 */
33struct rpc_clnt {
34 atomic_t cl_count; /* Number of references */
35 struct list_head cl_clients; /* Global list of clients */
36 struct list_head cl_tasks; /* List of tasks */
37 spinlock_t cl_lock; /* spinlock */
38 struct rpc_xprt __rcu * cl_xprt; /* transport */
39 struct rpc_procinfo * cl_procinfo; /* procedure info */
40 u32 cl_prog, /* RPC program number */
41 cl_vers, /* RPC version number */
42 cl_maxproc; /* max procedure number */
43
44 const char * cl_protname; /* protocol name */
45 struct rpc_auth * cl_auth; /* authenticator */
46 struct rpc_stat * cl_stats; /* per-program statistics */
47 struct rpc_iostats * cl_metrics; /* per-client statistics */
48
49 unsigned int cl_softrtry : 1,/* soft timeouts */
50 cl_discrtry : 1,/* disconnect before retry */
51 cl_autobind : 1,/* use getport() */
52 cl_chatty : 1;/* be verbose */
53
54 struct rpc_rtt * cl_rtt; /* RTO estimator data */
55 const struct rpc_timeout *cl_timeout; /* Timeout strategy */
56
57 int cl_nodelen; /* nodename length */
58 char cl_nodename[UNX_MAXNODENAME];
59 struct dentry * cl_dentry;
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 const struct rpc_program *cl_program;
64 char *cl_principal; /* target to authenticate to */
65};
66
67/*
68 * General RPC program info
69 */
70#define RPC_MAXVERSION 4
71struct rpc_program {
72 const char * name; /* protocol name */
73 u32 number; /* program number */
74 unsigned int nrvers; /* number of versions */
75 const struct rpc_version ** version; /* version array */
76 struct rpc_stat * stats; /* statistics */
77 const char * pipe_dir_name; /* path to rpc_pipefs dir */
78};
79
80struct rpc_version {
81 u32 number; /* version number */
82 unsigned int nrprocs; /* number of procs */
83 struct rpc_procinfo * procs; /* procedure array */
84};
85
86/*
87 * Procedure information
88 */
89struct rpc_procinfo {
90 u32 p_proc; /* RPC procedure number */
91 kxdreproc_t p_encode; /* XDR encode function */
92 kxdrdproc_t p_decode; /* XDR decode function */
93 unsigned int p_arglen; /* argument hdr length (u32) */
94 unsigned int p_replen; /* reply hdr length (u32) */
95 unsigned int p_count; /* call count */
96 unsigned int p_timer; /* Which RTT timer to use */
97 u32 p_statidx; /* Which procedure to account */
98 const char * p_name; /* name of procedure */
99};
100
101#ifdef __KERNEL__
102
103struct rpc_create_args {
104 struct net *net;
105 int protocol;
106 struct sockaddr *address;
107 size_t addrsize;
108 struct sockaddr *saddress;
109 const struct rpc_timeout *timeout;
110 const char *servername;
111 const struct rpc_program *program;
112 u32 prognumber; /* overrides program->number */
113 u32 version;
114 rpc_authflavor_t authflavor;
115 unsigned long flags;
116 char *client_name;
117 struct svc_xprt *bc_xprt; /* NFSv4.1 backchannel */
118};
119
120/* Values for "flags" field */
121#define RPC_CLNT_CREATE_HARDRTRY (1UL << 0)
122#define RPC_CLNT_CREATE_AUTOBIND (1UL << 2)
123#define RPC_CLNT_CREATE_NONPRIVPORT (1UL << 3)
124#define RPC_CLNT_CREATE_NOPING (1UL << 4)
125#define RPC_CLNT_CREATE_DISCRTRY (1UL << 5)
126#define RPC_CLNT_CREATE_QUIET (1UL << 6)
127
128struct rpc_clnt *rpc_create(struct rpc_create_args *args);
129struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *,
130 const struct rpc_program *, u32);
131void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt);
132struct rpc_clnt *rpc_clone_client(struct rpc_clnt *);
133struct rpc_clnt *rpc_clone_client_set_auth(struct rpc_clnt *,
134 rpc_authflavor_t);
135void rpc_shutdown_client(struct rpc_clnt *);
136void rpc_release_client(struct rpc_clnt *);
137void rpc_task_release_client(struct rpc_task *);
138
139int rpcb_create_local(struct net *);
140void rpcb_put_local(struct net *);
141int rpcb_register(struct net *, u32, u32, int, unsigned short);
142int rpcb_v4_register(struct net *net, const u32 program,
143 const u32 version,
144 const struct sockaddr *address,
145 const char *netid);
146void rpcb_getport_async(struct rpc_task *);
147
148void rpc_call_start(struct rpc_task *);
149int rpc_call_async(struct rpc_clnt *clnt,
150 const struct rpc_message *msg, int flags,
151 const struct rpc_call_ops *tk_ops,
152 void *calldata);
153int rpc_call_sync(struct rpc_clnt *clnt,
154 const struct rpc_message *msg, int flags);
155struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred,
156 int flags);
157int rpc_restart_call_prepare(struct rpc_task *);
158int rpc_restart_call(struct rpc_task *);
159void rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int);
160int rpc_protocol(struct rpc_clnt *);
161struct net * rpc_net_ns(struct rpc_clnt *);
162size_t rpc_max_payload(struct rpc_clnt *);
163unsigned long rpc_get_timeout(struct rpc_clnt *clnt);
164void rpc_force_rebind(struct rpc_clnt *);
165size_t rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t);
166const char *rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t);
167int rpc_localaddr(struct rpc_clnt *, struct sockaddr *, size_t);
168
169#endif /* __KERNEL__ */
170#endif /* _LINUX_SUNRPC_CLNT_H */