src/main/java/com/google/devtools/build/lib/skyframe/actiongraph/v2/KnownNestedSets.java

// Copyright 2018 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.actiongraph.v2;

import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.AnalysisProtosV2.DepSetOfFiles;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSet.Node;
import java.io.IOException;
import java.util.HashSet;
import java.util.Set;

/** Cache for NestedSets in the action graph. */
public class KnownNestedSets extends BaseCache<Object, DepSetOfFiles> {
  private final KnownArtifacts knownArtifacts;
  private final boolean deduplicateDepsets;

  KnownNestedSets(
      AqueryOutputHandler aqueryOutputHandler,
      KnownArtifacts knownArtifacts,
      boolean deduplicateDepsets) {
    super(aqueryOutputHandler);
    this.knownArtifacts = knownArtifacts;
    this.deduplicateDepsets = deduplicateDepsets;
  }

  @Override
  protected Object transformToKey(Object nestedSet) {
    return ((NestedSet) nestedSet).toNode();
  }

  @Override
  DepSetOfFiles createProto(Object nestedSetObject, int id)
      throws IOException, InterruptedException {
    NestedSet<?> nestedSet = (NestedSet) nestedSetObject;
    DepSetOfFiles.Builder depSetBuilder = DepSetOfFiles.newBuilder().setId(id);

    // Some malformed NestedSets have duplicate non-leaf child subsets. This does not add any
    // meaningful info and sometimes even corrupt the proto3 output. More context: b/186193294.
    Set<Node> visited = new HashSet<>();
    for (NestedSet<?> succ : nestedSet.getNonLeaves()) {
      if (!deduplicateDepsets || visited.add(succ.toNode())) {
        depSetBuilder.addTransitiveDepSetIds(this.dataToIdAndStreamOutputProto(succ));
      }
    }
    for (Object elem : nestedSet.getLeaves()) {
      depSetBuilder.addDirectArtifactIds(
          knownArtifacts.dataToIdAndStreamOutputProto((Artifact) elem));
    }
    return depSetBuilder.build();
  }

  @Override
  void toOutput(DepSetOfFiles depSetOfFilesProto) throws IOException {
    aqueryOutputHandler.outputDepSetOfFiles(depSetOfFilesProto);
  }
}