lix/src/libutil/error.cc

372 lines
9.8 KiB
C++
Raw Normal View History

#include "error.hh"
#include <iostream>
2020-03-25 16:52:03 +00:00
#include <optional>
#include "serialise.hh"
2020-05-14 18:28:18 +00:00
#include <sstream>
2020-04-29 03:06:08 +00:00
namespace nix {
2020-04-24 20:57:51 +00:00
const std::string nativeSystem = SYSTEM;
2020-06-19 19:44:08 +00:00
BaseError & BaseError::addTrace(std::optional<ErrPos> e, hintformat hint)
2020-06-18 21:25:26 +00:00
{
2020-10-07 14:33:19 +00:00
err.traces.push_front(Trace { .pos = e, .hint = hint });
2020-06-18 21:25:26 +00:00
return *this;
}
2020-06-04 17:53:19 +00:00
// c++ std::exception descendants must have a 'const char* what()' function.
// This stringifies the error and caches it for use by what(), or similarly by msg().
2020-10-07 14:33:19 +00:00
const string & BaseError::calcWhat() const
2020-05-14 18:28:18 +00:00
{
if (what_.has_value())
return *what_;
else {
err.name = sname();
std::ostringstream oss;
2020-06-29 16:20:51 +00:00
showErrorInfo(oss, err, false);
2020-05-14 18:28:18 +00:00
what_ = oss.str();
return *what_;
}
}
std::optional<string> ErrorInfo::programName = std::nullopt;
2020-10-07 14:33:19 +00:00
std::ostream & operator<<(std::ostream & os, const hintformat & hf)
2020-04-15 16:09:43 +00:00
{
return os << hf.str();
}
2020-10-07 14:33:19 +00:00
string showErrPos(const ErrPos & errPos)
{
if (errPos.line > 0) {
if (errPos.column > 0) {
return fmt("(%1%:%2%)", errPos.line, errPos.column);
} else {
return fmt("(%1%)", errPos.line);
}
}
else {
return "";
}
}
2020-10-07 14:33:19 +00:00
std::optional<LinesOfCode> getCodeLines(const ErrPos & errPos)
2020-05-20 23:25:02 +00:00
{
2020-06-24 14:33:53 +00:00
if (errPos.line <= 0)
return std::nullopt;
2020-05-20 23:25:02 +00:00
2020-06-24 14:33:53 +00:00
if (errPos.origin == foFile) {
LinesOfCode loc;
2020-05-21 04:18:26 +00:00
try {
2020-06-24 14:33:53 +00:00
AutoCloseFD fd = open(errPos.file.c_str(), O_RDONLY | O_CLOEXEC);
Don't log from inside the logger This deadlocks ProgressBar, e.g. # nix run --impure --no-substitute --store '/tmp/nix2?store=/foo' --expr 'derivation { builder = /nix/store/zi90rxslsm4mlr46l2xws1rm94g7pk8p-busybox-1.31.1-x86_64-unknown-linux-musl/bin/busybox; }' leads to Thread 1 (Thread 0x7ffff6126e80 (LWP 12250)): #0 0x00007ffff7215d62 in __lll_lock_wait () from /nix/store/9df65igwjmf2wbw0gbrrgair6piqjgmi-glibc-2.31/lib/libpthread.so.0 #1 0x00007ffff720e721 in pthread_mutex_lock () from /nix/store/9df65igwjmf2wbw0gbrrgair6piqjgmi-glibc-2.31/lib/libpthread.so.0 #2 0x00007ffff7ad17fa in __gthread_mutex_lock (__mutex=0x6c5448) at /nix/store/h31cy7jm6g7cfqbhc5pm4rf9c53i3qfb-gcc-9.3.0/include/c++/9.3.0/x86_64-unknown-linux-gnu/bits/gthr-default.h:749 #3 std::mutex::lock (this=0x6c5448) at /nix/store/h31cy7jm6g7cfqbhc5pm4rf9c53i3qfb-gcc-9.3.0/include/c++/9.3.0/bits/std_mutex.h:100 #4 std::unique_lock<std::mutex>::lock (this=0x7fffffff09a8, this=0x7fffffff09a8) at /nix/store/h31cy7jm6g7cfqbhc5pm4rf9c53i3qfb-gcc-9.3.0/include/c++/9.3.0/bits/unique_lock.h:141 #5 std::unique_lock<std::mutex>::unique_lock (__m=..., this=0x7fffffff09a8) at /nix/store/h31cy7jm6g7cfqbhc5pm4rf9c53i3qfb-gcc-9.3.0/include/c++/9.3.0/bits/unique_lock.h:71 #6 nix::Sync<nix::ProgressBar::State, std::mutex>::Lock::Lock (s=0x6c5448, this=0x7fffffff09a0) at src/libutil/sync.hh:45 #7 nix::Sync<nix::ProgressBar::State, std::mutex>::lock (this=0x6c5448) at src/libutil/sync.hh:85 #8 nix::ProgressBar::logEI (this=0x6c5440, ei=...) at src/libmain/progress-bar.cc:131 #9 0x00007ffff7608cfd in nix::Logger::logEI (ei=..., lvl=nix::lvlError, this=0x6c5440) at src/libutil/logging.hh:88 #10 nix::getCodeLines (errPos=...) at src/libutil/error.cc:66 #11 0x00007ffff76073f2 in nix::showErrorInfo (out=..., einfo=..., showTrace=<optimized out>) at /nix/store/h31cy7jm6g7cfqbhc5pm4rf9c53i3qfb-gcc-9.3.0/include/c++/9.3.0/optional:897 #12 0x00007ffff7ad19e7 in nix::ProgressBar::logEI (this=0x6c5440, ei=...) at src/libmain/progress-bar.cc:134 #13 0x00007ffff7ab9d10 in nix::Logger::logEI (ei=..., lvl=nix::lvlError, this=0x6c5440) at src/libutil/logging.hh:88 #14 nix::handleExceptions(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::function<void ()>) (programName="/home/eelco/Dev/nix/outputs/out/bin/nix", fun=...) at src/libmain/shared.cc:328 #15 0x000000000046226b in main (argc=<optimized out>, argv=<optimized out>) at /nix/store/h31cy7jm6g7cfqbhc5pm4rf9c53i3qfb-gcc-9.3.0/include/c++/9.3.0/ext/new_allocator.h:80
2020-12-22 10:15:29 +00:00
if (!fd) return {};
// count the newlines.
int count = 0;
string line;
int pl = errPos.line - 1;
do
2020-05-21 04:18:26 +00:00
{
Don't log from inside the logger This deadlocks ProgressBar, e.g. # nix run --impure --no-substitute --store '/tmp/nix2?store=/foo' --expr 'derivation { builder = /nix/store/zi90rxslsm4mlr46l2xws1rm94g7pk8p-busybox-1.31.1-x86_64-unknown-linux-musl/bin/busybox; }' leads to Thread 1 (Thread 0x7ffff6126e80 (LWP 12250)): #0 0x00007ffff7215d62 in __lll_lock_wait () from /nix/store/9df65igwjmf2wbw0gbrrgair6piqjgmi-glibc-2.31/lib/libpthread.so.0 #1 0x00007ffff720e721 in pthread_mutex_lock () from /nix/store/9df65igwjmf2wbw0gbrrgair6piqjgmi-glibc-2.31/lib/libpthread.so.0 #2 0x00007ffff7ad17fa in __gthread_mutex_lock (__mutex=0x6c5448) at /nix/store/h31cy7jm6g7cfqbhc5pm4rf9c53i3qfb-gcc-9.3.0/include/c++/9.3.0/x86_64-unknown-linux-gnu/bits/gthr-default.h:749 #3 std::mutex::lock (this=0x6c5448) at /nix/store/h31cy7jm6g7cfqbhc5pm4rf9c53i3qfb-gcc-9.3.0/include/c++/9.3.0/bits/std_mutex.h:100 #4 std::unique_lock<std::mutex>::lock (this=0x7fffffff09a8, this=0x7fffffff09a8) at /nix/store/h31cy7jm6g7cfqbhc5pm4rf9c53i3qfb-gcc-9.3.0/include/c++/9.3.0/bits/unique_lock.h:141 #5 std::unique_lock<std::mutex>::unique_lock (__m=..., this=0x7fffffff09a8) at /nix/store/h31cy7jm6g7cfqbhc5pm4rf9c53i3qfb-gcc-9.3.0/include/c++/9.3.0/bits/unique_lock.h:71 #6 nix::Sync<nix::ProgressBar::State, std::mutex>::Lock::Lock (s=0x6c5448, this=0x7fffffff09a0) at src/libutil/sync.hh:45 #7 nix::Sync<nix::ProgressBar::State, std::mutex>::lock (this=0x6c5448) at src/libutil/sync.hh:85 #8 nix::ProgressBar::logEI (this=0x6c5440, ei=...) at src/libmain/progress-bar.cc:131 #9 0x00007ffff7608cfd in nix::Logger::logEI (ei=..., lvl=nix::lvlError, this=0x6c5440) at src/libutil/logging.hh:88 #10 nix::getCodeLines (errPos=...) at src/libutil/error.cc:66 #11 0x00007ffff76073f2 in nix::showErrorInfo (out=..., einfo=..., showTrace=<optimized out>) at /nix/store/h31cy7jm6g7cfqbhc5pm4rf9c53i3qfb-gcc-9.3.0/include/c++/9.3.0/optional:897 #12 0x00007ffff7ad19e7 in nix::ProgressBar::logEI (this=0x6c5440, ei=...) at src/libmain/progress-bar.cc:134 #13 0x00007ffff7ab9d10 in nix::Logger::logEI (ei=..., lvl=nix::lvlError, this=0x6c5440) at src/libutil/logging.hh:88 #14 nix::handleExceptions(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::function<void ()>) (programName="/home/eelco/Dev/nix/outputs/out/bin/nix", fun=...) at src/libmain/shared.cc:328 #15 0x000000000046226b in main (argc=<optimized out>, argv=<optimized out>) at /nix/store/h31cy7jm6g7cfqbhc5pm4rf9c53i3qfb-gcc-9.3.0/include/c++/9.3.0/ext/new_allocator.h:80
2020-12-22 10:15:29 +00:00
line = readLine(fd.get());
++count;
if (count < pl)
;
else if (count == pl)
loc.prevLineOfCode = line;
else if (count == pl + 1)
loc.errLineOfCode = line;
else if (count == pl + 2) {
loc.nextLineOfCode = line;
break;
}
} while (true);
return loc;
2020-05-21 04:18:26 +00:00
}
2020-10-07 14:33:19 +00:00
catch (EndOfFile & eof) {
2020-07-01 18:02:02 +00:00
if (loc.errLineOfCode.has_value())
return loc;
else
return std::nullopt;
2020-05-21 04:18:26 +00:00
}
2020-10-07 14:33:19 +00:00
catch (std::exception & e) {
2020-06-24 14:33:53 +00:00
return std::nullopt;
2020-05-21 04:18:26 +00:00
}
2020-06-18 21:25:26 +00:00
} else {
2020-06-24 14:33:53 +00:00
std::istringstream iss(errPos.file);
2020-05-20 23:25:02 +00:00
// count the newlines.
int count = 0;
string line;
2020-06-24 14:33:53 +00:00
int pl = errPos.line - 1;
LinesOfCode loc;
2020-07-06 17:54:53 +00:00
2020-06-18 21:25:26 +00:00
do
2020-05-20 23:25:02 +00:00
{
2020-05-21 04:18:26 +00:00
std::getline(iss, line);
2020-05-20 23:25:02 +00:00
++count;
2020-06-18 21:25:26 +00:00
if (count < pl)
2020-05-20 23:25:02 +00:00
{
2020-06-18 21:25:26 +00:00
;
2020-05-20 23:25:02 +00:00
}
else if (count == pl) {
2020-06-24 14:33:53 +00:00
loc.prevLineOfCode = line;
2020-05-20 23:25:02 +00:00
} else if (count == pl + 1) {
2020-06-24 14:33:53 +00:00
loc.errLineOfCode = line;
2020-05-20 23:25:02 +00:00
} else if (count == pl + 2) {
2020-06-24 14:33:53 +00:00
loc.nextLineOfCode = line;
2020-05-20 23:25:02 +00:00
break;
}
2020-05-21 04:18:26 +00:00
if (!iss.good())
break;
2020-05-20 23:25:02 +00:00
} while (true);
2020-06-24 14:33:53 +00:00
return loc;
2020-05-20 23:25:02 +00:00
}
}
// print lines of code to the ostream, indicating the error column.
2020-10-07 14:33:19 +00:00
void printCodeLines(std::ostream & out,
const string & prefix,
const ErrPos & errPos,
const LinesOfCode & loc)
{
2020-04-08 15:48:21 +00:00
// previous line of code.
2020-06-24 14:33:53 +00:00
if (loc.prevLineOfCode.has_value()) {
2020-06-15 12:12:39 +00:00
out << std::endl
<< fmt("%1% %|2$5d|| %3%",
2020-06-18 21:25:26 +00:00
prefix,
2020-06-24 14:33:53 +00:00
(errPos.line - 1),
*loc.prevLineOfCode);
2020-04-08 15:48:21 +00:00
}
2020-04-02 22:02:40 +00:00
2020-06-24 14:33:53 +00:00
if (loc.errLineOfCode.has_value()) {
// line of code containing the error.
out << std::endl
<< fmt("%1% %|2$5d|| %3%",
2020-06-18 21:25:26 +00:00
prefix,
2020-06-24 14:33:53 +00:00
(errPos.line),
*loc.errLineOfCode);
// error arrows for the column range.
2020-06-24 14:33:53 +00:00
if (errPos.column > 0) {
int start = errPos.column;
std::string spaces;
for (int i = 0; i < start; ++i) {
spaces.append(" ");
}
std::string arrows("^");
2020-04-01 22:20:20 +00:00
out << std::endl
<< fmt("%1% |%2%" ANSI_RED "%3%" ANSI_NORMAL,
2020-06-18 21:25:26 +00:00
prefix,
spaces,
arrows);
}
}
2020-04-08 15:48:21 +00:00
// next line of code.
2020-06-24 14:33:53 +00:00
if (loc.nextLineOfCode.has_value()) {
out << std::endl
<< fmt("%1% %|2$5d|| %3%",
2020-06-18 21:25:26 +00:00
prefix,
2020-06-24 14:33:53 +00:00
(errPos.line + 1),
*loc.nextLineOfCode);
2020-04-08 15:48:21 +00:00
}
}
2020-10-07 14:33:19 +00:00
void printAtPos(const string & prefix, const ErrPos & pos, std::ostream & out)
{
2020-07-01 16:37:31 +00:00
if (pos)
{
switch (pos.origin) {
case foFile: {
out << prefix << ANSI_BLUE << "at: " << ANSI_YELLOW << showErrPos(pos) <<
ANSI_BLUE << " in file: " << ANSI_NORMAL << pos.file;
break;
}
case foString: {
out << prefix << ANSI_BLUE << "at: " << ANSI_YELLOW << showErrPos(pos) <<
2020-06-25 15:56:32 +00:00
ANSI_BLUE << " from string" << ANSI_NORMAL;
break;
}
case foStdin: {
out << prefix << ANSI_BLUE << "at: " << ANSI_YELLOW << showErrPos(pos) <<
ANSI_BLUE << " from stdin" << ANSI_NORMAL;
break;
}
default:
throw Error("invalid FileOrigin in errPos");
}
}
}
2020-10-07 14:33:19 +00:00
std::ostream & showErrorInfo(std::ostream & out, const ErrorInfo & einfo, bool showTrace)
{
auto errwidth = std::max<size_t>(getWindowSize().second, 20);
string prefix = "";
2020-04-01 22:20:20 +00:00
string levelString;
2020-04-02 22:02:40 +00:00
switch (einfo.level) {
case Verbosity::lvlError: {
levelString = ANSI_RED;
levelString += "error:";
levelString += ANSI_NORMAL;
break;
}
case Verbosity::lvlWarn: {
levelString = ANSI_YELLOW;
levelString += "warning:";
levelString += ANSI_NORMAL;
break;
}
case Verbosity::lvlInfo: {
levelString = ANSI_GREEN;
levelString += "info:";
levelString += ANSI_NORMAL;
break;
}
case Verbosity::lvlTalkative: {
levelString = ANSI_GREEN;
levelString += "talk:";
levelString += ANSI_NORMAL;
break;
}
case Verbosity::lvlChatty: {
levelString = ANSI_GREEN;
levelString += "chat:";
levelString += ANSI_NORMAL;
break;
}
case Verbosity::lvlVomit: {
levelString = ANSI_GREEN;
levelString += "vomit:";
levelString += ANSI_NORMAL;
break;
}
case Verbosity::lvlDebug: {
levelString = ANSI_YELLOW;
levelString += "debug:";
levelString += ANSI_NORMAL;
break;
}
default: {
levelString = fmt("invalid error level: %1%", einfo.level);
break;
}
}
auto ndl = prefix.length()
+ filterANSIEscapes(levelString, true).length()
+ 7
+ einfo.name.length()
+ einfo.programName.value_or("").length();
auto dashwidth = std::max<int>(errwidth - ndl, 3);
2020-04-01 22:20:20 +00:00
2020-06-15 16:16:03 +00:00
std::string dashes(dashwidth, '-');
2020-04-01 22:20:20 +00:00
// divider.
if (einfo.name != "")
2020-04-29 03:06:08 +00:00
out << fmt("%1%%2%" ANSI_BLUE " --- %3% %4% %5%" ANSI_NORMAL,
2020-04-29 16:14:32 +00:00
prefix,
levelString,
einfo.name,
dashes,
einfo.programName.value_or(""));
else
2020-04-29 03:06:08 +00:00
out << fmt("%1%%2%" ANSI_BLUE " -----%3% %4%" ANSI_NORMAL,
2020-04-29 16:14:32 +00:00
prefix,
levelString,
dashes,
einfo.programName.value_or(""));
bool nl = false; // intersperse newline between sections.
2020-07-01 16:37:31 +00:00
if (einfo.errPos.has_value() && (*einfo.errPos)) {
out << prefix << std::endl;
printAtPos(prefix, *einfo.errPos, out);
nl = true;
2020-04-01 22:20:20 +00:00
}
2020-04-01 22:20:20 +00:00
// description
if (einfo.description != "") {
if (nl)
out << std::endl << prefix;
out << std::endl << prefix << einfo.description;
nl = true;
}
2020-04-01 22:20:20 +00:00
if (einfo.errPos.has_value() && (*einfo.errPos)) {
2020-06-24 14:33:53 +00:00
auto loc = getCodeLines(*einfo.errPos);
2020-06-18 21:25:26 +00:00
2020-05-20 23:25:02 +00:00
// lines of code.
2020-06-24 14:33:53 +00:00
if (loc.has_value()) {
if (nl)
out << std::endl << prefix;
2020-06-24 14:33:53 +00:00
printCodeLines(out, prefix, *einfo.errPos, *loc);
nl = true;
2020-05-20 23:25:02 +00:00
}
}
2020-05-20 23:25:02 +00:00
// hint
if (einfo.hint.has_value()) {
if (nl)
out << std::endl << prefix;
out << std::endl << prefix << *einfo.hint;
nl = true;
2020-04-01 22:20:20 +00:00
}
2020-06-23 15:36:58 +00:00
// traces
2020-06-29 21:46:21 +00:00
if (showTrace && !einfo.traces.empty())
{
2020-06-30 21:44:19 +00:00
const string tracetitle(" show-trace ");
2020-06-29 21:46:21 +00:00
int fill = errwidth - tracetitle.length();
int lw = 0;
int rw = 0;
const int min_dashes = 3;
if (fill > min_dashes * 2) {
if (fill % 2 != 0) {
lw = fill / 2;
rw = lw + 1;
}
else
{
lw = rw = fill / 2;
}
}
else
lw = rw = min_dashes;
if (nl)
out << std::endl << prefix;
out << ANSI_BLUE << std::string(lw, '-') << tracetitle << std::string(rw, '-') << ANSI_NORMAL;
for (auto iter = einfo.traces.rbegin(); iter != einfo.traces.rend(); ++iter)
{
2020-07-06 16:51:48 +00:00
out << std::endl << prefix;
out << ANSI_BLUE << "trace: " << ANSI_NORMAL << iter->hint.str();
if (iter->pos.has_value() && (*iter->pos)) {
auto pos = iter->pos.value();
2020-06-29 21:46:21 +00:00
out << std::endl << prefix;
2020-07-06 16:51:48 +00:00
printAtPos(prefix, pos, out);
2020-07-06 16:51:48 +00:00
auto loc = getCodeLines(pos);
if (loc.has_value())
{
out << std::endl << prefix;
printCodeLines(out, prefix, pos, *loc);
2020-07-01 16:37:31 +00:00
out << std::endl << prefix;
2020-06-29 21:46:21 +00:00
}
}
2020-06-23 15:36:58 +00:00
}
}
return out;
}
}