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