| /* |
| * Copyright (C) 2019 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| #include <getopt.h> |
| #include <inttypes.h> |
| #include <signal.h> |
| #include <stdio.h> |
| #include <stdlib.h> |
| #include <sys/mman.h> |
| #include <sys/types.h> |
| #include <unistd.h> |
| |
| #include <iomanip> |
| #include <iostream> |
| #include <map> |
| #include <memory> |
| #include <string> |
| #include <vector> |
| |
| #include <android-base/stringprintf.h> |
| #include <android-base/strings.h> |
| #include <meminfo/procmeminfo.h> |
| |
| using ::android::base::StringPrintf; |
| using ::android::meminfo::EscapeCsvString; |
| using ::android::meminfo::EscapeJsonString; |
| using ::android::meminfo::Format; |
| using ::android::meminfo::GetFormat; |
| using ::android::meminfo::MemUsage; |
| using ::android::meminfo::Vma; |
| |
| // Global options |
| static std::string g_filename; |
| static bool g_terse = false; |
| static bool g_verbose = false; |
| static bool g_show_addr = false; |
| static bool g_quiet = false; |
| static pid_t g_pid = -1; |
| |
| static std::string get_vma_name(const Vma& vma, bool total, bool is_bss) { |
| if (total) { |
| return "TOTAL"; |
| } |
| std::string vma_name = vma.name; |
| if (is_bss) { |
| vma_name.append(" [bss]"); |
| } |
| return vma_name; |
| } |
| |
| static std::string get_flags(const Vma& vma, bool total) { |
| std::string flags_str("---"); |
| if (g_verbose && !total) { |
| if (vma.flags & PROT_READ) flags_str[0] = 'r'; |
| if (vma.flags & PROT_WRITE) flags_str[1] = 'w'; |
| if (vma.flags & PROT_EXEC) flags_str[2] = 'x'; |
| } |
| return flags_str; |
| } |
| |
| struct VmaInfo { |
| Vma vma; |
| bool is_bss; |
| uint32_t count; |
| |
| VmaInfo() = default; |
| VmaInfo(const Vma& v) : vma(v), is_bss(false), count(1) {} |
| VmaInfo(const Vma& v, bool bss) : vma(v), is_bss(bss), count(1) {} |
| VmaInfo(const Vma& v, const std::string& name, bool bss) : vma(v), is_bss(bss), count(1) { |
| vma.name = name; |
| } |
| |
| void to_raw(std::ostream&, bool) const; |
| void to_csv(std::ostream&, bool) const; |
| void to_json(std::ostream&, bool) const; |
| }; |
| |
| void VmaInfo::to_raw(std::ostream& output, bool total) const { |
| if (g_show_addr) { |
| if (total) { |
| output << " "; |
| } else { |
| output << std::hex << std::setw(16) << vma.start << " " << std::setw(16) << vma.end |
| << " " << std::dec; |
| } |
| } |
| // clang-format off |
| output << std::setw(8) << vma.usage.vss << " " |
| << std::setw(8) << vma.usage.rss << " " |
| << std::setw(8) << vma.usage.pss << " " |
| << std::setw(8) << vma.usage.shared_clean << " " |
| << std::setw(8) << vma.usage.shared_dirty << " " |
| << std::setw(8) << vma.usage.private_clean << " " |
| << std::setw(8) << vma.usage.private_dirty << " " |
| << std::setw(8) << vma.usage.swap << " " |
| << std::setw(8) << vma.usage.swap_pss << " " |
| << std::setw(9) << vma.usage.anon_huge_pages << " " |
| << std::setw(9) << vma.usage.shmem_pmd_mapped << " " |
| << std::setw(9) << vma.usage.file_pmd_mapped << " " |
| << std::setw(8) << vma.usage.shared_hugetlb << " " |
| << std::setw(8) << vma.usage.private_hugetlb << " " |
| << std::setw(8) << vma.usage.locked << " "; |
| // clang-format on |
| if (!g_verbose && !g_show_addr) { |
| output << std::setw(4) << count << " "; |
| } |
| if (g_verbose) { |
| if (total) { |
| output << " "; |
| } else { |
| output << std::setw(5) << get_flags(vma, total) << " "; |
| } |
| } |
| output << get_vma_name(vma, total, is_bss) << "\n"; |
| } |
| |
| void VmaInfo::to_csv(std::ostream& output, bool total) const { |
| // clang-format off |
| output << vma.usage.vss |
| << "," << vma.usage.rss |
| << "," << vma.usage.pss |
| << "," << vma.usage.shared_clean |
| << "," << vma.usage.shared_dirty |
| << "," << vma.usage.private_clean |
| << "," << vma.usage.private_dirty |
| << "," << vma.usage.swap |
| << "," << vma.usage.swap_pss |
| << "," << vma.usage.anon_huge_pages |
| << "," << vma.usage.shmem_pmd_mapped |
| << "," << vma.usage.file_pmd_mapped |
| << "," << vma.usage.shared_hugetlb |
| << "," << vma.usage.private_hugetlb |
| << "," << vma.usage.locked; |
| // clang-format on |
| if (g_show_addr) { |
| output << ","; |
| if (total) { |
| output << ","; |
| } else { |
| output << std::hex << vma.start << "," << vma.end << std::dec; |
| } |
| } |
| if (!g_verbose && !g_show_addr) { |
| output << "," << count; |
| } |
| if (g_verbose) { |
| output << ","; |
| if (!total) { |
| output << EscapeCsvString(get_flags(vma, total)); |
| } |
| } |
| output << "," << EscapeCsvString(get_vma_name(vma, total, is_bss)) << "\n"; |
| } |
| |
| void VmaInfo::to_json(std::ostream& output, bool total) const { |
| // clang-format off |
| output << "{\"virtual size\":" << vma.usage.vss |
| << ",\"RSS\":" << vma.usage.rss |
| << ",\"PSS\":" << vma.usage.pss |
| << ",\"shared clean\":" << vma.usage.shared_clean |
| << ",\"shared dirty\":" << vma.usage.shared_dirty |
| << ",\"private clean\":" << vma.usage.private_clean |
| << ",\"private dirty\":" << vma.usage.private_dirty |
| << ",\"swap\":" << vma.usage.swap |
| << ",\"swapPSS\":" << vma.usage.swap_pss |
| << ",\"Anon HugePages\":" << vma.usage.anon_huge_pages |
| << ",\"Shmem PmdMapped\":" << vma.usage.shmem_pmd_mapped |
| << ",\"File PmdMapped\":" << vma.usage.file_pmd_mapped |
| << ",\"Shared Hugetlb\":" << vma.usage.shared_hugetlb |
| << ",\"Private Hugetlb\":" << vma.usage.private_hugetlb |
| << ",\"Locked\":" << vma.usage.locked; |
| // clang-format on |
| if (g_show_addr) { |
| if (total) { |
| output << ",\"start addr\":\"\",\"end addr\":\"\""; |
| } else { |
| output << ",\"start addr\":\"" << std::hex << vma.start << "\",\"end addr\":\"" |
| << vma.end << "\"" << std::dec; |
| } |
| } |
| if (!g_verbose && !g_show_addr) { |
| output << ",\"#\":" << count; |
| } |
| if (g_verbose) { |
| output << ",\"flags\":" << EscapeJsonString(get_flags(vma, total)); |
| } |
| output << ",\"object\":" << EscapeJsonString(get_vma_name(vma, total, is_bss)) << "}"; |
| } |
| |
| static std::multimap<std::string, VmaInfo> g_vmas; |
| |
| [[noreturn]] static void usage(int exit_status) { |
| std::cerr << "showmap [-aqtv] [-f FILE] PID\n" |
| << "-a\taddresses (show virtual memory map)\n" |
| << "-q\tquiet (don't show error if map could not be read)\n" |
| << "-t\tterse (show only items with private pages)\n" |
| << "-v\tverbose (don't coalesce maps with the same name)\n" |
| << "-f\tFILE (read from input from FILE instead of PID)\n" |
| << "-o\t[raw][json][csv] Print output in the specified format.\n" |
| << " \tDefault output format is raw text.)\n"; |
| |
| exit(exit_status); |
| } |
| |
| static bool is_library(const std::string& name) { |
| return (name.size() > 4) && (name[0] == '/') && ::android::base::EndsWith(name, ".so"); |
| } |
| |
| static void infer_vma_name(VmaInfo& current, const VmaInfo& recent) { |
| if (current.vma.name.empty()) { |
| if (recent.vma.end == current.vma.start && is_library(recent.vma.name)) { |
| current.vma.name = recent.vma.name; |
| current.is_bss = true; |
| } else { |
| current.vma.name = "[anon]"; |
| } |
| } |
| } |
| |
| static void add_mem_usage(MemUsage* to, const MemUsage& from) { |
| to->vss += from.vss; |
| to->rss += from.rss; |
| to->pss += from.pss; |
| |
| to->swap += from.swap; |
| to->swap_pss += from.swap_pss; |
| |
| to->private_clean += from.private_clean; |
| to->private_dirty += from.private_dirty; |
| to->shared_clean += from.shared_clean; |
| to->shared_dirty += from.shared_dirty; |
| |
| to->anon_huge_pages += from.anon_huge_pages; |
| to->shmem_pmd_mapped += from.shmem_pmd_mapped; |
| to->file_pmd_mapped += from.file_pmd_mapped; |
| to->shared_hugetlb += from.shared_hugetlb; |
| to->private_hugetlb += from.private_hugetlb; |
| } |
| |
| static void collect_vma(const Vma& vma) { |
| static VmaInfo recent; |
| VmaInfo current(vma); |
| |
| std::string key; |
| if (g_show_addr) { |
| // vma.end is included in case vma.start is identical for two VMAs. |
| key = StringPrintf("%16" PRIx64 "%16" PRIx64, vma.start, vma.end); |
| } else { |
| key = vma.name; |
| } |
| |
| if (g_vmas.empty()) { |
| g_vmas.emplace(key, current); |
| recent = current; |
| return; |
| } |
| |
| infer_vma_name(current, recent); |
| recent = current; |
| |
| // If sorting by address, the VMA can be placed into the map as-is. |
| if (g_show_addr) { |
| g_vmas.emplace(key, current); |
| return; |
| } |
| |
| // infer_vma_name() may have changed current.vma.name, so this key needs to be set again before |
| // using it to sort by name. For verbose output, the VMA can immediately be placed into the map. |
| key = current.vma.name; |
| if (g_verbose) { |
| g_vmas.emplace(key, current); |
| return; |
| } |
| |
| // Coalesces VMAs' usage by name, if !g_show_addr && !g_verbose. |
| auto iter = g_vmas.find(key); |
| if (iter == g_vmas.end()) { |
| g_vmas.emplace(key, current); |
| return; |
| } |
| |
| VmaInfo& match = iter->second; |
| add_mem_usage(&match.vma.usage, current.vma.usage); |
| match.is_bss &= current.is_bss; |
| } |
| |
| static void print_text_header(std::ostream& output) { |
| if (g_show_addr) { |
| output << " start end "; |
| } |
| output << " virtual shared shared private private " |
| "Anon Shmem File Shared Private\n"; |
| if (g_show_addr) { |
| output << " addr addr "; |
| } |
| output << " size RSS PSS clean dirty clean dirty swap swapPSS " |
| "HugePages PmdMapped PmdMapped Hugetlb Hugetlb Locked "; |
| if (!g_verbose && !g_show_addr) { |
| output << " # "; |
| } |
| if (g_verbose) { |
| output << "flags "; |
| } |
| output << "object\n"; |
| } |
| |
| static void print_text_divider(std::ostream& output) { |
| if (g_show_addr) { |
| output << "---------------- ---------------- "; |
| } |
| output << "-------- -------- -------- -------- -------- -------- -------- -------- -------- " |
| << "--------- --------- --------- -------- -------- -------- "; |
| if (!g_verbose && !g_show_addr) { |
| output << "---- "; |
| } |
| if (g_verbose) { |
| output << "----- "; |
| } |
| output << "------------------------------\n"; |
| } |
| |
| static void print_csv_header(std::ostream& output) { |
| output << "\"virtual size\",\"RSS\",\"PSS\",\"shared clean\",\"shared dirty\"," |
| "\"private clean\",\"private dirty\",\"swap\",\"swapPSS\",\"Anon HugePages\"," |
| "\"Shmem PmdMapped\",\"File PmdMapped\",\"Shared Hugetlb\",\"Private Hugetlb\"," |
| "\"Locked\""; |
| if (g_show_addr) { |
| output << ",\"start addr\",\"end addr\""; |
| } |
| if (!g_verbose && !g_show_addr) { |
| output << ",\"#\""; |
| } |
| if (g_verbose) { |
| output << ",\"flags\""; |
| } |
| output << ",\"object\"\n"; |
| } |
| |
| static void print_header(Format format, std::ostream& output) { |
| switch (format) { |
| case Format::RAW: |
| print_text_header(output); |
| print_text_divider(output); |
| break; |
| case Format::CSV: |
| print_csv_header(output); |
| break; |
| case Format::JSON: |
| output << "["; |
| break; |
| default: |
| break; |
| } |
| } |
| |
| static void print_vmainfo(const VmaInfo& v, Format format, std::ostream& output) { |
| switch (format) { |
| case Format::RAW: |
| v.to_raw(output, false); |
| break; |
| case Format::CSV: |
| v.to_csv(output, false); |
| break; |
| case Format::JSON: |
| v.to_json(output, false); |
| output << ","; |
| break; |
| default: |
| break; |
| } |
| } |
| |
| static void print_vmainfo_totals(const VmaInfo& total_usage, Format format, std::ostream& output) { |
| switch (format) { |
| case Format::RAW: |
| print_text_divider(output); |
| print_text_header(output); |
| print_text_divider(output); |
| total_usage.to_raw(output, true); |
| break; |
| case Format::CSV: |
| total_usage.to_csv(output, true); |
| break; |
| case Format::JSON: |
| total_usage.to_json(output, true); |
| output << "]\n"; |
| break; |
| default: |
| break; |
| } |
| } |
| |
| static int showmap(Format format) { |
| if (!::android::meminfo::ForEachVmaFromFile(g_filename, collect_vma)) { |
| if (!g_quiet) { |
| std::cerr << "Failed to parse file " << g_filename << "\n"; |
| } |
| return 1; |
| } |
| |
| print_header(format, std::cout); |
| |
| VmaInfo total_usage; |
| for (const auto& entry : g_vmas) { |
| const VmaInfo& v = entry.second; |
| add_mem_usage(&total_usage.vma.usage, v.vma.usage); |
| if (g_terse && !(v.vma.usage.private_dirty || v.vma.usage.private_clean)) { |
| continue; |
| } |
| |
| print_vmainfo(v, format, std::cout); |
| } |
| print_vmainfo_totals(total_usage, format, std::cout); |
| |
| return 0; |
| } |
| |
| int main(int argc, char* argv[]) { |
| signal(SIGPIPE, SIG_IGN); |
| struct option longopts[] = { |
| {"help", no_argument, nullptr, 'h'}, |
| {0, 0, nullptr, 0}, |
| }; |
| |
| Format format = Format::RAW; |
| int opt; |
| while ((opt = getopt_long(argc, argv, "tvaqf:o:h", longopts, nullptr)) != -1) { |
| switch (opt) { |
| case 't': |
| g_terse = true; |
| break; |
| case 'a': |
| g_show_addr = true; |
| break; |
| case 'v': |
| g_verbose = true; |
| break; |
| case 'q': |
| g_quiet = true; |
| break; |
| case 'f': |
| g_filename = optarg; |
| break; |
| case 'o': |
| format = GetFormat(optarg); |
| if (format == Format::INVALID) { |
| std::cerr << "Invalid format.\n"; |
| usage(EXIT_FAILURE); |
| } |
| break; |
| case 'h': |
| usage(EXIT_SUCCESS); |
| default: |
| usage(EXIT_FAILURE); |
| } |
| } |
| |
| if (g_filename.empty()) { |
| if ((argc - 1) < optind) { |
| std::cerr << "Invalid arguments: Must provide <pid> at the end\n"; |
| usage(EXIT_FAILURE); |
| } |
| |
| g_pid = atoi(argv[optind]); |
| if (g_pid <= 0) { |
| std::cerr << "Invalid process id " << argv[optind] << "\n"; |
| usage(EXIT_FAILURE); |
| } |
| |
| g_filename = ::android::base::StringPrintf("/proc/%d/smaps", g_pid); |
| } |
| |
| return showmap(format); |
| } |
