X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvnet%2Fsession%2Fapplication.h;h=a853c3cb73a5c2703f6880da42a3fc6b392b68ba;hb=79f89537c;hp=027d6967fd788b75dd31a45dd1e4d0aba6b3c7d2;hpb=68b0fb0c620c7451ef1a6380c43c39de6614db51;p=vpp.git

diff --git a/src/vnet/session/application.h b/src/vnet/session/application.h
index 027d6967fd7..a853c3cb73a 100644
--- a/src/vnet/session/application.h
+++ b/src/vnet/session/application.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017 Cisco and/or its affiliates.
+ * Copyright (c) 2017-2019 Cisco and/or its affiliates.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at:
@@ -16,98 +16,280 @@
 #ifndef SRC_VNET_SESSION_APPLICATION_H_
 #define SRC_VNET_SESSION_APPLICATION_H_
 
-#include <vnet/vnet.h>
-#include <vnet/session/session.h>
+#include <vnet/session/application_interface.h>
+#include <vnet/session/application_namespace.h>
+#include <vnet/session/session_types.h>
+#include <vnet/session/segment_manager.h>
 
-typedef enum
-{
-  APP_SERVER,
-  APP_CLIENT
-} application_type_t;
+#define APP_DEBUG 0
+
+#if APP_DEBUG > 0
+#define APP_DBG(_fmt, _args...) clib_warning (_fmt, ##_args)
+#else
+#define APP_DBG(_fmt, _args...)
+#endif
 
-typedef struct _stream_session_cb_vft
+typedef struct app_worker_
 {
-  /** Notify server of new segment */
-  int (*add_segment_callback) (u32 api_client_index, const u8 * seg_name,
-			       u32 seg_size);
+  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
+
+  /** Worker index in global worker pool*/
+  u32 wrk_index;
+
+  /** Worker index in app's map pool */
+  u32 wrk_map_index;
+
+  /** Index of owning app */
+  u32 app_index;
+
+  /** Application listens for events on this svm queue */
+  svm_msg_q_t *event_queue;
+
+  /** Segment manager used for outgoing connects issued by the app */
+  u32 connects_seg_manager;
 
-  /** Notify server of newly accepted session */
-  int (*session_accept_callback) (stream_session_t * new_session);
+  /** Lookup tables for listeners. Value is segment manager index */
+  uword *listeners_table;
 
-  /* Connection request callback */
-  int (*session_connected_callback) (u32 api_client_index,
-				     stream_session_t * s, u8 code);
+  /**
+   * First segment manager has in the the first segment the application's
+   * event fifo. Depending on what the app does, it may be either used for
+   * a listener or for connects.
+   */
+  u32 first_segment_manager;
+  u8 first_segment_manager_in_use;
 
-  /** Notify app that session is closing */
-  void (*session_disconnect_callback) (stream_session_t * s);
+  /** API index for the worker. Needed for multi-process apps */
+  u32 api_client_index;
 
-  /** Notify app that session was reset */
-  void (*session_reset_callback) (stream_session_t * s);
+  u8 app_is_builtin;
+} app_worker_t;
 
-  /* Direct RX callback, for built-in servers */
-  int (*builtin_server_rx_callback) (stream_session_t * session);
+typedef struct app_worker_map_
+{
+  u32 wrk_index;
+} app_worker_map_t;
 
-  /* Redirect connection to local server */
-  int (*redirect_connect_callback) (u32 api_client_index, void *mp);
-} session_cb_vft_t;
+typedef struct app_listener_
+{
+  clib_bitmap_t *workers;	/**< workers accepting connections */
+  u32 accept_rotor;		/**< last worker to accept a connection */
+  u32 al_index;			/**< app listener index in app pool */
+  u32 app_index;		/**< owning app index */
+  u32 local_index;		/**< local listening session index */
+  u32 session_index;		/**< global listening session index */
+  session_handle_t ls_handle;	/**< session handle of the local or global
+				     listening session that also identifies
+				     the app listener */
+} app_listener_t;
 
