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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * input.c: Unix file input
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #include <vlib/vlib.h>
41 #include <vlib/unix/unix.h>
43 #include <vppinfra/tw_timer_1t_3w_1024sl_ov.h>
46 #define HAVE_LINUX_EPOLL
48 #ifdef HAVE_LINUX_EPOLL
50 #include <sys/epoll.h>
55 struct epoll_event *epoll_events;
58 u64 epoll_files_ready;
62 static linux_epoll_main_t linux_epoll_main;
65 linux_epoll_file_update (clib_file_t * f, clib_file_update_type_t update_type)
67 clib_file_main_t *fm = &file_main;
68 linux_epoll_main_t *em = &linux_epoll_main;
72 memset (&e, 0, sizeof (e));
75 if (f->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE)
77 if (f->flags & UNIX_FILE_EVENT_EDGE_TRIGGERED)
79 e.data.u32 = f - fm->file_pool;
85 case UNIX_FILE_UPDATE_ADD:
89 case UNIX_FILE_UPDATE_MODIFY:
93 case UNIX_FILE_UPDATE_DELETE:
98 clib_warning ("unknown update_type %d", update_type);
102 if (epoll_ctl (em->epoll_fd, op, f->file_descriptor, &e) < 0)
103 clib_unix_warning ("epoll_ctl");
107 linux_epoll_input (vlib_main_t * vm,
108 vlib_node_runtime_t * node, vlib_frame_t * frame)
110 unix_main_t *um = &unix_main;
111 clib_file_main_t *fm = &file_main;
112 linux_epoll_main_t *em = &linux_epoll_main;
113 struct epoll_event *e;
117 vlib_node_main_t *nm = &vm->node_main;
118 u32 ticks_until_expiration;
120 int timeout_ms = 0, max_timeout_ms = 10;
121 f64 vector_rate = vlib_last_vectors_per_main_loop (vm);
123 /* If we're not working very hard, decide how long to sleep */
124 if (vector_rate < 2 && vm->api_queue_nonempty == 0
125 && nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] == 0)
127 ticks_until_expiration = TW (tw_timer_first_expires_in_ticks)
128 ((TWT (tw_timer_wheel) *) nm->timing_wheel);
130 /* Nothing on the fast wheel, sleep 10ms */
131 if (ticks_until_expiration == TW_SLOTS_PER_RING)
134 timeout_ms = max_timeout_ms;
138 timeout = (f64) ticks_until_expiration *1e-5;
143 timeout_ms = timeout * 1e3;
144 /* Must be between 1 and 10 ms. */
145 timeout_ms = clib_max (1, timeout_ms);
146 timeout_ms = clib_min (max_timeout_ms, timeout_ms);
149 node->input_main_loops_per_call = 0;
153 /* Don't come back for a respectable number of dispatch cycles */
154 node->input_main_loops_per_call = 1024;
157 /* Allow any signal to wakeup our sleep. */
159 static sigset_t unblock_all_signals;
160 n_fds_ready = epoll_pwait (em->epoll_fd,
162 vec_len (em->epoll_events),
163 timeout_ms, &unblock_all_signals);
165 /* This kludge is necessary to run over absurdly old kernels */
166 if (n_fds_ready < 0 && errno == ENOSYS)
168 n_fds_ready = epoll_wait (em->epoll_fd,
170 vec_len (em->epoll_events), timeout_ms);
177 if (unix_error_is_fatal (errno))
178 vlib_panic_with_error (vm, clib_error_return_unix (0, "epoll_wait"));
180 /* non fatal error (e.g. EINTR). */
184 em->epoll_waits += 1;
185 em->epoll_files_ready += n_fds_ready;
187 for (e = em->epoll_events; e < em->epoll_events + n_fds_ready; e++)
190 clib_file_t *f = pool_elt_at_index (fm->file_pool, i);
191 clib_error_t *errors[4];
194 if (PREDICT_TRUE (!(e->events & EPOLLERR)))
196 if (e->events & EPOLLIN)
198 errors[n_errors] = f->read_function (f);
199 n_errors += errors[n_errors] != 0;
201 if (e->events & EPOLLOUT)
203 errors[n_errors] = f->write_function (f);
204 n_errors += errors[n_errors] != 0;
209 if (f->error_function)
211 errors[n_errors] = f->error_function (f);
212 n_errors += errors[n_errors] != 0;
215 close (f->file_descriptor);
218 ASSERT (n_errors < ARRAY_LEN (errors));
219 for (i = 0; i < n_errors; i++)
221 unix_save_error (um, errors[i]);
229 VLIB_REGISTER_NODE (linux_epoll_input_node,static) = {
230 .function = linux_epoll_input,
231 .type = VLIB_NODE_TYPE_PRE_INPUT,
232 .name = "unix-epoll-input",
237 linux_epoll_input_init (vlib_main_t * vm)
239 linux_epoll_main_t *em = &linux_epoll_main;
240 clib_file_main_t *fm = &file_main;
242 /* Allocate some events. */
243 vec_resize (em->epoll_events, VLIB_FRAME_SIZE);
245 em->epoll_fd = epoll_create (vec_len (em->epoll_events));
246 if (em->epoll_fd < 0)
247 return clib_error_return_unix (0, "epoll_create");
249 fm->file_update = linux_epoll_file_update;
254 VLIB_INIT_FUNCTION (linux_epoll_input_init);
256 #endif /* HAVE_LINUX_EPOLL */
258 static clib_error_t *
259 unix_input_init (vlib_main_t * vm)
261 return vlib_call_init_function (vm, linux_epoll_input_init);
264 VLIB_INIT_FUNCTION (unix_input_init);
267 * fd.io coding-style-patch-verification: ON
270 * eval: (c-set-style "gnu")