// 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.analysis.actions; import com.google.common.collect.ImmutableList; import com.google.common.collect.Iterables; import com.google.devtools.build.lib.actions.Action; import com.google.devtools.build.lib.actions.ActionOwner; import com.google.devtools.build.lib.actions.Artifact; import com.google.devtools.build.lib.actions.ParameterFile; import com.google.devtools.build.lib.analysis.AnalysisEnvironment; import com.google.devtools.build.lib.analysis.config.BuildConfiguration; import com.google.devtools.build.lib.util.Preconditions; import com.google.devtools.build.lib.vfs.PathFragment; import java.util.List; import javax.annotation.Nullable; import javax.annotation.concurrent.Immutable; /** * A command-line implementation that wraps another command line and puts the arguments in a * parameter file if necessary * *
The Linux kernel has a limit for the command line length, and that can be easily reached * if, for example, a command is listing all its inputs on the command line. */ @Immutable public final class ParamFileHelper { /** * Returns a params file artifact or null for a given command description. * *
Returns null if parameter files are not to be used according to paramFileInfo, or if the * command line is short enough that a parameter file is not needed. * *
Make sure to add the returned artifact (if not null) as an input of the corresponding
* action.
*
* @param executableArgs leading arguments that should never be wrapped in a parameter file
* @param arguments arguments to the command (in addition to executableArgs), OR
* @param commandLine a {@link CommandLine} that provides the arguments (in addition to
* executableArgs)
* @param paramFileInfo parameter file information
* @param configuration the configuration
* @param analysisEnvironment the analysis environment
* @param outputs outputs of the action (used to construct a filename for the params file)
*/
public static Artifact getParamsFileMaybe(
List Call this with the result of {@link #getParamsFileMaybe} if it is not null.
*
* @param executableArgs leading arguments that should never be wrapped in a parameter file
* @param arguments arguments to the command (in addition to executableArgs), OR
* @param commandLine a {@link CommandLine} that provides the arguments (in addition to
* executableArgs)
* @param isShellCommand true if this is a shell command
* @param owner owner of the action
* @param paramFileInfo parameter file information
*/
public static CommandLine createWithParamsFile(
List Call this if {@link #getParamsFileMaybe} returns null.
*
* @param executableArgs leading arguments that should never be wrapped in a parameter file
* @param arguments arguments to the command (in addition to executableArgs), OR
* @param commandLine a {@link CommandLine} that provides the arguments (in addition to
* executableArgs)
* @param isShellCommand true if this is a shell command
*/
public static CommandLine createWithoutParamsFile(List