Changeset 31eb568 in mainline

Timestamp:

2025-05-06T22:27:00Z (5 weeks ago)

Author:

Miroslav Cimerman <mc@…>

Children:

ac4b70b

Parents:

13c2365

Message:

hr: comment hr.c a bit

File:

• uspace/srv/bd/hr/hr.c (modified) (15 diffs)

uspace/srv/bd/hr/hr.c

@@ -31 +31 @@
  */
 /**
- * @file
+ * @file hr.c
+ * @brief HelenRAID server methods.
  */
 
@@ -40 +41 @@
 #include <hr.h>
 #include <io/log.h>
-#include <inttypes.h>
 #include <ipc/hr.h>
 #include <ipc/services.h>
 #include <loc.h>
 #include <task.h>
-#include <stdatomic.h>
 #include <stdio.h>
 #include <stdlib.h>
@@ -52 +51 @@
 #include <block.h>
 
-#include "fge.h"
-#include "io.h"
-#include "superblock.h"
 #include "util.h"
 #include "var.h"
@@ -64 +60 @@
 static void hr_add_hotspare_srv(ipc_call_t *);
 static void hr_print_status_srv(ipc_call_t *);
-static void hr_ctl_conn(ipc_call_t *, void *);
+static void hr_ctl_conn(ipc_call_t *);
 static void hr_client_conn(ipc_call_t *, void *);
 
@@ -73 +69 @@
 static service_id_t ctl_sid;
 
+/** Volume creation (server).
+ *
+ * Creates HelenRAID volume from parameters and
+ * devices specified in hr_config_t.
+ *
+ * @param icall hr_config_t
+ */
 static void hr_create_srv(ipc_call_t *icall)
 {
@@ -175 +178 @@
 }
 
+/** Manual volume assembly (server).
+ *
+ * Tries to assemble a volume from devices in hr_config_t and
+ * sends the number of successful volumes assembled back to the
+ * client.
+ *
+ * @param icall hr_config_t
+ */
 static void hr_assemble_srv(ipc_call_t *icall)
 {
@@ -234 +245 @@
 }
 
+/** Automatic volume assembly (server).
+ *
+ * Tries to assemble a volume from devices in disk location
+ * category and sends the number of successful volumes assembled
+ * back to client.
+ */
 static void hr_auto_assemble_srv(ipc_call_t *icall)
 {
@@ -269 +286 @@
 }
 
+/** Volume deactivation (server).
+ *
+ * Deactivates/detaches specified volume.
+ */
 static void hr_stop_srv(ipc_call_t *icall)
 {
@@ -290 +311 @@
 }
 
+/** Automatic volume deactivation (server).
+ *
+ * Tries to deactivate/detach all volumes.
+ */
 static void hr_stop_all_srv(ipc_call_t *icall)
 {
@@ -316 +341 @@
 }
 
+/** Simulate volume extent failure (server).
+ *
+ * Changes the specified extent's state to FAULTY.
+ * Other extents' metadata are marked as dirty, therefore
+ * it effectively invalides the specified extent as well
+ * for further uses.
+ */
 static void hr_fail_extent_srv(ipc_call_t *icall)
 {
@@ -347 +379 @@
 }
 
+/** Add hotspare to volume (server).
+ *
+ * Adds hotspare to a volume.
+ */
 static void hr_add_hotspare_srv(ipc_call_t *icall)
 {
@@ -378 +414 @@
 }
 
+/** Volume state printing (server).
+ *
+ * Prints info about all active volumes.
+ */
 static void hr_print_status_srv(ipc_call_t *icall)
 {
@@ -447 +487 @@
 }
 
-static void hr_ctl_conn(ipc_call_t *icall, void *arg)
+/**  HelenRAID server control IPC methods crossroad.
+ */
+static void hr_ctl_conn(ipc_call_t *icall)
 {
         HR_DEBUG("%s()", __func__);
@@ -494 +536 @@
 }
 
+/**  HelenRAID server IPC method crossroad.
+ *
+ * Distinguishes between control IPC and block device
+ * IPC calls.
+ */
 static void hr_client_conn(ipc_call_t *icall, void *arg)
 {
@@ -503 +550 @@
 
         if (svc_id == ctl_sid) {
-                hr_ctl_conn(icall, arg);
+                hr_ctl_conn(icall);
         } else {
-                HR_DEBUG("bd_conn()\n");
                 vol = hr_get_volume(svc_id);
                 if (vol == NULL)