summaryrefslogtreecommitdiffstats
path: root/LICENSE
blob: 7a4a3ea2424c09fbe48d455aed1eaa94d9124835 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright [yyyy] [name of copyright owner]

   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

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
ion); } session_cb_vft_t; typedef struct app_worker_ { 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; /** Lookup tables for listeners. Value is segment manager index */ uword *listeners_table; /** * 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; /* * Local "cut through" connections specific */ /** Segment manager used for incoming "cut through" connects */ u32 local_segment_manager; /** Pool of local sessions the app owns (as a server) */ local_session_t *local_sessions; /** Hash table of the app's local connects */ uword *local_connects; u8 app_is_builtin; } app_worker_t; typedef struct app_worker_map_ { u32 wrk_index; } app_worker_map_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_t; typedef struct application_ { /** App index in app pool */ u32 app_index; /** Binary API connection index, ~0 if internal */ u32 api_client_index; /** Flags */ u32 flags; /** Callbacks: shoulder-taps for the server/client */ session_cb_vft_t cb_fns; /** Segment manager properties. Shared by all segment managers */ segment_manager_properties_t sm_properties; /** Pool of mappings that keep track of workers associated to this app */ app_worker_map_t *worker_maps; /** Name registered by builtin apps */ u8 *name; /** Namespace the application belongs to */ u32 ns_index; u16 proxied_transports; /** Pool of listeners for the app */ app_listener_t *listeners; /** Pool of local listeners for app */ app_listener_t *local_listeners; /** Pool of local listen sessions */ local_session_t *local_listen_sessions; /* * TLS Specific */ /** Certificate to be used for listen sessions */ u8 *tls_cert; /** PEM encoded key */ u8 *tls_key; /** Preferred tls engine */ u8 tls_engine; } application_t; typedef struct app_main_ { /** * Pool from which we allocate all applications */ application_t *app_pool; /** * Pool of workers associated to apps */ app_worker_t *workers; /** * Hash table of apps by api client index */ uword *app_by_api_client_index; /** * Hash table of builtin apps by name */ uword *app_by_name; } app_main_t; #define foreach_app_init_args \ _(u32, api_client_index) \ _(u8 *, name) \ _(u64 *, options) \ _(u8 *, namespace_id) \ _(session_cb_vft_t *, session_cb_vft) \ _(u32, app_index) \ 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_index; /**< Index to delete or return value if add */ ssvm_private_t *segment; /**< First segment in segment manager */ 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_worker_t *app_worker_alloc (application_t * app); int app_worker_alloc_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); void app_worker_free (app_worker_t * app_wrk); int app_worker_open_session (app_worker_t * app, session_endpoint_t * tep, u32 api_context); segment_manager_t *app_worker_get_listen_segment_manager (app_worker_t *, stream_session_t *); segment_manager_t *app_worker_get_connect_segment_manager (app_worker_t *); int app_worker_alloc_connects_segment_manager (app_worker_t * app); int app_worker_add_segment_notify (u32 app_or_wrk, ssvm_private_t * fs); u32 app_worker_n_listeners (app_worker_t * app); stream_session_t *app_worker_first_listener (app_worker_t * app, u8 fib_proto, u8 transport_proto); u8 app_worker_application_is_builtin (app_worker_t * app_wrk); int app_worker_send_event (app_worker_t * app, stream_session_t * s, u8 evt); int app_worker_lock_and_send_event (app_worker_t * app, stream_session_t * s, u8 evt_type); clib_error_t *vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a); int application_start_listen (application_t * app, session_endpoint_extended_t * tep, session_handle_t * handle); int application_stop_listen (u32 app_index, u32 app_or_wrk, session_handle_t handle); application_t *application_alloc (void); int application_alloc_and_init (app_init_args_t * args); void application_free (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); application_t *application_lookup_name (const u8 * name); u32 application_index (application_t * app); 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 (stream_session_t * ls, u8 is_local); int application_api_queue_is_full (application_t * app); 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); 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); u8 application_use_mq_for_ctrl (application_t * app); void application_setup_proxy (application_t * app); void application_remove_proxy (application_t * app); segment_manager_properties_t *application_get_segment_manager_properties (u32 app_index); segment_manager_properties_t * application_segment_manager_properties (application_t * app); /* * Local session */ local_session_t *application_local_session_alloc (app_worker_t * app); void application_local_session_free (app_worker_t * app, local_session_t * ls); local_session_t *application_get_local_session (app_worker_t * app, u32 session_index); local_session_t *application_get_local_session_from_handle (session_handle_t handle); local_session_t * application_get_local_listen_session_from_handle (session_handle_t lh); int application_start_local_listen (application_t * server, session_endpoint_extended_t * sep, session_handle_t * handle); int application_stop_local_listen (u32 app_index, u32 app_or_wrk, session_handle_t lh); int application_local_session_connect (app_worker_t * client, app_worker_t * server, local_session_t * ls, u32 opaque); int application_local_session_connect_notify (local_session_t * ls); int application_local_session_disconnect (u32 app_or_wrk, local_session_t * ls); int application_local_session_disconnect_w_index (u32 app_or_wrk, u32 ls_index); void app_worker_local_sessions_free (app_worker_t * app); always_inline u32 local_session_id (local_session_t * ls) { ASSERT (ls->session_index < (2 << 16)); u32 app_or_wrk_index; if (ls->session_state == SESSION_STATE_LISTENING) { ASSERT (ls->app_index < (2 << 16)); app_or_wrk_index = ls->app_index; } else { ASSERT (ls->app_wrk_index < (2 << 16)); app_or_wrk_index = ls->app_wrk_index; } return ((u32) app_or_wrk_index << 16 | (u32) ls->session_index); } always_inline void local_session_parse_id (u32 ls_id, u32 * app_or_wrk, u32 * session_index) { *app_or_wrk = ls_id >> 16; *session_index = ls_id & 0xFF; } always_inline void local_session_parse_handle (session_handle_t handle, u32 * app_or_wrk_index, u32 * session_index) { u32 bottom; ASSERT ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX); bottom = (handle & 0xFFFFFFFF); local_session_parse_id (bottom, app_or_wrk_index, session_index); } always_inline session_handle_t application_local_session_handle (local_session_t * ls) { return ((u64) SESSION_LOCAL_HANDLE_PREFIX << 32) | (u64) local_session_id (ls); } always_inline local_session_t * application_get_local_listen_session (application_t * app, u32 session_index) { return pool_elt_at_index (app->local_listen_sessions, session_index); } always_inline local_session_t * application_get_local_listener_w_handle (session_handle_t handle) { u32 server_index, session_index; application_t *app; local_session_parse_handle (handle, &server_index, &session_index); app = application_get (server_index); return application_get_local_listen_session (app, session_index); } always_inline u8 application_local_session_listener_has_transport (local_session_t * ls) { transport_proto_t tp; tp = session_type_transport_proto (ls->listener_session_type); return (tp != TRANSPORT_PROTO_NONE); } void mq_send_local_session_disconnected_cb (u32 app_or_wrk, local_session_t * ls); uword unformat_application_proto (unformat_input_t * input, va_list * args); #endif /* SRC_VNET_SESSION_APPLICATION_H_ */ /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */