KarmaGYZ commented on a change in pull request #13416: URL: https://github.com/apache/flink/pull/13416#discussion_r491804281
########## File path: flink-runtime/src/test/java/org/apache/flink/runtime/util/config/memory/ManagedMemoryUtilsTest.java ########## @@ -0,0 +1,131 @@ +/* + * 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.flink.runtime.util.config.memory; + +import org.apache.flink.configuration.Configuration; +import org.apache.flink.configuration.IllegalConfigurationException; +import org.apache.flink.configuration.TaskManagerOptions; +import org.apache.flink.configuration.UnmodifiableConfiguration; +import org.apache.flink.core.memory.ManagedMemoryUseCase; +import org.apache.flink.util.TestLogger; + +import org.junit.Test; + +import java.util.Collections; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Map; + +import static org.hamcrest.Matchers.is; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertThat; + +/** + * Tests for {@link ManagedMemoryUtils}. + */ +public class ManagedMemoryUtilsTest extends TestLogger { + + private static final double DELTA = 0.000001; + + private static final int DATA_PROC_WEIGHT = 111; + private static final int PYTHON_WEIGHT = 222; + + private static final UnmodifiableConfiguration CONFIG_WITH_ALL_USE_CASES = + new UnmodifiableConfiguration(new Configuration() {{ + set( + TaskManagerOptions.MANAGED_MEMORY_CONSUMER_WEIGHTS, + new HashMap<String, String>() {{ + put(TaskManagerOptions.ManagedMemoryConsumerNames.DATAPROC, String.valueOf(DATA_PROC_WEIGHT)); + put(TaskManagerOptions.ManagedMemoryConsumerNames.PYTHON, String.valueOf(PYTHON_WEIGHT)); + }}); + }}); + + @Test + public void testGetWeightsFromConfig() { + final Map<ManagedMemoryUseCase, Integer> expectedWeights = new HashMap<ManagedMemoryUseCase, Integer>() {{ + put(ManagedMemoryUseCase.ROCKSDB, DATA_PROC_WEIGHT); + put(ManagedMemoryUseCase.BATCH_OP, DATA_PROC_WEIGHT); + put(ManagedMemoryUseCase.PYTHON, PYTHON_WEIGHT); + }}; + + final Map<ManagedMemoryUseCase, Integer> configuredWeights = + ManagedMemoryUtils.getManagedMemoryUseCaseWeightsFromConfig(CONFIG_WITH_ALL_USE_CASES); + + assertThat(configuredWeights, is(expectedWeights)); + } + + @Test(expected = IllegalConfigurationException.class) + public void testGetWeightsFromConfigFailUnknownUseCase() { + final Configuration config = new Configuration() {{ + set(TaskManagerOptions.MANAGED_MEMORY_CONSUMER_WEIGHTS, Collections.singletonMap("UNKNOWN_KEY", "123")); + }}; + + ManagedMemoryUtils.getManagedMemoryUseCaseWeightsFromConfig(config); + } + + @Test(expected = IllegalConfigurationException.class) + public void testGetWeightsFromConfigFailNegativeWeight() { + final Configuration config = new Configuration() {{ + set(TaskManagerOptions.MANAGED_MEMORY_CONSUMER_WEIGHTS, + Collections.singletonMap(TaskManagerOptions.ManagedMemoryConsumerNames.DATAPROC, "-123")); + }}; + + ManagedMemoryUtils.getManagedMemoryUseCaseWeightsFromConfig(config); + } + + @Test + public void testConvertToFractionOfSlot() { + final ManagedMemoryUseCase useCase = ManagedMemoryUseCase.BATCH_OP; + final double fractionOfUseCase = 0.3; + + final double fractionOfSlot = ManagedMemoryUtils.convertToFractionOfSlot( + useCase, + fractionOfUseCase, + new HashSet<ManagedMemoryUseCase>() {{ + add(ManagedMemoryUseCase.BATCH_OP); + add(ManagedMemoryUseCase.PYTHON); + }}, + CONFIG_WITH_ALL_USE_CASES); + + assertEquals(fractionOfUseCase / 3, fractionOfSlot, DELTA); + } + + @Test + public void testConvertToFractionOfSlotWeightNotConfigured() { + final ManagedMemoryUseCase useCase = ManagedMemoryUseCase.BATCH_OP; + final double fractionOfUseCase = 0.3; + + final Configuration config = new Configuration() {{ + set(TaskManagerOptions.MANAGED_MEMORY_CONSUMER_WEIGHTS, Collections.emptyMap()); + }}; + + final double fractionOfSlot = ManagedMemoryUtils.convertToFractionOfSlot( + useCase, + fractionOfUseCase, + new HashSet<ManagedMemoryUseCase>() {{ + add(ManagedMemoryUseCase.BATCH_OP); + add(ManagedMemoryUseCase.PYTHON); + }}, + config); + + assertEquals(0.0, fractionOfSlot, DELTA); + } + + Review comment: Redundant lines. ########## File path: flink-runtime/src/main/java/org/apache/flink/runtime/util/config/memory/ManagedMemoryUtils.java ########## @@ -0,0 +1,89 @@ +/* + * 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.flink.runtime.util.config.memory; + +import org.apache.flink.api.java.tuple.Tuple2; +import org.apache.flink.configuration.Configuration; +import org.apache.flink.configuration.IllegalConfigurationException; +import org.apache.flink.configuration.TaskManagerOptions; +import org.apache.flink.core.memory.ManagedMemoryUseCase; + +import java.math.BigDecimal; +import java.util.Map; +import java.util.Set; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +/** + * Utils for configuration and calculations related to managed memory and its various use cases. + */ +public enum ManagedMemoryUtils { + ; + + private static final int MANAGED_MEMORY_FRACTION_SCALE = 16; + + public static double convertToFractionOfSlot( + ManagedMemoryUseCase useCase, + double fractionOfUseCase, + Set<ManagedMemoryUseCase> allUseCases, + Configuration config) { + final Map<ManagedMemoryUseCase, Integer> allUseCaseWeights = getManagedMemoryUseCaseWeightsFromConfig(config); + final int totalWeights = allUseCases.stream() + .mapToInt((uc) -> allUseCaseWeights.getOrDefault(uc, 0)) + .sum(); + final int useCaseWeight = allUseCaseWeights.getOrDefault(useCase, 0); + final double useCaseFractionOfSlot = totalWeights > 0 ? + getFractionRoundedDown(useCaseWeight, totalWeights) : + 0.0; + + return fractionOfUseCase * useCaseFractionOfSlot; + } + + public static Map<ManagedMemoryUseCase, Integer> getManagedMemoryUseCaseWeightsFromConfig(Configuration config) { Review comment: It seems this function could be package-private and annotated with "VisibleForTesting". Or it will be used by other classes in the future? ########## File path: flink-runtime/src/main/java/org/apache/flink/runtime/util/config/memory/ManagedMemoryUtils.java ########## @@ -0,0 +1,89 @@ +/* + * 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.flink.runtime.util.config.memory; + +import org.apache.flink.api.java.tuple.Tuple2; +import org.apache.flink.configuration.Configuration; +import org.apache.flink.configuration.IllegalConfigurationException; +import org.apache.flink.configuration.TaskManagerOptions; +import org.apache.flink.core.memory.ManagedMemoryUseCase; + +import java.math.BigDecimal; +import java.util.Map; +import java.util.Set; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +/** + * Utils for configuration and calculations related to managed memory and its various use cases. + */ +public enum ManagedMemoryUtils { + ; Review comment: It's not a problem, but I think it would be good to align the way to achieve singleton in a specific project. After a quick search, I found there is rarely such use-cases in Flink. Using an empty private construct method might be better. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected]
