Changeset 87b490e3 in mainline for uspace/app/pcapctl/main.c

Timestamp:

2024-12-13T08:44:05Z (10 months ago)

Author:

Nataliia Korop <n.corop08@…>

Children:

420b13d

Parents:

fb31682

git-author:

Nataliia Korop <n.corop08@…> (2024-11-30 19:08:32)

git-committer:

Nataliia Korop <n.corop08@…> (2024-12-13 08:44:05)

Message:

docs comments

File:

• uspace/app/pcapctl/main.c (modified) (9 diffs)

uspace/app/pcapctl/main.c

@@ -30 +30 @@
  * @{
  */
-/** @file pcapctl app
+/** @file pcapctl command-line utility.
  */
 
@@ -42 +42 @@
 #include "pcapdump_client.h"
 
-#define NAME "pcapctl"
-#define DEFAULT_DEV_NUM 0
-#define DECIMAL_SYSTEM 10
-
-#define DEFAULT_FILE_OPS 0
-#define SHORT_FILE_OPS 1
-#define APPEND_FILE_OPS 2
-#define USB_FILE_OPS 3
-
+#define NAME                            "pcapctl"
+#define DEFAULT_DEV_NUM         0
+#define DECIMAL_SYSTEM          10
+
+/* Default writer operations for dumper, must be consistent with array defined in /uspace/lib/pcap/pcap_dumper.c */
+#define DEFAULT_FILE_OPS        0
+#define SHORT_FILE_OPS          1
+#define APPEND_FILE_OPS         2
+#define USB_FILE_OPS            3
+
+/** Create async session and send start request.
+ *  @param dev_number index of the device that can dump packets.
+ *  @param name of the output buffer.
+ *  @param ops_index index of the writer operations for the dumper.
+ *  @return EOK if all parameters are valid and start request was sent successfully, error code otherwise.
+ */
 static errno_t start_dumping(int *dev_number, const char *name, int *ops_index)
 {
@@ -77 +84 @@
 }
 
+/** Create async session and send stop dumping request.
+ *  @param dev_numbe index of the device on which the dumping will be stopped.
+ *  @return EOK if request was sent successfully, error code otherwise.
+ */
 static errno_t stop_dumping(int *dev_number)
 {
@@ -92 +103 @@
 }
 
+/** Print devices that can dump packets. */
 static void list_devs(void)
 {
@@ -101 +113 @@
  */
 static const struct option opts[] = {
-        { "append", required_argument, 0, 'A' }, // file as argument and ops 0 if not exist and 2 if exists
-        { "new", required_argument, 0, 'N' }, // file name as argument
+        { "append", required_argument, 0, 'A' }, /* file as argument and ops 0 if not exist and 2 if exists */
+        { "new", required_argument, 0, 'N' }, /* file name as argument */
         { "truncated", required_argument, 0, 'T' }, // truncated ops
         { "usb", required_argument, 0, 'U' }, //??
@@ -116 +128 @@
 };
 
+/** Check if the file exists.
+ *  @param path of the file to check.
+ *  @return true if exists, false otherwise.
+ */
 static bool file_exists(const char *path)
 {
@@ -128 +144 @@
 static void usage(void)
 {
-        printf("Usage:\n"
+        printf("HelenOS Packet Dumping utility.\n"
+            "Usage:\n"
             NAME " --list | -l \n"
             "\tList of devices\n"
@@ -218 +235 @@
         }
 
-        printf("%s: HelenOS Packet Dumping utility: device - %d, ops - %d.\n", NAME, dev_number, ops_number);
-
         if (start) {
 
@@ -227 +242 @@
                 }
 
+                printf("Sarting dumping on device - %d, ops - %d.\n", dev_number, ops_number);
+
                 /* start with dev number and name */
                 start_dumping(&dev_number, output_file_name, &ops_number);
         } else if (stop) {
                 /* stop with dev number */
+                printf("Stopping dumping on device - %d, ops - %d.\n", dev_number, ops_number);
                 stop_dumping(&dev_number);
         } else {