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 /** The decimal representation of an uint64_t never exceeds that size. */
20 #define FORMATED_VALUE_SIZE 25
22 #define GLOBAL_LIST_ATOMS \
25 ATOM(dirname, STRING) \
27 #define ATOM(x, y) { .name = #x, .type = AT_ ## y},
28 struct atom global_list_atoms[] = {
33 #define ATOM(x, y) gla_ ## x,
34 enum global_list_atoms {GLOBAL_LIST_ATOMS};
37 #define GLOBAL_SUMMARY_ATOMS \
42 #define ATOM(x, y) { .name = #x, .type = AT_ ## y},
43 struct atom global_summary_atoms[] = {
48 #define ATOM(x, y) gsa_ ## x,
49 enum global_summary_atoms {GLOBAL_SUMMARY_ATOMS};
52 #define USER_SUMMARY_ATOMS \
53 ATOM(pw_name, STRING) \
59 #define ATOM(x, y) { .name = #x, .type = AT_ ## y},
60 struct atom user_summary_atoms[] = {
65 #define ATOM(x, y) usa_ ## x,
66 enum user_summary_atoms {USER_SUMMARY_ATOMS};
71 /* these get filled in by the select command. */
72 static char count_unit_buf[4] = "( )", size_unit_buf[4] = "( )";
74 struct global_list_info {
78 struct format_info *fi;
81 struct global_summary_info {
82 /** Global dir count. */
84 /** Global files count. */
86 /** Global bytes count. */
92 enum user_stats_flags {
93 USF_PRINT_DIRNAME = 1,
96 USF_COMPUTE_SUMMARY = 8,
99 struct user_stats_info {
101 enum user_stats_flags flags;
104 struct user_info *ui;
107 static const uint64_t size_unit_divisors[] = {
108 [size_unit_arg_b] = 1ULL,
109 [size_unit_arg_k] = 1024ULL,
110 [size_unit_arg_m] = 1024ULL * 1024ULL,
111 [size_unit_arg_g] = 1024ULL * 1024ULL * 1024ULL,
112 [size_unit_arg_t] = 1024ULL * 1024ULL * 1024ULL * 1024ULL,
115 static const uint64_t count_unit_divisors[] = {
117 [count_unit_arg_n] = 1ULL,
118 [count_unit_arg_k] = 1000ULL,
119 [count_unit_arg_m] = 1000ULL * 1000ULL,
120 [count_unit_arg_g] = 1000ULL * 1000ULL * 1000ULL,
121 [count_unit_arg_t] = 1000ULL * 1000ULL * 1000ULL * 1000ULL,
124 static const char size_unit_abbrevs[] = " BKMGT";
125 static const char count_unit_abbrevs[] = " kmgt";
126 static enum enum_size_unit format_size_value(enum enum_size_unit unit,
127 uint64_t value, int print_unit, char *result)
129 enum enum_size_unit u = unit;
130 char unit_buf[2] = "\0\0";
132 if (unit == size_unit_arg_h) /* human readable */
133 for (u = size_unit_arg_b; u < size_unit_arg_t &&
134 value > size_unit_divisors[u + 1]; u++)
137 unit_buf[0] = size_unit_abbrevs[u];
138 sprintf(result, "%llu%s",
139 (long long unsigned)value / size_unit_divisors[u], unit_buf);
143 static enum enum_count_unit format_count_value(enum enum_count_unit unit,
144 uint64_t value, int print_unit, char *result)
146 enum enum_count_unit u = unit;
147 char unit_buf[2] = "\0\0";
149 if (unit == count_unit_arg_h) /* human readable */
150 for (u = count_unit_arg_n; u < count_unit_arg_t &&
151 value > count_unit_divisors[u + 1]; u++)
154 unit_buf[0] = count_unit_abbrevs[u];
155 sprintf(result, "%llu%s",
156 (long long unsigned)value / count_unit_divisors[u], unit_buf);
160 static FILE *output_file;
162 __printf_1_2 static int output(const char const *fmt, ...)
168 ret = vfprintf(output_file, fmt, argp);
170 return ret < 0? -E_OUTPUT : 1;
173 static int get_dir_name_by_number(uint64_t *dirnum, char **name)
175 char *result = NULL, *tmp;
177 uint64_t val = *dirnum;
178 struct osl_object obj;
184 obj.size = sizeof(val);
185 ret = osl(osl_get_row(dir_table, DT_NUM, &obj, &row));
188 ret = osl(osl_get_object(dir_table, row, DT_PARENT_NUM, &obj));
191 val = *(uint64_t *)obj.data;
192 ret = osl(osl_get_object(dir_table, row, DT_NAME, &obj));
195 pfx = (select_conf.print_base_dir_given || val)? (char *)obj.data : ".";
196 tmp = make_message("%s/%s", pfx, result? result : "");
212 static int get_dir_name_of_row(struct osl_row *dir_table_row, char **name)
214 struct osl_object obj;
218 ret = osl(osl_get_object(dir_table, dir_table_row, DT_NUM, &obj));
221 return get_dir_name_by_number((uint64_t *)obj.data, name);
224 static int get_num_files_of_row(struct osl_row *row, uint64_t *num_files)
226 struct osl_object obj;
227 int ret = osl(osl_get_object(dir_table, row, DT_FILES, &obj));
230 *num_files = *(uint64_t *)obj.data;
234 static int get_num_bytes_of_row(struct osl_row *row, uint64_t *num_bytes)
236 struct osl_object obj;
237 int ret = osl(osl_get_object(dir_table, row, DT_BYTES, &obj));
240 *num_bytes = *(uint64_t *)obj.data;
245 static int user_stats_loop_function(struct osl_row *row, void *data)
247 struct user_stats_info *usi = data;
248 struct osl_object obj;
249 int ret, summary = usi->flags & USF_COMPUTE_SUMMARY;
250 char formated_value[FORMATED_VALUE_SIZE];
253 if (!usi->count && !summary) {
254 ret = -E_LOOP_COMPLETE;
257 if (summary || (usi->count && (usi->flags & USF_PRINT_FILES))) {
259 ret = osl(osl_get_object(usi->ui->table, row, UT_FILES, &obj));
262 files = *(uint64_t *)obj.data;
263 if (usi->count && (usi->flags & USF_PRINT_FILES)) {
264 format_count_value(select_conf.count_unit_arg, files,
265 select_conf.count_unit_arg == count_unit_arg_h,
267 ret = output("\t%s%s", formated_value,
268 (usi->flags & (USF_PRINT_BYTES | USF_PRINT_DIRNAME))?
274 usi->ui->files += files;
276 if (summary || (usi->count && (usi->flags & USF_PRINT_BYTES))) {
278 ret = osl(osl_get_object(usi->ui->table, row, UT_BYTES, &obj));
281 bytes = *(uint64_t *)obj.data;
282 if (usi->count && (usi->flags & USF_PRINT_BYTES)) {
283 format_size_value(select_conf.size_unit_arg, bytes,
284 select_conf.size_unit_arg == size_unit_arg_h,
286 ret = output("%s%s%s",
287 (usi->flags & USF_PRINT_FILES)? "" : "\t",
289 usi->flags & USF_PRINT_DIRNAME? "\t" : "\n"
295 usi->ui->bytes += bytes;
300 if (usi->count && (usi->flags & USF_PRINT_DIRNAME)) {
302 ret = osl(osl_get_object(usi->ui->table, row, UT_DIR_NUM, &obj));
305 ret = get_dir_name_by_number((uint64_t *)obj.data, &dirname);
308 ret = output("%s%s\n",
309 (usi->flags & (USF_PRINT_BYTES | USF_PRINT_FILES))? "" : "\t",
320 usi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
324 static int check_loop_return(int ret, int loop_ret, int loop_osl_errno)
328 assert(ret == -E_OSL);
329 if (osl_errno != E_OSL_LOOP)
330 /* error not caused by loop function returning negative. */
332 assert(loop_ret < 0);
333 if (loop_ret == -E_LOOP_COMPLETE) /* no error */
335 if (loop_ret == -E_OSL) { /* osl error in loop function */
336 assert(loop_osl_errno);
337 osl_errno = loop_osl_errno;
342 static int adu_loop_reverse(struct osl_table *t, unsigned col_num, void *private_data,
343 osl_rbtree_loop_func *func, int *loop_ret, int *loop_osl_errno)
345 int ret = osl(osl_rbtree_loop_reverse(t, col_num, private_data, func));
346 return check_loop_return(ret, *loop_ret, *loop_osl_errno);
349 static int global_summary_loop_function(struct osl_row *row, void *data)
351 struct global_summary_info *gsi = data;
355 ret = get_num_files_of_row(row, &num);
358 gsi->num_files += num;
360 ret = get_num_bytes_of_row(row, &num);
363 gsi->num_bytes += num;
368 gsi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
372 static int print_global_summary(struct format_info *fi)
376 struct global_summary_info gsi = {.num_dirs = 0};
378 union atom_value values[] = {
379 [gsa_dirs] = {.num_value = 0ULL},
380 [gsa_files] = {.num_value = 0ULL},
381 [gsa_size] = {.num_value = 0ULL}
384 ret = adu_loop_reverse(dir_table, DT_BYTES, &gsi,
385 global_summary_loop_function, &gsi.ret, &gsi.osl_errno);
388 values[gsa_dirs].num_value = (long long unsigned)gsi.num_dirs;
389 values[gsa_files].num_value = (long long unsigned)gsi.num_files;
390 values[gsa_size].num_value = (long long unsigned)gsi.num_bytes;
391 if (!select_conf.no_headers_given) {
392 ret = output("Global summary\n");
396 buf = format_items(fi, values);
397 ret = output("%s", buf);
402 static int print_user_summary_line(struct user_info *ui, __a_unused void *data)
404 struct format_info *fi = data;
405 union atom_value values[] = {
406 [usa_pw_name] = {.string_value = ui->pw_name?
408 [usa_uid] = {.num_value = (long long unsigned)ui->uid},
409 [usa_dirs] = {.num_value = (long long unsigned)ui->dirs},
410 [usa_files] = {.num_value = (long long unsigned)ui->files},
411 [usa_size] = {.num_value = (long long unsigned)ui->bytes}
413 char *buf = format_items(fi, values);
414 int ret = output("%s", buf);
420 static int name_comp(const void *a, const void *b)
422 char *x = ((struct user_info *)a)->pw_name;
423 char *y = ((struct user_info *)b)->pw_name;
432 static int uid_comp(const void *a, const void *b)
434 return -NUM_COMPARE(((struct user_info *)a)->uid,
435 ((struct user_info *)b)->uid);
438 static int dir_count_comp(const void *a, const void *b)
440 return NUM_COMPARE(((struct user_info *)a)->dirs,
441 ((struct user_info *)b)->dirs);
444 static int file_count_comp(const void *a, const void *b)
446 return NUM_COMPARE(((struct user_info *)a)->files,
447 ((struct user_info *)b)->files);
450 static int size_comp(const void *a, const void *b)
452 return NUM_COMPARE(((struct user_info *)a)->bytes,
453 ((struct user_info *)b)->bytes);
457 * The comparators for sorting the user summary.
459 * This is an array of pointers to functions taking two constant void *
460 * pointers and returning an int.
462 static int (*summary_comparators[])(const void *, const void *) = {
463 [user_summary_sort_arg_name] = name_comp,
464 [user_summary_sort_arg_uid] = uid_comp,
465 [user_summary_sort_arg_dir_count] = dir_count_comp,
466 [user_summary_sort_arg_file_count] = file_count_comp,
467 [user_summary_sort_arg_size] = size_comp,
470 static int print_user_summary(struct format_info *fi)
472 if (!select_conf.no_headers_given) {
473 int ret = output("User summary\n");
477 sort_hash_table(summary_comparators[select_conf.user_summary_sort_arg]);
478 return for_each_admissible_user(print_user_summary_line, fi);
481 static int print_user_list(struct user_info *ui, __a_unused void *data)
484 struct user_stats_info usi;
485 enum enum_user_list ula = select_conf.user_list_arg;
486 int print_size_list = (ula == user_list_arg_size
487 || ula == user_list_arg_both);
489 if (print_size_list) {
490 usi.count = select_conf.limit_arg;
492 usi.flags = USF_PRINT_DIRNAME | USF_PRINT_BYTES | USF_COMPUTE_SUMMARY;
493 if (!select_conf.no_headers_given) {
494 ret = output("%s (uid %u), by size%s:\n",
495 ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid,
500 ret = adu_loop_reverse(ui->table, UT_BYTES, &usi, user_stats_loop_function,
501 &usi.ret, &usi.osl_errno);
508 if (ula == user_list_arg_file_count || ula == user_list_arg_both) {
509 if (!select_conf.no_headers_given) {
510 ret = output("%s (uid %u), by file count%s:\n",
511 ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid,
516 usi.count = select_conf.limit_arg,
518 usi.flags = USF_PRINT_DIRNAME | USF_PRINT_FILES;
519 ret = adu_loop_reverse(ui->table, UT_FILES, &usi, user_stats_loop_function,
520 &usi.ret, &usi.osl_errno);
527 if (ula == user_list_arg_none && !select_conf.no_user_summary_given) {
528 usi.count = select_conf.limit_arg;
530 usi.flags = USF_COMPUTE_SUMMARY;
531 ret = adu_loop_reverse(ui->table, UT_FILES, &usi, user_stats_loop_function,
532 &usi.ret, &usi.osl_errno);
539 static int print_user_lists(void)
541 return for_each_admissible_user(print_user_list, NULL);
544 static int global_list_loop_function(struct osl_row *row, void *data)
546 struct global_list_info *gli = data;
547 union atom_value values[] = {
548 [gla_size] = {.num_value = 0ULL},
549 [gla_files] = {.num_value = 0ULL},
550 [gla_dirname] = {.string_value = NULL}
552 uint64_t num_files, num_bytes;
557 ret = -E_LOOP_COMPLETE;
561 ret = get_num_files_of_row(row, &num_files);
564 values[gla_files].num_value = (long long unsigned)num_files;
566 ret = get_num_bytes_of_row(row, &num_bytes);
569 values[gla_size].num_value = (long long unsigned)num_bytes;
571 ret = get_dir_name_of_row(row, &dirname);
574 values[gla_dirname].string_value = dirname;
576 buf = format_items(gli->fi, values);
578 ret = output("%s", buf);
585 gli->osl_errno = (ret == -E_OSL)? osl_errno : 0;
589 static int print_global_list(struct format_info *fi)
592 enum dir_table_columns sort_column = DT_BYTES;
593 struct global_list_info gli = {
595 .count = select_conf.limit_arg
598 if (!select_conf.no_headers_given) {
599 ret = output("Global list\n");
603 if (select_conf.sort_arg == sort_arg_files)
604 sort_column = DT_FILES;
605 return adu_loop_reverse(dir_table, sort_column, &gli,
606 global_list_loop_function, &gli.ret, &gli.osl_errno);
609 static int print_statistics(struct select_format_info *sli)
613 switch (select_conf.select_mode_arg) {
614 case select_mode_arg_global_list:
615 ret = print_global_list(sli->global_list_fi);
616 free_format_info(sli->global_list_fi);
618 case select_mode_arg_global_summary:
619 ret = print_global_summary(sli->global_summary_fi);
620 free_format_info(sli->global_summary_fi);
622 case select_mode_arg_user_list:
623 ret = print_user_lists();
625 case select_mode_arg_user_summary:
626 ret = print_user_summary(sli->user_summary_fi);
627 free_format_info(sli->user_summary_fi);
630 ERROR_LOG("bad select mode\n");
631 return ERRNO_TO_ERROR(-EINVAL);
634 static int read_uid_file(struct uid_range *admissible_uids)
638 char *filename = get_uid_list_name(), *map;
639 int ret = mmap_full_file(filename, O_RDONLY, (void **)&map, &size, NULL);
643 INFO_LOG("failed to map %s\n", filename);
648 INFO_LOG("found %u uids in %s\n", (unsigned)num_uids, filename);
651 * Compute number of hash table bits. The hash table size must be a
652 * power of two and larger than the number of uids.
655 while (1 << bits < num_uids)
657 create_hash_table(bits);
658 for (n = 0; n < num_uids; n++) {
659 uint32_t uid = read_u32(map + n * sizeof(uid));
660 ret = search_uid(uid, admissible_uids, OPEN_USER_TABLE, NULL);
665 adu_munmap(map, size);
669 int run_select_query(struct uid_range *admissible_uids,
670 struct select_format_info *sfi)
674 if (select_conf.output_given && strcmp(select_conf.output_arg, "-")) {
675 output_file = fopen(select_conf.output_arg, "w");
677 return -ERRNO_TO_ERROR(errno);
679 output_file = stdout;
681 if (select_conf.count_unit_arg != count_unit_arg_h)
682 count_unit_buf[1] = count_unit_abbrevs[select_conf.count_unit_arg];
684 count_unit_buf[0] = '\0';
685 if (select_conf.size_unit_arg != size_unit_arg_h)
686 size_unit_buf[1] = size_unit_abbrevs[select_conf.size_unit_arg];
688 size_unit_buf[0] = '\0';
690 ret = open_dir_table(0);
694 ret = read_uid_file(admissible_uids);
698 ret = print_statistics(sfi);
701 if (output_file != stdout)
706 /* return: < 0: error, >0: OK, == 0: help given */
707 int parse_select_options(char *string, struct select_cmdline_parser_params *params,
708 struct uid_range **admissible_uids, struct select_format_info *sfi)
713 if (conf.select_options_given) {
717 ret = create_argv(string, &argv);
721 ret = select_cmdline_parser_ext(argc, argv, &select_conf, params);
725 if (select_conf.help_given || select_conf.detailed_help_given)
729 ret = parse_uid_arg(select_conf.uid_arg, admissible_uids);
732 ret = parse_format_string(select_conf.user_summary_format_arg,
733 user_summary_atoms, &sfi->user_summary_fi);
736 ret = parse_format_string(select_conf.global_summary_format_arg,
737 global_summary_atoms, &sfi->global_summary_fi);
739 goto global_summary_err;
740 ret = parse_format_string(select_conf.global_list_format_arg,
741 global_list_atoms, &sfi->global_list_fi);
743 goto global_list_err;
746 free_format_info(sfi->global_summary_fi);
748 free_format_info(sfi->user_summary_fi);
751 line = select_conf.detailed_help_given?
752 select_args_info_detailed_help : select_args_info_help;
754 output_file = stdout;
755 for (; *line; line++) {
756 ret = output("%s\n", *line);
765 struct uid_range *admissible_uids = NULL;
766 struct select_format_info sfi;
768 struct select_cmdline_parser_params params = {
772 .check_ambiguity = 1,
776 select_cmdline_parser_init(&select_conf);
777 ret = parse_select_options(conf.select_options_arg, ¶ms,
778 &admissible_uids, &sfi);
779 if (ret <= 0) /* do not run query if help was given */
781 return run_select_query(admissible_uids, &sfi);