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

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

Version: ~ [ linux-5.2-rc4 ] ~ [ linux-5.1.9 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.50 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.125 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.181 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.181 ] ~ [ 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.68 ] ~ [ 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.39.4 ] ~ [ linux-2.6.38.8 ] ~ [ linux-2.6.37.6 ] ~ [ linux-2.6.36.4 ] ~ [ linux-2.6.35.14 ] ~ [ linux-2.6.34.15 ] ~ [ linux-2.6.33.20 ] ~ [ 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 /*
  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 #include <linux/sunrpc/xprtmultipath.h>
 29 
 30 struct rpc_inode;
 31 
 32 /*
 33  * The high-level client handle
 34  */
 35 struct rpc_clnt {
 36         atomic_t                cl_count;       /* Number of references */
 37         unsigned int            cl_clid;        /* client id */
 38         struct list_head        cl_clients;     /* Global list of clients */
 39         struct list_head        cl_tasks;       /* List of tasks */
 40         spinlock_t              cl_lock;        /* spinlock */
 41         struct rpc_xprt __rcu * cl_xprt;        /* transport */
 42         struct rpc_procinfo *   cl_procinfo;    /* procedure info */
 43         u32                     cl_prog,        /* RPC program number */
 44                                 cl_vers,        /* RPC version number */
 45                                 cl_maxproc;     /* max procedure number */
 46 
 47         struct rpc_auth *       cl_auth;        /* authenticator */
 48         struct rpc_stat *       cl_stats;       /* per-program statistics */
 49         struct rpc_iostats *    cl_metrics;     /* per-client statistics */
 50 
 51         unsigned int            cl_softrtry : 1,/* soft timeouts */
 52                                 cl_discrtry : 1,/* disconnect before retry */
 53                                 cl_noretranstimeo: 1,/* No retransmit timeouts */
 54                                 cl_autobind : 1,/* use getport() */
 55                                 cl_chatty   : 1;/* be verbose */
 56 
 57         struct rpc_rtt *        cl_rtt;         /* RTO estimator data */
 58         const struct rpc_timeout *cl_timeout;   /* Timeout strategy */
 59 
 60         atomic_t                cl_swapper;     /* swapfile count */
 61         int                     cl_nodelen;     /* nodename length */
 62         char                    cl_nodename[UNX_MAXNODENAME+1];
 63         struct rpc_pipe_dir_head cl_pipedir_objects;
 64         struct rpc_clnt *       cl_parent;      /* Points to parent of clones */
 65         struct rpc_rtt          cl_rtt_default;
 66         struct rpc_timeout      cl_timeout_default;
 67         const struct rpc_program *cl_program;
 68 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
 69         struct dentry           *cl_debugfs;    /* debugfs directory */
 70 #endif
 71         struct rpc_xprt_iter    cl_xpi;
 72 };
 73 
 74 /*
 75  * General RPC program info
 76  */
 77 #define RPC_MAXVERSION          4
 78 struct rpc_program {
 79         const char *            name;           /* protocol name */
 80         u32                     number;         /* program number */
 81         unsigned int            nrvers;         /* number of versions */
 82         const struct rpc_version **     version;        /* version array */
 83         struct rpc_stat *       stats;          /* statistics */
 84         const char *            pipe_dir_name;  /* path to rpc_pipefs dir */
 85 };
 86 
 87 struct rpc_version {
 88         u32                     number;         /* version number */
 89         unsigned int            nrprocs;        /* number of procs */
 90         struct rpc_procinfo *   procs;          /* procedure array */
 91 };
 92 
 93 /*
 94  * Procedure information
 95  */
 96 struct rpc_procinfo {
 97         u32                     p_proc;         /* RPC procedure number */
 98         kxdreproc_t             p_encode;       /* XDR encode function */
 99         kxdrdproc_t             p_decode;       /* XDR decode function */
100         unsigned int            p_arglen;       /* argument hdr length (u32) */
101         unsigned int            p_replen;       /* reply hdr length (u32) */
102         unsigned int            p_count;        /* call count */
103         unsigned int            p_timer;        /* Which RTT timer to use */
104         u32                     p_statidx;      /* Which procedure to account */
105         const char *            p_name;         /* name of procedure */
106 };
107 
108 #ifdef __KERNEL__
109 
110 struct rpc_create_args {
111         struct net              *net;
112         int                     protocol;
113         struct sockaddr         *address;
114         size_t                  addrsize;
115         struct sockaddr         *saddress;
116         const struct rpc_timeout *timeout;
117         const char              *servername;
118         const char              *nodename;
119         const struct rpc_program *program;
120         u32                     prognumber;     /* overrides program->number */
121         u32                     version;
122         rpc_authflavor_t        authflavor;
123         unsigned long           flags;
124         char                    *client_name;
125         struct svc_xprt         *bc_xprt;       /* NFSv4.1 backchannel */
126 };
127 
128 /* Values for "flags" field */
129 #define RPC_CLNT_CREATE_HARDRTRY        (1UL << 0)
130 #define RPC_CLNT_CREATE_AUTOBIND        (1UL << 2)
131 #define RPC_CLNT_CREATE_NONPRIVPORT     (1UL << 3)
132 #define RPC_CLNT_CREATE_NOPING          (1UL << 4)
133 #define RPC_CLNT_CREATE_DISCRTRY        (1UL << 5)
134 #define RPC_CLNT_CREATE_QUIET           (1UL << 6)
135 #define RPC_CLNT_CREATE_INFINITE_SLOTS  (1UL << 7)
136 #define RPC_CLNT_CREATE_NO_IDLE_TIMEOUT (1UL << 8)
137 #define RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT      (1UL << 9)
138 
139 struct rpc_clnt *rpc_create(struct rpc_create_args *args);
140 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *,
141                                 const struct rpc_program *, u32);
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 int             rpc_clnt_iterate_for_each_xprt(struct rpc_clnt *clnt,
184                         int (*fn)(struct rpc_clnt *, struct rpc_xprt *, void *),
185                         void *data);
186 
187 int             rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt,
188                         struct rpc_xprt_switch *xps,
189                         struct rpc_xprt *xprt,
190                         void *dummy);
191 int             rpc_clnt_add_xprt(struct rpc_clnt *, struct xprt_create *,
192                         int (*setup)(struct rpc_clnt *,
193                                 struct rpc_xprt_switch *,
194                                 struct rpc_xprt *,
195                                 void *),
196                         void *data);
197 
198 const char *rpc_proc_name(const struct rpc_task *task);
199 #endif /* __KERNEL__ */
200 #endif /* _LINUX_SUNRPC_CLNT_H */
201 

~ [ 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