[Depends on #8344] Implement ApiHandler functions and add JsonWriter (#8379)

show50726 · web-flow · commit 9ca0594d7c40 · 2025-02-15T02:27:42.000Z
* Introduce FrameGraphInfo class

* Move the assignment into pimpl

* Make ctors explicit

* Add ctors to fg info structs

* Revert the macro change to align with existing

* Address the comments

* Remove pimpl and move func def to .cc

* Fix

* Convert the FrameGraph to FrameGraphInfo

* Initialize and update debug server on engine side

* Fix compile error

* Address the comments

* Update

* Use camelCase

* Use camelCase

* Update

* Add JsonWriter to convert fginfo to json

* Add getStatus api and implement it

* Add increment

* Implement GET apis

* Fix compile error

* Update

* Use c_str_safe

* Add operator== for FrameGraphInfo

* Call updateFrameGraph in appropriate locations

* Address the comments
diff --git a/libs/fgviewer/CMakeLists.txt b/libs/fgviewer/CMakeLists.txt
@@ -23,6 +23,7 @@ set(SRCS
     src/ApiHandler.h
     src/DebugServer.cpp
     src/FrameGraphInfo.cpp
+    src/JsonWriter.cpp
 )
 
 # ==================================================================================================
diff --git a/libs/fgviewer/include/fgviewer/FrameGraphInfo.h b/libs/fgviewer/include/fgviewer/FrameGraphInfo.h
@@ -1,5 +1,5 @@
 /*
-* Copyright (C) 2024 The Android Open Source Project
+ * Copyright (C) 2024 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.
@@ -36,17 +36,25 @@ class FrameGraphInfo {
 
     FrameGraphInfo(FrameGraphInfo const &) = delete;
 
+    bool operator==(const FrameGraphInfo& rhs) const;
+
     struct Pass {
         Pass(utils::CString name, std::vector<ResourceId> reads,
              std::vector<ResourceId> writes);
 
+        bool operator==(const Pass& rhs) const;
+
         utils::CString name;
         std::vector<ResourceId> reads;
         std::vector<ResourceId> writes;
     };
 
     struct Resource {
+        bool operator==(const Resource& rhs) const;
+
         struct Property {
+            bool operator==(const Property& rhs) const;
+
             utils::CString name;
             utils::CString value;
         };
@@ -70,6 +78,12 @@ class FrameGraphInfo {
     // The incoming passes should be sorted by the execution order.
     void setPasses(std::vector<Pass> sortedPasses);
 
+    const char* getViewName() const;
+
+    const std::vector<Pass>& getPasses() const;
+
+    const std::unordered_map<ResourceId, Resource>& getResources() const;
+
 private:
     utils::CString viewName;
     // The order of the passes in the vector indicates the execution
diff --git a/libs/fgviewer/src/ApiHandler.cpp b/libs/fgviewer/src/ApiHandler.cpp
@@ -18,6 +18,7 @@
 #include "ApiHandler.h"
 
 #include <fgviewer/DebugServer.h>
+#include <fgviewer/JsonWriter.h>
 
 #include <utils/FixedCapacityVector.h>
 #include <utils/Log.h>
@@ -40,29 +41,96 @@ auto const error = [](int line, std::string const& uri) {
 
 } // anonymous
 
-bool ApiHandler::handleGetApiFgInfo(struct mg_connection* conn,
-        struct mg_request_info const* request) {
-    auto const softError = [conn, request](char const* msg) {
-        utils::slog.e << "[fgviewer] DebugServer: " << msg << ": " << request->query_string << utils::io::endl;
-        mg_printf(conn, kErrorHeader.data(), "application/txt");
-        mg_write(conn, msg, strlen(msg));
+bool ApiHandler::handleGet(CivetServer* server, struct mg_connection* conn) {
+    struct mg_request_info const* request = mg_get_request_info(conn);
+    std::string const& uri = request->local_uri;
+
+    if (uri.find("/api/status") == 0) {
+        return handleGetStatus(conn, request);
+    }
+
+    if (uri == "/api/framegraphs") {
+        std::unique_lock const lock(mServer->mViewsMutex);
+        mg_printf(conn, kSuccessHeader.data(), "application/json");
+        mg_printf(conn, "[");
+        int index = 0;
+        for (auto const& view: mServer->mViews) {
+            bool const last = (++index) == mServer->mViews.size();
+
+            JsonWriter writer;
+            if (!writer.writeFrameGraphInfo(view.second)) {
+                return error(__LINE__, uri);
+            }
+
+            mg_printf(conn, "{ \"fgid\": \"%8.8x\", %s } %s", view.first, writer.getJsonString(),
+                    last ? "" : ",");
+        }
+        mg_printf(conn, "]");
+        return true;
+    }
+
+    if (uri == "/api/framegraph") {
+        const FrameGraphInfo* result = getFrameGraphInfo(request);
+        if (!result) {
+            return error(__LINE__, uri);
+        }
+
+        JsonWriter writer;
+        if (!writer.writeFrameGraphInfo(*result)) {
+            return error(__LINE__, uri);
+        }
+        mg_printf(conn, kSuccessHeader.data(), "application/json");
+        mg_printf(conn, "{ %s }", writer.getJsonString());
         return true;
-    };
+    }
 
-    // TODO: Implement the method
-    return true;
+    return error(__LINE__, uri);
 }
 
-void ApiHandler::addFrameGraph(FrameGraphInfo const* framegraph) {
-    // TODO: Implement the method
+void ApiHandler::updateFrameGraph(ViewHandle view_handle) {
+    std::unique_lock const lock(mStatusMutex);
+    snprintf(statusFrameGraphId, sizeof(statusFrameGraphId), "%8.8x", view_handle);
+    mCurrentStatus++;
+    mStatusCondition.notify_all();
 }
 
+const FrameGraphInfo* ApiHandler::getFrameGraphInfo(struct mg_request_info const* request) {
+    size_t const qlength = strlen(request->query_string);
+    char fgid[9] = {};
+    if (mg_get_var(request->query_string, qlength, "fgid", fgid, sizeof(fgid)) < 0) {
+        return nullptr;
+    }
+    uint32_t const id = strtoul(fgid, nullptr, 16);
+    std::unique_lock const lock(mServer->mViewsMutex);
+    const auto it = mServer->mViews.find(id);
+    return it == mServer->mViews.end()
+        ? nullptr
+        : &(it->second);
+}
 
-bool ApiHandler::handleGet(CivetServer* server, struct mg_connection* conn) {
-    struct mg_request_info const* request = mg_get_request_info(conn);
-    std::string const& uri = request->local_uri;
-
-    // TODO: Implement the method
+bool ApiHandler::handleGetStatus(struct mg_connection* conn,
+                                 struct mg_request_info const* request) {
+    char const* qstr = request->query_string;
+    if (qstr && strcmp(qstr, "firstTime") == 0) {
+        mg_printf(conn, kSuccessHeader.data(), "application/txt");
+        mg_write(conn, "0", 1);
+        return true;
+    }
+
+    std::unique_lock<std::mutex> lock(mStatusMutex);
+    uint64_t const currentStatusCount = mCurrentStatus;
+    if (mStatusCondition.wait_for(lock, 10s,
+                                  [this, currentStatusCount] {
+                                      return currentStatusCount < mCurrentStatus;
+                                  })) {
+        mg_printf(conn, kSuccessHeader.data(), "application/txt");
+        mg_write(conn, statusFrameGraphId, 8);
+    } else {
+        mg_printf(conn, kSuccessHeader.data(), "application/txt");
+        // Use '1' to indicate a no-op.  This ensures that we don't block forever if the client is
+        // gone.
+        mg_write(conn, "1", 1);
+    }
     return true;
 }
 
diff --git a/libs/fgviewer/src/ApiHandler.h b/libs/fgviewer/src/ApiHandler.h
@@ -17,6 +17,8 @@
 #ifndef FGVIEWER_APIHANDLER_H
 #define FGVIEWER_APIHANDLER_H
 
+#include <fgviewer/DebugServer.h>
+
 #include <CivetServer.h>
 
 namespace filament::fgviewer {
@@ -27,7 +29,8 @@ struct FrameGraphInfo;
 // Handles the following REST requests, where {id} is an 8-digit hex string.
 //
 //    GET /api/framegraphs
-//    GET /api/framegraph?fg={viewname}
+//    GET /api/framegraph?fg={fgid}
+//    GET /api/status
 //
 class ApiHandler : public CivetHandler {
 public:
@@ -36,12 +39,25 @@ class ApiHandler : public CivetHandler {
     ~ApiHandler() = default;
 
     bool handleGet(CivetServer* server, struct mg_connection* conn);
-    void addFrameGraph(FrameGraphInfo const* frameGraph);
+
+    void updateFrameGraph(ViewHandle view_handle);
 
 private:
-    bool handleGetApiFgInfo(struct mg_connection* conn, struct mg_request_info const* request);
+    const FrameGraphInfo* getFrameGraphInfo(struct mg_request_info const* request);
+
+    bool handleGetStatus(struct mg_connection* conn,
+                         struct mg_request_info const* request);
 
     DebugServer* mServer;
+
+    std::mutex mStatusMutex;
+    std::condition_variable mStatusCondition;
+    char statusFrameGraphId[9] = {};
+
+    // This variable is to implement a *hanging* effect for /api/status. The call to /api/status
+    // will always block until statusMaterialId is updated again. The client is expected to keep
+    // calling /api/status (a constant "pull" to simulate a push).
+    uint64_t mCurrentStatus = 0;
 };
 
 } // filament::fgviewer
diff --git a/libs/fgviewer/src/DebugServer.cpp b/libs/fgviewer/src/DebugServer.cpp
@@ -110,6 +110,7 @@ ViewHandle DebugServer::createView(utils::CString name) {
     std::unique_lock<utils::Mutex> lock(mViewsMutex);
     ViewHandle handle = mViewCounter++;
     mViews.emplace(handle, FrameGraphInfo(std::move(name)));
+    mApiHandler->updateFrameGraph(handle);
 
     return handle;
 }
@@ -121,8 +122,19 @@ void DebugServer::destroyView(ViewHandle h) {
 
 void DebugServer::update(ViewHandle h, FrameGraphInfo info) {
     std::unique_lock<utils::Mutex> lock(mViewsMutex);
+    const auto it = mViews.find(h);
+    if (it == mViews.end()) {
+        slog.w << "[fgviewer] Received update for unknown handle " << h;
+        return;
+    }
+
+    bool has_changed = !(it->second == info);
+    if (!has_changed)
+        return;
+
     mViews.erase(h);
     mViews.emplace(h, std::move(info));
+    mApiHandler->updateFrameGraph(h);
 }
 
 } // namespace filament::fgviewer
diff --git a/libs/fgviewer/src/FrameGraphInfo.cpp b/libs/fgviewer/src/FrameGraphInfo.cpp
@@ -1,5 +1,5 @@
 /*
-* Copyright (C) 2024 The Android Open Source Project
+ * Copyright (C) 2024 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.
@@ -25,15 +25,33 @@ FrameGraphInfo::~FrameGraphInfo() = default;
 
 FrameGraphInfo::FrameGraphInfo(FrameGraphInfo&& rhs) noexcept = default;
 
+bool FrameGraphInfo::operator==(const FrameGraphInfo& rhs) const {
+    return viewName == rhs.viewName
+            && passes == rhs.passes
+            && resources == rhs.resources;
+}
+
 FrameGraphInfo::Pass::Pass(utils::CString name, std::vector<ResourceId> reads,
     std::vector<ResourceId> writes): name(std::move(name)),
                                     reads(std::move(reads)),
                                     writes(std::move(writes)) {}
 
+bool FrameGraphInfo::Pass::operator==(const Pass& rhs) const {
+    return name == rhs.name && reads == rhs.reads && writes == rhs.writes;
+}
+
 FrameGraphInfo::Resource::Resource(ResourceId id, utils::CString name,
     std::vector<Property> properties): id(id),
     name(std::move(name)), properties(std::move(properties)) {}
 
+bool FrameGraphInfo::Resource::operator==(const Resource& rhs) const {
+    return id == rhs.id && name == rhs.name && properties == rhs.properties;
+}
+
+bool FrameGraphInfo::Resource::Property::operator==(const Property &rhs) const {
+    return name == rhs.name && value == rhs.value;
+}
+
 void FrameGraphInfo::setResources(
     std::unordered_map<ResourceId, Resource> resources) {
     this->resources = std::move(resources);
@@ -43,4 +61,17 @@ void FrameGraphInfo::setPasses(std::vector<Pass> sortedPasses) {
     passes = std::move(sortedPasses);
 }
 
+const char* FrameGraphInfo::getViewName() const {
+    return viewName.c_str_safe();
+}
+
+const std::vector<FrameGraphInfo::Pass>& FrameGraphInfo::getPasses() const {
+    return passes;
+}
+
+const std::unordered_map<ResourceId, FrameGraphInfo::Resource>&
+    FrameGraphInfo::getResources() const {
+    return resources;
+}
+
 } // namespace filament::fgviewer
diff --git a/libs/fgviewer/src/JsonWriter.cpp b/libs/fgviewer/src/JsonWriter.cpp

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ set(SRCS`
`23`	`23`	`src/ApiHandler.h`
`24`	`24`	`src/DebugServer.cpp`
`25`	`25`	`src/FrameGraphInfo.cpp`
	`26`	`+ src/JsonWriter.cpp`
`26`	`27`	`)`
`27`	`28`
`28`	`29`	`# ==================================================================================================`