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;
76 } jvpp_registry_main_t;
78 jvpp_registry_main_t jvpp_registry_main __attribute__((aligned (64)));
80 void vl_client_add_api_signatures(vl_api_memclnt_create_t *mp) {
82 * Send the main API signature in slot 0. This bit of code must
83 * match the checks in ../vpe/api/api.c: vl_msg_api_version_check().
85 mp->api_versions[0] = clib_host_to_net_u32(vpe_api_version);
88 /* cleanup handler for RX thread */
89 static_always_inline void cleanup_rx_thread(void *arg) {
90 jvpp_main_t * jm = &jvpp_main;
91 jvpp_registry_main_t * rm = &jvpp_registry_main;
95 int getEnvStat = (*jm->jvm)->GetEnv(jm->jvm, (void **) &(jm->jenv),
97 if (getEnvStat == JNI_EVERSION) {
98 clib_warning("Unsupported JNI version\n");
99 rm->control_ping_retval = VNET_API_ERROR_UNSUPPORTED_JNI_VERSION;
101 } else if (getEnvStat != JNI_EDETACHED) {
102 (*jm->jvm)->DetachCurrentThread(jm->jvm);
104 out: vppjni_unlock(jm);
107 static void vl_api_control_ping_reply_t_handler(
108 vl_api_control_ping_reply_t * mp) {
109 jvpp_main_t * jm = &jvpp_main;
110 jvpp_registry_main_t * rm = &jvpp_registry_main;
111 char was_thread_connected = 0;
113 // attach to java thread if not attached
114 int getEnvStat = (*jm->jvm)->GetEnv(jm->jvm, (void **) &(jm->jenv),
116 if (getEnvStat == JNI_EDETACHED) {
117 if ((*jm->jvm)->AttachCurrentThread(jm->jvm, (void **) &(jm->jenv),
119 clib_warning("Failed to attach thread\n");
120 rm->control_ping_retval =
121 VNET_API_ERROR_FAILED_TO_ATTACH_TO_JAVA_THREAD;
125 // workaround as we can't use pthread_cleanup_push
126 pthread_key_create(&rm->cleanup_rx_thread_key, cleanup_rx_thread);
127 // destructor is only called if the value of key is non null
128 pthread_setspecific(rm->cleanup_rx_thread_key, (void *) 1);
129 was_thread_connected = 1;
130 } else if (getEnvStat == JNI_EVERSION) {
131 clib_warning("Unsupported JNI version\n");
132 rm->control_ping_retval = VNET_API_ERROR_UNSUPPORTED_JNI_VERSION;
136 if (was_thread_connected == 0) {
137 JNIEnv *env = jm->jenv;
138 if (mp->retval < 0) {
139 call_on_error("controlPing", mp->context, mp->retval,
140 rm->registryClass, rm->registryObject,
141 rm->callbackExceptionClass);
143 jmethodID constructor = (*env)->GetMethodID(env,
144 rm->controlPingReplyClass, "<init>", "()V");
145 jmethodID callbackMethod = (*env)->GetMethodID(env,
146 rm->registryClass, "onControlPingReply",
147 "(Lio/fd/vpp/jvpp/dto/ControlPingReply;)V");
149 jobject dto = (*env)->NewObject(env, rm->controlPingReplyClass,
152 jfieldID contextFieldId = (*env)->GetFieldID(env,
153 rm->controlPingReplyClass, "context", "I");
154 (*env)->SetIntField(env, dto, contextFieldId,
155 clib_net_to_host_u32(mp->context));
157 jfieldID clientIndexFieldId = (*env)->GetFieldID(env,
158 rm->controlPingReplyClass, "clientIndex", "I");
159 (*env)->SetIntField(env, dto, clientIndexFieldId,
160 clib_net_to_host_u32(mp->client_index));
162 jfieldID vpePidFieldId = (*env)->GetFieldID(env,
163 rm->controlPingReplyClass, "vpePid", "I");
164 (*env)->SetIntField(env, dto, vpePidFieldId,
165 clib_net_to_host_u32(mp->vpe_pid));
167 (*env)->CallVoidMethod(env, rm->registryObject, callbackMethod,
169 (*env)->DeleteLocalRef(env, dto);
173 out: rm->control_ping_result_ready = 1;
176 static int find_ping_id() {
178 jvpp_main_t * jm = &jvpp_main;
179 jvpp_registry_main_t * rm = &jvpp_registry_main;
180 api_main_t *am = &api_main;
182 jm->messages_hash = am->msg_index_by_name_and_crc;
184 rm->control_ping_msg_id = -1;
185 rm->control_ping_reply_msg_id = -1;
187 hash_foreach_pair (hp, jm->messages_hash,
189 char *key = (char *)hp->key; // key format: name_crc
190 int msg_name_len = strlen(key) - 9; // ignore crc
191 if (strlen(CONTROL_PING_MESSAGE) == msg_name_len &&
192 strncmp(CONTROL_PING_MESSAGE, (char *)hp->key, msg_name_len) == 0) {
193 rm->control_ping_msg_id = (u32)hp->value[0];
195 if (strlen(CONTROL_PING_REPLY_MESSAGE) == msg_name_len &&
196 strncmp(CONTROL_PING_REPLY_MESSAGE, (char *)hp->key, msg_name_len) == 0) {
197 rm->control_ping_reply_msg_id = (u32)hp->value[0];
200 if (rm->control_ping_msg_id == -1) {
201 clib_warning("failed to find id for %s", CONTROL_PING_MESSAGE);
204 if (rm->control_ping_reply_msg_id == -1) {
205 clib_warning("failed to find id for %s", CONTROL_PING_REPLY_MESSAGE);
211 static int send_initial_control_ping() {
213 clib_time_t clib_time;
214 vl_api_control_ping_t * mp;
215 jvpp_main_t * jm = &jvpp_main;
216 jvpp_registry_main_t * rm = &jvpp_registry_main;
218 clib_time_init(&clib_time);
220 rm->control_ping_result_ready = 0;
221 mp = vl_msg_api_alloc(sizeof(*mp));
222 memset(mp, 0, sizeof(*mp));
223 mp->_vl_msg_id = ntohs(rm->control_ping_msg_id);
224 mp->client_index = jm->my_client_index;
227 vl_msg_api_send_shmem(jm->vl_input_queue, (u8 *) &mp);
229 // wait for results: Current time + 10 seconds is the timeout
230 timeout = clib_time_now(&clib_time) + 10.0;
231 int rv = VNET_API_ERROR_RESPONSE_NOT_READY;
232 while (clib_time_now(&clib_time) < timeout) {
233 if (rm->control_ping_result_ready == 1) {
234 rv = rm->control_ping_retval;
240 clib_warning("first control ping failed: %d", rv);
246 static int connect_to_vpe(char *name) {
247 jvpp_main_t * jm = &jvpp_main;
248 api_main_t * am = &api_main;
249 jvpp_registry_main_t * rm = &jvpp_registry_main;
251 if (vl_client_connect_to_vlib("/vpe-api", name, 32) < 0)
254 jm->my_client_index = am->my_client_index;
256 jm->vl_input_queue = am->shmem_hdr->vl_input_queue;
258 if (find_ping_id() < 0)
261 vl_msg_api_set_handlers(rm->control_ping_reply_msg_id, CONTROL_PING_REPLY_MESSAGE,
262 vl_api_control_ping_reply_t_handler, vl_noop_handler,
263 vl_api_control_ping_reply_t_endian,
264 vl_api_control_ping_reply_t_print,
265 sizeof(vl_api_control_ping_reply_t), 1);
267 return send_initial_control_ping();
270 JNIEXPORT jobject JNICALL Java_io_fd_vpp_jvpp_VppJNIConnection_clientConnect(
271 JNIEnv *env, jclass obj, jstring clientName) {
273 const char *client_name;
274 void vl_msg_reply_handler_hookup(void);
275 jvpp_main_t * jm = &jvpp_main;
276 jvpp_registry_main_t * rm = &jvpp_registry_main;
278 jclass connectionInfoClass = (*env)->FindClass(env,
279 "io/fd/vpp/jvpp/VppJNIConnection$ConnectionInfo");
280 jmethodID connectionInfoConstructor = (*env)->GetMethodID(env,
281 connectionInfoClass, "<init>", "(JII)V");
284 * Bail out now if we're not running as root
286 if (geteuid() != 0) {
287 return (*env)->NewObject(env, connectionInfoClass,
288 connectionInfoConstructor, 0, 0,
289 VNET_API_ERROR_NOT_RUNNING_AS_ROOT);
292 if (rm->is_connected) {
293 return (*env)->NewObject(env, connectionInfoClass,
294 connectionInfoConstructor, 0, 0,
295 VNET_API_ERROR_ALREADY_CONNECTED);
298 client_name = (*env)->GetStringUTFChars(env, clientName, 0);
300 return (*env)->NewObject(env, connectionInfoClass,
301 connectionInfoConstructor, 0, 0, VNET_API_ERROR_INVALID_VALUE);
304 rv = connect_to_vpe((char *) client_name);
307 clib_warning("connection failed, rv %d", rv);
309 (*env)->ReleaseStringUTFChars(env, clientName, client_name);
311 return (*env)->NewObject(env, connectionInfoClass,
312 connectionInfoConstructor, (jlong) pointer_to_uword (jm->vl_input_queue),
313 (jint) jm->my_client_index, (jint) rv);
316 JNIEXPORT jint JNICALL Java_io_fd_vpp_jvpp_JVppRegistryImpl_controlPing0(
317 JNIEnv *env, jobject regstryObject) {
318 jvpp_main_t * jm = &jvpp_main;
319 vl_api_control_ping_t * mp;
320 u32 my_context_id = vppjni_get_context_id(&jvpp_main);
321 jvpp_registry_main_t * rm = &jvpp_registry_main;
323 if (rm->registryObject == 0) {
324 rm->registryObject = (*env)->NewGlobalRef(env, regstryObject);
326 if (rm->registryClass == 0) {
327 rm->registryClass = (jclass) (*env)->NewGlobalRef(env,
328 (*env)->GetObjectClass(env, regstryObject));
331 mp = vl_msg_api_alloc(sizeof(*mp));
332 memset(mp, 0, sizeof(*mp));
333 mp->_vl_msg_id = ntohs(rm->control_ping_msg_id);
334 mp->client_index = jm->my_client_index;
335 mp->context = clib_host_to_net_u32(my_context_id);
338 vl_msg_api_send_shmem(jm->vl_input_queue, (u8 *) &mp);
339 return my_context_id;
342 JNIEXPORT void JNICALL Java_io_fd_vpp_jvpp_VppJNIConnection_clientDisconnect(
343 JNIEnv *env, jclass clazz) {
344 jvpp_registry_main_t * rm = &jvpp_registry_main;
345 rm->is_connected = 0; // TODO make thread safe
346 vl_client_disconnect_from_vlib();
349 if (rm->registryObject) {
350 (*env)->DeleteGlobalRef(env, rm->registryObject);
351 rm->registryObject = 0;
353 if (rm->registryClass) {
354 (*env)->DeleteGlobalRef(env, rm->registryClass);
355 rm->registryClass = 0;
359 jint JNI_OnLoad(JavaVM *vm, void *reserved) {
360 jvpp_main_t * jm = &jvpp_main;
361 jvpp_registry_main_t * rm = &jvpp_registry_main;
364 if ((*vm)->GetEnv(vm, (void**) &env, JNI_VERSION_1_8) != JNI_OK) {
368 rm->controlPingReplyClass = (jclass) (*env)->NewGlobalRef(env,
369 (*env)->FindClass(env, "io/fd/vpp/jvpp/dto/ControlPingReply"));
370 if ((*env)->ExceptionCheck(env)) {
371 (*env)->ExceptionDescribe(env);
372 clib_warning("Failed to cache class references\n");
376 rm->callbackExceptionClass = (jclass) (*env)->NewGlobalRef(env,
377 (*env)->FindClass(env, "io/fd/vpp/jvpp/VppCallbackException"));
378 if ((*env)->ExceptionCheck(env)) {
379 (*env)->ExceptionDescribe(env);
384 return JNI_VERSION_1_8;
387 void JNI_OnUnload(JavaVM *vm, void *reserved) {
388 jvpp_main_t * jm = &jvpp_main;
390 if ((*vm)->GetEnv(vm, (void**) &env, JNI_VERSION_1_8) != JNI_OK) {