Statistics Stream

Reference Documentation

product_line_custom
Intel® PAC
Napatech SmartNIC
category
Reference Information
Napatech Software Suite: Statistics Stream

Detailed Description

The statistics stream is used to access statistics from the system. The statistics stream is read only.

Statistical information is retrieved using the NT_STATISTICS_READ_CMD_QUERY_V3 command in a call to NT_StatRead on an open statistics stream. This command will fill out the supplied NtStatistics_t structure with port and color based statistics for all adapters in the system. The NtPortStatisticsValid_v1_s structure can be used to check which returned part of the NtPortStatistics_v1_s structure is valid. This is useful since not all adapters support all types of statistical information.

Note
Be aware that statistics from multiple adapters are only synchronized if the time is synchronized.

For an example on how to use the statistics stream see stat/stat_example.c.

Color Statistics

The color statistics for each color are found by counting the number of packets getting that specific color.
The colors are specified in some assign commands using either the 'Color' or 'ColorMask' options. By default all packets will get color 0. It is totally up to the application what meaning that should be put into a given color. The color statistics work probably best with the prioritized 'Color' option where the packet gets its color from one unique source. If you use the 'ColorMask' option, you can easily have a situation where one packet increments more than one color counter.

Color counters are never reset. It is the responsibility of the application to handle this.

It can be achieved by remembering the counter values for a given color when it was first configured and then subsequently only showing the delta compared to this initial value. Another option is to set the clear flag in NtStatisticsQuery_v2_s::clear on the first call to NT_StatRead. This will make the subsequent calls to NT_StatRead return only the delta compared to the first call.

Be aware that setting this clear flag will clear all statistics counters. If this is not desirable the application will have to handle it by itself.

Note
The color statistics only supports counters for colors 0-63 which could give rise to confusion as you can use 32 bits in the 'ColorMask' option. Only the lower 6 bits in the color field are considered when updating the color counters.
Note
Color statistics are only updated by packets that are assigned to a stream (including StreamId=drop). Packets that are not matched by any NTPL filter, or are matched by a filter that does not assign a StreamId (or inherit a StreamId from a previous filter), will not contribute to color statistics.
Note
The statistic stream is not thread-safe. If the same stream handle is to be used by multiple threads, it must be mutex protected in the application.

Functions

int NT_StatOpen (NtStatStream_t *hStatStream, const char *name)
 Opens a statistics stream. More...
 
int NT_StatRead (NtStatStream_t hStatStream, NtStatistics_t *stat)
 Reads statistics. More...
 
int NT_StatClose (NtStatStream_t hStatStream)
 Closes a statistics stream. More...
 

Data Structures

struct  NtRMON1Counters_s
 
struct  NtExtendedRMONCounters_v1_s
 
struct  NtCheckSumCounters_s
 
struct  NtDecodeCounters_v1_s
 
struct  NtExtendedDropCounters_v1_s
 
struct  NtColorStatistics_s
 
struct  NtStatGroupColor_s
 
struct  NtStatGroupAdapter_s
 
struct  NtIpFragTableCounters_s
 
struct  NtPortStatistics_v2_s
 
struct  NtPortStatistics_v2_s::NtPortStatisticsValid_v2_s
 
struct  NtStatGroupport_v2_s
 
struct  NtStatGroupStream_s
 
struct  NtStatisticsQuery_v3_s
 
struct  NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s::NtStatisticsQueryPortResult_v3_s
 
struct  NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s::NtStatisticsQueryAdapterResult_v3_s
 
struct  NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s
 
struct  NtStatisticsUsageData_v0_s
 
struct  NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatOnboardBufferingUsage_s
 
struct  NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s::NtStatUsageRx_s
 
struct  NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s::NtStatUsageDrop_s
 
struct  NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s
 
struct  NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s
 
struct  NtStatisticsUsageData_v0_s::NtStatUsageData_s
 
struct  NtStatisticsFlowData_v0_s
 
struct  NtStatisticsFlowData_v1_s
 
struct  NtStatistics_s
 
union  NtStatistics_s::NtStatistics_u
 

Typedefs

typedef struct NtStatistics_s NtStatistics_t
 
typedef struct NtStatStream_s * NtStatStream_t
 

Enumerations

enum  NtStatisticsCmd_e {
  NT_STATISTICS_READ_CMD_UNKNOWN =0, NT_STATISTICS_READ_CMD_COMPAT_0, NT_STATISTICS_READ_CMD_COMPAT_1, NT_STATISTICS_READ_CMD_COMPAT_2,
  NT_STATISTICS_READ_CMD_QUERY_V3, NT_STATISTICS_READ_CMD_USAGE_DATA_V0, NT_STATISTICS_READ_CMD_FLOW_V0, NT_STATISTICS_READ_CMD_FLOW_V1
}
 

Data Structure Documentation

struct NtRMON1Counters_s

RMON1 counters as defined in RFC 2819

Definition at line 130 of file stream_statistics.h.

Data Fields

uint64_t dropEvents
 Number of events where packet(s) are dropped by the MAC because they are too small or the MAC has bandwidth issues. More...
 
uint64_t octets
 Number of octets received by the port (good and bad) More...
 
uint64_t pkts
 Number of packets received by the port (good and bad) More...
 
uint64_t broadcastPkts
 Number of broadcast packets including MAC control packets. More...
 
uint64_t multicastPkts
 Number of multicast packets including MAC pause and MAC control packets. More...
 
uint64_t crcAlignErrors
 Number of packets with CRC/Align errors. More...
 
uint64_t undersizePkts
 Number of packets < 64 octets.
Note: When packets with a size in the range [17..63] are transmitted on the following 1G adapters: NT4E2-4-PTP, NT4E2-4T-BP, NT4E and NT4E-STD using the segment interface, the packets will silently be padded to a size of 64 bytes, which is the size reported by NtLinkCapabilities_s::minTxPktSize. For this reason they will be registered as 64 octet packets and not as an undersize packets. More...
 
uint64_t oversizePkts
 Number of packets > 1518 octets (and for NT adapters, packets > MAX and packets < 10000) If packets count here they do not count in the packet and octet counters.
Note: This counter doesn't count in the TX direction for the following products: NT4E CAPTURE, NT4E-STD CAPTURE, NT20E CAPTURE. More...
 
uint64_t fragments
 Number of packets < 64 octets with errors. More...
 
uint64_t jabbers
 Number of packets > MAX with errors - if packets count here they do not count in the packets and octets counters. More...
 
uint64_t collisions
 Number of collisions detected. More...
 
uint64_t pkts64Octets
 Number of packets = 64 octets. More...
 
uint64_t pkts65to127Octets
 Number of packets in the range 65 to 127 octets. More...
 
uint64_t pkts128to255Octets
 Number of packets in the range 128 to 255 octets. More...
 
uint64_t pkts256to511Octets
 Number of packets in the range 256 to 511 octets. More...
 
uint64_t pkts512to1023Octets
 Number of packets in the range 512 to 1023 octets. More...
 
uint64_t pkts1024to1518Octets
 Number of packets in the range 1024 to 1518 octets. More...
 

Field Documentation

