Frameboundary2

cmd/gapit/flags.go

@@ -322,6 +322,7 @@ type (
 		Capture struct {
 			Frames int `help:"only capture the given number of frames. 0 for all"`
 		}
+		RespectAndroidFrameBoundary bool `help:"If true: respect the ANDROID_frame_boundary extension. If false: ignore."`
 		No struct {
 			Buffer bool `help:"Do not buffer the output, this helps if the application crashes"`
 		}

cmd/gapit/trace.go

@@ -228,25 +228,26 @@ func (verb *traceVerb) Run(ctx context.Context, flags flag.FlagSet) error {
 	}
 
 	options := &service.TraceOptions{
-		Type:                         api.traceType,
-		AdditionalCommandLineArgs:    verb.AdditionalArgs,
-		Cwd:                          verb.WorkingDir,
-		Environment:                  verb.Env,
-		Duration:                     float32(verb.For.Seconds()),
-		ObserveFrameFrequency:        uint32(verb.Observe.Frames),
-		StartFrame:                   uint32(verb.Start.At.Frame),
-		FramesToCapture:              uint32(verb.Capture.Frames),
-		DeferStart:                   verb.Start.Defer,
-		NoBuffer:                     verb.No.Buffer,
-		HideUnknownExtensions:        verb.Disable.Unknown.Extensions,
-		RecordTraceTimes:             verb.Record.TraceTimes,
-		ClearCache:                   verb.Clear.Cache,
-		ServerLocalSavePath:          out,
-		PipeName:                     verb.PipeName,
-		DisableCoherentMemoryTracker: verb.Disable.CoherentMemoryTracker,
-		WaitForDebugger:              verb.WaitForDebugger,
-		ProcessName:                  verb.ProcessName,
-		LoadValidationLayer:          verb.LoadValidationLayer,
+		Type:                         	api.traceType,
+		AdditionalCommandLineArgs:    	verb.AdditionalArgs,
+		Cwd:                          	verb.WorkingDir,
+		Environment:                  	verb.Env,
+		Duration:                     	float32(verb.For.Seconds()),
+		ObserveFrameFrequency:        	uint32(verb.Observe.Frames),
+		StartFrame:                   	uint32(verb.Start.At.Frame),
+		FramesToCapture:              	uint32(verb.Capture.Frames),
+		DeferStart:                   	verb.Start.Defer,
+		RespectFrameBoundaryDelimiters:	verb.RespectAndroidFrameBoundary,
+		NoBuffer:                     	verb.No.Buffer,
+		HideUnknownExtensions:        	verb.Disable.Unknown.Extensions,
+		RecordTraceTimes:             	verb.Record.TraceTimes,
+		ClearCache:                   	verb.Clear.Cache,
+		ServerLocalSavePath:          	out,
+		PipeName:                     	verb.PipeName,
+		DisableCoherentMemoryTracker: 	verb.Disable.CoherentMemoryTracker,
+		WaitForDebugger:              	verb.WaitForDebugger,
+		ProcessName:                  	verb.ProcessName,
+		LoadValidationLayer:          	verb.LoadValidationLayer,
 	}
 	target(options)
 

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

@@ -336,6 +336,7 @@ private static class TraceInput extends Composite {
       private final Spinner duration;
       private final Label durationUnit;
       private final Label startUnit;
+      private final Button respectAndroidFrameBoundary;
       private final Button withoutBuffering;
       private final Button includeUnsupportedExtensions;
       private final Button loadValidationLayer;
@@ -489,6 +490,8 @@ protected String createAndShowDialog(String current) {
         duration.setVisible(DURATION_FRAMES_MAX > 1);
         durationUnit = createLabel(durGroup, DURATION_FRAMES_UNIT);
         durationUnit.setVisible(DURATION_FRAMES_MAX > 1);
+        respectAndroidFrameBoundary = createCheckbox(durGroup, "Respect ANDROID_frame_boundary", false);
+        respectAndroidFrameBoundary.setEnabled(true);
 
         Group optGroup  = withLayoutData(
             createGroup(this, "Trace Options", new GridLayout(2, false)),
@@ -1028,6 +1031,7 @@ public TraceRequest getTraceRequest(Settings settings) {
             .setUri(traceTarget.getText())
             .setAdditionalCommandLineArgs(arguments.getText())
             .setFramesToCapture(duration.getSelection())
+            .setRespectFrameBoundaryDelimiters(respectAndroidFrameBoundary.getSelection())
             .setNoBuffer(withoutBuffering.getSelection())
             .setHideUnknownExtensions(!includeUnsupportedExtensions.getSelection())
             .setServerLocalSavePath(output.getAbsolutePath())

gapii/cc/call_observer.cpp

@@ -132,6 +132,10 @@ void CallObserver::observeTimestamp() {
   encode_message(&timestamp);
 }
 
+bool CallObserver::respectFrameBoundaryDelimiters() {
+  return mSpy->respectFrameBoundaryDelimiters();
+}
+
 void CallObserver::enter(const ::google::protobuf::Message* cmd) {
   endTraceIfRequested();
   if (!mShouldTrace) {

gapii/cc/call_observer.h

@@ -202,6 +202,9 @@ class CallObserver : gapil::Encoder {
   // observeTimestamp encodes a timestamp extra in the trace
   void observeTimestamp();
 
+  // If true, respect frame delimiter hints (ie, ANDROID_frame_boundary)
+  bool respectFrameBoundaryDelimiters();
+
  private:
   // shouldObserve returns true if the given slice is located in application
   // pool and we are supposed to observe application pool.

gapii/cc/connection_header.h

@@ -56,6 +56,8 @@ class ConnectionHeader {
   static const uint32_t FLAG_DISABLE_COHERENT_MEMORY_TRACKER = 0x00000100;
   // Waits for the debugger to attach (useful for debug)
   static const uint32_t FLAG_WAIT_FOR_DEBUGGER = 0x00000200;
+  // Set to enable use of frame delimiters, eg ANDROID_frame_boundary extension 
+  static const uint32_t FLAG_RESPECT_FRAME_BOUNDARY_DELIMITERS = 0x00001000;
 
   // read reads the ConnectionHeader from the provided stream, returning true
   // on success or false on error.

gapii/cc/spy.cpp

@@ -93,7 +93,8 @@ Spy::Spy()
       mSuspendCaptureFrames(0),
       mCaptureFrames(0),
       mObserveFrameFrequency(0),
-      mFrameNumber(0) {
+      mFrameNumber(0),
+      mRespectFrameBoundaryDelimiters(false) {
   // Start by checking whether to capture the current process: compare the
   // current process name with the "capture_proc_name" that we get from the
   // environment. An empty "capture_proc_name" means capture any process. This
@@ -166,6 +167,7 @@ Spy::Spy()
                               ? kSuspendIndefinitely
                               : header.mStartFrame;
   mCaptureFrames = header.mNumFrames;
+  mRespectFrameBoundaryDelimiters = (header.mFlags & ConnectionHeader::FLAG_RESPECT_FRAME_BOUNDARY_DELIMITERS) != 0;
 
   set_valid_apis(header.mAPIs);
   GAPID_ERROR("APIS %08x", header.mAPIs);

gapii/cc/spy.h

@@ -85,6 +85,9 @@ class Spy : public VulkanSpy {
   int mObserveFrameFrequency;
   uint64_t mFrameNumber;
 
+  bool mRespectFrameBoundaryDelimiters;
+  bool respectFrameBoundaryDelimiters() override { return mRespectFrameBoundaryDelimiters; }
+
   std::unique_ptr<core::AsyncJob> mMessageReceiverJob;
 
   friend struct spy_creator;

gapii/cc/spy_base.h

@@ -110,6 +110,9 @@ class SpyBase {
   void set_record_timestamps(bool record) { mRecordTimestamps = record; }
   bool should_record_timestamps() const { return mRecordTimestamps; }
 
+  // If true, respect frame delimiter extensions, eg ANDROID_frame_boundary
+  virtual bool respectFrameBoundaryDelimiters() { return false; }
+
   // Ends the current trace if requested by client.
   virtual void endTraceIfRequested() {}
 

gapii/client/capture.go

@@ -52,6 +52,9 @@ const (
 	DisableCoherentMemoryTracker Flags = 0x000000100
 	// WaitForDebugger makes gapii wait for a debugger to connect
 	WaitForDebugger Flags = 0x000000200
+	// FLAG_RESPECT_ANDROID_FRAME_BOUNDARY
+	RespectFrameBoundaryDelimiters = 0x00001000
+
 
 	// VulkanAPI is hard-coded bit mask for Vulkan API, it needs to be kept in sync
 	// with the api_index in the vulkan.api file.

gapis/api/templates/api_spy.cpp.tmpl

@@ -219,6 +219,12 @@
         called = true;
         {{if GetAnnotation $ "frame_end"}}
           onPreEndOfFrame(observer, {{Global "ApiIndex"}});
+        {{else}}
+          {{if GetAnnotation $ "frame_delimiter"}}
+            if(observer->respectFrameBoundaryDelimiters()) {
+              onPreEndOfFrame(observer, {{Global "ApiIndex"}});
+            }
+          {{end}}
         {{end}}
 
         observer->observePending();
@@ -272,7 +278,16 @@
       observer->observePending();
       observer->exit();
 
-      {{if GetAnnotation $ "frame_end"}}onPostEndOfFrame();{{end}}
+      {{if GetAnnotation $ "frame_end"}}
+        onPostEndOfFrame();
+      {{else}}
+        {{if GetAnnotation $ "frame_delimiter"}}
+        if(observer->respectFrameBoundaryDelimiters()) {
+          onPostEndOfFrame();
+        }
+        {{end}}
+      {{end}}
+
       {{if not (IsVoid $.Return.Type)}}¶
         return result;
       {{end}}

gapis/api/vulkan/extensions/android_frame_boundary.api

@@ -35,7 +35,7 @@
 @extension("VK_ANDROID_frame_boundary")
 @indirect("VkDevice")
 @override
-@frame_end
+@frame_delimiter
 @no_replay
 cmd void vkFrameBoundaryANDROID(
     VkDevice                device,

gapis/service/service.proto

@@ -1384,7 +1384,8 @@ message TraceOptions {
   uint32 start_frame = 12;
   // How many frames should we capture
   uint32 frames_to_capture = 13;
-  reserved 14;
+  // Set whether to respect the ANDROID_frame_boundary extension
+  bool respect_frame_boundary_delimiters = 14;
   // Insert extra commands to record error state
   bool record_error_state = 15;
   // Wait for an event to start tracing

gapis/trace/tracer/tracer.go

@@ -127,6 +127,9 @@ func GapiiOptions(o *service.TraceOptions) gapii.Options {
 	if o.WaitForDebugger {
 		flags |= gapii.WaitForDebugger
 	}
+	if o.RespectFrameBoundaryDelimiters {
+		flags |= gapii.RespectFrameBoundaryDelimiters
+	}
 
 	return gapii.Options{
 		o.ObserveFrameFrequency,