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 struct user_summary_info {
99 enum user_stats_flags {
100 USF_PRINT_DIRNAME = 1,
103 USF_COMPUTE_SUMMARY = 8,
106 struct user_stats_info {
108 enum user_stats_flags flags;
111 struct user_info *ui;
114 static const uint64_t size_unit_divisors[] = {
115 [size_unit_arg_b] = 1ULL,
116 [size_unit_arg_k] = 1024ULL,
117 [size_unit_arg_m] = 1024ULL * 1024ULL,
118 [size_unit_arg_g] = 1024ULL * 1024ULL * 1024ULL,
119 [size_unit_arg_t] = 1024ULL * 1024ULL * 1024ULL * 1024ULL,
122 static const uint64_t count_unit_divisors[] = {
124 [count_unit_arg_n] = 1ULL,
125 [count_unit_arg_k] = 1000ULL,
126 [count_unit_arg_m] = 1000ULL * 1000ULL,
127 [count_unit_arg_g] = 1000ULL * 1000ULL * 1000ULL,
128 [count_unit_arg_t] = 1000ULL * 1000ULL * 1000ULL * 1000ULL,
131 static const char size_unit_abbrevs[] = " BKMGT";
132 static const char count_unit_abbrevs[] = " kmgt";
133 static enum enum_size_unit format_size_value(enum enum_size_unit unit,
134 uint64_t value, int print_unit, char *result)
136 enum enum_size_unit u = unit;
137 char unit_buf[2] = "\0\0";
139 if (unit == size_unit_arg_h) /* human readable */
140 for (u = size_unit_arg_b; u < size_unit_arg_t &&
141 value > size_unit_divisors[u + 1]; u++)
144 unit_buf[0] = size_unit_abbrevs[u];
145 sprintf(result, "%llu%s",
146 (long long unsigned)value / size_unit_divisors[u], unit_buf);
150 static enum enum_count_unit format_count_value(enum enum_count_unit unit,
151 uint64_t value, int print_unit, char *result)
153 enum enum_count_unit u = unit;
154 char unit_buf[2] = "\0\0";
156 if (unit == count_unit_arg_h) /* human readable */
157 for (u = count_unit_arg_n; u < count_unit_arg_t &&
158 value > count_unit_divisors[u + 1]; u++)
161 unit_buf[0] = count_unit_abbrevs[u];
162 sprintf(result, "%llu%s",
163 (long long unsigned)value / count_unit_divisors[u], unit_buf);
167 static FILE *output_file;
169 __printf_1_2 static int output(const char const *fmt, ...)
175 ret = vfprintf(output_file, fmt, argp);
177 return ret < 0? -E_OUTPUT : 1;
180 static int get_dir_name_by_number(uint64_t *dirnum, char **name)
182 char *result = NULL, *tmp;
184 uint64_t val = *dirnum;
185 struct osl_object obj;
191 obj.size = sizeof(val);
192 ret = osl(osl_get_row(dir_table, DT_NUM, &obj, &row));
195 ret = osl(osl_get_object(dir_table, row, DT_PARENT_NUM, &obj));
198 val = *(uint64_t *)obj.data;
199 ret = osl(osl_get_object(dir_table, row, DT_NAME, &obj));
202 pfx = (select_conf.print_base_dir_given || val)? (char *)obj.data : ".";
203 tmp = make_message("%s/%s", pfx, result? result : "");
219 static int get_dir_name_of_row(struct osl_row *dir_table_row, char **name)
221 struct osl_object obj;
225 ret = osl(osl_get_object(dir_table, dir_table_row, DT_NUM, &obj));
228 return get_dir_name_by_number((uint64_t *)obj.data, name);
231 static int get_num_files_of_row(struct osl_row *row, uint64_t *num_files)
233 struct osl_object obj;
234 int ret = osl(osl_get_object(dir_table, row, DT_FILES, &obj));
237 *num_files = *(uint64_t *)obj.data;
241 static int get_num_user_files(struct osl_row *row, struct user_info *ui,
244 struct osl_object obj;
245 int ret = osl(osl_get_object(ui->table, row, UT_FILES, &obj));
249 *num_files = *(uint64_t *)obj.data;
253 static int get_num_bytes_of_row(struct osl_row *row, uint64_t *num_bytes)
255 struct osl_object obj;
256 int ret = osl(osl_get_object(dir_table, row, DT_BYTES, &obj));
259 *num_bytes = *(uint64_t *)obj.data;
263 static int get_num_user_bytes(struct osl_row *row, struct user_info *ui,
266 struct osl_object obj;
267 int ret = osl(osl_get_object(ui->table, row, UT_BYTES, &obj));
271 *num_bytes = *(uint64_t *)obj.data;
276 static int user_stats_loop_function(struct osl_row *row, void *data)
278 struct user_stats_info *usi = data;
279 struct osl_object obj;
280 int ret, summary = usi->flags & USF_COMPUTE_SUMMARY;
281 char formated_value[FORMATED_VALUE_SIZE];
284 if (!usi->count && !summary) {
285 ret = -E_LOOP_COMPLETE;
288 if (summary || (usi->count && (usi->flags & USF_PRINT_FILES))) {
290 ret = osl(osl_get_object(usi->ui->table, row, UT_FILES, &obj));
293 files = *(uint64_t *)obj.data;
294 if (usi->count && (usi->flags & USF_PRINT_FILES)) {
295 format_count_value(select_conf.count_unit_arg, files,
296 select_conf.count_unit_arg == count_unit_arg_h,
298 ret = output("\t%s%s", formated_value,
299 (usi->flags & (USF_PRINT_BYTES | USF_PRINT_DIRNAME))?
305 usi->ui->files += files;
307 if (summary || (usi->count && (usi->flags & USF_PRINT_BYTES))) {
309 ret = osl(osl_get_object(usi->ui->table, row, UT_BYTES, &obj));
312 bytes = *(uint64_t *)obj.data;
313 if (usi->count && (usi->flags & USF_PRINT_BYTES)) {
314 format_size_value(select_conf.size_unit_arg, bytes,
315 select_conf.size_unit_arg == size_unit_arg_h,
317 ret = output("%s%s%s",
318 (usi->flags & USF_PRINT_FILES)? "" : "\t",
320 usi->flags & USF_PRINT_DIRNAME? "\t" : "\n"
326 usi->ui->bytes += bytes;
331 if (usi->count && (usi->flags & USF_PRINT_DIRNAME)) {
333 ret = osl(osl_get_object(usi->ui->table, row, UT_DIR_NUM, &obj));
336 ret = get_dir_name_by_number((uint64_t *)obj.data, &dirname);
339 ret = output("%s%s\n",
340 (usi->flags & (USF_PRINT_BYTES | USF_PRINT_FILES))? "" : "\t",
351 usi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
355 static int check_loop_return(int ret, int loop_ret, int loop_osl_errno)
359 assert(ret == -E_OSL);
360 if (osl_errno != E_OSL_LOOP)
361 /* error not caused by loop function returning negative. */
363 assert(loop_ret < 0);
364 if (loop_ret == -E_LOOP_COMPLETE) /* no error */
366 if (loop_ret == -E_OSL) { /* osl error in loop function */
367 assert(loop_osl_errno);
368 osl_errno = loop_osl_errno;
373 static int adu_loop_reverse(struct osl_table *t, unsigned col_num, void *private_data,
374 osl_rbtree_loop_func *func, int *loop_ret, int *loop_osl_errno)
376 int ret = osl(osl_rbtree_loop_reverse(t, col_num, private_data, func));
377 return check_loop_return(ret, *loop_ret, *loop_osl_errno);
380 static int global_summary_loop_function(struct osl_row *row, void *data)
382 struct global_summary_info *gsi = data;
386 ret = get_num_files_of_row(row, &num);
389 gsi->num_files += num;
391 ret = get_num_bytes_of_row(row, &num);
394 gsi->num_bytes += num;
399 gsi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
403 static int print_global_summary(struct format_info *fi)
407 struct global_summary_info gsi = {.num_dirs = 0};
409 union atom_value values[] = {
410 [gsa_dirs] = {.num_value = 0ULL},
411 [gsa_files] = {.num_value = 0ULL},
412 [gsa_size] = {.num_value = 0ULL}
415 ret = adu_loop_reverse(dir_table, DT_BYTES, &gsi,
416 global_summary_loop_function, &gsi.ret, &gsi.osl_errno);
419 values[gsa_dirs].num_value = (long long unsigned)gsi.num_dirs;
420 values[gsa_files].num_value = (long long unsigned)gsi.num_files;
421 values[gsa_size].num_value = (long long unsigned)gsi.num_bytes;
422 if (!select_conf.no_headers_given) {
423 ret = output("Global summary\n");
427 buf = format_items(fi, values);
428 ret = output("%s", buf);
433 static int user_summary_loop_function(struct osl_row *row, void *data)
435 struct user_summary_info *usi = data;
439 ret = get_num_user_files(row, usi->ui, &num);
442 usi->ui->files += num;
443 ret = get_num_user_bytes(row, usi->ui, &num);
446 usi->ui->bytes += num;
451 usi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
455 static int compute_user_summary(struct user_info *ui, __a_unused void *data)
457 struct user_summary_info usi = {.ui = ui};
459 return adu_loop_reverse(ui->table, UT_BYTES, &usi, user_summary_loop_function,
460 &usi.ret, &usi.osl_errno);
463 static int print_user_summary_line(struct user_info *ui, void *data)
465 struct format_info *fi = data;
466 union atom_value values[] = {
467 [usa_pw_name] = {.string_value = ui->pw_name?
469 [usa_uid] = {.num_value = (long long unsigned)ui->uid},
470 [usa_dirs] = {.num_value = (long long unsigned)ui->dirs},
471 [usa_files] = {.num_value = (long long unsigned)ui->files},
472 [usa_size] = {.num_value = (long long unsigned)ui->bytes}
477 buf = format_items(fi, values);
478 ret = output("%s", buf);
483 static int name_comp(const void *a, const void *b)
485 char *x = ((struct user_info *)a)->pw_name;
486 char *y = ((struct user_info *)b)->pw_name;
495 static int uid_comp(const void *a, const void *b)
497 return -NUM_COMPARE(((struct user_info *)a)->uid,
498 ((struct user_info *)b)->uid);
501 static int dir_count_comp(const void *a, const void *b)
503 return NUM_COMPARE(((struct user_info *)a)->dirs,
504 ((struct user_info *)b)->dirs);
507 static int file_count_comp(const void *a, const void *b)
509 return NUM_COMPARE(((struct user_info *)a)->files,
510 ((struct user_info *)b)->files);
513 static int size_comp(const void *a, const void *b)
515 return NUM_COMPARE(((struct user_info *)a)->bytes,
516 ((struct user_info *)b)->bytes);
520 * The comparators for sorting the user summary.
522 * This is an array of pointers to functions taking two constant void *
523 * pointers and returning an int.
525 static int (*summary_comparators[])(const void *, const void *) = {
526 [user_summary_sort_arg_name] = name_comp,
527 [user_summary_sort_arg_uid] = uid_comp,
528 [user_summary_sort_arg_dir_count] = dir_count_comp,
529 [user_summary_sort_arg_file_count] = file_count_comp,
530 [user_summary_sort_arg_size] = size_comp,
533 static int print_user_summary(struct format_info *fi)
535 if (!select_conf.no_headers_given) {
536 int ret = output("User summary\n");
540 int ret = for_each_admissible_user(compute_user_summary, fi);
543 sort_hash_table(summary_comparators[select_conf.user_summary_sort_arg]);
544 return for_each_admissible_user(print_user_summary_line, fi);
547 static int print_user_list(struct user_info *ui, __a_unused void *data)
550 struct user_stats_info usi;
551 enum enum_user_list ula = select_conf.user_list_arg;
552 int print_size_list = (ula == user_list_arg_size
553 || ula == user_list_arg_both);
555 if (print_size_list) {
556 usi.count = select_conf.limit_arg;
558 usi.flags = USF_PRINT_DIRNAME | USF_PRINT_BYTES | USF_COMPUTE_SUMMARY;
559 if (!select_conf.no_headers_given) {
560 ret = output("%s (uid %u), by size%s:\n",
561 ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid,
566 ret = adu_loop_reverse(ui->table, UT_BYTES, &usi, user_stats_loop_function,
567 &usi.ret, &usi.osl_errno);
574 if (ula == user_list_arg_file_count || ula == user_list_arg_both) {
575 if (!select_conf.no_headers_given) {
576 ret = output("%s (uid %u), by file count%s:\n",
577 ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid,
582 usi.count = select_conf.limit_arg,
584 usi.flags = USF_PRINT_DIRNAME | USF_PRINT_FILES;
585 ret = adu_loop_reverse(ui->table, UT_FILES, &usi, user_stats_loop_function,
586 &usi.ret, &usi.osl_errno);
593 if (ula == user_list_arg_none && !select_conf.no_user_summary_given) {
594 usi.count = select_conf.limit_arg;
596 usi.flags = USF_COMPUTE_SUMMARY;
597 ret = adu_loop_reverse(ui->table, UT_FILES, &usi, user_stats_loop_function,
598 &usi.ret, &usi.osl_errno);
605 static int print_user_lists(void)
607 return for_each_admissible_user(print_user_list, NULL);
610 static int global_list_loop_function(struct osl_row *row, void *data)
612 struct global_list_info *gli = data;
613 union atom_value values[] = {
614 [gla_size] = {.num_value = 0ULL},
615 [gla_files] = {.num_value = 0ULL},
616 [gla_dirname] = {.string_value = NULL}
618 uint64_t num_files, num_bytes;
623 ret = -E_LOOP_COMPLETE;
627 ret = get_num_files_of_row(row, &num_files);
630 values[gla_files].num_value = (long long unsigned)num_files;
632 ret = get_num_bytes_of_row(row, &num_bytes);
635 values[gla_size].num_value = (long long unsigned)num_bytes;
637 ret = get_dir_name_of_row(row, &dirname);
640 values[gla_dirname].string_value = dirname;
642 buf = format_items(gli->fi, values);
644 ret = output("%s", buf);
651 gli->osl_errno = (ret == -E_OSL)? osl_errno : 0;
655 static int print_global_list(struct format_info *fi)
658 enum dir_table_columns sort_column = DT_BYTES;
659 struct global_list_info gli = {
661 .count = select_conf.limit_arg
664 if (!select_conf.no_headers_given) {
665 ret = output("Global list\n");
669 if (select_conf.list_sort_arg == list_sort_arg_file_count)
670 sort_column = DT_FILES;
671 return adu_loop_reverse(dir_table, sort_column, &gli,
672 global_list_loop_function, &gli.ret, &gli.osl_errno);
675 static int print_statistics(struct select_format_info *sli)
679 switch (select_conf.select_mode_arg) {
680 case select_mode_arg_global_list:
681 ret = print_global_list(sli->global_list_fi);
682 free_format_info(sli->global_list_fi);
684 case select_mode_arg_global_summary:
685 ret = print_global_summary(sli->global_summary_fi);
686 free_format_info(sli->global_summary_fi);
688 case select_mode_arg_user_list:
689 ret = print_user_lists();
691 case select_mode_arg_user_summary:
692 ret = print_user_summary(sli->user_summary_fi);
693 free_format_info(sli->user_summary_fi);
696 ERROR_LOG("bad select mode\n");
697 return ERRNO_TO_ERROR(-EINVAL);
700 static int read_uid_file(struct uid_range *admissible_uids)
704 char *filename = get_uid_list_name(), *map;
705 int ret = mmap_full_file(filename, O_RDONLY, (void **)&map, &size, NULL);
709 INFO_LOG("failed to map %s\n", filename);
714 INFO_LOG("found %u uids in %s\n", (unsigned)num_uids, filename);
717 * Compute number of hash table bits. The hash table size must be a
718 * power of two and larger than the number of uids.
721 while (1 << bits < num_uids)
723 create_hash_table(bits);
724 for (n = 0; n < num_uids; n++) {
725 uint32_t uid = read_u32(map + n * sizeof(uid));
726 ret = search_uid(uid, admissible_uids, OPEN_USER_TABLE, NULL);
731 adu_munmap(map, size);
735 int run_select_query(struct uid_range *admissible_uids,
736 struct select_format_info *sfi)
740 if (select_conf.output_given && strcmp(select_conf.output_arg, "-")) {
741 output_file = fopen(select_conf.output_arg, "w");
743 return -ERRNO_TO_ERROR(errno);
745 output_file = stdout;
747 if (select_conf.count_unit_arg != count_unit_arg_h)
748 count_unit_buf[1] = count_unit_abbrevs[select_conf.count_unit_arg];
750 count_unit_buf[0] = '\0';
751 if (select_conf.size_unit_arg != size_unit_arg_h)
752 size_unit_buf[1] = size_unit_abbrevs[select_conf.size_unit_arg];
754 size_unit_buf[0] = '\0';
756 ret = open_dir_table(0);
760 ret = read_uid_file(admissible_uids);
764 ret = print_statistics(sfi);
767 if (output_file != stdout)
772 /* return: < 0: error, >0: OK, == 0: help given */
773 int parse_select_options(char *string, struct select_cmdline_parser_params *params,
774 struct uid_range **admissible_uids, struct select_format_info *sfi)
779 if (conf.select_options_given) {
783 ret = create_argv(string, &argv);
787 ret = select_cmdline_parser_ext(argc, argv, &select_conf, params);
791 if (select_conf.help_given || select_conf.detailed_help_given)
795 ret = parse_uid_arg(select_conf.uid_arg, admissible_uids);
798 ret = parse_format_string(select_conf.user_summary_format_arg,
799 user_summary_atoms, &sfi->user_summary_fi);
802 ret = parse_format_string(select_conf.global_summary_format_arg,
803 global_summary_atoms, &sfi->global_summary_fi);
805 goto global_summary_err;
806 ret = parse_format_string(select_conf.global_list_format_arg,
807 global_list_atoms, &sfi->global_list_fi);
809 goto global_list_err;
812 free_format_info(sfi->global_summary_fi);
814 free_format_info(sfi->user_summary_fi);
817 line = select_conf.detailed_help_given?
818 select_args_info_detailed_help : select_args_info_help;
820 output_file = stdout;
821 for (; *line; line++) {
822 ret = output("%s\n", *line);
831 struct uid_range *admissible_uids = NULL;
832 struct select_format_info sfi;
834 struct select_cmdline_parser_params params = {
838 .check_ambiguity = 1,
842 select_cmdline_parser_init(&select_conf);
843 ret = parse_select_options(conf.select_options_arg, ¶ms,
844 &admissible_uids, &sfi);
845 if (ret <= 0) /* do not run query if help was given */
847 return run_select_query(admissible_uids, &sfi);