org.apache.flink.runtime.jobmaster.slotpool.DefaultSlotPoolFactory Maven / Gradle / Ivy

/*
 * 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.jobmaster.slotpool;

import org.apache.flink.api.common.JobID;
import org.apache.flink.api.common.time.Time;
import org.apache.flink.configuration.CheckpointingOptions;
import org.apache.flink.configuration.Configuration;
import org.apache.flink.configuration.JobManagerOptions;
import org.apache.flink.runtime.akka.AkkaUtils;
import org.apache.flink.runtime.rpc.RpcService;
import org.apache.flink.runtime.util.clock.Clock;
import org.apache.flink.runtime.util.clock.SystemClock;

import javax.annotation.Nonnull;

/**
 * Default slot pool factory.
 */
public class DefaultSlotPoolFactory implements SlotPoolFactory {

	@Nonnull
	private final RpcService rpcService;

	@Nonnull
	private final SchedulingStrategy schedulingStrategy;

	@Nonnull
	private final Clock clock;

	@Nonnull
	private final Time rpcTimeout;

	@Nonnull
	private final Time slotIdleTimeout;

	@Nonnull
	private final Boolean enableSharedSlot;

	private final boolean enableSlotTagMatching;

	private final boolean enableSlotsConverging;

	public DefaultSlotPoolFactory(
			@Nonnull RpcService rpcService,
			@Nonnull SchedulingStrategy schedulingStrategy,
			@Nonnull Clock clock,
			@Nonnull Time rpcTimeout,
			@Nonnull Time slotIdleTimeout,
			@Nonnull Boolean enableSharedSlot,
			boolean enableSlotTagMatching,
			boolean enableSlotsConverging) {
		this.rpcService = rpcService;
		this.schedulingStrategy = schedulingStrategy;
		this.clock = clock;
		this.rpcTimeout = rpcTimeout;
		this.slotIdleTimeout = slotIdleTimeout;
		this.enableSharedSlot = enableSharedSlot;
		this.enableSlotTagMatching = enableSlotTagMatching;
		this.enableSlotsConverging = enableSlotsConverging;
	}

	@Override
	@Nonnull
	public SlotPool createSlotPool(@Nonnull JobID jobId) {
		return new SlotPool(
			rpcService,
			jobId,
			schedulingStrategy,
			clock,
			rpcTimeout,
			slotIdleTimeout,
			enableSharedSlot,
			enableSlotTagMatching,
			enableSlotsConverging);
	}

	public static DefaultSlotPoolFactory fromConfiguration(
			@Nonnull Configuration configuration,
			@Nonnull RpcService rpcService) {
		return fromConfiguration(new SlotPoolConfiguration(configuration), rpcService);
	}

	public static DefaultSlotPoolFactory fromConfiguration(
			@Nonnull SlotPoolConfiguration slotPoolConfiguration,
			@Nonnull RpcService rpcService) {

		final Configuration configuration = slotPoolConfiguration.getConfiguration();
		final Time rpcTimeout = AkkaUtils.getTimeoutAsTime(configuration);
		final Time slotIdleTimeout = Time.milliseconds(configuration.getLong(JobManagerOptions.SLOT_IDLE_TIMEOUT));

		final SchedulingStrategy schedulingStrategy = selectSchedulingStrategy(configuration);
		final Boolean enableSharedSlot = configuration.getBoolean(JobManagerOptions.SLOT_ENABLE_SHARED_SLOT);

		return new DefaultSlotPoolFactory(
			rpcService,
			schedulingStrategy,
			SystemClock.getInstance(),
			rpcTimeout,
			slotIdleTimeout,
			enableSharedSlot,
			slotPoolConfiguration.isEnableSlotTagMatching(),
			slotPoolConfiguration.isEnableSlotsConverging());
	}

	private static SchedulingStrategy selectSchedulingStrategy(Configuration configuration) {
		if (configuration.getBoolean(CheckpointingOptions.LOCAL_RECOVERY)) {
			return PreviousAllocationSchedulingStrategy.getInstance();
		} else {
			return LocationPreferenceSchedulingStrategy.getInstance();
		}
	}
}