uint64_t NtRMON1Counters_s::dropEvents

Number of events where packet(s) are dropped by the MAC because they are too small or the MAC has bandwidth issues.

Definition at line 131 of file stream_statistics.h.

uint64_t NtRMON1Counters_s::octets

Number of octets received by the port (good and bad)

Examples:
stat/stat_example.c.

Definition at line 132 of file stream_statistics.h.

Referenced by main().

uint64_t NtRMON1Counters_s::pkts

Number of packets received by the port (good and bad)

Examples:
net/transmit_multifunction/transmit_multifunction_example.c, and stat/stat_example.c.

Definition at line 133 of file stream_statistics.h.

Referenced by main().

uint64_t NtRMON1Counters_s::broadcastPkts

Number of broadcast packets including MAC control packets.

Definition at line 134 of file stream_statistics.h.

uint64_t NtRMON1Counters_s::multicastPkts

Number of multicast packets including MAC pause and MAC control packets.

Definition at line 135 of file stream_statistics.h.

uint64_t NtRMON1Counters_s::crcAlignErrors

Number of packets with CRC/Align errors.

Definition at line 136 of file stream_statistics.h.

uint64_t NtRMON1Counters_s::undersizePkts

Number of packets < 64 octets.
Note: When packets with a size in the range [17..63] are transmitted on the following 1G adapters: NT4E2-4-PTP, NT4E2-4T-BP, NT4E and NT4E-STD using the segment interface, the packets will silently be padded to a size of 64 bytes, which is the size reported by NtLinkCapabilities_s::minTxPktSize. For this reason they will be registered as 64 octet packets and not as an undersize packets.

Definition at line 137 of file stream_statistics.h.

uint64_t NtRMON1Counters_s::oversizePkts

Number of packets > 1518 octets (and for NT adapters, packets > MAX and packets < 10000) If packets count here they do not count in the packet and octet counters.
Note: This counter doesn't count in the TX direction for the following products: NT4E CAPTURE, NT4E-STD CAPTURE, NT20E CAPTURE.

Definition at line 138 of file stream_statistics.h.

uint64_t NtRMON1Counters_s::fragments

Number of packets < 64 octets with errors.

Definition at line 139 of file stream_statistics.h.

uint64_t NtRMON1Counters_s::jabbers

Number of packets > MAX with errors - if packets count here they do not count in the packets and octets counters.

Definition at line 140 of file stream_statistics.h.

uint64_t NtRMON1Counters_s::collisions

Number of collisions detected.

Definition at line 141 of file stream_statistics.h.

uint64_t NtRMON1Counters_s::pkts64Octets

Number of packets = 64 octets.

Definition at line 142 of file stream_statistics.h.

uint64_t NtRMON1Counters_s::pkts65to127Octets

Number of packets in the range 65 to 127 octets.

Definition at line 143 of file stream_statistics.h.

uint64_t NtRMON1Counters_s::pkts128to255Octets

Number of packets in the range 128 to 255 octets.

Definition at line 144 of file stream_statistics.h.

uint64_t NtRMON1Counters_s::pkts256to511Octets

Number of packets in the range 256 to 511 octets.

Definition at line 145 of file stream_statistics.h.

uint64_t NtRMON1Counters_s::pkts512to1023Octets

Number of packets in the range 512 to 1023 octets.

Definition at line 146 of file stream_statistics.h.

uint64_t NtRMON1Counters_s::pkts1024to1518Octets

Number of packets in the range 1024 to 1518 octets.

Definition at line 147 of file stream_statistics.h.

struct NtExtendedRMONCounters_v1_s

Extended RMON - these counters are used to categorize packets not handled by RMON1

Definition at line 153 of file stream_statistics.h.

Data Fields

uint64_t pkts1519to2047Octets
 Number of packets in the range 1519 to 2047 octets. More...
 
uint64_t pkts2048to4095Octets
 Number of packets in the range 2048 to 4095 octets. More...
 
uint64_t pkts4096to8191Octets
 Number of packets in the range 4096 to 8191 octets. More...
 
uint64_t pkts8192toMaxOctets
 Number of packets in the range 8192 to MAX octets. More...
 
uint64_t pktsHardSlice
 Number of packets in the range 10001 to 16383 octets. More...
 
uint64_t pktsHardSliceJabber
 Number of bad packets in the range 10001 to 16383 octets and packets > 16383 octets. More...
 
uint64_t unicastPkts
 Number of Unicast packets including MAC control packets. More...
 
uint64_t pktsCrc
 Number of packets with CRC errors. More...
 
uint64_t pktsAlignment
 Number of packets with alignment errors. More...
 
uint64_t pktsCodeViolation
 Number of packets with code violation errors. More...
 
uint64_t pktsRetransmit
 

Field Documentation

uint64_t NtExtendedRMONCounters_v1_s::pkts1519to2047Octets

Number of packets in the range 1519 to 2047 octets.

Definition at line 154 of file stream_statistics.h.

uint64_t NtExtendedRMONCounters_v1_s::pkts2048to4095Octets

Number of packets in the range 2048 to 4095 octets.

Definition at line 155 of file stream_statistics.h.

uint64_t NtExtendedRMONCounters_v1_s::pkts4096to8191Octets

Number of packets in the range 4096 to 8191 octets.

Definition at line 156 of file stream_statistics.h.

uint64_t NtExtendedRMONCounters_v1_s::pkts8192toMaxOctets

Number of packets in the range 8192 to MAX octets.

Definition at line 157 of file stream_statistics.h.

uint64_t NtExtendedRMONCounters_v1_s::pktsHardSlice

Number of packets in the range 10001 to 16383 octets.

Definition at line 158 of file stream_statistics.h.

uint64_t NtExtendedRMONCounters_v1_s::pktsHardSliceJabber

Number of bad packets in the range 10001 to 16383 octets and packets > 16383 octets.

Definition at line 159 of file stream_statistics.h.

uint64_t NtExtendedRMONCounters_v1_s::unicastPkts

Number of Unicast packets including MAC control packets.

Definition at line 160 of file stream_statistics.h.

uint64_t NtExtendedRMONCounters_v1_s::pktsCrc

Number of packets with CRC errors.

Definition at line 162 of file stream_statistics.h.

uint64_t NtExtendedRMONCounters_v1_s::pktsAlignment

Number of packets with alignment errors.

Definition at line 163 of file stream_statistics.h.

uint64_t NtExtendedRMONCounters_v1_s::pktsCodeViolation

Number of packets with code violation errors.

Definition at line 164 of file stream_statistics.h.

uint64_t NtExtendedRMONCounters_v1_s::pktsRetransmit

Definition at line 165 of file stream_statistics.h.

struct NtCheckSumCounters_s

Checksum counters - these counters count packets with IP/TCP/UDP errors

Definition at line 171 of file stream_statistics.h.

Data Fields

uint64_t pktsIpChkSumError
 Number of packets with IP checksum errors. More...
 
uint64_t pktsUdpChkSumError
 Number of packets with UDP checksum errors. More...
 
uint64_t pktsTcpChkSumError
 Number of packets with TCP checksum errors. More...
 

Field Documentation

