suricata
host-queue.h
Go to the documentation of this file.
1 /* Copyright (C) 2007-2012 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 /**
19  * \file
20  *
21  * \author Victor Julien <victor@inliniac.net>
22  */
23 
24 #ifndef __HOST_QUEUE_H__
25 #define __HOST_QUEUE_H__
26 
27 #include "suricata-common.h"
28 #include "host.h"
29 
30 /** Spinlocks or Mutex for the host queues. */
31 //#define HQLOCK_SPIN
32 #define HQLOCK_MUTEX
33 
34 #ifdef HQLOCK_SPIN
35  #ifdef HQLOCK_MUTEX
36  #error Cannot enable both HQLOCK_SPIN and HQLOCK_MUTEX
37  #endif
38 #endif
39 
40 /* Define a queue for storing hosts */
41 typedef struct HostQueue_
42 {
45  uint32_t len;
46 #ifdef DBG_PERF
47  uint32_t dbg_maxlen;
48 #endif /* DBG_PERF */
49 #ifdef HQLOCK_MUTEX
51 #elif defined HQLOCK_SPIN
52  SCSpinlock s;
53 #else
54  #error Enable HQLOCK_SPIN or HQLOCK_MUTEX
55 #endif
56 } HostQueue;
57 
58 #ifdef HQLOCK_SPIN
59  #define HQLOCK_INIT(q) SCSpinInit(&(q)->s, 0)
60  #define HQLOCK_DESTROY(q) SCSpinDestroy(&(q)->s)
61  #define HQLOCK_LOCK(q) SCSpinLock(&(q)->s)
62  #define HQLOCK_TRYLOCK(q) SCSpinTrylock(&(q)->s)
63  #define HQLOCK_UNLOCK(q) SCSpinUnlock(&(q)->s)
64 #elif defined HQLOCK_MUTEX
65  #define HQLOCK_INIT(q) SCMutexInit(&(q)->m, NULL)
66  #define HQLOCK_DESTROY(q) SCMutexDestroy(&(q)->m)
67  #define HQLOCK_LOCK(q) SCMutexLock(&(q)->m)
68  #define HQLOCK_TRYLOCK(q) SCMutexTrylock(&(q)->m)
69  #define HQLOCK_UNLOCK(q) SCMutexUnlock(&(q)->m)
70 #else
71  #error Enable HQLOCK_SPIN or HQLOCK_MUTEX
72 #endif
73 
74 /* prototypes */
75 HostQueue *HostQueueNew(void);
78 
79 void HostEnqueue (HostQueue *, Host *);
81 uint32_t HostQueueLen(HostQueue *);
82 
83 #endif /* __HOST_QUEUE_H__ */
84 
struct HostQueue_ HostQueue
uint32_t HostQueueLen(HostQueue *)
Definition: host-queue.c:136
Host * top
Definition: host-queue.h:43
HostQueue * HostQueueInit(HostQueue *)
Definition: host-queue.c:34
Host * bot
Definition: host-queue.h:44
HostQueue * HostQueueNew(void)
Definition: host-queue.c:43
void HostEnqueue(HostQueue *, Host *)
add a host to a queue
Definition: host-queue.c:70
#define SCSpinlock
Host * HostDequeue(HostQueue *)
remove a host from the queue
Definition: host-queue.c:103
Definition: host.h:58
void HostQueueDestroy(HostQueue *)
Destroy a host queue.
Definition: host-queue.c:59
#define SCMutex
SCMutex m
Definition: host-queue.h:50
uint32_t len
Definition: host-queue.h:45