Utility functions to handle device list. More...

#include "suricata-common.h"
#include "conf.h"
#include "util-device.h"
#include "util-ioctl.h"
#include "util-misc.h"
#include "util-dpdk.h"
#include "device-storage.h"
#include "util-debug.h"

Include dependency graph for util-device.c:

Go to the source code of this file.

Macros
#define	MAX_DEVNAME 10

Functions
void	LiveSetOffloadDisable (void)

void	LiveSetOffloadWarn (void)

int	LiveGetOffload (void)

int	LiveRegisterDeviceName (const char *dev)
	Add a device for monitoring. More...

int	LiveRegisterDevice (const char *dev)
	Add a pcap device for monitoring and create structure. More...

int	LiveGetDeviceCount (void)
	Get the number of registered devices. More...

const char *	LiveGetDeviceName (int number)
	Get a pointer to the device name at idx. More...

LiveDevice *	LiveGetDevice (const char *name)
	Get a pointer to the device at idx. More...

const char *	LiveGetShortName (const char *dev)

int	LiveBuildDeviceList (const char *runmode)

int	LiveBuildDeviceListCustom (const char runmode, const char itemname)

void	LiveDeviceHasNoStats (void)

int	LiveDeviceListClean (void)

LiveDevice *	LiveDeviceForEach (LiveDevice ldev, LiveDevice ndev)

void	LiveDeviceFinalize (void)

void	LiveDevRegisterExtension (void)

int	LiveDevUseBypass (LiveDevice *dev)

void	LiveDevAddBypassStats (LiveDevice *dev, uint64_t cnt, int family)

void	LiveDevSubBypassStats (LiveDevice *dev, uint64_t cnt, int family)

void	LiveDevAddBypassFail (LiveDevice *dev, uint64_t cnt, int family)

void	LiveDevAddBypassSuccess (LiveDevice *dev, uint64_t cnt, int family)

Variables
	BypassInfo

Detailed Description

Utility functions to handle device list.

Author: Eric Leblond eric@.nosp@m.regi.nosp@m.t.org

Definition in file util-device.c.

Macro Definition Documentation

◆ MAX_DEVNAME

#define MAX_DEVNAME 10

Definition at line 29 of file util-device.c.

Function Documentation

◆ LiveBuildDeviceList()

int LiveBuildDeviceList ( const char * runmode )

Definition at line 274 of file util-device.c.

References LiveBuildDeviceListCustom().

Here is the call graph for this function:

◆ LiveBuildDeviceListCustom()

int LiveBuildDeviceListCustom	(	const char *	runmode,
		const char *	itemname
	)

Definition at line 279 of file util-device.c.

Referenced by LiveBuildDeviceList().

Here is the caller graph for this function:

◆ LiveDevAddBypassFail()

void LiveDevAddBypassFail	(	LiveDevice *	dev,
		uint64_t	cnt,
		int	family
	)

Increase number of failed captured flows for a protocol family

Parameters

dev	pointer to LiveDevice to set stats for
cnt	number of flows to add
family	AF_INET to set IPv4 count or AF_INET6 to set IPv6 count

Definition at line 534 of file util-device.c.

References BypassInfo, and LiveDevGetStorageById().

Here is the call graph for this function:

◆ LiveDevAddBypassStats()

void LiveDevAddBypassStats	(	LiveDevice *	dev,
		uint64_t	cnt,
		int	family
	)

Increase number of currently bypassed flows for a protocol family

Parameters

dev	pointer to LiveDevice to set stats for
cnt	number of flows to add
family	AF_INET to set IPv4 count or AF_INET6 to set IPv6 count

Definition at line 496 of file util-device.c.

References BypassInfo, and LiveDevGetStorageById().

Here is the call graph for this function:

◆ LiveDevAddBypassSuccess()

void LiveDevAddBypassSuccess	(	LiveDevice *	dev,
		uint64_t	cnt,
		int	family
	)

Increase number of currently successfully bypassed flows for a protocol family

Parameters

dev	pointer to LiveDevice to set stats for
cnt	number of flows to add
family	AF_INET to set IPv4 count or AF_INET6 to set IPv6 count

Definition at line 553 of file util-device.c.

References BypassInfo, and LiveDevGetStorageById().

Here is the call graph for this function:

◆ LiveDeviceFinalize()

void LiveDeviceFinalize ( void )

Create registered devices

This function creates all needed LiveDevice from the LiveDeviceName list created via LiveRegisterDevice()

Definition at line 442 of file util-device.c.

References LiveDeviceName_::dev, LiveRegisterDevice(), next, SCFree, SCLogDebug, and TAILQ_FOREACH_SAFE.

Referenced by PostConfLoadedSetup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LiveDeviceForEach()

LiveDevice* LiveDeviceForEach	(	LiveDevice **	ldev,
		LiveDevice **	ndev
	)

Definition at line 420 of file util-device.c.

References next, TAILQ_FIRST, and TAILQ_NEXT.

◆ LiveDeviceHasNoStats()

void LiveDeviceHasNoStats ( void )

Call this function to disable stat on live devices

This can be useful in the case, this is not a real interface.

Definition at line 309 of file util-device.c.

Referenced by RunModeIpsIPFWAutoFp(), RunModeIpsIPFWWorker(), RunModeIpsNFQAutoFp(), RunModeIpsNFQWorker(), and RunModeIpsWinDivertAutoFp().

Here is the caller graph for this function:

◆ LiveDeviceListClean()

int LiveDeviceListClean ( void )

Definition at line 314 of file util-device.c.

References DPDKCloseDevice(), next, SCEnter, TAILQ_FOREACH, and TAILQ_FOREACH_SAFE.

Referenced by GlobalsDestroy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LiveDevRegisterExtension()

