2 * Copyright (C) 2008 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file select.c The select mode of adu. */
9 #include <dirent.h> /* readdir() */
12 #include "gcc-compat.h"
17 #include "portable_io.h"
19 /** Global dir count. */
20 static uint64_t num_dirs;
21 /** Global files count. */
22 static uint64_t num_files;
23 /** Global bytes count. */
24 static uint64_t num_bytes;
27 /** The decimal representation of an uint64_t never exceeds that size. */
28 #define FORMATED_VALUE_SIZE 25
30 #define GLOBAL_SUMMARY_ATOMS \
35 #define ATOM(x, y) { .name = #x, .type = AT_ ## y},
36 struct atom global_summary_atoms[] = {
41 #define ATOM(x, y) gsa_ ## x,
42 enum global_summary_atoms {GLOBAL_SUMMARY_ATOMS};
45 #define USER_SUMMARY_ATOMS \
46 ATOM(pw_name, STRING) \
52 #define ATOM(x, y) { .name = #x, .type = AT_ ## y},
53 struct atom user_summary_atoms[] = {
58 #define ATOM(x, y) usa_ ## x,
59 enum user_summary_atoms {USER_SUMMARY_ATOMS};
63 /* these get filled in by the select command. */
64 static char count_unit_buf[4] = "( )", size_unit_buf[4] = "( )";
66 enum global_stats_flags {
67 GSF_PRINT_DIRNAME = 1,
70 GSF_COMPUTE_SUMMARY = 8,
73 struct global_stats_info {
77 enum global_stats_flags flags;
80 enum user_stats_flags {
81 USF_PRINT_DIRNAME = 1,
84 USF_COMPUTE_SUMMARY = 8,
87 struct user_stats_info {
89 enum user_stats_flags flags;
95 static const uint64_t size_unit_divisors[] = {
96 [size_unit_arg_b] = 1ULL,
97 [size_unit_arg_k] = 1024ULL,
98 [size_unit_arg_m] = 1024ULL * 1024ULL,
99 [size_unit_arg_g] = 1024ULL * 1024ULL * 1024ULL,
100 [size_unit_arg_t] = 1024ULL * 1024ULL * 1024ULL * 1024ULL,
103 static const uint64_t count_unit_divisors[] = {
105 [count_unit_arg_n] = 1ULL,
106 [count_unit_arg_k] = 1000ULL,
107 [count_unit_arg_m] = 1000ULL * 1000ULL,
108 [count_unit_arg_g] = 1000ULL * 1000ULL * 1000ULL,
109 [count_unit_arg_t] = 1000ULL * 1000ULL * 1000ULL * 1000ULL,
112 static const char size_unit_abbrevs[] = " BKMGT";
113 static const char count_unit_abbrevs[] = " kmgt";
114 static enum enum_size_unit format_size_value(enum enum_size_unit unit,
115 uint64_t value, int print_unit, char *result)
117 enum enum_size_unit u = unit;
118 char unit_buf[2] = "\0\0";
120 if (unit == size_unit_arg_h) /* human readable */
121 for (u = size_unit_arg_b; u < size_unit_arg_t &&
122 value > size_unit_divisors[u + 1]; u++)
125 unit_buf[0] = size_unit_abbrevs[u];
126 sprintf(result, "%llu%s",
127 (long long unsigned)value / size_unit_divisors[u], unit_buf);
131 static enum enum_count_unit format_count_value(enum enum_count_unit unit,
132 uint64_t value, int print_unit, char *result)
134 enum enum_count_unit u = unit;
135 char unit_buf[2] = "\0\0";
137 if (unit == count_unit_arg_h) /* human readable */
138 for (u = count_unit_arg_n; u < count_unit_arg_t &&
139 value > count_unit_divisors[u + 1]; u++)
142 unit_buf[0] = count_unit_abbrevs[u];
143 sprintf(result, "%llu%s",
144 (long long unsigned)value / count_unit_divisors[u], unit_buf);
148 static FILE *output_file;
150 __printf_1_2 static int output(const char const *fmt, ...)
156 ret = vfprintf(output_file, fmt, argp);
158 return ret < 0? -E_OUTPUT : 1;
161 static int get_dir_name_by_number(uint64_t *dirnum, char **name)
163 char *result = NULL, *tmp;
165 uint64_t val = *dirnum;
166 struct osl_object obj;
172 obj.size = sizeof(val);
173 ret = osl(osl_get_row(dir_table, DT_NUM, &obj, &row));
176 ret = osl(osl_get_object(dir_table, row, DT_PARENT_NUM, &obj));
179 val = *(uint64_t *)obj.data;
180 ret = osl(osl_get_object(dir_table, row, DT_NAME, &obj));
183 pfx = (select_conf.print_base_dir_given || val)? (char *)obj.data : ".";
184 tmp = make_message("%s/%s", pfx, result? result : "");
200 static int get_dir_name_of_row(struct osl_row *dir_table_row, char **name)
202 struct osl_object obj;
206 ret = osl(osl_get_object(dir_table, dir_table_row, DT_NUM, &obj));
209 return get_dir_name_by_number((uint64_t *)obj.data, name);
212 static int user_stats_loop_function(struct osl_row *row, void *data)
214 struct user_stats_info *usi = data;
215 struct osl_object obj;
216 int ret, summary = usi->flags & GSF_COMPUTE_SUMMARY;
217 char formated_value[FORMATED_VALUE_SIZE];
220 if (!usi->count && !summary) {
221 ret = -E_LOOP_COMPLETE;
224 if (summary || (usi->count && (usi->flags & USF_PRINT_FILES))) {
226 ret = osl(osl_get_object(usi->ui->table, row, UT_FILES, &obj));
229 files = *(uint64_t *)obj.data;
230 if (usi->count && (usi->flags & USF_PRINT_FILES)) {
231 format_count_value(select_conf.count_unit_arg, files,
232 select_conf.count_unit_arg == count_unit_arg_h,
234 ret = output("\t%s%s", formated_value,
235 (usi->flags & (USF_PRINT_BYTES | USF_PRINT_DIRNAME))?
241 usi->ui->files += files;
243 if (summary || (usi->count && (usi->flags & USF_PRINT_BYTES))) {
245 ret = osl(osl_get_object(usi->ui->table, row, UT_BYTES, &obj));
248 bytes = *(uint64_t *)obj.data;
249 if (usi->count && (usi->flags & USF_PRINT_BYTES)) {
250 format_size_value(select_conf.size_unit_arg, bytes,
251 select_conf.size_unit_arg == size_unit_arg_h,
253 ret = output("%s%s%s",
254 (usi->flags & USF_PRINT_FILES)? "" : "\t",
256 usi->flags & USF_PRINT_DIRNAME? "\t" : "\n"
262 usi->ui->bytes += bytes;
267 if (usi->count && (usi->flags & USF_PRINT_DIRNAME)) {
269 ret = osl(osl_get_object(usi->ui->table, row, UT_DIR_NUM, &obj));
272 ret = get_dir_name_by_number((uint64_t *)obj.data, &dirname);
275 ret = output("%s%s\n",
276 (usi->flags & (USF_PRINT_BYTES | USF_PRINT_FILES))? "" : "\t",
287 usi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
291 static int global_stats_loop_function(struct osl_row *row, void *data)
293 struct global_stats_info *gsi = data;
294 struct osl_object obj;
295 char *dirname, formated_value[FORMATED_VALUE_SIZE];
296 int ret, summary = gsi->flags & GSF_COMPUTE_SUMMARY;
299 if (!gsi->count && !summary) {
300 ret = -E_LOOP_COMPLETE;
303 if (summary || (gsi->count && (gsi->flags & GSF_PRINT_FILES))) {
305 ret = osl(osl_get_object(dir_table, row, DT_FILES, &obj));
308 files = *(uint64_t *)obj.data;
309 if (gsi->count && (gsi->flags & GSF_PRINT_FILES)) {
310 format_count_value(select_conf.count_unit_arg, files,
311 select_conf.count_unit_arg == count_unit_arg_h,
313 ret = output("\t%s%s", formated_value,
314 (gsi->flags & (GSF_PRINT_BYTES | GSF_PRINT_DIRNAME))?
322 if (summary || (gsi->count && (gsi->flags & GSF_PRINT_BYTES))) {
324 ret = osl(osl_get_object(dir_table, row, DT_BYTES, &obj));
327 bytes = *(uint64_t *)obj.data;
328 if (gsi->count && (gsi->flags & GSF_PRINT_BYTES)) {
329 format_size_value(select_conf.size_unit_arg, bytes,
330 select_conf.size_unit_arg == size_unit_arg_h,
332 ret = output("%s%s%s",
333 (gsi->flags & GSF_PRINT_FILES)? "" : "\t",
335 (gsi->flags & GSF_PRINT_DIRNAME)? "\t" : "\n"
345 if (gsi->count && (gsi->flags & GSF_PRINT_DIRNAME)) {
346 ret = get_dir_name_of_row(row, &dirname);
349 ret = output("%s%s\n",
350 (gsi->flags & (GSF_PRINT_BYTES | GSF_PRINT_FILES))? "" : "\t",
361 gsi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
365 static int check_loop_return(int ret, int loop_ret, int loop_osl_errno)
369 assert(ret == -E_OSL);
370 if (osl_errno != E_OSL_LOOP)
371 /* error not caused by loop function returning negative. */
373 assert(loop_ret < 0);
374 if (loop_ret == -E_LOOP_COMPLETE) /* no error */
376 if (loop_ret == -E_OSL) { /* osl error in loop function */
377 assert(loop_osl_errno);
378 osl_errno = loop_osl_errno;
383 static int adu_loop_reverse(struct osl_table *t, unsigned col_num, void *private_data,
384 osl_rbtree_loop_func *func, int *loop_ret, int *loop_osl_errno)
386 int ret = osl(osl_rbtree_loop_reverse(t, col_num, private_data, func));
387 return check_loop_return(ret, *loop_ret, *loop_osl_errno);
390 static int print_global_summary(struct format_info *fi)
394 union atom_value values[] = {
395 [gsa_dirs] = {.num_value = (long long unsigned)num_dirs},
396 [gsa_files] = {.num_value = (long long unsigned)num_files},
397 [gsa_size] = {.num_value = (long long unsigned)num_bytes}
400 if (select_conf.no_global_summary_given)
402 if (!select_conf.no_headers_given) {
403 ret = output("Global summary\n");
407 buf = format_items(fi, values);
408 ret = output("%s", buf);
413 static int print_user_summary_line(struct user_info *ui, __a_unused void *data)
415 struct format_info *fi = data;
416 union atom_value values[] = {
417 [usa_pw_name] = {.string_value = ui->pw_name?
419 [usa_uid] = {.num_value = (long long unsigned)ui->uid},
420 [usa_dirs] = {.num_value = (long long unsigned)ui->dirs},
421 [usa_files] = {.num_value = (long long unsigned)ui->files},
422 [usa_size] = {.num_value = (long long unsigned)ui->bytes}
424 char *buf = format_items(fi, values);
425 int ret = output("%s", buf);
431 static int name_comp(const void *a, const void *b)
433 char *x = ((struct user_info *)a)->pw_name;
434 char *y = ((struct user_info *)b)->pw_name;
443 static int uid_comp(const void *a, const void *b)
445 return -NUM_COMPARE(((struct user_info *)a)->uid,
446 ((struct user_info *)b)->uid);
449 static int dir_count_comp(const void *a, const void *b)
451 return NUM_COMPARE(((struct user_info *)a)->dirs,
452 ((struct user_info *)b)->dirs);
455 static int file_count_comp(const void *a, const void *b)
457 return NUM_COMPARE(((struct user_info *)a)->files,
458 ((struct user_info *)b)->files);
461 static int size_comp(const void *a, const void *b)
463 return NUM_COMPARE(((struct user_info *)a)->bytes,
464 ((struct user_info *)b)->bytes);
468 * The comparators for sorting the user summary.
470 * This is an array of pointers to functions taking two constant void *
471 * pointers and returning an int.
473 static int (*summary_comparators[])(const void *, const void *) = {
474 [user_summary_sort_arg_name] = name_comp,
475 [user_summary_sort_arg_uid] = uid_comp,
476 [user_summary_sort_arg_dir_count] = dir_count_comp,
477 [user_summary_sort_arg_file_count] = file_count_comp,
478 [user_summary_sort_arg_size] = size_comp,
481 static int print_user_summary(struct format_info *fi)
483 if (select_conf.no_user_summary_given)
485 if (!select_conf.no_headers_given) {
486 int ret = output("User summary\n");
490 sort_hash_table(summary_comparators[select_conf.user_summary_sort_arg]);
491 return for_each_admissible_user(print_user_summary_line, fi);
494 static int print_user_list(struct user_info *ui, __a_unused void *data)
497 struct user_stats_info usi;
498 enum enum_user_list ula = select_conf.user_list_arg;
499 int print_size_list = (ula == user_list_arg_size
500 || ula == user_list_arg_both);
502 if (print_size_list) {
503 usi.count = select_conf.limit_arg;
505 usi.flags = USF_PRINT_DIRNAME | USF_PRINT_BYTES | USF_COMPUTE_SUMMARY;
506 if (!select_conf.no_headers_given) {
507 ret = output("%s (uid %u), by size%s:\n",
508 ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid,
513 ret = adu_loop_reverse(ui->table, UT_BYTES, &usi, user_stats_loop_function,
514 &usi.ret, &usi.osl_errno);
521 if (ula == user_list_arg_file_count || ula == user_list_arg_both) {
522 if (!select_conf.no_headers_given) {
523 ret = output("%s (uid %u), by file count%s:\n",
524 ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid,
529 usi.count = select_conf.limit_arg,
531 usi.flags = USF_PRINT_DIRNAME | USF_PRINT_FILES;
532 ret = adu_loop_reverse(ui->table, UT_FILES, &usi, user_stats_loop_function,
533 &usi.ret, &usi.osl_errno);
540 if (ula == user_list_arg_none && !select_conf.no_user_summary_given) {
541 usi.count = select_conf.limit_arg;
543 usi.flags = USF_COMPUTE_SUMMARY;
544 ret = adu_loop_reverse(ui->table, UT_FILES, &usi, user_stats_loop_function,
545 &usi.ret, &usi.osl_errno);
552 static int print_user_lists(void)
554 return for_each_admissible_user(print_user_list, NULL);
557 static int print_global_lists(void)
559 struct global_stats_info gsi;
561 enum enum_global_list gla = select_conf.global_list_arg;
562 int print_size_list = (gla == global_list_arg_size
563 || gla == global_list_arg_both);
565 if (print_size_list) {
566 gsi.count = select_conf.limit_arg;
567 gsi.flags = GSF_PRINT_DIRNAME | GSF_PRINT_BYTES | GSF_COMPUTE_SUMMARY;
568 if (!select_conf.no_headers_given) {
569 ret = output("By size%s:\n", size_unit_buf);
573 ret = adu_loop_reverse(dir_table, DT_BYTES, &gsi,
574 global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
581 if (gla == global_list_arg_file_count || gla == global_list_arg_both) {
582 gsi.count = select_conf.limit_arg;
583 gsi.flags = GSF_PRINT_DIRNAME | GSF_PRINT_FILES;
584 if (!print_size_list)
585 gsi.flags |= GSF_COMPUTE_SUMMARY;
586 if (!select_conf.no_headers_given) {
587 ret = output("By file count%s:\n", count_unit_buf);
591 ret = adu_loop_reverse(dir_table, DT_FILES, &gsi,
592 global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
599 if (gla == global_list_arg_none && !select_conf.no_global_summary_given) {
600 /* must compute summary */
601 gsi.count = select_conf.limit_arg;
602 gsi.flags = GSF_COMPUTE_SUMMARY;
603 ret = adu_loop_reverse(dir_table, DT_FILES, &gsi,
604 global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
611 static int print_statistics(struct select_format_info *sli)
615 ret = print_global_lists();
618 ret = print_global_summary(sli->global_summary_fi);
619 free_format_info(sli->global_summary_fi);
622 ret = print_user_lists();
625 ret = print_user_summary(sli->user_summary_fi);
626 free_format_info(sli->user_summary_fi);
632 static int read_uid_file(struct uid_range *admissible_uids)
636 char *filename = get_uid_list_name(), *map;
637 int ret = mmap_full_file(filename, O_RDONLY, (void **)&map, &size, NULL);
641 INFO_LOG("failed to map %s\n", filename);
646 INFO_LOG("found %u uids in %s\n", (unsigned)num_uids, filename);
649 * Compute number of hash table bits. The hash table size must be a
650 * power of two and larger than the number of uids.
653 while (1 << bits < num_uids)
655 create_hash_table(bits);
656 for (n = 0; n < num_uids; n++) {
657 uint32_t uid = read_u32(map + n * sizeof(uid));
658 ret = search_uid(uid, admissible_uids, OPEN_USER_TABLE, NULL);
663 adu_munmap(map, size);
667 int run_select_query(struct uid_range *admissible_uids,
668 struct select_format_info *sfi)
672 if (select_conf.output_given && strcmp(select_conf.output_arg, "-")) {
673 output_file = fopen(select_conf.output_arg, "w");
675 return -ERRNO_TO_ERROR(errno);
677 output_file = stdout;
679 if (select_conf.count_unit_arg != count_unit_arg_h)
680 count_unit_buf[1] = count_unit_abbrevs[select_conf.count_unit_arg];
682 count_unit_buf[0] = '\0';
683 if (select_conf.size_unit_arg != size_unit_arg_h)
684 size_unit_buf[1] = size_unit_abbrevs[select_conf.size_unit_arg];
686 size_unit_buf[0] = '\0';
688 ret = open_dir_table(0);
692 ret = read_uid_file(admissible_uids);
696 ret = print_statistics(sfi);
699 if (output_file != stdout)
704 /* return: < 0: error, >0: OK, == 0: help given */
705 int parse_select_options(char *string, struct select_cmdline_parser_params *params,
706 struct uid_range **admissible_uids, struct select_format_info *sfi)
711 if (conf.select_options_given) {
715 ret = create_argv(string, &argv);
719 ret = select_cmdline_parser_ext(argc, argv, &select_conf, params);
723 if (select_conf.help_given || select_conf.detailed_help_given)
727 ret = parse_uid_arg(select_conf.uid_arg, admissible_uids);
730 ret = parse_format_string(select_conf.user_summary_format_arg,
731 user_summary_atoms, &sfi->user_summary_fi);
734 ret = parse_format_string(select_conf.global_summary_format_arg,
735 global_summary_atoms, &sfi->global_summary_fi);
737 free_format_info(sfi->user_summary_fi);
742 line = select_conf.detailed_help_given?
743 select_args_info_detailed_help : select_args_info_help;
745 output_file = stdout;
746 for (; *line; line++) {
747 ret = output("%s\n", *line);
756 struct uid_range *admissible_uids = NULL;
757 struct select_format_info sfi;
759 struct select_cmdline_parser_params params = {
763 .check_ambiguity = 1,
767 select_cmdline_parser_init(&select_conf);
768 ret = parse_select_options(conf.select_options_arg, ¶ms,
769 &admissible_uids, &sfi);
770 if (ret <= 0) /* do not run query if help was given */
772 return run_select_query(admissible_uids, &sfi);