lix/src/libutil/error.hh

215 lines
5 KiB
C++
Raw Normal View History

2020-04-26 20:47:41 +00:00
#pragma once
2020-04-26 20:47:41 +00:00
#include "ref.hh"
2020-04-03 14:48:20 +00:00
#include "types.hh"
2020-07-07 12:37:47 +00:00
#include "fmt.hh"
2020-03-27 16:55:09 +00:00
2020-06-15 23:35:07 +00:00
#include <cstring>
2020-04-26 20:47:41 +00:00
#include <list>
#include <memory>
#include <map>
#include <optional>
2020-07-07 12:37:47 +00:00
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
2020-04-26 20:47:41 +00:00
/* Before 4.7, gcc's std::exception uses empty throw() specifiers for
* its (virtual) destructor and what() in c++11 mode, in violation of spec
*/
#ifdef __GNUC__
#if __GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 7)
#define EXCEPTION_NEEDS_THROW_SPEC
#endif
#endif
namespace nix {
/*
2020-06-04 17:53:19 +00:00
2020-06-18 21:25:26 +00:00
This file defines two main structs/classes used in nix error handling.
2020-06-04 17:53:19 +00:00
2020-06-18 21:25:26 +00:00
ErrorInfo provides a standard payload of error information, with conversion to string
happening in the logger rather than at the call site.
2020-06-04 17:53:19 +00:00
2020-06-18 21:25:26 +00:00
BaseError is the ancestor of nix specific exceptions (and Interrupted), and contains
an ErrorInfo.
2020-06-04 17:53:19 +00:00
2020-06-18 21:25:26 +00:00
ErrorInfo structs are sent to the logger as part of an exception, or directly with the
logError or logWarning macros.
2020-03-24 17:21:35 +00:00
2020-11-11 16:21:26 +00:00
See libutil/tests/logging.cc for usage examples.
2020-06-04 17:53:19 +00:00
2020-06-18 21:25:26 +00:00
*/
2020-06-04 17:53:19 +00:00
2020-04-29 03:06:08 +00:00
typedef enum {
2020-04-26 20:47:41 +00:00
lvlError = 0,
lvlWarn,
lvlNotice,
2020-04-26 20:47:41 +00:00
lvlInfo,
lvlTalkative,
lvlChatty,
lvlDebug,
lvlVomit
} Verbosity;
2020-06-18 21:25:26 +00:00
typedef enum {
2020-05-21 04:18:26 +00:00
foFile,
foStdin,
foString
} FileOrigin;
2020-06-24 14:33:53 +00:00
// the lines of code surrounding an error.
struct LinesOfCode {
std::optional<string> prevLineOfCode;
std::optional<string> errLineOfCode;
std::optional<string> nextLineOfCode;
};
2020-06-04 17:53:19 +00:00
// ErrPos indicates the location of an error in a nix file.
2020-04-29 03:06:08 +00:00
struct ErrPos {
int line = 0;
int column = 0;
2020-04-26 20:47:41 +00:00
string file;
2020-05-21 04:18:26 +00:00
FileOrigin origin;
2020-04-26 20:47:41 +00:00
operator bool() const
{
return line != 0;
}
2020-06-04 17:53:19 +00:00
// convert from the Pos struct, found in libexpr.
2020-04-08 15:07:58 +00:00
template <class P>
ErrPos& operator=(const P &pos)
{
2020-05-21 04:18:26 +00:00
origin = pos.origin;
2020-04-26 20:47:41 +00:00
line = pos.line;
2020-04-08 15:07:58 +00:00
column = pos.column;
2020-06-30 17:00:51 +00:00
// is file symbol null?
if (pos.file.set())
file = pos.file;
else
file = "";
2020-04-08 15:07:58 +00:00
return *this;
}
2020-04-08 15:48:21 +00:00
template <class P>
ErrPos(const P &p)
{
2020-04-27 21:15:08 +00:00
*this = p;
2020-04-08 15:48:21 +00:00
}
};
2021-09-13 17:57:25 +00:00
std::optional<LinesOfCode> getCodeLines(const ErrPos & errPos);
void printCodeLines(std::ostream & out,
const string & prefix,
const ErrPos & errPos,
const LinesOfCode & loc);
2020-06-18 21:25:26 +00:00
struct Trace {
2020-06-19 19:44:08 +00:00
std::optional<ErrPos> pos;
2020-06-18 21:25:26 +00:00
hintformat hint;
2020-03-24 17:21:35 +00:00
};
2020-04-29 03:06:08 +00:00
struct ErrorInfo {
2020-04-26 20:47:41 +00:00
Verbosity level;
Improve error formatting Changes: * The divider lines are gone. These were in practice a bit confusing, in particular with --show-trace or --keep-going, since then there were multiple lines, suggesting a start/end which wasn't the case. * Instead, multi-line error messages are now indented to align with the prefix (e.g. "error: "). * The 'description' field is gone since we weren't really using it. * 'hint' is renamed to 'msg' since it really wasn't a hint. * The error is now printed *before* the location info. * The 'name' field is no longer printed since most of the time it wasn't very useful since it was just the name of the exception (like EvalError). Ideally in the future this would be a unique, easily googleable error ID (like rustc). * "trace:" is now just "…". This assumes error contexts start with something like "while doing X". Example before: error: --- AssertionError ---------------------------------------------------------------------------------------- nix at: (7:7) in file: /home/eelco/Dev/nixpkgs/pkgs/applications/misc/hello/default.nix 6| 7| x = assert false; 1; | ^ 8| assertion 'false' failed ----------------------------------------------------- show-trace ----------------------------------------------------- trace: while evaluating the attribute 'x' of the derivation 'hello-2.10' at: (192:11) in file: /home/eelco/Dev/nixpkgs/pkgs/stdenv/generic/make-derivation.nix 191| // (lib.optionalAttrs (!(attrs ? name) && attrs ? pname && attrs ? version)) { 192| name = "${attrs.pname}-${attrs.version}"; | ^ 193| } // (lib.optionalAttrs (stdenv.hostPlatform != stdenv.buildPlatform && !dontAddHostSuffix && (attrs ? name || (attrs ? pname && attrs ? version)))) { Example after: error: assertion 'false' failed at: (7:7) in file: /home/eelco/Dev/nixpkgs/pkgs/applications/misc/hello/default.nix 6| 7| x = assert false; 1; | ^ 8| … while evaluating the attribute 'x' of the derivation 'hello-2.10' at: (192:11) in file: /home/eelco/Dev/nixpkgs/pkgs/stdenv/generic/make-derivation.nix 191| // (lib.optionalAttrs (!(attrs ? name) && attrs ? pname && attrs ? version)) { 192| name = "${attrs.pname}-${attrs.version}"; | ^ 193| } // (lib.optionalAttrs (stdenv.hostPlatform != stdenv.buildPlatform && !dontAddHostSuffix && (attrs ? name || (attrs ? pname && attrs ? version)))) {
2021-01-20 23:27:36 +00:00
string name; // FIXME: rename
hintformat msg;
std::optional<ErrPos> errPos;
2020-06-18 21:25:26 +00:00
std::list<Trace> traces;
2020-03-24 17:21:35 +00:00
2020-04-26 20:47:41 +00:00
static std::optional<string> programName;
2020-04-07 01:43:22 +00:00
};
2020-03-24 17:21:35 +00:00
2020-06-27 18:19:31 +00:00
std::ostream& showErrorInfo(std::ostream &out, const ErrorInfo &einfo, bool showTrace);
2020-03-24 17:21:35 +00:00
2020-04-26 20:47:41 +00:00
/* BaseError should generally not be caught, as it has Interrupted as
a subclass. Catch Error instead. */
class BaseError : public std::exception
2020-04-07 01:43:22 +00:00
{
2020-04-26 20:47:41 +00:00
protected:
2020-05-07 22:43:36 +00:00
mutable ErrorInfo err;
2020-04-30 00:57:05 +00:00
2020-05-07 22:43:36 +00:00
mutable std::optional<string> what_;
2020-05-14 18:28:18 +00:00
const string& calcWhat() const;
2020-04-07 01:43:22 +00:00
public:
2020-04-26 20:47:41 +00:00
unsigned int status = 1; // exit status
template<typename... Args>
BaseError(unsigned int status, const Args & ... args)
Improve error formatting Changes: * The divider lines are gone. These were in practice a bit confusing, in particular with --show-trace or --keep-going, since then there were multiple lines, suggesting a start/end which wasn't the case. * Instead, multi-line error messages are now indented to align with the prefix (e.g. "error: "). * The 'description' field is gone since we weren't really using it. * 'hint' is renamed to 'msg' since it really wasn't a hint. * The error is now printed *before* the location info. * The 'name' field is no longer printed since most of the time it wasn't very useful since it was just the name of the exception (like EvalError). Ideally in the future this would be a unique, easily googleable error ID (like rustc). * "trace:" is now just "…". This assumes error contexts start with something like "while doing X". Example before: error: --- AssertionError ---------------------------------------------------------------------------------------- nix at: (7:7) in file: /home/eelco/Dev/nixpkgs/pkgs/applications/misc/hello/default.nix 6| 7| x = assert false; 1; | ^ 8| assertion 'false' failed ----------------------------------------------------- show-trace ----------------------------------------------------- trace: while evaluating the attribute 'x' of the derivation 'hello-2.10' at: (192:11) in file: /home/eelco/Dev/nixpkgs/pkgs/stdenv/generic/make-derivation.nix 191| // (lib.optionalAttrs (!(attrs ? name) && attrs ? pname && attrs ? version)) { 192| name = "${attrs.pname}-${attrs.version}"; | ^ 193| } // (lib.optionalAttrs (stdenv.hostPlatform != stdenv.buildPlatform && !dontAddHostSuffix && (attrs ? name || (attrs ? pname && attrs ? version)))) { Example after: error: assertion 'false' failed at: (7:7) in file: /home/eelco/Dev/nixpkgs/pkgs/applications/misc/hello/default.nix 6| 7| x = assert false; 1; | ^ 8| … while evaluating the attribute 'x' of the derivation 'hello-2.10' at: (192:11) in file: /home/eelco/Dev/nixpkgs/pkgs/stdenv/generic/make-derivation.nix 191| // (lib.optionalAttrs (!(attrs ? name) && attrs ? pname && attrs ? version)) { 192| name = "${attrs.pname}-${attrs.version}"; | ^ 193| } // (lib.optionalAttrs (stdenv.hostPlatform != stdenv.buildPlatform && !dontAddHostSuffix && (attrs ? name || (attrs ? pname && attrs ? version)))) {
2021-01-20 23:27:36 +00:00
: err { .level = lvlError, .msg = hintfmt(args...) }
2020-04-26 20:47:41 +00:00
, status(status)
2020-04-30 00:57:05 +00:00
{ }
2020-04-26 20:47:41 +00:00
template<typename... Args>
BaseError(const std::string & fs, const Args & ... args)
Improve error formatting Changes: * The divider lines are gone. These were in practice a bit confusing, in particular with --show-trace or --keep-going, since then there were multiple lines, suggesting a start/end which wasn't the case. * Instead, multi-line error messages are now indented to align with the prefix (e.g. "error: "). * The 'description' field is gone since we weren't really using it. * 'hint' is renamed to 'msg' since it really wasn't a hint. * The error is now printed *before* the location info. * The 'name' field is no longer printed since most of the time it wasn't very useful since it was just the name of the exception (like EvalError). Ideally in the future this would be a unique, easily googleable error ID (like rustc). * "trace:" is now just "…". This assumes error contexts start with something like "while doing X". Example before: error: --- AssertionError ---------------------------------------------------------------------------------------- nix at: (7:7) in file: /home/eelco/Dev/nixpkgs/pkgs/applications/misc/hello/default.nix 6| 7| x = assert false; 1; | ^ 8| assertion 'false' failed ----------------------------------------------------- show-trace ----------------------------------------------------- trace: while evaluating the attribute 'x' of the derivation 'hello-2.10' at: (192:11) in file: /home/eelco/Dev/nixpkgs/pkgs/stdenv/generic/make-derivation.nix 191| // (lib.optionalAttrs (!(attrs ? name) && attrs ? pname && attrs ? version)) { 192| name = "${attrs.pname}-${attrs.version}"; | ^ 193| } // (lib.optionalAttrs (stdenv.hostPlatform != stdenv.buildPlatform && !dontAddHostSuffix && (attrs ? name || (attrs ? pname && attrs ? version)))) { Example after: error: assertion 'false' failed at: (7:7) in file: /home/eelco/Dev/nixpkgs/pkgs/applications/misc/hello/default.nix 6| 7| x = assert false; 1; | ^ 8| … while evaluating the attribute 'x' of the derivation 'hello-2.10' at: (192:11) in file: /home/eelco/Dev/nixpkgs/pkgs/stdenv/generic/make-derivation.nix 191| // (lib.optionalAttrs (!(attrs ? name) && attrs ? pname && attrs ? version)) { 192| name = "${attrs.pname}-${attrs.version}"; | ^ 193| } // (lib.optionalAttrs (stdenv.hostPlatform != stdenv.buildPlatform && !dontAddHostSuffix && (attrs ? name || (attrs ? pname && attrs ? version)))) {
2021-01-20 23:27:36 +00:00
: err { .level = lvlError, .msg = hintfmt(fs, args...) }
2020-04-30 00:57:05 +00:00
{ }
2020-04-26 20:47:41 +00:00
BaseError(hintformat hint)
Improve error formatting Changes: * The divider lines are gone. These were in practice a bit confusing, in particular with --show-trace or --keep-going, since then there were multiple lines, suggesting a start/end which wasn't the case. * Instead, multi-line error messages are now indented to align with the prefix (e.g. "error: "). * The 'description' field is gone since we weren't really using it. * 'hint' is renamed to 'msg' since it really wasn't a hint. * The error is now printed *before* the location info. * The 'name' field is no longer printed since most of the time it wasn't very useful since it was just the name of the exception (like EvalError). Ideally in the future this would be a unique, easily googleable error ID (like rustc). * "trace:" is now just "…". This assumes error contexts start with something like "while doing X". Example before: error: --- AssertionError ---------------------------------------------------------------------------------------- nix at: (7:7) in file: /home/eelco/Dev/nixpkgs/pkgs/applications/misc/hello/default.nix 6| 7| x = assert false; 1; | ^ 8| assertion 'false' failed ----------------------------------------------------- show-trace ----------------------------------------------------- trace: while evaluating the attribute 'x' of the derivation 'hello-2.10' at: (192:11) in file: /home/eelco/Dev/nixpkgs/pkgs/stdenv/generic/make-derivation.nix 191| // (lib.optionalAttrs (!(attrs ? name) && attrs ? pname && attrs ? version)) { 192| name = "${attrs.pname}-${attrs.version}"; | ^ 193| } // (lib.optionalAttrs (stdenv.hostPlatform != stdenv.buildPlatform && !dontAddHostSuffix && (attrs ? name || (attrs ? pname && attrs ? version)))) { Example after: error: assertion 'false' failed at: (7:7) in file: /home/eelco/Dev/nixpkgs/pkgs/applications/misc/hello/default.nix 6| 7| x = assert false; 1; | ^ 8| … while evaluating the attribute 'x' of the derivation 'hello-2.10' at: (192:11) in file: /home/eelco/Dev/nixpkgs/pkgs/stdenv/generic/make-derivation.nix 191| // (lib.optionalAttrs (!(attrs ? name) && attrs ? pname && attrs ? version)) { 192| name = "${attrs.pname}-${attrs.version}"; | ^ 193| } // (lib.optionalAttrs (stdenv.hostPlatform != stdenv.buildPlatform && !dontAddHostSuffix && (attrs ? name || (attrs ? pname && attrs ? version)))) {
2021-01-20 23:27:36 +00:00
: err { .level = lvlError, .msg = hint }
{ }
BaseError(ErrorInfo && e)
: err(std::move(e))
{ }
BaseError(const ErrorInfo & e)
2020-04-26 20:47:41 +00:00
: err(e)
2020-04-30 00:57:05 +00:00
{ }
2020-04-29 03:06:08 +00:00
virtual const char* sname() const { return "BaseError"; }
2020-04-26 20:47:41 +00:00
#ifdef EXCEPTION_NEEDS_THROW_SPEC
~BaseError() throw () { };
2020-05-07 22:43:36 +00:00
const char * what() const throw () { return calcWhat().c_str(); }
2020-04-26 20:47:41 +00:00
#else
2020-05-07 22:43:36 +00:00
const char * what() const noexcept override { return calcWhat().c_str(); }
2020-04-26 20:47:41 +00:00
#endif
2020-05-07 22:43:36 +00:00
const string & msg() const { return calcWhat(); }
2020-10-07 14:33:19 +00:00
const ErrorInfo & info() const { calcWhat(); return err; }
2020-06-24 19:10:41 +00:00
2020-06-24 19:46:25 +00:00
template<typename... Args>
BaseError & addTrace(std::optional<ErrPos> e, const string &fs, const Args & ... args)
{
return addTrace(e, hintfmt(fs, args...));
}
2020-06-24 19:10:41 +00:00
BaseError & addTrace(std::optional<ErrPos> e, hintformat hint);
bool hasTrace() const { return !err.traces.empty(); }
2020-04-07 01:43:22 +00:00
};
2020-04-26 20:47:41 +00:00
#define MakeError(newClass, superClass) \
class newClass : public superClass \
{ \
public: \
using superClass::superClass; \
2020-04-29 03:06:08 +00:00
virtual const char* sname() const override { return #newClass; } \
2020-04-26 20:47:41 +00:00
}
2020-04-08 15:07:58 +00:00
2020-04-26 20:47:41 +00:00
MakeError(Error, BaseError);
MakeError(UsageError, Error);
MakeError(UnimplementedError, Error);
2020-04-26 20:47:41 +00:00
class SysError : public Error
2020-04-02 22:02:40 +00:00
{
2020-04-26 20:47:41 +00:00
public:
int errNo;
2020-03-24 15:18:23 +00:00
2020-04-26 20:47:41 +00:00
template<typename... Args>
SysError(const Args & ... args)
2020-06-18 21:25:26 +00:00
: Error("")
2020-05-06 20:07:20 +00:00
{
errNo = errno;
auto hf = hintfmt(args...);
Improve error formatting Changes: * The divider lines are gone. These were in practice a bit confusing, in particular with --show-trace or --keep-going, since then there were multiple lines, suggesting a start/end which wasn't the case. * Instead, multi-line error messages are now indented to align with the prefix (e.g. "error: "). * The 'description' field is gone since we weren't really using it. * 'hint' is renamed to 'msg' since it really wasn't a hint. * The error is now printed *before* the location info. * The 'name' field is no longer printed since most of the time it wasn't very useful since it was just the name of the exception (like EvalError). Ideally in the future this would be a unique, easily googleable error ID (like rustc). * "trace:" is now just "…". This assumes error contexts start with something like "while doing X". Example before: error: --- AssertionError ---------------------------------------------------------------------------------------- nix at: (7:7) in file: /home/eelco/Dev/nixpkgs/pkgs/applications/misc/hello/default.nix 6| 7| x = assert false; 1; | ^ 8| assertion 'false' failed ----------------------------------------------------- show-trace ----------------------------------------------------- trace: while evaluating the attribute 'x' of the derivation 'hello-2.10' at: (192:11) in file: /home/eelco/Dev/nixpkgs/pkgs/stdenv/generic/make-derivation.nix 191| // (lib.optionalAttrs (!(attrs ? name) && attrs ? pname && attrs ? version)) { 192| name = "${attrs.pname}-${attrs.version}"; | ^ 193| } // (lib.optionalAttrs (stdenv.hostPlatform != stdenv.buildPlatform && !dontAddHostSuffix && (attrs ? name || (attrs ? pname && attrs ? version)))) { Example after: error: assertion 'false' failed at: (7:7) in file: /home/eelco/Dev/nixpkgs/pkgs/applications/misc/hello/default.nix 6| 7| x = assert false; 1; | ^ 8| … while evaluating the attribute 'x' of the derivation 'hello-2.10' at: (192:11) in file: /home/eelco/Dev/nixpkgs/pkgs/stdenv/generic/make-derivation.nix 191| // (lib.optionalAttrs (!(attrs ? name) && attrs ? pname && attrs ? version)) { 192| name = "${attrs.pname}-${attrs.version}"; | ^ 193| } // (lib.optionalAttrs (stdenv.hostPlatform != stdenv.buildPlatform && !dontAddHostSuffix && (attrs ? name || (attrs ? pname && attrs ? version)))) {
2021-01-20 23:27:36 +00:00
err.msg = hintfmt("%1%: %2%", normaltxt(hf.str()), strerror(errNo));
2020-05-06 20:07:20 +00:00
}
2020-03-27 16:03:02 +00:00
2020-05-06 20:07:20 +00:00
virtual const char* sname() const override { return "SysError"; }
2020-04-26 20:47:41 +00:00
};
2020-03-27 16:03:02 +00:00
}