2 * nfsrpc.h -- RPC client APIs provided by support/nfs
4 * Copyright (C) 2008 Oracle Corporation. All rights reserved.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public
17 * License along with this program; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 021110-1307, USA.
23 #ifndef __NFS_UTILS_NFSRPC_H
24 #define __NFS_UTILS_NFSRPC_H
26 #include <rpc/types.h>
30 * Conventional RPC program numbers
33 #define RPCBPROG ((rpcprog_t)100000)
36 #define PMAPPROG ((rpcprog_t)100000)
40 #define NFSPROG ((rpcprog_t)100003)
43 #define MOUNTPROG ((rpcprog_t)100005)
46 #define NLMPROG ((rpcprog_t)100021)
49 #define NSMPROG ((rpcprog_t)100024)
53 * nfs_clear_rpc_createerr - zap all error reporting fields
56 static inline void nfs_clear_rpc_createerr(void)
58 memset(&rpc_createerr, 0, sizeof(rpc_createerr));
62 * Look up an RPC program name in /etc/rpc
64 extern rpcprog_t nfs_getrpcbyname(const rpcprog_t, const char *table[]);
67 * Acquire an RPC CLIENT * with an ephemeral source port
69 extern CLIENT *nfs_get_rpcclient(const struct sockaddr *,
70 const socklen_t, const unsigned short,
71 const rpcprog_t, const rpcvers_t,
75 * Acquire an RPC CLIENT * with a privileged source port
77 extern CLIENT *nfs_get_priv_rpcclient( const struct sockaddr *,
78 const socklen_t, const unsigned short,
79 const rpcprog_t, const rpcvers_t,
83 * Convert a netid to a protocol number and protocol family
85 extern int nfs_get_proto(const char *netid, sa_family_t *family,
86 unsigned long *protocol);
89 * Convert a protocol family and protocol name to a netid
91 extern char *nfs_get_netid(const sa_family_t family,
92 const unsigned long protocol);
95 * Convert a socket address to a universal address
97 extern char *nfs_sockaddr2universal(const struct sockaddr *);
100 * Extract port number from a universal address
102 extern int nfs_universal2port(const char *);
105 * Generic function that maps an RPC service tuple to an IP port
106 * number of the service on a remote post, and sends a NULL
107 * request to determine if the service is responding to requests
109 extern int nfs_getport_ping(struct sockaddr *sap,
110 const socklen_t salen,
111 const rpcprog_t program,
112 const rpcvers_t version,
113 const unsigned short protocol);
116 * Generic function that maps an RPC service tuple to an IP port
117 * number of the service on a remote host
119 extern unsigned short nfs_getport(const struct sockaddr *,
120 const socklen_t, const rpcprog_t,
121 const rpcvers_t, const unsigned short);
124 * Generic function that maps an RPC service tuple to an IP port
125 * number of the service on the local host
127 extern unsigned short nfs_getlocalport(const rpcprot_t,
128 const rpcvers_t, const unsigned short);
131 * Function to invoke an rpcbind v3/v4 GETADDR request
133 extern unsigned short nfs_rpcb_getaddr(const struct sockaddr *,
135 const unsigned short,
136 const struct sockaddr *,
139 const unsigned short,
140 const struct timeval *);
143 * Function to invoke a portmap GETPORT request
145 extern unsigned long nfs_pmap_getport(const struct sockaddr_in *,
146 const unsigned short,
150 const struct timeval *);
153 * Contact a remote RPC service to discover whether it is responding
156 extern int nfs_rpc_ping(const struct sockaddr *sap,
157 const socklen_t salen,
158 const rpcprog_t program,
159 const rpcvers_t version,
160 const unsigned short protocol,
161 const struct timeval *timeout);
163 #endif /* !__NFS_UTILS_NFSRPC_H */