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"
17 #include "select.cmdline.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;
26 /** The decimal representation of an uint64_t never exceeds that size. */
27 #define FORMATED_VALUE_SIZE 25
29 /* these get filled in by the select command. */
30 static char count_unit_buf[4] = "( )", size_unit_buf[4] = "( )";
32 enum global_stats_flags {
33 GSF_PRINT_DIRNAME = 1,
36 GSF_COMPUTE_SUMMARY = 8,
39 struct global_stats_info {
43 enum global_stats_flags flags;
46 enum user_stats_flags {
47 USF_PRINT_DIRNAME = 1,
50 USF_COMPUTE_SUMMARY = 8,
53 struct user_stats_info {
55 enum user_stats_flags flags;
61 static const uint64_t size_unit_divisors[] = {
62 [size_unit_arg_b] = 1ULL,
63 [size_unit_arg_k] = 1024ULL,
64 [size_unit_arg_m] = 1024ULL * 1024ULL,
65 [size_unit_arg_g] = 1024ULL * 1024ULL * 1024ULL,
66 [size_unit_arg_t] = 1024ULL * 1024ULL * 1024ULL * 1024ULL,
69 static const uint64_t count_unit_divisors[] = {
71 [count_unit_arg_n] = 1ULL,
72 [count_unit_arg_k] = 1000ULL,
73 [count_unit_arg_m] = 1000ULL * 1000ULL,
74 [count_unit_arg_g] = 1000ULL * 1000ULL * 1000ULL,
75 [count_unit_arg_t] = 1000ULL * 1000ULL * 1000ULL * 1000ULL,
78 static const char size_unit_abbrevs[] = " BKMGT";
79 static const char count_unit_abbrevs[] = " kmgt";
80 static enum enum_size_unit format_size_value(enum enum_size_unit unit,
81 uint64_t value, int print_unit, char *result)
83 enum enum_size_unit u = unit;
84 char unit_buf[2] = "\0\0";
86 if (unit == size_unit_arg_h) /* human readable */
87 for (u = size_unit_arg_b; u < size_unit_arg_t &&
88 value > size_unit_divisors[u + 1]; u++)
91 unit_buf[0] = size_unit_abbrevs[u];
92 sprintf(result, "%llu%s",
93 (long long unsigned)value / size_unit_divisors[u], unit_buf);
97 static enum enum_count_unit format_count_value(enum enum_count_unit unit,
98 uint64_t value, int print_unit, char *result)
100 enum enum_count_unit u = unit;
101 char unit_buf[2] = "\0\0";
103 if (unit == count_unit_arg_h) /* human readable */
104 for (u = count_unit_arg_n; u < count_unit_arg_t &&
105 value > count_unit_divisors[u + 1]; u++)
108 unit_buf[0] = count_unit_abbrevs[u];
109 sprintf(result, "%llu%s",
110 (long long unsigned)value / count_unit_divisors[u], unit_buf);
114 static FILE *output_file;
116 __printf_1_2 static int output(const char const *fmt, ...)
122 ret = vfprintf(output_file, fmt, argp);
124 return ret < 0? -E_OUTPUT : 1;
127 static int get_dir_name_by_number(uint64_t *dirnum, char **name)
129 char *result = NULL, *tmp;
131 uint64_t val = *dirnum;
132 struct osl_object obj;
138 obj.size = sizeof(val);
139 ret = osl(osl_get_row(dir_table, DT_NUM, &obj, &row));
142 ret = osl(osl_get_object(dir_table, row, DT_PARENT_NUM, &obj));
145 val = *(uint64_t *)obj.data;
146 ret = osl(osl_get_object(dir_table, row, DT_NAME, &obj));
149 pfx = (select_conf.print_base_dir_given || val)? (char *)obj.data : ".";
150 tmp = make_message("%s/%s", pfx, result? result : "");
166 static int get_dir_name_of_row(struct osl_row *dir_table_row, char **name)
168 struct osl_object obj;
172 ret = osl(osl_get_object(dir_table, dir_table_row, DT_NUM, &obj));
175 return get_dir_name_by_number((uint64_t *)obj.data, name);
178 static int user_stats_loop_function(struct osl_row *row, void *data)
180 struct user_stats_info *usi = data;
181 struct osl_object obj;
182 int ret, summary = usi->flags & GSF_COMPUTE_SUMMARY;
183 char formated_value[FORMATED_VALUE_SIZE];
186 if (!usi->count && !summary) {
187 ret = -E_LOOP_COMPLETE;
190 if (summary || (usi->count && (usi->flags & USF_PRINT_FILES))) {
192 ret = osl(osl_get_object(usi->ui->table, row, UT_FILES, &obj));
195 files = *(uint64_t *)obj.data;
196 if (usi->count && (usi->flags & USF_PRINT_FILES)) {
197 format_count_value(select_conf.count_unit_arg, files,
198 select_conf.count_unit_arg == count_unit_arg_h,
200 ret = output("\t%s%s", formated_value,
201 (usi->flags & (USF_PRINT_BYTES | USF_PRINT_DIRNAME))?
207 usi->ui->files += files;
209 if (summary || (usi->count && (usi->flags & USF_PRINT_BYTES))) {
211 ret = osl(osl_get_object(usi->ui->table, row, UT_BYTES, &obj));
214 bytes = *(uint64_t *)obj.data;
215 if (usi->count && (usi->flags & USF_PRINT_BYTES)) {
216 format_size_value(select_conf.size_unit_arg, bytes,
217 select_conf.size_unit_arg == size_unit_arg_h,
219 ret = output("%s%s%s",
220 (usi->flags & USF_PRINT_FILES)? "" : "\t",
222 usi->flags & USF_PRINT_DIRNAME? "\t" : "\n"
228 usi->ui->bytes += bytes;
233 if (usi->count && (usi->flags & USF_PRINT_DIRNAME)) {
235 ret = osl(osl_get_object(usi->ui->table, row, UT_DIR_NUM, &obj));
238 ret = get_dir_name_by_number((uint64_t *)obj.data, &dirname);
241 ret = output("%s%s\n",
242 (usi->flags & (USF_PRINT_BYTES | USF_PRINT_FILES))? "" : "\t",
253 usi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
257 static int global_stats_loop_function(struct osl_row *row, void *data)
259 struct global_stats_info *gsi = data;
260 struct osl_object obj;
261 char *dirname, formated_value[FORMATED_VALUE_SIZE];
262 int ret, summary = gsi->flags & GSF_COMPUTE_SUMMARY;
265 if (!gsi->count && !summary) {
266 ret = -E_LOOP_COMPLETE;
269 if (summary || (gsi->count && (gsi->flags & GSF_PRINT_FILES))) {
271 ret = osl(osl_get_object(dir_table, row, DT_FILES, &obj));
274 files = *(uint64_t *)obj.data;
275 if (gsi->count && (gsi->flags & GSF_PRINT_FILES)) {
276 format_count_value(select_conf.count_unit_arg, files,
277 select_conf.count_unit_arg == count_unit_arg_h,
279 ret = output("\t%s%s", formated_value,
280 (gsi->flags & (GSF_PRINT_BYTES | GSF_PRINT_DIRNAME))?
288 if (summary || (gsi->count && (gsi->flags & GSF_PRINT_BYTES))) {
290 ret = osl(osl_get_object(dir_table, row, DT_BYTES, &obj));
293 bytes = *(uint64_t *)obj.data;
294 if (gsi->count && (gsi->flags & GSF_PRINT_BYTES)) {
295 format_size_value(select_conf.size_unit_arg, bytes,
296 select_conf.size_unit_arg == size_unit_arg_h,
298 ret = output("%s%s%s",
299 (gsi->flags & GSF_PRINT_FILES)? "" : "\t",
301 (gsi->flags & GSF_PRINT_DIRNAME)? "\t" : "\n"
311 if (gsi->count && (gsi->flags & GSF_PRINT_DIRNAME)) {
312 ret = get_dir_name_of_row(row, &dirname);
315 ret = output("%s%s\n",
316 (gsi->flags & (GSF_PRINT_BYTES | GSF_PRINT_FILES))? "" : "\t",
327 gsi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
331 static int check_loop_return(int ret, int loop_ret, int loop_osl_errno)
335 assert(ret == -E_OSL);
336 if (osl_errno != E_OSL_LOOP)
337 /* error not caused by loop function returning negative. */
339 assert(loop_ret < 0);
340 if (loop_ret == -E_LOOP_COMPLETE) /* no error */
342 if (loop_ret == -E_OSL) { /* osl error in loop function */
343 assert(loop_osl_errno);
344 osl_errno = loop_osl_errno;
349 static int adu_loop_reverse(struct osl_table *t, unsigned col_num, void *private_data,
350 osl_rbtree_loop_func *func, int *loop_ret, int *loop_osl_errno)
352 int ret = osl(osl_rbtree_loop_reverse(t, col_num, private_data, func));
353 return check_loop_return(ret, *loop_ret, *loop_osl_errno);
356 static int print_global_summary(void)
358 char d[FORMATED_VALUE_SIZE], f[FORMATED_VALUE_SIZE],
359 s[FORMATED_VALUE_SIZE];
360 enum enum_count_unit ud, uf;
361 enum enum_size_unit us;
364 if (select_conf.no_global_summary_given)
366 ud = format_count_value(select_conf.count_unit_arg, num_dirs, 0, d);
367 uf = format_count_value(select_conf.count_unit_arg, num_files, 0, f);
368 us = format_size_value(select_conf.size_unit_arg, num_bytes, 0, s);
370 if (!select_conf.no_headers_given) {
371 ret = output("Global summary "
372 "(dirs(%c)/files(%c)/size(%c))\n",
373 count_unit_abbrevs[ud],
374 count_unit_abbrevs[uf],
375 size_unit_abbrevs[us]
380 return output("\t%s\t%s\t%s\n\n", d, f, s);
383 static int print_user_summary_line(struct user_info *ui, __a_unused void *data)
385 char formated_dir_count[FORMATED_VALUE_SIZE],
386 formated_file_count[FORMATED_VALUE_SIZE],
387 formated_bytes[FORMATED_VALUE_SIZE ];
389 format_count_value(select_conf.count_unit_arg, ui->dirs,
390 select_conf.count_unit_arg == count_unit_arg_h,
392 format_count_value(select_conf.count_unit_arg, ui->files,
393 select_conf.count_unit_arg == count_unit_arg_h,
394 formated_file_count);
395 format_size_value(select_conf.size_unit_arg, ui->bytes,
396 select_conf.size_unit_arg == size_unit_arg_h,
398 return output("\t%s\t%u\t%s\t%s\t%s\n",
399 ui->pw_name? ui->pw_name : "?",
407 static int name_comp(const void *a, const void *b)
409 char *x = ((struct user_info *)a)->pw_name;
410 char *y = ((struct user_info *)b)->pw_name;
419 static int uid_comp(const void *a, const void *b)
421 return -NUM_COMPARE(((struct user_info *)a)->uid,
422 ((struct user_info *)b)->uid);
425 static int dir_count_comp(const void *a, const void *b)
427 return NUM_COMPARE(((struct user_info *)a)->dirs,
428 ((struct user_info *)b)->dirs);
431 static int file_count_comp(const void *a, const void *b)
433 return NUM_COMPARE(((struct user_info *)a)->files,
434 ((struct user_info *)b)->files);
437 static int size_comp(const void *a, const void *b)
439 return NUM_COMPARE(((struct user_info *)a)->bytes,
440 ((struct user_info *)b)->bytes);
444 * The comparators for sorting the user summary.
446 * This is an array of pointers to functions taking two constant void *
447 * pointers and returning an int.
449 static int (*summary_comparators[])(const void *, const void *) = {
450 [user_summary_sort_arg_name] = name_comp,
451 [user_summary_sort_arg_uid] = uid_comp,
452 [user_summary_sort_arg_dir_count] = dir_count_comp,
453 [user_summary_sort_arg_file_count] = file_count_comp,
454 [user_summary_sort_arg_size] = size_comp,
457 static int print_user_summary(void)
459 if (select_conf.no_user_summary_given)
461 if (!select_conf.no_headers_given) {
462 int ret = output("User summary "
463 "(pw_name/uid/dirs%s/files%s/size%s):\n",
464 count_unit_buf, count_unit_buf, size_unit_buf);
468 sort_hash_table(summary_comparators[select_conf.user_summary_sort_arg]);
469 return for_each_admissible_user(print_user_summary_line, NULL);
472 static int print_user_list(struct user_info *ui, __a_unused void *data)
475 struct user_stats_info usi;
476 enum enum_user_list ula = select_conf.user_list_arg;
477 int print_size_list = (ula == user_list_arg_size
478 || ula == user_list_arg_both);
480 if (print_size_list) {
481 usi.count = select_conf.limit_arg;
483 usi.flags = USF_PRINT_DIRNAME | USF_PRINT_BYTES | USF_COMPUTE_SUMMARY;
484 if (!select_conf.no_headers_given) {
485 ret = output("%s (uid %u), by size%s:\n",
486 ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid,
491 ret = adu_loop_reverse(ui->table, UT_BYTES, &usi, user_stats_loop_function,
492 &usi.ret, &usi.osl_errno);
499 if (ula == user_list_arg_file_count || ula == user_list_arg_both) {
500 if (!select_conf.no_headers_given) {
501 ret = output("%s (uid %u), by file count%s:\n",
502 ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid,
507 usi.count = select_conf.limit_arg,
509 usi.flags = USF_PRINT_DIRNAME | USF_PRINT_FILES;
510 ret = adu_loop_reverse(ui->table, UT_FILES, &usi, user_stats_loop_function,
511 &usi.ret, &usi.osl_errno);
518 if (ula == user_list_arg_none && !select_conf.no_user_summary_given) {
519 usi.count = select_conf.limit_arg;
521 usi.flags = USF_COMPUTE_SUMMARY;
522 ret = adu_loop_reverse(ui->table, UT_FILES, &usi, user_stats_loop_function,
523 &usi.ret, &usi.osl_errno);
530 static int print_user_lists(void)
532 return for_each_admissible_user(print_user_list, NULL);
535 static int print_global_lists(void)
537 struct global_stats_info gsi;
539 enum enum_global_list gla = select_conf.global_list_arg;
540 int print_size_list = (gla == global_list_arg_size
541 || gla == global_list_arg_both);
543 if (print_size_list) {
544 gsi.count = select_conf.limit_arg;
545 gsi.flags = GSF_PRINT_DIRNAME | GSF_PRINT_BYTES | GSF_COMPUTE_SUMMARY;
546 if (!select_conf.no_headers_given) {
547 ret = output("By size%s:\n", size_unit_buf);
551 ret = adu_loop_reverse(dir_table, DT_BYTES, &gsi,
552 global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
559 if (gla == global_list_arg_file_count || gla == global_list_arg_both) {
560 gsi.count = select_conf.limit_arg;
561 gsi.flags = GSF_PRINT_DIRNAME | GSF_PRINT_FILES;
562 if (!print_size_list)
563 gsi.flags |= GSF_COMPUTE_SUMMARY;
564 if (!select_conf.no_headers_given) {
565 ret = output("By file count%s:\n", count_unit_buf);
569 ret = adu_loop_reverse(dir_table, DT_FILES, &gsi,
570 global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
577 if (gla == global_list_arg_none && !select_conf.no_global_summary_given) {
578 /* must compute summary */
579 gsi.count = select_conf.limit_arg;
580 gsi.flags = GSF_COMPUTE_SUMMARY;
581 ret = adu_loop_reverse(dir_table, DT_FILES, &gsi,
582 global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
589 static int print_statistics(void)
593 ret = print_global_lists();
596 ret = print_global_summary();
599 ret = print_user_lists();
602 ret = print_user_summary();
608 static int read_uid_file(struct uid_range *admissible_uids)
612 char *filename = get_uid_list_name(), *map;
613 int ret = mmap_full_file(filename, O_RDONLY, (void **)&map, &size, NULL);
617 INFO_LOG("failed to map %s\n", filename);
622 INFO_LOG("found %u uids in %s\n", (unsigned)num_uids, filename);
625 * Compute number of hash table bits. The hash table size must be a
626 * power of two and larger than the number of uids.
629 while (1 << bits < num_uids)
631 create_hash_table(bits);
632 for (n = 0; n < num_uids; n++) {
633 uint32_t uid = read_u32(map + n * sizeof(uid));
634 ret = search_uid(uid, admissible_uids, OPEN_USER_TABLE, NULL);
639 adu_munmap(map, size);
643 int run_select_query(struct uid_range *admissible_uids)
647 if (select_conf.output_given && strcmp(select_conf.output_arg, "-")) {
648 output_file = fopen(select_conf.output_arg, "w");
650 return -ERRNO_TO_ERROR(errno);
652 output_file = stdout;
654 if (select_conf.count_unit_arg != count_unit_arg_h)
655 count_unit_buf[1] = count_unit_abbrevs[select_conf.count_unit_arg];
657 count_unit_buf[0] = '\0';
658 if (select_conf.size_unit_arg != size_unit_arg_h)
659 size_unit_buf[1] = size_unit_abbrevs[select_conf.size_unit_arg];
661 size_unit_buf[0] = '\0';
663 ret = open_dir_table(0);
667 ret = read_uid_file(admissible_uids);
671 ret = print_statistics();
674 if (output_file != stdout)
682 struct uid_range *admissible_uids = NULL;
684 if (conf.select_options_given) {
685 struct select_cmdline_parser_params params = {
689 .check_ambiguity = 1,
693 if (select_cmdline_parser_string_ext(conf.select_options_arg,
694 &select_conf, "select", ¶ms))
696 ret = parse_uid_arg(select_conf.uid_arg, &admissible_uids);
700 return run_select_query(admissible_uids);