Initial commit of vpp code.
[vpp.git] / vnet / vnet / flow / flow_report.h
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 #ifndef __included_vnet_flow_report_h__
16 #define __included_vnet_flow_report_h__
17
18 #include <vlib/vlib.h>
19 #include <vnet/vnet.h>
20 #include <vnet/pg/pg.h>
21 #include <vnet/ethernet/ethernet.h>
22 #include <vnet/ethernet/packet.h>
23 #include <vnet/ip/ip_packet.h>
24 #include <vnet/ip/ip4_packet.h>
25 #include <vnet/ip/ip6_packet.h>
26 #include <vnet/ip/udp.h>
27 #include <vlib/cli.h>
28 #include <vppinfra/error.h>
29 #include <vppinfra/hash.h>
30 #include <vppinfra/cache.h>
31
32 #include <vnet/flow/ipfix_packet.h>
33
34 /* Used to build the rewrite */
35 typedef struct {
36   ip4_header_t ip4;
37   udp_header_t udp;
38   ipfix_template_packet_t ipfix;
39 } ip4_ipfix_template_packet_t;
40
41 struct flow_report_main;
42 struct flow_report;
43
44 typedef u8 * (vnet_flow_rewrite_callback_t)(struct flow_report_main *, 
45                                             struct flow_report *,
46                                             ip4_address_t *,
47                                             ip4_address_t *);
48
49 typedef vlib_frame_t * (vnet_flow_data_callback_t) (struct flow_report_main *, 
50                                                     struct flow_report *,
51                                                     vlib_frame_t *, u32 *, 
52                                                     u32);
53 typedef struct flow_report {
54   /* ipfix rewrite, set by callback */
55   u8 * rewrite;
56   u32 sequence_number;
57   u32 domain_id;
58   f64 last_template_sent;
59   int update_rewrite;
60
61   /* Bitmap of fields to send */
62   uword * fields_to_send;
63
64   /* Opaque data */
65   void * opaque;
66
67   /* build-the-rewrite callback */
68   vnet_flow_rewrite_callback_t *rewrite_callback;
69
70   /* Send-flow-data callback */
71   vnet_flow_data_callback_t *flow_data_callback;
72 } flow_report_t;
73
74 typedef struct flow_report_main {
75   flow_report_t * reports;
76
77   /* ipfix collector, our ip address */
78   ip4_address_t ipfix_collector;
79   ip4_address_t src_address;
80
81   /* time scale transform. Joy. */
82   u32 unix_time_0;
83   f64 vlib_time_0;
84
85   /* convenience variables */
86   vlib_main_t * vlib_main;
87   vnet_main_t * vnet_main;
88 } flow_report_main_t;
89
90 flow_report_main_t flow_report_main;
91
92 vlib_node_registration_t flow_report_process_node;
93
94 int vnet_flow_report_enable_disable (u32 sw_if_index, u32 table_index,
95                                        int enable_disable);
96 typedef struct {
97   vnet_flow_data_callback_t *flow_data_callback;
98   vnet_flow_rewrite_callback_t *rewrite_callback;
99   void * opaque;
100   int is_add;
101   u32 domain_id;
102 } vnet_flow_report_add_del_args_t;  
103
104 int vnet_flow_report_add_del (flow_report_main_t *frm, 
105                               vnet_flow_report_add_del_args_t *a);
106
107 #endif /* __included_vnet_flow_report_h__ */