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"
18 #include "select.cmdline.h"
21 #define GLOBAL_LIST_ATOMS \
24 ATOM(dirname, STRING) \
26 #define ATOM(x, y) { .name = #x, .type = AT_ ## y},
27 struct atom global_list_atoms[] = {
32 #define ATOM(x, y) gla_ ## x,
33 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};
53 #define USER_LIST_ATOMS \
54 ATOM(pw_name, STRING) \
58 ATOM(dirname, STRING) \
60 #define ATOM(x, y) { .name = #x, .type = AT_ ## y},
61 struct atom user_list_atoms[] = {
66 #define ATOM(x, y) ula_ ## x,
67 enum user_list_atoms {USER_LIST_ATOMS};
71 #define USER_SUMMARY_ATOMS \
72 ATOM(pw_name, STRING) \
78 #define ATOM(x, y) { .name = #x, .type = AT_ ## y},
79 struct atom user_summary_atoms[] = {
84 #define ATOM(x, y) usa_ ## x,
85 enum user_summary_atoms {USER_SUMMARY_ATOMS};
88 struct global_list_info {
92 struct format_info *fi;
95 struct global_summary_info {
96 /** Global dir count. */
98 /** Global files count. */
100 /** Global bytes count. */
106 struct user_list_info {
108 struct user_info *ui;
109 struct format_info *fi;
114 struct user_summary_info {
115 struct user_info *ui;
121 static FILE *output_file;
123 __printf_1_2 static int output(const char const *fmt, ...)
129 ret = vfprintf(output_file, fmt, argp);
131 return ret < 0? -E_OUTPUT : 1;
134 static int get_dir_name_by_number(uint64_t *dirnum, char **name)
136 char *result = NULL, *tmp;
138 uint64_t val = *dirnum;
139 struct osl_object obj;
145 obj.size = sizeof(val);
146 ret = osl(osl_get_row(dir_table, DT_NUM, &obj, &row));
149 ret = osl(osl_get_object(dir_table, row, DT_PARENT_NUM, &obj));
152 val = *(uint64_t *)obj.data;
153 ret = osl(osl_get_object(dir_table, row, DT_NAME, &obj));
156 pfx = (select_conf.print_base_dir_given || val)? (char *)obj.data : ".";
157 tmp = make_message("%s/%s", pfx, result? result : "");
173 static int get_dir_name_of_row(struct osl_row *dir_table_row, char **name)
175 struct osl_object obj;
179 ret = osl(osl_get_object(dir_table, dir_table_row, DT_NUM, &obj));
182 return get_dir_name_by_number((uint64_t *)obj.data, name);
185 static int get_dir_name_of_user_row(struct osl_row *user_table_row,
186 struct user_info *ui, char **dirname)
188 struct osl_object obj;
189 int ret = osl(osl_get_object(ui->table, user_table_row,
194 return get_dir_name_by_number((uint64_t *)obj.data, dirname);
197 static int get_num_files_of_row(struct osl_row *row, uint64_t *num_files)
199 struct osl_object obj;
200 int ret = osl(osl_get_object(dir_table, row, DT_FILES, &obj));
203 *num_files = *(uint64_t *)obj.data;
207 static int get_num_user_files(struct osl_row *row, struct user_info *ui,
210 struct osl_object obj;
211 int ret = osl(osl_get_object(ui->table, row, UT_FILES, &obj));
215 *num_files = *(uint64_t *)obj.data;
219 static int get_num_bytes_of_row(struct osl_row *row, uint64_t *num_bytes)
221 struct osl_object obj;
222 int ret = osl(osl_get_object(dir_table, row, DT_BYTES, &obj));
225 *num_bytes = *(uint64_t *)obj.data;
229 static int get_num_user_bytes(struct osl_row *row, struct user_info *ui,
232 struct osl_object obj;
233 int ret = osl(osl_get_object(ui->table, row, UT_BYTES, &obj));
237 *num_bytes = *(uint64_t *)obj.data;
241 static int check_loop_return(int ret, int loop_ret, int loop_osl_errno)
245 assert(ret == -E_OSL);
246 if (osl_errno != E_OSL_LOOP)
247 /* error not caused by loop function returning negative. */
249 assert(loop_ret < 0);
250 if (loop_ret == -E_LOOP_COMPLETE) /* no error */
252 if (loop_ret == -E_OSL) { /* osl error in loop function */
253 assert(loop_osl_errno);
254 osl_errno = loop_osl_errno;
259 static int adu_loop_reverse(struct osl_table *t, unsigned col_num, void *private_data,
260 osl_rbtree_loop_func *func, int *loop_ret, int *loop_osl_errno)
262 int ret = osl(osl_rbtree_loop_reverse(t, col_num, private_data, func));
263 return check_loop_return(ret, *loop_ret, *loop_osl_errno);
266 static int global_summary_loop_function(struct osl_row *row, void *data)
268 struct global_summary_info *gsi = data;
272 ret = get_num_files_of_row(row, &num);
275 gsi->num_files += num;
277 ret = get_num_bytes_of_row(row, &num);
280 gsi->num_bytes += num;
285 gsi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
289 static int print_global_summary(struct format_info *fi)
293 struct global_summary_info gsi = {.num_dirs = 0};
295 union atom_value values[] = {
296 [gsa_dirs] = {.num_value = 0ULL},
297 [gsa_files] = {.num_value = 0ULL},
298 [gsa_size] = {.num_value = 0ULL}
301 ret = adu_loop_reverse(dir_table, DT_BYTES, &gsi,
302 global_summary_loop_function, &gsi.ret, &gsi.osl_errno);
305 values[gsa_dirs].num_value = (long long unsigned)gsi.num_dirs;
306 values[gsa_files].num_value = (long long unsigned)gsi.num_files;
307 values[gsa_size].num_value = (long long unsigned)gsi.num_bytes;
308 if (!select_conf.no_headers_given) {
309 ret = output("Global summary\n");
313 buf = format_items(fi, values);
314 ret = output("%s", buf);
319 static int user_summary_loop_function(struct osl_row *row, void *data)
321 struct user_summary_info *usi = data;
325 ret = get_num_user_files(row, usi->ui, &num);
328 usi->ui->files += num;
329 ret = get_num_user_bytes(row, usi->ui, &num);
332 usi->ui->bytes += num;
337 usi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
341 static int compute_user_summary(struct user_info *ui, __a_unused void *data)
343 struct user_summary_info usi = {.ui = ui};
345 return adu_loop_reverse(ui->table, UT_BYTES, &usi, user_summary_loop_function,
346 &usi.ret, &usi.osl_errno);
349 static int print_user_summary_line(struct user_info *ui, void *data)
351 struct format_info *fi = data;
352 union atom_value values[] = {
353 [usa_pw_name] = {.string_value = ui->pw_name?
355 [usa_uid] = {.num_value = (long long unsigned)ui->uid},
356 [usa_dirs] = {.num_value = (long long unsigned)ui->dirs},
357 [usa_files] = {.num_value = (long long unsigned)ui->files},
358 [usa_size] = {.num_value = (long long unsigned)ui->bytes}
363 buf = format_items(fi, values);
364 ret = output("%s", buf);
369 static int name_comp(const void *a, const void *b)
371 char *x = ((struct user_info *)a)->pw_name;
372 char *y = ((struct user_info *)b)->pw_name;
381 static int uid_comp(const void *a, const void *b)
383 return -NUM_COMPARE(((struct user_info *)a)->uid,
384 ((struct user_info *)b)->uid);
387 static int dir_count_comp(const void *a, const void *b)
389 return NUM_COMPARE(((struct user_info *)a)->dirs,
390 ((struct user_info *)b)->dirs);
393 static int file_count_comp(const void *a, const void *b)
395 return NUM_COMPARE(((struct user_info *)a)->files,
396 ((struct user_info *)b)->files);
399 static int size_comp(const void *a, const void *b)
401 return NUM_COMPARE(((struct user_info *)a)->bytes,
402 ((struct user_info *)b)->bytes);
405 static int print_user_summary(struct format_info *fi)
408 * The comparators for sorting the user summary.
410 * This is an array of pointers to functions taking two constant void *
411 * pointers and returning an int.
413 static int (*summary_comparators[])(const void *, const void *) = {
414 [user_summary_sort_arg_name] = name_comp,
415 [user_summary_sort_arg_uid] = uid_comp,
416 [user_summary_sort_arg_dir_count] = dir_count_comp,
417 [user_summary_sort_arg_file_count] = file_count_comp,
418 [user_summary_sort_arg_size] = size_comp,
421 if (!select_conf.no_headers_given) {
422 int ret = output("User summary\n");
426 int ret = for_each_admissible_user(compute_user_summary, fi);
429 sort_hash_table(summary_comparators[select_conf.user_summary_sort_arg]);
430 return for_each_admissible_user(print_user_summary_line, fi);
433 static int user_list_loop_function(struct osl_row *row, void *data)
435 struct user_list_info *uli = data;
436 union atom_value values[] = {
437 [ula_pw_name] = {.string_value = uli->ui->pw_name?
438 uli->ui->pw_name : "?"},
439 [ula_uid] = {.num_value = (long long unsigned)uli->ui->uid},
440 [ula_files] = {.num_value = 0ULL},
441 [ula_size] = {.num_value = 0ULL},
442 [ula_dirname] = {.string_value = NULL}
449 ret = -E_LOOP_COMPLETE;
453 ret = get_num_user_files(row, uli->ui, &num);
456 values[ula_files].num_value = num;
458 ret = get_num_user_bytes(row, uli->ui, &num);
461 values[ula_size].num_value = num;
463 ret = get_dir_name_of_user_row(row, uli->ui, &dirname);
466 values[ula_dirname].string_value = dirname;
468 buf = format_items(uli->fi, values);
470 ret = output("%s", buf);
478 uli->osl_errno = (ret == -E_OSL)? osl_errno : 0;
482 static int print_user_list(struct user_info *ui, void *data)
484 struct format_info *fi = data;
486 enum user_table_columns sort_column = UT_BYTES;
487 struct user_list_info uli = {
490 .count = select_conf.limit_arg
493 if (select_conf.list_sort_arg == list_sort_arg_file_count)
494 sort_column = UT_FILES;
496 if (!select_conf.no_headers_given) {
497 ret = output("%s (uid %u)\n",
498 ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid);
502 return adu_loop_reverse(ui->table, sort_column, &uli, user_list_loop_function,
503 &uli.ret, &uli.osl_errno);
506 static int global_list_loop_function(struct osl_row *row, void *data)
508 struct global_list_info *gli = data;
509 union atom_value values[] = {
510 [gla_size] = {.num_value = 0ULL},
511 [gla_files] = {.num_value = 0ULL},
512 [gla_dirname] = {.string_value = NULL}
514 uint64_t num_files, num_bytes;
519 ret = -E_LOOP_COMPLETE;
523 ret = get_num_files_of_row(row, &num_files);
526 values[gla_files].num_value = (long long unsigned)num_files;
528 ret = get_num_bytes_of_row(row, &num_bytes);
531 values[gla_size].num_value = (long long unsigned)num_bytes;
533 ret = get_dir_name_of_row(row, &dirname);
536 values[gla_dirname].string_value = dirname;
538 buf = format_items(gli->fi, values);
540 ret = output("%s", buf);
549 gli->osl_errno = (ret == -E_OSL)? osl_errno : 0;
553 static int print_global_list(struct format_info *fi)
556 enum dir_table_columns sort_column = DT_BYTES;
557 struct global_list_info gli = {
559 .count = select_conf.limit_arg
562 if (!select_conf.no_headers_given) {
563 ret = output("Global list\n");
567 if (select_conf.list_sort_arg == list_sort_arg_file_count)
568 sort_column = DT_FILES;
569 return adu_loop_reverse(dir_table, sort_column, &gli,
570 global_list_loop_function, &gli.ret, &gli.osl_errno);
573 static int print_statistics(struct format_info *fi)
575 switch (select_conf.select_mode_arg) {
576 case select_mode_arg_global_list:
577 return print_global_list(fi);
578 case select_mode_arg_global_summary:
579 return print_global_summary(fi);
580 case select_mode_arg_user_list:
581 return for_each_admissible_user(print_user_list, fi);
582 case select_mode_arg_user_summary:
583 return print_user_summary(fi);
585 ERROR_LOG("bad select mode\n");
586 return -ERRNO_TO_ERROR(-EINVAL);
589 int run_select_query(struct uid_range *admissible_uids, struct format_info *fi)
593 if (select_conf.output_given && strcmp(select_conf.output_arg, "-")) {
594 output_file = fopen(select_conf.output_arg, "w");
596 return -ERRNO_TO_ERROR(errno);
598 output_file = stdout;
600 ret = open_dir_table(0);
604 ret = read_uid_file(admissible_uids);
608 ret = print_statistics(fi);
611 if (output_file != stdout)
616 #define GLOBAL_LIST_DFLT_FMT "%(size:r:8) %(files:r:8) %(dirname)\n"
617 #define GLOBAL_SUMMARY_DFLT_FMT "#directories: %(dirs), #files: %(files), size: %(size)\n\n"
618 #define USER_LIST_DFLT_FMT "%(size:r:5) %(files:r:5) %(dirname)\n"
619 #define USER_SUMMARY_DFLT_FMT "%(pw_name:l:16) %(uid:r:5) %(dirs:r:5) %(files:r:5) %(size:r:5)\n"
621 static int setup_format_string(char *fmt, struct format_info **fi)
626 INFO_LOG("using default format string\n");
627 switch (select_conf.select_mode_arg) {
628 case select_mode_arg_global_list:
630 fmt = GLOBAL_LIST_DFLT_FMT;
631 atoms = global_list_atoms;
633 case select_mode_arg_global_summary:
635 fmt = GLOBAL_SUMMARY_DFLT_FMT;
636 atoms = global_summary_atoms;
638 case select_mode_arg_user_list:
640 fmt = USER_LIST_DFLT_FMT;
641 atoms = user_list_atoms;
643 case select_mode_arg_user_summary:
645 fmt = USER_SUMMARY_DFLT_FMT;
646 atoms = user_summary_atoms;
649 ERROR_LOG("bad select mode\n");
650 return -ERRNO_TO_ERROR(-EINVAL);
652 INFO_LOG("format string: %s\n", fmt);
653 return parse_format_string(fmt, atoms, fi);
656 /* return: < 0: error, >0: OK, == 0: help given */
657 int parse_select_options(char *string, struct select_cmdline_parser_params *params,
658 struct uid_range **admissible_uids, struct format_info **fi)
668 ret = create_argv(string, &argv);
672 ret = select_cmdline_parser_ext(argc, argv, &select_conf, params);
676 if (select_conf.help_given || select_conf.detailed_help_given)
678 fmt = select_conf.format_arg;
680 ret = parse_uid_arg(select_conf.uid_arg, admissible_uids);
683 return setup_format_string(fmt, fi);
685 line = select_conf.detailed_help_given?
686 select_args_info_detailed_help : select_args_info_help;
688 output_file = stdout;
689 for (; *line; line++) {
690 ret = output("%s\n", *line);
699 struct uid_range *admissible_uids = NULL;
701 struct format_info *fi;
702 struct select_cmdline_parser_params params = {
706 .check_ambiguity = 1,
710 select_cmdline_parser_init(&select_conf);
711 ret = parse_select_options(conf.select_options_arg, ¶ms,
712 &admissible_uids, &fi);
713 if (ret <= 0) /* do not run query if help was given */
715 ret = run_select_query(admissible_uids, fi);
716 free_format_info(fi);