lib/librte_port/rte_port_source_sink.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef __INCLUDE_RTE_PORT_SOURCE_SINK_H__
  35 #define __INCLUDE_RTE_PORT_SOURCE_SINK_H__
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /**
  42  * @file
  43  * RTE Port Source/Sink
  44  *
  45  * source: input port that can be used to generate packets
  46  * sink: output port that drops all packets written to it
  47  *
  48  ***/
  49
  50 #include "rte_port.h"
  51
  52 /** source port parameters */
  53 struct rte_port_source_params {
  54         /** Pre-initialized buffer pool */
  55         struct rte_mempool *mempool;
  56 #ifdef RTE_NEXT_ABI
  57
  58         /** The full path of the pcap file to read packets from */
  59         char *file_name;
  60         /** The number of bytes to be read from each packet in the
  61          *  pcap file. If this value is 0, the whole packet is read;
  62          *  if it is bigger than packet size, the generated packets
  63          *  will contain the whole packet */
  64         uint32_t n_bytes_per_pkt;
  65
  66 #endif
  67 };
  68
  69 /** source port operations */
  70 extern struct rte_port_in_ops rte_port_source_ops;
  71
  72 /** sink port parameters */
  73 struct rte_port_sink_params {
  74         /** The full path of the pcap file to write the packets to */
  75         char *file_name;
  76         /** The maximum number of packets write to the pcap file.
  77          *  If this value is 0, the "infinite" write will be carried
  78          *  out.
  79          */
  80         uint32_t max_n_pkts;
  81 };
  82
  83 /** sink port operations */
  84 extern struct rte_port_out_ops rte_port_sink_ops;
  85
  86 #ifdef __cplusplus
  87 }
  88 #endif
  89
  90 #endif