Modified mechanism to assign privileged ports and enable it for Windows as well
[deb_libnfs.git] / lib / socket.c
CommitLineData
84004dbf
RS
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*/
a8a1b858
M
17#ifdef WIN32
18#include "win32_compat.h"
19#else
20#include <unistd.h>
21#include <poll.h>
22#include <arpa/inet.h>
23#include <sys/ioctl.h>
24#include <sys/socket.h>
25#include <netdb.h>
26#endif/*WIN32*/
84004dbf 27
fc01d2a9
TN
28#ifdef HAVE_CONFIG_H
29#include "config.h"
30#endif
84004dbf 31#include <stdio.h>
98f5fee8 32#include <stdlib.h>
84004dbf 33#include <fcntl.h>
84004dbf
RS
34#include <string.h>
35#include <errno.h>
98f5fee8 36#include <rpc/rpc.h>
84004dbf 37#include <rpc/xdr.h>
fc01d2a9
TN
38#ifdef HAVE_SYS_FILIO_H
39#include <sys/filio.h>
40#endif
647d2ea1
RS
41#ifdef HAVE_SYS_SOCKIO_H
42#include <sys/sockio.h>
43#endif
485bc9b9 44#include <sys/types.h>
84004dbf
RS
45#include "libnfs.h"
46#include "libnfs-raw.h"
47#include "libnfs-private.h"
48#include "slist.h"
49
fcc42bfe
M
50#ifdef WIN32
51//has to be included after stdlib!!
52#include "win32_errnowrapper.h"
53#endif
54
55
1744ef90
RS
56static int rpc_reconnect_requeue(struct rpc_context *rpc);
57static int rpc_connect_sockaddr_async(struct rpc_context *rpc, struct sockaddr_storage *s);
b077fdeb 58
84004dbf
RS
59static void set_nonblocking(int fd)
60{
99c14c9b 61 int v = 0;
6874f61e 62#if defined(WIN32)
99c14c9b 63 long nonblocking=1;
64 v = ioctlsocket(fd, FIONBIO,&nonblocking);
6874f61e 65#else
84004dbf
RS
66 v = fcntl(fd, F_GETFL, 0);
67 fcntl(fd, F_SETFL, v | O_NONBLOCK);
a8a1b858 68#endif //FIXME
84004dbf
RS
69}
70
71int rpc_get_fd(struct rpc_context *rpc)
72{
73 return rpc->fd;
74}
75
76int rpc_which_events(struct rpc_context *rpc)
77{
912f7ad5 78 int events = rpc->is_connected ? POLLIN : POLLOUT;
84004dbf 79
5911f3e8
RS
80 if (rpc->is_udp != 0) {
81 /* for udp sockets we only wait for pollin */
82 return POLLIN;
83 }
84
84004dbf
RS
85 if (rpc->outqueue) {
86 events |= POLLOUT;
87 }
88 return events;
89}
90
91static int rpc_write_to_socket(struct rpc_context *rpc)
92{
183451cf 93 int64_t count;
84004dbf
RS
94
95 if (rpc == NULL) {
84004dbf
RS
96 return -1;
97 }
98 if (rpc->fd == -1) {
1896d37b
RS
99 rpc_set_error(rpc, "trying to write but not connected");
100 return -1;
84004dbf
RS
101 }
102
103 while (rpc->outqueue != NULL) {
183451cf 104 int64_t total;
84004dbf
RS
105
106 total = rpc->outqueue->outdata.size;
107
6874f61e
RS
108#if defined(WIN32)
109 count = send(rpc->fd, rpc->outqueue->outdata.data + rpc->outqueue->written, total - rpc->outqueue->written, 0);
110#else
84004dbf 111 count = write(rpc->fd, rpc->outqueue->outdata.data + rpc->outqueue->written, total - rpc->outqueue->written);
6874f61e 112#endif
84004dbf
RS
113 if (count == -1) {
114 if (errno == EAGAIN || errno == EWOULDBLOCK) {
84004dbf
RS
115 return 0;
116 }
1896d37b
RS
117 rpc_set_error(rpc, "Error when writing to socket :%s(%d)", strerror(errno), errno);
118 return -1;
84004dbf
RS
119 }
120
121 rpc->outqueue->written += count;
122 if (rpc->outqueue->written == total) {
123 struct rpc_pdu *pdu = rpc->outqueue;
124
125 SLIST_REMOVE(&rpc->outqueue, pdu);
126 SLIST_ADD_END(&rpc->waitpdu, pdu);
127 }
128 }
129 return 0;
130}
131
132static int rpc_read_from_socket(struct rpc_context *rpc)
133{
134 int available;
135 int size;
cdb19ec1 136 int pdu_size;
183451cf 137 int64_t count;
84004dbf 138
6874f61e
RS
139#if defined(WIN32)
140 if (ioctlsocket(rpc->fd, FIONREAD, &available) != 0) {
141#else
84004dbf 142 if (ioctl(rpc->fd, FIONREAD, &available) != 0) {
6874f61e 143#endif
84004dbf
RS
144 rpc_set_error(rpc, "Ioctl FIONREAD returned error : %d. Closing socket.", errno);
145 return -1;
146 }
a8a1b858 147
84004dbf
RS
148 if (available == 0) {
149 rpc_set_error(rpc, "Socket has been closed");
1896d37b 150 return -1;
84004dbf 151 }
cdb19ec1 152
0268794f
RS
153 if (rpc->is_udp) {
154 char *buf;
155 socklen_t socklen = sizeof(rpc->udp_src);
156
157 buf = malloc(available);
158 if (buf == NULL) {
159 rpc_set_error(rpc, "Failed to malloc buffer for recvfrom");
160 return -1;
161 }
162 count = recvfrom(rpc->fd, buf, available, MSG_DONTWAIT, (struct sockaddr *)&rpc->udp_src, &socklen);
163 if (count < 0) {
164 rpc_set_error(rpc, "Failed recvfrom: %s", strerror(errno));
165 free(buf);
166 }
167 if (rpc_process_pdu(rpc, buf, count) != 0) {
168 rpc_set_error(rpc, "Invalid/garbage pdu received from server. Ignoring PDU");
169 free(buf);
170 return -1;
171 }
172 free(buf);
173 return 0;
174 }
175
cdb19ec1
RS
176 /* read record marker, 4 bytes at the beginning of every pdu */
177 if (rpc->inbuf == NULL) {
178 rpc->insize = 4;
179 rpc->inbuf = malloc(rpc->insize);
180 if (rpc->inbuf == NULL) {
181 rpc_set_error(rpc, "Failed to allocate buffer for record marker, errno:%d. Closing socket.", errno);
182 return -1;
183 }
184 }
185 if (rpc->inpos < 4) {
186 size = 4 - rpc->inpos;
187
6874f61e
RS
188#if defined(WIN32)
189 count = recv(rpc->fd, rpc->inbuf + rpc->inpos, size, 0);
190#else
cdb19ec1 191 count = read(rpc->fd, rpc->inbuf + rpc->inpos, size);
6874f61e 192#endif
cdb19ec1
RS
193 if (count == -1) {
194 if (errno == EINTR) {
195 return 0;
196 }
197 rpc_set_error(rpc, "Read from socket failed, errno:%d. Closing socket.", errno);
198 return -1;
199 }
200 available -= count;
201 rpc->inpos += count;
202 }
203
204 if (available == 0) {
205 return 0;
206 }
207
208 pdu_size = rpc_get_pdu_size(rpc->inbuf);
209 if (rpc->insize < pdu_size) {
210 unsigned char *buf;
211
212 buf = malloc(pdu_size);
213 if (buf == NULL) {
214 rpc_set_error(rpc, "Failed to allocate buffer of %d bytes for pdu, errno:%d. Closing socket.", pdu_size, errno);
215 return -1;
216 }
217 memcpy(buf, rpc->inbuf, rpc->insize);
218 free(rpc->inbuf);
219 rpc->inbuf = buf;
220 rpc->insize = rpc_get_pdu_size(rpc->inbuf);
84004dbf 221 }
cdb19ec1
RS
222
223 size = available;
224 if (size > rpc->insize - rpc->inpos) {
225 size = rpc->insize - rpc->inpos;
84004dbf
RS
226 }
227
6874f61e
RS
228#if defined(WIN32)
229 count = recv(rpc->fd, rpc->inbuf + rpc->inpos, size, 0);
230#else
cdb19ec1 231 count = read(rpc->fd, rpc->inbuf + rpc->inpos, size);
6874f61e 232#endif
84004dbf
RS
233 if (count == -1) {
234 if (errno == EINTR) {
84004dbf
RS
235 return 0;
236 }
237 rpc_set_error(rpc, "Read from socket failed, errno:%d. Closing socket.", errno);
1896d37b 238 return -1;
84004dbf 239 }
cdb19ec1
RS
240 available -= count;
241 rpc->inpos += count;
84004dbf 242
cdb19ec1
RS
243 if (rpc->inpos == rpc->insize) {
244 if (rpc_process_pdu(rpc, rpc->inbuf, pdu_size) != 0) {
84004dbf 245 rpc_set_error(rpc, "Invalid/garbage pdu received from server. Closing socket");
1896d37b 246 return -1;
84004dbf 247 }
cdb19ec1
RS
248 free(rpc->inbuf);
249 rpc->inbuf = NULL;
250 rpc->insize = 0;
251 rpc->inpos = 0;
84004dbf 252 }
cdb19ec1 253
84004dbf
RS
254 return 0;
255}
256
257
258
259int rpc_service(struct rpc_context *rpc, int revents)
260{
261 if (revents & POLLERR) {
fcc42bfe 262#ifdef WIN32
a8a1b858 263 char err = 0;
fcc42bfe
M
264#else
265 int err = 0;
266#endif
912f7ad5
RS
267 socklen_t err_size = sizeof(err);
268
269 if (getsockopt(rpc->fd, SOL_SOCKET, SO_ERROR,
bb4e9ed6 270 (char *)&err, &err_size) != 0 || err != 0) {
912f7ad5
RS
271 if (err == 0) {
272 err = errno;
273 }
274 rpc_set_error(rpc, "rpc_service: socket error "
275 "%s(%d).",
276 strerror(err), err);
84004dbf 277 } else {
912f7ad5
RS
278 rpc_set_error(rpc, "rpc_service: POLLERR, "
279 "Unknown socket error.");
84004dbf 280 }
b990de23
RS
281 if (rpc->connect_cb != NULL) {
282 rpc->connect_cb(rpc, RPC_STATUS_ERROR, rpc->error_string, rpc->connect_data);
283 }
84004dbf
RS
284 return -1;
285 }
286 if (revents & POLLHUP) {
84004dbf 287 rpc_set_error(rpc, "Socket failed with POLLHUP");
b990de23
RS
288 if (rpc->connect_cb != NULL) {
289 rpc->connect_cb(rpc, RPC_STATUS_ERROR, rpc->error_string, rpc->connect_data);
290 }
1896d37b 291 return -1;
84004dbf
RS
292 }
293
294 if (rpc->is_connected == 0 && rpc->fd != -1 && revents&POLLOUT) {
912f7ad5
RS
295 int err = 0;
296 socklen_t err_size = sizeof(err);
297
298 if (getsockopt(rpc->fd, SOL_SOCKET, SO_ERROR,
bb4e9ed6 299 (char *)&err, &err_size) != 0 || err != 0) {
912f7ad5
RS
300 if (err == 0) {
301 err = errno;
302 }
303 rpc_set_error(rpc, "rpc_service: socket error "
304 "%s(%d) while connecting.",
305 strerror(err), err);
b990de23
RS
306 if (rpc->connect_cb != NULL) {
307 rpc->connect_cb(rpc, RPC_STATUS_ERROR,
912f7ad5 308 NULL, rpc->connect_data);
b990de23 309 }
912f7ad5
RS
310 return -1;
311 }
312
84004dbf 313 rpc->is_connected = 1;
b990de23
RS
314 if (rpc->connect_cb != NULL) {
315 rpc->connect_cb(rpc, RPC_STATUS_SUCCESS, NULL, rpc->connect_data);
316 }
84004dbf
RS
317 return 0;
318 }
319
b077fdeb
RS
320 if (revents & POLLIN) {
321 if (rpc_read_from_socket(rpc) != 0) {
1744ef90 322 rpc_reconnect_requeue(rpc);
b077fdeb 323 return 0;
84004dbf
RS
324 }
325 }
326
b077fdeb
RS
327 if (revents & POLLOUT && rpc->outqueue != NULL) {
328 if (rpc_write_to_socket(rpc) != 0) {
329 rpc_set_error(rpc, "write to socket failed");
1896d37b 330 return -1;
84004dbf
RS
331 }
332 }
333
334 return 0;
335}
336
1744ef90 337void rpc_set_autoreconnect(struct rpc_context *rpc)
84004dbf 338{
1744ef90
RS
339 rpc->auto_reconnect = 1;
340}
84004dbf 341
1744ef90
RS
342void rpc_unset_autoreconnect(struct rpc_context *rpc)
343{
344 rpc->auto_reconnect = 0;
345}
070287e5 346
1744ef90
RS
347static int rpc_connect_sockaddr_async(struct rpc_context *rpc, struct sockaddr_storage *s)
348{
349 int socksize;
84004dbf 350
1744ef90 351 switch (s->ss_family) {
84004dbf 352 case AF_INET:
84004dbf 353 socksize = sizeof(struct sockaddr_in);
6874f61e 354 rpc->fd = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
84004dbf 355 break;
1744ef90
RS
356 default:
357 rpc_set_error(rpc, "Can not handle AF_FAMILY:%d", s->ss_family);
358 return -1;
84004dbf
RS
359 }
360
361 if (rpc->fd == -1) {
362 rpc_set_error(rpc, "Failed to open socket");
1896d37b 363 return -1;
84004dbf
RS
364 }
365
07fd0cbc
RS
366 /* Some systems allow you to set capabilities on an executable
367 * to allow the file to be executed with privilege to bind to
368 * privileged system ports, even if the user is not root.
369 *
370 * Opportunistically try to bind the socket to a low numbered
371 * system port in the hope that the user is either root or the
372 * executable has the CAP_NET_BIND_SERVICE.
373 *
374 * As soon as we fail the bind() with EACCES we know we will never
375 * be able to bind to a system port so we terminate the loop.
376 *
377 * On linux, use
378 * sudo setcap 'cap_net_bind_service=+ep' /path/executable
379 * to make the executable able to bind to a system port.
ac559609
RI
380 *
381 * On Windows, there is no concept of privileged ports. Thus
382 * binding will usually succeed.
07fd0cbc 383 */
ac559609
RI
384 {
385 struct sockaddr_in sin;
386 static int portOfs = 0;
387 const int firstPort = 512; /* >= 512 according to Sun docs */
388 const int portCount = IPPORT_RESERVED - firstPort;
389 int startOfs = portOfs, port, rc;
390
391 do {
392 rc = -1;
393 port = htons(firstPort + portOfs);
394 portOfs = (portOfs + 1) % portCount;
395
396 /* skip well-known ports */
397 if (!getservbyport(port, "tcp")) {
398 memset(&sin, 0, sizeof(sin));
399 sin.sin_port = port;
400 sin.sin_family = AF_INET;
401 sin.sin_addr.s_addr = 0;
402
403 rc = bind(rpc->fd, (struct sockaddr *)&sin, sizeof(struct sockaddr_in));
404#if !defined(WIN32)
405 /* we got EACCES, so don't try again */
406 if (rc != 0 && errno == EACCES)
407 break;
408#endif
07fd0cbc 409 }
ac559609 410 } while (rc != 0 && portOfs != startOfs);
07fd0cbc 411 }
07fd0cbc 412
84004dbf 413 set_nonblocking(rpc->fd);
07fd0cbc 414
4b0e8df9 415#if defined(WIN32)
1744ef90 416 if (connect(rpc->fd, (struct sockaddr *)s, socksize) == 0 && errno != EINPROGRESS )
4b0e8df9 417#else
1744ef90 418 if (connect(rpc->fd, (struct sockaddr *)s, socksize) != 0 && errno != EINPROGRESS)
4b0e8df9 419#endif
420 {
59f298f5 421 rpc_set_error(rpc, "connect() to server failed. %s(%d)", strerror(errno), errno);
1896d37b 422 return -1;
84004dbf
RS
423 }
424
425 return 0;
426}
427
1744ef90
RS
428int rpc_connect_async(struct rpc_context *rpc, const char *server, int port, rpc_cb cb, void *private_data)
429{
430 struct sockaddr_in *sin = (struct sockaddr_in *)&rpc->s;
431
432 if (rpc->fd != -1) {
433 rpc_set_error(rpc, "Trying to connect while already connected");
434 return -1;
435 }
436
437 if (rpc->is_udp != 0) {
438 rpc_set_error(rpc, "Trying to connect on UDP socket");
439 return -1;
440 }
441
442 rpc->auto_reconnect = 0;
443
444 sin->sin_family = AF_INET;
445 sin->sin_port = htons(port);
446 if (inet_pton(AF_INET, server, &sin->sin_addr) != 1) {
447 rpc_set_error(rpc, "Not a valid server ip address");
448 return -1;
449 }
450
451
452 switch (rpc->s.ss_family) {
453 case AF_INET:
454#ifdef HAVE_SOCKADDR_LEN
455 sin->sin_len = sizeof(struct sockaddr_in);
456#endif
457 break;
458 }
459
460 rpc->connect_cb = cb;
461 rpc->connect_data = private_data;
462
463 if (rpc_connect_sockaddr_async(rpc, &rpc->s) != 0) {
464 return -1;
465 }
466
467 return 0;
468}
469
84004dbf
RS
470int rpc_disconnect(struct rpc_context *rpc, char *error)
471{
1744ef90
RS
472 rpc_unset_autoreconnect(rpc);
473
84004dbf 474 if (rpc->fd != -1) {
6874f61e
RS
475#if defined(WIN32)
476 closesocket(rpc->fd);
477#else
84004dbf 478 close(rpc->fd);
6874f61e 479#endif
84004dbf
RS
480 }
481 rpc->fd = -1;
482
483 rpc->is_connected = 0;
484
485 rpc_error_all_pdus(rpc, error);
486
487 return 0;
488}
485bc9b9 489
1744ef90
RS
490static void reconnect_cb(struct rpc_context *rpc, int status, void *data _U_, void *private_data)
491{
492 if (status != RPC_STATUS_SUCCESS) {
493 rpc_error_all_pdus(rpc, "RPC ERROR: Failed to reconnect async");
494 return;
495 }
496
497 rpc->is_connected = 1;
b990de23 498 rpc->connect_cb = NULL;
1744ef90
RS
499}
500
501/* disconnect but do not error all PDUs, just move pdus in-flight back to the outqueue and reconnect */
502static int rpc_reconnect_requeue(struct rpc_context *rpc)
b077fdeb
RS
503{
504 struct rpc_pdu *pdu;
505
506 if (rpc->fd != -1) {
6874f61e
RS
507#if defined(WIN32)
508 closesocket(rpc->fd);
509#else
b077fdeb 510 close(rpc->fd);
6874f61e 511#endif
b077fdeb
RS
512 }
513 rpc->fd = -1;
514
515 rpc->is_connected = 0;
516
517 /* socket is closed so we will not get any replies to any commands
518 * in flight. Move them all over from the waitpdu queue back to the out queue
519 */
520 for (pdu=rpc->waitpdu; pdu; pdu=pdu->next) {
521 SLIST_REMOVE(&rpc->waitpdu, pdu);
522 SLIST_ADD(&rpc->outqueue, pdu);
1744ef90
RS
523 /* we have to re-send the whole pdu again */
524 pdu->written = 0;
525 }
526
527 if (rpc->auto_reconnect != 0) {
528 rpc->connect_cb = reconnect_cb;
529
530 if (rpc_connect_sockaddr_async(rpc, &rpc->s) != 0) {
531 rpc_error_all_pdus(rpc, "RPC ERROR: Failed to reconnect async");
532 return -1;
533 }
b077fdeb
RS
534 }
535
536 return 0;
537}
538
485bc9b9
RS
539
540int rpc_bind_udp(struct rpc_context *rpc, char *addr, int port)
541{
542 struct addrinfo *ai = NULL;
543 char service[6];
544
545 if (rpc->is_udp == 0) {
546 rpc_set_error(rpc, "Cant not bind UDP. Not UDP context");
547 return -1;
548 }
549
6874f61e 550 sprintf(service, "%d", port);
485bc9b9
RS
551 if (getaddrinfo(addr, service, NULL, &ai) != 0) {
552 rpc_set_error(rpc, "Invalid address:%s. "
553 "Can not resolv into IPv4/v6 structure.");
554 return -1;
555 }
556
557 switch(ai->ai_family) {
558 case AF_INET:
559 rpc->fd = socket(ai->ai_family, SOCK_DGRAM, 0);
560 if (rpc->fd == -1) {
561 rpc_set_error(rpc, "Failed to create UDP socket: %s", strerror(errno));
562 freeaddrinfo(ai);
563 return -1;
564 }
565
566 if (bind(rpc->fd, (struct sockaddr *)ai->ai_addr, sizeof(struct sockaddr_in)) != 0) {
567 rpc_set_error(rpc, "Failed to bind to UDP socket: %s",strerror(errno));
568 freeaddrinfo(ai);
569 return -1;
570 }
571 break;
572 default:
573 rpc_set_error(rpc, "Can not handle UPD sockets of family %d yet", ai->ai_family);
574 freeaddrinfo(ai);
575 return -1;
576 }
577
578 freeaddrinfo(ai);
579
580 return 0;
581}
582
5bf60dc6
RS
583int rpc_set_udp_destination(struct rpc_context *rpc, char *addr, int port, int is_broadcast)
584{
585 struct addrinfo *ai = NULL;
586 char service[6];
587
588 if (rpc->is_udp == 0) {
589 rpc_set_error(rpc, "Can not set destination sockaddr. Not UDP context");
590 return -1;
591 }
592
6874f61e 593 sprintf(service, "%d", port);
5bf60dc6
RS
594 if (getaddrinfo(addr, service, NULL, &ai) != 0) {
595 rpc_set_error(rpc, "Invalid address:%s. "
596 "Can not resolv into IPv4/v6 structure.");
597 return -1;
598 }
599
600 if (rpc->udp_dest) {
601 free(rpc->udp_dest);
602 rpc->udp_dest = NULL;
603 }
604 rpc->udp_dest = malloc(ai->ai_addrlen);
605 if (rpc->udp_dest == NULL) {
606 rpc_set_error(rpc, "Out of memory. Failed to allocate sockaddr structure");
607 return -1;
608 }
609 memcpy(rpc->udp_dest, ai->ai_addr, ai->ai_addrlen);
610 freeaddrinfo(ai);
611
612 rpc->is_broadcast = is_broadcast;
bb4e9ed6 613 setsockopt(rpc->fd, SOL_SOCKET, SO_BROADCAST, (char *)&is_broadcast, sizeof(is_broadcast));
5bf60dc6
RS
614
615 return 0;
616}
c481da67
RS
617
618struct sockaddr *rpc_get_recv_sockaddr(struct rpc_context *rpc)
619{
620 return (struct sockaddr *)&rpc->udp_src;
621}
83aa785d
RS
622
623int rpc_queue_length(struct rpc_context *rpc)
624{
625 int i=0;
626 struct rpc_pdu *pdu;
627
628 for(pdu = rpc->outqueue; pdu; pdu = pdu->next) {
629 i++;
630 }
631 for(pdu = rpc->waitpdu; pdu; pdu = pdu->next) {
632 i++;
633 }
634 return i;
635}