flowmatch_example_ntpl.cpp Source File

1 /*

2  *

3  * Copyright 2023 Napatech A/S. All Rights Reserved.

4  *

5  * 1. Copying, modification, and distribution of this file, or executable

6  * versions of this file, is governed by the terms of the Napatech Software

7  * license agreement under which this file was made available. If you do not

8  * agree to the terms of the license do not install, copy, access or

9  * otherwise use this file.

10  *

11  * 2. Under the Napatech Software license agreement you are granted a

12  * limited, non-exclusive, non-assignable, copyright license to copy, modify

13  * and distribute this file in conjunction with Napatech SmartNIC's and

14  * similar hardware manufactured or supplied by Napatech A/S.

15  *

16  * 3. The full Napatech Software license agreement is included in this

17  * distribution, please see "NP-0405 Napatech Software license

18  * agreement.pdf"

19  *

20  * 4. Redistributions of source code must retain this copyright notice,

21  * list of conditions and the following disclaimer.

22  *

23  * THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTIES, EXPRESS OR

24  * IMPLIED, AND NAPATECH DISCLAIMS ALL IMPLIED WARRANTIES INCLUDING ANY

25  * IMPLIED WARRANTY OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, OR OF

26  * FITNESS FOR A PARTICULAR PURPOSE. TO THE EXTENT NOT PROHIBITED BY

27  * APPLICABLE LAW, IN NO EVENT SHALL NAPATECH BE LIABLE FOR PERSONAL INJURY,

28  * OR ANY INCIDENTAL, SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES WHATSOEVER,

29  * INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, CORRUPTION OR

30  * LOSS OF DATA, FAILURE TO TRANSMIT OR RECEIVE ANY DATA OR INFORMATION,

31  * BUSINESS INTERRUPTION OR ANY OTHER COMMERCIAL DAMAGES OR LOSSES, ARISING

32  * OUT OF OR RELATED TO YOUR USE OR INABILITY TO USE NAPATECH SOFTWARE OR

33  * SERVICES OR ANY THIRD PARTY SOFTWARE OR APPLICATIONS IN CONJUNCTION WITH

34  * THE NAPATECH SOFTWARE OR SERVICES, HOWEVER CAUSED, REGARDLESS OF THE THEORY

35  * OF LIABILITY (CONTRACT, TORT OR OTHERWISE) AND EVEN IF NAPATECH HAS BEEN

36  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SOME JURISDICTIONS DO NOT ALLOW

37  * THE EXCLUSION OR LIMITATION OF LIABILITY FOR PERSONAL INJURY, OR OF

38  * INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS LIMITATION MAY NOT APPLY TO YOU.

39  *

40  *

41 

42  */

43 

44 // Include this in order to access the Napatech API

45 #include <nt.h>

46 

47 #include <iostream>

48 

49 #include "flowmatch_example_helper.h"

50 

51 #include "flowmatch_example_ntpl.h"

52 

53 #define STR_INNER(A) #A

54 #define STR(A) STR_INNER(A)

55 

56 namespace {

57 

58 /**

59  * Wrapper for NT_NTPL. Handles errors if they occur.

60  */

61 void ntplCall(NtConfigStream_t& hCfgStream, const char* str)

62 {

63  std::cout << str << std::endl;

64 

65  NtNtplInfo_t ntplInfo;

66  int status = NT_NTPL(hCfgStream, str, &ntplInfo, NT_NTPL_PARSER_VALIDATE_NORMAL);

67  handleErrorStatus(status, "NT_NTPL() failed");

68 }

69 

70 } // Unnamed namespace

71 

72 void assignNtplFilters()

