Skip to content

Add configurable retry count for busy response handling #5001

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
polybassa wants to merge 1 commit into
base: master
Choose a base branch
from
+39 −4
Open

Add configurable retry count for busy response handling #5001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions scapy/contrib/automotive/scanner/enumerator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ class ServiceEnumerator(AutomotiveTestCase, metaclass=abc.ABCMeta):
'exit_if_service_not_supported': (bool, None),
'exit_scan_on_first_negative_response': (bool, None),
'retry_if_busy_returncode': (bool, None),
'retry_if_busy_returncode_count': (int, lambda x: x >= 0),
'stop_event': (threading.Event, None),
'debug': (bool, None),
'scan_range': ((list, tuple, range), None),
Expand Down Expand Up @@ -118,6 +119,10 @@ class ServiceEnumerator(AutomotiveTestCase, metaclass=abc.ABCMeta):
:param bool retry_if_busy_returncode: Specifies to retry a request, if
the 'busyRepeatRequest' negative
response code is received.
:param int retry_if_busy_returncode_count: Number of retries if a
'busyRepeatRequest' negative
response code is received.
Default is 3.
:param bool debug: Enables debug functions during execute.
:param Event stop_event: Signals immediate stop of the execution.
:param scan_range: Specifies the identifiers to be scanned.
Expand All @@ -135,6 +140,7 @@ def __init__(self):
self._results = list() # type: List[_AutomotiveTestCaseScanResult]
self._request_iterators = dict() # type: Dict[EcuState, Iterable[Packet]] # noqa: E501
self._retry_pkt = defaultdict(list) # type: Dict[EcuState, Union[Packet, Iterable[Packet]]] # noqa: E501
self._busy_repeat_request_count = defaultdict(int) # type: Dict[EcuState, int] # noqa: E501
self._negative_response_blacklist = [0x10, 0x11] # type: List[int]
self._requests_per_state_estimated = None # type: Optional[int]
self._tester_present_sender = None # type: Optional[PeriodicSenderThread]
Expand Down Expand Up @@ -507,13 +513,27 @@ def _evaluate_retry(self,
): # type: (...) -> bool
retry_if_busy_returncode = \
kwargs.pop("retry_if_busy_returncode", True)
retry_if_busy_returncode_count = \
kwargs.pop("retry_if_busy_returncode_count", 3)

if retry_if_busy_returncode and response.service == 0x7f \
and self._get_negative_response_code(response) == 0x21:
log_automotive.debug(
"Retry %s because retry_if_busy_returncode received",
repr(request))
return self._populate_retry(state, request)
if self._busy_repeat_request_count[state] < \
retry_if_busy_returncode_count:
self._busy_repeat_request_count[state] += 1
self._retry_pkt[state] = request
log_automotive.debug(
"Retry %s because retry_if_busy_returncode received",
repr(request))
return True
else:
log_automotive.debug(
"Max busy repeat retries (%d) exceeded for %s",
retry_if_busy_returncode_count, repr(request))
self._busy_repeat_request_count[state] = 0
return False

self._busy_repeat_request_count[state] = 0
return False

def _compute_statistics(self):
Expand Down
15 changes: 15 additions & 0 deletions test/contrib/automotive/scanner/enumerator.uts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,10 +175,25 @@ assert False == e._evaluate_response(EcuState(session=1), UDS(b"\x10\x03abcd"),
assert False == e._evaluate_response(EcuState(session=1), UDS(b"\x10\x03abcd"), UDS(b"\x7f\x10\x11"), **conf)
assert False == e._evaluate_response(EcuState(session=1), UDS(b"\x10\x03abcd"), UDS(b"\x7f\x10\x7f"), **conf)
assert not e._retry_pkt[EcuState(session=1)]
# Default retry_if_busy_returncode_count=3: three retries before giving up
assert True == e._evaluate_response(EcuState(session=1), UDS(b"\x10\x03abcd"), UDS(b"\x7f\x10\x21"), **conf)
assert e._retry_pkt[EcuState(session=1)] == UDS(b"\x10\x03abcd")
assert True == e._evaluate_response(EcuState(session=1), UDS(b"\x10\x03abcd"), UDS(b"\x7f\x10\x21"), **conf)
assert e._retry_pkt[EcuState(session=1)] == UDS(b"\x10\x03abcd")
assert True == e._evaluate_response(EcuState(session=1), UDS(b"\x10\x03abcd"), UDS(b"\x7f\x10\x21"), **conf)
assert e._retry_pkt[EcuState(session=1)] == UDS(b"\x10\x03abcd")
assert False == e._evaluate_response(EcuState(session=1), UDS(b"\x10\x03abcd"), UDS(b"\x7f\x10\x21"), **conf)
assert not e._retry_pkt[EcuState(session=1)]
# retry_if_busy_returncode_count=1: single retry then give up
conf_count1 = {"retry_if_busy_returncode": True, "retry_if_busy_returncode_count": 1}
assert True == e._evaluate_response(EcuState(session=1), UDS(b"\x10\x03abcd"), UDS(b"\x7f\x10\x21"), **conf_count1)
assert e._retry_pkt[EcuState(session=1)] == UDS(b"\x10\x03abcd")
assert False == e._evaluate_response(EcuState(session=1), UDS(b"\x10\x03abcd"), UDS(b"\x7f\x10\x21"), **conf_count1)
assert not e._retry_pkt[EcuState(session=1)]
# retry_if_busy_returncode_count=0: no retries
conf_count0 = {"retry_if_busy_returncode": True, "retry_if_busy_returncode_count": 0}
assert False == e._evaluate_response(EcuState(session=1), UDS(b"\x10\x03abcd"), UDS(b"\x7f\x10\x21"), **conf_count0)
assert not e._retry_pkt[EcuState(session=1)]

assert True == e._evaluate_response(EcuState(session=1), UDS(b"\x10\x03abcd"), UDS(b"\x50\x03\x00"), **conf)
assert False == e._evaluate_response(EcuState(session=1), UDS(b"\x11\x03abcd"), UDS(b"\x51\x03\x00"), **conf)
Expand Down
Loading