uint64_t NtCheckSumCounters_s::pktsIpChkSumError

Number of packets with IP checksum errors.

Definition at line 172 of file stream_statistics.h.

uint64_t NtCheckSumCounters_s::pktsUdpChkSumError

Number of packets with UDP checksum errors.

Definition at line 173 of file stream_statistics.h.

uint64_t NtCheckSumCounters_s::pktsTcpChkSumError

Number of packets with TCP checksum errors.

Definition at line 174 of file stream_statistics.h.

struct NtDecodeCounters_v1_s

Packet decoding counters - these counters are available on adapters with a packet decoder

Definition at line 180 of file stream_statistics.h.

Data Fields

uint64_t pktsGiantUndersize
 Number of packets > 63 bytes including tags and =< 63 excluding tags. More...
 
uint64_t pktsBabyGiant
 Number of packets > MAX including tags and =< MAX excluding tags. More...
 
uint64_t pktsNotIslVlanMpls
 Number of packets without ISL, VLAN and MPLS. More...
 
uint64_t pktsIsl
 Number of packets with ISL. More...
 
uint64_t pktsVlan
 Number of packets with VLAN. More...
 
uint64_t pktsIslVlan
 Number of packets with ISL and VLAN. More...
 
uint64_t pktsMpls
 Number of packets with MPLS. More...
 
uint64_t pktsIslMpls
 Number of packets with ISL and MPLS. More...
 
uint64_t pktsVlanMpls
 Number of packets with VLAN and MPLS. More...
 
uint64_t pktsIslVlanMpls
 Number of packets with ISL, VLAN and MPLS. More...
 
uint64_t pktsDuplicate
 Number of packets marked as duplicates. More...
 

Field Documentation

uint64_t NtDecodeCounters_v1_s::pktsGiantUndersize

Number of packets > 63 bytes including tags and =< 63 excluding tags.

Definition at line 181 of file stream_statistics.h.

uint64_t NtDecodeCounters_v1_s::pktsBabyGiant

Number of packets > MAX including tags and =< MAX excluding tags.

Definition at line 182 of file stream_statistics.h.

uint64_t NtDecodeCounters_v1_s::pktsNotIslVlanMpls

Number of packets without ISL, VLAN and MPLS.

Definition at line 183 of file stream_statistics.h.

uint64_t NtDecodeCounters_v1_s::pktsIsl

Number of packets with ISL.

Definition at line 184 of file stream_statistics.h.

uint64_t NtDecodeCounters_v1_s::pktsVlan

Number of packets with VLAN.

Definition at line 185 of file stream_statistics.h.

uint64_t NtDecodeCounters_v1_s::pktsIslVlan

Number of packets with ISL and VLAN.

Definition at line 186 of file stream_statistics.h.

uint64_t NtDecodeCounters_v1_s::pktsMpls

Number of packets with MPLS.

Definition at line 187 of file stream_statistics.h.

uint64_t NtDecodeCounters_v1_s::pktsIslMpls

Number of packets with ISL and MPLS.

Definition at line 188 of file stream_statistics.h.

uint64_t NtDecodeCounters_v1_s::pktsVlanMpls

Number of packets with VLAN and MPLS.

Definition at line 189 of file stream_statistics.h.

uint64_t NtDecodeCounters_v1_s::pktsIslVlanMpls

Number of packets with ISL, VLAN and MPLS.

Definition at line 190 of file stream_statistics.h.

uint64_t NtDecodeCounters_v1_s::pktsDuplicate

Number of packets marked as duplicates.

Definition at line 191 of file stream_statistics.h.

struct NtExtendedDropCounters_v1_s

Extended drop counters - these counters will count the packets dropped for various reasons

Definition at line 198 of file stream_statistics.h.

Data Fields

uint64_t pktsMacBandwidth
 Number of packets dropped by the MAC because of bandwidth issues and number of packets < 17 octets. This counter is also available in NtRMON1Counters_s::dropEvents. More...
 
uint64_t pktsOverflow
 Number of packets dropped because the port buffer is full. More...
 
uint64_t octetsOverflow
 Number of octets dropped because the port buffer is full. More...
 
uint64_t pktsDedup
 Number of packets dropped because of deduplication. More...
 
uint64_t octetsDedup
 Number of octets dropped because of deduplication. More...
 
uint64_t pktsNoFilter
 Number of packets dropped because they do not match a filter. More...
 
uint64_t octetsNoFilter
 Number of octets dropped because they do not match a filter. More...
 
uint64_t pktsFilterDrop
 Number of packets dropped because they are explicitly dropped. More...
 
uint64_t octetsFilterDrop
 Number of octets dropped because they are explicitly dropped. More...
 

Field Documentation

uint64_t NtExtendedDropCounters_v1_s::pktsMacBandwidth

Number of packets dropped by the MAC because of bandwidth issues and number of packets < 17 octets. This counter is also available in NtRMON1Counters_s::dropEvents.

Definition at line 199 of file stream_statistics.h.

uint64_t NtExtendedDropCounters_v1_s::pktsOverflow

Number of packets dropped because the port buffer is full.

Definition at line 201 of file stream_statistics.h.

uint64_t NtExtendedDropCounters_v1_s::octetsOverflow

Number of octets dropped because the port buffer is full.

Definition at line 202 of file stream_statistics.h.

uint64_t NtExtendedDropCounters_v1_s::pktsDedup

Number of packets dropped because of deduplication.

Definition at line 204 of file stream_statistics.h.

uint64_t NtExtendedDropCounters_v1_s::octetsDedup

Number of octets dropped because of deduplication.

Definition at line 205 of file stream_statistics.h.

uint64_t NtExtendedDropCounters_v1_s::pktsNoFilter

Number of packets dropped because they do not match a filter.

Definition at line 207 of file stream_statistics.h.

uint64_t NtExtendedDropCounters_v1_s::octetsNoFilter

Number of octets dropped because they do not match a filter.

Definition at line 208 of file stream_statistics.h.

uint64_t NtExtendedDropCounters_v1_s::pktsFilterDrop

Number of packets dropped because they are explicitly dropped.

Definition at line 210 of file stream_statistics.h.

uint64_t NtExtendedDropCounters_v1_s::octetsFilterDrop

Number of octets dropped because they are explicitly dropped.

Definition at line 211 of file stream_statistics.h.

struct NtColorStatistics_s

Color counters

Definition at line 218 of file stream_statistics.h.

Data Fields

uint64_t pkts
 Number of packets. More...
 
uint64_t octets
 Number of octets. More...
 

Field Documentation

uint64_t NtColorStatistics_s::pkts

Number of packets.

Examples:
net/analysis/analysis_example.c, net/capture/capture_example.c, net/streamidstatistics/streamidstatistics_example.c, and net/vlandemo/vlandemo_example.c.

Definition at line 219 of file stream_statistics.h.

Referenced by main().

uint64_t NtColorStatistics_s::octets

Number of octets.

Examples:
net/analysis/analysis_example.c, net/capture/capture_example.c, net/streamidstatistics/streamidstatistics_example.c, and net/vlandemo/vlandemo_example.c.

Definition at line 220 of file stream_statistics.h.

