2 * Copyright (c) 2008, 2009, 2010, 2011 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #ifndef OFPROTO_NETFLOW_H
18 #define OFPROTO_NETFLOW_H 1
24 /* Default active timeout interval, in seconds.
26 * (The active timeout interval is the interval at which NetFlow records are
27 * sent for flows that do not expire, so that such flows are still
29 #define NF_ACTIVE_TIMEOUT_DEFAULT 600
33 struct netflow_options {
34 struct sset collectors;
41 enum netflow_output_ports {
42 NF_OUT_FLOOD = UINT16_MAX,
43 NF_OUT_MULTI = UINT16_MAX - 1,
44 NF_OUT_DROP = UINT16_MAX - 2
48 long long int last_expired; /* Time this flow last timed out. */
49 long long int created; /* Time flow was created since time out. */
51 uint64_t packet_count_off; /* Packet count at last time out. */
52 uint64_t byte_count_off; /* Byte count at last time out. */
54 uint16_t output_iface; /* Output interface index. */
55 uint8_t tcp_flags; /* Bitwise-OR of all TCP flags seen. */
58 struct netflow *netflow_create(void);
59 void netflow_destroy(struct netflow *);
60 int netflow_set_options(struct netflow *, const struct netflow_options *);
61 void netflow_expire(struct netflow *, struct netflow_flow *,
64 bool netflow_run(struct netflow *);
65 void netflow_wait(struct netflow *);
67 void netflow_flow_init(struct netflow_flow *);
68 void netflow_flow_clear(struct netflow_flow *);
69 void netflow_flow_update_time(struct netflow *, struct netflow_flow *,
71 void netflow_flow_update_flags(struct netflow_flow *, uint8_t tcp_flags);
72 bool netflow_active_timeout_expired(struct netflow *, struct netflow_flow *);
74 #endif /* netflow.h */