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() */
11 #include "gcc-compat.h"
16 #include "portable_io.h"
18 /** Global dir count. */
19 static uint64_t num_dirs;
20 /** Global files count. */
21 static uint64_t num_files;
22 /** Global bytes count. */
23 static uint64_t num_bytes;
25 /** The decimal representation of an uint64_t never exceeds that size. */
26 #define FORMATED_VALUE_SIZE 25
28 /* these get filled in by the select command. */
29 static char count_unit_buf[4] = "( )", size_unit_buf[4] = "( )";
31 enum global_stats_flags {
32 GSF_PRINT_DIRNAME = 1,
35 GSF_COMPUTE_SUMMARY = 8,
38 struct global_stats_info {
42 enum global_stats_flags flags;
45 enum user_stats_flags {
46 USF_PRINT_DIRNAME = 1,
49 USF_COMPUTE_SUMMARY = 8,
52 struct user_stats_info {
54 enum user_stats_flags flags;
60 static const uint64_t size_unit_divisors[] = {
61 [size_unit_arg_b] = 1ULL,
62 [size_unit_arg_k] = 1024ULL,
63 [size_unit_arg_m] = 1024ULL * 1024ULL,
64 [size_unit_arg_g] = 1024ULL * 1024ULL * 1024ULL,
65 [size_unit_arg_t] = 1024ULL * 1024ULL * 1024ULL * 1024ULL,
68 static const uint64_t count_unit_divisors[] = {
70 [count_unit_arg_n] = 1ULL,
71 [count_unit_arg_k] = 1000ULL,
72 [count_unit_arg_m] = 1000ULL * 1000ULL,
73 [count_unit_arg_g] = 1000ULL * 1000ULL * 1000ULL,
74 [count_unit_arg_t] = 1000ULL * 1000ULL * 1000ULL * 1000ULL,
77 static const char size_unit_abbrevs[] = " BKMGT";
78 static const char count_unit_abbrevs[] = " kmgt";
79 static enum enum_size_unit format_size_value(enum enum_size_unit unit,
80 uint64_t value, int print_unit, char *result)
82 enum enum_size_unit u = unit;
83 char unit_buf[2] = "\0\0";
85 if (unit == size_unit_arg_h) /* human readable */
86 for (u = size_unit_arg_b; u < size_unit_arg_t &&
87 value > size_unit_divisors[u + 1]; u++)
90 unit_buf[0] = size_unit_abbrevs[u];
91 sprintf(result, "%llu%s",
92 (long long unsigned)value / size_unit_divisors[u], unit_buf);
96 static enum enum_count_unit format_count_value(enum enum_count_unit unit,
97 uint64_t value, int print_unit, char *result)
99 enum enum_count_unit u = unit;
100 char unit_buf[2] = "\0\0";
102 if (unit == count_unit_arg_h) /* human readable */
103 for (u = count_unit_arg_n; u < count_unit_arg_t &&
104 value > count_unit_divisors[u + 1]; u++)
107 unit_buf[0] = count_unit_abbrevs[u];
108 sprintf(result, "%llu%s",
109 (long long unsigned)value / count_unit_divisors[u], unit_buf);
113 static FILE *output_file;
115 __printf_1_2 static int output(const char const *fmt, ...)
121 ret = vfprintf(output_file, fmt, argp);
123 return ret < 0? -E_OUTPUT : 1;
126 static int get_dir_name_by_number(uint64_t *dirnum, char **name)
128 char *result = NULL, *tmp;
130 uint64_t val = *dirnum;
131 struct osl_object obj;
137 obj.size = sizeof(val);
138 ret = osl(osl_get_row(dir_table, DT_NUM, &obj, &row));
141 ret = osl(osl_get_object(dir_table, row, DT_PARENT_NUM, &obj));
144 val = *(uint64_t *)obj.data;
145 ret = osl(osl_get_object(dir_table, row, DT_NAME, &obj));
148 pfx = (select_conf.print_base_dir_given || val)? (char *)obj.data : ".";
149 tmp = make_message("%s/%s", pfx, result? result : "");
165 static int get_dir_name_of_row(struct osl_row *dir_table_row, char **name)
167 struct osl_object obj;
171 ret = osl(osl_get_object(dir_table, dir_table_row, DT_NUM, &obj));
174 return get_dir_name_by_number((uint64_t *)obj.data, name);
177 static int user_stats_loop_function(struct osl_row *row, void *data)
179 struct user_stats_info *usi = data;
180 struct osl_object obj;
181 int ret, summary = usi->flags & GSF_COMPUTE_SUMMARY;
182 char formated_value[FORMATED_VALUE_SIZE];
185 if (!usi->count && !summary) {
186 ret = -E_LOOP_COMPLETE;
189 if (summary || (usi->count && (usi->flags & USF_PRINT_FILES))) {
191 ret = osl(osl_get_object(usi->ui->table, row, UT_FILES, &obj));
194 files = *(uint64_t *)obj.data;
195 if (usi->count && (usi->flags & USF_PRINT_FILES)) {
196 format_count_value(select_conf.count_unit_arg, files,
197 select_conf.count_unit_arg == count_unit_arg_h,
199 ret = output("\t%s%s", formated_value,
200 (usi->flags & (USF_PRINT_BYTES | USF_PRINT_DIRNAME))?
206 usi->ui->files += files;
208 if (summary || (usi->count && (usi->flags & USF_PRINT_BYTES))) {
210 ret = osl(osl_get_object(usi->ui->table, row, UT_BYTES, &obj));
213 bytes = *(uint64_t *)obj.data;
214 if (usi->count && (usi->flags & USF_PRINT_BYTES)) {
215 format_size_value(select_conf.size_unit_arg, bytes,
216 select_conf.size_unit_arg == size_unit_arg_h,
218 ret = output("%s%s%s",
219 (usi->flags & USF_PRINT_FILES)? "" : "\t",
221 usi->flags & USF_PRINT_DIRNAME? "\t" : "\n"
227 usi->ui->bytes += bytes;
232 if (usi->count && (usi->flags & USF_PRINT_DIRNAME)) {
234 ret = osl(osl_get_object(usi->ui->table, row, UT_DIR_NUM, &obj));
237 ret = get_dir_name_by_number((uint64_t *)obj.data, &dirname);
240 ret = output("%s%s\n",
241 (usi->flags & (USF_PRINT_BYTES | USF_PRINT_FILES))? "" : "\t",
252 usi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
256 static int global_stats_loop_function(struct osl_row *row, void *data)
258 struct global_stats_info *gsi = data;
259 struct osl_object obj;
260 char *dirname, formated_value[FORMATED_VALUE_SIZE];
261 int ret, summary = gsi->flags & GSF_COMPUTE_SUMMARY;
264 if (!gsi->count && !summary) {
265 ret = -E_LOOP_COMPLETE;
268 if (summary || (gsi->count && (gsi->flags & GSF_PRINT_FILES))) {
270 ret = osl(osl_get_object(dir_table, row, DT_FILES, &obj));
273 files = *(uint64_t *)obj.data;
274 if (gsi->count && (gsi->flags & GSF_PRINT_FILES)) {
275 format_count_value(select_conf.count_unit_arg, files,
276 select_conf.count_unit_arg == count_unit_arg_h,
278 ret = output("\t%s%s", formated_value,
279 (gsi->flags & (GSF_PRINT_BYTES | GSF_PRINT_DIRNAME))?
287 if (summary || (gsi->count && (gsi->flags & GSF_PRINT_BYTES))) {
289 ret = osl(osl_get_object(dir_table, row, DT_BYTES, &obj));
292 bytes = *(uint64_t *)obj.data;
293 if (gsi->count && (gsi->flags & GSF_PRINT_BYTES)) {
294 format_size_value(select_conf.size_unit_arg, bytes,
295 select_conf.size_unit_arg == size_unit_arg_h,
297 ret = output("%s%s%s",
298 (gsi->flags & GSF_PRINT_FILES)? "" : "\t",
300 (gsi->flags & GSF_PRINT_DIRNAME)? "\t" : "\n"
310 if (gsi->count && (gsi->flags & GSF_PRINT_DIRNAME)) {
311 ret = get_dir_name_of_row(row, &dirname);
314 ret = output("%s%s\n",
315 (gsi->flags & (GSF_PRINT_BYTES | GSF_PRINT_FILES))? "" : "\t",
326 gsi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
330 static int check_loop_return(int ret, int loop_ret, int loop_osl_errno)
334 assert(ret == -E_OSL);
335 if (osl_errno != E_OSL_LOOP)
336 /* error not caused by loop function returning negative. */
338 assert(loop_ret < 0);
339 if (loop_ret == -E_LOOP_COMPLETE) /* no error */
341 if (loop_ret == -E_OSL) { /* osl error in loop function */
342 assert(loop_osl_errno);
343 osl_errno = loop_osl_errno;
348 static int adu_loop_reverse(struct osl_table *t, unsigned col_num, void *private_data,
349 osl_rbtree_loop_func *func, int *loop_ret, int *loop_osl_errno)
351 int ret = osl(osl_rbtree_loop_reverse(t, col_num, private_data, func));
352 return check_loop_return(ret, *loop_ret, *loop_osl_errno);
355 static int print_global_summary(void)
357 char d[FORMATED_VALUE_SIZE], f[FORMATED_VALUE_SIZE],
358 s[FORMATED_VALUE_SIZE];
359 enum enum_count_unit ud, uf;
360 enum enum_size_unit us;
363 if (select_conf.no_global_summary_given)
365 ud = format_count_value(select_conf.count_unit_arg, num_dirs, 0, d);
366 uf = format_count_value(select_conf.count_unit_arg, num_files, 0, f);
367 us = format_size_value(select_conf.size_unit_arg, num_bytes, 0, s);
369 if (!select_conf.no_headers_given) {
370 ret = output("Global summary "
371 "(dirs(%c)/files(%c)/size(%c))\n",
372 count_unit_abbrevs[ud],
373 count_unit_abbrevs[uf],
374 size_unit_abbrevs[us]
379 return output("\t%s\t%s\t%s\n\n", d, f, s);
382 static int print_user_summary_line(struct user_info *ui, __a_unused void *data)
384 char formated_dir_count[FORMATED_VALUE_SIZE],
385 formated_file_count[FORMATED_VALUE_SIZE],
386 formated_bytes[FORMATED_VALUE_SIZE ];
388 format_count_value(select_conf.count_unit_arg, ui->dirs,
389 select_conf.count_unit_arg == count_unit_arg_h,
391 format_count_value(select_conf.count_unit_arg, ui->files,
392 select_conf.count_unit_arg == count_unit_arg_h,
393 formated_file_count);
394 format_size_value(select_conf.size_unit_arg, ui->bytes,
395 select_conf.size_unit_arg == size_unit_arg_h,
397 return output("\t%s\t%u\t%s\t%s\t%s\n",
398 ui->pw_name? ui->pw_name : "?",
406 static int name_comp(const void *a, const void *b)
408 char *x = ((struct user_info *)a)->pw_name;
409 char *y = ((struct user_info *)b)->pw_name;
418 static int uid_comp(const void *a, const void *b)
420 return -NUM_COMPARE(((struct user_info *)a)->uid,
421 ((struct user_info *)b)->uid);
424 static int dir_count_comp(const void *a, const void *b)
426 return NUM_COMPARE(((struct user_info *)a)->dirs,
427 ((struct user_info *)b)->dirs);
430 static int file_count_comp(const void *a, const void *b)
432 return NUM_COMPARE(((struct user_info *)a)->files,
433 ((struct user_info *)b)->files);
436 static int size_comp(const void *a, const void *b)
438 return NUM_COMPARE(((struct user_info *)a)->bytes,
439 ((struct user_info *)b)->bytes);
443 * The comparators for sorting the user summary.
445 * This is an array of pointers to functions taking two constant void *
446 * pointers and returning an int.
448 static int (*summary_comparators[])(const void *, const void *) = {
449 [user_summary_sort_arg_name] = name_comp,
450 [user_summary_sort_arg_uid] = uid_comp,
451 [user_summary_sort_arg_dir_count] = dir_count_comp,
452 [user_summary_sort_arg_file_count] = file_count_comp,
453 [user_summary_sort_arg_size] = size_comp,
456 static int print_user_summary(void)
458 if (select_conf.no_user_summary_given)
460 if (!select_conf.no_headers_given) {
461 int ret = output("User summary "
462 "(pw_name/uid/dirs%s/files%s/size%s):\n",
463 count_unit_buf, count_unit_buf, size_unit_buf);
467 sort_hash_table(summary_comparators[select_conf.user_summary_sort_arg]);
468 return for_each_admissible_user(print_user_summary_line, NULL);
471 static int print_user_list(struct user_info *ui, __a_unused void *data)
474 struct user_stats_info usi;
475 enum enum_user_list ula = select_conf.user_list_arg;
476 int print_size_list = (ula == user_list_arg_size
477 || ula == user_list_arg_both);
479 if (print_size_list) {
480 usi.count = select_conf.limit_arg;
482 usi.flags = USF_PRINT_DIRNAME | USF_PRINT_BYTES | USF_COMPUTE_SUMMARY;
483 if (!select_conf.no_headers_given) {
484 ret = output("%s (uid %u), by size%s:\n",
485 ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid,
490 ret = adu_loop_reverse(ui->table, UT_BYTES, &usi, user_stats_loop_function,
491 &usi.ret, &usi.osl_errno);
498 if (ula == user_list_arg_file_count || ula == user_list_arg_both) {
499 if (!select_conf.no_headers_given) {
500 ret = output("%s (uid %u), by file count%s:\n",
501 ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid,
506 usi.count = select_conf.limit_arg,
508 usi.flags = USF_PRINT_DIRNAME | USF_PRINT_FILES;
509 ret = adu_loop_reverse(ui->table, UT_FILES, &usi, user_stats_loop_function,
510 &usi.ret, &usi.osl_errno);
517 if (ula == user_list_arg_none && !select_conf.no_user_summary_given) {
518 usi.count = select_conf.limit_arg;
520 usi.flags = USF_COMPUTE_SUMMARY;
521 ret = adu_loop_reverse(ui->table, UT_FILES, &usi, user_stats_loop_function,
522 &usi.ret, &usi.osl_errno);
529 static int print_user_lists(void)
531 return for_each_admissible_user(print_user_list, NULL);
534 static int print_global_lists(void)
536 struct global_stats_info gsi;
538 enum enum_global_list gla = select_conf.global_list_arg;
539 int print_size_list = (gla == global_list_arg_size
540 || gla == global_list_arg_both);
542 if (print_size_list) {
543 gsi.count = select_conf.limit_arg;
544 gsi.flags = GSF_PRINT_DIRNAME | GSF_PRINT_BYTES | GSF_COMPUTE_SUMMARY;
545 if (!select_conf.no_headers_given) {
546 ret = output("By size%s:\n", size_unit_buf);
550 ret = adu_loop_reverse(dir_table, DT_BYTES, &gsi,
551 global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
558 if (gla == global_list_arg_file_count || gla == global_list_arg_both) {
559 gsi.count = select_conf.limit_arg;
560 gsi.flags = GSF_PRINT_DIRNAME | GSF_PRINT_FILES;
561 if (!print_size_list)
562 gsi.flags |= GSF_COMPUTE_SUMMARY;
563 if (!select_conf.no_headers_given) {
564 ret = output("By file count%s:\n", count_unit_buf);
568 ret = adu_loop_reverse(dir_table, DT_FILES, &gsi,
569 global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
576 if (gla == global_list_arg_none && !select_conf.no_global_summary_given) {
577 /* must compute summary */
578 gsi.count = select_conf.limit_arg;
579 gsi.flags = GSF_COMPUTE_SUMMARY;
580 ret = adu_loop_reverse(dir_table, DT_FILES, &gsi,
581 global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
588 static int print_statistics(void)
592 ret = print_global_lists();
595 ret = print_global_summary();
598 ret = print_user_lists();
601 ret = print_user_summary();
607 static int read_uid_file(struct uid_range *admissible_uids)
611 char *filename = get_uid_list_name(), *map;
612 int ret = mmap_full_file(filename, O_RDONLY, (void **)&map, &size, NULL);
616 INFO_LOG("failed to map %s\n", filename);
621 INFO_LOG("found %u uids in %s\n", (unsigned)num_uids, filename);
624 * Compute number of hash table bits. The hash table size must be a
625 * power of two and larger than the number of uids.
628 while (1 << bits < num_uids)
630 create_hash_table(bits);
631 for (n = 0; n < num_uids; n++) {
632 uint32_t uid = read_u32(map + n * sizeof(uid));
633 ret = search_uid(uid, admissible_uids, OPEN_USER_TABLE, NULL);
638 adu_munmap(map, size);
642 int run_select_query(struct uid_range *admissible_uids)
646 if (select_conf.output_given && strcmp(select_conf.output_arg, "-")) {
647 output_file = fopen(select_conf.output_arg, "w");
649 return -ERRNO_TO_ERROR(errno);
651 output_file = stdout;
653 if (select_conf.count_unit_arg != count_unit_arg_h)
654 count_unit_buf[1] = count_unit_abbrevs[select_conf.count_unit_arg];
656 count_unit_buf[0] = '\0';
657 if (select_conf.size_unit_arg != size_unit_arg_h)
658 size_unit_buf[1] = size_unit_abbrevs[select_conf.size_unit_arg];
660 size_unit_buf[0] = '\0';
662 ret = open_dir_table(0);
666 ret = read_uid_file(admissible_uids);
670 ret = print_statistics();
673 if (output_file != stdout)
678 /* return: < 0: error, >0: OK, == 0: help given */
679 int parse_select_options(char *string, struct select_cmdline_parser_params *params,
680 struct uid_range **admissible_uids)
685 if (select_cmdline_parser_string_ext(string, &select_conf, "select",
688 ret = parse_uid_arg(select_conf.uid_arg, admissible_uids);
691 if (!select_conf.help_given && !select_conf.detailed_help_given)
694 line = select_conf.detailed_help_given?
695 select_args_info_detailed_help : select_args_info_help;
697 output_file = stdout;
698 for (; *line; line++) {
699 ret = output("%s\n", *line);
708 struct uid_range *admissible_uids = NULL;
710 if (conf.select_options_given) {
712 struct select_cmdline_parser_params params = {
716 .check_ambiguity = 1,
719 ret = parse_select_options(conf.select_options_arg, ¶ms,
721 if (ret <= 0) /* do not run query if help was given */
724 return run_select_query(admissible_uids);