mirror of https://github.com/OISF/suricata
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
152 lines
4.9 KiB
C
152 lines
4.9 KiB
C
/* Copyright (C) 2007-2015 Open Information Security Foundation
|
|
*
|
|
* You can copy, redistribute or modify this Program under the terms of
|
|
* the GNU General Public License version 2 as published by the Free
|
|
* Software Foundation.
|
|
*
|
|
* 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
|
|
* version 2 along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
* 02110-1301, USA.
|
|
*/
|
|
|
|
/**
|
|
* \file
|
|
*
|
|
* \author Anoop Saldanha <anoopsaldanha@gmail.com>
|
|
* \author Victor Julien <victor@inliniac.net>
|
|
*/
|
|
|
|
#ifndef __COUNTERS_H__
|
|
#define __COUNTERS_H__
|
|
|
|
/* forward declaration of the ThreadVars structure */
|
|
struct ThreadVars_;
|
|
|
|
/**
|
|
* \brief Container to hold the counter variable
|
|
*/
|
|
typedef struct StatsCounter_ {
|
|
int type;
|
|
|
|
/* local id for this counter in this thread */
|
|
uint16_t id;
|
|
|
|
/* global id, used in output */
|
|
uint16_t gid;
|
|
|
|
/* counter value(s): copies from the 'private' counter */
|
|
uint64_t value; /**< sum of updates/increments, or 'set' value */
|
|
uint64_t updates; /**< number of updates (for avg) */
|
|
|
|
/* when using type STATS_TYPE_Q_FUNC this function is called once
|
|
* to get the counter value, regardless of how many threads there are. */
|
|
uint64_t (*Func)(void);
|
|
|
|
/* name of the counter */
|
|
const char *name;
|
|
|
|
/* the next perfcounter for this tv's tm instance */
|
|
struct StatsCounter_ *next;
|
|
} StatsCounter;
|
|
|
|
/**
|
|
* \brief Stats Context for a ThreadVars instance
|
|
*/
|
|
typedef struct StatsPublicThreadContext_ {
|
|
/* flag set by the wakeup thread, to inform the client threads to sync */
|
|
uint32_t perf_flag;
|
|
|
|
/* pointer to the head of a list of counters assigned under this context */
|
|
StatsCounter *head;
|
|
|
|
/* holds the total no of counters already assigned for this perf context */
|
|
uint16_t curr_id;
|
|
|
|
/* mutex to prevent simultaneous access during update_counter/output_stat */
|
|
SCMutex m;
|
|
} StatsPublicThreadContext;
|
|
|
|
/**
|
|
* \brief Storage for local counters, with a link to the public counter used
|
|
* for syncs
|
|
*/
|
|
typedef struct StatsLocalCounter_ {
|
|
/* pointer to the counter that corresponds to this local counter */
|
|
StatsCounter *pc;
|
|
|
|
/* local counter id of the above counter */
|
|
uint16_t id;
|
|
|
|
/* total value of the adds/increments, or exact value in case of 'set' */
|
|
uint64_t value;
|
|
|
|
/* no of times the local counter has been updated */
|
|
uint64_t updates;
|
|
} StatsLocalCounter;
|
|
|
|
/**
|
|
* \brief used to hold the private version of the counters registered
|
|
*/
|
|
typedef struct StatsPrivateThreadContext_ {
|
|
/* points to the array holding local counters */
|
|
StatsLocalCounter *head;
|
|
|
|
/* size of head array in elements */
|
|
uint32_t size;
|
|
|
|
int initialized;
|
|
} StatsPrivateThreadContext;
|
|
|
|
/* the initialization functions */
|
|
void StatsInit(void);
|
|
void StatsSetupPostConfigPreOutput(void);
|
|
void StatsSetupPostConfigPostOutput(void);
|
|
void StatsSpawnThreads(void);
|
|
void StatsRegisterTests(void);
|
|
bool StatsEnabled(void);
|
|
|
|
/* functions used to free the resources alloted by the Stats API */
|
|
void StatsReleaseResources(void);
|
|
|
|
/* counter registration functions */
|
|
uint16_t StatsRegisterCounter(const char *, struct ThreadVars_ *);
|
|
uint16_t StatsRegisterAvgCounter(const char *, struct ThreadVars_ *);
|
|
uint16_t StatsRegisterMaxCounter(const char *, struct ThreadVars_ *);
|
|
uint16_t StatsRegisterGlobalCounter(const char *cname, uint64_t (*Func)(void));
|
|
|
|
/* functions used to update local counter values */
|
|
void StatsAddUI64(struct ThreadVars_ *, uint16_t, uint64_t);
|
|
void StatsSetUI64(struct ThreadVars_ *, uint16_t, uint64_t);
|
|
void StatsIncr(struct ThreadVars_ *, uint16_t);
|
|
|
|
/* utility functions */
|
|
int StatsUpdateCounterArray(StatsPrivateThreadContext *, StatsPublicThreadContext *);
|
|
uint64_t StatsGetLocalCounterValue(struct ThreadVars_ *, uint16_t);
|
|
int StatsSetupPrivate(struct ThreadVars_ *);
|
|
void StatsThreadCleanup(struct ThreadVars_ *);
|
|
|
|
#define StatsSyncCounters(tv) \
|
|
StatsUpdateCounterArray(&(tv)->perf_private_ctx, &(tv)->perf_public_ctx); \
|
|
|
|
#define StatsSyncCountersIfSignalled(tv) \
|
|
do { \
|
|
if ((tv)->perf_public_ctx.perf_flag == 1) { \
|
|
StatsUpdateCounterArray(&(tv)->perf_private_ctx, \
|
|
&(tv)->perf_public_ctx); \
|
|
} \
|
|
} while (0)
|
|
|
|
#ifdef BUILD_UNIX_SOCKET
|
|
TmEcode StatsOutputCounterSocket(json_t *cmd,
|
|
json_t *answer, void *data);
|
|
#endif
|
|
|
|
#endif /* __COUNTERS_H__ */
|
|
|