org.gradle.internal.work.DefaultAsyncWorkTracker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
There is a newer version: 8.11.1
/*
 * Copyright 2017 the original author or authors.
 *
 * Licensed 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.gradle.internal.work;

import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ListMultimap;
import org.gradle.internal.exceptions.DefaultMultiCauseException;
import org.gradle.internal.operations.BuildOperationRef;
import org.gradle.util.internal.CollectionUtils;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.concurrent.locks.ReentrantLock;

public class DefaultAsyncWorkTracker implements AsyncWorkTracker {
    private final ListMultimap items = ArrayListMultimap.create();
    private final Set waiting = new HashSet<>();
    private final ReentrantLock lock = new ReentrantLock();
    private final WorkerLeaseService workerLeaseService;

    public DefaultAsyncWorkTracker(WorkerLeaseService workerLeaseService) {
        this.workerLeaseService = workerLeaseService;
    }

    @Override
    public void registerWork(BuildOperationRef operation, AsyncWorkCompletion workCompletion) {
        lock.lock();
        try {
            if (waiting.contains(operation)) {
                throw new IllegalStateException("Another thread is currently waiting on the completion of work for the provided operation");
            }
            items.put(operation, workCompletion);
        } finally {
            lock.unlock();
        }
    }

    @Override
    public void waitForCompletion(BuildOperationRef operation, ProjectLockRetention lockRetention) {
        final List workItems;
        lock.lock();
        try {
            workItems = ImmutableList.copyOf(items.get(operation));
            startWaiting(operation, workItems);
        } finally {
            lock.unlock();
        }

        waitForAll(operation, workItems, lockRetention);
    }

    @Override
    public void waitForCompletion(BuildOperationRef operation, List workItems, ProjectLockRetention lockRetention) {
        startWaiting(operation, workItems);
        waitForAll(operation, workItems, lockRetention);
    }

    private void waitForAll(BuildOperationRef operation, List workItems, ProjectLockRetention lockRetention) {
        try {
            if (!workItems.isEmpty()) {
                waitForItemsAndGatherFailures(workItems, lockRetention);
            }
        } finally {
            stopWaiting(operation);
        }
    }

    private void waitForItemsAndGatherFailures(List workItems, AsyncWorkTracker.ProjectLockRetention lockRetention) {
        switch (lockRetention) {
            case RETAIN_PROJECT_LOCKS:
                waitForItemsAndGatherFailures(workItems);
                return;
            case RELEASE_PROJECT_LOCKS:
                workerLeaseService.runAsIsolatedTask();
                waitForItemsAndGatherFailures(workItems);
                return;
            case RELEASE_AND_REACQUIRE_PROJECT_LOCKS:
                if (!hasWorkInProgress(workItems)) {
                    // All items are complete. Do not release project lock and simply collect failures.
                    waitForItemsAndGatherFailures(workItems);
                    return;
                }
                workerLeaseService.runAsIsolatedTask(() -> waitForItemsAndGatherFailures(workItems));
        }
    }

    private boolean hasWorkInProgress(List workItems) {
        return CollectionUtils.any(workItems, workCompletion -> !workCompletion.isComplete());
    }

    @Override
    public boolean hasUncompletedWork(BuildOperationRef operation) {
        lock.lock();
        try {
            List workItems = items.get(operation);
            for (AsyncWorkCompletion workCompletion : workItems) {
                if (!workCompletion.isComplete()) {
                    return true;
                }
            }
            return false;
        } finally {
            lock.unlock();
        }
    }

    private void waitForItemsAndGatherFailures(Iterable workItems) {
        // Release worker lease while waiting
        workerLeaseService.withoutLock(workerLeaseService.getCurrentWorkerLease(), () -> {
            final List failures = new ArrayList<>();
            for (AsyncWorkCompletion item : workItems) {
                try {
                    item.waitForCompletion();
                } catch (Throwable t) {
                    if (Thread.currentThread().isInterrupted()) {
                        cancel(workItems);
                    }
                    failures.add(t);
                }
            }

            if (failures.size() > 0) {
                throw new DefaultMultiCauseException("There were failures while executing asynchronous work:", failures);
            }
        });
    }

    private void cancel(Iterable workItems) {
        for (AsyncWorkCompletion workItem : workItems) {
            workItem.cancel();
        }
    }

    private void startWaiting(BuildOperationRef operation, List workItems) {
        lock.lock();
        try {
            items.get(operation).removeAll(workItems);
            waiting.add(operation);
        } finally {
            lock.unlock();
        }
    }

    private void stopWaiting(BuildOperationRef operation) {
        lock.lock();
        try {
            waiting.remove(operation);
        } finally {
            lock.unlock();
        }
    }
}