~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/sunrpc/clnt.h

Version: ~ [ linux-5.4-rc1 ] ~ [ linux-5.3.2 ] ~ [ linux-5.2.18 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.76 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.146 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.194 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.194 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.74 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-3.9.11 ] ~ [ linux-3.8.13 ] ~ [ linux-3.7.10 ] ~ [ linux-3.6.11 ] ~ [ linux-3.5.7 ] ~ [ linux-3.4.113 ] ~ [ linux-3.3.8 ] ~ [ linux-3.2.102 ] ~ [ linux-3.1.10 ] ~ [ linux-3.0.101 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp