FD.io VPP  v19.01.3-6-g70449b9b9
Vector Packet Processing
input.c
Go to the documentation of this file.
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 /*
16  * input.c: Unix file input
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39 
40 #include <vlib/vlib.h>
41 #include <vlib/unix/unix.h>
42 #include <signal.h>
43 #include <unistd.h>
45 
46 /* FIXME autoconf */
47 #define HAVE_LINUX_EPOLL
48 
49 #ifdef HAVE_LINUX_EPOLL
50 
51 #include <sys/epoll.h>
52 
53 typedef struct
54 {
55  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
56  int epoll_fd;
57  struct epoll_event *epoll_events;
59 
60  /* Statistics. */
64 
65 static linux_epoll_main_t *linux_epoll_mains = 0;
66 
67 static void
69 {
71  linux_epoll_main_t *em = vec_elt_at_index (linux_epoll_mains,
73  struct epoll_event e = { 0 };
74  int op, add_del = 0;
75 
76  e.events = EPOLLIN;
78  e.events |= EPOLLOUT;
80  e.events |= EPOLLET;
81  e.data.u32 = f - fm->file_pool;
82 
83  op = -1;
84 
85  switch (update_type)
86  {
88  op = EPOLL_CTL_ADD;
89  add_del = 1;
90  break;
91 
93  op = EPOLL_CTL_MOD;
94  break;
95 
97  op = EPOLL_CTL_DEL;
98  add_del = -1;
99  break;
100 
101  default:
102  clib_warning ("unknown update_type %d", update_type);
103  return;
104  }
105 
106  /* worker threads open epoll fd only if needed */
107  if (update_type == UNIX_FILE_UPDATE_ADD && em->epoll_fd == -1)
108  {
109  em->epoll_fd = epoll_create (1);
110  if (em->epoll_fd < 0)
111  {
112  clib_unix_warning ("epoll_create");
113  return;
114  }
115  em->n_epoll_fds = 0;
116  }
117 
118  if (epoll_ctl (em->epoll_fd, op, f->file_descriptor, &e) < 0)
119  {
120  clib_unix_warning ("epoll_ctl");
121  return;
122  }
123 
124  em->n_epoll_fds += add_del;
125 
126  if (em->n_epoll_fds == 0)
127  {
128  close (em->epoll_fd);
129  em->epoll_fd = -1;
130  }
131 }
132 
135  vlib_frame_t * frame, u32 thread_index)
136 {
137  unix_main_t *um = &unix_main;
139  linux_epoll_main_t *em = vec_elt_at_index (linux_epoll_mains, thread_index);
140  struct epoll_event *e;
141  int n_fds_ready;
142  int is_main = (thread_index == 0);
143 
144  {
145  vlib_node_main_t *nm = &vm->node_main;
146  u32 ticks_until_expiration;
147  f64 timeout;
148  f64 now;
149  int timeout_ms = 0, max_timeout_ms = 10;
150  f64 vector_rate = vlib_last_vectors_per_main_loop (vm);
151 
152  if (is_main == 0)
153  now = vlib_time_now (vm);
154 
155  /*
156  * If we've been asked for a fixed-sleep between main loop polls,
157  * do so right away.
158  */
159  if (PREDICT_FALSE (is_main && um->poll_sleep_usec))
160  {
161  struct timespec ts, tsrem;
162  timeout = 0;
163  timeout_ms = 0;
164  node->input_main_loops_per_call = 0;
165  ts.tv_sec = 0;
166  ts.tv_nsec = 1000 * um->poll_sleep_usec;
167 
168  while (nanosleep (&ts, &tsrem) < 0)
169  {
170  ts = tsrem;
171  }
172  }
173  /* If we're not working very hard, decide how long to sleep */
174  else if (is_main && vector_rate < 2 && vm->api_queue_nonempty == 0
175  && nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] == 0)
176  {
177  ticks_until_expiration = TW (tw_timer_first_expires_in_ticks)
178  ((TWT (tw_timer_wheel) *) nm->timing_wheel);
179 
180  /* Nothing on the fast wheel, sleep 10ms */
181  if (ticks_until_expiration == TW_SLOTS_PER_RING)
182  {
183  timeout = 10e-3;
184  timeout_ms = max_timeout_ms;
185  }
186  else
187  {
188  timeout = (f64) ticks_until_expiration *1e-5;
189  if (timeout < 1e-3)
190  timeout_ms = 0;
191  else
192  {
193  timeout_ms = timeout * 1e3;
194  /* Must be between 1 and 10 ms. */
195  timeout_ms = clib_max (1, timeout_ms);
196  timeout_ms = clib_min (max_timeout_ms, timeout_ms);
197  }
198  }
199  node->input_main_loops_per_call = 0;
200  }
201  else if (is_main == 0 && vector_rate < 2
203  && nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] == 0)
204  {
205  timeout = 10e-3;
206  timeout_ms = max_timeout_ms;
207  node->input_main_loops_per_call = 0;
208  }
209  else /* busy */
210  {
211  /* Don't come back for a respectable number of dispatch cycles */
212  node->input_main_loops_per_call = 1024;
213  }
214 
215  /* Allow any signal to wakeup our sleep. */
216  if (is_main || em->epoll_fd != -1)
217  {
218  static sigset_t unblock_all_signals;
219  n_fds_ready = epoll_pwait (em->epoll_fd,
220  em->epoll_events,
221  vec_len (em->epoll_events),
222  timeout_ms, &unblock_all_signals);
223 
224  /* This kludge is necessary to run over absurdly old kernels */
225  if (n_fds_ready < 0 && errno == ENOSYS)
226  {
227  n_fds_ready = epoll_wait (em->epoll_fd,
228  em->epoll_events,
229  vec_len (em->epoll_events), timeout_ms);
230  }
231 
232  }
233  else
234  {
235  /*
236  * Worker thread, no epoll fd's, sleep for 100us at a time
237  * and check for a barrier sync request
238  */
239  if (timeout_ms)
240  {
241  struct timespec ts, tsrem;
242  f64 limit = now + (f64) timeout_ms * 1e-3;
243 
244  while (vlib_time_now (vm) < limit)
245  {
246  /* Sleep for 100us at a time */
247  ts.tv_sec = 0;
248  ts.tv_nsec = 1000 * 100;
249 
250  while (nanosleep (&ts, &tsrem) < 0)
251  ts = tsrem;
253  goto done;
254  }
255  }
256  goto done;
257  }
258  }
259 
260  if (n_fds_ready < 0)
261  {
262  if (unix_error_is_fatal (errno))
263  vlib_panic_with_error (vm, clib_error_return_unix (0, "epoll_wait"));
264 
265  /* non fatal error (e.g. EINTR). */
266  goto done;
267  }
268 
269  em->epoll_waits += 1;
270  em->epoll_files_ready += n_fds_ready;
271 
272  for (e = em->epoll_events; e < em->epoll_events + n_fds_ready; e++)
273  {
274  u32 i = e->data.u32;
276  clib_error_t *errors[4];
277  int n_errors = 0;
278 
279  if (PREDICT_FALSE (pool_is_free (fm->file_pool, f)))
280  {
281  /*
282  * Under rare scenerop, epoll may still post us events for the
283  * deleted file descriptor. We just deal with it and throw away the
284  * events for the corresponding file descriptor.
285  */
286  if (e->events & EPOLLIN)
287  {
288  errors[n_errors] =
289  clib_error_return (0, "epoll event EPOLLIN dropped due "
290  "to free index %u", i);
291  n_errors++;
292  }
293  if (e->events & EPOLLOUT)
294  {
295  errors[n_errors] =
296  clib_error_return (0, "epoll event EPOLLOUT dropped due "
297  "to free index %u", i);
298  n_errors++;
299  }
300  if (e->events & EPOLLERR)
301  {
302  errors[n_errors] =
303  clib_error_return (0, "epoll event EPOLLERR dropped due "
304  "to free index %u", i);
305  n_errors++;
306  }
307  }
308  else if (PREDICT_TRUE (!(e->events & EPOLLERR)))
309  {
310  if (e->events & EPOLLIN)
311  {
312  f->read_events++;
313  errors[n_errors] = f->read_function (f);
314  /* Make sure f is valid if the file pool moves */
315  if (pool_is_free_index (fm->file_pool, i))
316  continue;
317  f = pool_elt_at_index (fm->file_pool, i);
318  n_errors += errors[n_errors] != 0;
319  }
320  if (e->events & EPOLLOUT)
321  {
322  f->write_events++;
323  errors[n_errors] = f->write_function (f);
324  n_errors += errors[n_errors] != 0;
325  }
326  }
327  else
328  {
329  if (f->error_function)
330  {
331  f->error_events++;
332  errors[n_errors] = f->error_function (f);
333  n_errors += errors[n_errors] != 0;
334  }
335  else
336  close (f->file_descriptor);
337  }
338 
339  ASSERT (n_errors < ARRAY_LEN (errors));
340  for (i = 0; i < n_errors; i++)
341  {
342  unix_save_error (um, errors[i]);
343  }
344  }
345 
346 done:
347  return 0;
348 }
349 
350 static uword
352  vlib_node_runtime_t * node, vlib_frame_t * frame)
353 {
354  u32 thread_index = vlib_get_thread_index ();
355 
356  if (thread_index == 0)
357  return linux_epoll_input_inline (vm, node, frame, 0);
358  else
359  return linux_epoll_input_inline (vm, node, frame, thread_index);
360 }
361 
362 /* *INDENT-OFF* */
364  .function = linux_epoll_input,
365  .type = VLIB_NODE_TYPE_PRE_INPUT,
366  .name = "unix-epoll-input",
367 };
368 /* *INDENT-ON* */
369 
370 clib_error_t *
372 {
373  linux_epoll_main_t *em;
376 
377 
378  vec_validate_aligned (linux_epoll_mains, tm->n_vlib_mains,
380 
381  vec_foreach (em, linux_epoll_mains)
382  {
383  /* Allocate some events. */
385 
386  if (linux_epoll_mains == em)
387  {
388  em->epoll_fd = epoll_create (1);
389  if (em->epoll_fd < 0)
390  return clib_error_return_unix (0, "epoll_create");
391  }
392  else
393  em->epoll_fd = -1;
394  }
395 
397 
398  return 0;
399 }
400 
402 
403 #endif /* HAVE_LINUX_EPOLL */
404 
405 static clib_error_t *
407 {
409 }
410 
412 
413 /*
414  * fd.io coding-style-patch-verification: ON
415  *
416  * Local Variables:
417  * eval: (c-set-style "gnu")
418  * End:
419  */
#define UNIX_FILE_EVENT_EDGE_TRIGGERED
Definition: file.h:58
unix_main_t unix_main
Definition: main.c:62
vlib_main_t vlib_global_main
Definition: main.c:1850
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
#define clib_min(x, y)
Definition: clib.h:295
static void vlib_panic_with_error(vlib_main_t *vm, clib_error_t *error)
Definition: main.h:277
static clib_error_t * unix_input_init(vlib_main_t *vm)
Definition: input.c:406
static vlib_node_registration_t linux_epoll_input_node
(constructor) VLIB_REGISTER_NODE (linux_epoll_input_node)
Definition: input.c:363
#define PREDICT_TRUE(x)
Definition: clib.h:112
unsigned long u64
Definition: types.h:89
u32 poll_sleep_usec
Definition: unix.h:106
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:232
u32 file_descriptor
Definition: file.h:54
int i
u32 polling_thread_index
Definition: file.h:61
#define pool_is_free(P, E)
Use free bitmap to query whether given element is free.
Definition: pool.h:275
#define vec_validate_aligned(V, I, A)
Make sure vector is long enough for given index (no header, specified alignment)
Definition: vec.h:450
static u32 vlib_last_vectors_per_main_loop(vlib_main_t *vm)
Definition: main.h:305
clib_file_function_t * read_function
Definition: file.h:67
double f64
Definition: types.h:142
#define fm
u32 input_main_loops_per_call
For input nodes: decremented on each main loop interation until it reaches zero and function is calle...
Definition: node.h:520
clib_file_t * file_pool
Definition: file.h:88
#define static_always_inline
Definition: clib.h:99
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:163
clib_file_update_type_t
Definition: file.h:78
static uword linux_epoll_input(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: input.c:351
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
#define clib_error_return(e, args...)
Definition: error.h:99
clib_file_main_t file_main
Definition: main.c:63
#define vec_resize(V, N)
Resize a vector (no header, unspecified alignment) Add N elements to end of given vector V...
Definition: vec.h:242
f64 time_last_barrier_release
Definition: main.h:68
unsigned int u32
Definition: types.h:88
#define vlib_call_init_function(vm, x)
Definition: init.h:260
#define VLIB_FRAME_SIZE
Definition: node.h:401
vlib_worker_thread_t * vlib_worker_threads
Definition: threads.c:36
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:511
#define clib_error_return_unix(e, args...)
Definition: error.h:102
#define TW_SLOTS_PER_RING
#define TWT(a)
u32 flags
Definition: file.h:56
#define PREDICT_FALSE(x)
Definition: clib.h:111
void(* file_update)(clib_file_t *file, clib_file_update_type_t update_type)
Definition: file.h:90
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:169
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:212
vlib_main_t * vm
Definition: buffer.c:301
static void linux_epoll_file_update(clib_file_t *f, clib_file_update_type_t update_type)
Definition: input.c:68
#define clib_warning(format, args...)
Definition: error.h:59
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:283
#define ARRAY_LEN(x)
Definition: clib.h:62
volatile u32 * wait_at_barrier
Definition: threads.h:90
#define ASSERT(truth)
static word unix_error_is_fatal(word error)
Definition: error.h:118
clib_error_t * linux_epoll_input_init(vlib_main_t *vm)
Definition: input.c:371
static_always_inline uword linux_epoll_input_inline(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame, u32 thread_index)
Definition: input.c:134
#define UNIX_FILE_DATA_AVAILABLE_TO_WRITE
Definition: file.h:57
#define clib_max(x, y)
Definition: clib.h:288
struct epoll_event * epoll_events
Definition: input.c:57
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
u32 input_node_counts_by_state[VLIB_N_NODE_STATE]
Definition: node.h:774
u64 read_events
Definition: file.h:73
vlib_node_main_t node_main
Definition: main.h:129
u64 uword
Definition: types.h:112
#define clib_unix_warning(format, args...)
Definition: error.h:68
u64 epoll_files_ready
Definition: input.c:61
clib_file_function_t * error_function
Definition: file.h:67
u64 write_events
Definition: file.h:74
static vlib_thread_main_t * vlib_get_thread_main()
Definition: global_funcs.h:32
static void unix_save_error(unix_main_t *um, clib_error_t *error)
Definition: unix.h:115
u64 error_events
Definition: file.h:75
#define vec_foreach(var, vec)
Vector iterator.
Definition: file.h:51
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
#define TW(a)
clib_file_function_t * write_function
Definition: file.h:67
void * timing_wheel
Definition: node.h:750