org.apache.flink.runtime.resourcemanager.slotmanager.DefaultResourceTracker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flink-runtime Show documentation
The newest version!
/*
 * 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.resourcemanager.slotmanager;

import org.apache.flink.annotation.VisibleForTesting;
import org.apache.flink.api.common.JobID;
import org.apache.flink.runtime.clusterframework.types.ResourceProfile;
import org.apache.flink.runtime.slots.ResourceRequirement;
import org.apache.flink.util.Preconditions;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;

/** Default {@link ResourceTracker} implementation. */
public class DefaultResourceTracker implements ResourceTracker {

    private static final Logger LOG = LoggerFactory.getLogger(DefaultResourceTracker.class);

    private final Map trackers = new HashMap<>();

    @Override
    public void notifyResourceRequirements(
            JobID jobId, Collection resourceRequirements) {
        Preconditions.checkNotNull(jobId);
        Preconditions.checkNotNull(resourceRequirements);
        LOG.trace(
                "Received notification for job {} having new resource requirements {}.",
                jobId,
                resourceRequirements);
        getOrCreateTracker(jobId).notifyResourceRequirements(resourceRequirements);

        if (resourceRequirements.isEmpty()) {
            checkWhetherTrackerCanBeRemoved(jobId, trackers.get(jobId));
        }
    }

    private void checkWhetherTrackerCanBeRemoved(JobID jobId, JobScopedResourceTracker tracker) {
        if (tracker.isEmpty()) {
            LOG.debug("Stopping tracking of resources for job {}.", jobId);
            trackers.remove(jobId);
        }
    }

    @Override
    public void notifyAcquiredResource(JobID jobId, ResourceProfile resourceProfile) {
        Preconditions.checkNotNull(jobId);
        Preconditions.checkNotNull(resourceProfile);
        LOG.trace(
                "Received notification for job {} having acquired resource {}.",
                jobId,
                resourceProfile);
        getOrCreateTracker(jobId).notifyAcquiredResource(resourceProfile);
    }

    private JobScopedResourceTracker getOrCreateTracker(JobID jobId) {
        return trackers.computeIfAbsent(
                jobId,
                ignored -> {
                    LOG.debug("Initiating tracking of resources for job {}.", jobId);
                    return new JobScopedResourceTracker(jobId);
                });
    }

    @Override
    public void notifyLostResource(JobID jobId, ResourceProfile resourceProfile) {
        Preconditions.checkNotNull(jobId);
        Preconditions.checkNotNull(resourceProfile);
        JobScopedResourceTracker tracker = trackers.get(jobId);

        // during shutdown the tracker is cleared before task executors are unregistered,
        // to prevent the loss of resources triggering new allocations
        if (tracker != null) {
            LOG.trace(
                    "Received notification for job {} having lost resource {}.",
                    jobId,
                    resourceProfile);
            tracker.notifyLostResource(resourceProfile);

            checkWhetherTrackerCanBeRemoved(jobId, tracker);
        } else {
            LOG.trace(
                    "Received notification for job {} having lost resource {}, but no such job was tracked.",
                    jobId,
                    resourceProfile);
        }
    }

    @Override
    public void clear() {
        trackers.clear();
    }

    @Override
    public Map> getMissingResources() {
        Map> allMissingResources = new HashMap<>();
        for (Map.Entry tracker : trackers.entrySet()) {
            Collection missingResources =
                    tracker.getValue().getMissingResources();
            if (!missingResources.isEmpty()) {
                allMissingResources.put(tracker.getKey(), missingResources);
            }
        }
        return allMissingResources;
    }

    @Override
    public Collection getAcquiredResources(JobID jobId) {
        Preconditions.checkNotNull(jobId);
        JobScopedResourceTracker tracker = trackers.get(jobId);
        return tracker == null ? Collections.emptyList() : tracker.getAcquiredResources();
    }

    @Override
    public boolean isRequirementEmpty(JobID jobId) {
        return Optional.ofNullable(trackers.get(jobId))
                .map(JobScopedResourceTracker::isRequirementEmpty)
                .orElse(true);
    }

    @VisibleForTesting
    boolean isEmpty() {
        return trackers.isEmpty();
    }
}