feat(mgb): dump static memory info by tensorboard

GitOrigin-RevId: 2020ad81f9f3921fca97d6a82096b80297c31eb6

sdk/load-and-run/src/mgblar.cpp

@@ -143,11 +143,13 @@ R"__usage__(
     details.
 )__usage__"
 #ifndef __IN_TEE_ENV__
+#if MGB_ENABLE_JSON
 R"__usage__(
-  --get-static-mem-info <svgname>
+  --get-static-mem-info <log_dir_path>
     Record the static graph's static memory info.
 )__usage__"
 #endif
+#endif
 #if MGB_ENABLE_FASTRUN
 R"__usage__(
  --full-run
@@ -555,7 +557,9 @@ struct Args {
     bool reproducible = false;
     std::string fast_run_cache_path;
 #ifndef __IN_TEE_ENV__
-    std::string static_mem_svg_path;
+#if MGB_ENABLE_JSON
+    std::string static_mem_log_dir_path;
+#endif
 #endif
     bool copy_to_host = false;
     int nr_run = 10;
@@ -859,9 +863,11 @@ void run_test_st(Args &env) {
 
     auto func = env.load_ret.graph_compile(out_spec);
 #ifndef __IN_TEE_ENV__
-    if (!env.static_mem_svg_path.empty()) {
-        func->get_static_memory_alloc_info(env.static_mem_svg_path);
+#if MGB_ENABLE_JSON
+    if (!env.static_mem_log_dir_path.empty()) {
+        func->get_static_memory_alloc_info(env.static_mem_log_dir_path);
     }
+#endif
 #endif
     auto warmup = [&]() {
         printf("=== prepare: %.3fms; going to warmup\n",
@@ -1444,17 +1450,15 @@ Args Args::from_argv(int argc, char **argv) {
             continue;
         }
 #ifndef __IN_TEE_ENV__
+#if MGB_ENABLE_JSON
         if (!strcmp(argv[i], "--get-static-mem-info")) {
             ++i;
             mgb_assert(i < argc, "value not given for --get-static-mem-info");
-            ret.static_mem_svg_path = argv[i];
-            mgb_assert(
-                    ret.static_mem_svg_path.find(".svg") != std::string::npos,
-                    "the filename should be end with .svg, but got %s",
-                    ret.static_mem_svg_path.c_str());
+            ret.static_mem_log_dir_path = argv[i];
             continue;
         }
 #endif
+#endif
 #if MGB_ENABLE_FASTRUN
         if (!strcmp(argv[i], "--fast-run")) {
             ret.use_fast_run = true;

src/core/impl/graph/cg_impl_seq.cpp

@@ -13,6 +13,7 @@
 #include "megbrain/graph/exc_extra_info.h"
 #include "megbrain/opr/tensor_manip.h"
 #include "megbrain/utils/arith_helper.h"
+#include "megbrain/utils/visable_data_set.h"
 
 using namespace mgb;
 using namespace cg;
@@ -300,8 +301,10 @@ void ComputingGraphImpl::ComputingSequence::do_execute(
 
     exec_ctx.perform(&m_exec_env);
 #ifndef __IN_TEE_ENV__
+#if MGB_ENABLE_JSON
     do_regist();
 #endif
+#endif
 }
 
 void ComputingGraphImpl::ComputingSequence::preprocess(ExecContext* ctx) {
@@ -514,17 +517,20 @@ AsyncExecutable& ComputingGraphImpl::ComputingSequence::execute() {
     return *this;
 }
 #ifndef __IN_TEE_ENV__
+#if MGB_ENABLE_JSON
 void ComputingGraphImpl::ComputingSequence::get_static_memory_alloc_info(
-        const std::string& svg_name) const {
+        const std::string& log_dir) const {
     auto& recorder = StaticMemRecorder::Instance();
     recorder.active();
-    recorder.set_svg_name(svg_name);
+    recorder.set_log_dir_name(log_dir);
+    VisableDataSet writer(log_dir);
+    writer.draw_graph(this->to_json());
 }
 
 void ComputingGraphImpl::ComputingSequence::do_regist() const {
     // regist weights
     auto& recorder = StaticMemRecorder::Instance();
-    if (recorder.valid()) {
+    if (recorder.valid() && recorder.weight_chunk_id() == 0) {
         size_t addr_base = recorder.peak_mem_size();
         size_t chunk_id = recorder.set_weight_chunk_id();
         for (auto&& i : *(this->m_opr_seq)) {
@@ -549,10 +555,11 @@ void ComputingGraphImpl::ComputingSequence::do_regist() const {
             }
         }
         recorder.set_sum_mem_size(addr_base);
-        recorder.show();
+        recorder.dump_to_json();
     }
 }
 #endif
+#endif
 AsyncExecutable& ComputingGraphImpl::ComputingSequence::wait() {
     do_wait(true);
     return *this;

src/core/impl/graph/cg_impl_seq.h

@@ -173,12 +173,14 @@ public:
 
     std::unique_ptr<RecordedComputingSequence> as_recorded_seq();
 #ifndef __IN_TEE_ENV__
+#if MGB_ENABLE_JSON
     void get_static_memory_alloc_info(
-            const std::string& svg_name =
-                    "static_mem_record.svg") const override;
+            const std::string& log_dir =
+                    "logs/test") const override;
 
     void do_regist() const;
 #endif
+#endif
 };
 
 class ComputingGraphImpl::MegDNNDtorCheck : public NonCopyableObj {

src/core/impl/graph/var_node_mem_mgr/static_mem_alloc.h

@@ -12,6 +12,7 @@
 #pragma once
 
 #include "megbrain/plugin/static_mem_record.h"
+#include "megbrain/utils/visable_data_set.h"
 #include "megbrain_build_config.h"
 
 #include <cstddef>

src/core/impl/utils/visable_data_set.cpp

@@ -106,8 +106,6 @@ void VisableDataSet::write_to_file() {
     }
 }
 
-// const std::string PeakMemoryInfo::content() const {return }
-
 std::shared_ptr<json::Value> Chunk::to_json() const {
     auto objptr = json::Object::make();
     auto&& obj = *objptr;

src/core/include/megbrain/graph/bases.h

@@ -196,8 +196,8 @@ class AsyncExecutable : public json::Serializable,
         }
 #ifndef __IN_TEE_ENV__
         virtual void get_static_memory_alloc_info(
-                const std::string& svg_name) const {
-            mgb_assert(svg_name.length() < 0,
+                const std::string& log_dir) const {
+            mgb_assert(log_dir.length() < 0,
                        "can't call this function directly\n");
         }
 #endif

src/plugin/impl/static_mem_record.cpp

@@ -11,312 +11,41 @@
  */
 
 #include "megbrain/plugin/static_mem_record.h"
+#include "megbrain/utils/visable_data_set.h"
 #ifndef __IN_TEE_ENV__
+#if MGB_ENABLE_JSON
 #include <fstream>
 #include <iostream>
 
 using namespace mgb;
 using namespace cg;
 
-namespace {
-#define SVG_WIDTH 20000.0
-#define SVG_HEIGHT 15000.0
-#define OPR_RECT_WIDTH 40.0
-#define OPR_RECT_HEIGHT 20.0
-
-const std::string rect =
-        "<rect x=\"{}\" y=\"{}\" width=\"{}\" height=\"{}\" fill=\"{}\" "
-        " {}></rect>";
-const std::string text = "<text x=\"{}\" y=\"{}\" font-size=\"{}\">{}</text>";
-const std::string polyline =
-        "<polyline points=\"{}\" style=\"fill:none;stroke:{};stroke-width:{}\" "
-        "/>";
-const std::string opr_info =
-        "tag:type=\"opr\" tag:id=\"{}\" tag:size=\"{}\" tag:name=\"{}\"";
-const std::string chunk_info =
-        "tag:type=\"chunk\" tag:id=\"{}\" tag:time=\"{}\" tag:addr=\"{}\" "
-        "tag:size=\"{}\" tag:owner_var_name=\"{}\"";
-const std::string animate =
-        "<animate attributeName=\"opacity\" from=\"0\" to=\"1\" "
-        "begin=\"{}.mouseover\" fill=\"freeze\" dur=\"1s\"/>\n<animate "
-        "attributeName=\"opacity\" from=\"1\" to=\"0\" begin=\"{}.mouseout\" "
-        "fill=\"freeze\" dur=\"1s\"/>";
-
-std::string& replace_by_parameter(std::string& original_str, size_t index) {
-    MGB_MARK_USED_VAR(index);
-    return original_str;
-}
-
-template <typename... Args>
-std::string& replace_by_parameter(std::string& original_str, size_t index,
-                                  const std::string& parameter,
-                                  const Args&... args) {
-    index = original_str.find("{}", index);
-    original_str.replace(index, 2, parameter);
-    index += parameter.length();
-    replace_by_parameter(original_str, index, args...);
-    return original_str;
-}
-
-std::string set_opr_info(std::string id, std::string size, std::string name,
-                         std::string info = opr_info) {
-    return replace_by_parameter(info, 0, id, size, name);
-}
-
-std::string set_chunk_info(std::string id, std::string time, std::string addr,
-                           std::string size, std::string owner_var_name,
-                           std::string info = chunk_info) {
-    return replace_by_parameter(info, 0, id, time, addr, size, owner_var_name);
-}
-
-std::string draw_rect(std::string x, std::string y, std::string widith,
-                      std::string height, std::string color, std::string info,
-                      std::string r = rect) {
-    return replace_by_parameter(r, 0, x, y, widith, height, color, info);
-}
-
-std::string draw_text(std::string x, std::string y, std::string font_size,
-                      std::string txt, std::string t = text) {
-    return replace_by_parameter(t, 0, x, y, font_size, txt);
-}
-
-std::string draw_polyline(std::string point_seq, std::string color,
-                          std::string width, std::string p = polyline) {
-    return replace_by_parameter(p, 0, point_seq, color, width);
-}
-}  // namespace
-
-void StaticMemRecorder::dump_svg() {
-    float svg_width = SVG_WIDTH, svg_height = SVG_HEIGHT,
-          opr_rect_width = OPR_RECT_WIDTH, opr_rect_height = OPR_RECT_HEIGHT;
-    float address_scale = 1;
-    size_t opr_nr = m_opr_seq_recorder.size();
-    if (opr_nr * OPR_RECT_WIDTH > SVG_WIDTH) {
-        svg_width = SVG_WIDTH;
-        opr_rect_width = svg_width / opr_nr;
-        opr_rect_height = opr_rect_width / 2;
-    } else {
-        opr_rect_width = OPR_RECT_WIDTH;
-        svg_width = opr_nr * opr_rect_width;
-    }
-    if (m_sum_mem_size > SVG_HEIGHT) {
-        svg_height = SVG_HEIGHT;
-        address_scale = svg_height / m_sum_mem_size;
-    } else {
-        svg_height = m_sum_mem_size;
-    }
-
-    // Rescale
-    float aspect_ratio = SVG_WIDTH / SVG_HEIGHT;
-    if (svg_width / svg_height < 1) {
-        svg_width = svg_height * aspect_ratio;
-        opr_rect_width = svg_width / opr_nr;
-        opr_rect_height = opr_rect_width / 2;
-    } else if (svg_width / svg_height > aspect_ratio) {
-        svg_height = svg_width / aspect_ratio;
-        address_scale = svg_height / m_sum_mem_size;
-    }
-
-    svg_height = svg_height + opr_rect_height * 2;
-
-    std::ofstream outfile;
-    outfile.open(m_svg_name);
-    outfile << "<?xml version=\"1.0\" standalone=\"no\"?>" << std::endl;
-    outfile << "<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN/\" "
-               "\"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\">"
-            << std::endl;
-    outfile << "<svg width=\"" + std::to_string(svg_width) + "\" height=\"" +
-                       std::to_string(svg_height) +
-                       "\" version=\"1.1\" "
-                       "xmlns=\"http://www.w3.org/2000/svg\">"
-            << std::endl;
-
-    float base_height = svg_height - opr_rect_height;
-    std::string peak_mem_polyline =
-            "0," +
-            std::to_string(base_height - m_peak_mem_size * address_scale) +
-            " " + std::to_string(m_opr_seq_recorder.size() * opr_rect_width) +
-            "," + std::to_string(base_height - m_peak_mem_size * address_scale);
-    std::string sum_mem_polyline =
-            "0," +
-            std::to_string(base_height - m_sum_mem_size * address_scale) + " " +
-            std::to_string(m_opr_seq_recorder.size() * opr_rect_width) + "," +
-            std::to_string(base_height - m_sum_mem_size * address_scale);
-    std::string memory_polyline = "";
-    for (size_t i = 0; i < m_opr_seq_recorder.size(); i++) {
-        auto&& opr = m_opr_seq_recorder.at(i);
-        memory_polyline +=
-                std::to_string((i + 0.5) * opr_rect_width) + "," +
-                std::to_string(base_height - opr.size * address_scale) + " ";
-
-        outfile << draw_text(std::to_string(i * opr_rect_width),
-                             std::to_string(svg_height - opr_rect_height * 0.5),
-                             std::to_string(opr_rect_height * 0.5),
-                             "opr" + std::to_string(i))
-                << std::endl;
-        std::string opr_info =
-                set_opr_info(
-                        std::to_string(opr.id),
-                        std::to_string(opr.size) + "B(" +
-                                std::to_string(opr.size / 1024.0 / 1024.0) +
-                                "MiB)",
-                        opr.name) +
-                " opacity=\"0\"";
-        outfile << draw_rect(std::to_string(i * opr_rect_width),
-                             std::to_string(base_height),
-                             std::to_string(opr_rect_width),
-                             std::to_string(opr_rect_height), "white", opr_info)
-                << std::endl;
-    }
-
-    for (size_t i = 0; i < m_memory_chunk_recorder.size(); i++) {
-        auto&& chunk = m_memory_chunk_recorder.at(i);
-        std::string chunk_info = set_chunk_info(
-                std::to_string(chunk.id),
-                "[" + std::to_string(chunk.time_begin) + "," +
-                        std::to_string(chunk.time_end) + ")",
-                "[" + std::to_string(chunk.addr_begin) + "," +
-                        std::to_string(chunk.addr_end) + ")",
-                std::to_string(chunk.addr_end - chunk.addr_begin) + "B(" +
-                        std::to_string((chunk.addr_end - chunk.addr_begin) /
-                                       1024.0 / 1024.0) +
-                        "MiB)",
-                chunk.owner_var_name);
-
-        outfile << draw_rect(
-                           std::to_string(chunk.time_begin * opr_rect_width),
-                           std::to_string(base_height -
-                                          chunk.addr_end * address_scale),
-                           std::to_string((chunk.time_end - chunk.time_begin) *
-                                          opr_rect_width),
-                           std::to_string((chunk.addr_end - chunk.addr_begin) *
-                                          address_scale),
-                           "gray", chunk_info)
-                << std::endl;
-        outfile << draw_text(std::to_string(chunk.time_begin * opr_rect_width),
-                             std::to_string(base_height -
-                                            chunk.addr_end * address_scale + 9),
-                             std::to_string(9),
-                             "chunk" + std::to_string(chunk.id))
-                << std::endl;
-    }
-
-    outfile << draw_text("0",
-                         std::to_string(base_height -
-                                        m_peak_mem_size * address_scale +
-                                        opr_rect_height * 0.5),
-                         std::to_string(opr_rect_height * 0.5),
-                         "peak_memory_size:" + std::to_string(m_peak_mem_size) +
-                                 "B(" +
-                                 std::to_string(m_peak_mem_size / 1024.0 /
-                                                1024.0) +
-                                 "MiB)")
-            << std::endl;
-    outfile << draw_text("0",
-                         std::to_string(base_height -
-                                        m_sum_mem_size * address_scale +
-                                        opr_rect_height * 0.5),
-                         std::to_string(opr_rect_height * 0.5),
-                         "sum_memory_size:" + std::to_string(m_sum_mem_size) +
-                                 "B(" +
-                                 std::to_string(m_sum_mem_size / 1024.0 /
-                                                1024.0) +
-                                 "MiB)")
-            << std::endl;
-    outfile << draw_polyline(memory_polyline, "blue",
-                             std::to_string(opr_rect_height * 0.1))
-            << std::endl;
-    outfile << draw_polyline(peak_mem_polyline, "green",
-                             std::to_string(opr_rect_height * 0.1))
-            << std::endl;
-    outfile << draw_polyline(sum_mem_polyline, "red",
-                             std::to_string(opr_rect_height * 0.1))
-            << std::endl;
-    outfile << "<text svg:info=\"The abscissa represents the opr sequence, the "
-               "ordinate represents the logical address.\" "
-               "svg:chunk_time=\"[opra,oprb) means the chunk is created when "
-               "opra execute and is freed before oprb\" "
-               "svg:chunk_oner_var_name=\"var that first creates this "
-               "chunk\"></text>"
-            << std::endl;
-    outfile << "</svg>" << std::endl;
-    outfile.close();
-}
-
-void StaticMemRecorder::show() {
+void StaticMemRecorder::dump_to_json() {
+    VisableDataSet writer(m_log_dir);
     for (auto&& i : m_memory_chunk_recorder) {
-        if (i.id >= m_weight_chunk_id) {
-            break;
-        }
-        size_t begin = i.time_begin, end = i.time_end;
-        if (i.is_overwrite) {
-            begin++;
-        }
-        for (size_t j = begin; j < end; j++) {
-            m_opr_seq_recorder.at(j).size += i.size_orig;
+        // static mem chunk
+        if (i.id < m_weight_chunk_id) {
+            std::string overwrite_dest_id =
+                    i.is_overwrite ? std::to_string(i.overwrite_dest_id) : "-1";
+            Chunk c(std::to_string(i.id), Chunk::static_mem,
+                    std::to_string(i.time_begin), std::to_string(i.time_end),
+                    std::to_string(i.addr_begin), std::to_string(i.addr_end),
+                    overwrite_dest_id);
+            writer.dump_info(c);
+        } else {
+            // weight mem chunk
+            Chunk c(std::to_string(i.id), Chunk::weight_mem,
+                    std::to_string(i.time_begin), std::to_string(i.time_end),
+                    std::to_string(i.addr_begin), std::to_string(i.addr_end),
+                    "-1");
+            writer.dump_info(c);
         }
     }
-
-    // log peak memory size, where it is reached and which chunks constitute it.
-    mgb_log("peak_mem_size = %zu\n", m_peak_mem_size);
-    size_t max_size = 0;
-    std::vector<size_t> opr_ids;
     for (auto&& i : m_opr_seq_recorder) {
-        if (i.size == max_size) {
-            opr_ids.push_back(i.id);
-        } else if (i.size > max_size) {
-            max_size = i.size;
-            opr_ids.clear();
-            opr_ids.push_back(i.id);
-        }
-    }
-
-    auto opr2chunk = get_chunk_construct(opr_ids);
-    mgb_log("oprs reach the peak memory:\n");
-    for (auto&& i : opr_ids) {
-        mgb_log("opr id = %zu\n", i);
+        OprSeq o(std::to_string(i.id), i.name);
+        writer.dump_info(o);
     }
-    mgb_log("More details:\n");
-    for (size_t i = 0; i < opr2chunk.size(); i++) {
-        mgb_log("opr id = %zu\n", opr_ids.at(i));
-        if (i + 1 < opr2chunk.size() &&
-            opr2chunk.at(i) == opr2chunk.at(i + 1)) {
-            continue;
-        }
-        for (size_t j = 0; j < opr2chunk.at(i).size(); j++) {
-            auto&& chunk = m_memory_chunk_recorder.at(opr2chunk.at(i).at(j));
-            mgb_log("[memory_chunk_id=%zu, size=%zu B,  "
-                    "[life_begin=%zu,life_end=%zu),  owner_opr_name=%s]\n",
-                    chunk.id, chunk.size_orig, chunk.time_begin, chunk.time_end,
-                    m_opr_seq_recorder.at(chunk.time_begin).name.c_str());
-        }
-    }
-    dump_svg();
-}
-
-std::vector<std::vector<size_t>> StaticMemRecorder::get_chunk_construct(
-        std::vector<size_t> opr_ids) {
-    std::vector<std::vector<size_t>> chunk_ids;
-    chunk_ids.resize(opr_ids.size());
-    for (auto&& i : m_memory_chunk_recorder) {
-        if (i.id >= m_weight_chunk_id) {
-            break;
-        }
-        size_t begin = i.time_begin, end = i.time_end;
-        if (i.is_overwrite) {
-            begin = begin + 1;
-        }
-        if (opr_ids.front() >= end || opr_ids.back() < begin) {
-            continue;
-        }
-        for (size_t k = 0; k < opr_ids.size(); k++) {
-            if (opr_ids.at(k) >= end) {
-                break;
-            } else if (opr_ids.at(k) >= begin) {
-                chunk_ids.at(k).push_back(i.id);
-            }
-        }
-    }
-    return chunk_ids;
+    writer.write_to_file();
 }
 #endif
+#endif
\ No newline at end of file

src/plugin/include/megbrain/plugin/static_mem_record.h

@@ -12,6 +12,7 @@
 
 #pragma once
 #include "megbrain/utils/metahelper.h"
+#include <regex>
 #ifndef __IN_TEE_ENV__
 namespace mgb {
 namespace cg {
@@ -66,33 +67,25 @@ public:
     }
 
     const size_t& weight_chunk_id() const { return m_weight_chunk_id; }
-
-    void dump_svg();
-
-    void show();
-
-    void set_svg_name(const std::string& svg_name) {
-        mgb_assert(svg_name.length() > 4,
-                   "svg_name must be end with \".svg\"\n");
-        mgb_assert(svg_name.compare(svg_name.length() - 4, 4, ".svg") == 0,
-                   "svg_name must be end with \".svg\"\n");
-        m_svg_name = svg_name;
+#if MGB_ENABLE_JSON
+    void dump_to_json();
+#endif
+    void set_log_dir_name(const std::string& log_dir) {
+        std::regex reg("^[0-9a-zA-Z/]+$");
+        mgb_assert(std::regex_match(log_dir, reg), "log_dir format error.\n");
+        m_log_dir = log_dir;
     }
 
-    const std::string& get_svg_name() const{
-        return m_svg_name;
-    }
+    const std::string& get_log_dir() const { return m_log_dir; }
 
 private:
     bool m_is_record = false;
-    std::string m_svg_name;
+    std::string m_log_dir;
     // All chunks after m_memory_chunk_recorder.at(m_weight_chunk_id) are
     // weights memory chunks
     size_t m_peak_mem_size, m_sum_mem_size, m_weight_chunk_id;
     std::vector<opr_record> m_opr_seq_recorder;
     std::vector<memory_chunk_record> m_memory_chunk_recorder;
-    std::vector<std::vector<size_t>> get_chunk_construct(
-            std::vector<size_t> opr_ids);
 };
 }  // namespace cg
 }  // namespace mgb