• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2011-2018, The Linux Foundation. All rights reserved.
3  * Not a Contribution
4  *
5  * Copyright (C) 2008 The Android Open Source Project
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  */
19 
20 #ifndef __GR_PRIV_HANDLE_H__
21 #define __GR_PRIV_HANDLE_H__
22 
23 #include <errno.h>
24 #include <log/log.h>
25 #include <hardware/gralloc.h>
26 #include <hardware/gralloc1.h>
27 #include <cinttypes>
28 
29 #define GRALLOC1_FUNCTION_PERFORM 0x00001000
30 
31 #define DBG_HANDLE false
32 
33 typedef gralloc1_error_t (*GRALLOC1_PFN_PERFORM)(gralloc1_device_t *device, int operation, ...);
34 
35 #define PRIV_HANDLE_CONST(exp) static_cast<const private_handle_t *>(exp)
36 
37 #pragma pack(push, 4)
38 struct private_handle_t : public native_handle_t {
39   enum {
40     PRIV_FLAGS_FRAMEBUFFER = 0x00000001,
41     PRIV_FLAGS_USES_ION = 0x00000008,
42     PRIV_FLAGS_NEEDS_FLUSH = 0x00000020,
43     PRIV_FLAGS_INTERNAL_ONLY = 0x00000040,
44     PRIV_FLAGS_NON_CPU_WRITER = 0x00000080,
45     PRIV_FLAGS_CACHED = 0x00000200,
46     PRIV_FLAGS_SECURE_BUFFER = 0x00000400,
47     PRIV_FLAGS_EXTERNAL_ONLY = 0x00002000,
48     PRIV_FLAGS_PROTECTED_BUFFER = 0x00004000,
49     PRIV_FLAGS_VIDEO_ENCODER = 0x00010000,
50     PRIV_FLAGS_CAMERA_WRITE = 0x00020000,
51     PRIV_FLAGS_CAMERA_READ = 0x00040000,
52     PRIV_FLAGS_HW_COMPOSER = 0x00080000,
53     PRIV_FLAGS_HW_TEXTURE = 0x00100000,
54     PRIV_FLAGS_ITU_R_601 = 0x00200000,     // Unused from display
55     PRIV_FLAGS_ITU_R_601_FR = 0x00400000,  // Unused from display
56     PRIV_FLAGS_ITU_R_709 = 0x00800000,     // Unused from display
57     PRIV_FLAGS_SECURE_DISPLAY = 0x01000000,
58     PRIV_FLAGS_TILE_RENDERED = 0x02000000,
59     PRIV_FLAGS_CPU_RENDERED = 0x04000000,
60     PRIV_FLAGS_UBWC_ALIGNED = 0x08000000,
61     PRIV_FLAGS_DISP_CONSUMER = 0x10000000,
62     PRIV_FLAGS_CLIENT_ALLOCATED = 0x20000000,  // Ion buffer allocated outside of gralloc
63   };
64 
65   // file-descriptors dup'd over IPC
66   int fd;
67   int fd_metadata;
68 
69   // values sent over IPC
70   int magic;
71   int flags;
72   int width;             // holds width of the actual buffer allocated
73   int height;            // holds height of the  actual buffer allocated
74   int unaligned_width;   // holds width client asked to allocate
75   int unaligned_height;  // holds height client asked to allocate
76   int format;
77   int buffer_type;
78   unsigned int layer_count;
79   uint64_t id;
80   uint64_t usage;
81 
82   unsigned int size;
83   unsigned int offset;
84   unsigned int offset_metadata;
85   uint64_t base;
86   uint64_t base_metadata;
87   uint64_t gpuaddr;
88 
89   static const int kNumFds = 2;
90   static const int kMagic = 'gmsm';
91 
NumIntsprivate_handle_t92   static inline int NumInts() {
93     return ((sizeof(private_handle_t) - sizeof(native_handle_t)) / sizeof(int)) - kNumFds;
94   }
95 
96   private_handle_t(int fd, int meta_fd, int flags, int width, int height, int uw, int uh,
97                    int format, int buf_type, unsigned int size, uint64_t usage = 0)
fdprivate_handle_t98       : fd(fd),
99         fd_metadata(meta_fd),
100         magic(kMagic),
101         flags(flags),
102         width(width),
103         height(height),
104         unaligned_width(uw),
105         unaligned_height(uh),
106         format(format),
107         buffer_type(buf_type),
108         layer_count(1),
109         id(0),
110         usage(usage),
111         size(size),
112         offset(0),
113         offset_metadata(0),
114         base(0),
115         base_metadata(0),
116         gpuaddr(0) {
117     version = static_cast<int>(sizeof(native_handle));
118     numInts = NumInts();
119     numFds = kNumFds;
120   }
121 
122   // Legacy constructor used by some clients
private_handle_tprivate_handle_t123   private_handle_t(int fd, unsigned int size, int usage, int buf_type, int format, int w, int h)
124       : private_handle_t(fd, -1, PRIV_FLAGS_CLIENT_ALLOCATED, w, h, 0, 0, format, buf_type, size,
125                          static_cast<uint64_t>(usage)) {}
126 
~private_handle_tprivate_handle_t127   ~private_handle_t() {
128     magic = 0;
129     ALOGE_IF(DBG_HANDLE, "Deleting buffer handle %p", this);
130   }
131 
validateprivate_handle_t132   static int validate(const native_handle *h) {
133     auto *hnd = static_cast<const private_handle_t *>(h);
134     if (!h || h->version != sizeof(native_handle) || h->numInts != NumInts() ||
135         h->numFds != kNumFds) {
136       ALOGE("Invalid gralloc handle (at %p): ver(%d/%zu) ints(%d/%d) fds(%d/%d) ",
137           h, h ? h->version : -1, sizeof(native_handle), h ? h->numInts : -1, NumInts(),
138           h ? h->numFds : -1, kNumFds);
139       return -EINVAL;
140     }
141     if (hnd->magic != kMagic) {
142        ALOGE("magic(%c%c%c%c/%c%c%c%c)",
143           hnd ? (((hnd->magic >> 24) & 0xFF) ? ((hnd->magic >> 24) & 0xFF) : '-') : '?',
144           hnd ? (((hnd->magic >> 16) & 0xFF) ? ((hnd->magic >> 16) & 0xFF) : '-') : '?',
145           hnd ? (((hnd->magic >> 8) & 0xFF) ? ((hnd->magic >> 8) & 0xFF) : '-') : '?',
146           hnd ? (((hnd->magic >> 0) & 0xFF) ? ((hnd->magic >> 0) & 0xFF) : '-') : '?',
147           (kMagic >> 24) & 0xFF, (kMagic >> 16) & 0xFF, (kMagic >> 8) & 0xFF, (kMagic >> 0) & 0xFF);
148       return -EINVAL;
149     }
150 
151     return 0;
152   }
153 
Dumpprivate_handle_t154   static void Dump(const private_handle_t *hnd) {
155     ALOGD("handle id:%" PRIu64
156           " wxh:%dx%d uwxuh:%dx%d size: %d fd:%d fd_meta:%d flags:0x%x "
157           "usage:0x%" PRIx64 "  format:0x%x layer_count: %d",
158           hnd->id, hnd->width, hnd->height, hnd->unaligned_width, hnd->unaligned_height, hnd->size,
159           hnd->fd, hnd->fd_metadata, hnd->flags, hnd->usage, hnd->format, hnd->layer_count);
160   }
161 
GetUnalignedWidthprivate_handle_t162   int GetUnalignedWidth() const { return unaligned_width; }
163 
GetUnalignedHeightprivate_handle_t164   int GetUnalignedHeight() const { return unaligned_height; }
165 
GetColorFormatprivate_handle_t166   int GetColorFormat() const { return format; }
167 
GetLayerCountprivate_handle_t168   unsigned int GetLayerCount() const { return layer_count; }
169 
GetStrideprivate_handle_t170   int GetStride() const {
171     // In handle we currently store aligned width after allocation.
172     return width;
173   }
174 
GetUsageprivate_handle_t175   uint64_t GetUsage() const { return usage; }
176 
GetBackingstoreprivate_handle_t177   uint64_t GetBackingstore() const { return id; }
178 };
179 #pragma pack(pop)
180 
181 #endif  // __GR_PRIV_HANDLE_H__
182