summaryrefslogtreecommitdiffhomepage
path: root/src/output/pe_output_error.c
blob: 33e2b7aa9443f5b2714d9ca41bd4008d0853ca47 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
/***************************************************************/
/*  perk: PE Resource Kit                                      */
/*  Copyright (C) 2015--2016  Z. Gilboa                        */
/*  Released under GPLv2 and GPLv3; see COPYING.PERK.          */
/***************************************************************/

#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <unistd.h>
#include <perk/perk.h>

static const char aclr_reset[]   = "\x1b[0m";
static const char aclr_bold[]    = "\x1b[1m";

static const char aclr_green[]   = "\x1b[32m";
static const char aclr_blue[]    = "\x1b[34m";
static const char aclr_magenta[] = "\x1b[35m";

static const char const * const pe_error_strings[PERK_ERR_CAP] = {
	[PERK_ERR_FLOW_ERROR]      = "flow error: unexpected condition or other",
	[PERK_ERR_FLEE_ERROR]      = "flees and bugs and cats and mice",
	[PERK_ERR_NULL_CONTEXT]    = "null driver or unit context",
	[PERK_ERR_NULL_IMAGE]      = "null image base pointer",
	[PERK_ERR_INVALID_CONTEXT] = "invalid driver or unit context",
	[PERK_ERR_INVALID_IMAGE]   = "invalid PE image",
	[PERK_ERR_IMAGE_SIZE_ZERO] = "PE image size cannot be zero",
	[PERK_ERR_IMAGE_MALFORMED] = "malformed PE image detected",
	[PERK_ERR_BAD_DOS_HEADER]  = "bad DOS header",
	[PERK_ERR_BAD_COFF_HEADER] = "bad COFF header",
	[PERK_ERR_BAD_IMAGE_TYPE]  = "bad PE image type",
};

static const char * pe_output_error_header(const struct pe_error_info * erri)
{
	if (erri->flags & PERK_ERROR_CHILD)
		return "exec error upon";

	else if (erri->flags & PERK_ERROR_TOP_LEVEL)
		return "error logged in";

	else if (erri->flags & PERK_ERROR_NESTED)
		return "< returned to >";

	else
		return "distorted state";
}

static const char * pe_output_strerror(const struct pe_error_info * erri)
{
	if (erri->flags & PERK_ERROR_CUSTOM)
		return ((erri->liberror < 0) || (erri->liberror >= PERK_ERR_CAP))
			? "internal error: please report to the maintainer"
			: pe_error_strings[erri->liberror];

	else if (erri->flags & PERK_ERROR_NESTED)
		return "";

	else if (erri->flags & PERK_ERROR_CHILD)
		return "(see child process error messages)";

	else if (erri->syserror == ENOBUFS)
		return "input error: string length exceeds buffer size.";

	else
		return strerror(erri->syserror);
}

static int pe_output_error_record_plain(
	const struct pe_driver_ctx *	dctx,
	const struct pe_error_info *	erri)
{
	const char * errdesc = pe_output_strerror(erri);

	if (fprintf(stderr,"%s: %s %s(), line %d%s%s.\n",
			dctx->program,
			pe_output_error_header(erri),
			erri->function,
			erri->line,
			strlen(errdesc) ? ": " : "",
			errdesc) < 0)
		return -1;

	return fflush(stderr);
}

static int pe_output_error_record_annotated(
	const struct pe_driver_ctx *	dctx,
	const struct pe_error_info *	erri)
{
	const char * errdesc = pe_output_strerror(erri);

	if (fprintf(
			stderr,
			"%s%s%s:%s %s%s%s %s%s%s()%s, %s%sline %d%s%s%s%s%s.\n",

			aclr_bold,aclr_magenta,
			dctx->program,
			aclr_reset,

			aclr_bold,
			pe_output_error_header(erri),
			aclr_reset,

			aclr_bold,aclr_blue,
			erri->function,
			aclr_reset,

			aclr_bold,aclr_green,
			erri->line,
			aclr_reset,
			strlen(errdesc) ? ": " : "",

			aclr_bold,
			pe_output_strerror(erri),
			aclr_reset) < 0)
		return -1;

	return fflush(stderr);
}

int pe_output_error_record(
	const struct pe_driver_ctx *	dctx,
	const struct pe_error_info *	erri)
{
	if (dctx->cctx->drvflags & PERK_DRIVER_ANNOTATE_NEVER)
		return pe_output_error_record_plain(dctx,erri);

	else if (dctx->cctx->drvflags & PERK_DRIVER_ANNOTATE_ALWAYS)
		return pe_output_error_record_annotated(dctx,erri);

	else if (isatty(STDERR_FILENO))
		return pe_output_error_record_annotated(dctx,erri);

	else
		return pe_output_error_record_plain(dctx,erri);
}

static int pe_output_error_vector_plain(const struct pe_driver_ctx * dctx)
{
	struct pe_error_info ** perr;

	for (perr=dctx->errv; *perr; perr++)
		if (pe_output_error_record_plain(dctx,*perr))
			return -1;

	return 0;
}

static int pe_output_error_vector_annotated(const struct pe_driver_ctx * dctx)
{
	struct pe_error_info ** perr;

	for (perr=dctx->errv; *perr; perr++)
		if (pe_output_error_record_annotated(dctx,*perr))
			return -1;

	return 0;
}

int pe_output_error_vector(const struct pe_driver_ctx * dctx)
{
	if (dctx->cctx->drvflags & PERK_DRIVER_ANNOTATE_NEVER)
		return pe_output_error_vector_plain(dctx);

	else if (dctx->cctx->drvflags & PERK_DRIVER_ANNOTATE_ALWAYS)
		return pe_output_error_vector_annotated(dctx);

	else if (isatty(STDERR_FILENO))
		return pe_output_error_vector_annotated(dctx);

	else
		return pe_output_error_vector_plain(dctx);
}