test/py: support running sandbox under gdbserver
[platform/kernel/u-boot.git] / test / py / u_boot_console_sandbox.py
1 # Copyright (c) 2015 Stephen Warren
2 # Copyright (c) 2015-2016, NVIDIA CORPORATION. All rights reserved.
3 #
4 # SPDX-License-Identifier: GPL-2.0
5
6 # Logic to interact with the sandbox port of U-Boot, running as a sub-process.
7
8 import time
9 from u_boot_spawn import Spawn
10 from u_boot_console_base import ConsoleBase
11
12 class ConsoleSandbox(ConsoleBase):
13     """Represents a connection to a sandbox U-Boot console, executed as a sub-
14     process."""
15
16     def __init__(self, log, config):
17         """Initialize a U-Boot console connection.
18
19         Args:
20             log: A multiplexed_log.Logfile instance.
21             config: A "configuration" object as defined in conftest.py.
22
23         Returns:
24             Nothing.
25         """
26
27         super(ConsoleSandbox, self).__init__(log, config, max_fifo_fill=1024)
28
29     def get_spawn(self):
30         """Connect to a fresh U-Boot instance.
31
32         A new sandbox process is created, so that U-Boot begins running from
33         scratch.
34
35         Args:
36             None.
37
38         Returns:
39             A u_boot_spawn.Spawn object that is attached to U-Boot.
40         """
41
42         cmd = []
43         if self.config.gdbserver:
44             cmd += ['gdbserver', self.config.gdbserver]
45         cmd += [
46             self.config.build_dir + '/u-boot',
47             '-d',
48             self.config.build_dir + '/arch/sandbox/dts/test.dtb'
49         ]
50         return Spawn(cmd, cwd=self.config.source_dir)
51
52     def kill(self, sig):
53         """Send a specific Unix signal to the sandbox process.
54
55         Args:
56             sig: The Unix signal to send to the process.
57
58         Returns:
59             Nothing.
60         """
61
62         self.log.action('kill %d' % sig)
63         self.p.kill(sig)
64
65     def validate_exited(self):
66         """Determine whether the sandbox process has exited.
67
68         If required, this function waits a reasonable time for the process to
69         exit.
70
71         Args:
72             None.
73
74         Returns:
75             Boolean indicating whether the process has exited.
76         """
77
78         p = self.p
79         self.p = None
80         for i in xrange(100):
81             ret = not p.isalive()
82             if ret:
83                 break
84             time.sleep(0.1)
85         p.close()
86         return ret