suricata
util-device.h
Go to the documentation of this file.
1 /* Copyright (C) 2011-2016 Open Information Security Foundation
2  *
3  * You can copy, redistribute or modify this Program under the terms of
4  * the GNU General Public License version 2 as published by the Free
5  * Software Foundation.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * version 2 along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15  * 02110-1301, USA.
16  */
17 
18 #ifndef __UTIL_DEVICE_H__
19 #define __UTIL_DEVICE_H__
20 
21 #include "queue.h"
22 #include "unix-manager.h"
23 
24 #define OFFLOAD_FLAG_SG (1<<0)
25 #define OFFLOAD_FLAG_TSO (1<<1)
26 #define OFFLOAD_FLAG_GSO (1<<2)
27 #define OFFLOAD_FLAG_GRO (1<<3)
28 #define OFFLOAD_FLAG_LRO (1<<4)
29 #define OFFLOAD_FLAG_RXCSUM (1<<5)
30 #define OFFLOAD_FLAG_TXCSUM (1<<6)
31 #define OFFLOAD_FLAG_TOE (1<<7)
32 
33 void LiveSetOffloadDisable(void);
34 void LiveSetOffloadWarn(void);
35 int LiveGetOffload(void);
36 
37 #define MAX_DEVNAME 10
38 
39 /** storage for live device names */
40 typedef struct LiveDevice_ {
41  char *dev; /**< the device (e.g. "eth0") */
44 
45  int id;
46 
47  SC_ATOMIC_DECLARE(uint64_t, pkts);
48  SC_ATOMIC_DECLARE(uint64_t, drop);
49  SC_ATOMIC_DECLARE(uint64_t, bypassed);
50  SC_ATOMIC_DECLARE(uint64_t, invalid_checksums);
52 
53  uint32_t tenant_id; /**< tenant id in multi-tenancy */
54  uint32_t offload_orig; /**< original offload settings to restore @exit */
56 
57 typedef struct LiveDeviceName_ {
58  char *dev; /**< the device (e.g. "eth0") */
61 
62 void LiveDevRegisterExtension(void);
63 
64 int LiveRegisterDeviceName(const char *dev);
65 int LiveGetDeviceNameCount(void);
66 const char *LiveGetDeviceNameName(int number);
67 int LiveRegisterDevice(const char *dev);
69 void LiveDevSetBypassStats(LiveDevice *dev, uint64_t cnt, int family);
70 void LiveDevAddBypassStats(LiveDevice *dev, uint64_t cnt, int family);
71 void LiveDevSubBypassStats(LiveDevice *dev, uint64_t cnt, int family);
72 void LiveDevAddBypassFail(LiveDevice *dev, uint64_t cnt, int family);
73 void LiveDevAddBypassSuccess(LiveDevice *dev, uint64_t cnt, int family);
74 int LiveGetDeviceCount(void);
75 const char *LiveGetDeviceName(int number);
76 LiveDevice *LiveGetDevice(const char *dev);
77 const char *LiveGetShortName(const char *dev);
78 int LiveBuildDeviceList(const char *base);
79 void LiveDeviceHasNoStats(void);
80 int LiveDeviceListClean(void);
81 int LiveBuildDeviceListCustom(const char *base, const char *itemname);
82 
84 
85 void LiveDeviceFinalize(void);
86 
87 #ifdef BUILD_UNIX_SOCKET
88 TmEcode LiveDeviceIfaceStat(json_t *cmd, json_t *server_msg, void *data);
89 TmEcode LiveDeviceIfaceList(json_t *cmd, json_t *server_msg, void *data);
90 TmEcode LiveDeviceGetBypassedStats(json_t *cmd, json_t *answer, void *data);
91 #endif
92 
93 #endif /* __UTIL_DEVICE_H__ */
LiveDevAddBypassSuccess
void LiveDevAddBypassSuccess(LiveDevice *dev, uint64_t cnt, int family)
Definition: util-device.c:599
LiveSetOffloadDisable
void LiveSetOffloadDisable(void)
Definition: util-device.c:69
LiveDevSubBypassStats
void LiveDevSubBypassStats(LiveDevice *dev, uint64_t cnt, int family)
Definition: util-device.c:561
LiveDevice_::id
int id
Definition: util-device.h:45
next
struct HtpBodyChunk_ * next
Definition: app-layer-htp.h:0
LiveDevice_
Definition: util-device.h:40
LiveDevice_::tenant_id_set
bool tenant_id_set
Definition: util-device.h:43
LiveDevice
struct LiveDevice_ LiveDevice
LiveGetDeviceName
const char * LiveGetDeviceName(int number)
Get a pointer to the device name at idx.
Definition: util-device.c:176
LiveRegisterDevice
int LiveRegisterDevice(const char *dev)
Add a pcap device for monitoring and create structure.
Definition: util-device.c:124
LiveDeviceName_::TAILQ_ENTRY
TAILQ_ENTRY(LiveDeviceName_) next
LiveRegisterDeviceName
int LiveRegisterDeviceName(const char *dev)
Add a device for monitoring.
Definition: util-device.c:95
LiveDeviceFinalize
void LiveDeviceFinalize(void)
Definition: util-device.c:469
LiveDevAddBypassFail
void LiveDevAddBypassFail(LiveDevice *dev, uint64_t cnt, int family)
Definition: util-device.c:580
LiveDevAddBypassStats
void LiveDevAddBypassStats(LiveDevice *dev, uint64_t cnt, int family)
Definition: util-device.c:542
MAX_DEVNAME
#define MAX_DEVNAME
Definition: util-device.h:37
LiveBuildDeviceList
int LiveBuildDeviceList(const char *base)
Definition: util-device.c:307
LiveDevice_::SC_ATOMIC_DECLARE
SC_ATOMIC_DECLARE(uint64_t, invalid_checksums)
LiveDeviceName
struct LiveDeviceName_ LiveDeviceName
LiveDeviceForEach
LiveDevice * LiveDeviceForEach(LiveDevice **ldev, LiveDevice **ndev)
Definition: util-device.c:447
LiveGetDeviceNameName
const char * LiveGetDeviceNameName(int number)
Get a pointer to the pre device name at idx.
Definition: util-device.c:217
LiveDeviceListClean
int LiveDeviceListClean(void)
Definition: util-device.c:347
LiveDevice_::tenant_id
uint32_t tenant_id
Definition: util-device.h:53
LiveGetDeviceCount
int LiveGetDeviceCount(void)
Get the number of registered devices.
Definition: util-device.c:156
LiveDevice_::dev
char * dev
Definition: util-device.h:41
LiveDevSetBypassStats
void LiveDevSetBypassStats(LiveDevice *dev, uint64_t cnt, int family)
Definition: util-device.c:523
LiveDevRegisterExtension
void LiveDevRegisterExtension(void)
Definition: util-device.c:492
LiveDeviceName_::dev
char * dev
Definition: util-device.h:58
LiveGetOffload
int LiveGetOffload(void)
Definition: util-device.c:79
LiveDevice_::offload_orig
uint32_t offload_orig
Definition: util-device.h:54
LiveBuildDeviceListCustom
int LiveBuildDeviceListCustom(const char *base, const char *itemname)
Definition: util-device.c:312
TmEcode
TmEcode
Definition: tm-threads-common.h:77
queue.h
LiveDevice_::TAILQ_ENTRY
TAILQ_ENTRY(LiveDevice_) next
LiveDevice_::SC_ATOMIC_DECLARE
SC_ATOMIC_DECLARE(uint64_t, bypassed)
unix-manager.h
LiveDevice_::SC_ATOMIC_DECLARE
SC_ATOMIC_DECLARE(uint64_t, pkts)
LiveDeviceName_
Definition: util-device.h:57
LiveDevice_::SC_ATOMIC_DECLARE
SC_ATOMIC_DECLARE(uint64_t, drop)
LiveDeviceHasNoStats
void LiveDeviceHasNoStats(void)
Definition: util-device.c:342
LiveGetShortName
const char * LiveGetShortName(const char *dev)
Definition: util-device.c:299
LiveGetDevice
LiveDevice * LiveGetDevice(const char *dev)
Get a pointer to the device at idx.
Definition: util-device.c:278
LiveDevice_::dev_short
char dev_short[MAX_DEVNAME+1]
Definition: util-device.h:42
LiveSetOffloadWarn
void LiveSetOffloadWarn(void)
Definition: util-device.c:74
LiveDevUseBypass
int LiveDevUseBypass(LiveDevice *dev)
Definition: util-device.c:501
LiveGetDeviceNameCount
int LiveGetDeviceNameCount(void)
Get the number of pre registered devices.
Definition: util-device.c:197