-typedef struct _application
+typedef struct application_
 {
-  /** Index in server pool */
-  u32 index;
+  /** App index in app pool */
+  u32 app_index;
 
   /** Flags */
   u32 flags;
 
-  /** Binary API connection index, ~0 if internal */
-  u32 api_client_index;
+  /** Callbacks: shoulder-taps for the server/client */
+  session_cb_vft_t cb_fns;
 
-  /* */
-  u32 api_context;
+  /** Segment manager properties. Shared by all segment managers */
+  segment_manager_props_t sm_properties;
 
-  /** Application listens for events on this svm queue */
-  unix_shared_memory_queue_t *event_queue;
+  /** Pool of mappings that keep track of workers associated to this app */
+  app_worker_map_t *worker_maps;
 
-  /** Stream session type */
-  u8 session_type;
+  /** Name registered by builtin apps */
+  u8 *name;
 
-  /* Stream server mode: accept or connect */
-  u8 mode;
+  /** Namespace the application belongs to */
+  u32 ns_index;
 
-  u32 session_manager_index;
+  u16 proxied_transports;
 
-  /*
-   * Bind/Listen specific
-   */
+  /** Pool of listeners for the app */
+  app_listener_t *listeners;
+
+  /** Preferred tls engine */
+  u8 tls_engine;
+
+  u64 *quicly_ctx;
 
-  /** Accept cookie, for multiple session flavors ($$$ maybe) */
-  u32 accept_cookie;
+} application_t;
 
-  /** Index of the listen session or connect session */
-  u32 session_index;
+typedef struct app_main_
+{
+  /**
+   * Pool from which we allocate all applications
+   */
+  application_t *app_pool;
 
-  /** Session thread index for client connect sessions */
-  u32 thread_index;
+  /**
+   * Hash table of apps by api client index
+   */
+  uword *app_by_api_client_index;
 
-  /*
-   * Callbacks: shoulder-taps for the server/client
+  /**
+   * Hash table of builtin apps by name
    */
-  session_cb_vft_t cb_fns;
-} application_t;
+  uword *app_by_name;
+
+  /**
+   * Pool from which we allocate certificates (key, cert)
+   */
+  app_cert_key_pair_t *cert_key_pair_store;
+} app_main_t;
+
+typedef struct app_init_args_
+{
+#define _(_type, _name) _type _name;
+  foreach_app_init_args
+#undef _
+} app_init_args_t;
+
+typedef struct _vnet_app_worker_add_del_args
+{
+  u32 app_index;		/**< App for which a new worker is requested */
+  u32 wrk_map_index;		/**< Index to delete or return value if add */
+  u32 api_client_index;		/**< Binary API client index */
+  ssvm_private_t *segment;	/**< First segment in segment manager */
+  u64 segment_handle;		/**< Handle for the segment */
+  svm_msg_q_t *evt_q;		/**< Worker message queue */
+  u8 is_add;			/**< Flag set if addition */
+} vnet_app_worker_add_del_args_t;
+
+#define APP_INVALID_INDEX ((u32)~0)
+#define APP_NS_INVALID_INDEX ((u32)~0)
+#define APP_INVALID_SEGMENT_MANAGER_INDEX ((u32) ~0)
+
+app_listener_t *app_listener_get (application_t * app, u32 al_index);
+int app_listener_alloc_and_init (application_t * app,
+				 session_endpoint_cfg_t * sep,
+				 app_listener_t ** listener);
+void app_listener_cleanup (app_listener_t * app_listener);
+session_handle_t app_listener_handle (app_listener_t * app_listener);
+app_listener_t *app_listener_lookup (application_t * app,
+				     session_endpoint_cfg_t * sep);
+
+/**
+ * Get app listener handle for listening session
+ *
+ * For a given listening session, this can return either the session
+ * handle of the app listener associated to the listening session or,
+ * if no such app listener exists, the session's handle
+ *
+ * @param ls		listening session
+ * @return		app listener or listening session handle
+ */
+session_handle_t app_listen_session_handle (session_t * ls);
+/**
+ * Get app listener for listener session handle
+ *
+ * Should only be called on handles that have an app listener, i.e.,
+ * were obtained at the end of a @ref vnet_listen call.
+ *
+ * @param handle	handle of the app listener. This is the handle of
+ * 			either the global or local listener
+ * @return		pointer to app listener or 0
+ */
+app_listener_t *app_listener_get_w_handle (session_handle_t handle);
+app_listener_t *app_listener_get_w_session (session_t * ls);
+session_t *app_listener_get_session (app_listener_t * al);
+session_t *app_listener_get_local_session (app_listener_t * al);
 
-application_t *application_new (application_type_t type, session_type_t sst,
-				u32 api_client_index, u32 flags,
-				session_cb_vft_t * cb_fns);
-void application_del (application_t * app);
 application_t *application_get (u32 index);
+application_t *application_get_if_valid (u32 index);
 application_t *application_lookup (u32 api_client_index);
