-
Notifications
You must be signed in to change notification settings - Fork 6.9k
/
Copy pathnet_ip.h
1454 lines (1289 loc) · 39.3 KB
/
net_ip.h
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
/** @file
* @brief IPv6 and IPv4 definitions
*
* Generic IPv6 and IPv4 address definitions.
*/
/*
* Copyright (c) 2016 Intel Corporation
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef ZEPHYR_INCLUDE_NET_NET_IP_H_
#define ZEPHYR_INCLUDE_NET_NET_IP_H_
/**
* @brief IPv4/IPv6 primitives and helpers
* @defgroup ip_4_6 IPv4/IPv6 primitives and helpers
* @ingroup networking
* @{
*/
#include <string.h>
#include <zephyr/types.h>
#include <stdbool.h>
#include <sys/util.h>
#include <sys/byteorder.h>
#include <toolchain.h>
#include <net/net_linkaddr.h>
#ifdef __cplusplus
extern "C" {
#endif
/** @cond INTERNAL_HIDDEN */
/* Specifying VLAN tag here in order to avoid circular dependencies */
#define NET_VLAN_TAG_UNSPEC 0x0fff
/** @endcond */
/* Protocol families. */
#define PF_UNSPEC 0 /**< Unspecified protocol family. */
#define PF_INET 1 /**< IP protocol family version 4. */
#define PF_INET6 2 /**< IP protocol family version 6. */
#define PF_PACKET 3 /**< Packet family. */
#define PF_CAN 4 /**< Controller Area Network. */
#define PF_NET_MGMT 5 /**< Network management info. */
#define PF_LOCAL 6 /**< Inter-process communication */
#define PF_UNIX PF_LOCAL /**< Inter-process communication */
/* Address families. */
#define AF_UNSPEC PF_UNSPEC /**< Unspecified address family. */
#define AF_INET PF_INET /**< IP protocol family version 4. */
#define AF_INET6 PF_INET6 /**< IP protocol family version 6. */
#define AF_PACKET PF_PACKET /**< Packet family. */
#define AF_CAN PF_CAN /**< Controller Area Network. */
#define AF_NET_MGMT PF_NET_MGMT /**< Network management info. */
#define AF_LOCAL PF_LOCAL /**< Inter-process communication */
#define AF_UNIX PF_UNIX /**< Inter-process communication */
/** Protocol numbers from IANA/BSD */
enum net_ip_protocol {
IPPROTO_IP = 0, /**< IP protocol (pseudo-val for setsockopt() */
IPPROTO_ICMP = 1, /**< ICMP protocol */
IPPROTO_TCP = 6, /**< TCP protocol */
IPPROTO_UDP = 17, /**< UDP protocol */
IPPROTO_IPV6 = 41, /**< IPv6 protocol */
IPPROTO_ICMPV6 = 58, /**< ICMPv6 protocol */
IPPROTO_RAW = 255, /**< RAW IP packets */
};
/** Protocol numbers for TLS protocols */
enum net_ip_protocol_secure {
IPPROTO_TLS_1_0 = 256, /**< TLS 1.0 protocol */
IPPROTO_TLS_1_1 = 257, /**< TLS 1.1 protocol */
IPPROTO_TLS_1_2 = 258, /**< TLS 1.2 protocol */
IPPROTO_DTLS_1_0 = 272, /**< DTLS 1.0 protocol */
IPPROTO_DTLS_1_2 = 273, /**< DTLS 1.2 protocol */
};
/** Socket type */
enum net_sock_type {
SOCK_STREAM = 1, /**< Stream socket type */
SOCK_DGRAM, /**< Datagram socket type */
SOCK_RAW /**< RAW socket type */
};
/** @brief Convert 16-bit value from network to host byte order.
*
* @param x The network byte order value to convert.
*
* @return Host byte order value.
*/
#define ntohs(x) sys_be16_to_cpu(x)
/** @brief Convert 32-bit value from network to host byte order.
*
* @param x The network byte order value to convert.
*
* @return Host byte order value.
*/
#define ntohl(x) sys_be32_to_cpu(x)
/** @brief Convert 64-bit value from network to host byte order.
*
* @param x The network byte order value to convert.
*
* @return Host byte order value.
*/
#define ntohll(x) sys_be64_to_cpu(x)
/** @brief Convert 16-bit value from host to network byte order.
*
* @param x The host byte order value to convert.
*
* @return Network byte order value.
*/
#define htons(x) sys_cpu_to_be16(x)
/** @brief Convert 32-bit value from host to network byte order.
*
* @param x The host byte order value to convert.
*
* @return Network byte order value.
*/
#define htonl(x) sys_cpu_to_be32(x)
/** @brief Convert 64-bit value from host to network byte order.
*
* @param x The host byte order value to convert.
*
* @return Network byte order value.
*/
#define htonll(x) sys_cpu_to_be64(x)
/** IPv6 address struct */
struct in6_addr {
union {
uint8_t s6_addr[16];
uint16_t s6_addr16[8]; /* In big endian */
uint32_t s6_addr32[4]; /* In big endian */
};
};
/** IPv4 address struct */
struct in_addr {
union {
uint8_t s4_addr[4];
uint16_t s4_addr16[2]; /* In big endian */
uint32_t s4_addr32[1]; /* In big endian */
uint32_t s_addr; /* In big endian, for POSIX compatibility. */
};
};
/** Socket address family type */
typedef unsigned short int sa_family_t;
/** Length of a socket address */
typedef size_t socklen_t;
/*
* Note that the sin_port and sin6_port are in network byte order
* in various sockaddr* structs.
*/
/** Socket address struct for IPv6. */
struct sockaddr_in6 {
sa_family_t sin6_family; /* AF_INET6 */
uint16_t sin6_port; /* Port number */
struct in6_addr sin6_addr; /* IPv6 address */
uint8_t sin6_scope_id; /* interfaces for a scope */
};
struct sockaddr_in6_ptr {
sa_family_t sin6_family; /* AF_INET6 */
uint16_t sin6_port; /* Port number */
struct in6_addr *sin6_addr; /* IPv6 address */
uint8_t sin6_scope_id; /* interfaces for a scope */
};
/** Socket address struct for IPv4. */
struct sockaddr_in {
sa_family_t sin_family; /* AF_INET */
uint16_t sin_port; /* Port number */
struct in_addr sin_addr; /* IPv4 address */
};
struct sockaddr_in_ptr {
sa_family_t sin_family; /* AF_INET */
uint16_t sin_port; /* Port number */
struct in_addr *sin_addr; /* IPv4 address */
};
/** Socket address struct for packet socket. */
struct sockaddr_ll {
sa_family_t sll_family; /* Always AF_PACKET */
uint16_t sll_protocol; /* Physical-layer protocol */
int sll_ifindex; /* Interface number */
uint16_t sll_hatype; /* ARP hardware type */
uint8_t sll_pkttype; /* Packet type */
uint8_t sll_halen; /* Length of address */
uint8_t sll_addr[8]; /* Physical-layer address */
};
struct sockaddr_ll_ptr {
sa_family_t sll_family; /* Always AF_PACKET */
uint16_t sll_protocol; /* Physical-layer protocol */
int sll_ifindex; /* Interface number */
uint16_t sll_hatype; /* ARP hardware type */
uint8_t sll_pkttype; /* Packet type */
uint8_t sll_halen; /* Length of address */
uint8_t *sll_addr; /* Physical-layer address */
};
struct sockaddr_can_ptr {
sa_family_t can_family;
int can_ifindex;
};
#if !defined(HAVE_IOVEC)
struct iovec {
void *iov_base;
size_t iov_len;
};
#endif
struct msghdr {
void *msg_name; /* optional socket address */
socklen_t msg_namelen; /* size of socket address */
struct iovec *msg_iov; /* scatter/gather array */
size_t msg_iovlen; /* number of elements in msg_iov */
void *msg_control; /* ancillary data */
size_t msg_controllen; /* ancillary data buffer len */
int msg_flags; /* flags on received message */
};
struct cmsghdr {
socklen_t cmsg_len; /* Number of bytes, including header */
int cmsg_level; /* Originating protocol */
int cmsg_type; /* Protocol-specific type */
/* Followed by unsigned char cmsg_data[]; */
};
/* Alignment for headers and data. These are arch specific but define
* them here atm if not found alredy.
*/
#if !defined(ALIGN_H)
#define ALIGN_H(x) WB_UP(x)
#endif
#if !defined(ALIGN_D)
#define ALIGN_D(x) WB_UP(x)
#endif
#if !defined(CMSG_FIRSTHDR)
#define CMSG_FIRSTHDR(msghdr) \
((msghdr)->msg_controllen >= sizeof(struct cmsghdr) ? \
(struct cmsghdr *)((msghdr)->msg_control) : NULL)
#endif
#if !defined(CMSG_NXTHDR)
#define CMSG_NXTHDR(msghdr, cmsg) \
(((cmsg) == NULL) ? CMSG_FIRSTHDR(msghdr) : \
(((uint8_t *)(cmsg) + ALIGN_H((cmsg)->cmsg_len) + \
ALIGN_D(sizeof(struct cmsghdr)) > \
(uint8_t *)((msghdr)->msg_control) + (msghdr)->msg_controllen) ? \
NULL : \
(struct cmsghdr *)((uint8_t *)(cmsg) + \
ALIGN_H((cmsg)->cmsg_len))))
#endif
#if !defined(CMSG_DATA)
#define CMSG_DATA(cmsg) ((uint8_t *)(cmsg) + ALIGN_D(sizeof(struct cmsghdr)))
#endif
#if !defined(CMSG_SPACE)
#define CMSG_SPACE(length) (ALIGN_D(sizeof(struct cmsghdr)) + ALIGN_H(length))
#endif
#if !defined(CMSG_LEN)
#define CMSG_LEN(length) (ALIGN_D(sizeof(struct cmsghdr)) + length)
#endif
/** @cond INTERNAL_HIDDEN */
/* Packet types. */
#define PACKET_HOST 0 /* To us */
#define PACKET_BROADCAST 1 /* To all */
#define PACKET_MULTICAST 2 /* To group */
#define PACKET_OTHERHOST 3 /* To someone else */
#define PACKET_OUTGOING 4 /* Originated by us */
#define PACKET_LOOPBACK 5
#define PACKET_FASTROUTE 6
/* Note: These macros are defined in a specific order.
* The largest sockaddr size is the last one.
*/
#if defined(CONFIG_NET_IPV4)
#undef NET_SOCKADDR_MAX_SIZE
#undef NET_SOCKADDR_PTR_MAX_SIZE
#define NET_SOCKADDR_MAX_SIZE (sizeof(struct sockaddr_in))
#define NET_SOCKADDR_PTR_MAX_SIZE (sizeof(struct sockaddr_in_ptr))
#endif
#if defined(CONFIG_NET_SOCKETS_PACKET)
#undef NET_SOCKADDR_MAX_SIZE
#undef NET_SOCKADDR_PTR_MAX_SIZE
#define NET_SOCKADDR_MAX_SIZE (sizeof(struct sockaddr_ll))
#define NET_SOCKADDR_PTR_MAX_SIZE (sizeof(struct sockaddr_ll_ptr))
#endif
#if defined(CONFIG_NET_IPV6)
#undef NET_SOCKADDR_MAX_SIZE
#undef NET_SOCKADDR_PTR_MAX_SIZE
#define NET_SOCKADDR_MAX_SIZE (sizeof(struct sockaddr_in6))
#define NET_SOCKADDR_PTR_MAX_SIZE (sizeof(struct sockaddr_in6_ptr))
#endif
#if !defined(CONFIG_NET_IPV4)
#if !defined(CONFIG_NET_IPV6)
#if !defined(CONFIG_NET_SOCKETS_PACKET)
#define NET_SOCKADDR_MAX_SIZE (sizeof(struct sockaddr_in6))
#define NET_SOCKADDR_PTR_MAX_SIZE (sizeof(struct sockaddr_in6_ptr))
#endif
#endif
#endif
/** @endcond */
/** Generic sockaddr struct. Must be cast to proper type. */
struct sockaddr {
sa_family_t sa_family;
char data[NET_SOCKADDR_MAX_SIZE - sizeof(sa_family_t)];
};
/** @cond INTERNAL_HIDDEN */
struct sockaddr_ptr {
sa_family_t family;
char data[NET_SOCKADDR_PTR_MAX_SIZE - sizeof(sa_family_t)];
};
/* Same as sockaddr in our case */
struct sockaddr_storage {
sa_family_t ss_family;
char data[NET_SOCKADDR_MAX_SIZE - sizeof(sa_family_t)];
};
/* Socket address struct for UNIX domain sockets */
struct sockaddr_un {
sa_family_t sun_family; /* AF_UNIX */
char sun_path[NET_SOCKADDR_MAX_SIZE - sizeof(sa_family_t)];
};
struct net_addr {
sa_family_t family;
union {
struct in6_addr in6_addr;
struct in_addr in_addr;
};
};
#define IN6ADDR_ANY_INIT { { { 0, 0, 0, 0, 0, 0, 0, 0, 0, \
0, 0, 0, 0, 0, 0, 0 } } }
#define IN6ADDR_LOOPBACK_INIT { { { 0, 0, 0, 0, 0, 0, 0, \
0, 0, 0, 0, 0, 0, 0, 0, 1 } } }
extern const struct in6_addr in6addr_any;
extern const struct in6_addr in6addr_loopback;
/** @endcond */
/** Max length of the IPv4 address as a string. Defined by POSIX. */
#define INET_ADDRSTRLEN 16
/** Max length of the IPv6 address as a string. Takes into account possible
* mapped IPv4 addresses.
*/
#define INET6_ADDRSTRLEN 46
/** @cond INTERNAL_HIDDEN */
/* These are for internal usage of the stack */
#define NET_IPV6_ADDR_LEN sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx")
#define NET_IPV4_ADDR_LEN sizeof("xxx.xxx.xxx.xxx")
#define INADDR_ANY 0
#define INADDR_ANY_INIT { { { INADDR_ANY } } }
/** @endcond */
enum net_ip_mtu {
/** IPv6 MTU length. We must be able to receive this size IPv6 packet
* without fragmentation.
*/
NET_IPV6_MTU = 1280,
/** IPv4 MTU length. We must be able to receive this size IPv4 packet
* without fragmentation.
*/
NET_IPV4_MTU = 576,
};
/** Network packet priority settings described in IEEE 802.1Q Annex I.1 */
enum net_priority {
NET_PRIORITY_BK = 1, /**< Background (lowest) */
NET_PRIORITY_BE = 0, /**< Best effort (default) */
NET_PRIORITY_EE = 2, /**< Excellent effort */
NET_PRIORITY_CA = 3, /**< Critical applications (highest) */
NET_PRIORITY_VI = 4, /**< Video, < 100 ms latency and jitter */
NET_PRIORITY_VO = 5, /**< Voice, < 10 ms latency and jitter */
NET_PRIORITY_IC = 6, /**< Internetwork control */
NET_PRIORITY_NC = 7 /**< Network control */
} __packed;
/** IPv6/IPv4 network connection tuple */
struct net_tuple {
struct net_addr *remote_addr; /**< IPv6/IPv4 remote address */
struct net_addr *local_addr; /**< IPv6/IPv4 local address */
uint16_t remote_port; /**< UDP/TCP remote port */
uint16_t local_port; /**< UDP/TCP local port */
enum net_ip_protocol ip_proto; /**< IP protocol */
};
/** What is the current state of the network address */
enum net_addr_state {
NET_ADDR_ANY_STATE = -1, /**< Default (invalid) address type */
NET_ADDR_TENTATIVE = 0, /**< Tentative address */
NET_ADDR_PREFERRED, /**< Preferred address */
NET_ADDR_DEPRECATED, /**< Deprecated address */
} __packed;
/** How the network address is assigned to network interface */
enum net_addr_type {
/** Default value. This is not a valid value. */
NET_ADDR_ANY = 0,
/** Auto configured address */
NET_ADDR_AUTOCONF,
/** Address is from DHCP */
NET_ADDR_DHCP,
/** Manually set address */
NET_ADDR_MANUAL,
/** Manually set address which is overridable by DHCP */
NET_ADDR_OVERRIDABLE,
} __packed;
/** @cond INTERNAL_HIDDEN */
struct net_ipv6_hdr {
uint8_t vtc;
uint8_t tcflow;
uint16_t flow;
uint16_t len;
uint8_t nexthdr;
uint8_t hop_limit;
struct in6_addr src;
struct in6_addr dst;
} __packed;
struct net_ipv6_frag_hdr {
uint8_t nexthdr;
uint8_t reserved;
uint16_t offset;
uint32_t id;
} __packed;
struct net_ipv4_hdr {
uint8_t vhl;
uint8_t tos;
uint16_t len;
uint8_t id[2];
uint8_t offset[2];
uint8_t ttl;
uint8_t proto;
uint16_t chksum;
struct in_addr src;
struct in_addr dst;
} __packed;
struct net_icmp_hdr {
uint8_t type;
uint8_t code;
uint16_t chksum;
} __packed;
struct net_udp_hdr {
uint16_t src_port;
uint16_t dst_port;
uint16_t len;
uint16_t chksum;
} __packed;
struct net_tcp_hdr {
uint16_t src_port;
uint16_t dst_port;
uint8_t seq[4];
uint8_t ack[4];
uint8_t offset;
uint8_t flags;
uint8_t wnd[2];
uint16_t chksum;
uint8_t urg[2];
uint8_t optdata[0];
} __packed;
static inline const char *net_addr_type2str(enum net_addr_type type)
{
switch (type) {
case NET_ADDR_AUTOCONF:
return "AUTO";
case NET_ADDR_DHCP:
return "DHCP";
case NET_ADDR_MANUAL:
return "MANUAL";
case NET_ADDR_OVERRIDABLE:
return "OVERRIDE";
case NET_ADDR_ANY:
default:
break;
}
return "<unknown>";
}
/* IPv6 extension headers types */
#define NET_IPV6_NEXTHDR_HBHO 0
#define NET_IPV6_NEXTHDR_DESTO 60
#define NET_IPV6_NEXTHDR_ROUTING 43
#define NET_IPV6_NEXTHDR_FRAG 44
#define NET_IPV6_NEXTHDR_NONE 59
/**
* This 2 unions are here temporarily, as long as net_context.h will
* be still public and not part of the core only.
*/
union net_ip_header {
struct net_ipv4_hdr *ipv4;
struct net_ipv6_hdr *ipv6;
};
union net_proto_header {
struct net_udp_hdr *udp;
struct net_tcp_hdr *tcp;
};
#define NET_UDPH_LEN 8 /* Size of UDP header */
#define NET_TCPH_LEN 20 /* Size of TCP header */
#define NET_ICMPH_LEN 4 /* Size of ICMP header */
#define NET_IPV6H_LEN 40 /* Size of IPv6 header */
#define NET_ICMPV6H_LEN NET_ICMPH_LEN /* Size of ICMPv6 header */
#define NET_IPV6UDPH_LEN (NET_UDPH_LEN + NET_IPV6H_LEN) /* IPv6 + UDP */
#define NET_IPV6TCPH_LEN (NET_TCPH_LEN + NET_IPV6H_LEN) /* IPv6 + TCP */
#define NET_IPV6ICMPH_LEN (NET_IPV6H_LEN + NET_ICMPH_LEN) /* ICMPv6 + IPv6 */
#define NET_IPV6_FRAGH_LEN 8
#define NET_IPV4H_LEN 20 /* Size of IPv4 header */
#define NET_ICMPV4H_LEN NET_ICMPH_LEN /* Size of ICMPv4 header */
#define NET_IPV4UDPH_LEN (NET_UDPH_LEN + NET_IPV4H_LEN) /* IPv4 + UDP */
#define NET_IPV4TCPH_LEN (NET_TCPH_LEN + NET_IPV4H_LEN) /* IPv4 + TCP */
#define NET_IPV4ICMPH_LEN (NET_IPV4H_LEN + NET_ICMPH_LEN) /* ICMPv4 + IPv4 */
/** @endcond */
/**
* @brief Check if the IPv6 address is a loopback address (::1).
*
* @param addr IPv6 address
*
* @return True if address is a loopback address, False otherwise.
*/
static inline bool net_ipv6_is_addr_loopback(struct in6_addr *addr)
{
return UNALIGNED_GET(&addr->s6_addr32[0]) == 0 &&
UNALIGNED_GET(&addr->s6_addr32[1]) == 0 &&
UNALIGNED_GET(&addr->s6_addr32[2]) == 0 &&
ntohl(UNALIGNED_GET(&addr->s6_addr32[3])) == 1;
}
/**
* @brief Check if the IPv6 address is a multicast address.
*
* @param addr IPv6 address
*
* @return True if address is multicast address, False otherwise.
*/
static inline bool net_ipv6_is_addr_mcast(const struct in6_addr *addr)
{
return addr->s6_addr[0] == 0xFF;
}
struct net_if;
struct net_if_config;
extern struct net_if_addr *net_if_ipv6_addr_lookup(const struct in6_addr *addr,
struct net_if **iface);
/**
* @brief Check if IPv6 address is found in one of the network interfaces.
*
* @param addr IPv6 address
*
* @return True if address was found, False otherwise.
*/
static inline bool net_ipv6_is_my_addr(struct in6_addr *addr)
{
return net_if_ipv6_addr_lookup(addr, NULL) != NULL;
}
extern struct net_if_mcast_addr *net_if_ipv6_maddr_lookup(
const struct in6_addr *addr, struct net_if **iface);
/**
* @brief Check if IPv6 multicast address is found in one of the
* network interfaces.
*
* @param maddr Multicast IPv6 address
*
* @return True if address was found, False otherwise.
*/
static inline bool net_ipv6_is_my_maddr(struct in6_addr *maddr)
{
return net_if_ipv6_maddr_lookup(maddr, NULL) != NULL;
}
/**
* @brief Check if two IPv6 addresses are same when compared after prefix mask.
*
* @param addr1 First IPv6 address.
* @param addr2 Second IPv6 address.
* @param length Prefix length (max length is 128).
*
* @return True if IPv6 prefixes are the same, False otherwise.
*/
static inline bool net_ipv6_is_prefix(const uint8_t *addr1,
const uint8_t *addr2,
uint8_t length)
{
uint8_t bits = 128 - length;
uint8_t bytes = length / 8U;
uint8_t remain = bits % 8;
uint8_t mask;
if (length > 128) {
return false;
}
if (memcmp(addr1, addr2, bytes)) {
return false;
}
if (!remain) {
/* No remaining bits, the prefixes are the same as first
* bytes are the same.
*/
return true;
}
/* Create a mask that has remaining most significant bits set */
mask = ((0xff << (8 - remain)) ^ 0xff) << remain;
return (addr1[bytes] & mask) == (addr2[bytes] & mask);
}
/**
* @brief Check if the IPv4 address is a loopback address (127.0.0.0/8).
*
* @param addr IPv4 address
*
* @return True if address is a loopback address, False otherwise.
*/
static inline bool net_ipv4_is_addr_loopback(struct in_addr *addr)
{
return addr->s4_addr[0] == 127U;
}
/**
* @brief Check if the IPv4 address is unspecified (all bits zero)
*
* @param addr IPv4 address.
*
* @return True if the address is unspecified, false otherwise.
*/
static inline bool net_ipv4_is_addr_unspecified(const struct in_addr *addr)
{
return UNALIGNED_GET(&addr->s_addr) == 0;
}
/**
* @brief Check if the IPv4 address is a multicast address.
*
* @param addr IPv4 address
*
* @return True if address is multicast address, False otherwise.
*/
static inline bool net_ipv4_is_addr_mcast(const struct in_addr *addr)
{
return (ntohl(UNALIGNED_GET(&addr->s_addr)) & 0xE0000000) == 0xE0000000;
}
/**
* @brief Check if the given IPv4 address is a link local address.
*
* @param addr A valid pointer on an IPv4 address
*
* @return True if it is, false otherwise.
*/
static inline bool net_ipv4_is_ll_addr(const struct in_addr *addr)
{
return (ntohl(UNALIGNED_GET(&addr->s_addr)) & 0xA9FE0000) == 0xA9FE0000;
}
/**
* @def net_ipaddr_copy
* @brief Copy an IPv4 or IPv6 address
*
* @param dest Destination IP address.
* @param src Source IP address.
*
* @return Destination address.
*/
#define net_ipaddr_copy(dest, src) \
UNALIGNED_PUT(UNALIGNED_GET(src), dest)
/**
* @brief Compare two IPv4 addresses
*
* @param addr1 Pointer to IPv4 address.
* @param addr2 Pointer to IPv4 address.
*
* @return True if the addresses are the same, false otherwise.
*/
static inline bool net_ipv4_addr_cmp(const struct in_addr *addr1,
const struct in_addr *addr2)
{
return UNALIGNED_GET(&addr1->s_addr) == UNALIGNED_GET(&addr2->s_addr);
}
/**
* @brief Compare two IPv6 addresses
*
* @param addr1 Pointer to IPv6 address.
* @param addr2 Pointer to IPv6 address.
*
* @return True if the addresses are the same, false otherwise.
*/
static inline bool net_ipv6_addr_cmp(const struct in6_addr *addr1,
const struct in6_addr *addr2)
{
return !memcmp(addr1, addr2, sizeof(struct in6_addr));
}
/**
* @brief Check if the given IPv6 address is a link local address.
*
* @param addr A valid pointer on an IPv6 address
*
* @return True if it is, false otherwise.
*/
static inline bool net_ipv6_is_ll_addr(const struct in6_addr *addr)
{
return UNALIGNED_GET(&addr->s6_addr16[0]) == htons(0xFE80);
}
/**
* @brief Return pointer to any (all bits zeros) IPv6 address.
*
* @return Any IPv6 address.
*/
const struct in6_addr *net_ipv6_unspecified_address(void);
/**
* @brief Return pointer to any (all bits zeros) IPv4 address.
*
* @return Any IPv4 address.
*/
const struct in_addr *net_ipv4_unspecified_address(void);
/**
* @brief Return pointer to broadcast (all bits ones) IPv4 address.
*
* @return Broadcast IPv4 address.
*/
const struct in_addr *net_ipv4_broadcast_address(void);
struct net_if;
extern bool net_if_ipv4_addr_mask_cmp(struct net_if *iface,
const struct in_addr *addr);
/**
* @brief Check if the given address belongs to same subnet that
* has been configured for the interface.
*
* @param iface A valid pointer on an interface
* @param addr IPv4 address
*
* @return True if address is in same subnet, false otherwise.
*/
static inline bool net_ipv4_addr_mask_cmp(struct net_if *iface,
const struct in_addr *addr)
{
return net_if_ipv4_addr_mask_cmp(iface, addr);
}
extern bool net_if_ipv4_is_addr_bcast(struct net_if *iface,
const struct in_addr *addr);
/**
* @brief Check if the given IPv4 address is a broadcast address.
*
* @param iface Interface to use. Must be a valid pointer to an interface.
* @param addr IPv4 address
*
* @return True if address is a broadcast address, false otherwise.
*/
#if defined(CONFIG_NET_NATIVE_IPV4)
static inline bool net_ipv4_is_addr_bcast(struct net_if *iface,
const struct in_addr *addr)
{
if (net_ipv4_addr_cmp(addr, net_ipv4_broadcast_address())) {
return true;
}
return net_if_ipv4_is_addr_bcast(iface, addr);
}
#else
static inline bool net_ipv4_is_addr_bcast(struct net_if *iface,
const struct in_addr *addr)
{
ARG_UNUSED(iface);
ARG_UNUSED(addr);
return false;
}
#endif
extern struct net_if_addr *net_if_ipv4_addr_lookup(const struct in_addr *addr,
struct net_if **iface);
/**
* @brief Check if the IPv4 address is assigned to any network interface
* in the system.
*
* @param addr A valid pointer on an IPv4 address
*
* @return True if IPv4 address is found in one of the network interfaces,
* False otherwise.
*/
static inline bool net_ipv4_is_my_addr(const struct in_addr *addr)
{
bool ret;
ret = net_if_ipv4_addr_lookup(addr, NULL) != NULL;
if (!ret) {
ret = net_ipv4_is_addr_bcast(NULL, addr);
}
return ret;
}
/**
* @brief Check if the IPv6 address is unspecified (all bits zero)
*
* @param addr IPv6 address.
*
* @return True if the address is unspecified, false otherwise.
*/
static inline bool net_ipv6_is_addr_unspecified(const struct in6_addr *addr)
{
return UNALIGNED_GET(&addr->s6_addr32[0]) == 0 &&
UNALIGNED_GET(&addr->s6_addr32[1]) == 0 &&
UNALIGNED_GET(&addr->s6_addr32[2]) == 0 &&
UNALIGNED_GET(&addr->s6_addr32[3]) == 0;
}
/**
* @brief Check if the IPv6 address is solicited node multicast address
* FF02:0:0:0:0:1:FFXX:XXXX defined in RFC 3513
*
* @param addr IPv6 address.
*
* @return True if the address is solicited node address, false otherwise.
*/
static inline bool net_ipv6_is_addr_solicited_node(const struct in6_addr *addr)
{
return UNALIGNED_GET(&addr->s6_addr32[0]) == htonl(0xff020000) &&
UNALIGNED_GET(&addr->s6_addr32[1]) == 0x00000000 &&
UNALIGNED_GET(&addr->s6_addr32[2]) == htonl(0x00000001) &&
((UNALIGNED_GET(&addr->s6_addr32[3]) & htonl(0xff000000)) ==
htonl(0xff000000));
}
/**
* @brief Check if the IPv6 address is a given scope multicast
* address (FFyx::).
*
* @param addr IPv6 address
* @param scope Scope to check
*
* @return True if the address is in given scope multicast address,
* false otherwise.
*/
static inline bool net_ipv6_is_addr_mcast_scope(const struct in6_addr *addr,
int scope)
{
return (addr->s6_addr[0] == 0xff) && (addr->s6_addr[1] == scope);
}
/**
* @brief Check if the IPv6 address is a global multicast address (FFxE::/16).
*
* @param addr IPv6 address.
*
* @return True if the address is global multicast address, false otherwise.
*/
static inline bool net_ipv6_is_addr_mcast_global(const struct in6_addr *addr)
{
return net_ipv6_is_addr_mcast_scope(addr, 0x0e);
}
/**
* @brief Check if the IPv6 address is a interface scope multicast
* address (FFx1::).
*
* @param addr IPv6 address.
*
* @return True if the address is a interface scope multicast address,
* false otherwise.
*/
static inline bool net_ipv6_is_addr_mcast_iface(const struct in6_addr *addr)
{
return net_ipv6_is_addr_mcast_scope(addr, 0x01);
}
/**
* @brief Check if the IPv6 address is a mesh-local scope multicast
* address (FFx3::).
*
* @param addr IPv6 address.
*
* @return True if the address is a mesh-local scope multicast address,
* false otherwise.
*/
static inline bool net_ipv6_is_addr_mcast_mesh(const struct in6_addr *addr)
{
return net_ipv6_is_addr_mcast_scope(addr, 0x03);
}
/**
* @brief Check if the IPv6 address is a site scope multicast
* address (FFx5::).
*
* @param addr IPv6 address.
*
* @return True if the address is a site scope multicast address,
* false otherwise.
*/
static inline bool net_ipv6_is_addr_mcast_site(const struct in6_addr *addr)
{
return net_ipv6_is_addr_mcast_scope(addr, 0x05);
}
/**
* @brief Check if the IPv6 address is an organization scope multicast
* address (FFx8::).
*
* @param addr IPv6 address.
*
* @return True if the address is an organization scope multicast address,
* false otherwise.
*/
static inline bool net_ipv6_is_addr_mcast_org(const struct in6_addr *addr)
{
return net_ipv6_is_addr_mcast_scope(addr, 0x08);
}
/**
* @brief Check if the IPv6 address belongs to certain multicast group
*
* @param addr IPv6 address.
* @param group Group id IPv6 address, the values must be in network
* byte order
*
* @return True if the IPv6 multicast address belongs to given multicast
* group, false otherwise.
*/
static inline bool net_ipv6_is_addr_mcast_group(const struct in6_addr *addr,
const struct in6_addr *group)
{
return UNALIGNED_GET(&addr->s6_addr16[1]) == group->s6_addr16[1] &&
UNALIGNED_GET(&addr->s6_addr16[2]) == group->s6_addr16[2] &&
UNALIGNED_GET(&addr->s6_addr16[3]) == group->s6_addr16[3] &&
UNALIGNED_GET(&addr->s6_addr32[1]) == group->s6_addr32[1] &&
UNALIGNED_GET(&addr->s6_addr32[2]) == group->s6_addr32[1] &&
UNALIGNED_GET(&addr->s6_addr32[3]) == group->s6_addr32[3];
}
/**
* @brief Create solicited node IPv6 multicast address
* FF02:0:0:0:0:1:FFXX:XXXX defined in RFC 3513
*
* @param src IPv6 address.