blob: 680e2e331e9b99dde5d4bb62bde3a8486fa9f31e [file] [log] [blame]
// 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.
#include "src/main/cpp/option_processor.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <algorithm>
#include <cassert>
#include <set>
#include <utility>
#include "src/main/cpp/blaze_util.h"
#include "src/main/cpp/blaze_util_platform.h"
#include "src/main/cpp/util/file.h"
#include "src/main/cpp/util/file_platform.h"
#include "src/main/cpp/util/logging.h"
#include "src/main/cpp/util/strings.h"
#include "src/main/cpp/workspace_layout.h"
// On OSX, there apparently is no header that defines this.
extern char **environ;
namespace blaze {
using std::list;
using std::map;
using std::set;
using std::string;
using std::vector;
constexpr char WorkspaceLayout::WorkspacePrefix[];
OptionProcessor::RcOption::RcOption(int rcfile_index, const string& option)
: rcfile_index_(rcfile_index), option_(option) {
}
OptionProcessor::RcFile::RcFile(const string& filename, int index)
: filename_(filename), index_(index) {
}
blaze_exit_code::ExitCode OptionProcessor::RcFile::Parse(
const string& workspace,
vector<RcFile*>* rcfiles,
map<string, vector<RcOption> >* rcoptions,
string* error) {
list<string> initial_import_stack;
initial_import_stack.push_back(filename_);
return Parse(
workspace, filename_, index_, rcfiles, rcoptions, &initial_import_stack,
error);
}
blaze_exit_code::ExitCode OptionProcessor::RcFile::Parse(
const string& workspace,
const string& filename_ref,
const int index,
vector<RcFile*>* rcfiles,
map<string, vector<RcOption> >* rcoptions,
list<string>* import_stack,
string* error) {
string filename(filename_ref); // file
BAZEL_LOG(INFO) << "Parsing the RcFile " << filename;
string contents;
if (!blaze_util::ReadFile(filename, &contents)) {
// We checked for file readability before, so this is unexpected.
blaze_util::StringPrintf(error,
"Unexpected error reading .blazerc file '%s'", filename.c_str());
return blaze_exit_code::INTERNAL_ERROR;
}
// A '\' at the end of a line continues the line.
blaze_util::Replace("\\\r\n", "", &contents);
blaze_util::Replace("\\\n", "", &contents);
vector<string> startup_options;
vector<string> lines = blaze_util::Split(contents, '\n');
for (int line = 0; line < lines.size(); ++line) {
blaze_util::StripWhitespace(&lines[line]);
// Check for an empty line.
if (lines[line].empty()) {
continue;
}
vector<string> words;
// This will treat "#" as a comment, and properly
// quote single and double quotes, and treat '\'
// as an escape character.
// TODO(bazel-team): This function silently ignores
// dangling backslash escapes and missing end-quotes.
blaze_util::Tokenize(lines[line], '#', &words);
if (words.empty()) {
// Could happen if line starts with "#"
continue;
}
string command = words[0];
if (command == "import") {
if (words.size() != 2
|| (words[1].compare(0, WorkspaceLayout::WorkspacePrefixLength,
WorkspaceLayout::WorkspacePrefix) == 0
&& !WorkspaceLayout::WorkspaceRelativizeRcFilePath(
workspace, &words[1]))) {
blaze_util::StringPrintf(error,
"Invalid import declaration in .blazerc file '%s': '%s'",
filename.c_str(), lines[line].c_str());
return blaze_exit_code::BAD_ARGV;
}
if (std::find(import_stack->begin(), import_stack->end(), words[1]) !=
import_stack->end()) {
string loop;
for (list<string>::const_iterator imported_rc = import_stack->begin();
imported_rc != import_stack->end(); ++imported_rc) {
loop += " " + *imported_rc + "\n";
}
blaze_util::StringPrintf(error,
"Import loop detected:\n%s", loop.c_str());
return blaze_exit_code::BAD_ARGV;
}
rcfiles->push_back(new RcFile(words[1], rcfiles->size()));
import_stack->push_back(words[1]);
blaze_exit_code::ExitCode parse_exit_code =
RcFile::Parse(workspace, rcfiles->back()->Filename(),
rcfiles->back()->Index(),
rcfiles, rcoptions, import_stack, error);
if (parse_exit_code != blaze_exit_code::SUCCESS) {
return parse_exit_code;
}
import_stack->pop_back();
} else {
for (int word = 1; word < words.size(); ++word) {
(*rcoptions)[command].push_back(RcOption(index, words[word]));
if (command == "startup") {
startup_options.push_back(words[word]);
}
}
}
}
if (!startup_options.empty()) {
string startup_args;
blaze_util::JoinStrings(startup_options, ' ', &startup_args);
fprintf(stderr, "INFO: Reading 'startup' options from %s: %s\n",
filename.c_str(), startup_args.c_str());
}
return blaze_exit_code::SUCCESS;
}
OptionProcessor::OptionProcessor(
std::unique_ptr<StartupOptions> default_startup_options) :
initialized_(false),
parsed_startup_options_(std::move(default_startup_options)) {
}
std::unique_ptr<CommandLine> OptionProcessor::SplitCommandLine(
const vector<string>& args,
string* error) {
const string lowercase_product_name =
parsed_startup_options_->GetLowercaseProductName();
if (args.empty()) {
blaze_util::StringPrintf(error,
"Unable to split command line, args is empty");
return nullptr;
}
const string path_to_binary(args[0]);
// Process the startup options.
vector<string> startup_args;
vector<string>::size_type i = 1;
while (i < args.size() && IsArg(args[i])) {
const string current_arg(args[i]);
// If the current argument is a valid nullary startup option such as
// --master_bazelrc or --nomaster_bazelrc proceed to examine the next
// argument.
if (parsed_startup_options_->IsNullary(current_arg)) {
startup_args.push_back(current_arg);
i++;
} else if (parsed_startup_options_->IsUnary(current_arg)) {
// If the current argument is a valid unary startup option such as
// --bazelrc there are two cases to consider.
// The option is of the form '--bazelrc=value', hence proceed to
// examine the next argument.
if (current_arg.find("=") != string::npos) {
startup_args.push_back(current_arg);
i++;
} else {
// Otherwise, the option is of the form '--bazelrc value', hence
// skip the next argument and proceed to examine the argument located
// two places after.
if (i + 1 >= args.size()) {
blaze_util::StringPrintf(
error,
"Startup option '%s' expects a value.\n"
"Usage: '%s=somevalue' or '%s somevalue'.\n"
" For more info, run '%s help startup_options'.",
current_arg.c_str(), current_arg.c_str(), current_arg.c_str(),
lowercase_product_name.c_str());
return nullptr;
}
// In this case we transform it to the form '--bazelrc=value'.
startup_args.push_back(current_arg + string("=") + args[i + 1]);
i += 2;
}
} else {
// If the current argument is not a valid unary or nullary startup option
// then fail.
blaze_util::StringPrintf(
error,
"Unknown %s startup option: '%s'.\n"
" For more info, run '%s help startup_options'.",
lowercase_product_name.c_str(), current_arg.c_str(),
lowercase_product_name.c_str());
return nullptr;
}
}
// The command is the arg right after the startup options.
if (i == args.size()) {
return std::unique_ptr<CommandLine>(
new CommandLine(path_to_binary, startup_args, "", {}));
}
const string command(args[i]);
// The rest are the command arguments.
const vector<string> command_args(args.begin() + i + 1, args.end());
return std::unique_ptr<CommandLine>(
new CommandLine(path_to_binary, startup_args, command, command_args));
}
// Return the path to the user's rc file. If cmdLineRcFile != NULL,
// use it, dying if it is not readable. Otherwise, return the first
// readable file called rc_basename from [workspace, $HOME]
//
// If no readable .blazerc file is found, return the empty string.
blaze_exit_code::ExitCode OptionProcessor::FindUserBlazerc(
const char* cmdLineRcFile,
const string& rc_basename,
const string& workspace,
string* blaze_rc_file,
string* error) {
if (cmdLineRcFile != NULL) {
string rcFile = MakeAbsolute(cmdLineRcFile);
if (!blaze_util::CanAccess(rcFile, true, false, false)) {
blaze_util::StringPrintf(error,
"Error: Unable to read .blazerc file '%s'.", rcFile.c_str());
return blaze_exit_code::BAD_ARGV;
}
*blaze_rc_file = rcFile;
return blaze_exit_code::SUCCESS;
}
string workspaceRcFile = blaze_util::JoinPath(workspace, rc_basename);
if (blaze_util::CanAccess(workspaceRcFile, true, false, false)) {
*blaze_rc_file = workspaceRcFile;
return blaze_exit_code::SUCCESS;
}
string home = blaze::GetEnv("HOME");
if (home.empty()) {
*blaze_rc_file = "";
return blaze_exit_code::SUCCESS;
}
string userRcFile = blaze_util::JoinPath(home, rc_basename);
if (blaze_util::CanAccess(userRcFile, true, false, false)) {
*blaze_rc_file = userRcFile;
return blaze_exit_code::SUCCESS;
}
*blaze_rc_file = "";
return blaze_exit_code::SUCCESS;
}
blaze_exit_code::ExitCode OptionProcessor::ParseOptions(
const vector<string>& args,
const string& workspace,
const string& cwd,
string* error) {
assert(!initialized_);
initialized_ = true;
const char* blazerc = NULL;
bool use_master_blazerc = true;
// Check if there is a blazerc related option given
args_ = args;
for (int i= 1; i < args.size(); i++) {
const char* arg_chr = args[i].c_str();
const char* next_arg_chr = (i + 1) < args.size()
? args[i + 1].c_str()
: NULL;
if (blazerc == NULL) {
blazerc = GetUnaryOption(arg_chr, next_arg_chr, "--blazerc");
}
if (blazerc == NULL) {
blazerc = GetUnaryOption(arg_chr, next_arg_chr, "--bazelrc");
}
if (use_master_blazerc &&
(GetNullaryOption(arg_chr, "--nomaster_blazerc") ||
GetNullaryOption(arg_chr, "--nomaster_bazelrc"))) {
use_master_blazerc = false;
}
}
blaze_exit_code::ExitCode validate_startup_options_exit_code =
parsed_startup_options_->ValidateStartupOptions(args, error);
if (validate_startup_options_exit_code != blaze_exit_code::SUCCESS) {
return validate_startup_options_exit_code;
}
// Parse depot and user blazerc files.
// This is a little inefficient (copying a multimap around), but it is a
// small one and this way I don't have to care about memory management.
vector<string> candidate_blazerc_paths;
if (use_master_blazerc) {
WorkspaceLayout::FindCandidateBlazercPaths(workspace, cwd, args,
&candidate_blazerc_paths);
}
string user_blazerc_path;
blaze_exit_code::ExitCode find_blazerc_exit_code = FindUserBlazerc(
blazerc, WorkspaceLayout::RcBasename(), workspace, &user_blazerc_path,
error);
if (find_blazerc_exit_code != blaze_exit_code::SUCCESS) {
return find_blazerc_exit_code;
}
candidate_blazerc_paths.push_back(user_blazerc_path);
// Throw away missing files, dedupe candidate blazerc paths, and parse the
// blazercs, all while preserving order. Duplicates can arise if e.g. the
// binary's path *is* the depot path.
set<string> blazerc_paths;
for (const auto& candidate_blazerc_path : candidate_blazerc_paths) {
if (!candidate_blazerc_path.empty()
&& (blazerc_paths.insert(candidate_blazerc_path).second)) {
blazercs_.push_back(
new RcFile(candidate_blazerc_path, blazercs_.size()));
blaze_exit_code::ExitCode parse_exit_code =
blazercs_.back()->Parse(workspace, &blazercs_, &rcoptions_, error);
if (parse_exit_code != blaze_exit_code::SUCCESS) {
return parse_exit_code;
}
}
}
blaze_exit_code::ExitCode parse_startup_options_exit_code =
ParseStartupOptions(error);
if (parse_startup_options_exit_code != blaze_exit_code::SUCCESS) {
return parse_startup_options_exit_code;
}
// Determine command
if (startup_args_ + 1 >= args.size()) {
command_ = "";
return blaze_exit_code::SUCCESS;
}
command_ = args[startup_args_ + 1];
AddRcfileArgsAndOptions(parsed_startup_options_->batch, cwd);
for (unsigned int cmd_arg = startup_args_ + 2;
cmd_arg < args.size(); cmd_arg++) {
command_arguments_.push_back(args[cmd_arg]);
}
return blaze_exit_code::SUCCESS;
}
blaze_exit_code::ExitCode OptionProcessor::ParseOptions(
int argc,
const char* argv[],
const string& workspace,
const string& cwd,
string* error) {
vector<string> args(argc);
for (int arg = 0; arg < argc; arg++) {
args[arg] = argv[arg];
}
return ParseOptions(args, workspace, cwd, error);
}
blaze_exit_code::ExitCode OptionProcessor::ParseStartupOptions(string *error) {
// Process rcfile startup options
map< string, vector<RcOption> >::const_iterator it =
rcoptions_.find("startup");
blaze_exit_code::ExitCode process_arg_exit_code;
bool is_space_separated;
if (it != rcoptions_.end()) {
const vector<RcOption>& startup_options = it->second;
int i = 0;
// Process all elements except the last one.
for (; i < startup_options.size() - 1; i++) {
const RcOption& option = startup_options[i];
const string& blazerc = blazercs_[option.rcfile_index()]->Filename();
process_arg_exit_code = parsed_startup_options_->ProcessArg(
option.option(), startup_options[i + 1].option(), blazerc,
&is_space_separated, error);
if (process_arg_exit_code != blaze_exit_code::SUCCESS) {
return process_arg_exit_code;
}
if (is_space_separated) {
i++;
}
}
// Process last element, if any.
if (i < startup_options.size()) {
const RcOption& option = startup_options[i];
if (IsArg(option.option())) {
const string& blazerc = blazercs_[option.rcfile_index()]->Filename();
process_arg_exit_code = parsed_startup_options_->ProcessArg(
option.option(), "", blazerc, &is_space_separated, error);
if (process_arg_exit_code != blaze_exit_code::SUCCESS) {
return process_arg_exit_code;
}
}
}
}
// Process command-line args next, so they override any of the same options
// from .blazerc. Stop on first non-arg, this includes --help
unsigned int i = 1;
if (!args_.empty()) {
for (; (i < args_.size() - 1) && IsArg(args_[i]); i++) {
process_arg_exit_code = parsed_startup_options_->ProcessArg(
args_[i], args_[i + 1], "", &is_space_separated, error);
if (process_arg_exit_code != blaze_exit_code::SUCCESS) {
return process_arg_exit_code;
}
if (is_space_separated) {
i++;
}
}
if (i < args_.size() && IsArg(args_[i])) {
process_arg_exit_code = parsed_startup_options_->ProcessArg(
args_[i], "", "", &is_space_separated, error);
if (process_arg_exit_code != blaze_exit_code::SUCCESS) {
return process_arg_exit_code;
}
i++;
}
}
startup_args_ = i -1;
return blaze_exit_code::SUCCESS;
}
// Appends the command and arguments from argc/argv to the end of arg_vector,
// and also splices in some additional terminal and environment options between
// the command and the arguments. NB: Keep the options added here in sync with
// BlazeCommandDispatcher.INTERNAL_COMMAND_OPTIONS!
void OptionProcessor::AddRcfileArgsAndOptions(bool batch, const string& cwd) {
// Provide terminal options as coming from the least important rc file.
command_arguments_.push_back("--rc_source=client");
command_arguments_.push_back("--default_override=0:common=--isatty=" +
ToString(IsStandardTerminal()));
command_arguments_.push_back(
"--default_override=0:common=--terminal_columns=" +
ToString(GetTerminalColumns()));
// Push the options mapping .blazerc numbers to filenames.
for (int i_blazerc = 0; i_blazerc < blazercs_.size(); i_blazerc++) {
const RcFile* blazerc = blazercs_[i_blazerc];
command_arguments_.push_back("--rc_source=" +
blaze::ConvertPath(blazerc->Filename()));
}
// Push the option defaults
for (map<string, vector<RcOption> >::const_iterator it = rcoptions_.begin();
it != rcoptions_.end(); ++it) {
if (it->first == "startup") {
// Skip startup options, they are parsed in the C++ wrapper
continue;
}
for (int ii = 0; ii < it->second.size(); ii++) {
const RcOption& rcoption = it->second[ii];
command_arguments_.push_back(
"--default_override=" + ToString(rcoption.rcfile_index() + 1) + ":"
+ it->first + "=" + rcoption.option());
}
}
// Pass the client environment to the server in server mode.
if (batch) {
command_arguments_.push_back("--ignore_client_env");
} else {
for (char** env = environ; *env != NULL; env++) {
string env_str(*env);
int pos = env_str.find("=");
if (pos != string::npos) {
string name = env_str.substr(0, pos);
if (name == "PATH") {
env_str = "PATH=" + ConvertPathList(env_str.substr(pos + 1));
} else if (name == "TMP") {
// A valid Windows path "c:/foo" is also a valid Unix path list of
// ["c", "/foo"] so must use ConvertPath here. See GitHub issue #1684.
env_str = "TMP=" + ConvertPath(env_str.substr(pos + 1));
}
}
command_arguments_.push_back("--client_env=" + env_str);
}
}
command_arguments_.push_back("--client_cwd=" + blaze::ConvertPath(cwd));
if (IsEmacsTerminal()) {
command_arguments_.push_back("--emacs");
}
}
void OptionProcessor::GetCommandArguments(vector<string>* result) const {
result->insert(result->end(),
command_arguments_.begin(),
command_arguments_.end());
}
const string& OptionProcessor::GetCommand() const {
return command_;
}
StartupOptions* OptionProcessor::GetParsedStartupOptions() const {
return parsed_startup_options_.get();
}
OptionProcessor::~OptionProcessor() {
for (auto it : blazercs_) {
delete it;
}
}
} // namespace blaze