void LiveDevRegisterExtension ( void )

Register bypass stats storage

Definition at line 465 of file util-device.c.

Referenced by PostConfLoadedSetup().

Here is the caller graph for this function:

◆ LiveDevSubBypassStats()

void LiveDevSubBypassStats	(	LiveDevice *	dev,
		uint64_t	cnt,
		int	family
	)

Decrease number of currently bypassed flows for a protocol family

Parameters

dev	pointer to LiveDevice to set stats for
cnt	number of flows to remove
family	AF_INET to set IPv4 count or AF_INET6 to set IPv6 count

Definition at line 515 of file util-device.c.

References BypassInfo, and LiveDevGetStorageById().

Here is the call graph for this function:

◆ LiveDevUseBypass()

int LiveDevUseBypass ( LiveDevice * dev )

Prepare a LiveDevice so we can set bypass stats

Definition at line 474 of file util-device.c.

References BypassInfo, LiveDevSetStorageById(), SC_ATOMIC_INIT, SCCalloc, and SCLogError.

Here is the call graph for this function:

◆ LiveGetDevice()

LiveDevice* LiveGetDevice ( const char * name )

Get a pointer to the device at idx.

Parameters

number idx of the device in our list

Return values

ptr	pointer to the string containing the device
NULL	on error

Definition at line 248 of file util-device.c.

References LiveDevice_::dev, next, SCLogWarning, and TAILQ_FOREACH.

Referenced by LiveGetShortName(), and ReceiveErfDagThreadInit().

Here is the caller graph for this function:

◆ LiveGetDeviceCount()

int LiveGetDeviceCount ( void )

Get the number of registered devices.

Return values

cnt	the number of registered devices

Definition at line 164 of file util-device.c.

References next, and TAILQ_FOREACH.

Referenced by LiveRegisterDevice(), RunModeSetIPSAutoFp(), RunModeSetIPSWorker(), RunModeSetLiveCaptureAutoFp(), RunModeSetLiveCaptureSingle(), and RunModeSetLiveCaptureWorkers().

Here is the caller graph for this function:

◆ LiveGetDeviceName()

const char* LiveGetDeviceName ( int number )

Get a pointer to the device name at idx.

Parameters

number idx of the device in our list

Return values

ptr	pointer to the string containing the device
NULL	on error

Definition at line 184 of file util-device.c.

References LiveDevice_::dev, next, and TAILQ_FOREACH.

Referenced by RunModeSetIPSAutoFp(), RunModeSetIPSWorker(), RunModeSetLiveCaptureAutoFp(), RunModeSetLiveCaptureSingle(), and RunModeSetLiveCaptureWorkers().

Here is the caller graph for this function:

◆ LiveGetOffload()

int LiveGetOffload ( void )

Definition at line 81 of file util-device.c.

◆ LiveGetShortName()

const char* LiveGetShortName ( const char * dev )

Definition at line 266 of file util-device.c.

References LiveDevice_::dev_short, and LiveGetDevice().

Referenced by RunModeSetLiveCaptureAutoFp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LiveRegisterDevice()

int LiveRegisterDevice ( const char * dev )

Add a pcap device for monitoring and create structure.

Parameters

dev	string with the device name

Return values

0	on success.
-1	on failure.

Definition at line 126 of file util-device.c.

References LiveDevice_::dev, LiveDevStorageSize(), LiveGetDeviceCount(), SCCalloc, SCFree, SCStrdup, and unlikely.

Referenced by LiveDeviceFinalize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LiveRegisterDeviceName()

int LiveRegisterDeviceName ( const char * dev )

Add a device for monitoring.

To be used during option parsing. When a device has to be created during runmode init, use LiveRegisterDevice()

Parameters

dev	string with the device name

Return values

0	on success.
-1	on failure.

Definition at line 97 of file util-device.c.

References LiveDeviceName_::dev, next, SCCalloc, SCFree, SCLogDebug, SCStrdup, TAILQ_INSERT_TAIL, and unlikely.

Referenced by SCParseCommandLine().

Here is the caller graph for this function:

◆ LiveSetOffloadDisable()

void LiveSetOffloadDisable ( void )

Definition at line 71 of file util-device.c.

Referenced by PostConfLoadedSetup().

Here is the caller graph for this function:

◆ LiveSetOffloadWarn()

void LiveSetOffloadWarn ( void )

Definition at line 76 of file util-device.c.

Referenced by PostConfLoadedSetup().

Here is the caller graph for this function:

Variable Documentation

◆ BypassInfo

BypassInfo

Definition at line 60 of file util-device.c.

Referenced by LiveDevAddBypassFail(), LiveDevAddBypassStats(), LiveDevAddBypassSuccess(), LiveDevSubBypassStats(), and LiveDevUseBypass().

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ MAX_DEVNAME

Function Documentation

◆ LiveBuildDeviceList()

◆ LiveBuildDeviceListCustom()

◆ LiveDevAddBypassFail()

◆ LiveDevAddBypassStats()

◆ LiveDevAddBypassSuccess()

◆ LiveDeviceFinalize()

◆ LiveDeviceForEach()

◆ LiveDeviceHasNoStats()

◆ LiveDeviceListClean()

◆ LiveDevRegisterExtension()

◆ LiveDevSubBypassStats()

◆ LiveDevUseBypass()

◆ LiveGetDevice()

◆ LiveGetDeviceCount()

◆ LiveGetDeviceName()

◆ LiveGetOffload()

◆ LiveGetShortName()

◆ LiveRegisterDevice()

◆ LiveRegisterDeviceName()

◆ LiveSetOffloadDisable()

◆ LiveSetOffloadWarn()

Variable Documentation

◆ BypassInfo