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 #include <sys/socket.h>  /* struct sockaddr_storage */
  18
  19 #include "libnfs-zdr.h"
  20
  21 struct rpc_fragment {
  22         struct rpc_fragment *next;
  23         uint64_t size;
  24         char *data;
  25 };
  26
  27 #define RPC_CONTEXT_MAGIC 0xc6e46435
  28
  29 struct rpc_context {
  30         uint32_t magic;
  31         int fd;
  32         int is_connected;
  33
  34         char *error_string;
  35
  36         rpc_cb connect_cb;
  37         void *connect_data;
  38
  39         struct AUTH *auth;
  40         unsigned long xid;
  41
  42        /* buffer used for encoding RPC PDU */
  43        char *encodebuf;
  44        int encodebuflen;
  45
  46        struct rpc_pdu *outqueue;
  47        struct sockaddr_storage udp_src;
  48        struct rpc_pdu *waitpdu;
  49
  50        uint32_t inpos;
  51        uint32_t insize;
  52        char *inbuf;
  53
  54        /* special fields for UDP, which can sometimes be BROADCASTed */
  55        int is_udp;
  56        struct sockaddr *udp_dest;
  57        int is_broadcast;
  58
  59        /* track the address we connect to so we can auto-reconnect on session failure */
  60        struct sockaddr_storage s;
  61        int auto_reconnect;
  62
  63         /* fragment reassembly */
  64         struct rpc_fragment *fragments;
  65 };
  66
  67 struct rpc_pdu {
  68         struct rpc_pdu *next;
  69
  70         unsigned long xid;
  71         ZDR zdr;
  72
  73         uint32_t written;
  74         struct rpc_data outdata;
  75
  76         rpc_cb cb;
  77         void *private_data;
  78
  79         /* function to decode the zdr reply data and buffer to decode into */
  80         zdrproc_t zdr_decode_fn;
  81         caddr_t zdr_decode_buf;
  82         uint32_t zdr_decode_bufsize;
  83 };
  84
  85 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);
  86 void rpc_free_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
  87 int rpc_queue_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
  88 int rpc_get_pdu_size(char *buf);
  89 int rpc_process_pdu(struct rpc_context *rpc, char *buf, int size);
  90 void rpc_error_all_pdus(struct rpc_context *rpc, char *error);
  91
  92 void rpc_set_error(struct rpc_context *rpc, char *error_string, ...);
  93 void nfs_set_error(struct nfs_context *nfs, char *error_string, ...);
  94
  95 const char *nfs_get_server(struct nfs_context *nfs);
  96 const char *nfs_get_export(struct nfs_context *nfs);
  97
  98 /* we dont want to expose UDP to normal applications/users  this is private to libnfs to use exclusively for broadcast RPC */
  99 int rpc_bind_udp(struct rpc_context *rpc, char *addr, int port);
 100 int rpc_set_udp_destination(struct rpc_context *rpc, char *addr, int port, int is_broadcast);
 101 struct rpc_context *rpc_init_udp_context(void);
 102 struct sockaddr *rpc_get_recv_sockaddr(struct rpc_context *rpc);
 103
 104 void rpc_set_autoreconnect(struct rpc_context *rpc);
 105 void rpc_unset_autoreconnect(struct rpc_context *rpc);
 106
 107 int rpc_add_fragment(struct rpc_context *rpc, char *data, uint64_t size);
 108 void rpc_free_all_fragments(struct rpc_context *rpc);
 109
 110 const struct nfs_fh3 *nfs_get_rootfh(struct nfs_context *nfs);