73 {

74  int status;

75  NtConfigStream_t hCfgStream;

76 

77  std::cout << "NTPL filters:" << std::endl;

78 

79  // Open a configuration stream to assign a filter to a stream ID.

80  status = NT_ConfigOpen(&hCfgStream, "Learn_example_config");

81  handleErrorStatus(status, "NT_ConfigOpen() failed");

82 

83  // Deletion of filters and macros, and clear FPGA flow tables.

84  ntplCall(hCfgStream, "Delete = All");

85 

86  // KeyType Command for IPv4 and IPv6

87  // In this example swapable field values are chosen, denoted by sw_.

88  ntplCall(hCfgStream, "KeyType[Name=kt4] = {sw_32_32, sw_16_16}");

89  ntplCall(hCfgStream, "KeyType[Name=kt6] = {sw_128_128, sw_16_16}");

90 

91  // Define keys for IPv4/IPv6 using src addr, dst addr, src port, dst port

92  // For suffix Y's for LayerXHeader[X]/Y/Y is here equivalent to the bit-field sizes chosen for the KeyType

93  ntplCall(hCfgStream, "KeyDef[Name=kd4; KeyType=kt4; IpProtocolField=Outer] = (Layer3Header[12]/32/32, Layer4Header[0]/16/16)");

94  ntplCall(hCfgStream, "keydef[Name=kd6; KeyType=kt6; IpProtocolField=Outer] = (Layer3Header[8]/128/128, Layer4Header[0]/16/16)");

95 

96  // Shorthand for the checks used in these filters.

97  ntplCall(hCfgStream, "DefineMacro(\"LearnFilterCheck\", \"Port==$1 and Layer2Protocol==EtherII and Layer3Protocol==$2 and Layer4Protocol==tcp\")");

98 

99  // Create filters for not learned flows that should be send to the application.

100  // The colormask option is used to make it easy for the application to distinguish

101  // IPv4 and IPv6. Colormask could also be used to distinguish protocols and ports etc.

102  // The offset0 option is set to the position of the source IP addr.

103  // In this example descriptor DYN4 with ColorBits set to FlowID is used, this will

104  // cause the id, which is set for each individual learned flow, to be available

105  // in the packet descriptor field color1. This feature is only available for DYN4.

106  ntplCall(hCfgStream, "Assign[StreamId=" STR(STREAM_ID_MISS) "; Descriptor=DYN4, ColorBits=FlowID, Offset0=Layer3Header[12]; ColorMask=" STR(COLOR_IPV4) "] = LearnFilterCheck(0,ipv4) and Key(kd4, KeyID=" STR(KEY_ID_IPV4) ")==MISS");

107  ntplCall(hCfgStream, "Assign[StreamId=" STR(STREAM_ID_MISS) "; Descriptor=DYN4, ColorBits=FlowID, Offset0=Layer3Header[8]; ColorMask=" STR(COLOR_IPV6) "] = LearnFilterCheck(0,ipv6) and Key(kd6, KeyID=" STR(KEY_ID_IPV6) ")==MISS");

108  ntplCall(hCfgStream, "Assign[StreamId=" STR(STREAM_ID_MISS) "; Descriptor=DYN4, ColorBits=FlowID, Offset0=Layer3Header[12]; ColorMask=" STR(COLOR_IPV4) "] = LearnFilterCheck(1,ipv4) and Key(kd4, KeyID=" STR(KEY_ID_IPV4) ", FieldAction=Swap)==MISS");

109  ntplCall(hCfgStream, "Assign[StreamId=" STR(STREAM_ID_MISS) "; Descriptor=DYN4, ColorBits=FlowID, Offset0=Layer3Header[8]; ColorMask=" STR(COLOR_IPV6) "] = LearnFilterCheck(1,ipv6) and Key(kd6, KeyID=" STR(KEY_ID_IPV6) ", FieldAction=Swap)==MISS");

110 

111  // Create filters for unhandled packages, which will simply be counted by the application.

112  ntplCall(hCfgStream, "Assign[StreamId=" STR(STREAM_ID_UNHA) "] = LearnFilterCheck(0,ipv4) and Key(kd4, KeyID=" STR(KEY_ID_IPV4) ")==UNHANDLED");

113  ntplCall(hCfgStream, "Assign[StreamId=" STR(STREAM_ID_UNHA) "] = LearnFilterCheck(0,ipv6) and Key(kd6, KeyID=" STR(KEY_ID_IPV6) ")==UNHANDLED");

114  ntplCall(hCfgStream, "Assign[StreamId=" STR(STREAM_ID_UNHA) "] = LearnFilterCheck(1,ipv4) and Key(kd4, KeyID=" STR(KEY_ID_IPV4) ", FieldAction=Swap)==UNHANDLED");

115  ntplCall(hCfgStream, "Assign[StreamId=" STR(STREAM_ID_UNHA) "] = LearnFilterCheck(1,ipv6) and Key(kd6, KeyID=" STR(KEY_ID_IPV6) ", FieldAction=Swap)==UNHANDLED");

116 

117  // Create filters for learned flows. The packages will not be forwarded

118  // to the application, but will be tracked according to the option "CounterSet".

119  // When set, the "KeyId" option signals that the Flow Matcher rather than

120  // Key Matcher should be used for the test.

121  // Note that the CounterSet option given for the final Assign commands for

122  // each of the 4 filters, will overwrite previous CounterSet options.

123  ntplCall(hCfgStream, "Assign[StreamId=Drop] = LearnFilterCheck(0,ipv4) and Key(kd4, KeyID=" STR(KEY_ID_IPV4) ", CounterSet=CSA)==" STR(KEY_SET_ID));

124  ntplCall(hCfgStream, "Assign[StreamId=Drop] = LearnFilterCheck(0,ipv6) and Key(kd6, KeyID=" STR(KEY_ID_IPV6) ", CounterSet=CSA)==" STR(KEY_SET_ID));

125  ntplCall(hCfgStream, "Assign[StreamId=Drop] = LearnFilterCheck(1,ipv4) and Key(kd4, KeyID=" STR(KEY_ID_IPV4) ", CounterSet=CSB, FieldAction=Swap)==" STR(KEY_SET_ID));

126  ntplCall(hCfgStream, "Assign[StreamId=Drop] = LearnFilterCheck(1,ipv6) and Key(kd6, KeyID=" STR(KEY_ID_IPV6) ", CounterSet=CSB, FieldAction=Swap)==" STR(KEY_SET_ID));

127 

128  std::cout << std::endl;

129 

130  // Close configuration stream

131  status = NT_ConfigClose(hCfgStream);

132  handleErrorStatus(status, "NT_ConfigClose() failed");

133 }