Referenced by main().

struct NtStatGroupColor_s

Statistics info group for color statistics

Definition at line 228 of file stream_statistics.h.

Data Fields

int supported
 Set if color statistics is supported. More...
 
struct NtColorStatistics_s aColor [64]
 The color statistics. More...
 
uint64_t ts
 Color counter sample time stamp. The format of the timestamp is specified by tsType. More...
 
enum NtTimestampType_e tsType
 Time stamp type - For a description of the time stamp type see "DN-0384 3GD Time-Stamping and Time Synchronization User Guide". More...
 

Field Documentation

int NtStatGroupColor_s::supported

Set if color statistics is supported.

Definition at line 229 of file stream_statistics.h.

struct NtColorStatistics_s NtStatGroupColor_s::aColor[64]

The color statistics.

Definition at line 232 of file stream_statistics.h.

uint64_t NtStatGroupColor_s::ts

Color counter sample time stamp. The format of the timestamp is specified by tsType.

Definition at line 235 of file stream_statistics.h.

enum NtTimestampType_e NtStatGroupColor_s::tsType

Time stamp type - For a description of the time stamp type see "DN-0384 3GD Time-Stamping and Time Synchronization User Guide".

Definition at line 236 of file stream_statistics.h.

struct NtStatGroupAdapter_s

Statistics info group for adapter statistics

Definition at line 242 of file stream_statistics.h.

Data Fields

struct NtStatGroupColor_s color
 

Field Documentation

struct NtStatGroupColor_s NtStatGroupAdapter_s::color

Definition at line 243 of file stream_statistics.h.

struct NtIpFragTableCounters_s

Statistics info for IPF (IP Fragment matching table)

Definition at line 249 of file stream_statistics.h.

Data Fields

uint64_t ipFragTableFirstHit
 Counts all IPv4/IPv6 first-fragment hits in FPGA IPF-table. More...
 
uint64_t ipFragTableFirstNoHit
 Counts all IPv4/IPv6 first-fragment misses in FPGA IPF-table (first fragment not received) More...
 
uint64_t ipFragTableMidHit
 Counts all IPv4/IPv6 mid-fragment hits in FPGA IPF-table. More...
 
uint64_t ipFragTableMidNoHit
 Counts all IPv4/IPv6 mid-fragment misses in FPGA IPF-table (middle fragment not received) More...
 
uint64_t ipFragTableLastHit
 Counts all IPv4/IPv6 last-fragment hits in FPGA IPF-table. More...
 
uint64_t ipFragTableLastNoHit
 Counts all IPv4/IPv6 last-fragment misses in FPGA IPF-table (last fragment not received - e.g. before timeout) More...
 

Field Documentation

uint64_t NtIpFragTableCounters_s::ipFragTableFirstHit

Counts all IPv4/IPv6 first-fragment hits in FPGA IPF-table.

Definition at line 250 of file stream_statistics.h.

uint64_t NtIpFragTableCounters_s::ipFragTableFirstNoHit

Counts all IPv4/IPv6 first-fragment misses in FPGA IPF-table (first fragment not received)

Definition at line 251 of file stream_statistics.h.

uint64_t NtIpFragTableCounters_s::ipFragTableMidHit

Counts all IPv4/IPv6 mid-fragment hits in FPGA IPF-table.

Definition at line 252 of file stream_statistics.h.

uint64_t NtIpFragTableCounters_s::ipFragTableMidNoHit

Counts all IPv4/IPv6 mid-fragment misses in FPGA IPF-table (middle fragment not received)

Definition at line 253 of file stream_statistics.h.

uint64_t NtIpFragTableCounters_s::ipFragTableLastHit

Counts all IPv4/IPv6 last-fragment hits in FPGA IPF-table.

Definition at line 254 of file stream_statistics.h.

uint64_t NtIpFragTableCounters_s::ipFragTableLastNoHit

Counts all IPv4/IPv6 last-fragment misses in FPGA IPF-table (last fragment not received - e.g. before timeout)

Definition at line 255 of file stream_statistics.h.

struct NtPortStatistics_v2_s

Statistics for each port

Definition at line 261 of file stream_statistics.h.

Data Fields

struct NtPortStatistics_v2_s::NtPortStatisticsValid_v2_s valid
 
struct NtRMON1Counters_s RMON1
 RMON1 counters. More...
 
struct NtExtendedRMONCounters_v1_s extRMON
 Extended RMON counters. More...
 
struct NtCheckSumCounters_s chksum
 Checksum error counters. More...
 
struct NtDecodeCounters_v1_s decode
 Packets decoded by onboard packet decoder. More...
 
struct NtExtendedDropCounters_v1_s extDrop
 Extended drop counters. More...
 
struct NtIpFragTableCounters_s ipf
 IP fragment table counters (when using IPFMode) More...
 

Field Documentation

struct NtRMON1Counters_s NtPortStatistics_v2_s::RMON1

RMON1 counters.

Examples:
net/transmit_multifunction/transmit_multifunction_example.c, and stat/stat_example.c.

Definition at line 274 of file stream_statistics.h.

Referenced by main().

struct NtExtendedRMONCounters_v1_s NtPortStatistics_v2_s::extRMON

Extended RMON counters.

Definition at line 275 of file stream_statistics.h.

struct NtCheckSumCounters_s NtPortStatistics_v2_s::chksum

Checksum error counters.

Definition at line 276 of file stream_statistics.h.

struct NtDecodeCounters_v1_s NtPortStatistics_v2_s::decode

Packets decoded by onboard packet decoder.

Definition at line 277 of file stream_statistics.h.

struct NtExtendedDropCounters_v1_s NtPortStatistics_v2_s::extDrop

Extended drop counters.

Definition at line 278 of file stream_statistics.h.

struct NtIpFragTableCounters_s NtPortStatistics_v2_s::ipf

IP fragment table counters (when using IPFMode)

Definition at line 279 of file stream_statistics.h.

struct NtPortStatistics_v2_s::NtPortStatisticsValid_v2_s

Valid indicators - these indicate which counters are supported by the port

Definition at line 265 of file stream_statistics.h.

Data Fields

int RMON1
 Is set if RMON1 counters are supported. More...
 
int extRMON
 Is set if extended RMON counters are supported. More...
 
int chksum
 Is set if IP/TCP/UDP checksum counters are supported. More...
 
int decode
 Is set if packet decode counters are supported. More...
 
int extDrop
 Is set if extended drop counters are supported. More...
 
int ipf
 Is set if IP fragment table counters are supported. More...
 

Field Documentation

int NtPortStatistics_v2_s::NtPortStatisticsValid_v2_s::RMON1

Is set if RMON1 counters are supported.

Examples:
net/transmit_multifunction/transmit_multifunction_example.c, and stat/stat_example.c.

Definition at line 266 of file stream_statistics.h.

Referenced by main().

int NtPortStatistics_v2_s::NtPortStatisticsValid_v2_s::extRMON

Is set if extended RMON counters are supported.

Definition at line 267 of file stream_statistics.h.

int NtPortStatistics_v2_s::NtPortStatisticsValid_v2_s::chksum

Is set if IP/TCP/UDP checksum counters are supported.

