chore: Improve status code checks

src/internal_modules/roc_audio/fanout.cpp

@@ -9,6 +9,7 @@
 #include "roc_audio/fanout.h"
 #include "roc_audio/sample_spec_to_str.h"
 #include "roc_core/panic.h"
+#include "roc_status/code_to_str.h"
 
 namespace roc {
 namespace audio {
@@ -53,7 +54,14 @@ status::StatusCode Fanout::write(Frame& in_frame) {
     for (IFrameWriter* writer = frame_writers_.front(); writer != NULL;
          writer = frame_writers_.nextof(*writer)) {
         const status::StatusCode code = writer->write(in_frame);
+
         if (code != status::StatusOK) {
+            // These codes can be returned only from read().
+            roc_panic_if_msg(
+                code == status::StatusPart || code == status::StatusDrain,
+                "fanout loop: unexpected status from write operation: status=%s",
+                status::code_to_str(code));
+
             return code;
         }
     }

src/internal_modules/roc_pipeline/receiver_loop.cpp

@@ -224,6 +224,9 @@ status::StatusCode ReceiverLoop::read(audio::Frame& frame,
     // invokes process_subframe_imp() and process_task_imp()
     const status::StatusCode code = process_subframes_and_tasks(frame, duration, mode);
 
+    roc_panic_if_msg(code <= status::NoStatus || code >= status::MaxStatus,
+                     "receiver loop: invalid status code %d", code);
+
     if (code != status::StatusOK && code != status::StatusPart) {
         return code;
     }

src/internal_modules/roc_pipeline/receiver_session.cpp

@@ -391,6 +391,9 @@ status::StatusCode ReceiverSession::read(audio::Frame& frame,
 
     const status::StatusCode code = frame_reader_->read(frame, duration, mode);
 
+    roc_panic_if_msg(code <= status::NoStatus || code >= status::MaxStatus,
+                     "receiver session: invalid status code %d", code);
+
     // Failure happened. Remember error to return it from next refresh() call.
     // Return StatusEnd to be excluded from mixing.
     // We don't return error from read() because we don't want the whole

src/internal_modules/roc_pipeline/receiver_source.cpp

@@ -126,6 +126,8 @@ status::StatusCode ReceiverSource::refresh(core::nanoseconds_t current_time,
 
         const status::StatusCode code = slot->refresh(current_time, slot_deadline);
         if (code != status::StatusOK) {
+            roc_log(LogError, "receiver source: failed to refresh slot: status=%s",
+                    status::code_to_str(code));
             return code;
         }
 
@@ -206,7 +208,15 @@ status::StatusCode ReceiverSource::read(audio::Frame& frame,
                                         audio::FrameReadMode mode) {
     roc_panic_if(init_status_ != status::StatusOK);
 
-    return frame_reader_->read(frame, duration, mode);
+    const status::StatusCode code = frame_reader_->read(frame, duration, mode);
+
+    if (code != status::StatusOK && code != status::StatusPart
+        && code != status::StatusDrain) {
+        roc_log(LogError, "receiver source: failed to read frame: status=%s",
+                status::code_to_str(code));
+    }
+
+    return code;
 }
 
 } // namespace pipeline

src/internal_modules/roc_pipeline/sender_loop.cpp

@@ -211,7 +211,13 @@ status::StatusCode SenderLoop::write(audio::Frame& frame) {
     }
 
     // invokes process_subframe_imp() and process_task_imp()
-    return process_subframes_and_tasks(frame, frame.duration(), audio::ModeHard);
+    const status::StatusCode code =
+        process_subframes_and_tasks(frame, frame.duration(), audio::ModeHard);
+
+    roc_panic_if_msg(code <= status::NoStatus || code >= status::MaxStatus,
+                     "sender loop: invalid status code %d", code);
+
+    return code;
 }
 
 core::nanoseconds_t SenderLoop::timestamp_imp() const {

src/internal_modules/roc_pipeline/sender_session.cpp

@@ -422,6 +422,9 @@ status::StatusCode SenderSession::write(audio::Frame& frame) {
 
     const status::StatusCode code = frame_writer_->write(frame);
 
+    roc_panic_if_msg(code <= status::NoStatus || code >= status::MaxStatus,
+                     "sender session: invalid status code %d", code);
+
     // If error happens, save it to return later from refresh(), which allows
     // SenderSlot to handle it.
     if (code != status::StatusOK) {

src/internal_modules/roc_pipeline/sender_sink.cpp

@@ -126,6 +126,8 @@ status::StatusCode SenderSink::refresh(core::nanoseconds_t current_time,
 
         const status::StatusCode code = slot->refresh(current_time, slot_deadline);
         if (code != status::StatusOK) {
+            roc_log(LogError, "sender sink: failed to refresh slot: status=%s",
+                    status::code_to_str(code));
             return code;
         }
 
@@ -186,7 +188,14 @@ bool SenderSink::has_clock() const {
 status::StatusCode SenderSink::write(audio::Frame& frame) {
     roc_panic_if(init_status_ != status::StatusOK);
 
-    return frame_writer_->write(frame);
+    const status::StatusCode code = frame_writer_->write(frame);
+
+    if (code != status::StatusOK) {
+        roc_log(LogError, "sender sink: failed to write frame: status=%s",
+                status::code_to_str(code));
+    }
+
+    return code;
 }
 
 } // namespace pipeline

src/internal_modules/roc_sndio/pump.cpp

@@ -65,6 +65,9 @@ status::StatusCode Pump::run() {
         }
     }
 
+    roc_panic_if_msg(code <= status::NoStatus || code >= status::MaxStatus,
+                     "pump: invalid status code %d", code);
+
     if (code == status::StatusEnd) {
         code = status::StatusOK; // EOF is fine
     }

src/internal_modules/roc_status/code_to_str.cpp

@@ -16,6 +16,7 @@ namespace status {
 const char* code_to_str(StatusCode code) {
     switch (code) {
     case NoStatus:
+    case MaxStatus:
         break;
     case StatusOK:
         return "OK";

src/internal_modules/roc_status/status_code.h

@@ -190,6 +190,9 @@ enum StatusCode {
     //!  Example: trying to push packet for an interface that does not support
     //!  it, trying to connect using a protocol that doesn't support it.
     StatusBadOperation,
+
+    //! Maximum enum value.
+    MaxStatus,
 };
 
 } // namespace status