rpuch commented on code in PR #6370: URL: https://github.com/apache/ignite-3/pull/6370#discussion_r2262142021
########## modules/network/src/main/java/org/apache/ignite/internal/network/handshake/HandshakeEventLoopSwitcher.java: ########## @@ -0,0 +1,206 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF 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.apache.ignite.internal.network.handshake; + +import static org.apache.ignite.internal.util.CompletableFutures.nullCompletedFuture; + +import io.netty.channel.Channel; +import io.netty.channel.ChannelId; +import io.netty.channel.EventLoop; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.CompletableFuture; +import org.apache.ignite.internal.logger.IgniteLogger; +import org.apache.ignite.internal.logger.Loggers; +import org.apache.ignite.internal.network.netty.ChannelKey; +import org.apache.ignite.network.ClusterNode; + +/** + * A class responsible for managing the assignment of Netty channels to event loops + * and switching channels between event loops when necessary. + */ +public class HandshakeEventLoopSwitcher { + private static final IgniteLogger LOG = Loggers.forClass(HandshakeEventLoopSwitcher.class); + + /** List of available event loops. */ + private final List<EventLoop> executors; + + /** Map to track the number of channels assigned to each event loop. */ + private final Map<Integer, Set<ChannelId>> activeChannelMap; + + /** + * Map to track channel reservations for specific communication connections. + * The map prevents applying different event loops for the same chenell key. Review Comment: ```suggestion * The map prevents applying different event loops for the same channel key. ``` ########## modules/network/src/main/java/org/apache/ignite/internal/network/handshake/HandshakeEventLoopSwitcher.java: ########## @@ -0,0 +1,206 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF 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.apache.ignite.internal.network.handshake; + +import static org.apache.ignite.internal.util.CompletableFutures.nullCompletedFuture; + +import io.netty.channel.Channel; +import io.netty.channel.ChannelId; +import io.netty.channel.EventLoop; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.CompletableFuture; +import org.apache.ignite.internal.logger.IgniteLogger; +import org.apache.ignite.internal.logger.Loggers; +import org.apache.ignite.internal.network.netty.ChannelKey; +import org.apache.ignite.network.ClusterNode; + +/** + * A class responsible for managing the assignment of Netty channels to event loops + * and switching channels between event loops when necessary. + */ +public class HandshakeEventLoopSwitcher { + private static final IgniteLogger LOG = Loggers.forClass(HandshakeEventLoopSwitcher.class); + + /** List of available event loops. */ + private final List<EventLoop> executors; + + /** Map to track the number of channels assigned to each event loop. */ + private final Map<Integer, Set<ChannelId>> activeChannelMap; + + /** + * Map to track channel reservations for specific communication connections. + * The map prevents applying different event loops for the same chenell key. + */ + private final Map<ChannelKey, Integer> channelReservationMap; + + /** + * Constructs a new instance of HandshakeEventLoopSwitcher. + * + * @param eventLoops The list of event loops to manage. + */ + public HandshakeEventLoopSwitcher(List<EventLoop> eventLoops) { + this.executors = eventLoops; + this.activeChannelMap = new HashMap<>(eventLoops.size()); + this.channelReservationMap = new HashMap<>(); + } + + /** + * Switches the event loop of a given channel if needed. + * + * @param channel The channel to potentially switch to a different event loop. + * @param afterSwitching A callback to execute after the switching operation. + * @return A CompletableFuture that completes when the event loop is switched. + */ + public CompletableFuture<Void> switchEventLoopIfNeeded(Channel channel, Runnable afterSwitching) { + return switchEventLoopIfNeeded(channel, afterSwitching, null); + } + + /** + * Switches the event loop of a given channel if needed. + * + * @param channel The channel to potentially switch to a different event loop. + * @param afterSwitching A callback to execute after the switching operation. + * @param channelKey The unique key identifying the channel. + * @return A CompletableFuture that completes when the event loop is switched. + */ + public CompletableFuture<Void> switchEventLoopIfNeeded(Channel channel, Runnable afterSwitching, ChannelKey channelKey) { + ChannelId channelId = channel.id(); + + EventLoop targetEventLoop = eventLoopForKey(channelId, channelKey); + + if (targetEventLoop != channel.eventLoop()) { + CompletableFuture<Void> fut = new CompletableFuture<>(); + + channel.deregister().addListener(deregistrationFuture -> { + if (!deregistrationFuture.isSuccess()) { + LOG.error("Cannot deregister a channel from an event loop", deregistrationFuture.cause()); + + fut.completeExceptionally(deregistrationFuture.cause()); + + channel.close(); + + return; + } + + targetEventLoop.register(channel).addListener(registrationFuture -> { + if (!registrationFuture.isSuccess()) { + LOG.error("Cannot register a channel with an event loop", registrationFuture.cause()); + + fut.completeExceptionally(deregistrationFuture.cause()); + + channel.close(); + + return; + } + + channel.closeFuture().addListener(future -> { + channelUnregistered(channelId); + }); + + + fut.complete(null); + + afterSwitching.run(); + }); + }); + + return fut; + } + + afterSwitching.run(); + + return nullCompletedFuture(); + } + + + /** + * Determines the appropriate event loop for a given channel key. + * + * @param channelId The ID of the channel. + * @param channelKey The unique key identifying the channel. + * @return The selected event loop for the channel. + */ + private synchronized EventLoop eventLoopForKey(ChannelId channelId, ChannelKey channelKey) { Review Comment: ```suggestion private synchronized EventLoop eventLoopForKey(ChannelId channelId, @Nullable ChannelKey channelKey) { ``` ########## modules/network/src/main/java/org/apache/ignite/internal/network/handshake/HandshakeEventLoopSwitcher.java: ########## @@ -0,0 +1,206 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF 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.apache.ignite.internal.network.handshake; + +import static org.apache.ignite.internal.util.CompletableFutures.nullCompletedFuture; + +import io.netty.channel.Channel; +import io.netty.channel.ChannelId; +import io.netty.channel.EventLoop; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.CompletableFuture; +import org.apache.ignite.internal.logger.IgniteLogger; +import org.apache.ignite.internal.logger.Loggers; +import org.apache.ignite.internal.network.netty.ChannelKey; +import org.apache.ignite.network.ClusterNode; + +/** + * A class responsible for managing the assignment of Netty channels to event loops + * and switching channels between event loops when necessary. + */ +public class HandshakeEventLoopSwitcher { + private static final IgniteLogger LOG = Loggers.forClass(HandshakeEventLoopSwitcher.class); + + /** List of available event loops. */ + private final List<EventLoop> executors; + + /** Map to track the number of channels assigned to each event loop. */ + private final Map<Integer, Set<ChannelId>> activeChannelMap; + + /** + * Map to track channel reservations for specific communication connections. + * The map prevents applying different event loops for the same chenell key. + */ + private final Map<ChannelKey, Integer> channelReservationMap; + + /** + * Constructs a new instance of HandshakeEventLoopSwitcher. + * + * @param eventLoops The list of event loops to manage. + */ + public HandshakeEventLoopSwitcher(List<EventLoop> eventLoops) { + this.executors = eventLoops; + this.activeChannelMap = new HashMap<>(eventLoops.size()); + this.channelReservationMap = new HashMap<>(); + } + + /** + * Switches the event loop of a given channel if needed. + * + * @param channel The channel to potentially switch to a different event loop. + * @param afterSwitching A callback to execute after the switching operation. + * @return A CompletableFuture that completes when the event loop is switched. + */ + public CompletableFuture<Void> switchEventLoopIfNeeded(Channel channel, Runnable afterSwitching) { + return switchEventLoopIfNeeded(channel, afterSwitching, null); + } + + /** + * Switches the event loop of a given channel if needed. + * + * @param channel The channel to potentially switch to a different event loop. + * @param afterSwitching A callback to execute after the switching operation. + * @param channelKey The unique key identifying the channel. + * @return A CompletableFuture that completes when the event loop is switched. + */ + public CompletableFuture<Void> switchEventLoopIfNeeded(Channel channel, Runnable afterSwitching, ChannelKey channelKey) { Review Comment: ```suggestion public CompletableFuture<Void> switchEventLoopIfNeeded(Channel channel, Runnable afterSwitching, @Nullablr ChannelKey channelKey) { ``` Also, it seems to make sense to put closure parameters last (after all 'simple type' parameters), this allows to make the code more readable if the closure is a lambda of a few lines, not just one expression ########## modules/network/src/main/java/org/apache/ignite/internal/network/handshake/HandshakeEventLoopSwitcher.java: ########## @@ -0,0 +1,206 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF 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.apache.ignite.internal.network.handshake; + +import static org.apache.ignite.internal.util.CompletableFutures.nullCompletedFuture; + +import io.netty.channel.Channel; +import io.netty.channel.ChannelId; +import io.netty.channel.EventLoop; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.CompletableFuture; +import org.apache.ignite.internal.logger.IgniteLogger; +import org.apache.ignite.internal.logger.Loggers; +import org.apache.ignite.internal.network.netty.ChannelKey; +import org.apache.ignite.network.ClusterNode; + +/** + * A class responsible for managing the assignment of Netty channels to event loops + * and switching channels between event loops when necessary. + */ +public class HandshakeEventLoopSwitcher { + private static final IgniteLogger LOG = Loggers.forClass(HandshakeEventLoopSwitcher.class); + + /** List of available event loops. */ + private final List<EventLoop> executors; + + /** Map to track the number of channels assigned to each event loop. */ + private final Map<Integer, Set<ChannelId>> activeChannelMap; + + /** + * Map to track channel reservations for specific communication connections. + * The map prevents applying different event loops for the same chenell key. + */ + private final Map<ChannelKey, Integer> channelReservationMap; + + /** + * Constructs a new instance of HandshakeEventLoopSwitcher. + * + * @param eventLoops The list of event loops to manage. + */ + public HandshakeEventLoopSwitcher(List<EventLoop> eventLoops) { + this.executors = eventLoops; + this.activeChannelMap = new HashMap<>(eventLoops.size()); + this.channelReservationMap = new HashMap<>(); + } + + /** + * Switches the event loop of a given channel if needed. + * + * @param channel The channel to potentially switch to a different event loop. + * @param afterSwitching A callback to execute after the switching operation. + * @return A CompletableFuture that completes when the event loop is switched. + */ + public CompletableFuture<Void> switchEventLoopIfNeeded(Channel channel, Runnable afterSwitching) { Review Comment: Both callbacks and promises/futures are used for async programming, but we should not mix them as this causes confusion. Before your change, we didn't need futures, so callback style was used; but as we now switch to the 'future style', let's remove the callback. The caller should just use future composition (`thenCompose()`, for example) to proceed after having switched to the new event loop. Also, please state in the javadoc of this method (and its overload) that the future will be completed in the target event loop. ########## modules/network/src/main/java/org/apache/ignite/internal/network/handshake/HandshakeEventLoopSwitcher.java: ########## @@ -0,0 +1,206 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF 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.apache.ignite.internal.network.handshake; + +import static org.apache.ignite.internal.util.CompletableFutures.nullCompletedFuture; + +import io.netty.channel.Channel; +import io.netty.channel.ChannelId; +import io.netty.channel.EventLoop; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.CompletableFuture; +import org.apache.ignite.internal.logger.IgniteLogger; +import org.apache.ignite.internal.logger.Loggers; +import org.apache.ignite.internal.network.netty.ChannelKey; +import org.apache.ignite.network.ClusterNode; + +/** + * A class responsible for managing the assignment of Netty channels to event loops + * and switching channels between event loops when necessary. + */ +public class HandshakeEventLoopSwitcher { + private static final IgniteLogger LOG = Loggers.forClass(HandshakeEventLoopSwitcher.class); + + /** List of available event loops. */ + private final List<EventLoop> executors; + + /** Map to track the number of channels assigned to each event loop. */ + private final Map<Integer, Set<ChannelId>> activeChannelMap; + + /** + * Map to track channel reservations for specific communication connections. + * The map prevents applying different event loops for the same chenell key. + */ + private final Map<ChannelKey, Integer> channelReservationMap; Review Comment: ```suggestion private final Map<ChannelKey, Integer> channelReservationMap = new HashMap<>(); ``` ########## modules/network/src/main/java/org/apache/ignite/internal/network/handshake/HandshakeEventLoopSwitcher.java: ########## @@ -0,0 +1,206 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF 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.apache.ignite.internal.network.handshake; + +import static org.apache.ignite.internal.util.CompletableFutures.nullCompletedFuture; + +import io.netty.channel.Channel; +import io.netty.channel.ChannelId; +import io.netty.channel.EventLoop; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.CompletableFuture; +import org.apache.ignite.internal.logger.IgniteLogger; +import org.apache.ignite.internal.logger.Loggers; +import org.apache.ignite.internal.network.netty.ChannelKey; +import org.apache.ignite.network.ClusterNode; + +/** + * A class responsible for managing the assignment of Netty channels to event loops + * and switching channels between event loops when necessary. + */ +public class HandshakeEventLoopSwitcher { + private static final IgniteLogger LOG = Loggers.forClass(HandshakeEventLoopSwitcher.class); + + /** List of available event loops. */ + private final List<EventLoop> executors; + + /** Map to track the number of channels assigned to each event loop. */ + private final Map<Integer, Set<ChannelId>> activeChannelMap; + + /** + * Map to track channel reservations for specific communication connections. + * The map prevents applying different event loops for the same chenell key. + */ + private final Map<ChannelKey, Integer> channelReservationMap; + + /** + * Constructs a new instance of HandshakeEventLoopSwitcher. + * + * @param eventLoops The list of event loops to manage. + */ + public HandshakeEventLoopSwitcher(List<EventLoop> eventLoops) { + this.executors = eventLoops; + this.activeChannelMap = new HashMap<>(eventLoops.size()); + this.channelReservationMap = new HashMap<>(); + } + + /** + * Switches the event loop of a given channel if needed. + * + * @param channel The channel to potentially switch to a different event loop. + * @param afterSwitching A callback to execute after the switching operation. + * @return A CompletableFuture that completes when the event loop is switched. + */ + public CompletableFuture<Void> switchEventLoopIfNeeded(Channel channel, Runnable afterSwitching) { + return switchEventLoopIfNeeded(channel, afterSwitching, null); + } + + /** + * Switches the event loop of a given channel if needed. + * + * @param channel The channel to potentially switch to a different event loop. + * @param afterSwitching A callback to execute after the switching operation. + * @param channelKey The unique key identifying the channel. + * @return A CompletableFuture that completes when the event loop is switched. + */ + public CompletableFuture<Void> switchEventLoopIfNeeded(Channel channel, Runnable afterSwitching, ChannelKey channelKey) { + ChannelId channelId = channel.id(); + + EventLoop targetEventLoop = eventLoopForKey(channelId, channelKey); + + if (targetEventLoop != channel.eventLoop()) { + CompletableFuture<Void> fut = new CompletableFuture<>(); + + channel.deregister().addListener(deregistrationFuture -> { + if (!deregistrationFuture.isSuccess()) { + LOG.error("Cannot deregister a channel from an event loop", deregistrationFuture.cause()); + + fut.completeExceptionally(deregistrationFuture.cause()); + + channel.close(); + + return; + } + + targetEventLoop.register(channel).addListener(registrationFuture -> { + if (!registrationFuture.isSuccess()) { + LOG.error("Cannot register a channel with an event loop", registrationFuture.cause()); + + fut.completeExceptionally(deregistrationFuture.cause()); + + channel.close(); + + return; + } + + channel.closeFuture().addListener(future -> { + channelUnregistered(channelId); + }); + + + fut.complete(null); + + afterSwitching.run(); + }); + }); + + return fut; + } + + afterSwitching.run(); + + return nullCompletedFuture(); + } + + + /** + * Determines the appropriate event loop for a given channel key. + * + * @param channelId The ID of the channel. + * @param channelKey The unique key identifying the channel. + * @return The selected event loop for the channel. + */ + private synchronized EventLoop eventLoopForKey(ChannelId channelId, ChannelKey channelKey) { + if (channelKey != null) { + Integer idx = channelReservationMap.get(channelKey); + + if (idx != null) { + return executors.get(idx); + } + } + + int minCnt = Integer.MAX_VALUE; + int index = 0; + + for (int i = 0; i < executors.size(); i++) { + Set<ChannelId> channelIds = activeChannelMap.getOrDefault(i, Set.of()); + + if (channelIds.contains(channelId)) { + return executors.get(index); Review Comment: Here, we don't update `channelReservationMap`. This code relies on an invariant that for the same channelId it cannot happen that first a null key is supplied, then a non-null key is supplied. This is not the most obvious invariant, it can be easy to break it in the future. Let's add an assertion here that channelKey is null. ########## modules/network/src/main/java/org/apache/ignite/internal/network/handshake/HandshakeEventLoopSwitcher.java: ########## @@ -0,0 +1,206 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF 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.apache.ignite.internal.network.handshake; + +import static org.apache.ignite.internal.util.CompletableFutures.nullCompletedFuture; + +import io.netty.channel.Channel; +import io.netty.channel.ChannelId; +import io.netty.channel.EventLoop; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.CompletableFuture; +import org.apache.ignite.internal.logger.IgniteLogger; +import org.apache.ignite.internal.logger.Loggers; +import org.apache.ignite.internal.network.netty.ChannelKey; +import org.apache.ignite.network.ClusterNode; + +/** + * A class responsible for managing the assignment of Netty channels to event loops + * and switching channels between event loops when necessary. + */ +public class HandshakeEventLoopSwitcher { + private static final IgniteLogger LOG = Loggers.forClass(HandshakeEventLoopSwitcher.class); + + /** List of available event loops. */ + private final List<EventLoop> executors; + + /** Map to track the number of channels assigned to each event loop. */ + private final Map<Integer, Set<ChannelId>> activeChannelMap; + + /** + * Map to track channel reservations for specific communication connections. + * The map prevents applying different event loops for the same chenell key. + */ + private final Map<ChannelKey, Integer> channelReservationMap; + + /** + * Constructs a new instance of HandshakeEventLoopSwitcher. + * + * @param eventLoops The list of event loops to manage. + */ + public HandshakeEventLoopSwitcher(List<EventLoop> eventLoops) { + this.executors = eventLoops; + this.activeChannelMap = new HashMap<>(eventLoops.size()); + this.channelReservationMap = new HashMap<>(); + } + + /** + * Switches the event loop of a given channel if needed. + * + * @param channel The channel to potentially switch to a different event loop. + * @param afterSwitching A callback to execute after the switching operation. + * @return A CompletableFuture that completes when the event loop is switched. + */ + public CompletableFuture<Void> switchEventLoopIfNeeded(Channel channel, Runnable afterSwitching) { + return switchEventLoopIfNeeded(channel, afterSwitching, null); + } + + /** + * Switches the event loop of a given channel if needed. + * + * @param channel The channel to potentially switch to a different event loop. + * @param afterSwitching A callback to execute after the switching operation. + * @param channelKey The unique key identifying the channel. + * @return A CompletableFuture that completes when the event loop is switched. + */ + public CompletableFuture<Void> switchEventLoopIfNeeded(Channel channel, Runnable afterSwitching, ChannelKey channelKey) { + ChannelId channelId = channel.id(); + + EventLoop targetEventLoop = eventLoopForKey(channelId, channelKey); + + if (targetEventLoop != channel.eventLoop()) { + CompletableFuture<Void> fut = new CompletableFuture<>(); + + channel.deregister().addListener(deregistrationFuture -> { + if (!deregistrationFuture.isSuccess()) { + LOG.error("Cannot deregister a channel from an event loop", deregistrationFuture.cause()); + + fut.completeExceptionally(deregistrationFuture.cause()); + + channel.close(); + + return; + } + + targetEventLoop.register(channel).addListener(registrationFuture -> { + if (!registrationFuture.isSuccess()) { + LOG.error("Cannot register a channel with an event loop", registrationFuture.cause()); + + fut.completeExceptionally(deregistrationFuture.cause()); + + channel.close(); + + return; + } + + channel.closeFuture().addListener(future -> { + channelUnregistered(channelId); + }); + + + fut.complete(null); + + afterSwitching.run(); + }); + }); + + return fut; + } + + afterSwitching.run(); + + return nullCompletedFuture(); + } + + + /** + * Determines the appropriate event loop for a given channel key. + * + * @param channelId The ID of the channel. + * @param channelKey The unique key identifying the channel. Review Comment: Please elaborate what it means if it's null ########## modules/network/src/main/java/org/apache/ignite/internal/network/handshake/HandshakeEventLoopSwitcher.java: ########## @@ -0,0 +1,206 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF 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.apache.ignite.internal.network.handshake; + +import static org.apache.ignite.internal.util.CompletableFutures.nullCompletedFuture; + +import io.netty.channel.Channel; +import io.netty.channel.ChannelId; +import io.netty.channel.EventLoop; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.CompletableFuture; +import org.apache.ignite.internal.logger.IgniteLogger; +import org.apache.ignite.internal.logger.Loggers; +import org.apache.ignite.internal.network.netty.ChannelKey; +import org.apache.ignite.network.ClusterNode; + +/** + * A class responsible for managing the assignment of Netty channels to event loops + * and switching channels between event loops when necessary. + */ +public class HandshakeEventLoopSwitcher { + private static final IgniteLogger LOG = Loggers.forClass(HandshakeEventLoopSwitcher.class); + + /** List of available event loops. */ + private final List<EventLoop> executors; + + /** Map to track the number of channels assigned to each event loop. */ + private final Map<Integer, Set<ChannelId>> activeChannelMap; + + /** + * Map to track channel reservations for specific communication connections. + * The map prevents applying different event loops for the same chenell key. + */ + private final Map<ChannelKey, Integer> channelReservationMap; + + /** + * Constructs a new instance of HandshakeEventLoopSwitcher. + * + * @param eventLoops The list of event loops to manage. + */ + public HandshakeEventLoopSwitcher(List<EventLoop> eventLoops) { + this.executors = eventLoops; + this.activeChannelMap = new HashMap<>(eventLoops.size()); + this.channelReservationMap = new HashMap<>(); + } + + /** + * Switches the event loop of a given channel if needed. + * + * @param channel The channel to potentially switch to a different event loop. + * @param afterSwitching A callback to execute after the switching operation. + * @return A CompletableFuture that completes when the event loop is switched. + */ + public CompletableFuture<Void> switchEventLoopIfNeeded(Channel channel, Runnable afterSwitching) { + return switchEventLoopIfNeeded(channel, afterSwitching, null); + } + + /** + * Switches the event loop of a given channel if needed. + * + * @param channel The channel to potentially switch to a different event loop. + * @param afterSwitching A callback to execute after the switching operation. + * @param channelKey The unique key identifying the channel. + * @return A CompletableFuture that completes when the event loop is switched. + */ + public CompletableFuture<Void> switchEventLoopIfNeeded(Channel channel, Runnable afterSwitching, ChannelKey channelKey) { + ChannelId channelId = channel.id(); + + EventLoop targetEventLoop = eventLoopForKey(channelId, channelKey); + + if (targetEventLoop != channel.eventLoop()) { + CompletableFuture<Void> fut = new CompletableFuture<>(); + + channel.deregister().addListener(deregistrationFuture -> { + if (!deregistrationFuture.isSuccess()) { + LOG.error("Cannot deregister a channel from an event loop", deregistrationFuture.cause()); + + fut.completeExceptionally(deregistrationFuture.cause()); + + channel.close(); + + return; + } + + targetEventLoop.register(channel).addListener(registrationFuture -> { + if (!registrationFuture.isSuccess()) { + LOG.error("Cannot register a channel with an event loop", registrationFuture.cause()); + + fut.completeExceptionally(deregistrationFuture.cause()); + + channel.close(); + + return; + } + + channel.closeFuture().addListener(future -> { + channelUnregistered(channelId); + }); + + + fut.complete(null); + + afterSwitching.run(); + }); + }); + + return fut; + } + + afterSwitching.run(); + + return nullCompletedFuture(); + } + + + /** + * Determines the appropriate event loop for a given channel key. + * + * @param channelId The ID of the channel. + * @param channelKey The unique key identifying the channel. + * @return The selected event loop for the channel. + */ + private synchronized EventLoop eventLoopForKey(ChannelId channelId, ChannelKey channelKey) { + if (channelKey != null) { + Integer idx = channelReservationMap.get(channelKey); + + if (idx != null) { + return executors.get(idx); + } + } + + int minCnt = Integer.MAX_VALUE; + int index = 0; + + for (int i = 0; i < executors.size(); i++) { + Set<ChannelId> channelIds = activeChannelMap.getOrDefault(i, Set.of()); + + if (channelIds.contains(channelId)) { + return executors.get(index); + } + + int cnt = channelIds.size(); + + if (cnt < minCnt) { + minCnt = cnt; + index = i; Review Comment: Let's break the loop if `cnt` is 0 ########## modules/network/src/main/java/org/apache/ignite/internal/network/handshake/HandshakeEventLoopSwitcher.java: ########## @@ -0,0 +1,206 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF 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.apache.ignite.internal.network.handshake; + +import static org.apache.ignite.internal.util.CompletableFutures.nullCompletedFuture; + +import io.netty.channel.Channel; +import io.netty.channel.ChannelId; +import io.netty.channel.EventLoop; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.CompletableFuture; +import org.apache.ignite.internal.logger.IgniteLogger; +import org.apache.ignite.internal.logger.Loggers; +import org.apache.ignite.internal.network.netty.ChannelKey; +import org.apache.ignite.network.ClusterNode; + +/** + * A class responsible for managing the assignment of Netty channels to event loops + * and switching channels between event loops when necessary. + */ +public class HandshakeEventLoopSwitcher { + private static final IgniteLogger LOG = Loggers.forClass(HandshakeEventLoopSwitcher.class); + + /** List of available event loops. */ + private final List<EventLoop> executors; + + /** Map to track the number of channels assigned to each event loop. */ + private final Map<Integer, Set<ChannelId>> activeChannelMap; + + /** + * Map to track channel reservations for specific communication connections. + * The map prevents applying different event loops for the same chenell key. + */ + private final Map<ChannelKey, Integer> channelReservationMap; + + /** + * Constructs a new instance of HandshakeEventLoopSwitcher. + * + * @param eventLoops The list of event loops to manage. + */ + public HandshakeEventLoopSwitcher(List<EventLoop> eventLoops) { + this.executors = eventLoops; + this.activeChannelMap = new HashMap<>(eventLoops.size()); + this.channelReservationMap = new HashMap<>(); + } + + /** + * Switches the event loop of a given channel if needed. + * + * @param channel The channel to potentially switch to a different event loop. + * @param afterSwitching A callback to execute after the switching operation. + * @return A CompletableFuture that completes when the event loop is switched. + */ + public CompletableFuture<Void> switchEventLoopIfNeeded(Channel channel, Runnable afterSwitching) { + return switchEventLoopIfNeeded(channel, afterSwitching, null); + } + + /** + * Switches the event loop of a given channel if needed. + * + * @param channel The channel to potentially switch to a different event loop. + * @param afterSwitching A callback to execute after the switching operation. + * @param channelKey The unique key identifying the channel. + * @return A CompletableFuture that completes when the event loop is switched. + */ + public CompletableFuture<Void> switchEventLoopIfNeeded(Channel channel, Runnable afterSwitching, ChannelKey channelKey) { + ChannelId channelId = channel.id(); + + EventLoop targetEventLoop = eventLoopForKey(channelId, channelKey); + + if (targetEventLoop != channel.eventLoop()) { + CompletableFuture<Void> fut = new CompletableFuture<>(); + + channel.deregister().addListener(deregistrationFuture -> { + if (!deregistrationFuture.isSuccess()) { + LOG.error("Cannot deregister a channel from an event loop", deregistrationFuture.cause()); + + fut.completeExceptionally(deregistrationFuture.cause()); + + channel.close(); + + return; + } + + targetEventLoop.register(channel).addListener(registrationFuture -> { + if (!registrationFuture.isSuccess()) { + LOG.error("Cannot register a channel with an event loop", registrationFuture.cause()); + + fut.completeExceptionally(deregistrationFuture.cause()); + + channel.close(); + + return; + } + + channel.closeFuture().addListener(future -> { + channelUnregistered(channelId); + }); + + + fut.complete(null); + + afterSwitching.run(); + }); + }); + + return fut; + } + + afterSwitching.run(); + + return nullCompletedFuture(); + } + + + /** + * Determines the appropriate event loop for a given channel key. + * + * @param channelId The ID of the channel. + * @param channelKey The unique key identifying the channel. + * @return The selected event loop for the channel. + */ + private synchronized EventLoop eventLoopForKey(ChannelId channelId, ChannelKey channelKey) { + if (channelKey != null) { + Integer idx = channelReservationMap.get(channelKey); + + if (idx != null) { + return executors.get(idx); + } + } + + int minCnt = Integer.MAX_VALUE; + int index = 0; + + for (int i = 0; i < executors.size(); i++) { + Set<ChannelId> channelIds = activeChannelMap.getOrDefault(i, Set.of()); + + if (channelIds.contains(channelId)) { + return executors.get(index); + } + + int cnt = channelIds.size(); + + if (cnt < minCnt) { + minCnt = cnt; + index = i; + } + } + + + activeChannelMap.computeIfAbsent(index, key -> new HashSet<>()).add(channelId); + + if (channelKey != null) { + channelReservationMap.put(channelKey, index); + } + + Review Comment: Again, two blank lines in a row ########## modules/client-handler/src/main/java/org/apache/ignite/client/handler/ClientInboundMessageHandler.java: ########## @@ -460,17 +465,22 @@ private void handshake(ChannelHandlerContext ctx, ClientMessageUnpacker unpacker return; } - authenticationManager - .authenticateAsync(createAuthenticationRequest(clientHandshakeExtensions)) - .handleAsync((user, err) -> { - if (err != null) { - handshakeError(ctx, packer, err); - } else { - handshakeSuccess(ctx, packer, user, clientFeatures, clientVer, clientCode); - } + handshakeEventLoopSwitcher.switchEventLoopIfNeeded(channelHandlerContext.channel(), + () -> authenticationManager.authenticateAsync(createAuthenticationRequest(clientHandshakeExtensions)) + .handleAsync((user, err) -> { + if (err != null) { + handshakeError(ctx, packer, err); + } else { + handshakeSuccess(ctx, packer, user, clientFeatures, clientVer, clientCode); + } + + return null; + }, ctx.executor())) + .exceptionally(t -> { Review Comment: I wonder why this `exceptionally()` is added ########## modules/network/src/test/java/org/apache/ignite/internal/network/netty/RecoveryHandshakeTest.java: ########## @@ -801,7 +815,19 @@ private RecoveryAcceptorHandshakeManager createRecoveryAcceptorHandshakeManager( new ClusterNodeImpl(launchId, consistentId, new NetworkAddress(ACCEPTOR_HOST, PORT)), MESSAGE_FACTORY, provider, - () -> List.of(acceptorSideChannel.eventLoop()), + new HandshakeEventLoopSwitcher(List.of()) { Review Comment: Should we introduce a `NoOpHandshakeEventLoopSwitcher` in tests to avoid repetition? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@ignite.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
