src/developer/memory/mem/main.cc

// Copyright 2019 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include <fidl/fuchsia.memory/cpp/wire.h>
#include <lib/async-loop/cpp/loop.h>
#include <lib/async-loop/default.h>
#include <lib/component/incoming/cpp/service_client.h>
#include <lib/fdio/directory.h>
#include <lib/syslog/cpp/macros.h>
#include <lib/trace-provider/fdio_connect.h>
#include <lib/trace-provider/provider.h>
#include <lib/trace/observer.h>
#include <lib/zx/clock.h>
#include <zircon/status.h>

#include <condition_variable>
#include <filesystem>
#include <iostream>
#include <mutex>
#include <utility>

#include "src/developer/memory/metrics/bucket_match.h"
#include "src/developer/memory/metrics/capture.h"
#include "src/developer/memory/metrics/digest.h"
#include "src/developer/memory/metrics/printer.h"
#include "src/developer/memory/metrics/summary.h"
#include "src/developer/memory/metrics/watcher.h"
#include "src/lib/fxl/command_line.h"
#include "src/lib/fxl/strings/string_number_conversions.h"

using namespace memory;

const zx::duration kHighWaterPollFrequency = zx::msec(500);
const uint64_t kHighWaterThreshold = 10ul * 1024 * 1024;

// Returns a Digester using the memory monitor configuration if available.
std::vector<BucketMatch> GetBucketMatchesFromConfig() {
  std::string config_str;
  if (!files::ReadFileToString("/config/data/buckets.json", &config_str)) {
    FX_LOGS(ERROR) << "Unable to read configuration, no bucket will be used";
    return {};
  }

  auto matches = BucketMatch::ReadBucketMatchesFromConfig(config_str);
  FX_CHECK(matches.has_value());
  return *matches;
}

void SignalMemoryPressure(fuchsia_memorypressure::Level level) {
  auto client_end = component::Connect<fuchsia_memory::Debugger>();
  if (!client_end.is_ok()) {
    FX_LOGS(ERROR) << "Could not connect to the memory monitor";
    return;
  }

  auto result = fidl::WireCall(*client_end)->SignalMemoryPressure(level);
  if (result.status() != ZX_OK) {
    FX_LOGS(ERROR) << "Could not signal memory pressure";
    return;
  }
}

int Mem(const fxl::CommandLine& command_line) {
  if (command_line.HasOption("signal")) {
    std::string level_value;
    FX_CHECK(command_line.GetOptionValue("signal", &level_value));

    fuchsia_memorypressure::Level level;
    if (level_value == "NORMAL") {
      level = fuchsia_memorypressure::Level::kNormal;
    } else if (level_value == "WARNING") {
      level = fuchsia_memorypressure::Level::kWarning;
    } else if (level_value == "CRITICAL") {
      level = fuchsia_memorypressure::Level::kCritical;
    } else {
      std::cerr << "Invalid value for --signal: " << level_value;
      return EXIT_FAILURE;
    }
    SignalMemoryPressure(level);
    return EXIT_SUCCESS;
  }

  CaptureState capture_state;
  auto s = Capture::GetCaptureState(&capture_state);
  Printer printer(std::cout);

  if (s != ZX_OK) {
    std::cerr << "Error getting capture state: " << zx_status_get_string(s);
    return EXIT_FAILURE;
  }

  if (command_line.HasOption("output") || command_line.HasOption("print")) {
    zx_koid_t pid = 0;
    std::string pid_value;
    if (command_line.GetOptionValue("pid", &pid_value)) {
      if (!fxl::StringToNumberWithError(pid_value, &pid)) {
        std::cerr << "Invalid value for --pid: " << pid_value;
        return EXIT_FAILURE;
      }
    }
    int64_t repeat = 0;  // int64_t to be compatible with zx::sec() below.
    std::string repeat_value;
    if (command_line.GetOptionValue("repeat", &repeat_value)) {
      if (!fxl::StringToNumberWithError(repeat_value, &repeat)) {
        std::cerr << "Invalid value for --repeat: " << repeat_value;
        return EXIT_FAILURE;
      }
    }
    zx::duration repeat_secs = zx::sec(repeat);
    zx::time start = zx::clock::get_monotonic();
    Namer namer(Summary::kNameMatches);
    for (int64_t i = 1; true; i++) {
      Capture capture;
      auto s = Capture::GetCapture(&capture, capture_state, VMO);
      if (s != ZX_OK) {
        std::cerr << "Error getting capture: " << zx_status_get_string(s);
        return EXIT_FAILURE;
      }
      if (command_line.HasOption("digest")) {
        Digester digester(GetBucketMatchesFromConfig());
        Digest d(capture, &digester);
        printer.OutputDigest(d);
      } else if (command_line.HasOption("print")) {
        printer.PrintCapture(capture);
        if (repeat != 0) {
          std::cout << std::endl;
        }
      } else {
        printer.OutputSummary(Summary(capture, &namer), UNSORTED, pid);
      }

      if (repeat == 0) {
        break;
      }

      zx::time next = start + (repeat_secs * i);
      if (next <= zx::clock::get_monotonic()) {
        next = zx::clock::get_monotonic() + repeat_secs;
      }
      zx::nanosleep(next);
    }

    return EXIT_SUCCESS;
  }

  if (command_line.HasOption("watch")) {
    int64_t watch = 0;  // int64_t to be compatible with zx::sec() below.
    std::string watch_value;
    if (command_line.GetOptionValue("watch", &watch_value)) {
      if (!fxl::StringToNumberWithError(watch_value, &watch)) {
        std::cerr << "Invalid value for --watch: " << watch_value;
        return EXIT_FAILURE;
      }
    }
    async::Loop loop(&kAsyncLoopConfigAttachToCurrentThread);
    trace::TraceProviderWithFdio trace_provider(loop.dispatcher(), "mem --watch");
    Capture capture;
    Watcher watcher(
        kHighWaterPollFrequency, kHighWaterThreshold, loop.dispatcher(),
        [&capture_state](Capture* c, CaptureLevel l) {
          return Capture::GetCapture(c, capture_state, l);
        },
        [&capture](const Capture& c) { capture = c; });

    loop.Run(zx::clock::get_monotonic() + zx::sec(watch));
    printer.PrintCapture(capture);
    std::cout << std::endl;
    return EXIT_SUCCESS;
  }

  Capture capture;
  s = Capture::GetCapture(&capture, capture_state, VMO);
  if (s != ZX_OK) {
    std::cerr << "Error getting capture: " << zx_status_get_string(s);
    return EXIT_FAILURE;
  }
  if (command_line.HasOption("digest")) {
    Digester digester(GetBucketMatchesFromConfig());
    Digest digest(capture, &digester);
    printer.PrintDigest(digest);
    if (command_line.HasOption("undigested")) {
      std::cout << capture.koid_to_vmo().size() << " VMOs, " << digest.undigested_vmos().size()
                << " Undigested\n";
      Namer namer(Summary::kNameMatches);
      Summary undigested_summary(capture, &namer, digest.undigested_vmos());
      std::cout << undigested_summary.process_summaries().size() << " Process summaries\n";
      printer.PrintSummary(undigested_summary, memory::VMO, SORTED);
    }
    return EXIT_SUCCESS;
  }
  printer.PrintSummary(Summary(capture, Summary::kNameMatches), VMO, SORTED);
  return EXIT_SUCCESS;
}