-u32 application_get_index (application_t * app);
+application_t *application_lookup_name (const u8 * name);
+app_worker_t *application_get_worker (application_t * app, u32 wrk_index);
+app_worker_t *application_get_default_worker (application_t * app);
+app_worker_t *application_listener_select_worker (session_t * ls);
+int application_change_listener_owner (session_t * s, app_worker_t * app_wrk);
+int application_is_proxy (application_t * app);
+int application_is_builtin (application_t * app);
+int application_is_builtin_proxy (application_t * app);
+u32 application_session_table (application_t * app, u8 fib_proto);
+u32 application_local_session_table (application_t * app);
+const u8 *application_name_from_index (u32 app_or_wrk);
+u8 application_has_local_scope (application_t * app);
+u8 application_has_global_scope (application_t * app);
+void application_setup_proxy (application_t * app);
+void application_remove_proxy (application_t * app);
+
+segment_manager_props_t *application_get_segment_manager_properties (u32
+								     app_index);
+
+segment_manager_props_t
+  * application_segment_manager_properties (application_t * app);
+
+/*
+ * App worker
+ */
+
+app_worker_t *app_worker_alloc (application_t * app);
+int application_alloc_worker_and_init (application_t * app,
+				       app_worker_t ** wrk);
+app_worker_t *app_worker_get (u32 wrk_index);
+app_worker_t *app_worker_get_if_valid (u32 wrk_index);
+application_t *app_worker_get_app (u32 wrk_index);
+int app_worker_own_session (app_worker_t * app_wrk, session_t * s);
+void app_worker_free (app_worker_t * app_wrk);
+int app_worker_connect_session (app_worker_t * app, session_endpoint_t * tep,
+				u32 api_context);
+int app_worker_start_listen (app_worker_t * app_wrk, app_listener_t * lstnr);
+int app_worker_stop_listen (app_worker_t * app_wrk, app_listener_t * al);
+int app_worker_init_accepted (session_t * s);
+int app_worker_accept_notify (app_worker_t * app_wrk, session_t * s);
+int app_worker_init_connected (app_worker_t * app_wrk, session_t * s);
+int app_worker_connect_notify (app_worker_t * app_wrk, session_t * s,
+			       u32 opaque);
+int app_worker_close_notify (app_worker_t * app_wrk, session_t * s);
+int app_worker_transport_closed_notify (app_worker_t * app_wrk,
+					session_t * s);
+int app_worker_reset_notify (app_worker_t * app_wrk, session_t * s);
+int app_worker_cleanup_notify (app_worker_t * app_wrk, session_t * s,
+			       session_cleanup_ntf_t ntf);
+int app_worker_migrate_notify (app_worker_t * app_wrk, session_t * s,
+			       session_handle_t new_sh);
+int app_worker_builtin_rx (app_worker_t * app_wrk, session_t * s);
+int app_worker_builtin_tx (app_worker_t * app_wrk, session_t * s);
+segment_manager_t *app_worker_get_listen_segment_manager (app_worker_t *,
+							  session_t *);
+segment_manager_t *app_worker_get_connect_segment_manager (app_worker_t *);
+segment_manager_t
+  * app_worker_get_or_alloc_connect_segment_manager (app_worker_t *);
+int app_worker_alloc_connects_segment_manager (app_worker_t * app);
+int app_worker_add_segment_notify (app_worker_t * app_wrk,
+				   u64 segment_handle);
+int app_worker_del_segment_notify (app_worker_t * app_wrk,
+				   u64 segment_handle);
+u32 app_worker_n_listeners (app_worker_t * app);
+session_t *app_worker_first_listener (app_worker_t * app,
+				      u8 fib_proto, u8 transport_proto);
+int app_worker_send_event (app_worker_t * app, session_t * s, u8 evt);
+int app_worker_lock_and_send_event (app_worker_t * app, session_t * s,
+				    u8 evt_type);
+session_t *app_worker_proxy_listener (app_worker_t * app, u8 fib_proto,
+				      u8 transport_proto);
+u8 *format_app_worker (u8 * s, va_list * args);
+u8 *format_app_worker_listener (u8 * s, va_list * args);
+void app_worker_format_connects (app_worker_t * app_wrk, int verbose);
+int vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a);
+
+uword unformat_application_proto (unformat_input_t * input, va_list * args);
+
+app_cert_key_pair_t *app_cert_key_pair_get (u32 index);
+app_cert_key_pair_t *app_cert_key_pair_get_if_valid (u32 index);
+app_cert_key_pair_t *app_cert_key_pair_get_default ();
 
-int
-application_server_init (application_t * server, u32 segment_size,
-			 u32 add_segment_size, u32 rx_fifo_size,
-			 u32 tx_fifo_size, u8 ** segment_name);
-int application_api_queue_is_full (application_t * app);
+/* Needed while we support both bapi and mq ctrl messages */
+int mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
+			      session_handle_t handle, int rv);
+int mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
+				  session_t * s, u8 is_fail);
+void mq_send_unlisten_reply (app_worker_t * app_wrk, session_handle_t sh,
+			     u32 context, int rv);
 
 #endif /* SRC_VNET_SESSION_APPLICATION_H_ */