support/include/nfsrpc.h

   1 /*
   2  * nfsrpc.h -- RPC client APIs provided by support/nfs
   3  *
   4  * Copyright (C) 2008 Oracle Corporation.  All rights reserved.
   5  *
   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.
  10  *
  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.
  15  *
  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.
  20  *
  21  */
  22
  23 #ifndef __NFS_UTILS_NFSRPC_H
  24 #define __NFS_UTILS_NFSRPC_H
  25
  26 #include <rpc/types.h>
  27
  28 /*
  29  * Conventional RPC program numbers
  30  */
  31 #ifndef RPCBPROG
  32 #define RPCBPROG        ((rpcprog_t)100000)
  33 #endif
  34 #ifndef PMAPPROG
  35 #define PMAPPROG        ((rpcprog_t)100000)
  36 #endif
  37
  38 #ifndef NFSPROG
  39 #define NFSPROG         ((rpcprog_t)100003)
  40 #endif
  41 #ifndef MOUNTPROG
  42 #define MOUNTPROG       ((rpcprog_t)100005)
  43 #endif
  44 #ifndef NLMPROG
  45 #define NLMPROG         ((rpcprog_t)100021)
  46 #endif
  47 #ifndef NSMPROG
  48 #define NSMPROG         ((rpcprog_t)100024)
  49 #endif
  50
  51 /*
  52  * Look up an RPC program name in /etc/rpc
  53  */
  54 extern rpcprog_t        nfs_getrpcbyname(const rpcprog_t, const char *table[]);
  55
  56 /*
  57  * Acquire an RPC CLIENT *
  58  */
  59 extern CLIENT           *nfs_get_rpcclient(const struct sockaddr *,
  60                                 const socklen_t, const unsigned short,
  61                                 const rpcprog_t, const rpcvers_t,
  62                                 struct timeval *);
  63
  64 /*
  65  * Convert a socket address to a universal address
  66  */
  67 extern char             *nfs_sockaddr2universal(const struct sockaddr *,
  68                                 const socklen_t);
  69
  70 /*
  71  * Extract port number from a universal address
  72  */
  73 extern int              nfs_universal2port(const char *);
  74
  75 /*
  76  * Generic function that maps an RPC service tuple to an IP port
  77  * number of the service on a remote post, and sends a NULL
  78  * request to determine if the service is responding to requests
  79  */
  80 extern int              nfs_getport_ping(struct sockaddr *sap,
  81                                 const socklen_t salen,
  82                                 const rpcprog_t program,
  83                                 const rpcvers_t version,
  84                                 const unsigned short protocol);
  85
  86 /*
  87  * Generic function that maps an RPC service tuple to an IP port
  88  * number of the service on a remote host
  89  */
  90 extern unsigned short   nfs_getport(const struct sockaddr *,
  91                                 const socklen_t, const rpcprog_t,
  92                                 const rpcvers_t, const unsigned short);
  93
  94 /*
  95  * Generic function that maps an RPC service tuple to an IP port
  96  * number of the service on the local host
  97  */
  98 extern unsigned short   nfs_getlocalport(const rpcprot_t,
  99                                 const rpcvers_t, const unsigned short);
 100
 101 /*
 102  * Function to invoke an rpcbind v3/v4 GETADDR request
 103  */
 104 extern unsigned short   nfs_rpcb_getaddr(const struct sockaddr *,
 105                                 const socklen_t,
 106                                 const unsigned short,
 107                                 const struct sockaddr *,
 108                                 const socklen_t,
 109                                 const rpcprog_t,
 110                                 const rpcvers_t,
 111                                 const unsigned short,
 112                                 const struct timeval *);
 113
 114 /*
 115  * Function to invoke a portmap GETPORT request
 116  */
 117 extern unsigned long    nfs_pmap_getport(const struct sockaddr_in *,
 118                                 const unsigned short,
 119                                 const unsigned long,
 120                                 const unsigned long,
 121                                 const unsigned long,
 122                                 const struct timeval *);
 123
 124 /*
 125  * Contact a remote RPC service to discover whether it is responding
 126  * to requests.
 127  */
 128 extern int              nfs_rpc_ping(const struct sockaddr *sap,
 129                                 const socklen_t salen,
 130                                 const rpcprog_t program,
 131                                 const rpcvers_t version,
 132                                 const unsigned short protocol,
 133                                 const struct timeval *timeout);
 134
 135 #endif  /* __NFS_UTILS_NFSRPC_H */