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 struct select_args_info select_conf;
81 static struct uid_range *admissible_uids;
83 static enum enum_size_unit format_size_value(enum enum_size_unit unit,
84 uint64_t value, int print_unit, char *result)
86 enum enum_size_unit u = unit;
87 char unit_buf[2] = "\0\0";
89 if (unit == size_unit_arg_h) /* human readable */
90 for (u = size_unit_arg_b; u < size_unit_arg_t &&
91 value > size_unit_divisors[u + 1]; u++)
94 unit_buf[0] = size_unit_abbrevs[u];
95 sprintf(result, "%llu%s",
96 (long long unsigned)value / size_unit_divisors[u], unit_buf);
100 static enum enum_count_unit format_count_value(enum enum_count_unit unit,
101 uint64_t value, int print_unit, char *result)
103 enum enum_count_unit u = unit;
104 char unit_buf[2] = "\0\0";
106 if (unit == count_unit_arg_h) /* human readable */
107 for (u = count_unit_arg_n; u < count_unit_arg_t &&
108 value > count_unit_divisors[u + 1]; u++)
111 unit_buf[0] = count_unit_abbrevs[u];
112 sprintf(result, "%llu%s",
113 (long long unsigned)value / count_unit_divisors[u], unit_buf);
117 static int get_dir_name_by_number(uint64_t *dirnum, char **name)
119 char *result = NULL, *tmp;
121 uint64_t val = *dirnum;
122 struct osl_object obj;
128 obj.size = sizeof(val);
129 ret = osl(osl_get_row(dir_table, DT_NUM, &obj, &row));
132 ret = osl(osl_get_object(dir_table, row, DT_PARENT_NUM, &obj));
135 val = *(uint64_t *)obj.data;
136 ret = osl(osl_get_object(dir_table, row, DT_NAME, &obj));
139 pfx = (conf.print_base_dir_given || val)? (char *)obj.data : ".";
140 tmp = make_message("%s/%s", pfx, result? result : "");
156 static int get_dir_name_of_row(struct osl_row *dir_table_row, char **name)
158 struct osl_object obj;
162 ret = osl(osl_get_object(dir_table, dir_table_row, DT_NUM, &obj));
165 return get_dir_name_by_number((uint64_t *)obj.data, name);
168 static int user_stats_loop_function(struct osl_row *row, void *data)
170 struct user_stats_info *usi = data;
171 struct osl_object obj;
172 int ret, summary = usi->flags & GSF_COMPUTE_SUMMARY;
173 char formated_value[FORMATED_VALUE_SIZE];
176 if (!usi->count && !summary) {
177 ret = -E_LOOP_COMPLETE;
180 if (summary || (usi->count && (usi->flags & USF_PRINT_FILES))) {
182 ret = osl(osl_get_object(usi->ui->table, row, UT_FILES, &obj));
185 files = *(uint64_t *)obj.data;
186 if (usi->count && (usi->flags & USF_PRINT_FILES)) {
187 format_count_value(select_conf.count_unit_arg, files,
188 select_conf.count_unit_arg == count_unit_arg_h,
190 printf("\t%s%s", formated_value,
191 (usi->flags & (USF_PRINT_BYTES | USF_PRINT_DIRNAME))?
196 usi->ui->files += files;
198 if (summary || (usi->count && (usi->flags & USF_PRINT_BYTES))) {
200 ret = osl(osl_get_object(usi->ui->table, row, UT_BYTES, &obj));
203 bytes = *(uint64_t *)obj.data;
204 if (usi->count && (usi->flags & USF_PRINT_BYTES)) {
205 format_size_value(select_conf.size_unit_arg, bytes,
206 select_conf.size_unit_arg == size_unit_arg_h,
209 (usi->flags & USF_PRINT_FILES)? "" : "\t",
211 usi->flags & USF_PRINT_DIRNAME? "\t" : "\n"
215 usi->ui->bytes += bytes;
220 if (usi->count && (usi->flags & USF_PRINT_DIRNAME)) {
222 ret = osl(osl_get_object(usi->ui->table, row, UT_DIR_NUM, &obj));
225 ret = get_dir_name_by_number((uint64_t *)obj.data, &dirname);
229 (usi->flags & (USF_PRINT_BYTES | USF_PRINT_FILES))? "" : "\t",
238 usi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
242 static int global_stats_loop_function(struct osl_row *row, void *data)
244 struct global_stats_info *gsi = data;
245 struct osl_object obj;
246 char *dirname, formated_value[FORMATED_VALUE_SIZE];
247 int ret, summary = gsi->flags & GSF_COMPUTE_SUMMARY;
250 if (!gsi->count && !summary) {
251 ret = -E_LOOP_COMPLETE;
254 if (summary || (gsi->count && (gsi->flags & GSF_PRINT_FILES))) {
256 ret = osl(osl_get_object(dir_table, row, DT_FILES, &obj));
259 files = *(uint64_t *)obj.data;
260 if (gsi->count && (gsi->flags & GSF_PRINT_FILES)) {
261 format_count_value(select_conf.count_unit_arg, files,
262 select_conf.count_unit_arg == count_unit_arg_h,
264 printf("\t%s%s", formated_value,
265 (gsi->flags & (GSF_PRINT_BYTES | GSF_PRINT_DIRNAME))?
271 if (summary || (gsi->count && (gsi->flags & GSF_PRINT_BYTES))) {
273 ret = osl(osl_get_object(dir_table, row, DT_BYTES, &obj));
276 bytes = *(uint64_t *)obj.data;
277 if (gsi->count && (gsi->flags & GSF_PRINT_BYTES)) {
278 format_size_value(select_conf.size_unit_arg, bytes,
279 select_conf.size_unit_arg == size_unit_arg_h,
282 (gsi->flags & GSF_PRINT_FILES)? "" : "\t",
284 (gsi->flags & GSF_PRINT_DIRNAME)? "\t" : "\n"
292 if (gsi->count && (gsi->flags & GSF_PRINT_DIRNAME)) {
293 ret = get_dir_name_of_row(row, &dirname);
297 (gsi->flags & (GSF_PRINT_BYTES | GSF_PRINT_FILES))? "" : "\t",
306 gsi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
310 static int check_loop_return(int ret, int loop_ret, int loop_osl_errno)
314 assert(ret == -E_OSL);
315 if (osl_errno != E_OSL_LOOP)
316 /* error not caused by loop function returning negative. */
318 assert(loop_ret < 0);
319 if (loop_ret == -E_LOOP_COMPLETE) /* no error */
321 if (loop_ret == -E_OSL) { /* osl error in loop function */
322 assert(loop_osl_errno);
323 osl_errno = loop_osl_errno;
328 static int adu_loop_reverse(struct osl_table *t, unsigned col_num, void *private_data,
329 osl_rbtree_loop_func *func, int *loop_ret, int *loop_osl_errno)
331 int ret = osl(osl_rbtree_loop_reverse(t, col_num, private_data, func));
332 return check_loop_return(ret, *loop_ret, *loop_osl_errno);
335 static void print_global_summary(void)
337 char d[FORMATED_VALUE_SIZE], f[FORMATED_VALUE_SIZE],
338 s[FORMATED_VALUE_SIZE];
339 enum enum_count_unit ud, uf;
340 enum enum_size_unit us;
342 if (conf.no_global_summary_given)
344 ud = format_count_value(select_conf.count_unit_arg, num_dirs, 0, d);
345 uf = format_count_value(select_conf.count_unit_arg, num_files, 0, f);
346 us = format_size_value(select_conf.size_unit_arg, num_bytes, 0, s);
348 if (!conf.no_headers_given)
349 printf("Global summary "
350 "(dirs(%c)/files(%c)/size(%c))\n",
351 count_unit_abbrevs[ud],
352 count_unit_abbrevs[uf],
353 size_unit_abbrevs[us]
355 printf("\t%s\t%s\t%s\n\n", d, f, s);
358 static int print_user_summary_line(struct user_info *ui, __a_unused void *data)
360 char formated_dir_count[FORMATED_VALUE_SIZE],
361 formated_file_count[FORMATED_VALUE_SIZE],
362 formated_bytes[FORMATED_VALUE_SIZE ];
364 format_count_value(select_conf.count_unit_arg, ui->dirs,
365 select_conf.count_unit_arg == count_unit_arg_h,
367 format_count_value(select_conf.count_unit_arg, ui->files,
368 select_conf.count_unit_arg == count_unit_arg_h,
369 formated_file_count);
370 format_size_value(select_conf.size_unit_arg, ui->bytes,
371 select_conf.size_unit_arg == size_unit_arg_h,
373 printf("\t%s\t%u\t%s\t%s\t%s\n",
374 ui->pw_name? ui->pw_name : "?",
383 static int name_comp(const void *a, const void *b)
385 char *x = ((struct user_info *)a)->pw_name;
386 char *y = ((struct user_info *)b)->pw_name;
395 static int uid_comp(const void *a, const void *b)
397 return -NUM_COMPARE(((struct user_info *)a)->uid,
398 ((struct user_info *)b)->uid);
401 static int dir_count_comp(const void *a, const void *b)
403 return NUM_COMPARE(((struct user_info *)a)->dirs,
404 ((struct user_info *)b)->dirs);
407 static int file_count_comp(const void *a, const void *b)
409 return NUM_COMPARE(((struct user_info *)a)->files,
410 ((struct user_info *)b)->files);
413 static int size_comp(const void *a, const void *b)
415 return NUM_COMPARE(((struct user_info *)a)->bytes,
416 ((struct user_info *)b)->bytes);
420 * The comparators for sorting the user summary.
422 * This is an array of pointers to functions taking two constant void *
423 * pointers and returning an int.
425 static int (*summary_comparators[])(const void *, const void *) = {
426 [user_summary_sort_arg_name] = name_comp,
427 [user_summary_sort_arg_uid] = uid_comp,
428 [user_summary_sort_arg_dir_count] = dir_count_comp,
429 [user_summary_sort_arg_file_count] = file_count_comp,
430 [user_summary_sort_arg_size] = size_comp,
433 static void print_user_summary(void)
435 if (conf.no_user_summary_given)
437 if (!conf.no_headers_given)
438 printf("User summary "
439 "(pw_name/uid/dirs%s/files%s/size%s):\n",
440 count_unit_buf, count_unit_buf, size_unit_buf);
441 sort_hash_table(summary_comparators[conf.user_summary_sort_arg]);
442 for_each_admissible_user(print_user_summary_line, NULL);
445 static int print_user_list(struct user_info *ui, __a_unused void *data)
448 struct user_stats_info usi;
449 enum enum_user_list ula = conf.user_list_arg;
450 int print_size_list = (ula == user_list_arg_size
451 || ula == user_list_arg_both);
453 if (print_size_list) {
454 usi.count = select_conf.limit_arg;
456 usi.flags = USF_PRINT_DIRNAME | USF_PRINT_BYTES | USF_COMPUTE_SUMMARY;
457 if (!conf.no_headers_given)
458 printf("%s (uid %u), by size%s:\n",
459 ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid,
461 ret = adu_loop_reverse(ui->table, UT_BYTES, &usi, user_stats_loop_function,
462 &usi.ret, &usi.osl_errno);
467 if (ula == user_list_arg_file_count || ula == user_list_arg_both) {
468 if (!conf.no_headers_given)
469 printf("%s (uid %u), by file count%s:\n",
470 ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid,
472 usi.count = select_conf.limit_arg,
474 usi.flags = USF_PRINT_DIRNAME | USF_PRINT_FILES;
475 ret = adu_loop_reverse(ui->table, UT_FILES, &usi, user_stats_loop_function,
476 &usi.ret, &usi.osl_errno);
481 if (ula == user_list_arg_none && !conf.no_user_summary_given) {
482 usi.count = select_conf.limit_arg;
484 usi.flags = USF_COMPUTE_SUMMARY;
485 ret = adu_loop_reverse(ui->table, UT_FILES, &usi, user_stats_loop_function,
486 &usi.ret, &usi.osl_errno);
493 static int print_user_lists(void)
495 return for_each_admissible_user(print_user_list, NULL);
498 static int print_global_lists(void)
500 struct global_stats_info gsi;
502 enum enum_global_list gla = conf.global_list_arg;
503 int print_size_list = (gla == global_list_arg_size
504 || gla == global_list_arg_both);
506 if (print_size_list) {
507 gsi.count = select_conf.limit_arg;
508 gsi.flags = GSF_PRINT_DIRNAME | GSF_PRINT_BYTES | GSF_COMPUTE_SUMMARY;
509 if (!conf.no_headers_given)
510 printf("By size%s:\n", size_unit_buf);
511 ret = adu_loop_reverse(dir_table, DT_BYTES, &gsi,
512 global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
517 if (gla == global_list_arg_file_count || gla == global_list_arg_both) {
518 gsi.count = select_conf.limit_arg;
519 gsi.flags = GSF_PRINT_DIRNAME | GSF_PRINT_FILES;
520 if (!print_size_list)
521 gsi.flags |= GSF_COMPUTE_SUMMARY;
522 if (!conf.no_headers_given)
523 printf("By file count%s:\n", count_unit_buf);
524 ret = adu_loop_reverse(dir_table, DT_FILES, &gsi,
525 global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
530 if (gla == global_list_arg_none && !conf.no_global_summary_given) {
531 /* must compute summary */
532 gsi.count = select_conf.limit_arg;
533 gsi.flags = GSF_COMPUTE_SUMMARY;
534 ret = adu_loop_reverse(dir_table, DT_FILES, &gsi,
535 global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
542 static int print_statistics(void)
546 ret = print_global_lists();
549 print_global_summary();
551 print_user_summary();
555 static int read_uid_file(void)
559 char *filename = get_uid_list_name(), *map;
560 int ret = mmap_full_file(filename, O_RDONLY, (void **)&map, &size, NULL);
564 INFO_LOG("failed to map %s\n", filename);
569 INFO_LOG("found %u uids in %s\n", (unsigned)num_uids, filename);
572 * Compute number of hash table bits. The hash table size must be a
573 * power of two and larger than the number of uids.
576 while (1 << bits < num_uids)
578 create_hash_table(bits);
579 for (n = 0; n < num_uids; n++) {
580 uint32_t uid = read_u32(map + n * sizeof(uid));
581 ret = search_uid(uid, admissible_uids, OPEN_USER_TABLE, NULL);
586 adu_munmap(map, size);
593 struct select_cmdline_parser_params params = {
597 .check_ambiguity = 1,
601 if (conf.select_options_given) {
602 if (select_cmdline_parser_string_ext(conf.select_options_arg,
603 &select_conf, "select", ¶ms))
605 ret = parse_uid_arg(select_conf.uid_arg, &admissible_uids);
610 if (select_conf.count_unit_arg != count_unit_arg_h)
611 count_unit_buf[1] = count_unit_abbrevs[select_conf.count_unit_arg];
613 count_unit_buf[0] = '\0';
614 if (select_conf.size_unit_arg != size_unit_arg_h)
615 size_unit_buf[1] = size_unit_abbrevs[select_conf.size_unit_arg];
617 size_unit_buf[0] = '\0';
619 ret = open_dir_table(0);
623 ret = read_uid_file();
627 ret = print_statistics();