Setup trace ffx unix pipe (google#1277)

* [fuchsia] Create AGI to ffx unix socket bridge.

Author: rosasco-wk

core/cc/fuchsia/zircon_socket_connection.cpp

@@ -21,30 +21,65 @@
 #include <errno.h>
 #include <zircon/status.h>
 
+#include <thread>
+
 #include "core/cc/log.h"
 
+#define ERR_IF_COND(cond, ...) \
+  if ((cond)) {                \
+    GAPID_ERROR(__VA_ARGS__);  \
+  }
+
 namespace core {
 
 ZirconSocketConnection::~ZirconSocketConnection() { mSocket.reset(); }
 
 size_t ZirconSocketConnection::send(const void* data, size_t size) {
   size_t bytes_written = 0;
   zx_status_t status = mSocket.write(0u, data, size, &bytes_written);
-  if (status != ZX_OK) {
-    GAPID_ERROR("Failed to write data to Zircon socket: %s",
-                zx_status_get_string(status));
-  }
+  ERR_IF_COND(status != ZX_OK, "Failed to write data to Zircon socket: %s",
+              zx_status_get_string(status));
   return bytes_written;
 }
 
-size_t ZirconSocketConnection::recv(void* data, size_t size) {
-  size_t bytes_read = 0;
-  zx_status_t status = mSocket.read(0u, data, size, &bytes_read);
-  if (status != ZX_OK) {
-    GAPID_ERROR("Failed to read data from Zircon socket: %s",
-                zx_status_get_string(status));
-  }
-  return bytes_read;
+size_t ZirconSocketConnection::recv(void* data, const size_t size) {
+  const auto p = static_cast<uint8_t*>(data);
+  size_t total_bytes_read = 0;
+  zx_status_t read_status = ZX_ERR_INTERNAL;
+  zx_status_t wait_status = ZX_ERR_INTERNAL;
+  zx_signals_t observed_signal = 0;
+  do {
+    size_t bytes_read = 0;
+    read_status = mSocket.read(0u, p + total_bytes_read,
+                               size - total_bytes_read, &bytes_read);
+    switch (read_status) {
+      case ZX_OK:
+        total_bytes_read += bytes_read;
+        break;
+      case ZX_ERR_SHOULD_WAIT:
+        wait_status =
+            mSocket.wait_one(ZX_SOCKET_READABLE | ZX_SOCKET_PEER_CLOSED,
+                             zx::time::infinite(), &observed_signal);
+
+        if (wait_status != ZX_OK || observed_signal & ZX_SOCKET_PEER_CLOSED) {
+          GAPID_ERROR("ZirconSocketConnection wait_status: %s observed: %d",
+                      zx_status_get_string(wait_status), observed_signal);
+          return 0;
+        }
+        break;
+      default:
+        GAPID_ERROR("ZirconSocketConnection unexpected read_status: %s",
+                    zx_status_get_string(read_status));
+        return 0;
+    }
+  } while ((read_status == ZX_OK || observed_signal & ZX_SOCKET_READABLE) &&
+           total_bytes_read < size);
+
+  ERR_IF_COND(total_bytes_read != size,
+              "Failed to read %zu bytes from Zircon socket. read_status: %s",
+              size, zx_status_get_string(read_status));
+
+  return total_bytes_read;
 }
 
 std::unique_ptr<Connection> ZirconSocketConnection::accept(int timeoutMs) {

core/cc/fuchsia/zircon_socket_connection.h

@@ -37,7 +37,7 @@ class ZirconSocketConnection final : public Connection {
   ZirconSocketConnection& operator=(const ZirconSocketConnection&) = delete;
 
   // Implementation of the Connection interface.
-  size_t send(const void* data, size_t size) override;
+  size_t send(const void* data, const size_t size) override;
   size_t recv(void* data, size_t size) override;
   const char* error() override;
 

core/os/fuchsia/ffx/bind.go

@@ -160,26 +160,40 @@ func (b *binding) TraceProviders(ctx context.Context) ([]string, error) {
 
 // StartTrace implements the fuchsia.Device interface and starts a Fuchsia trace.
 func (b *binding) StartTrace(ctx context.Context, options *service.TraceOptions, traceFile file.Path, stop task.Signal, ready task.Task) error {
-	var categoriesArg string
-
-	// Initialize shell command.
-	cmd := b.Command("trace", "start", "--output", traceFile.System())
-
-	// Extract trace options and append arguments to command.
-	if options != nil {
-		if durationSecs := int(options.Duration); durationSecs > 0 {
-			cmd = cmd.With("--duration", strconv.Itoa(durationSecs))
+	var cmd shell.Cmd
+	switch t := options.GetType(); t {
+	case service.TraceType_Graphics:
+		if fuchsiaConfig := options.GetFuchsiaTraceConfig(); fuchsiaConfig != nil {
+			// Initialize shell command.
+			cmd = b.Command("agis", "listen", strconv.FormatInt(int64(fuchsiaConfig.GetGlobalId()), 10))
+		} else {
+			return fmt.Errorf("fuchsiaConfig is nil for graphics trace")
 		}
+	case service.TraceType_Fuchsia:
+		var categoriesArg string
+		// Initialize shell command.
+		cmd = b.Command("trace", "start", "--output", traceFile.System())
+
+		// Extract trace options and append arguments to command.
+		if options != nil {
+			if durationSecs := int(options.Duration); durationSecs > 0 {
+				cmd = cmd.With("--duration", strconv.Itoa(durationSecs))
+			}
 
-		// ffx expects a comma delimited list of trace categories.
-		if fuchsiaConfig := options.GetFuchsiaTraceConfig(); fuchsiaConfig != nil {
-			categoriesArg = strings.Join(fuchsiaConfig.Categories, ",")
-			if len(categoriesArg) > 0 {
-				cmd = cmd.With("--categories", categoriesArg)
+			// ffx expects a comma delimited list of trace categories.
+			if fuchsiaConfig := options.GetFuchsiaTraceConfig(); fuchsiaConfig != nil {
+				categories := fuchsiaConfig.GetCategories()
+				categoriesArg = strings.Join(categories, ",")
+				if len(categoriesArg) > 0 {
+					cmd = cmd.With("--categories", categoriesArg)
+				}
 			}
 		}
+	default:
+		return fmt.Errorf("Unknown Fuchsia trace type: %d", t)
 	}
 
+	log.I(ctx, "StartTrace is calling `ffx agis listen <global_id>`")
 	stdout, err := cmd.Call(ctx)
 
 	if err != nil {

gapic/src/main/com/google/gapid/perfetto/views/FuchsiaTraceConfigDialog.java

@@ -94,9 +94,13 @@ public static String getConfigSummary(Settings settings) {
     }
   }
 
-  public static Service.FuchsiaTraceConfig.Builder getConfig(Settings settings) {
+  public static Service.FuchsiaTraceConfig.Builder getCategories(Settings settings) {
     return Service.FuchsiaTraceConfig.newBuilder()
-        .addAllCategories(settings.fuchsiaTracing().getCategoriesList());
+       .addAllCategories(settings.fuchsiaTracing().getCategoriesList());
+  }
+
+  public static Service.FuchsiaTraceConfig.Builder getGlobalId(int globalId) {
+    return Service.FuchsiaTraceConfig.newBuilder().setGlobalId(globalId);
   }
 
   @Override

gapic/src/main/com/google/gapid/server/Tracer.java

@@ -71,6 +71,7 @@ protected void onUiThread(Throwable result) {
       }
     });
 
+    // Send the trace request to gapis.
     sender.send(Service.TraceRequest.newBuilder()
         .setInitialize(request.options)
         .build());

gapic/src/main/com/google/gapid/settings.proto

@@ -203,6 +203,7 @@ message Perfetto {
 
 message FuchsiaTracing {
   repeated string categories = 1;
+  int32 global_id = 2;
 }
 
 message Settings {

gapic/src/main/com/google/gapid/views/TracerDialog.java

@@ -190,13 +190,18 @@ public static void showTracingDialog(
   private static void showTracingDialog(
       TraceType type, Client client, Shell shell, Models models, Widgets widgets) {
     models.analytics.postInteraction(View.Trace, ClientAction.Show);
+
     TraceInputDialog input =
         new TraceInputDialog(shell, type, models, widgets, models.devices::loadDevices);
+
     if (loadDevicesAndShowDialog(input, models) == Window.OK) {
-      TraceProgressDialog progress = new TraceProgressDialog(
-          shell, models.analytics, input.getValue(), widgets.theme);
+      TraceProgressDialog progress =
+        new TraceProgressDialog(shell, models.analytics, input.getValue(), widgets.theme);
+
       Tracer.Trace trace = Tracer.trace(client, shell, input.getValue(), progress);
+
       progress.setTrace(trace);
+
       if (progress.open() == Window.OK && progress.successful()) {
         models.capture.loadCapture(input.getValue().output);
       }
@@ -429,7 +434,9 @@ public TraceInput(Composite parent, TraceType type, Models models, Widgets widge
             createGroup(this, "Application", new GridLayout(2, false)),
             new GridData(GridData.FILL_HORIZONTAL));
         targetLabel = createLabel(appGroup, TARGET_LABEL + ":");
+
         traceTarget = withLayoutData(new ActionTextbox(appGroup, trace.getUri()) {
+
           @Override
           protected String createAndShowDialog(String current) {
             DeviceCaptureInfo dev = getSelectedDevice();
@@ -450,6 +457,7 @@ protected String createAndShowDialog(String current) {
             }
             return null;
           }
+
         }, new GridData(SWT.FILL, SWT.FILL, true, false));
 
         createLabel(appGroup, "Additional Arguments:");
@@ -1070,11 +1078,26 @@ public TraceRequest getTraceRequest(Settings settings) {
           options.setClearCache(clearCache.getSelection());
         }
 
+        if (dev.isFuchsia()) {
+           if(type == TraceType.System) {
+             options.setFuchsiaTraceConfig(FuchsiaTraceConfigDialog.getCategories(settings));
+           } else if (type == TraceType.Vulkan) {
+             String uri = trace.getUri();
+             if (!uri.isEmpty()) {
+               String[] tokens = uri.split("\\s+");
+               int globalId = Integer.parseInt(tokens[0]);
+               options.setFuchsiaTraceConfig(FuchsiaTraceConfigDialog.getGlobalId(globalId));
+             } else {
+               throw new AssertionError("No global ID found in URI");
+             }
+           } else {
+             throw new AssertionError("Invalid Fuchsia trace type");
+           }
+        }
+
         if (type == TraceType.System) {
           options.setDuration(duration.getSelection());
-          if (dev.isFuchsia()) {
-            options.setFuchsiaTraceConfig(FuchsiaTraceConfigDialog.getConfig(settings));
-          } else {
+          if (!dev.isFuchsia()) {
             int durationMs = duration.getSelection() * 1000;
             // TODO: this isn't really unlimited.
             durationMs = (durationMs == 0) ? (int)MINUTES.toMillis(10) : durationMs;

gapii/cc/connection_header.cpp

@@ -31,6 +31,7 @@ ConnectionHeader::ConnectionHeader()
 
 bool ConnectionHeader::read(core::StreamReader* reader) {
   if (!reader->read(mMagic)) {
+    GAPID_WARNING("ConnectionHeader read into mMagic (4 bytes), failed.");
     return false;
   }
   if (mMagic[0] != 's' || mMagic[1] != 'p' || mMagic[2] != 'y' ||
@@ -43,6 +44,7 @@ bool ConnectionHeader::read(core::StreamReader* reader) {
   // TODO: Endian-swap data if GAPII is running on a big-endian architecture.
 
   if (!reader->read(mVersion)) {
+    GAPID_WARNING("ConnectionHeader read into mVersion, failed.");
     return false;
   }
 
@@ -58,6 +60,8 @@ bool ConnectionHeader::read(core::StreamReader* reader) {
   if (!reader->read(mObserveFrameFrequency) || !reader->read(mStartFrame) ||
       !reader->read(mNumFrames) || !reader->read(mAPIs) ||
       !reader->read(mFlags)) {
+    GAPID_WARNING(
+        "ConnectionHeader bulk of header information read has FAILED");
     return false;
   }
 

gapii/cc/spy.cpp

@@ -174,6 +174,8 @@ Spy::Spy()
 #endif                                          // TARGET_OS
     if (mConnection->write("gapii", 5) != 5) {  // handshake string
       GAPID_FATAL("Couldn't send \"gapii\" handshake string");
+    } else {
+      GAPID_INFO("Wrote \"gapii\" to vulkan socket.");
     }
     GAPID_INFO("Connection made");
   }
@@ -322,7 +324,8 @@ zx_handle_t Spy::AgisRegisterAndRetrieve(uint64_t client_id) {
                 register_result.error_value().FormatDescription().c_str());
   }
 
-  // Retrieve Vulkan socket.
+  // Issue hanging get to retrieve the Vulkan socket.
+  GAPID_INFO("Gapii - Issuing hanging get to wait for Vulkan socket");
   fidl::Result<fuchsia_gpu_agis::ComponentRegistry::GetVulkanSocket>
       socket_result = mAgisComponentRegistry->GetVulkanSocket(client_id);
   if (socket_result.is_error()) {
@@ -332,6 +335,8 @@ zx_handle_t Spy::AgisRegisterAndRetrieve(uint64_t client_id) {
   zx::socket vulkan_socket(std::move(socket_result->socket()));
   if (!vulkan_socket.is_valid()) {
     GAPID_ERROR("Spy(fuchsia) GetVulkanSocket() - invalid socket");
+  } else {
+    GAPID_INFO("Gapii - Retrieved valid Vulkan socket.");
   }
 
   // Release socket back to the caller.

gapii/client/adb.go

@@ -53,7 +53,7 @@ type Process struct {
 	Options Options
 
 	// The connection
-	conn net.Conn
+	Conn net.Conn
 }
 
 // Start launches an activity on an android device with the GAPII interceptor