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"
17 #include "portable_io.h"
20 #define GLOBAL_LIST_ATOMS \
23 ATOM(dirname, STRING) \
25 #define ATOM(x, y) { .name = #x, .type = AT_ ## y},
26 struct atom global_list_atoms[] = {
31 #define ATOM(x, y) gla_ ## x,
32 enum global_list_atoms {GLOBAL_LIST_ATOMS};
36 #define GLOBAL_SUMMARY_ATOMS \
41 #define ATOM(x, y) { .name = #x, .type = AT_ ## y},
42 struct atom global_summary_atoms[] = {
47 #define ATOM(x, y) gsa_ ## x,
48 enum global_summary_atoms {GLOBAL_SUMMARY_ATOMS};
52 #define USER_LIST_ATOMS \
53 ATOM(pw_name, STRING) \
57 ATOM(dirname, STRING) \
59 #define ATOM(x, y) { .name = #x, .type = AT_ ## y},
60 struct atom user_list_atoms[] = {
65 #define ATOM(x, y) ula_ ## x,
66 enum user_list_atoms {USER_LIST_ATOMS};
70 #define USER_SUMMARY_ATOMS \
71 ATOM(pw_name, STRING) \
77 #define ATOM(x, y) { .name = #x, .type = AT_ ## y},
78 struct atom user_summary_atoms[] = {
83 #define ATOM(x, y) usa_ ## x,
84 enum user_summary_atoms {USER_SUMMARY_ATOMS};
87 struct global_list_info {
91 struct format_info *fi;
94 struct global_summary_info {
95 /** Global dir count. */
97 /** Global files count. */
99 /** Global bytes count. */
105 struct user_list_info {
107 struct user_info *ui;
108 struct format_info *fi;
113 struct user_summary_info {
114 struct user_info *ui;
120 static FILE *output_file;
122 __printf_1_2 static int output(const char const *fmt, ...)
128 ret = vfprintf(output_file, fmt, argp);
130 return ret < 0? -E_OUTPUT : 1;
133 static int get_dir_name_by_number(uint64_t *dirnum, char **name)
135 char *result = NULL, *tmp;
137 uint64_t val = *dirnum;
138 struct osl_object obj;
144 obj.size = sizeof(val);
145 ret = osl(osl_get_row(dir_table, DT_NUM, &obj, &row));
148 ret = osl(osl_get_object(dir_table, row, DT_PARENT_NUM, &obj));
151 val = *(uint64_t *)obj.data;
152 ret = osl(osl_get_object(dir_table, row, DT_NAME, &obj));
155 pfx = (select_conf.print_base_dir_given || val)? (char *)obj.data : ".";
156 tmp = make_message("%s/%s", pfx, result? result : "");
172 static int get_dir_name_of_row(struct osl_row *dir_table_row, char **name)
174 struct osl_object obj;
178 ret = osl(osl_get_object(dir_table, dir_table_row, DT_NUM, &obj));
181 return get_dir_name_by_number((uint64_t *)obj.data, name);
184 static int get_dir_name_of_user_row(struct osl_row *user_table_row,
185 struct user_info *ui, char **dirname)
187 struct osl_object obj;
188 int ret = osl(osl_get_object(ui->table, user_table_row,
193 return get_dir_name_by_number((uint64_t *)obj.data, dirname);
196 static int get_num_files_of_row(struct osl_row *row, uint64_t *num_files)
198 struct osl_object obj;
199 int ret = osl(osl_get_object(dir_table, row, DT_FILES, &obj));
202 *num_files = *(uint64_t *)obj.data;
206 static int get_num_user_files(struct osl_row *row, struct user_info *ui,
209 struct osl_object obj;
210 int ret = osl(osl_get_object(ui->table, row, UT_FILES, &obj));
214 *num_files = *(uint64_t *)obj.data;
218 static int get_num_bytes_of_row(struct osl_row *row, uint64_t *num_bytes)
220 struct osl_object obj;
221 int ret = osl(osl_get_object(dir_table, row, DT_BYTES, &obj));
224 *num_bytes = *(uint64_t *)obj.data;
228 static int get_num_user_bytes(struct osl_row *row, struct user_info *ui,
231 struct osl_object obj;
232 int ret = osl(osl_get_object(ui->table, row, UT_BYTES, &obj));
236 *num_bytes = *(uint64_t *)obj.data;
240 static int check_loop_return(int ret, int loop_ret, int loop_osl_errno)
244 assert(ret == -E_OSL);
245 if (osl_errno != E_OSL_LOOP)
246 /* error not caused by loop function returning negative. */
248 assert(loop_ret < 0);
249 if (loop_ret == -E_LOOP_COMPLETE) /* no error */
251 if (loop_ret == -E_OSL) { /* osl error in loop function */
252 assert(loop_osl_errno);
253 osl_errno = loop_osl_errno;
258 static int adu_loop_reverse(struct osl_table *t, unsigned col_num, void *private_data,
259 osl_rbtree_loop_func *func, int *loop_ret, int *loop_osl_errno)
261 int ret = osl(osl_rbtree_loop_reverse(t, col_num, private_data, func));
262 return check_loop_return(ret, *loop_ret, *loop_osl_errno);
265 static int global_summary_loop_function(struct osl_row *row, void *data)
267 struct global_summary_info *gsi = data;
271 ret = get_num_files_of_row(row, &num);
274 gsi->num_files += num;
276 ret = get_num_bytes_of_row(row, &num);
279 gsi->num_bytes += num;
284 gsi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
288 static int print_global_summary(struct format_info *fi)
292 struct global_summary_info gsi = {.num_dirs = 0};
294 union atom_value values[] = {
295 [gsa_dirs] = {.num_value = 0ULL},
296 [gsa_files] = {.num_value = 0ULL},
297 [gsa_size] = {.num_value = 0ULL}
300 ret = adu_loop_reverse(dir_table, DT_BYTES, &gsi,
301 global_summary_loop_function, &gsi.ret, &gsi.osl_errno);
304 values[gsa_dirs].num_value = (long long unsigned)gsi.num_dirs;
305 values[gsa_files].num_value = (long long unsigned)gsi.num_files;
306 values[gsa_size].num_value = (long long unsigned)gsi.num_bytes;
307 if (!select_conf.no_headers_given) {
308 ret = output("Global summary\n");
312 buf = format_items(fi, values);
313 ret = output("%s", buf);
318 static int user_summary_loop_function(struct osl_row *row, void *data)
320 struct user_summary_info *usi = data;
324 ret = get_num_user_files(row, usi->ui, &num);
327 usi->ui->files += num;
328 ret = get_num_user_bytes(row, usi->ui, &num);
331 usi->ui->bytes += num;
336 usi->osl_errno = (ret == -E_OSL)? osl_errno : 0;
340 static int compute_user_summary(struct user_info *ui, __a_unused void *data)
342 struct user_summary_info usi = {.ui = ui};
344 return adu_loop_reverse(ui->table, UT_BYTES, &usi, user_summary_loop_function,
345 &usi.ret, &usi.osl_errno);
348 static int print_user_summary_line(struct user_info *ui, void *data)
350 struct format_info *fi = data;
351 union atom_value values[] = {
352 [usa_pw_name] = {.string_value = ui->pw_name?
354 [usa_uid] = {.num_value = (long long unsigned)ui->uid},
355 [usa_dirs] = {.num_value = (long long unsigned)ui->dirs},
356 [usa_files] = {.num_value = (long long unsigned)ui->files},
357 [usa_size] = {.num_value = (long long unsigned)ui->bytes}
362 buf = format_items(fi, values);
363 ret = output("%s", buf);
368 static int name_comp(const void *a, const void *b)
370 char *x = ((struct user_info *)a)->pw_name;
371 char *y = ((struct user_info *)b)->pw_name;
380 static int uid_comp(const void *a, const void *b)
382 return -NUM_COMPARE(((struct user_info *)a)->uid,
383 ((struct user_info *)b)->uid);
386 static int dir_count_comp(const void *a, const void *b)
388 return NUM_COMPARE(((struct user_info *)a)->dirs,
389 ((struct user_info *)b)->dirs);
392 static int file_count_comp(const void *a, const void *b)
394 return NUM_COMPARE(((struct user_info *)a)->files,
395 ((struct user_info *)b)->files);
398 static int size_comp(const void *a, const void *b)
400 return NUM_COMPARE(((struct user_info *)a)->bytes,
401 ((struct user_info *)b)->bytes);
404 static int print_user_summary(struct format_info *fi)
407 * The comparators for sorting the user summary.
409 * This is an array of pointers to functions taking two constant void *
410 * pointers and returning an int.
412 static int (*summary_comparators[])(const void *, const void *) = {
413 [user_summary_sort_arg_name] = name_comp,
414 [user_summary_sort_arg_uid] = uid_comp,
415 [user_summary_sort_arg_dir_count] = dir_count_comp,
416 [user_summary_sort_arg_file_count] = file_count_comp,
417 [user_summary_sort_arg_size] = size_comp,
420 if (!select_conf.no_headers_given) {
421 int ret = output("User summary\n");
425 int ret = for_each_admissible_user(compute_user_summary, fi);
428 sort_hash_table(summary_comparators[select_conf.user_summary_sort_arg]);
429 return for_each_admissible_user(print_user_summary_line, fi);
432 static int user_list_loop_function(struct osl_row *row, void *data)
434 struct user_list_info *uli = data;
435 union atom_value values[] = {
436 [ula_pw_name] = {.string_value = uli->ui->pw_name?
437 uli->ui->pw_name : "?"},
438 [ula_uid] = {.num_value = (long long unsigned)uli->ui->uid},
439 [ula_files] = {.num_value = 0ULL},
440 [ula_size] = {.num_value = 0ULL},
441 [ula_dirname] = {.string_value = NULL}
448 ret = -E_LOOP_COMPLETE;
452 ret = get_num_user_files(row, uli->ui, &num);
455 values[ula_files].num_value = num;
457 ret = get_num_user_bytes(row, uli->ui, &num);
460 values[ula_size].num_value = num;
462 ret = get_dir_name_of_user_row(row, uli->ui, &dirname);
465 values[ula_dirname].string_value = dirname;
467 buf = format_items(uli->fi, values);
469 ret = output("%s", buf);
475 uli->osl_errno = (ret == -E_OSL)? osl_errno : 0;
479 static int print_user_list(struct user_info *ui, void *data)
481 struct format_info *fi = data;
483 enum user_table_columns sort_column = UT_BYTES;
484 struct user_list_info uli = {
487 .count = select_conf.limit_arg
490 if (select_conf.list_sort_arg == list_sort_arg_file_count)
491 sort_column = UT_FILES;
493 if (!select_conf.no_headers_given) {
494 ret = output("%s (uid %u)\n",
495 ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid);
499 return adu_loop_reverse(ui->table, sort_column, &uli, user_list_loop_function,
500 &uli.ret, &uli.osl_errno);
503 static int global_list_loop_function(struct osl_row *row, void *data)
505 struct global_list_info *gli = data;
506 union atom_value values[] = {
507 [gla_size] = {.num_value = 0ULL},
508 [gla_files] = {.num_value = 0ULL},
509 [gla_dirname] = {.string_value = NULL}
511 uint64_t num_files, num_bytes;
516 ret = -E_LOOP_COMPLETE;
520 ret = get_num_files_of_row(row, &num_files);
523 values[gla_files].num_value = (long long unsigned)num_files;
525 ret = get_num_bytes_of_row(row, &num_bytes);
528 values[gla_size].num_value = (long long unsigned)num_bytes;
530 ret = get_dir_name_of_row(row, &dirname);
533 values[gla_dirname].string_value = dirname;
535 buf = format_items(gli->fi, values);
537 ret = output("%s", buf);
544 gli->osl_errno = (ret == -E_OSL)? osl_errno : 0;
548 static int print_global_list(struct format_info *fi)
551 enum dir_table_columns sort_column = DT_BYTES;
552 struct global_list_info gli = {
554 .count = select_conf.limit_arg
557 if (!select_conf.no_headers_given) {
558 ret = output("Global list\n");
562 if (select_conf.list_sort_arg == list_sort_arg_file_count)
563 sort_column = DT_FILES;
564 return adu_loop_reverse(dir_table, sort_column, &gli,
565 global_list_loop_function, &gli.ret, &gli.osl_errno);
568 static int print_statistics(struct format_info *fi)
570 switch (select_conf.select_mode_arg) {
571 case select_mode_arg_global_list:
572 return print_global_list(fi);
573 case select_mode_arg_global_summary:
574 return print_global_summary(fi);
575 case select_mode_arg_user_list:
576 return for_each_admissible_user(print_user_list, fi);
577 case select_mode_arg_user_summary:
578 return print_user_summary(fi);
580 ERROR_LOG("bad select mode\n");
581 return ERRNO_TO_ERROR(-EINVAL);
584 static int read_uid_file(struct uid_range *admissible_uids)
588 char *filename = get_uid_list_name(), *map;
589 int ret = mmap_full_file(filename, O_RDONLY, (void **)&map, &size, NULL);
593 INFO_LOG("failed to map %s\n", filename);
598 INFO_LOG("found %u uids in %s\n", (unsigned)num_uids, filename);
601 * Compute number of hash table bits. The hash table size must be a
602 * power of two and larger than the number of uids.
605 while (1 << bits < num_uids)
607 create_hash_table(bits);
608 for (n = 0; n < num_uids; n++) {
609 uint32_t uid = read_u32(map + n * sizeof(uid));
610 ret = search_uid(uid, admissible_uids, OPEN_USER_TABLE, NULL);
615 adu_munmap(map, size);
619 int run_select_query(struct uid_range *admissible_uids, struct format_info *fi)
623 if (select_conf.output_given && strcmp(select_conf.output_arg, "-")) {
624 output_file = fopen(select_conf.output_arg, "w");
626 return -ERRNO_TO_ERROR(errno);
628 output_file = stdout;
630 ret = open_dir_table(0);
634 ret = read_uid_file(admissible_uids);
638 ret = print_statistics(fi);
641 if (output_file != stdout)
646 #define GLOBAL_LIST_DFLT_FMT "%(size:r:8) %(files:r:8) %(dirname)\n"
647 #define GLOBAL_SUMMARY_DFLT_FMT "#directories: %(dirs), #files: %(files), size: %(size)\n\n"
648 #define USER_LIST_DFLT_FMT "%(size:r:5) %(files:r:5) %(dirname)\n"
649 #define USER_SUMMARY_DFLT_FMT "%(pw_name:l:16) %(uid:r:5) %(dirs:r:5) %(files:r:5) %(size:r:5)\n"
651 /* return: < 0: error, >0: OK, == 0: help given */
652 int parse_select_options(char *string, struct select_cmdline_parser_params *params,
653 struct uid_range **admissible_uids, struct format_info **fi)
660 if (conf.select_options_given) {
664 ret = create_argv(string, &argv);
668 ret = select_cmdline_parser_ext(argc, argv, &select_conf, params);
672 if (select_conf.help_given || select_conf.detailed_help_given)
674 fmt = select_conf.format_arg;
677 ret = parse_uid_arg(select_conf.uid_arg, admissible_uids);
682 INFO_LOG("using default format string\n");
683 switch (select_conf.select_mode_arg) {
684 case select_mode_arg_global_list:
686 fmt = GLOBAL_LIST_DFLT_FMT;
687 atoms = global_list_atoms;
689 case select_mode_arg_global_summary:
691 fmt = GLOBAL_SUMMARY_DFLT_FMT;
692 atoms = global_summary_atoms;
694 case select_mode_arg_user_list:
696 fmt = USER_LIST_DFLT_FMT;
697 atoms = user_list_atoms;
699 case select_mode_arg_user_summary:
701 fmt = USER_SUMMARY_DFLT_FMT;
702 atoms = user_summary_atoms;
705 ERROR_LOG("bad select mode\n");
706 return -ERRNO_TO_ERROR(-EINVAL);
708 INFO_LOG("format string: %s\n", fmt);
709 return parse_format_string(fmt, atoms, fi);
711 line = select_conf.detailed_help_given?
712 select_args_info_detailed_help : select_args_info_help;
714 output_file = stdout;
715 for (; *line; line++) {
716 ret = output("%s\n", *line);
725 struct uid_range *admissible_uids = NULL;
727 struct format_info *fi;
728 struct select_cmdline_parser_params params = {
732 .check_ambiguity = 1,
736 select_cmdline_parser_init(&select_conf);
737 ret = parse_select_options(conf.select_options_arg, ¶ms,
738 &admissible_uids, &fi);
739 if (ret <= 0) /* do not run query if help was given */
741 ret = run_select_query(admissible_uids, fi);
742 free_format_info(fi);