config_example.c Source File

/*
 *
 * Copyright 2023 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 "NP-0405 Napatech 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 config/config_example.c
 * @section config_example_description Description
 *
 * This source file is an example of how to use the @ref ConfigStream
 * "Configuration stream" interface in NTAPI.
 *
 * The following NTAPI functions are used:
 * - @ref NT_Init()
 * - @ref NT_ConfigOpen()
 * - @ref NT_ConfigWrite()
 * - @ref NT_ConfigRead()
 * - @ref NT_ConfigClose()
 * - @ref NT_Done()
 * - @ref NT_ExplainError()
 *
 * <hr>
 * @section config_example_prerequisites Prerequisites
 * A working system is needed with a Napatech accelerator as adapter 0.
 *
 * @section config_example_flow Program flow
 * @{
 * The following is required to perform read and write operations on
 * the @ref ConfigStream "configuration stream":
 * - \#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_ConfigOpen() - Open a configuration stream.
 * - @ref NT_ConfigRead() - Read configuration.
 * - @ref NT_ConfigWrite() - Write configuration.
 * - @ref NT_ConfigClose() - Close the stream when terminating.
 * - @ref NT_Done() - Close down the NTAPI library.
 * - @ref NT_ExplainError() - Explain an error code returned by NTAPI functions.
 *
 *<hr>
 * @}
 */

// Include this in order to access the Napatech API
#include <nt.h>

#if defined(__linux__) || defined(__FreeBSD__)
  #include <unistd.h> // sleep()
#elif defined(WIN32) || defined (WIN64)
  #include <winsock2.h>
#endif


int main(void)
{
  NtConfigStream_t hConfigStream; // Configuration stream handle
  NtConfig_t hConfig;             // Configuration handle
  char errorBuffer[NT_ERRBUF_SIZE];         // Error buffer
  int status;                   // Status variable

  // 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) {
    // Get the status code as text
    NT_ExplainError(status, errorBuffer, sizeof(errorBuffer));
    fprintf(stderr, "NT_Init() failed: %s\n", errorBuffer);
    return -1;
  }

  // Open the configuration stream
  if ((status = NT_ConfigOpen(&hConfigStream, "ExampleConfig")) != NT_SUCCESS) {
    // Get the status code as text
    NT_ExplainError(status, errorBuffer, sizeof(errorBuffer));
    fprintf(stderr, "NT_ConfigOpen() failed: %s\n", errorBuffer);
    return -1;
  }

  // Read the current timestamp
  hConfig.parm=NT_CONFIG_PARM_ADAPTER_TIMESTAMP;
  hConfig.u.timestampRead.adapter=0;
  if ((status = NT_ConfigRead(hConfigStream, &hConfig)) != NT_SUCCESS) {
    // Get the status code as text
    NT_ExplainError(status, errorBuffer, sizeof(errorBuffer));
    fprintf(stderr, "NT_ConfigRead() failed: %s\n", errorBuffer);
    return -1;
  }

  // Print the current timestamp
  printf("Adapter 0 time is: %llX type %s.\n",
         (unsigned long long)hConfig.u.timestampRead.data.ts,
         (hConfig.u.timestampRead.data.tsType==NT_TIMESTAMP_TYPE_NATIVE?"Native":
          hConfig.u.timestampRead.data.tsType==NT_TIMESTAMP_TYPE_NATIVE_NDIS?"Native NDIS":
          hConfig.u.timestampRead.data.tsType==NT_TIMESTAMP_TYPE_NATIVE_UNIX?"Native UNIX":
          hConfig.u.timestampRead.data.tsType==NT_TIMESTAMP_TYPE_UNIX_NANOTIME?"UNIX Nanosecond":"Unknown"));

  // Set the timestamp to 0
  hConfig.parm=NT_CONFIG_PARM_ADAPTER_TIMESTAMP;
  hConfig.u.timestampWrite.adapter=0;
  hConfig.u.timestampWrite.data.bCurrent=0;
  hConfig.u.timestampWrite.data.ts=0;
  printf("Setting time to 0.\n");
  if ((status = NT_ConfigWrite(hConfigStream, &hConfig)) != NT_SUCCESS) {
    // Get the status code as text
    NT_ExplainError(status, errorBuffer, sizeof(errorBuffer));
    fprintf(stderr, "NT_ConfigWrite() failed: %s\n", errorBuffer);
    return -1;
  }

  // Sleep 1 sec
#if defined(__linux__) || defined(__FreeBSD__)
  sleep(1);
#elif defined(WIN32) || defined (WIN64)
  Sleep(1000); // sleep 1000 milliseconds = 1 second
#endif

  // Read the timestamp again
  hConfig.parm=NT_CONFIG_PARM_ADAPTER_TIMESTAMP;
  hConfig.u.timestampRead.adapter=0;
  if ((status = NT_ConfigRead(hConfigStream, &hConfig)) != NT_SUCCESS) {
    // Get the status code as text
    NT_ExplainError(status, errorBuffer, sizeof(errorBuffer));
    fprintf(stderr, "NT_ConfigRead() failed: %s\n", errorBuffer);
    return -1;
  }

  printf("Sleep 1 sec.\n");
  printf("Adapter 0 time is: %llX type %s.\n",
         (unsigned long long)hConfig.u.timestampRead.data.ts,
         (hConfig.u.timestampRead.data.tsType==NT_TIMESTAMP_TYPE_NATIVE?"Native":
          hConfig.u.timestampRead.data.tsType==NT_TIMESTAMP_TYPE_NATIVE_NDIS?"Native NDIS":
          hConfig.u.timestampRead.data.tsType==NT_TIMESTAMP_TYPE_NATIVE_UNIX?"Native UNIX":
          hConfig.u.timestampRead.data.tsType==NT_TIMESTAMP_TYPE_UNIX_NANOTIME?"UNIX Nanosecond":"Unknown"));

  // Close the configuration stream
  if ((status = NT_ConfigClose(hConfigStream)) != NT_SUCCESS) {
    // Get the status code as text
    NT_ExplainError(status, errorBuffer, sizeof(errorBuffer));
    fprintf(stderr, "NT_ConfigClose() failed: %s\n", errorBuffer);
    return -1;
  }

  // Close down the NTAPI library
  NT_Done();

  printf("Done.\n");
  return 0;
}