Make GrIODB keep pending IO refs on all resources it records into its cmd stream.

include/gpu/GrGpuResourceRef.h

 /*
  * Copyright 2014 Google Inc.
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 #ifndef GrGpuResourceRef_DEFINED
 #define GrGpuResourceRef_DEFINED
 
 #include "SkRefCnt.h"
 
 class GrGpuResource;
 
 /**
+ * This class is intended only for internal use in core Gr code.
+ *
  * Class that wraps a resource referenced by a GrProgramElement or GrDrawState. It manages

[robertphillips, 2014/09/18 19:30:51]

reosource - typo.

[bsalomon, 2014/09/18 19:43:54]

Done.

- * converting refs to pending io operations. Like SkAutoTUnref, its constructor and setter adopt
- * a ref from their caller. This class is intended only for internal use in core Gr code.
+ * converting refs to pending IO operations. It allows a reosource ownership to be in three
+ * states:
+ *          1. Owns a single ref
+ *          2. Owns a single ref and a pending IO operation (read, write, or read-write)
+ *          3. Owns a single pending IO operation.
+ *
+ * It is legal to destroy the GrGpuResourceRef in any of these states. It starts in state
+ * 1. Calling markPendingIO() converts it from state 1 to state 2. Calling removeRef() goes from
+ * state 2 to state 3. Calling pendingIOComplete() moves from state 2 to state 1. There is no
+ * valid way of going from state 3 back to 2 or 1.
+ *
+ * Like SkAutoTUnref, its constructor and setter adopt a ref from their caller.
+ *
+ * TODO: Once GrDODrawState no longer exists and therefore GrDrawState and GrOptDrawState no
+ * longer share an instance of this class, attempt to make the resource owned by GrGpuResourceRef
+ * only settable via the constructor.
  */
 class GrGpuResourceRef : SkNoncopyable {
 public:
     SK_DECLARE_INST_COUNT_ROOT(GrGpuResourceRef);
 
     enum IOType {
         kRead_IOType,
         kWrite_IOType,
         kRW_IOType,
 
@@ skipping 17 matching lines @@
     /** Adopts a ref from the caller. ioType expresses what type of IO operations will be marked as
         pending on the resource when markPendingIO is called. */
     GrGpuResourceRef(GrGpuResource*, IOType);
 
     /** Adopts a ref from the caller. ioType expresses what type of IO operations will be marked as
         pending on the resource when markPendingIO is called. */
     void setResource(GrGpuResource*, IOType);
 
 private:
     /** Called by owning GrProgramElement when the program element is first scheduled for
-        execution. */
+        execution. It can only be called once. */
     void markPendingIO() const;
 
     /** Called when the program element/draw state is no longer owned by GrDrawTarget-client code.
         This lets the cache know that the drawing code will no longer schedule additional reads or
-        writes to the resource using the program element or draw state. */
+        writes to the resource using the program element or draw state. It can only be called once.
+      */
     void removeRef() const;
 
     /** Called to indicate that the previous pending IO is complete. Useful when the owning object
         still has refs, so it is not about to destroy this GrGpuResourceRef, but its previously
-        pending executions have been complete.
-     */
+        pending executions have been complete. Can only be called if removeRef() was not previously
+        called. */
     void pendingIOComplete() const;
 
     friend class GrRODrawState;
     friend class GrProgramElement;
 
     GrGpuResource*      fResource;
     mutable bool        fOwnRef;
     mutable bool        fPendingIO;
     IOType              fIOType;
 
     typedef SkNoncopyable INHERITED;
 };
 
+/** 
+ * Templated version of GrGpuResourceRef to enforce type safety.
+ */
 template <typename T> class GrTGpuResourceRef : public GrGpuResourceRef {
 public:
     GrTGpuResourceRef() {}
 
     /** Adopts a ref from the caller. ioType expresses what type of IO operations will be marked as
         pending on the resource when markPendingIO is called. */

[robertphillips, 2014/09/18 19:30:51]

Was reverting the INHERITED stuff intentional ?

[bsalomon, 2014/09/18 19:43:55]

oops.. no

-    GrTGpuResourceRef(T* resource, IOType ioType) : INHERITED(resource, ioType) {}
+    GrTGpuResourceRef(T* resource, IOType ioType) : GrGpuResourceRef(resource, ioType) {}
 
     T* get() const { return static_cast<T*>(this->getResource()); }
 
     /** Adopts a ref from the caller. ioType expresses what type of IO operations will be marked as
         pending on the resource when markPendingIO is called. */
     void set(T* resource, IOType ioType) { this->setResource(resource, ioType); }
+};
+
+/**
+ * This is similar to GrTGpuResourceRef but can only be in the pending IO state. It never owns a
+ * ref.
+ */
+template <typename T> class GrPendingIOResource : SkNoncopyable {
+public:
+    typedef GrGpuResourceRef::IOType IOType;
+    GrPendingIOResource(T* resource, IOType ioType) : fResource(resource), fIOType(ioType) {
+        if (NULL != fResource) {
+            switch (fIOType) {
+                case GrGpuResourceRef::kNone_IOType:
+                    SkFAIL("GrPendingIOResource with neither reads nor writes?");
+                    break;
+                case GrGpuResourceRef::kRead_IOType:
+                    fResource->addPendingRead();
+                    break;
+                case GrGpuResourceRef::kWrite_IOType:
+                    fResource->addPendingWrite();
+                    break;
+                case GrGpuResourceRef::kRW_IOType:
+                    fResource->addPendingRead();
+                    fResource->addPendingWrite();
+                    break;
+            }
+        }
+    }
+
+    ~GrPendingIOResource() {
+        if (NULL != fResource) {
+            switch (fIOType) {
+                case GrGpuResourceRef::kNone_IOType:
+                    SkFAIL("GrPendingIOResource with neither reads nor writes?");
+                    break;
+                case GrGpuResourceRef::kRead_IOType:
+                    fResource->completedRead();
+                    break;
+                case GrGpuResourceRef::kWrite_IOType:
+                    fResource->completedWrite();
+                    break;
+                case GrGpuResourceRef::kRW_IOType:
+                    fResource->completedRead();
+                    fResource->completedWrite();
+                    break;
+            }
+        }
+    }
+

[robertphillips, 2014/09/18 19:30:51]

Should this really be const ?

[bsalomon, 2014/09/18 19:43:54]

I think so. It is on other similar classes. const SkAutoTFoo<A> means the
SkAutoTFoo is const not the A.

Otherwise this would work:

class A {
public:
   Texture* getTexture() const { return fTexture; }

private:
   Texture* fTexture;
};

but not this:

class A {
public:
   Texture* getTexture() const { return fAuto.get(); }

private:
   SkAutoTFoo<Texture> fAuto;
};

which makes the SkAutoTFoo less useful than a raw ptr.

+    T* get() const { return fResource; }
 
 private:
-    typedef GrGpuResourceRef INHERITED;
+    IOType  fIOType;
+    T*      fResource;
 };
-
-
 #endif