forked from wireshark/wireshark
-
Notifications
You must be signed in to change notification settings - Fork 0
/
dftest.c
527 lines (459 loc) · 14.4 KB
/
dftest.c
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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
/* dftest.c
* Shows display filter byte-code, for debugging dfilter routines.
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <[email protected]>
* Copyright 1998 Gerald Combs
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#include <config.h>
#define WS_LOG_DOMAIN LOG_DOMAIN_MAIN
#include <stdlib.h>
#include <stdio.h>
#include <locale.h>
#include <string.h>
#include <errno.h>
#include <glib.h>
#include <ws_exit_codes.h>
#include <epan/epan.h>
#include <epan/timestamp.h>
#include <epan/prefs.h>
#include <epan/dfilter/dfilter.h>
#include <epan/dfilter/dfilter-macro.h>
#ifdef HAVE_PLUGINS
#include <wsutil/plugins.h>
#endif
#include <wsutil/filesystem.h>
#include <wsutil/privileges.h>
#include <wsutil/report_message.h>
#include <wsutil/wslog.h>
#include <wsutil/ws_getopt.h>
#include <wsutil/utf8_entities.h>
#include <wiretap/wtap.h>
#include "ui/util.h"
#include "wsutil/cmdarg_err.h"
#include "ui/failure_message.h"
#include "wsutil/version_info.h"
static int opt_verbose = 0;
static int opt_debug_level = 0; /* currently up to 2 */
static int opt_flex = 0;
static int opt_lemon = 0;
static int opt_syntax_tree = 0;
static int opt_return_vals = 0;
static int opt_timer = 0;
static long opt_optimize = 1;
static int opt_show_types = 0;
static int opt_dump_refs = 0;
static int opt_dump_macros = 0;
static gint64 elapsed_expand = 0;
static gint64 elapsed_compile = 0;
/*
* Report an error in command-line arguments.
*/
static void
dftest_cmdarg_err(const char *fmt, va_list ap)
{
fprintf(stderr, "dftest: ");
vfprintf(stderr, fmt, ap);
fprintf(stderr, "\n");
}
/*
* Report additional information for an error in command-line arguments.
*/
static void
dftest_cmdarg_err_cont(const char *fmt, va_list ap)
{
vfprintf(stderr, fmt, ap);
fprintf(stderr, "\n");
}
static void
putloc(FILE *fp, df_loc_t loc)
{
for (long i = 0; i < loc.col_start; i++) {
fputc(' ', fp);
}
fputc('^', fp);
for (size_t l = loc.col_len; l > 1; l--) {
fputc('~', fp);
}
fputc('\n', fp);
}
WS_NORETURN static void
print_usage(int status)
{
FILE *fp = stdout;
fprintf(fp, "\n");
fprintf(fp, "Usage: dftest [OPTIONS] -- EXPRESSION\n");
fprintf(fp, "Options:\n");
fprintf(fp, " -V, --verbose enable verbose mode\n");
fprintf(fp, " -d, --debug[=N] increase or set debug level\n");
fprintf(fp, " -D set maximum debug level\n");
fprintf(fp, " -f, --flex enable Flex debug trace\n");
fprintf(fp, " -l, --lemon enable Lemon debug trace\n");
fprintf(fp, " -s, --syntax print syntax tree\n");
fprintf(fp, " -m --macros print saved macros\n");
fprintf(fp, " -t, --timer print elapsed compilation time\n");
fprintf(fp, " -r --return-vals return field values for the tree root\n");
fprintf(fp, " -0, --optimize=0 do not optimize (check syntax)\n");
fprintf(fp, " --types show field value types\n");
/* NOTE: References are loaded during runtime and dftest only does compilation.
* Unless some static reference data is hard-coded at compile time during
* development the --refs option to dftest is useless because it will just
* print empty reference vectors. */
fprintf(fp, " --refs dump some runtime data structures\n");
fprintf(fp, " -h, --help display this help and exit\n");
fprintf(fp, " -v, --version print version\n");
fprintf(fp, "\n");
ws_log_print_usage(fp);
exit(status);
}
static void
print_syntax_tree(dfilter_t *df)
{
printf("Syntax tree:\n%s\n\n", dfilter_syntax_tree(df));
}
static void
print_macros(void)
{
if (dfilter_macro_table_count() == 0) {
printf("Macros: (empty)\n\n");
return;
}
struct dfilter_macro_table_iter iter;
const char *name, *text;
dfilter_macro_table_iter_init(&iter);
printf("Macros:\n");
while (dfilter_macro_table_iter_next(&iter, &name, &text)) {
printf(" "UTF8_BULLET" %s:\n", name);
printf(" %s\n", text);
}
printf("\n");
}
static void
print_warnings(dfilter_t *df)
{
guint i;
GPtrArray *deprecated;
int count = 0;
for (GSList *l = dfilter_get_warnings(df); l != NULL; l = l->next) {
printf("\nWarning: %s.", (char *)l->data);
count++;
}
deprecated = dfilter_deprecated_tokens(df);
if (deprecated && deprecated->len) {
for (i = 0; i < deprecated->len; i++) {
const char *token = g_ptr_array_index(deprecated, i);
printf("\nWarning: Deprecated token \"%s\".", token);
count++;
}
}
if (count) {
printf("\n");
}
}
static void
print_elapsed(void)
{
printf("\nElapsed: %"PRId64" µs (%"PRId64" µs + %"PRId64" µs)\n",
elapsed_expand + elapsed_compile,
elapsed_expand,
elapsed_compile);
}
static char *
expand_filter(const char *text)
{
char *expanded = NULL;
df_error_t *err = NULL;
gint64 start;
start = g_get_monotonic_time();
expanded = dfilter_expand(text, &err);
if (expanded == NULL) {
fprintf(stderr, "Error: %s\n", err->msg);
df_error_free(&err);
}
elapsed_expand = g_get_monotonic_time() - start;
return expanded;
}
static gboolean
compile_filter(const char *text, dfilter_t **dfp)
{
unsigned df_flags = 0;
gboolean ok;
df_error_t *df_err = NULL;
gint64 start;
if (opt_optimize > 0)
df_flags |= DF_OPTIMIZE;
if (opt_syntax_tree)
df_flags |= DF_SAVE_TREE;
if (opt_flex)
df_flags |= DF_DEBUG_FLEX;
if (opt_lemon)
df_flags |= DF_DEBUG_LEMON;
if (opt_return_vals)
df_flags |= DF_RETURN_VALUES;
start = g_get_monotonic_time();
ok = dfilter_compile_full(text, dfp, &df_err, df_flags, "dftest");
if (!ok) {
fprintf(stderr, "Error: %s\n", df_err->msg);
if (df_err->loc.col_start >= 0) {
fprintf(stderr, " %s\n ", text);
putloc(stderr, df_err->loc);
}
df_error_free(&df_err);
}
elapsed_compile = g_get_monotonic_time() - start;
return ok;
}
static int
optarg_to_digit(const char *arg)
{
if (strlen(arg) > 1 || !g_ascii_isdigit(*arg)) {
printf("Error: \"%s\" is not a valid number 0-9\n", arg);
print_usage(WS_EXIT_INVALID_OPTION);
}
errno = 0;
int digit = (int)strtol(ws_optarg, NULL, 10);
if (errno) {
printf("Error: %s\n", g_strerror(errno));
print_usage(WS_EXIT_INVALID_OPTION);
}
return digit;
}
int
main(int argc, char **argv)
{
char *configuration_init_error;
char *text = NULL;
char *expanded_text = NULL;
dfilter_t *df = NULL;
int exit_status = EXIT_FAILURE;
/*
* Set the C-language locale to the native environment and set the
* code page to UTF-8 on Windows.
*/
#ifdef _WIN32
setlocale(LC_ALL, ".UTF-8");
#else
setlocale(LC_ALL, "");
#endif
cmdarg_err_init(dftest_cmdarg_err, dftest_cmdarg_err_cont);
/* Initialize log handler early for startup. */
ws_log_init("dftest", vcmdarg_err);
/* Early logging command-line initialization. */
ws_log_parse_args(&argc, argv, vcmdarg_err, 1);
ws_noisy("Finished log init and parsing command line log arguments");
ws_init_version_info("DFTest", NULL, NULL);
const char *optstring = "hvdDflsmrtV0";
static struct ws_option long_options[] = {
{ "help", ws_no_argument, 0, 'h' },
{ "version", ws_no_argument, 0, 'v' },
{ "debug", ws_optional_argument, 0, 'd' },
{ "flex", ws_no_argument, 0, 'f' },
{ "lemon", ws_no_argument, 0, 'l' },
{ "syntax", ws_no_argument, 0, 's' },
{ "macros", ws_no_argument, 0, 'm' },
{ "timer", ws_no_argument, 0, 't' },
{ "verbose", ws_no_argument, 0, 'V' },
{ "return-vals", ws_no_argument, 0, 'r' },
{ "optimize", ws_required_argument, 0, 1000 },
{ "types", ws_no_argument, 0, 2000 },
{ "refs", ws_no_argument, 0, 3000 },
{ NULL, 0, 0, 0 }
};
int opt;
for (;;) {
opt = ws_getopt_long(argc, argv, optstring, long_options, NULL);
if (opt == -1)
break;
switch (opt) {
case 'V':
opt_verbose = 1;
break;
case 'd':
if (ws_optarg) {
opt_debug_level = optarg_to_digit(ws_optarg);
}
else {
opt_debug_level++;
}
opt_show_types = 1;
break;
case 'D':
opt_debug_level = 9;
opt_lemon = 1;
opt_flex = 1;
opt_show_types = 1;
break;
case 'f':
opt_flex = 1;
break;
case 'l':
opt_lemon = 1;
break;
case 's':
opt_syntax_tree = 1;
break;
case 'm':
opt_dump_macros = 1;
break;
case 't':
opt_timer = 1;
break;
case 'r':
opt_return_vals = 1;
break;
case '0':
opt_optimize = 0;
break;
case 1000:
opt_optimize = optarg_to_digit(ws_optarg);
break;
case 2000:
opt_show_types = 1;
break;
case 3000:
opt_dump_refs = 1;
break;
case 'v':
show_version();
exit(EXIT_SUCCESS);
break;
case 'h':
show_help_header(NULL);
print_usage(EXIT_SUCCESS);
break;
case '?':
print_usage(EXIT_FAILURE);
default:
ws_assert_not_reached();
}
}
/* Check for filter on command line. */
if (argv[ws_optind] == NULL) {
/* If not printing macros we need a filter expression to compile. */
if (!opt_dump_macros) {
printf("Error: Missing argument.\n");
print_usage(EXIT_FAILURE);
}
}
/* Set dfilter domain logging. */
if (opt_debug_level > 1) {
ws_log_set_noisy_filter(LOG_DOMAIN_DFILTER);
}
else if (opt_debug_level > 0 || opt_flex || opt_lemon) {
/* Also enable some dfilter logs with flex/lemon traces for context. */
ws_log_set_debug_filter(LOG_DOMAIN_DFILTER);
}
/*
* Get credential information for later use.
*/
init_process_policies();
/*
* Attempt to get the pathname of the directory containing the
* executable file.
*/
configuration_init_error = configuration_init(argv[0], NULL);
if (configuration_init_error != NULL) {
fprintf(stderr, "Error: Can't get pathname of directory containing "
"the dftest program: %s.\n",
configuration_init_error);
g_free(configuration_init_error);
}
static const struct report_message_routines dftest_report_routines = {
failure_message,
failure_message,
open_failure_message,
read_failure_message,
write_failure_message,
cfile_open_failure_message,
cfile_dump_open_failure_message,
cfile_read_failure_message,
cfile_write_failure_message,
cfile_close_failure_message
};
init_report_message("dftest", &dftest_report_routines);
timestamp_set_type(TS_RELATIVE);
timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
/*
* Libwiretap must be initialized before libwireshark is, so that
* dissection-time handlers for file-type-dependent blocks can
* register using the file type/subtype value for the file type.
*/
wtap_init(TRUE);
/* Register all dissectors; we must do this before checking for the
"-g" flag, as the "-g" flag dumps a list of fields registered
by the dissectors, and we must do it before we read the preferences,
in case any dissectors register preferences. */
if (!epan_init(NULL, NULL, TRUE))
goto out;
/* Load libwireshark settings from the current profile. */
epan_load_settings();
/* notify all registered modules that have had any of their preferences
changed either from one of the preferences file or from the command
line that its preferences have changed. */
prefs_apply_all();
if (opt_dump_macros) {
print_macros();
if (argv[ws_optind] == NULL) {
/* No filter expression, we're done. */
exit(EXIT_SUCCESS);
}
}
/* Check again for filter on command line */
if (argv[ws_optind] == NULL) {
printf("Error: Missing argument.\n");
print_usage(EXIT_FAILURE);
}
/* This is useful to prevent confusion with option parsing.
* Skips printing options and argv[0]. */
if (opt_verbose) {
for (int i = ws_optind; i < argc; i++) {
fprintf(stderr, "argv[%d]: %s\n", i, argv[i]);
}
fprintf(stderr, "\n");
}
/* Get filter text */
text = get_args_as_string(argc, argv, ws_optind);
printf("Filter:\n %s\n\n", text);
/* Expand macros. */
expanded_text = expand_filter(text);
if (expanded_text == NULL) {
exit_status = WS_EXIT_INVALID_FILTER;
goto out;
}
if (strcmp(text, expanded_text) != 0)
printf("Filter (after expansion):\n %s\n\n", expanded_text);
/* Compile it */
if (!compile_filter(expanded_text, &df)) {
exit_status = WS_EXIT_INVALID_FILTER;
goto out;
}
/* If logging is enabled add an empty line. */
if (opt_debug_level > 0) {
printf("\n");
}
if (df == NULL) {
printf("Filter is empty.\n");
exit_status = WS_EXIT_INVALID_FILTER;
goto out;
}
if (opt_syntax_tree)
print_syntax_tree(df);
uint16_t dump_flags = 0;
if (opt_show_types)
dump_flags |= DF_DUMP_SHOW_FTYPE;
if (opt_dump_refs)
dump_flags |= DF_DUMP_REFERENCES;
dfilter_dump(stdout, df, dump_flags);
print_warnings(df);
if (opt_timer)
print_elapsed();
exit_status = 0;
out:
epan_cleanup();
dfilter_free(df);
g_free(text);
g_free(expanded_text);
exit(exit_status);
}