From e893fd33603e36231edd7729062f88ab9b132619 Mon Sep 17 00:00:00 2001
From: Kuan-Ying Lee <kuan-ying.lee@canonical.com>
Date: Fri, 19 Jul 2024 14:21:10 +0800
Subject: [PATCH] contrib/vmallocinfo: add scripts to dump vmallocinfo

Sample output:

python3 drgn -s vmlinux -c vmcore contrib/vmallocinfo.py

0xffff800080000000-0xffff800080005000      20480 start_kernel pages=4 vmalloc
0xffff800080005000-0xffff800080007000       8192 ioremap_prot phys=0x8020000 ioremap
0xffff800080008000-0xffff80008000d000      20480 start_kernel pages=4 vmalloc
0xffff80008000d000-0xffff80008000f000       8192 bpf_prog_alloc_no_stats pages=1 vmalloc
0xffff800082a00000-0xffff8000833d1000   10293248 paging_init phys=0x42c00000 vmap
0xffff800083400000-0xffff800083405000      20480 start_kernel pages=4 vmalloc
0xffff800083405000-0xffff800083408000      12288 pcpu_mem_zalloc pages=2 vmalloc
0xffff800083408000-0xffff80008340d000      20480 kernel_clone pages=4 vmalloc
0xffff80008340d000-0xffff80008340f000       8192 ioremap_prot phys=0x9030000 ioremap
0xffff800083480000-0xffff800083485000      20480 kernel_clone pages=4 vmalloc
0xffff800083488000-0xffff80008348d000      20480 kernel_clone pages=4 vmalloc
0xffff800083500000-0xffff800083505000      20480 fork_idle pages=4 vmalloc
...

Signed-off-by: Kuan-Ying Lee <kuan-ying.lee@canonical.com>
---
 contrib/vmallocinfo.py | 76 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 76 insertions(+)
 create mode 100755 contrib/vmallocinfo.py

diff --git a/contrib/vmallocinfo.py b/contrib/vmallocinfo.py
new file mode 100755
index 000000000..f9552ca46
--- /dev/null
+++ b/contrib/vmallocinfo.py
@@ -0,0 +1,76 @@
+#!/usr/bin/env drgn
+# Copyright (c) Canonical Ltd.
+# SPDX-License-Identifier: LGPL-2.1-or-later
+
+""" Script to dump vmallocinfo status using drgn"""
+
+import re
+from typing import Optional
+
+from drgn import IntegerLike, Program
+from drgn.helpers.linux.mm import for_each_vmap_area
+
+VMAP_RAM = 0x1  # indicates vm_map_ram area
+
+VM_IOREMAP = 0x00000001  # ioremap() and friends
+VM_ALLOC = 0x00000002  # vmalloc()
+VM_MAP = 0x00000004  # vmap()ed pages
+VM_USERMAP = 0x00000008  # suitable for remap_vmalloc_range
+VM_DMA_COHERENT = 0x00000010  # dma_alloc_coherent
+VM_SPARSE = 0x00001000  # sparse vm_area. not all pages are present.
+
+
+def is_vmalloc_addr(prog: Program, addr: IntegerLike) -> Optional[bool]:
+    vmcoreinfo = prog["VMCOREINFO"].string_()
+    match = re.search(
+        rb"^NUMBER\(VMALLOC_START\)=(0x[0-9a-f]+)$", vmcoreinfo, flags=re.M
+    )
+    if match:
+        VMALLOC_START = int(match.group(1), 16)
+
+    match = re.search(rb"^NUMBER\(VMALLOC_END\)=(0x[0-9a-f]+)$", vmcoreinfo, flags=re.M)
+    if match:
+        VMALLOC_END = int(match.group(1), 16)
+
+    try:
+        return True if addr >= VMALLOC_START and addr < VMALLOC_END else False
+    except:
+        return None
+
+
+for vmap_area in for_each_vmap_area(prog):
+    if not vmap_area.vm:
+        if vmap_area.flags & VMAP_RAM:
+            print(
+                f"0x{vmap_area.va_start:x}-0x{vmap_area.va_end:x} {vmap_area.va_end - vmap_area.va_start:10d} vm_map_ram"
+            )
+            continue
+    v = vmap_area.vm
+    print(
+        f"0x{v.addr.value_():x}-0x{(v.addr+v.size).value_():x} {v.size.value_():10d}",
+        end="",
+    )
+    if v.caller:
+        try:
+            print(f" {prog.symbol(v.caller.value_()).name}", end="")
+        except LookupError:
+            print(f" 0x{v.caller.value_():x}", end="")
+    if v.nr_pages:
+        print(f" pages={v.nr_pages.value_():d}", end="")
+    if v.phys_addr:
+        print(f" phys=0x{v.phys_addr.value_():x}", end="")
+    if v.flags & VM_IOREMAP:
+        print(" ioremap", end="")
+    if v.flags & VM_SPARSE:
+        print(" sparse", end="")
+    if v.flags & VM_ALLOC:
+        print(" vmalloc", end="")
+    if v.flags & VM_MAP:
+        print(" vmap", end="")
+    if v.flags & VM_USERMAP:
+        print(" user", end="")
+    if v.flags & VM_DMA_COHERENT:
+        print(" dma-coherent", end="")
+    if is_vmalloc_addr(prog, v.pages):
+        print(" vpages", end="")
+    print("")