mirror of
https://github.com/fish-shell/fish-shell.git
synced 2024-11-26 02:13:38 +08:00
546 lines
19 KiB
C++
546 lines
19 KiB
C++
//
|
|
// The main loop of the fish program.
|
|
/*
|
|
Copyright (C) 2005-2008 Axel Liljencrantz
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License version 2 as
|
|
published by the Free Software Foundation.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
#include "config.h"
|
|
|
|
#include <errno.h>
|
|
#include <fcntl.h>
|
|
#include <getopt.h>
|
|
#include <limits.h>
|
|
#include <locale.h>
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <sys/resource.h>
|
|
#include <sys/stat.h>
|
|
#include <unistd.h>
|
|
|
|
#include <cstring>
|
|
#include <cwchar>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "builtin.h"
|
|
#include "common.h"
|
|
#include "env.h"
|
|
#include "event.h"
|
|
#include "expand.h"
|
|
#include "fallback.h" // IWYU pragma: keep
|
|
#include "fish_version.h"
|
|
#include "flog.h"
|
|
#include "function.h"
|
|
#include "future_feature_flags.h"
|
|
#include "history.h"
|
|
#include "intern.h"
|
|
#include "io.h"
|
|
#include "parser.h"
|
|
#include "path.h"
|
|
#include "proc.h"
|
|
#include "reader.h"
|
|
#include "signal.h"
|
|
#include "wcstringutil.h"
|
|
#include "wutil.h" // IWYU pragma: keep
|
|
|
|
// container to hold the options specified within the command line
|
|
class fish_cmd_opts_t {
|
|
public:
|
|
// Future feature flags values string
|
|
wcstring features;
|
|
// File path for debug output.
|
|
std::string debug_output;
|
|
// Commands to be executed in place of interactive shell.
|
|
std::vector<std::string> batch_cmds;
|
|
// Commands to execute after the shell's config has been read.
|
|
std::vector<std::string> postconfig_cmds;
|
|
/// Whether to print rusage-self stats after execution.
|
|
bool print_rusage_self{false};
|
|
/// Whether no-exec is set.
|
|
bool no_exec{false};
|
|
/// Whether this is a login shell.
|
|
bool is_login{false};
|
|
/// Whether this is an interactive session.
|
|
bool is_interactive_session{false};
|
|
};
|
|
|
|
/// If we are doing profiling, the filename to output to.
|
|
static const char *s_profiling_output_filename = nullptr;
|
|
|
|
/// \return a timeval converted to milliseconds.
|
|
long long tv_to_msec(const struct timeval &tv) {
|
|
long long msec = static_cast<long long>(tv.tv_sec) * 1000; // milliseconds per second
|
|
msec += tv.tv_usec / 1000; // microseconds per millisecond
|
|
return msec;
|
|
}
|
|
|
|
static void print_rusage_self(FILE *fp) {
|
|
#ifndef HAVE_GETRUSAGE
|
|
fprintf(fp, "getrusage() not supported on this platform");
|
|
return;
|
|
#else
|
|
struct rusage rs;
|
|
if (getrusage(RUSAGE_SELF, &rs)) {
|
|
perror("getrusage");
|
|
return;
|
|
}
|
|
#if defined(__APPLE__) && defined(__MACH__)
|
|
// Macs use bytes.
|
|
long rss_kb = rs.ru_maxrss / 1024;
|
|
#else
|
|
// Everyone else uses KB.
|
|
long rss_kb = rs.ru_maxrss;
|
|
#endif
|
|
fprintf(fp, " rusage self:\n");
|
|
fprintf(fp, " user time: %llu ms\n", tv_to_msec(rs.ru_utime));
|
|
fprintf(fp, " sys time: %llu ms\n", tv_to_msec(rs.ru_stime));
|
|
fprintf(fp, " total time: %llu ms\n", tv_to_msec(rs.ru_utime) + tv_to_msec(rs.ru_stime));
|
|
fprintf(fp, " max rss: %ld kb\n", rss_kb);
|
|
fprintf(fp, " signals: %ld\n", rs.ru_nsignals);
|
|
#endif
|
|
}
|
|
|
|
static bool has_suffix(const std::string &path, const char *suffix, bool ignore_case) {
|
|
size_t pathlen = path.size(), suffixlen = std::strlen(suffix);
|
|
return pathlen >= suffixlen &&
|
|
!(ignore_case ? strcasecmp : std::strcmp)(path.c_str() + pathlen - suffixlen, suffix);
|
|
}
|
|
|
|
/// Modifies the given path by calling realpath. Returns true if realpath succeeded, false
|
|
/// otherwise.
|
|
static bool get_realpath(std::string &path) {
|
|
char buff[PATH_MAX], *ptr;
|
|
if ((ptr = realpath(path.c_str(), buff))) {
|
|
path = ptr;
|
|
}
|
|
return ptr != nullptr;
|
|
}
|
|
|
|
static struct config_paths_t determine_config_directory_paths(const char *argv0) {
|
|
struct config_paths_t paths;
|
|
bool done = false;
|
|
std::string exec_path = get_executable_path(argv0);
|
|
if (get_realpath(exec_path)) {
|
|
FLOGF(config, L"exec_path: '%s', argv[0]: '%s'", exec_path.c_str(), argv0);
|
|
// TODO: we should determine program_name from argv0 somewhere in this file
|
|
|
|
#ifdef CMAKE_BINARY_DIR
|
|
// Detect if we're running right out of the CMAKE build directory
|
|
if (string_prefixes_string(CMAKE_BINARY_DIR, exec_path.c_str())) {
|
|
FLOGF(config,
|
|
"Running out of build directory, using paths relative to CMAKE_SOURCE_DIR:\n %s",
|
|
CMAKE_SOURCE_DIR);
|
|
|
|
done = true;
|
|
paths.data = wcstring{L"" CMAKE_SOURCE_DIR} + L"/share";
|
|
paths.sysconf = wcstring{L"" CMAKE_SOURCE_DIR} + L"/etc";
|
|
paths.doc = wcstring{L"" CMAKE_SOURCE_DIR} + L"/user_doc/html";
|
|
paths.bin = wcstring{L"" CMAKE_BINARY_DIR};
|
|
}
|
|
#endif
|
|
|
|
if (!done) {
|
|
// The next check is that we are in a reloctable directory tree
|
|
const char *installed_suffix = "/bin/fish";
|
|
const char *just_a_fish = "/fish";
|
|
const char *suffix = nullptr;
|
|
|
|
if (has_suffix(exec_path, installed_suffix, false)) {
|
|
suffix = installed_suffix;
|
|
} else if (has_suffix(exec_path, just_a_fish, false)) {
|
|
FLOGF(config, L"'fish' not in a 'bin/', trying paths relative to source tree");
|
|
suffix = just_a_fish;
|
|
}
|
|
|
|
if (suffix) {
|
|
bool seems_installed = (suffix == installed_suffix);
|
|
|
|
wcstring base_path = str2wcstring(exec_path);
|
|
base_path.resize(base_path.size() - std::strlen(suffix));
|
|
|
|
paths.data = base_path + (seems_installed ? L"/share/fish" : L"/share");
|
|
paths.sysconf = base_path + (seems_installed ? L"/etc/fish" : L"/etc");
|
|
paths.doc = base_path + (seems_installed ? L"/share/doc/fish" : L"/user_doc/html");
|
|
paths.bin = base_path + (seems_installed ? L"/bin" : L"");
|
|
|
|
// Check only that the data and sysconf directories exist. Handle the doc
|
|
// directories separately.
|
|
struct stat buf;
|
|
if (0 == wstat(paths.data, &buf) && 0 == wstat(paths.sysconf, &buf)) {
|
|
// The docs dir may not exist; in that case fall back to the compiled in path.
|
|
if (0 != wstat(paths.doc, &buf)) {
|
|
paths.doc = L"" DOCDIR;
|
|
}
|
|
done = true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!done) {
|
|
// Fall back to what got compiled in.
|
|
FLOGF(config, L"Using compiled in paths:");
|
|
paths.data = L"" DATADIR "/fish";
|
|
paths.sysconf = L"" SYSCONFDIR "/fish";
|
|
paths.doc = L"" DOCDIR;
|
|
paths.bin = L"" BINDIR;
|
|
}
|
|
|
|
FLOGF(config,
|
|
L"determine_config_directory_paths() results:\npaths.data: %ls\npaths.sysconf: "
|
|
L"%ls\npaths.doc: %ls\npaths.bin: %ls",
|
|
paths.data.c_str(), paths.sysconf.c_str(), paths.doc.c_str(), paths.bin.c_str());
|
|
return paths;
|
|
}
|
|
|
|
// Source the file config.fish in the given directory.
|
|
static void source_config_in_directory(const wcstring &dir) {
|
|
// If the config.fish file doesn't exist or isn't readable silently return. Fish versions up
|
|
// thru 2.2.0 would instead try to source the file with stderr redirected to /dev/null to deal
|
|
// with that possibility.
|
|
//
|
|
// This introduces a race condition since the readability of the file can change between this
|
|
// test and the execution of the 'source' command. However, that is not a security problem in
|
|
// this context so we ignore it.
|
|
const wcstring config_pathname = dir + L"/config.fish";
|
|
const wcstring escaped_dir = escape_string(dir, ESCAPE_ALL);
|
|
const wcstring escaped_pathname = escaped_dir + L"/config.fish";
|
|
if (waccess(config_pathname, R_OK) != 0) {
|
|
FLOGF(config, L"not sourcing %ls (not readable or does not exist)", escaped_pathname.c_str());
|
|
return;
|
|
}
|
|
FLOGF(config, L"sourcing %ls", escaped_pathname.c_str());
|
|
|
|
const wcstring cmd = L"builtin source " + escaped_pathname;
|
|
parser_t &parser = parser_t::principal_parser();
|
|
set_is_within_fish_initialization(true);
|
|
parser.eval(cmd, io_chain_t());
|
|
set_is_within_fish_initialization(false);
|
|
}
|
|
|
|
/// Parse init files. exec_path is the path of fish executable as determined by argv[0].
|
|
static int read_init(const struct config_paths_t &paths) {
|
|
source_config_in_directory(paths.data);
|
|
source_config_in_directory(paths.sysconf);
|
|
|
|
// We need to get the configuration directory before we can source the user configuration file.
|
|
// If path_get_config returns false then we have no configuration directory and no custom config
|
|
// to load.
|
|
wcstring config_dir;
|
|
if (path_get_config(config_dir)) {
|
|
source_config_in_directory(config_dir);
|
|
}
|
|
|
|
return 1;
|
|
}
|
|
|
|
int run_command_list(std::vector<std::string> *cmds, const io_chain_t &io) {
|
|
parser_t &parser = parser_t::principal_parser();
|
|
|
|
for (const auto &cmd : *cmds) {
|
|
const wcstring cmd_wcs = str2wcstring(cmd);
|
|
parser.eval(cmd_wcs, io);
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
/// Parse the argument list, return the index of the first non-flag arguments.
|
|
static int fish_parse_opt(int argc, char **argv, fish_cmd_opts_t *opts) {
|
|
static const char *const short_opts = "+hPilnvc:C:p:d:f:D:";
|
|
static const struct option long_opts[] = {
|
|
{"command", required_argument, nullptr, 'c'},
|
|
{"init-command", required_argument, nullptr, 'C'},
|
|
{"features", required_argument, nullptr, 'f'},
|
|
{"debug", required_argument, nullptr, 'd'},
|
|
{"debug-output", required_argument, nullptr, 'o'},
|
|
{"debug-stack-frames", required_argument, nullptr, 'D'},
|
|
{"interactive", no_argument, nullptr, 'i'},
|
|
{"login", no_argument, nullptr, 'l'},
|
|
{"no-execute", no_argument, nullptr, 'n'},
|
|
{"print-rusage-self", no_argument, nullptr, 1},
|
|
{"print-debug-categories", no_argument, nullptr, 2},
|
|
{"profile", required_argument, nullptr, 'p'},
|
|
{"private", no_argument, nullptr, 'P'},
|
|
{"help", no_argument, nullptr, 'h'},
|
|
{"version", no_argument, nullptr, 'v'},
|
|
{nullptr, 0, nullptr, 0}};
|
|
|
|
int opt;
|
|
while ((opt = getopt_long(argc, argv, short_opts, long_opts, nullptr)) != -1) {
|
|
switch (opt) {
|
|
case 'c': {
|
|
opts->batch_cmds.push_back(optarg);
|
|
break;
|
|
}
|
|
case 'C': {
|
|
opts->postconfig_cmds.push_back(optarg);
|
|
break;
|
|
}
|
|
case 'd': {
|
|
char *end;
|
|
long tmp;
|
|
|
|
errno = 0;
|
|
tmp = strtol(optarg, &end, 10);
|
|
|
|
if (tmp >= 0 && tmp <= 10 && !*end && !errno) {
|
|
debug_level = static_cast<int>(tmp);
|
|
} else {
|
|
activate_flog_categories_by_pattern(str2wcstring(optarg));
|
|
}
|
|
break;
|
|
}
|
|
case 'o': {
|
|
opts->debug_output = optarg;
|
|
break;
|
|
}
|
|
case 'f': {
|
|
opts->features = str2wcstring(optarg);
|
|
break;
|
|
}
|
|
case 'h': {
|
|
opts->batch_cmds.push_back("__fish_print_help fish");
|
|
break;
|
|
}
|
|
case 'i': {
|
|
opts->is_interactive_session = true;
|
|
break;
|
|
}
|
|
case 'l': {
|
|
opts->is_login = true;
|
|
break;
|
|
}
|
|
case 'n': {
|
|
opts->no_exec = true;
|
|
break;
|
|
}
|
|
case 1: {
|
|
opts->print_rusage_self = true;
|
|
break;
|
|
}
|
|
case 2: {
|
|
auto cats = get_flog_categories();
|
|
// Compute width of longest name.
|
|
int name_width = 0;
|
|
for (const auto *cat : cats) {
|
|
name_width = std::max(name_width, static_cast<int>(wcslen(cat->name)));
|
|
}
|
|
// A little extra space.
|
|
name_width += 2;
|
|
for (const auto *cat : cats) {
|
|
// Negating the name width left-justifies.
|
|
printf("%*ls %ls\n", -name_width, cat->name, _(cat->description));
|
|
}
|
|
exit(0);
|
|
break;
|
|
}
|
|
case 'p': {
|
|
s_profiling_output_filename = optarg;
|
|
g_profiling_active = true;
|
|
break;
|
|
}
|
|
case 'P': {
|
|
start_private_mode();
|
|
break;
|
|
}
|
|
case 'v': {
|
|
std::fwprintf(stdout, _(L"%s, version %s\n"), PACKAGE_NAME, get_fish_version());
|
|
exit(0);
|
|
break;
|
|
}
|
|
case 'D': {
|
|
char *end;
|
|
long tmp;
|
|
|
|
errno = 0;
|
|
tmp = strtol(optarg, &end, 10);
|
|
|
|
if (tmp > 0 && tmp <= 128 && !*end && !errno) {
|
|
set_debug_stack_frames(static_cast<int>(tmp));
|
|
} else {
|
|
std::fwprintf(stderr, _(L"Invalid value '%s' for debug-stack-frames flag"),
|
|
optarg);
|
|
exit(1);
|
|
}
|
|
break;
|
|
}
|
|
default: {
|
|
// We assume getopt_long() has already emitted a diagnostic msg.
|
|
exit(1);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
// If our command name begins with a dash that implies we're a login shell.
|
|
opts->is_login |= argv[0][0] == '-';
|
|
|
|
// We are an interactive session if we have not been given an explicit
|
|
// command or file to execute and stdin is a tty. Note that the -i or
|
|
// --interactive options also force interactive mode.
|
|
if (opts->batch_cmds.empty() && optind == argc && isatty(STDIN_FILENO)) {
|
|
set_interactive_session(session_interactivity_t::implied);
|
|
}
|
|
|
|
return optind;
|
|
}
|
|
|
|
int main(int argc, char **argv) {
|
|
int res = 1;
|
|
int my_optind = 0;
|
|
|
|
program_name = L"fish";
|
|
set_main_thread();
|
|
setup_fork_guards();
|
|
signal_unblock_all();
|
|
setlocale(LC_ALL, "");
|
|
|
|
// struct stat tmp;
|
|
// stat("----------FISH_HIT_MAIN----------", &tmp);
|
|
|
|
const char *dummy_argv[2] = {"fish", nullptr};
|
|
if (!argv[0]) {
|
|
argv = (char **)dummy_argv; //!OCLINT(parameter reassignment)
|
|
argc = 1; //!OCLINT(parameter reassignment)
|
|
}
|
|
fish_cmd_opts_t opts{};
|
|
my_optind = fish_parse_opt(argc, argv, &opts);
|
|
|
|
// Direct any debug output right away.
|
|
FILE *debug_output = nullptr;
|
|
if (!opts.debug_output.empty()) {
|
|
debug_output = fopen(opts.debug_output.c_str(), "w");
|
|
if (!debug_output) {
|
|
fprintf(stderr, "Could not open file %s\n", opts.debug_output.c_str());
|
|
perror("fopen");
|
|
exit(-1);
|
|
}
|
|
set_cloexec(fileno(debug_output));
|
|
setlinebuf(debug_output);
|
|
set_flog_output_file(debug_output);
|
|
}
|
|
|
|
// No-exec is prohibited when in interactive mode.
|
|
if (opts.is_interactive_session && opts.no_exec) {
|
|
FLOGF(warning, _(L"Can not use the no-execute mode when running an interactive session"));
|
|
opts.no_exec = false;
|
|
}
|
|
|
|
// Apply our options.
|
|
if (opts.is_login) mark_login();
|
|
if (opts.no_exec) mark_no_exec();
|
|
if (opts.is_interactive_session) set_interactive_session(session_interactivity_t::explicit_);
|
|
|
|
// Only save (and therefore restore) the fg process group if we are interactive. See issues
|
|
// #197 and #1002.
|
|
if (session_interactivity() != session_interactivity_t::not_interactive) {
|
|
save_term_foreground_process_group();
|
|
}
|
|
|
|
const struct config_paths_t paths = determine_config_directory_paths(argv[0]);
|
|
env_init(&paths);
|
|
// Set features early in case other initialization depends on them.
|
|
// Start with the ones set in the environment, then those set on the command line (so the
|
|
// command line takes precedence).
|
|
if (auto features_var = env_stack_t::globals().get(L"fish_features")) {
|
|
for (const wcstring &s : features_var->as_list()) {
|
|
mutable_fish_features().set_from_string(s);
|
|
}
|
|
}
|
|
mutable_fish_features().set_from_string(opts.features);
|
|
proc_init();
|
|
builtin_init();
|
|
misc_init();
|
|
reader_init();
|
|
|
|
parser_t &parser = parser_t::principal_parser();
|
|
|
|
if (read_init(paths)) {
|
|
// Stomp the exit status of any initialization commands (issue #635).
|
|
parser.set_last_statuses(statuses_t::just(STATUS_CMD_OK));
|
|
|
|
// Run post-config commands specified as arguments, if any.
|
|
if (!opts.postconfig_cmds.empty()) {
|
|
res = run_command_list(&opts.postconfig_cmds, {});
|
|
}
|
|
|
|
if (!opts.batch_cmds.empty()) {
|
|
// Run the commands specified as arguments, if any.
|
|
if (get_login()) {
|
|
// Do something nasty to support OpenSUSE assuming we're bash. This may modify cmds.
|
|
fish_xdm_login_hack_hack_hack_hack(&opts.batch_cmds, argc - my_optind,
|
|
argv + my_optind);
|
|
}
|
|
res = run_command_list(&opts.batch_cmds, {});
|
|
reader_set_end_loop(false);
|
|
} else if (my_optind == argc) {
|
|
// Implicitly interactive mode.
|
|
res = reader_read(parser, STDIN_FILENO, {});
|
|
} else {
|
|
const char *file = *(argv + (my_optind++));
|
|
autoclose_fd_t fd(open_cloexec(file, O_RDONLY));
|
|
if (!fd.valid()) {
|
|
perror(file);
|
|
} else {
|
|
wcstring_list_t list;
|
|
for (char **ptr = argv + my_optind; *ptr; ptr++) {
|
|
list.push_back(str2wcstring(*ptr));
|
|
}
|
|
parser.vars().set(L"argv", ENV_DEFAULT, list);
|
|
|
|
auto &ld = parser.libdata();
|
|
wcstring rel_filename = str2wcstring(file);
|
|
scoped_push<const wchar_t *> filename_push{&ld.current_filename,
|
|
intern(rel_filename.c_str())};
|
|
res = reader_read(parser, fd.fd(), {});
|
|
if (res) {
|
|
FLOGF(warning, _(L"Error while reading file %ls\n"),
|
|
ld.current_filename ? ld.current_filename : _(L"Standard input"));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
int exit_status = res ? STATUS_CMD_UNKNOWN : parser.get_last_status();
|
|
|
|
event_fire(parser,
|
|
proc_create_event(L"PROCESS_EXIT", event_type_t::exit, getpid(), exit_status));
|
|
|
|
// Trigger any exit handlers.
|
|
wcstring_list_t event_args = {to_string(exit_status)};
|
|
event_fire_generic(parser, L"fish_exit", &event_args);
|
|
|
|
restore_term_mode();
|
|
restore_term_foreground_process_group();
|
|
|
|
if (g_profiling_active) {
|
|
parser.emit_profiling(s_profiling_output_filename);
|
|
}
|
|
|
|
history_save_all();
|
|
if (opts.print_rusage_self) {
|
|
print_rusage_self(stderr);
|
|
}
|
|
if (debug_output) {
|
|
fclose(debug_output);
|
|
}
|
|
exit_without_destructors(exit_status);
|
|
return EXIT_FAILURE; // above line should always exit
|
|
}
|