int main(int argc, const char** argv) {
  auto command_line = fxl::CommandLineFromArgcArgv(argc, argv);

  if (command_line.HasOption("help")) {
    std::cout << "Usage: mem [options]\n"
                 "  Prints system-wide task and memory\n\n"
                 "  Memory numbers are triplets P,S,T\n"
                 "  P: Private bytes\n"
                 "  S: Total bytes scaled by 1/# processes sharing each byte\n"
                 "  T: Total bytes\n"
                 "     S and T are inclusive of P\n\n"
                 " Options:\n"
                 " [default]  Human readable representation of process and vmo groups\n"
                 " --trace    Enable tracing support\n"
                 " --print    Machine readable representation of process and vmos\n"
                 " --watch=N  Prints machine readable representation of process and vmos at the\n"
                 "            point of highest memory pressure in the next N seconds.\n"
                 " --output   CSV of process memory\n"
                 "            --repeat=N Runs forever, outputing every N seconds\n"
                 "            --pid=N    Output vmo groups of process pid instead\n"
                 " --digest   Prints a bucketized digest of memory usage\n"
                 " --signal=L Signal userspace clients with memory pressure level L\n"
                 "            where L can be CRITICAL, WARNING or NORMAL. Clients can\n"
                 "            use this command to test their response to memory pressure.\n"
                 "            Does not affect the real memory pressure level on the system,\n"
                 "            or trigger any kernel memory reclamation tasks.\n"
                 " --no-deprecation-warning\n"
                 "            Hides the deprecation warning.\n";
    return EXIT_SUCCESS;
  }

  if (!command_line.HasOption("no-deprecation-warning")) {
    std::cout << "Warning: `fx mem` is being deprecated in favor of `ffx profile memory`.\n"
                 "Please file bugs regarding the deprecation in Tools>ffx>Profile>Memory\n"
                 "Use the option `--no-deprecation-warning` to disable the warning.\n";
  }

  if (command_line.HasOption("trace")) {
    async::Loop loop(&kAsyncLoopConfigNoAttachToCurrentThread);
    loop.StartThread("provider loop");
    trace::TraceProviderWithFdio trace_provider(loop.dispatcher(), "mem");
    trace::TraceObserver trace_observer;
    std::mutex m;
    std::condition_variable cv;
    bool got_start = false;
    trace_observer.Start(loop.dispatcher(), [&m, &cv, &got_start] {
      std::unique_lock<std::mutex> lock(m);
      got_start = true;
      cv.notify_all();
    });
    std::unique_lock<std::mutex> l(m);
    cv.wait(l, [&got_start] { return got_start; });
    return Mem(command_line);
  }
  return Mem(command_line);
}