Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Chuck Lever | a02d692 | 2009-08-09 15:09:34 -0400 | [diff] [blame] | 12 | #include <linux/socket.h> |
| 13 | #include <linux/in.h> |
| 14 | #include <linux/in6.h> |
| 15 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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> |
Trond Myklebust | 7d217ca | 2009-08-09 15:14:24 -0400 | [diff] [blame] | 24 | #include <linux/path.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 25 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 26 | struct rpc_inode; |
| 27 | |
| 28 | /* |
| 29 | * The high-level client handle |
| 30 | */ |
| 31 | struct rpc_clnt { |
Trond Myklebust | 34f52e3 | 2007-06-14 16:40:31 -0400 | [diff] [blame] | 32 | struct kref cl_kref; /* Number of references */ |
Trond Myklebust | 6529eba | 2007-06-14 16:40:14 -0400 | [diff] [blame] | 33 | struct list_head cl_clients; /* Global list of clients */ |
| 34 | struct list_head cl_tasks; /* List of tasks */ |
Trond Myklebust | 4bef61f | 2007-06-16 14:17:01 -0400 | [diff] [blame] | 35 | spinlock_t cl_lock; /* spinlock */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 36 | struct rpc_xprt * cl_xprt; /* transport */ |
| 37 | struct rpc_procinfo * cl_procinfo; /* procedure info */ |
Chuck Lever | 4a68179 | 2006-08-22 20:06:15 -0400 | [diff] [blame] | 38 | u32 cl_prog, /* RPC program number */ |
| 39 | cl_vers, /* RPC version number */ |
| 40 | cl_maxproc; /* max procedure number */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 41 | |
| 42 | char * cl_server; /* server machine name */ |
| 43 | char * cl_protname; /* protocol name */ |
| 44 | struct rpc_auth * cl_auth; /* authenticator */ |
Chuck Lever | 11c556b | 2006-03-20 13:44:22 -0500 | [diff] [blame] | 45 | struct rpc_stat * cl_stats; /* per-program statistics */ |
| 46 | struct rpc_iostats * cl_metrics; /* per-client statistics */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 47 | |
| 48 | unsigned int cl_softrtry : 1,/* soft timeouts */ |
Chuck Lever | 43d78ef | 2007-02-06 18:26:11 -0500 | [diff] [blame] | 49 | cl_discrtry : 1,/* disconnect before retry */ |
Olga Kornievskaia | b6b6152 | 2008-06-09 16:51:31 -0400 | [diff] [blame] | 50 | cl_autobind : 1,/* use getport() */ |
| 51 | cl_chatty : 1;/* be verbose */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 52 | |
| 53 | struct rpc_rtt * cl_rtt; /* RTO estimator data */ |
Trond Myklebust | ba7392b | 2007-12-20 16:03:55 -0500 | [diff] [blame] | 54 | const struct rpc_timeout *cl_timeout; /* Timeout strategy */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 55 | |
| 56 | int cl_nodelen; /* nodename length */ |
| 57 | char cl_nodename[UNX_MAXNODENAME]; |
Trond Myklebust | 7d217ca | 2009-08-09 15:14:24 -0400 | [diff] [blame] | 58 | struct path cl_path; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 59 | struct rpc_clnt * cl_parent; /* Points to parent of clones */ |
| 60 | struct rpc_rtt cl_rtt_default; |
Trond Myklebust | ba7392b | 2007-12-20 16:03:55 -0500 | [diff] [blame] | 61 | struct rpc_timeout cl_timeout_default; |
Trond Myklebust | 3e32a5d | 2006-11-16 11:37:27 -0500 | [diff] [blame] | 62 | struct rpc_program * cl_program; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 63 | char cl_inline_name[32]; |
Olga Kornievskaia | 608207e | 2008-12-23 16:17:40 -0500 | [diff] [blame] | 64 | char *cl_principal; /* target to authenticate to */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 65 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 66 | |
| 67 | /* |
| 68 | * General RPC program info |
| 69 | */ |
| 70 | #define RPC_MAXVERSION 4 |
| 71 | struct rpc_program { |
| 72 | char * name; /* protocol name */ |
| 73 | u32 number; /* program number */ |
| 74 | unsigned int nrvers; /* number of versions */ |
| 75 | struct rpc_version ** version; /* version array */ |
| 76 | struct rpc_stat * stats; /* statistics */ |
| 77 | char * pipe_dir_name; /* path to rpc_pipefs dir */ |
| 78 | }; |
| 79 | |
| 80 | struct 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 | */ |
| 89 | struct rpc_procinfo { |
| 90 | u32 p_proc; /* RPC procedure number */ |
| 91 | kxdrproc_t p_encode; /* XDR encode function */ |
| 92 | kxdrproc_t p_decode; /* XDR decode function */ |
Chuck Lever | 2bea90d | 2007-03-29 16:47:53 -0400 | [diff] [blame] | 93 | unsigned int p_arglen; /* argument hdr length (u32) */ |
| 94 | unsigned int p_replen; /* reply hdr length (u32) */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 95 | unsigned int p_count; /* call count */ |
| 96 | unsigned int p_timer; /* Which RTT timer to use */ |
Chuck Lever | cc0175c | 2006-03-20 13:44:22 -0500 | [diff] [blame] | 97 | u32 p_statidx; /* Which procedure to account */ |
| 98 | char * p_name; /* name of procedure */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 99 | }; |
| 100 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 101 | #ifdef __KERNEL__ |
| 102 | |
Chuck Lever | c286676 | 2006-08-22 20:06:20 -0400 | [diff] [blame] | 103 | struct rpc_create_args { |
| 104 | int protocol; |
| 105 | struct sockaddr *address; |
| 106 | size_t addrsize; |
Frank van Maarseveen | d3bc9a1 | 2007-07-09 22:23:35 +0200 | [diff] [blame] | 107 | struct sockaddr *saddress; |
Trond Myklebust | ba7392b | 2007-12-20 16:03:55 -0500 | [diff] [blame] | 108 | const struct rpc_timeout *timeout; |
Chuck Lever | c286676 | 2006-08-22 20:06:20 -0400 | [diff] [blame] | 109 | char *servername; |
| 110 | struct rpc_program *program; |
Benny Halevy | d5b337b | 2008-09-28 09:21:26 +0300 | [diff] [blame] | 111 | u32 prognumber; /* overrides program->number */ |
Chuck Lever | c286676 | 2006-08-22 20:06:20 -0400 | [diff] [blame] | 112 | u32 version; |
| 113 | rpc_authflavor_t authflavor; |
| 114 | unsigned long flags; |
Olga Kornievskaia | 608207e | 2008-12-23 16:17:40 -0500 | [diff] [blame] | 115 | char *client_name; |
Chuck Lever | c286676 | 2006-08-22 20:06:20 -0400 | [diff] [blame] | 116 | }; |
| 117 | |
| 118 | /* Values for "flags" field */ |
| 119 | #define RPC_CLNT_CREATE_HARDRTRY (1UL << 0) |
Chuck Lever | c286676 | 2006-08-22 20:06:20 -0400 | [diff] [blame] | 120 | #define RPC_CLNT_CREATE_AUTOBIND (1UL << 2) |
Trond Myklebust | 90c5755 | 2007-06-09 19:49:36 -0400 | [diff] [blame] | 121 | #define RPC_CLNT_CREATE_NONPRIVPORT (1UL << 3) |
| 122 | #define RPC_CLNT_CREATE_NOPING (1UL << 4) |
| 123 | #define RPC_CLNT_CREATE_DISCRTRY (1UL << 5) |
Olga Kornievskaia | b6b6152 | 2008-06-09 16:51:31 -0400 | [diff] [blame] | 124 | #define RPC_CLNT_CREATE_QUIET (1UL << 6) |
Chuck Lever | c286676 | 2006-08-22 20:06:20 -0400 | [diff] [blame] | 125 | |
| 126 | struct rpc_clnt *rpc_create(struct rpc_create_args *args); |
Andreas Gruenbacher | 007e251 | 2005-06-22 17:16:23 +0000 | [diff] [blame] | 127 | struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *, |
Chuck Lever | 89eb21c | 2007-09-11 18:00:09 -0400 | [diff] [blame] | 128 | struct rpc_program *, u32); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 129 | struct rpc_clnt *rpc_clone_client(struct rpc_clnt *); |
Trond Myklebust | 4c402b4 | 2007-06-14 16:40:32 -0400 | [diff] [blame] | 130 | void rpc_shutdown_client(struct rpc_clnt *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 131 | void rpc_release_client(struct rpc_clnt *); |
Chuck Lever | cce63cd | 2007-07-01 12:13:12 -0400 | [diff] [blame] | 132 | |
Chuck Lever | 14aeb21 | 2008-08-18 19:34:00 -0400 | [diff] [blame] | 133 | int rpcb_register(u32, u32, int, unsigned short); |
Chuck Lever | c2e1b09 | 2008-07-14 16:03:30 -0400 | [diff] [blame] | 134 | int rpcb_v4_register(const u32 program, const u32 version, |
| 135 | const struct sockaddr *address, |
Chuck Lever | 14aeb21 | 2008-08-18 19:34:00 -0400 | [diff] [blame] | 136 | const char *netid); |
Chuck Lever | f1ec08c | 2008-01-14 15:11:53 -0500 | [diff] [blame] | 137 | int rpcb_getport_sync(struct sockaddr_in *, u32, u32, int); |
Chuck Lever | 45160d6 | 2007-07-01 12:13:17 -0400 | [diff] [blame] | 138 | void rpcb_getport_async(struct rpc_task *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 139 | |
Trond Myklebust | 77de2c5 | 2007-10-25 18:40:21 -0400 | [diff] [blame] | 140 | void rpc_call_start(struct rpc_task *); |
Trond Myklebust | cbc2005 | 2008-02-14 11:11:30 -0500 | [diff] [blame] | 141 | int rpc_call_async(struct rpc_clnt *clnt, |
| 142 | const struct rpc_message *msg, int flags, |
| 143 | const struct rpc_call_ops *tk_ops, |
Trond Myklebust | 963d8fe | 2006-01-03 09:55:04 +0100 | [diff] [blame] | 144 | void *calldata); |
Trond Myklebust | cbc2005 | 2008-02-14 11:11:30 -0500 | [diff] [blame] | 145 | int rpc_call_sync(struct rpc_clnt *clnt, |
| 146 | const struct rpc_message *msg, int flags); |
Trond Myklebust | 5e1550d | 2007-06-23 10:17:16 -0400 | [diff] [blame] | 147 | struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, |
| 148 | int flags); |
Andy Adamson | aae2006 | 2009-04-01 09:22:40 -0400 | [diff] [blame] | 149 | void rpc_restart_call_prepare(struct rpc_task *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 150 | void rpc_restart_call(struct rpc_task *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 151 | void rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int); |
| 152 | size_t rpc_max_payload(struct rpc_clnt *); |
Chuck Lever | 35f5a42 | 2006-01-03 09:55:50 +0100 | [diff] [blame] | 153 | void rpc_force_rebind(struct rpc_clnt *); |
Chuck Lever | ed39440 | 2006-08-22 20:06:17 -0400 | [diff] [blame] | 154 | size_t rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t); |
Chuck Lever | b454ae9 | 2008-01-07 18:34:48 -0500 | [diff] [blame] | 155 | const char *rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 156 | |
Chuck Lever | a02d692 | 2009-08-09 15:09:34 -0400 | [diff] [blame] | 157 | size_t rpc_ntop(const struct sockaddr *, char *, const size_t); |
| 158 | size_t rpc_pton(const char *, const size_t, |
| 159 | struct sockaddr *, const size_t); |
| 160 | char * rpc_sockaddr2uaddr(const struct sockaddr *); |
| 161 | size_t rpc_uaddr2sockaddr(const char *, const size_t, |
| 162 | struct sockaddr *, const size_t); |
| 163 | |
| 164 | static inline unsigned short rpc_get_port(const struct sockaddr *sap) |
| 165 | { |
| 166 | switch (sap->sa_family) { |
| 167 | case AF_INET: |
| 168 | return ntohs(((struct sockaddr_in *)sap)->sin_port); |
| 169 | case AF_INET6: |
| 170 | return ntohs(((struct sockaddr_in6 *)sap)->sin6_port); |
| 171 | } |
| 172 | return 0; |
| 173 | } |
| 174 | |
| 175 | static inline void rpc_set_port(struct sockaddr *sap, |
| 176 | const unsigned short port) |
| 177 | { |
| 178 | switch (sap->sa_family) { |
| 179 | case AF_INET: |
| 180 | ((struct sockaddr_in *)sap)->sin_port = htons(port); |
| 181 | break; |
| 182 | case AF_INET6: |
| 183 | ((struct sockaddr_in6 *)sap)->sin6_port = htons(port); |
| 184 | break; |
| 185 | } |
| 186 | } |
| 187 | |
| 188 | #define IPV6_SCOPE_DELIMITER '%' |
| 189 | #define IPV6_SCOPE_ID_LEN sizeof("%nnnnnnnnnn") |
| 190 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 191 | #endif /* __KERNEL__ */ |
| 192 | #endif /* _LINUX_SUNRPC_CLNT_H */ |