net/replayfilewithtimestampinject/replayfilewithtimestampinject_example.c

/*
 *
 * Copyright 2025 Napatech A/S. All Rights Reserved.
 *
 * 1. Copying, modification, and distribution of this file, or executable
 * versions of this file, is governed by the terms of the Napatech Software
 * license agreement under which this file was made available. If you do not
 * agree to the terms of the license do not install, copy, access or
 * otherwise use this file.
 *
 * 2. Under the Napatech Software license agreement you are granted a
 * limited, non-exclusive, non-assignable, copyright license to copy, modify
 * and distribute this file in conjunction with Napatech SmartNIC's and
 * similar hardware manufactured or supplied by Napatech A/S.
 *
 * 3. The full Napatech Software License Agreement is included in this
 * distribution, please see "NA-0009 Software License Agreement.pdf"
 *
 * 4. Redistributions of source code must retain this copyright notice,
 * list of conditions and the following disclaimer.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTIES, EXPRESS OR
 * IMPLIED, AND NAPATECH DISCLAIMS ALL IMPLIED WARRANTIES INCLUDING ANY
 * IMPLIED WARRANTY OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, OR OF
 * FITNESS FOR A PARTICULAR PURPOSE. TO THE EXTENT NOT PROHIBITED BY
 * APPLICABLE LAW, IN NO EVENT SHALL NAPATECH BE LIABLE FOR PERSONAL INJURY,
 * OR ANY INCIDENTAL, SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES WHATSOEVER,
 * INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, CORRUPTION OR
 * LOSS OF DATA, FAILURE TO TRANSMIT OR RECEIVE ANY DATA OR INFORMATION,
 * BUSINESS INTERRUPTION OR ANY OTHER COMMERCIAL DAMAGES OR LOSSES, ARISING
 * OUT OF OR RELATED TO YOUR USE OR INABILITY TO USE NAPATECH SOFTWARE OR
 * SERVICES OR ANY THIRD PARTY SOFTWARE OR APPLICATIONS IN CONJUNCTION WITH
 * THE NAPATECH SOFTWARE OR SERVICES, HOWEVER CAUSED, REGARDLESS OF THE THEORY
 * OF LIABILITY (CONTRACT, TORT OR OTHERWISE) AND EVEN IF NAPATECH HAS BEEN
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SOME JURISDICTIONS DO NOT ALLOW
 * THE EXCLUSION OR LIMITATION OF LIABILITY FOR PERSONAL INJURY, OR OF
 * INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS LIMITATION MAY NOT APPLY TO YOU.
 *
 *
 */
