include/libnfs-private.h

   1 /*
   2    Copyright (C) 2010 by Ronnie Sahlberg <ronniesahlberg@gmail.com>
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU Lesser General Public License as published by
   6    the Free Software Foundation; either version 2.1 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU Lesser General Public License for more details.
  13
  14    You should have received a copy of the GNU Lesser General Public License
  15    along with this program; if not, see <http://www.gnu.org/licenses/>.
  16 */
  17
  18 #ifndef _LIBNFS_PRIVATE_H_
  19 #define _LIBNFS_PRIVATE_H_
  20
  21 #ifdef HAVE_CONFIG_H
  22 #include "config.h"  /* HAVE_SOCKADDR_STORAGE ? */
  23 #endif
  24
  25 #ifndef WIN32
  26 #include <sys/socket.h>  /* struct sockaddr_storage */
  27 #endif
  28
  29 #include "libnfs-zdr.h"
  30
  31
  32 #if !defined(HAVE_SOCKADDR_STORAGE) && !defined(WIN32)
  33 /*
  34  * RFC 2553: protocol-independent placeholder for socket addresses
  35  */
  36 #define _SS_MAXSIZE     128
  37 #define _SS_ALIGNSIZE   (sizeof(double))
  38 #define _SS_PAD1SIZE    (_SS_ALIGNSIZE - sizeof(unsigned char) * 2)
  39 #define _SS_PAD2SIZE    (_SS_MAXSIZE - sizeof(unsigned char) * 2 - \
  40                                 _SS_PAD1SIZE - _SS_ALIGNSIZE)
  41
  42 struct sockaddr_storage {
  43 #ifdef HAVE_SOCKADDR_LEN
  44         unsigned char ss_len;           /* address length */
  45         unsigned char ss_family;        /* address family */
  46 #else
  47         unsigned short ss_family;
  48 #endif
  49         char    __ss_pad1[_SS_PAD1SIZE];
  50         double  __ss_align;     /* force desired structure storage alignment */
  51         char    __ss_pad2[_SS_PAD2SIZE];
  52 };
  53 #endif
  54
  55
  56 struct rpc_fragment {
  57         struct rpc_fragment *next;
  58         uint64_t size;
  59         char *data;
  60 };
  61
  62 #define RPC_CONTEXT_MAGIC 0xc6e46435
  63 #define RPC_PARAM_UNDEFINED -1
  64
  65 struct rpc_context {
  66         uint32_t magic;
  67         int fd;
  68         int is_connected;
  69
  70         char *error_string;
  71
  72         rpc_cb connect_cb;
  73         void *connect_data;
  74
  75         struct AUTH *auth;
  76         uint32_t xid;
  77
  78         /* buffer used for encoding RPC PDU */
  79         char *encodebuf;
  80         int encodebuflen;
  81
  82         struct rpc_pdu *outqueue;
  83         struct sockaddr_storage udp_src;
  84         struct rpc_pdu *waitpdu;
  85
  86         uint32_t inpos;
  87         uint32_t insize;
  88         char *inbuf;
  89
  90         /* special fields for UDP, which can sometimes be BROADCASTed */
  91         int is_udp;
  92         struct sockaddr *udp_dest;
  93         int is_broadcast;
  94
  95         /* track the address we connect to so we can auto-reconnect on session failure */
  96         struct sockaddr_storage s;
  97         int auto_reconnect;
  98
  99         /* fragment reassembly */
 100         struct rpc_fragment *fragments;
 101
 102         /* parameters passable via URL */
 103         int tcp_syncnt;
 104         int uid;
 105         int gid;
 106 };
 107
 108 struct rpc_pdu {
 109         struct rpc_pdu *next;
 110
 111         uint32_t xid;
 112         ZDR zdr;
 113
 114         uint32_t written;
 115         struct rpc_data outdata;
 116
 117         rpc_cb cb;
 118         void *private_data;
 119
 120         /* function to decode the zdr reply data and buffer to decode into */
 121         zdrproc_t zdr_decode_fn;
 122         caddr_t zdr_decode_buf;
 123         uint32_t zdr_decode_bufsize;
 124 };
 125
 126 struct rpc_pdu *rpc_allocate_pdu(struct rpc_context *rpc, int program, int version, int procedure, rpc_cb cb, void *private_data, zdrproc_t zdr_decode_fn, int zdr_bufsize);
 127 void rpc_free_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
 128 int rpc_queue_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
 129 int rpc_get_pdu_size(char *buf);
 130 int rpc_process_pdu(struct rpc_context *rpc, char *buf, int size);
 131 void rpc_error_all_pdus(struct rpc_context *rpc, char *error);
 132
 133 void rpc_set_error(struct rpc_context *rpc, char *error_string, ...);
 134 void nfs_set_error(struct nfs_context *nfs, char *error_string, ...);
 135
 136 const char *nfs_get_server(struct nfs_context *nfs);
 137 const char *nfs_get_export(struct nfs_context *nfs);
 138
 139 /* we dont want to expose UDP to normal applications/users  this is private to libnfs to use exclusively for broadcast RPC */
 140 int rpc_bind_udp(struct rpc_context *rpc, char *addr, int port);
 141 int rpc_set_udp_destination(struct rpc_context *rpc, char *addr, int port, int is_broadcast);
 142 struct rpc_context *rpc_init_udp_context(void);
 143 struct sockaddr *rpc_get_recv_sockaddr(struct rpc_context *rpc);
 144
 145 void rpc_set_autoreconnect(struct rpc_context *rpc);
 146 void rpc_unset_autoreconnect(struct rpc_context *rpc);
 147
 148 void rpc_set_tcp_syncnt(struct rpc_context *rpc, int v);
 149 void rpc_set_uid(struct rpc_context *rpc, int uid);
 150 void rpc_set_gid(struct rpc_context *rpc, int gid);
 151
 152 int rpc_add_fragment(struct rpc_context *rpc, char *data, uint64_t size);
 153 void rpc_free_all_fragments(struct rpc_context *rpc);
 154
 155 const struct nfs_fh3 *nfs_get_rootfh(struct nfs_context *nfs);
 156
 157 #endif /* !_LIBNFS_PRIVATE_H_ */