scalar-diagnose: move functionality to common location
Move the core functionality of 'scalar diagnose' into a new 'diagnose.[c,h]' library to prepare for new callers in the main Git tree generating diagnostic archives. These callers will be introduced in subsequent patches. While this patch appears large, it is mostly made up of moving code out of 'scalar.c' and into 'diagnose.c'. Specifically, the functions - dir_file_stats_objects() - dir_file_stats() - count_files() - loose_objs_stats() - add_directory_to_archiver() are all copied verbatim from 'scalar.c'. The 'create_diagnostics_archive()' function is a mostly identical (partial) copy of 'cmd_diagnose()', with the primary changes being that 'zip_path' is an input and "Enlistment root" is corrected to "Repository root" in the archiver log. Helped-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Victoria Dye <vdye@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Victoria Dye committed
Aug 12, 2022 at 20:10 UTC
bb2c34956ad4fab1e7619327219fb5a5a49f571b
4 files changed
+227
-200
Makefile
+1
@@ -932,6 +932,7 @@ LIB_OBJS += ctype.o
932
LIB_OBJS += date.o
933
LIB_OBJS += decorate.o
934
LIB_OBJS += delta-islands.o
935
+LIB_OBJS += diagnose.o
936
LIB_OBJS += diff-delta.o
937
LIB_OBJS += diff-merges.o
938
LIB_OBJS += diff-lib.o
contrib/scalar/scalar.c
+2
-200
@@ -11,9 +11,7 @@
11
#include "dir.h"
12
#include "packfile.h"
13
#include "help.h"
14
-#include "archive.h"
15
-#include "object-store.h"
16
-#include "compat/disk.h"
14
+#include "diagnose.h"
15
16
/*
17
* Remove the deepest subdirectory in the provided path string. Path must not
@@ -263,53 +261,6 @@ static int unregister_dir(void)
261
return res;
262
}
263
266
-static int add_directory_to_archiver(struct strvec *archiver_args,
267
- const char *path, int recurse)
268
-{
269
- int at_root = !*path;
270
- DIR *dir;
271
- struct dirent *e;
272
- struct strbuf buf = STRBUF_INIT;
273
- size_t len;
274
- int res = 0;
275
-
276
- dir = opendir(at_root ? "." : path);
277
- if (!dir) {
278
- if (errno == ENOENT) {
279
- warning(_("could not archive missing directory '%s'"), path);
280
- return 0;
281
- }
282
- return error_errno(_("could not open directory '%s'"), path);
283
- }
284
-
285
- if (!at_root)
286
- strbuf_addf(&buf, "%s/", path);
287
- len = buf.len;
288
- strvec_pushf(archiver_args, "--prefix=%s", buf.buf);
289
-
290
- while (!res && (e = readdir(dir))) {
291
- if (!strcmp(".", e->d_name) || !strcmp("..", e->d_name))
292
- continue;
293
-
294
- strbuf_setlen(&buf, len);
295
- strbuf_addstr(&buf, e->d_name);
296
-
297
- if (e->d_type == DT_REG)
298
- strvec_pushf(archiver_args, "--add-file=%s", buf.buf);
299
- else if (e->d_type != DT_DIR)
300
- warning(_("skipping '%s', which is neither file nor "
301
- "directory"), buf.buf);
302
- else if (recurse &&
303
- add_directory_to_archiver(archiver_args,
304
- buf.buf, recurse) < 0)
305
- res = -1;
306
- }
307
-
308
- closedir(dir);
309
- strbuf_release(&buf);
310
- return res;
311
-}
312
-
264
/* printf-style interface, expects `<key>=<value>` argument */
265
static int set_config(const char *fmt, ...)
266
{
@@ -550,83 +501,6 @@ cleanup:
501
return res;
502
}
503
553
-static void dir_file_stats_objects(const char *full_path, size_t full_path_len,
554
- const char *file_name, void *data)
555
-{
556
- struct strbuf *buf = data;
557
- struct stat st;
558
-
559
- if (!stat(full_path, &st))
560
- strbuf_addf(buf, "%-70s %16" PRIuMAX "\n", file_name,
561
- (uintmax_t)st.st_size);
562
-}
563
-
564
-static int dir_file_stats(struct object_directory *object_dir, void *data)
565
-{
566
- struct strbuf *buf = data;
567
-
568
- strbuf_addf(buf, "Contents of %s:\n", object_dir->path);
569
-
570
- for_each_file_in_pack_dir(object_dir->path, dir_file_stats_objects,
571
- data);
572
-
573
- return 0;
574
-}
575
-
576
-static int count_files(char *path)
577
-{
578
- DIR *dir = opendir(path);
579
- struct dirent *e;
580
- int count = 0;
581
-
582
- if (!dir)
583
- return 0;
584
-
585
- while ((e = readdir(dir)) != NULL)
586
- if (!is_dot_or_dotdot(e->d_name) && e->d_type == DT_REG)
587
- count++;
588
-
589
- closedir(dir);
590
- return count;
591
-}
592
-
593
-static void loose_objs_stats(struct strbuf *buf, const char *path)
594
-{
595
- DIR *dir = opendir(path);
596
- struct dirent *e;
597
- int count;
598
- int total = 0;
599
- unsigned char c;
600
- struct strbuf count_path = STRBUF_INIT;
601
- size_t base_path_len;
602
-
603
- if (!dir)
604
- return;
605
-
606
- strbuf_addstr(buf, "Object directory stats for ");
607
- strbuf_add_absolute_path(buf, path);
608
- strbuf_addstr(buf, ":\n");
609
-
610
- strbuf_add_absolute_path(&count_path, path);
611
- strbuf_addch(&count_path, '/');
612
- base_path_len = count_path.len;
613
-
614
- while ((e = readdir(dir)) != NULL)
615
- if (!is_dot_or_dotdot(e->d_name) &&
616
- e->d_type == DT_DIR && strlen(e->d_name) == 2 &&
617
- !hex_to_bytes(&c, e->d_name, 1)) {
618
- strbuf_setlen(&count_path, base_path_len);
619
- strbuf_addstr(&count_path, e->d_name);
620
- total += (count = count_files(count_path.buf));
621
- strbuf_addf(buf, "%s : %7d files\n", e->d_name, count);
622
- }
623
-
624
- strbuf_addf(buf, "Total: %d loose objects", total);
625
-
626
- strbuf_release(&count_path);
627
- closedir(dir);
628
-}
629
-
504
static int cmd_diagnose(int argc, const char **argv)
505
{
506
struct option options[] = {
@@ -637,12 +511,8 @@ static int cmd_diagnose(int argc, const char **argv)
511
NULL
512
};
513
struct strbuf zip_path = STRBUF_INIT;
640
- struct strvec archiver_args = STRVEC_INIT;
641
- char **argv_copy = NULL;
642
- int stdout_fd = -1, archiver_fd = -1;
514
time_t now = time(NULL);
515
struct tm tm;
645
- struct strbuf buf = STRBUF_INIT;
516
int res = 0;
517
518
argc = parse_options(argc, argv, NULL, options,
@@ -663,79 +533,11 @@ static int cmd_diagnose(int argc, const char **argv)
533
zip_path.buf);
534
goto diagnose_cleanup;
535
}
666
- stdout_fd = dup(1);
667
- if (stdout_fd < 0) {
668
- res = error_errno(_("could not duplicate stdout"));
669
- goto diagnose_cleanup;
670
- }
671
-
672
- archiver_fd = xopen(zip_path.buf, O_CREAT | O_WRONLY | O_TRUNC, 0666);
673
- if (archiver_fd < 0 || dup2(archiver_fd, 1) < 0) {
674
- res = error_errno(_("could not redirect output"));
675
- goto diagnose_cleanup;
676
- }
677
-
678
- init_zip_archiver();
679
- strvec_pushl(&archiver_args, "scalar-diagnose", "--format=zip", NULL);
680
-
681
- strbuf_reset(&buf);
682
- strbuf_addstr(&buf, "Collecting diagnostic info\n\n");
683
- get_version_info(&buf, 1);
684
-
685
- strbuf_addf(&buf, "Enlistment root: %s\n", the_repository->worktree);
686
- get_disk_info(&buf);
687
- write_or_die(stdout_fd, buf.buf, buf.len);
688
- strvec_pushf(&archiver_args,
689
- "--add-virtual-file=diagnostics.log:%.*s",
690
- (int)buf.len, buf.buf);
691
-
692
- strbuf_reset(&buf);
693
- strbuf_addstr(&buf, "--add-virtual-file=packs-local.txt:");
694
- dir_file_stats(the_repository->objects->odb, &buf);
695
- foreach_alt_odb(dir_file_stats, &buf);
696
- strvec_push(&archiver_args, buf.buf);
697
-
698
- strbuf_reset(&buf);
699
- strbuf_addstr(&buf, "--add-virtual-file=objects-local.txt:");
700
- loose_objs_stats(&buf, ".git/objects");
701
- strvec_push(&archiver_args, buf.buf);
702
-
703
- if ((res = add_directory_to_archiver(&archiver_args, ".git", 0)) ||
704
- (res = add_directory_to_archiver(&archiver_args, ".git/hooks", 0)) ||
705
- (res = add_directory_to_archiver(&archiver_args, ".git/info", 0)) ||
706
- (res = add_directory_to_archiver(&archiver_args, ".git/logs", 1)) ||
707
- (res = add_directory_to_archiver(&archiver_args, ".git/objects/info", 0)))
708
- goto diagnose_cleanup;
709
-
710
- strvec_pushl(&archiver_args, "--prefix=",
711
- oid_to_hex(the_hash_algo->empty_tree), "--", NULL);
712
-
713
- /* `write_archive()` modifies the `argv` passed to it. Let it. */
714
- argv_copy = xmemdupz(archiver_args.v,
715
- sizeof(char *) * archiver_args.nr);
716
- res = write_archive(archiver_args.nr, (const char **)argv_copy, NULL,
717
- the_repository, NULL, 0);
718
- if (res) {
719
- error(_("failed to write archive"));
720
- goto diagnose_cleanup;
721
- }
536
723
- if (!res)
724
- fprintf(stderr, "\n"
725
- "Diagnostics complete.\n"
726
- "All of the gathered info is captured in '%s'\n",
727
- zip_path.buf);
537
+ res = create_diagnostics_archive(&zip_path);
538
539
diagnose_cleanup:
730
- if (archiver_fd >= 0) {
731
- close(1);
732
- dup2(stdout_fd, 1);
733
- }
734
- free(argv_copy);
735
- strvec_clear(&archiver_args);
540
strbuf_release(&zip_path);
737
- strbuf_release(&buf);
738
-
541
return res;
542
}
543
diagnose.c
new
+216
@@ -0,0 +1,216 @@
1
+#include "cache.h"
2
+#include "diagnose.h"
3
+#include "compat/disk.h"
4
+#include "archive.h"
5
+#include "dir.h"
6
+#include "help.h"
7
+#include "strvec.h"
8
+#include "object-store.h"
9
+#include "packfile.h"
10
+
11
+static void dir_file_stats_objects(const char *full_path, size_t full_path_len,
12
+ const char *file_name, void *data)
13
+{
14
+ struct strbuf *buf = data;
15
+ struct stat st;
16
+
17
+ if (!stat(full_path, &st))
18
+ strbuf_addf(buf, "%-70s %16" PRIuMAX "\n", file_name,
19
+ (uintmax_t)st.st_size);
20
+}
21
+
22
+static int dir_file_stats(struct object_directory *object_dir, void *data)
23
+{
24
+ struct strbuf *buf = data;
25
+
26
+ strbuf_addf(buf, "Contents of %s:\n", object_dir->path);
27
+
28
+ for_each_file_in_pack_dir(object_dir->path, dir_file_stats_objects,
29
+ data);
30
+
31
+ return 0;
32
+}
33
+
34
+static int count_files(char *path)
35
+{
36
+ DIR *dir = opendir(path);
37
+ struct dirent *e;
38
+ int count = 0;
39
+
40
+ if (!dir)
41
+ return 0;
42
+
43
+ while ((e = readdir(dir)) != NULL)
44
+ if (!is_dot_or_dotdot(e->d_name) && e->d_type == DT_REG)
45
+ count++;
46
+
47
+ closedir(dir);
48
+ return count;
49
+}
50
+
51
+static void loose_objs_stats(struct strbuf *buf, const char *path)
52
+{
53
+ DIR *dir = opendir(path);
54
+ struct dirent *e;
55
+ int count;
56
+ int total = 0;
57
+ unsigned char c;
58
+ struct strbuf count_path = STRBUF_INIT;
59
+ size_t base_path_len;
60
+
61
+ if (!dir)
62
+ return;
63
+
64
+ strbuf_addstr(buf, "Object directory stats for ");
65
+ strbuf_add_absolute_path(buf, path);
66
+ strbuf_addstr(buf, ":\n");
67
+
68
+ strbuf_add_absolute_path(&count_path, path);
69
+ strbuf_addch(&count_path, '/');
70
+ base_path_len = count_path.len;
71
+
72
+ while ((e = readdir(dir)) != NULL)
73
+ if (!is_dot_or_dotdot(e->d_name) &&
74
+ e->d_type == DT_DIR && strlen(e->d_name) == 2 &&
75
+ !hex_to_bytes(&c, e->d_name, 1)) {
76
+ strbuf_setlen(&count_path, base_path_len);
77
+ strbuf_addstr(&count_path, e->d_name);
78
+ total += (count = count_files(count_path.buf));
79
+ strbuf_addf(buf, "%s : %7d files\n", e->d_name, count);
80
+ }
81
+
82
+ strbuf_addf(buf, "Total: %d loose objects", total);
83
+
84
+ strbuf_release(&count_path);
85
+ closedir(dir);
86
+}
87
+
88
+static int add_directory_to_archiver(struct strvec *archiver_args,
89
+ const char *path, int recurse)
90
+{
91
+ int at_root = !*path;
92
+ DIR *dir;
93
+ struct dirent *e;
94
+ struct strbuf buf = STRBUF_INIT;
95
+ size_t len;
96
+ int res = 0;
97
+
98
+ dir = opendir(at_root ? "." : path);
99
+ if (!dir) {
100
+ if (errno == ENOENT) {
101
+ warning(_("could not archive missing directory '%s'"), path);
102
+ return 0;
103
+ }
104
+ return error_errno(_("could not open directory '%s'"), path);
105
+ }
106
+
107
+ if (!at_root)
108
+ strbuf_addf(&buf, "%s/", path);
109
+ len = buf.len;
110
+ strvec_pushf(archiver_args, "--prefix=%s", buf.buf);
111
+
112
+ while (!res && (e = readdir(dir))) {
113
+ if (!strcmp(".", e->d_name) || !strcmp("..", e->d_name))
114
+ continue;
115
+
116
+ strbuf_setlen(&buf, len);
117
+ strbuf_addstr(&buf, e->d_name);
118
+
119
+ if (e->d_type == DT_REG)
120
+ strvec_pushf(archiver_args, "--add-file=%s", buf.buf);
121
+ else if (e->d_type != DT_DIR)
122
+ warning(_("skipping '%s', which is neither file nor "
123
+ "directory"), buf.buf);
124
+ else if (recurse &&
125
+ add_directory_to_archiver(archiver_args,
126
+ buf.buf, recurse) < 0)
127
+ res = -1;
128
+ }
129
+
130
+ closedir(dir);
131
+ strbuf_release(&buf);
132
+ return res;
133
+}
134
+
135
+int create_diagnostics_archive(struct strbuf *zip_path)
136
+{
137
+ struct strvec archiver_args = STRVEC_INIT;
138
+ char **argv_copy = NULL;
139
+ int stdout_fd = -1, archiver_fd = -1;
140
+ struct strbuf buf = STRBUF_INIT;
141
+ int res;
142
+
143
+ stdout_fd = dup(STDOUT_FILENO);
144
+ if (stdout_fd < 0) {
145
+ res = error_errno(_("could not duplicate stdout"));
146
+ goto diagnose_cleanup;
147
+ }
148
+
149
+ archiver_fd = xopen(zip_path->buf, O_CREAT | O_WRONLY | O_TRUNC, 0666);
150
+ if (dup2(archiver_fd, STDOUT_FILENO) < 0) {
151
+ res = error_errno(_("could not redirect output"));
152
+ goto diagnose_cleanup;
153
+ }
154
+
155
+ init_zip_archiver();
156
+ strvec_pushl(&archiver_args, "git-diagnose", "--format=zip", NULL);
157
+
158
+ strbuf_reset(&buf);
159
+ strbuf_addstr(&buf, "Collecting diagnostic info\n\n");
160
+ get_version_info(&buf, 1);
161
+
162
+ strbuf_addf(&buf, "Repository root: %s\n", the_repository->worktree);
163
+ get_disk_info(&buf);
164
+ write_or_die(stdout_fd, buf.buf, buf.len);
165
+ strvec_pushf(&archiver_args,
166
+ "--add-virtual-file=diagnostics.log:%.*s",
167
+ (int)buf.len, buf.buf);
168
+
169
+ strbuf_reset(&buf);
170
+ strbuf_addstr(&buf, "--add-virtual-file=packs-local.txt:");
171
+ dir_file_stats(the_repository->objects->odb, &buf);
172
+ foreach_alt_odb(dir_file_stats, &buf);
173
+ strvec_push(&archiver_args, buf.buf);
174
+
175
+ strbuf_reset(&buf);
176
+ strbuf_addstr(&buf, "--add-virtual-file=objects-local.txt:");
177
+ loose_objs_stats(&buf, ".git/objects");
178
+ strvec_push(&archiver_args, buf.buf);
179
+
180
+ if ((res = add_directory_to_archiver(&archiver_args, ".git", 0)) ||
181
+ (res = add_directory_to_archiver(&archiver_args, ".git/hooks", 0)) ||
182
+ (res = add_directory_to_archiver(&archiver_args, ".git/info", 0)) ||
183
+ (res = add_directory_to_archiver(&archiver_args, ".git/logs", 1)) ||
184
+ (res = add_directory_to_archiver(&archiver_args, ".git/objects/info", 0)))
185
+ goto diagnose_cleanup;
186
+
187
+ strvec_pushl(&archiver_args, "--prefix=",
188
+ oid_to_hex(the_hash_algo->empty_tree), "--", NULL);
189
+
190
+ /* `write_archive()` modifies the `argv` passed to it. Let it. */
191
+ argv_copy = xmemdupz(archiver_args.v,
192
+ sizeof(char *) * archiver_args.nr);
193
+ res = write_archive(archiver_args.nr, (const char **)argv_copy, NULL,
194
+ the_repository, NULL, 0);
195
+ if (res) {
196
+ error(_("failed to write archive"));
197
+ goto diagnose_cleanup;
198
+ }
199
+
200
+ fprintf(stderr, "\n"
201
+ "Diagnostics complete.\n"
202
+ "All of the gathered info is captured in '%s'\n",
203
+ zip_path->buf);
204
+
205
+diagnose_cleanup:
206
+ if (archiver_fd >= 0) {
207
+ dup2(stdout_fd, STDOUT_FILENO);
208
+ close(stdout_fd);
209
+ close(archiver_fd);
210
+ }
211
+ free(argv_copy);
212
+ strvec_clear(&archiver_args);
213
+ strbuf_release(&buf);
214
+
215
+ return res;
216
+}
diagnose.h
new
+8
@@ -0,0 +1,8 @@
1
+#ifndef DIAGNOSE_H
2
+#define DIAGNOSE_H
3
+
4
+#include "strbuf.h"
5
+
6
+int create_diagnostics_archive(struct strbuf *zip_path);
7
+
8
+#endif /* DIAGNOSE_H */