session: basic fifo-tuning-logic
[vpp.git] / src / vnet / session / application_worker.c
index 08b42f3..1793998 100644 (file)
@@ -33,7 +33,7 @@ app_worker_alloc (application_t * app)
   app_wrk->wrk_map_index = ~0;
   app_wrk->connects_seg_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
   app_wrk->first_segment_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
-  APP_DBG ("New app %v worker %u", app_get_name (app), app_wrk->wrk_index);
+  APP_DBG ("New app %v worker %u", app->name, app_wrk->wrk_index);
   return app_wrk;
 }
 
@@ -58,10 +58,9 @@ app_worker_free (app_worker_t * app_wrk)
   vnet_unlisten_args_t _a, *a = &_a;
   u64 handle, *handles = 0;
   segment_manager_t *sm;
+  session_t *ls;
   u32 sm_index;
   int i;
-  app_listener_t *al;
-  session_t *ls;
 
   /*
    *  Listener cleanup
@@ -70,8 +69,7 @@ app_worker_free (app_worker_t * app_wrk)
   /* *INDENT-OFF* */
   hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
     ls = listen_session_get_from_handle (handle);
-    al = app_listener_get (app, ls->al_index);
-    vec_add1 (handles, app_listener_handle (al));
+    vec_add1 (handles, app_listen_session_handle (ls));
     sm = segment_manager_get (sm_index);
     sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
   }));
@@ -95,7 +93,7 @@ app_worker_free (app_worker_t * app_wrk)
       sm = segment_manager_get (app_wrk->connects_seg_manager);
       sm->app_wrk_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
       sm->first_is_protected = 0;
-      segment_manager_init_del (sm);
+      segment_manager_init_free (sm);
     }
 
   /* If first segment manager is used by a listener */
@@ -108,12 +106,12 @@ app_worker_free (app_worker_t * app_wrk)
       /* .. and has no fifos, e.g. it might be used for redirected sessions,
        * remove it */
       if (!segment_manager_has_fifos (sm))
-       segment_manager_del (sm);
+       segment_manager_free (sm);
     }
 
-  pool_put (app_workers, app_wrk);
   if (CLIB_DEBUG)
     clib_memset (app_wrk, 0xfe, sizeof (*app_wrk));
+  pool_put (app_workers, app_wrk);
 }
 
 application_t *
@@ -140,7 +138,7 @@ app_worker_alloc_segment_manager (app_worker_t * app_wrk)
       return sm;
     }
 
-  sm = segment_manager_new ();
+  sm = segment_manager_alloc ();
   sm->app_wrk_index = app_wrk->wrk_index;
 
   return sm;
@@ -150,11 +148,10 @@ static int
 app_worker_alloc_session_fifos (segment_manager_t * sm, session_t * s)
 {
   svm_fifo_t *rx_fifo = 0, *tx_fifo = 0;
-  u32 fifo_segment_index;
   int rv;
 
-  if ((rv = segment_manager_alloc_session_fifos (sm, &rx_fifo, &tx_fifo,
-                                                &fifo_segment_index)))
+  if ((rv = segment_manager_alloc_session_fifos (sm, s->thread_index,
+                                                &rx_fifo, &tx_fifo)))
     return rv;
 
   rx_fifo->master_session_index = s->session_index;
@@ -240,7 +237,7 @@ app_worker_stop_listen_session (app_worker_t * app_wrk, session_t * ls)
     }
   else
     {
-      segment_manager_init_del (sm);
+      segment_manager_init_free (sm);
     }
   hash_unset (app_wrk->listeners_table, handle);
 }
@@ -278,11 +275,16 @@ app_worker_init_accepted (session_t * s)
   app_worker_t *app_wrk;
   segment_manager_t *sm;
   session_t *listener;
+  application_t *app;
 
-  listener = listen_session_get (s->listener_index);
+  listener = listen_session_get_from_handle (s->listener_handle);
   app_wrk = application_listener_select_worker (listener);
   s->app_wrk_index = app_wrk->wrk_index;
 
+  app = application_get (app_wrk->app_index);
+  if (app->cb_fns.fifo_tuning_callback)
+    s->flags |= SESSION_F_CUSTOM_FIFO_TUNING;
+
   sm = app_worker_get_listen_segment_manager (app_wrk, listener);
   if (app_worker_alloc_session_fifos (sm, s))
     return -1;
