From 33eab3a829fee3bc89e435e10ec581d87d68797c Mon Sep 17 00:00:00 2001 From: Jesse Hall Date: Fri, 24 Mar 2017 13:16:27 -0700 Subject: [PATCH] Add gralloc usage conversion functions Converting gralloc1 / ..graphics.allocator@2.0 usage to gralloc0 usage requires more than just ORing bits and truncating: the CPU_READ_OFTEN bits don't match up correctly. Add utility functions for converting back and forth which handle this properly. Test: boot bullhead-eng Change-Id: I1cee972feaea486d5607c60acead2e870c2c9549 --- libgrallocusage/Android.bp | 29 +++ libgrallocusage/GrallocUsageConversion.cpp | 65 ++++++ libgrallocusage/MODULE_LICENSE_APACHE2 | 0 libgrallocusage/NOTICE | 190 ++++++++++++++++++ .../grallocusage/GrallocUsageConversion.h | 47 +++++ 5 files changed, 331 insertions(+) create mode 100644 libgrallocusage/Android.bp create mode 100644 libgrallocusage/GrallocUsageConversion.cpp create mode 100644 libgrallocusage/MODULE_LICENSE_APACHE2 create mode 100644 libgrallocusage/NOTICE create mode 100644 libgrallocusage/include/grallocusage/GrallocUsageConversion.h diff --git a/libgrallocusage/Android.bp b/libgrallocusage/Android.bp new file mode 100644 index 000000000..54bfee5c4 --- /dev/null +++ b/libgrallocusage/Android.bp @@ -0,0 +1,29 @@ +// Copyright 2017 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +cc_library_static { + name: "libgrallocusage", + cppflags: [ + "-Weverything", + "-Werror", + "-Wno-c++98-compat-pedantic", + // Hide errors in headers we include + "-Wno-global-constructors", + "-Wno-exit-time-destructors", + "-Wno-padded", + ], + srcs: ["GrallocUsageConversion.cpp"], + export_include_dirs: ["include"], + shared_libs: ["android.hardware.graphics.allocator@2.0"], +} diff --git a/libgrallocusage/GrallocUsageConversion.cpp b/libgrallocusage/GrallocUsageConversion.cpp new file mode 100644 index 000000000..8164beb80 --- /dev/null +++ b/libgrallocusage/GrallocUsageConversion.cpp @@ -0,0 +1,65 @@ +/* + * Copyright 2017 The Android Open Source Project + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include + +#include +#include + +using android::hardware::graphics::allocator::V2_0::ProducerUsage; +using android::hardware::graphics::allocator::V2_0::ConsumerUsage; + +void android_convertGralloc0To1Usage(int32_t usage, uint64_t* producerUsage, + uint64_t* consumerUsage) { + constexpr uint64_t PRODUCER_MASK = ProducerUsage::CPU_READ | + /* ProducerUsage::CPU_READ_OFTEN | */ + ProducerUsage::CPU_WRITE | + /* ProducerUsage::CPU_WRITE_OFTEN | */ + ProducerUsage::GPU_RENDER_TARGET | ProducerUsage::PROTECTED | + ProducerUsage::CAMERA | ProducerUsage::VIDEO_DECODER | + ProducerUsage::SENSOR_DIRECT_DATA; + constexpr uint64_t CONSUMER_MASK = ConsumerUsage::CPU_READ | + /* ConsumerUsage::CPU_READ_OFTEN | */ + ConsumerUsage::GPU_TEXTURE | ConsumerUsage::HWCOMPOSER | + ConsumerUsage::CLIENT_TARGET | ConsumerUsage::CURSOR | + ConsumerUsage::VIDEO_ENCODER | ConsumerUsage::CAMERA | + ConsumerUsage::RENDERSCRIPT | ConsumerUsage::GPU_DATA_BUFFER; + *producerUsage = static_cast(usage) & PRODUCER_MASK; + *consumerUsage = static_cast(usage) & CONSUMER_MASK; + if ((static_cast(usage) & GRALLOC_USAGE_SW_READ_OFTEN) == GRALLOC_USAGE_SW_READ_OFTEN) { + *producerUsage |= ProducerUsage::CPU_READ_OFTEN; + *consumerUsage |= ConsumerUsage::CPU_READ_OFTEN; + } + if ((static_cast(usage) & GRALLOC_USAGE_SW_WRITE_OFTEN) == + GRALLOC_USAGE_SW_WRITE_OFTEN) { + *producerUsage |= ProducerUsage::CPU_WRITE_OFTEN; + } +} + +int32_t android_convertGralloc1To0Usage(uint64_t producerUsage, uint64_t consumerUsage) { + static_assert(uint64_t(ConsumerUsage::CPU_READ_OFTEN) == uint64_t(ProducerUsage::CPU_READ_OFTEN), + "expected ConsumerUsage and ProducerUsage CPU_READ_OFTEN bits to match"); + uint64_t merged = producerUsage | consumerUsage; + if ((merged & (ConsumerUsage::CPU_READ_OFTEN)) != 0) { + merged &= ~uint64_t(ConsumerUsage::CPU_READ_OFTEN); + merged |= GRALLOC_USAGE_SW_READ_OFTEN; + } + if ((merged & (ProducerUsage::CPU_WRITE_OFTEN)) != 0) { + merged &= ~uint64_t(ProducerUsage::CPU_WRITE_OFTEN); + merged |= GRALLOC_USAGE_SW_WRITE_OFTEN; + } + return static_cast(merged); +} diff --git a/libgrallocusage/MODULE_LICENSE_APACHE2 b/libgrallocusage/MODULE_LICENSE_APACHE2 new file mode 100644 index 000000000..e69de29bb diff --git a/libgrallocusage/NOTICE b/libgrallocusage/NOTICE new file mode 100644 index 000000000..c5b1efa7a --- /dev/null +++ b/libgrallocusage/NOTICE @@ -0,0 +1,190 @@ + + Copyright (c) 2005-2008, The Android Open Source Project + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + diff --git a/libgrallocusage/include/grallocusage/GrallocUsageConversion.h b/libgrallocusage/include/grallocusage/GrallocUsageConversion.h new file mode 100644 index 000000000..5c94343c2 --- /dev/null +++ b/libgrallocusage/include/grallocusage/GrallocUsageConversion.h @@ -0,0 +1,47 @@ +/* + * Copyright 2017 The Android Open Source Project + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef ANDROID_GRALLOCUSAGE_GRALLOC_USAGE_CONVERSION_H +#define ANDROID_GRALLOCUSAGE_GRALLOC_USAGE_CONVERSION_H 1 + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +// Conversion functions are out-of-line so that users don't have to be exposed to +// android/hardware/graphics/allocator/2.0/types.h and link against +// android.hardware.graphics.allocator@2.0 to get that in their search path. + +// Convert a 32-bit gralloc0 usage mask to a producer/consumer pair of 64-bit usage masks as used +// by android.hardware.graphics.allocator@2.0 (and gralloc1). This conversion properly handles the +// mismatch between a.h.g.allocator@2.0's CPU_{READ,WRITE}_OFTEN and gralloc0's +// SW_{READ,WRITE}_OFTEN. +void android_convertGralloc0To1Usage(int32_t usage, uint64_t* producerUsage, + uint64_t* consumerUsage); + +// Convert a producer/consumer pair of 64-bit usage masks as used by +// android.hardware.graphics.allocator@2.0 (and gralloc1) to a 32-bit gralloc0 usage mask. This +// conversion properly handles the mismatch between a.h.g.allocator@2.0's CPU_{READ,WRITE}_OFTEN +// and gralloc0's SW_{READ,WRITE}_OFTEN. +int32_t android_convertGralloc1To0Usage(uint64_t producerUsage, uint64_t consumerUsage); + +#ifdef __cplusplus +} +#endif + +#endif // ANDROID_GRALLOCUSAGE_GRALLOC_USAGE_CONVERSION_H