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>
29 * Conventional RPC program numbers
32 #define RPCBPROG ((rpcprog_t)100000)
35 #define PMAPPROG ((rpcprog_t)100000)
39 #define NFSPROG ((rpcprog_t)100003)
42 #define MOUNTPROG ((rpcprog_t)100005)
45 #define NLMPROG ((rpcprog_t)100021)
48 #define NSMPROG ((rpcprog_t)100024)
52 * Look up an RPC program name in /etc/rpc
54 extern rpcprog_t nfs_getrpcbyname(const rpcprog_t, const char *table[]);
57 * Look up a port number in /etc/services for an RPC program
59 extern unsigned short nfs_getportbynumber(const rpcprog_t program,
60 const unsigned short transport);
63 * Acquire an RPC CLIENT *
65 extern CLIENT *nfs_get_rpcclient(const struct sockaddr *,
66 const socklen_t, const unsigned short,
67 const rpcprog_t, const rpcvers_t,
71 * Convert a socket address to a universal address
73 extern char *nfs_sockaddr2universal(const struct sockaddr *,
77 * Extract port number from a universal address
79 extern int nfs_universal2port(const char *);
82 * Generic function that maps an RPC service tuple to an IP port
83 * number of the service on a remote post, and sends a NULL
84 * request to determine if the service is responding to requests
86 extern int nfs_getport_ping(struct sockaddr *sap,
87 const socklen_t salen,
88 const rpcprog_t program,
89 const rpcvers_t version,
90 const unsigned short protocol);
93 * Generic function that maps an RPC service tuple to an IP port
94 * number of the service on a remote host
96 extern unsigned short nfs_getport(const struct sockaddr *,
97 const socklen_t, const rpcprog_t,
98 const rpcvers_t, const unsigned short);
101 * Generic function that maps an RPC service tuple to an IP port
102 * number of the service on the local host
104 extern unsigned short nfs_getlocalport(const rpcprot_t,
105 const rpcvers_t, const unsigned short);
108 * Function to invoke an rpcbind v3/v4 GETADDR request
110 extern unsigned short nfs_rpcb_getaddr(const struct sockaddr *,
112 const unsigned short,
113 const struct sockaddr *,
117 const unsigned short,
118 const struct timeval *);
121 * Function to invoke a portmap GETPORT request
123 extern unsigned long nfs_pmap_getport(const struct sockaddr_in *,
124 const unsigned short,
128 const struct timeval *);
131 * Contact a remote RPC service to discover whether it is responding
134 extern int nfs_rpc_ping(const struct sockaddr *sap,
135 const socklen_t salen,
136 const rpcprog_t program,
137 const rpcvers_t version,
138 const unsigned short protocol,
139 const struct timeval *timeout);
141 #endif /* __NFS_UTILS_NFSRPC_H */