/**
 *
 * @example net/replayfilewithtimestampinject/replayfilewithtimestampinject_example.c
 *
 * @section replayfilewithtimestampinject_example_description Description
 *
 * This source file is an example of how to read a capture file using NTAPI
 * and transmit the packet using a dynamic descriptor which makes it possible
 * to inject the transmitted timestamp in the packet.
 *
 * This example make use of the following settings in ntservice.ini
 *
 * TimestampFormat = UNIX_NS
 *
 * TimestampInjectStaticOffset = 0
 *
 * TimestampInjectDynamicOffset = TSI_DYN_SOF
 *
 * PacketDescriptor = NT
 *
 *
 * The NT_NetFile...() functions does not require NTservice to be running.
 *
 * The following NTAPI functions are used:
 * - @ref NT_ExplainError()
 * - @ref NT_Init()
 * - @ref NT_NetFileClose()
 * - @ref NT_NetFileGet()
 * - @ref NT_NetFileOpen()
 * - @ref NT_NetFileRelease()
 * - @ref NT_NET_GET_PKT_DESCR_PTR_DYN3()
 * - @ref NT_NET_GET_PKT_L2_PTR()
 * - @ref NT_NET_GET_PKT_WIRE_LENGTH()
 * - @ref NT_NetTxClose()
 * - @ref NT_NETTX_DESCRIPTOR_MODE_DYN3
 * - @ref NT_NetTxGet()
 * - @ref NT_NETTX_NUMA_ADAPTER_HB
 * - @ref NT_NetTxOpen_Attr
 * - @ref NT_NetTxOpenAttrSetDescriptorPosChecksumCmd()
 * - @ref NT_NetTxOpenAttrSetDescriptorPosFrameType()
 * - @ref NT_NetTxOpenAttrSetMinHostbufferSize()
 * - @ref NT_NetTxOpenAttrSetName()
 * - @ref NT_NetTxOpenAttrSetPortMask()
 * - @ref NT_NetTxOpenAttrSetTxtDescriptorPosFcs()
 * - @ref NT_NetTxOpenAttrSetTxtDescriptorPosTimestampInject()
 * - @ref NT_NetTxOpen()
 * - @ref NT_NetTxRelease()
 *
 * @section replayfilewithtimestampinject_example_prerequisites Prerequisites
 *
 * - Capture file, that has been captured with the @ref
 *   net/capture/capture_example.c "net/capture/capture_example.c" example.
 *
 * - The capture filename should be given as first argument to this example.
 *
 * @section replayfilewithtimestampinject_example_flow Program flow
 * @{
 * The following is required to perform replay of a captured file
 *
 * - \#include/nt.h - Applications/Tools only need to include @ref nt.h
 *   to obtain prototypes, macros etc. from NTAPI.
 * - @ref NT_Init(@ref NTAPI_VERSION) - Initialize the NTAPI
 *   library. @ref NTAPI_VERSION is a define that describes the version
 *   of the API described in the header files included by @ref
 *   nt.h. NT_Init() will ask the NTAPI library to convert return data
 *   to the @ref NTAPI_VERSION if possible. This will ensure that
 *   applications can run on NTAPI libraries of newer versions.
 * - @ref NT_NetFileOpen() - Open the captured file and assign it to a stream.
 * - @ref NT_NetFileGet() - Get a segment from the file.  This call will
 *   return @ref NT_SUCCESS upon return of a segment and
 *   @ref NT_STATUS_END_OF_FILE when there is no more segments
 *   avaialble. The latter will cause the example to exit.
 * - @ref NT_NetFileRelease() - Release the segment from the file stream.
 * - @ref NT_NetFileClose() - Close the file stream when no more segments can be found.
 *
 *<hr>
 *
 * @section replayfilewithtimestampinject_example_code Code
 * @}
 *
 */
// Include this in order to access the Napatech API
#include <nt.h>
#include <argparse.h>
#define PORT        0
// The struct below represents the TX dynamic descriptor
// used by this application
//
// The struct is based on a copy of Dynamic descriptor 3
// It is modified with the location of the command bits
// time stamp inject handling and FCS handling.
//
// This example uses 3 bits of the color_hi field
// for these command bits. In other words - the
// normal color_hi:28 has been replaced by the
// 3 command bits and a color_hi_unused:25
//
struct Dyn3_tx_descriptor {
  uint64_t capLength:14;
  uint64_t wireLength:14;
  uint64_t color_lo:14;
  uint64_t rxPort:6;
  uint64_t descrFormat:8;
  uint64_t descrLength:6;
  uint64_t tsColor:1;
  uint64_t ntDynDescr:1;
  uint64_t timestamp;
  uint64_t tsiCmd:1;             // Timestamp inject command, 1 bit starting at bit offset 128
  uint64_t fcsCmd:2;             // FCS command, 2 bits starting at bit offset 129
  uint64_t color_hi_unused:25;   // The remaing 25 unused bits of color_hi
  uint64_t offset0:10;
  uint64_t offset1:10;
};
// Time stamp inject command bit values
const uint64_t NO_TS_INJECT  = 0;
const uint64_t TS_INJECT     = 1;
// FCS command bits values
const uint64_t FCS_GOOD      = 0;
const uint64_t FCS_BAD       = 1;
const uint64_t FCS_RESERVED  = 2;
const uint64_t FCS_UNCHANGED = 3;
static const char *usageText[] = {
  "USAGE: replayfilewithtimestampinject_example <nt3gd_capture_filename>\n"
  "Commands:\n",
  NULL};
