pktdescr_dyn2.h Source 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_DYN2 variable packet descriptor.\n

35  */

36 

37 #ifndef __PKT_DESCR_DYN2_H__

38 #define __PKT_DESCR_DYN2_H__

39 

40 /** @addtogroup PacketDescriptorDyn2

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. This descriptor

45  * offers a 38-bit color field, which is useful when identifying billions of flows or

46  * alternatively holding the hash value.<br/>

47  * Note: The wireLength field has been sacrificed so in case of slicing the

48  * original packet length is unknown.

49  */

50 

51 // Ensure that the following is packed.

52 #pragma pack(push, 1)

53 

54 /**

55  * @brief NT Variable descriptor 2

56  */

57 typedef struct NtDyn2Descr_s {

58  uint64_t capLength:14; /**< The length of the packet incl. descriptor. */ /* 0*/

59  uint64_t offset0:10; /**< Programmable offset into the packet. Default is outer L3. */ /* 14*/

60  uint64_t offset1:10; /**< Programmable offset into the packet. Default is outer L4. */ /* 24*/

61  uint64_t ipProtocol:8; /**< Select-able IP protocol. Default is outer IP Protocol field. */ /* 34*/

62  uint64_t rxPort:6; /**< The port that received the frame. */ /* 42*/

63  uint64_t descrFormat:8; /**< The descriptor type. */ /* 48*/

64  uint64_t descrLength:6; /**< The length of the descriptor in bytes. */ /* 56*/

65  uint64_t tsColor:1; /**< Timestamp color. Reserved for future use. */ /* 62*/

66  uint64_t ntDynDescr:1; /**< Set to 1 to identify this descriptor as a dynamic descriptor. */ /* 63*/

67  uint64_t timestamp; /**< The time of arrival of the packet. */ /* 64*/

68  uint64_t offset2:10; /**< Programmable offset into the packet. Default is outer L4 payload. */ /*128*/

69  uint64_t color:38; /**< 32 bit hash and 6 bit traditional color. */ /*138*/

70 } NtDyn2Descr_t; // descrFormat = 2, descrLength = 22 /*176 bits*/

71 

72 // Disable 1-byte packing

73 #pragma pack(pop)

74 

75 #ifndef DOXYGEN_INTERNAL_ONLY

76 

77 

78 #define _NT_NET_GET_PKT_DESCR_PTR_DYN2(_hNetBuf_) ((NtDyn2Descr_t*)(_hNetBuf_)->hHdr)

79 

80 

81 #ifdef DEBUG

82 //Guards against misconfigurations

83 #ifdef _MSC_VER

84 static void __nt_dyn2_check__(void);

85 #else

86 static void __nt_dyn2_check__(void) __attribute__ ((unused));

87 #endif

88 static void __nt_dyn2_check__(void) {

89  //Compile-time check to avoid sizeof(NtDyn2Descr_t) != 22

90 #ifdef WIN32

91  // Windows will always allocate 3 * 64 bit = 24 bytes

92  switch (0) { case 0: case sizeof(NtDyn2Descr_t) == 24:; }

93 #else

94  switch (0) { case 0: case sizeof (NtDyn2Descr_t) == 22: ; }

95 #endif

96 }

97 #endif // DEBUG

98 

99 #endif // DOXYGEN_INTERNAL_ONLY

100 

101 /** @} */

102 

103 #endif // __PKT_DESCR_DYN2_H__