aboutsummaryrefslogtreecommitdiffstats
path: root/test/debug.py
blob: d77fd87f3e5a6764479a5eeff49672f8920cefb0 (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
""" debug utilities """

import os
import pexpect
import sys

from sanity_run_vpp import SanityTestCase
from shutil import rmtree
from config import available_cpus

gdb_path = "/usr/bin/gdb"


def spawn_gdb(binary_path, core_path):
    if os.path.isfile(gdb_path) and os.access(gdb_path, os.X_OK):
        # automatically attach gdb
        gdb_cmdline = "%s %s %s" % (gdb_path, binary_path, core_path)
        gdb = pexpect.spawn(gdb_cmdline)
        gdb.interact()
        try:
            gdb.terminate(True)
        except:
            pass
        if gdb.isalive():
            raise Exception("GDB refused to die...")
    else:
        sys.stderr.write(
            "Debugger '%s' does not exist or is not an executable..\n" % gdb_path
        )


def start_vpp_in_gdb():
    # here we use SanityTestCase as a dummy to inherit functionality,
    # but any test case class could be used ...
    SanityTestCase.set_debug_flags("attach")
    SanityTestCase.tempdir = SanityTestCase.get_tempdir()
    SanityTestCase.assign_cpus(available_cpus[: SanityTestCase.get_cpus_required()])
    SanityTestCase.setUpConstants()
    vpp_cmdline = SanityTestCase.vpp_cmdline
    print("Hacking cmdline to make VPP interactive.")
    vpp_cmdline.insert(vpp_cmdline.index("nodaemon"), "interactive")
    print("VPP cmdline is %s" % " ".join(vpp_cmdline))
    print("Running GDB.")

    if os.path.isfile(gdb_path) and os.access(gdb_path, os.X_OK):
        gdb_cmdline = "%s --args %s " % (gdb_path, " ".join(vpp_cmdline))
        print("GDB cmdline is %s" % gdb_cmdline)
        gdb = pexpect.spawn(gdb_cmdline)
        gdb.interact()
        try:
            gdb.terminate(True)
        except:
            pass
        if gdb.isalive():
            raise Exception("GDB refused to die...")
    else:
        sys.stderr.write(
            "Debugger '%s' does not exist or is not an executable..\n" % gdb_path
        )
">*args, vlib_rx_or_tx_t); char *t; switch (r) { case VLIB_RX: t = "rx"; break; case VLIB_TX: t = "tx"; break; default: t = "INVALID"; break; } vec_add (s, t, strlen (t)); return s; } u8 * format_vlib_read_write (u8 * s, va_list * args) { vlib_rx_or_tx_t r = va_arg (*args, vlib_rx_or_tx_t); char *t; switch (r) { case VLIB_READ: t = "read"; break; case VLIB_WRITE: t = "write"; break; default: t = "INVALID"; break; } vec_add (s, t, strlen (t)); return s; } /* Formats buffer data as printable ascii or as hex. */ u8 * format_vlib_buffer_data (u8 * s, va_list * args) { u8 *data = va_arg (*args, u8 *); u32 n_data_bytes = va_arg (*args, u32); u32 i, is_printable; is_printable = 1; for (i = 0; i < n_data_bytes && is_printable; i++) { u8 c = data[i]; if (c < 0x20) is_printable = 0; else if (c >= 0x7f) is_printable = 0; } if (is_printable) vec_add (s, data, n_data_bytes); else s = format (s, "%U", format_hex_bytes, data, n_data_bytes); return s; } /* Enable/on => 1; disable/off => 0. */ uword unformat_vlib_enable_disable (unformat_input_t * input, va_list * args) { int *result = va_arg (*args, int *); int enable; if (unformat (input, "enable") || unformat (input, "on")) enable = 1; else if (unformat (input, "disable") || unformat (input, "off")) enable = 0; else return 0; *result = enable; return 1; } /* rx/tx => VLIB_RX/VLIB_TX. */ uword unformat_vlib_rx_tx (unformat_input_t * input, va_list * args) { int *result = va_arg (*args, int *); if (unformat (input, "rx")) *result = VLIB_RX; else if (unformat (input, "tx")) *result = VLIB_TX; else return 0; return 1; } /* Parse an int either %d or 0x%x. */ uword unformat_vlib_number (unformat_input_t * input, va_list * args) { int *result = va_arg (*args, int *); return (unformat (input, "0x%x", result) || unformat (input, "%d", result)); } /* Parse a-zA-Z0-9_ token and hash to value. */ uword unformat_vlib_number_by_name (unformat_input_t * input, va_list * args) { uword *hash = va_arg (*args, uword *); int *result = va_arg (*args, int *); uword *p; u8 *token; int i; if (!unformat_user (input, unformat_token, "a-zA-Z0-9_", &token)) return 0; /* Null terminate. */ if (vec_len (token) > 0 && token[vec_len (token) - 1] != 0) vec_add1 (token, 0); /* Check for exact match. */ p = hash_get_mem (hash, token); if (p) goto done; /* Convert to upper case & try match. */ for (i = 0; i < vec_len (token); i++) if (token[i] >= 'a' && token[i] <= 'z') token[i] = 'A' + token[i] - 'a'; p = hash_get_mem (hash, token); done: vec_free (token); if (p) *result = p[0]; return p != 0; } /* Parse a filename to dump debug info */ uword unformat_vlib_tmpfile (unformat_input_t * input, va_list * args) { u8 **chroot_filename = va_arg (*args, u8 **); u8 *filename; if (!unformat (input, "%s", &filename)) return 0; /* Brain-police user path input */ if (strstr ((char *) filename, "..") || index ((char *) filename, '/')) { vec_free (filename); return 0; } *chroot_filename = format (0, "/tmp/%s%c", filename, 0); vec_free (filename); return 1; } u8 * format_vlib_thread_name (u8 * s, va_list * args) { u32 thread_index = va_arg (*args, u32); if (thread_index == 0) return format (s, "main"); if (thread_index < vec_len (vlib_worker_threads)) return format (s, "%s", vlib_worker_threads[thread_index].name); return s; } u8 * format_vlib_thread_name_and_index (u8 * s, va_list * args) { u32 thread_index = va_arg (*args, u32); return format (s, "%U (%u)", format_vlib_thread_name, thread_index, thread_index); } /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */