2 * Copyright (c) 2010-2011 Alexander V. Chernikov <melifaro@ipfw.ru>
3 * Copyright (c) 2004-2005 Gleb Smirnoff <glebius@FreeBSD.org>
4 * Copyright (c) 2001-2003 Roman V. Palagin <romanp@unshadow.net>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * $SourceForge: ng_netflow.h,v 1.26 2004/09/04 15:44:55 glebius Exp $
32 #ifndef _NG_NETFLOW_H_
33 #define _NG_NETFLOW_H_
35 #define NG_NETFLOW_NODE_TYPE "netflow"
36 #define NGM_NETFLOW_COOKIE 1365756954
37 #define NGM_NETFLOW_V9_COOKIE 1349865386
39 #define NG_NETFLOW_MAXIFACES USHRT_MAX
43 #define NG_NETFLOW_HOOK_DATA "iface"
44 #define NG_NETFLOW_HOOK_OUT "out"
45 #define NG_NETFLOW_HOOK_EXPORT "export"
46 #define NG_NETFLOW_HOOK_EXPORT9 "export9"
48 /* This define effectively disable (v5) netflow export hook! */
49 /* #define COUNTERS_64 */
51 /* Netgraph commands understood by netflow node */
53 NGM_NETFLOW_INFO = 1|NGM_READONLY|NGM_HASREPLY, /* get node info */
54 NGM_NETFLOW_IFINFO = 2|NGM_READONLY|NGM_HASREPLY, /* get iface info */
55 NGM_NETFLOW_SHOW = 3|NGM_READONLY|NGM_HASREPLY, /* show ip cache flow */
56 NGM_NETFLOW_SETDLT = 4, /* set data-link type */
57 NGM_NETFLOW_SETIFINDEX = 5, /* set interface index */
58 NGM_NETFLOW_SETTIMEOUTS = 6, /* set active/inactive flow timeouts */
59 NGM_NETFLOW_SETCONFIG = 7, /* set flow generation options */
60 NGM_NETFLOW_SETTEMPLATE = 8, /* set v9 flow template periodic */
61 NGM_NETFLOW_SETMTU = 9, /* set outgoing interface MTU */
62 NGM_NETFLOW_V9INFO = 10|NGM_READONLY|NGM_HASREPLY, /* get v9 info */
65 /* This structure is returned by the NGM_NETFLOW_INFO message */
66 struct ng_netflow_info {
67 uint64_t nfinfo_bytes; /* accounted IPv4 bytes */
68 uint64_t nfinfo_packets; /* accounted IPv4 packets */
69 uint64_t nfinfo_bytes6; /* accounted IPv6 bytes */
70 uint64_t nfinfo_packets6; /* accounted IPv6 packets */
71 uint64_t nfinfo_sbytes; /* skipped IPv4 bytes */
72 uint64_t nfinfo_spackets; /* skipped IPv4 packets */
73 uint64_t nfinfo_sbytes6; /* skipped IPv6 bytes */
74 uint64_t nfinfo_spackets6; /* skipped IPv6 packets */
75 uint64_t nfinfo_act_exp; /* active expiries */
76 uint64_t nfinfo_inact_exp; /* inactive expiries */
77 uint32_t nfinfo_used; /* used cache records */
78 uint32_t nfinfo_used6; /* used IPv6 cache records */
79 uint32_t nfinfo_alloc_failed; /* failed allocations */
80 uint32_t nfinfo_export_failed; /* failed exports */
81 uint32_t nfinfo_export9_failed; /* failed exports */
82 uint32_t nfinfo_realloc_mbuf; /* reallocated mbufs */
83 uint32_t nfinfo_alloc_fibs; /* fibs allocated */
84 uint32_t nfinfo_inact_t; /* flow inactive timeout */
85 uint32_t nfinfo_act_t; /* flow active timeout */
88 /* Parse the info structure */
89 #define NG_NETFLOW_INFO_TYPE { \
90 { "IPv4 bytes", &ng_parse_uint64_type },\
91 { "IPv4 packets", &ng_parse_uint64_type },\
92 { "IPv6 bytes", &ng_parse_uint64_type },\
93 { "IPv6 packets", &ng_parse_uint64_type },\
94 { "IPv4 skipped bytes", &ng_parse_uint64_type },\
95 { "IPv4 skipped packets", &ng_parse_uint64_type },\
96 { "IPv6 skipped bytes", &ng_parse_uint64_type },\
97 { "IPv6 skipped packets", &ng_parse_uint64_type },\
98 { "Active expiries", &ng_parse_uint64_type },\
99 { "Inactive expiries", &ng_parse_uint64_type },\
100 { "IPv4 records used", &ng_parse_uint32_type },\
101 { "IPv6 records used", &ng_parse_uint32_type },\
102 { "Failed allocations", &ng_parse_uint32_type },\
103 { "V5 failed exports", &ng_parse_uint32_type },\
104 { "V9 failed exports", &ng_parse_uint32_type },\
105 { "mbuf reallocations", &ng_parse_uint32_type },\
106 { "fibs allocated", &ng_parse_uint32_type },\
107 { "Inactive timeout", &ng_parse_uint32_type },\
108 { "Active timeout", &ng_parse_uint32_type },\
113 /* This structure is returned by the NGM_NETFLOW_IFINFO message */
114 struct ng_netflow_ifinfo {
115 uint32_t ifinfo_packets; /* number of packets for this iface */
116 uint8_t ifinfo_dlt; /* Data Link Type, DLT_XXX */
117 #define MAXDLTNAMELEN 20
118 uint16_t ifinfo_index; /* connected iface index */
123 /* This structure is passed to NGM_NETFLOW_SETDLT message */
124 struct ng_netflow_setdlt {
125 uint16_t iface; /* which iface dlt change */
126 uint8_t dlt; /* DLT_XXX from bpf.h */
129 /* This structure is passed to NGM_NETFLOW_SETIFINDEX */
130 struct ng_netflow_setifindex {
131 uint16_t iface; /* which iface index change */
132 uint16_t index; /* new index */
135 /* This structure is passed to NGM_NETFLOW_SETTIMEOUTS */
136 struct ng_netflow_settimeouts {
137 uint32_t inactive_timeout; /* flow inactive timeout */
138 uint32_t active_timeout; /* flow active timeout */
141 #define NG_NETFLOW_CONF_INGRESS 0x01 /* Account on ingress */
142 #define NG_NETFLOW_CONF_EGRESS 0x02 /* Account on egress */
143 #define NG_NETFLOW_CONF_ONCE 0x04 /* Add tag to account only once */
144 #define NG_NETFLOW_CONF_THISONCE 0x08 /* Account once in current node */
145 #define NG_NETFLOW_CONF_NOSRCLOOKUP 0x10 /* No radix lookup on src */
146 #define NG_NETFLOW_CONF_NODSTLOOKUP 0x20 /* No radix lookup on dst */
148 #define NG_NETFLOW_IS_FRAG 0x01
149 #define NG_NETFLOW_FLOW_FLAGS (NG_NETFLOW_CONF_NOSRCLOOKUP|\
150 NG_NETFLOW_CONF_NODSTLOOKUP)
152 /* This structure is passed to NGM_NETFLOW_SETCONFIG */
153 struct ng_netflow_setconfig {
154 uint16_t iface; /* which iface config change */
155 uint32_t conf; /* new config */
158 /* This structure is passed to NGM_NETFLOW_SETTEMPLATE */
159 struct ng_netflow_settemplate {
160 uint16_t time; /* max time between announce */
161 uint16_t packets; /* max packets between announce */
164 /* This structure is passed to NGM_NETFLOW_SETMTU */
165 struct ng_netflow_setmtu {
166 uint16_t mtu; /* MTU for packet */
169 /* This structure is used in NGM_NETFLOW_SHOW request/response */
170 struct ngnf_show_header {
171 u_char version; /* IPv4 or IPv6 */
172 uint32_t hash_id; /* current hash index */
173 uint32_t list_id; /* current record number in hash */
174 uint32_t nentries; /* number of records in response */
177 /* This structure is used in NGM_NETFLOW_V9INFO message */
178 struct ng_netflow_v9info {
179 uint16_t templ_packets; /* v9 template packets */
180 uint16_t templ_time; /* v9 template time */
181 uint16_t mtu; /* v9 MTU */
185 * Somewhere flow_rec6 is casted to flow_rec, and flow6_entry_data is
186 * casted to flow_entry_data. After casting, fle->r.fib is accessed.
187 * So beginning of these structs up to fib should be kept common.
190 /* This is unique data, which identifies flow */
194 struct in_addr r_src;
195 struct in_addr r_dst;
198 uint16_t s_port; /* source TCP/UDP port */
199 uint16_t d_port; /* destination TCP/UDP port */
205 u_char prot; /* IP protocol */
206 u_char tos; /* IP TOS */
207 uint16_t i_ifx; /* input interface index */
213 /* This is unique data, which identifies flow */
218 struct in_addr r_src;
219 struct in6_addr r_src6;
222 struct in_addr r_dst;
223 struct in6_addr r_dst6;
227 uint16_t s_port; /* source TCP/UDP port */
228 uint16_t d_port; /* destination TCP/UDP port */
234 u_char prot; /* IP protocol */
235 u_char tos; /* IP TOS */
236 uint16_t i_ifx; /* input interface index */
242 #define r_ip_p misc.i.prot
243 #define r_tos misc.i.tos
244 #define r_i_ifx misc.i.i_ifx
245 #define r_misc misc.all
246 #define r_ports ports.both
247 #define r_sport ports.dir.s_port
248 #define r_dport ports.dir.d_port
250 /* A flow entry which accumulates statistics */
251 struct flow_entry_data {
252 uint16_t version; /* Protocol version */
254 struct in_addr next_hop;
255 uint16_t fle_o_ifx; /* output interface index */
256 #define fle_i_ifx r.misc.i.i_ifx
257 uint8_t dst_mask; /* destination route mask bits */
258 uint8_t src_mask; /* source route mask bits */
261 long first; /* uptime on first packet */
262 long last; /* uptime on last packet */
263 u_char tcp_flags; /* cumulative OR */
266 struct flow6_entry_data {
267 uint16_t version; /* Protocol version */
270 struct in_addr next_hop;
271 struct in6_addr next_hop6;
273 uint16_t fle_o_ifx; /* output interface index */
274 #define fle_i_ifx r.misc.i.i_ifx
275 uint8_t dst_mask; /* destination route mask bits */
276 uint8_t src_mask; /* source route mask bits */
279 long first; /* uptime on first packet */
280 long last; /* uptime on last packet */
281 u_char tcp_flags; /* cumulative OR */
285 * How many flow records we will transfer at once
286 * without overflowing socket receive buffer
288 #define NREC_AT_ONCE 1000
289 #define NREC6_AT_ONCE (NREC_AT_ONCE * sizeof(struct flow_entry_data) / \
290 sizeof(struct flow6_entry_data))
291 #define NGRESP_SIZE (sizeof(struct ngnf_show_header) + (NREC_AT_ONCE * \
292 sizeof(struct flow_entry_data)))
293 #define SORCVBUF_SIZE (NGRESP_SIZE + 2 * sizeof(struct ng_mesg))
295 /* Everything below is for kernel */
300 TAILQ_ENTRY(flow_entry) fle_hash; /* entries in hash slot */
301 struct flow_entry_data f;
305 TAILQ_ENTRY(flow_entry) fle_hash; /* entries in hash slot */
306 struct flow6_entry_data f;
308 /* Parsing declarations */
310 /* Parse the ifinfo structure */
311 #define NG_NETFLOW_IFINFO_TYPE { \
312 { "packets", &ng_parse_uint32_type },\
313 { "data link type", &ng_parse_uint8_type }, \
314 { "index", &ng_parse_uint16_type },\
315 { "conf", &ng_parse_uint32_type },\
319 /* Parse the setdlt structure */
320 #define NG_NETFLOW_SETDLT_TYPE { \
321 { "iface", &ng_parse_uint16_type }, \
322 { "dlt", &ng_parse_uint8_type }, \
326 /* Parse the setifindex structure */
327 #define NG_NETFLOW_SETIFINDEX_TYPE { \
328 { "iface", &ng_parse_uint16_type }, \
329 { "index", &ng_parse_uint16_type }, \
333 /* Parse the settimeouts structure */
334 #define NG_NETFLOW_SETTIMEOUTS_TYPE { \
335 { "inactive", &ng_parse_uint32_type }, \
336 { "active", &ng_parse_uint32_type }, \
340 /* Parse the setifindex structure */
341 #define NG_NETFLOW_SETCONFIG_TYPE { \
342 { "iface", &ng_parse_uint16_type }, \
343 { "conf", &ng_parse_uint32_type }, \
347 /* Parse the settemplate structure */
348 #define NG_NETFLOW_SETTEMPLATE_TYPE { \
349 { "time", &ng_parse_uint16_type }, \
350 { "packets", &ng_parse_uint16_type }, \
354 /* Parse the setmtu structure */
355 #define NG_NETFLOW_SETMTU_TYPE { \
356 { "mtu", &ng_parse_uint16_type }, \
360 /* Parse the v9info structure */
361 #define NG_NETFLOW_V9INFO_TYPE { \
362 { "v9 template packets", &ng_parse_uint16_type },\
363 { "v9 template time", &ng_parse_uint16_type },\
364 { "v9 MTU", &ng_parse_uint16_type },\
368 /* Private hook data */
369 struct ng_netflow_iface {
370 hook_p hook; /* NULL when disconnected */
371 hook_p out; /* NULL when no bypass hook */
372 struct ng_netflow_ifinfo info;
375 typedef struct ng_netflow_iface *iface_p;
376 typedef struct ng_netflow_ifinfo *ifinfo_p;
378 struct netflow_export_item {
381 struct netflow_v9_packet_opt *item9_opt;
384 /* Structure contatining fib-specific data */
386 uint32_t fib; /* kernel fib id */
388 /* Various data used for export */
389 struct netflow_export_item exp;
391 struct mtx export_mtx; /* exp.item mutex */
392 struct mtx export9_mtx; /* exp.item9 mutex */
393 uint32_t flow_seq; /* current V5 flow sequence */
394 uint32_t flow9_seq; /* current V9 flow sequence */
395 uint32_t domain_id; /* Observartion domain id */
396 /* Netflow V9 counters */
397 uint32_t templ_last_ts; /* unixtime of last template announce */
398 uint32_t templ_last_pkt; /* packet count on last announce */
399 uint32_t sent_packets; /* packets sent by exporter; */
401 /* Current packet specific options */
402 struct netflow_v9_packet_opt *export9_opt;
405 typedef struct fib_export *fib_export_p;
407 /* Structure describing our flow engine */
409 node_p node; /* link to the node itself */
410 hook_p export; /* export data goes there */
411 hook_p export9; /* Netflow V9 export data goes there */
412 struct callout exp_callout; /* expiry periodic job */
415 * Flow entries are allocated in uma(9) zone zone. They are
416 * indexed by hash hash. Each hash element consist of tailqueue
417 * head and mutex to protect this element.
419 #define CACHESIZE (65536*16)
420 #define CACHELOWAT (CACHESIZE * 3/4)
421 #define CACHEHIGHWAT (CACHESIZE * 9/10)
423 struct flow_hash_entry *hash;
426 * NetFlow data export
428 * export_item is a data item, it has an mbuf with cluster
429 * attached to it. A thread detaches export_item from priv
430 * and works with it. If the export is full it is sent, and
431 * a new one is allocated. Before exiting thread re-attaches
432 * its current item back to priv. If there is item already,
433 * current incomplete datagram is sent.
434 * export_mtx is used for attaching/detaching.
440 struct flow_hash_entry *hash6;
444 counter_u64_t nfinfo_bytes; /* accounted IPv4 bytes */
445 counter_u64_t nfinfo_packets; /* accounted IPv4 packets */
446 counter_u64_t nfinfo_bytes6; /* accounted IPv6 bytes */
447 counter_u64_t nfinfo_packets6; /* accounted IPv6 packets */
448 counter_u64_t nfinfo_sbytes; /* skipped IPv4 bytes */
449 counter_u64_t nfinfo_spackets; /* skipped IPv4 packets */
450 counter_u64_t nfinfo_sbytes6; /* skipped IPv6 bytes */
451 counter_u64_t nfinfo_spackets6; /* skipped IPv6 packets */
452 counter_u64_t nfinfo_act_exp; /* active expiries */
453 counter_u64_t nfinfo_inact_exp; /* inactive expiries */
454 uint32_t nfinfo_alloc_failed; /* failed allocations */
455 uint32_t nfinfo_export_failed; /* failed exports */
456 uint32_t nfinfo_export9_failed; /* failed exports */
457 uint32_t nfinfo_realloc_mbuf; /* reallocated mbufs */
458 uint32_t nfinfo_alloc_fibs; /* fibs allocated */
459 uint32_t nfinfo_inact_t; /* flow inactive timeout */
460 uint32_t nfinfo_act_t; /* flow active timeout */
462 /* Multiple FIB support */
463 fib_export_p *fib_data; /* vector to per-fib data */
464 uint16_t maxfibs; /* number of allocated fibs */
466 /* Netflow v9 configuration options */
468 * RFC 3954 clause 7.3
469 * "Both options MUST be configurable by the user on the Exporter."
471 uint16_t templ_time; /* time between sending templates */
472 uint16_t templ_packets; /* packets between sending templates */
473 #define NETFLOW_V9_MAX_FLOWSETS 2
474 u_char flowsets_count; /* current flowsets used */
476 /* Count of records in each flowset */
477 u_char flowset_records[NETFLOW_V9_MAX_FLOWSETS - 1];
478 uint16_t mtu; /* export interface MTU */
480 /* Pointers to pre-compiled flowsets */
481 struct netflow_v9_flowset_header
482 *v9_flowsets[NETFLOW_V9_MAX_FLOWSETS - 1];
484 struct ng_netflow_iface ifaces[NG_NETFLOW_MAXIFACES];
487 typedef struct netflow *priv_p;
489 /* Header of a small list in hash cell */
490 struct flow_hash_entry {
492 TAILQ_HEAD(fhead, flow_entry) head;
495 #define ERROUT(x) { error = (x); goto done; }
497 #define MTAG_NETFLOW 1221656444
498 #define MTAG_NETFLOW_CALLED 0
500 #define m_pktlen(m) ((m)->m_pkthdr.len)
503 #define priv_to_fib(priv, fib) (priv)->fib_data[(fib)]
506 * Cisco uses milliseconds for uptime. Bad idea, since it overflows
507 * every 48+ days. But we will do same to keep compatibility. This macro
508 * does overflowable multiplication to 1000.
510 #define MILLIUPTIME(t) (((t) << 9) + /* 512 */ \
511 ((t) << 8) + /* 256 */ \
512 ((t) << 7) + /* 128 */ \
513 ((t) << 6) + /* 64 */ \
514 ((t) << 5) + /* 32 */ \
517 /* Prototypes for netflow.c */
518 void ng_netflow_cache_init(priv_p);
519 void ng_netflow_cache_flush(priv_p);
520 int ng_netflow_fib_init(priv_p priv, int fib);
521 void ng_netflow_copyinfo(priv_p, struct ng_netflow_info *);
522 void ng_netflow_copyv9info(priv_p, struct ng_netflow_v9info *);
523 timeout_t ng_netflow_expire;
524 int ng_netflow_flow_add(priv_p, fib_export_p, struct ip *, caddr_t,
525 uint8_t, uint8_t, unsigned int);
526 int ng_netflow_flow6_add(priv_p, fib_export_p, struct ip6_hdr *, caddr_t,
527 uint8_t, uint8_t, unsigned int);
528 int ng_netflow_flow_show(priv_p, struct ngnf_show_header *req,
529 struct ngnf_show_header *resp);
530 void ng_netflow_v9_cache_init(priv_p);
531 void ng_netflow_v9_cache_flush(priv_p);
532 item_p get_export9_dgram(priv_p, fib_export_p,
533 struct netflow_v9_packet_opt **);
534 void return_export9_dgram(priv_p, fib_export_p, item_p,
535 struct netflow_v9_packet_opt *, int);
536 int export9_add(item_p, struct netflow_v9_packet_opt *,
537 struct flow_entry *);
538 int export9_send(priv_p, fib_export_p, item_p,
539 struct netflow_v9_packet_opt *, int);
542 #endif /* _NG_NETFLOW_H_ */