Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Share netty event loops between transports (#46346)
Currently Elasticsearch creates independent event loop groups for each transport (http and internal) transport type. This is unnecessary and can lead to contention when different threads access shared resources (ex: allocators). This commit moves to a model where, by default, the event loops are shared between the transports. The previous behavior can be attained by specifically setting the http worker count.
- Loading branch information
1 parent
f61d3d8
commit 0bf4be7
Showing
17 changed files
with
328 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
141 changes: 141 additions & 0 deletions
141
modules/transport-netty4/src/main/java/org/elasticsearch/transport/SharedGroupFactory.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch 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. | ||
| */ | ||
|
|
||
| package org.elasticsearch.transport; | ||
|
|
||
| import io.netty.channel.EventLoopGroup; | ||
| import io.netty.channel.nio.NioEventLoopGroup; | ||
| import io.netty.util.concurrent.Future; | ||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
| import org.elasticsearch.common.settings.Settings; | ||
| import org.elasticsearch.common.util.concurrent.AbstractRefCounted; | ||
| import org.elasticsearch.http.HttpServerTransport; | ||
| import org.elasticsearch.http.netty4.Netty4HttpServerTransport; | ||
| import org.elasticsearch.transport.netty4.Netty4Transport; | ||
|
|
||
| import java.util.concurrent.TimeUnit; | ||
| import java.util.concurrent.atomic.AtomicBoolean; | ||
|
|
||
| import static org.elasticsearch.common.util.concurrent.EsExecutors.daemonThreadFactory; | ||
|
|
||
| /** | ||
| * Creates and returns {@link io.netty.channel.EventLoopGroup} instances. It will return a shared group for | ||
| * both {@link #getHttpGroup()} and {@link #getTransportGroup()} if | ||
| * {@link org.elasticsearch.http.netty4.Netty4HttpServerTransport#SETTING_HTTP_WORKER_COUNT} is configured to be 0. | ||
| * If that setting is not 0, then it will return a different group in the {@link #getHttpGroup()} call. | ||
| */ | ||
| public final class SharedGroupFactory { | ||
|
|
||
| private static final Logger logger = LogManager.getLogger(SharedGroupFactory.class); | ||
|
|
||
| private final Settings settings; | ||
| private final int workerCount; | ||
| private final int httpWorkerCount; | ||
|
|
||
| private RefCountedGroup genericGroup; | ||
| private SharedGroup dedicatedHttpGroup; | ||
|
|
||
| public SharedGroupFactory(Settings settings) { | ||
| this.settings = settings; | ||
| this.workerCount = Netty4Transport.WORKER_COUNT.get(settings); | ||
| this.httpWorkerCount = Netty4HttpServerTransport.SETTING_HTTP_WORKER_COUNT.get(settings); | ||
| } | ||
|
|
||
| public Settings getSettings() { | ||
| return settings; | ||
| } | ||
|
|
||
| public int getTransportWorkerCount() { | ||
| return workerCount; | ||
| } | ||
|
|
||
| public synchronized SharedGroup getTransportGroup() { | ||
| return getGenericGroup(); | ||
| } | ||
|
|
||
| public synchronized SharedGroup getHttpGroup() { | ||
| if (httpWorkerCount == 0) { | ||
| return getGenericGroup(); | ||
| } else { | ||
| if (dedicatedHttpGroup == null) { | ||
| NioEventLoopGroup eventLoopGroup = new NioEventLoopGroup(httpWorkerCount, | ||
| daemonThreadFactory(settings, HttpServerTransport.HTTP_SERVER_WORKER_THREAD_NAME_PREFIX)); | ||
| dedicatedHttpGroup = new SharedGroup(new RefCountedGroup(eventLoopGroup)); | ||
| } | ||
| return dedicatedHttpGroup; | ||
| } | ||
| } | ||
|
|
||
| private SharedGroup getGenericGroup() { | ||
| if (genericGroup == null) { | ||
| EventLoopGroup eventLoopGroup = new NioEventLoopGroup(workerCount, | ||
| daemonThreadFactory(settings, TcpTransport.TRANSPORT_WORKER_THREAD_NAME_PREFIX)); | ||
| this.genericGroup = new RefCountedGroup(eventLoopGroup); | ||
| } else { | ||
| genericGroup.incRef(); | ||
| } | ||
| return new SharedGroup(genericGroup); | ||
| } | ||
|
|
||
| private static class RefCountedGroup extends AbstractRefCounted { | ||
|
|
||
| public static final String NAME = "ref-counted-event-loop-group"; | ||
| private final EventLoopGroup eventLoopGroup; | ||
|
|
||
| private RefCountedGroup(EventLoopGroup eventLoopGroup) { | ||
| super(NAME); | ||
| this.eventLoopGroup = eventLoopGroup; | ||
| } | ||
|
|
||
| @Override | ||
| protected void closeInternal() { | ||
| Future<?> shutdownFuture = eventLoopGroup.shutdownGracefully(0, 5, TimeUnit.SECONDS); | ||
| shutdownFuture.awaitUninterruptibly(); | ||
| if (shutdownFuture.isSuccess() == false) { | ||
| logger.warn("Error closing netty event loop group", shutdownFuture.cause()); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Wraps the {@link RefCountedGroup}. Calls {@link RefCountedGroup#decRef()} on close. After close, | ||
| * this wrapped instance can no longer be used. | ||
| */ | ||
| public static class SharedGroup { | ||
|
|
||
| private final RefCountedGroup refCountedGroup; | ||
|
|
||
| private final AtomicBoolean isOpen = new AtomicBoolean(true); | ||
|
|
||
| private SharedGroup(RefCountedGroup refCountedGroup) { | ||
| this.refCountedGroup = refCountedGroup; | ||
| } | ||
|
|
||
| public EventLoopGroup getLowLevelGroup() { | ||
| return refCountedGroup.eventLoopGroup; | ||
| } | ||
|
|
||
| public void shutdown() { | ||
| if (isOpen.compareAndSet(true, false)) { | ||
| refCountedGroup.decRef(); | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.