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