Changeset c111da2 in mainline for uspace/lib

Timestamp:

2025-10-09T15:44:52Z (3 months ago)

Author:

Jiri Svoboda <jiri@…>

Branches:

master

Children:

cfd04c4

Parents:

1a96db9

Message:

Create non-zero size file in Navigator, new newfile utility.

Location:

uspace/lib

Files:

• c/generic/capa.c (modified) (2 diffs)
• c/include/capa.h (modified) (2 diffs)
• c/test/capa.c (modified) (2 diffs)
• fmgt/include/fmgt.h (modified) (2 diffs)
• fmgt/include/types/fmgt.h (modified) (1 diff)
• fmgt/meson.build (modified) (1 diff)
• fmgt/src/fmgt.c (modified) (5 diffs)
• fmgt/test/fmgt.c (added)
• fmgt/test/main.c (added)

uspace/lib/c/generic/capa.c

@@ -1 +1 @@
 /*
- * Copyright (c) 2015 Jiri Svoboda
+ * Copyright (c) 2025 Jiri Svoboda
  * All rights reserved.
  *
@@ -233 +233 @@
 }
 
+errno_t capa_format_buf(capa_spec_t *capa, char *buf, size_t bufsize)
+{
+        errno_t rc;
+        const char *sunit;
+        uint64_t ipart;
+        uint64_t fpart;
+        uint64_t div;
+
+        sunit = NULL;
+
+        assert(capa->cunit < CU_LIMIT);
+
+        rc = ipow10_u64(capa->dp, &div);
+        if (rc != EOK)
+                return rc;
+
+        ipart = capa->m / div;
+        fpart = capa->m % div;
+
+        sunit = cu_str[capa->cunit];
+        if (capa->dp > 0) {
+                snprintf(buf, bufsize, "%" PRIu64 ".%0*" PRIu64 " %s", ipart,
+                    (int)capa->dp, fpart, sunit);
+        } else {
+                snprintf(buf, bufsize, "%" PRIu64 " %s", ipart, sunit);
+        }
+
+        return EOK;
+}
+
+errno_t capa_blocks_format(uint64_t nblocks, size_t block_size,
+    char **rptr)
+{
+        capa_spec_t capa;
+
+        capa_from_blocks(nblocks, block_size, &capa);
+        capa_simplify(&capa);
+        return capa_format(&capa, rptr);
+}
+
+void capa_blocks_format_buf(uint64_t nblocks, size_t block_size,
+    char *buf, size_t bsize)
+{
+        capa_spec_t capa;
+        errno_t rc;
+
+        capa_from_blocks(nblocks, block_size, &capa);
+        capa_simplify(&capa);
+
+        /* Should not get range error because of nblocks * block_size limits */
+        rc = capa_format_buf(&capa, buf, bsize);
+        assert(rc == EOK);
+        (void)rc;
+}
+
 static errno_t capa_digit_val(char c, int *val)
 {

uspace/lib/c/include/capa.h

@@ -1 +1 @@
 /*
- * Copyright (c) 2015 Jiri Svoboda
+ * Copyright (c) 2025 Jiri Svoboda
  * All rights reserved.
  *
@@ -87 +87 @@
 } capa_spec_t;
 
+/** Size of buffer large enough for capa_blocks_format_buf */
+#define CAPA_BLOCKS_BUFSIZE 16
+
 extern errno_t capa_format(capa_spec_t *, char **);
+extern errno_t capa_format_buf(capa_spec_t *, char *, size_t);
+extern errno_t capa_blocks_format(uint64_t, size_t, char **);
+extern void capa_blocks_format_buf(uint64_t, size_t, char *, size_t);
 extern errno_t capa_parse(const char *, capa_spec_t *);
 extern void capa_simplify(capa_spec_t *);

uspace/lib/c/test/capa.c

@@ -1 +1 @@
 /*
+ * Copyright (c) 2025 Jiri Svoboda
  * Copyright (c) 2019 Matthieu Riolo
  * All rights reserved.
@@ -285 +286 @@
 }
 
+PCUT_TEST(capa_blocks_format)
+{
+        errno_t rc;
+        char *str;
+
+        rc = capa_blocks_format(42, 1, &str);
+        PCUT_ASSERT_ERRNO_VAL(EOK, rc);
+        PCUT_ASSERT_STR_EQUALS("42 B", str);
+        free(str);
+}
+
+PCUT_TEST(capa_blocks_format_buf)
+{
+        char str[CAPA_BLOCKS_BUFSIZE];
+
+        capa_blocks_format_buf(42, 1, str, sizeof(str));
+        PCUT_ASSERT_STR_EQUALS("42 B", str);
+}
+
 PCUT_EXPORT(capa);

uspace/lib/fmgt/include/fmgt.h

@@ -39 +39 @@
 
 #include <errno.h>
+#include <stdbool.h>
 #include <stddef.h>
+#include <stdint.h>
 #include "types/fmgt.h"
 
@@ -45 +47 @@
 extern void fmgt_set_cb(fmgt_t *, fmgt_cb_t *, void *);
 extern void fmgt_destroy(fmgt_t *);
+extern void fmgt_set_init_update(fmgt_t *, bool);
 extern errno_t fmgt_new_file_suggest(char **);
+extern errno_t fmgt_new_file(fmgt_t *, const char *, uint64_t);
 
 #endif

uspace/lib/fmgt/include/types/fmgt.h

@@ -38 +38 @@
 #define TYPES_FMGT_H
 
+#include <capa.h>
+#include <fibril_synch.h>
+
+/** File management progress update */
+typedef struct {
+        /** Current file processed bytes */
+        char curf_procb[CAPA_BLOCKS_BUFSIZE];
+        /** Total bytes to process for current file */
+        char curf_totalb[CAPA_BLOCKS_BUFSIZE];
+        /** Percent of current file processed */
+        char curf_percent[5];
+} fmgt_progress_t;
+
 /** File management callbacks */
 typedef struct {
+        void (*progress)(void *, fmgt_progress_t *);
 } fmgt_cb_t;
 
 typedef struct {
+        /** Lock */
+        fibril_mutex_t lock;
+        /** Progress update timer */
+        fibril_timer_t *timer;
         /** Callback functions */
         fmgt_cb_t *cb;
         /** Argument to callback functions */
         void *cb_arg;
+        /** Bytes processed from current file */
+        uint64_t curf_procb;
+        /** Total size of current file */
+        uint64_t curf_totalb;
+        /** Progress was displayed for current file */
+        bool curf_progr;
+        /** Post an immediate initial progress update */
+        bool do_init_update;
 } fmgt_t;
 

uspace/lib/fmgt/meson.build

@@ -28 +28 @@
 
 src = files(
-        'src/fmgt.c'
+        'src/fmgt.c',
 )
+
+test_src = files(
+        'test/fmgt.c',
+        'test/main.c',
+)

uspace/lib/fmgt/src/fmgt.c

@@ -46 +46 @@
 
 #define NEWNAME_LEN 64
+#define BUFFER_SIZE 16384
 
 /** Create file management library instance.
@@ -59 +60 @@
         if (fmgt == NULL)
                 return ENOMEM;
+
+        fibril_mutex_initialize(&fmgt->lock);
+        fmgt->timer = fibril_timer_create(&fmgt->lock);
+        if (fmgt->timer == NULL) {
+                free(fmgt);
+                return ENOMEM;
+        }
 
         *rfmgt = fmgt;
@@ -77 +85 @@
 }
 
+/** Configure whether to give immediate initial progress update.
+ *
+ * @param fmgt File management object
+ * @param enabled @c true to post and immediate initial progress update
+ */
+void fmgt_set_init_update(fmgt_t *fmgt, bool enabled)
+{
+        fmgt->do_init_update = enabled;
+}
+
 /** Destroy file management library instance.
  *
@@ -83 +101 @@
 void fmgt_destroy(fmgt_t *fmgt)
 {
+        (void)fibril_timer_clear(fmgt->timer);
+        fibril_timer_destroy(fmgt->timer);
         free(fmgt);
 }
@@ -116 +136 @@
 }
 
+/** Get progress update report.
+ *
+ * @param fmgt File management object
+ * @param progress Place to store progress update
+ */
+static void fmgt_get_progress(fmgt_t *fmgt, fmgt_progress_t *progress)
+{
+        unsigned percent;
+
+        if (fmgt->curf_totalb > 0)
+                percent = fmgt->curf_procb * 100 / fmgt->curf_totalb;
+        else
+                percent = 100;
+
+        capa_blocks_format_buf(fmgt->curf_procb, 1, progress->curf_procb,
+            sizeof(progress->curf_procb));
+        capa_blocks_format_buf(fmgt->curf_totalb, 1, progress->curf_totalb,
+            sizeof(progress->curf_totalb));
+        snprintf(progress->curf_percent, sizeof(progress->curf_percent), "%u%%",
+            percent);
+}
+
+/** Give the caller progress update.
+ *
+ * @param fmgt File management object
+ */
+static void fmgt_progress_update(fmgt_t *fmgt)
+{
+        fmgt_progress_t progress;
+
+        if (fmgt->cb != NULL && fmgt->cb->progress != NULL) {
+                fmgt_get_progress(fmgt, &progress);
+                fmgt->curf_progr = true;
+                fmgt->cb->progress(fmgt->cb_arg, &progress);
+        }
+}
+
+/** Provide initial progress update (if required).
+ *
+ * The caller configures the file management object regarding whether
+ * initial updates are required.
+ *
+ * @param fmgt File management object
+ */
+static void fmgt_initial_progress_update(fmgt_t *fmgt)
+{
+        if (fmgt->do_init_update)
+                fmgt_progress_update(fmgt);
+}
+
+/** Provide final progress update (if required).
+ *
+ * Final update is provided only if a previous progress update was given.
+ *
+ * @param fmgt File management object
+ */
+static void fmgt_final_progress_update(fmgt_t *fmgt)
+{
+        if (fmgt->curf_progr)
+                fmgt_progress_update(fmgt);
+}
+
+/** Progress timer function.
+ *
+ * Periodically called to provide progress updates.
+ *
+ * @param arg Argument (fmgt_t *)
+ */
+static void fmgt_timer_fun(void *arg)
+{
+        fmgt_t *fmgt = (fmgt_t *)arg;
+
+        fmgt_progress_update(fmgt);
+        fibril_timer_set(fmgt->timer, 500000, fmgt_timer_fun, (void *)fmgt);
+}
+
+/** Start progress update timer.
+ *
+ * @param fmgt File management object
+ */
+static void fmgt_timer_start(fmgt_t *fmgt)
+{
+        fibril_timer_set(fmgt->timer, 500000, fmgt_timer_fun, (void *)fmgt);
+}
+
+/** Create new file.
+ *
+ * @param fmgt File management object
+ * @param fname File name
+ * @param fsize Size of new file (number of zero bytes to fill in)
+ * @return EOK on success or an error code
+ */
+errno_t fmgt_new_file(fmgt_t *fmgt, const char *fname, uint64_t fsize)
+{
+        int fd;
+        size_t nw;
+        aoff64_t pos = 0;
+        uint64_t now;
+        char *buffer;
+        errno_t rc;
+
+        buffer = calloc(BUFFER_SIZE, 1);
+        if (buffer == NULL)
+                return ENOMEM;
+
+        rc = vfs_lookup_open(fname, WALK_REGULAR | WALK_MUST_CREATE,
+            MODE_WRITE, &fd);
+        if (rc != EOK) {
+                free(buffer);
+                return rc;
+        }
+
+        fmgt->curf_procb = 0;
+        fmgt->curf_totalb = fsize;
+        fmgt->curf_progr = false;
+        fmgt_timer_start(fmgt);
+
+        fmgt_initial_progress_update(fmgt);
+
+        while (fmgt->curf_procb < fsize) {
+                now = fsize - fmgt->curf_procb;
+                if (now > BUFFER_SIZE)
+                        now = BUFFER_SIZE;
+
+                rc = vfs_write(fd, &pos, buffer, now, &nw);
+                if (rc != EOK) {
+                        free(buffer);
+                        vfs_put(fd);
+                        fmgt_final_progress_update(fmgt);
+                        return rc;
+                }
+
+                fmgt->curf_procb += nw;
+        }
+
+        free(buffer);
+        vfs_put(fd);
+        fmgt_final_progress_update(fmgt);
+        return EOK;
+}
+
 /** @}
  */