com.google.devtools.build.lib.skyframe.ActionArtifactCycleReporter.java Source code

Introduction

Here is the source code for com.google.devtools.build.lib.skyframe.ActionArtifactCycleReporter.java

Source

// Copyright 2014 The Bazel Authors. All rights reserved.
//
// 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 com.google.devtools.build.lib.skyframe;

import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
import com.google.common.collect.Iterables;
import com.google.devtools.build.lib.actions.Action;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.pkgcache.PackageProvider;
import com.google.devtools.build.lib.skyframe.ArtifactSkyKey.OwnedArtifact;
import com.google.devtools.build.lib.skyframe.TargetCompletionValue.TargetCompletionKey;
import com.google.devtools.build.lib.skyframe.TestCompletionValue.TestCompletionKey;
import com.google.devtools.build.skyframe.CycleInfo;
import com.google.devtools.build.skyframe.SkyFunctionName;
import com.google.devtools.build.skyframe.SkyKey;

/**
 * Reports cycles between Actions and Artifacts. These indicates cycles within a rule.
 */
public class ActionArtifactCycleReporter extends AbstractLabelCycleReporter {
    @SuppressWarnings("unchecked")
    private static final Predicate<SkyKey> IS_ARTIFACT_OR_ACTION_SKY_KEY = Predicates.or(
            SkyFunctions.isSkyFunction(SkyFunctions.ARTIFACT),
            SkyFunctions.isSkyFunction(SkyFunctions.ACTION_EXECUTION),
            SkyFunctions.isSkyFunction(SkyFunctions.TARGET_COMPLETION),
            SkyFunctions.isSkyFunction(SkyFunctions.TEST_COMPLETION));

    ActionArtifactCycleReporter(PackageProvider packageProvider) {
        super(packageProvider);
    }

    @Override
    protected String prettyPrint(SkyKey key) {
        return prettyPrint(key.functionName(), key.argument());
    }

    private String prettyPrint(SkyFunctionName skyFunctionName, Object arg) {
        if (arg instanceof OwnedArtifact) {
            return "file: " + ((OwnedArtifact) arg).getArtifact().getRootRelativePathString();
        } else if (arg instanceof Action) {
            return "action: " + ((Action) arg).getMnemonic();
        } else if (arg instanceof TargetCompletionKey && skyFunctionName.equals(SkyFunctions.TARGET_COMPLETION)) {
            return "configured target: " + ((TargetCompletionKey) arg).labelAndConfiguration().getLabel();
        } else if (arg instanceof TestCompletionKey && skyFunctionName.equals(SkyFunctions.TEST_COMPLETION)) {
            return "test target: " + ((TestCompletionKey) arg).labelAndConfiguration().getLabel();
        }
        throw new IllegalStateException(
                "Argument is not Action, TargetCompletion, TestCompletion or OwnedArtifact: " + arg);
    }

    @Override
    protected Label getLabel(SkyKey key) {
        Object arg = key.argument();
        if (arg instanceof OwnedArtifact) {
            return ((OwnedArtifact) arg).getArtifact().getOwner();
        } else if (arg instanceof Action) {
            return ((Action) arg).getOwner().getLabel();
        } else if (arg instanceof TargetCompletionKey
                && key.functionName().equals(SkyFunctions.TARGET_COMPLETION)) {
            return ((TargetCompletionKey) arg).labelAndConfiguration().getLabel();
        } else if (arg instanceof TestCompletionKey && key.functionName().equals(SkyFunctions.TEST_COMPLETION)) {
            return ((TestCompletionKey) arg).labelAndConfiguration().getLabel();
        }
        throw new IllegalStateException(
                "Argument is not Action, TargetCompletion, TestCompletion or OwnedArtifact: " + arg);
    }

    @Override
    protected boolean canReportCycle(SkyKey topLevelKey, CycleInfo cycleInfo) {
        return IS_ARTIFACT_OR_ACTION_SKY_KEY.apply(topLevelKey)
                && Iterables.all(cycleInfo.getCycle(), IS_ARTIFACT_OR_ACTION_SKY_KEY);
    }
}