snf.h

/*************************************************************************
 * The contents of this file are subject to the MYRICOM SNIFFER10G
 * LICENSE (the "License"); User may not use this file except in
 * compliance with the License.  The full text of the License can found
 * in LICENSE.TXT
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.  See
 * the License for the specific language governing rights and
 * limitations under the License.
 *
 * Copyright 2008-2009 by Myricom, Inc.  All rights reserved.
 ***********************************************************************/

#ifndef _snf_h
#define _snf_h

#include <stdint.h>

#ifdef __cplusplus
extern "C"
{
#endif

#define SNF_VERSION_API 0x0002

typedef struct snf_handle *snf_handle_t;

int  snf_init(uint16_t api_version); /* must be SNF_VERSION_API */


struct snf_ifaddrs {
  struct snf_ifaddrs *snf_ifa_next;      
  const char *snf_ifa_name;       
  uint32_t    snf_ifa_boardnum;   
  int         snf_ifa_maxrings;   
  uint8_t     snf_ifa_macaddr[6]; 
};

int  snf_getifaddrs(struct snf_ifaddrs **ifaddrs_o);

void snf_freeifaddrs(struct snf_ifaddrs *ifaddrs);

struct snf_recv_req;

enum snf_rss_params_mode { 
  SNF_RSS_FLAGS = 0, 
  SNF_RSS_FUNCTION = 1 
};

enum snf_rss_mode_flags {
  SNF_RSS_IP        =  0x01, 
  SNF_RSS_SRC_PORT  =  0x10, 
  SNF_RSS_DST_PORT  =  0x20  
};
#define SNF_RSS_IPV4 SNF_RSS_IP 
struct snf_rss_mode_function {

  uint32_t   (*rss_hash_fn)(struct snf_recv_req *r, void *context);
  void        *rss_context;
};

struct snf_rss_params {
  enum snf_rss_params_mode mode; 
  union {
    enum snf_rss_mode_flags      rss_flags; 
    struct snf_rss_mode_function rss_function; 
  } params; 
};
#define SNF_F_PSHARED 0x1

#define SNF_F_RX_DUPLICATE 0x300

#define SNF_F_RX_PRIVATE 0x100

int snf_open(uint32_t boardnum,
             int num_rings,
             const struct snf_rss_params *rss_parms,
             int64_t dataring_sz,
             int flags,
             snf_handle_t *devhandle);

int snf_start(snf_handle_t devhandle);

int snf_stop(snf_handle_t devhandle);

int snf_close(snf_handle_t devhandle);

typedef struct snf_ring   *snf_ring_t;

int snf_ring_open(snf_handle_t devhandle, snf_ring_t *ringh);

int snf_ring_close(snf_ring_t ringh);

struct snf_recv_req {
  void    *pkt_addr;  
  uint32_t length;    
  uint64_t timestamp; 
  uint64_t token;     
};

int snf_ring_recv(snf_ring_t ringh, int timeout_ms, struct snf_recv_req *recv_req);

struct snf_ring_stats {
  uint64_t  nic_pkt_recv;       
  uint64_t  nic_pkt_overflow;   
  uint64_t  nic_pkt_bad;        
  uint64_t  ring_pkt_recv;      
  uint64_t  ring_pkt_overflow;  
  uint64_t  nic_bytes_recv;     
};

int snf_ring_getstats(snf_ring_t ringh, struct snf_ring_stats *stats);

#ifdef __cplusplus
}
#endif
#endif /* _snf_h */

---

26 October 2010 Sniffer10G 1.0.2_pcap1.1.1