1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
/*
** Copyright (C) 2014 Cisco and/or its affiliates. All rights reserved.
** Copyright (C) 2010-2013 Sourcefire, Inc.
** Author: Michael R. Altizer <maltizer@sourcefire.com>
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License Version 2 as
** published by the Free Software Foundation. You may not use, modify or
** distribute this program under any other version of the GNU General
** Public License.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef _DAQ_API_H
#define _DAQ_API_H
#include <daq_common.h>
struct _daq_dict_entry
{
char *key;
char *value;
struct _daq_dict_entry *next;
};
struct _daq_module
{
/* The version of the API this module implements.
This *must* be the first element in the structure. */
const uint32_t api_version;
/* The version of the DAQ module itself - can be completely arbitrary. */
const uint32_t module_version;
/* The name of the module (sfpacket, xvnim, pcap, etc.) */
const char *name;
/* Various flags describing the module and its capabilities (Inline-capabale, etc.) */
const uint32_t type;
/* Initialize the device for packet acquisition with the supplied configuration.
This should not start queuing packets for the application. */
int (*initialize) (const DAQ_Config_t *config, void **ctxt_ptr, char *errbuf, size_t len);
/* Set the module's BPF based on the given string */
int (*set_filter) (void *handle, const char *filter);
/* Complete device opening and begin queuing packets if they have not been already. */
int (*start) (void *handle);
/* Acquire up to <cnt> packets and call <callback> for each with <user> as the final argument.
The return value of the callback will determine the action taken by the DAQ for each packet.
If <cnt> is 0, packets will continue to be acquired until some other factor breaks the
acquisition loop. */
int (*acquire) (void *handle, int cnt, DAQ_Analysis_Func_t callback, DAQ_Meta_Func_t metaback, void *user);
/* Inject a new packet going either the same or opposite direction as the specified packet. */
int (*inject) (void *handle, const DAQ_PktHdr_t *hdr, const uint8_t *packet_data, uint32_t len, int reverse);
/* Force breaking out of the acquisition loop after the current iteration. */
int (*breakloop) (void *handle);
/* Stop queuing packets, if possible */
int (*stop) (void *handle);
/* Close the device and clean up */
void (*shutdown) (void *handle);
/* Get the status of the module (one of DAQ_STATE_*). */
DAQ_State (*check_status) (void *handle);
/* Populates the <stats> structure with the current DAQ stats. These stats are cumulative. */
int (*get_stats) (void *handle, DAQ_Stats_t *stats);
/* Resets the DAQ module's internal stats. */
void (*reset_stats) (void *handle);
/* Return the configured snaplen */
int (*get_snaplen) (void *handle);
/* Return a bitfield of the device's capabilities */
uint32_t (*get_capabilities) (void *handle);
/* Return the instance's Data Link Type */
int (*get_datalink_type) (void *handle);
/* Return a pointer to the module's internal error buffer */
const char * (*get_errbuf) (void *handle);
/* Write a string to the module instance's internal error buffer */
void (*set_errbuf) (void *handle, const char *string);
/* Return the index of the given named device if possible. */
int (*get_device_index) (void *handle, const char *device);
/* Modify a flow */
int (*modify_flow) (void *handle, const DAQ_PktHdr_t *hdr, DAQ_ModFlow_t *modify);
/* Read new configuration */
int (*hup_prep) (void *handle, void **new_config);
/* Swap new and old configuration */
int (*hup_apply) (void *handle, void *new_config, void **old_config);
/* Destroy old configuration */
int (*hup_post) (void *handle, void *old_config);
/** DAQ API to program a FST/EFT entry for dynamic protocol data channel
*
* @param [in] handle DAQ module handle
* @param [in] hdr DAQ packet header of the control channel packet.
* @param [in] dp_key Key structure of the data channel flow
* @param [in] packet_data Packet of the companion control channel packet.
* @return Error code of the API. 0 - success.
*/
int (*dp_add_dc) (void *handle, const DAQ_PktHdr_t * hdr, DAQ_DP_key_t * dp_key, const uint8_t * packet_data);
};
#define DAQ_API_VERSION 0x00010002
#define DAQ_ERRBUF_SIZE 256
/* This is a convenience macro for safely printing to DAQ error buffers. It must be called on a known-size character array. */
#ifdef WIN32
inline void DPE(char *var, char *fmt, ...)
{
va_list ap;
va_start(ap, fmt);
snprintf(var, sizeof(var), ap);
va_end(ap);
}
#else
#define DPE(var, ...) snprintf(var, sizeof(var), __VA_ARGS__)
#endif
#endif /* _DAQ_API_H */
|
