src/flow-util.h


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

/* Copyright (C) 2007-2012 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 Victor Julien <victor@inliniac.net>
 */

#ifndef __FLOW_UTIL_H__
#define __FLOW_UTIL_H__

#include "flow.h"
#include "stream-tcp-private.h"

#define RESET_COUNTERS(f)                                                                          \
    do {                                                                                           \
        (f)->todstpktcnt = 0;                                                                      \
        (f)->tosrcpktcnt = 0;                                                                      \
        (f)->todstbytecnt = 0;                                                                     \
        (f)->tosrcbytecnt = 0;                                                                     \
    } while (0)

#define FLOW_INITIALIZE(f)                                                                         \
    do {                                                                                           \
        (f)->sp = 0;                                                                               \
        (f)->dp = 0;                                                                               \
        (f)->proto = 0;                                                                            \
        (f)->livedev = NULL;                                                                       \
        (f)->timeout_at = 0;                                                                       \
        (f)->timeout_policy = 0;                                                                   \
        (f)->vlan_idx = 0;                                                                         \
        (f)->next = NULL;                                                                          \
        (f)->flow_state = 0;                                                                       \
        (f)->tenant_id = 0;                                                                        \
        (f)->parent_id = 0;                                                                        \
        (f)->probing_parser_toserver_alproto_masks = 0;                                            \
        (f)->probing_parser_toclient_alproto_masks = 0;                                            \
        (f)->flags = 0;                                                                            \
        (f)->file_flags = 0;                                                                       \
        (f)->protodetect_dp = 0;                                                                   \
        SCTIME_INIT((f)->lastts);                                                                  \
        FLOWLOCK_INIT((f));                                                                        \
        (f)->protoctx = NULL;                                                                      \
        (f)->flow_end_flags = 0;                                                                   \
        (f)->alproto = 0;                                                                          \
        (f)->alproto_ts = 0;                                                                       \
        (f)->alproto_tc = 0;                                                                       \
        (f)->alproto_orig = 0;                                                                     \
        (f)->alproto_expect = 0;                                                                   \
        (f)->de_ctx_version = 0;                                                                   \
        (f)->thread_id[0] = 0;                                                                     \
        (f)->thread_id[1] = 0;                                                                     \
        (f)->alparser = NULL;                                                                      \
        (f)->alstate = NULL;                                                                       \
        (f)->sgh_toserver = NULL;                                                                  \
        (f)->sgh_toclient = NULL;                                                                  \
        (f)->flowvar = NULL;                                                                       \
        RESET_COUNTERS((f));                                                                       \
    } while (0)

/** \brief macro to recycle a flow before it goes into the spare queue for reuse.
 *
 *  Note that the lnext, lprev, hnext fields are untouched, those are
 *  managed by the queueing code. Same goes for fb (FlowBucket ptr) field.
 */
#define FLOW_RECYCLE(f)                                                                            \
    do {                                                                                           \
        FlowCleanupAppLayer((f));                                                                  \
        (f)->sp = 0;                                                                               \
        (f)->dp = 0;                                                                               \
        (f)->proto = 0;                                                                            \
        (f)->livedev = NULL;                                                                       \
        (f)->vlan_idx = 0;                                                                         \
        (f)->ffr = 0;                                                                              \
        (f)->next = NULL;                                                                          \
        (f)->timeout_at = 0;                                                                       \
        (f)->timeout_policy = 0;                                                                   \
        (f)->flow_state = 0;                                                                       \
        (f)->tenant_id = 0;                                                                        \
        (f)->parent_id = 0;                                                                        \
        (f)->probing_parser_toserver_alproto_masks = 0;                                            \
        (f)->probing_parser_toclient_alproto_masks = 0;                                            \
        (f)->flags = 0;                                                                            \
        (f)->file_flags = 0;                                                                       \
        (f)->protodetect_dp = 0;                                                                   \
        SCTIME_INIT((f)->lastts);                                                                  \
        (f)->protoctx = NULL;                                                                      \
        (f)->flow_end_flags = 0;                                                                   \
        (f)->alparser = NULL;                                                                      \
        (f)->alstate = NULL;                                                                       \
        (f)->alproto = 0;                                                                          \
        (f)->alproto_ts = 0;                                                                       \
        (f)->alproto_tc = 0;                                                                       \
        (f)->alproto_orig = 0;                                                                     \
        (f)->alproto_expect = 0;                                                                   \
        (f)->de_ctx_version = 0;                                                                   \
        (f)->thread_id[0] = 0;                                                                     \
        (f)->thread_id[1] = 0;                                                                     \
        (f)->sgh_toserver = NULL;                                                                  \
        (f)->sgh_toclient = NULL;                                                                  \
        GenericVarFree((f)->flowvar);                                                              \
        (f)->flowvar = NULL;                                                                       \
        RESET_COUNTERS((f));                                                                       \
    } while (0)

#define FLOW_DESTROY(f)                                                                            \
    do {                                                                                           \
        FlowCleanupAppLayer((f));                                                                  \
                                                                                                   \
        FLOWLOCK_DESTROY((f));                                                                     \
        GenericVarFree((f)->flowvar);                                                              \
    } while (0)

/** \brief check if a memory alloc would fit in the memcap
 *
 *  \param size memory allocation size to check
 *
 *  \retval 1 it fits
 *  \retval 0 no fit
 */
#define FLOW_CHECK_MEMCAP(size)                                                                    \
    ((((uint64_t)SC_ATOMIC_GET(flow_memuse) + (uint64_t)(size)) <=                                 \
            SC_ATOMIC_GET(flow_config.memcap)))

Flow *FlowAlloc(void);
void FlowFree(Flow *);
uint8_t FlowGetProtoMapping(uint8_t);
void FlowInit(Flow *, const Packet *);
uint8_t FlowGetReverseProtoMapping(uint8_t rproto);

/* flow end counter logic */

typedef struct FlowEndCounters_ {
    uint16_t flow_state[FLOW_STATE_SIZE];
    uint16_t flow_tcp_state[TCP_CLOSED + 1];
    uint16_t flow_tcp_liberal;
} FlowEndCounters;

static inline void FlowEndCountersUpdate(ThreadVars *tv, FlowEndCounters *fec, Flow *f)
{
    if (f->proto == IPPROTO_TCP && f->protoctx != NULL) {
        TcpSession *ssn = f->protoctx;
        StatsIncr(tv, fec->flow_tcp_state[ssn->state]);
        if (ssn->flags & STREAMTCP_FLAG_LOSSY_BE_LIBERAL) {
            StatsIncr(tv, fec->flow_tcp_liberal);
        }
    }
    StatsIncr(tv, fec->flow_state[f->flow_state]);
}

void FlowEndCountersRegister(ThreadVars *t, FlowEndCounters *fec);

#endif /* __FLOW_UTIL_H__ */