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 #ifdef HAVE_CONFIG_H
  18 #include "config.h"  /* HAVE_SOCKADDR_STORAGE ? */
  19 #endif
  20
  21 #ifndef WIN32
  22 #include <sys/socket.h>  /* struct sockaddr_storage */
  23 #endif
  24
  25 #include "libnfs-zdr.h"
  26
  27
  28 #if !defined(HAVE_SOCKADDR_STORAGE) && !defined(WIN32)
  29 /*
  30  * RFC 2553: protocol-independent placeholder for socket addresses
  31  */
  32 #define _SS_MAXSIZE     128
  33 #define _SS_ALIGNSIZE   (sizeof(double))
  34 #define _SS_PAD1SIZE    (_SS_ALIGNSIZE - sizeof(unsigned char) * 2)
  35 #define _SS_PAD2SIZE    (_SS_MAXSIZE - sizeof(unsigned char) * 2 - \
  36                                 _SS_PAD1SIZE - _SS_ALIGNSIZE)
  37
  38 struct sockaddr_storage {
  39 #ifdef HAVE_SOCKADDR_LEN
  40         unsigned char ss_len;           /* address length */
  41         unsigned char ss_family;        /* address family */
  42 #else
  43         unsigned short ss_family;
  44 #endif
  45         char    __ss_pad1[_SS_PAD1SIZE];
  46         double  __ss_align;     /* force desired structure storage alignment */
  47         char    __ss_pad2[_SS_PAD2SIZE];
  48 };
  49 #endif
  50
  51
  52 struct rpc_fragment {
  53         struct rpc_fragment *next;
  54         uint64_t size;
  55         char *data;
  56 };
  57
  58 #define RPC_CONTEXT_MAGIC 0xc6e46435
  59 #define RPC_PARAM_UNDEFINED -1
  60
  61 struct rpc_context {
  62         uint32_t magic;
  63         int fd;
  64         int is_connected;
  65
  66         char *error_string;
  67
  68         rpc_cb connect_cb;
  69         void *connect_data;
  70
  71         struct AUTH *auth;
  72         uint32_t xid;
  73
  74         /* buffer used for encoding RPC PDU */
  75         char *encodebuf;
  76         int encodebuflen;
  77
  78         struct rpc_pdu *outqueue;
  79         struct sockaddr_storage udp_src;
  80         struct rpc_pdu *waitpdu;
  81
  82         uint32_t inpos;
  83         uint32_t insize;
  84         char *inbuf;
  85
  86         /* special fields for UDP, which can sometimes be BROADCASTed */
  87         int is_udp;
  88         struct sockaddr *udp_dest;
  89         int is_broadcast;
  90
  91         /* track the address we connect to so we can auto-reconnect on session failure */
  92         struct sockaddr_storage s;
  93         int auto_reconnect;
  94
  95         /* fragment reassembly */
  96         struct rpc_fragment *fragments;
  97
  98         /* parameters passable via URL */
  99         int tcp_syncnt;
 100         int uid;
 101         int gid;
 102 };
 103
 104 struct rpc_pdu {
 105         struct rpc_pdu *next;
 106
 107         uint32_t xid;
 108         ZDR zdr;
 109
 110         uint32_t written;
 111         struct rpc_data outdata;
 112
 113         rpc_cb cb;
 114         void *private_data;
 115
 116         /* function to decode the zdr reply data and buffer to decode into */
 117         zdrproc_t zdr_decode_fn;
 118         caddr_t zdr_decode_buf;
 119         uint32_t zdr_decode_bufsize;
 120 };
 121
 122 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);
 123 void rpc_free_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
 124 int rpc_queue_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
 125 int rpc_get_pdu_size(char *buf);
 126 int rpc_process_pdu(struct rpc_context *rpc, char *buf, int size);
 127 void rpc_error_all_pdus(struct rpc_context *rpc, char *error);
 128
 129 void rpc_set_error(struct rpc_context *rpc, char *error_string, ...);
 130 void nfs_set_error(struct nfs_context *nfs, char *error_string, ...);
 131
 132 const char *nfs_get_server(struct nfs_context *nfs);
 133 const char *nfs_get_export(struct nfs_context *nfs);
 134
 135 /* we dont want to expose UDP to normal applications/users  this is private to libnfs to use exclusively for broadcast RPC */
 136 int rpc_bind_udp(struct rpc_context *rpc, char *addr, int port);
 137 int rpc_set_udp_destination(struct rpc_context *rpc, char *addr, int port, int is_broadcast);
 138 struct rpc_context *rpc_init_udp_context(void);
 139 struct sockaddr *rpc_get_recv_sockaddr(struct rpc_context *rpc);
 140
 141 void rpc_set_autoreconnect(struct rpc_context *rpc);
 142 void rpc_unset_autoreconnect(struct rpc_context *rpc);
 143
 144 void rpc_set_tcp_syncnt(struct rpc_context *rpc, int v);
 145 void rpc_set_uid(struct rpc_context *rpc, int uid);
 146 void rpc_set_gid(struct rpc_context *rpc, int gid);
 147
 148 int rpc_add_fragment(struct rpc_context *rpc, char *data, uint64_t size);
 149 void rpc_free_all_fragments(struct rpc_context *rpc);
 150
 151 const struct nfs_fh3 *nfs_get_rootfh(struct nfs_context *nfs);