/* * Copyright 2013 The Netty Project * * The Netty Project licenses this file to you under the Apache License, * version 2.0 (the "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the * License for the specific language governing permissions and limitations * under the License. */ #define _GNU_SOURCE #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "netty_epoll_linuxsocket.h" #include "netty_unix_errors.h" #include "netty_unix_filedescriptor.h" #include "netty_unix_jni.h" #include "netty_unix_limits.h" #include "netty_unix_socket.h" #include "netty_unix_util.h" // TCP_FASTOPEN is defined in linux 3.7. We define this here so older kernels can compile. #ifndef TCP_FASTOPEN #define TCP_FASTOPEN 23 #endif /** * On older Linux kernels, epoll can't handle timeout * values bigger than (LONG_MAX - 999ULL)/HZ. * * See: * - https://github.com/libevent/libevent/blob/master/epoll.c#L138 * - http://cvs.schmorp.de/libev/ev_epoll.c?revision=1.68&view=markup */ #define MAX_EPOLL_TIMEOUT_MSEC (35*60*1000) // optional extern int epoll_create1(int flags) __attribute__((weak)); #ifdef IO_NETTY_SENDMMSG_NOT_FOUND extern int sendmmsg(int sockfd, struct mmsghdr* msgvec, unsigned int vlen, unsigned int flags) __attribute__((weak)); #ifndef __USE_GNU struct mmsghdr { struct msghdr msg_hdr; /* Message header */ unsigned int msg_len; /* Number of bytes transmitted */ }; #endif #endif // Those are initialized in the init(...) method and cached for performance reasons jfieldID fileChannelFieldId = NULL; jfieldID transferredFieldId = NULL; jfieldID fdFieldId = NULL; jfieldID fileDescriptorFieldId = NULL; jfieldID packetAddrFieldId = NULL; jfieldID packetScopeIdFieldId = NULL; jfieldID packetPortFieldId = NULL; jfieldID packetMemoryAddressFieldId = NULL; jfieldID packetCountFieldId = NULL; clockid_t waitClockId = 0; // initialized by netty_unix_util_initialize_wait_clock // util methods static int getSysctlValue(const char * property, int* returnValue) { int rc = -1; FILE *fd=fopen(property, "r"); if (fd != NULL) { char buf[32] = {0x0}; if (fgets(buf, 32, fd) != NULL) { *returnValue = atoi(buf); rc = 0; } fclose(fd); } return rc; } static inline jint epollCtl(JNIEnv* env, jint efd, int op, jint fd, jint flags) { uint32_t events = flags; struct epoll_event ev = { .data.fd = fd, .events = events }; return epoll_ctl(efd, op, fd, &ev); } // JNI Registered Methods Begin static jint netty_epoll_native_eventFd(JNIEnv* env, jclass clazz) { jint eventFD = eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK); if (eventFD < 0) { int err = errno; netty_unix_errors_throwChannelExceptionErrorNo(env, "eventfd() failed: ", err); } return eventFD; } static void netty_epoll_native_eventFdWrite(JNIEnv* env, jclass clazz, jint fd, jlong value) { jint eventFD = eventfd_write(fd, (eventfd_t) value); if (eventFD < 0) { int err = errno; netty_unix_errors_throwChannelExceptionErrorNo(env, "eventfd_write() failed: ", err); } } static void netty_epoll_native_eventFdRead(JNIEnv* env, jclass clazz, jint fd) { uint64_t eventfd_t; if (eventfd_read(fd, &eventfd_t) != 0) { // something is serious wrong netty_unix_errors_throwRuntimeException(env, "eventfd_read() failed"); } } static jint netty_epoll_native_epollCreate(JNIEnv* env, jclass clazz) { jint efd; if (epoll_create1) { efd = epoll_create1(EPOLL_CLOEXEC); } else { // size will be ignored anyway but must be positive efd = epoll_create(126); } if (efd < 0) { int err = errno; if (epoll_create1) { netty_unix_errors_throwChannelExceptionErrorNo(env, "epoll_create1() failed: ", err); } else { netty_unix_errors_throwChannelExceptionErrorNo(env, "epoll_create() failed: ", err); } return efd; } if (!epoll_create1) { if (fcntl(efd, F_SETFD, FD_CLOEXEC) < 0) { int err = errno; close(efd); netty_unix_errors_throwChannelExceptionErrorNo(env, "fcntl() failed: ", err); return err; } } return efd; } static jint netty_epoll_native_epollWait0(JNIEnv* env, jclass clazz, jint efd, jlong address, jint len, jint timeout) { struct epoll_event *ev = (struct epoll_event*) (intptr_t) address; struct timespec ts; jlong timeBeforeWait, timeNow; int timeDiff, result, err; if (timeout > MAX_EPOLL_TIMEOUT_MSEC) { // Workaround for bug in older linux kernels that can not handle bigger timeout then MAX_EPOLL_TIMEOUT_MSEC. timeout = MAX_EPOLL_TIMEOUT_MSEC; } clock_gettime(waitClockId, &ts); timeBeforeWait = ts.tv_sec * 1000 + ts.tv_nsec / 1000000; for (;;) { result = epoll_wait(efd, ev, len, timeout); if (result >= 0) { return result; } if ((err = errno) == EINTR) { if (timeout > 0) { clock_gettime(waitClockId, &ts); timeNow = ts.tv_sec * 1000 + ts.tv_nsec / 1000000; timeDiff = timeNow - timeBeforeWait; timeout -= timeDiff; if (timeDiff < 0 || timeout <= 0) { return 0; } timeBeforeWait = timeNow; } else if (timeout == 0) { return 0; } } else { return -err; } } } static jint netty_epoll_native_epollCtlAdd0(JNIEnv* env, jclass clazz, jint efd, jint fd, jint flags) { int res = epollCtl(env, efd, EPOLL_CTL_ADD, fd, flags); if (res < 0) { return -errno; } return res; } static jint netty_epoll_native_epollCtlMod0(JNIEnv* env, jclass clazz, jint efd, jint fd, jint flags) { int res = epollCtl(env, efd, EPOLL_CTL_MOD, fd, flags); if (res < 0) { return -errno; } return res; } static jint netty_epoll_native_epollCtlDel0(JNIEnv* env, jclass clazz, jint efd, jint fd) { // Create an empty event to workaround a bug in older kernels which can not handle NULL. struct epoll_event event = { 0 }; int res = epoll_ctl(efd, EPOLL_CTL_DEL, fd, &event); if (res < 0) { return -errno; } return res; } static jint netty_epoll_native_sendmmsg0(JNIEnv* env, jclass clazz, jint fd, jobjectArray packets, jint offset, jint len) { struct mmsghdr msg[len]; struct sockaddr_storage addr[len]; socklen_t addrSize; int i; memset(msg, 0, sizeof(msg)); for (i = 0; i < len; i++) { jobject packet = (*env)->GetObjectArrayElement(env, packets, i + offset); jbyteArray address = (jbyteArray) (*env)->GetObjectField(env, packet, packetAddrFieldId); jint scopeId = (*env)->GetIntField(env, packet, packetScopeIdFieldId); jint port = (*env)->GetIntField(env, packet, packetPortFieldId); if (netty_unix_socket_initSockaddr(env, address, scopeId, port, &addr[i], &addrSize) == -1) { return -1; } msg[i].msg_hdr.msg_name = &addr[i]; msg[i].msg_hdr.msg_namelen = addrSize; msg[i].msg_hdr.msg_iov = (struct iovec*) (intptr_t) (*env)->GetLongField(env, packet, packetMemoryAddressFieldId); msg[i].msg_hdr.msg_iovlen = (*env)->GetIntField(env, packet, packetCountFieldId);; } ssize_t res; int err; do { res = sendmmsg(fd, msg, len, 0); // keep on writing if it was interrupted } while (res == -1 && ((err = errno) == EINTR)); if (res < 0) { return -err; } return (jint) res; } static jlong netty_epoll_native_sendfile0(JNIEnv* env, jclass clazz, jint fd, jobject fileRegion, jlong base_off, jlong off, jlong len) { jobject fileChannel = (*env)->GetObjectField(env, fileRegion, fileChannelFieldId); if (fileChannel == NULL) { netty_unix_errors_throwRuntimeException(env, "failed to get DefaultFileRegion.file"); return -1; } jobject fileDescriptor = (*env)->GetObjectField(env, fileChannel, fileDescriptorFieldId); if (fileDescriptor == NULL) { netty_unix_errors_throwRuntimeException(env, "failed to get FileChannelImpl.fd"); return -1; } jint srcFd = (*env)->GetIntField(env, fileDescriptor, fdFieldId); if (srcFd == -1) { netty_unix_errors_throwRuntimeException(env, "failed to get FileDescriptor.fd"); return -1; } ssize_t res; off_t offset = base_off + off; int err; do { res = sendfile(fd, srcFd, &offset, (size_t) len); } while (res == -1 && ((err = errno) == EINTR)); if (res < 0) { return -err; } if (res > 0) { // update the transferred field in DefaultFileRegion (*env)->SetLongField(env, fileRegion, transferredFieldId, off + res); } return res; } static jstring netty_epoll_native_kernelVersion(JNIEnv* env, jclass clazz) { struct utsname name; int res = uname(&name); if (res == 0) { return (*env)->NewStringUTF(env, name.release); } int err = errno; netty_unix_errors_throwRuntimeExceptionErrorNo(env, "uname() failed: ", err); return NULL; } static jboolean netty_epoll_native_isSupportingSendmmsg(JNIEnv* env, jclass clazz) { // Use & to avoid warnings with -Wtautological-pointer-compare when sendmmsg is // not weakly defined. if (&sendmmsg != NULL) { return JNI_TRUE; } return JNI_FALSE; } static jboolean netty_epoll_native_isSupportingTcpFastopen(JNIEnv* env, jclass clazz) { int fastopen = 0; getSysctlValue("/proc/sys/net/ipv4/tcp_fastopen", &fastopen); if (fastopen > 0) { return JNI_TRUE; } return JNI_FALSE; } static jint netty_epoll_native_epollet(JNIEnv* env, jclass clazz) { return EPOLLET; } static jint netty_epoll_native_epollin(JNIEnv* env, jclass clazz) { return EPOLLIN; } static jint netty_epoll_native_epollout(JNIEnv* env, jclass clazz) { return EPOLLOUT; } static jint netty_epoll_native_epollrdhup(JNIEnv* env, jclass clazz) { return EPOLLRDHUP; } static jint netty_epoll_native_epollerr(JNIEnv* env, jclass clazz) { return EPOLLERR; } static jint netty_epoll_native_sizeofEpollEvent(JNIEnv* env, jclass clazz) { return sizeof(struct epoll_event); } static jint netty_epoll_native_offsetofEpollData(JNIEnv* env, jclass clazz) { return offsetof(struct epoll_event, data); } static jint netty_epoll_native_splice0(JNIEnv* env, jclass clazz, jint fd, jlong offIn, jint fdOut, jlong offOut, jlong len) { ssize_t res; int err; loff_t off_in = (loff_t) offIn; loff_t off_out = (loff_t) offOut; loff_t* p_off_in = off_in >= 0 ? &off_in : NULL; loff_t* p_off_out = off_in >= 0 ? &off_out : NULL; do { res = splice(fd, p_off_in, fdOut, p_off_out, (size_t) len, SPLICE_F_NONBLOCK | SPLICE_F_MOVE); // keep on splicing if it was interrupted } while (res == -1 && ((err = errno) == EINTR)); if (res < 0) { return -err; } return (jint) res; } static jint netty_epoll_native_tcpMd5SigMaxKeyLen(JNIEnv* env, jclass clazz) { struct tcp_md5sig md5sig; // Defensive size check if (sizeof(md5sig.tcpm_key) < TCP_MD5SIG_MAXKEYLEN) { return sizeof(md5sig.tcpm_key); } return TCP_MD5SIG_MAXKEYLEN; } // JNI Registered Methods End // JNI Method Registration Table Begin static const JNINativeMethod statically_referenced_fixed_method_table[] = { { "epollet", "()I", (void *) netty_epoll_native_epollet }, { "epollin", "()I", (void *) netty_epoll_native_epollin }, { "epollout", "()I", (void *) netty_epoll_native_epollout }, { "epollrdhup", "()I", (void *) netty_epoll_native_epollrdhup }, { "epollerr", "()I", (void *) netty_epoll_native_epollerr }, { "tcpMd5SigMaxKeyLen", "()I", (void *) netty_epoll_native_tcpMd5SigMaxKeyLen }, { "isSupportingSendmmsg", "()Z", (void *) netty_epoll_native_isSupportingSendmmsg }, { "isSupportingTcpFastopen", "()Z", (void *) netty_epoll_native_isSupportingTcpFastopen }, { "kernelVersion", "()Ljava/lang/String;", (void *) netty_epoll_native_kernelVersion } }; static const jint statically_referenced_fixed_method_table_size = sizeof(statically_referenced_fixed_method_table) / sizeof(statically_referenced_fixed_method_table[0]); static const JNINativeMethod fixed_method_table[] = { { "eventFd", "()I", (void *) netty_epoll_native_eventFd }, { "eventFdWrite", "(IJ)V", (void *) netty_epoll_native_eventFdWrite }, { "eventFdRead", "(I)V", (void *) netty_epoll_native_eventFdRead }, { "epollCreate", "()I", (void *) netty_epoll_native_epollCreate }, { "epollWait0", "(IJII)I", (void *) netty_epoll_native_epollWait0 }, { "epollCtlAdd0", "(III)I", (void *) netty_epoll_native_epollCtlAdd0 }, { "epollCtlMod0", "(III)I", (void *) netty_epoll_native_epollCtlMod0 }, { "epollCtlDel0", "(II)I", (void *) netty_epoll_native_epollCtlDel0 }, // "sendmmsg0" has a dynamic signature // "sendFile0" has a dynamic signature { "sizeofEpollEvent", "()I", (void *) netty_epoll_native_sizeofEpollEvent }, { "offsetofEpollData", "()I", (void *) netty_epoll_native_offsetofEpollData }, { "splice0", "(IJIJJ)I", (void *) netty_epoll_native_splice0 } }; static const jint fixed_method_table_size = sizeof(fixed_method_table) / sizeof(fixed_method_table[0]); static jint dynamicMethodsTableSize() { return fixed_method_table_size + 2; } static JNINativeMethod* createDynamicMethodsTable(const char* packagePrefix) { JNINativeMethod* dynamicMethods = malloc(sizeof(JNINativeMethod) * dynamicMethodsTableSize()); memcpy(dynamicMethods, fixed_method_table, sizeof(fixed_method_table)); char* dynamicTypeName = netty_unix_util_prepend(packagePrefix, "io/netty/channel/epoll/NativeDatagramPacketArray$NativeDatagramPacket;II)I"); JNINativeMethod* dynamicMethod = &dynamicMethods[fixed_method_table_size]; dynamicMethod->name = "sendmmsg0"; dynamicMethod->signature = netty_unix_util_prepend("(I[L", dynamicTypeName); dynamicMethod->fnPtr = (void *) netty_epoll_native_sendmmsg0; free(dynamicTypeName); ++dynamicMethod; dynamicTypeName = netty_unix_util_prepend(packagePrefix, "io/netty/channel/DefaultFileRegion;JJJ)J"); dynamicMethod->name = "sendfile0"; dynamicMethod->signature = netty_unix_util_prepend("(IL", dynamicTypeName); dynamicMethod->fnPtr = (void *) netty_epoll_native_sendfile0; free(dynamicTypeName); return dynamicMethods; } static void freeDynamicMethodsTable(JNINativeMethod* dynamicMethods) { jint fullMethodTableSize = dynamicMethodsTableSize(); jint i = fixed_method_table_size; for (; i < fullMethodTableSize; ++i) { free(dynamicMethods[i].signature); } free(dynamicMethods); } // JNI Method Registration Table End static jint netty_epoll_native_JNI_OnLoad(JNIEnv* env, const char* packagePrefix) { // We must register the statically referenced methods first! if (netty_unix_util_register_natives(env, packagePrefix, "io/netty/channel/epoll/NativeStaticallyReferencedJniMethods", statically_referenced_fixed_method_table, statically_referenced_fixed_method_table_size) != 0) { return JNI_ERR; } // Register the methods which are not referenced by static member variables JNINativeMethod* dynamicMethods = createDynamicMethodsTable(packagePrefix); if (netty_unix_util_register_natives(env, packagePrefix, "io/netty/channel/epoll/Native", dynamicMethods, dynamicMethodsTableSize()) != 0) { freeDynamicMethodsTable(dynamicMethods); return JNI_ERR; } freeDynamicMethodsTable(dynamicMethods); dynamicMethods = NULL; // Load all c modules that we depend upon if (netty_unix_limits_JNI_OnLoad(env, packagePrefix) == JNI_ERR) { return JNI_ERR; } if (netty_unix_errors_JNI_OnLoad(env, packagePrefix) == JNI_ERR) { return JNI_ERR; } if (netty_unix_filedescriptor_JNI_OnLoad(env, packagePrefix) == JNI_ERR) { return JNI_ERR; } if (netty_unix_socket_JNI_OnLoad(env, packagePrefix) == JNI_ERR) { return JNI_ERR; } if (netty_epoll_linuxsocket_JNI_OnLoad(env, packagePrefix) == JNI_ERR) { return JNI_ERR; } // Initialize this module char* nettyClassName = netty_unix_util_prepend(packagePrefix, "io/netty/channel/DefaultFileRegion"); jclass fileRegionCls = (*env)->FindClass(env, nettyClassName); free(nettyClassName); nettyClassName = NULL; if (fileRegionCls == NULL) { return JNI_ERR; } fileChannelFieldId = (*env)->GetFieldID(env, fileRegionCls, "file", "Ljava/nio/channels/FileChannel;"); if (fileChannelFieldId == NULL) { netty_unix_errors_throwRuntimeException(env, "failed to get field ID: DefaultFileRegion.file"); return JNI_ERR; } transferredFieldId = (*env)->GetFieldID(env, fileRegionCls, "transferred", "J"); if (transferredFieldId == NULL) { netty_unix_errors_throwRuntimeException(env, "failed to get field ID: DefaultFileRegion.transferred"); return JNI_ERR; } jclass fileChannelCls = (*env)->FindClass(env, "sun/nio/ch/FileChannelImpl"); if (fileChannelCls == NULL) { // pending exception... return JNI_ERR; } fileDescriptorFieldId = (*env)->GetFieldID(env, fileChannelCls, "fd", "Ljava/io/FileDescriptor;"); if (fileDescriptorFieldId == NULL) { netty_unix_errors_throwRuntimeException(env, "failed to get field ID: FileChannelImpl.fd"); return JNI_ERR; } jclass fileDescriptorCls = (*env)->FindClass(env, "java/io/FileDescriptor"); if (fileDescriptorCls == NULL) { // pending exception... return JNI_ERR; } fdFieldId = (*env)->GetFieldID(env, fileDescriptorCls, "fd", "I"); if (fdFieldId == NULL) { netty_unix_errors_throwRuntimeException(env, "failed to get field ID: FileDescriptor.fd"); return JNI_ERR; } nettyClassName = netty_unix_util_prepend(packagePrefix, "io/netty/channel/epoll/NativeDatagramPacketArray$NativeDatagramPacket"); jclass nativeDatagramPacketCls = (*env)->FindClass(env, nettyClassName); free(nettyClassName); nettyClassName = NULL; if (nativeDatagramPacketCls == NULL) { // pending exception... return JNI_ERR; } packetAddrFieldId = (*env)->GetFieldID(env, nativeDatagramPacketCls, "addr", "[B"); if (packetAddrFieldId == NULL) { netty_unix_errors_throwRuntimeException(env, "failed to get field ID: NativeDatagramPacket.addr"); return JNI_ERR; } packetScopeIdFieldId = (*env)->GetFieldID(env, nativeDatagramPacketCls, "scopeId", "I"); if (packetScopeIdFieldId == NULL) { netty_unix_errors_throwRuntimeException(env, "failed to get field ID: NativeDatagramPacket.scopeId"); return JNI_ERR; } packetPortFieldId = (*env)->GetFieldID(env, nativeDatagramPacketCls, "port", "I"); if (packetPortFieldId == NULL) { netty_unix_errors_throwRuntimeException(env, "failed to get field ID: NativeDatagramPacket.port"); return JNI_ERR; } packetMemoryAddressFieldId = (*env)->GetFieldID(env, nativeDatagramPacketCls, "memoryAddress", "J"); if (packetMemoryAddressFieldId == NULL) { netty_unix_errors_throwRuntimeException(env, "failed to get field ID: NativeDatagramPacket.memoryAddress"); return JNI_ERR; } packetCountFieldId = (*env)->GetFieldID(env, nativeDatagramPacketCls, "count", "I"); if (packetCountFieldId == NULL) { netty_unix_errors_throwRuntimeException(env, "failed to get field ID: NativeDatagramPacket.count"); return JNI_ERR; } if (!netty_unix_util_initialize_wait_clock(&waitClockId)) { fprintf(stderr, "FATAL: could not find a clock for clock_gettime!\n"); return JNI_ERR; } return NETTY_JNI_VERSION; } static void netty_epoll_native_JNI_OnUnLoad(JNIEnv* env) { netty_unix_limits_JNI_OnUnLoad(env); netty_unix_errors_JNI_OnUnLoad(env); netty_unix_filedescriptor_JNI_OnUnLoad(env); netty_unix_socket_JNI_OnUnLoad(env); netty_epoll_linuxsocket_JNI_OnUnLoad(env); } // Invoked by the JVM when statically linked jint JNI_OnLoad_netty_transport_native_epoll(JavaVM* vm, void* reserved) { JNIEnv* env; if ((*vm)->GetEnv(vm, (void**) &env, NETTY_JNI_VERSION) != JNI_OK) { return JNI_ERR; } char* packagePrefix = NULL; #ifndef NETTY_BUILD_STATIC Dl_info dlinfo; jint status = 0; // We need to use an address of a function that is uniquely part of this library, so choose a static // function. See https://github.com/netty/netty/issues/4840. if (!dladdr((void*) netty_epoll_native_JNI_OnUnLoad, &dlinfo)) { fprintf(stderr, "FATAL: transport-native-epoll JNI call to dladdr failed!\n"); return JNI_ERR; } packagePrefix = netty_unix_util_parse_package_prefix(dlinfo.dli_fname, "netty_transport_native_epoll", &status); if (status == JNI_ERR) { fprintf(stderr, "FATAL: transport-native-epoll JNI encountered unexpected dlinfo.dli_fname: %s\n", dlinfo.dli_fname); return JNI_ERR; } #endif /* NETTY_BUILD_STATIC */ jint ret = netty_epoll_native_JNI_OnLoad(env, packagePrefix); if (packagePrefix != NULL) { free(packagePrefix); packagePrefix = NULL; } return ret; } #ifndef NETTY_BUILD_STATIC jint JNI_OnLoad(JavaVM* vm, void* reserved) { return JNI_OnLoad_netty_transport_native_epoll(vm, reserved); } #endif /* NETTY_BUILD_STATIC */ // Invoked by the JVM when statically linked void JNI_OnUnload_netty_transport_native_epoll(JavaVM* vm, void* reserved) { JNIEnv* env; if ((*vm)->GetEnv(vm, (void**) &env, NETTY_JNI_VERSION) != JNI_OK) { // Something is wrong but nothing we can do about this :( return; } netty_epoll_native_JNI_OnUnLoad(env); } #ifndef NETTY_BUILD_STATIC void JNI_OnUnload(JavaVM* vm, void* reserved) { JNI_OnUnload_netty_transport_native_epoll(vm, reserved); } #endif /* NETTY_BUILD_STATIC */