@@ -310,6 +312,10 @@ app_worker_init_connected (app_worker_t * app_wrk, session_t * s)
       if (app_worker_alloc_session_fifos (sm, s))
        return -1;
     }
+
+  if (app->cb_fns.fifo_tuning_callback)
+    s->flags |= SESSION_F_CUSTOM_FIFO_TUNING;
+
   return 0;
 }
 
@@ -329,6 +335,33 @@ app_worker_close_notify (app_worker_t * app_wrk, session_t * s)
   return 0;
 }
 
+int
+app_worker_transport_closed_notify (app_worker_t * app_wrk, session_t * s)
+{
+  application_t *app = application_get (app_wrk->app_index);
+  if (app->cb_fns.session_transport_closed_callback)
+    app->cb_fns.session_transport_closed_callback (s);
+  return 0;
+}
+
+int
+app_worker_reset_notify (app_worker_t * app_wrk, session_t * s)
+{
+  application_t *app = application_get (app_wrk->app_index);
+  app->cb_fns.session_reset_callback (s);
+  return 0;
+}
+
+int
+app_worker_cleanup_notify (app_worker_t * app_wrk, session_t * s,
+                          session_cleanup_ntf_t ntf)
+{
+  application_t *app = application_get (app_wrk->app_index);
+  if (app->cb_fns.session_cleanup_callback)
+    app->cb_fns.session_cleanup_callback (s, ntf);
+  return 0;
+}
+
 int
 app_worker_builtin_rx (app_worker_t * app_wrk, session_t * s)
 {
@@ -337,6 +370,27 @@ app_worker_builtin_rx (app_worker_t * app_wrk, session_t * s)
   return 0;
 }
 
