src/vlib/unix/input.c

   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>
  44 #include <vppinfra/tw_timer_1t_3w_1024sl_ov.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;
  58   int n_epoll_fds;
  59
  60   /* Statistics. */
  61   u64 epoll_files_ready;
  62   u64 epoll_waits;
  63 } linux_epoll_main_t;
  64
  65 static linux_epoll_main_t *linux_epoll_mains = 0;
  66
  67 static void
  68 linux_epoll_file_update (clib_file_t * f, clib_file_update_type_t update_type)
  69 {
  70   clib_file_main_t *fm = &file_main;
  71   linux_epoll_main_t *em = vec_elt_at_index (linux_epoll_mains,
  72                                              f->polling_thread_index);
  73   struct epoll_event e = { 0 };
  74   int op, add_del = 0;
  75
  76   e.events = EPOLLIN;
  77   if (f->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE)
  78     e.events |= EPOLLOUT;
  79   if (f->flags & UNIX_FILE_EVENT_EDGE_TRIGGERED)
  80     e.events |= EPOLLET;
  81   e.data.u32 = f - fm->file_pool;
  82
  83   op = -1;
  84
  85   switch (update_type)
  86     {
  87     case UNIX_FILE_UPDATE_ADD:
  88       op = EPOLL_CTL_ADD;
  89       add_del = 1;
  90       break;
  91
  92     case UNIX_FILE_UPDATE_MODIFY:
  93       op = EPOLL_CTL_MOD;
  94       break;
  95
  96     case UNIX_FILE_UPDATE_DELETE:
  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
 133 static_always_inline uword
 134 linux_epoll_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
 135                           vlib_frame_t * frame, u32 thread_index)
 136 {
 137   unix_main_t *um = &unix_main;
 138   clib_file_main_t *fm = &file_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     int timeout_ms = 0, max_timeout_ms = 10;
 149     f64 vector_rate = vlib_last_vectors_per_main_loop (vm);
 150
 151     /*
 152      * If we've been asked for a fixed-sleep between main loop polls,
 153      * do so right away.
 154      */
 155     if (PREDICT_FALSE (is_main && um->poll_sleep_usec))
 156       {
 157         struct timespec ts, tsrem;
 158         timeout = 0;
 159         timeout_ms = 0;
 160         node->input_main_loops_per_call = 0;
 161         ts.tv_sec = 0;
 162         ts.tv_nsec = 1000 * um->poll_sleep_usec;
 163
 164         while (nanosleep (&ts, &tsrem) < 0)
 165           {
 166             ts = tsrem;
 167           }
 168       }
 169     /* If we're not working very hard, decide how long to sleep */
 170     else if (is_main && vector_rate < 2 && vm->api_queue_nonempty == 0
 171              && nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] == 0)
 172       {
 173         ticks_until_expiration = TW (tw_timer_first_expires_in_ticks)
 174           ((TWT (tw_timer_wheel) *) nm->timing_wheel);
 175
 176         /* Nothing on the fast wheel, sleep 10ms */
 177         if (ticks_until_expiration == TW_SLOTS_PER_RING)
 178           {
 179             timeout = 10e-3;
 180             timeout_ms = max_timeout_ms;
 181           }
 182         else
 183           {
 184             timeout = (f64) ticks_until_expiration *1e-5;
 185             if (timeout < 1e-3)
 186               timeout_ms = 0;
 187             else
 188               {
 189                 timeout_ms = timeout * 1e3;
 190                 /* Must be between 1 and 10 ms. */
 191                 timeout_ms = clib_max (1, timeout_ms);
 192                 timeout_ms = clib_min (max_timeout_ms, timeout_ms);
 193               }
 194           }
 195         node->input_main_loops_per_call = 0;
 196       }
 197     else if (is_main == 0 && vector_rate < 2 &&
 198              nm->input_node_counts_by_state[VLIB_NODE_STATE_POLLING] == 0)
 199       {
 200         timeout = 10e-3;
 201         timeout_ms = max_timeout_ms;
 202         node->input_main_loops_per_call = 0;
 203       }
 204     else                        /* busy */
 205       {
 206         /* Don't come back for a respectable number of dispatch cycles */
 207         node->input_main_loops_per_call = 1024;
 208       }
 209
 210     /* Allow any signal to wakeup our sleep. */
 211     if (is_main || em->epoll_fd != -1)
 212       {
 213         static sigset_t unblock_all_signals;
 214         n_fds_ready = epoll_pwait (em->epoll_fd,
 215                                    em->epoll_events,
 216                                    vec_len (em->epoll_events),
 217                                    timeout_ms, &unblock_all_signals);
 218
 219         /* This kludge is necessary to run over absurdly old kernels */
 220         if (n_fds_ready < 0 && errno == ENOSYS)
 221           {
 222             n_fds_ready = epoll_wait (em->epoll_fd,
 223                                       em->epoll_events,
 224                                       vec_len (em->epoll_events), timeout_ms);
 225           }
 226
 227       }
 228     else
 229       {
 230         if (timeout_ms)
 231           usleep (timeout_ms * 1000);
 232         goto done;
 233       }
 234   }
 235
 236   if (n_fds_ready < 0)
 237     {
 238       if (unix_error_is_fatal (errno))
 239         vlib_panic_with_error (vm, clib_error_return_unix (0, "epoll_wait"));
 240
 241       /* non fatal error (e.g. EINTR). */
 242       goto done;
 243     }
 244
 245   em->epoll_waits += 1;
 246   em->epoll_files_ready += n_fds_ready;
 247
 248   for (e = em->epoll_events; e < em->epoll_events + n_fds_ready; e++)
 249     {
 250       u32 i = e->data.u32;
 251       clib_file_t *f = fm->file_pool + i;
 252       clib_error_t *errors[4];
 253       int n_errors = 0;
 254
 255       if (PREDICT_FALSE (pool_is_free (fm->file_pool, f)))
 256         {
 257           /*
 258            * Under rare scenerop, epoll may still post us events for the
 259            * deleted file descriptor. We just deal with it and throw away the
 260            * events for the corresponding file descriptor.
 261            */
 262           if (e->events & EPOLLIN)
 263             {
 264               errors[n_errors] =
 265                 clib_error_return (0, "epoll event EPOLLIN dropped due "
 266                                    "to free index %u", i);
 267               n_errors++;
 268             }
 269           if (e->events & EPOLLOUT)
 270             {
 271               errors[n_errors] =
 272                 clib_error_return (0, "epoll event EPOLLOUT dropped due "
 273                                    "to free index %u", i);
 274               n_errors++;
 275             }
 276           if (e->events & EPOLLERR)
 277             {
 278               errors[n_errors] =
 279                 clib_error_return (0, "epoll event EPOLLERR dropped due "
 280                                    "to free index %u", i);
 281               n_errors++;
 282             }
 283         }
 284       else if (PREDICT_TRUE (!(e->events & EPOLLERR)))
 285         {
 286           if (e->events & EPOLLIN)
 287             {
 288               errors[n_errors] = f->read_function (f);
 289               f->read_events++;
 290               n_errors += errors[n_errors] != 0;
 291             }
 292           if (e->events & EPOLLOUT)
 293             {
 294               errors[n_errors] = f->write_function (f);
 295               f->write_events++;
 296               n_errors += errors[n_errors] != 0;
 297             }
 298         }
 299       else
 300         {
 301           if (f->error_function)
 302             {
 303               errors[n_errors] = f->error_function (f);
 304               f->error_events++;
 305               n_errors += errors[n_errors] != 0;
 306             }
 307           else
 308             close (f->file_descriptor);
 309         }
 310
 311       ASSERT (n_errors < ARRAY_LEN (errors));
 312       for (i = 0; i < n_errors; i++)
 313         {
 314           unix_save_error (um, errors[i]);
 315         }
 316     }
 317
 318 done:
 319   if (PREDICT_FALSE (vm->cpu_id != clib_get_current_cpu_id ()))
 320     {
 321       vm->cpu_id = clib_get_current_cpu_id ();
 322       vm->numa_node = clib_get_current_numa_node ();
 323     }
 324
 325   return 0;
 326 }
 327
 328 static uword
 329 linux_epoll_input (vlib_main_t * vm,
 330                    vlib_node_runtime_t * node, vlib_frame_t * frame)
 331 {
 332   u32 thread_index = vlib_get_thread_index ();
 333
 334   if (thread_index == 0)
 335     return linux_epoll_input_inline (vm, node, frame, 0);
 336   else
 337     return linux_epoll_input_inline (vm, node, frame, thread_index);
 338 }
 339
 340 /* *INDENT-OFF* */
 341 VLIB_REGISTER_NODE (linux_epoll_input_node,static) = {
 342   .function = linux_epoll_input,
 343   .type = VLIB_NODE_TYPE_PRE_INPUT,
 344   .name = "unix-epoll-input",
 345 };
 346 /* *INDENT-ON* */
 347
 348 clib_error_t *
 349 linux_epoll_input_init (vlib_main_t * vm)
 350 {
 351   linux_epoll_main_t *em;
 352   clib_file_main_t *fm = &file_main;
 353   vlib_thread_main_t *tm = vlib_get_thread_main ();
 354
 355
 356   vec_validate_aligned (linux_epoll_mains, tm->n_vlib_mains,
 357                         CLIB_CACHE_LINE_BYTES);
 358
 359   vec_foreach (em, linux_epoll_mains)
 360   {
 361     /* Allocate some events. */
 362     vec_resize (em->epoll_events, VLIB_FRAME_SIZE);
 363
 364     if (linux_epoll_mains == em)
 365       {
 366         em->epoll_fd = epoll_create (1);
 367         if (em->epoll_fd < 0)
 368           return clib_error_return_unix (0, "epoll_create");
 369       }
 370     else
 371       em->epoll_fd = -1;
 372   }
 373
 374   fm->file_update = linux_epoll_file_update;
 375
 376   return 0;
 377 }
 378
 379 VLIB_INIT_FUNCTION (linux_epoll_input_init);
 380
 381 #endif /* HAVE_LINUX_EPOLL */
 382
 383 static clib_error_t *
 384 unix_input_init (vlib_main_t * vm)
 385 {
 386   return vlib_call_init_function (vm, linux_epoll_input_init);
 387 }
 388
 389 VLIB_INIT_FUNCTION (unix_input_init);
 390
 391 /*
 392  * fd.io coding-style-patch-verification: ON
 393  *
 394  * Local Variables:
 395  * eval: (c-set-style "gnu")
 396  * End:
 397  */