1 // SPDX-License-Identifier: GPL-2.0
3 * User-space helper to sort the output of /sys/kernel/debug/page_owner
6 * cat /sys/kernel/debug/page_owner > page_owner_full.txt
7 * ./page_owner_sort page_owner_full.txt sorted_page_owner.txt
8 * Or sort by total memory:
9 * ./page_owner_sort -m page_owner_full.txt sorted_page_owner.txt
11 * See Documentation/mm/page_owner.rst
16 #include <sys/types.h>
23 #include <linux/types.h>
29 #define TASK_COMM_LEN 16
33 char *comm; // task command name
45 FILTER_UNRELEASE = 1<<1,
51 CULL_UNRELEASE = 1<<1,
55 CULL_STACKTRACE = 1<<5,
60 ALLOCATOR_SLAB = 1<<2,
61 ALLOCATOR_VMALLOC = 1<<3,
62 ALLOCATOR_OTHERS = 1<<4
65 ARG_TXT, ARG_COMM, ARG_STACKTRACE, ARG_ALLOC_TS, ARG_FREE_TS,
66 ARG_CULL_TIME, ARG_PAGE_NUM, ARG_PID, ARG_TGID, ARG_UNKNOWN, ARG_FREE,
73 struct filter_condition {
81 struct sort_condition {
82 int (**cmps)(const void *, const void *);
86 static struct filter_condition fc;
87 static struct sort_condition sc;
88 static regex_t order_pattern;
89 static regex_t pid_pattern;
90 static regex_t tgid_pattern;
91 static regex_t comm_pattern;
92 static regex_t ts_nsec_pattern;
93 static regex_t free_ts_nsec_pattern;
94 static struct block_list *list;
101 static void set_single_cmp(int (*cmp)(const void *, const void *), int sign);
103 int read_block(char *buf, char *ext_buf, int buf_size, FILE *fin)
105 char *curr = buf, *const buf_end = buf + buf_size;
107 while (buf_end - curr > 1 && fgets(curr, buf_end - curr, fin)) {
108 if (*curr == '\n') { /* empty line */
111 if (!strncmp(curr, "PFN", 3)) {
112 strcpy(ext_buf, curr);
115 curr += strlen(curr);
118 return -1; /* EOF or no space left in buf. */
121 static int compare_txt(const void *p1, const void *p2)
123 const struct block_list *l1 = p1, *l2 = p2;
125 return strcmp(l1->txt, l2->txt);
128 static int compare_stacktrace(const void *p1, const void *p2)
130 const struct block_list *l1 = p1, *l2 = p2;
132 return strcmp(l1->stacktrace, l2->stacktrace);
135 static int compare_num(const void *p1, const void *p2)
137 const struct block_list *l1 = p1, *l2 = p2;
139 return l1->num - l2->num;
142 static int compare_page_num(const void *p1, const void *p2)
144 const struct block_list *l1 = p1, *l2 = p2;
146 return l1->page_num - l2->page_num;
149 static int compare_pid(const void *p1, const void *p2)
151 const struct block_list *l1 = p1, *l2 = p2;
153 return l1->pid - l2->pid;
156 static int compare_tgid(const void *p1, const void *p2)
158 const struct block_list *l1 = p1, *l2 = p2;
160 return l1->tgid - l2->tgid;
163 static int compare_allocator(const void *p1, const void *p2)
165 const struct block_list *l1 = p1, *l2 = p2;
167 return l1->allocator - l2->allocator;
170 static int compare_comm(const void *p1, const void *p2)
172 const struct block_list *l1 = p1, *l2 = p2;
174 return strcmp(l1->comm, l2->comm);
177 static int compare_ts(const void *p1, const void *p2)
179 const struct block_list *l1 = p1, *l2 = p2;
181 return l1->ts_nsec < l2->ts_nsec ? -1 : 1;
184 static int compare_free_ts(const void *p1, const void *p2)
186 const struct block_list *l1 = p1, *l2 = p2;
188 return l1->free_ts_nsec < l2->free_ts_nsec ? -1 : 1;
191 static int compare_release(const void *p1, const void *p2)
193 const struct block_list *l1 = p1, *l2 = p2;
195 if (!l1->free_ts_nsec && !l2->free_ts_nsec)
197 if (l1->free_ts_nsec && l2->free_ts_nsec)
199 return l1->free_ts_nsec ? 1 : -1;
202 static int compare_cull_condition(const void *p1, const void *p2)
205 return compare_txt(p1, p2);
206 if ((cull & CULL_STACKTRACE) && compare_stacktrace(p1, p2))
207 return compare_stacktrace(p1, p2);
208 if ((cull & CULL_PID) && compare_pid(p1, p2))
209 return compare_pid(p1, p2);
210 if ((cull & CULL_TGID) && compare_tgid(p1, p2))
211 return compare_tgid(p1, p2);
212 if ((cull & CULL_COMM) && compare_comm(p1, p2))
213 return compare_comm(p1, p2);
214 if ((cull & CULL_UNRELEASE) && compare_release(p1, p2))
215 return compare_release(p1, p2);
216 if ((cull & CULL_ALLOCATOR) && compare_allocator(p1, p2))
217 return compare_allocator(p1, p2);
221 static int compare_sort_condition(const void *p1, const void *p2)
225 for (int i = 0; i < sc.size; ++i)
227 cmp = sc.signs[i] * sc.cmps[i](p1, p2);
231 static int search_pattern(regex_t *pattern, char *pattern_str, char *buf)
234 regmatch_t pmatch[2];
236 err = regexec(pattern, buf, 2, pmatch, REG_NOTBOL);
237 if (err != 0 || pmatch[1].rm_so == -1) {
239 fprintf(stderr, "no matching pattern in %s\n", buf);
242 val_len = pmatch[1].rm_eo - pmatch[1].rm_so;
244 memcpy(pattern_str, buf + pmatch[1].rm_so, val_len);
249 static void check_regcomp(regex_t *pattern, const char *regex)
253 err = regcomp(pattern, regex, REG_EXTENDED | REG_NEWLINE);
254 if (err != 0 || pattern->re_nsub != 1) {
255 fprintf(stderr, "Invalid pattern %s code %d\n", regex, err);
260 static char **explode(char sep, const char *str, int *size)
262 int count = 0, len = strlen(str);
263 int lastindex = -1, j = 0;
265 for (int i = 0; i < len; i++)
268 char **ret = calloc(++count, sizeof(char *));
270 for (int i = 0; i < len; i++) {
272 ret[j] = calloc(i - lastindex, sizeof(char));
273 memcpy(ret[j++], str + lastindex + 1, i - lastindex - 1);
277 if (lastindex <= len - 1) {
278 ret[j] = calloc(len - lastindex, sizeof(char));
279 memcpy(ret[j++], str + lastindex + 1, strlen(str) - 1 - lastindex);
285 static void free_explode(char **arr, int size)
287 for (int i = 0; i < size; i++)
292 # define FIELD_BUFF 25
294 static int get_page_num(char *buf)
297 char order_str[FIELD_BUFF] = {0};
300 search_pattern(&order_pattern, order_str, buf);
302 order_val = strtol(order_str, &endptr, 10);
303 if (order_val > 64 || errno != 0 || endptr == order_str || *endptr != '\0') {
305 fprintf(stderr, "wrong order in follow buf:\n%s\n", buf);
309 return 1 << order_val;
312 static pid_t get_pid(char *buf)
315 char pid_str[FIELD_BUFF] = {0};
318 search_pattern(&pid_pattern, pid_str, buf);
320 pid = strtol(pid_str, &endptr, 10);
321 if (errno != 0 || endptr == pid_str || *endptr != '\0') {
323 fprintf(stderr, "wrong/invalid pid in follow buf:\n%s\n", buf);
331 static pid_t get_tgid(char *buf)
334 char tgid_str[FIELD_BUFF] = {0};
337 search_pattern(&tgid_pattern, tgid_str, buf);
339 tgid = strtol(tgid_str, &endptr, 10);
340 if (errno != 0 || endptr == tgid_str || *endptr != '\0') {
342 fprintf(stderr, "wrong/invalid tgid in follow buf:\n%s\n", buf);
350 static __u64 get_ts_nsec(char *buf)
353 char ts_nsec_str[FIELD_BUFF] = {0};
356 search_pattern(&ts_nsec_pattern, ts_nsec_str, buf);
358 ts_nsec = strtoull(ts_nsec_str, &endptr, 10);
359 if (errno != 0 || endptr == ts_nsec_str || *endptr != '\0') {
361 fprintf(stderr, "wrong ts_nsec in follow buf:\n%s\n", buf);
368 static __u64 get_free_ts_nsec(char *buf)
371 char free_ts_nsec_str[FIELD_BUFF] = {0};
374 search_pattern(&free_ts_nsec_pattern, free_ts_nsec_str, buf);
376 free_ts_nsec = strtoull(free_ts_nsec_str, &endptr, 10);
377 if (errno != 0 || endptr == free_ts_nsec_str || *endptr != '\0') {
379 fprintf(stderr, "wrong free_ts_nsec in follow buf:\n%s\n", buf);
386 static char *get_comm(char *buf)
388 char *comm_str = malloc(TASK_COMM_LEN);
390 memset(comm_str, 0, TASK_COMM_LEN);
392 search_pattern(&comm_pattern, comm_str, buf);
396 fprintf(stderr, "wrong comm in follow buf:\n%s\n", buf);
403 static int get_arg_type(const char *arg)
405 if (!strcmp(arg, "pid") || !strcmp(arg, "p"))
407 else if (!strcmp(arg, "tgid") || !strcmp(arg, "tg"))
409 else if (!strcmp(arg, "name") || !strcmp(arg, "n"))
411 else if (!strcmp(arg, "stacktrace") || !strcmp(arg, "st"))
412 return ARG_STACKTRACE;
413 else if (!strcmp(arg, "free") || !strcmp(arg, "f"))
415 else if (!strcmp(arg, "txt") || !strcmp(arg, "T"))
417 else if (!strcmp(arg, "free_ts") || !strcmp(arg, "ft"))
419 else if (!strcmp(arg, "alloc_ts") || !strcmp(arg, "at"))
421 else if (!strcmp(arg, "allocator") || !strcmp(arg, "ator"))
422 return ARG_ALLOCATOR;
428 static int get_allocator(const char *buf, const char *migrate_info)
430 char *tmp, *first_line, *second_line;
433 if (strstr(migrate_info, "CMA"))
434 allocator |= ALLOCATOR_CMA;
435 if (strstr(migrate_info, "slab"))
436 allocator |= ALLOCATOR_SLAB;
437 tmp = strstr(buf, "__vmalloc_node_range");
446 tmp = strstr(tmp, "alloc_pages");
447 if (tmp && first_line <= tmp && tmp < second_line)
448 allocator |= ALLOCATOR_VMALLOC;
451 allocator = ALLOCATOR_OTHERS;
455 static bool match_num_list(int num, int *list, int list_size)
457 for (int i = 0; i < list_size; ++i)
463 static bool match_str_list(const char *str, char **list, int list_size)
465 for (int i = 0; i < list_size; ++i)
466 if (!strcmp(list[i], str))
471 static bool is_need(char *buf)
473 if ((filter & FILTER_UNRELEASE) && get_free_ts_nsec(buf) != 0)
475 if ((filter & FILTER_PID) && !match_num_list(get_pid(buf), fc.pids, fc.pids_size))
477 if ((filter & FILTER_TGID) &&
478 !match_num_list(get_tgid(buf), fc.tgids, fc.tgids_size))
481 char *comm = get_comm(buf);
483 if ((filter & FILTER_COMM) &&
484 !match_str_list(comm, fc.comms, fc.comms_size)) {
492 static void add_list(char *buf, int len, char *ext_buf)
494 if (list_size != 0 &&
495 len == list[list_size-1].len &&
496 memcmp(buf, list[list_size-1].txt, len) == 0) {
497 list[list_size-1].num++;
498 list[list_size-1].page_num += get_page_num(buf);
501 if (list_size == max_size) {
502 fprintf(stderr, "max_size too small??\n");
507 list[list_size].pid = get_pid(buf);
508 list[list_size].tgid = get_tgid(buf);
509 list[list_size].comm = get_comm(buf);
510 list[list_size].txt = malloc(len+1);
511 if (!list[list_size].txt) {
512 fprintf(stderr, "Out of memory\n");
515 memcpy(list[list_size].txt, buf, len);
516 list[list_size].txt[len] = 0;
517 list[list_size].len = len;
518 list[list_size].num = 1;
519 list[list_size].page_num = get_page_num(buf);
521 list[list_size].stacktrace = strchr(list[list_size].txt, '\n') ?: "";
522 if (*list[list_size].stacktrace == '\n')
523 list[list_size].stacktrace++;
524 list[list_size].ts_nsec = get_ts_nsec(buf);
525 list[list_size].free_ts_nsec = get_free_ts_nsec(buf);
526 list[list_size].allocator = get_allocator(buf, ext_buf);
528 if (list_size % 1000 == 0) {
529 printf("loaded %d\r", list_size);
534 static bool parse_cull_args(const char *arg_str)
537 char **args = explode(',', arg_str, &size);
539 for (int i = 0; i < size; ++i) {
540 int arg_type = get_arg_type(args[i]);
542 if (arg_type == ARG_PID)
544 else if (arg_type == ARG_TGID)
546 else if (arg_type == ARG_COMM)
548 else if (arg_type == ARG_STACKTRACE)
549 cull |= CULL_STACKTRACE;
550 else if (arg_type == ARG_FREE)
551 cull |= CULL_UNRELEASE;
552 else if (arg_type == ARG_ALLOCATOR)
553 cull |= CULL_ALLOCATOR;
555 free_explode(args, size);
559 free_explode(args, size);
561 set_single_cmp(compare_num, SORT_DESC);
565 static void set_single_cmp(int (*cmp)(const void *, const void *), int sign)
567 if (sc.signs == NULL || sc.size < 1)
568 sc.signs = calloc(1, sizeof(int));
570 if (sc.cmps == NULL || sc.size < 1)
571 sc.cmps = calloc(1, sizeof(int *));
576 static bool parse_sort_args(const char *arg_str)
580 if (sc.size != 0) { /* reset sort_condition */
586 char **args = explode(',', arg_str, &size);
588 sc.signs = calloc(size, sizeof(int));
589 sc.cmps = calloc(size, sizeof(int *));
590 for (int i = 0; i < size; ++i) {
593 sc.signs[i] = SORT_ASC;
594 if (args[i][0] == '-' || args[i][0] == '+') {
595 if (args[i][0] == '-')
596 sc.signs[i] = SORT_DESC;
600 int arg_type = get_arg_type(args[i]+offset);
602 if (arg_type == ARG_PID)
603 sc.cmps[i] = compare_pid;
604 else if (arg_type == ARG_TGID)
605 sc.cmps[i] = compare_tgid;
606 else if (arg_type == ARG_COMM)
607 sc.cmps[i] = compare_comm;
608 else if (arg_type == ARG_STACKTRACE)
609 sc.cmps[i] = compare_stacktrace;
610 else if (arg_type == ARG_ALLOC_TS)
611 sc.cmps[i] = compare_ts;
612 else if (arg_type == ARG_FREE_TS)
613 sc.cmps[i] = compare_free_ts;
614 else if (arg_type == ARG_TXT)
615 sc.cmps[i] = compare_txt;
616 else if (arg_type == ARG_ALLOCATOR)
617 sc.cmps[i] = compare_allocator;
619 free_explode(args, size);
625 free_explode(args, size);
629 static int *parse_nums_list(char *arg_str, int *list_size)
632 char **args = explode(',', arg_str, &size);
633 int *list = calloc(size, sizeof(int));
636 for (int i = 0; i < size; ++i) {
639 list[i] = strtol(args[i], &endptr, 10);
640 if (errno != 0 || endptr == args[i] || *endptr != '\0') {
646 free_explode(args, size);
650 static void print_allocator(FILE *out, int allocator)
652 fprintf(out, "allocated by ");
653 if (allocator & ALLOCATOR_CMA)
654 fprintf(out, "CMA ");
655 if (allocator & ALLOCATOR_SLAB)
656 fprintf(out, "SLAB ");
657 if (allocator & ALLOCATOR_VMALLOC)
658 fprintf(out, "VMALLOC ");
659 if (allocator & ALLOCATOR_OTHERS)
660 fprintf(out, "OTHERS ");
663 #define BUF_SIZE (128 * 1024)
665 static void usage(void)
667 printf("Usage: ./page_owner_sort [OPTIONS] <input> <output>\n"
668 "-m\t\tSort by total memory.\n"
669 "-s\t\tSort by the stack trace.\n"
670 "-t\t\tSort by times (default).\n"
671 "-p\t\tSort by pid.\n"
672 "-P\t\tSort by tgid.\n"
673 "-n\t\tSort by task command name.\n"
674 "-a\t\tSort by memory allocate time.\n"
675 "-r\t\tSort by memory release time.\n"
676 "-f\t\tFilter out the information of blocks whose memory has been released.\n"
677 "-d\t\tPrint debug information.\n"
678 "--pid <pidlist>\tSelect by pid. This selects the information of blocks whose process ID numbers appear in <pidlist>.\n"
679 "--tgid <tgidlist>\tSelect by tgid. This selects the information of blocks whose Thread Group ID numbers appear in <tgidlist>.\n"
680 "--name <cmdlist>\n\t\tSelect by command name. This selects the information of blocks whose command name appears in <cmdlist>.\n"
681 "--cull <rules>\tCull by user-defined rules.<rules> is a single argument in the form of a comma-separated list with some common fields predefined\n"
682 "--sort <order>\tSpecify sort order as: [+|-]key[,[+|-]key[,...]]\n"
686 int main(int argc, char **argv)
693 struct option longopts[] = {
694 { "pid", required_argument, NULL, 1 },
695 { "tgid", required_argument, NULL, 2 },
696 { "name", required_argument, NULL, 3 },
697 { "cull", required_argument, NULL, 4 },
698 { "sort", required_argument, NULL, 5 },
702 while ((opt = getopt_long(argc, argv, "adfmnprstP", longopts, NULL)) != -1)
705 set_single_cmp(compare_ts, SORT_ASC);
711 filter = filter | FILTER_UNRELEASE;
714 set_single_cmp(compare_page_num, SORT_DESC);
717 set_single_cmp(compare_pid, SORT_ASC);
720 set_single_cmp(compare_free_ts, SORT_ASC);
723 set_single_cmp(compare_stacktrace, SORT_ASC);
726 set_single_cmp(compare_num, SORT_DESC);
729 set_single_cmp(compare_tgid, SORT_ASC);
732 set_single_cmp(compare_comm, SORT_ASC);
735 filter = filter | FILTER_PID;
736 fc.pids = parse_nums_list(optarg, &fc.pids_size);
737 if (fc.pids == NULL) {
738 fprintf(stderr, "wrong/invalid pid in from the command line:%s\n",
744 filter = filter | FILTER_TGID;
745 fc.tgids = parse_nums_list(optarg, &fc.tgids_size);
746 if (fc.tgids == NULL) {
747 fprintf(stderr, "wrong/invalid tgid in from the command line:%s\n",
753 filter = filter | FILTER_COMM;
754 fc.comms = explode(',', optarg, &fc.comms_size);
757 if (!parse_cull_args(optarg)) {
758 fprintf(stderr, "wrong argument after --cull option:%s\n",
764 if (!parse_sort_args(optarg)) {
765 fprintf(stderr, "wrong argument after --sort option:%s\n",
775 if (optind >= (argc - 1)) {
780 fin = fopen(argv[optind], "r");
781 fout = fopen(argv[optind + 1], "w");
788 check_regcomp(&order_pattern, "order\\s*([0-9]*),");
789 check_regcomp(&pid_pattern, "pid\\s*([0-9]*),");
790 check_regcomp(&tgid_pattern, "tgid\\s*([0-9]*) ");
791 check_regcomp(&comm_pattern, "tgid\\s*[0-9]*\\s*\\((.*)\\),\\s*ts");
792 check_regcomp(&ts_nsec_pattern, "ts\\s*([0-9]*)\\s*ns,");
793 check_regcomp(&free_ts_nsec_pattern, "free_ts\\s*([0-9]*)\\s*ns");
794 fstat(fileno(fin), &st);
795 max_size = st.st_size / 100; /* hack ... */
797 list = malloc(max_size * sizeof(*list));
798 buf = malloc(BUF_SIZE);
799 ext_buf = malloc(BUF_SIZE);
800 if (!list || !buf || !ext_buf) {
801 fprintf(stderr, "Out of memory\n");
806 int buf_len = read_block(buf, ext_buf, BUF_SIZE, fin);
810 add_list(buf, buf_len, ext_buf);
813 printf("loaded %d\n", list_size);
815 printf("sorting ....\n");
817 qsort(list, list_size, sizeof(list[0]), compare_cull_condition);
821 for (i = count = 0; i < list_size; i++) {
823 compare_cull_condition((void *)(&list[count-1]), (void *)(&list[i])) != 0) {
824 list[count++] = list[i];
826 list[count-1].num += list[i].num;
827 list[count-1].page_num += list[i].page_num;
831 qsort(list, count, sizeof(list[0]), compare_sort_condition);
833 for (i = 0; i < count; i++) {
835 fprintf(fout, "%d times, %d pages, ", list[i].num, list[i].page_num);
836 print_allocator(fout, list[i].allocator);
837 fprintf(fout, ":\n%s\n", list[i].txt);
840 fprintf(fout, "%d times, %d pages",
841 list[i].num, list[i].page_num);
842 if (cull & CULL_PID || filter & FILTER_PID)
843 fprintf(fout, ", PID %d", list[i].pid);
844 if (cull & CULL_TGID || filter & FILTER_TGID)
845 fprintf(fout, ", TGID %d", list[i].pid);
846 if (cull & CULL_COMM || filter & FILTER_COMM)
847 fprintf(fout, ", task_comm_name: %s", list[i].comm);
848 if (cull & CULL_ALLOCATOR) {
850 print_allocator(fout, list[i].allocator);
852 if (cull & CULL_UNRELEASE)
853 fprintf(fout, " (%s)",
854 list[i].free_ts_nsec ? "UNRELEASED" : "RELEASED");
855 if (cull & CULL_STACKTRACE)
856 fprintf(fout, ":\n%s", list[i].stacktrace);
860 regfree(&order_pattern);
861 regfree(&pid_pattern);
862 regfree(&tgid_pattern);
863 regfree(&comm_pattern);
864 regfree(&ts_nsec_pattern);
865 regfree(&free_ts_nsec_pattern);