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 } jvpp_registry_main_t;
  77
  78 jvpp_registry_main_t jvpp_registry_main __attribute__((aligned (64)));
  79
  80 void vl_client_add_api_signatures(vl_api_memclnt_create_t *mp) {
  81     /*
  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().
  84      */
  85     mp->api_versions[0] = clib_host_to_net_u32(vpe_api_version);
  86 }
  87
  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;
  92
  93     vppjni_lock(jm, 99);
  94
  95     int getEnvStat = (*jm->jvm)->GetEnv(jm->jvm, (void **) &(jm->jenv),
  96     JNI_VERSION_1_8);
  97     if (getEnvStat == JNI_EVERSION) {
  98         clib_warning("Unsupported JNI version\n");
  99         rm->control_ping_retval = VNET_API_ERROR_UNSUPPORTED_JNI_VERSION;
 100         goto out;
 101     } else if (getEnvStat != JNI_EDETACHED) {
 102         (*jm->jvm)->DetachCurrentThread(jm->jvm);
 103     }
 104     out: vppjni_unlock(jm);
 105 }
 106
 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;
 112
 113     // attach to java thread if not attached
 114     int getEnvStat = (*jm->jvm)->GetEnv(jm->jvm, (void **) &(jm->jenv),
 115             JNI_VERSION_1_8);
 116     if (getEnvStat == JNI_EDETACHED) {
 117         if ((*jm->jvm)->AttachCurrentThread(jm->jvm, (void **) &(jm->jenv),
 118                 NULL) != 0) {
 119             clib_warning("Failed to attach thread\n");
 120             rm->control_ping_retval =
 121                     VNET_API_ERROR_FAILED_TO_ATTACH_TO_JAVA_THREAD;
 122             goto out;
 123         }
 124
 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;
 133         goto out;
 134     }
 135
 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);
 142         } else {
 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");
 148
 149             jobject dto = (*env)->NewObject(env, rm->controlPingReplyClass,
 150                     constructor);
 151
 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));
 156
 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));
 161
 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));
 166
 167             (*env)->CallVoidMethod(env, rm->registryObject, callbackMethod,
 168                     dto);
 169             (*env)->DeleteLocalRef(env, dto);
 170         }
 171     }
 172
 173     out: rm->control_ping_result_ready = 1;
 174 }
 175
 176 static int find_ping_id() {
 177     int rv = 0;
 178     jvpp_main_t * jm = &jvpp_main;
 179     jvpp_registry_main_t * rm = &jvpp_registry_main;
 180     api_main_t *am = &api_main;
 181     hash_pair_t *hp;
 182     jm->messages_hash = am->msg_index_by_name_and_crc;
 183
 184     rm->control_ping_msg_id = -1;
 185     rm->control_ping_reply_msg_id = -1;
 186
 187     hash_foreach_pair (hp, jm->messages_hash,
 188     ({
 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];
 194         }
 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];
 198         }
 199     }));
 200     if (rm->control_ping_msg_id == -1) {
 201         clib_warning("failed to find id for %s", CONTROL_PING_MESSAGE);
 202         rv = -1;
 203     }
 204     if (rm->control_ping_reply_msg_id == -1) {
 205         clib_warning("failed to find id for %s", CONTROL_PING_REPLY_MESSAGE);
 206         rv = -1;
 207     }
 208     return rv;
 209 }
 210
 211 static int send_initial_control_ping() {
 212     f64 timeout;
 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;
 217
 218     clib_time_init(&clib_time);
 219
 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;
 225
 226     // send message:
 227     vl_msg_api_send_shmem(jm->vl_input_queue, (u8 *) &mp);
 228
 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;
 235             break;
 236         }
 237     }
 238
 239     if (rv != 0) {
 240         clib_warning("first control ping failed: %d", rv);
 241     }
 242
 243     return rv;
 244 }
 245
 246 static int connect_to_vpe(char *shm_prefix, 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;
 250
 251     if (vl_client_connect_to_vlib(shm_prefix, name, 32) < 0)
 252         return -1;
 253     jm->my_client_index = am->my_client_index;
 254
 255     jm->vl_input_queue = am->shmem_hdr->vl_input_queue;
 256
 257     if (find_ping_id() < 0)
 258         return -1;
 259
 260     vl_msg_api_set_handlers(rm->control_ping_reply_msg_id, CONTROL_PING_REPLY_MESSAGE,
 261             vl_api_control_ping_reply_t_handler, vl_noop_handler,
 262             vl_api_control_ping_reply_t_endian,
 263             vl_api_control_ping_reply_t_print,
 264             sizeof(vl_api_control_ping_reply_t), 1);
 265
 266     return send_initial_control_ping();
 267 }
 268
 269 JNIEXPORT jobject JNICALL Java_io_fd_vpp_jvpp_VppJNIConnection_clientConnect(
 270         JNIEnv *env, jclass obj, jstring shmPrefix, jstring clientName) {
 271     /*
 272      * TODO introducing memory prefix as variable can be used in hc2vpp
 273      * to be able to run without root privileges
 274      * https://jira.fd.io/browse/HC2VPP-176
 275      */
 276     int rv;
 277     const char *client_name;
 278     const char *shm_prefix;
 279     void vl_msg_reply_handler_hookup(void);
 280     jvpp_main_t * jm = &jvpp_main;
 281     jvpp_registry_main_t * rm = &jvpp_registry_main;
 282
 283     jclass connectionInfoClass = (*env)->FindClass(env,
 284             "io/fd/vpp/jvpp/VppJNIConnection$ConnectionInfo");
 285     jmethodID connectionInfoConstructor = (*env)->GetMethodID(env,
 286             connectionInfoClass, "<init>", "(JII)V");
 287
 288     if (rm->is_connected) {
 289         return (*env)->NewObject(env, connectionInfoClass,
 290                 connectionInfoConstructor, 0, 0,
 291                 VNET_API_ERROR_ALREADY_CONNECTED);
 292     }
 293
 294     client_name = (*env)->GetStringUTFChars(env, clientName, 0);
 295     shm_prefix = (*env)->GetStringUTFChars(env, shmPrefix, 0);
 296
 297     if (!client_name) {
 298         return (*env)->NewObject(env, connectionInfoClass,
 299                 connectionInfoConstructor, 0, 0, VNET_API_ERROR_INVALID_VALUE, shmPrefix);
 300     }
 301
 302     if (!shm_prefix) {
 303         return (*env)->NewObject(env, connectionInfoClass,
 304                 connectionInfoConstructor, 0, 0, VNET_API_ERROR_INVALID_VALUE, shmPrefix);
 305     }
 306
 307     rv = connect_to_vpe((char *) shm_prefix, (char *) client_name);
 308
 309     if (rv < 0)
 310         clib_warning("connection failed, rv %d", rv);
 311
 312     (*env)->ReleaseStringUTFChars(env, clientName, client_name);
 313     (*env)->ReleaseStringUTFChars(env, shmPrefix, shm_prefix);
 314
 315     return (*env)->NewObject(env, connectionInfoClass,
 316             connectionInfoConstructor, (jlong) pointer_to_uword (jm->vl_input_queue),
 317             (jint) jm->my_client_index, (jint) rv);
 318 }
 319
 320 JNIEXPORT jint JNICALL Java_io_fd_vpp_jvpp_JVppRegistryImpl_controlPing0(
 321         JNIEnv *env, jobject regstryObject) {
 322     jvpp_main_t * jm = &jvpp_main;
 323     vl_api_control_ping_t * mp;
 324     u32 my_context_id = vppjni_get_context_id(&jvpp_main);
 325     jvpp_registry_main_t * rm = &jvpp_registry_main;
 326
 327     if (rm->registryObject == 0) {
 328         rm->registryObject = (*env)->NewGlobalRef(env, regstryObject);
 329     }
 330     if (rm->registryClass == 0) {
 331         rm->registryClass = (jclass) (*env)->NewGlobalRef(env,
 332                 (*env)->GetObjectClass(env, regstryObject));
 333     }
 334
 335     mp = vl_msg_api_alloc(sizeof(*mp));
 336     memset(mp, 0, sizeof(*mp));
 337     mp->_vl_msg_id = ntohs(rm->control_ping_msg_id);
 338     mp->client_index = jm->my_client_index;
 339     mp->context = clib_host_to_net_u32(my_context_id);
 340
 341     // send message:
 342     vl_msg_api_send_shmem(jm->vl_input_queue, (u8 *) &mp);
 343     return my_context_id;
 344 }
 345
 346 JNIEXPORT void JNICALL Java_io_fd_vpp_jvpp_VppJNIConnection_clientDisconnect(
 347         JNIEnv *env, jclass clazz) {
 348     jvpp_registry_main_t * rm = &jvpp_registry_main;
 349     rm->is_connected = 0; // TODO make thread safe
 350     vl_client_disconnect_from_vlib();
 351
 352     // cleanup:
 353     if (rm->registryObject) {
 354         (*env)->DeleteGlobalRef(env, rm->registryObject);
 355         rm->registryObject = 0;
 356     }
 357     if (rm->registryClass) {
 358         (*env)->DeleteGlobalRef(env, rm->registryClass);
 359         rm->registryClass = 0;
 360     }
 361 }
 362
 363 jint JNI_OnLoad(JavaVM *vm, void *reserved) {
 364     jvpp_main_t * jm = &jvpp_main;
 365     jvpp_registry_main_t * rm = &jvpp_registry_main;
 366     JNIEnv* env;
 367
 368     if ((*vm)->GetEnv(vm, (void**) &env, JNI_VERSION_1_8) != JNI_OK) {
 369         return JNI_EVERSION;
 370     }
 371
 372     rm->controlPingReplyClass = (jclass) (*env)->NewGlobalRef(env,
 373             (*env)->FindClass(env, "io/fd/vpp/jvpp/dto/ControlPingReply"));
 374     if ((*env)->ExceptionCheck(env)) {
 375         (*env)->ExceptionDescribe(env);
 376         clib_warning("Failed to cache class references\n");
 377         return JNI_ERR;
 378     }
 379
 380     rm->callbackExceptionClass = (jclass) (*env)->NewGlobalRef(env,
 381             (*env)->FindClass(env, "io/fd/vpp/jvpp/VppCallbackException"));
 382     if ((*env)->ExceptionCheck(env)) {
 383         (*env)->ExceptionDescribe(env);
 384         return JNI_ERR;
 385     }
 386
 387     jm->jvm = vm;
 388     return JNI_VERSION_1_8;
 389 }
 390
 391 void JNI_OnUnload(JavaVM *vm, void *reserved) {
 392     jvpp_main_t * jm = &jvpp_main;
 393     JNIEnv* env;
 394     if ((*vm)->GetEnv(vm, (void**) &env, JNI_VERSION_1_8) != JNI_OK) {
 395         return;
 396     }
 397
 398     jm->jenv = NULL;
 399     jm->jvm = NULL;
 400 }