2 * Copyright (c) 2016 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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #define _GNU_SOURCE /* for strcasestr(3) */
16 #include <vnet/vnet.h>
18 #define vl_api_version(n,v) static u32 vpe_api_version = (v);
19 #include <vpp/api/vpe.api.h>
24 #include <jvpp-common/jvpp_common.h>
25 #include "io_fd_vpp_jvpp_VppJNIConnection.h"
26 #include "io_fd_vpp_jvpp_JVppRegistryImpl.h"
28 #include <vpp/api/vpe_msg_enum.h>
29 #define vl_typedefs /* define message structures */
30 #include <vpp/api/vpe_all_api_h.h>
34 #include <vpp/api/vpe_all_api_h.h>
37 /* instantiate all the print functions we know about */
38 #define vl_print(handle, ...)
40 #include <vpp/api/vpe_all_api_h.h>
43 vlib_main_t vlib_global_main;
44 vlib_main_t **vlib_mains;
47 * The Java runtime isn't compile w/ -fstack-protector,
48 * so we have to supply missing external references for the
49 * regular vpp libraries.
51 void __stack_chk_guard(void) __attribute__((weak));
52 void __stack_chk_guard(void) {
55 #define CONTROL_PING_MESSAGE "control_ping"
56 #define CONTROL_PING_REPLY_MESSAGE "control_ping_reply"
59 /* UThread attachment */
60 volatile u32 control_ping_result_ready;
61 volatile i32 control_ping_retval;
63 /* Control ping callback */
64 jobject registryObject;
66 jclass controlPingReplyClass;
67 jclass callbackExceptionClass;
68 int control_ping_msg_id;
69 int control_ping_reply_msg_id;
72 pthread_key_t cleanup_rx_thread_key;
74 /* Connected indication */
75 volatile u8 is_connected;
77 } jvpp_registry_main_t;
79 jvpp_registry_main_t jvpp_registry_main __attribute__((aligned (64)));
81 void vl_client_add_api_signatures(vl_api_memclnt_create_t *mp) {
83 * Send the main API signature in slot 0. This bit of code must
84 * match the checks in ../vpe/api/api.c: vl_msg_api_version_check().
86 mp->api_versions[0] = clib_host_to_net_u32(vpe_api_version);
89 /* cleanup handler for RX thread */
90 static_always_inline void cleanup_rx_thread(void *arg) {
91 jvpp_main_t * jm = &jvpp_main;
92 jvpp_registry_main_t * rm = &jvpp_registry_main;
96 int getEnvStat = (*jm->jvm)->GetEnv(jm->jvm, (void **) &(jm->jenv),
98 if (getEnvStat == JNI_EVERSION) {
99 clib_warning("Unsupported JNI version\n");
100 rm->control_ping_retval = VNET_API_ERROR_UNSUPPORTED_JNI_VERSION;
102 } else if (getEnvStat != JNI_EDETACHED) {
103 (*jm->jvm)->DetachCurrentThread(jm->jvm);
105 out: vppjni_unlock(jm);
108 static void vl_api_control_ping_reply_t_handler(
109 vl_api_control_ping_reply_t * mp) {
110 jvpp_main_t * jm = &jvpp_main;
111 jvpp_registry_main_t * rm = &jvpp_registry_main;
112 char was_thread_connected = 0;
114 // attach to java thread if not attached
115 int getEnvStat = (*jm->jvm)->GetEnv(jm->jvm, (void **) &(jm->jenv),
117 if (getEnvStat == JNI_EDETACHED) {
118 if ((*jm->jvm)->AttachCurrentThread(jm->jvm, (void **) &(jm->jenv),
120 clib_warning("Failed to attach thread\n");
121 rm->control_ping_retval =
122 VNET_API_ERROR_FAILED_TO_ATTACH_TO_JAVA_THREAD;
126 // workaround as we can't use pthread_cleanup_push
127 pthread_key_create(&rm->cleanup_rx_thread_key, cleanup_rx_thread);
128 // destructor is only called if the value of key is non null
129 pthread_setspecific(rm->cleanup_rx_thread_key, (void *) 1);
130 was_thread_connected = 1;
131 } else if (getEnvStat == JNI_EVERSION) {
132 clib_warning("Unsupported JNI version\n");
133 rm->control_ping_retval = VNET_API_ERROR_UNSUPPORTED_JNI_VERSION;
137 if (was_thread_connected == 0) {
138 JNIEnv *env = jm->jenv;
139 if (mp->retval < 0) {
140 call_on_error("controlPing", mp->context, mp->retval,
141 rm->registryClass, rm->registryObject,
142 rm->callbackExceptionClass);
144 jmethodID constructor = (*env)->GetMethodID(env,
145 rm->controlPingReplyClass, "<init>", "()V");
146 jmethodID callbackMethod = (*env)->GetMethodID(env,
147 rm->registryClass, "onControlPingReply",
148 "(Lio/fd/vpp/jvpp/dto/ControlPingReply;)V");
150 jobject dto = (*env)->NewObject(env, rm->controlPingReplyClass,
153 jfieldID contextFieldId = (*env)->GetFieldID(env,
154 rm->controlPingReplyClass, "context", "I");
155 (*env)->SetIntField(env, dto, contextFieldId,
156 clib_net_to_host_u32(mp->context));
158 jfieldID clientIndexFieldId = (*env)->GetFieldID(env,
159 rm->controlPingReplyClass, "clientIndex", "I");
160 (*env)->SetIntField(env, dto, clientIndexFieldId,
161 clib_net_to_host_u32(mp->client_index));
163 jfieldID vpePidFieldId = (*env)->GetFieldID(env,
164 rm->controlPingReplyClass, "vpePid", "I");
165 (*env)->SetIntField(env, dto, vpePidFieldId,
166 clib_net_to_host_u32(mp->vpe_pid));
168 (*env)->CallVoidMethod(env, rm->registryObject, callbackMethod,
170 (*env)->DeleteLocalRef(env, dto);
174 out: rm->vpe_pid = clib_net_to_host_u32(mp->vpe_pid);
175 rm->control_ping_result_ready = 1;
178 static int find_ping_id() {
180 jvpp_main_t * jm = &jvpp_main;
181 jvpp_registry_main_t * rm = &jvpp_registry_main;
182 api_main_t *am = &api_main;
184 jm->messages_hash = am->msg_index_by_name_and_crc;
186 rm->control_ping_msg_id = -1;
187 rm->control_ping_reply_msg_id = -1;
189 hash_foreach_pair (hp, jm->messages_hash,
191 char *key = (char *)hp->key; // key format: name_crc
192 int msg_name_len = strlen(key) - 9; // ignore crc
193 if (strlen(CONTROL_PING_MESSAGE) == msg_name_len &&
194 strncmp(CONTROL_PING_MESSAGE, (char *)hp->key, msg_name_len) == 0) {
195 rm->control_ping_msg_id = (u32)hp->value[0];
197 if (strlen(CONTROL_PING_REPLY_MESSAGE) == msg_name_len &&
198 strncmp(CONTROL_PING_REPLY_MESSAGE, (char *)hp->key, msg_name_len) == 0) {
199 rm->control_ping_reply_msg_id = (u32)hp->value[0];
202 if (rm->control_ping_msg_id == -1) {
203 clib_warning("failed to find id for %s", CONTROL_PING_MESSAGE);
206 if (rm->control_ping_reply_msg_id == -1) {
207 clib_warning("failed to find id for %s", CONTROL_PING_REPLY_MESSAGE);
213 static int send_initial_control_ping() {
215 clib_time_t clib_time;
216 vl_api_control_ping_t * mp;
217 jvpp_main_t * jm = &jvpp_main;
218 jvpp_registry_main_t * rm = &jvpp_registry_main;
220 clib_time_init(&clib_time);
222 rm->control_ping_result_ready = 0;
223 mp = vl_msg_api_alloc(sizeof(*mp));
224 memset(mp, 0, sizeof(*mp));
225 mp->_vl_msg_id = ntohs(rm->control_ping_msg_id);
226 mp->client_index = jm->my_client_index;
229 vl_msg_api_send_shmem(jm->vl_input_queue, (u8 *) &mp);
231 // wait for results: Current time + 10 seconds is the timeout
232 timeout = clib_time_now(&clib_time) + 10.0;
233 int rv = VNET_API_ERROR_RESPONSE_NOT_READY;
234 while (clib_time_now(&clib_time) < timeout) {
235 if (rm->control_ping_result_ready == 1) {
236 rv = rm->control_ping_retval;
242 vl_msg_api_clean_handlers(rm->control_ping_reply_msg_id);
243 clib_warning("first control ping failed: %d", rv);
248 static int connect_to_vpe(char *shm_prefix, char *name) {
249 jvpp_main_t * jm = &jvpp_main;
250 api_main_t * am = &api_main;
251 jvpp_registry_main_t * rm = &jvpp_registry_main;
253 if (vl_client_connect_to_vlib(shm_prefix, name, 32) < 0)
255 jm->my_client_index = am->my_client_index;
257 jm->vl_input_queue = am->shmem_hdr->vl_input_queue;
259 if (find_ping_id() < 0)
262 vl_msg_api_set_handlers(rm->control_ping_reply_msg_id, CONTROL_PING_REPLY_MESSAGE,
263 vl_api_control_ping_reply_t_handler, vl_noop_handler,
264 vl_api_control_ping_reply_t_endian,
265 vl_api_control_ping_reply_t_print,
266 sizeof(vl_api_control_ping_reply_t), 1);
268 return send_initial_control_ping();
271 JNIEXPORT jobject JNICALL Java_io_fd_vpp_jvpp_VppJNIConnection_clientConnect(
272 JNIEnv *env, jclass obj, jstring shmPrefix, jstring clientName) {
274 * TODO introducing memory prefix as variable can be used in hc2vpp
275 * to be able to run without root privileges
276 * https://jira.fd.io/browse/HC2VPP-176
279 const char *client_name;
280 const char *shm_prefix;
281 void vl_msg_reply_handler_hookup(void);
282 jvpp_main_t * jm = &jvpp_main;
283 jvpp_registry_main_t * rm = &jvpp_registry_main;
285 jclass connectionInfoClass = (*env)->FindClass(env,
286 "io/fd/vpp/jvpp/VppJNIConnection$ConnectionInfo");
287 jmethodID connectionInfoConstructor = (*env)->GetMethodID(env,
288 connectionInfoClass, "<init>", "(JIII)V");
290 if (rm->is_connected) {
291 return (*env)->NewObject(env, connectionInfoClass,
292 connectionInfoConstructor, 0, 0,
293 VNET_API_ERROR_ALREADY_CONNECTED, 0);
296 client_name = (*env)->GetStringUTFChars(env, clientName, 0);
297 shm_prefix = (*env)->GetStringUTFChars(env, shmPrefix, 0);
300 return (*env)->NewObject(env, connectionInfoClass,
301 connectionInfoConstructor, 0, 0, VNET_API_ERROR_INVALID_VALUE, 0, shmPrefix);
305 return (*env)->NewObject(env, connectionInfoClass,
306 connectionInfoConstructor, 0, 0, VNET_API_ERROR_INVALID_VALUE, 0, shmPrefix);
309 rv = connect_to_vpe((char *) shm_prefix, (char *) client_name);
312 clib_warning("connection failed, rv %d", rv);
314 (*env)->ReleaseStringUTFChars(env, clientName, client_name);
315 (*env)->ReleaseStringUTFChars(env, shmPrefix, shm_prefix);
317 return (*env)->NewObject(env, connectionInfoClass,
318 connectionInfoConstructor, (jlong) pointer_to_uword (jm->vl_input_queue),
319 (jint) jm->my_client_index, (jint) rv, (jint) rm->vpe_pid);
322 JNIEXPORT jint JNICALL Java_io_fd_vpp_jvpp_JVppRegistryImpl_controlPing0(
323 JNIEnv *env, jobject regstryObject) {
324 jvpp_main_t * jm = &jvpp_main;
325 vl_api_control_ping_t * mp;
326 u32 my_context_id = vppjni_get_context_id(&jvpp_main);
327 jvpp_registry_main_t * rm = &jvpp_registry_main;
329 if (rm->registryObject == 0) {
330 rm->registryObject = (*env)->NewGlobalRef(env, regstryObject);
332 if (rm->registryClass == 0) {
333 rm->registryClass = (jclass) (*env)->NewGlobalRef(env,
334 (*env)->GetObjectClass(env, regstryObject));
337 mp = vl_msg_api_alloc(sizeof(*mp));
338 memset(mp, 0, sizeof(*mp));
339 mp->_vl_msg_id = ntohs(rm->control_ping_msg_id);
340 mp->client_index = jm->my_client_index;
341 mp->context = clib_host_to_net_u32(my_context_id);
344 vl_msg_api_send_shmem(jm->vl_input_queue, (u8 *) &mp);
345 return my_context_id;
348 JNIEXPORT void JNICALL Java_io_fd_vpp_jvpp_VppJNIConnection_clientDisconnect(
349 JNIEnv *env, jclass clazz) {
350 jvpp_registry_main_t * rm = &jvpp_registry_main;
351 rm->is_connected = 0; // TODO make thread safe
352 vl_client_disconnect_from_vlib();
355 if (rm->registryObject) {
356 (*env)->DeleteGlobalRef(env, rm->registryObject);
357 rm->registryObject = 0;
359 if (rm->registryClass) {
360 (*env)->DeleteGlobalRef(env, rm->registryClass);
361 rm->registryClass = 0;
365 jint JNI_OnLoad(JavaVM *vm, void *reserved) {
366 jvpp_main_t * jm = &jvpp_main;
367 jvpp_registry_main_t * rm = &jvpp_registry_main;
370 if ((*vm)->GetEnv(vm, (void**) &env, JNI_VERSION_1_8) != JNI_OK) {
374 rm->controlPingReplyClass = (jclass) (*env)->NewGlobalRef(env,
375 (*env)->FindClass(env, "io/fd/vpp/jvpp/dto/ControlPingReply"));
376 if ((*env)->ExceptionCheck(env)) {
377 (*env)->ExceptionDescribe(env);
378 clib_warning("Failed to cache class references\n");
382 rm->callbackExceptionClass = (jclass) (*env)->NewGlobalRef(env,
383 (*env)->FindClass(env, "io/fd/vpp/jvpp/VppCallbackException"));
384 if ((*env)->ExceptionCheck(env)) {
385 (*env)->ExceptionDescribe(env);
390 return JNI_VERSION_1_8;
393 void JNI_OnUnload(JavaVM *vm, void *reserved) {
394 jvpp_main_t * jm = &jvpp_main;
396 if ((*vm)->GetEnv(vm, (void**) &env, JNI_VERSION_1_8) != JNI_OK) {