Data Structures
struct	SCTimeval32_

Macros
#define	FROM_TIMEVAL(timev) { .tv_sec = (timev).tv_sec, .tv_nsec = (timev).tv_usec * 1000 }
	intialize a 'struct timespec' from a 'struct timeval'. More...

Typedefs
typedef struct SCTimeval32_	SCTimeval32

Functions
void	TimeInit (void)

void	TimeDeinit (void)

void	TimeSetByThread (const int thread_id, const struct timeval *tv)

void	TimeGet (struct timeval *)

void	TimeSet (struct timeval *)

void	TimeSetToCurrentTime (void)
	set the time to "gettimeofday" meant for testing More...

void	TimeSetIncrementTime (uint32_t)
	increment the time in the engine More...

void	TimeModeSetLive (void)

void	TimeModeSetOffline (void)

int	TimeModeIsLive (void)

struct tm *	SCLocalTime (time_t timep, struct tm *result)

void	CreateTimeString (const struct timeval ts, char str, size_t size)

void	CreateIsoTimeString (const struct timeval ts, char str, size_t size)

void	CreateUtcIsoTimeString (const struct timeval ts, char str, size_t size)

void	CreateFormattedTimeString (const struct tm t, const char fmt, char *str, size_t size)

time_t	SCMkTimeUtc (struct tm *tp)
	Convert broken-down time to seconds since Unix epoch. More...

int	SCStringPatternToTime (char string, const char patterns, int num_patterns, struct tm time)
	Parse a date string based on specified patterns. More...

int	SCTimeToStringPattern (time_t epoch, const char pattern, char str, size_t size)
	Convert epoch time to string pattern. More...

uint64_t	SCParseTimeSizeString (const char *str)
	Parse string containing time size (1m, 1h, etc). More...

uint64_t	SCGetSecondsUntil (const char *str, time_t epoch)
	Get seconds until a time unit changes. More...

uint64_t	SCTimespecAsEpochMillis (const struct timespec *ts)

Detailed Description

Author: Victor Julien victo.nosp@m.r@in.nosp@m.linia.nosp@m.c.ne.nosp@m.t

Definition in file util-time.h.

Macro Definition Documentation

#define FROM_TIMEVAL ( timev ) { .tv_sec = (timev).tv_sec, .tv_nsec = (timev).tv_usec * 1000 }

intialize a 'struct timespec' from a 'struct timeval'.

Definition at line 44 of file util-time.h.

Referenced by StatsSetUI64().

Typedef Documentation

typedef struct SCTimeval32_ SCTimeval32

A timeval with 32 bit fields.

Used by the unified on disk file format.

Function Documentation

void CreateFormattedTimeString	(	const struct tm *	t,
		const char *	fmt,
		char *	str,
		size_t	size
	)

Definition at line 219 of file util-time.c.

References likely.

Referenced by LogCustomFormatWriteTimestamp().

Here is the caller graph for this function:

void CreateIsoTimeString	(	const struct timeval *	ts,
		char *	str,
		size_t	size
	)

Definition at line 187 of file util-time.c.

References likely, and SCLocalTime().

Referenced by AlertJsonHeader(), CreateJSONHeader(), JsonAddFlow(), SCProfilingRulesGlobalInit(), SCProfilingSghsGlobalInit(), and StatsToJSON().

Here is the call graph for this function:

Here is the caller graph for this function:

void CreateTimeString	(	const struct timeval *	ts,
		char *	str,
		size_t	size
	)

Definition at line 245 of file util-time.c.

References CreateTimeString(), likely, SCLocalTime(), str, and ts.

Referenced by AlertFastLogger(), CreateTimeString(), and TLSGetIPInformations().

Here is the call graph for this function:

Here is the caller graph for this function:

void CreateUtcIsoTimeString	(	const struct timeval *	ts,
		char *	str,
		size_t	size
	)

Definition at line 203 of file util-time.c.

References likely, and SCUtcTime().

Referenced by TLSGetIPInformations().

Here is the call graph for this function:

Here is the caller graph for this function:

uint64_t SCGetSecondsUntil	(	const char *	str,
		time_t	epoch
	)

Get seconds until a time unit changes.

Parameters

str	String containing time type (minute, hour, etc).
epoch	Epoch time.

Return values

seconds.

Definition at line 597 of file util-time.c.

References SCLocalTime().

Referenced by SCConfLogOpenGeneric().

Here is the call graph for this function:

Here is the caller graph for this function:

struct tm* SCLocalTime	(	time_t	timep,
		struct tm *	result
	)

Definition at line 240 of file util-time.c.

Referenced by CreateIsoTimeString(), CreateTimeString(), LogCustomFormatWriteTimestamp(), SCGetSecondsUntil(), SCProfilingKeywordsGlobalInit(), SCProfilingPrefilterGlobalInit(), SCProfilingRulesGlobalInit(), SCProfilingSghsGlobalInit(), SCTimeToStringPattern(), SetupFPAnalyzer(), and SetupRuleAnalyzer().

Here is the caller graph for this function:

time_t SCMkTimeUtc ( struct tm * tp )

Convert broken-down time to seconds since Unix epoch.

This function is based on: http://www.catb.org/esr/time-programming (released to the public domain).

Parameters

tp	Pointer to broken-down time.

Return values

Seconds since Unix epoch.

Definition at line 418 of file util-time.c.

References MONTHSPERYEAR.

Referenced by DetectTlsValidityRegister().

Here is the caller graph for this function:

uint64_t SCParseTimeSizeString ( const char * str )

Parse string containing time size (1m, 1h, etc).

