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 | |
| 12 | #include <linux/sunrpc/msg_prot.h> |
| 13 | #include <linux/sunrpc/sched.h> |
| 14 | #include <linux/sunrpc/xprt.h> |
| 15 | #include <linux/sunrpc/auth.h> |
| 16 | #include <linux/sunrpc/stats.h> |
| 17 | #include <linux/sunrpc/xdr.h> |
| 18 | #include <linux/sunrpc/timer.h> |
| 19 | #include <asm/signal.h> |
| 20 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 21 | struct rpc_inode; |
| 22 | |
| 23 | /* |
| 24 | * The high-level client handle |
| 25 | */ |
| 26 | struct rpc_clnt { |
| 27 | atomic_t cl_count; /* Number of clones */ |
| 28 | atomic_t cl_users; /* number of references */ |
| 29 | struct rpc_xprt * cl_xprt; /* transport */ |
| 30 | struct rpc_procinfo * cl_procinfo; /* procedure info */ |
Chuck Lever | 4a68179 | 2006-08-22 20:06:15 -0400 | [diff] [blame] | 31 | u32 cl_prog, /* RPC program number */ |
| 32 | cl_vers, /* RPC version number */ |
| 33 | cl_maxproc; /* max procedure number */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 34 | |
| 35 | char * cl_server; /* server machine name */ |
| 36 | char * cl_protname; /* protocol name */ |
| 37 | struct rpc_auth * cl_auth; /* authenticator */ |
Chuck Lever | 11c556b | 2006-03-20 13:44:22 -0500 | [diff] [blame] | 38 | struct rpc_stat * cl_stats; /* per-program statistics */ |
| 39 | struct rpc_iostats * cl_metrics; /* per-client statistics */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 40 | |
| 41 | unsigned int cl_softrtry : 1,/* soft timeouts */ |
| 42 | cl_intr : 1,/* interruptible */ |
Chuck Lever | 43d78ef | 2007-02-06 18:26:11 -0500 | [diff] [blame] | 43 | cl_discrtry : 1,/* disconnect before retry */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 44 | cl_autobind : 1,/* use getport() */ |
| 45 | cl_oneshot : 1,/* dispose after use */ |
| 46 | cl_dead : 1;/* abandoned */ |
| 47 | |
| 48 | struct rpc_rtt * cl_rtt; /* RTO estimator data */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 49 | |
| 50 | int cl_nodelen; /* nodename length */ |
| 51 | char cl_nodename[UNX_MAXNODENAME]; |
| 52 | char cl_pathname[30];/* Path in rpc_pipe_fs */ |
Trond Myklebust | 5428154 | 2006-03-20 13:44:49 -0500 | [diff] [blame] | 53 | struct vfsmount * cl_vfsmnt; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 54 | struct dentry * cl_dentry; /* inode */ |
| 55 | struct rpc_clnt * cl_parent; /* Points to parent of clones */ |
| 56 | struct rpc_rtt cl_rtt_default; |
Trond Myklebust | 3e32a5d | 2006-11-16 11:37:27 -0500 | [diff] [blame] | 57 | struct rpc_program * cl_program; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 58 | char cl_inline_name[32]; |
| 59 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 60 | |
| 61 | /* |
| 62 | * General RPC program info |
| 63 | */ |
| 64 | #define RPC_MAXVERSION 4 |
| 65 | struct rpc_program { |
| 66 | char * name; /* protocol name */ |
| 67 | u32 number; /* program number */ |
| 68 | unsigned int nrvers; /* number of versions */ |
| 69 | struct rpc_version ** version; /* version array */ |
| 70 | struct rpc_stat * stats; /* statistics */ |
| 71 | char * pipe_dir_name; /* path to rpc_pipefs dir */ |
| 72 | }; |
| 73 | |
| 74 | struct rpc_version { |
| 75 | u32 number; /* version number */ |
| 76 | unsigned int nrprocs; /* number of procs */ |
| 77 | struct rpc_procinfo * procs; /* procedure array */ |
| 78 | }; |
| 79 | |
| 80 | /* |
| 81 | * Procedure information |
| 82 | */ |
| 83 | struct rpc_procinfo { |
| 84 | u32 p_proc; /* RPC procedure number */ |
| 85 | kxdrproc_t p_encode; /* XDR encode function */ |
| 86 | kxdrproc_t p_decode; /* XDR decode function */ |
Chuck Lever | 2bea90d | 2007-03-29 16:47:53 -0400 | [diff] [blame] | 87 | unsigned int p_arglen; /* argument hdr length (u32) */ |
| 88 | unsigned int p_replen; /* reply hdr length (u32) */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 89 | unsigned int p_count; /* call count */ |
| 90 | unsigned int p_timer; /* Which RTT timer to use */ |
Chuck Lever | cc0175c | 2006-03-20 13:44:22 -0500 | [diff] [blame] | 91 | u32 p_statidx; /* Which procedure to account */ |
| 92 | char * p_name; /* name of procedure */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 93 | }; |
| 94 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 95 | #ifdef __KERNEL__ |
| 96 | |
Chuck Lever | c286676 | 2006-08-22 20:06:20 -0400 | [diff] [blame] | 97 | struct rpc_create_args { |
| 98 | int protocol; |
| 99 | struct sockaddr *address; |
| 100 | size_t addrsize; |
| 101 | struct rpc_timeout *timeout; |
| 102 | char *servername; |
| 103 | struct rpc_program *program; |
| 104 | u32 version; |
| 105 | rpc_authflavor_t authflavor; |
| 106 | unsigned long flags; |
| 107 | }; |
| 108 | |
| 109 | /* Values for "flags" field */ |
| 110 | #define RPC_CLNT_CREATE_HARDRTRY (1UL << 0) |
| 111 | #define RPC_CLNT_CREATE_INTR (1UL << 1) |
| 112 | #define RPC_CLNT_CREATE_AUTOBIND (1UL << 2) |
| 113 | #define RPC_CLNT_CREATE_ONESHOT (1UL << 3) |
| 114 | #define RPC_CLNT_CREATE_NONPRIVPORT (1UL << 4) |
| 115 | #define RPC_CLNT_CREATE_NOPING (1UL << 5) |
Chuck Lever | 43d78ef | 2007-02-06 18:26:11 -0500 | [diff] [blame] | 116 | #define RPC_CLNT_CREATE_DISCRTRY (1UL << 6) |
Chuck Lever | c286676 | 2006-08-22 20:06:20 -0400 | [diff] [blame] | 117 | |
| 118 | struct rpc_clnt *rpc_create(struct rpc_create_args *args); |
Andreas Gruenbacher | 007e251 | 2005-06-22 17:16:23 +0000 | [diff] [blame] | 119 | struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *, |
| 120 | struct rpc_program *, int); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 121 | struct rpc_clnt *rpc_clone_client(struct rpc_clnt *); |
| 122 | int rpc_shutdown_client(struct rpc_clnt *); |
| 123 | int rpc_destroy_client(struct rpc_clnt *); |
| 124 | void rpc_release_client(struct rpc_clnt *); |
Chuck Lever | a509050 | 2007-03-29 16:48:04 -0400 | [diff] [blame] | 125 | int rpcb_register(u32, u32, int, unsigned short, int *); |
| 126 | void rpcb_getport(struct rpc_task *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 127 | |
| 128 | void rpc_call_setup(struct rpc_task *, struct rpc_message *, int); |
| 129 | |
| 130 | int rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, |
Trond Myklebust | 963d8fe | 2006-01-03 09:55:04 +0100 | [diff] [blame] | 131 | int flags, const struct rpc_call_ops *tk_ops, |
| 132 | void *calldata); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 133 | int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, |
| 134 | int flags); |
| 135 | void rpc_restart_call(struct rpc_task *); |
| 136 | void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset); |
| 137 | void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset); |
| 138 | void rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int); |
| 139 | size_t rpc_max_payload(struct rpc_clnt *); |
Chuck Lever | 35f5a42 | 2006-01-03 09:55:50 +0100 | [diff] [blame] | 140 | void rpc_force_rebind(struct rpc_clnt *); |
Trond Myklebust | 5ee0ed7 | 2005-06-22 17:16:20 +0000 | [diff] [blame] | 141 | int rpc_ping(struct rpc_clnt *clnt, int flags); |
Chuck Lever | ed39440 | 2006-08-22 20:06:17 -0400 | [diff] [blame] | 142 | size_t rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t); |
Chuck Lever | f425eba | 2006-08-22 20:06:18 -0400 | [diff] [blame] | 143 | char * rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 144 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 145 | /* |
| 146 | * Helper function for NFSroot support |
| 147 | */ |
Chuck Lever | a509050 | 2007-03-29 16:48:04 -0400 | [diff] [blame] | 148 | int rpcb_getport_external(struct sockaddr_in *, __u32, __u32, int); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 149 | |
| 150 | #endif /* __KERNEL__ */ |
| 151 | #endif /* _LINUX_SUNRPC_CLNT_H */ |