forked from openvswitch/ovs
/
packets.h
1644 lines (1437 loc) · 50.8 KB
/
packets.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
/*
* Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef PACKETS_H
#define PACKETS_H 1
#include <inttypes.h>
#include <sys/types.h>
#include <stdint.h>
#include <string.h>
#include "compiler.h"
#include "openvswitch/geneve.h"
#include "openvswitch/packets.h"
#include "openvswitch/types.h"
#include "openvswitch/nsh.h"
#include "odp-netlink.h"
#include "random.h"
#include "hash.h"
#include "tun-metadata.h"
#include "unaligned.h"
#include "util.h"
#include "timeval.h"
struct dp_packet;
struct ds;
/* Purely internal to OVS userspace. These flags should never be exposed to
* the outside world and so aren't included in the flags mask. */
/* Tunnel information is in userspace datapath format. */
#define FLOW_TNL_F_UDPIF (1 << 4)
static inline bool ipv6_addr_is_set(const struct in6_addr *addr);
static inline bool
flow_tnl_dst_is_set(const struct flow_tnl *tnl)
{
return tnl->ip_dst || ipv6_addr_is_set(&tnl->ipv6_dst);
}
struct in6_addr flow_tnl_dst(const struct flow_tnl *tnl);
struct in6_addr flow_tnl_src(const struct flow_tnl *tnl);
/* Returns an offset to 'src' covering all the meaningful fields in 'src'. */
static inline size_t
flow_tnl_size(const struct flow_tnl *src)
{
if (!flow_tnl_dst_is_set(src)) {
/* Covers ip_dst and ipv6_dst only. */
return offsetof(struct flow_tnl, ip_src);
}
if (src->flags & FLOW_TNL_F_UDPIF) {
/* Datapath format, cover all options we have. */
return offsetof(struct flow_tnl, metadata.opts)
+ src->metadata.present.len;
}
if (!src->metadata.present.map) {
/* No TLVs, opts is irrelevant. */
return offsetof(struct flow_tnl, metadata.opts);
}
/* Have decoded TLVs, opts is relevant. */
return sizeof *src;
}
/* Copy flow_tnl, but avoid copying unused portions of tun_metadata. Unused
* data in 'dst' is NOT cleared, so this must not be used in cases where the
* uninitialized portion may be hashed over. */
static inline void
flow_tnl_copy__(struct flow_tnl *dst, const struct flow_tnl *src)
{
memcpy(dst, src, flow_tnl_size(src));
}
static inline bool
flow_tnl_equal(const struct flow_tnl *a, const struct flow_tnl *b)
{
size_t a_size = flow_tnl_size(a);
return a_size == flow_tnl_size(b) && !memcmp(a, b, a_size);
}
/* Datapath packet metadata */
struct pkt_metadata {
PADDED_MEMBERS_CACHELINE_MARKER(CACHE_LINE_SIZE, cacheline0,
uint32_t recirc_id; /* Recirculation id carried with the
recirculating packets. 0 for packets
received from the wire. */
uint32_t dp_hash; /* hash value computed by the recirculation
action. */
uint32_t skb_priority; /* Packet priority for QoS. */
uint32_t pkt_mark; /* Packet mark. */
uint8_t ct_state; /* Connection state. */
bool ct_orig_tuple_ipv6;
uint16_t ct_zone; /* Connection zone. */
uint32_t ct_mark; /* Connection mark. */
ovs_u128 ct_label; /* Connection label. */
union flow_in_port in_port; /* Input port. */
);
PADDED_MEMBERS_CACHELINE_MARKER(CACHE_LINE_SIZE, cacheline1,
union { /* Populated only for non-zero 'ct_state'. */
struct ovs_key_ct_tuple_ipv4 ipv4;
struct ovs_key_ct_tuple_ipv6 ipv6; /* Used only if */
} ct_orig_tuple; /* 'ct_orig_tuple_ipv6' is set */
);
PADDED_MEMBERS_CACHELINE_MARKER(CACHE_LINE_SIZE, cacheline2,
struct flow_tnl tunnel; /* Encapsulating tunnel parameters. Note that
* if 'ip_dst' == 0, the rest of the fields may
* be uninitialized. */
);
};
BUILD_ASSERT_DECL(offsetof(struct pkt_metadata, cacheline0) == 0);
BUILD_ASSERT_DECL(offsetof(struct pkt_metadata, cacheline1) ==
CACHE_LINE_SIZE);
BUILD_ASSERT_DECL(offsetof(struct pkt_metadata, cacheline2) ==
2 * CACHE_LINE_SIZE);
static inline void
pkt_metadata_init_tnl(struct pkt_metadata *md)
{
/* Zero up through the tunnel metadata options. The length and table
* are before this and as long as they are empty, the options won't
* be looked at. */
memset(md, 0, offsetof(struct pkt_metadata, tunnel.metadata.opts));
}
static inline void
pkt_metadata_init(struct pkt_metadata *md, odp_port_t port)
{
/* This is called for every packet in userspace datapath and affects
* performance if all the metadata is initialized. Hence, fields should
* only be zeroed out when necessary.
*
* Initialize only till ct_state. Once the ct_state is zeroed out rest
* of ct fields will not be looked at unless ct_state != 0.
*/
memset(md, 0, offsetof(struct pkt_metadata, ct_orig_tuple_ipv6));
/* It can be expensive to zero out all of the tunnel metadata. However,
* we can just zero out ip_dst and the rest of the data will never be
* looked at. */
md->tunnel.ip_dst = 0;
md->tunnel.ipv6_dst = in6addr_any;
md->in_port.odp_port = port;
}
/* This function prefetches the cachelines touched by pkt_metadata_init()
* and pkt_metadata_init_tnl(). For performance reasons the two functions
* should be kept in sync. */
static inline void
pkt_metadata_prefetch_init(struct pkt_metadata *md)
{
/* Prefetch cacheline0 as members till ct_state and odp_port will
* be initialized later in pkt_metadata_init(). */
OVS_PREFETCH(md->cacheline0);
/* Prefetch cacheline1 as members of this cacheline will be zeroed out
* in pkt_metadata_init_tnl(). */
OVS_PREFETCH(md->cacheline1);
/* Prefetch cachline2 as ip_dst & ipv6_dst fields will be initialized. */
OVS_PREFETCH(md->cacheline2);
}
bool dpid_from_string(const char *s, uint64_t *dpidp);
#define ETH_ADDR_LEN 6
static const struct eth_addr eth_addr_broadcast OVS_UNUSED
= ETH_ADDR_C(ff,ff,ff,ff,ff,ff);
static const struct eth_addr eth_addr_exact OVS_UNUSED
= ETH_ADDR_C(ff,ff,ff,ff,ff,ff);
static const struct eth_addr eth_addr_zero OVS_UNUSED
= ETH_ADDR_C(00,00,00,00,00,00);
static const struct eth_addr64 eth_addr64_zero OVS_UNUSED
= ETH_ADDR64_C(00,00,00,00,00,00,00,00);
static const struct eth_addr eth_addr_stp OVS_UNUSED
= ETH_ADDR_C(01,80,c2,00,00,00);
static const struct eth_addr eth_addr_lacp OVS_UNUSED
= ETH_ADDR_C(01,80,c2,00,00,02);
static const struct eth_addr eth_addr_bfd OVS_UNUSED
= ETH_ADDR_C(00,23,20,00,00,01);
static inline bool eth_addr_is_broadcast(const struct eth_addr a)
{
return (a.be16[0] & a.be16[1] & a.be16[2]) == htons(0xffff);
}
static inline bool eth_addr_is_multicast(const struct eth_addr a)
{
return a.ea[0] & 1;
}
static inline bool eth_addr_is_local(const struct eth_addr a)
{
/* Local if it is either a locally administered address or a Nicira random
* address. */
return a.ea[0] & 2
|| (a.be16[0] == htons(0x0023)
&& (a.be16[1] & htons(0xff80)) == htons(0x2080));
}
static inline bool eth_addr_is_zero(const struct eth_addr a)
{
return !(a.be16[0] | a.be16[1] | a.be16[2]);
}
static inline bool eth_addr64_is_zero(const struct eth_addr64 a)
{
return !(a.be16[0] | a.be16[1] | a.be16[2] | a.be16[3]);
}
static inline int eth_mask_is_exact(const struct eth_addr a)
{
return (a.be16[0] & a.be16[1] & a.be16[2]) == htons(0xffff);
}
static inline int eth_addr_compare_3way(const struct eth_addr a,
const struct eth_addr b)
{
return memcmp(&a, &b, sizeof a);
}
static inline int eth_addr64_compare_3way(const struct eth_addr64 a,
const struct eth_addr64 b)
{
return memcmp(&a, &b, sizeof a);
}
static inline bool eth_addr_equals(const struct eth_addr a,
const struct eth_addr b)
{
return !eth_addr_compare_3way(a, b);
}
static inline bool eth_addr64_equals(const struct eth_addr64 a,
const struct eth_addr64 b)
{
return !eth_addr64_compare_3way(a, b);
}
static inline bool eth_addr_equal_except(const struct eth_addr a,
const struct eth_addr b,
const struct eth_addr mask)
{
return !(((a.be16[0] ^ b.be16[0]) & mask.be16[0])
|| ((a.be16[1] ^ b.be16[1]) & mask.be16[1])
|| ((a.be16[2] ^ b.be16[2]) & mask.be16[2]));
}
static inline uint64_t eth_addr_to_uint64(const struct eth_addr ea)
{
return (((uint64_t) ntohs(ea.be16[0]) << 32)
| ((uint64_t) ntohs(ea.be16[1]) << 16)
| ntohs(ea.be16[2]));
}
static inline uint64_t eth_addr_vlan_to_uint64(const struct eth_addr ea,
uint16_t vlan)
{
return (((uint64_t)vlan << 48) | eth_addr_to_uint64(ea));
}
static inline void eth_addr_from_uint64(uint64_t x, struct eth_addr *ea)
{
ea->be16[0] = htons(x >> 32);
ea->be16[1] = htons((x & 0xFFFF0000) >> 16);
ea->be16[2] = htons(x & 0xFFFF);
}
static inline struct eth_addr eth_addr_invert(const struct eth_addr src)
{
struct eth_addr dst;
for (int i = 0; i < ARRAY_SIZE(src.be16); i++) {
dst.be16[i] = ~src.be16[i];
}
return dst;
}
static inline void eth_addr_mark_random(struct eth_addr *ea)
{
ea->ea[0] &= ~1; /* Unicast. */
ea->ea[0] |= 2; /* Private. */
}
static inline void eth_addr_random(struct eth_addr *ea)
{
random_bytes((uint8_t *)ea, sizeof *ea);
eth_addr_mark_random(ea);
}
static inline void eth_addr_nicira_random(struct eth_addr *ea)
{
eth_addr_random(ea);
/* Set the OUI to the Nicira one. */
ea->ea[0] = 0x00;
ea->ea[1] = 0x23;
ea->ea[2] = 0x20;
/* Set the top bit to indicate random Nicira address. */
ea->ea[3] |= 0x80;
}
static inline uint32_t hash_mac(const struct eth_addr ea,
const uint16_t vlan, const uint32_t basis)
{
return hash_uint64_basis(eth_addr_vlan_to_uint64(ea, vlan), basis);
}
bool eth_addr_is_reserved(const struct eth_addr);
bool eth_addr_from_string(const char *, struct eth_addr *);
void compose_rarp(struct dp_packet *, const struct eth_addr);
void eth_push_vlan(struct dp_packet *, ovs_be16 tpid, ovs_be16 tci);
void eth_pop_vlan(struct dp_packet *);
const char *eth_from_hex(const char *hex, struct dp_packet **packetp);
void eth_format_masked(const struct eth_addr ea,
const struct eth_addr *mask, struct ds *s);
void set_mpls_lse(struct dp_packet *, ovs_be32 label);
void push_mpls(struct dp_packet *packet, ovs_be16 ethtype, ovs_be32 lse);
void pop_mpls(struct dp_packet *, ovs_be16 ethtype);
void set_mpls_lse_ttl(ovs_be32 *lse, uint8_t ttl);
void set_mpls_lse_tc(ovs_be32 *lse, uint8_t tc);
void set_mpls_lse_label(ovs_be32 *lse, ovs_be32 label);
void set_mpls_lse_bos(ovs_be32 *lse, uint8_t bos);
ovs_be32 set_mpls_lse_values(uint8_t ttl, uint8_t tc, uint8_t bos,
ovs_be32 label);
/* Example:
*
* struct eth_addr mac;
* [...]
* printf("The Ethernet address is "ETH_ADDR_FMT"\n", ETH_ADDR_ARGS(mac));
*
*/
#define ETH_ADDR_FMT \
"%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8
#define ETH_ADDR_ARGS(EA) ETH_ADDR_BYTES_ARGS((EA).ea)
#define ETH_ADDR_BYTES_ARGS(EAB) \
(EAB)[0], (EAB)[1], (EAB)[2], (EAB)[3], (EAB)[4], (EAB)[5]
#define ETH_ADDR_STRLEN 17
/* Example:
*
* struct eth_addr64 eui64;
* [...]
* printf("The EUI-64 address is "ETH_ADDR64_FMT"\n", ETH_ADDR64_ARGS(mac));
*
*/
#define ETH_ADDR64_FMT \
"%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8":" \
"%02"PRIx8":%02"PRIx8":%02"PRIx8":%02"PRIx8
#define ETH_ADDR64_ARGS(EA) ETH_ADDR64_BYTES_ARGS((EA).ea64)
#define ETH_ADDR64_BYTES_ARGS(EAB) \
(EAB)[0], (EAB)[1], (EAB)[2], (EAB)[3], \
(EAB)[4], (EAB)[5], (EAB)[6], (EAB)[7]
#define ETH_ADDR64_STRLEN 23
/* Example:
*
* char *string = "1 00:11:22:33:44:55 2";
* struct eth_addr mac;
* int a, b;
*
* if (ovs_scan(string, "%d"ETH_ADDR_SCAN_FMT"%d",
* &a, ETH_ADDR_SCAN_ARGS(mac), &b)) {
* ...
* }
*/
#define ETH_ADDR_SCAN_FMT "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8
#define ETH_ADDR_SCAN_ARGS(EA) \
&(EA).ea[0], &(EA).ea[1], &(EA).ea[2], &(EA).ea[3], &(EA).ea[4], &(EA).ea[5]
#define ETH_TYPE_IP 0x0800
#define ETH_TYPE_ARP 0x0806
#define ETH_TYPE_TEB 0x6558
#define ETH_TYPE_VLAN_8021Q 0x8100
#define ETH_TYPE_VLAN ETH_TYPE_VLAN_8021Q
#define ETH_TYPE_VLAN_8021AD 0x88a8
#define ETH_TYPE_IPV6 0x86dd
#define ETH_TYPE_LACP 0x8809
#define ETH_TYPE_RARP 0x8035
#define ETH_TYPE_MPLS 0x8847
#define ETH_TYPE_MPLS_MCAST 0x8848
#define ETH_TYPE_NSH 0x894f
#define ETH_TYPE_ERSPAN1 0x88be /* version 1 type II */
#define ETH_TYPE_ERSPAN2 0x22eb /* version 2 type III */
static inline bool eth_type_mpls(ovs_be16 eth_type)
{
return eth_type == htons(ETH_TYPE_MPLS) ||
eth_type == htons(ETH_TYPE_MPLS_MCAST);
}
static inline bool eth_type_vlan(ovs_be16 eth_type)
{
return eth_type == htons(ETH_TYPE_VLAN_8021Q) ||
eth_type == htons(ETH_TYPE_VLAN_8021AD);
}
/* Minimum value for an Ethernet type. Values below this are IEEE 802.2 frame
* lengths. */
#define ETH_TYPE_MIN 0x600
#define ETH_HEADER_LEN 14
#define ETH_PAYLOAD_MIN 46
#define ETH_PAYLOAD_MAX 1500
#define ETH_TOTAL_MIN (ETH_HEADER_LEN + ETH_PAYLOAD_MIN)
#define ETH_TOTAL_MAX (ETH_HEADER_LEN + ETH_PAYLOAD_MAX)
#define ETH_VLAN_TOTAL_MAX (ETH_HEADER_LEN + VLAN_HEADER_LEN + ETH_PAYLOAD_MAX)
struct eth_header {
struct eth_addr eth_dst;
struct eth_addr eth_src;
ovs_be16 eth_type;
};
BUILD_ASSERT_DECL(ETH_HEADER_LEN == sizeof(struct eth_header));
void push_eth(struct dp_packet *packet, const struct eth_addr *dst,
const struct eth_addr *src);
void pop_eth(struct dp_packet *packet);
void push_nsh(struct dp_packet *packet, const struct nsh_hdr *nsh_hdr_src);
bool pop_nsh(struct dp_packet *packet);
#define LLC_DSAP_SNAP 0xaa
#define LLC_SSAP_SNAP 0xaa
#define LLC_CNTL_SNAP 3
#define LLC_HEADER_LEN 3
struct llc_header {
uint8_t llc_dsap;
uint8_t llc_ssap;
uint8_t llc_cntl;
};
BUILD_ASSERT_DECL(LLC_HEADER_LEN == sizeof(struct llc_header));
/* LLC field values used for STP frames. */
#define STP_LLC_SSAP 0x42
#define STP_LLC_DSAP 0x42
#define STP_LLC_CNTL 0x03
#define SNAP_ORG_ETHERNET "\0\0" /* The compiler adds a null byte, so
sizeof(SNAP_ORG_ETHERNET) == 3. */
#define SNAP_HEADER_LEN 5
OVS_PACKED(
struct snap_header {
uint8_t snap_org[3];
ovs_be16 snap_type;
});
BUILD_ASSERT_DECL(SNAP_HEADER_LEN == sizeof(struct snap_header));
#define LLC_SNAP_HEADER_LEN (LLC_HEADER_LEN + SNAP_HEADER_LEN)
OVS_PACKED(
struct llc_snap_header {
struct llc_header llc;
struct snap_header snap;
});
BUILD_ASSERT_DECL(LLC_SNAP_HEADER_LEN == sizeof(struct llc_snap_header));
#define VLAN_VID_MASK 0x0fff
#define VLAN_VID_SHIFT 0
#define VLAN_PCP_MASK 0xe000
#define VLAN_PCP_SHIFT 13
#define VLAN_CFI 0x1000
#define VLAN_CFI_SHIFT 12
/* Given the vlan_tci field from an 802.1Q header, in network byte order,
* returns the VLAN ID in host byte order. */
static inline uint16_t
vlan_tci_to_vid(ovs_be16 vlan_tci)
{
return (ntohs(vlan_tci) & VLAN_VID_MASK) >> VLAN_VID_SHIFT;
}
/* Given the vlan_tci field from an 802.1Q header, in network byte order,
* returns the priority code point (PCP) in host byte order. */
static inline int
vlan_tci_to_pcp(ovs_be16 vlan_tci)
{
return (ntohs(vlan_tci) & VLAN_PCP_MASK) >> VLAN_PCP_SHIFT;
}
/* Given the vlan_tci field from an 802.1Q header, in network byte order,
* returns the Canonical Format Indicator (CFI). */
static inline int
vlan_tci_to_cfi(ovs_be16 vlan_tci)
{
return (vlan_tci & htons(VLAN_CFI)) != 0;
}
#define VLAN_HEADER_LEN 4
struct vlan_header {
ovs_be16 vlan_tci; /* Lowest 12 bits are VLAN ID. */
ovs_be16 vlan_next_type;
};
BUILD_ASSERT_DECL(VLAN_HEADER_LEN == sizeof(struct vlan_header));
#define VLAN_ETH_HEADER_LEN (ETH_HEADER_LEN + VLAN_HEADER_LEN)
struct vlan_eth_header {
struct eth_addr veth_dst;
struct eth_addr veth_src;
ovs_be16 veth_type; /* Always htons(ETH_TYPE_VLAN). */
ovs_be16 veth_tci; /* Lowest 12 bits are VLAN ID. */
ovs_be16 veth_next_type;
};
BUILD_ASSERT_DECL(VLAN_ETH_HEADER_LEN == sizeof(struct vlan_eth_header));
/* MPLS related definitions */
#define MPLS_TTL_MASK 0x000000ff
#define MPLS_TTL_SHIFT 0
#define MPLS_BOS_MASK 0x00000100
#define MPLS_BOS_SHIFT 8
#define MPLS_TC_MASK 0x00000e00
#define MPLS_TC_SHIFT 9
#define MPLS_LABEL_MASK 0xfffff000
#define MPLS_LABEL_SHIFT 12
#define MPLS_HLEN 4
struct mpls_hdr {
ovs_16aligned_be32 mpls_lse;
};
BUILD_ASSERT_DECL(MPLS_HLEN == sizeof(struct mpls_hdr));
/* Given a mpls label stack entry in network byte order
* return mpls label in host byte order */
static inline uint32_t
mpls_lse_to_label(ovs_be32 mpls_lse)
{
return (ntohl(mpls_lse) & MPLS_LABEL_MASK) >> MPLS_LABEL_SHIFT;
}
/* Given a mpls label stack entry in network byte order
* return mpls tc */
static inline uint8_t
mpls_lse_to_tc(ovs_be32 mpls_lse)
{
return (ntohl(mpls_lse) & MPLS_TC_MASK) >> MPLS_TC_SHIFT;
}
/* Given a mpls label stack entry in network byte order
* return mpls ttl */
static inline uint8_t
mpls_lse_to_ttl(ovs_be32 mpls_lse)
{
return (ntohl(mpls_lse) & MPLS_TTL_MASK) >> MPLS_TTL_SHIFT;
}
/* Set label in mpls lse. */
static inline void
flow_set_mpls_lse_label(ovs_be32 *mpls_lse, uint32_t label)
{
*mpls_lse &= ~htonl(MPLS_LABEL_MASK);
*mpls_lse |= htonl(label << MPLS_LABEL_SHIFT);
}
/* Set TC in mpls lse. */
static inline void
flow_set_mpls_lse_tc(ovs_be32 *mpls_lse, uint8_t tc)
{
*mpls_lse &= ~htonl(MPLS_TC_MASK);
*mpls_lse |= htonl((tc & 0x7) << MPLS_TC_SHIFT);
}
/* Set BOS in mpls lse. */
static inline void
flow_set_mpls_lse_bos(ovs_be32 *mpls_lse, uint8_t bos)
{
*mpls_lse &= ~htonl(MPLS_BOS_MASK);
*mpls_lse |= htonl((bos & 0x1) << MPLS_BOS_SHIFT);
}
/* Set TTL in mpls lse. */
static inline void
flow_set_mpls_lse_ttl(ovs_be32 *mpls_lse, uint8_t ttl)
{
*mpls_lse &= ~htonl(MPLS_TTL_MASK);
*mpls_lse |= htonl(ttl << MPLS_TTL_SHIFT);
}
/* Given a mpls label stack entry in network byte order
* return mpls BoS bit */
static inline uint8_t
mpls_lse_to_bos(ovs_be32 mpls_lse)
{
return (mpls_lse & htonl(MPLS_BOS_MASK)) != 0;
}
#define IP_FMT "%"PRIu32".%"PRIu32".%"PRIu32".%"PRIu32
#define IP_ARGS(ip) \
ntohl(ip) >> 24, \
(ntohl(ip) >> 16) & 0xff, \
(ntohl(ip) >> 8) & 0xff, \
ntohl(ip) & 0xff
/* Example:
*
* char *string = "1 33.44.55.66 2";
* ovs_be32 ip;
* int a, b;
*
* if (ovs_scan(string, "%d"IP_SCAN_FMT"%d", &a, IP_SCAN_ARGS(&ip), &b)) {
* ...
* }
*/
#define IP_SCAN_FMT "%"SCNu8".%"SCNu8".%"SCNu8".%"SCNu8
#define IP_SCAN_ARGS(ip) \
((void) (ovs_be32) *(ip), &((uint8_t *) ip)[0]), \
&((uint8_t *) ip)[1], \
&((uint8_t *) ip)[2], \
&((uint8_t *) ip)[3]
#define IP_PORT_SCAN_FMT "%"SCNu8".%"SCNu8".%"SCNu8".%"SCNu8":%"SCNu16
#define IP_PORT_SCAN_ARGS(ip, port) \
((void) (ovs_be32) *(ip), &((uint8_t *) ip)[0]), \
&((uint8_t *) ip)[1], \
&((uint8_t *) ip)[2], \
&((uint8_t *) ip)[3], \
((void) (ovs_be16) *(port), (uint16_t *) port)
/* Returns true if 'netmask' is a CIDR netmask, that is, if it consists of N
* high-order 1-bits and 32-N low-order 0-bits. */
static inline bool
ip_is_cidr(ovs_be32 netmask)
{
uint32_t x = ~ntohl(netmask);
return !(x & (x + 1));
}
static inline bool
ip_is_multicast(ovs_be32 ip)
{
return (ip & htonl(0xf0000000)) == htonl(0xe0000000);
}
static inline bool
ip_is_local_multicast(ovs_be32 ip)
{
return (ip & htonl(0xffffff00)) == htonl(0xe0000000);
}
int ip_count_cidr_bits(ovs_be32 netmask);
void ip_format_masked(ovs_be32 ip, ovs_be32 mask, struct ds *);
bool ip_parse(const char *s, ovs_be32 *ip);
char *ip_parse_port(const char *s, ovs_be32 *ip, ovs_be16 *port)
OVS_WARN_UNUSED_RESULT;
char *ip_parse_masked(const char *s, ovs_be32 *ip, ovs_be32 *mask)
OVS_WARN_UNUSED_RESULT;
char *ip_parse_cidr(const char *s, ovs_be32 *ip, unsigned int *plen)
OVS_WARN_UNUSED_RESULT;
char *ip_parse_masked_len(const char *s, int *n, ovs_be32 *ip, ovs_be32 *mask)
OVS_WARN_UNUSED_RESULT;
char *ip_parse_cidr_len(const char *s, int *n, ovs_be32 *ip,
unsigned int *plen)
OVS_WARN_UNUSED_RESULT;
#define IP_VER(ip_ihl_ver) ((ip_ihl_ver) >> 4)
#define IP_IHL(ip_ihl_ver) ((ip_ihl_ver) & 15)
#define IP_IHL_VER(ihl, ver) (((ver) << 4) | (ihl))
#ifndef IPPROTO_SCTP
#define IPPROTO_SCTP 132
#endif
#ifndef IPPROTO_DCCP
#define IPPROTO_DCCP 33
#endif
#ifndef IPPROTO_IGMP
#define IPPROTO_IGMP 2
#endif
#ifndef IPPROTO_UDPLITE
#define IPPROTO_UDPLITE 136
#endif
/* TOS fields. */
#define IP_ECN_NOT_ECT 0x0
#define IP_ECN_ECT_1 0x01
#define IP_ECN_ECT_0 0x02
#define IP_ECN_CE 0x03
#define IP_ECN_MASK 0x03
#define IP_DSCP_CS6 0xc0
#define IP_DSCP_MASK 0xfc
static inline int
IP_ECN_is_ce(uint8_t dsfield)
{
return (dsfield & IP_ECN_MASK) == IP_ECN_CE;
}
#define IP_VERSION 4
#define IP_DONT_FRAGMENT 0x4000 /* Don't fragment. */
#define IP_MORE_FRAGMENTS 0x2000 /* More fragments. */
#define IP_FRAG_OFF_MASK 0x1fff /* Fragment offset. */
#define IP_IS_FRAGMENT(ip_frag_off) \
((ip_frag_off) & htons(IP_MORE_FRAGMENTS | IP_FRAG_OFF_MASK))
#define IP_HEADER_LEN 20
struct ip_header {
uint8_t ip_ihl_ver;
uint8_t ip_tos;
ovs_be16 ip_tot_len;
ovs_be16 ip_id;
ovs_be16 ip_frag_off;
uint8_t ip_ttl;
uint8_t ip_proto;
ovs_be16 ip_csum;
ovs_16aligned_be32 ip_src;
ovs_16aligned_be32 ip_dst;
};
BUILD_ASSERT_DECL(IP_HEADER_LEN == sizeof(struct ip_header));
/* ICMPv4 types. */
#define ICMP4_ECHO_REPLY 0
#define ICMP4_DST_UNREACH 3
#define ICMP4_SOURCEQUENCH 4
#define ICMP4_REDIRECT 5
#define ICMP4_ECHO_REQUEST 8
#define ICMP4_TIME_EXCEEDED 11
#define ICMP4_PARAM_PROB 12
#define ICMP4_TIMESTAMP 13
#define ICMP4_TIMESTAMPREPLY 14
#define ICMP4_INFOREQUEST 15
#define ICMP4_INFOREPLY 16
#define ICMP_HEADER_LEN 8
struct icmp_header {
uint8_t icmp_type;
uint8_t icmp_code;
ovs_be16 icmp_csum;
union {
struct {
ovs_be16 id;
ovs_be16 seq;
} echo;
struct {
ovs_be16 empty;
ovs_be16 mtu;
} frag;
ovs_16aligned_be32 gateway;
} icmp_fields;
};
BUILD_ASSERT_DECL(ICMP_HEADER_LEN == sizeof(struct icmp_header));
#define IGMP_HEADER_LEN 8
struct igmp_header {
uint8_t igmp_type;
uint8_t igmp_code;
ovs_be16 igmp_csum;
ovs_16aligned_be32 group;
};
BUILD_ASSERT_DECL(IGMP_HEADER_LEN == sizeof(struct igmp_header));
#define IGMPV3_HEADER_LEN 8
struct igmpv3_header {
uint8_t type;
uint8_t rsvr1;
ovs_be16 csum;
ovs_be16 rsvr2;
ovs_be16 ngrp;
};
BUILD_ASSERT_DECL(IGMPV3_HEADER_LEN == sizeof(struct igmpv3_header));
#define IGMPV3_QUERY_HEADER_LEN 12
struct igmpv3_query_header {
uint8_t type;
uint8_t max_resp;
ovs_be16 csum;
ovs_16aligned_be32 group;
uint8_t srs_qrv;
uint8_t qqic;
ovs_be16 nsrcs;
};
BUILD_ASSERT_DECL(
IGMPV3_QUERY_HEADER_LEN == sizeof(struct igmpv3_query_header
));
#define IGMPV3_RECORD_LEN 8
struct igmpv3_record {
uint8_t type;
uint8_t aux_len;
ovs_be16 nsrcs;
ovs_16aligned_be32 maddr;
};
BUILD_ASSERT_DECL(IGMPV3_RECORD_LEN == sizeof(struct igmpv3_record));
#define IGMP_HOST_MEMBERSHIP_QUERY 0x11 /* From RFC1112 */
#define IGMP_HOST_MEMBERSHIP_REPORT 0x12 /* Ditto */
#define IGMPV2_HOST_MEMBERSHIP_REPORT 0x16 /* V2 version of 0x12 */
#define IGMP_HOST_LEAVE_MESSAGE 0x17
#define IGMPV3_HOST_MEMBERSHIP_REPORT 0x22 /* V3 version of 0x12 */
/*
* IGMPv3 and MLDv2 use the same codes.
*/
#define IGMPV3_MODE_IS_INCLUDE 1
#define IGMPV3_MODE_IS_EXCLUDE 2
#define IGMPV3_CHANGE_TO_INCLUDE_MODE 3
#define IGMPV3_CHANGE_TO_EXCLUDE_MODE 4
#define IGMPV3_ALLOW_NEW_SOURCES 5
#define IGMPV3_BLOCK_OLD_SOURCES 6
#define SCTP_HEADER_LEN 12
struct sctp_header {
ovs_be16 sctp_src;
ovs_be16 sctp_dst;
ovs_16aligned_be32 sctp_vtag;
ovs_16aligned_be32 sctp_csum;
};
BUILD_ASSERT_DECL(SCTP_HEADER_LEN == sizeof(struct sctp_header));
#define UDP_HEADER_LEN 8
struct udp_header {
ovs_be16 udp_src;
ovs_be16 udp_dst;
ovs_be16 udp_len;
ovs_be16 udp_csum;
};
BUILD_ASSERT_DECL(UDP_HEADER_LEN == sizeof(struct udp_header));
#define ESP_HEADER_LEN 8
struct esp_header {
ovs_be32 spi;
ovs_be32 seq_no;
};
BUILD_ASSERT_DECL(ESP_HEADER_LEN == sizeof(struct esp_header));
#define ESP_TRAILER_LEN 2
struct esp_trailer {
uint8_t pad_len;
uint8_t next_hdr;
};
BUILD_ASSERT_DECL(ESP_TRAILER_LEN == sizeof(struct esp_trailer));
#define TCP_FIN 0x001
#define TCP_SYN 0x002
#define TCP_RST 0x004
#define TCP_PSH 0x008
#define TCP_ACK 0x010
#define TCP_URG 0x020
#define TCP_ECE 0x040
#define TCP_CWR 0x080
#define TCP_NS 0x100
#define TCP_CTL(flags, offset) (htons((flags) | ((offset) << 12)))
#define TCP_FLAGS(tcp_ctl) (ntohs(tcp_ctl) & 0x0fff)
#define TCP_FLAGS_BE16(tcp_ctl) ((tcp_ctl) & htons(0x0fff))
#define TCP_OFFSET(tcp_ctl) (ntohs(tcp_ctl) >> 12)
#define TCP_HEADER_LEN 20
struct tcp_header {
ovs_be16 tcp_src;
ovs_be16 tcp_dst;
ovs_16aligned_be32 tcp_seq;
ovs_16aligned_be32 tcp_ack;
ovs_be16 tcp_ctl;
ovs_be16 tcp_winsz;
ovs_be16 tcp_csum;
ovs_be16 tcp_urg;
};
BUILD_ASSERT_DECL(TCP_HEADER_LEN == sizeof(struct tcp_header));
#define ICMP_L4_DATA_LEN 8
/* Connection states.
*
* Names like CS_RELATED are bit values, e.g. 1 << 2.
* Names like CS_RELATED_BIT are bit indexes, e.g. 2. */
#define CS_STATES \
CS_STATE(NEW, 0, "new") \
CS_STATE(ESTABLISHED, 1, "est") \
CS_STATE(RELATED, 2, "rel") \
CS_STATE(REPLY_DIR, 3, "rpl") \
CS_STATE(INVALID, 4, "inv") \
CS_STATE(TRACKED, 5, "trk") \
CS_STATE(SRC_NAT, 6, "snat") \
CS_STATE(DST_NAT, 7, "dnat")
enum {
#define CS_STATE(ENUM, INDEX, NAME) \
CS_##ENUM = 1 << INDEX, \
CS_##ENUM##_BIT = INDEX,
CS_STATES
#undef CS_STATE
};
/* Undefined connection state bits. */
enum {
#define CS_STATE(ENUM, INDEX, NAME) +CS_##ENUM
CS_SUPPORTED_MASK = CS_STATES
#undef CS_STATE
};
#define CS_UNSUPPORTED_MASK (~(uint32_t)CS_SUPPORTED_MASK)
#define ARP_HRD_ETHERNET 1
#define ARP_PRO_IP 0x0800
#define ARP_OP_REQUEST 1
#define ARP_OP_REPLY 2
#define ARP_OP_RARP 3
#define ARP_ETH_HEADER_LEN 28
struct arp_eth_header {
/* Generic members. */
ovs_be16 ar_hrd; /* Hardware type. */
ovs_be16 ar_pro; /* Protocol type. */
uint8_t ar_hln; /* Hardware address length. */
uint8_t ar_pln; /* Protocol address length. */
ovs_be16 ar_op; /* Opcode. */
/* Ethernet+IPv4 specific members. */
struct eth_addr ar_sha; /* Sender hardware address. */
ovs_16aligned_be32 ar_spa; /* Sender protocol address. */
struct eth_addr ar_tha; /* Target hardware address. */
ovs_16aligned_be32 ar_tpa; /* Target protocol address. */
};
BUILD_ASSERT_DECL(ARP_ETH_HEADER_LEN == sizeof(struct arp_eth_header));
#define IPV6_HEADER_LEN 40
/* Like struct in6_addr, but whereas that struct requires 32-bit alignment on
* most implementations, this one only requires 16-bit alignment. */
union ovs_16aligned_in6_addr {
ovs_be16 be16[8];
ovs_16aligned_be32 be32[4];
};
/* Like struct in6_hdr, but whereas that struct requires 32-bit alignment, this
* one only requires 16-bit alignment. */
struct ovs_16aligned_ip6_hdr {
union {
struct ovs_16aligned_ip6_hdrctl {
ovs_16aligned_be32 ip6_un1_flow;
ovs_be16 ip6_un1_plen;
uint8_t ip6_un1_nxt;
uint8_t ip6_un1_hlim;
} ip6_un1;
uint8_t ip6_un2_vfc;
} ip6_ctlun;
union ovs_16aligned_in6_addr ip6_src;
union ovs_16aligned_in6_addr ip6_dst;
};
/* Like struct in6_frag, but whereas that struct requires 32-bit alignment,
* this one only requires 16-bit alignment. */
struct ovs_16aligned_ip6_frag {
uint8_t ip6f_nxt;
uint8_t ip6f_reserved;
ovs_be16 ip6f_offlg;
ovs_16aligned_be32 ip6f_ident;
};
#define ICMP6_HEADER_LEN 4
struct icmp6_header {
uint8_t icmp6_type;
uint8_t icmp6_code;
ovs_be16 icmp6_cksum;
};
BUILD_ASSERT_DECL(ICMP6_HEADER_LEN == sizeof(struct icmp6_header));
#define ICMP6_ERROR_HEADER_LEN 8
struct icmp6_error_header {
struct icmp6_header icmp6_base;
ovs_be32 icmp6_error_ext;
};
BUILD_ASSERT_DECL(ICMP6_ERROR_HEADER_LEN == sizeof(struct icmp6_error_header));
uint32_t packet_csum_pseudoheader6(const struct ovs_16aligned_ip6_hdr *);
ovs_be16 packet_csum_upperlayer6(const struct ovs_16aligned_ip6_hdr *,
const void *, uint8_t, uint16_t);
/* Neighbor Discovery option field.
* ND options are always a multiple of 8 bytes in size. */
#define ND_LLA_OPT_LEN 8
struct ovs_nd_lla_opt {