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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
|
/* ==========================================================================
Licensed under BSD 2clause license See LICENSE file for more information
Author: Michał Łyszczek <michal.lyszczek@bofc.pl>
==========================================================================
-----------------------------------------------------------
/ This module allows caller to print memory in a nice \
| formatted output, there is a little dragon magic here, so |
| be careful and don't wander too far. See this dog? He |
\ wandered a little bit to far /
-----------------------------------------------------------
\ ^ /^
\ / \ // \
\ |\___/| / \// .\
\ /O O \__ / // | \ \ *----*
/ / \/_/ // | \ \ \ |
@___@` \/_ // | \ \ \/\ \
0/0/| \/_ // | \ \ \ \
0/0/0/0/| \/// | \ \ | |
0/0/0/0/0/_|_ / ( // | \ _\ | /
0/0/0/0/0/0/`/,_ _ _/ ) ; -. | _ _\.-~ / /
,-} _ *-.|.-~-. .~ ~
\ \__/ `/\ / ~-. _ .-~ /
\____(oo) *. } { /
( (--) .----~-.\ \-` .~
//__\\ \__ Ack! ///.----..< \ _ -~
// \\ ///-._ _ _ _ _ _ _{^ - - - - ~
==========================================================================
_ __ __ ____ _ __
(_)____ _____ / /__ __ ____/ /___ / __/(_)/ /___ _____
/ // __ \ / ___// // / / // __ // _ \ / /_ / // // _ \ / ___/
/ // / / // /__ / // /_/ // /_/ // __/ / __// // // __/(__ )
/_//_/ /_/ \___//_/ \__,_/ \__,_/ \___/ /_/ /_//_/ \___//____/
========================================================================== */
#include "el-private.h"
#include <ctype.h>
#include <stdio.h>
/* ==========================================================================
_ __ ____
____ _____ (_)_ __ ____ _ / /_ ___ / __/__ __ ____ _____ _____
/ __ \ / ___// /| | / // __ `// __// _ \ / /_ / / / // __ \ / ___// ___/
/ /_/ // / / / | |/ // /_/ // /_ / __/ / __// /_/ // / / // /__ (__ )
/ .___//_/ /_/ |___/ \__,_/ \__/ \___/ /_/ \__,_//_/ /_/ \___//____/
/_/
========================================================================== */
/* ==========================================================================
prints single memory line, example line can look like this:
0x0020: 6e 20 70 72 69 6e 74 61 62 6c 65 09 63 68 61 72 n printable.char
========================================================================== */
static int el_print_line
(
const char *file, /* file name where log is printed */
size_t num, /* line number where log is printed */
const char *func, /* function name to print */
enum el_level level, /* log level to print message with */
struct el *el, /* el defining printing style */
const unsigned char *buf, /* memory location to print */
size_t line_size, /* size of line in bytes */
size_t line_number /* line number beign processed */
)
{
/* buffers to hold whole line of bytes representation in hex
* and char
*/
char hex_data[EL_MEM_HEX_LEN + 1] = {0};
char char_data[EL_MEM_CHAR_LEN + 1] = {0};
/* calculate buf offset value
*/
const unsigned int offset = EL_MEM_LINE_SIZE * line_number;
/* fill data buffers with representation of bytes
*/
size_t bn; /* byte number */
for (bn = 0; bn < line_size; ++bn)
{
unsigned char current_byte;
char *current_hex_pos;
char *current_char_pos;
/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
current_byte = *buf++;
current_hex_pos = hex_data + bn * EL_MEM_SINGLE_HEX_LEN;
current_char_pos = char_data + bn;
sprintf(current_hex_pos, "%02x ", current_byte);
if (isprint(current_byte) == 0)
{
current_byte = '.';
}
*current_char_pos = current_byte;
}
/* print constructed line
*/
return el_oprint_nb(file, num, func, level, el, "0x%04x %-*s %s",
offset, EL_MEM_HEX_LEN, hex_data, char_data);
}
/* ==========================================================================
Function prints byte from memory location in a nice format.
Single line of data printed will be formated like this (please note,
that this is documented for lines that shows only 16 bytes in a line,
this value can be changed in compile time only).
0xNNNN HH HH HH HH HH HH HH HH HH HH HH HH HH HH HH HH CCCCCCCCCCCCCCCC
Where
NNNN Adress of the first byte in line
HH Byte value in hex representation
C Character representation of the byte (or '.' if not printable)
First 8 bytes are fixed, and consists of offset from the first byte and
' ' (2 spaces). Next bytes are counted from formula 3*EL_MEM_LINE_SIZE
(3 bytes are for 2 hex characters and a space). Next there is 2 bytes
for space, and EL_MEM_LINE_SIZE bytes for character representation
If table is set to 1, table will be printed, and message will look like:
------ ----------------------------------------------- ----------------
offset hex ascii
------ ----------------------------------------------- ----------------
0xNNNN HH HH HH HH HH HH HH HH HH HH HH HH HH HH HH HH CCCCCCCCCCCCCCCC
------ ----------------------------------------------- ----------------
========================================================================== */
static int el_pmem
(
const char *file, /* file name where log is printed */
size_t num, /* line number where log is printed */
const char *func, /* function name to print */
enum el_level level, /* log level to print message with */
struct el *el, /* el defining printing style */
const void *mem, /* memory location to print */
size_t mlen, /* number of bytes to print */
int table /* print table? or not to print table? */
)
{
/* String needed to print separator for array-like formating
*/
static const char *separator =
"-----------------------------------------------------------------------------";
/* calculate some constants for this call based on mlen
*/
const size_t msg_size = mlen;
const size_t lines_count = msg_size / EL_MEM_LINE_SIZE;
const size_t last_line_size = msg_size % EL_MEM_LINE_SIZE;
size_t line_number; /* current line number being printed */
int rv; /* return value of print functions */
/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
rv = 0;
/* let's first check if logs are enabled for passed level, if
* not, there is no need to waste cycles on useless string
* preparation
*/
VALID(EINVAL, mem);
VALID(EINVAL, mlen);
VALID(EINVAL, el);
el_lock(el);
VALIDC(ERANGE, el_log_allowed(el, level), el_unlock(el));
/* print log table preamble that is:
*
* ------ ----------------------------------------------- ----------------
* offset hex ascii
* ------ ----------------------------------------------- ----------------
*/
if (table)
{
rv = 0;
rv |= el_oprint_nb(file, num, func, level, el, "%.*s %.*s %.*s",
EL_MEM_OFFSET_LEN - 2, separator,
EL_MEM_HEX_LEN - 1, separator,
EL_MEM_CHAR_LEN, separator);
rv |= el_oprint_nb(file, num, func, level, el, "%-*s%-*s%s",
EL_MEM_OFFSET_LEN, "offset",
EL_MEM_HEX_LEN + 1, "hex", "ascii");
rv |= el_oprint_nb(file, num, func, level, el, "%.*s %.*s %.*s",
EL_MEM_OFFSET_LEN - 2, separator,
EL_MEM_HEX_LEN - 1, separator,
EL_MEM_CHAR_LEN, separator);
}
/* print all lines that contains EL_MEM_LINE_SIZE bytes,
* meaning we print all whole lines
*/
for (line_number = 0; line_number < lines_count; ++line_number)
{
rv |= el_print_line(file, num, func, level, el,
mem, EL_MEM_LINE_SIZE, line_number);
/* move memory pointer to point to next chunk of data to
* print
*/
mem = (const unsigned char *)mem + EL_MEM_LINE_SIZE;
}
/* if buflen is not divisible by EL_MEM_LINE_SIZE we still need
* to print last line which has less bytes then
* EL_MEM_LINE_SIZE.
*/
if (last_line_size)
{
rv |= el_print_line(file, num, func, level, el,
mem, last_line_size, line_number);
}
/* print ending line
*
* ------ ----------------------------------------------- ----------------
*/
if (table)
{
rv |= el_oprint_nb(file, num, func, level, el, "%.*s %.*s %.*s",
EL_MEM_OFFSET_LEN - 2, separator,
EL_MEM_HEX_LEN - 1, separator,
EL_MEM_CHAR_LEN, separator);
}
el_unlock(el);
return rv;
}
/* ==========================================================================
__ __ _ ____
____ __ __ / /_ / /(_)_____ / __/__ __ ____ _____ _____
/ __ \ / / / // __ \ / // // ___/ / /_ / / / // __ \ / ___// ___/
/ /_/ // /_/ // /_/ // // // /__ / __// /_/ // / / // /__ (__ )
/ .___/ \__,_//_.___//_//_/ \___/ /_/ \__,_//_/ /_/ \___//____/
/_/
========================================================================== */
/* ==========================================================================
same as el_pmem and prints table
========================================================================== */
/* public api */ int el_opmemory_table
(
const char *file, /* file name where log is printed */
size_t num, /* line number where log is printed */
const char *func, /* function name to print */
enum el_level level, /* log level to print message with */
struct el *el, /* el defining printing style */
const void *mem, /* memory location to print */
size_t mlen /* number of bytes to print */
)
{
return el_pmem(file, num, func, level, el, mem, mlen, 1);
}
/* ==========================================================================
same as el_opmemory_table but uses default option object
========================================================================== */
/* public api */ int el_pmemory_table
(
const char *file, /* file name where log is printed */
size_t num, /* line number where log is printed */
const char *func, /* function name to print */
enum el_level level, /* log level to print message with */
const void *mem, /* memory location to print */
size_t mlen /* number of bytes to print */
)
{
return el_opmemory_table(file, num, func, level, &g_el, mem, mlen);
}
/* ==========================================================================
Same as el_pmem and prints no table
========================================================================== */
/* public api */ int el_opmemory
(
const char *file, /* file name where log is printed */
size_t num, /* line number where log is printed */
const char *func, /* function name to print */
enum el_level level, /* log level to print message with */
struct el *el, /* el defining printing style */
const void *mem, /* memory location to print */
size_t mlen /* number of bytes to print */
)
{
return el_pmem(file, num, func, level, el, mem, mlen, 0);
}
/* ==========================================================================
same as el_opmemory but uses default option object
========================================================================== */
/* public api */ int el_pmemory
(
const char *file, /* file name where log is printed */
size_t num, /* line number where log is printed */
const char *func, /* function name to print */
enum el_level level, /* log level to print message with */
const void *mem, /* memory location to print */
size_t mlen /* number of bytes to print */
)
{
return el_opmemory(file, num, func, level, &g_el, mem, mlen);
}
|
