include/ui/Fence.h

   1 /*
   2  * Copyright (C) 2012 The Android Open Source Project
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef ANDROID_FENCE_H
  18 #define ANDROID_FENCE_H
  19
  20 #include <stdint.h>
  21 #include <limits.h>
  22 #include <sys/types.h>
  23
  24 #include <ui/ANativeObjectBase.h>
  25 #include <ui/PixelFormat.h>
  26 #include <ui/Rect.h>
  27 #include <utils/Flattenable.h>
  28 #include <utils/String8.h>
  29
  30 struct ANativeWindowBuffer;
  31
  32 namespace android {
  33
  34 // ===========================================================================
  35 // Fence
  36 // ===========================================================================
  37
  38 class Fence
  39     : public LightRefBase<Fence>, public Flattenable
  40 {
  41 public:
  42     static const sp<Fence> NO_FENCE;
  43
  44     // Construct a new Fence object with an invalid file descriptor.  This
  45     // should be done when the Fence object will be set up by unflattening
  46     // serialized data.
  47     Fence();
  48
  49     // Construct a new Fence object to manage a given fence file descriptor.
  50     // When the new Fence object is destructed the file descriptor will be
  51     // closed.
  52     Fence(int fenceFd);
  53
  54     // Check whether the Fence has an open fence file descriptor. Most Fence
  55     // methods treat an invalid file descriptor just like a valid fence that
  56     // is already signalled, so using this is usually not necessary.
  57     bool isValid() const { return mFenceFd != -1; }
  58
  59     // wait waits for up to timeout milliseconds for the fence to signal.  If
  60     // the fence signals then NO_ERROR is returned. If the timeout expires
  61     // before the fence signals then -ETIME is returned.  A timeout of
  62     // TIMEOUT_NEVER may be used to indicate that the call should wait
  63     // indefinitely for the fence to signal.
  64     int wait(unsigned int timeout);
  65
  66     // TIMEOUT_NEVER may be passed to the wait method to indicate that it
  67     // should wait indefinitely for the fence to signal.
  68     enum { TIMEOUT_NEVER = UINT_MAX };
  69
  70     // merge combines two Fence objects, creating a new Fence object that
  71     // becomes signaled when both f1 and f2 are signaled (even if f1 or f2 is
  72     // destroyed before it becomes signaled).  The name argument specifies the
  73     // human-readable name to associated with the new Fence object.
  74     static sp<Fence> merge(const String8& name, const sp<Fence>& f1,
  75             const sp<Fence>& f2);
  76
  77     // Return a duplicate of the fence file descriptor. The caller is
  78     // responsible for closing the returned file descriptor. On error, -1 will
  79     // be returned and errno will indicate the problem.
  80     int dup() const;
  81
  82     // Flattenable interface
  83     size_t getFlattenedSize() const;
  84     size_t getFdCount() const;
  85     status_t flatten(void* buffer, size_t size,
  86             int fds[], size_t count) const;
  87     status_t unflatten(void const* buffer, size_t size,
  88             int fds[], size_t count);
  89
  90 private:
  91     // Only allow instantiation using ref counting.
  92     friend class LightRefBase<Fence>;
  93     virtual ~Fence();
  94
  95     // Disallow copying
  96     Fence(const Fence& rhs);
  97     Fence& operator = (const Fence& rhs);
  98     const Fence& operator = (const Fence& rhs) const;
  99
 100     int mFenceFd;
 101 };
 102
 103 }; // namespace android
 104
 105 #endif // ANDROID_FENCE_H