Skip to content
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.

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

Handle PermissionErrors on downlink #150

Merged
merged 3 commits into from
Nov 15, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
1 change: 1 addition & 0 deletions .github/actions/spelling/expect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -572,6 +572,7 @@ Smath
SNDHWM
socketserver
sorttable
spam
sphinxcontrib
splitext
squashify
Expand Down
25 changes: 19 additions & 6 deletions src/fprime_gds/common/files/downlinker.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ def __init__(self, directory, timeout=20.0, log_dir=None):
self.sequence = 0 # Keeps track of what the current sequence ID should be
self.timer = fprime_gds.common.files.helpers.Timeout()
self.timer.setup(self.timeout, timeout)
os.makedirs(self.__directory, exist_ok=True)
LeStarch marked this conversation as resolved.
Show resolved Hide resolved

def data_callback(self, data, sender=None):
"""
Expand Down Expand Up @@ -96,7 +95,15 @@ def handle_start(self, data):
size,
self.__log_dir,
)
self.active.open(TransmitFileState.WRITE)
try:
self.active.open(TransmitFileState.WRITE)
except PermissionError as exc:
self.state = FileStates.ERROR
LOGGER.warning(
"Unable to open file for writing. Discarding subsequent downlink packets. "
+ str(exc)
)
return
LOGGER.addHandler(self.active.log_handler)
message = "Received START packet with metadata:\n"
message += "\tSize: %d\n"
Expand All @@ -116,7 +123,10 @@ def handle_data(self, data):
# Initialize all relevant DATA packet attributes into variables from file_data
offset = data.offset
if self.state != FileStates.RUNNING:
LOGGER.warning("Received unexpected data packet for offset: %d", offset)
# ERROR state means GDS is not ready to receive data packets (permission error)
# No need to log this, as it is already logged in handle_start and would only spam logs
if self.state != FileStates.ERROR:
LOGGER.warning("Received unexpected data packet for offset: %d", offset)
else:
if data.seqID != self.sequence:
LOGGER.warning(
Expand Down Expand Up @@ -156,9 +166,10 @@ def handle_end(self, data):
"""
# Initialize all relevant END packet attributes into variables from file_data
# hashValue attribute is not relevant right now, but might be in the future
if self.state != FileStates.RUNNING:
LOGGER.warning("Received unexpected END packet")
else:
if self.state == FileStates.ERROR:
LOGGER.info("Received END packet for discarded downlink")
self.finish()
elif self.state == FileStates.RUNNING:
if data.seqID != self.sequence:
LOGGER.warning(
"End packet has unexpected sequence id. Expected: %d got %d",
Expand All @@ -167,6 +178,8 @@ def handle_end(self, data):
)
LOGGER.info("Received END packet, finishing downlink")
self.finish()
else:
LOGGER.warning("Received unexpected END packet")

def timeout(self):
"""Timeout the current downlink"""
Expand Down
1 change: 1 addition & 0 deletions src/fprime_gds/common/files/helpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ class FileStates(enum.Enum):
RUNNING = 1
CANCELED = 2
END_WAIT = 3 # Waiting for the handshake for CANCEL or END packet
ERROR = 4


class CFDPChecksum:
Expand Down
6 changes: 6 additions & 0 deletions src/fprime_gds/common/pipeline/files.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

@author mstarch
"""
import os
import fprime_gds.common.files.downlinker
import fprime_gds.common.files.uplinker

Expand Down Expand Up @@ -41,6 +42,11 @@ def setup_file_handling(
)
file_decoder.register(self.__downlinker)
distributor.register("FW_PACKET_HAND", self.__uplinker)
if not os.access(down_store, os.W_OK):
thomas-bc marked this conversation as resolved.
Show resolved Hide resolved
print(
f"[WARNING] {down_store} is not writable. Downlinker will not be able to save files."
" Fix permissions or change storage directory with --file-storage-directory"
)

@property
def uplinker(self):
Expand Down
Loading