1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
|
/*
* (C) 2011-2017 by Harald Welte <laforge@gnumonks.org>
*
* All Rights Reserved
*
* SPDX-License-Identifier: GPL-2.0+
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*/
#include "../config.h"
/*! \addtogroup socket
* @{
* Osmocom socket convenience functions.
*
* \file socket.c */
#ifdef HAVE_SYS_SOCKET_H
#include <osmocom/core/logging.h>
#include <osmocom/core/select.h>
#include <osmocom/core/socket.h>
#include <osmocom/core/talloc.h>
#include <osmocom/core/utils.h>
#include <sys/ioctl.h>
#include <sys/socket.h>
#include <sys/types.h>
#include <sys/un.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <stdio.h>
#include <unistd.h>
#include <stdint.h>
#include <string.h>
#include <errno.h>
#include <netdb.h>
#include <ifaddrs.h>
static struct addrinfo *addrinfo_helper(uint16_t family, uint16_t type, uint8_t proto,
const char *host, uint16_t port, bool passive)
{
struct addrinfo hints, *result, *rp;
char portbuf[6];
int rc;
snprintf(portbuf, sizeof(portbuf), "%u", port);
memset(&hints, 0, sizeof(struct addrinfo));
hints.ai_family = family;
if (type == SOCK_RAW) {
/* Workaround for glibc, that returns EAI_SERVICE (-8) if
* SOCK_RAW and IPPROTO_GRE is used.
* http://sourceware.org/bugzilla/show_bug.cgi?id=15015
*/
hints.ai_socktype = SOCK_DGRAM;
hints.ai_protocol = IPPROTO_UDP;
} else {
hints.ai_socktype = type;
hints.ai_protocol = proto;
}
if (passive)
hints.ai_flags |= AI_PASSIVE;
rc = getaddrinfo(host, portbuf, &hints, &result);
if (rc != 0) {
LOGP(DLGLOBAL, LOGL_ERROR, "getaddrinfo returned NULL: %s:%u: %s\n",
host, port, strerror(errno));
return NULL;
}
for (rp = result; rp != NULL; rp = rp->ai_next) {
/* Workaround for glibc again */
if (type == SOCK_RAW) {
rp->ai_socktype = SOCK_RAW;
rp->ai_protocol = proto;
}
}
return result;
}
static int socket_helper(const struct addrinfo *rp, unsigned int flags)
{
int sfd, on = 1;
sfd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
if (sfd == -1) {
LOGP(DLGLOBAL, LOGL_ERROR,
"unable to create socket: %s\n", strerror(errno));
return sfd;
}
if (flags & OSMO_SOCK_F_NONBLOCK) {
if (ioctl(sfd, FIONBIO, (unsigned char *)&on) < 0) {
LOGP(DLGLOBAL, LOGL_ERROR,
"cannot set this socket unblocking: %s\n",
strerror(errno));
close(sfd);
sfd = -EINVAL;
}
}
return sfd;
}
static int osmo_sock_init_tail(int fd, uint16_t type, unsigned int flags)
{
int rc;
/* Make sure to call 'listen' on a bound, connection-oriented sock */
if ((flags & (OSMO_SOCK_F_BIND|OSMO_SOCK_F_CONNECT)) == OSMO_SOCK_F_BIND) {
switch (type) {
case SOCK_STREAM:
case SOCK_SEQPACKET:
rc = listen(fd, 10);
if (rc < 0) {
LOGP(DLGLOBAL, LOGL_ERROR, "unable to listen on socket: %s\n",
strerror(errno));
return rc;
}
break;
}
}
if (flags & OSMO_SOCK_F_NO_MCAST_LOOP) {
rc = osmo_sock_mcast_loop_set(fd, false);
if (rc < 0) {
LOGP(DLGLOBAL, LOGL_ERROR, "unable to disable multicast loop: %s\n",
strerror(errno));
return rc;
}
}
if (flags & OSMO_SOCK_F_NO_MCAST_ALL) {
rc = osmo_sock_mcast_all_set(fd, false);
if (rc < 0) {
LOGP(DLGLOBAL, LOGL_ERROR, "unable to disable receive of all multicast: %s\n",
strerror(errno));
/* do not abort here, as this is just an
* optional additional optimization that only
* exists on Linux only */
}
}
return 0;
}
/*! Initialize a socket (including bind and/or connect)
* \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC
* \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
* \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
* \param[in] local_host local host name or IP address in string form
* \param[in] local_port local port number in host byte order
* \param[in] remote_host remote host name or IP address in string form
* \param[in] remote_port remote port number in host byte order
* \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
* \returns socket file descriptor on success; negative on error
*
* This function creates a new socket of the designated \a family, \a
* type and \a proto and optionally binds it to the \a local_host and \a
* local_port as well as optionally connects it to the \a remote_host
* and \q remote_port, depending on the value * of \a flags parameter.
*
* As opposed to \ref osmo_sock_init(), this function allows to combine
* the \ref OSMO_SOCK_F_BIND and \ref OSMO_SOCK_F_CONNECT flags. This
* is useful if you want to connect to a remote host/port, but still
* want to bind that socket to either a specific local alias IP and/or a
* specific local source port.
*
* You must specify either \ref OSMO_SOCK_F_BIND, or \ref
* OSMO_SOCK_F_CONNECT, or both.
*
* If \ref OSMO_SOCK_F_NONBLOCK is specified, the socket will be set to
* non-blocking mode.
*/
int osmo_sock_init2(uint16_t family, uint16_t type, uint8_t proto,
const char *local_host, uint16_t local_port,
const char *remote_host, uint16_t remote_port, unsigned int flags)
{
struct addrinfo *result, *rp;
int sfd = -1, rc, on = 1;
if ((flags & (OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT)) == 0) {
LOGP(DLGLOBAL, LOGL_ERROR, "invalid: you have to specify either "
"BIND or CONNECT flags\n");
return -EINVAL;
}
/* figure out local side of socket */
if (flags & OSMO_SOCK_F_BIND) {
result = addrinfo_helper(family, type, proto, local_host, local_port, true);
if (!result)
return -EINVAL;
for (rp = result; rp != NULL; rp = rp->ai_next) {
sfd = socket_helper(rp, flags);
if (sfd < 0)
continue;
if (proto != IPPROTO_UDP || flags & OSMO_SOCK_F_UDP_REUSEADDR) {
rc = setsockopt(sfd, SOL_SOCKET, SO_REUSEADDR,
&on, sizeof(on));
if (rc < 0) {
LOGP(DLGLOBAL, LOGL_ERROR,
"cannot setsockopt socket:"
" %s:%u: %s\n",
local_host, local_port,
strerror(errno));
close(sfd);
continue;
}
}
if (bind(sfd, rp->ai_addr, rp->ai_addrlen) == -1) {
LOGP(DLGLOBAL, LOGL_ERROR, "unable to bind socket: %s:%u: %s\n",
local_host, local_port, strerror(errno));
close(sfd);
continue;
}
break;
}
freeaddrinfo(result);
if (rp == NULL) {
LOGP(DLGLOBAL, LOGL_ERROR, "no suitable local addr found for: %s:%u\n",
local_host, local_port);
return -ENODEV;
}
}
/* Reached this point, if OSMO_SOCK_F_BIND then sfd is valid (>=0) or it
was already closed and func returned. If OSMO_SOCK_F_BIND is not
set, then sfd = -1 */
/* figure out remote side of socket */
if (flags & OSMO_SOCK_F_CONNECT) {
result = addrinfo_helper(family, type, proto, remote_host, remote_port, false);
if (!result) {
if (sfd >= 0)
close(sfd);
return -EINVAL;
}
for (rp = result; rp != NULL; rp = rp->ai_next) {
if (sfd < 0) {
sfd = socket_helper(rp, flags);
if (sfd < 0)
continue;
}
rc = connect(sfd, rp->ai_addr, rp->ai_addrlen);
if (rc != 0 && errno != EINPROGRESS) {
LOGP(DLGLOBAL, LOGL_ERROR, "unable to connect socket: %s:%u: %s\n",
remote_host, remote_port, strerror(errno));
/* We want to maintain the bind socket if bind was enabled */
if (!(flags & OSMO_SOCK_F_BIND)) {
close(sfd);
sfd = -1;
}
continue;
}
break;
}
freeaddrinfo(result);
if (rp == NULL) {
LOGP(DLGLOBAL, LOGL_ERROR, "no suitable remote addr found for: %s:%u\n",
remote_host, remote_port);
if (sfd >= 0)
close(sfd);
return -ENODEV;
}
}
rc = osmo_sock_init_tail(sfd, type, flags);
if (rc < 0) {
close(sfd);
sfd = -1;
}
return sfd;
}
/*! Initialize a socket (including bind/connect)
* \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC
* \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
* \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
* \param[in] host remote host name or IP address in string form
* \param[in] port remote port number in host byte order
* \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
* \returns socket file descriptor on success; negative on error
*
* This function creates a new socket of the designated \a family, \a
* type and \a proto and optionally binds or connects it, depending on
* the value of \a flags parameter.
*/
int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto,
const char *host, uint16_t port, unsigned int flags)
{
struct addrinfo *result, *rp;
int sfd, rc, on = 1;
if ((flags & (OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT)) ==
(OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT)) {
LOGP(DLGLOBAL, LOGL_ERROR, "invalid: both bind and connect flags set:"
" %s:%u\n", host, port);
return -EINVAL;
}
result = addrinfo_helper(family, type, proto, host, port, flags & OSMO_SOCK_F_BIND);
if (!result) {
LOGP(DLGLOBAL, LOGL_ERROR, "getaddrinfo returned NULL: %s:%u: %s\n",
host, port, strerror(errno));
return -EINVAL;
}
for (rp = result; rp != NULL; rp = rp->ai_next) {
sfd = socket_helper(rp, flags);
if (sfd == -1)
continue;
if (flags & OSMO_SOCK_F_CONNECT) {
rc = connect(sfd, rp->ai_addr, rp->ai_addrlen);
if (rc != 0 && errno != EINPROGRESS) {
close(sfd);
continue;
}
} else {
if (proto != IPPROTO_UDP || flags & OSMO_SOCK_F_UDP_REUSEADDR) {
rc = setsockopt(sfd, SOL_SOCKET, SO_REUSEADDR,
&on, sizeof(on));
if (rc < 0) {
LOGP(DLGLOBAL, LOGL_ERROR,
"cannot setsockopt socket:"
" %s:%u: %s\n",
host, port, strerror(errno));
close(sfd);
continue;
}
}
if (bind(sfd, rp->ai_addr, rp->ai_addrlen) == -1) {
LOGP(DLGLOBAL, LOGL_ERROR, "unable to bind socket:"
"%s:%u: %s\n",
host, port, strerror(errno));
close(sfd);
continue;
}
}
break;
}
freeaddrinfo(result);
if (rp == NULL) {
LOGP(DLGLOBAL, LOGL_ERROR, "no suitable addr found for: %s:%u\n",
host, port);
return -ENODEV;
}
if (proto != IPPROTO_UDP || flags & OSMO_SOCK_F_UDP_REUSEADDR) {
rc = setsockopt(sfd, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on));
if (rc < 0) {
LOGP(DLGLOBAL, LOGL_ERROR,
"cannot setsockopt socket: %s:%u: %s\n", host,
port, strerror(errno));
close(sfd);
sfd = -1;
}
}
rc = osmo_sock_init_tail(sfd, type, flags);
if (rc < 0) {
close(sfd);
sfd = -1;
}
return sfd;
}
/*! fill \ref osmo_fd for a give sfd
* \param[out] ofd file descriptor (will be filled in)
* \param[in] sfd socket file descriptor
* \returns socket fd on success; negative on error
*
* This function fills the \a ofd structure.
*/
static inline int osmo_fd_init_ofd(struct osmo_fd *ofd, int sfd)
{
int rc;
if (sfd < 0)
return sfd;
ofd->fd = sfd;
ofd->when = OSMO_FD_READ;
rc = osmo_fd_register(ofd);
if (rc < 0) {
close(sfd);
return rc;
}
return sfd;
}
/*! Initialize a socket and fill \ref osmo_fd
* \param[out] ofd file descriptor (will be filled in)
* \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC
* \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
* \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
* \param[in] host remote host name or IP address in string form
* \param[in] port remote port number in host byte order
* \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
* \returns socket fd on success; negative on error
*
* This function creates (and optionall binds/connects) a socket using
* \ref osmo_sock_init, but also fills the \a ofd structure.
*/
int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto,
const char *host, uint16_t port, unsigned int flags)
{
return osmo_fd_init_ofd(ofd, osmo_sock_init(family, type, proto, host, port, flags));
}
/*! Initialize a socket and fill \ref osmo_fd
* \param[out] ofd file descriptor (will be filled in)
* \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC
* \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
* \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
* \param[in] local_host local host name or IP address in string form
* \param[in] local_port local port number in host byte order
* \param[in] remote_host remote host name or IP address in string form
* \param[in] remote_port remote port number in host byte order
* \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
* \returns socket fd on success; negative on error
*
* This function creates (and optionall binds/connects) a socket using
* \ref osmo_sock_init2, but also fills the \a ofd structure.
*/
int osmo_sock_init2_ofd(struct osmo_fd *ofd, int family, int type, int proto,
const char *local_host, uint16_t local_port,
const char *remote_host, uint16_t remote_port, unsigned int flags)
{
return osmo_fd_init_ofd(ofd, osmo_sock_init2(family, type, proto, local_host,
local_port, remote_host, remote_port, flags));
}
/*! Initialize a socket and fill \ref sockaddr
* \param[out] ss socket address (will be filled in)
* \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
* \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
* \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
* \returns socket fd on success; negative on error
*
* This function creates (and optionall binds/connects) a socket using
* \ref osmo_sock_init, but also fills the \a ss structure.
*/
int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type,
uint8_t proto, unsigned int flags)
{
char host[NI_MAXHOST];
uint16_t port;
struct sockaddr_in *sin;
struct sockaddr_in6 *sin6;
int s, sa_len;
/* determine port and host from ss */
switch (ss->sa_family) {
case AF_INET:
sin = (struct sockaddr_in *) ss;
sa_len = sizeof(struct sockaddr_in);
port = ntohs(sin->sin_port);
break;
case AF_INET6:
sin6 = (struct sockaddr_in6 *) ss;
sa_len = sizeof(struct sockaddr_in6);
port = ntohs(sin6->sin6_port);
break;
default:
return -EINVAL;
}
s = getnameinfo(ss, sa_len, host, NI_MAXHOST,
NULL, 0, NI_NUMERICHOST);
if (s != 0) {
LOGP(DLGLOBAL, LOGL_ERROR, "getnameinfo failed:"
" %s\n", strerror(errno));
return s;
}
return osmo_sock_init(ss->sa_family, type, proto, host, port, flags);
}
static int sockaddr_equal(const struct sockaddr *a,
const struct sockaddr *b, unsigned int len)
{
struct sockaddr_in *sin_a, *sin_b;
struct sockaddr_in6 *sin6_a, *sin6_b;
if (a->sa_family != b->sa_family)
return 0;
switch (a->sa_family) {
case AF_INET:
sin_a = (struct sockaddr_in *)a;
sin_b = (struct sockaddr_in *)b;
if (!memcmp(&sin_a->sin_addr, &sin_b->sin_addr,
sizeof(struct in_addr)))
return 1;
break;
case AF_INET6:
sin6_a = (struct sockaddr_in6 *)a;
sin6_b = (struct sockaddr_in6 *)b;
if (!memcmp(&sin6_a->sin6_addr, &sin6_b->sin6_addr,
sizeof(struct in6_addr)))
return 1;
break;
}
return 0;
}
/*! Determine if the given address is a local address
* \param[in] addr Socket Address
* \param[in] addrlen Length of socket address in bytes
* \returns 1 if address is local, 0 otherwise.
*/
int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen)
{
struct ifaddrs *ifaddr, *ifa;
if (getifaddrs(&ifaddr) == -1) {
LOGP(DLGLOBAL, LOGL_ERROR, "getifaddrs:"
" %s\n", strerror(errno));
return -EIO;
}
for (ifa = ifaddr; ifa != NULL; ifa = ifa->ifa_next) {
if (!ifa->ifa_addr)
continue;
if (sockaddr_equal(ifa->ifa_addr, addr, addrlen)) {
freeifaddrs(ifaddr);
return 1;
}
}
freeifaddrs(ifaddr);
return 0;
}
/*! Convert sockaddr_in to IP address as char string and port as uint16_t.
* \param[out] addr String buffer to write IP address to, or NULL.
* \param[out] addr_len Size of \a addr.
* \param[out] port Pointer to uint16_t to write the port number to, or NULL.
* \param[in] sin Sockaddr to convert.
* \returns the required string buffer size, like osmo_strlcpy(), or 0 if \a addr is NULL.
*/
size_t osmo_sockaddr_in_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
const struct sockaddr_in *sin)
{
if (port)
*port = ntohs(sin->sin_port);
if (addr)
return osmo_strlcpy(addr, inet_ntoa(sin->sin_addr), addr_len);
return 0;
}
/*! Convert sockaddr to IP address as char string and port as uint16_t.
* \param[out] addr String buffer to write IP address to, or NULL.
* \param[out] addr_len Size of \a addr.
* \param[out] port Pointer to uint16_t to write the port number to, or NULL.
* \param[in] sa Sockaddr to convert.
* \returns the required string buffer size, like osmo_strlcpy(), or 0 if \a addr is NULL.
*/
unsigned int osmo_sockaddr_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
const struct sockaddr *sa)
{
const struct sockaddr_in *sin = (const struct sockaddr_in *)sa;
return osmo_sockaddr_in_to_str_and_uint(addr, addr_len, port, sin);
}
/*! Initialize a unix domain socket (including bind/connect)
* \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
* \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
* \param[in] socket_path path to identify the socket
* \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
* \returns socket fd on success; negative on error
*
* This function creates a new unix domain socket, \a
* type and \a proto and optionally binds or connects it, depending on
* the value of \a flags parameter.
*/
#if defined(__clang__) && defined(SUN_LEN)
__attribute__((no_sanitize("undefined")))
#endif
int osmo_sock_unix_init(uint16_t type, uint8_t proto,
const char *socket_path, unsigned int flags)
{
struct sockaddr_un local;
int sfd, rc, on = 1;
unsigned int namelen;
if ((flags & (OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT)) ==
(OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT))
return -EINVAL;
local.sun_family = AF_UNIX;
/* When an AF_UNIX socket is bound, sun_path should be NUL-terminated. See unix(7) man page. */
if (osmo_strlcpy(local.sun_path, socket_path, sizeof(local.sun_path)) >= sizeof(local.sun_path)) {
LOGP(DLGLOBAL, LOGL_ERROR, "Socket path exceeds maximum length of %zd bytes: %s\n",
sizeof(local.sun_path), socket_path);
return -ENOSPC;
}
#if defined(BSD44SOCKETS) || defined(__UNIXWARE__)
local.sun_len = strlen(local.sun_path);
#endif
#if defined(BSD44SOCKETS) || defined(SUN_LEN)
namelen = SUN_LEN(&local);
#else
namelen = strlen(local.sun_path) +
offsetof(struct sockaddr_un, sun_path);
#endif
sfd = socket(AF_UNIX, type, proto);
if (sfd < 0)
return -1;
if (flags & OSMO_SOCK_F_CONNECT) {
rc = connect(sfd, (struct sockaddr *)&local, namelen);
if (rc < 0)
goto err;
} else {
unlink(local.sun_path);
rc = bind(sfd, (struct sockaddr *)&local, namelen);
if (rc < 0)
goto err;
}
if (flags & OSMO_SOCK_F_NONBLOCK) {
if (ioctl(sfd, FIONBIO, (unsigned char *)&on) < 0) {
LOGP(DLGLOBAL, LOGL_ERROR,
"cannot set this socket unblocking: %s\n",
strerror(errno));
close(sfd);
return -EINVAL;
}
}
rc = osmo_sock_init_tail(sfd, type, flags);
if (rc < 0) {
close(sfd);
sfd = -1;
}
return sfd;
err:
close(sfd);
return -1;
}
/*! Initialize a unix domain socket and fill \ref osmo_fd
* \param[out] ofd file descriptor (will be filled in)
* \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
* \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
* \param[in] socket_path path to identify the socket
* \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
* \returns socket fd on success; negative on error
*
* This function creates (and optionally binds/connects) a socket
* using osmo_sock_unix_init, but also fills the ofd structure.
*/
int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto,
const char *socket_path, unsigned int flags)
{
return osmo_fd_init_ofd(ofd, osmo_sock_unix_init(type, proto, socket_path, flags));
}
/*! Get the IP and/or port number on socket in separate string buffers.
* \param[in] fd file descriptor of socket
* \param[out] ip IP address (will be filled in when not NULL)
* \param[in] ip_len length of the ip buffer
* \param[out] port number (will be filled in when not NULL)
* \param[in] port_len length of the port buffer
* \param[in] local (true) or remote (false) name will get looked at
* \returns 0 on success; negative otherwise
*/
int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local)
{
struct sockaddr sa;
socklen_t len = sizeof(sa);
char ipbuf[INET6_ADDRSTRLEN], portbuf[6];
int rc;
rc = local ? getsockname(fd, &sa, &len) : getpeername(fd, &sa, &len);
if (rc < 0)
return rc;
rc = getnameinfo(&sa, len, ipbuf, sizeof(ipbuf),
portbuf, sizeof(portbuf),
NI_NUMERICHOST | NI_NUMERICSERV);
if (rc < 0)
return rc;
if (ip)
strncpy(ip, ipbuf, ip_len);
if (port)
strncpy(port, portbuf, port_len);
return 0;
}
/*! Get local IP address on socket
* \param[in] fd file descriptor of socket
* \param[out] ip IP address (will be filled in)
* \param[in] len length of the output buffer
* \returns 0 on success; negative otherwise
*/
int osmo_sock_get_local_ip(int fd, char *ip, size_t len)
{
return osmo_sock_get_ip_and_port(fd, ip, len, NULL, 0, true);
}
/*! Get local port on socket
* \param[in] fd file descriptor of socket
* \param[out] port number (will be filled in)
* \param[in] len length of the output buffer
* \returns 0 on success; negative otherwise
*/
int osmo_sock_get_local_ip_port(int fd, char *port, size_t len)
{
return osmo_sock_get_ip_and_port(fd, NULL, 0, port, len, true);
}
/*! Get remote IP address on socket
* \param[in] fd file descriptor of socket
* \param[out] ip IP address (will be filled in)
* \param[in] len length of the output buffer
* \returns 0 on success; negative otherwise
*/
int osmo_sock_get_remote_ip(int fd, char *ip, size_t len)
{
return osmo_sock_get_ip_and_port(fd, ip, len, NULL, 0, false);
}
/*! Get remote port on socket
* \param[in] fd file descriptor of socket
* \param[out] port number (will be filled in)
* \param[in] len length of the output buffer
* \returns 0 on success; negative otherwise
*/
int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len)
{
return osmo_sock_get_ip_and_port(fd, NULL, 0, port, len, false);
}
/*! Get address/port information on socket in dyn-alloc string like "(r=1.2.3.4:5<->l=6.7.8.9:10)".
* Usually, it is better to use osmo_sock_get_name2() for a static string buffer or osmo_sock_get_name_buf() for a
* caller provided string buffer, to avoid the dynamic talloc allocation.
* \param[in] ctx talloc context from which to allocate string buffer
* \param[in] fd file descriptor of socket
* \returns string identifying the connection of this socket, talloc'd from ctx.
*/
char *osmo_sock_get_name(const void *ctx, int fd)
{
char str[OSMO_SOCK_NAME_MAXLEN];
int rc;
rc = osmo_sock_get_name_buf(str, sizeof(str), fd);
if (rc <= 0)
return NULL;
return talloc_asprintf(ctx, "(%s)", str);
}
/*! Get address/port information on socket in provided string buffer, like "r=1.2.3.4:5<->l=6.7.8.9:10".
* This does not include braces like osmo_sock_get_name().
* \param[out] str Destination string buffer.
* \param[in] str_len sizeof(str).
* \param[in] fd File descriptor of socket.
* \return String length as returned by snprintf(), or negative on error.
*/
int osmo_sock_get_name_buf(char *str, size_t str_len, int fd)
{
char hostbuf_l[INET6_ADDRSTRLEN], hostbuf_r[INET6_ADDRSTRLEN];
char portbuf_l[6], portbuf_r[6];
int rc;
/* get local */
if ((rc = osmo_sock_get_ip_and_port(fd, hostbuf_l, sizeof(hostbuf_l), portbuf_l, sizeof(portbuf_l), true))) {
osmo_strlcpy(str, "<error-in-getsockname>", str_len);
return rc;
}
/* get remote */
if (osmo_sock_get_ip_and_port(fd, hostbuf_r, sizeof(hostbuf_r), portbuf_r, sizeof(portbuf_r), false) != 0)
return snprintf(str, str_len, "r=NULL<->l=%s:%s", hostbuf_l, portbuf_l);
return snprintf(str, str_len, "r=%s:%s<->l=%s:%s", hostbuf_r, portbuf_r, hostbuf_l, portbuf_l);
}
/*! Get address/port information on socket in static string, like "r=1.2.3.4:5<->l=6.7.8.9:10".
* This does not include braces like osmo_sock_get_name().
* \param[in] fd File descriptor of socket.
* \return Static string buffer containing the result.
*/
const char *osmo_sock_get_name2(int fd)
{
static __thread char str[OSMO_SOCK_NAME_MAXLEN];
osmo_sock_get_name_buf(str, sizeof(str), fd);
return str;
}
/*! Get address/port information on socket in static string, like "r=1.2.3.4:5<->l=6.7.8.9:10".
* This does not include braces like osmo_sock_get_name().
* \param[in] fd File descriptor of socket.
* \return Static string buffer containing the result.
*/
char *osmo_sock_get_name2_c(const void *ctx, int fd)
{
char *str = talloc_size(ctx, OSMO_SOCK_NAME_MAXLEN);
if (!str)
return NULL;
osmo_sock_get_name_buf(str, OSMO_SOCK_NAME_MAXLEN, fd);
return str;
}
static int sock_get_domain(int fd)
{
int domain;
#ifdef SO_DOMAIN
socklen_t dom_len = sizeof(domain);
int rc;
rc = getsockopt(fd, SOL_SOCKET, SO_DOMAIN, &domain, &dom_len);
if (rc < 0)
return rc;
#else
/* This of course sucks, but what shall we do on OSs like
* FreeBSD that don't seem to expose a method by which one can
* learn the address family of a socket? */
domain = AF_INET;
#endif
return domain;
}
/*! Activate or de-activate local loop-back of transmitted multicast packets
* \param[in] fd file descriptor of related socket
* \param[in] enable Enable (true) or disable (false) loop-back
* \returns 0 on success; negative otherwise */
int osmo_sock_mcast_loop_set(int fd, bool enable)
{
int domain, loop = 0;
if (enable)
loop = 1;
domain = sock_get_domain(fd);
if (domain < 0)
return domain;
switch (domain) {
case AF_INET:
return setsockopt(fd, IPPROTO_IP, IP_MULTICAST_LOOP, &loop, sizeof(loop));
case AF_INET6:
return setsockopt(fd, IPPROTO_IPV6, IPV6_MULTICAST_LOOP, &loop, sizeof(loop));
default:
return -EINVAL;
}
}
/*! Set the TTL of outbound multicast packets
* \param[in] fd file descriptor of related socket
* \param[in] ttl TTL of to-be-sent multicast packets
* \returns 0 on success; negative otherwise */
int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl)
{
int domain, ttli = ttl;
domain = sock_get_domain(fd);
if (domain < 0)
return domain;
switch (domain) {
case AF_INET:
return setsockopt(fd, IPPROTO_IP, IP_MULTICAST_TTL, &ttli,
|