src/vpp-api/java/jvpp-registry/jvpp_registry.c

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15 #define _GNU_SOURCE /* for strcasestr(3) */
  16 #include <vnet/vnet.h>
  17
  18 #define vl_api_version(n,v) static u32 vpe_api_version = (v);
  19 #include <vpp/api/vpe.api.h>
  20 #undef vl_api_version
  21
  22
  23 #include <jni.h>
  24 #include <jvpp-common/jvpp_common.h>
  25 #include "io_fd_vpp_jvpp_VppJNIConnection.h"
  26 #include "io_fd_vpp_jvpp_JVppRegistryImpl.h"
  27
  28 #include <vpp/api/vpe_msg_enum.h>
  29 #define vl_typedefs             /* define message structures */
  30 #include <vpp/api/vpe_all_api_h.h>
  31 #undef vl_typedefs
  32
  33 #define vl_endianfun
  34 #include <vpp/api/vpe_all_api_h.h>
  35 #undef vl_endianfun
  36
  37 /* instantiate all the print functions we know about */
  38 #define vl_print(handle, ...)
  39 #define vl_printfun
  40 #include <vpp/api/vpe_all_api_h.h>
  41 #undef vl_printfun
  42
  43 vlib_main_t vlib_global_main;
  44 vlib_main_t **vlib_mains;
  45
  46 /*
  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.
  50  */
  51 void __stack_chk_guard(void) __attribute__((weak));
  52 void __stack_chk_guard(void) {
  53 }
  54
  55 #define CONTROL_PING_MESSAGE "control_ping"
  56 #define CONTROL_PING_REPLY_MESSAGE "control_ping_reply"
  57
  58 typedef struct {
  59     /* UThread attachment */
  60     volatile u32 control_ping_result_ready;
  61     volatile i32 control_ping_retval;
  62
  63     /* Control ping callback */
  64     jobject registryObject;
  65     jclass registryClass;
  66     jclass controlPingReplyClass;
  67     jclass callbackExceptionClass;
  68     int control_ping_msg_id;
  69     int control_ping_reply_msg_id;
  70
  71     /* Thread cleanup */
  72     pthread_key_t cleanup_rx_thread_key;
  73
  74     /* Connected indication */
  75     volatile u8 is_connected;
  76     u32 vpe_pid;
  77 } jvpp_registry_main_t;
  78
  79 jvpp_registry_main_t jvpp_registry_main __attribute__((aligned (64)));
  80
  81 void vl_client_add_api_signatures(vl_api_memclnt_create_t *mp) {
  82     /*
  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().
  85      */
  86     mp->api_versions[0] = clib_host_to_net_u32(vpe_api_version);
  87 }
  88
  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;
  93
  94     vppjni_lock(jm, 99);
  95
  96     int getEnvStat = (*jm->jvm)->GetEnv(jm->jvm, (void **) &(jm->jenv),
  97     JNI_VERSION_1_8);
  98     if (getEnvStat == JNI_EVERSION) {
  99         clib_warning("Unsupported JNI version\n");
 100         rm->control_ping_retval = VNET_API_ERROR_UNSUPPORTED_JNI_VERSION;
 101         goto out;
 102     } else if (getEnvStat != JNI_EDETACHED) {
 103         (*jm->jvm)->DetachCurrentThread(jm->jvm);
 104     }
 105     out: vppjni_unlock(jm);
 106 }
 107
 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;
 113
 114     // attach to java thread if not attached
 115     int getEnvStat = (*jm->jvm)->GetEnv(jm->jvm, (void **) &(jm->jenv),
 116             JNI_VERSION_1_8);
 117     if (getEnvStat == JNI_EDETACHED) {
 118         if ((*jm->jvm)->AttachCurrentThread(jm->jvm, (void **) &(jm->jenv),
 119                 NULL) != 0) {
 120             clib_warning("Failed to attach thread\n");
 121             rm->control_ping_retval =
 122                     VNET_API_ERROR_FAILED_TO_ATTACH_TO_JAVA_THREAD;
 123             goto out;
 124         }
 125
 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;
 134         goto out;
 135     }
 136
 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);
 143         } else {
 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");
 149
 150             jobject dto = (*env)->NewObject(env, rm->controlPingReplyClass,
 151                     constructor);
 152
 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));
 157
 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));
 162
 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));
 167
 168             (*env)->CallVoidMethod(env, rm->registryObject, callbackMethod,
 169                     dto);
 170             (*env)->DeleteLocalRef(env, dto);
 171         }
 172     }
 173
 174     out: rm->vpe_pid = clib_net_to_host_u32(mp->vpe_pid);
 175     rm->control_ping_result_ready = 1;
 176 }
 177
 178 static int find_ping_id() {
 179     int rv = 0;
 180     jvpp_main_t * jm = &jvpp_main;
 181     jvpp_registry_main_t * rm = &jvpp_registry_main;
 182     api_main_t *am = &api_main;
 183     hash_pair_t *hp;
 184     jm->messages_hash = am->msg_index_by_name_and_crc;
 185
 186     rm->control_ping_msg_id = -1;
 187     rm->control_ping_reply_msg_id = -1;
 188
 189     hash_foreach_pair (hp, jm->messages_hash,
 190     ({
 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];
 196         }
 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];
 200         }
 201     }));
 202     if (rm->control_ping_msg_id == -1) {
 203         clib_warning("failed to find id for %s", CONTROL_PING_MESSAGE);
 204         rv = -1;
 205     }
 206     if (rm->control_ping_reply_msg_id == -1) {
 207         clib_warning("failed to find id for %s", CONTROL_PING_REPLY_MESSAGE);
 208         rv = -1;
 209     }
 210     return rv;
 211 }
 212
 213 static int send_initial_control_ping() {
 214     f64 timeout;
 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;
 219
 220     clib_time_init(&clib_time);
 221
 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;
 227
 228     // send message:
 229     vl_msg_api_send_shmem(jm->vl_input_queue, (u8 *) &mp);
 230
 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;
 237             break;
 238         }
 239     }
 240
 241     if (rv != 0) {
 242         clib_warning("first control ping failed: %d", rv);
 243     }
 244     return rv;
 245 }
 246
 247 static int connect_to_vpe(char *shm_prefix, char *name) {
 248     jvpp_main_t * jm = &jvpp_main;
 249     api_main_t * am = &api_main;
 250     jvpp_registry_main_t * rm = &jvpp_registry_main;
 251
 252     if (vl_client_connect_to_vlib(shm_prefix, name, 32) < 0)
 253         return -1;
 254     jm->my_client_index = am->my_client_index;
 255
 256     jm->vl_input_queue = am->shmem_hdr->vl_input_queue;
 257
 258     if (find_ping_id() < 0)
 259         return -1;
 260
 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);
 266
 267     return send_initial_control_ping();
 268 }
 269
 270 JNIEXPORT jobject JNICALL Java_io_fd_vpp_jvpp_VppJNIConnection_clientConnect(
 271         JNIEnv *env, jclass obj, jstring shmPrefix, jstring clientName) {
 272     /*
 273      * TODO introducing memory prefix as variable can be used in hc2vpp
 274      * to be able to run without root privileges
 275      * https://jira.fd.io/browse/HC2VPP-176
 276      */
 277     int rv;
 278     const char *client_name;
 279     const char *shm_prefix;
 280     void vl_msg_reply_handler_hookup(void);
 281     jvpp_main_t * jm = &jvpp_main;
 282     jvpp_registry_main_t * rm = &jvpp_registry_main;
 283
 284     jclass connectionInfoClass = (*env)->FindClass(env,
 285             "io/fd/vpp/jvpp/VppJNIConnection$ConnectionInfo");
 286     jmethodID connectionInfoConstructor = (*env)->GetMethodID(env,
 287             connectionInfoClass, "<init>", "(JIII)V");
 288
 289     if (rm->is_connected) {
 290         return (*env)->NewObject(env, connectionInfoClass,
 291                 connectionInfoConstructor, 0, 0,
 292                 VNET_API_ERROR_ALREADY_CONNECTED, 0);
 293     }
 294
 295     client_name = (*env)->GetStringUTFChars(env, clientName, 0);
 296     shm_prefix = (*env)->GetStringUTFChars(env, shmPrefix, 0);
 297
 298     if (!client_name) {
 299         return (*env)->NewObject(env, connectionInfoClass,
 300                 connectionInfoConstructor, 0, 0, VNET_API_ERROR_INVALID_VALUE, 0, shmPrefix);
 301     }
 302
 303     if (!shm_prefix) {
 304         return (*env)->NewObject(env, connectionInfoClass,
 305                 connectionInfoConstructor, 0, 0, VNET_API_ERROR_INVALID_VALUE, 0, shmPrefix);
 306     }
 307
 308     rv = connect_to_vpe((char *) shm_prefix, (char *) client_name);
 309
 310     if (rv < 0)
 311         clib_warning("connection failed, rv %d", rv);
 312
 313     (*env)->ReleaseStringUTFChars(env, clientName, client_name);
 314     (*env)->ReleaseStringUTFChars(env, shmPrefix, shm_prefix);
 315
 316     return (*env)->NewObject(env, connectionInfoClass,
 317             connectionInfoConstructor, (jlong) pointer_to_uword (jm->vl_input_queue),
 318             (jint) jm->my_client_index, (jint) rv, (jint) rm->vpe_pid);
 319 }
 320
 321 JNIEXPORT jint JNICALL Java_io_fd_vpp_jvpp_JVppRegistryImpl_controlPing0(
 322         JNIEnv *env, jobject regstryObject) {
 323     jvpp_main_t * jm = &jvpp_main;
 324     vl_api_control_ping_t * mp;
 325     u32 my_context_id = vppjni_get_context_id(&jvpp_main);
 326     jvpp_registry_main_t * rm = &jvpp_registry_main;
 327
 328     if (rm->registryObject == 0) {
 329         rm->registryObject = (*env)->NewGlobalRef(env, regstryObject);
 330     }
 331     if (rm->registryClass == 0) {
 332         rm->registryClass = (jclass) (*env)->NewGlobalRef(env,
 333                 (*env)->GetObjectClass(env, regstryObject));
 334     }
 335
 336     mp = vl_msg_api_alloc(sizeof(*mp));
 337     memset(mp, 0, sizeof(*mp));
 338     mp->_vl_msg_id = ntohs(rm->control_ping_msg_id);
 339     mp->client_index = jm->my_client_index;
 340     mp->context = clib_host_to_net_u32(my_context_id);
 341
 342     // send message:
 343     vl_msg_api_send_shmem(jm->vl_input_queue, (u8 *) &mp);
 344     return my_context_id;
 345 }
 346
 347 JNIEXPORT void JNICALL Java_io_fd_vpp_jvpp_VppJNIConnection_clientDisconnect(
 348         JNIEnv *env, jclass clazz) {
 349     jvpp_registry_main_t * rm = &jvpp_registry_main;
 350     rm->is_connected = 0; // TODO make thread safe
 351     vl_client_disconnect_from_vlib();
 352
 353     // cleanup:
 354     if (rm->registryObject) {
 355         (*env)->DeleteGlobalRef(env, rm->registryObject);
 356         rm->registryObject = 0;
 357     }
 358     if (rm->registryClass) {
 359         (*env)->DeleteGlobalRef(env, rm->registryClass);
 360         rm->registryClass = 0;
 361     }
 362 }
 363
 364 jint JNI_OnLoad(JavaVM *vm, void *reserved) {
 365     jvpp_main_t * jm = &jvpp_main;
 366     jvpp_registry_main_t * rm = &jvpp_registry_main;
 367     JNIEnv* env;
 368
 369     if ((*vm)->GetEnv(vm, (void**) &env, JNI_VERSION_1_8) != JNI_OK) {
 370         return JNI_EVERSION;
 371     }
 372
 373     rm->controlPingReplyClass = (jclass) (*env)->NewGlobalRef(env,
 374             (*env)->FindClass(env, "io/fd/vpp/jvpp/dto/ControlPingReply"));
 375     if ((*env)->ExceptionCheck(env)) {
 376         (*env)->ExceptionDescribe(env);
 377         clib_warning("Failed to cache class references\n");
 378         return JNI_ERR;
 379     }
 380
 381     rm->callbackExceptionClass = (jclass) (*env)->NewGlobalRef(env,
 382             (*env)->FindClass(env, "io/fd/vpp/jvpp/VppCallbackException"));
 383     if ((*env)->ExceptionCheck(env)) {
 384         (*env)->ExceptionDescribe(env);
 385         return JNI_ERR;
 386     }
 387
 388     jm->jvm = vm;
 389     return JNI_VERSION_1_8;
 390 }
 391
 392 void JNI_OnUnload(JavaVM *vm, void *reserved) {
 393     jvpp_main_t * jm = &jvpp_main;
 394     JNIEnv* env;
 395     if ((*vm)->GetEnv(vm, (void**) &env, JNI_VERSION_1_8) != JNI_OK) {
 396         return;
 397     }
 398
 399     jm->jenv = NULL;
 400     jm->jvm = NULL;
 401 }