-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Thankfully, `query` already has most of the infrastructure necessary to make this easy. query implements graph output (in `GraphOutputFormatter`) over a `Digraph<Target>`, which is a generic graph data structure with `Target` payloads. All output logic then runs over this data structure. To opt query in, all we have to do is create an equivalent `Digraph<ConfiguredTarget>`, which is a simple transformation from the backing graph. This change creates a new generic class for that common logic: `GraphOutputWriter`. query's `GraphOutputFormatter` then becomes a simple wrapper over that, and the new `GraphOutputFormatterCallback` is cquery's equivalent. A few differences: - cquery output is always fully ordered (`--order_output=full`). We could match this with query's controllable version, but I don't see a reason to make this yet another bit to configured. - query output annotates edges with select() conditions. cquery doesn't do this because select()s are resolved and removed from the graph after analysis. I think we could annotate edges with the *chosen* condition if there was demand, but that'd be a followup effort. Fixes #10843 (for `cquery`, not `aquery`) Closes #12248. PiperOrigin-RevId: 337907070
- Loading branch information
1 parent
2300e6d
commit 02cbcd2
Showing
10 changed files
with
769 additions
and
297 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
119 changes: 119 additions & 0 deletions
119
src/main/java/com/google/devtools/build/lib/query2/cquery/GraphOutputFormatterCallback.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| // Copyright 2020 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.query2.cquery; | ||
|
|
||
| import com.google.common.collect.ImmutableSet; | ||
| import com.google.devtools.build.lib.analysis.ConfiguredTarget; | ||
| import com.google.devtools.build.lib.cmdline.Label; | ||
| import com.google.devtools.build.lib.events.ExtendedEventHandler; | ||
| import com.google.devtools.build.lib.graph.Digraph; | ||
| import com.google.devtools.build.lib.graph.Node; | ||
| import com.google.devtools.build.lib.query2.engine.QueryEnvironment.TargetAccessor; | ||
| import com.google.devtools.build.lib.query2.query.output.GraphOutputWriter; | ||
| import com.google.devtools.build.lib.query2.query.output.GraphOutputWriter.NodeReader; | ||
| import com.google.devtools.build.lib.skyframe.SkyframeExecutor; | ||
| import java.io.OutputStream; | ||
| import java.util.Comparator; | ||
|
|
||
| /** cquery output formatter that prints the result as factored graph in AT&T GraphViz format. */ | ||
| class GraphOutputFormatterCallback extends CqueryThreadsafeCallback { | ||
| @Override | ||
| public String getName() { | ||
| return "graph"; | ||
| } | ||
|
|
||
| /** Interface for finding a configured target's direct dependencies. */ | ||
| @FunctionalInterface | ||
| public interface DepsRetriever { | ||
| Iterable<ConfiguredTarget> getDirectDeps(ConfiguredTarget taget) throws InterruptedException; | ||
| } | ||
|
|
||
| private final DepsRetriever depsRetriever; | ||
|
|
||
| private final GraphOutputWriter.NodeReader<ConfiguredTarget> nodeReader = | ||
| new NodeReader<ConfiguredTarget>() { | ||
|
|
||
| private final Comparator<ConfiguredTarget> configuredTargetOrdering = | ||
| (ct1, ct2) -> { | ||
| // Order graph output first by target label, then by configuration hash. | ||
| Label label1 = ct1.getLabel(); | ||
| Label label2 = ct2.getLabel(); | ||
| return label1.equals(label2) | ||
| ? ct1.getConfigurationChecksum().compareTo(ct2.getConfigurationChecksum()) | ||
| : label1.compareTo(label2); | ||
| }; | ||
|
|
||
| @Override | ||
| public String getLabel(Node<ConfiguredTarget> node) { | ||
| // Node payloads are ConfiguredTargets. Output node labels are target labels + config | ||
| // hashes. | ||
| ConfiguredTarget ct = node.getLabel(); | ||
| return String.format( | ||
| "%s (%s)", | ||
| ct.getLabel(), | ||
| // TODO(gregce): Even if getConfiguration is a cache hit this has overhead, especially | ||
| // when called many times on the same configuration in the same query. Investigate the | ||
| // performance impact and apply a cache if measurements justify it (also in other | ||
| // callbacks that do this). | ||
| shortId(skyframeExecutor.getConfiguration(eventHandler, ct.getConfigurationKey()))); | ||
| } | ||
|
|
||
| @Override | ||
| public Comparator<ConfiguredTarget> comparator() { | ||
| return configuredTargetOrdering; | ||
| } | ||
| }; | ||
|
|
||
| GraphOutputFormatterCallback( | ||
| ExtendedEventHandler eventHandler, | ||
| CqueryOptions options, | ||
| OutputStream out, | ||
| SkyframeExecutor skyframeExecutor, | ||
| TargetAccessor<ConfiguredTarget> accessor, | ||
| DepsRetriever depsRetriever) { | ||
| super(eventHandler, options, out, skyframeExecutor, accessor); | ||
| this.depsRetriever = depsRetriever; | ||
| } | ||
|
|
||
| @Override | ||
| public void processOutput(Iterable<ConfiguredTarget> partialResult) throws InterruptedException { | ||
| // Transform the cquery-backed graph into a Digraph to make it suitable for GraphOutputWriter. | ||
| // Note that this involves an extra iteration over the entire query result subgraph. We could | ||
| // conceptually merge transformation and output writing into the same iteration if needed. | ||
| Digraph<ConfiguredTarget> graph = new Digraph<>(); | ||
| ImmutableSet<ConfiguredTarget> allNodes = ImmutableSet.copyOf(partialResult); | ||
| for (ConfiguredTarget configuredTarget : partialResult) { | ||
| Node<ConfiguredTarget> node = graph.createNode(configuredTarget); | ||
| for (ConfiguredTarget dep : depsRetriever.getDirectDeps(configuredTarget)) { | ||
| if (allNodes.contains(dep)) { | ||
| Node<ConfiguredTarget> depNode = graph.createNode(dep); | ||
| graph.addEdge(node, depNode); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| GraphOutputWriter<ConfiguredTarget> graphWriter = | ||
| new GraphOutputWriter<>( | ||
| nodeReader, | ||
| options.getLineTerminator(), | ||
| /*sortLabels=*/ true, | ||
| options.graphNodeStringLimit, | ||
| // select() conditions don't matter for cquery because cquery operates post-analysis | ||
| // phase, when select()s have been resolved and removed from the graph. | ||
| /*maxConditionalEdges=*/ 0, | ||
| options.graphFactored); | ||
| graphWriter.write(graph, /*conditionalEdges=*/ null, outputStream); | ||
| } | ||
| } |
Oops, something went wrong.