Definition at line 268 of file stream_statistics.h.

int NtPortStatistics_v2_s::NtPortStatisticsValid_v2_s::decode

Is set if packet decode counters are supported.

Definition at line 269 of file stream_statistics.h.

int NtPortStatistics_v2_s::NtPortStatisticsValid_v2_s::extDrop

Is set if extended drop counters are supported.

Definition at line 270 of file stream_statistics.h.

int NtPortStatistics_v2_s::NtPortStatisticsValid_v2_s::ipf

Is set if IP fragment table counters are supported.

Definition at line 271 of file stream_statistics.h.

struct NtStatGroupport_v2_s

Statistics info group for port statistics

Definition at line 285 of file stream_statistics.h.

Data Fields

struct NtPortStatistics_v2_s rx
 Counters based on RX ports. More...
 
struct NtPortStatistics_v2_s tx
 Counters based on TX ports. More...
 
uint64_t linkDownCounter
 Counts number of link downs. More...
 
uint64_t ts
 Port counter sample time stamp. The format of the timestamp is specified by tsType. More...
 
enum NtTimestampType_e tsType
 Time stamp type - For a description of the time stamp type see "DN-0384 3GD Time-Stamping and Time Synchronization User Guide". More...
 

Field Documentation

struct NtPortStatistics_v2_s NtStatGroupport_v2_s::rx

Counters based on RX ports.

Examples:
stat/stat_example.c.

Definition at line 286 of file stream_statistics.h.

Referenced by main().

struct NtPortStatistics_v2_s NtStatGroupport_v2_s::tx

Counters based on TX ports.

Examples:
net/transmit_multifunction/transmit_multifunction_example.c, and stat/stat_example.c.

Definition at line 287 of file stream_statistics.h.

Referenced by main().

uint64_t NtStatGroupport_v2_s::linkDownCounter

Counts number of link downs.

Definition at line 288 of file stream_statistics.h.

uint64_t NtStatGroupport_v2_s::ts

Port counter sample time stamp. The format of the timestamp is specified by tsType.

Definition at line 289 of file stream_statistics.h.

enum NtTimestampType_e NtStatGroupport_v2_s::tsType

Time stamp type - For a description of the time stamp type see "DN-0384 3GD Time-Stamping and Time Synchronization User Guide".

Definition at line 290 of file stream_statistics.h.

struct NtStatGroupStream_s

Statistics info group for stream statistics

Definition at line 296 of file stream_statistics.h.

Data Fields

struct {
   struct NtColorStatistics_s   forward
 Number of forwarded packets/bytes. More...
 
   struct NtColorStatistics_s   flush
 Number of flushed packets/bytes. Received while the stream-id is inactive. More...
 
   struct NtColorStatistics_s   drop
 Number of dropped packets/bytes. More...
 
streamid [256]
 Statistic for an assigned stream-id. More...
 
struct {
   struct NtColorStatistics_s   forward
 Number of forwarded packets/bytes. More...
 
   struct NtColorStatistics_s   flush
 Number of flushed packets/bytes. Received while the stream-id is inactive. More...
 