/**
 * Table of valid options.
 */
struct argparse_option arg_options[] = {
    OPT_HELP(),
    OPT_END(),
};
// printError is a simple convenience function for printing an NTAPI error
// message to stderr.
static void printError(const char *prefix, int errorCode) {
  char errorBuffer[NT_ERRBUF_SIZE];
  NT_ExplainError(errorCode, errorBuffer, sizeof errorBuffer);
  fprintf(stderr, "%s: %s\n", prefix, errorBuffer);
}
int main(int argc, const char** argv) {
  int status;                       // Status variable
  char errorBuffer[NT_ERRBUF_SIZE]; // Error buffer
  int numPackets = 0;               // The number of packets replayed
  size_t numBytes = 0;              // The number of bytes replayed
  size_t pktLen = 0;                // packet lenght
  int option;
  const char* ntcap_filename = NULL;
  NtNetStreamFile_t hNetFile;       // Handle to the File stream
  NtNetBuf_t hNetBufFile;           // Net buffer container. Used to return segments from the file stream
  struct argparse argparse;
  int running = 1;
  argparse_init(&argparse, arg_options, usageText, 0);
  option = argparse_parse(&argparse, argc, argv);
  if ((option >= 1) && (argv[0] != NULL)) {
    ntcap_filename = argv[0];
  } else {
    argparse_usage(&argparse);
    exit(0);
  }
  // Initialize the NTAPI library and thereby check if NTAPI_VERSION can be used together with this library
  if ((status = NT_Init(NTAPI_VERSION)) != NT_SUCCESS) {
    if ( status == NT_ERROR_NT_SERVICE_NOT_STARTED) {
      printf("NOTE: NT service is not started.\n");
    } else {
      // Get the status code as text
      NT_ExplainError(status, errorBuffer, sizeof(errorBuffer));
      fprintf(stderr, "NT_Init() failed: %s\n", errorBuffer);
      return -1;
    }
  }
  // Open the capture file to replay (captured with the capture example)
  if ((status = NT_NetFileOpen(&hNetFile, "FileStream", NT_NET_INTERFACE_PACKET, ntcap_filename)) != NT_SUCCESS) {
    // Get the status code as text
    NT_ExplainError(status, errorBuffer, sizeof(errorBuffer));
    fprintf(stderr, "NT_NetFileOpen() failed: %s\n", errorBuffer);
    return -1;
  }
  // Open a TX stream
  NtNetStreamTx_t hNetTx;
  status = NT_NetTxOpen(&hNetTx, "transmit_packet_example_txstream",
                        1ULL << PORT, NT_NETTX_NUMA_ADAPTER_HB, 0);
  if (status != NT_SUCCESS) {
    printError("NT_NetTxOpen() failed", status);
    return -1;
  }
  NtNetTxAttr_t txAttr;
  NT_NetTxOpenAttrInit(&txAttr);
  NT_NetTxOpenAttrSetName(&txAttr, "Time stamp Inject and FCS example");
  NT_NetTxOpenAttrSetPortMask(&txAttr, (uint64_t)(1U << PORT));
  NT_NetTxOpenAttrSetMinHostbufferSize(&txAttr, 0);
  NT_NetTxOpenAttrSetDescriptorMode(&txAttr, NT_NETTX_DESCRIPTOR_MODE_DYN3);
  // Set the position of the various descriptor command
  // in accordance with struct Dyn3_tx_descriptor
  status = NT_NetTxOpenAttrSetTxtDescriptorPosTimestampInject(&txAttr,  true, 128);
  if (status != NT_SUCCESS) {
    NT_ExplainError(status, errorBuffer, sizeof(errorBuffer));
    fprintf(stderr, "NT_NetTxOpenAttrSetTxtDescriptorPosTimestampInjectCmd failed: %s\n", errorBuffer);
    exit(1);
  }
  status = NT_NetTxOpenAttrSetTxtDescriptorPosFcs(&txAttr,  true, 129);
  if (status != NT_SUCCESS) {
    NT_ExplainError(status, errorBuffer, sizeof(errorBuffer));
    fprintf(stderr, "NT_NetTxOpenAttrSetTxtDescriptorPosFcs failed: %s\n", errorBuffer);
    exit(1);
  }
  // Open the TX network stream
  status = NT_NetTxOpen_Attr(&hNetTx, &txAttr);
  if (status != NT_SUCCESS) {
    NT_ExplainError(status, errorBuffer, sizeof(errorBuffer));
    fprintf(stderr, "NT_NetTxOpen() failed: %s\n", errorBuffer);
    exit(1);
  }
  NtNetBuf_t hNetBufTx;
  // Get packets from the file - update counters
  while (running) {
    // Get the packet
    if ((status = NT_NetFileGet(hNetFile, &hNetBufFile)) != NT_SUCCESS) {
      if (status == NT_STATUS_END_OF_FILE) {
        // The file has no more data
        break;
      }
      // Get the status code as text
      NT_ExplainError(status, errorBuffer, sizeof(errorBuffer));
      fprintf(stderr, "NT_NetFileGet() failed: %s\n", errorBuffer);
      return -1;
    }
    pktLen = NT_NET_GET_PKT_WIRE_LENGTH((hNetBufFile));
    printf("Fetched packet: #%d: packet length: %lu bytes - total capture length: %lu bytes\n", numPackets, pktLen, numBytes);
    // Get a packet TX buffer for this tx stream and port, without timeout
    if ((status = NT_NetTxGet(hNetTx, &hNetBufTx, PORT, pktLen,
            NT_NETTX_PACKET_OPTION_DYN, -1)) != NT_SUCCESS) {
      printError("NT_NetTxGet() failed", status);
      return -1;
    }
    memcpy(NT_NET_GET_PKT_L2_PTR(hNetBufTx), NT_NET_GET_PKT_L2_PTR(hNetBufFile), pktLen);
    NtDyn3Descr_t* packet_ptr = NT_NET_GET_PKT_DESCR_PTR_DYN3(hNetBufTx);
    struct Dyn3_tx_descriptor* overlay_ptr = (struct Dyn3_tx_descriptor*)(packet_ptr);
    overlay_ptr->tsiCmd = TS_INJECT & 0x01; // Set the time stamp inject command bits
    overlay_ptr->fcsCmd = FCS_GOOD  & 0x03; // Set the FCS command bits
    // Release the TX buffer and the packet will be transmitted
    if ((status = NT_NetTxRelease(hNetTx, hNetBufTx)) != NT_SUCCESS) {
      // Get the status code as text
      NT_ExplainError(status, errorBuffer, sizeof(errorBuffer));
      fprintf(stderr, "NT_NetTxRelease() failed: %s\n", errorBuffer);
      running = false;
    }
    numPackets++,
    numBytes += pktLen;
    // Release the file packet
    if ((status = NT_NetFileRelease(hNetFile, hNetBufFile)) != NT_SUCCESS) {
      // Get the status code as text
      NT_ExplainError(status, errorBuffer, sizeof(errorBuffer));
      fprintf(stderr, "NT_NetFileRelease() failed: %s\n", errorBuffer);
      running = false;
    }
  }
  // Close the TX stream
  NT_NetTxClose(hNetTx);
  // Close the file stream
  NT_NetFileClose(hNetFile);
  printf("Done: %d packets %lu bytes has been read\n", numPackets, numBytes);
  return 0;
}