iOAM trace configuration APIs
[vpp.git] / vnet / vnet / ip / ip6_hop_by_hop.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_ip6_hop_by_hop_h__
16 #define __included_ip6_hop_by_hop_h__
17
18 #include <vnet/ip/ip6_hop_by_hop_packet.h>
19
20 typedef struct {
21   /* The current rewrite we're using */
22   u8 * rewrite;
23
24   /* Trace data processing callback */
25   void *ioam_end_of_path_cb;
26   /* Configuration data */
27   /* Adjacency */
28   ip6_address_t adj;
29 #define IOAM_HBYH_ADD  0
30 #define IOAM_HBYH_MOD  1
31 #define IOAM_HBYH_POP  2
32   u8 ioam_flag;
33   /* time scale transform. Joy. */
34   u32 unix_time_0;
35   f64 vlib_time_0;
36
37
38   /* Trace option */
39   u8 trace_type;
40   u8 trace_option_elts;
41
42   /* Configured node-id */
43   u32 node_id;
44   u32 app_data;
45
46   /* PoW option */
47   u8 has_pow_option;
48
49 #define PPC_NONE  0
50 #define PPC_ENCAP 1
51 #define PPC_DECAP 2
52   u8 has_ppc_option;
53
54 #define TSP_SECONDS              0
55 #define TSP_MILLISECONDS         1
56 #define TSP_MICROSECONDS         2
57 #define TSP_NANOSECONDS          3
58   /* Time stamp precision. This is enumerated to above four options */
59   u32 trace_tsp;
60
61   /* convenience */
62   vlib_main_t * vlib_main;
63   vnet_main_t * vnet_main;
64 } ip6_hop_by_hop_main_t;
65
66 extern ip6_hop_by_hop_main_t ip6_hop_by_hop_main;
67
68 extern u8 * format_path_map(u8 * s, va_list * args);
69 extern clib_error_t *
70 ip6_ioam_trace_profile_set(u32 trace_option_elts, u32 trace_type, u32 node_id,
71                            u32 app_data, int has_pow_option, u32 trace_tsp,
72                            int has_e2e_option);
73 extern int ip6_ioam_set_destination (ip6_address_t *addr, u32 mask_width,
74                   u32 vrf_id, int is_add, int is_pop, int is_none);
75
76 extern clib_error_t * clear_ioam_rewrite_fn(void);
77
78 static inline u8 is_zero_ip4_address (ip4_address_t *a)
79 {
80   return (a->as_u32 == 0);
81 }
82
83 static inline void copy_ip6_address (ip6_address_t *dst, ip6_address_t *src)
84 {
85   dst->as_u64[0] = src->as_u64[0];
86   dst->as_u64[1] = src->as_u64[1];
87 }
88
89 static inline void set_zero_ip6_address (ip6_address_t *a)
90 {
91   a->as_u64[0] = 0;
92   a->as_u64[1] = 0;
93 }
94
95 static inline u8 cmp_ip6_address (ip6_address_t *a1, ip6_address_t *a2)
96 {
97   return ((a1->as_u64[0] == a2->as_u64[0]) && (a1->as_u64[1] == a2->as_u64[1]));
98 }
99 static inline u8 is_zero_ip6_address (ip6_address_t *a)
100 {
101   return ((a->as_u64[0] == 0) && (a->as_u64[1] == 0));
102 }
103
104 extern ip6_hop_by_hop_main_t * hm;
105 #endif /* __included_ip6_hop_by_hop_h__ */