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
|
# Copyright 2021 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
"""Device classes to interact with targets via RPC."""
import logging
from pathlib import Path
from types import ModuleType
from typing import Any, Callable, List, Union, Optional
from pw_thread_protos import thread_pb2
from pw_hdlc.rpc import (
HdlcRpcClient,
channel_output,
NoEncodingSingleChannelRpcClient,
RpcClient,
CancellableReader,
)
from pw_log.log_decoder import (
Log,
LogStreamDecoder,
log_decoded_log,
timestamp_parser_ns_since_boot,
)
from pw_log_rpc.rpc_log_stream import LogStreamHandler
from pw_metric import metric_parser
from pw_rpc import callback_client, Channel, console_tools
from pw_thread.thread_analyzer import ThreadSnapshotAnalyzer
from pw_tokenizer import detokenize
from pw_tokenizer.proto import decode_optionally_tokenized
from pw_unit_test.rpc import run_tests as pw_unit_test_run_tests, TestRecord
# Internal log for troubleshooting this tool (the console).
_LOG = logging.getLogger('tools')
DEFAULT_DEVICE_LOGGER = logging.getLogger('rpc_device')
# pylint: disable=too-many-arguments
class Device:
"""Represents an RPC Client for a device running a Pigweed target.
The target must have and RPC support, RPC logging.
Note: use this class as a base for specialized device representations.
"""
# pylint: disable=too-many-instance-attributes
def __init__(
# pylint: disable=too-many-arguments
self,
channel_id: int,
reader: CancellableReader,
write,
proto_library: List[Union[ModuleType, Path]],
detokenizer: Optional[detokenize.Detokenizer] = None,
timestamp_decoder: Optional[Callable[[int], str]] = None,
rpc_timeout_s: float = 5,
time_offset: int = 0,
use_rpc_logging: bool = True,
use_hdlc_encoding: bool = True,
logger: logging.Logger = DEFAULT_DEVICE_LOGGER,
):
self.channel_id = channel_id
self.protos = proto_library
self.detokenizer = detokenizer
self.rpc_timeout_s = rpc_timeout_s
self.time_offset = time_offset
self.logger = logger
self.logger.setLevel(logging.DEBUG) # Allow all device logs through.
callback_client_impl = callback_client.Impl(
default_unary_timeout_s=self.rpc_timeout_s,
default_stream_timeout_s=None,
)
def detokenize_and_log_output(data: bytes, _detokenizer=None):
log_messages = data.decode(
encoding='utf-8', errors='surrogateescape'
)
if self.detokenizer:
log_messages = decode_optionally_tokenized(
self.detokenizer, data
)
for line in log_messages.splitlines():
self.logger.info(line)
self.client: RpcClient
if use_hdlc_encoding:
channels = [Channel(self.channel_id, channel_output(write))]
self.client = HdlcRpcClient(
reader,
self.protos,
channels,
detokenize_and_log_output,
client_impl=callback_client_impl,
)
else:
channel = Channel(self.channel_id, write)
self.client = NoEncodingSingleChannelRpcClient(
reader,
self.protos,
channel,
client_impl=callback_client_impl,
)
if use_rpc_logging:
# Create the log decoder used by the LogStreamHandler.
def decoded_log_handler(log: Log) -> None:
log_decoded_log(log, self.logger)
self._log_decoder = LogStreamDecoder(
decoded_log_handler=decoded_log_handler,
detokenizer=self.detokenizer,
source_name='RpcDevice',
timestamp_parser=(
timestamp_decoder
if timestamp_decoder
else timestamp_parser_ns_since_boot
),
)
# Start listening to logs as soon as possible.
self.log_stream_handler = LogStreamHandler(
self.rpcs, self._log_decoder
)
self.log_stream_handler.listen_to_logs()
def __enter__(self):
return self
def __exit__(self, *exc_info):
self.close()
def close(self) -> None:
self.client.close()
def info(self) -> console_tools.ClientInfo:
return console_tools.ClientInfo('device', self.rpcs, self.client.client)
@property
def rpcs(self) -> Any:
"""Returns an object for accessing services on the specified channel."""
return next(iter(self.client.client.channels())).rpcs
def run_tests(self, timeout_s: Optional[float] = 5) -> TestRecord:
"""Runs the unit tests on this device."""
return pw_unit_test_run_tests(self.rpcs, timeout_s=timeout_s)
def get_and_log_metrics(self) -> dict:
"""Retrieves the parsed metrics and logs them to the console."""
metrics = metric_parser.parse_metrics(
self.rpcs, self.detokenizer, self.rpc_timeout_s
)
def print_metrics(metrics, path):
"""Traverses dictionaries, until a non-dict value is reached."""
for path_name, metric in metrics.items():
if isinstance(metric, dict):
print_metrics(metric, path + '/' + path_name)
else:
_LOG.info('%s/%s: %s', path, path_name, str(metric))
print_metrics(metrics, '')
return metrics
def snapshot_peak_stack_usage(self, thread_name: Optional[str] = None):
snapshot_service = self.rpcs.pw.thread.proto.ThreadSnapshotService
_, rsp = snapshot_service.GetPeakStackUsage(name=thread_name)
thread_info = thread_pb2.SnapshotThreadInfo()
for thread_info_block in rsp:
for thread in thread_info_block.threads:
thread_info.threads.append(thread)
for line in str(ThreadSnapshotAnalyzer(thread_info)).splitlines():
_LOG.info('%s', line)
|
