misc: remove GNU Indent directives
[vpp.git] / src / plugins / lldp / lldp_node.c
1 /*
2  * Copyright (c) 2011-2016 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 /**
16  * @file
17  * @brief LLDP nodes implementation
18  */
19 #include <lldp/lldp_node.h>
20 #include <vnet/ethernet/ethernet.h>
21 #include <vnet/ethernet/packet.h>
22
23 /* set this to 1 to turn on debug prints via clib_warning() */
24 #define LLDP_DEBUG (0)
25
26 static vlib_node_registration_t lldp_process_node;
27
28 #define F(sym, string) static char LLDP_ERR_##sym##_STR[] = string;
29 foreach_lldp_error (F);
30 #undef F
31
32 /*
33  * packet counter strings
34  * Dump these counters via the "show error" CLI command
35  */
36 static char *lldp_error_strings[] = {
37 #define F(sym, string) LLDP_ERR_##sym##_STR,
38   foreach_lldp_error (F)
39 #undef F
40 };
41
42 /*
43  * We actually send all lldp pkts to the "error" node after scanning
44  * them, so the graph node has only one next-index. The "error-drop"
45  * node automatically bumps our per-node packet counters for us.
46  */
47 typedef enum
48 {
49   LLDP_INPUT_NEXT_NORMAL,
50   LLDP_INPUT_N_NEXT,
51 } lldp_next_t;
52
53 /*
54  * Process a frame of lldp packets
55  * Expect 1 packet / frame
56  */
57 static uword
58 lldp_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
59               vlib_frame_t * frame)
60 {
61   u32 n_left_from, *from;
62   lldp_input_trace_t *t0;
63
64   from = vlib_frame_vector_args (frame);        /* array of buffer indices */
65   n_left_from = frame->n_vectors;       /* number of buffer indices */
66
67   while (n_left_from > 0)
68     {
69       u32 bi0;
70       vlib_buffer_t *b0;
71       u32 next0, error0;
72
73       bi0 = from[0];
74       b0 = vlib_get_buffer (vm, bi0);
75
76       next0 = LLDP_INPUT_NEXT_NORMAL;
77
78       /* scan this lldp pkt. error0 is the counter index to bump */
79       error0 = lldp_input (vm, b0, bi0);
80       b0->error = node->errors[error0];
81
82       /* If this pkt is traced, snapshot the data */
83       if (b0->flags & VLIB_BUFFER_IS_TRACED)
84         {
85           int len;
86           t0 = vlib_add_trace (vm, node, b0, sizeof (*t0));
87           len = (b0->current_length < sizeof (t0->data)) ? b0->current_length
88             : sizeof (t0->data);
89           t0->len = len;
90           clib_memcpy_fast (t0->data, vlib_buffer_get_current (b0), len);
91         }
92       /* push this pkt to the next graph node, always error-drop */
93       vlib_set_next_frame_buffer (vm, node, next0, bi0);
94
95       from += 1;
96       n_left_from -= 1;
97     }
98
99   return frame->n_vectors;
100 }
101
102 /*
103  * lldp input graph node declaration
104  */
105 VLIB_REGISTER_NODE(lldp_input_node, static) = {
106   .function = lldp_node_fn,
107   .name = "lldp-input",
108   .vector_size = sizeof(u32),
109   .type = VLIB_NODE_TYPE_INTERNAL,
110
111   .n_errors = LLDP_N_ERROR,
112   .error_strings = lldp_error_strings,
113
114   .format_trace = lldp_input_format_trace,
115
116   .n_next_nodes = LLDP_INPUT_N_NEXT,
117   .next_nodes =
118       {
119               [LLDP_INPUT_NEXT_NORMAL] = "error-drop",
120       },
121 };
122
123 /*
124  * lldp process node function
125  */
126 static uword
127 lldp_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
128 {
129   lldp_main_t *lm = &lldp_main;
130   f64 timeout = 0;
131   uword event_type, *event_data = 0;
132
133   /* So we can send events to the lldp process */
134   lm->lldp_process_node_index = lldp_process_node.index;
135
136   /* with ethernet input */
137   ethernet_register_input_type (vm, ETHERNET_TYPE_802_1_LLDP /* LLDP */ ,
138                                 lldp_input_node.index);
139
140   while (1)
141     {
142       if (vec_len (lm->intfs_timeouts))
143         {
144 #if LLDP_DEBUG
145           clib_warning ("DEBUG: wait for event with timeout %f", timeout);
146 #endif
147           (void) vlib_process_wait_for_event_or_clock (vm, timeout);
148         }
149       else
150         {
151 #if LLDP_DEBUG
152           clib_warning ("DEBUG: wait for event without timeout");
153 #endif
154           (void) vlib_process_wait_for_event (vm);
155         }
156       event_type = vlib_process_get_events (vm, &event_data);
157       switch (event_type)
158         {
159         case ~0:                /* no events => timeout */
160           /* nothing to do here */
161           break;
162         case LLDP_EVENT_RESCHEDULE:
163           /* nothing to do here - reschedule is done automatically after
164            * each event or timeout */
165           break;
166         default:
167           clib_warning ("BUG: event type 0x%wx", event_type);
168           break;
169         }
170       if (!vec_len (lm->intfs_timeouts))
171         {
172           continue;
173         }
174       /* send packet(s) and schedule another timeout */
175       const f64 now = vlib_time_now (lm->vlib_main);
176       while (1)
177         {
178           lldp_intf_t *n = pool_elt_at_index (lm->intfs,
179                                               lm->intfs_timeouts
180                                               [lm->intfs_timeouts_idx]);
181           if (n->last_sent < 0.01 || now > n->last_sent + lm->msg_tx_interval)
182             {
183 #if LLDP_DEBUG
184               clib_warning ("send packet to lldp %p, if idx %d", n,
185                             n->hw_if_index);
186 #endif
187               lldp_send_ethernet (lm, n, 0);
188               ++lm->intfs_timeouts_idx;
189               if (lm->intfs_timeouts_idx >= vec_len (lm->intfs_timeouts))
190                 {
191                   lm->intfs_timeouts_idx = 0;
192                 }
193               continue;
194             }
195           else
196             {
197               timeout = n->last_sent + lm->msg_tx_interval - now;
198               break;
199             }
200         }
201 #if LLDP_DEBUG
202       clib_warning ("DEBUG: timeout set to %f", timeout);
203       u8 *s = NULL;
204       u32 i;
205       vec_foreach_index (i, lm->intfs_timeouts)
206       {
207         if (i == lm->intfs_timeouts_idx)
208           {
209             s = format (s, " [%d]", lm->intfs_timeouts[i]);
210           }
211         else
212           {
213             s = format (s, " %d", lm->intfs_timeouts[i]);
214           }
215       }
216       clib_warning ("DEBUG: timeout schedule: %s", s);
217       vec_free (s);
218 #endif
219       if (event_data)
220         {
221           vec_set_len (event_data, 0);
222         }
223     }
224
225   return 0;
226 }
227
228 /*
229  * lldp process node declaration
230  */
231 VLIB_REGISTER_NODE(lldp_process_node, static) = {
232   .function = lldp_process,
233   .type = VLIB_NODE_TYPE_PROCESS,
234   .name = "lldp-process",
235 };
236
237 void
238 lldp_schedule_intf (lldp_main_t * lm, lldp_intf_t * n)
239 {
240   const int idx = n - lm->intfs;
241   u32 v;
242   vec_foreach_index (v, lm->intfs_timeouts)
243   {
244     if (lm->intfs_timeouts[v] == idx)
245       {
246         /* already scheduled */
247         return;
248       }
249   }
250   n->last_sent = 0;             /* ensure that a packet is sent out immediately */
251   /* put the interface at the current position in the timeouts - it
252    * will timeout immediately */
253   vec_insert (lm->intfs_timeouts, 1, lm->intfs_timeouts_idx);
254   lm->intfs_timeouts[lm->intfs_timeouts_idx] = n - lm->intfs;
255   vlib_process_signal_event (lm->vlib_main, lm->lldp_process_node_index,
256                              LLDP_EVENT_RESCHEDULE, 0);
257 #if LLDP_DEBUG
258   clib_warning ("DEBUG: schedule interface %p, if idx %d", n, n->hw_if_index);
259 #endif
260 }
261
262 void
263 lldp_unschedule_intf (lldp_main_t * lm, lldp_intf_t * n)
264 {
265   if (!n)
266     {
267       return;
268     }
269 #if LLDP_DEBUG
270   clib_warning ("DEBUG: unschedule interface %p, if idx %d", n,
271                 n->hw_if_index);
272 #endif
273   const int idx = n - lm->intfs;
274   u32 v;
275   /* remove intf index from timeouts vector */
276   vec_foreach_index (v, lm->intfs_timeouts)
277   {
278     if (lm->intfs_timeouts[v] == idx)
279       {
280         vec_delete (lm->intfs_timeouts, 1, v);
281         break;
282       }
283   }
284   /* wrap current timeout index to first element if needed */
285   if (lm->intfs_timeouts_idx >= vec_len (lm->intfs_timeouts))
286     {
287       lm->intfs_timeouts_idx = 0;
288     }
289   vlib_process_signal_event (lm->vlib_main, lm->lldp_process_node_index,
290                              LLDP_EVENT_RESCHEDULE, 0);
291 }
292
293 static clib_error_t *
294 lldp_sw_interface_up_down (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
295 {
296   lldp_main_t *lm = &lldp_main;
297   vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
298   lldp_intf_t *n = lldp_get_intf (lm, hi->hw_if_index);
299   if (n)
300     {
301       if (!(flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP))
302         {
303           /* FIXME - the packet sent here isn't send properly - need to find a
304            * way to send the packet before interface goes down */
305           lldp_send_ethernet (lm, n, 1);
306           lldp_unschedule_intf (lm, n);
307         }
308     }
309   return 0;
310 }
311
312 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (lldp_sw_interface_up_down);
313
314 static clib_error_t *
315 lldp_hw_interface_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
316 {
317   lldp_main_t *lm = &lldp_main;
318   lldp_intf_t *n = lldp_get_intf (lm, hw_if_index);
319   if (n)
320     {
321       if (flags & VNET_HW_INTERFACE_FLAG_LINK_UP)
322         {
323           lldp_schedule_intf (lm, n);
324         }
325     }
326   return 0;
327 }
328
329 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION (lldp_hw_interface_up_down);
330
331 /*
332  * fd.io coding-style-patch-verification: ON
333  *
334  * Local Variables:
335  * eval: (c-set-style "gnu")
336  * End:
337  */