summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2018-12-17docs: Add vmxmet3 driverjdenisco3-2/+131
Change-Id: I96425804c310a1ac1b7f5f12bb636e591c7bd429 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-12-17docs: clarify vector element alignment description.Dave Wallace1-5/+8
Change-Id: I6da153779010263e6fc4b51c64b01444aaadca17 Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
2018-12-13docs: Update the requirementsjdenisco2-10/+10
Change-Id: I80ea8a65317805c6542e338a92a21e6090f6c015 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-12-06nsim: add packet loss simulation, docsDave Barach2-1/+91
Change-Id: Ic9747541aad8148ebf7d520b525b99c4cc3961f3 Signed-off-by: Dave Barach <dave@barachs.net>
2018-12-06DOC-ONLY: MFIB documentationNeale Ranns4-5/+96
Change-Id: I8c7277584f231dd4732a4c6013e156a5bb821f41 Signed-off-by: Neale Ranns <nranns@cisco.com>
2018-12-05DOC ONLY: describe dispatch pcap tracingDave Barach3-2/+263
and wireshark dissection of these traces. Change-Id: I61029fd20d6d5f6c40638e3ea9223f2354abedba Signed-off-by: Dave Barach <dave@barachs.net>
2018-11-27docs: Add more on trexjdenisco7-22/+225
Change-Id: Ifb5eabe30e1b0ba911ddf455573cc346ff4bec85 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-11-23doc: delete wrong description since VPP support 1G hugepageYulong Pei1-3/+3
Change-Id: Ib673f8059f47d8e2e86ad810a354ddf630f557cf Signed-off-by: Yulong Pei <yulong.pei@intel.com>
2018-11-13docs and Config utility, package cloud supportjdenisco2-2/+6
Change-Id: I61303242b73e509df42dedba54f2ee5906a7e526 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-11-13vlib rename vlib_frame_args(...) to vlib_frame_scalar_args(..)Damjan Marion1-1/+1
Typically we have scalar_size == 0, so it doesn't matter but vlib_frame_args was providing pointer to scalar frame data, not vector data. To avoid future confusion function is renamed to vlib_frame_scalar_args(...) Change-Id: I48b75523b46d487feea24f3f3cb10c528dde516f Signed-off-by: Damjan Marion <damarion@cisco.com>
2018-11-12docs: add 1810, including package cloudjdenisco10-131/+178
Change-Id: Ieae5fc7c1e099392bc2a4e5948669d9210f2ebac Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-11-06docs: Add version and build datejdenisco3-0/+15
Change-Id: I6fd53d3ef12e4b6f1af1e5605c09938bce324ec9 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-11-06docs: Small changes to plugin, updated the requirementsjdenisco4-47/+32
Change-Id: I3c05a28991d01e726d4fa8580a720359a2d4ce91 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-10-30DOC-ONLY: document packet intialization from scratchDave Barach2-40/+126
Minor clean-up in the home gateway use-case documentation Change-Id: I7d3aaea8cec62248daf7814b21a8acb574ac12a1 Signed-off-by: Dave Barach <dave@barachs.net>
2018-10-30docs: Add VPP with iperf and trexjdenisco12-3/+554
Change-Id: I9f238b6092bc072fd875facfee5262c6b155043e Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-10-30DOC-ONLY: upgrade the "requests" packageDave Barach1-1/+1
requests 2.18.4 is the subject of a security alert Change-Id: Id1e9338d86bced8c0bb065db7b3dc7f02aa41afc Signed-off-by: Dave Barach <dave@barachs.net>
2018-10-26docs: add useful debug CLI Review UpdatesScott Keeler12-733/+755
Change-Id: I4ebd977672090f2a7fc08bb139832df39614564a Signed-off-by: Scott Keeler <skeeler@cisco.com>
2018-10-24docs: add useful debug CLIScott Keeler16-249/+1058
Change-Id: I5ef9ecd741f1623ae1b7a23fa0a4fa6db7e243a3 Signed-off-by: Scott Keeler <skeeler@cisco.com>
2018-10-24DOC ONLY: fix doc bugsDave Barach2-40/+44
multiarch support: change autotools -> cmake getting a patch reviewed: improve patch conflict resolution section Change-Id: I2f07e1d3f21dd8cefb4d4bb3b451965d9314211a Signed-off-by: Dave Barach <dave@barachs.net>
2018-10-22add Contiv-VPP installation guidance on Aarch64Lijian Zhang1-0/+10
add Contiv-VPP installation guidance on Aarch64 Change-Id: I323c871d346c47396916a618934c5e169ee49212 Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com> Reviewed-by: Song Zhu <Song.Zhu@arm.com> Reviewed-by: Trevor Tao <Trevor.Tao@arm.com> Reviewed-by: Sirshak Das <Sirshak.Das@arm.com> Reviewed-by: Tina Tsou <Tina.Tsou@arm.com>
2018-10-05DOC ONLY: clean up plugin documentationDave Barach4-175/+277
The old "sample_plugin" page was stuffed with superceded autotools build information, so it morphed into an "add a new plugin" page based on the emacs-lisp plugin generator. Before sending hate mail about emacs, please *look* at the new document: you'll find running the plugin generator hard to tell from running a shell script. Change-Id: I84da45675e838c05faeca05c8f7be45d8c7bff13 Signed-off-by: Dave Barach <dave@barachs.net>
2018-10-05docs: add contiv vppScott Keeler19-0/+2632
Change-Id: I92227fc4968fc6a478beb7f38707b91e9f0635ec Signed-off-by: Scott Keeler <skeeler@cisco.com>
2018-09-24Add the sphinx docs build optionsjdenisco2-8/+26
Change-Id: If7ac5b41ca4ac602a100b616b37d07f658fd6a90 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-09-18docs: Added Related Projects and Archivejdenisco4-10/+102
Change-Id: I9a6076aa53d810ec44761d9f9459eb91f2c05974 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-09-12Always use 'lib' instead of 'lib64'Damjan Marion3-4/+4
It is packaging responsibility to put libs in the right place. Use of lib64 resulted in huge amount of files with hardcoded lib64. This patch simplifies things... Change-Id: Iab0dea0583e480907732c5d2379eb951a00fa9e6 Signed-off-by: Damjan Marion <damarion@cisco.com>
2018-09-07docs: what is vpp and features and performanceScott Keeler10-29/+54
Change-Id: I5a9ae39ed0429b3de001b5109268d577a281cd46 Signed-off-by: Scott Keeler <skeeler@cisco.com>
2018-09-06DOC ONLY: cmake / ninja build system docDave Barach2-1/+188
Change-Id: I69cdcf3f0940f8a5f60203034688a0c63446f65c Signed-off-by: Dave Barach <dave@barachs.net>
2018-08-31Docs: update MPLS FIB section with text from the wikiNeale Ranns1-49/+152
Change-Id: I9d903db89facc916fb5dd23d564417230e1c76e0 Signed-off-by: Neale Ranns <nranns@cisco.com>
2018-08-30docs: Add features by release sectionScitt Keeler12-0/+706
Change-Id: Ibcae8c8ecdf8a3c2d7bcf96bf7cd5b741e2fad22 Signed-off-by: Scitt Keeler <skeeler@cisco.com>
2018-08-30docs: FIB 2.0 startjdenisco26-1/+745
Change-Id: I87cd2eae133c9f5b9f7764a0f7a41bcc28523e4c Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-08-27docs: Finish event logger, viewer and cleanup.John DeNisco17-142/+346
Change-Id: I3de038439bf0ab5755777c0f4930aec0514f5b63 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-17docs: Moved installing up a level, removed guides.John DeNisco14-98/+25
Change-Id: Ie4b2939b693698585f1f2d12391a0009e80bac0b Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-17Update AArch64 CSIT machines into FD.io VPP docsLijian Zhang2-2/+11
The outlook will appear as below. The FD.io CSIT is implemented with below platforms: x86/64 ARM-AArch64 Huawei TaiShan 2280 Marvell MACCHIATObin Change-Id: Ie84a99c53a0fc2186ea6992baca9558b6d96c7f8 Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
2018-08-17docs: Rework the VPP progressive Tutorial.John DeNisco21-471/+394
Change-Id: If5b0d07ea90d978c6b1f11210a661876b7929653 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-14DOCS: Moved multiarch and build system, Incorprated Scott's changesJohn DeNisco25-101/+130
Change-Id: I5a57846db2d4faac1aa24db4629b612657f59afb Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-14DOCS: Updated startup.conf parametersandrew1-69/+174
Change-Id: Id1f4ff7409e8a833b8f7e6030d7287d8c1274c2d Signed-off-by: andrew <andrew.olechtchouk@gmail.com>
2018-08-13DOCS: Cleanup Getting StartedJohn DeNisco11-253/+97
Change-Id: I4766773779f8d5c30a24bfed48090d7305c80ec5 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-10DOC-ONLY: document latest multi-arch support schemeDave Barach3-0/+172
Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I613415c109f648248ee04dd76d5e652dbf21bc7f
2018-08-10DOC-ONLY: build system detailsDave Barach5-0/+382
The tables need some TLC from someone familiar with making pretty tables. Fixed text-wrapping onto newlines for all tables in our docs. Changed Environment Variables to ENV Variables so that the specific column header fits properly. Change-Id: Ie758612e561eefe44e771dac63b63bf026a52c2d Signed-off-by: Dave Barach <dave@barachs.net>
2018-08-10docs: A little cleanup and added some gdb examples.andrew4-18/+210
docs: Added section on running VPP for developers. Change-Id: I98b5c6f1c9fee60b297e3947e78ec33f950f598a Signed-off-by: andrew <andrew.olechtchouk@gmail.com>
2018-08-09DOCS: General cleanup (did not move any sections)andrew7-53/+60
Change-Id: I67cc42769661c10d2793f8c6cdb3b232b803d145 Signed-off-by: andrew <andrew.olechtchouk@gmail.com>
2018-08-09DOCS: modified writing docs sectionjavierfernandezvalles1-1/+1
Change-Id: Ic3ec16dba1a6374785f25f622b2cdc9b6415a13b Signed-off-by: javierfernandezvalles <JaviervallesF@gmail.com>
2018-08-09DOCS: Restructure EventsJohn DeNisco93-866/+270
Change-Id: I135ced20b58cdb72fbd0784015af037bb6e7ad28 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-08DOC ONLY: Add a new doc for integrating a plugin with VPPandrew4-0/+710
Convert doxygen docs (vpp api module and binary api support) to .rst Added a brief explanation of binary api message numbering for plugins Change-Id: If7d37f29aa65a884b51f3d27957f80d1357ed29b Signed-off-by: andrew <andrew.olechtchouk@gmail.com> Signed-off-by: Dave Barach <dave@barachs.net>
2018-08-07docs: Cleaned up a little removed instructions for mac.andrew1-22/+89
docs: Updated section on using git-review Change-Id: I180f67e3478b57b1de03df95fc67a0cfdd44dfb5 Signed-off-by: andrew <andrew.olechtchouk@gmail.com>
2018-08-07DOC ONLY: document bihash table walker rulesDave Barach1-0/+35
Change-Id: I0c48e0f4b87065d8f42009e2cc9709c6b7f5e851 Signed-off-by: Dave Barach <dave@barachs.net>
2018-08-03Added missing fileJohn DeNisco13-1352/+1372
docs: Incorporate Javier's progressive VPP tutorial Change-Id: Iecee041039c7ed81713bc0530fc536e989c71497 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-03docs: Incororate Scott's overall reviewJohn DeNisco22-78/+146
Change-Id: Ic70a62e17891fa9291a5274400ae89f1d6194b6e Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-01docs: change code blocks from "shell" to "console"John DeNisco7-47/+47
Change-Id: I136fccfc06e07fb68d11df686c59687362fb8827 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-07-27Fix .gitignore so docs/Makefile is not ignored. Add README and Makefile. Fis ↵John DeNisco3-11/+80
gitreview. Change-Id: I3d664d9c881ce127a09b9d68c1181a7098a39074 Signed-off-by: John DeNisco <jdenisco@cisco.com>
>++])) goto failed; if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT) { segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name); rv = vcl_segment_attach (segment_handle, segment_name, SSVM_SEGMENT_MEMFD, fds[n_fds++]); vec_free (segment_name); if (rv != 0) goto failed; } vcl_segment_attach_mq (segment_handle, mp->app_mq, 0, &wrk->app_event_queue); if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD) { svm_msg_q_set_eventfd (wrk->app_event_queue, fds[n_fds]); vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue); n_fds++; } vcl_segment_discover_mqs (vcl_vpp_worker_segment_handle (0), fds + n_fds, mp->n_fds - n_fds); vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0), mp->vpp_ctrl_mq, mp->vpp_ctrl_mq_thread, &wrk->ctrl_mq); vcm->ctrl_mq = wrk->ctrl_mq; vec_free (fds); } else { segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name); rv = vcl_segment_attach (segment_handle, segment_name, SSVM_SEGMENT_SHM, -1); vec_free (segment_name); if (rv != 0) goto failed; } vcm->app_index = clib_net_to_host_u32 (mp->app_index); wrk->bapi_app_state = STATE_APP_ATTACHED; return; failed: wrk->bapi_app_state = STATE_APP_FAILED; for (i = clib_max (n_fds - 1, 0); i < vec_len (fds); i++) close (fds[i]); vec_free (fds); } static void vl_api_app_worker_add_del_reply_t_handler (vl_api_app_worker_add_del_reply_t * mp) { int n_fds = 0, *fds = 0, i, rv; u64 segment_handle; vcl_worker_t *wrk; u32 wrk_index; char *segment_name = 0; if (!mp->is_add) return; wrk_index = mp->context; wrk = vcl_worker_get_if_valid (wrk_index); if (!wrk) return; if (mp->retval) { clib_warning ("VCL<%d>: add/del worker failed: %U", getpid (), format_api_error, ntohl (mp->retval)); goto failed; } vcl_set_worker_index (wrk_index); wrk->vpp_wrk_index = clib_net_to_host_u32 (mp->wrk_index); wrk->ctrl_mq = vcm->ctrl_mq; segment_handle = clib_net_to_host_u64 (mp->segment_handle); if (segment_handle == VCL_INVALID_SEGMENT_HANDLE) { clib_warning ("invalid segment handle"); goto failed; } if (mp->n_fds) { vec_validate (fds, mp->n_fds); if (vl_socket_client_recv_fd_msg2 (&wrk->bapi_sock_ctx, fds, mp->n_fds, 5)) goto failed; if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT) if (vcl_segment_attach (vcl_vpp_worker_segment_handle (wrk_index), "vpp-worker-seg", SSVM_SEGMENT_MEMFD, fds[n_fds++])) goto failed; if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT) { segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name); rv = vcl_segment_attach (segment_handle, segment_name, SSVM_SEGMENT_MEMFD, fds[n_fds++]); vec_free (segment_name); if (rv != 0) goto failed; } vcl_segment_attach_mq (segment_handle, mp->app_event_queue_address, 0, &wrk->app_event_queue); if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD) { svm_msg_q_set_eventfd (wrk->app_event_queue, fds[n_fds]); vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue); n_fds++; } vec_free (fds); } else { segment_name = vl_api_from_api_to_new_c_string (&mp->segment_name); rv = vcl_segment_attach (segment_handle, segment_name, SSVM_SEGMENT_SHM, -1); vec_free (segment_name); if (rv != 0) goto failed; } wrk->bapi_app_state = STATE_APP_READY; VDBG (0, "worker %u vpp-worker %u added", wrk_index, wrk->vpp_wrk_index); return; failed: wrk->bapi_app_state = STATE_APP_FAILED; for (i = clib_max (n_fds - 1, 0); i < vec_len (fds); i++) close (fds[i]); vec_free (fds); } static void vl_api_app_add_cert_key_pair_reply_t_handler ( vl_api_app_add_cert_key_pair_reply_t *mp) { vcl_worker_t *wrk = vcl_worker_get_current (); if (mp->retval) { VDBG (0, "Adding cert and key failed: %U", format_api_error, ntohl (mp->retval)); return; } wrk->bapi_return = clib_net_to_host_u32 (mp->index); wrk->bapi_app_state = STATE_APP_READY; } static void vl_api_app_del_cert_key_pair_reply_t_handler ( vl_api_app_del_cert_key_pair_reply_t *mp) { if (mp->retval) { VDBG (0, "Deleting cert and key failed: %U", format_api_error, ntohl (mp->retval)); return; } } #define foreach_sock_msg \ _ (SESSION_ENABLE_DISABLE_REPLY, session_enable_disable_reply) \ _ (APP_ATTACH_REPLY, app_attach_reply) \ _ (APP_ADD_CERT_KEY_PAIR_REPLY, app_add_cert_key_pair_reply) \ _ (APP_DEL_CERT_KEY_PAIR_REPLY, app_del_cert_key_pair_reply) \ _ (APP_WORKER_ADD_DEL_REPLY, app_worker_add_del_reply) #define vl_print(handle, ...) fformat (handle, __VA_ARGS__) #define vl_endianfun /* define message structures */ #include <vnet/session/session.api.h> #undef vl_endianfun #define vl_calcsizefun #include <vnet/session/session.api.h> #undef vl_calcsizefun /* instantiate all the print functions we know about */ #define vl_printfun #include <vnet/session/session.api.h> #undef vl_printfun #define vl_api_version(n, v) static u32 api_version = v; #include <vnet/session/session.api.h> #undef vl_api_version static void vcl_bapi_hookup (void) { u8 *msg_base_lookup_name = format (0, "session_%08x%c", api_version, 0); REPLY_MSG_ID_BASE = vl_client_get_first_plugin_msg_id ((char *) msg_base_lookup_name); vec_free (msg_base_lookup_name); if (REPLY_MSG_ID_BASE == (u16) ~0) return; #define _(N, n) \ vl_msg_api_set_handlers ( \ REPLY_MSG_ID_BASE + VL_API_##N, #n, vl_api_##n##_t_handler, \ vl_noop_handler, vl_api_##n##_t_endian, vl_api_##n##_t_print, \ sizeof (vl_api_##n##_t), 1, vl_api_##n##_t_print_json, \ vl_api_##n##_t_tojson, vl_api_##n##_t_fromjson, \ vl_api_##n##_t_calc_size); foreach_sock_msg; #undef _ } /* * VPP-API message functions */ static void vcl_bapi_send_session_enable_disable (u8 is_enable) { vcl_worker_t *wrk = vcl_worker_get_current (); vl_api_session_enable_disable_t *bmp; bmp = vl_msg_api_alloc (sizeof (*bmp)); memset (bmp, 0, sizeof (*bmp)); bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_SESSION_ENABLE_DISABLE); bmp->client_index = wrk->api_client_handle; bmp->context = htonl (0xfeedface); bmp->is_enable = is_enable; vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp); } void vcl_bapi_send_attach (void) { vcl_worker_t *wrk = vcl_worker_get_current (); u8 tls_engine = CRYPTO_ENGINE_OPENSSL; vl_api_app_attach_t *bmp; u8 nsid_len = vec_len (vcm->cfg.namespace_id); u8 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp || vcm->cfg.app_proxy_transport_udp); tls_engine = vcm->cfg.tls_engine ? vcm->cfg.tls_engine : tls_engine; bmp = vl_msg_api_alloc (sizeof (*bmp)); memset (bmp, 0, sizeof (*bmp)); bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_ATTACH); bmp->client_index = wrk->api_client_handle; bmp->context = htonl (0xfeedface); bmp->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT | (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) | (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) | (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0) | (vcm->cfg.use_mq_eventfd ? APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD : 0); bmp->options[APP_OPTIONS_PROXY_TRANSPORT] = (u64) ((vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) | (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0)); bmp->options[APP_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size; bmp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size; bmp->options[APP_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size; bmp->options[APP_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size; bmp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] = vcm->cfg.preallocated_fifo_pairs; bmp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = vcm->cfg.event_queue_size; bmp->options[APP_OPTIONS_TLS_ENGINE] = tls_engine; if (nsid_len) { vl_api_vec_to_api_string (vcm->cfg.namespace_id, &bmp->namespace_id); bmp->options[APP_OPTIONS_NAMESPACE_SECRET] = vcm->cfg.namespace_secret; } vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp); } void vcl_bapi_send_detach (void) { vcl_worker_t *wrk = vcl_worker_get_current (); vl_api_application_detach_t *bmp; bmp = vl_msg_api_alloc (sizeof (*bmp)); memset (bmp, 0, sizeof (*bmp)); bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APPLICATION_DETACH); bmp->client_index = wrk->api_client_handle; bmp->context = htonl (0xfeedface); vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & bmp); } static void vcl_bapi_send_app_worker_add_del (u8 is_add) { vcl_worker_t *wrk = vcl_worker_get_current (); vl_api_app_worker_add_del_t *mp; mp = vl_msg_api_alloc (sizeof (*mp)); memset (mp, 0, sizeof (*mp)); mp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_WORKER_ADD_DEL); mp->client_index = wrk->api_client_handle; mp->app_index = clib_host_to_net_u32 (vcm->app_index); mp->context = wrk->wrk_index; mp->is_add = is_add; if (!is_add) mp->wrk_index = clib_host_to_net_u32 (wrk->vpp_wrk_index); vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp); } static void vcl_bapi_send_child_worker_del (vcl_worker_t * child_wrk) { vcl_worker_t *wrk = vcl_worker_get_current (); vl_api_app_worker_add_del_t *mp; mp = vl_msg_api_alloc (sizeof (*mp)); memset (mp, 0, sizeof (*mp)); mp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_WORKER_ADD_DEL); mp->client_index = wrk->api_client_handle; mp->app_index = clib_host_to_net_u32 (vcm->app_index); mp->context = wrk->wrk_index; mp->is_add = 0; mp->wrk_index = clib_host_to_net_u32 (child_wrk->vpp_wrk_index); vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) & mp); } static void vcl_bapi_send_app_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair) { vcl_worker_t *wrk = vcl_worker_get_current (); u32 cert_len = ckpair->cert_len; u32 key_len = ckpair->key_len; vl_api_app_add_cert_key_pair_t *bmp; bmp = vl_msg_api_alloc (sizeof (*bmp) + cert_len + key_len); clib_memset (bmp, 0, sizeof (*bmp) + cert_len + key_len); bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_ADD_CERT_KEY_PAIR); bmp->client_index = wrk->api_client_handle; bmp->context = wrk->wrk_index; bmp->cert_len = clib_host_to_net_u16 (cert_len); bmp->certkey_len = clib_host_to_net_u16 (key_len + cert_len); clib_memcpy_fast (bmp->certkey, ckpair->cert, cert_len); clib_memcpy_fast (bmp->certkey + cert_len, ckpair->key, key_len); vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) &bmp); } static void vcl_bapi_send_app_del_cert_key_pair (u32 ckpair_index) { vcl_worker_t *wrk = vcl_worker_get_current (); vl_api_app_del_cert_key_pair_t *bmp; bmp = vl_msg_api_alloc (sizeof (*bmp)); clib_memset (bmp, 0, sizeof (*bmp)); bmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_APP_DEL_CERT_KEY_PAIR); bmp->client_index = wrk->api_client_handle; bmp->context = wrk->wrk_index; bmp->index = clib_host_to_net_u32 (ckpair_index); vl_msg_api_send_shmem (wrk->vl_input_queue, (u8 *) &bmp); } u32 vcl_bapi_max_nsid_len (void) { vl_api_app_attach_t *mp; return (sizeof (mp->namespace_id) - 1); } static void vcl_bapi_init_error_string_table (void) { vcm->error_string_by_error_number = hash_create (0, sizeof (uword)); #define _(n, v, s) hash_set (vcm->error_string_by_error_number, -v, s); foreach_vnet_api_error; #undef _ hash_set (vcm->error_string_by_error_number, 99, "Misc"); } static void vcl_bapi_cleanup (void) { socket_client_main_t *scm = &socket_client_main; api_main_t *am = vlibapi_get_main (); am->my_client_index = ~0; am->my_registration = 0; am->vl_input_queue = 0; am->msg_index_by_name_and_crc = 0; scm->socket_fd = 0; vl_client_api_unmap (); } static int vcl_bapi_connect_to_vpp (void) { vcl_worker_t *wrk = vcl_worker_get_current (); vppcom_cfg_t *vcl_cfg = &vcm->cfg; int rv = VPPCOM_OK; api_main_t *am; u8 *wrk_name; wrk_name = format (0, "%v-wrk-%u%c", vcm->app_name, wrk->wrk_index, 0); /* Make sure api is cleaned up in case this is a connect from a * forked worker */ vcl_bapi_cleanup (); vlibapi_set_main (&wrk->bapi_api_ctx); vlibapi_set_memory_client_main (&wrk->bapi_mem_ctx); if (!vcl_cfg->vpp_bapi_socket_name) { rv = VPPCOM_EINVAL; goto error; } if (vl_socket_client_connect2 (&wrk->bapi_sock_ctx, (char *) vcl_cfg->vpp_bapi_socket_name, (char *) wrk_name, 0 /* default rx/tx buffer */ )) { VERR ("app (%s) socket connect failed!", wrk_name); rv = VPPCOM_ECONNREFUSED; goto error; } if (vl_socket_client_init_shm2 (&wrk->bapi_sock_ctx, 0, 1 /* want_pthread */ )) { VERR ("app (%s) init shm failed!", wrk_name); rv = VPPCOM_ECONNREFUSED; goto error; } vcl_bapi_hookup (); am = vlibapi_get_main (); wrk->vl_input_queue = am->shmem_hdr->vl_input_queue; wrk->api_client_handle = (u32) am->my_client_index; VDBG (0, "app (%s) is connected to VPP!", wrk_name); vcl_evt (VCL_EVT_INIT, vcm); error: vec_free (wrk_name); return rv; } void vcl_bapi_disconnect_from_vpp (void) { vcl_worker_t *wrk = vcl_worker_get_current (); vppcom_cfg_t *vcl_cfg = &vcm->cfg; if (vcl_cfg->vpp_bapi_socket_name) vl_socket_client_disconnect2 (&wrk->bapi_sock_ctx); else vl_client_disconnect_from_vlib (); } static const char * vcl_bapi_app_state_str (vcl_bapi_app_state_t state) { char *st; switch (state) { case STATE_APP_START: st = "STATE_APP_START"; break; case STATE_APP_CONN_VPP: st = "STATE_APP_CONN_VPP"; break; case STATE_APP_ENABLED: st = "STATE_APP_ENABLED"; break; case STATE_APP_ATTACHED: st = "STATE_APP_ATTACHED"; break; default: st = "UNKNOWN_APP_STATE"; break; } return st; } static int vcl_bapi_wait_for_wrk_state_change (vcl_bapi_app_state_t app_state) { vcl_worker_t *wrk = vcl_worker_get_current (); f64 timeout = clib_time_now (&wrk->clib_time) + vcm->cfg.app_timeout; while (clib_time_now (&wrk->clib_time) < timeout) { if (wrk->bapi_app_state == app_state) return VPPCOM_OK; if (wrk->bapi_app_state == STATE_APP_FAILED) return VPPCOM_ECONNABORTED; } VDBG (0, "timeout waiting for state %s, current state %d", vcl_bapi_app_state_str (app_state), wrk->bapi_app_state); vcl_evt (VCL_EVT_SESSION_TIMEOUT, vcm, bapi_app_state); return VPPCOM_ETIMEDOUT; } static int vcl_bapi_session_enable (void) { vcl_worker_t *wrk = vcl_worker_get_current (); int rv; if (wrk->bapi_app_state != STATE_APP_ENABLED) { vcl_bapi_send_session_enable_disable (1 /* is_enabled == TRUE */ ); rv = vcl_bapi_wait_for_wrk_state_change (STATE_APP_ENABLED); if (PREDICT_FALSE (rv)) { VDBG (0, "application session enable timed out! returning %d (%s)", rv, vppcom_retval_str (rv)); return rv; } } return VPPCOM_OK; } static int vcl_bapi_init (void) { vcl_worker_t *wrk = vcl_worker_get_current (); int rv; wrk->bapi_app_state = STATE_APP_START; vcl_bapi_init_error_string_table (); rv = vcl_bapi_connect_to_vpp (); if (rv) { VERR ("couldn't connect to VPP!"); return rv; } VDBG (0, "sending session enable"); rv = vcl_bapi_session_enable (); if (rv) { VERR ("vppcom_app_session_enable() failed!"); return rv; } return 0; } int vcl_bapi_attach (void) { int rv; /* API hookup and connect to VPP */ if ((rv = vcl_bapi_init ())) return rv; vcl_bapi_send_attach (); rv = vcl_bapi_wait_for_wrk_state_change (STATE_APP_ATTACHED); if (PREDICT_FALSE (rv)) { VDBG (0, "application attach timed out! returning %d (%s)", rv, vppcom_retval_str (rv)); return rv; } return 0; } int vcl_bapi_app_worker_add (void) { vcl_worker_t *wrk = vcl_worker_get_current (); if (vcl_bapi_connect_to_vpp ()) return -1; wrk->bapi_app_state = STATE_APP_ADDING_WORKER; vcl_bapi_send_app_worker_add_del (1 /* is_add */ ); if (vcl_bapi_wait_for_wrk_state_change (STATE_APP_READY)) return -1; return 0; } void vcl_bapi_app_worker_del (vcl_worker_t * wrk) { /* Notify vpp that the worker is going away */ if (wrk->wrk_index == vcl_get_worker_index ()) vcl_bapi_send_app_worker_add_del (0 /* is_add */ ); else vcl_bapi_send_child_worker_del (wrk); /* Disconnect the binary api */ if (vec_len (vcm->workers) == 1) vcl_bapi_disconnect_from_vpp (); else vl_client_send_disconnect (1 /* vpp should cleanup */ ); } int vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds) { clib_error_t *err; if ((err = vl_socket_client_recv_fd_msg2 (&wrk->bapi_sock_ctx, fds, n_fds, 5))) { clib_error_report (err); return -1; } return 0; } int vcl_bapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair) { vcl_worker_t *wrk = vcl_worker_get_current (); if (ckpair->key_len == 0 || ckpair->key_len == ~0) return VPPCOM_EINVAL; vcl_bapi_send_app_add_cert_key_pair (ckpair); wrk->bapi_app_state = STATE_APP_ADDING_TLS_DATA; vcl_bapi_wait_for_wrk_state_change (STATE_APP_READY); if (wrk->bapi_app_state == STATE_APP_READY) return wrk->bapi_return; return VPPCOM_EFAULT; } int vcl_bapi_del_cert_key_pair (u32 ckpair_index) { /* Don't wait for reply */ vcl_bapi_send_app_del_cert_key_pair (ckpair_index); return 0; } int vcl_bapi_worker_set (void) { vcl_worker_t *wrk = vcl_worker_get_current (); int i; /* Find the first worker with the same pid */ for (i = 0; i < vec_len (vcm->workers); i++) { if (i == wrk->wrk_index) continue; if (vcm->workers[i].current_pid == wrk->current_pid) { wrk->vl_input_queue = vcm->workers[i].vl_input_queue; wrk->api_client_handle = vcm->workers[i].api_client_handle; return 0; } } return -1; } /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */