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(struct user_info *a, struct user_info *b)
371 char *x = a->pw_name;
372 char *y = b->pw_name;
381 static int uid_comp(struct user_info *a, struct user_info *b)
383 return -NUM_COMPARE(a->uid, b->uid);
386 static int dir_count_comp(struct user_info *a, struct user_info *b)
388 return NUM_COMPARE(a->dirs, b->dirs);
391 static int file_count_comp(struct user_info *a, struct user_info *b)
393 return NUM_COMPARE(a->files, b->files);
396 static int size_comp(struct user_info *a, struct user_info *b)
398 return NUM_COMPARE(a->bytes, b->bytes);
401 static int print_user_summary(struct format_info *fi)
404 int (*comp)(struct user_info *a, struct user_info *b);
406 if (!select_conf.no_headers_given) {
407 ret = output("User summary\n");
411 ret = for_each_admissible_user(compute_user_summary, fi);
414 switch (select_conf.user_summary_sort_arg) {
415 case user_summary_sort_arg_name:
418 case user_summary_sort_arg_uid:
421 case user_summary_sort_arg_dir_count:
422 comp = dir_count_comp;
424 case user_summary_sort_arg_file_count:
425 comp = file_count_comp;
427 case user_summary_sort_arg_size:
431 sort_hash_table(comp);
432 return for_each_admissible_user(print_user_summary_line, fi);
435 static int user_list_loop_function(struct osl_row *row, void *data)
437 struct user_list_info *uli = data;
438 union atom_value values[] = {
439 [ula_pw_name] = {.string_value = uli->ui->pw_name?
440 uli->ui->pw_name : "?"},
441 [ula_uid] = {.num_value = (long long unsigned)uli->ui->uid},
442 [ula_files] = {.num_value = 0ULL},
443 [ula_size] = {.num_value = 0ULL},
444 [ula_dirname] = {.string_value = NULL}
451 ret = -E_LOOP_COMPLETE;
455 ret = get_num_user_files(row, uli->ui, &num);
458 values[ula_files].num_value = num;
460 ret = get_num_user_bytes(row, uli->ui, &num);
463 values[ula_size].num_value = num;
465 ret = get_dir_name_of_user_row(row, uli->ui, &dirname);
468 values[ula_dirname].string_value = dirname;
470 buf = format_items(uli->fi, values);
472 ret = output("%s", buf);
480 uli->osl_errno = (ret == -E_OSL)? osl_errno : 0;
484 static int print_user_list(struct user_info *ui, void *data)
486 struct format_info *fi = data;
488 enum user_table_columns sort_column = UT_BYTES;
489 struct user_list_info uli = {
492 .count = select_conf.limit_arg
495 if (select_conf.list_sort_arg == list_sort_arg_file_count)
496 sort_column = UT_FILES;
498 if (!select_conf.no_headers_given) {
499 ret = output("%s (uid %u)\n",
500 ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid);
504 return adu_loop_reverse(ui->table, sort_column, &uli, user_list_loop_function,
505 &uli.ret, &uli.osl_errno);
508 static int global_list_loop_function(struct osl_row *row, void *data)
510 struct global_list_info *gli = data;
511 union atom_value values[] = {
512 [gla_size] = {.num_value = 0ULL},
513 [gla_files] = {.num_value = 0ULL},
514 [gla_dirname] = {.string_value = NULL}
516 uint64_t num_files, num_bytes;
521 ret = -E_LOOP_COMPLETE;
525 ret = get_num_files_of_row(row, &num_files);
528 values[gla_files].num_value = (long long unsigned)num_files;
530 ret = get_num_bytes_of_row(row, &num_bytes);
533 values[gla_size].num_value = (long long unsigned)num_bytes;
535 ret = get_dir_name_of_row(row, &dirname);
538 values[gla_dirname].string_value = dirname;
540 buf = format_items(gli->fi, values);
542 ret = output("%s", buf);
551 gli->osl_errno = (ret == -E_OSL)? osl_errno : 0;
555 static int print_global_list(struct format_info *fi)
558 enum dir_table_columns sort_column = DT_BYTES;
559 struct global_list_info gli = {
561 .count = select_conf.limit_arg
564 if (!select_conf.no_headers_given) {
565 ret = output("Global list\n");
569 if (select_conf.list_sort_arg == list_sort_arg_file_count)
570 sort_column = DT_FILES;
571 return adu_loop_reverse(dir_table, sort_column, &gli,
572 global_list_loop_function, &gli.ret, &gli.osl_errno);
575 static int print_statistics(struct format_info *fi)
577 switch (select_conf.select_mode_arg) {
578 case select_mode_arg_global_list:
579 return print_global_list(fi);
580 case select_mode_arg_global_summary:
581 return print_global_summary(fi);
582 case select_mode_arg_user_list:
583 return for_each_admissible_user(print_user_list, fi);
584 case select_mode_arg_user_summary:
585 return print_user_summary(fi);
587 ERROR_LOG("bad select mode\n");
588 return -ERRNO_TO_ERROR(EINVAL);
591 static int open_pipe(char *path)
598 return ERRNO_TO_ERROR(errno);
601 return ERRNO_TO_ERROR(errno);
602 if (ret) { /* parent */
603 DEBUG_LOG("created process %d\n", ret);
605 output_file = fdopen(p[1], "w");
607 return ERRNO_TO_ERROR(errno);
611 if (p[0] != STDIN_FILENO)
612 dup2(p[0], STDIN_FILENO);
613 DEBUG_LOG("executing %s\n", path);
614 argc = split_args(path, &argv, " \t");
615 execvp(argv[0], argv);
616 ERROR_LOG("error executing %s: %s\n", path,
617 adu_strerror(ERRNO_TO_ERROR(errno)));
621 static int open_output_stream(void)
624 int ret, flags = O_WRONLY | O_CREAT;
626 if (!select_conf.output_given)
628 p = select_conf.output_arg;
630 case '\0': /* empty string */
633 if (!p[1]) /* "-" means stdout */
635 /* string starting with a dash */
639 if (!p[1]) /* ">" is invalid */
646 /* string starting with ">>" */
647 if (!p[2]) /* ">>" is invalid */
653 if (!p[1]) /* "|" is invalid */
657 default: /* args starts with no magic character */
662 output_file = stdout;
666 return -E_BAD_OUTPUT_ARG;
669 * glibc's 'x' mode to fopen is not portable, so use open() and
672 ret = open(p, flags, 0644);
674 return -ERRNO_TO_ERROR(errno);
675 output_file = fdopen(ret, "w");
677 return -ERRNO_TO_ERROR(errno);
681 int run_select_query(struct uid_range *admissible_uids, struct format_info *fi)
683 int ret = open_output_stream();
687 ret = open_dir_table(0);
691 ret = open_admissible_user_tables(admissible_uids);
695 ret = print_statistics(fi);
697 if (output_file && output_file != stdout) {
704 #define GLOBAL_LIST_DFLT_FMT "%(size:r:8) %(files:r:8) %(dirname)\n"
705 #define GLOBAL_SUMMARY_DFLT_FMT "#directories: %(dirs), #files: %(files), size: %(size)\n\n"
706 #define USER_LIST_DFLT_FMT "%(size:r:5) %(files:r:5) %(dirname)\n"
707 #define USER_SUMMARY_DFLT_FMT "%(pw_name:l:16) %(uid:r:5) %(dirs:r:5) %(files:r:5) %(size:r:5)\n"
709 static int setup_format_string(char *fmt, struct format_info **fi)
714 INFO_LOG("using default format string\n");
715 switch (select_conf.select_mode_arg) {
716 case select_mode_arg_global_list:
718 fmt = GLOBAL_LIST_DFLT_FMT;
719 atoms = global_list_atoms;
721 case select_mode_arg_global_summary:
723 fmt = GLOBAL_SUMMARY_DFLT_FMT;
724 atoms = global_summary_atoms;
726 case select_mode_arg_user_list:
728 fmt = USER_LIST_DFLT_FMT;
729 atoms = user_list_atoms;
731 case select_mode_arg_user_summary:
733 fmt = USER_SUMMARY_DFLT_FMT;
734 atoms = user_summary_atoms;
737 ERROR_LOG("bad select mode\n");
738 return -ERRNO_TO_ERROR(EINVAL);
740 INFO_LOG("format string: %s\n", fmt);
741 return parse_format_string(fmt, atoms, fi);
744 /* return: < 0: error, >0: OK, == 0: help given */
745 int parse_select_options(char *string, struct select_cmdline_parser_params *params,
746 struct uid_range **admissible_uids, struct format_info **fi)
748 int ret, num_uid_ranges;
756 ret = create_argv(string, &argv);
760 ret = select_cmdline_parser_ext(argc, argv, &select_conf, params);
764 if (select_conf.help_given || select_conf.detailed_help_given)
766 fmt = select_conf.format_arg;
768 ret = parse_uid_arg(select_conf.uid_arg, admissible_uids);
771 num_uid_ranges = ret;
772 ret = append_users(select_conf.user_arg, select_conf.user_given,
773 admissible_uids, num_uid_ranges);
776 return setup_format_string(fmt, fi);
778 line = select_conf.detailed_help_given?
779 select_args_info_detailed_help : select_args_info_help;
781 output_file = stdout;
782 for (; *line; line++) {
783 ret = output("%s\n", *line);
792 struct uid_range *admissible_uids = NULL;
794 struct format_info *fi;
795 struct select_cmdline_parser_params params = {
799 .check_ambiguity = 1,
803 ret = parse_select_options(conf.select_options_arg, ¶ms,
804 &admissible_uids, &fi);
806 ret = read_uid_file();
809 ret = run_select_query(admissible_uids, fi);
810 free_format_info(fi);
813 select_cmdline_parser_free(&select_conf);