Parameters

str	String to parse.

Return values

size	on success.
0	on failure.

Definition at line 546 of file util-time.c.

Referenced by SCConfLogOpenGeneric().

Here is the caller graph for this function:

int SCStringPatternToTime	(	char *	string,
		const char **	patterns,
		int	num_patterns,
		struct tm *	tp
	)

Parse a date string based on specified patterns.

This function is based on GNU C library getdate.

Parameters

string	Date string to parse.
patterns	String array containing patterns.
num_patterns	Number of patterns to check.
tp	Pointer to broken-down time.

Return values

0	on success.
1	on failure.

Definition at line 461 of file util-time.c.

References strptime().

Referenced by DetectTlsValidityRegister().

Here is the call graph for this function:

Here is the caller graph for this function:

uint64_t SCTimespecAsEpochMillis ( const struct timespec * ts )

Definition at line 615 of file util-time.c.

Referenced by PcapDetermineDirectoryOrFile(), PcapDirectoryDispatch(), and RunModeUnixSocketGetDefaultMode().

Here is the caller graph for this function:

int SCTimeToStringPattern	(	time_t	epoch,
		const char *	pattern,
		char *	str,
		size_t	size
	)

Convert epoch time to string pattern.

This function converts epoch time to a string based on a pattern.

Parameters

epoch	Epoch time.
pattern	String pattern.
str	Formated string.
size	Size of allocated string.

Return values

0	on success.
1	on failure.

Definition at line 517 of file util-time.c.

References SCLocalTime(), strlcpy(), and unlikely.

Here is the call graph for this function:

void TimeDeinit ( void )

Definition at line 85 of file util-time.c.

References SCSpinDestroy.

Referenced by GlobalsInitPreConfig().

Here is the caller graph for this function:

void TimeGet ( struct timeval * )

Definition at line 146 of file util-time.c.

References RunmodeIsUnittests(), SCLogDebug, SCSpinLock, SCSpinUnlock, TmreadsGetMinimalTimestamp(), TRUE, and unlikely.

Referenced by DetectDetectionFilterRegister(), DetectThresholdRegister(), NoWinDivertSupportExit(), SCThresholdConfParseFile(), TagTimeoutCheck(), TimeSetIncrementTime(), TmModuleDecodePcapRegister(), TmModuleFlowRecyclerRegister(), Unified2AlertInitCtx(), UnixSocketPcapFile(), UTHBuildPacketIPV6Real(), and UTHBuildPacketReal().

Here is the call graph for this function:

Here is the caller graph for this function:

void TimeInit ( void )

Definition at line 77 of file util-time.c.

References SCSpinInit.

Referenced by GlobalsInitPreConfig().

Here is the caller graph for this function:

int TimeModeIsLive ( void )

Definition at line 102 of file util-time.c.

void TimeModeSetLive ( void )

Definition at line 90 of file util-time.c.

References SCLogDebug, and TRUE.

Referenced by RunModeIdsAFPAutoFp(), RunModeIdsAFPSingle(), RunModeIdsAFPWorkers(), RunModeIdsErfDagAutoFp(), RunModeIdsErfDagSingle(), RunModeIdsErfDagWorkers(), RunModeIdsNetmapAutoFp(), RunModeIdsNetmapSingle(), RunModeIdsNetmapWorkers(), RunModeIdsNflogAutoFp(), RunModeIdsNflogSingle(), RunModeIdsNflogWorkers(), RunModeIdsPcapAutoFp(), RunModeIdsPcapSingle(), RunModeIdsPcapWorkers(), RunModeIdsPfringAutoFp(), RunModeIdsPfringSingle(), RunModeIdsPfringWorkers(), RunModeIpsIPFWAutoFp(), RunModeIpsIPFWWorker(), RunModeIpsNFQAutoFp(), RunModeIpsNFQWorker(), RunModeIpsWinDivertAutoFp(), and RunModeNapatechRegister().

Here is the caller graph for this function:

void TimeModeSetOffline ( void )

Definition at line 96 of file util-time.c.

References FALSE, and SCLogDebug.

Referenced by RunModeErfFileAutoFp(), RunModeErfFileSingle(), RunModeFilePcapAutoFp(), RunModeFilePcapSingle(), and UtRunTests().

Here is the caller graph for this function:

void TimeSet ( struct timeval * )

Definition at line 116 of file util-time.c.

References SCLogDebug, SCSpinLock, SCSpinUnlock, and TRUE.

Referenced by TimeSetIncrementTime(), and TimeSetToCurrentTime().

Here is the caller graph for this function:

void TimeSetByThread	(	const int	thread_id,
		const struct timeval *	tv
	)

Definition at line 107 of file util-time.c.

References TmThreadsSetThreadTimestamp(), and TRUE.

Here is the call graph for this function:

void TimeSetIncrementTime ( uint32_t tv_sec )

increment the time in the engine

Parameters

tv_sec seconds to increment the time with

Definition at line 175 of file util-time.c.

References TimeGet(), and TimeSet().

Referenced by DetectDetectionFilterRegister(), DetectThresholdRegister(), FlowUpdateState(), SCThresholdConfParseFile(), TagTimeoutCheck(), TmModuleFlowRecyclerRegister(), and Unified2AlertInitCtx().

Here is the call graph for this function:

Here is the caller graph for this function:

void TimeSetToCurrentTime ( void )

set the time to "gettimeofday" meant for testing

Definition at line 135 of file util-time.c.

References TimeSet().

Referenced by UtRunTests().

Here is the call graph for this function:

Here is the caller graph for this function:

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Function Documentation