blob: 60802adea643e350970cece8bf9d45a9b3b88706 (
plain)
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
/*
* trace_util.h -- Trace Profile Utility header
*
* Copyright (c) 2016 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef include_vnet_trace_util_h
#define include_vnet_trace_util_h
#define debug_ioam debug_ioam_fn
/**
* Usage:
*
* On any node that participates in iOAM Trace.
*
* Step 1: Initialize this library by calling trace_init()
* Step 2: Setup a trace profile that contains all the parameters needed to compute cumulative:
* Call these functions:
* trace_profile_find
* trace_profile_create
* Step 2a: On initial node enable the profile to be used:
* trace_profile_set_active / trace_profile_get_active will return the profile
* Step 4: TBD
* trace_validate
*
*/
typedef struct trace_profile_
{
u8 valid:1;
u8 trace_type;
u8 num_elts;
/* Configured node-id */
u32 node_id;
u32 app_data;
u32 trace_tsp;
} trace_profile;
typedef struct
{
/* Name of the default profile list in use */
trace_profile profile;
/* API message ID base */
u16 msg_id_base;
/* convenience */
vlib_main_t *vlib_main;
vnet_main_t *vnet_main;
} trace_main_t;
extern trace_main_t trace_main;
/*
* Initialize Trace profile
*/
int trace_util_init (void);
/*
* Find a trace profile
*/
always_inline trace_profile *
trace_profile_find (void)
{
trace_main_t *sm = &trace_main;
return (&(sm->profile));
}
/* setup and clean up profile */
int trace_profile_create (trace_profile * profile, u8 trace_type, u8 num_elts,
u32 trace_tsp, u32 node_id, u32 app_data);
void clear_trace_profiles (void);
/* *INDENT-OFF* */
typedef CLIB_PACKED (struct
{
u8 ioam_trace_type;
u8 data_list_elts_left;
u32 elts[0]; /* Variable type. So keep it generic */
}) ioam_trace_hdr_t;
/* *INDENT-ON* */
#define BIT_TTL_NODEID (1<<0)
#define BIT_ING_INTERFACE (1<<1)
#define BIT_EGR_INTERFACE (1<<2)
#define BIT_TIMESTAMP (1<<3)
#define BIT_APPDATA (1<<4)
#define TRACE_TYPE_MASK 0x1F /* Mask of all above bits */
/*
0x00011111 iOAM-trace-type is 0x00011111 then the format of node
data is:
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Hop_Lim | node_id |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| ingress_if_id | egress_if_id |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ timestamp +
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| app_data |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*/
#define TRACE_TYPE_IF_TS_APP 0x1f
typedef struct
{
u32 ttl_node_id;
u16 ingress_if;
u16 egress_if;
u32 timestamp;
u32 app_data;
} ioam_trace_if_ts_app_t;
/*
0x00000111 iOAM-trace-type is 0x00000111 then the format is:
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Hop_Lim | node_id |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| ingress_if_id | egress_if_id |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*/
#define TRACE_TYPE_IF 0x03
typedef struct
{
u32 ttl_node_id;
u16 ingress_if;
u16 egress_if;
} ioam_trace_if_t;
/*
0x00001001 iOAM-trace-type is 0x00001001 then the format is:
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Hop_Lim | node_id |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ timestamp +
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*/
#define TRACE_TYPE_TS 0x09
typedef struct
{
u32 ttl_node_id;
u32 timestamp;
} ioam_trace_ts_t;
/*
0x00010001 iOAM-trace-type is 0x00010001 then the format is:
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Hop_Lim | node_id |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| app_data |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*/
#define TRACE_TYPE_APP 0x11
typedef struct
{
u32 ttl_node_id;
u32 app_data;
} ioam_trace_app_t;
/*
0x00011001 iOAM-trace-type is 0x00011001 then the format is:
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Hop_Lim | node_id |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ timestamp +
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| app_data |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*/
#define TRACE_TYPE_TS_APP 0x19
typedef struct
{
u32 ttl_node_id;
u32 timestamp;
u32 app_data;
} ioam_trace_ts_app_t;
static inline u8
fetch_trace_data_size (u8 trace_type)
{
u8 trace_data_size = 0;
if (trace_type == TRACE_TYPE_IF_TS_APP)
trace_data_size = sizeof (ioam_trace_if_ts_app_t);
else if (trace_type == TRACE_TYPE_IF)
trace_data_size = sizeof (ioam_trace_if_t);
else if (trace_type == TRACE_TYPE_TS)
trace_data_size = sizeof (ioam_trace_ts_t);
else if (trace_type == TRACE_TYPE_APP)
trace_data_size = sizeof (ioam_trace_app_t);
else if (trace_type == TRACE_TYPE_TS_APP)
trace_data_size = sizeof (ioam_trace_ts_app_t);
return trace_data_size;
}
int ioam_trace_get_sizeof_handler (u32 * result);
int ip6_trace_profile_setup (void);
int ip6_trace_profile_cleanup (void);
#define TSP_SECONDS 0
#define TSP_MILLISECONDS 1
#define TSP_MICROSECONDS 2
#define TSP_NANOSECONDS 3
#endif
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/
|
