diagnose.c: refactor to safely use 'd_type'

Refactor usage of the 'd_type' property of 'struct dirent' in 'diagnose.c'
to instead utilize the compatibility macro 'DTYPE()'. On systems where
'd_type' is not present in 'struct dirent', this macro will always return
'DT_UNKNOWN'. In that case, instead fall back on using the 'stat.st_mode' to
determine whether the dirent points to a dir, file, or link.

Additionally, add a test to 't0092-diagnose.sh' to verify that files (e.g.,
loose objects) are counted properly.

Note that the new function 'get_dtype()' is based on 'resolve_dtype()' in
'dir.c' (which itself was refactored from a prior 'get_dtype()' in
ad6f2157f9 (dir: restructure in a way to avoid passing around a struct
dirent, 2020-01-16)), but differs in that it is meant for use on arbitrary
files, such as those inside the '.git' dir. Because of this, it does not
search the index for a matching entry to derive the 'd_type'.

Reported-by: Randall S. Becker <rsbecker@nexbridge.com>
Signed-off-by: Victoria Dye <vdye@github.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/diagnose.c b/diagnose.c
index beb0a8741ba3ce65a389a55810e0b8d5b03010fa..8f2656989666b67a3281d29a83f73ff82a006a1d 100644 (file)
--- a/diagnose.c
+++ b/diagnose.c
@@ -66,17 +66,53 @@ static int dir_file_stats(struct object_directory *object_dir, void *data)
        return 0;
 }
 
-static int count_files(char *path)
+/*
+ * Get the d_type of a dirent. If the d_type is unknown, derive it from
+ * stat.st_mode.
+ *
+ * Note that 'path' is assumed to have a trailing slash. It is also modified
+ * in-place during the execution of the function, but is then reverted to its
+ * original value before returning.
+ */
+static unsigned char get_dtype(struct dirent *e, struct strbuf *path)
 {
-       DIR *dir = opendir(path);
+       struct stat st;
+       unsigned char dtype = DTYPE(e);
+       size_t base_path_len;
+
+       if (dtype != DT_UNKNOWN)
+               return dtype;
+
+       /* d_type unknown in dirent, try to fall back on lstat results */
+       base_path_len = path->len;
+       strbuf_addstr(path, e->d_name);
+       if (lstat(path->buf, &st))
+               goto cleanup;
+
+       /* determine d_type from st_mode */
+       if (S_ISREG(st.st_mode))
+               dtype = DT_REG;
+       else if (S_ISDIR(st.st_mode))
+               dtype = DT_DIR;
+       else if (S_ISLNK(st.st_mode))
+               dtype = DT_LNK;
+
+cleanup:
+       strbuf_setlen(path, base_path_len);
+       return dtype;
+}
+
+static int count_files(struct strbuf *path)
+{
+       DIR *dir = opendir(path->buf);
        struct dirent *e;
        int count = 0;
 
        if (!dir)
                return 0;
 
-       while ((e = readdir(dir)) != NULL)
-               if (!is_dot_or_dotdot(e->d_name) && e->d_type == DT_REG)
+       while ((e = readdir_skip_dot_and_dotdot(dir)) != NULL)
+               if (get_dtype(e, path) == DT_REG)
                        count++;
 
        closedir(dir);
@@ -104,13 +140,13 @@ static void loose_objs_stats(struct strbuf *buf, const char *path)
        strbuf_addch(&count_path, '/');
        base_path_len = count_path.len;
 
-       while ((e = readdir(dir)) != NULL)
-               if (!is_dot_or_dotdot(e->d_name) &&
-                   e->d_type == DT_DIR && strlen(e->d_name) == 2 &&
+       while ((e = readdir_skip_dot_and_dotdot(dir)) != NULL)
+               if (get_dtype(e, &count_path) == DT_DIR &&
+                   strlen(e->d_name) == 2 &&
                    !hex_to_bytes(&c, e->d_name, 1)) {
                        strbuf_setlen(&count_path, base_path_len);
-                       strbuf_addstr(&count_path, e->d_name);
-                       total += (count = count_files(count_path.buf));
+                       strbuf_addf(&count_path, "%s/", e->d_name);
+                       total += (count = count_files(&count_path));
                        strbuf_addf(buf, "%s : %7d files\n", e->d_name, count);
                }
 
@@ -144,22 +180,28 @@ static int add_directory_to_archiver(struct strvec *archiver_args,
        len = buf.len;
        strvec_pushf(archiver_args, "--prefix=%s", buf.buf);
 
-       while (!res && (e = readdir(dir))) {
-               if (!strcmp(".", e->d_name) || !strcmp("..", e->d_name))
-                       continue;
+       while (!res && (e = readdir_skip_dot_and_dotdot(dir))) {
+               struct strbuf abspath = STRBUF_INIT;
+               unsigned char dtype;
+
+               strbuf_add_absolute_path(&abspath, at_root ? "." : path);
+               strbuf_addch(&abspath, '/');
+               dtype = get_dtype(e, &abspath);
 
                strbuf_setlen(&buf, len);
                strbuf_addstr(&buf, e->d_name);
 
-               if (e->d_type == DT_REG)
+               if (dtype == DT_REG)
                        strvec_pushf(archiver_args, "--add-file=%s", buf.buf);
-               else if (e->d_type != DT_DIR)
+               else if (dtype != DT_DIR)
                        warning(_("skipping '%s', which is neither file nor "
                                  "directory"), buf.buf);
                else if (recurse &&
                         add_directory_to_archiver(archiver_args,
                                                   buf.buf, recurse) < 0)
                        res = -1;
+
+               strbuf_release(&abspath);
        }
 
        closedir(dir);

diff --git a/t/t0092-diagnose.sh b/t/t0092-diagnose.sh
index fca9b58489cf5409dc1a9d908a058ddfd24b8fa2..133e5747d613e5ade6ab8bfe67ab46a31021d64e 100755 (executable)
--- a/t/t0092-diagnose.sh
+++ b/t/t0092-diagnose.sh
@@ -28,12 +28,23 @@ test_expect_success UNZIP 'creates diagnostics zip archive' '
        ! "$GIT_UNZIP" -l "$zip_path" | grep ".git/"
 '
 
+test_expect_success UNZIP 'counts loose objects' '
+       test_commit A &&
+
+       # After committing, should have non-zero loose objects
+       git diagnose -o test-count -s 1 >out &&
+       zip_path=test-count/git-diagnostics-1.zip &&
+       "$GIT_UNZIP" -p "$zip_path" objects-local.txt >out &&
+       grep "^Total: [1-9][0-9]* loose objects" out
+'
+
 test_expect_success UNZIP '--mode=stats excludes .git dir contents' '
        test_when_finished rm -rf report &&
 
        git diagnose -o report -s test --mode=stats >out &&
 
        # Includes pack quantity/size info
+       zip_path=report/git-diagnostics-test.zip &&
        "$GIT_UNZIP" -p "$zip_path" packs-local.txt >out &&
        grep ".git/objects" out &&
 
@@ -47,6 +58,7 @@ test_expect_success UNZIP '--mode=all includes .git dir contents' '
        git diagnose -o report -s test --mode=all >out &&
 
        # Includes pack quantity/size info
+       zip_path=report/git-diagnostics-test.zip &&
        "$GIT_UNZIP" -p "$zip_path" packs-local.txt >out &&
        grep ".git/objects" out &&