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 struct uid_range *admissible_uids;
82 static enum enum_size_unit format_size_value(enum enum_size_unit unit,
83 uint64_t value, int print_unit, char *result)
85 enum enum_size_unit u = unit;
86 char unit_buf[2] = "\0\0";
88 if (unit == size_unit_arg_h) /* human readable */
89 for (u = size_unit_arg_b; u < size_unit_arg_t &&
90 value > size_unit_divisors[u + 1]; u++)
93 unit_buf[0] = size_unit_abbrevs[u];
94 sprintf(result, "%llu%s",
95 (long long unsigned)value / size_unit_divisors[u], unit_buf);
99 static enum enum_count_unit format_count_value(enum enum_count_unit unit,
100 uint64_t value, int print_unit, char *result)
102 enum enum_count_unit u = unit;
103 char unit_buf[2] = "\0\0";
105 if (unit == count_unit_arg_h) /* human readable */
106 for (u = count_unit_arg_n; u < count_unit_arg_t &&
107 value > count_unit_divisors[u + 1]; u++)
110 unit_buf[0] = count_unit_abbrevs[u];
111 sprintf(result, "%llu%s",
112 (long long unsigned)value / count_unit_divisors[u], unit_buf);
116 static int get_dir_name_by_number(uint64_t *dirnum, char **name)
118 char *result = NULL, *tmp;
120 uint64_t val = *dirnum;
121 struct osl_object obj;
127 obj.size = sizeof(val);
128 ret = osl(osl_get_row(dir_table, DT_NUM, &obj, &row));
131 ret = osl(osl_get_object(dir_table, row, DT_PARENT_NUM, &obj));
134 val = *(uint64_t *)obj.data;
135 ret = osl(osl_get_object(dir_table, row, DT_NAME, &obj));
138 pfx = (select_conf.print_base_dir_given || val)? (char *)obj.data : ".";
139 tmp = make_message("%s/%s", pfx, result? result : "");
155 static int get_dir_name_of_row(struct osl_row *dir_table_row, char **name)
157 struct osl_object obj;
161 ret = osl(osl_get_object(dir_table, dir_table_row, DT_NUM, &obj));
164 return get_dir_name_by_number((uint64_t *)obj.data, name);
167 static int user_stats_loop_function(struct osl_row *row, void *data)
169 struct user_stats_info *usi = data;
170 struct osl_object obj;
171 int ret, summary = usi->flags & GSF_COMPUTE_SUMMARY;
172 char formated_value[FORMATED_VALUE_SIZE];
175 if (!usi->count && !summary) {
176 ret = -E_LOOP_COMPLETE;
179 if (summary || (usi->count && (usi->flags & USF_PRINT_FILES))) {
181 ret = osl(osl_get_object(usi->ui->table, row, UT_FILES, &obj));
184 files = *(uint64_t *)obj.data;
185 if (usi->count && (usi->flags & USF_PRINT_FILES)) {
186 format_count_value(select_conf.count_unit_arg, files,
187 select_conf.count_unit_arg == count_unit_arg_h,
189 printf("\t%s%s", formated_value,
190 (usi->flags & (USF_PRINT_BYTES | USF_PRINT_DIRNAME))?
195 usi->ui->files += files;
197 if (summary || (usi->count && (usi->flags & USF_PRINT_BYTES))) {
199 ret = osl(osl_get_object(usi->ui->table, row, UT_BYTES, &obj));
202 bytes = *(uint64_t *)obj.data;
203 if (usi->count && (usi->flags & USF_PRINT_BYTES)) {
204 format_size_value(select_conf.size_unit_arg, bytes,
205 select_conf.size_unit_arg == size_unit_arg_h,
208 (usi->flags & USF_PRINT_FILES)? "" : "\t",
210 usi->flags & USF_PRINT_DIRNAME? "\t" : "\n"
214 usi->ui->bytes += bytes;
219 if (usi->count && (usi->flags & USF_PRINT_DIRNAME)) {
221 ret = osl(osl_get_object(usi->ui->table, row, UT_DIR_NUM, &obj));
224 ret = get_dir_name_by_number((uint64_t *)obj.data, &dirname);
228 (usi->flags & (USF_PRINT_BYTES | USF_PRINT_FILES))? "" : "\t",
237 usi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
241 static int global_stats_loop_function(struct osl_row *row, void *data)
243 struct global_stats_info *gsi = data;
244 struct osl_object obj;
245 char *dirname, formated_value[FORMATED_VALUE_SIZE];
246 int ret, summary = gsi->flags & GSF_COMPUTE_SUMMARY;
249 if (!gsi->count && !summary) {
250 ret = -E_LOOP_COMPLETE;
253 if (summary || (gsi->count && (gsi->flags & GSF_PRINT_FILES))) {
255 ret = osl(osl_get_object(dir_table, row, DT_FILES, &obj));
258 files = *(uint64_t *)obj.data;
259 if (gsi->count && (gsi->flags & GSF_PRINT_FILES)) {
260 format_count_value(select_conf.count_unit_arg, files,
261 select_conf.count_unit_arg == count_unit_arg_h,
263 printf("\t%s%s", formated_value,
264 (gsi->flags & (GSF_PRINT_BYTES | GSF_PRINT_DIRNAME))?
270 if (summary || (gsi->count && (gsi->flags & GSF_PRINT_BYTES))) {
272 ret = osl(osl_get_object(dir_table, row, DT_BYTES, &obj));
275 bytes = *(uint64_t *)obj.data;
276 if (gsi->count && (gsi->flags & GSF_PRINT_BYTES)) {
277 format_size_value(select_conf.size_unit_arg, bytes,
278 select_conf.size_unit_arg == size_unit_arg_h,
281 (gsi->flags & GSF_PRINT_FILES)? "" : "\t",
283 (gsi->flags & GSF_PRINT_DIRNAME)? "\t" : "\n"
291 if (gsi->count && (gsi->flags & GSF_PRINT_DIRNAME)) {
292 ret = get_dir_name_of_row(row, &dirname);
296 (gsi->flags & (GSF_PRINT_BYTES | GSF_PRINT_FILES))? "" : "\t",
305 gsi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
309 static int check_loop_return(int ret, int loop_ret, int loop_osl_errno)
313 assert(ret == -E_OSL);
314 if (osl_errno != E_OSL_LOOP)
315 /* error not caused by loop function returning negative. */
317 assert(loop_ret < 0);
318 if (loop_ret == -E_LOOP_COMPLETE) /* no error */
320 if (loop_ret == -E_OSL) { /* osl error in loop function */
321 assert(loop_osl_errno);
322 osl_errno = loop_osl_errno;
327 static int adu_loop_reverse(struct osl_table *t, unsigned col_num, void *private_data,
328 osl_rbtree_loop_func *func, int *loop_ret, int *loop_osl_errno)
330 int ret = osl(osl_rbtree_loop_reverse(t, col_num, private_data, func));
331 return check_loop_return(ret, *loop_ret, *loop_osl_errno);
334 static void print_global_summary(void)
336 char d[FORMATED_VALUE_SIZE], f[FORMATED_VALUE_SIZE],
337 s[FORMATED_VALUE_SIZE];
338 enum enum_count_unit ud, uf;
339 enum enum_size_unit us;
341 if (select_conf.no_global_summary_given)
343 ud = format_count_value(select_conf.count_unit_arg, num_dirs, 0, d);
344 uf = format_count_value(select_conf.count_unit_arg, num_files, 0, f);
345 us = format_size_value(select_conf.size_unit_arg, num_bytes, 0, s);
347 if (!select_conf.no_headers_given)
348 printf("Global summary "
349 "(dirs(%c)/files(%c)/size(%c))\n",
350 count_unit_abbrevs[ud],
351 count_unit_abbrevs[uf],
352 size_unit_abbrevs[us]
354 printf("\t%s\t%s\t%s\n\n", d, f, s);
357 static int print_user_summary_line(struct user_info *ui, __a_unused void *data)
359 char formated_dir_count[FORMATED_VALUE_SIZE],
360 formated_file_count[FORMATED_VALUE_SIZE],
361 formated_bytes[FORMATED_VALUE_SIZE ];
363 format_count_value(select_conf.count_unit_arg, ui->dirs,
364 select_conf.count_unit_arg == count_unit_arg_h,
366 format_count_value(select_conf.count_unit_arg, ui->files,
367 select_conf.count_unit_arg == count_unit_arg_h,
368 formated_file_count);
369 format_size_value(select_conf.size_unit_arg, ui->bytes,
370 select_conf.size_unit_arg == size_unit_arg_h,
372 printf("\t%s\t%u\t%s\t%s\t%s\n",
373 ui->pw_name? ui->pw_name : "?",
382 static int name_comp(const void *a, const void *b)
384 char *x = ((struct user_info *)a)->pw_name;
385 char *y = ((struct user_info *)b)->pw_name;
394 static int uid_comp(const void *a, const void *b)
396 return -NUM_COMPARE(((struct user_info *)a)->uid,
397 ((struct user_info *)b)->uid);
400 static int dir_count_comp(const void *a, const void *b)
402 return NUM_COMPARE(((struct user_info *)a)->dirs,
403 ((struct user_info *)b)->dirs);
406 static int file_count_comp(const void *a, const void *b)
408 return NUM_COMPARE(((struct user_info *)a)->files,
409 ((struct user_info *)b)->files);
412 static int size_comp(const void *a, const void *b)
414 return NUM_COMPARE(((struct user_info *)a)->bytes,
415 ((struct user_info *)b)->bytes);
419 * The comparators for sorting the user summary.
421 * This is an array of pointers to functions taking two constant void *
422 * pointers and returning an int.
424 static int (*summary_comparators[])(const void *, const void *) = {
425 [user_summary_sort_arg_name] = name_comp,
426 [user_summary_sort_arg_uid] = uid_comp,
427 [user_summary_sort_arg_dir_count] = dir_count_comp,
428 [user_summary_sort_arg_file_count] = file_count_comp,
429 [user_summary_sort_arg_size] = size_comp,
432 static void print_user_summary(void)
434 if (select_conf.no_user_summary_given)
436 if (!select_conf.no_headers_given)
437 printf("User summary "
438 "(pw_name/uid/dirs%s/files%s/size%s):\n",
439 count_unit_buf, count_unit_buf, size_unit_buf);
440 sort_hash_table(summary_comparators[select_conf.user_summary_sort_arg]);
441 for_each_admissible_user(print_user_summary_line, NULL);
444 static int print_user_list(struct user_info *ui, __a_unused void *data)
447 struct user_stats_info usi;
448 enum enum_user_list ula = select_conf.user_list_arg;
449 int print_size_list = (ula == user_list_arg_size
450 || ula == user_list_arg_both);
452 if (print_size_list) {
453 usi.count = select_conf.limit_arg;
455 usi.flags = USF_PRINT_DIRNAME | USF_PRINT_BYTES | USF_COMPUTE_SUMMARY;
456 if (!select_conf.no_headers_given)
457 printf("%s (uid %u), by size%s:\n",
458 ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid,
460 ret = adu_loop_reverse(ui->table, UT_BYTES, &usi, user_stats_loop_function,
461 &usi.ret, &usi.osl_errno);
466 if (ula == user_list_arg_file_count || ula == user_list_arg_both) {
467 if (!select_conf.no_headers_given)
468 printf("%s (uid %u), by file count%s:\n",
469 ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid,
471 usi.count = select_conf.limit_arg,
473 usi.flags = USF_PRINT_DIRNAME | USF_PRINT_FILES;
474 ret = adu_loop_reverse(ui->table, UT_FILES, &usi, user_stats_loop_function,
475 &usi.ret, &usi.osl_errno);
480 if (ula == user_list_arg_none && !select_conf.no_user_summary_given) {
481 usi.count = select_conf.limit_arg;
483 usi.flags = USF_COMPUTE_SUMMARY;
484 ret = adu_loop_reverse(ui->table, UT_FILES, &usi, user_stats_loop_function,
485 &usi.ret, &usi.osl_errno);
492 static int print_user_lists(void)
494 return for_each_admissible_user(print_user_list, NULL);
497 static int print_global_lists(void)
499 struct global_stats_info gsi;
501 enum enum_global_list gla = select_conf.global_list_arg;
502 int print_size_list = (gla == global_list_arg_size
503 || gla == global_list_arg_both);
505 if (print_size_list) {
506 gsi.count = select_conf.limit_arg;
507 gsi.flags = GSF_PRINT_DIRNAME | GSF_PRINT_BYTES | GSF_COMPUTE_SUMMARY;
508 if (!select_conf.no_headers_given)
509 printf("By size%s:\n", size_unit_buf);
510 ret = adu_loop_reverse(dir_table, DT_BYTES, &gsi,
511 global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
516 if (gla == global_list_arg_file_count || gla == global_list_arg_both) {
517 gsi.count = select_conf.limit_arg;
518 gsi.flags = GSF_PRINT_DIRNAME | GSF_PRINT_FILES;
519 if (!print_size_list)
520 gsi.flags |= GSF_COMPUTE_SUMMARY;
521 if (!select_conf.no_headers_given)
522 printf("By file count%s:\n", count_unit_buf);
523 ret = adu_loop_reverse(dir_table, DT_FILES, &gsi,
524 global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
529 if (gla == global_list_arg_none && !select_conf.no_global_summary_given) {
530 /* must compute summary */
531 gsi.count = select_conf.limit_arg;
532 gsi.flags = GSF_COMPUTE_SUMMARY;
533 ret = adu_loop_reverse(dir_table, DT_FILES, &gsi,
534 global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
541 static int print_statistics(void)
545 ret = print_global_lists();
548 print_global_summary();
550 print_user_summary();
554 static int read_uid_file(void)
558 char *filename = get_uid_list_name(), *map;
559 int ret = mmap_full_file(filename, O_RDONLY, (void **)&map, &size, NULL);
563 INFO_LOG("failed to map %s\n", filename);
568 INFO_LOG("found %u uids in %s\n", (unsigned)num_uids, filename);
571 * Compute number of hash table bits. The hash table size must be a
572 * power of two and larger than the number of uids.
575 while (1 << bits < num_uids)
577 create_hash_table(bits);
578 for (n = 0; n < num_uids; n++) {
579 uint32_t uid = read_u32(map + n * sizeof(uid));
580 ret = search_uid(uid, admissible_uids, OPEN_USER_TABLE, NULL);
585 adu_munmap(map, size);
592 if (conf.select_options_given) {
593 struct select_cmdline_parser_params params = {
597 .check_ambiguity = 1,
601 if (select_cmdline_parser_string_ext(conf.select_options_arg,
602 &select_conf, "select", ¶ms))
604 ret = parse_uid_arg(select_conf.uid_arg, &admissible_uids);
609 if (select_conf.count_unit_arg != count_unit_arg_h)
610 count_unit_buf[1] = count_unit_abbrevs[select_conf.count_unit_arg];
612 count_unit_buf[0] = '\0';
613 if (select_conf.size_unit_arg != size_unit_arg_h)
614 size_unit_buf[1] = size_unit_abbrevs[select_conf.size_unit_arg];
616 size_unit_buf[0] = '\0';
618 ret = open_dir_table(0);
622 ret = read_uid_file();
626 ret = print_statistics();