+int
+app_worker_builtin_tx (app_worker_t * app_wrk, session_t * s)
+{
+  application_t *app = application_get (app_wrk->app_index);
+
+  if (!app->cb_fns.builtin_app_tx_callback)
+    return 0;
+
+  app->cb_fns.builtin_app_tx_callback (s);
+  return 0;
+}
+
+int
+app_worker_migrate_notify (app_worker_t * app_wrk, session_t * s,
+                          session_handle_t new_sh)
+{
+  application_t *app = application_get (app_wrk->app_index);
+  app->cb_fns.session_migrate_callback (s, new_sh);
+  return 0;
+}
+
 int
 app_worker_own_session (app_worker_t * app_wrk, session_t * s)
 {
@@ -361,21 +415,11 @@ app_worker_own_session (app_worker_t * app_wrk, session_t * s)
   if (app_worker_alloc_session_fifos (sm, s))
     return -1;
 
-  if (!svm_fifo_is_empty (rxf))
-    {
-      clib_memcpy_fast (s->rx_fifo->data, rxf->data, rxf->nitems);
-      s->rx_fifo->head = rxf->head;
-      s->rx_fifo->tail = rxf->tail;
-      s->rx_fifo->cursize = rxf->cursize;
-    }
+  if (!svm_fifo_is_empty_cons (rxf))
+    svm_fifo_clone (s->rx_fifo, rxf);
 
-  if (!svm_fifo_is_empty (txf))
-    {
-      clib_memcpy_fast (s->tx_fifo->data, txf->data, txf->nitems);
-      s->tx_fifo->head = txf->head;
-      s->tx_fifo->tail = txf->tail;
-      s->tx_fifo->cursize = txf->cursize;
-    }
+  if (!svm_fifo_is_empty_cons (txf))
+    svm_fifo_clone (s->tx_fifo, txf);
 
   segment_manager_dealloc_fifos (rxf, txf);
 
@@ -397,6 +441,15 @@ app_worker_connect_session (app_worker_t * app, session_endpoint_t * sep,
   return 0;
 }
 
+int
+app_worker_session_fifo_tuning (app_worker_t * app_wrk, session_t * s,
+                               svm_fifo_t * f,
+                               session_ft_action_t act, u32 len)
+{
+  application_t *app = application_get (app_wrk->app_index);
+  return app->cb_fns.fifo_tuning_callback (s, f, act, len);
+}
+
 int
 app_worker_alloc_connects_segment_manager (app_worker_t * app_wrk)
 {
@@ -433,7 +486,7 @@ app_worker_get_listen_segment_manager (app_worker_t * app,
 {
   uword *smp;
   smp = hash_get (app->listeners_table, listen_session_get_handle (listener));
-  ASSERT (smp != 0);
+  ALWAYS_ASSERT (smp != 0);
   return segment_manager_get (*smp);
 }
 
@@ -491,7 +544,8 @@ int
 app_worker_add_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
 {
   application_t *app = application_get (app_wrk->app_index);
-  return app->cb_fns.add_segment_callback (app_wrk->api_client_index,
+
+  return app->cb_fns.add_segment_callback (app_wrk->wrk_index,
                                           segment_handle);
 }
 
@@ -499,7 +553,7 @@ int
 app_worker_del_segment_notify (app_worker_t * app_wrk, u64 segment_handle)
 {
   application_t *app = application_get (app_wrk->app_index);
-  return app->cb_fns.del_segment_callback (app_wrk->api_client_index,
+  return app->cb_fns.del_segment_callback (app_wrk->wrk_index,
                                           segment_handle);
 }
 
@@ -510,138 +564,97 @@ app_worker_application_is_builtin (app_worker_t * app_wrk)
 }
 
 static inline int
-app_enqueue_evt (svm_msg_q_t * mq, svm_msg_q_msg_t * msg, u8 lock)
-{
-  if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
-    {
-      clib_warning ("evt q full");
-      svm_msg_q_free_msg (mq, msg);
-      if (lock)
-       svm_msg_q_unlock (mq);
-      return -1;
-    }
-
-  if (lock)
-    {
-      svm_msg_q_add_and_unlock (mq, msg);
-      return 0;
-    }
-
-  /* Even when not locking the ring, we must wait for queue mutex */
-  if (svm_msg_q_add (mq, msg, SVM_Q_WAIT))
-    {
-      clib_warning ("msg q add returned");
-      return -1;
-    }
-  return 0;
-}
-
-static inline int
-app_send_io_evt_rx (app_worker_t * app_wrk, session_t * s, u8 lock)
+app_send_io_evt_rx (app_worker_t * app_wrk, session_t * s)
 {
   session_event_t *evt;
   svm_msg_q_msg_t msg;
   svm_msg_q_t *mq;
 
+  if (app_worker_application_is_builtin (app_wrk))
+    return app_worker_builtin_rx (app_wrk, s);
+
+  /* Make sure the session is in established state within external apps.
+   * Should be removed once we confirm closes to apps */
   if (PREDICT_FALSE (s->session_state != SESSION_STATE_READY
                     && s->session_state != SESSION_STATE_LISTENING))
-    {
-      /* Session is closed so app will never clean up. Flush rx fifo */
-      if (s->session_state == SESSION_STATE_CLOSED)
-       svm_fifo_dequeue_drop_all (s->rx_fifo);
-      return 0;
-    }
-
-  if (app_worker_application_is_builtin (app_wrk))
-    {
-      application_t *app = application_get (app_wrk->app_index);
-      return app->cb_fns.builtin_app_rx_callback (s);
-    }
+    return 0;
 
   if (svm_fifo_has_event (s->rx_fifo))
     return 0;
 
   mq = app_wrk->event_queue;
-  if (lock)
-    svm_msg_q_lock (mq);
+  svm_msg_q_lock (mq);
+
+  if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
+    {
+      clib_warning ("evt q full");
+      svm_msg_q_unlock (mq);
+      return -1;
+    }
 
   if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
     {
       clib_warning ("evt q rings full");
-      if (lock)
-       svm_msg_q_unlock (mq);
+      svm_msg_q_unlock (mq);
       return -1;
     }
 
   msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
-  ASSERT (!svm_msg_q_msg_is_invalid (&msg));
-
   evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
   evt->session_index = s->rx_fifo->client_session_index;
   evt->event_type = SESSION_IO_EVT_RX;
 
   (void) svm_fifo_set_event (s->rx_fifo);
+  svm_msg_q_add_and_unlock (mq, &msg);
 
-  if (app_enqueue_evt (mq, &msg, lock))
-    return -1;
   return 0;
 }
 
 static inline int
-app_send_io_evt_tx (app_worker_t * app_wrk, session_t * s, u8 lock)
+app_send_io_evt_tx (app_worker_t * app_wrk, session_t * s)
 {
   svm_msg_q_t *mq;
   session_event_t *evt;
   svm_msg_q_msg_t msg;
 
   if (app_worker_application_is_builtin (app_wrk))
-    return 0;
+    return app_worker_builtin_tx (app_wrk, s);
 
   mq = app_wrk->event_queue;
-  if (lock)
-    svm_msg_q_lock (mq);
+  svm_msg_q_lock (mq);
+
+  if (PREDICT_FALSE (svm_msg_q_is_full (mq)))
+    {
+      clib_warning ("evt q full");
+      svm_msg_q_unlock (mq);
+      return -1;
+    }
 
   if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
     {
       clib_warning ("evt q rings full");
-      if (lock)
-       svm_msg_q_unlock (mq);
+      svm_msg_q_unlock (mq);
       return -1;
     }
 
   msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
-  ASSERT (!svm_msg_q_msg_is_invalid (&msg));
-
   evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
   evt->event_type = SESSION_IO_EVT_TX;
   evt->session_index = s->tx_fifo->client_session_index;
 
-  return app_enqueue_evt (mq, &msg, lock);
+  svm_msg_q_add_and_unlock (mq, &msg);
+  return 0;
 }
 
 /* *INDENT-OFF* */
 typedef int (app_send_evt_handler_fn) (app_worker_t *app,
-                                      session_t *s,
-                                      u8 lock);
+                                      session_t *s);
 static app_send_evt_handler_fn * const app_send_evt_handler_fns[2] = {
     app_send_io_evt_rx,
     app_send_io_evt_tx,
 };
 /* *INDENT-ON* */
 
-/**
- * Send event to application
- *
- * Logic from queue perspective is non-blocking. If there's
- * not enough space to enqueue a message, we return.
- */
-int
-app_worker_send_event (app_worker_t * app, session_t * s, u8 evt_type)
-{
-  ASSERT (app && evt_type <= SESSION_IO_EVT_TX);
-  return app_send_evt_handler_fns[evt_type] (app, s, 0 /* lock */ );
-}
-
 /**
  * Send event to application
  *
@@ -652,7 +665,7 @@ int
 app_worker_lock_and_send_event (app_worker_t * app, session_t * s,
                                u8 evt_type)
 {
-  return app_send_evt_handler_fns[evt_type] (app, s, 1 /* lock */ );
+  return app_send_evt_handler_fns[evt_type] (app, s);
 }
 
 u8 *
@@ -710,63 +723,20 @@ format_app_worker (u8 * s, va_list * args)
 void
 app_worker_format_connects (app_worker_t * app_wrk, int verbose)
 {
-  svm_fifo_segment_private_t *fifo_segment;
-  vlib_main_t *vm = vlib_get_main ();
   segment_manager_t *sm;
-  const u8 *app_name;
-  u8 *s = 0;
 
   /* Header */
   if (!app_wrk)
     {
-      if (verbose)
-       vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
-                        "API Client", "SegManager");
-      else
-       vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
+      segment_manager_format_sessions (0, verbose);
       return;
     }
 
   if (app_wrk->connects_seg_manager == (u32) ~ 0)
     return;
 
-  app_name = application_name_from_index (app_wrk->app_index);
-
-  /* Across all fifo segments */
   sm = segment_manager_get (app_wrk->connects_seg_manager);
-
-  /* *INDENT-OFF* */
-  segment_manager_foreach_segment_w_lock (fifo_segment, sm, ({
-    svm_fifo_t *fifo;
-    u8 *str;
-
-    fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
-    while (fifo)
-      {
-        u32 session_index, thread_index;
-        session_t *session;
-
-        session_index = fifo->master_session_index;
-        thread_index = fifo->master_thread_index;
-
-        session = session_get (session_index, thread_index);
-        str = format (0, "%U", format_session, session, verbose);
-
-        if (verbose)
-          s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
-                      app_wrk->api_client_index, app_wrk->connects_seg_manager);
-        else
-          s = format (s, "%-40s%-20s", str, app_name);
-
-        vlib_cli_output (vm, "%v", s);
-        vec_reset_length (s);
-        vec_free (str);
-
-        fifo = fifo->next;
-      }
-    vec_free (s);
-  }));
-  /* *INDENT-ON* */
+  segment_manager_format_sessions (sm, verbose);
 }
 
 /*