socket: fix broken connect for non broadcast traffic
[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
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 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 #if !defined(HAVE_SOCKADDR_STORAGE) && !defined(WIN32)
36 /*
37 * RFC 2553: protocol-independent placeholder for socket addresses
38 */
39 #define _SS_MAXSIZE 128
40 #define _SS_ALIGNSIZE (sizeof(double))
41 #define _SS_PAD1SIZE (_SS_ALIGNSIZE - sizeof(unsigned char) * 2)
42 #define _SS_PAD2SIZE (_SS_MAXSIZE - sizeof(unsigned char) * 2 - \
43 _SS_PAD1SIZE - _SS_ALIGNSIZE)
44
45 struct sockaddr_storage {
46 #ifdef HAVE_SOCKADDR_LEN
47 unsigned char ss_len; /* address length */
48 unsigned char ss_family; /* address family */
49 #else
50 unsigned short ss_family;
51 #endif
52 char __ss_pad1[_SS_PAD1SIZE];
53 double __ss_align; /* force desired structure storage alignment */
54 char __ss_pad2[_SS_PAD2SIZE];
55 };
56 #endif
57
58
59 struct rpc_fragment {
60 struct rpc_fragment *next;
61 uint64_t size;
62 char *data;
63 };
64
65 #define RPC_CONTEXT_MAGIC 0xc6e46435
66 #define RPC_PARAM_UNDEFINED -1
67
68 /*
69 * Queue is singly-linked but we hold on to the tail
70 */
71 struct rpc_queue {
72 struct rpc_pdu *head, *tail;
73 };
74
75 #define HASHES 1024
76
77 struct rpc_context {
78 uint32_t magic;
79 int fd;
80 int is_connected;
81
82 char *error_string;
83
84 rpc_cb connect_cb;
85 void *connect_data;
86
87 struct AUTH *auth;
88 uint32_t xid;
89
90 /* buffer used for encoding RPC PDU */
91 char *encodebuf;
92 int encodebuflen;
93
94 struct rpc_queue outqueue;
95 struct sockaddr_storage udp_src;
96 struct rpc_queue waitpdu[HASHES];
97
98 uint32_t inpos;
99 uint32_t insize;
100 char *inbuf;
101
102 /* special fields for UDP, which can sometimes be BROADCASTed */
103 int is_udp;
104 struct sockaddr *udp_dest;
105 int is_broadcast;
106
107 /* track the address we connect to so we can auto-reconnect on session failure */
108 struct sockaddr_storage s;
109 int auto_reconnect;
110
111 /* fragment reassembly */
112 struct rpc_fragment *fragments;
113
114 /* parameters passable via URL */
115 int tcp_syncnt;
116 int uid;
117 int gid;
118 };
119
120 struct rpc_pdu {
121 struct rpc_pdu *next;
122
123 uint32_t xid;
124 ZDR zdr;
125
126 uint32_t written;
127 struct rpc_data outdata;
128
129 rpc_cb cb;
130 void *private_data;
131
132 /* function to decode the zdr reply data and buffer to decode into */
133 zdrproc_t zdr_decode_fn;
134 caddr_t zdr_decode_buf;
135 uint32_t zdr_decode_bufsize;
136 };
137
138 void rpc_reset_queue(struct rpc_queue *q);
139 void rpc_enqueue(struct rpc_queue *q, struct rpc_pdu *pdu);
140 void rpc_return_to_queue(struct rpc_queue *q, struct rpc_pdu *pdu);
141 unsigned int rpc_hash_xid(uint32_t xid);
142
143 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);
144 void rpc_free_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
145 int rpc_queue_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
146 int rpc_get_pdu_size(char *buf);
147 int rpc_process_pdu(struct rpc_context *rpc, char *buf, int size);
148 void rpc_error_all_pdus(struct rpc_context *rpc, char *error);
149
150 void rpc_set_error(struct rpc_context *rpc, char *error_string, ...)
151 #ifdef __GNUC__
152 __attribute__((format(printf, 2, 3)))
153 #endif
154 ;
155
156 void nfs_set_error(struct nfs_context *nfs, char *error_string, ...)
157 #ifdef __GNUC__
158 __attribute__((format(printf, 2, 3)))
159 #endif
160 ;
161
162 const char *nfs_get_server(struct nfs_context *nfs);
163 const char *nfs_get_export(struct nfs_context *nfs);
164
165 /* we dont want to expose UDP to normal applications/users this is private to libnfs to use exclusively for broadcast RPC */
166 int rpc_bind_udp(struct rpc_context *rpc, char *addr, int port);
167 int rpc_set_udp_destination(struct rpc_context *rpc, char *addr, int port, int is_broadcast);
168 struct rpc_context *rpc_init_udp_context(void);
169 struct sockaddr *rpc_get_recv_sockaddr(struct rpc_context *rpc);
170
171 void rpc_set_autoreconnect(struct rpc_context *rpc);
172 void rpc_unset_autoreconnect(struct rpc_context *rpc);
173
174 void rpc_set_tcp_syncnt(struct rpc_context *rpc, int v);
175 void rpc_set_uid(struct rpc_context *rpc, int uid);
176 void rpc_set_gid(struct rpc_context *rpc, int gid);
177
178 int rpc_add_fragment(struct rpc_context *rpc, char *data, uint64_t size);
179 void rpc_free_all_fragments(struct rpc_context *rpc);
180
181 const struct nfs_fh3 *nfs_get_rootfh(struct nfs_context *nfs);
182
183 #ifdef __cplusplus
184 }
185 #endif
186
187 #endif /* !_LIBNFS_PRIVATE_H_ */