lean4-htt/src/shell/lean.cpp

544 lines
18 KiB
C++

/*
Copyright (c) 2013 Microsoft Corporation. All rights reserved.
Released under Apache 2.0 license as described in the file LICENSE.
Author: Leonardo de Moura
*/
#include <iostream>
#include <fstream>
#include <signal.h>
#include <cstdlib>
#include <getopt.h>
#include <string>
#include <utility>
#include <vector>
#include "util/realpath.h"
#include "util/stackinfo.h"
#include "util/macros.h"
#include "util/debug.h"
#include "util/sstream.h"
#include "util/interrupt.h"
#include "util/memory.h"
#include "util/thread.h"
#include "util/lean_path.h"
#include "util/file_lock.h"
#include "util/sexpr/options.h"
#include "util/sexpr/option_declarations.h"
#include "kernel/environment.h"
#include "kernel/kernel_exception.h"
#include "kernel/type_checker.h"
#include "kernel/formatter.h"
#include "library/st_task_queue.h"
#include "library/mt_task_queue.h"
#include "library/module_mgr.h"
#include "library/standard_kernel.h"
#include "library/module.h"
#include "library/type_context.h"
#include "library/io_state_stream.h"
#include "library/export.h"
#include "library/message_builder.h"
#include "frontends/lean/parser.h"
#include "frontends/lean/pp.h"
#include "frontends/lean/dependencies.h"
#include "frontends/lean/opt_cmd.h"
#include "frontends/smt2/parser.h"
#include "frontends/lean/json.h"
#include "library/native_compiler/options.h"
#include "library/native_compiler/native_compiler.h"
#include "library/trace.h"
#include "init/init.h"
#include "shell/simple_pos_info_provider.h"
#include "shell/leandoc.h"
#if defined(LEAN_SERVER)
#include "shell/server.h"
#endif
#if defined(LEAN_EMSCRIPTEN)
#include <emscripten.h>
#endif
#include "version.h"
#include "githash.h" // NOLINT
using namespace lean; // NOLINT
static void display_header(std::ostream & out) {
out << "Lean (version " << LEAN_VERSION_MAJOR << "."
<< LEAN_VERSION_MINOR << "." << LEAN_VERSION_PATCH;
if (std::strcmp(g_githash, "GITDIR-NOTFOUND") == 0) {
if (std::strcmp(LEAN_PACKAGE_VERSION, "NOT-FOUND") != 0) {
out << ", package " << LEAN_PACKAGE_VERSION;
}
} else {
out << ", commit " << std::string(g_githash).substr(0, 12);
}
out << ", " << LEAN_STR(LEAN_BUILD_TYPE) << ")\n";
}
static void display_help(std::ostream & out) {
display_header(out);
std::cout << "Input format:\n";
std::cout << " --smt2 interpret files as SMT-Lib2 files\n";
std::cout << "Miscellaneous:\n";
std::cout << " --help -h display this message\n";
std::cout << " --version -v display version number\n";
std::cout << " --githash display the git commit hash number used to build this binary\n";
std::cout << " --path display the path used for finding Lean libraries and extensions\n";
std::cout << " --doc=file -r generate module documentation based on module doc strings\n";
std::cout << " --make create olean files\n";
std::cout << " --trust=num -t trust level (default: max) 0 means do not trust any macro,\n"
<< " and type check all imported modules\n";
std::cout << " --quiet -q do not print verbose messages\n";
std::cout << " --memory=num -M maximum amount of memory that should be used by Lean\n";
std::cout << " (in megabytes)\n";
#if defined(LEAN_MULTI_THREAD)
std::cout << " --threads=num -j number of threads used to process lean files\n";
std::cout << " --tstack=num -s thread stack size in Kb\n";
#endif
std::cout << " --deps just print dependencies of a Lean input\n";
#if defined(LEAN_SERVER)
std::cout << " --json print JSON-formatted structured error messages\n";
std::cout << " --server start lean in server mode\n";
std::cout << " --server=file start lean in server mode, redirecting standard input from the specified file (for debugging)\n";
#endif
std::cout << " --profile display elaboration/type checking time for each definition/theorem\n";
DEBUG_CODE(
std::cout << " --debug=tag enable assertions with the given tag\n";
)
std::cout << " -D name=value set a configuration option (see set_option command)\n";
std::cout << "Exporting data:\n";
std::cout << " --export=file -E export final environment as textual low-level file\n";
std::cout << " --export-all=file -A export final environment (and all dependencies) as textual low-level file\n";
}
static struct option g_long_options[] = {
{"version", no_argument, 0, 'v'},
{"help", no_argument, 0, 'h'},
{"smt2", no_argument, 0, 'Y'},
{"path", no_argument, 0, 'p'},
{"githash", no_argument, 0, 'g'},
{"make", no_argument, 0, 'm'},
{"export", required_argument, 0, 'E'},
{"export-all", required_argument, 0, 'A'},
{"memory", required_argument, 0, 'M'},
{"trust", required_argument, 0, 't'},
{"profile", no_argument, 0, 'P'},
{"threads", required_argument, 0, 'j'},
{"quiet", no_argument, 0, 'q'},
{"deps", no_argument, 0, 'd'},
{"compile", optional_argument, 0, 'C'},
#if defined(LEAN_SERVER)
{"json", no_argument, 0, 'J'},
{"server", optional_argument, 0, 'S'},
#endif
{"doc", required_argument, 0, 'r'},
#if defined(LEAN_MULTI_THREAD)
{"tstack", required_argument, 0, 's'},
#endif
#ifdef LEAN_DEBUG
{"debug", required_argument, 0, 'B'},
#endif
{0, 0, 0, 0}
};
static char const * g_opt_str =
"PdD:qpgvht:012E:A:B:j:012rM:012"
#if defined(LEAN_MULTI_THREAD)
"s:012"
#endif
; // NOLINT
options set_config_option(options const & opts, char const * in) {
if (!in) return opts;
while (*in && std::isspace(*in))
++in;
std::string in_str(in);
auto pos = in_str.find('=');
if (pos == std::string::npos)
throw lean::exception("invalid -D parameter, argument must contain '='");
lean::name opt = lean::string_to_name(in_str.substr(0, pos));
std::string val = in_str.substr(pos+1);
auto decls = lean::get_option_declarations();
auto it = decls.find(opt);
if (it) {
switch (it->kind()) {
case lean::BoolOption:
if (val == "true")
return opts.update(opt, true);
else if (val == "false")
return opts.update(opt, false);
else
throw lean::exception(lean::sstream() << "invalid -D parameter, invalid configuration option '" << opt
<< "' value, it must be true/false");
case lean::IntOption:
case lean::UnsignedOption:
return opts.update(opt, atoi(val.c_str()));
case lean::StringOption:
return opts.update(opt, val);
default:
throw lean::exception(lean::sstream() << "invalid -D parameter, configuration option '" << opt
<< "' cannot be set in the command line, use set_option command");
}
} else {
throw lean::exception(lean::sstream() << "invalid -D parameter, unknown configuration option '" << opt << "'");
}
}
class initializer {
private:
lean::initializer m_init;
public:
initializer() {
#if defined(LEAN_SERVER)
lean::initialize_server();
#endif
}
~initializer() {
#if defined(LEAN_SERVER)
lean::finalize_server();
#endif
}
};
class progress_message_stream : public stream_message_buffer {
mutex m_mutex;
bool m_showing_task = false;
std::ostream & m_out;
void clear_shown_task() {
if (m_showing_task) {
m_out << "\33[2K\r";
m_showing_task = false;
}
}
public:
progress_message_stream(std::ostream & out) :
stream_message_buffer(out), m_out(out) {}
~progress_message_stream() {
clear_shown_task();
}
void report(message_bucket_id const & bucket, message const & msg) override {
unique_lock<mutex> lock(m_mutex);
clear_shown_task();
stream_message_buffer::report(bucket, msg);
}
void show_current_task(std::string const & desc) {
unique_lock<mutex> lock(m_mutex);
clear_shown_task();
m_out << desc << std::flush;
m_showing_task = true;
}
};
int main(int argc, char ** argv) {
#if defined(LEAN_EMSCRIPTEN)
EM_ASM(
var lean_path = process.env['LEAN_PATH'];
if (lean_path) {
ENV['LEAN_PATH'] = lean_path;
}
try {
// emscripten cannot mount all of / in the vfs,
// we can only mount subdirectories...
FS.mount(NODEFS, { root: '/home' }, '/home');
FS.mkdir('/root');
FS.mount(NODEFS, { root: '/root' }, '/root');
FS.chdir(process.cwd());
} catch (e) {
console.log(e);
});
#endif
::initializer init;
bool make_mode = false;
unsigned trust_lvl = LEAN_BELIEVER_TRUST_LEVEL+1;
bool smt2 = false;
bool compile = false;
bool only_deps = false;
unsigned num_threads = 0;
#if defined(LEAN_MULTI_THREAD)
num_threads = hardware_concurrency();
#endif
#if defined(LEAN_SERVER)
bool json_output = false;
#endif
options opts;
optional<std::string> export_txt;
optional<std::string> export_all_txt;
optional<std::string> doc;
optional<std::string> server_in;
std::string native_output;
while (true) {
int c = getopt_long(argc, argv, g_opt_str, g_long_options, NULL);
if (c == -1)
break; // end of command line
switch (c) {
case 'j':
num_threads = static_cast<unsigned>(atoi(optarg));
break;
case 'v':
display_header(std::cout);
return 0;
case 'g':
std::cout << g_githash << "\n";
return 0;
case 'h':
display_help(std::cout);
return 0;
case 'Y':
smt2 = true;
break;
case 'p':
std::cout << lean::get_lean_path() << "\n";
return 0;
case 's':
lean::lthread::set_thread_stack_size(static_cast<size_t>((atoi(optarg)/4)*4)*static_cast<size_t>(1024));
break;
case 'm':
make_mode = true;
break;
case 'n':
native_output = optarg;
break;
case 'C':
compile = true;
break;
case 'r':
doc = optarg;
break;
case 'M':
lean::set_max_memory_megabyte(atoi(optarg));
opts = opts.update(lean::get_max_memory_opt_name(), atoi(optarg));
break;
case 't':
trust_lvl = atoi(optarg);
break;
case 'q':
opts = opts.update(lean::get_verbose_opt_name(), false);
break;
case 'd':
only_deps = true;
break;
case 'D':
try {
opts = set_config_option(opts, optarg);
} catch (lean::exception & ex) {
std::cerr << ex.what() << std::endl;
return 1;
}
break;
#if defined(LEAN_SERVER)
case 'J':
opts = opts.update(lean::name{"trace", "as_messages"}, true);
json_output = true;
break;
case 'S':
opts = opts.update("server", true);
opts = opts.update(lean::name{"trace", "as_messages"}, true);
if (optarg) server_in = optional<std::string>(optarg);
break;
#endif
case 'P':
opts = opts.update("profiler", true);
break;
case 'E':
export_txt = std::string(optarg);
break;
#if defined(LEAN_DEBUG)
case 'B':
lean::enable_debug(optarg);
break;
#endif
case 'A':
export_all_txt = std::string(optarg);
break;
default:
std::cerr << "Unknown command line option\n";
display_help(std::cerr);
return 1;
}
}
environment env = mk_environment(trust_lvl);
io_state ios(opts, lean::mk_pretty_formatter_factory());
if (smt2) {
// Note: the smt2 flag may override other flags
bool ok = true;
for (int i = optind; i < argc; i++) {
try {
if (doc) throw lean::exception("leandoc does not support .smt2 files");
ok = ::lean::smt2::parse_commands(env, ios, argv[i]);
} catch (lean::exception & ex) {
ok = false;
type_context tc(env, ios.get_options());
simple_pos_info_provider pp(argv[i]);
lean::message_builder(&pp, std::make_shared<type_context>(env, ios.get_options()),
env, ios, argv[i], pos_info(1, 1), lean::ERROR)
.set_exception(ex).report();
}
}
return ok ? 0 : 1;
}
#if defined(LEAN_SERVER)
if (opts.get_bool("server")) {
/* Disable assertion violation dialog:
(C)ontinue, (A)bort, (S)top, Invoke (G)DB */
lean::enable_debug_dialog(false);
std::unique_ptr<std::ifstream> file_in;
if (server_in) {
file_in.reset(new std::ifstream(*server_in));
std::cin.rdbuf(file_in->rdbuf());
}
server(num_threads, env, ios).run();
return 0;
}
#endif
std::shared_ptr<message_buffer> msg_buf =
std::make_shared<progress_message_stream>(std::cout);
#if defined(LEAN_SERVER)
if (json_output) {
msg_buf = std::make_shared<json_message_stream>(std::cout);
ios.set_regular_channel(ios.get_diagnostic_channel_ptr());
}
#endif
scope_global_ios scope_ios(ios);
scoped_message_buffer scope_msg_buf(msg_buf.get());
scope_message_context scope_msg_ctx(message_bucket_id { "_global", 1 });
try {
std::vector<std::string> args(argv + optind, argv + argc);
if (make_mode) {
if (args.empty()) args.push_back(".");
std::vector<std::string> files;
for (auto & f : args) {
if (auto i_d = is_dir(f)) {
if (*i_d) {
recursive_list_files(f, files);
} else {
files.push_back(f);
}
}
}
args.clear();
for (auto & f : files) {
if (is_lean_file(f))
args.push_back(f);
}
}
std::vector<std::string> module_args;
for (auto & f : args) module_args.push_back(lrealpath(f.c_str()));
std::shared_ptr<task_queue> tq;
#if defined(LEAN_MULTI_THREAD)
if (num_threads == 0) {
tq = std::make_shared<st_task_queue>();
} else {
tq = std::make_shared<mt_task_queue>(num_threads);
}
#else
tq = std::make_shared<st_task_queue>();
#endif
scope_global_task_queue scope(tq.get());
if (make_mode) {
if (auto prog_msg_buf = std::dynamic_pointer_cast<progress_message_stream>(msg_buf))
tq->set_progress_callback([=](generic_task * t) {
if (t && !t->is_tiny())
prog_msg_buf->show_current_task(t->description());
});
}
fs_module_vfs vfs;
if (!make_mode || export_txt || export_all_txt) {
for (auto & mod_id : module_args)
vfs.m_modules_to_load_from_source.insert(mod_id);
}
module_mgr mod_mgr(&vfs, msg_buf.get(), env, ios);
mod_mgr.set_save_olean(make_mode);
bool ok = true;
if (only_deps) {
for (auto & mod_fn : module_args) {
try {
if (!display_deps(env, std::cout, std::cerr, mod_fn.c_str()))
ok = false;
} catch (lean::exception &ex) {
ok = false;
lean::message_builder(env, ios, mod_fn, lean::pos_info(1, 1), lean::ERROR).set_exception(
ex).report();
}
}
return ok ? 0 : 1;
}
std::vector<std::pair<module_id, std::shared_ptr<module_info const>>> mods;
for (auto & mod : module_args) {
auto mod_info = mod_mgr.get_module(mod);
mods.push_back({mod, mod_info});
}
tq->join();
for (auto & mod : mods) {
try {
auto res = mod.second->m_result.get();
ok = ok && res.m_ok;
} catch (exception & ex) {
ok = false;
// exception has already been reported
}
}
// Options appear to be empty, pretty sure I'm making a mistake here.
if (compile && !mods.empty()) {
auto final_env = *mods.front().second->m_result.get().m_env;
auto final_opts = mods.front().second->m_result.get().m_opts;
type_context tc(final_env, final_opts);
lean::scope_trace_env scope2(final_env, final_opts, tc);
lean::native::scope_config scoped_native_config(
final_opts);
native_compile_binary(final_env, final_env.get(lean::name("main")));
}
// if (!mods.empty() && export_native_objects) {
// // this code is now broken
// env = lean::set_native_module_path(env, lean::name(native_output));
// }
if (export_txt && !mods.empty()) {
exclusive_file_lock export_lock(*export_txt);
std::ofstream out(*export_txt);
export_module_as_lowtext(out, *mods.front().second->m_result.get().m_env);
}
if (export_all_txt && !mods.empty()) {
exclusive_file_lock export_lock(*export_all_txt);
std::ofstream out(*export_all_txt);
export_all_as_lowtext(out, *mods.front().second->m_result.get().m_env);
}
if (doc) {
exclusive_file_lock export_lock(*doc);
std::ofstream out(*doc);
gen_doc(env, opts, out);
}
return ok ? 0 : 1;
} catch (lean::throwable & ex) {
lean::message_builder(env, ios, "<unknown>", lean::pos_info(1, 1), lean::ERROR).set_exception(ex).report();
} catch (std::bad_alloc & ex) {
std::cerr << "out of memory" << std::endl;
}
return 1;
}