   struct NtColorStatistics_s   drop
 Number of dropped packets/bytes. More...
 
Unassigned
 Statistic for traffic received in a host buffer before it has been assigned to a stream-id. More...
 
uint64_t ts
 Stream statistic sample time stamp. The format of the timestamp is specified by the timestamp setting TimestampFormat in the ini-file. More...
 

Field Documentation

struct NtColorStatistics_s NtStatGroupStream_s::forward

Number of forwarded packets/bytes.

Examples:
net/streamidstatistics/streamidstatistics_example.c.

Definition at line 298 of file stream_statistics.h.

Referenced by main().

struct NtColorStatistics_s NtStatGroupStream_s::flush

Number of flushed packets/bytes. Received while the stream-id is inactive.

Definition at line 299 of file stream_statistics.h.

struct NtColorStatistics_s NtStatGroupStream_s::drop

Number of dropped packets/bytes.

Examples:
net/analysis/analysis_example.c, net/capture/capture_example.c, net/streamidstatistics/streamidstatistics_example.c, and net/vlandemo/vlandemo_example.c.

Definition at line 300 of file stream_statistics.h.

Referenced by main().

struct { ... } NtStatGroupStream_s::streamid[256]
struct { ... } NtStatGroupStream_s::Unassigned

Statistic for traffic received in a host buffer before it has been assigned to a stream-id.

uint64_t NtStatGroupStream_s::ts

Stream statistic sample time stamp. The format of the timestamp is specified by the timestamp setting TimestampFormat in the ini-file.

Definition at line 307 of file stream_statistics.h.

struct NtStatisticsQuery_v3_s

Definition at line 310 of file stream_statistics.h.

Data Fields

int poll
 Gets the current statistical information or waits for a new update. More...
 
int clear
 Clears the statistical information after it has been read. All statistics counters for the current stream will be cleared. Other statistics streams will remain untouched. More...
 
struct NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s data
 Structure for statistic results. More...
 

Field Documentation

int NtStatisticsQuery_v3_s::poll

Gets the current statistical information or waits for a new update.

Examples:
net/analysis/analysis_example.c, net/capture/capture_example.c, net/streamidstatistics/streamidstatistics_example.c, net/transmit_multifunction/transmit_multifunction_example.c, net/vlandemo/vlandemo_example.c, and stat/stat_example.c.

Definition at line 311 of file stream_statistics.h.

Referenced by main().

int NtStatisticsQuery_v3_s::clear

Clears the statistical information after it has been read. All statistics counters for the current stream will be cleared. Other statistics streams will remain untouched.

Examples:
net/analysis/analysis_example.c, net/capture/capture_example.c, net/streamidstatistics/streamidstatistics_example.c, net/transmit_multifunction/transmit_multifunction_example.c, net/vlandemo/vlandemo_example.c, and stat/stat_example.c.

Definition at line 312 of file stream_statistics.h.

Referenced by main().

struct NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s::NtStatisticsQueryPortResult_v3_s

Port specific statistics

Definition at line 320 of file stream_statistics.h.

Data Fields

uint8_t numPorts
 Number of ports in aPorts. More...
 
uint8_t Reserved1 [3]
 
struct NtStatGroupport_v2_s aPorts [64]
 Array of port statistic structures in the system. More...
 

Field Documentation

uint8_t NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s::NtStatisticsQueryPortResult_v3_s::numPorts

Number of ports in aPorts.

Definition at line 321 of file stream_statistics.h.

uint8_t NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s::NtStatisticsQueryPortResult_v3_s::Reserved1[3]

Definition at line 322 of file stream_statistics.h.

struct NtStatGroupport_v2_s NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s::NtStatisticsQueryPortResult_v3_s::aPorts[64]

Array of port statistic structures in the system.

Examples:
net/transmit_multifunction/transmit_multifunction_example.c, and stat/stat_example.c.

Definition at line 325 of file stream_statistics.h.

Referenced by main().

struct NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s::NtStatisticsQueryAdapterResult_v3_s

Adapter specific statistics

Definition at line 332 of file stream_statistics.h.

Data Fields

uint8_t numAdapters
 Number of adapters in aAdapters. More...
 
uint8_t Reserved1 [3]
 
struct NtStatGroupAdapter_s aAdapters [10]
 Array of adapter statistic structures. More...
 

Field Documentation

uint8_t NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s::NtStatisticsQueryAdapterResult_v3_s::numAdapters

Number of adapters in aAdapters.

Definition at line 333 of file stream_statistics.h.

uint8_t NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s::NtStatisticsQueryAdapterResult_v3_s::Reserved1[3]

Definition at line 334 of file stream_statistics.h.

struct NtStatGroupAdapter_s NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s::NtStatisticsQueryAdapterResult_v3_s::aAdapters[10]

Array of adapter statistic structures.

Definition at line 335 of file stream_statistics.h.

struct NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s

Data section holding the statistic counters

Definition at line 316 of file stream_statistics.h.

Data Fields

struct NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s::NtStatisticsQueryPortResult_v3_s port
 
struct NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s::NtStatisticsQueryAdapterResult_v3_s adapter
 
struct NtStatGroupStream_s stream
 

Field Documentation

struct NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s::NtStatisticsQueryAdapterResult_v3_s NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s::adapter
struct NtStatGroupStream_s NtStatisticsQuery_v3_s::NtStatisticsQueryResult_v3_s::stream

Stream specific statistics

Examples:
net/analysis/analysis_example.c, net/capture/capture_example.c, net/streamidstatistics/streamidstatistics_example.c, and net/vlandemo/vlandemo_example.c.

Definition at line 340 of file stream_statistics.h.

Referenced by main().

struct NtStatisticsUsageData_v0_s

Definition at line 344 of file stream_statistics.h.

Data Fields

uint8_t streamid
 The streamid to get the usage data for. More...
 
struct NtStatisticsUsageData_v0_s::NtStatUsageData_s data
 

Field Documentation

uint8_t NtStatisticsUsageData_v0_s::streamid

The streamid to get the usage data for.

Examples:
statUsage/statUsage_example.c.

Definition at line 345 of file stream_statistics.h.

Referenced by main().

struct NtStatisticsUsageData_v0_s::NtStatUsageData_s NtStatisticsUsageData_v0_s::data
Examples:
statUsage/statUsage_example.c.

Referenced by main().

struct NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatOnboardBufferingUsage_s

Definition at line 359 of file stream_statistics.h.

Data Fields

uint64_t used
 Onboard adapter buffering. More...
 
uint64_t size
 Onboard adapter buffering size. More...
 
uint32_t crcErrors
 The number of CRC errors detected in the onboard buffer. More...
 

Field Documentation

uint64_t NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatOnboardBufferingUsage_s::used

Onboard adapter buffering.

Examples:
statUsage/statUsage_example.c.

Definition at line 360 of file stream_statistics.h.

Referenced by main().

uint64_t NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatOnboardBufferingUsage_s::size

Onboard adapter buffering size.

Examples:
statUsage/statUsage_example.c.

Definition at line 361 of file stream_statistics.h.

Referenced by main().

uint32_t NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatOnboardBufferingUsage_s::crcErrors

The number of CRC errors detected in the onboard buffer.

Definition at line 362 of file stream_statistics.h.

struct NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s::NtStatUsageRx_s

Definition at line 366 of file stream_statistics.h.

Data Fields

uint64_t bytes
 Bytes received. More...
 
uint64_t frames
 Frames received. More...
 

Field Documentation

uint64_t NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s::NtStatUsageRx_s::bytes

Bytes received.

Definition at line 367 of file stream_statistics.h.

uint64_t NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s::NtStatUsageRx_s::frames

Frames received.

Examples:
statUsage/statUsage_example.c.

Definition at line 368 of file stream_statistics.h.

Referenced by main().

struct NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s::NtStatUsageDrop_s

Definition at line 370 of file stream_statistics.h.

Data Fields

uint64_t bytes
 Bytes dropped. More...
 
uint64_t frames
 Frames dropped. More...
 

Field Documentation

uint64_t NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s::NtStatUsageDrop_s::bytes

Bytes dropped.

Definition at line 371 of file stream_statistics.h.

uint64_t NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s::NtStatUsageDrop_s::frames

Frames dropped.

Examples:
statUsage/statUsage_example.c.

Definition at line 372 of file stream_statistics.h.

Referenced by main().

struct NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s

Definition at line 365 of file stream_statistics.h.

Data Fields

struct NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s::NtStatUsageRx_s rx
 
struct NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s::NtStatUsageDrop_s drop
 
uint64_t ts
 Time stamp of gathered statistics. More...
 

Field Documentation

struct NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s::NtStatUsageRx_s NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s::rx
Examples:
statUsage/statUsage_example.c.

Referenced by main().

struct NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s::NtStatUsageDrop_s NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s::drop
Examples:
statUsage/statUsage_example.c.

Referenced by main().

uint64_t NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s::ts

Time stamp of gathered statistics.

Definition at line 374 of file stream_statistics.h.

struct NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s

Definition at line 349 of file stream_statistics.h.

Data Fields

uint64_t deQueued
 Bytes available or in use by the streams. More...
 
uint64_t enQueued
 Bytes available to the host buffer handler. More...
 
uint64_t enQueuedAdapter
 
uint8_t adapterNo
 The adapter owning the host buffer. More...
 
uint8_t numaNode
 The numanode on which the hostbuffer is located. More...
 
uint64_t hostBufferSize
 The host buffer size. More...
 
uint32_t numStreams
 Number of streams using the host buffers. More...
 
struct NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatOnboardBufferingUsage_s onboardBuffering
 
struct NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s stat
 

Field Documentation

uint64_t NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::deQueued

Bytes available or in use by the streams.

Examples:
statUsage/statUsage_example.c.

Definition at line 350 of file stream_statistics.h.

Referenced by main().

uint64_t NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::enQueued

Bytes available to the host buffer handler.

Examples:
statUsage/statUsage_example.c.

Definition at line 351 of file stream_statistics.h.

Referenced by main().

uint64_t NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::enQueuedAdapter

Bytes currently in the adapter

Examples:
statUsage/statUsage_example.c.

Definition at line 352 of file stream_statistics.h.

Referenced by main().

uint8_t NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::adapterNo

The adapter owning the host buffer.

Examples:
statUsage/statUsage_example.c.

Definition at line 354 of file stream_statistics.h.

Referenced by main().

uint8_t NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::numaNode

The numanode on which the hostbuffer is located.

Examples:
statUsage/statUsage_example.c.

Definition at line 355 of file stream_statistics.h.

Referenced by main().

uint64_t NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::hostBufferSize

The host buffer size.

Examples:
statUsage/statUsage_example.c.

Definition at line 356 of file stream_statistics.h.

Referenced by main().

uint32_t NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::numStreams

Number of streams using the host buffers.

Examples:
statUsage/statUsage_example.c.

Definition at line 357 of file stream_statistics.h.

Referenced by main().

struct NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatOnboardBufferingUsage_s NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::onboardBuffering
Examples:
statUsage/statUsage_example.c.

Referenced by main().

struct NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::NtStatUsage_s NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s::stat
Examples:
statUsage/statUsage_example.c.

Referenced by main().

struct NtStatisticsUsageData_v0_s::NtStatUsageData_s

Definition at line 347 of file stream_statistics.h.

Data Fields

uint32_t numHostBufferUsed
 Number of hostbuffers used by this stream ID. More...
 
struct NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s hb [256]
 

Field Documentation

uint32_t NtStatisticsUsageData_v0_s::NtStatUsageData_s::numHostBufferUsed

Number of hostbuffers used by this stream ID.

Examples:
statUsage/statUsage_example.c.

Definition at line 348 of file stream_statistics.h.

Referenced by main().

struct NtStatisticsUsageData_v0_s::NtStatUsageData_s::NtStatHostBufferUsage_s NtStatisticsUsageData_v0_s::NtStatUsageData_s::hb[256]
Examples:
statUsage/statUsage_example.c.

Referenced by main().

struct NtStatisticsFlowData_v0_s

Flow matcher statistics version 0

Definition at line 383 of file stream_statistics.h.

Data Fields

int clear
 Clears the statistical information after it has been read. More...
 
uint8_t adapterNo
 Adapter to receive the flow statistics from. More...
 
uint8_t reserved [3]
 
uint64_t learnDone
 Total number of flows programmed. More...
 
uint64_t learnFail
 Number of flows that couldn't be programmed. More...
 
uint64_t learnIgnore
 
uint64_t unlearnDone
 
uint64_t unlearnIgnore
 
uint64_t automaticUnlearnDone
 
uint64_t automaticUnlearnIgnore
 
uint64_t automaticUnlearnFail
 
uint64_t timeoutUnlearnDone
 
uint64_t dmaWriteRecords
 
uint64_t dmaReadInfoRecords
 
uint64_t dmaReadStatRecords
 
uint64_t dmaDroppedInfoRecords
 
uint64_t dmaDroppedStatRecords
 

Field Documentation

int NtStatisticsFlowData_v0_s::clear

Clears the statistical information after it has been read.

Definition at line 384 of file stream_statistics.h.

Referenced by openAndClearFlowStats(), and printAndCloseFlowStats().

uint8_t NtStatisticsFlowData_v0_s::adapterNo

Adapter to receive the flow statistics from.

Definition at line 385 of file stream_statistics.h.

Referenced by openAndClearFlowStats(), and printAndCloseFlowStats().

uint8_t NtStatisticsFlowData_v0_s::reserved[3]

Definition at line 386 of file stream_statistics.h.

uint64_t NtStatisticsFlowData_v0_s::learnDone

Total number of flows programmed.

Definition at line 387 of file stream_statistics.h.

Referenced by printAndCloseFlowStats().

uint64_t NtStatisticsFlowData_v0_s::learnFail

Number of flows that couldn't be programmed.

Definition at line 388 of file stream_statistics.h.

Referenced by printAndCloseFlowStats().

uint64_t NtStatisticsFlowData_v0_s::learnIgnore

Definition at line 389 of file stream_statistics.h.

Referenced by printAndCloseFlowStats().

uint64_t NtStatisticsFlowData_v0_s::unlearnDone

Definition at line 390 of file stream_statistics.h.

Referenced by printAndCloseFlowStats().

uint64_t NtStatisticsFlowData_v0_s::unlearnIgnore

Definition at line 391 of file stream_statistics.h.

Referenced by printAndCloseFlowStats().

uint64_t NtStatisticsFlowData_v0_s::automaticUnlearnDone

Definition at line 392 of file stream_statistics.h.

Referenced by printAndCloseFlowStats().

uint64_t NtStatisticsFlowData_v0_s::automaticUnlearnIgnore

Definition at line 393 of file stream_statistics.h.

Referenced by printAndCloseFlowStats().

uint64_t NtStatisticsFlowData_v0_s::automaticUnlearnFail

Definition at line 394 of file stream_statistics.h.

Referenced by printAndCloseFlowStats().

uint64_t NtStatisticsFlowData_v0_s::timeoutUnlearnDone

Definition at line 395 of file stream_statistics.h.

Referenced by printAndCloseFlowStats().

uint64_t NtStatisticsFlowData_v0_s::dmaWriteRecords

Definition at line 396 of file stream_statistics.h.

Referenced by printAndCloseFlowStats().

uint64_t NtStatisticsFlowData_v0_s::dmaReadInfoRecords

Definition at line 397 of file stream_statistics.h.

Referenced by printAndCloseFlowStats().

uint64_t NtStatisticsFlowData_v0_s::dmaReadStatRecords

Definition at line 398 of file stream_statistics.h.

Referenced by printAndCloseFlowStats().

uint64_t NtStatisticsFlowData_v0_s::dmaDroppedInfoRecords

Definition at line 399 of file stream_statistics.h.

Referenced by printAndCloseFlowStats().

uint64_t NtStatisticsFlowData_v0_s::dmaDroppedStatRecords

Definition at line 400 of file stream_statistics.h.

Referenced by printAndCloseFlowStats().

struct NtStatisticsFlowData_v1_s

Flow matcher statistics version 1

Definition at line 406 of file stream_statistics.h.

Data Fields

int clear
 Clears the statistical information after it has been read. More...
 
uint8_t adapterNo
 Adapter to receive the flow statistics from. More...
 
uint8_t reserved [3]
 
uint64_t learnDone
 Total number of flows programmed. More...
 
uint64_t learnFail
 Number of flows that couldn't be programmed. More...
 
uint64_t learnIgnore
 
uint64_t unlearnDone
 
uint64_t unlearnIgnore
 
uint64_t automaticUnlearnDone
 
uint64_t automaticUnlearnIgnore
 
uint64_t automaticUnlearnFail
 
uint64_t timeoutUnlearnDone
 
uint64_t currentFlowCount
 
uint64_t dmaWriteRecords
 
uint64_t dmaReadInfoRecords
 
uint64_t dmaReadStatRecords
 
uint64_t dmaDroppedInfoRecords
 
uint64_t dmaDroppedStatRecords
 

Field Documentation

int NtStatisticsFlowData_v1_s::clear

Clears the statistical information after it has been read.

Definition at line 407 of file stream_statistics.h.

uint8_t NtStatisticsFlowData_v1_s::adapterNo

Adapter to receive the flow statistics from.

Definition at line 408 of file stream_statistics.h.

uint8_t NtStatisticsFlowData_v1_s::reserved[3]

Definition at line 409 of file stream_statistics.h.

uint64_t NtStatisticsFlowData_v1_s::learnDone

Total number of flows programmed.

Definition at line 410 of file stream_statistics.h.

uint64_t NtStatisticsFlowData_v1_s::learnFail

Number of flows that couldn't be programmed.

Definition at line 411 of file stream_statistics.h.

uint64_t NtStatisticsFlowData_v1_s::learnIgnore

Definition at line 412 of file stream_statistics.h.

uint64_t NtStatisticsFlowData_v1_s::unlearnDone

Definition at line 413 of file stream_statistics.h.

uint64_t NtStatisticsFlowData_v1_s::unlearnIgnore

Definition at line 414 of file stream_statistics.h.

uint64_t NtStatisticsFlowData_v1_s::automaticUnlearnDone

Definition at line 415 of file stream_statistics.h.

uint64_t NtStatisticsFlowData_v1_s::automaticUnlearnIgnore

Definition at line 416 of file stream_statistics.h.

uint64_t NtStatisticsFlowData_v1_s::automaticUnlearnFail

Definition at line 417 of file stream_statistics.h.

uint64_t NtStatisticsFlowData_v1_s::timeoutUnlearnDone

Definition at line 418 of file stream_statistics.h.

uint64_t NtStatisticsFlowData_v1_s::currentFlowCount

Definition at line 419 of file stream_statistics.h.

uint64_t NtStatisticsFlowData_v1_s::dmaWriteRecords

Definition at line 420 of file stream_statistics.h.

uint64_t NtStatisticsFlowData_v1_s::dmaReadInfoRecords

Definition at line 421 of file stream_statistics.h.

uint64_t NtStatisticsFlowData_v1_s::dmaReadStatRecords

Definition at line 422 of file stream_statistics.h.

uint64_t NtStatisticsFlowData_v1_s::dmaDroppedInfoRecords

Definition at line 423 of file stream_statistics.h.

uint64_t NtStatisticsFlowData_v1_s::dmaDroppedStatRecords

Definition at line 424 of file stream_statistics.h.

struct NtStatistics_s
union NtStatistics_s::NtStatistics_u

Statistics data

Definition at line 440 of file stream_statistics.h.

Data Fields

struct NtStatisticsQuery_v3_s query_v3
 The structure to use for NtStatistics_s::cmd==NT_STATISTICS_READ_CMD_QUERY_V3. More...
 
struct NtStatisticsUsageData_v0_s usageData_v0
 The structure to use for NtStatistics_s::cmd==NT_STATISTICS_READ_CMD_USAGE_DATA. More...
 
struct NtStatisticsFlowData_v0_s flowData_v0
 The structure to use for NtStatistics_s::cmd==NT_STATISTICS_READ_CMD_FLOW_V0. More...
 
struct NtStatisticsFlowData_v1_s flowData_v1
 The structure to use for NtStatistics_s::cmd==NT_STATISTICS_READ_CMD_FLOW_V1. More...
 

Field Documentation

struct NtStatisticsQuery_v3_s NtStatistics_s::NtStatistics_u::query_v3

The structure to use for NtStatistics_s::cmd==NT_STATISTICS_READ_CMD_QUERY_V3.

Examples:
net/analysis/analysis_example.c, net/capture/capture_example.c, net/streamidstatistics/streamidstatistics_example.c, net/transmit_multifunction/transmit_multifunction_example.c, net/vlandemo/vlandemo_example.c, and stat/stat_example.c.

Definition at line 441 of file stream_statistics.h.

Referenced by main().

struct NtStatisticsUsageData_v0_s NtStatistics_s::NtStatistics_u::usageData_v0

The structure to use for NtStatistics_s::cmd==NT_STATISTICS_READ_CMD_USAGE_DATA.

Examples:
statUsage/statUsage_example.c.

Definition at line 442 of file stream_statistics.h.

Referenced by main().

struct NtStatisticsFlowData_v0_s NtStatistics_s::NtStatistics_u::flowData_v0

The structure to use for NtStatistics_s::cmd==NT_STATISTICS_READ_CMD_FLOW_V0.

Definition at line 443 of file stream_statistics.h.

Referenced by openAndClearFlowStats(), and printAndCloseFlowStats().

struct NtStatisticsFlowData_v1_s NtStatistics_s::NtStatistics_u::flowData_v1

The structure to use for NtStatistics_s::cmd==NT_STATISTICS_READ_CMD_FLOW_V1.

Definition at line 444 of file stream_statistics.h.

Function Documentation

int NT_StatOpen ( NtStatStream_t hStatStream,
const char *  name 
)

Opens a statistics stream.

This function is called to retrieve a handle to a statistics stream

Parameters
[out]hStatStreamReference to a NtStatStream_t stream pointer
[in]nameStream friendly name - used in, for example, logging statements
Return values
0Success
!=0Error
Examples:
net/analysis/analysis_example.c, net/capture/capture_example.c, net/streamidstatistics/streamidstatistics_example.c, net/transmit_multifunction/transmit_multifunction_example.c, net/vlandemo/vlandemo_example.c, stat/stat_example.c, and statUsage/statUsage_example.c.

Referenced by main(), and openAndClearFlowStats().

int NT_StatRead ( NtStatStream_t  hStatStream,
NtStatistics_t stat 
)

Reads statistics.

Returns statistical information from the system

Parameters
[in]hStatStreamNtStatStream_t handle
[in]statReturn buffer for statistics
Return values
0Success
NT_STATUS_TIMEOUTNo data has been returned and a timeout has occured
NT_STATUS_TRYAGAINThe resource is temporarily unavailable because of reconfiguration - call NT_StatRead() again
!=0Error
Examples:
net/analysis/analysis_example.c, net/capture/capture_example.c, net/streamidstatistics/streamidstatistics_example.c, net/transmit_multifunction/transmit_multifunction_example.c, net/vlandemo/vlandemo_example.c, stat/stat_example.c, and statUsage/statUsage_example.c.

Referenced by main(), openAndClearFlowStats(), and printAndCloseFlowStats().

int NT_StatClose ( NtStatStream_t  hStatStream)

Closes a statistics stream.

This function is called to close a statistics stream

Parameters
[in]hStatStreamReference to a NtStatStream_t stream pointer
Return values
0Success
!=0Error
Examples:
net/analysis/analysis_example.c, net/capture/capture_example.c, net/streamidstatistics/streamidstatistics_example.c, net/transmit_multifunction/transmit_multifunction_example.c, net/vlandemo/vlandemo_example.c, stat/stat_example.c, and statUsage/statUsage_example.c.

Referenced by main(), and printAndCloseFlowStats().

Typedef Documentation

Statistics

typedef struct NtStatStream_s* NtStatStream_t

Statistics stream handle

Definition at line 457 of file stream_statistics.h.

Enumeration Type Documentation

Possible statistics read commands

Enumerator
NT_STATISTICS_READ_CMD_UNKNOWN 

Unknown read command.

NT_STATISTICS_READ_CMD_COMPAT_0 

Command for backward compatibility - defined in stream_statistics_compat.h.

NT_STATISTICS_READ_CMD_COMPAT_1 

Command for backward compatibility - defined in stream_statistics_compat.h.

NT_STATISTICS_READ_CMD_COMPAT_2 

Command for backward compatibility - defined in stream_statistics_compat.h.

NT_STATISTICS_READ_CMD_QUERY_V3 

Reads all the statistical information version 3.

NT_STATISTICS_READ_CMD_USAGE_DATA_V0 

Reads hostbuffer, streamid and SDRAM usage data.

NT_STATISTICS_READ_CMD_FLOW_V0 

Reads flow matcher statistics.

NT_STATISTICS_READ_CMD_FLOW_V1 

Reads flow matcher statistics.

Definition at line 116 of file stream_statistics.h.