pktdescr_dyn1.h Source File

Reference Documentation

Platform
Intel® PAC
Napatech SmartNIC
Content Type
Reference Information
Capture Software Version
Link™ Capture Software 12.10
Napatech Software Suite: include/ntapi/pktdescr_dyn1.h Source File
pktdescr_dyn1.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (C) 2023 Napatech A/S.
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  * * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Napatech A/S nor the
14  * names of its contributors may be used to endorse or promote products
15  * derived from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL NAPATECH A/S BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  *
29 
30  */
31 
32 /**
33  * @file
34  * This source file contains the NT_DYN1 variable packet descriptor.\n
35  */
36 
37 #ifndef __PKT_DESCR_DYN1_H__
38 #define __PKT_DESCR_DYN1_H__
39 
40 /** @addtogroup PacketDescriptorDyn1
41  * @{
42  *
43  * This descriptor offers 3 dynamic offsets, IP protocol field and a 6-bit color field.
44  * The packet descriptor is suited for applications doing NetFlow and IDS. <br/>
45  * Note: The wireLength field has been sacrificed so in case of slicing the
46  * original packet length is unknown.
47  */
48 
49 // Ensure that the following is packed.
50 #pragma pack(push, 1)
51 
52 /**
53  * @brief NT Variable descriptor 1
54  */
55 typedef struct NtDyn1Descr_s {
56  uint64_t capLength:14; /**< The length of the packet incl. descriptor. */ /* 0*/
57  uint64_t offset0:10; /**< Programmable offset into the packet. Default is outer L3. */ /* 14*/
58  uint64_t offset1:10; /**< Programmable offset into the packet. Default is outer L4. */ /* 24*/
59  uint64_t ipProtocol:8; /**< Select-able IP protocol. Default is outer IP Protocol field. */ /* 34*/
60  uint64_t rxPort:6; /**< The port that received the frame. */ /* 42*/
61  uint64_t descrFormat:8; /**< The descriptor type. */ /* 48*/
62  uint64_t descrLength:6; /**< The length of the descriptor in bytes. */ /* 56*/
63  uint64_t tsColor:1; /**< Timestamp color. Reserved for future use. */ /* 62*/
64  uint64_t ntDynDescr:1; /**< Set to 1 to identify this descriptor as a dynamic descriptor. */ /* 63*/
65  uint64_t timestamp; /**< The time of arrival of the packet. */ /* 64*/
66  uint16_t offset2:10; /**< Programmable offset into the packet. Default is outer L4 payload. */ /*128*/
67  uint16_t color:6; /**< Programmable packet color. */ /*138*/
68 } NtDyn1Descr_t; // descrFormat = 1, descrLength = 18 /*144 bits*/
69 
70 // Disable 1-byte packing
71 #pragma pack(pop)
72 
73 #ifndef DOXYGEN_INTERNAL_ONLY
74 
75 
76 #define _NT_NET_GET_PKT_DESCR_PTR_DYN1(_hNetBuf_) ((NtDyn1Descr_t*)(_hNetBuf_)->hHdr)
77 
78 
79 #ifdef DEBUG
80 //Guards against misconfigurations
81 #ifdef _MSC_VER
82 static void __nt_dyn1_check__(void);
83 #else
84 static void __nt_dyn1_check__(void) __attribute__ ((unused));
85 #endif
86 static void __nt_dyn1_check__(void) {
87  //Compile-time check to avoid sizeof(NtDyn1Descr_t) != 18
88  switch (0) { case 0: case sizeof (NtDyn1Descr_t) == 18: ; }
89 }
90 #endif // DEBUG
91 
92 #endif // DOXYGEN_INTERNAL_ONLY
93 
94 /** @} */
95 
96 #endif // __PKT_DESCR_DYN1_H__